Skip to content

Readarr in Docker on a Synology NAS

UpdateDate
New guide published15/07/2022
Added new port settings and Docker Bridge Network23/07/2022


What is Readarr?

Readarr is an ebook 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.

Downloading the Readarr Image

Open up Docker 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, right click on it and select ‘Download’ or click the button at the top of the window.

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.

You can check the status of the download over on the ‘Image’ tab.

Setting up the container

In Docker click on the ‘Image’ tab, in the list of your containers select the ‘Linuxserver Readarr’ image and click on ‘Launch’

You will be greeted with the Network screen, we will be using the ‘synobridge’ network we created earlier select it from the list and click Next.

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.

You will also notice a Configure capabilities button — don’t change anything in here!

Next up we are going to click on the ‘Advanced Settings’ button, this will take you to a new window with a number of tabs which we are going to work through.

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, you will need to do one at a time.

VariableValue
PUIDThe UID you obtained in the user setup guide
PGIDThe GID you obtained in the user setup guide
TZYour timezone wikipedia.org/wiki/List_of_tz_database_time_zones

You do not need to set up anything on these tabs.

Press ‘Save’ to go back to the initial setup screen, then press ‘Next’

Port Settings

We won’t be changing any of the ports the container uses. You can repeat the ones shown on the right side of the settings page ‘Container Port’ onto the left side ‘Local Port’ once you have done this press ‘Next’.

Volume Settings

We will now be specifying the directories where Readarr will store its configuration files and where to store downloaded books

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

Now add ‘/config’ to the ‘Mount path’ box

Click Add Folder again and this time select the top level ‘data’ share and click Select.

You will now enter ‘/data’ into the ‘Mount path’ box

Your path settings should now look like the table/screenshot below.

File/FolderMount path
docker/readarr/config
data/data

Click Next to move to the final 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 6767

e.g. 192.168.0.40:8787



Docker Compose

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

version: "3.8"
services:
  linuxserver-readarr:
    image: lscr.io/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/readarr.yml up -d


Throw me some bits or buy me a coffee?

If you have found my site useful please consider pinging me a tip as it helps cover the cost of running the site, you can even buy me a coffee 🙂

Buy Me A Coffee
Doge / Ethereum / Bitcoin
Published inDockerSynology

10 Comments

  1. Thanks again ! Your tutorials are perfects ! After Readarr could you do something with Calibre ?

  2. Ejah Ejah

    Hi,
    After installing Readarr with docker compose and adding a indexer and a download client (NzbGet). This message still appears in the system status of Readarr:
    You are using docker; download client Nzbget places downloads in /data/usenet/completed/Readarr but this directory does not appear to exist inside the container. Review your remote path mappings and container volume settings.

    I have tried many ways to get rid of this message. unfortunately I cant find the solution

    • Dr_Frankenstein Dr_Frankenstein

      Hmm it should exist as the mount point is /data to ensure Readarr has access to both the download path and the final books folder in /media

      Did you set anything in the remote path mapping settings at all?

      Also double check that you can browse inside /data you can try doing a manual import to see the file system.

      • Ejah Ejah

        Thank you for your respond! I solved the issue by doing the manual import

        • Dr_Frankenstein Dr_Frankenstein

          Nice one!

    • Paul Paul

      Hello,

      I have exactly the same issue, only in Radarr.
      The difference being that this Radarr installation was setup some time ago and was working just fine until recently.

      • Paul Paul

        I’ve installed Readarr as well, Having exactly the same issue. Manual import shows a folder, but without the expected content.

      • Dr_Frankenstein Dr_Frankenstein

        I have 5 or 6 different people having a similar issue across the comments and also on Discord for Radarr and also Readarr. On the Readarr side double check you PUID and PGID are set correctly – Readarr is very much in development so expect bugs for a while. There are 360+ open issues on Github https://github.com/Readarr/Readarr/issues

        Also one common denomintator I am seeing is that you and others have a final directory with a capital R (Readarr) or M (Movies) try using lower case.

        • Paul Paul

          I’ve installed readarr and radarr following exactly the setup described: problems are gone.
          I’ve no clue what is different though. Final outcome is fine with me.

          • Dr_Frankenstein Dr_Frankenstein

            There must have been a bug fix or something. Or the classic turn it off and on again and if works.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

drfrankenstein.co.uk – writing Synology Docker Guides since 2016 – Join My Discord!