You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Plex-Meta-Manager/docs/config/overview.md

47 lines
3.6 KiB

# Config File
8 months ago
Kometa uses a YAML configuration file; this file contains settings that determine how Kometa behaves, and the required
connection details needed to connect to Plex Media Server, Radarr, Sonarr, and other third-party services via API.
8 months ago
By default, and unless otherwise stated, Kometa looks for the configuration file at `/config/config.yml`.
A template Configuration Template File can be found in the
8 months ago
[GitHub Repo](https://github.com/Kometa-Team/Kometa/blob/master/config/config.yml.template).
If Kometa cannot find the `config.yml` at the default location, it will attempt to rename `config.yml.template` for the user. If the template file cannot be found, Kometa will attempt to download a copy from the GitHub repository in line with the user's current branch. If this also fails, the user will have to download the Configuration Template File from the above link and manually rename it to `config.yml`
8 months ago
This table outlines the third-party services that Kometa can make use of. Each service has specific
requirements for setup that can be found by clicking the links within the table or in the sidebar.
| Attribute | Required |
|:--------------------------------------------|:----------------------------------------------------------------------|
| [`libraries`](libraries.md) | :fontawesome-solid-circle-check:{ .green } |
| [`playlist_files`](../notused/playlists.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`settings`](settings.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`webhooks`](webhooks.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`plex`](plex.md) | :fontawesome-solid-circle-check:{ .green } Either here or per library |
| [`tmdb`](tmdb.md) | :fontawesome-solid-circle-check:{ .green } |
| [`tautulli`](tautulli.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`github`](github.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`omdb`](omdb.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`mdblist`](mdblist.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`notifiarr`](notifiarr.md) | :fontawesome-solid-circle-xmark:{ .red } |
12 months ago
| [`gotify`](gotify.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`anidb`](anidb.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`radarr`](radarr.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`sonarr`](sonarr.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`trakt`](trakt.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`mal`](myanimelist.md) | :fontawesome-solid-circle-xmark:{ .red } |
## Configuration Template File Example
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.
~~~yaml
{%
include-markdown "../../config/config.yml.template"
comments=false
%}
~~~