Skip to content

Usenet streaming with a WebDAV server and a SABnzbd-compatible API

C#
1.8 KB
Raw Blame

Contributing

Set up your system

The project consists of two sub projects: frontend and backend Both share some necessary environment variables.

Ensure that frontend and backend share the same environment configuration!

Environment variables:

export CONFIG_PATH=/where/to/create/database/
export FRONTEND_BACKEND_API_KEY=$(head -c 32 /dev/urandom | hexdump -ve '1/1 "%.2x"')
export BACKEND_URL=http://localhost:5000

You need some packages in order to run the project:

  • dotnet-sdk
  • aspnet-runtime
  • nodejs
  • npm

Example installation for Arch based systems:

sudo pacman -S dotnet-sdk aspnet-runtime nodejs npm

Build / run backend

cd backend

# Build (release)
dotnet publish -c Release -o ./publish

# Create database
mkdir -p $CONFIG_PATH
./publish/NzbWebDAV --db-migration

# Run backend
./publish/NzbWebDAV

Build / serve frontend

cd frontend

# Install dependencies
npm install

# Run / serve frontend with hot module replacement
npm run dev

Build Docker image

Using Docker CLI

In the root directory, run:

docker build .

You can also tag the release, which can be used with docker compose:

docker build -t example/nzbdav:test_build .

Run the container:

docker run --rm -it \
  -v /path/to/nzbdav/config:/config \
  -e PUID=1000 \
  -e PGID=1000 \
  -p 3333:3000 \
  example/nzbdav:test_build

Using Docker Compose

services:
  nzbdav:
    build: .
    ports:
      - 3333:3000
    volumes:
      - /path/to/nzbdav/config:/config
      - /path/to/nzbdav/data:/data
    environment:
      - PUID=1000
      - PGID=1000

Build and run container:

docker compose up

Contributing

You might check types before creating a PR:

cd frontend
npm run typecheck