Plex-Meta-Manager/docs/config/overview.md
2023-12-31 11:45:00 -05:00

2.9 KiB

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.

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 :fontawesome-solid-circle-check:{ .green }
playlist_files :fontawesome-solid-circle-xmark:{ .red }
settings :fontawesome-solid-circle-xmark:{ .red }
webhooks :fontawesome-solid-circle-xmark:{ .red }
plex :fontawesome-solid-circle-check:{ .green } Either here or per library
tmdb :fontawesome-solid-circle-check:{ .green }
github :fontawesome-solid-circle-xmark:{ .red }
tautulli :fontawesome-solid-circle-xmark:{ .red }
omdb :fontawesome-solid-circle-xmark:{ .red }
notifiarr :fontawesome-solid-circle-xmark:{ .red }
anidb :fontawesome-solid-circle-xmark:{ .red }
radarr :fontawesome-solid-circle-xmark:{ .red }
sonarr :fontawesome-solid-circle-xmark:{ .red }
trakt :fontawesome-solid-circle-xmark:{ .red }
mal :fontawesome-solid-circle-xmark:{ .red }

Configuration File Example

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

{%    
  include-markdown "../../config/config.yml.template" 
  comments=false
%}