跳转到内容
SyncTV SyncTV 文档

快速开始

单机生产部署包含一个 SyncTV 进程、一个 PostgreSQL 和一个 Redis。Kubernetes 或多副本部署先完成单机闭环，再进入 Helm 部署 和 集群配置。

前置条件

Section titled “前置条件”
  • Docker 和 Docker Compose 可用。
  • openssl 和 python3 可用于生成环境文件。
  • 当前目录可以长期保存 Compose 文件、.env.postgres、.env.redis、.env.synctv 和数据卷。
  • 已准备 root 用户密码。生产环境使用密码管理器生成。

启动

Section titled “启动”

  1. 创建目录并下载 Compose 文件：

    Terminal window
    mkdir synctv-compose
    cd synctv-compose
    curl -fsSLO https://raw.githubusercontent.com/zijiren233/synctv/next/docker-compose.yml
    curl -fsSLO https://raw.githubusercontent.com/zijiren233/synctv/next/.env.postgres.example
    curl -fsSLO https://raw.githubusercontent.com/zijiren233/synctv/next/.env.redis.example
    curl -fsSLO https://raw.githubusercontent.com/zijiren233/synctv/next/.env.synctv.example
    mkdir -p scripts
    curl -fsSL https://raw.githubusercontent.com/zijiren233/synctv/next/scripts/init-compose-env.sh -o scripts/init-compose-env.sh
    chmod +x scripts/init-compose-env.sh

  2. 生成 .env.postgres、.env.redis 和 .env.synctv：

    Terminal window
    ./scripts/init-compose-env.sh

  3. 编辑 .env.synctv，至少设置 root 密码：

    SYNCTV_BOOTSTRAP_ROOT_PASSWORD=replace-with-a-strong-password

  4. 检查 Compose 渲染结果：

    Terminal window
    docker compose config

  5. 启动服务：

    Terminal window
    docker compose up -d

验证

Section titled “验证”
Terminal window
docker compose ps
curl -fsS http://localhost:8080/health/ready

成功后打开：

http://localhost:8080

默认 root 用户名是 root。密码来自 .env.synctv 中的 SYNCTV_BOOTSTRAP_ROOT_PASSWORD。

必须保存的值

Section titled “必须保存的值”
环境变量用途
SYNCTV_JWT_SECRET签发 access token、refresh token 和 guest token
SYNCTV_SECURITY_OPAQUE_SERVER_SETUP_SECRETOPAQUE 密码认证的服务端长期 secret
SYNCTV_SECURITY_CREDENTIAL_ENCRYPTION_KEY加密 Provider 凭据
SYNCTV_BOOTSTRAP_ROOT_PASSWORD首次创建 root 用户

常见失败

Section titled “常见失败”
现象处理
docker compose config 提示变量缺失确认已运行 ./scripts/init-compose-env.sh，并在当前目录保留 .env.postgres、.env.redis 和 .env.synctv。
/health/ready 失败运行 docker compose logs -f synctv，先看第一条启动错误。
浏览器跨域错误在 .env.synctv 中设置 SYNCTV_SERVER_CORS_ALLOWED_ORIGINS，只填写 origin。
root 用户无法登录确认数据库首次启动时已设置 SYNCTV_BOOTSTRAP_ROOT_PASSWORD，并查看启动日志中的 bootstrap 结果。

继续阅读

Section titled “继续阅读”