Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-10 06:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

new config template

Browse source
This commit is contained in:
Chaz Larson 2022-12-10 11:49:53 -06:00
parent 0eb84fe60f
commit 914c311e21
1 changed files with 42 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
docs/config/configuration.md
View file

@ -33,38 +33,38 @@ This example outlines what a "standard" config.yml file might look like when in
<summary>Example config.yml file</summary> <summary>Example config.yml file</summary>
```yaml ```yaml
libraries: # This is called out once within the config.yml file ## This file is a template remove the .template to use the file
Movies: # Each library must match the Plex library name
libraries: # This is called out once within the config.yml file
Movies: # Each library must match the Plex library name
metadata_path: metadata_path:
- file: config/Movies.yml # This is a local file on the system - pmm: basic # This is a file within the defaults folder in the Repository
- folder: config/Movies/ # This is a local directory on the system - pmm: imdb # This is a file within the defaults folder in the Repository
- pmm: basic # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html # see the wiki for how to use local files, folders, URLs, or files from git
- pmm: imdb # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html
overlay_path: overlay_path:
- remove_overlays: false # Set this to true to remove all overlays - remove_overlays: false # Set this to true to remove all overlays
- file: config/Overlays.yml # This is a local file on the system - pmm: ribbon # This is a file within the defaults folder in the Repository
- pmm: ribbon # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html # see the wiki for how to use local files, folders, URLs, or files from git
TV Shows: TV Shows:
metadata_path: metadata_path:
- file: config/TVShows.yml - pmm: basic # This is a file within the defaults folder in the Repository
- folder: config/TV Shows/ - pmm: imdb # This is a file within the defaults folder in the Repository
- pmm: basic # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html # see the wiki for how to use local files, folders, URLs, or files from git
- pmm: imdb # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html
overlay_path: overlay_path:
- remove_overlays: false # Set this to true to remove all overlays - remove_overlays: false # Set this to true to remove all overlays
- file: config/Overlays.yml # This is a local file on the system - pmm: ribbon # This is a file within the defaults folder in the Repository
- pmm: ribbon # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html # see the wiki for how to use local files, folders, URLs, or files from git
Anime: Anime:
metadata_path: metadata_path:
- file: config/Anime.yml - pmm: basic # This is a file within the defaults folder in the Repository
- pmm: basic # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html - pmm: anilist # This is a file within the defaults folder in the Repository
- pmm: anilist # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html # see the wiki for how to use local files, folders, URLs, or files from git
Music: Music:
metadata_path: metadata_path:
- file: config/Music.yml - file: config/Music.yml # This is a local file THAT YOU MIGHT CREATE
playlist_files: playlist_files:
- file: config/playlists.yml - pmm: playlist # This is a file within the defaults folder in the Repository
- pmm: playlist # This is a local PMM Default file. Usage Guide: https://metamanager.wiki/en/nightly/defaults/guide.html # see the wiki for how to use local files, folders, URLs, or files from git
settings: settings:
cache: true cache: true
cache_expiration: 60 cache_expiration: 60
@ -72,6 +72,7 @@ settings:
asset_folders: true asset_folders: true
asset_depth: 0 asset_depth: 0
create_asset_folders: false create_asset_folders: false
prioritize_assets: false
dimensional_asset_rename: false dimensional_asset_rename: false
download_url_assets: false download_url_assets: false
show_missing_season_assets: false show_missing_season_assets: false
@ -90,40 +91,47 @@ settings:
show_options: false show_options: false
show_missing: true show_missing: true
show_missing_assets: true show_missing_assets: true
save_report: true save_report: false
tvdb_language: eng tvdb_language: eng
ignore_ids: ignore_ids:
ignore_imdb_ids: ignore_imdb_ids:
item_refresh_delay: 0 item_refresh_delay: 0
playlist_sync_to_users: all playlist_sync_to_user: all
playlist_report: false
verify_ssl: true verify_ssl: true
webhooks: custom_repo:
check_nightly: false
webhooks: # Can be individually specified per library as well
error: error:
version:
run_start: run_start:
run_end: run_end:
changes: changes:
version: plex: # Can be individually specified per library as well; REQUIRED for the script to run
plex:
url: http://192.168.1.12:32400 url: http://192.168.1.12:32400
token: #################### token: ####################
timeout: 60 timeout: 60
clean_bundles: false clean_bundles: false
empty_trash: false empty_trash: false
optimize: false optimize: false
tmdb: tmdb: # REQUIRED for the script to run
apikey: ################################ apikey: ################################
language: en language: en
tautulli: tautulli: # Can be individually specified per library as well
url: http://192.168.1.12:8181 url: http://192.168.1.12:8181
apikey: ################################ apikey: ################################
omdb: omdb:
apikey: ######## apikey: ########
cache_expiration: 60
mdblist:
apikey: #########################
cache_expiration: 60
notifiarr: notifiarr:
apikey: #################################### apikey: ####################################
anidb: anidb: # Not required for AniDB builders unless you want mature content
username: ###### username: ######
password: ###### password: ######
radarr: radarr: # Can be individually specified per library as well
url: http://192.168.1.12:7878 url: http://192.168.1.12:7878
token: ################################ token: ################################
add_missing: false add_missing: false
@ -136,7 +144,7 @@ radarr:
search: false search: false
radarr_path: radarr_path:
plex_path: plex_path:
sonarr: sonarr: # Can be individually specified per library as well
url: http://192.168.1.12:8989 url: http://192.168.1.12:8989
token: ################################ token: ################################
add_missing: false add_missing: false
@ -155,6 +163,7 @@ sonarr:
trakt: trakt:
client_id: ################################################################ client_id: ################################################################
client_secret: ################################################################ client_secret: ################################################################
pin:
authorization: authorization:
# everything below is autofilled by the script # everything below is autofilled by the script
access_token: access_token: