Files
Volcano-Engine-TTS-UI/CHANGELOG.md
T
sun 621f9f847e docs(m4): 收敛文档/dock/changelog,env 减到 4 个引导变量
M3 后所有业务配置(api_key/resource_id/speaker/format/sample_rate/...)已搬入
数据库,env 只剩 4 个启动引导参数(setup 前 / DB 还不存在时必需):
  1. TTS_ADMIN_KEY     安装 token(/api/setup 鉴权)
  2. TTS_DB_PATH       DB 路径(可选)
  3. PORT              监听端口(可选)
  4. OPENAI_TTS_API_KEY  OpenAI 端鉴权(可选)

之前 .env.example 仍列出 11 个 BYTEDANCE_TTS_* env,误导用户把配置填 env 里
(实际被 DB 覆盖,改了不生效)。

改:
- .env.example: 只列 4 个 bootstrap env,其他写"通过 WebUI 设置"
- docker-compose.yml: env 块只透传 4 个,加 named volume 持久化 tts.db
  (无 volume = 容器重启丢所有配置)
- Dockerfile: 准备 /data 目录,appuser 可写
- CHANGELOG.md: 新文件,记 v0.2.0 全部 M0-M3 + 这次修复

不动:
- README.md(M4 第 5 步独立 commit,文件大)
- 集成测试(M4 第 6 步)

e2e 验证:
- go build ./... 通过
- 旧 .env 文件如果存在仍然兼容(env var 作为 DB 缺失时的 fallback)

未 push (待 M4 全部完成)
2026-08-30 23:23:53 +08:00

3.3 KiB

Changelog

本项目的所有重要变更都记录在本文档。版本号遵循 SemVer。

[0.2.0] - 2026-08-30

新增

  • M0 · SQLite + store 包: 引入 modernc.org/sqlite (无 CGO), 所有运行时配置 (settings + voices) 持久化到 SQLite
  • M1 · 安装流程: 首次启动进入 /setup 向导, 通过 4 步表单收集凭证 + 默认音色 + 音色列表, 完成后写 installed.lock 锁定
    • 引导页无外部依赖: Vue 3.4 + axios 1.6 via bootcdn, //go:embed 进 binary
    • 自愈回退: 检测到 DB 损坏自动备份 + 转 setup 模式 (不丢数据)
  • M2 · WebUI 后台: /admin 单页 SPA, 含登录 / 仪表盘 / 音色管理 / 设置 / CORS 配置
    • 默认鉴权基于 auth_key (DB), 失败计数 + 限流
    • 浏览器安装修复: 同源请求跳过 CORS 校验, install 模式完全跳过 CORS
  • M3 · 全局设置 + 声音路由:
    • default_speaker 是 voice 名字 (如 chun), 路由时查 voice 表拿到真 speaker ID (如 S_G8tEKnaJ1)
    • /v1/audio/speech 支持 voice=<name> 动态路由, 命中但 enabled=0 返回 403
    • 未知 voice 返回 400 unknown_voice: '<name>'
    • 禁用 voice 返回 403 voice '<name>' is disabled
  • OpenAI 端 key 走 DB: auth_key 设置项, 不再依赖 OPENAI_TTS_API_KEY env
  • CORS 全 DB 化: cors_origins / cors_allow_all 走 /admin 设置, install 模式跳过
  • CORS 修复: 同源请求跳过 CORS 校验 (避免浏览器自家人拦自家人)
  • 运营工具: cmd/dumpdb — 离线 dump tts.db 的 settings + voices
  • fail-fast: normal 模式下 TTS 配置损坏 → log.Fatalf 退出, 触发 K8s / Docker 重启
    • 配套 metric tts_config_load_failures_total{mode="normal"} 便于告警
    • /health body 加 error 字段直接展示失败原因
  • speaker ID 隐私保护: 日志里 telemetry.MaskSpeaker (S_G8****naJ1); /metrics 标签用 telemetry.SpeakerLabel (sha1[:8])

修复

  • resource_id 覆盖: LoadRuntimeConfig 之前用 voice 行的 resource_id 覆盖 settings 里的, 导致用户设的 default_resource_id 永远没机会生效。现在 settings 优先, voice 行的 resource_id 仅在 voice= 显式传时使用
  • 默认值修正: 把过时的 volc.megatts.icl / volc.megatts.default 全部改成 v3 API 2.0 复刻项目唯一合法的 seed-icl-2.0; 模型名统一 seed-tts-2.0-standard
  • log 格式一致: voice 命中 log 跟合成 log 同样打码
  • setup UX 改进: voice 行 resource_id 留空时, 自动用 settings 里的 default_resource_id 兜底, 避免 settings / voice 资源 ID 不一致导致 500
  • /admin dashboard banner 误报: reloadAll() 加 loadSettings(), 避免 "CORS 未配置" 黄条永远显示

变更

  • .env.example 收敛: 移除 BYTEDANCE_TTS_* 业务 env, 只留 4 个引导 env (TTS_ADMIN_KEY / TTS_DB_PATH / PORT / OPENAI_TTS_API_KEY); 业务配置走 WebUI
  • docker-compose: 加 tts-data named volume 持久化 tts.db
  • Dockerfile: 准备 /data 目录, appuser 可写, 解决 tts.db 落盘权限

[0.1.0] - 初版

  • 火山 TTS v3 → OpenAI 兼容 /v1/audio/speech 单二进制
  • 配置全 env 驱动 (BYTEDANCE_TTS_* 11 个)
  • 限流 / 鉴权 / Prometheus metrics / CORS / 反代 XFF 解析