Wiki > readarr

"Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will grab, sort, and rename them. Note that only one type of a given book is supported. If you want both an audiobook and ebook of a given book you will need multiple instances."

Installation

The port number 12439 has automatically been generated by this page and will be used throughout this article, but can be changed to a port between 10000-32000 if needed.

1. Connect to your slot with SSH

2. Download the latest development version version of Readarr for Linux .NET Core x64

    wget --content-disposition 'http://readarr.servarr.com/v1/update/develop/updatefile?os=linux&runtime=netcore&arch=x64'
   

3. Extract the archive

    tar zxvf Readarr*.tar.gz
   

4. Temporarily start Readarr to generate configuration files

    ~/Readarr/Readarr & sleep 10 && pkill -f Readarr
   

5. Edit the configuration file at ~/.config/Readarr/config.xml to use a unique port.

    nano ~/.config/Readarr/config.xml
   

   Change <Port>8787</Port> to <Port>12439</Port>

   If the <Port></Port> variable is missing, add it on your own. Make sure to add it before the BaseURL variable.

   Save the file by pressing Ctrl+S then exit nano with Ctrl+X

6. Start Readarr

    screen -dmS Readarr ~/Readarr/Readarr -data=/home/user/.config/Readarr
   

Immediately access http://server.whatbox.ca:12439/settings/general and set Authentication to Forms and add a username (like user) and password, then click "Save Changes" at the top of the page. This is required to protect your slot!

Usage

Connecting to rTorrent

Under Settings > Download Client, select to add a client with the + button and then select rTorrent. Enter the following information to connect to rTorrent:

    Host: localhost
    Port: 443
    URL Path: xmlrpc
    Use SSL: Yes
    Username: user
    Password: Your server password

Connecting to Transmission

You will need the Transmission daemon port from your Slot Info page.

Under Settings > Download Client, select to add a client with the + button and then select Transmission. Enter the following information to connect to Transmission:

    Host: localhost
    Port: Daemon port as listed on your Slot Info page
    Username: user
    Password: Your server password

Connection to Deluge

You will need the Deluge WebUI address from your Slot Info page.

Make sure the Deluge WebUI has been enabled from the Settings link on your Manage page.

Under Settings > Download Client, select to add a client with the + button and then select Deluge. Enter the following information to connect to Deluge:

    Host: localhost
    Port: 5 digit port from the end of your Deluge WebUI link, as listed on your Slot Info page.
    Password: Your server password
    Category: Leave blank if the Label plugin has not yet been enabled in the Deluge WebUI

Automatic Restart (optional)

1. Make a file to be used for the script. touch ~/Readarr_restart.cron

2. Edit the file and enter the text below. nano -w ~/Readarr_restart.cron

    #!/bin/bash
    if pgrep -fx "/home/user/Readarr/Readarr -data=/home/user/.config/Readarr" > /dev/null
    then
        echo "Readarr is running."
    else 
        echo "Readarr is not running, starting Readarr"
        /home/user/Readarr/Readarr -data=/home/user/.config/Readarr
    fi
    exit
   

3. Save the file with Ctrl+S then exit nano with Ctrl+X

4. Make the script executable. chmod +x ~/Readarr_restart.cron

5. Open your crontab. EDITOR=nano crontab -e

6. Enter the following text

    @reboot /home/user/Readarr_restart.cron >/dev/null 2>&1
    */5 * * * * /home/user/Readarr_restart.cron >/dev/null 2>&1
   

7. Save the file with Ctrl+S then exit nano with Ctrl+X