Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4aba37884b'
${ noResults }
Plex-Meta-Manager/docs/home/guides/configuration.md

7.4 KiB
Raw Blame History

Configuration File Walkthrough

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

Example config.yml file 
libraries:                                      
  Movies - 4K:
    metadata_path:
      - file: config/Movies.yml
      - git: meisnate12/MovieCharts
  TV Shows:
    metadata_path:
      - file: config/TVShows.yml
      - folder: config/TV Shows/
      - git: meisnate12/ShowCharts
  Animé:
    metadata_path:
      - file: config/Anime.yml
  Music:
    metadata_path:
      - file: config/Music.yml
playlist_files:
  - file: config/playlists.yml
  - git: meisnate12/Playlists
settings:
  cache: true
  cache_expiration: 60
  asset_directory: config/assets
  asset_folders: true
  asset_depth: 0
  create_asset_folders: false
  dimensional_asset_rename: false
  download_url_assets: false
  show_missing_season_assets: false
  show_missing_episode_assets: false
  show_asset_not_needed: true
  sync_mode: append
  minimum_items: 1
  default_collection_order:
  delete_below_minimum: true
  delete_not_scheduled: false
  run_again_delay: 2
  missing_only_released: false
  only_filter_missing: false
  show_unmanaged: true
  show_filtered: false
  show_options: false
  show_missing: true
  show_missing_assets: true
  save_missing: true
  tvdb_language: eng
  ignore_ids:
  ignore_imdb_ids:
  item_refresh_delay: 0
  playlist_sync_to_user: all
  verify_ssl: true
webhooks:
  error:
  run_start:
  run_end:
  changes:
plex:
  url: http://192.168.1.12:32400
  token: ####################
  timeout: 60
  clean_bundles: false
  empty_trash: false
  optimize: false
tmdb:
  apikey: ################################
  language: en
tautulli:
  url: http://192.168.1.12:8181
  apikey: ################################
omdb:
  apikey: ########
notifiarr:
  apikey: ####################################
anidb:
  username: ######
  password: ######
radarr:
  url: http://192.168.1.12:7878
  token: ################################
  add_missing: false
  add_existing: false
  root_folder_path: S:/Movies
  monitor: true
  availability: announced
  quality_profile: HD-1080p
  tag:
  search: false
  radarr_path:
  plex_path:
sonarr:
  url: http://192.168.1.12:8989
  token: ################################
  add_missing: false
  add_existing: false
  root_folder_path: "S:/TV Shows"
  monitor: all
  quality_profile: HD-1080p
  language_profile: English
  series_type: standard
  season_folder: true
  tag:
  search: false
  cutoff_search: false
  sonarr_path:
  plex_path:
trakt:
  client_id: ################################################################
  client_secret: ################################################################
  authorization:
    # everything below is autofilled by the script
    access_token:
    token_type:
    expires_in:
    refresh_token:
    scope: public
    created_at:
mal:
  client_id: ################################
  client_secret: ################################################################
  authorization:
    # everything below is autofilled by the script
    access_token:
    token_type:
    expires_in:
    refresh_token:

Expand the above to see the full config.yml file before continuing.

Library Mappings (libraries:)

libraries: is used to tell PMM that the following code relates to Plex libraries. libraries: should only be seen once within the configuration file.

In this specific example there are four Plex libraries that are being connected to: Movies - 4K, TV Shows, Animé and Music. These names must match the name of the library as it appears within Plex, including any special characters such as the é within Animé.

Using Movies - 4K: as an example, metadata_path: instructs PMM that the next piece of code is where to look for the Metadata Files which will be covered in the next section.

Metadata/YAML files (metadata_path: mappings)

As can be seen in the original config.yml example, there are three metadata_paths being pointed to for the TV Shows library:

  TV Shows:
    metadata_path:
      - file: config/TVShows.yml
      - folder: config/TV Shows/
      - git: meisnate12/ShowCharts

These path types are outlined as follows:

  • - file: refers to a YAML file which is located within the system that PMM is being run from.

  • - folder: refers to a directory containing YAML files which is located within the system that PMM is being run from.

  • - git: refers to a YAML file which is hosted on the GitHub Configs Repo unless the user has specified a custom repository within the settings section of the config.yml file.

Within the above example, PMM will:

  • First, look within the root of the PMM directory (also known as config/) for a metadata file named Movies.yml. If this file does not exist, PMM will skip the entry and move to the next one in the list.

  • Then, look within the root of the PMM directory (also known as config/) for a directory called TV Shows, and then load any metadata/YAML files within that directory.

  • Finally, look at the meisnate12 folder within the GitHub Configs Repo for a file called MovieCharts.yml which it finds here.

It should be noted that whilst the user should be able to edit any metadata files which are - file: or - folder: based, they have little to no control over - git: metadata files unless a copy of the YAML file is downloaded and ran locally. In the above example, if the user downloaded the MovieCharts.yml file from the GitHub Configs Repo and placed it in the root directory of PMM (config/), then the metadata_path mapping would be updated to reflect this as follows:

  Movies - 4K:
    metadata_path:
      - file: config/Movies.yml
      - file: config/MovieCharts.yml        <------ HERE

Playlists (playlist_files: mappings)

Playlists can be seen as an extension of Libraries in that they are both handled very similarly within PMM:

playlist_files:
  - file: config/playlists.yml
  - git: meisnate12/Playlists

As with libraries:, YAML files are defined to create the Playlists. It should be noted that whilst in libraries: when working with playlist_files: you call out the libraries being connected to within the Metadata/YAML file as Playlists can combine media from multiple libraries. You can view an example playlists.yml file as follows:

Example playlists.yml file 
playlists:
  Marvel Cinematic Universe:
    sync_to_users: all
    sync_mode: sync
    libraries: Movies, TV Shows
    trakt_list: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe?sort=rank,asc
    summary: Marvel Cinematic Universe In Order
  Star Wars Clone Wars Chronological Order:
    sync_to_users: all
    sync_mode: sync
    libraries: Movies, TV Shows
    trakt_list: https://trakt.tv/users/tomfin46/lists/star-wars-the-clone-wars-chronological-episode-order

As can be seen in the above examples, multiple libraries are being used to combine different types of media (movies and tv shows in this case) into one playlist.