Skip to main content

Initial Setup

Readarr is a Libary manager that is able to sort, and rename content.

Major features include:

  • Complete content management. Naming conventions, metadata and audio/ebook management.
  • All in a beautiful UI with full SSL support.

You can view the application's repo here: [https://github.com/Readarr/Readarr)

In this section, we'll be setting up Readarr for the first time. This guide assumes that this is your first time installing Readarr, and you'll be storing your media locally, saving it to ~/media. We'll be doing the following:

  • Enabling automatic organization and adding a root Folder
  • Connecting your download clients

Enabling Automatic Organization

  • Access and log in to your Readarr instance using the credentials you set during installation

  • Go to Settings

  • Make sure that advanced settings are set to Shown and click Media Management

  • Under Book Naming section, check Rename Books

  • Under Importing section, make sure that Use hardlinks instead of copy is checked

    • Hardlinks effectively creates a file that points directly to your source file in the disk. You can do anything to this file without affecting your source file and vice versa.

Add your media Root Folder

  • To add your Root Folders, select Add Root Folder also under Settings -> Media Management
  • This will bring up the File Browser window.
  • From here, navigate to your ~/media/ folder and select the correct folder
  • Once that's done, click OK. You'll see the absolute path of the Root folder.
  • Click Save changes to save your changes

Adding Download Clients

  • Now, click the Download clients tab.
  • To add your preferred client, click the big + button, then select your preferred client.
  • Be sure to enable "Show Advanced settings" Using the Cog Icon in the top left-hand side to show URL Base Field.

Torrent Clients

Deluge
Host: {username}.{servername}.usbx.me
Port: 443
URL Base: /deluge
Password: As configured in UCP under Deluge
Category: readarr
Add Paused: NO
Use SSL: YES
rTorrent
Host: {username}.{servername}.usbx.me
Port: 443
URL Path: /RPC2
Username: {username}
Password: As configured in UCP under ruTorrent
Category: readarr
Add Stopped: NO
Use SSL: YES
Transmission
Host: {username}.{servername}.usbx.me
Port: 443
Username: {username}
Password: As configured in UCP under Transmission
Category: readarr
Add Stopped: NO
Use SSL: YES

Usenet Clients

SABnzbd
Host: {username}.{servername}.usbx.me
Port: 443
URL Path: /sabnzbd
API Key: As obtained from SABnzbd
Username: {username}
Password: Configured during SABnzbd setup
Category: readarr
Use SSL: YES
Nzbget
Host: {username}.{servername}.usbx.me
Port: 443
URL Path: /nzbget
Username: {nzbget username}
Password: {nzbget password}
Category: readarr (You may need to update this in NZBGET Settings if connection fails)
Add Paused: NO
Use SSL: YES

Backing Up and Restoring RadarrReadarr

In this section, we'll be showing you how to backup and restore Readarr.

Backing Up RadarrReadarr

  • Log into your Readarr instance
  • In System -> Backup, click Backup Now. This will create a zip containing your Backup.
  • Click your newly created Backup to download it to your PC.

Restoring RadarrReadarr

  • On your newly installed Readarr instance, go to System -> Backup
  • Click Restore backup.
  • A window appears. Click Choose file and navigate to your Readarr Backup.
  • Once selected, click Restore and wait for a few moments.
  • Go back to the UCP, then set a new password on Radarr. Once it's set, log in again and check that all of your settings have been restored correctly.

Troubleshooting Information

Why is Readarr down with application error 502? It won't come back!

If your Readarr is reporting 502 and you have followed all the instructions on the error page (restarting, then upgrading if that fails), then something else is going on. All troubleshooting from here requires you to access your SSH terminal.

  • If you use mergerfs in conjunction with Readarr, first ensure your mono instance is not defunct with ps aux | grep defunct. If it's defunct, killing your mounts will release the process, and you will be able to restart Readarr. Rclone cloud mounts should not be used directly with any application. MergerFS should be used.
  • Have you been into the system settings of Readarr recently and use a password manager? Your password manager may have auto-filled the port. The ports should not be modified as they are just the internal docker ports, and SSL is handled via nginx. Please check the ports in the applications config.xml with the following command:
cat .apps/readarr/config.xml | grep Port

Readarr output should look like this:

support@server:~$ cat .apps/readarr/config.xml | grep Port
  <Port>8787</Port>
  <SslPort>6868</SslPort>

If they report other values, then use a text editor on config.xml and change to the port displayed above.

Back to top