Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 5.35 KB

README.md

File metadata and controls

120 lines (81 loc) · 5.35 KB

linuxserver.io

The LinuxServer.io team brings you another container release featuring easy user mapping and community support. Find us for support at:

  • forum.linuxserver.io
  • IRC on freenode at #linuxserver.io
  • Podcast covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!

linuxserver/nzbget

Docker PullsDocker StarsBuild Status

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.

nzbget

Usage

docker create \
	--name nzbget \
	-p 6789:6789 \
	-e PUID=<UID> -e PGID=<GID> \
	-e TZ=<timezone> \
	-v </path/to/appdata>:/config \
	-v <path/to/downloads>:/downloads \
	linuxserver/nzbget

This container is based on alpine linux with s6 overlay. For shell access whilst the container is running do docker exec -it nzbget /bin/bash.

You can choose between ,using tags, various branch versions of nzbget, no tag is required to remain on the main branch.

Add one of the tags, if required, to the linuxserver/nzbget line of the run/create command in the following format, linuxserver/nzbget:testing

Tags

  • testing

Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.

  • -p 6789 - NZBGet WebUI Port
  • -v /config - NZBGet App data
  • -v /downloads - location of downloads on disk
  • -e PGID for for GroupID - see below for explanation
  • -e PUID for for UserID - see below for explanation
  • -e TZ for timezone EG. Europe/London

User / Group Identifiers

Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.

In this instance PUID=1001 and PGID=1001. To find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

Setting up the application

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

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" }}' linuxserver/nzbget

Versions

  • 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.