Skip to content

qooode/nzbdavex

Repository files navigation

NzbDavEx

NzbDavEx is a WebDAV server that presents NZB documents as a virtual filesystem. It exposes standard filesystem semantics (browse, read, and random-access seek) over HTTP(S) without requiring full downloads to local disk, and ships a SABnzbd-compatible HTTP API for integration with compatible automation tools.

This is an extended fork of nzbdav with additional functionality layered on top: a Watchdog module for unattended file verification, multi-provider NNTP support with per-provider usage accounting, an indexers manager with strict-match filtering, search profiles exposing token-scoped search-API endpoints to external clients, and an updated settings UI.

Features

  • WebDAV server: serves a virtual filesystem over HTTP(S)
  • NZB virtualisation: browse and read NZB-described content without downloading
  • Random-access reads: seek support, including within RAR/7z and password-protected archives
  • SABnzbd-compatible API: interoperable with applications that speak the SABnzbd HTTP protocol
  • Multi-provider NNTP: failover between providers and per-provider usage tracking
  • Indexers manager: configure indexer sources from the UI
  • Watchdog: automated verification and re-fetch workflows driven by user-defined rules
  • Search Profiles: token-scoped search-API endpoints with per-profile indexer selection, consumable by any compatible external client
  • Health checks & repairs: detect and replace content no longer available at the source

Getting Started

Pre-built multi-arch images (amd64/arm64) are published to GHCR. Pull the stable image and run it:

docker run --rm -it -p 3000:3000 ghcr.io/qooode/nzbdavex:stable

To persist settings, mount a volume at /config:

mkdir -p $(pwd)/nzbdavex-config && \
docker run --rm -it \
  -v $(pwd)/nzbdavex-config:/config \
  -e PUID=1000 \
  -e PGID=1000 \
  -p 3000:3000 \
  ghcr.io/qooode/nzbdavex:stable

Image tags:

  • :stable — newest stable release (recommended)
  • :1.2, :1.2.0 — pin to a release line or an exact version
  • :edge — latest commit on main (for testing; may be unstable)
  • :latest — alias for :stable

Note

On an IPv6-only host? GitHub Container Registry (ghcr.io) is not reachable over IPv6, so an IPv6-only server can't pull from it. The same images, with the same tags, are mirrored to Docker Hub, which does support IPv6 — pull from there instead:

docker run --rm -it -p 3000:3000 qooode/nzbdavex:stable

Anywhere this guide shows ghcr.io/qooode/nzbdavex, substitute qooode/nzbdavex (Docker Hub).

To update, pull the newer image and recreate the container:

docker pull ghcr.io/qooode/nzbdavex:stable

Build from source (optional)

Prefer to build it yourself? Clone the repo and build with Docker:

git clone https://github.com/qooode/nzbdavex.git
cd nzbdavex
docker build -t nzbdavex:stable .
docker run --rm -it -p 3000:3000 nzbdavex:stable

Once running, open the UI on port 3000 and head to Settings to configure your NNTP providers and WebDAV credentials.

Setup Guide

For a more detailed walk-through covering Docker Compose, Rclone sidecar mounting, performance tuning, and integrations, see docs/setup-guide.md.

License

See LICENSE.

Disclaimer

NzbDavEx is a general-purpose WebDAV server and file-mounting utility. It is provided as-is, without warranty of any kind, express or implied. The software does not host, distribute, or index any content; it only connects to user-supplied third-party services using credentials supplied by the user.

Users are solely responsible for:

  • Ensuring that their use of this software, and of any third-party services configured with it, complies with all applicable laws and regulations in their jurisdiction;
  • Complying with the terms of service of any provider they connect to;
  • The content they choose to access, store, or transmit through this software.

The authors and contributors accept no liability for any use of this software.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors