文档导览

这个页面按任务组织文档入口。它不是配置参考的替代品，而是帮助你判断先读哪一页、每一页解决什么问题。

角色路径

我要把服务跑起来最短路径启动 PostgreSQL、Redis 和 SyncTV，并验证服务可访问。

我要准备生产环境检查 secret、数据库、Redis、反向代理、Ingress、存储、监控、备份和升级策略。

我要理解整体架构了解单二进制服务、网络入口、状态层、媒体代理、slice cache 和集群模型。

我要理解认证安全确认密码、WebAuthn、邮箱、OAuth2、用户 2FA、token 上下文和 management 控制面边界。

我要管理生产实例按用户、房间、审核、Provider、runtime settings、system 和 slice cache 理解管理操作。

我要理解权限解释全局角色、房间角色、权限位、房间设置、成员权限覆盖和用户偏好。

我要排查故障按现象定位启动、配置、部署、认证、代理、直播和集群问题。

我要做备份恢复确认 PostgreSQL、secret、配置文件、HLS、Redis 状态和恢复演练步骤。

我要说明数据保留说明个人信息、Provider 凭据、审计日志、通知、聊天、备份和后台清理策略。

我要规划升级处理 migration、Compose/Helm 发布、滚动更新、配置快照和回滚风险。

我要接入观测配置健康检查、metrics、日志、关键告警和事故信息收集流程。

我要查某个配置项按配置结构列出字段、类型、默认值、环境变量和详细说明入口。

我要查热更新设置列出 runtime settings 的 key、默认值、校验规则、同步语义和 CLI 示例。

我要一份配置模板提供最小生产配置骨架和覆盖全部静态字段的全量 YAML 示例。

我要理解配置来源解释默认值、配置文件、环境变量、secret 文件、CLI 覆盖和 data_dir 路径解析。

我要部署到 Kubernetes 说明 Helm values、HTTP/gRPC 独立 Service、独立 Ingress、metrics 和外部依赖。

我要接入外部媒体源说明 Alist、Emby、Bilibili、直链、Provider instance、请求头和凭据加密。

我要排查代理缓存解释业务缓存、代理 slice cache、Range 行为、存储目录、TTL 和容量控制。

我要接入 API 说明如何启用 openapi feature，并访问 Swagger UI 与 OpenAPI JSON。

我要写客户端或 SDK 说明登录、MFA、OAuth2、WebSocket、gRPC room metadata、媒体 header 和 token 处理方式。

配置页很细，建议不要从头到尾线性阅读。先按运行所需依赖确认基础配置，再按启用的功能模块进入对应页面。

基础运行

必读先读服务监听、运行时路径、安全密钥、数据库与 Redis。

访问控制

继续读 CORS、可信代理、限流、邮件、OAuth2、WebAuthn 和用户安全相关配置。

媒体能力

如果启用媒体源或代理缓存，阅读 Provider、cache/proxy、直播和 WebRTC 文档。

横向扩展

如果多副本运行，阅读 cluster、Redis、Helm、Ingress、HLS 存储和 metrics 文档。