Skip to Content
NZBGet

NZBGet

High-performance Usenet downloader with web interface

NZBGet is a binary downloader that retrieves files from Usenet based on NZB files. Written in C++, NZBGet is renowned for its extraordinary performance and efficiency—using minimal CPU and memory while maximizing download speeds. On QuickBox, NZBGet runs as a per-user daemon with its binary at /opt/username/NZBGet/nzbget and a web interface published through the nginx reverse proxy.

Per-User Binary

Dedicated binary in /opt/<user>/NZBGet with user-owned permissions

Reverse-Proxy Ready

nginx location /username/nzbget with HTTP auth backed by htpasswd

Post-Processing

Built-in scripts copied to /home/<user>/.config/NZBGet/scripts

TLS Artifacts

Self-signed certs and CA bundle created under /home/<user>/.ssl

Usenet Provider Required
Info

NZBGet requires a Usenet provider subscription and an indexer to obtain NZB files. Configure your provider credentials in the NZBGet web interface after installation.


Installation

Have your Usenet provider (news server) and indexer credentials ready — you enter them in the NZBGet web interface after installation.

Install from the Dashboard

Open App Dashboard → Package Management (/dashboard?mode=packages), find NZBGet in the catalog (browse Download Clients or search), and click Install. The dashboard streams the install log live and NZBGet appears in your Application Control panel when it finishes. Reinstall and Remove are in the same Package Management panel. To update, use the amber Update badge on the NZBGet row in the App Dashboard.

What you see and can manage is gated by your account: admins manage any user’s apps; regular users manage their own. For the full package flow see App Management.

Install from the CLI (automation)

The CLI runs the same install and is suited to automation and scripting:

bash
qb install nzbget -u username
CommandDescription
qb install nzbget -u username
Install NZBGet for the specified user (per-user binary + config)
qb reinstall nzbget -u username
Reinstall while preserving config and nginx/service wiring
qb update nzbget -u username
Update NZBGet binary from nzbgetcom/nzbget release feed
qb remove nzbget -u username
Stop service, clean files, and remove DB entries

CLI Options

OptionDescription
-u, --usernameRequired

Target QuickBox username for install/remove/update operations


Directory Layout

Path
Description
/opt/username/NZBGet
nzbget
NZBGet binary executable
nzbget.conf
Default configuration template
scripts/
Built-in post-processing scripts
Path
Description
/home/username/.config/NZBGet
nzbget.conf
User configuration (auto-written with QuickBox defaults)
nzbget.log
Application log
downloads/
MainDir: active downloads
completed/
DestDir: finished files
intermediate/
InterDir: temp staging
queue/
QueueDir: NZB queue data
tmp/
TempDir: temporary working files
nzb/
NzbDir: watch folder
scripts/
ScriptDir: post-processing scripts (built-ins copied here)
nzbget.lock
LockFile
Path
Description
/home/username/.ssl
cacert.pem
CA bundle fetched from curl.se
username-selfsigned.crt
Self-signed cert generated per user
username-selfsigned.key
TLS key; permissions 750

Network & Access

NZBGet binds to localhost on auto-assigned Control/Secure ports (defaults start at 6789/6791 if free). QuickBox publishes the UI through nginx at:

https://yourserver.com/username/nzbget/ 

Auth: nginx uses Basic Auth with /etc/htpasswd.d/htpasswd.username (your QuickBox credentials). Upstream NZBGet control credentials are set to the same username/password and bound to 127.0.0.1.

Proxy details
Info

Traffic terminates at nginx over HTTPS, then proxies to http://127.0.0.1:<assigned_port>/username/nzbget (port is assigned during install and written to the service/nginx configs). The self-signed SecurePort is present but not used by the reverse proxy.

First Login
Tip

After installation, access the web interface to configure your Usenet provider (news servers), indexers, and download categories.


Services

NZBGet uses a templated systemd unit (nzbget@.service) running as a forking daemon:

bash
# Check status
systemctl status nzbget@username
 
# View logs
journalctl -u nzbget@username -f
 
# Restart service
systemctl restart nzbget@username
 
# Reload configuration
systemctl reload nzbget@username

The service starts NZBGet as a forking daemon and restarts it automatically on failure.

Logs
Tip

Runtime logs live at /home/username/.config/NZBGet/nzbget.log.


