--- title: sabnzbd --- # [linuxserver/sabnzbd](https://github.com/linuxserver/docker-sabnzbd) [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fsabnzbd?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fsabnzbd) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-sabnzbd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-sabnzbd) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sabnzbd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-sabnzbd/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-sabnzbd/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-sabnzbd/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/sabnzbd) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sabnzbd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/sabnzbd) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sabnzbd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/sabnzbd) [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-sabnzbd%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sabnzbd/job/master/) [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fsabnzbd%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/sabnzbd/latest/index.html) [Sabnzbd](http://sabnzbd.org/) 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. [![sabnzbd](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sabnzbd-banner.png)](http://sabnzbd.org/) ## Supported Architectures We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). 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-\ | | arm64 | ✅ | arm64v8-\ | | armhf | ❌ | | ## 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 the develop branch | | nightly | ✅ | Latest commits from the develop branch | ## Application Setup Initial setup is done via `http://:` ie, http://192.168.1.100:8080. See the [SABnzbd wiki](https://sabnzbd.org/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](https://github.com/caronc/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](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) 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](https://docs.linuxserver.io/general/docker-compose)) ```yaml --- version: "2.1" services: sabnzbd: image: lscr.io/linuxserver/sabnzbd:latest container_name: sabnzbd environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC 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](https://docs.docker.com/engine/reference/commandline/cli/)) ```bash docker run -d \ --name=sabnzbd \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -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 Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | ### 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: ```bash -e FILE__MYVAR=/run/secrets/mysecretvariable ``` Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` 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](https://en.wikipedia.org/wiki/Umask) 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 your_user` as below: ```bash id your_user ``` Example output: ```text uid=1000(your_user) gid=1000(your_user) groups=1000(your_user) ``` ## Docker Mods [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=sabnzbd&query=%24.mods%5B%27sabnzbd%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=sabnzbd "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") We publish various [Docker Mods](https://github.com/linuxserver/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: ```bash docker exec -it sabnzbd /bin/bash ``` * To monitor the logs of the container in realtime: ```bash docker logs -f sabnzbd ``` * Container version number: ```bash docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd ``` * Image version number: ```bash docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sabnzbd:latest ``` ## Updating Info Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. Below are the instructions for updating containers: ### Via Docker Compose * Update images: * All images: ```bash docker-compose pull ``` * Single image: ```bash docker-compose pull sabnzbd ``` * Update containers: * All containers: ```bash docker-compose up -d ``` * Single container: ```bash docker-compose up -d sabnzbd ``` * You can also remove the old dangling images: ```bash docker image prune ``` ### Via Docker Run * Update the image: ```bash docker pull lscr.io/linuxserver/sabnzbd:latest ``` * Stop the running container: ```bash docker stop sabnzbd ``` * Delete the container: ```bash docker rm sabnzbd ``` * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) * You can also remove the old dangling images: ```bash docker image prune ``` ### Via Watchtower auto-updater (only use if you don't remember the original parameters) * Pull the latest image at its tag and replace it with the same env variables in one run: ```bash docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ --run-once sabnzbd ``` * You can also remove the old dangling images: `docker image prune` !!! warning We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose). ### Image Update Notifications - Diun (Docker Image Update Notifier) !!! tip We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. ## Building locally If you want to make local modifications to these images for development purposes or just to customize the logic: ```bash git clone https://github.com/linuxserver/docker-sabnzbd.git cd docker-sabnzbd docker build \ --no-cache \ --pull \ -t lscr.io/linuxserver/sabnzbd:latest . ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` ```bash docker run --rm --privileged multiarch/qemu-user-static:register --reset ``` Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. ## Versions * **13.09.23:** - Use par2cmdline-turbo in place of par2cmdline. * **16.08.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). * **10.08.23:** - Bump unrar to 6.2.10. * **16.05.23:** - Rebase stable to Alpine 3.18, deprecate armhf. * **15.03.23:** - Switch from p7zip to 7zip, bump unrar to 6.2.6. * **05.03.23:** - Rebase master branch to Alpine 3.17. * **03.10.22:** - Rebase master branch to Alpine 3.16, migrate to s6v3. * **12.08.22:** - Bump unrar to 6.1.7. * **31.07.22:** - Add nightly tag. * **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](https://github.com/sabnzbd/sabnzbd#resolving-dependencies). * **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.