Plex-Meta-Manager/docs/config/overview.md

44 lines
3.1 KiB
Markdown
Raw Normal View History

2023-12-31 16:45:00 +00:00
# Config File
2024-04-22 14:20:12 +00:00
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.
2023-12-31 16:45:00 +00:00
2024-04-22 14:20:12 +00:00
By default, and unless otherwise stated, Kometa looks for the configuration file at `/config/config.yml`.
2023-12-31 16:45:00 +00:00
A template Configuration File can be found in the
2024-04-22 14:20:12 +00:00
[GitHub Repo](https://github.com/Kometa-Team/Kometa/blob/master/config/config.yml.template).
2023-12-31 16:45:00 +00:00
2024-04-22 14:20:12 +00:00
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.
2023-12-31 16:45:00 +00:00
| 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 } |
2023-12-31 16:45:00 +00:00
| [`omdb`](omdb.md) | :fontawesome-solid-circle-xmark:{ .red } |
| [`mdblist`](mdblist.md) | :fontawesome-solid-circle-xmark:{ .red } |
2023-12-31 16:45:00 +00:00
| [`notifiarr`](notifiarr.md) | :fontawesome-solid-circle-xmark:{ .red } |
2024-01-18 00:23:06 +00:00
| [`gotify`](gotify.md) | :fontawesome-solid-circle-xmark:{ .red } |
2023-12-31 16:45:00 +00:00
| [`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 File Example
This example outlines what a "standard" config.yml file might look like when in use.
~~~yaml
{%
include-markdown "../../config/config.yml.template"
comments=false
%}
~~~