Shared Collection Variables¶

These variables are shared by the default collection files. File-specific variables are documented on each Defaults page.

Shared Template Variables

File paths need to be valid in the context where Kometa is running; this is primarily an issue when running in docker, as Kometa inside the container cannot see host paths.

Variable Description Values

collection_mode

Controls the collection mode of all collections in a Defaults File.

`default`	Library default
`hide`	Hide Collection
`hide_items`	Hide Items in this Collection
`show_items`	Show this Collection and its Items

collection_section Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros "05") Any number

delete_collections_named Used to delete any collections in your plex named one of the given collections. List of Collection Names to delete

file_background_<<key>> Sets the background filepath of the key's collection. Filepath directly to the Image

file_background Sets the background filepath for all collections. Filepath directly to the Image

file_logo_<<key>> Sets the logo filepath of the key's collection. Filepath directly to the Image

file_logo Sets the logo filepath for all collections. Filepath directly to the Image

file_poster_<<key>> Sets the poster filepath of the key's collection. Filepath directly to the Image

file_poster Sets the poster filepath for all collections. Filepath directly to the Image

file_square_art_<<key>> Sets the square art filepath of the key's collection. Filepath directly to the Image

file_square_art Sets the square art filepath for all collections. Filepath directly to the Image

ignore_ids Set a List or comma-separated string of TMDb/TVDb IDs to ignore in all collections. List or comma-separated string of TMDb/TVDb IDs

ignore_imdb_ids Set a List or comma-separated string of IMDb IDs to ignore in all collections. List or comma-separated string of IMDb IDs

hub_priority_<<key>> Sets the position priority for the key's collection's Recommendation Hub row. Default: hub_priority
Integer greater than 0

hub_priority Sets the position priority for all collections in a Defaults File. Collections with hub_priority are sorted to the front of the hub list (lowest number first) before any auto_sort_hubs ordering is applied. Requires the collection to be promoted to a hub via visible_library, visible_home, or visible_shared (Plex Pass Required). If omitted, normal hub sorting is used. Integer greater than 0

item_radarr_tag_<<key>> Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the key's collection. Default: item_radarr_tag
List or comma-separated string of tags

item_radarr_tag Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults File. List or comma-separated string of tags

item_sonarr_tag_<<key>> Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the key's collection. Default: item_sonarr_tag
List or comma-separated string of tags

item_sonarr_tag Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults File. List or comma-separated string of tags

language Set the language of Collection Names and Summaries Default: default
default (English), fr (French), or de (German)

minimum_items_<<key>> Set the number of minimum items for a collection to be created for the key's collection. Any number greater than 0

minimum_items Set the number of minimum items for a collection to be created for all collections. Any number greater than 0

name_<<key>> Changes the name of the key's collection. New Collection Name

name_mapping Changes the name_mapping of all collections. Default: <<title>>
Any String with <<key_name>> in it.

order_<<key>> Controls the sort order of the collections in their collection section. Any number

radarr_add_missing Override Radarr add_missing attribute for all collections in a Defaults File. true or false

radarr_add_missing_<<key>> Override Radarr add_missing attribute of the key's collection. Default: radarr_add_missing
true or false

radarr_folder Override Radarr root_folder_path attribute for all collections in a Defaults File. Folder Path

radarr_folder_<<key>> Override Radarr root_folder_path attribute of the key's collection. Default: radarr_folder
Folder Path

radarr_monitor_existing Override Radarr monitor_existing attribute for all collections in a Defaults File. true or false

radarr_monitor_existing_<<key>> Override Radarr monitor_existing attribute of the key's collection. true or false

radarr_search Override Radarr search attribute or all collections in a Defaults File. true or false

radarr_search_<<key>> Override Radarr search attribute of the key's collection. Default: radarr_search
true or false

radarr_tag Override Radarr tag attribute for all collections in a Defaults File. List or comma-separated string of tags

radarr_tag_<<key>> Override Radarr tag attribute of the key's collection. Default: radarr_tag
List or comma-separated string of tags

radarr_upgrade_existing Override Radarr upgrade_existing attribute for all collections in a Defaults File. true or false

radarr_upgrade_existing_<<key>> Override Radarr upgrade_existing attribute of the key's collection. true or false

schedule_<<key>> Set the schedule for a specific key's collection. Any Scheduling Option

schedule Set the schedule for all of the collections in a Defaults File. Any Scheduling Option

sonarr_add_missing_<<key>> Override Sonarr add_missing attribute of the key's collection. Default: sonarr_add_missing
true or false

