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 |
|---|---|
| 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 |
What is SABnzbd?
SABnzbd is a binary newsreader, it is used to download files from Usenet, and where required will also repair and extract releases. It works on its own or in conjunction with other tools such as Lidarr and Radarr.
Let’s Begin
In this guide I will take you through the steps to get SABnzbd up and running in Docker.
In order for you to successfully use this guide please complete the three preceding guides
- Step 1: Directory Setup Guide
- Step 2: Setting up a restricted Docker user
- Step 3: Setting up a Docker Bridge Network
Downloading the SABnzbd Image
Open up Docker within DSM and navigate to the ‘Registry’ tab and search for ‘SABnzbd’.
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.
The pop-up box will ask which version you want to download, make sure you choose ‘Latest’ from the list of available versions.
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 SABnzbd’ 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 SABnzbd starts automatically if you reboot your NAS.
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 SABnzbd will store its configuration files and where download files.
Click on Add Folder, click on the docker share and create a new sub-folder called ‘sabnzbd’ select this folder and click ‘select’
You will now repeat this step but this time adding the /data/usenet folder and then add the Mount Paths as per the table / screenshot below.
| File/Folder | Mount path |
|---|---|
| docker/sabnzbd | /config |
| data/usenet | /data/usenet |
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.
Some final steps
SABnzbd will now be running on port 8080 you can connect to it by going to the IP address of your NAS with that port
e.g. 192.168.0.40:8080
Once you have completed the setup wizard, go into the settings and amend your folders to the following
(Please note, if you have trouble accessing the setup wizard or get an error after the first step. Stop the Docker package in the Package Centre and restart it, or in some cases do a reboot)
After the initial set up you will need to ensure the ‘Folders’ settings are in line with the table/screenshot below.
| Setting | Path |
|---|---|
| Temporary Download Folder | /data/usenet/intermediate |
| Completed Download Folder | /data/usenet/completed |
| Watched Folder | /data/usenet/nzb |
| Historic Updates | Date |
|---|---|
| Added Docker Compose details Added new folder mappings to ensure atomic moves and Hard-linking | 03/05/2021 |
| Guide re-written and updated with DSM7 screenshots | 01/08/2021 |
| Added note about rebooting if you are unable to access the Setup Wizard | 14/01/2022 |
| Updated steps and screenshots for DSM7.1 | 02/07/2022 |
| Added new port settings and Docker Bridge Network | 24/07/2022 |
| Compose version number removed and small wording amendments | 08/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.
I’d like to use a different port for sabnzbd. How can I set that up in the network settings installation?
Hey, when setting up don’t tick the ‘Same as network host’ check box, then on the ports page you will need to change the port that says AUTO to your specified port number, the other port leave as it is.
Worked perfectly, thank you!
Great tune thank you but you’ve missed out on an important bit in the setup in the Categories tab in SABnzbd and this bit has me confused as I know it’s needed.
The other thing that confuses me is that for some unknown reason I cannot for the life of me see Volume 1 to get to my Media. It just won’t show for some reason.
You can add categories if you like, I just cover the initial setup… You won’t see the volumes in the syno GUI they are hidden you just map the shares you require.
Also to add if you add categories don’t add any paths, let Sonarr and Radarr handle the file moves
Can you make one of your guides for installing plex on DM7? I loved the SAB,Sonarr and Radarr guides THANK YOU Very Much!
Yes, it’s in the works.
I just receive a ‘500 Internal Server Error’ when attempting to move to /sabnzbd/wizard/two page on the sabnzbd setup wizard. It seems to be complaining about Pyhton 3.8.
Traceback (most recent call last):
File “/usr/local/lib/python3.8/dist-packages/cherrypy/_cprequest.py”, line 638, in respond
self._do_respond(path_info)
Maybe try downloading the image again.
same.
cause and solution?
Thanks for jumping through some hoops in Discord – The solution seems to be to delete all the files SAB creates at first start up in the /docker/sabnzbd folder and start again… It seems like a bug at startup.
doesn’t seem to resolve my issue. I’ve stopped, deleted the contents of the folder numerous times with no luck. Ive also redownloaded the image and resetup the container with no luck, always get the same “Traceback (most recent call last):
File “/usr/local/lib/python3.8/dist-packages/cherrypy/_cprequest.py”, line 638, in respond
self._do_respond(path_info)”
Very weird, it’s hard to call what could be causing it. As it’s effects some people buy not others. It would be a good idea to post this as an issue on the Linuxserver discord https://discord.com/invite/YWrKVTn
I’m having the same issue. Tried the same things, no luck.
It’s worth reporting this as an issue on Github as it seems to be affecting a number of Synology users
Did you sort this, according to the linuxserver github they fixed this issue last year? did a restart of the container help?
Hi – I never actually got the wizard/two page to load but by restarting my php installation and restarting the containers I was just able to login to the SAB interface without issue, just using the IP:port address. I cannot say why the error happened, I’ve not looked into root cause.
I encountered the same error, and when I checked on the installed packages in my Package Center it had Python2 installed, not Python 3.8. So I just selected Python 3.8 to install, rebooted the NAS, and SABnzdb worked.
The container has all the required packages within it, it must have just been the reboot that fixed it.
Hello, I have had the same problem… I solved it by restarting the NAS…
Thanks a lot for this awesome guide !
I had the same error at the launch but afterwhile it just disappeared
close/restart docker syno package – no need to restart NAS
A couple of people this didn’t work for, I will add to the notes though.
Many thanks for this – this worked perfectly for me on Synology 1821+