Last updated on 10 October 2023
Please note if you are using DSM7.2 or higher you should use the Container Manager version of this guide from the menu.
This guide has reached the end of its updates as most people are now on the latest DSM update - This guide is correct as of 08/12/2023 however no further updates will be added.
| Update | Date |
|---|---|
| Removed docker compose section as rarely used | 18/07/2023 |
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.
- 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 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.
It can sometimes be hard to spot the correct version in the list – see the second screenshot below for it’s location
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.
| Variable | Value |
|---|---|
| PUID | The UID you obtained in the user setup guide |
| PGID | The GID you obtained in the user setup guide |
| TZ | Your timezone wikipedia.org/wiki/List_of_tz_database_time_zones |
Links/Execution Commands
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/Folder | Mount 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 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.
| App | Root Folder |
|---|---|
| Readarr | /data/media/books |
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.
| Historic Updates | Date |
|---|---|
| New guide published | 15/07/2022 |
| Added new port settings and Docker Bridge Network | 23/07/2022 |
| Compose version number removed and small wording amendments | 09/04/2023 |
| Amended the path to save the compose file – this is for security, so the container has no access to the file contents. | 14/04/2023 |
Looking for some help, join our Discord community
If you are struggling with any steps in the guides or looking to branch out into other containers join our Discord community!
Buy me a beverage!
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 stay hydrated. Plus 10% goes to the devs of the apps I do guides for every year.
Hi there!
Big thanks for your guides! I have been going through one by one and not only learning about amazing tools which are out there – but also being to very clearly and precisely install them!
I have one tiny comment, a typo in this text:
“You should now be able to access Readarr via the IP of your NAS followed by the port 6767”
(It should be 8787).
Big thanks again!!
Ha thanks – I clearly wrote the port directly below so who knows what I was thinking about while typing – I blame my haunted keyboard.
Thanks for setting this for books. However I am not able to complete the setup yet. I created the docker, after launching the Readarr, I was able to setup media management settings. But when I started the download clients I am using NZBget and t gives error that the category Readarr doesn’t exist? NZBGet is correct downloader for books? If not, then what do I need to setup for books?
Hey Amit, within NZBget settings there is a categories section you just need to add ‘books’ to it, this just means when they download they drop into a books folder within the completed folder.
i had the same problem mentioned in the comments but for lidarr. Maybe others made the same mistake i did.
i didnt properly read your instructions on the ‘NZBGet in Docker on a Synology NAS’ guide. The file paths section clearly says to change the MainDir setting on NZBGet. After doing that AND manually creating a Music folder in my /data/media/usenet/completed folder the error went away.
The Error:
You are using docker; download client NZBGet places downloads in /downloads/completed/Music but this directory does not appear to exist inside the container. Review your remote path mappings and container volume settings.
Thanks again ! Your tutorials are perfects ! After Readarr could you do something with Calibre ?
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
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.
Thank you for your respond! I solved the issue by doing the manual import
Nice one!
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.
I’ve installed Readarr as well, Having exactly the same issue. Manual import shows a folder, but without the expected content.
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.
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.
There must have been a bug fix or something. Or the classic turn it off and on again and if works.