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, 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
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: alwaysI 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: alwaysEditing 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 enabled and configured the Synology Firewall you will need to create exceptions for any containers that have a Web UI or have any incoming or outgoing connections. This section covers the basics of how to add these. (Please note this is a generic section and will not show the specific ports used in this guide however it applies in the same way)
Also, I would like to refer people to the great guide on getting the Firewall correctly configured over on WunderTechs site.
Head into the Control Panel> Security > Firewall, from here click Edit Rules for the profile you set up when you enabled the Firewall.
Next click on Create and you will see the screen below. Source IP and Action will be automatically selected to All and Allow, I will leave it up to you as to your own preference on whether you want to lock down specific Source IPs from having access. In this example we will leave as All.
You will now choose ‘Custom‘ and then the Custom button
Now select Destination from the drop-down menu, most web based containers require TCP access but check the guide as it will show the port and protocol. Then add comma separated ports. Then press OK.
Click OK a couple of times to get back to the main screen. You will see by default the new rule is added to the bottom of the list. You must always have your Block All rule last in the list as the rules are applied top down so move your container up.
You have now completed the Firewall changes and can continue with the guide.
Containers are ready to use
You will now be able to access each of the containers on their respective ports.
| App | Port used |
|---|---|
| Lidarr | NASIP:8686 |
| Radarr | NASIP:7878 |
| Sonarr | NASIP:8989 |
| Readarr | NASIP:8787 |
| Bazarr | NASIP:6767 |
| Prowlarr | 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.
| 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 |
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.
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.
Thanks for the guides.
I came across them a long time ago and have come back to revisit them as I rebuild my 1821+ system. My original setup was and is still very similar to your recommendations. I am a bit different, i that I am now trying to future proof any Docker changes. My directory structure is:
docker
docker/containers/container-names
docker/downloads/usenet & torrents
docker/projects/project-name
media/
I have also started using the .env file. As an example my sonarr docker-compose file looks like this:
sonarr:
image: linuxserver/sonarr:latest
container_name: sonarr
network_mode: ${NET_NAME}
security_opt:
– no-new-privileges:true
ports:
– 8989:8989/tcp
environment:
– PUID=${PUID}
– PGID=${PGID}
– TZ=${TZ}
– UMASK=022
volumes:
– ${CONTAINER_DIR}/sonarr:/config
– ${DOWNLOAD_DIR}:/downloads
– ${MEDIA_DIR}/tv:/media/tv
restart: always
Some of the variables used in this example are reused in ALL my containers, others in a few. The intent is to have 1 .env file that every container gets the variables from. In that way, I can change things in one location and it changes things in all my containers.
The problem I am having is getting it to work. I want to put the .env file in the projects directory at the top level. It would also have to be a relational path not absolute, so something like ../.env.
I have tried
env-file:
– ../.env
but not working.
Any ideas? Also thought it might be something you could write a guide on or use.
Hey good for trying to get .envs going, unfortunately Container Manager doesn’t support them 🙁
You would have to either start the docker compose via SSH or use something like Portainer or Dockge (I need to play with the latter yet)
Thank you for that. I never thought that Container Manager would not support environment. Looks like I will be spinning up Portainer then.
I am sure this has been asked. I setup Sab, Sonarr, Oversarr, and Radarr using previous methods. I finally got around to adding Tautuili using the new Container Manager setup and the Project folder. Is it worth moving previous containers over, or just leave them and use the new method on new ones going forward? Just curious what would be gained, seems straight forward to move them, just if it ain’t broke kinda thing.
Certainly no harm either way to be honest, you will be pointing to the same config file paths as these have not changed at all, some enhancements in relation to security in the compose files etc. As always I would recommend making sure you have a backup just in case!
Backup on R/O Friday, always. I wanted to add Bazarr and Lidarr, I suppose I might as well move them all over. Thanks as always. I’ll shoot you another beer, when, this works. 🙂
Thanks for the beer 🙂
Not surprised, worked great. Beer/coffee sent.
I got the following error for all the containers when I ran the project.
“sonarr ipv4 forwarding is disabled. networking will not work”
“radarr ipv4 forwarding is disabled. networking will not work”
etc.
I can login to all the *arrs but neither sonarr or radarr will return any search results from TMDb or TVDb
The only thing I have been able to find about that via google is that Unifi routers can block them but I have a Tp-link router and don’t have any ad blocking turned on my router.
Can you just initially try rebooting the NAS maybe a setting has not updated correctly under the covers with Docker?!
I think that worked. I have another question regarding the qbittorent w/ gluetun setup but i’ll ask that over on that article. thanks again!
Recently, this has popped up, and i dont know how to fix it…
Unable to write to configured recycling bin folder: /volume2/downloads/Trash. Ensure this path exists and is writable by the user running Sonarr
Did you enable the Recycle bin within the Sonarr config. Its in Settings > Media Management (turn on advanced) and it lets you set a path outside of the default.
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!
I followed your guide so far and I haven’t had any errors yet. A really great and simple to follow guide! thanks!
But I don’t understand this part (I’m noob anyway). Can you explain what needs to be done for example in Sonarr? is HOST: 172.20.0.1 and do I keep the default PORT or change it to the qBittorrent listening port?
Essentially for the various connections you set within Radarr and Sonarr and Prowlarr you can use 172:20.0.1 between them… So in Radarr where it asks for the connection details for qBittorrent you just add this ip and port and it will automatically connect.