Sonarr#

Sonarr Automated TV show downloading

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling sonarr#

Command:#

vlab set sonarr.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

sonarr
enable: True

Finalising changes:#

run: vlab update_one service=sonarr

FIRST RUN#

You will need to configure an Indexer and a Download Client for Sonarr to work.

Indexer: Jackett#

The Download Client will be Jackett, you should make sure that you have it installed and configured to follow these instructions. Then, in Sonarr, go to Settings then the Indexers tab, and click the Plus button. Select the Custom button undernear Torznab and enter Jackett for the name, for the URL enter http://jackett:9117/api/v2.0/indexers/all/results/torznab/ and for the API Key, enter the API key that Jackett displays on its Dashboard.

Download client: Transmission#

The Download Client will be Transmission, you should make sure that you have it installed and configured to follow these instructions. Then, in Sonarr, go to the Download Client tab, toggle the Advanced Settings toggle in the top right to Shown, then click the Plus button, select Transmission. In the form that popped up, enter transmission for host, 9091 for port, and your transmission username and password in their respective fields. Indicate the following value for the Directory field:

  • /data/complete/tv

Click Save to close the modal window. Back in the Advanced settings screen, add a "Remote Path Mappings" with the following values:

  • Host: transmission
  • Local Path: /downloads
  • Remote Path: /data/complete/tv

Usage#

We recommend that you make sure you point Sonarr to /tv, when you add a TV show.

Now if you add some content to Sonarr, they will automatically be searched and downloaded according to your settings.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=sonarr to complete the changes

ACCESS#

sonarr (HTTPS) link: https://sonarr.vivumlab.xyz/ sonarr (HTTP) link: http://sonarr.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set sonarr.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

sonarr
https_only: True
Finalising changes:#

run: vlab update_one service=sonarr

AUTH#

Default: False
Options: True/False

Command:#

vlab set sonarr.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

sonarr
auth: True
Finalising changes:#

run: vlab update_one service=sonarr

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set sonarr.domain sonarr.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

sonarr
domain: sonarr.com
Finalising changes:#

run: vlab update_one service=sonarr

SUBDOMAIN#

Default: sonarr
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set sonarr.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

sonarr
subdomain: media
Finalising changes:#

run: vlab update_one service=sonarr

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set sonarr.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

sonarr
version: 2.7
Finalising changes:#

run: vlab update_one service=sonarr

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.