mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
37 lines
No EOL
2.2 KiB
Markdown
37 lines
No EOL
2.2 KiB
Markdown
# 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) | ✅ |
|
|
| [`playlist_files`](playlists) | ❌ |
|
|
| [`settings`](settings) | ❌ |
|
|
| [`webhooks`](webhooks) | ❌ |
|
|
| [`plex`](plex) | ✅ <br/>Either here or per library |
|
|
| [`tmdb`](tmdb) | ✅ |
|
|
| [`github`](github) | ❌ |
|
|
| [`tautulli`](tautulli) | ❌ |
|
|
| [`omdb`](omdb) | ❌ |
|
|
| [`notifiarr`](notifiarr) | ❌ |
|
|
| [`anidb`](anidb) | ❌ |
|
|
| [`radarr`](radarr) | ❌ |
|
|
| [`sonarr`](sonarr) | ❌ |
|
|
| [`trakt`](trakt) | ❌ |
|
|
| [`mal`](myanimelist) | ❌ |
|
|
|
|
## 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
|
|
---
|
|
``` |