docker nzbget
v24.3-ls167
The LinuxServer.io team brings you another container release featuring:
Find us at:
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.
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: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 |
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 nzbget releases |
| testing | ✅ | nzbget pre-releases |
Webui can be found at
login:nzbget, password:tegbzn6789
To allow scheduling, from the webui set the time correction value in settings/logging.
You can add an additional mount point for intermediate unpacking folder with:-
-v /path/to/nzbget/intermediate:/intermediate
for example, and changing the setting for InterDir in the PATHS tab of settings to /intermediate
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 don't understand, or don't want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
services:
nzbget:
image: lscr.io/linuxserver/nzbget:latest
container_name: nzbget
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- NZBGET_USER=nzbget #optional
- NZBGET_PASS=tegbzn6789 #optional
volumes:
- /path/to/nzbget/data:/config
- /path/to/downloads:/downloads #optional
ports:
- 6789:6789
restart: unless-stoppeddocker run -d
--name=nzbget
-e PUID=1000
-e PGID=1000
-e TZ=Etc/UTC
-e NZBGET_USER=nzbget `#optional`
-e NZBGET_PASS=tegbzn6789 `#optional`
-p 6789:6789
-v /path/to/nzbget/data:/config
-v /path/to/downloads:/downloads `#optional`
--restart unless-stopped
lscr.io/linuxserver/nzbget:latestContainers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate -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.
| Parameter | Function |
|---|---|
-p 6789 |
WebUI |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Etc/UTC |
specify a timezone to use, see this list. |
-e NZBGET_USER=nzbget |
Specify the user for web authentication. |
-e NZBGET_PASS=tegbzn6789 |
Specify the password for web authentication. |
-v /config |
Persistent config |
-v /downloads |
Location of downloads on disk. |
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariableWill set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.
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.
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:
id your_userExample output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
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.
Shell access whilst the container is running:
docker exec -it nzbget /bin/bashTo monitor the logs of the container in realtime:
docker logs -f nzbgetContainer version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbgetImage version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nzbget:latestMost of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Update images:
All images:
docker-compose pullSingle image:
docker-compose pull nzbgetUpdate containers:
All containers:
docker-compose up -dSingle container:
docker-compose up -d nzbgetYou can also remove the old dangling images:
docker image pruneUpdate the image:
docker pull lscr.io/linuxserver/nzbget:latestStop the running container:
docker stop nzbgetDelete the container:
docker rm nzbgetRecreate 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:
docker image pruneTip
We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-nzbget.git
cd docker-nzbget
docker build
--no-cache
--pull
-t lscr.io/linuxserver/nzbget:latest .The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --resetOnce registered you can define the dockerfile to use with -f Dockerfile.aarch64.
