Skip to content

nzbfast: add app - #5992

Open
nzbfast wants to merge 2 commits into
getumbrel:masterfrom
nzbfast:add-nzbfast
Open

nzbfast: add app#5992
nzbfast wants to merge 2 commits into
getumbrel:masterfrom
nzbfast:add-nzbfast

Conversation

@nzbfast

@nzbfast nzbfast commented Aug 15, 2026

Copy link
Copy Markdown

nzbfast 1.1.2

nzbfast is a speed-focused Usenet (NZB) downloader written in Rust: one small binary, low memory footprint, and it saturates a fast line with a handful of connections. Articles are verified as they arrive, so most jobs finish with no separate verify pass, and repair and unpack run only when they are needed.

Packaging notes

  • app_proxy fronts the web UI; nothing is published with raw ports:.
  • PROXY_AUTH_WHITELIST: "/api*,/newznab/api*,/jsonrpc*" - these are the SABnzbd-compatible API, the Newznab search endpoint and the NZBGet JSON-RPC facade. Sonarr/Radarr/Prowlarr and the mobile remotes talk to those and cannot present an Umbrel session cookie, so they authenticate with nzbfast's own API key instead. The container generates a key on first run and refuses to start keyless on a published port, so the whitelisted paths are never unauthenticated. This mirrors what the SABnzbd package does with /api*.
  • Persistence: /config is the install - settings, the API key, the queue, history and the index database - so it is a bind mount under ${APP_DATA_DIR}/data, together with the watch folder. Both source directories are committed with .gitkeep.
  • Downloads use the shared Downloads mount, hence STORAGE_DOWNLOADS in permissions:.
  • No host access: no Docker socket, no privileged mode, no host networking, no device mounts.
  • PUID/PGID 1000: the image's entrypoint starts as root only to adopt the ownership of the bind mounts, then drops to that uid/gid before exec'ing the daemon. That is the supported path upstream exposes, so user: is not forced.

Default credentials

None. There is no login; the app opens straight to the dashboard behind Umbrel auth. The API key that Sonarr/Radarr need is generated per install and shown under Settings → Security, so defaultUsername/defaultPassword are empty rather than fabricated.

Testing

npm run lint:apps -- nzbfast --check-images reports no issues, and git diff --check is clean.

I do not have an umbrelOS device, so the install has not been exercised through Umbrel itself. What has been verified is the container this package runs, deployed from the same compose shape on Linux: it reaches its healthcheck, the dashboard serves, mode=version answers, and mode=queue is refused with API Key Required until a key is presented. Happy to make any changes a maintainer with a device finds.

Screenshots and the logo live at https://nzbfast.github.io/nzbfast/ and in the project repo; say the word and I will attach whatever sizes the App Store assets need. No gallery or icon files are committed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant