Allow Plex Meta Manager to create and maintain a local cache database for faster subsequent processing. The cache file is created in the same directory as the configuration file.

**Attribute:** `cache` **Levels with this Attribute:** Global **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: cache: true ``` ??? blank "`cache_expiration` - Used to control how long data is cached for.¶"

Set the number of days before each cache mapping expires and has to be re-cached.

**Attribute:** `cache_expiration` **Levels with this Attribute:** Global **Accepted Values:** Integer greater than 0 **Default Value:** `60` ???+ example "Example" ```yaml settings: cache_expiration: 30 ``` ??? blank "`asset_directory` - Used to define where local assets are located.¶"

Specify the directories where assets (posters, backgrounds, etc) are located. ???+ tip Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container).

**Attribute:** `asset_directory` **Levels with this Attribute:** Global/Library **Accepted Values:** Any Directory or List of Directories **Default Value:** `[Directory containing YAML config]/assets` ???+ example "Example" ```yaml settings: asset_directory: config/movies ``` ```yaml settings: asset_directory: - config/assets/movies - config/assets/collections ``` ??? blank "`asset_folders` - Used to control the asset directory folder structure.¶"

While `true`, PMM will search the `asset_directory` for a dedicated folder per item vs while false will look for an image. i.e. When `true` the example path would be `/Star Wars/poster.png` instead of `/Star Wars.png`.

**Attribute:** `asset_folders` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: asset_folders: true ``` ??? blank "`asset_depth` - Used to control the depth of search in the asset directory.¶"

Specify how many folder levels to scan for an item within the asset directory. At each asset level, PMM will look for either `medianame.ext` [such as Star Wars.png] or a dedicated folder containing `poster.ext`. i.e. `/Star Wars/poster.png` and `/Star Wars.png` are both asset depth 0, whilst `/Movies/Star Wars/poster.png` and `/Movies/Star Wars.png` are both asset level 1. ???+ tip `asset_folders` must be set to `true` for this to take effect. increasing the amount of levels to scan will reduce performance

**Attribute:** `asset_depth` **Levels with this Attribute:** Global/Library **Accepted Values:** Any Integer 0 or greater **Default Value:** `0` ???+ example "Example" ```yaml settings: asset_depth: 2 ``` ??? blank "`create_asset_folders` - Used to automatically create asset folders when none exist.¶"

Whilst searching for assets, if an asset folder cannot be found within the `asset_directory` one will be created. Asset Searches can happen in a number of ways. * Any Collection specified under the `collections` header in a Collection File. * Any Item specified under the `metadata` header in a Collection File. * Any Playlist specified under the `playlists` header in a Playlist File. * Any Item in a library that is running the `assets_for_all` Library Operation. * Any Item that has an Overlay applied to it. * Any Item found by a Builder while the definition also has `item_assets: true` specified.

**Attribute:** `create_asset_folders` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: create_asset_folders: true ``` ??? blank "`prioritize_assets` - Used to prioritize `asset_directory` images over all other images types.¶"

When determining which image to use on an item prioritize the `asset_directory` over all other images types.

**Attribute:** `prioritize_assets` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: prioritize_assets: true ``` ??? blank "`dimensional_asset_rename` - Used to automatically rename asset files based on their dimensions.¶"

Whilst searching for assets, scan the folders within the `asset_directory` and if an asset poster (i.e. `/ASSET_NAME/poster.ext`) was not found, rename the first image found that has a height greater than or equal to its width to `poster.ext`. If an asset background (i.e. `/ASSET_NAME/background.ext`), rename the first image found that has a width greater than its height to `background.ext`. ???+ tip `asset_folders` must be set to `true` for this to take effect.

**Attribute:** `dimensional_asset_rename` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: dimensional_asset_rename: true ``` ??? blank "`download_url_assets` - Used to download url images into the asset directory.¶"

Whilst searching for assets, download images set within Collection/Metadata/Playlist files( i.e. images set by `url_poster` or `url_background`) into the asset folder if none are already present.

**Attribute:** `download_url_assets` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: download_url_assets: true ``` ??? blank "`show_missing_season_assets` - Used to show any missing season assets.¶"

