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: 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 ! thx you for your guide !
Very noob question.
Do we need to keep all these services behind a VPN ? or the only service behind the VPN should be the “downloader” (qBittorent in my case) ?
In either way, can we you this guide with qbitorrent being behind a vpn ? (from one of your other guides), or do we need to change stuff ?
Thx you !
Hey so no need for the Arr’s to be behind the VPN so you can do this setup and the GlueTUN and Qbit setup independently and they can all talk to one another.
Ok thank you, a beer well deserved !
You can keep *arr apps and nzb downloaders out of vpn but keep torrent downloaders (Qbittorrent/Deluge) and indexer managers (Prowlarr/Jackett/NZBHydra2) in Gluetun’s docker compose.
It will save you from a lot of troubles and speed issues as providers have started to struggle torrents and indexers as much as possible!
Just my 2c…
Thank you so much for this guide! Everything works perfectly 🙂
Glad its working 🙂
I have been super impressed by this guide and have successfully built my homelab following your instructions … so firstly thanks!!
Do you use a Homepage/Dashboard tool that pulls all this together into a single interface?
I’d be interested to know your preference and even more keen to see the installation instructions 🙂
Hey, I have tried a few over the years I am currently using Flame just as its nice and simple with just links. I know some people use Homepage, Homer etc. Check the github page for the one you want use and generally they have a compose file which you can essentially compare to how the ones work on here. Feel free to message me if you get stuck. I need to start work on a couple of new guides.
Hiya – I tried Flame and homepage but didn’t like them so went for Homarr in the end … which I really like.
As a form of giving back, this is the YAML I used which worked v well within the ecosystem you have guided me to !!
version: ‘3’
#———————————————————————#
# Homarr – A simple, yet powerful dashboard for your server. #
#———————————————————————#
services:
homarr:
container_name: homarr
environment:
– PUID=1234 #CHANGE_TO_YOUR_UID
– PGID=56789 #CHANGE_TO_YOUR_GID
image: ghcr.io/ajnart/homarr:latest
restart: unless-stopped
volumes:
– /var/run/docker.sock:/var/run/docker.sock # Optional, only if you want docker integration
– /volume1/docker/homarr/configs:/app/data/configs
– /volume1/docker/homarr/icons:/app/public/icons
– /volume1/docker/homarr/data:/data
ports:
– ‘7575:7575’
network_mode: synobridge
security_opt:
– no-new-privileges:true
Thanks Dr_F
Thanks for this. I have started working on some new guides after a break, aiming to get one out every couple of weeks (but limited to the ones I am using)
Good morning and THANK YOU!!!!
Another question…
After getting all the Arrs up and running, the final step has got me perplexed… adding download clients.
I assume I choose Torrents\Deluge since that is the Project I created using this guide with Deluge & AirVPN.
I am changing the host to 172.20.0.1, but am getting an authentication error with the password already filled in. I have tried the dockerlimited password with no luck. When launching all the Arrs for the first time, I was forced to create remote user account, which I used the same credentials for all the Arrs. I chose to disable authentication for Local Addresses.
Thoughts?
Hey
So the deluge password will be whatever you set it to when you went through the guide. It’s not the password for the dockerlimited account. The arrs do now force you to create logins for them due to the amount of people exposing them to the internet without login details!
Hey mate, thanks for all these guides. I’ve set up the docker user & group as you set out, but when I spin the aars up, they all have a line in the log that says “[Info] AppFolderInfo: Data directory is being overridden to [/config]”. The app still deploys, but the internal /data folder is empty.
Their volumes are all set up like this:
volumes:
– /volume1/docker/sonarr:/config
– /volume1/data/:/data
I tried it like this too:
– /volume1/docker/sonarr:/config
– /volume1/data:/data
I’m pretty sure I have the folder permissions set correctly (your other guides have worked as they should)
Any ideas? Thanks again!
Hey
Triple check the PUID/PGIDs are correct as this is the no1 reason for issues usually. Failing that can you jump back to the User and Group guide, at the bottom you will see some permissions fix commands.. Odd that it would just be one of them playing up!