Skip to content

v3.8.0 Get started GitHub

Docs

Deploy. Configure. Operate.

Pick the deploy path that fits how you run infrastructure, then go deep with the reference docs. Every page here is rendered from the repository, so it matches the code.

01 Choose your path

From nostream start to blue/green.

Start with Docker Compose. Move to the pre-built image when it's a real server, and to HAProxy when you can't afford a restart.

Fastest way to a working relay on a laptop or a VPS.

~5 min

~/compose

# clone and configuregit clone https://github.com/cameri/nostream.git && cd nostreamecho "SECRET=$(openssl rand -hex 128)" > .env# install the CLI from the checkout and startpnpm add -g .nostream start# with TLS via nginx + certbotRELAY_DOMAIN=relay.example.com CERTBOT_EMAIL=you@example.com nostream start --nginx

Read: Quick start (Docker Compose) →

02 Documentation

Quick start to every last setting.

Start here

Production setup guide

Step-by-step production setup: host requirements, bootstrap, compose, reverse proxy with TLS, and verification.

Read → README.md

Quick start

Requirements, Docker Compose and standalone setup, payments and maintenance.

Read → CLI.md

CLI reference

nostream start, info, config, import/export, invites and the interactive TUI.

Operate

CONFIGURATION.md

Configuration

Every environment variable and settings.yaml key, with defaults.

Read → docs/REDIS.md

Redis

Cache, rate limiting and broadcast fan-out. ACL setup and troubleshooting.

Deploy

deploy/README.md

Production deployment

Minimal Compose stack on a pre-built GHCR image. Bootstrap, settings, services.

Read → docs/DEPLOY-RUNBOOK.md

Deploy runbook & HAProxy

Single-relay and blue/green rollouts, verification, rollback.

Read → docs/DEPLOYMENT.md

Container publishing

How images are built and published from CI.

Project

CONTRIBUTING.md

Contributing

Local development, tests and the changeset workflow.

Read → SECURITY.md

Security policy

Supported versions and how to report a vulnerability.