Sonarr Attributes

Background

This is an optional YAML section of your global preferences file (preferences.yml) for outlining how the Maker should interact with an instance of Sonarr.

Sonarr is used as one of the automated sources of episode information. The most important information pulled from Sonarr are episode titles (which are pulled from thetvdb), however Sonarr is also queried for information used to improve the source image gathering process.

Complete Example

# preferences.yml
sonarr:
  url: http://192.168.0.1:8989/
  api_key: abcdef01234567890
  verify_ssl: true
  downloaded_only: true
  sync:
    file: ./yaml/sonarr_sync.yml
    mode: append
    compact_mode: true
    monitored_only: true
    add_template: my_template
    required_tags:
    - ongoing
    volumes:
      /sonarr/media/tv: /maker/media/tv
    plex_libraries:
      /maker/media/tv: TV
      /maker/media/anime: anime
    exclusions:
    - series: Pokémon (1997)
    - tag: widescreen-shows
    - yaml: ./yaml/ignore.yml

options:     # Global options ...
archive:     # Archive options ...
plex:        # Plex options ...
jellyfin:    # Jellyfin options ...
emby:        # Emby options ...
tautulli:    # Tautulli options ...
tmdb:        # TMDb options ...
imagemagick: # Imagemagick options ...

Multiple Instances of Sonarr

TCM can communicate with multiple instances of Sonarr. This can be easily accomplished by specifying the servers as a list of entries, like so:

sonarr:
- url: http://192.168.0.1:8989/
  api_key: abcdef
  # Any options
- url: http://192.168.0.2:8989/
  api_key: fedcba
  # Any options
# Any number of Sonarr instances

If a series is present on more than one instance of Sonarr, the first server (as listed sequentially in your preferences file) with the series will be utilized. To override this, specifying sonarr_server_id within a series YAML file will override the search. This is the index in the list, starting at 0 - so sonarr_server_id: 0 is the first element of the list, 1 the second, etc.

Attributes

Name	YAML Attribute	Allowed Values	Default Value	Required
Sonarr URL	url	A valid Sonarr API URL	-	✔️
Sonarr API Key	api_key	A valid Sonarr API key	-	✔️
Verify SSL	verify_ssl	Boolean (true or false)	true	❌
Downloaded Only	downloaded_only	Boolean (true or false)	false	❌
YAML Syncing	sync	A sync configuration	-	❌

Sonarr URL

URL to send API requests to Sonarr. Sonarr supports two different API endpoints, and using the /v3/ API endpoint is strongly recommended as I don't believe the older API is updated and might lead to some broken features.

Sonarr API Key

Sonarr requires an API key to validate external requests. This can be accessed via Settings > General > Security > API Key (shown below).

Verify SSL

By default, TCM will attempt to verify the security of the API requests made to Sonarr. However, for some users running TCM or Sonarr on machines without valid SSL certificates, this can result in Sonarr communication failures. Disabling this setting can prevent those errors.

Disabling SSL verification does have marginal security risks, but given that TCM will likely be communicating with Sonarr internally (local to your network), the real risk is quite low.

Downloaded Only

By default, TCM will grab Episode data for all Episodes available on Sonarr/TVDb. However, many users often only want to create Title cards for Episodes they have physically downloaded - this setting can enable that.

Setting this to true means TCM will ignore any Episode that is not downloaded when looking for new Episodes. false means all Episodes will be pulled.

NOTE: TCM will not remove Episodes that you had downloaded and then later removed.

This setting functions differently from the sync option (also called downloaded_only), in that this controls which Episodes are added to TCM, while the sync option controls which Series are added.

YAML Sync

TitleCardMaker can automatically create/update series YAML files so that cards can be created for series within Sonarr automatically, without the need to add all series manually. This behavior is disabled by default.

This functionality is detailed here.