# Self-host NZBGet

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

- Page: https://levelrail.com/templates/nzbget/
- JSON: https://levelrail.com/templates/nzbget.json
- Category: Media
- Licence: GPL-2.0-only (Copyleft license)
- Source: https://github.com/nzbgetcom/nzbget
- Upstream docs: https://nzbget.com/documentation/

## Requirements
- Memory: about 256 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: f451d98066cbc0c108146420a61a60f7638de50e067738951461e0105eeaa56d

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| nzbget | nzbgetcom/nzbget:v26.3@sha256 | f451d98066cbc0c108146420a61a60f7638de50e067738951461e0105eeaa56d | 6789 | config -> /config; downloads -> /downloads |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| nzbget | NZBGET_PASS | generated |
| nzbget | NZBGET_USER | preset |
| nzbget | PGID | preset |
| nzbget | PUID | preset |
| nzbget | TZ | preset |

## Deploy

### CLI

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

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

### API

```bash
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"
  }'
```

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

## First run
1. Sign in as admin with the generated password, then add your news server under Settings.

## Questions

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

Self-host NZBGet, NZBGet docker compose file, deploy NZBGet on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