sonarr_add_missing Override Sonarr add_missing attribute for all collections in a Defaults File. true or false

sonarr_folder_<<key>> Override Sonarr root_folder_path attribute of the key's collection. Default: sonarr_folder
Folder Path

sonarr_folder Override Sonarr root_folder_path attribute for all collections in a Defaults File. Folder Path

sonarr_monitor_existing_<<key>> Override Sonarr monitor_existing attribute of the key's collection. true or false

sonarr_monitor_existing Override Sonarr monitor_existing attribute for all collections in a Defaults File. true or false

sonarr_search_<<key>> Override Sonarr search attribute of the key's collection. Default: sonarr_search
true or false

sonarr_search Override Sonarr search attribute or all collections in a Defaults File. true or false

sonarr_tag_<<key>> Override Sonarr tag attribute of the key's collection. Default: sonarr_tag
List or comma-separated string of tags

sonarr_tag Override Sonarr tag attribute for all collections in a Defaults File. List or comma-separated string of tags

sonarr_upgrade_existing_<<key>> Override Sonarr upgrade_existing attribute of the key's collection. true or false

sonarr_upgrade_existing Override Sonarr upgrade_existing attribute for all collections in a Defaults File. true or false

sort_prefix Changes the prefix of the sort title. Default: !
Any String

sort_title Changes the sort title of all collections. Default: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>
Any String

summary_<<key>> Changes the summary of the key's collection. New Collection Summary

url_background_<<key>> Sets the background url of the key's collection. URL directly to the Image

url_background Sets the background url for all collections. URL directly to the Image

url_logo_<<key>> Sets the logo url of the key's collection. URL directly to the Image

url_logo Sets the logo url for all collections. URL directly to the Image

url_poster_<<key>> Changes the poster url of the key's collection. URL directly to the Image

url_poster Changes the poster url for all collections. URL directly to the Image

url_square_art_<<key>> Sets the square url of the key's collection. URL directly to the Image

url_square_art Sets the square url for all collections. URL directly to the Image

use_<<key>> Turns off individual Collections in a Defaults File. false to turn off the collection

use_all Turns off all Collections in a Defaults File. false to turn off the collection

visible_home_<<key>>

Controls visible on Home Tab of the key's collection. (Only works with Plex Pass)

Default: visible_home

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_home

Controls visible on Home Tab for all collections in a Defaults File. (Only works with Plex Pass)

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_library_<<key>>

Controls visible on Library Recommended Tab of the key's collection. (Only works with Plex Pass)

Default: visible_library

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_library

Controls visible on Library Recommended Tab for all collections in a Defaults File. (Only works with Plex Pass)

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_shared_<<key>>

Controls visible on Shared Users' Home Tab of the key's collection. (Only works with Plex Pass)

Default: visible_shared

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_shared

Controls visible on Shared Users' Home Tab for all collections in a Defaults File. (Only works with Plex Pass)

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

Shared Separator Variables

Variable Description Values

collection_mode

Controls the collection mode of all collections in a Defaults File.

`default`	Library default
`hide`	Hide Collection
`hide_items`	Hide Items in this Collection
`show_items`	Show this Collection and its Items

collection_section Changes the sort order of the collection sections against other default collection sections. Any number

name_separator Changes the name of the key's collection. New Collection Name

placeholder_imdb_id Add a placeholder Movie/Show to the Separator. Valid for Movie or Show libraries assuming the ID points to an item of the correct type. IMDb ID

placeholder_tmdb_movie Add a placeholder Movie to the Separator. Only valid for Movie libraries. TMDb Movie ID

placeholder_tvdb_show Add a placeholder Show to the Separator. Only valid for Show libraries. TVDb Show ID

sep_style Choose the Separator Style. Default: orig
amethyst, aqua, blue, forest, fuchsia, gold, gray, green, navy, ocean, olive, orchid, orig, pink, plum, purple, red, rust, salmon, sand, stb, or tan

sort_prefix Changes the prefix of the sort title. Default: !
Any String

sort_title Changes the sort title of all collections. Default: <<sort_prefix>><<collection_section>>_!<<title>>
Any String

summary_separator Changes the summary of the key's collection. New Collection Summary

url_poster_separator Changes the poster url of the key's collection. URL directly to the Image

use_separator Turn the Separator Collection off. false to turn of the collection

Shared Collection Variables¶

YAML Lists Explained

1. List Within a Mapping

2. Inline Style

YAML Dictionaries Explained