Sonarr
Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
Initial Setup
First you must connect to your slot via ssh. If you need help connecting to the server, please read the help article here.
Installing Sonarr is easy. Simply issue the following command:
box install sonarr
This command will configure sonarr for your user.
How to Access
Once setup, sonarr will be available at the link https://<hostname.io>/sonarr
Service Management
Like all box configured applications, you can manage Sonarr via SSH with box with start, stop, restart, enable and disable commands.
- Status
- Start
- Stop
- Restart
- Enable
- Disable
box status sonarr
box start sonarr
box stop sonarr
box restart sonarr
box enable sonarr
box disable sonarr
Configuration
Out of the box, Sonarr comes with very little configuration. Following are some basic tasks to help get your client up and running:
Add a new show (and your first root directory)
- At the top, click series.
- Click the button
+ Add Series
- Type the name of the show you want to add
- Under
Path
, chooseAdd a new path
. Enter the path for the folder you wish to add your Sonarr shows to and click the green checkmark to add the directory.
- e.g.
"/home/<username>/media/TV Shows"
- Change the other settings to your own needs
- Click the green + to add the show.
Connect download clients
To add a download client, go to Settings > Download Client
. Make sure Advanced Settings
are shown and click Add Client
.
- ruTorrent
- Deluge
- qBittorrent
- NZBGet
- SABnzbd
Name: rTorrent
rTorrent host: 127.0.0.1
Port: 443
URL Path: /rutorrent/plugins/httprpc/action.php
Use SSL: ON
Username: <your username>
Password: <your password>
Add label to torrent: TV (or anything else you desire)
Optional - Downloaded files location: <custom directory>
NOTE: If you have errors adding rTorrent to Sonarr, please try going to Settings > General and disable certificate validation for localhost addresses
Name: Deluge
Host: 127.0.0.1
Post: <deluge web port> (cat ~/.config/deluge/web.conf | grep port)
Deluge Password: <your password>
Add label to torrent: TV (or anything else you desire)
* label plugin must be enabled in Deluge if you add a label
SSL: OFF
Name: qBittorrent
Host: <subnet ip> (In older cases: 127.0.0.1 - you can get your subnet IP by SSH'ing into your server and running `cat .install/subnet.lock`)
Post: <qbittorrent web port>
Username: <your username>
Password: <your password>
Category: TV (or anything else you desire)
SSL: OFF
Name: NZBget
NZBget host: 127.0.0.1
port: 443
URL Base: nzbget
Connect using HTTPS: ON
nzbget username: <your username>
nzbget Password: <your password>
Add label to torrent: Series (or anything else you desire)
* label must exist under Categories in nzbGet
Name: SABnzbd
SABnzbd host: 127.0.0.1
port: 443
Use SSL: ON
URL Base: /<yourusername>/sabnzbd
API Key: <yourapikey>
Add label to torrent: Series (or anything else you desire)
* label must exist under Categories in SABnzbd
Since Sonarr v3, you will now need to disable certificate validation for localhost domains as well if you are connecting to port 443. You can find this setting in Settings > General.
Add an indexer with Jackett
Sonarr only supports a few trackers out of the box, but the indexers can be expanded by using the application Jackett. To add an indexer with Jackett, use the following steps.
By default, when receivng the torznab feed from Jackett, it will need to be modified to be connected with the application. The default link looks like:
https://app02.hostingby.design/jackett/api/v2.0/indexers/yourtracker/results/torznab/
We need to edit this link to remove https and add the port number. Thus, if your port number was 12345
, your editted URL would look like this:
http://app02.hostingby.design:12345/jackett/api/v2.0/indexers/yourtracker/results/torznab/
- Go to
Settings > Indexers
and click+
to add a new indexer. - Under
Torrent
chooseTorznab
- Use the settings:
Name: <tracker name>
URL: <click copy torznab feed in jackett and modify as per above>
API: <copy and paste from jackett UI>
- Click
Test
. If all is good, clickSave
.
Sonarr not working after update
In some cases when Sonarr is updated through the WebUI, you may encounter an issue where Sonarr is not starting correctly. Thankfully there is an easy fix:
- Make sure you have a red dot next to Sonarr in the Swizzin WebUI.
- Login via SSH and navigate
cd ~/.config/Sonarr/
and copy the sonarr.db withcp sonarr.db ~/
- Go back into your home dir with
cd ~/
and then runbox remove sonarr
and thenbox install sonarr
- After Sonarr is installed, go into the Swizzin WebUI and turn off Sonarr with the Enabled switch, wait around 10-20 seconds for the Sonarr instance to be completely turned off, noted by the Red Dot next to Sonarr.
- Go back into the Sonarr config folder with
cd ~/.config/Sonarr
and remove the sonarr.db, sonarr.db-shm, sonarr.db-wal and sonarr.pid files withrm sonarr.db, sonarr.db-shm, sonarr.db-wal and sonarr.pid
. Now navigate back to your home dir withcd ~/
and copy over the backup of your .db file withcp sonarr.db ~/.config/Sonarr/
- Now you are free to turn on Sonarr back from the switch in the Swizzin Panel.
Other tasks
You may wish to further alter your setup by setting quality profiles or setting up post-processing so that media is automatically transferred to your Sonarr library when your torrents are completed. If you need further help, you can refer to the Sonarr Wiki.