Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-26 14:30:25 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/config/sonarr.md
meisnate12 9894d2fbf1 [5] various minor fixes
2022-04-01 02:42:04 -04:00

16 KiB
Raw Blame History

Sonarr Attributes

Configuring Sonarr is optional but will allow you to send shows to a Sonarr instance when they're found missing while updating a library's collections.

Sonarr V2 may work, but it is not supported please upgrade to V3 if you can.

A sonarr mapping can be either in the root of the config file as global mapping for all libraries, or you can specify the sonarr mapping individually per library.

Below is a sonarr mapping example and the full set of attributes:

sonarr:
  url: http://192.168.1.12:32789
  token: ################################
  add_missing: false
  add_existing: false
  root_folder_path: S:/Shows
  monitor: all
  quality_profile: HD-1080p
  language_profile: English
  series_type: standard
  season_folder: true
  tag: pmm
  search: false
  cutoff_search: false
  sonarr_path: /media
  plex_path: /share/CACHEDEV1_DATA/Multimedia
Attribute Allowed Values Default Required
url Sonarr URL (Including URL Base if set).
Example: http://192.168.1.12:32788		 N/A ✅
token Sonarr API Token. N/A ✅
add_missing Adds all missing shows found from all collections to Sonarr.
Use the sonarr_add_missing Sonarr Details in the collection definition to add missing per collection.
boolean: true or false		 false ❌
add_existing Adds all existing shows in collections to Sonarr.
Use the sonarr_add_existing Sonarr Details in the collection definition to add existing per collection.
boolean: true or false		 false ❌
root_folder_path Default Root Folder Path to use when adding new shows.
Use the sonarr_folder Sonarr Details in the collection definition to set the Root Folder per collection.		 N/A ✅
monitor Default Monitor to use when adding new shows.
Use the sonarr_monitor Sonarr Details in the collection definition to set the Monitor value per collection.
Values:
allAll episodes except specials
futureEpisodes that have not aired yet
missingEpisodes that do not have files or have not aired yet
existingEpisodes that have files or have not aired yet
pilotThe first episode, all others will be ignored
firstAll episodes of the first season, all others will be ignored
latestAll episodes of the latest season and future seasons
noneNo episodes
 all ❌
quality_profile Default Quality Profile to use when adding new shows.
Use the sonarr_quality Sonarr Details in the collection definition to set the Quality Profile per collection.		 N/A ✅
language_profile Default Language Profile to use when adding new shows.
Use the sonarr_language Sonarr Details in the collection definition to set the Language Profile per collection.		 First Profile ❌
series_type Default Series Type to use when adding new shows.
Use the sonarr_series Sonarr Details in the collection definition to set the Series Type per collection.
Values:
standardEpisodes released with SxxEyy pattern
dailyEpisodes released daily that use year-month-day pattern (2017-05-25)
animeEpisodes released using an absolute episode number
standard: Episodes released with SxxEyy pattern
daily: Episodes released daily or less frequently that use year-month-day (2017-05-25)
anime: Episodes released using an absolute episode number		 standard ❌
season_folder Use the Season Folder Option when adding new shows.
Use the sonarr_season Sonarr Details in the collection definition to set the season folder value per collection.
boolean: true or false		 true ❌
tag Default this list or comma-separated string of tags to use when adding new shows.
Use the sonarr_tag Sonarr Details in the collection definition to set the tags per collection.		 ❌
search Start search for missing episodes when adding new shows.
Use the sonarr_search Sonarr Details in the collection definition to set the search value per collection.
boolean: true or false		 false ❌
cutoff_search Start search for cutoff unmet episodes when adding new shows.
Use the sonarr_cutoff_search Sonarr Details in the collection definition to set the cutoff search value per collection.
boolean: true or false		 false ❌
plex_path When using add_existing or sonarr_add_all Convert this part of the path to sonarr_path. ❌
sonarr_path When using add_existing or sonarr_add_all Convert the plex_path part of the path to this. ❌

  • The token can be found by going to Sonarr > Settings > General > Security > API Key

  • The quality_profile and language_profile must be the exact name of the desired quality profile, including all spaces and capitalization.

  • You can set most attributes per collection by using the Sonarr Details in the collection definition.

Sonarr Details