Self-host NZBGet with Levelrail

A fast, light Usenet downloader with a web interface and scripting support.

  • Authornzbgetcom
  • LicenceGPL-2.0-only
  • Memory256 MiB
  • Services1

How to self-host NZBGet

  1. Pull the images

    One image is pulled on your server.

    Show images
    • nzbgetcom/nzbget:v26.3@sha256:f451d98066cbc0c108146420a61a60f7638de50e067738951461e0105eeaa56d
  2. Create the app

    One service starts in a single Compose app, with 2 named volume mounts for your data, on port 6789.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 4 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

  • Sign in as admin with the generated password, then add your news server under Settings.

NZBGet requirements

Memory
About 256 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
6789
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
GPL-2.0-only, copyleft license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then NZBGet. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the NZBGet docs page.

Deploy NZBGet your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy NZBGet from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain nzbget=app.example.com.

levelrail-cli templates install nzbget --name my-nzbget

Deploy NZBGet with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/nzbget/install \
  -d '{
    "name": "my-nzbget"
  }'

NZBGet configuration

NZBGet services

ServiceImagePortsVolumes
nzbget nzbgetcom/nzbget:v26.3@sha256:f451d98066cbc0c108146420a61a60f7638de50e067738951461e0105eeaa56d 6789 config -> /configdownloads -> /downloads

NZBGet environment variables

VariableServiceValue
NZBGET_PASS nzbget Generated at deploy
NZBGET_USER nzbget Preset by the template
PGID nzbget Preset by the template
PUID nzbget Preset by the template
TZ nzbget Preset by the template

Ports and volumes

Ports
6789
Volumes
2 named mounts: config -> /config, downloads -> /downloads

NZBGet FAQ

How much memory does NZBGet need?

The catalog lists about 256 MiB of memory for NZBGet.

Does NZBGet run on arm64?

For NZBGet, arm64 support is not confirmed; amd64 is unknown.

What licence is NZBGet under?

NZBGet is licensed under GPL-2.0-only, which is copyleft, so changes you distribute must be shared under the same terms.

Does NZBGet need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does NZBGet use?

NZBGet listens on port 6789 inside the stack.

Where does NZBGet keep its data?

In named volumes: config mounted at /config and downloads mounted at /downloads.

Can I deploy NZBGet on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for NZBGet, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image nzbgetcom/nzbget:v26.3@sha256:f451d98066cbc0c108146420a61a60f7638de50e067738951461e0105eeaa56d is what you deploy there.

levelrail-cli templates install nzbget --name my-nzbget