FileBot Post-Processing (courtesy setup)

QuickBox can wire NZBGet to FileBot during FileBot installation:

  1. Install FileBot with the NZBGet option:
    bash
    qb install filebot -u username -o nzbget -mp /path/to/media
  2. QuickBox drops ~/.config/NZBGet/scripts/nzbget-postprocess.sh and rewrites it with your username and media path.
  3. In NZBGet → Settings → Extension Scripts, add nzbget-postprocess.sh and enable it for relevant categories.
What the script does
Success

Invokes /usr/local/bin/username/filebot with the AMC preset, duplicates to your media path, skips conflicts, and honors /home/username/.filebot/.excludes.


Integrations

NZBGet Integrations

NZBGet works seamlessly with media automation tools.

Media Automation

3

Post-Processing

2

Configuration

You can connect *arr apps directly to NZBGet by providing the following details in their download client settings:

SettingValue
Hostlocalhost
Port443
Use SSLEnabled
URL Base/username/nzbget/
UsernameQuickBox username
PasswordQuickBox user password
Not seeing the URL Base option?
Info

If you are not seeing the URL Base field, click the cog icon to enable advanced settings in the download client configuration.


Browser Download Index

NZBGet gets the same per-user browser file index as the torrent clients. It lists your NZBGet completed-download folder in a dark-themed fancyindex view, which is useful for grabbing a single finished file without loading the NZBGet web interface. The Download Activity panel in the dashboard links to it as Open download folder.

https://your-server-ip/username.nzbget.downloads 
How it works
Info

The nginx config at /etc/nginx/software/username.dlindex.conf serves your NZBGet completed-download folder through the shared fancyindex snippet. By default that is /home/username/.config/NZBGet/completed. Access is protected by auth_basic against /etc/htpasswd.d/htpasswd.username, which is the same credential file used for other QuickBox user endpoints.

  • The listing is the folder set as DestDir in NZBGet (the destination folder in nzbget.conf), not a fixed location. Change it in NZBGet and QuickBox re-renders the index on its own, usually within seconds, with an hourly check as a safety net. If the folder can’t be served (it is a symlink, it is outside your home folder, /mnt and /media, it doesn’t exist, or the web server can’t read it), the index keeps serving the default folder and the dashboard shows a note beginning “Showing the default folder.” See Open download folder for each note.
  • Removing NZBGet keeps your finished downloads. qb remove nzbget deletes the client’s configuration and install files but never the completed-download folder or what is inside it, so the default folder and the path leading to it stay while the rest of ~/.config/NZBGet is deleted, and the remove output names the folder it kept. Reinstalling keeps the folder you had by writing DestDir back into the fresh configuration.
  • If the page fails to load while the rest of the dashboard works, see Downloads / browse index page not loading.

Troubleshooting

Downloads / browse index page not loading

QuickBox builds a per-user nginx fancyindex view of each user’s completed downloads, and NZBGet’s completed folder is included in it. This browse index is a single shared per-user config — /etc/nginx/software/username.dlindex.conf — that covers every download client that user has installed, not NZBGet alone. It has no service of its own.

Symptoms

  • The per-user downloads / file-browse index page fails to load — returns a 502 or 404, shows blank, or errors — while the rest of the dashboard works normally
  • Only the directory-listing page is affected; NZBGet itself keeps running

Resolution

  • Rebuild for one user: qb fix dlindex -u username
  • Rebuild for all users: qb fix dlindex
  • The fix re-renders /etc/nginx/software/username.dlindex.conf, runs nginx -t, and reloads nginx only on a successful test
  • See the qb fix reference: /docs/cli-reference/fix#fix-dlindex

The same fix applies to the browse page for every download client — see the Download Clients overview.


Best Practices

Do

  • Configure multiple news servers for redundancy and completion.
  • Use SSL connections to your Usenet provider.
  • Keep categories aligned with your *arr apps and FileBot scripts.
  • Use qb update nzbget to pull the latest nzbgetcom/nzbget binary.

Don't

  • Do not manually edit systemd or nginx files—use qb commands.
  • Do not store completed downloads in the intermediate folder.

Additional Resources

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

  • Dedicated Support
  • Feature Previews
  • Community Configs
  • Active Discussions
Join Discord Server
Last updated on