24
Sonarr Attributes
meisnate12 edited this page 2 years ago
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: 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
sonarr_path: /media
plex_path: /share/CACHEDEV1_DATA/Multimedia
| Name | Attribute | Allowed Values | Default | Required |
|---|---|---|---|---|
| Sonarr URL | url |
Sonarr URL (Including URL Base if set) 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 specialsfuture: Monitor episodes that have not aired yetmissing: Monitor episodes that do not have files or have not aired yetexisting: Monitor episodes that have files or have not aired yetpilot: Monitor the first episode. All other episodes will be ignoredfirst: Monitor all episodes of the first season. All other seasons will be ignoredlatest: Monitor all episodes of the latest season and future seasonsnone: 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 patterndaily: 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 | ❌ |
| Plex Path | plex_path |
When using add_existing or sonarr_add_all Convert this part of the path to sonarr_path |
|
❌ |
| Sonarr Path | sonarr_path |
When using add_existing or sonarr_add_all Convert the plex_path part of the path to this |
|
❌ |
-
The
tokencan be found by going toSonarr > Settings > General > Security > API Key -
The
quality_profileandlanguage_profilemust 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
