Rooms
Members, playlists, chat, permissions, and current playback state are organized around rooms. See Rooms.
SyncTV Documentation
A self-hosted synchronized watching app organized around rooms, playback, chat, media sources, and members.
Rooms are the daily entry point in SyncTV. Users watch, chat, and switch playlists in rooms. Room administrators manage members and permissions. Platform administrators maintain accounts, reviews, Providers, livestreaming, and runtime policy.
These docs are organized by task. Start with “Use SyncTV” for the product experience, “Administer SyncTV” for instance management, “Install and Upgrade” for deployment, and “Develop with SyncTV” for client integration.
Choose a Path
Section titled “Choose a Path” Use SyncTV Sign in, join rooms, synchronize playback, chat, add media, and manage personal settings.
Administer an Instance Manage users, rooms, reviews, providers, livestreaming, runtime settings, and maintenance tasks.
Install or Upgrade Choose Compose, source runs, or Helm/Kubernetes and complete production checks.
Build a Client Use OpenAPI, gRPC, WebSocket Realtime, tickets, playback info, and errors.
Common Tasks
Section titled “Common Tasks”| Goal | Page |
|---|---|
| Sign in and protect an account | Sign In and Account Security |
| Create or join a room | Create and Join Rooms |
| Fix playback drift or failure | Synchronized Playback and User Troubleshooting |
| Add media | Add Media |
| Manage users, rooms, and reviews | Administer SyncTV |
| Start a self-hosted instance | Quick Start |
| Build a client | Client Integration Guide |
Understand SyncTV
Section titled “Understand SyncTV”Synchronized Playback
The server owns room playback state. Clients follow play, pause, seek, and media changes through Realtime. See Playback Model.
Media Sources
Providers turn Alist, Emby/Jellyfin, Bilibili, direct URLs, remote services, or live inputs into playable results. See Media Sources.
Permissions
Global roles, room roles, member overrides, and room settings decide what each person can do. See Permissions Model.
Before Production
Section titled “Before Production”Production Checklist
Confirm TLS, secrets, PostgreSQL, Redis, backups, metrics, management access, and restore practice.
Runtime Boundaries
Understand PostgreSQL, Redis, secrets, management endpoints, media proxying, and non-goals.
Configuration Entry
Configuration files, environment variables, runtime settings, and CLI overrides have different scopes.
For deployment paths, see Choose a Deployment Path. For runtime dependencies and non-goals, see Runtime Boundaries. For all configuration fields, see Configuration Index.
License
Section titled “License”SyncTV is licensed under the MIT License. See the repository LICENSE file for the full terms.