Generally, you should use the official docker image:
kometateam/kometa
All the examples in the wiki are assuming the use of this image, and many do not work with non-official
Docker images due to differences in how the authors have chosen to construct their images.
Generally speaking, we suggest you use the official image instead of these alternates, unless you have a specific reason to use one of these over the official.
We do not provide support for issues which specifically relate to using third-party images [LSIO or other].
One alternate image we see a lot is the Linuxserver image, due to its prominent placement in unRAID and linuxserver's general reputation.
The first image offered in unRAID for Kometa is the Linuxserver.io image [linuxserver/kometa]
This image is different to the official image [kometateam/kometa] in a couple ways that could cause issues for users who follow our installation guides.
If you use the LSIO image you should be aware of the following.
The LSIO image:
Advises and provides examples of absolute paths in the config, for example /config/Movies.yml and not
config/Movies.yml, however, relative paths should still work as expected.
Resets ownership of entire /config dir on startup based on the values of the PUID/PGID environment variables.
If not set, the ownership of the /config dir and its contents is set to 911:911, which can cause permissions issues.
Generally speaking, we suggest you use the official image instead of LSIO. We do not provide support for issues which relate to using third-party images [LSIO or other].
There are 8 other images listed at dockerhub aside from the official image and linuxserver. None of them discuss how they are different beyond one noting it includes curl.
Unless you have some compelling reason to use one of those, you shouldn't. You should stick with the official image.
If you choose to use another image than the default, you should be prepared for the possibility that published examples fail in various ways.
These services do not store season or episode-level ratings, using these options will allow show ratings to be
applied at the season or episode level.
YAML Lists Explained
YAML supports different ways to define lists. Below are some common methods:
1. List Within a Mapping
fruits:
- apple
- banana
- cherry
2. Inline Style
fruits: [ apple, banana, cherry ]
Each style can be used depending on your needs. The block style is typically more readable for longer lists,
while the inline style is compact and useful for short lists.
YAML Dictionaries Explained
Dictionaries are used to associate key/value pairs that are unordered. Dictionaries can be nested by increasing
the indentation,
or new dictionaries can be created at the same level by resolving the previous one.
cache: true cache_expiration: 60
The "keys" are cache and cache_expiration and the "values" are true and
60 respectively.
You can use multiple score filters but the number will have to match every filter. All unrated items are considered
to have a 0 rating.
These filters only work if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL) or to an account's Reviews (i.e. it should have
/USERNAME/films/reviews/ in the URL).
This filter only works if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL).
When title is not provided and the mapping name was not specified as an ID, the default behaviour is to
use the mapping name as title for matching.
When mapping_id is not provided and the mapping name was specified as an ID, the default behaviour is
to use the mapping name as mapping_id for matching.
When the server does not have a Plex Pass then the Edition Field is not accessible. In this scenario, Kometa will
check the movie's filepath for {edition-...} to determine what the edition is.
Requires Plex Pass.
Must be using the New Plex Movie Agent or the New Plex TV Agent.
Each default has a key that when calling to effect a specific collection/overlay you must replace
<<key>> with when calling.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
Also is a Tag Filter and can use all of those modifiers.
Requires Template Variables to function
Designed to use the TRaSH Guides filename naming scheme
Editions overlay is designed to use the Editions field within Plex (which requires Plex Pass to use) or the TRaSH Guides filename naming scheme
Designed to use the TRaSH Guides filename naming scheme
While these overlays can technically be applied at this level, they were not designed for it. For example, a show's
season cannot have a resolution since it is not a video file, and an episode cannot have a Common Sense rating since
only Movies and Shows are rated by Common Sense.