Kometa config file
Kometa (formerly Plex Meta Manager or PMM) configuration file for stable versions
Validate with Lintel
npx @lintel/lintel checkProperties
Describes the primary Plex server to which Kometa can connect. This attribute is REQUIRED. It can be overridden at the library level.
8 nested properties
URL at which Kometa can connect to your plex server. NOT app.plex.tv
Admin token for this Plex server
Connection timeout in seconds for this Plex server
Sets DB Cache value for this Plex server in MB
true/false - If 'true', cleans metadata bundles on this Plex server
true/false - If 'true', empties trash on this Plex server
true/false - If 'true', optimizes database on this Plex server
Turn SSL Verification on or off for only Plex.
API Information to connect to TMDb; REQUIRED for the script to run
4 nested properties
API Key to connect to TMDb; REQUIRED for the script to run
This field can be either null or a valid ISO 639 language code.
This field can be either null or a valid ISO 3166-1 Code.
An integer greater than 0 in days
2 nested properties
6 nested properties
2 nested properties
An integer greater than 0 in days
2 nested properties
An integer greater than 0 in days
1 nested properties
2 nested properties
3 nested properties
3 nested properties
This field can be either null or a valid ISO 639 language code.
An integer greater than 0 in days
Enable access to mature/restricted content
18 nested properties
Ensures all existing shows in collections match your monitor setting. Use the sonarr_monitor_existing Sonarr Setting in the collection definition to match the monitor setting per collection.
15 nested properties
40 nested properties
Used to control Kometa's cache database. Allow Kometa 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.
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. An integer greater than 0 in days
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]
Used to define where local assets are located. Specify the directories where assets (posters, backgrounds, etc) are located.
Used to control the asset directory folder structure. While true, Kometa will search the asset_directory for a dedicated folder per item vs while false will look for an image.
Used to control the depth of search in the asset directory. At each asset level, Kometa will look for either medianame.ext [such as Star Wars.png] or a dedicated folder containing poster.ext. i.e. <path_to_assets>/Star Wars/poster.png and <path_to_assets>/Star Wars.png are both asset depth 0, whilst <path_to_assets>/Movies/Star Wars/poster.png and <path_to_assets>/Movies/Star Wars.png are both asset level 1.
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.
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.
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.
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.
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.
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.
Used to show/hide the update not needed messages. Whilst searching for assets, show or hide the update not needed messages.
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.
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.
Used to set the collection_order for every collection run. Set the collection_order for every collection run by Kometa 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).
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.
Used to delete collections not scheduled. If a collection is skipped due to it not being scheduled, delete the collection.
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.
Used to filter unreleased items from missing lists. Whilst running a collection or playlist, when Kometa 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.
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 for more information.
Used to show collections not managed by Kometa. List all collections not managed by Kometa at the end of each run.
Used to show collections not in the current run. List all collections not configured in the current Kometa run at the end of each run.
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)
Used to show unfiltered items. List all items which make it through a filter into a collection or playlist (i.e. if it MEETS the filter criteria)
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.
Used to show missing items from collections or playlists. While show_missing is true items missing from collections or playlists will be displayed.
Used to print a message when assets are missing. Display missing asset warnings for items, collections, and playlists.
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.
Specify the language to query TVDb in. This field can be either null or a valid ISO 639-2 language code.
List of TMDb/TVDb IDs to ignore. Set a null, a single TMDb/TVDb ID, or a comma-separated string of TMDb/TVDb IDs to ignore in all collections.
List of IMDb IDs to ignore. Set a null, a single IMDb ID, or a comma-separated string of IMDb IDs to ignore in all collections.
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.
Set the default playlist sync_to_users. To Sync a playlist to only yourself, leave playlist_sync_to_users blank/null. Therefore, leaving it blank, 'all', a list of users, or a comma-separated string of users is accepted
Set the default playlist exclude_users. Provide a null value, a list of users, or a comma-separated string of users to be excluded in the playlist.
Used to print out a playlist report. Set playlist_report to true to print out a playlist report at the end of the log.
Turn SSL Verification on or off.
Used to set up the custom repo file block type. Specify where the repo attribute's base is when defining collection_files, metadata_files, playlist_file, and overlay_files.
Used to control the filetype used with overlay images.
Used to control the JPG or Lossy WEBP quality used with overlay images.
2 nested properties
3 nested properties
Definitions
Describes the primary Plex server to which Kometa can connect. This attribute is REQUIRED. It can be overridden at the library level.
URL at which Kometa can connect to your plex server. NOT app.plex.tv
Admin token for this Plex server
Connection timeout in seconds for this Plex server
Sets DB Cache value for this Plex server in MB
true/false - If 'true', cleans metadata bundles on this Plex server
true/false - If 'true', empties trash on this Plex server
true/false - If 'true', optimizes database on this Plex server
Turn SSL Verification on or off for only Plex.
Describes the Plex server where this library is found.
URL at which Kometa can connect to this plex server. NOT app.plex.tv
Admin token for this Plex server
Connection timeout in seconds for this Plex server
Sets DB Cache value for this Plex server in MB
true/false - If 'true', cleans metadata bundles on this Plex server
true/false - If 'true', empties trash on this Plex server
true/false - If 'true', optimizes database on this Plex server
API Information to connect to TMDb; REQUIRED for the script to run
API Key to connect to TMDb; REQUIRED for the script to run
This field can be either null or a valid ISO 639 language code.
This field can be either null or a valid ISO 3166-1 Code.
An integer greater than 0 in days
An integer greater than 0 in days
An integer greater than 0 in days
This field can be either null or a valid ISO 639 language code.
An integer greater than 0 in days
Enable access to mature/restricted content
Ensures all existing shows in collections match your monitor setting. Use the sonarr_monitor_existing Sonarr Setting in the collection definition to match the monitor setting per collection.
Ensures all existing shows in collections match your monitor setting. Use the sonarr_monitor_existing Sonarr Setting in the collection definition to match the monitor setting per collection.
Used to control Kometa's cache database. Allow Kometa 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.
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. An integer greater than 0 in days
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]
Used to define where local assets are located. Specify the directories where assets (posters, backgrounds, etc) are located.
Used to control the asset directory folder structure. While true, Kometa will search the asset_directory for a dedicated folder per item vs while false will look for an image.
Used to control the depth of search in the asset directory. At each asset level, Kometa will look for either medianame.ext [such as Star Wars.png] or a dedicated folder containing poster.ext. i.e. <path_to_assets>/Star Wars/poster.png and <path_to_assets>/Star Wars.png are both asset depth 0, whilst <path_to_assets>/Movies/Star Wars/poster.png and <path_to_assets>/Movies/Star Wars.png are both asset level 1.
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.
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.
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.
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.
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.
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.
Used to show/hide the update not needed messages. Whilst searching for assets, show or hide the update not needed messages.
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.
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.
Used to set the collection_order for every collection run. Set the collection_order for every collection run by Kometa 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).
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.
Used to delete collections not scheduled. If a collection is skipped due to it not being scheduled, delete the collection.
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.
Used to filter unreleased items from missing lists. Whilst running a collection or playlist, when Kometa 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.
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 for more information.
Used to show collections not managed by Kometa. List all collections not managed by Kometa at the end of each run.
Used to show collections not in the current run. List all collections not configured in the current Kometa run at the end of each run.
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)
Used to show unfiltered items. List all items which make it through a filter into a collection or playlist (i.e. if it MEETS the filter criteria)
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.
Used to show missing items from collections or playlists. While show_missing is true items missing from collections or playlists will be displayed.
Used to print a message when assets are missing. Display missing asset warnings for items, collections, and playlists.
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.
Specify the language to query TVDb in. This field can be either null or a valid ISO 639-2 language code.
List of TMDb/TVDb IDs to ignore. Set a null, a single TMDb/TVDb ID, or a comma-separated string of TMDb/TVDb IDs to ignore in all collections.
List of IMDb IDs to ignore. Set a null, a single IMDb ID, or a comma-separated string of IMDb IDs to ignore in all collections.
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.
Set the default playlist sync_to_users. To Sync a playlist to only yourself, leave playlist_sync_to_users blank/null. Therefore, leaving it blank, 'all', a list of users, or a comma-separated string of users is accepted
Set the default playlist exclude_users. Provide a null value, a list of users, or a comma-separated string of users to be excluded in the playlist.
Used to print out a playlist report. Set playlist_report to true to print out a playlist report at the end of the log.
Turn SSL Verification on or off.
Used to set up the custom repo file block type. Specify where the repo attribute's base is when defining collection_files, metadata_files, playlist_file, and overlay_files.
Used to control the filetype used with overlay images.
Used to control the JPG or Lossy WEBP quality used with overlay images.
2 nested properties
5 nested properties
2 nested properties
5 nested properties
94 nested properties
Toggles color styling for applicable overlays like content ratings.
Changes Streaming Service overlays to only apply to original content produced by the service. Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Choose the number of overlay this queue displays. Default: 3 Values: 1, 2, 3, 4, or 5
Choose the text after the 'nr' key for the Overlay. Values: Any String
Choose the text after the key for the Overlay. Default: + Values: Any String
Choose the text before the 'nr' key for the Overlay. Values: Any String
Choose the text before the key for the Overlay. Values: Any String
94 nested properties
Toggles color styling for applicable overlays like content ratings.
Changes Streaming Service overlays to only apply to original content produced by the service. Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Choose the number of overlay this queue displays. Default: 3 Values: 1, 2, 3, 4, or 5
Choose the text after the 'nr' key for the Overlay. Values: Any String
Choose the text after the key for the Overlay. Default: + Values: Any String
Choose the text before the 'nr' key for the Overlay. Values: Any String
Choose the text before the key for the Overlay. Values: Any String
2 nested properties
5 nested properties
94 nested properties
Toggles color styling for applicable overlays like content ratings.
Changes Streaming Service overlays to only apply to original content produced by the service. Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Choose the number of overlay this queue displays. Default: 3 Values: 1, 2, 3, 4, or 5
Choose the text after the 'nr' key for the Overlay. Values: Any String
Choose the text after the key for the Overlay. Default: + Values: Any String
Choose the text before the 'nr' key for the Overlay. Values: Any String
Choose the text before the key for the Overlay. Values: Any String
2 nested properties
5 nested properties
94 nested properties
Toggles color styling for applicable overlays like content ratings.
Changes Streaming Service overlays to only apply to original content produced by the service. Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Choose the number of overlay this queue displays. Default: 3 Values: 1, 2, 3, 4, or 5
Choose the text after the 'nr' key for the Overlay. Values: Any String
Choose the text after the key for the Overlay. Default: + Values: Any String
Choose the text before the 'nr' key for the Overlay. Values: Any String
Choose the text before the key for the Overlay. Values: Any String
2 nested properties
5 nested properties
94 nested properties
Toggles color styling for applicable overlays like content ratings.
Changes Streaming Service overlays to only apply to original content produced by the service. Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Choose the number of overlay this queue displays. Default: 3 Values: 1, 2, 3, 4, or 5
Choose the text after the 'nr' key for the Overlay. Values: Any String
Choose the text after the key for the Overlay. Default: + Values: Any String
Choose the text before the 'nr' key for the Overlay. Values: Any String
Choose the text before the key for the Overlay. Values: Any String
2 nested properties
5 nested properties
94 nested properties
Toggles color styling for applicable overlays like content ratings.
Changes Streaming Service overlays to only apply to original content produced by the service. Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Choose the number of overlay this queue displays. Default: 3 Values: 1, 2, 3, 4, or 5
Choose the text after the 'nr' key for the Overlay. Values: Any String
Choose the text after the key for the Overlay. Default: + Values: Any String
Choose the text before the 'nr' key for the Overlay. Values: Any String
Choose the text before the key for the Overlay. Values: Any String
6 nested properties
5 nested properties
4 nested properties
4 nested properties
Multiple styles are available for Separators, to match Plex's 'categories' feature.
Controls the collection mode of all collections in a Defaults file.
Set the language of Collection Names and Summaries that Kometa has been translated to with weblate
Add a placeholder Movie/Show to the Separator to ensure Plex sees a collection with 1 item because 0 item collections can be problematic for Plex. Valid for Movie or Show libraries assuming the ID points to an item of the correct type and that its in your library.
5 nested properties
Toggles color styling for applicable overlays like content ratings.
Changes Streaming Service overlays to only apply to original content produced by the service. Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Choose the number of overlay this queue displays. Default: 3 Values: 1, 2, 3, 4, or 5
Choose the text after the 'nr' key for the Overlay. Values: Any String
Choose the text after the key for the Overlay. Default: + Values: Any String
Choose the text before the 'nr' key for the Overlay. Values: Any String
Choose the text before the key for the Overlay. Values: Any String