Important or Recent Updates
Historic Updates | Date |
---|---|
New guide | 13/09/2023 |
Added additional security option to the compose to restrict the container from gaining new privileges as well as umask variable | 25/10/2023 |
Adjusted the restart variable to make sure containers start on boot | 28/10/2023 |
This guide is going to eventually replace the existing separate guides for all the apps in the title. By combining these into a single project it saves you time and effort in the initial set up and makes updates more seamless.
You can add and remove the containers from this project based on your preferences.
Migration from old guides.
If you followed my older guides where you set up each of these containers in the Container Manager UI or Pre DSM7.2 Docker UI you can follow this one to migrate in a couple of steps.
- Stop and delete the existing containers but keep your directories!
- Follow the rest of this guide and all your existing configs will be kept using your old files.
Settings for the Arrs
While I cover some very basics towards the end of the guide you really need to make use of the documentation, it goes into detail of how and why the core functions work across the apps. You can find it on the Servarr Wiki.
Let’s Begin
In order for you to successfully use this guide please complete the three initial setup guides if you have not done so already
- Docker Package, SSD and Memory Recommendations
- Step 1: Directory Setup Guide
- Step 2: Setting up a restricted Docker user
- Step 3: Setting up a Docker Bridge Network (synobridge)
As Container Manager now supports using Docker Compose in the UI we will be using it as it will save you lots of time and steps!
What on earth is a Docker Compose? Docker Compose allows us to define how Docker should set up one or more containers within a single configuration file. This file is yaml formatted and Container Manager uses the Projects feature to manage them.
Folder Setup
First we need to set up some folders for the Arr’s to save their configuration files and also where the Project will save the compose.
Using File Station create the following folders. (Skip ones you don’t need)
/docker/projects/arrs-compose - Required
/docker/radarr
/docker/sonarr
/docker/lidarr
/docker/prowlarr
/docker/bazarr
/docker/readarr
Container Set Up
Next we are going to set up a ‘Project’ in Container Manager. Open up Container Manager and click on Project, then on the right-hand side click ‘Create’.
In the next screen we will set up our General Settings.
Section | Setting |
---|---|
Project Name: | media-project |
Path: | /docker/projects/arrs-compose |
Source: | Create docker-compose.yml |
Next we are going to drop in our docker compose configuration, copy all the code in the box below and paste it into line ‘1’
A couple of notes:
- I personally use the Linuxserver images, so they are used below
- I am pulling these images directly from Docker Hub and not lscr.io this is because container manager can’t check for updates on third party sites
- You will see notes saying #change me we will do this on the next step, and you can remove the comments if you wish
services:
sonarr:
image: linuxserver/sonarr:latest
container_name: sonarr
environment:
- PUID=1234 #CHANGE_TO_YOUR_UID
- PGID=65432 #CHANGE_TO_YOUR_GID
- TZ=Europe/London #CHANGE_TO_YOUR_TZ
- UMASK=022
volumes:
- /volume1/docker/sonarr:/config
- /volume1/data:/data
ports:
- 8989:8989/tcp
network_mode: synobridge
security_opt:
- no-new-privileges:true
restart: always
lidarr:
image: linuxserver/lidarr:latest
container_name: lidarr
environment:
- PUID=1234 #CHANGE_TO_YOUR_UID
- PGID=65432 #CHANGE_TO_YOUR_GID
- TZ=Europe/London #CHANGE_TO_YOUR_TZ
- UMASK=022
volumes:
- /volume1/docker/lidarr:/config
- /volume1/data:/data
ports:
- 8686:8686/tcp
network_mode: synobridge
security_opt:
- no-new-privileges:true
restart: always
radarr:
image: linuxserver/radarr:latest
container_name: radarr
environment:
- PUID=1234 #CHANGE_TO_YOUR_UID
- PGID=65432 #CHANGE_TO_YOUR_GID
- TZ=Europe/London #CHANGE_TO_YOUR_TZ
- UMASK=022
volumes:
- /volume1/docker/radarr:/config
- /volume1/data:/data
ports:
- 7878:7878/tcp
network_mode: synobridge
security_opt:
- no-new-privileges:true
restart: always
readarr:
image: linuxserver/readarr:develop
container_name: readarr
environment:
- PUID=1234 #CHANGE_TO_YOUR_UID
- PGID=65432 #CHANGE_TO_YOUR_GID
- TZ=Europe/London #CHANGE_TO_YOUR_TZ
- UMASK=022
volumes:
- /volume1/docker/readarr:/config
- /volume1/data/:/data
ports:
- 8787:8787/tcp
network_mode: synobridge
security_opt:
- no-new-privileges:true
restart: always
bazarr:
image: linuxserver/bazarr:latest
container_name: bazarr
environment:
- PUID=1234 #CHANGE_TO_YOUR_UID
- PGID=65432 #CHANGE_TO_YOUR_GID
- TZ=Europe/London #CHANGE_TO_YOUR_TZ
- UMASK=022
volumes:
- /volume1/docker/bazarr:/config
- /volume1/data/:/data
ports:
- 6767:6767/tcp
network_mode: synobridge
security_opt:
- no-new-privileges:true
restart: always
I have split out Prowlarr as you may want this running on a VPN connection if your ISP blocks certain indexers. If not copy this section into your compose as well. See my Gluetun guides for more information on adding to a VPN.
prowlarr:
image: linuxserver/prowlarr:latest
container_name: prowlarr
environment:
- PUID=1234 #CHANGE_TO_YOUR_UID
- PGID=65432 #CHANGE_TO_YOUR_GID
- TZ=Europe/London #CHANGE_TO_YOUR_TZ
- UMASK=022
volumes:
- /volume1/docker/prowlarr:/config
ports:
- 9696:9696/tcp
network_mode: synobridge
security_opt:
- no-new-privileges:true
restart: always
Editing the Compose & Environment Variables
Please keep in mind that yaml formatting is very specific, so keep things lined up as per the original.
The compose contains all the Arr’s in the overall stack, you can remove any you don’t plan on using by deleting their entire section in the code.
We need to make some minor edits to the compose file in order to make sure the containers use the ‘dockerlimited’ user we created earlier and also let them know which timezone we are located. You will need to edit these in each section noted with ‘#change me’
Variable | Value |
---|---|
PUID= | Change it to the UID you obtained earlier in the first setup guides |
PGID= | Change it to the GID you obtained earlier in the first setup guides |
TZ= | You will need to change this line to your own timezone code – you can find the correct list of ones to use on wikipedia.org/wiki/List_of_tz_database_time_zones |
Once you have made all your required edits click ‘Next’
Nothing to change on the next screen click ‘Next’ again..
On the final screen just click ‘Done’ and you will see a new window appear which will kick of downloading of the required container image and configure the containers.
This can take a couple of minutes to finish as all the images are downloaded and extracted. You should see ‘Code 0’ when it has finished.
Once finished you will see the Project is running with a green status.
Firewall Exceptions
(Skip if you don’t have the Firewall configured)
If you have the Synology Firewall enabled please see this additional guide for further info on exceptions and correct set up.
Containers are ready to use
You will now be able to access each of the containers on their respective ports.
App | Address (not https://) |
---|---|
Lidarr | http://NASIP:8686 |
Radarr | http://NASIP:7878 |
Sonarr | http://NASIP:8989 |
Readarr | http://NASIP:8787 |
Bazarr | http://NASIP:6767 |
Prowlarr | http://NASIP:9696 |
Please see the next section which covers the ‘basics’ of each application setup as these usually catch people out. Full documentation can be found on https://wiki.servarr.com/
Key Settings within the Arrs
Settings > Media Management > Root Folders
Each of the Arr’s refer to the place(s) you keep your media as ‘Root Folders’. These are where the app will ultimately move your music/movies/books/shows once they finish downloading. Use the table below to set each of your folders correctly.
You will see other folders when you first browse for the /data folder it is located in the top level folder.
App | Root Folder |
---|---|
Lidarr | /data/media/music |
Radarr | /data/media/movies |
Sonarr | /data/media/tv |
Readarr | /data/media/books |
Bazarr | Not required |
Prowlarr | Not required |
Permission Issues (User ABC doesn’t have permission to access folder)
If you get this error when trying to add your Root folders check the following:
- Your PUID and PGID are set correctly and the right way round in the compose
- The ‘dockerlimited’ user has read and write permissions showing in the Control Panel > Shared Folders > Permissions
- If the above has not worked go back to the User creation guide and see the section ‘Permission Fixes – only use if you have issues‘ for a couple of commands that will fix things.
Settings > Media Management > Remote Path Mappings
While most of the settings on this page are self-explanatory something that has caught people out is the Remote Path Mappings setting. If you are hosting all your services on the same NAS and in Docker do not add any settings here.
Settings > Download Client(s) > Add your Client > Host and Port
As our containers are all running on the ‘Synobridge’ custom bridge we can use the Gateway IP for this bridge for inter container networking. This will be 172.20.0.1 and the appropriate port for your Client assuming it is running in Docker!
You should now have the basics in place and I 100% recommend having a look at the previously mentioned https://wiki.servarr.com/ documentation as it will help you understand how the Arrs work.
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.
Hey Doc, love your guides.
Quick question, when updating arr containers, I’ve found the synobrige IP address changes, which then requires me to reconfigure them so they can talk to each other. Is there a way to assign them a static IP on the synobrige network?
Thanks!
Hey Jon, use the bridge gateway IP of the synobridge 172.20.0.1 it will handle which container the data goes to and wont change.
Amazing, thanks! I missed the context of the gateway IP in your guide. Works now!
Hello.
I just wanted to know from the creator if this can work with a DS1522+ (32GB of RAM). Deploying in Portainer.
Incredible guide BTW!
Mail attached is not fake. I can also reply 🙂
Hey – Yes it can be deployed using Portainer, the compose is universal so you just need to follow the other bits around folder creation etc.
First of all amazing tutorials it helped me a lot.
I have a question regarding qBittorrent & ARR. Maybe i skipped something in settings not sure about it.
When i get a file it save it in folder /data/download/completed but it makes also a copy in /data/media/tv etc
Is it a way to just have a file and not duplicated files.
Hopefully you could help me with it.
Thank you
Hi Zizi – I will get this added to the FAQ – The file is hard linked, so only a single file exists but linked from both places allowing torrents to seed. Once you want to remove from qbit the link is removed leaving just the final file in your media folder.
Thank you for the reply
Hi Dr,
I’ve run through the ARR stack media-project and am logged in to Sonarr trying to configure it.
Im trying to set Root Folders of Sonarr but am getting the error:
Unable to add root folder
Folder ‘/TV0-N/’ is not writable by user ‘abc’
If I specify another folder to test, it works fine.
I am almost postitive that this issue is due to the filepaths having spaces in them.
/volume1/Media/MEDIA/TV/TV 0-N
Is there anything I can do to resolve this issue? Single \ Double quotes or brackets?
Changing the filepaths to remove the spaces isnt really an option at the moment.
services:
sonarr:
image: linuxserver/sonarr:latest
container_name: sonarr
environment:
– PUID=1031 #CHANGE_TO_YOUR_UID
– PGID=65541 #CHANGE_TO_YOUR_GID
– TZ=Europe/London #CHANGE_TO_YOUR_TZ
– UMASK=022
volumes:
– /volume1/docker/sonarr:/config
– /volume1/data:/data
– /volume1/Media/MEDIA/TV/TV 0-N:/TV0-N
– /volume2/Files/MEDIA2/TV/TV O-Z:/TVO-Z
ports:
– 8989:8989/tcp
network_mode: synobridge
security_opt:
– no-new-privileges:true
restart: always
Hey Donald, looks like you have a split issue… First I would keep the mount points consistent inside and outside the container, and to sort the spaces you can quote the whole line..
https://paste.drfrankenstein.co.uk/?93867c208402fbac#9eaZVmc4qKv7nZRB4tzsZngPixGVWnMrvhNRKWAKcLGD
Secondary the permissions issue, I would ensure your dockerlimited user and group have the been assigned read/write permissions to your media and files folders. You can do this either in Control Panel or directly in Filestation.. If you are having trouble with the permissions the User and Group guide has some permission fix commands you can run on those folders (swap the paths in the examples to your /volume1/Media/ and /volume2/Files
i followed the guide step by step from setting up director and network bridge etc.
once setup the arrs
going in to them i have 2 issues
1 – cannot get to nzbget on 172.20.0.1 (but can on the 192.168.86.15 NASIP). i have checked firewall is off. and the bridge IP range is correct
2- You are using docker; download client nzbget places downloads in /data/usenet/completed/Series but this directory does not appear to exist inside the container. Review your remote path mappings and container volume settings.
i setup the directory structure as you set out
i ran your docker compose as is (changing the env vars you said to change)
Hi Ryan
On number 1 I have seen this before and sometimes for whatever reason a reboot of the whole NAS clears up weird docker networking issues. It feels like a bug at this point, but I can’t see under the hood to say for sure.
On 2 check if the final Series folder is either `Series` or `series` as a capital letter will be considered two different folders – so NZBGet will be telling the Arrs that path but if the folder is differently named it will error.
If either of these still give you issues shout back as we can fix them as they are common errors