Whilst searching for assets, when scanning for assets for a TV Show, if Season posters are found (i.e. `/ASSET_NAME/Season##.ext`), notify the user of any seasons which do not have an asset image. ???+ tip "Shows/Hides messages like these for seasons/albums" "Asset Warning: No poster found for '{item_title}' in the assets folder '{directory}'" "Asset Warning: No poster '{name}' found in the assets folders" "Missing Season {season_number} Poster"

**Attribute:** `show_missing_season_assets` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: show_missing_season_assets: true ``` ??? blank "`show_missing_episode_assets` - Used to show any missing episode assets.¶"

Whilst searching for assets, when scanning for assets for a TV Show, if an Episode Title Card is found (i.e. `/ASSET_NAME/S##E##.ext`), notify the user of any episodes which do not have an asset image. ???+ tip "Shows/Hides messages like these for episodes" "Asset Warning: No poster found for '{item_title}' in the assets folder '{directory}'" "Asset Warning: No poster '{name}' found in the assets folders" "\nMissing S##E## Title Card"

**Attribute:** `show_missing_episode_assets` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: show_missing_episode_assets: true ``` ??? blank "`show_asset_not_needed` - Used to show/hide the `update not needed` messages.¶"

Whilst searching for assets, show or hide the `update not needed` messages.

**Attribute:** `show_asset_not_needed` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: show_asset_not_needed: true ``` ??? blank "`sync_mode` - Used to set the `sync_mode` for collections and playlists.¶"

Sets the `sync_mode` for collections and playlists. Setting the `sync_mode` directly in a collection or playlist definition will override the `sync_mode` for that definition.

**Attribute:** `sync_mode` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:**

`sync`	Will add and remove any items that are added/removed from the source builder.
`append`	Will only add items that are added from the source builder, but will not remove anything even if it is removed from the source builder.

**Default Value:** `append` ???+ example "Example" ```yaml settings: sync_mode: sync ``` ??? blank "`default_collection_order` - Used to set the `collection_order` for every collection run.¶"

Set the `collection_order` for every collection run by PMM unless the collection has a specific `collection_order`. ???+ tip `custom` cannot be used if more than one builder is being used for the collection (such as `imdb_list` and `trakt_list` within the same collection).

