Skip to content

Latest commit

 

History

History
42 lines (36 loc) · 3.12 KB

Sonarr-Attributes.md

File metadata and controls

42 lines (36 loc) · 3.12 KB
Raw

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.

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: true
  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
Name Attribute Allowed Values Default Required
Sonarr URL url Sonarr URL
Example: http://192.168.1.12:32788		 N/A ✔️
API Token token Sonarr API Token N/A ✔️
Add add Add missing shows found to Sonarr
boolean: true or false		 false ❌
Add Existing add_existing Add shows existing in this collection to Sonarr
boolean: true or false		 false ❌
Root Folder Path root_folder_path Sonarr Root Folder Path To Use N/A ✔️
Monitor monitor all: Monitor all episodes except specials
future: Monitor episodes that have not aired yet
missing: Monitor episodes that do not have files or have not aired yet
existing: Monitor episodes that have files or have not aired yet
pilot: Monitor the first episode. All other episodes will be ignored
first: Monitor all episodes of the first season. All other seasons will be ignored
latest: Monitor all episodes of the latest season and future seasons
none: No episodes will be monitored		 all ❌
Quality Profile quality_profile Quality Profile To Use N/A ✔️
Language Profile language_profile Language Profile To Use (v3 Only) First Profile ❌
Series Type series_type 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 season_folder Use the Season Folder Option when adding to Sonarr
boolean: true or false		 true ❌
Tag tag Add this list or comma-separated string of tags to every show added to Sonarr ❌
Search search Start search for missing episodes
boolean: true or false		 false ❌
Cutoff Search cutoff_search Start search for cutoff unmet episodes
boolean: true or false		 false ❌

  • 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 Collection Detail