Search…
Images
Powered By GitBook
linuxserver/nzbget
Nzbget is a usenet downloader, written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. 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/nzbget 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Version Tags

This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag
Description
latest
Stable nzbget releases
testing
nzbget pre-releases

Application Setup

Webui can be found at <your-ip>:6789 and the default login details (change ASAP) are
login:nzbget, password:tegbzn6789
To allow scheduling, from the webui set the time correction value in settings/logging.
To change umask settings.
scroll to bottom, set umask like this (example shown for unraid)
You can add an additional mount point for intermediate unpacking folder with:-
-v </path/to/intermedia_unpacking_folder>:/intermediate
for example, and changing the setting for InterDir in the PATHS tab of settings to /intermediate

Media folders

We have set /downloads as a optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to 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.
1
---
2
version: "2.1"
3
services:
4
nzbget:
5
image: lscr.io/linuxserver/nzbget
6
container_name: nzbget
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
volumes:
12
- /path/to/data:/config
13
- /path/to/downloads:/downloads #optional
14
ports:
15
- 6789:6789
16
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=nzbget \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-p 6789:6789 \
7
-v /path/to/data:/config \
8
-v /path/to/downloads:/downloads `#optional` \
9
--restart unless-stopped \
10
lscr.io/linuxserver/nzbget
Copied!

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
6789
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
NZBGet App data.
/downloads
Location of downloads on disk.

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:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

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 nzbget /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f nzbget
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbget
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nzbget

Versions

    04.07.21: - Rebase to alpine 3.14
    28.05.21: - Add linuxserver wheel index.
    23.01.21: - Rebasing to alpine 3.13.
    26.10.20: - Fix python dependencies.
    24.08.20: - Fix ignored umask environment variable.
    08.06.20: - Symlink python3 bin to python.
    01.06.20: - Rebasing to alpine 3.12. Removing python2.
    13.05.20: - Add rarfile python package (for DeepUnrar).
    01.01.20: - Add python3 alongside python2 during transition.
    19.12.19: - Rebasing to alpine 3.11.
    28.06.19: - Rebasing to alpine 3.10.
    13.06.19: - Add apprise, chardet & pynzbget packages.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    25.02.19: - Rebasing to alpine 3.9.
    20.01.19: - Add pipeline logic and multi arch, build from source.
    21.08.18: - Rebase to alpine 3.8.
    20.02.18: - Add note about supplemental mount point for intermediate unpacking.
    13.12.17: - Rebase to alpine 3.7.
    02.09.17: - Place app in subfolder rather than /app.
    12.07.17: - Add inspect commands to README, move to jenkins build and push.
    28.05.17: - Rebase to alpine 3.6.
    20.04.17: - Add testing branch.
    06.02.17: - Rebase to alpine 3.5.
    30.09.16: - Fix umask.
    09.09.16: - Add layer badges to README.
    27.08.16: - Add badges to README, perms fix on /app to allow updates.
    19.08.16: - Rebase to alpine linux.
    18.08.15: - Now useing latest version of unrar beta and implements the universal installer method.
Last modified 20d ago