**Attribute:** `default_collection_order` **Levels with this Attribute:** Global/Library **Accepted Values:**

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
[Any `plex_search` sort option](../files/builders/plex.md#sort-options)

**Default Value:** `None` ???+ example "Example" ```yaml settings: default_collection_order: release ``` ??? blank "`minimum_items` - Used to control minimum items requires to build a collection/playlist.¶"

Set the minimum number of items that must be found in order to build or update a collection/playlist.

**Attribute:** `minimum_items` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** Integer greater than 0 **Default Value:** `1` ???+ example "Example" ```yaml settings: minimum_items: 5 ``` ??? blank "`delete_below_minimum` - Used to delete collections below `minimum_items`¶"

When a collection is run, delete the collection if it is below the minimum number specified by `minimum_items`. ???+ tip Relies on `minimum_items` being set to the desired integer.

**Attribute:** `delete_below_minimum` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: delete_below_minimum: true ``` ??? blank "`delete_not_scheduled` - Used to delete collections not scheduled.¶"

If a collection is skipped due to it not being scheduled, delete the collection.

**Attribute:** `delete_not_scheduled` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: settings: delete_not_scheduled: true ``` ??? blank "`run_again_delay` - Used to control the number of minutes to delay running `run_again` collections.¶"

Set the number of minutes to delay running `run_again` collections after daily run is finished. For example, if a collection adds items to Sonarr/Radarr, the library can automatically re-run "X" amount of time later so that any downloaded items are processed. ???+ tip A collection is a `run_again` collection if it has the `run_again` [Setting](../files/settings.md) attribute set to true.

**Attribute:** `run_again_delay` **Levels with this Attribute:** Global **Accepted Values:** Any Integer 0 or greater **Default Value:** `0` ???+ example "Example" ```yaml settings: run_again_delay: 5 ``` ??? blank "`missing_only_released` - Used to filter unreleased items from missing lists.¶"

Whilst running a collection or playlist, when PMM handles missing items to either report it to the user, report it to a file, or send it to Radarr/Sonarr all unreleased items will be filtered out.

**Attribute:** `missing_only_released` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: missing_only_released: true ``` ??? blank "`show_unmanaged` - Used to show collections not managed by PMM.¶"

List all collections not managed by Plex Meta Manager at the end of each run.

**Attribute:** `show_unmanaged` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: show_unmanaged: false ``` ??? blank "`show_unconfigured` - Used to show collections not in the current run.¶"

List all collections not configured in the current Plex Meta Manager run at the end of each run.

**Attribute:** `show_unconfigured` **Levels with this Attribute:** Global/Library **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: show_unconfigured: false ``` ??? blank "`show_filtered` - Used to show filtered items.¶"

List all items which have been filtered out of a collection or playlist (i.e. if it doesn't meet the filter criteria)

**Attribute:** `show_filtered` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: show_filtered: true ``` ??? blank "`show_options` - Used to show attribute options from plex.¶"

While `show_options` is true the available options for an attribute when using `plex_search`, `smart_filter` or `filters` will be shown. i.e. a `smart_filter` on the `genre` attribute will return all of the attributes within the specified library.

**Attribute:** `show_options` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: show_options: true ``` ??? blank "`show_missing` - Used to show missing items from collections or playlists.¶"

While `show_missing` is true items missing from collections or playlists will be displayed.

**Attribute:** `show_missing` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: show_missing: false ``` ??? blank "`only_filter_missing` - Used to have the `filter` only apply to missing items.¶"

Only items missing from a collection will be filtered. **Only specific filters can filter missing. See [Filters](../files/filters.md) for more information.** ???+ note This can be used to filter which missing media items get sent to Sonarr/Radarr.

**Attribute:** `only_filter_missing` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: only_filter_missing: true ``` ??? blank "`show_missing_assets` - Used to print a message when assets are missing.¶"

Display missing asset warnings for items, collections, and playlists.

**Attribute:** `show_missing_assets` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: show_missing_assets: false ``` ??? blank "`save_report` - Used to save a report YAML file.¶"

Save a report of the items added, removed, filtered, or missing from collections to a YAML file in the same directory as the file run.

**Attribute:** `save_report` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: save_report: false ``` ??? blank "`report_path` - Used to specify the location of `save_report`.¶"

Specify the location where `save_report` is saved.

**Attribute:** `report_path` **Levels with this Attribute:** Library **Accepted Values:** YAML file path location **Default Value:** `[Directory containing YAML config]/[Library Mapping Name]_report.yml` ???+ example "Example" ```yaml settings: report_path: config/TV_missing_report.yml ``` ??? blank "`tvdb_language` - Specify the language to query TVDb in.¶"

Specify the language to query TVDb in. ???+ note If no language is specified or the specified language is not found then the original language is used.

**Attribute:** `tvdb_language` **Levels with this Attribute:** Global **Accepted Values:** [Any ISO 639-2 Language Code](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) **Default Value:** `None` ???+ example "Example" ```yaml settings: tvdb_language: en ``` ??? blank "`ignore_ids` - List of TMDb/TVDb IDs to ignore.¶"

Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections. ???+ note This does not apply to `smart_filter` Collections.

**Attribute:** `ignore_ids` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** List or comma-separated string of TMDb/TVDb IDs **Default Value:** `None` ???+ example "Example" ```yaml settings: ignore_ids: 572802,695721 ``` ??? blank "`ignore_imdb_ids` - List of IMDb IDs to ignore.¶"

Set a list or comma-separated string of IMDb IDs to ignore in all collections. ???+ note Rhis does not apply to `smart_filter` Collections.

**Attribute:** `ignore_imdb_ids` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** List or comma-separated string of IMDb IDs **Default Value:** `None` ???+ example "Example" ```yaml settings: ignore_imdb_ids: tt6710474,tt1630029 ``` ??? blank "`item_refresh_delay` - Time to wait between each `item_refresh`.¶"

Specify the amount of time to wait between each `item_refresh` of every movie/show in a collection/playlist. ???+ note Useful if your Plex Media Server is having issues with high request levels.

**Attribute:** `item_refresh_delay` **Levels with this Attribute:** Global/Library/Collection/Playlist **Accepted Values:** Any Integer 0 or greater **Default Value:** `0` ???+ example "Example" ```yaml settings: item_refresh_delay: 5 ``` ??? blank "`playlist_sync_to_users` - Set the default playlist `sync_to_users`.¶"

Set the default playlist `sync_to_users`. To Sync a playlist to only yourself leave `playlist_sync_to_users` blank. ???+ note sharing playlists with other users will not share any posters associated with the playlist, this is a Plex limitation.

**Attribute:** `playlist_sync_to_users` **Levels with this Attribute:** Global/Playlist **Accepted Values:** `all`, list of users, or comma-separated string of users **Default Value:** `all` ???+ example "Example" ```yaml settings: playlist_sync_to_users: - user1 - user2 ``` ??? blank "`playlist_exclude_users` - Set the default playlist `exclude_users`.¶"

Set the default playlist `exclude_users`.

**Attribute:** `playlist_exclude_users` **Levels with this Attribute:** Global/Playlist **Accepted Values:** list of users or comma-separated string of users **Default Value:** `None` ???+ example "Example" ```yaml settings: playlist_exclude_users: - user1 - user2 ``` ??? blank "`playlist_report` - Used to print out a playlist report.¶"

Set `playlist_report` to true to print out a playlist report at the end of the log.

**Attribute:** `playlist_report` **Levels with this Attribute:** Global **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: playlist_report: true ``` ??? blank "`run_order` - Used to specify the run order of the library components.¶"

Specify the run order of the library components [Library Operations, Collection Files and Overlay Files]

**Attribute:** `run_order` **Levels with this Attribute:** Global/Library **Accepted Values:** List or comma-separated string which must include `operations`, `metadata` and `overlays` in any order **Default Value:** `operations,metadata,collections,overlays` ???+ example "Example" ```yaml settings: run_order: - collections - overlays - operations - metadata ``` ??? blank "`custom_repo` - Used to set up the custom `repo` [file block type](files.md#location-types-and-paths).¶"

Specify where the `repo` attribute's base is when defining `collection_files`, `metadata_files`, `playlist_file` and `overlay_files`. ???+ note Ensure you are using the raw GitHub link (i.e. https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12 )

**Attribute:** `custom_repo` **Levels with this Attribute:** Global **Accepted Values:** Link to repository base **Default Value:** `None` ???+ example "Example" ```yaml settings: custom_repo: https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12 ``` ??? blank "`verify_ssl` - Turn SSL Verification on or off.¶"

Turn SSL Verification on or off. ???+ note set to false if your log file shows any errors similar to "SSL: CERTIFICATE_VERIFY_FAILED"

**Attribute:** `verify_ssl` **Levels with this Attribute:** Global **Accepted Values:** `true` or `false` **Default Value:** `true` ???+ example "Example" ```yaml settings: verify_ssl: false ``` ??? blank "`check_nightly` - Will check nightly for updates instead of develop.¶"

Will check nightly for updates instead of develop. ???+ note This does not affect which version of PMM is grabbed when using `git pull` or any other update mechanism, it is only used for the initial version check when PMM runs to specify if a new version is available. It is recommended to set this to `true` if you primarily use the `nightly` branch

**Attribute:** `check_nightly` **Levels with this Attribute:** Global **Accepted Values:** `true` or `false` **Default Value:** `false` ???+ example "Example" ```yaml settings: check_nightly: true ``` ## Default Values The below in an extract of the `config.yml.template` and is the initial values that are set if you follow any of the installation guides. ???+ tip We suggest users review each of these settings and amend as necessary, these are just default values to get you started. ~~~yaml settings: {% include-markdown "../../config/config.yml.template" comments=false preserve-includer-indent=false start="settings:" end="webhooks:" %} ~~~ ## Example Library-Level Settings The below showcases how to set a library-level setting, assuming that the attribute is listed as a library-level compatible attribute in the above table. If no library-level attribute is set, then the global attribute is used. ???+ tip Press the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: Movies: run_order: #(1)! - collections - metadata - operations - overlays minimum_items: 3 #(2)! collection_files: # stuff here overlay_files: # stuff here operations: # stuff here TV Shows: collection_files: # stuff here overlay_files: # stuff here operations: # stuff here settings: run_order: #(3)! - operations - overlays - collections - metadata minimum_items: 1 #(4)! ``` 1. Sets the `run_order` specifically for the Movies library 2. Sets the `minimum_items` attribute specifically for the Movies library 3. Sets the global `run_order` which will apply to all libraries unless a library-level `run_order` is found, as showcased in the above example 4. Sets the global `minimum_items` which will apply to all libraries unless a library-level `minimum_items` is found, as showcased in the above example