文档导览
普通用户 账号登录、创建或加入房间、同步观看、聊天、添加媒体和个人设置。
平台管理员 用户、房间、成员、审核、Provider、运行设置和维护任务。
部署者 选择单机 Compose、源码运行或 Helm/Kubernetes，并完成上线检查。
客户端开发者 认证、HTTP/gRPC、WebSocket Realtime、播放信息、Provider API 和错误处理。
运维人员 配置校验、观测、容量、备份、升级、密钥轮换和事故排查。
参考查阅 配置字段、环境变量、CLI、Runtime settings、指标、错误和限制。
按产品任务阅读
Section titled “按产品任务阅读”| 任务 | 入口 | 后续页面 |
|---|---|---|
| 登录和账号安全 | 登录与账号安全 | 认证与安全模型、WebAuthn 配置 |
| 创建或加入房间 | 创建和加入房间 | 房间概念、房间、权限与用户偏好 |
| 设置房间权限 | 权限模型 | 房间与成员管理 |
| 添加和播放媒体 | 添加媒体 | 播放模型 |
| 开启直播 | 添加媒体 | 直播配置 |
| 接入客户端 | 客户端集成指南 | SDK 与 API 示例、Realtime API |
| 修改共享实现行为 | 实现契约 | 缓存一致性开发指南、播放后台任务 |
| 处理用户问题 | 用户排障 | 排障入口 |
| 目标 | 起点 | 后续页面 |
|---|---|---|
| 单机自托管 | 快速开始 | Docker Compose 部署、生产部署清单 |
| Kubernetes 部署 | Helm 部署 | 集群配置、观测与运行手册 |
| 修改配置 | 配置文件如何工作 | 配置总索引、常用环境变量 |
| 备份恢复 | 备份与恢复 | 数据、隐私与保留策略 |
| 升级发布 | 升级与迁移 | 发布流程 |
| 事故排查 | 排障入口 | Metrics Catalog、容量规划 |
- 配置文件如何工作
- 安全与密钥
- 数据库与 Redis
- 服务监听与运行时路径
- 按启用功能进入 WebAuthn、邮件/OAuth2、Provider、直播、metrics、cluster 专题页。
| 参考 | 用途 |
|---|---|
| 配置索引 | 静态配置字段 |
| 环境变量 | 环境变量到配置字段的映射 |
| Runtime settings | 可热更新的数据库设置 |
| CLI 参考 | 管理命令 |
| OpenAPI | HTTP API JSON 和 Swagger UI |
| gRPC | gRPC 调试入口 |
| Metrics Catalog | Prometheus 指标名和 labels |
| 错误参考 | HTTP、gRPC、Realtime 和 Provider 错误 |
| 能力限制与非目标 | 当前设计边界和非目标 |