Documentation Map
Start by Role
Section titled “Start by Role” Users Sign in, create or join rooms, synchronize playback, chat, add media, and manage personal settings.
Administrators Manage users, rooms, members, reviews, Providers, runtime settings, and maintenance.
Deployers Choose single-node Compose, source runs, or Helm/Kubernetes and complete launch checks.
Client Developers Use authentication, HTTP/gRPC, WebSocket Realtime, playback info, Provider APIs, and errors.
Operators Validate config, observe health, plan capacity, back up, upgrade, rotate secrets, and handle incidents.
Reference Lookup Look up configuration fields, environment variables, CLI commands, runtime settings, metrics, errors, and limits.
Product Tasks
Section titled “Product Tasks”| Task | Start | Next pages |
|---|---|---|
| Sign in and secure an account | Sign In and Account Security | Authentication and Security Model, WebAuthn and Passkeys |
| Create or join rooms | Create and Join Rooms | Rooms, Rooms, Permissions, and Preferences |
| Configure room permissions | Permissions Model | Room and Member Management |
| Add and play media | Add Media | Playback Model |
| Enable livestreaming | Add Media | Livestream Configuration |
| Integrate a client | Client Integration Guide | SDK and API Examples, Realtime API |
| Change shared implementation behavior | Implementation Contracts | Cache Consistency Development Guide, Playback Background Workers |
| Support user issues | User Troubleshooting | Troubleshooting |
Install and Maintain
Section titled “Install and Maintain”| Goal | Start | Next pages |
|---|---|---|
| Self-host one node | Quick Start | Docker Compose Deployment, Production Checklist |
| Deploy on Kubernetes | Helm Deployment | Cluster Configuration, Observability Runbook |
| Change configuration | How Configuration Works | Configuration Index, Environment Variables |
| Back up and restore | Backup and Restore | Data, Privacy, and Retention |
| Upgrade or release | Upgrades and Migrations | Release Process |
| Handle incidents | Troubleshooting | Metrics Catalog, Capacity Planning |
Configuration Topics
Section titled “Configuration Topics”- How Configuration Works
- Security and Secrets
- Database and Redis
- Server Listener and Runtime Paths
- Continue with WebAuthn, email/OAuth2, providers, livestreaming, metrics, and cluster pages as features are enabled.
Reference Lookup
Section titled “Reference Lookup”| Reference | Use |
|---|---|
| Configuration Index | Static configuration fields |
| Environment Variables | Environment variable to config field mapping |
| Runtime Settings | Hot-reloadable database settings |
| CLI Reference | Management commands |
| OpenAPI | HTTP API JSON and Swagger UI |
| gRPC | gRPC debugging entrypoint |
| Metrics Catalog | Prometheus metric names and labels |
| Errors | HTTP, gRPC, Realtime, and Provider errors |
| Limitations and Non-goals | Current design boundaries and non-goals |