Documentation
Stellarr is a self-hosted text, voice, and video chat for small groups, packaged as a single Docker container.
TIP
To try Stellarr locally in a few minutes, start with the Quick start. Before exposing an instance to friends over the internet, review Requirements for PUBLIC_IP and UDP port forwarding.
Self-hosting
- Quick start: start a local instance with Docker Compose, create the owner account, and test voice.
- Requirements: host resources, published ports, NAT forwarding, and outbound network traffic.
- Configuration: environment variables for production, development, and non-Compose deployments.
- Reverse proxy and TLS: custom TLS certificates, reverse proxy configuration, trusted proxies, and WebRTC ports.
- Unraid: install and update from the Unraid template.
- Upgrading: volume backups, image upgrades, schema updates, and rollbacks.
Administration
- Operator CLI: inspect health, edit settings, rotate secrets, manage sessions, and stage backups with
stellarr. - Account security: second-factor methods, passkeys, OIDC linking, instance MFA policy, and account recovery.
- Automatic backups: scheduled backups, archive verification, local retention, and full or partial restore procedures.
- Cloudflare R2 offsite backups: direct S3 uploads, the Backup Relay Worker, retention, and security notes.
- Activity notifications: opt-in email and Web Push delivery, VAPID key setup, privacy guarantees, and retry behavior.
Reference
- Architecture: container services, Nginx routing, persistent storage, security, and authorization rules.
- RTC and ports: published ports, TURN relay sizing, NAT/firewall rules, and call diagnostics.
- Voice and RTC protocol: SignalR signaling, client state model, audio/video pipeline, screen sharing, and camera profiles.
- Stellarr Media: Rust SFU media server, SDP negotiation, receive subscriptions, downlink adaptation, and loopback control API.
- Localization: interface locales, server message catalogs, client-side Bergamot chat translation, and adding a language.
Component guides
- Stellarr Cockpit: operator panel architecture, localization, and checks.
- Stellarr Media crate: building and testing the
stellarr-mediabinary and the Chromium smoke suite. - Stellarr Init: PID 1 process manager, readiness probes, control socket, and PID-namespace tests.
- Platform templates: packaging rules for non-Compose templates and the Cloudflare backup relay.
- Branding: logo, mascot, color palette, typography, and trademark policy.