Skip to content

Setting up SABnzbd in Docker on a Synology NAS

This is the first part of a series showing you how to setup Usenet Automation using Docker on a Synology NAS.

I have been using the Synology community packages for quite some time as they were convenient to install from package manager but with recent iterations of DSM these packages quite often fail to install or even run, and its never clear what low level system changes they are making. So now that Docker is available for most Intel based Diskstation’s I decided to jump ship.

In this first guide I will take you through getting SABnzbd up and running within Docker.

What is Docker?

Docker is an open platform for developers and sysadmins to build, ship, and run distributed applications, these application are distributed as Containers.

What is a Container?

A container is kind of what it says on the box, it contains everything that is required to run a particular application. you simply download a pre packaged image someone has already built and it will run within Docker, this means it makes no changes to your system and can easily be backed up if you even need to move it elsewhere.

Onto the Guide

This guide makes some assumptions that you have a general knowledge of the DSM interface and how to do the basics.

What I will be covering

  1. Installing Docker
  2. Getting PGID and PUID
  3. Downloading the Images
  4. Setting up Sabnzbd

Installing Docker

First things first you need to head into Package Center and search for Docker, install it to which ever volume you want, I personally have my apps on a dedicated SSD which keeps things snappy.

Package Center Docker

When you first open docker you will be asked if you want to read the help guides, you can choose if you want to do this. You will then be greeted by the overview tab, this will give you some overall usage stats for CPU and Memory, and once installed it will list running containers, my 412+ has been upgraded to 2Gb of RAM when it was my main NAS.

Before we proceed any further with downloading and installing containers we need to make sure any shares we have are setup and ready.

PGID and PUID

In the previous versions of these guides I used a long winded approach to getting your ID information, I have since found a much easier approach.

You will need to SSH into your Diskstation using ‘Putty’ or an equivalent program.

Open up Putty, the only thing you need to enter is the IP address of your NAS and select the SSH radio button.

putty

Click on open, you will get a prompt asking if you trust the key, if this is the first time you have used SSH, just press OK or accept.

Enter the login information for you Synology user account, you will not be able to see the password as you type it, I use a very long one so I just paste it in from my password manager. (right click acts as paste in putty)

Once logged in type ‘id’ without the quotes and this will show your UID(aka PUID) which in my case is 1026 and the GID(aka PGID) which is 101 for an administrator

putty02

Downloading the Image

Head back into Docker and click on the Registry tab on the left hand side, the registry is where you search all of the available docker images on Docker.com. In the search box enter SABnzbd.

sabnzbd01

Click on the image made by Linux|Server.io as this will always be kept up to date. Click on Download.

sabnzbd02

After a few seconds the image will begin downloading this can be tracked in the ‘image’ tab, once the download has completed you will get a system message and the little blue animation to the right will stop.

Setting up SABnzbd 

Now we have our image downloaded we are ready to start setting up,  click on ‘Launch’ in the section at the top of the window. This doesn’t actually launch the app the wording is a little misleading, it essentially launches the settings.

newsab01

The initial screen you are greeted with allows you to change the container name and resource restrictions, In this case I am leaving this all at its default.

Click on Advanced Settings, on the first screen you see enable auto restart as this will mean SABNZBD will automatically start up if you ever reboot your NAS.

newsab02

‘Port Settings’

The port settings are extremely important, do not leave them to Auto as you will have to look up the port number every single time the container is restarted and it will screw with all your other containers as they will not be able to talk to each other.

Change the local ports to something you will remember as long as its between 32768 – 61000, for this tutorial I am using the ports below.

Local Port = 32700
Container Port = 8080 (SAB’s Non SSL Port)

Local Port = 32701
Container Port = 9090 (SAB’s SSL Port)

Press Next..

newsab04

‘Volumes’

Then click on volumes, we are now going to set up the shares we want to mount. SABNzbd only needs access to two folders.

Under the ‘Docker’ share on your Diskstation create a folder called ‘sabnzbd’ this is important as your configuration files will be stored here. We do the same thing for all the other guides.

And then also add your downloads folder, this can be where ever you want to download your files. It should look like the screenshot below.

 

Environment Variables (PGID, PUID and Timezone)

Next we are going to setup a couple of Environment variables this is the user details we took note of earlier in the guide, this allows the Docker image to have the right access to the shares we just added. In addition we are also required to set the timezone for the container you can find a list of zones on wikipedia https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

In the environment tab enter the details as shown in the screenshot, but change them to whatever yours were noted as.

PGID, PUID and TimeZone

Click OK and this will take you back to the summary screen we saw earlier.

All Done!

Once you have entered all the details click OK to go back to the summary screen press Next, we are ready to roll, tick the  ‘Run this container….’ box and hit apply. after a few seconds you will see the container running in the container tab. open up a browser window and enter the IP address of your NAS followed by the port number used for the Non SSL port.

