docker-documentation/images/docker-sabnzbd.md

title
sabnzbd

linuxserver/sabnzbd

Sabnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/sabnzbd:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	✅	arm32v7-<version tag>

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag	Available	Description
latest	✅	Stable SABnzbd releases
unstable	✅	Pre-releases from their GitHub

Application Setup

Initial setup is done from the http port.

See the SABnzbd wiki for more information.

nzb-notify

nzb-notify is included with this image as a convenience script. To use it set the Scripts folder in the Folder settings to /app/nzbnotify and then configure it under Notifications. See nzb-notify for more information.

Download folders

In Sabnzbd gui settings, under Folders, make sure to set the Completed Download Folder as /downloads and the Temporary Download Folder as /incomplete-downloads

We have set /incomplete-downloads and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.

Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.

The folks over at servarr.com wrote a good write-up on how to get started with this.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  sabnzbd:
    image: lscr.io/linuxserver/sabnzbd:latest
    container_name: sabnzbd
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/data:/config
      - /path/to/downloads:/downloads #optional
      - /path/to/incomplete/downloads:/incomplete-downloads #optional
    ports:
      - 8080:8080
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=sabnzbd \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 8080:8080 \
  -v /path/to/data:/config \
  -v /path/to/downloads:/downloads `#optional` \
  -v /path/to/incomplete/downloads:/incomplete-downloads `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/sabnzbd:latest

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter	Function
8080	HTTP port for the WebUI.

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
TZ=Europe/London	Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume	Function
/config	Local path for sabnzbd config files.
/downloads	Local path for finished downloads.
/incomplete-downloads	Local path for incomplete-downloads.

Miscellaneous Options

Parameter	Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:
  • docker exec -it sabnzbd /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f sabnzbd
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sabnzbd:latest

Versions

• 10.03.22: - Add nzb-notify.
• 22.02.22: - Rebase master branch to Alpine, build unrar from source, deprecate Alpine branch.
• 25.01.22: - Rebase Unstable branch to Alpine.
• 13.01.22: - Add alpine branch
• 08.08.21: - Bump to focal, dont enforce binding to ipv4 port 8080
• 24.07.21: - Add python3-setuptools.
• 14.05.21: - Use linuxserver.io wheel index for pip packages.
• 12.02.21: - Clean up rust/cargo and pip cache.
• 17.08.20: - Run from source with python3 instead of ppa, remove python2 completely, symlink python to python3.
• 02.01.20: - Add python3 on top of python2 to image during transition.
• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
• 25.02.19: - Rebase to Bionic, add python deps for scripts.
• 26.01.19: - Add pipeline logic and multi arch.
• 13.12.17: - Fix continuation lines.
• 12.07.17: - Add inspect commands to README, move to jenkins build and push.
• 10.04.17: - Bump to 2.0 Release.
• 25.02.17: - Switch to nobetas repo for master/latest branch and add unstable branch.
• 08.02.17: - Add pythonioenconding=utf8 as env.
• 15.09.16: - Compile par2 multicore as per latest info sabnzbd git readme.
• 11.09.16: - Bump to release of 1.10.
• 09.09.16: - Rebase back to xenial, issues with alpine version of python and 1.10 branch of sab.
• 28.08.16: - Rebase to alpine, using git version of sab.
• 17.03.16: - Bump to install 1.0 final at startup.
• 14.03.16: - Refresh image to pick up latest RC.
• 23.01.15: - Refresh image.
• 14.12.15: - Refresh image to pick up latest beta.
• 21.08.15: - Initial Release.