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

# Config File

Plex Meta Manager uses a YAML configuration file; this file contains settings that determine how Plex Meta Manager behaves, and the required connection details needed to connect to Plex Media Server, Radarr, Sonarr, and other third-party services via API.

By default, and unless otherwise stated, Plex Meta Manager looks for the configuration file at `/config/config.yml`.

A template Configuration File can be found in the [GitHub Repo](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/config.yml.template).

This table outlines the third-party services that Plex Meta Manager can make use of. Each service has specific requirements for setup that can be found by clicking the links within the table.

| Attribute                     | Required                                |
|:------------------------------|:----------------------------------------|
| [`libraries`](libraries)      | &#9989;                                 |
| [`playlist_files`](playlists) | &#10060;                                |
| [`settings`](settings)        | &#10060;                                |
| [`webhooks`](webhooks)        | &#10060;                                |
| [`plex`](plex)                | &#9989; <br/>Either here or per library |
| [`tmdb`](tmdb)                | &#9989;                                 |
| [`tautulli`](tautulli)        | &#10060;                                |
| [`omdb`](omdb)                | &#10060;                                |
| [`notifiarr`](notifiarr)      | &#10060;                                |
| [`anidb`](anidb)              | &#10060;                                |
| [`radarr`](radarr)            | &#10060;                                |
| [`sonarr`](sonarr)            | &#10060;                                |
| [`trakt`](trakt)              | &#10060;                                |
| [`mal`](myanimelist)          | &#10060;                                |

## Configuration File Example

This example outlines what a "standard" config.yml file might look like when in use.

```{literalinclude} ../../config/config.yml.template
---
language: yaml
---
```
[171] wiki update 2022-10-29 15:59:01 +00:00			`# Config File`
[100] add docs 2022-03-08 08:06:22 +00:00
[109] fix templates 2022-05-20 07:06:08 +00:00			`Plex Meta Manager uses a YAML configuration file; this file contains settings that determine how Plex Meta Manager behaves, and the required connection details needed to connect to Plex Media Server, Radarr, Sonarr, and other third-party services via API.`
[100] add docs 2022-03-08 08:06:22 +00:00
[171] wiki update 2022-10-29 15:59:01 +00:00			By default, and unless otherwise stated, Plex Meta Manager looks for the configuration file at `/config/config.yml`.
[100] add docs 2022-03-08 08:06:22 +00:00
			`A template Configuration File can be found in the [GitHub Repo](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/config.yml.template).`

			`This table outlines the third-party services that Plex Meta Manager can make use of. Each service has specific requirements for setup that can be found by clicking the links within the table.`

[22] table alignment 2022-11-16 14:30:04 +00:00			`\| Attribute \| Required \|`
			`\|:------------------------------\|:----------------------------------------\|`
			\| [`libraries`](libraries) \| ✅ \|
			\| [`playlist_files`](playlists) \| ❌ \|
			\| [`settings`](settings) \| ❌ \|
			\| [`webhooks`](webhooks) \| ❌ \|
[189] wiki update 2022-11-08 03:02:07 +00:00			\| [`plex`](plex) \| ✅ <br/>Either here or per library \|
[22] table alignment 2022-11-16 14:30:04 +00:00			\| [`tmdb`](tmdb) \| ✅ \|
			\| [`tautulli`](tautulli) \| ❌ \|
			\| [`omdb`](omdb) \| ❌ \|
			\| [`notifiarr`](notifiarr) \| ❌ \|
			\| [`anidb`](anidb) \| ❌ \|
			\| [`radarr`](radarr) \| ❌ \|
			\| [`sonarr`](sonarr) \| ❌ \|
			\| [`trakt`](trakt) \| ❌ \|
			\| [`mal`](myanimelist) \| ❌ \|
[109] fix templates 2022-05-20 07:06:08 +00:00
[171] wiki update 2022-10-29 15:59:01 +00:00			`## Configuration File Example`
[109] fix templates 2022-05-20 07:06:08 +00:00
			`This example outlines what a "standard" config.yml file might look like when in use.`

[33] update configuration 2023-01-26 15:17:14 +00:00			```{literalinclude} ../../config/config.yml.template
[34] add imdb_keyword filter 2023-01-27 15:16:00 +00:00			`---`
			`language: yaml`
			`---`
[32] fix for #1285 2023-01-26 14:23:11 +00:00			```