Readarr in Container Manager on a Synology NAS

This guide is now archived and not receiving updates
Use the new all in one Arr's Project

What is Readarr?

Readarr is an e-book and Audiobook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favourite authors and will interface with clients and indexers to grab, sort, and rename them.

Let’s Begin

In this guide I will take you through the steps to get Readarr up and running in Docker.

In order for you to successfully use this guide please complete the setting up a docker user guide, or have your ID details to hand.

• Docker, Memory Recommendations and Limitations
  
• Step 1: Directory Setup Guide
• Step 2: Setting up a restricted Docker user
• Step 3: Setting up a Docker Bridge Network

Downloading the Readarr Image

Open up Container Manager within DSM and navigate to the ‘Registry’ tab and search for ‘Readarr’. In the list of available containers select the one made by Linuxserver as shown below then click ‘Download’.

When the dialogue pops up asking you to choose a version, we are going to be using the ‘Develop’ branch as Readarr is still in development.

It can sometimes be hard to spot the correct version in the list, it’s directly after the arm64v8 images.

You will automatically be taken to the ‘Image’ tab once the download has completed select the image and click ‘Run’.

General Settings

Next you will be greeted with the General Settings screen, this is where you can start specifying some of your preferences.

You can change the name of the container to anything you like, and you may want to enable Auto Restart as this will ensure Readarr starts automatically if you reboot your NAS.

We won’t need to change any other settings on this screen. We are now going to work through the remain settings. Click on Next.

Port Settings

We won’t be changing any of the ports the container uses. You can repeat the one shown on the right side of the settings page which is the internal Container Port onto the left side which is the Local Port which is the one you will access in your browser. Now move to the next section.

Volume Settings

We will now be specifying the directories where Readarr will store its configuration files and where to find our media and downloads.

Click on ‘Add Folder’ select the ‘docker’ folder and create a new sub-folder called ‘readarr’ select this folder and click ‘select’

Repeat this process to add the /data folder.

ou will notice the section next to each folder is blank, we need to add a ‘Mount Path’ which maps the folders to a folder within the container. Use the ones shown below.

We can now move to the next section.

Environment (PGID, PUID and Timezone)

Next we are going to set up a couple of environment variables that docker will use to allow the container access to our files and folders and also to tell it where we live in the world.

Click the Add button, and fill in the following details as per the table/screenshot.

Capabilities

Nothing to change here leave at the default selection.

Network

In the Network section choose the ‘synobridge’ from the drop-down menu that we created earlier.

Execution Command / Links

Leave both of these section with their default settings.

Press ‘Next’ to go back to the Final Summary screen.

Summary

You have now completed the setup of the container.

You will be shown an overall summary of the settings we have specified, this is a good time to double-check everything is correct. Finally, click on Done and the container should start to boot.

You should now be able to access Readarr via the IP of your NAS followed by the port 8787

e.g. 192.168.0.40:8787

Key Settings and FAQ

Now you have set up Readarr there are some key settings you will need to set as these often catch new users out. I will add more as they come up.

Media Management / Root Folders (Settings>Media Management)

Readarr refers to the place(s) you keep your Books and Audiobooks as Root Folders. These are where Readarr will ultimately move your book files once they finish downloading.

Download Clients (Settings > Download Clients>Remote Path Mappings)

While most of the settings on this page are self-explanatory something that has caught people out if the Remote Path Mappings setting. If you are hosting all your services on the same NAS do not add any settings here.

I can’t get Readarr to Connect to my Download Client!

When setting up your preferred download client or Prowlarr etc. Usually you will use the IP of your NAS, however if for whatever reason this is not working you can use http://172.20.0.1 which is the IP of the ‘synobridge’ gateway.

Docker Compose

You can use the below code saved as readarr.yml in the ‘/docker’ share, this will do the entire process above in one quick command via SSH. Ensure you change the variables to your own.

services:
  linuxserver-readarr:
    image: linuxserver/readarr:develop
    container_name: readarr
    environment:
      - PUID=YOURUID
      - PGID=YOURGID
      - TZ=Europe/London
    volumes:
      - /volume1/docker/readarr/:/config
      - /volume1/data/:/data
    ports:
      - 8787:8787
    network_mode: synobridge
    restart: unless-stopped

sudo docker-compose -f /volume1/docker/readarr.yml up -d

Buy Me a Coffee or a Beer

If you have found my site useful please consider pinging me a tip as it helps cover the cost of running things or just lets me get the odd beverage. Plus 10% goes to the devs of the apps I do guides for every year.