sabisrunning
Up and running

You should see the SAB wizard so you can start to configure as you normally would.

If you have any questions please feel free to comment below.

Published inDockerSynology

19 Comments

  1. Rossi Rossi

    Great guide! Really looking forward to your Sonarr & CP guides. I’m also trying to get NzbGet up and running but I fail to save the settings once the container restarts. I’d be interested to see if you have any insights into how to solve the issue?

    • Dr_Frankenstein Dr_Frankenstein

      Once I have finished the other two guides I will have a look and NZBget. The Sonarr one should be up tomorrow at worst.

    • Dr_Frankenstein Dr_Frankenstein

      The NZBget guide will be up later today

  2. Kurt Kurt

    Hey drfrankenstein,

    Great tutorial, manage dot get SABnzbd working.

    Just 1 question, I use the PostProcessing Script CharTranslator.py , but now I dont know which folder to select?
    Before the container application, it used to be /usr/local/sabnzdb/var/script
    But that doesnt exist anymore…

    Kind regards,
    Kurt

  3. Mikael Mikael

    Hi,

    Thanks a lot for the tutorial!

    Could you give some more information regarding the mapping of folders?

    Thanks,
    Mikael

  4. Scott McNabb Scott McNabb

    Hi,

    I am a little confused on the “Volumes” section (the screenshot links to the ‘summary’ page, not volumes).

    I’m not sure what exactly to put for the Mount Path.
    I have File/Folder of “/downloads/sabnzbd” set to “/downloads”.
    I have File/Folder of “/docker/sabnzbd” set to “/sabnzbd”.

    (As per screenshot http://imgur.com/a/9DHgV).

    I’ve done a few test downloads and they seem to go to the right place, being my ‘downloads’ shared folder. But don’t know about the other one or if the config is being saved.. Help?

  5. Tom Tom

    I have Sonarr installed and working, emby installed and working, but cannot for the life of me get SABnzbd set up. I’ve run through the install process about a dozen times, trying everything I know of. Each time, the container shows SABnzbd running, on the ports I assigned, but when I try to open it in a browser window, I get “This site can’t be reached

    xx.x.x.xxx refused to connect.”

    I am an absolute Docker newbie, so any and all help sincerely appreciated.

    Tom

  6. Harry Harry

    Excellent guide, it’s running perfectly on my Synology now. Can you also explain how to upgrade sabnzbd when running it in a docker container? The version inside my docker is still 1.1.1 while version 1.2.3 is the latest version. Thanks!

    • Dr_Frankenstein Dr_Frankenstein

      I wrote a long reply on my mobile but since I enabled the captcha’s on comments (to stop the massive amount of spam) the app doesn’t let me reply grrr. I will see if I can update the post on how to update.

      • Harry Harry

        That would be great, looking forward to it.
        Thx!

      • Paul Incley Paul Incley

        Hi! This was such a helpful guide, thank you! Would also love to hear how to update SABnzbd.

      • Joris Joris

        Hey man, any updates on this?
        I’d like to go from 2.0.0 to 2.1.0

        • Dr_Frankenstein Dr_Frankenstein

          If you have followed the guide all your SAB settings are in the config folder, this means you can just remove the whole docker image download the latest copy and just setup the docker image again. all your settings will then be carried across.

  7. Scott Scott

    As per the last comment, I’m also not sure how to update sab – sonarr/couchpotato appear to update themselves within the container, but sabnzbd does not.

  8. James James

    I had to use a different version of sab. The current iteration uses /datadir instead of /config and it does not let you change the complete and incomplete folders to a level up folder. It had all sort of read write issues.

    • Dr_Frankenstein Dr_Frankenstein

      I will revisit the guide this week as I am on Holiday so will have lots on my own time 🙂

    • Dr_Frankenstein Dr_Frankenstein

      Hey, was this definately the Linux|Server build as their guidance doesn’t suggest there has been a change.

  9. NightShaman NightShaman

    I am moving over to Docker for all my media apps. I usually use categories in sabnzbd in the downloads folder so my other apps know where to pick them up from, and move them to the correct folder. When I use volumes to pick my download folder I do not see the sub folders for my categories in it. are you not able to use categories in a container?

  10. Glenn Glenn

    Don’t know if this is the best place ot post.. dont know where in reddit to post, but when i use SABnzDB on my 1815+ 2GB Synology, i keep getting Volume Utilization of 100% every now and then.
    Everything churns to a stop, cant copy files, plex stops working..
    I close SAB on docker and it all drops down within moments to normal levels.
    Running 5 x 6TB RED WD drives in SHR…

Leave a Reply

Your email address will not be published. Required fields are marked *