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