Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 sun
|
ec82e895c3 | ||
|
sun
|
96a525446b | ||
|
sun
|
f7c7e6ee3a | ||
|
sun
|
7b8f557f54 | ||
|
sun
|
c18cf63518 | ||
|
sun
|
49f57e4d28 |
+21
-1
@@ -29,5 +29,25 @@ OPENAI_TTS_API_KEY=
|
||||
# 装完后可改(也支持环境变量作为 DB 缺失时的 fallback)
|
||||
# ==========================================
|
||||
# X-Forwarded-For 解析跳数(可选, 0=启发式默认, N>0=精确 N 跳反代)
|
||||
# 装好后推荐到 /admin 改 trusted_proxy_hops
|
||||
# 装好后推荐到 /dashboard 改 trusted_proxy_hops
|
||||
# TRUSTED_PROXY_HOPS=2
|
||||
|
||||
# ==========================================
|
||||
# v0.3.0 新增
|
||||
# ==========================================
|
||||
|
||||
# 根路径 /metrics 的内网 CIDR 白名单(可选, 逗号分隔, 也接受裸 IP)
|
||||
# - 不配置:根路径 /metrics 完全不注册(访问 404)。
|
||||
# Prometheus 请改用鉴权版 /api/admin/metrics 并带 Bearer 凭证。
|
||||
# - 配置后:根路径 /metrics 仅对白名单来源开放,非白名单返回 404。
|
||||
# ⚠️ Docker 部署必须填「容器内网网段」,不要填 127.0.0.1/32 ——
|
||||
# 那是容器自身回环,宿主机/其他容器里的 Prometheus 进不来。
|
||||
# 例:
|
||||
# METRICS_ALLOW_CIDR=10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
|
||||
|
||||
# 管理后台专用凭证(可选)
|
||||
# - 不配置:管理接口回退使用 DB 里的 auth_key(即 OPENAI_TTS_API_KEY 那套),行为与旧版一致。
|
||||
# - 配置后:管理后台/管理接口只认这个 key,业务调用方拿到的 auth_key 无法访问管理接口。
|
||||
# 建议通过 WebUI 配置(/dashboard → 设置),不必写在这里;此处仅作说明。
|
||||
# 对应 DB 设置项:admin_key
|
||||
|
||||
|
||||
@@ -1,61 +0,0 @@
|
||||
name: CI
|
||||
|
||||
# 触发条件:
|
||||
# - push 到 develop / main
|
||||
# - 针对 develop / main 的 PR
|
||||
#
|
||||
# 为什么单独有这个 workflow:
|
||||
# 之前仓库里唯一的 workflow 是 docker.yml,它只在打 tag 时构建镜像,
|
||||
# 既不做 go build 也不跑 go vet,提交能不能编译没人自动盯着。
|
||||
#
|
||||
# ⚠️ 本 workflow 的实际覆盖范围(务必知悉):
|
||||
# 测试源码按项目策略**不入库**(见 .gitignore 的 `*_test.go`),因此干净克隆里
|
||||
# 没有任何 *_test.go,下面的 go test 步骤会打印 "no test files" 后通过。
|
||||
# 也就是说:**CI 只能守住"编译通过 + 静态检查通过",守不住行为回归。**
|
||||
# 行为回归要靠开发者在本地(测试文件所在处)自行执行:
|
||||
# go test ./... -count=1
|
||||
# 如果哪天测试重新入库,把下面的 go test 步骤改成会真正跑起来的形态即可。
|
||||
on:
|
||||
push:
|
||||
branches: [develop, main]
|
||||
pull_request:
|
||||
branches: [develop, main]
|
||||
|
||||
# 同一分支的重复推送取消上一次未完成的运行,省 CI 时间。
|
||||
concurrency:
|
||||
group: ci-${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build-and-test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
# 以 go.mod 里的 go 指令为准,避免两处版本漂移
|
||||
go-version-file: go.mod
|
||||
cache: true
|
||||
|
||||
- name: 下载依赖
|
||||
run: go mod download
|
||||
|
||||
- name: 编译检查
|
||||
run: go build ./...
|
||||
|
||||
- name: 静态检查
|
||||
run: go vet ./...
|
||||
|
||||
# 以下两步在"测试不入库"策略下是空转(no test files),保留是为了:
|
||||
# 1. 覆盖 lock 判定 / 损坏回退 / voice 路由等关键路径的测试一旦重新入库,
|
||||
# 无需改 workflow 即可直接生效;
|
||||
# 2. -count=1 禁用测试缓存,避免"改坏了却因缓存仍显示通过"。
|
||||
- name: 测试(测试源码不入库时为空转)
|
||||
run: go test ./... -count=1
|
||||
|
||||
- name: 关键路径汇总(integration)
|
||||
run: go test ./test/integration/ -count=1 -v
|
||||
|
||||
+2
-2
@@ -6,8 +6,8 @@
|
||||
|
||||
# Go 测试源码:不入库(测试保留在本地磁盘,由开发者自行 go test ./... -count=1)
|
||||
# 理由:测试用例会暴露内部实现细节与断言,不作为交付物外流。
|
||||
# 注意:本规则会把测试文件挡在 git 之外,因此仓库内不提供自动化测试;
|
||||
# .github/workflows/ci.yml 里的测试步骤在纯净克隆上无测试可跑。
|
||||
# 注意:本规则会把测试文件挡在 git 之外,因此仓库内不提供自动化测试,
|
||||
# 也没有自动化质量门 —— 守行为回归只能靠开发者在本地执行测试。
|
||||
*_test.go
|
||||
|
||||
# Editor / OS
|
||||
|
||||
+61
-7
@@ -2,7 +2,64 @@
|
||||
|
||||
本项目的所有重要变更都记录在本文档。版本号遵循 [SemVer](https://semver.org/)。
|
||||
|
||||
## [未发布]
|
||||
## [0.2.4] - 2026-10-04
|
||||
|
||||
### 路由鉴权架构升级 · 健康/指标端点收口 · 管理入口迁移
|
||||
|
||||
> ⚠️ **本版本为破坏性变更版本**,升级前请阅读 [Release Notes](docs/RELEASE_NOTES_v0.3.0.md)。
|
||||
>
|
||||
> **版本号说明**:本次以 `0.2.4` 发布(按补丁号连续),但**语义上是破坏性变更** ——
|
||||
> 未配凭证的部署会拒绝启动、匿名监控端点被收口、探针需改指 `/healthz`。
|
||||
> 之所以不用 minor 号,是为了保持编号连续;后续 `0.2.x` 用于修复本版本暴露的问题。
|
||||
>
|
||||
> **阶段编号说明**:初版方案的"阶段 1(收紧鉴权)"与"阶段 2(收口端点)"属于同一次安全改造、
|
||||
> 必须一起上线才有意义(只做前者是"有风险无收益"),故已**合并为现在的「阶段 1」**;
|
||||
> 后续阶段依次顺延。下文的「阶段 N」均指合并后的编号。
|
||||
|
||||
#### 新增
|
||||
|
||||
- **管理入口迁移到 `/dashboard`**:`/dashboard`、`/dashboard/voices`、`/dashboard/settings`
|
||||
为新入口;详细状态页(原 `/dashboard` 的旧预览页)迁至 **`/dashboard/status`**,
|
||||
并在侧边栏新增「观测 → 详细状态」入口。`/admin` 及子路径 **301 永久重定向**到对应新路径。
|
||||
- **API 路径分层**:`/api/admin/voices`、`/api/admin/settings`(含 `api-key` / `auth-key` / `admin-key`)
|
||||
为正式路径;**旧路径 `/api/voices`、`/api/settings` 保留为别名**(同一个 handler,不做重定向)。
|
||||
选别名而非 301/308 的原因:301 会把 POST/PUT/PATCH/DELETE 降级为 GET(RFC 7231)且被浏览器永久缓存,
|
||||
客户端察觉不到路径变化;308 虽保留方法但对脚本仍是行为变化。别名零往返、零破坏,老脚本完全无感。
|
||||
- **`GET /healthz` 匿名存活探针**:只返回 `200` 与字面量 `ok`,**不含任何字段**。
|
||||
供 K8s liveness/readiness、Docker HEALTHCHECK、负载均衡健康检查使用 ——
|
||||
这些探针默认不带 `Authorization`,若继续指向 `/health` 会因鉴权而全部失败。
|
||||
- **`GET /api/admin/health` 鉴权版详细健康数据**:与 `/api/admin/metrics` 风格一致,
|
||||
供管理面板与运维使用。
|
||||
- **`METRICS_ALLOW_CIDR` 内网白名单**(逗号分隔 CIDR,支持裸 IP 自动补掩码):
|
||||
配置后在根路径注册 `/metrics`,仅放行白名单来源;**非白名单返回 404 而非 403**,
|
||||
不向扫描者确认端点存在。未配置时根路径 `/metrics` **完全不注册**。
|
||||
- **独立管理凭证 `admin_key`(可选)**:管理接口凭证与业务调用凭证分离。
|
||||
取值优先级 `admin_key`(DB) → `auth_key`(DB) → `OPENAI_TTS_API_KEY`(env)。
|
||||
**不配置时行为与旧版完全一致**(回退用 `auth_key`),配置后业务 key 无法访问管理接口。
|
||||
新增 `PUT /api/admin/settings/admin-key`(及旧前缀别名)用于配置,
|
||||
凭证**只写不读**(`GET /api/admin/settings` 仅返回打码值与 `admin_key_set` / `admin_key_source`)。
|
||||
|
||||
#### 变更(Breaking Change)
|
||||
|
||||
- **`/health`、`/metrics`、`/dashboard` 不再匿名可读**:
|
||||
- `/health` → 鉴权(原匿名,泄漏版本 / commit / 内存 / goroutine / 配置错误文本)
|
||||
- `/dashboard` → 鉴权(原匿名,且它同时聚合 `/health` + `/metrics`,是单点泄漏最严重的端点)。
|
||||
对浏览器 HTML 请求做内容协商:返回页面外壳由前端显示登录视图;非 HTML 请求(脚本、抓取)无凭证一律 401。
|
||||
- 根路径 `/metrics` → 需要 `METRICS_ALLOW_CIDR`,否则 404
|
||||
- `/api/setup/status` → 鉴权(原本 normal 模式下仍匿名返回 `{installed, mode}`)
|
||||
- **`RequireAdmin` 在凭证未配置时不再放行**。此前 `len(keys)==0` 直接放行,导致未配置凭证的
|
||||
部署上管理接口完全裸奔(也使得给 `/metrics`、`/health` 加鉴权的加固形同虚设)。现在该情况返回 **401**。
|
||||
- **normal 模式下未配置任何管理凭证时服务拒绝启动**(fail-fast),启动摘要打印管理凭证来源。
|
||||
|
||||
> ⚠️ **升级提示**
|
||||
> 1. 若部署未配置 `auth_key` / `admin_key` / `OPENAI_TTS_API_KEY` 中任何一个,升级后服务将拒绝启动。
|
||||
> 2. K8s 探针 / Docker HEALTHCHECK 请改指 **`/healthz`**;Prometheus 请改用鉴权版
|
||||
> `/api/admin/metrics`,或配置 `METRICS_ALLOW_CIDR`。
|
||||
> 3. `METRICS_ALLOW_CIDR` 在 Docker 中**不要填 `127.0.0.1/32`**(那是容器自身回环),
|
||||
> 请填容器内网网段(如 `172.16.0.0/12`)。
|
||||
> 4. 管理入口改为 **`/dashboard`**;旧 `/admin` 路径保留 301 重定向,书签与脚本请尽快迁移。
|
||||
> 5. 管理 API 正式路径改为 **`/api/admin/*`**;旧 `/api/*` 路径仍可用(别名,非重定向),
|
||||
> 计划在后续版本移除。
|
||||
|
||||
### 修复
|
||||
|
||||
@@ -22,12 +79,9 @@
|
||||
- **测试源码不再入库**: `.gitignore` 恢复整体屏蔽 `*_test.go`。测试用例会暴露内部实现
|
||||
细节与断言,不作为交付物外流;测试文件保留在本地磁盘,由开发者自行执行
|
||||
`go test ./... -count=1`。
|
||||
⚠️ 代价必须明确:仓库内**不提供自动化测试**,`.github/workflows/ci.yml` 里的
|
||||
`go test` 步骤在纯净克隆上无测试可跑(会打印 `no test files` 并通过),
|
||||
**CI 只能守住"编译通过 + 静态检查通过",守不住行为回归**。
|
||||
- **新增 CI 校验** (`.github/workflows/ci.yml`): push / PR 到 `develop`、`main` 时跑
|
||||
`go build` + `go vet` + `go test -count=1`。此前仓库唯一的 workflow 只在打 tag 时构建
|
||||
Docker 镜像,不做任何编译或测试校验。
|
||||
⚠️ 代价必须明确:仓库内**不提供自动化测试**,也没有自动化质量门。
|
||||
守行为回归只能靠开发者在本地(测试文件所在处)执行测试;
|
||||
CI 仅在发版打 tag 时构建 Docker 镜像。
|
||||
- **文档订正**: `docs/UI_HANDOFF.md` 原为"单文件换皮"外包任务书,其中的
|
||||
"admin.html ≤ 35KB / setup.html ≤ 15KB / 只改两个 .html" 等约束在 admin 拆分多页后已作废,
|
||||
现标注为历史文档并补上当前真实文件结构与验收清单。
|
||||
|
||||
+4
-1
@@ -36,7 +36,10 @@ USER appuser
|
||||
|
||||
EXPOSE 8080
|
||||
|
||||
# v0.3.0:健康检查必须用 /healthz(匿名存活探针)。
|
||||
# /health 现在需要管理凭证,而 HEALTHCHECK 不带 Authorization ——
|
||||
# 继续用 /health 会让镜像一直被判定为 unhealthy。
|
||||
HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
|
||||
CMD wget -qO- http://localhost:8080/health || exit 1
|
||||
CMD wget -qO- http://localhost:8080/healthz || exit 1
|
||||
|
||||
ENTRYPOINT ["./tts-api"]
|
||||
|
||||
@@ -6,11 +6,14 @@
|
||||
|
||||
- 完全兼容 OpenAI `/v1/audio/speech` API
|
||||
- **引导式安装**: 首次启动自动进入 `/setup` 向导,无需手写 env
|
||||
- **WebUI 后台** `/admin`: 音色管理 / 全局设置 / CORS 配置 / 鉴权
|
||||
- **WebUI 后台** `/dashboard`: 音色管理 / 全局设置 / CORS 配置 / 鉴权
|
||||
- **音色库**: 多 voice 动态路由,未知 / 禁用 voice 返回明确错误
|
||||
- **多格式输出**: mp3 / ogg_opus / pcm / wav (内部转 pcm + 本地拼头) / aac / flac
|
||||
- **鉴权 + 限流**: API Key 校验, IP 速率限制, 全局并发限制
|
||||
- **观测**: Prometheus 文本格式 `/metrics` + 服务状态 `/health`, 零外部依赖
|
||||
- **凭证分离**(v0.3.0): 管理后台可配独立 `admin_key`,业务调用 Key 无法访问管理接口
|
||||
- **观测**: Prometheus 文本格式 + 服务状态, **默认无匿名监控端点**(v0.3.0 起)
|
||||
- `/healthz` 匿名存活探针(不含任何字段)· `/api/admin/metrics` 与 `/api/admin/health` 需鉴权
|
||||
- 根路径 `/metrics` 默认 404,需 `METRICS_ALLOW_CIDR` 内网白名单才注册
|
||||
- **跨平台**: Windows / Linux / macOS / Docker
|
||||
|
||||
## 快速开始
|
||||
@@ -35,7 +38,7 @@ go build -o tts-api .
|
||||
3. 音色列表: 每个 voice 的对外名 + 火山 speaker ID
|
||||
4. 确认提交
|
||||
|
||||
完成后自动跳转到 `/admin`,从这里登录管理。
|
||||
完成后自动跳转到 `/dashboard`,从这里登录管理。
|
||||
|
||||
### 3. 调用
|
||||
|
||||
@@ -56,9 +59,19 @@ curl -X POST http://localhost:8080/v1/audio/speech \
|
||||
| `TTS_ADMIN_KEY` | ✓ (生产) | `/api/setup` 安装 token,首次安装时校验 |
|
||||
| `TTS_DB_PATH` | ✗ | DB 路径,默认 `./tts.db` |
|
||||
| `PORT` | ✗ | 监听端口,默认 `8080` |
|
||||
| `OPENAI_TTS_API_KEY` | ✗ (生产) | OpenAI 端鉴权 key,可不设(内网) |
|
||||
| `OPENAI_TTS_API_KEY` | ✓ (生产) | 业务端鉴权 key;未设 `admin_key` 时**也用于管理后台登录** |
|
||||
|
||||
**所有业务配置**(`api_key` / `default_resource_id` / `default_speaker` / `default_format` / `sample_rate` / `model` / `model_type` / `explicit_language` / `enable_subtitle` / `timeout` / `cors_origins` / `cors_allow_all` / `auth_key` / `trusted_proxy_hops`) — 全部在 `/admin` 设置,持久化到 SQLite。
|
||||
v0.3.0 新增(均可选):
|
||||
|
||||
| 变量 | 用途 |
|
||||
|---|---|
|
||||
| `METRICS_ALLOW_CIDR` | 根路径 `/metrics` 的内网 CIDR 白名单(逗号分隔)。不配则根路径完全不注册 |
|
||||
|
||||
> ⚠️ **v0.3.0 起,normal 模式下未配置任何管理凭证(DB `admin_key` / DB `auth_key` /
|
||||
> env `OPENAI_TTS_API_KEY` 三者皆空)时服务将拒绝启动** —— 因为管理接口在无凭证时会拒绝
|
||||
> 所有请求,启动一个进不去后台的实例没有意义。
|
||||
|
||||
**所有业务配置**(`api_key` / `default_resource_id` / `default_speaker` / `default_format` / `sample_rate` / `model` / `model_type` / `explicit_language` / `enable_subtitle` / `timeout` / `cors_origins` / `cors_allow_all` / `auth_key` / **`admin_key`** / `trusted_proxy_hops`) — 全部在 `/dashboard` 设置,持久化到 SQLite。
|
||||
|
||||
env 仍可作为 fallback 读(老用户兼容),但**新用户应通过 WebUI 配**。
|
||||
|
||||
@@ -70,9 +83,9 @@ env 仍可作为 fallback 读(老用户兼容),但**新用户应通过 WebUI 配
|
||||
1. **凭证**: 火山 API Key (必填) + OpenAI 鉴权 Key (可选)
|
||||
2. **默认路由**: 默认资源 ID (`seed-icl-2.0`) + 默认音色名 + 默认格式 + 采样率
|
||||
3. **音色列表**: 每个 voice 一行,填对外名 + 火山 speaker ID
|
||||
4. **确认**: 提交写入 DB,自动跳 `/admin`
|
||||
4. **确认**: 提交写入 DB,自动跳 `/dashboard`
|
||||
|
||||
### `/admin` 日常管理
|
||||
### `/dashboard` 日常管理
|
||||
|
||||
| Tab | 用途 |
|
||||
|---|---|
|
||||
@@ -121,17 +134,31 @@ OpenAI 兼容,鉴权 `Authorization: Bearer <OPENAI_TTS_API_KEY>`(若已设)。
|
||||
| `pcm` | pcm | `audio/pcm` |
|
||||
| `aac` / `flac` | mp3 (降级) | `audio/mpeg` |
|
||||
|
||||
### `GET /health`
|
||||
### `GET /healthz`
|
||||
|
||||
无鉴权,返回:
|
||||
**无鉴权**。存活探针,**只返回 `200` 与字面量 `ok`,不含任何字段**。
|
||||
|
||||
供 K8s `livenessProbe`/`readinessProbe`、Docker `HEALTHCHECK`、负载均衡健康检查使用 ——
|
||||
这些探针默认不带 `Authorization`,不能指向需要鉴权的 `/health`。
|
||||
|
||||
```bash
|
||||
curl http://localhost:8080/healthz
|
||||
# ok
|
||||
```
|
||||
|
||||
### `GET /health`(v0.3.0 起需鉴权)
|
||||
|
||||
**需管理凭证**(`Authorization: Bearer <admin_key>`)。返回完整健康数据:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok", // ok | not_installed | configuration_error
|
||||
"service": "ByteDance TTS to OpenAI API Adapter",
|
||||
"version": "v0.2.0",
|
||||
"commit": "621f9f8",
|
||||
"version": "v0.3.0",
|
||||
"commit": "abc1234",
|
||||
"uptime": "3600 seconds",
|
||||
"start_time": "2026-10-04T00:00:00Z",
|
||||
"memory": { "heap_alloc": 0, "heap_inuse": 0, "goroutines": 0 },
|
||||
"config_status": {
|
||||
"all_required_vars_set": true,
|
||||
"config_error": false,
|
||||
@@ -145,16 +172,41 @@ OpenAI 兼容,鉴权 `Authorization: Bearer <OPENAI_TTS_API_KEY>`(若已设)。
|
||||
- 正常: HTTP 200, `status: "ok"`
|
||||
- 未安装: HTTP 200, `status: "not_installed"`
|
||||
- 配置损坏: HTTP 503, `status: "configuration_error"`, `error` 字段有原因
|
||||
- 无凭证: HTTP **401**
|
||||
|
||||
> v0.3.0 之前本端点是匿名的,会泄漏版本、commit、运行时长、内存与配置错误文本,现已收口。
|
||||
> 管理面板内使用鉴权版 **`GET /api/admin/health`**(返回同样的数据)。
|
||||
|
||||
### `GET /metrics`
|
||||
|
||||
Prometheus 文本格式,无鉴权。主要指标见 [观测 / Metrics](#观测--metrics)。
|
||||
**默认不注册**(访问 404)。两种使用方式:
|
||||
|
||||
### `GET /admin`, `GET /setup`, `GET /dashboard`
|
||||
1. **配置 `METRICS_ALLOW_CIDR`**(内网 CIDR 白名单,逗号分隔):
|
||||
根路径 `/metrics` 仅对白名单来源开放,**非白名单返回 404**(不是 403,避免确认端点存在)。
|
||||
```bash
|
||||
METRICS_ALLOW_CIDR=10.0.0.0/8,172.16.0.0/12
|
||||
```
|
||||
⚠️ Docker 部署请填**容器内网网段**,不要填 `127.0.0.1/32`(那是容器自身回环)。
|
||||
2. **使用鉴权版 `GET /api/admin/metrics`**,带 `Authorization: Bearer <管理凭证>`。
|
||||
Prometheus 侧需配 `authorization: { credentials: <管理凭证> }`。
|
||||
|
||||
- `/admin`: 后台 (Vue SPA),需鉴权
|
||||
- `/setup`: 引导式安装页 (Vue SPA),无鉴权,装完自动跳转
|
||||
- `/dashboard`: 服务状态预览页 (无鉴权)
|
||||
Prometheus 文本格式。主要指标见 [观测 / Metrics](#观测--metrics)。
|
||||
|
||||
### 管理页面与安装页
|
||||
|
||||
| 路径 | 说明 | 鉴权 |
|
||||
|---|---|---|
|
||||
| `GET /dashboard` | 管理看板 | 需鉴权(浏览器请求返回页面外壳,数据走 API) |
|
||||
| `GET /dashboard/voices` | 音色管理 | 同上 |
|
||||
| `GET /dashboard/settings` | 全局设置 | 同上 |
|
||||
| `GET /dashboard/status` | 详细服务状态(健康 + 指标看板) | 同上 |
|
||||
| `GET /dashboard/login` | 登录页 | **公开**(否则无法登录) |
|
||||
| `GET /setup` | 引导式安装页 | 无鉴权,装完自动跳转 |
|
||||
| `GET /admin` 等旧路径 | 301 永久重定向到对应 `/dashboard/*` | — |
|
||||
|
||||
> **为什么页面是"需鉴权"却又能直接打开?** 浏览器的 `Accept` 含 `text/html` 时返回页面外壳,
|
||||
> 由前端根据 `sessionStorage` 里的凭证决定显示登录视图;非 HTML 请求(脚本、抓取工具)
|
||||
> 无凭证一律 401。页面外壳不含任何数据,数据全部来自鉴权后的 `/api/admin/*` 接口。
|
||||
|
||||
## 老用户迁移 (从 v0.1.0 → v0.2.0)
|
||||
|
||||
@@ -162,19 +214,19 @@ v0.1.0 用 env 配 11 个 `BYTEDANCE_TTS_*` 变量。v0.2.0 起改 WebUI:
|
||||
|
||||
| 旧 env | v0.2.0 配置入口 |
|
||||
|---|---|
|
||||
| `BYTEDANCE_TTS_API_KEY` | `/admin` 设置 → API Key |
|
||||
| `BYTEDANCE_TTS_RESOURCE_ID` | `/admin` 设置 → 默认资源 ID |
|
||||
| `BYTEDANCE_TTS_SPEAKER` | `/admin` 设置 → 默认音色 (填 voice **名字**,不是 speaker ID) |
|
||||
| `BYTEDANCE_TTS_FORMAT` | `/admin` 设置 → 默认格式 |
|
||||
| `BYTEDANCE_TTS_SAMPLE_RATE` | `/admin` 设置 → 采样率 |
|
||||
| `BYTEDANCE_TTS_BIT_RATE` | `/admin` 设置 → MP3 比特率 |
|
||||
| `BYTEDANCE_TTS_MODEL` | `/admin` 设置 → 子模型 |
|
||||
| `BYTEDANCE_TTS_MODEL_TYPE` | `/admin` 设置 → 模型类型 |
|
||||
| `BYTEDANCE_TTS_EXPLICIT_LANGUAGE` | `/admin` 设置 → 显式语言 |
|
||||
| `BYTEDANCE_TTS_ENABLE_SUBTITLE` | `/admin` 设置 → 启用字级时间戳 |
|
||||
| `BYTEDANCE_TTS_API_KEY` | `/dashboard` 设置 → API Key |
|
||||
| `BYTEDANCE_TTS_RESOURCE_ID` | `/dashboard` 设置 → 默认资源 ID |
|
||||
| `BYTEDANCE_TTS_SPEAKER` | `/dashboard` 设置 → 默认音色 (填 voice **名字**,不是 speaker ID) |
|
||||
| `BYTEDANCE_TTS_FORMAT` | `/dashboard` 设置 → 默认格式 |
|
||||
| `BYTEDANCE_TTS_SAMPLE_RATE` | `/dashboard` 设置 → 采样率 |
|
||||
| `BYTEDANCE_TTS_BIT_RATE` | `/dashboard` 设置 → MP3 比特率 |
|
||||
| `BYTEDANCE_TTS_MODEL` | `/dashboard` 设置 → 子模型 |
|
||||
| `BYTEDANCE_TTS_MODEL_TYPE` | `/dashboard` 设置 → 模型类型 |
|
||||
| `BYTEDANCE_TTS_EXPLICIT_LANGUAGE` | `/dashboard` 设置 → 显式语言 |
|
||||
| `BYTEDANCE_TTS_ENABLE_SUBTITLE` | `/dashboard` 设置 → 启用字级时间戳 |
|
||||
| `BYTEDANCE_TTS_TIMEOUT` | (保留 env 暂未搬 DB) |
|
||||
| `ALLOWED_ORIGINS` | `/admin` → CORS → 跨域白名单 |
|
||||
| `OPENAI_TTS_API_KEY` | `/admin` 设置 → OpenAI 端鉴权 key |
|
||||
| `ALLOWED_ORIGINS` | `/dashboard` → CORS → 跨域白名单 |
|
||||
| `OPENAI_TTS_API_KEY` | `/dashboard` 设置 → OpenAI 端鉴权 key |
|
||||
|
||||
**逐步迁移建议**:
|
||||
|
||||
@@ -251,14 +303,30 @@ Prometheus 文本格式,无鉴权。可直接被 Prometheus 抓取或浏览器
|
||||
- 反代**仅**把鉴权后的请求转发到 `:8080`
|
||||
- 此时 `OPENAI_TTS_API_KEY` 可不设
|
||||
|
||||
**`/metrics` / `/dashboard` / `/health` 均不鉴权**,生产环境务必通过反代保护:
|
||||
### v0.3.0 起各端点的暴露面
|
||||
|
||||
v0.3.0 已把健康与指标端点收口,**默认不再有匿名可读的监控端点**:
|
||||
|
||||
| 端点 | 默认状态 | 说明 |
|
||||
|---|---|---|
|
||||
| `/healthz` | **匿名可读** | 只回 `200 ok`,**不含任何字段**,专供探针 |
|
||||
| `/health` | 需鉴权 | 完整健康数据 |
|
||||
| `/metrics`(根路径) | **默认 404** | 需 `METRICS_ALLOW_CIDR` 才注册 |
|
||||
| `/dashboard/*` | 需鉴权 | 管理面板(HTML 请求返回外壳,数据走 API) |
|
||||
| `/api/admin/*` | 需鉴权 | 管理 API(含 `/api/admin/health`、`/api/admin/metrics`) |
|
||||
| `/api/public/*` | 无鉴权 | 预留空壳,当前无业务 |
|
||||
|
||||
因此反代**只需**确保业务与管理接口不被匿名滥用;监控端点已由应用自身把关:
|
||||
|
||||
```nginx
|
||||
location /metrics { allow 10.0.0.0/8; deny all; } # 仅 Prometheus 服务器
|
||||
# 若未配 METRICS_ALLOW_CIDR,根路径 /metrics 本就 404,无需额外规则。
|
||||
# 若希望 Prometheus 走根路径,建议在应用侧配 METRICS_ALLOW_CIDR,而不是在反代做白名单。
|
||||
location /dashboard { auth_basic "admin"; auth_basic_user_file /etc/nginx/.htpasswd; }
|
||||
location /health { allow 10.0.0.0/8; deny all; } # 或 K8s liveness probe 直接访问
|
||||
```
|
||||
|
||||
> ⚠️ **探针必须指向 `/healthz`**。K8s `livenessProbe`/`readinessProbe`、Docker `HEALTHCHECK`
|
||||
> 默认不带 `Authorization`,若仍指向 `/health` 会一律 401,导致 Pod 反复重启 / 容器被判不健康。
|
||||
|
||||
## 部署
|
||||
|
||||
### Docker
|
||||
@@ -269,6 +337,7 @@ docker compose up -d
|
||||
```
|
||||
|
||||
`docker-compose.yml` 已配 named volume `tts-api-data` 挂载到容器 `/data`,DB 与 lock 文件持久化,容器重启不丢配置。
|
||||
其 `healthcheck` 已使用 `/healthz`。
|
||||
|
||||
### Linux Systemd
|
||||
|
||||
@@ -282,7 +351,7 @@ docker compose up -d
|
||||
| `installer/` | 启动期模式检测,DB 自愈回退 |
|
||||
| `setting/` | 全局配置 (TTSOptions / Auth / CORS) + 启动汇总 |
|
||||
| `store/` | SQLite 数据访问 (settings / voices) + 自愈 |
|
||||
| `controller/` | /v1/audio/speech、/health、/setup、/admin、/api/setup、/api/settings、/api/voices |
|
||||
| `controller/` | /v1/audio/speech、/healthz、/health、/setup、/dashboard、/api/setup、/api/admin/* |
|
||||
| `middleware/` | SecurityHeaders, CORS, 鉴权, 限流, 并发, 日志, 客户端 IP 提取, install 模式守卫 |
|
||||
| `router/` | 路由注册 |
|
||||
| `adapter/volcano/` | 火山 v3 HTTP Chunked 客户端 |
|
||||
@@ -339,12 +408,12 @@ PORT=8081 ./tts-api
|
||||
|
||||
如有问题,请检查:
|
||||
1. 服务启动后日志第一段 "环境配置汇总" — 火山必填项是否全 ✓
|
||||
2. `/health` 返回 `status: "ok"` 且 `config_error: false`
|
||||
3. `/admin` → 设置 tab 检查 API Key / 默认资源 ID / 默认音色
|
||||
4. `/admin` → 音色管理 tab 检查 voice 是否启用
|
||||
2. `/healthz` 返回 `ok`(存活);详细状态用鉴权接口 `/api/admin/health`,应返回 `status: "ok"` 且 `config_error: false`
|
||||
3. `/dashboard` → 设置 tab 检查 API Key / 默认资源 ID / 默认音色
|
||||
4. `/dashboard` → 音色 tab 检查 voice 是否启用
|
||||
5. 火山控制台 → 在线体验同一对 resource + speaker 能合成
|
||||
6. 客户端请求 URL 是否以 https:// 开头 (公网)
|
||||
7. `/admin` → CORS tab 检查白名单含前端完整 origin
|
||||
7. `/dashboard` → 设置 → CORS 检查白名单含前端完整 origin
|
||||
|
||||
## 许可证
|
||||
|
||||
|
||||
+91
-19
@@ -16,22 +16,27 @@ import (
|
||||
// SettingsResponse 是 GET /api/settings 的响应。
|
||||
// API key 永远打码(借用 setting.maskAPIKey 风格,前 4 后 4 中间 ****)。
|
||||
type SettingsResponse struct {
|
||||
APIKey string `json:"api_key"` // 打码形式,例如 S_G8****naJ1
|
||||
APIKeySet bool `json:"api_key_set"` // 是否已设置(用于前端判断要不要提示必填)
|
||||
AuthKey string `json:"auth_key"` // 鉴权 key 打码(客户端访问 + admin 登录用)
|
||||
AuthKeySet bool `json:"auth_key_set"`
|
||||
CORSAllowAll bool `json:"cors_allow_all"` // 允许所有来源(*)
|
||||
CORSOrigins string `json:"cors_origins"` // 逗号分隔的白名单(原文,含大小写,trim 末尾 /)
|
||||
CORSConfigured bool `json:"cors_configured"` // 是否配了 CORS(给 banner 用)
|
||||
APIKey string `json:"api_key"` // 打码形式,例如 S_G8****naJ1
|
||||
APIKeySet bool `json:"api_key_set"` // 是否已设置(用于前端判断要不要提示必填)
|
||||
AuthKey string `json:"auth_key"` // 鉴权 key 打码(客户端访问 + admin 登录用)
|
||||
AuthKeySet bool `json:"auth_key_set"`
|
||||
// AdminKey 是**管理接口专用**凭证(v0.3.0 新增,可选)。
|
||||
// 为空表示未单独配置,管理接口回退用 auth_key(向后兼容)。
|
||||
AdminKey string `json:"admin_key"` // 打码形式
|
||||
AdminKeySet bool `json:"admin_key_set"` // 是否单独配置了 admin_key
|
||||
AdminKeySource string `json:"admin_key_source"` // admin_key / auth_key / env / ""(未配置)
|
||||
CORSAllowAll bool `json:"cors_allow_all"` // 允许所有来源(*)
|
||||
CORSOrigins string `json:"cors_origins"` // 逗号分隔的白名单(原文,含大小写,trim 末尾 /)
|
||||
CORSConfigured bool `json:"cors_configured"` // 是否配了 CORS(给 banner 用)
|
||||
DefaultResourceID string `json:"default_resource_id"`
|
||||
DefaultSpeaker string `json:"default_speaker"`
|
||||
DefaultFormat string `json:"default_format"`
|
||||
SampleRate int `json:"sample_rate"`
|
||||
Model string `json:"model"`
|
||||
ModelType int `json:"model_type"`
|
||||
ExplicitLanguage string `json:"explicit_language"`
|
||||
EnableSubtitle bool `json:"enable_subtitle"`
|
||||
UpdatedAt string `json:"updated_at"` // RFC3339,来自 settings.installed_at(沿用)
|
||||
DefaultSpeaker string `json:"default_speaker"`
|
||||
DefaultFormat string `json:"default_format"`
|
||||
SampleRate int `json:"sample_rate"`
|
||||
Model string `json:"model"`
|
||||
ModelType int `json:"model_type"`
|
||||
ExplicitLanguage string `json:"explicit_language"`
|
||||
EnableSubtitle bool `json:"enable_subtitle"`
|
||||
UpdatedAt string `json:"updated_at"` // RFC3339,来自 settings.installed_at(沿用)
|
||||
}
|
||||
|
||||
// SettingsGetHandler GET /api/settings
|
||||
@@ -58,6 +63,9 @@ func SettingsGetHandler(w http.ResponseWriter, r *http.Request) {
|
||||
APIKeySet: all["api_key"] != "",
|
||||
AuthKey: maskAPIKeyField(all["auth_key"]),
|
||||
AuthKeySet: all["auth_key"] != "",
|
||||
AdminKey: maskAPIKeyField(all["admin_key"]),
|
||||
AdminKeySet: all["admin_key"] != "",
|
||||
AdminKeySource: setting.GetAdminKeySource(),
|
||||
CORSAllowAll: all["cors_allow_all"] == "1" || all["cors_allow_all"] == "true",
|
||||
CORSOrigins: all["cors_origins"],
|
||||
CORSConfigured: all["cors_allow_all"] == "1" || all["cors_allow_all"] == "true" || all["cors_origins"] != "",
|
||||
@@ -298,10 +306,74 @@ func SettingsAuthKeyHandler(w http.ResponseWriter, r *http.Request) {
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{"ok": true})
|
||||
}
|
||||
|
||||
// SettingsAdminKeyRequest 是 PUT /api/admin/settings/admin-key 的 body。
|
||||
// admin_key 是**管理接口专用**凭证;与 auth_key(业务侧 /v1/audio/speech 鉴权)分离后,
|
||||
// 业务调用方拿到的 key 不再能访问管理接口。
|
||||
// 传空串表示"清除独立管理凭证",管理接口回退用 auth_key(即旧行为)。
|
||||
type SettingsAdminKeyRequest struct {
|
||||
AdminKey string `json:"admin_key"`
|
||||
}
|
||||
|
||||
// SettingsAdminKeyHandler PUT /api/admin/settings/admin-key
|
||||
// 鉴权: RequireAdmin(注意:能用当前凭证改,改完下一个请求即用新凭证)。
|
||||
func SettingsAdminKeyHandler(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != http.MethodPut {
|
||||
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||
return
|
||||
}
|
||||
s := GetAdminStore()
|
||||
if s == nil {
|
||||
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||
return
|
||||
}
|
||||
|
||||
r.Body = http.MaxBytesReader(w, r.Body, 1<<10)
|
||||
var body SettingsAdminKeyRequest
|
||||
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||
return
|
||||
}
|
||||
key := strings.TrimSpace(body.AdminKey)
|
||||
|
||||
if key == "" {
|
||||
// 清除独立管理凭证 → 回退 auth_key。回退后若 auth_key 也为空,
|
||||
// 管理接口将全部 401(RequireAdmin 不再空凭证放行),这里必须挡住。
|
||||
authKey, _, _ := s.SettingsGet("auth_key")
|
||||
if authKey == "" {
|
||||
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||
"admin_key cannot be cleared while auth_key is empty (would lock out admin access)",
|
||||
"invalid_request_error", "missing_field")
|
||||
return
|
||||
}
|
||||
if err := s.SettingsDelete("admin_key"); err != nil {
|
||||
log.Printf("[settings] admin-key clear: %v", err)
|
||||
middleware.SendJSONError(w, http.StatusInternalServerError, "clear admin_key failed", "server_error", "db_write_failed")
|
||||
return
|
||||
}
|
||||
setting.SetAdminKeys([]string{authKey}, "auth_key")
|
||||
log.Printf("[settings] admin_key cleared; admin auth falls back to auth_key")
|
||||
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{"ok": true, "admin_key_set": false, "admin_key_source": "auth_key"})
|
||||
return
|
||||
}
|
||||
|
||||
if err := s.SettingsSet("admin_key", key); err != nil {
|
||||
log.Printf("[settings] admin-key set: %v", err)
|
||||
middleware.SendJSONError(w, http.StatusInternalServerError, "write admin_key failed", "server_error", "db_write_failed")
|
||||
return
|
||||
}
|
||||
// 立即生效:只单独刷新管理凭证列表,不重新 LoadRuntimeConfig(那会覆盖其它字段)
|
||||
setting.SetAdminKeys([]string{key}, "admin_key")
|
||||
log.Printf("[settings] admin_key updated, runtime active (next request uses new admin credential)")
|
||||
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{"ok": true, "admin_key_set": true, "admin_key_source": "admin_key"})
|
||||
}
|
||||
|
||||
// SettingsCORSRequest 是 PUT /api/settings/cors 的 body。
|
||||
// 两个字段都可选(至少给一个),用指针区分"未传"和"传空串":
|
||||
// - allow_all 指针: nil=未传(不动) *true=开 *false=关
|
||||
// - origins 字符串: nil=未传(不动) ""=传空串(清空) "url1\nurl2"=覆盖
|
||||
//
|
||||
// 这样用户能精确表达意图(保留 / 改 / 清空),不会被 0/"" 歧义坑死。
|
||||
type SettingsCORSRequest struct {
|
||||
AllowAll *bool `json:"allow_all,omitempty"`
|
||||
@@ -386,10 +458,10 @@ func SettingsCORSHandler(w http.ResponseWriter, r *http.Request) {
|
||||
log.Printf("[settings] cors updated (allow_all=%v origins=%q), runtime active", setting.GetCORSAllowAll(), originsStr)
|
||||
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||
"ok": true,
|
||||
"allow_all": setting.GetCORSAllowAll(),
|
||||
"origins": originsStr,
|
||||
"cors_active": true,
|
||||
"ok": true,
|
||||
"allow_all": setting.GetCORSAllowAll(),
|
||||
"origins": originsStr,
|
||||
"cors_active": true,
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
+1
-1
@@ -244,7 +244,7 @@ func SetupSubmitHandler(w http.ResponseWriter, r *http.Request) {
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||
"ok": true,
|
||||
"message": "installed",
|
||||
"redirect": "/admin",
|
||||
"redirect": "/dashboard", // v0.3.0: 管理入口由 /admin 迁至 /dashboard
|
||||
"settings": len(settingsKV),
|
||||
"voices": inserted,
|
||||
})
|
||||
|
||||
@@ -274,6 +274,21 @@ func contentTypeFor(format string) string {
|
||||
}
|
||||
|
||||
// HealthHandler 暴露运行期状态;无鉴权。
|
||||
// HealthzHandler GET /healthz —— 匿名存活探针,**只回 200 与字面量 "ok"**。
|
||||
//
|
||||
// 为什么单独做这个:v0.3.0 把详细健康数据(/health)收口到管理鉴权之后,
|
||||
// 但 K8s liveness/readiness、Docker HEALTHCHECK、负载均衡健康检查默认都不带 Authorization。
|
||||
// 若把它们继续指向 /health,加鉴权后会一律 401,导致探针失败、Pod 反复重启。
|
||||
//
|
||||
// 因此本端点刻意**不返回任何字段**(无版本、无内存、无配置状态、无模式信息),
|
||||
// 只用于回答"进程还在不在"。运维要细节请走鉴权后的 /health。
|
||||
func HealthzHandler(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
||||
w.Header().Set("Cache-Control", "no-store")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write([]byte("ok"))
|
||||
}
|
||||
|
||||
func HealthHandler(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
|
||||
|
||||
+11
-3
@@ -13,15 +13,23 @@ services:
|
||||
- TTS_DB_PATH=/data/tts.db
|
||||
- PORT=8080
|
||||
- OPENAI_TTS_API_KEY=${OPENAI_TTS_API_KEY:-}
|
||||
# 可选,装好后也可在 /admin 改
|
||||
# 可选,装好后也可在 /dashboard 改
|
||||
- TRUSTED_PROXY_HOPS=${TRUSTED_PROXY_HOPS:-}
|
||||
# v0.3.0 新增(可选):根路径 /metrics 的内网 CIDR 白名单,逗号分隔。
|
||||
# 不配置时根路径 /metrics 完全不注册(Prometheus 请改用鉴权版 /api/admin/metrics)。
|
||||
# ⚠️ 这里必须填「容器内网网段」,不要填 127.0.0.1/32 ——
|
||||
# 那是容器自身回环,Prometheus 在宿主机/其他容器里根本进不来。
|
||||
# 例:METRICS_ALLOW_CIDR=172.16.0.0/12
|
||||
- METRICS_ALLOW_CIDR=${METRICS_ALLOW_CIDR:-}
|
||||
volumes:
|
||||
# DB + lock 文件必须挂载,否则容器重启后配置全丢
|
||||
- tts-data:/data
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
# 用 wget 检查,alpine 镜像有
|
||||
test: ["CMD", "wget", "-qO-", "http://localhost:8080/health"]
|
||||
# v0.3.0:必须用 /healthz(匿名存活探针)。
|
||||
# /health 现在需要管理凭证,而健康检查不带 Authorization ——
|
||||
# 继续用 /health 会让容器一直被判定为 unhealthy。
|
||||
test: ["CMD", "wget", "-qO-", "http://localhost:8080/healthz"]
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
retries: 3
|
||||
|
||||
@@ -0,0 +1,438 @@
|
||||
# Volcano-Engine-TTS-UI v0.3.0 阶段性实施步骤书
|
||||
|
||||
> **文件名**：`IMPLEMENT_v0.3.0.md`
|
||||
> **基线**：`develop`
|
||||
> **版本目标**：v0.3.0 —— 路由鉴权架构升级、健康/指标端点收口、管理入口统一到 `/dashboard`
|
||||
> **关联文档**：[UPSTREAM_ADAPTER_GUIDE.md](UPSTREAM_ADAPTER_GUIDE.md)（上游适配器重构，与本改造正交，互不干扰）
|
||||
>
|
||||
> 本文是 v0.3.0 的**唯一实施依据**，由初版方案按实际代码基线校正而成。
|
||||
> 校正说明见 [附录 A](#附录-a与初版方案的差异)。
|
||||
|
||||
---
|
||||
|
||||
## 实施进度
|
||||
|
||||
> **编号说明**:初版方案的"阶段 1(收紧鉴权)"与"阶段 2(收口端点)"属于同一次安全改造、
|
||||
> 必须一起上线才有意义(只做前者是"有风险无收益"),已**合并为现在的「阶段 1」**,
|
||||
> 后续阶段依次顺延。下表的阶段号均为合并后编号。
|
||||
|
||||
| 阶段 | 内容 | 状态 | 提交 |
|
||||
|---|---|---|---|
|
||||
| 1 | 收紧 `RequireAdmin` + 独立 `admin_key` + 启动期校验 + 收口健康/指标端点 + `/healthz` + `METRICS_ALLOW_CIDR` | ✅ 已完成 | 见下 |
|
||||
| 2 | 路由分层 + 旧路径别名 + `/admin`→`/dashboard` | ✅ 已完成 | 见下 |
|
||||
| 3 | 文档 / 示例配置 / Docker 注释 / CHANGELOG | ✅ 已完成 | 见下 |
|
||||
| 4 | 全量回归测试（发布前） | ⏳ 待执行 | — |
|
||||
|
||||
**阶段 3 额外修复的两处部署陷阱**（阶段 1 给 `/health` 加鉴权引发的连带问题）：
|
||||
|
||||
- `docker-compose.yml` 的 `healthcheck` 原指向 `/health`；该端点加鉴权后会一律 401，
|
||||
导致**容器被判定为 unhealthy** → 已改为 `/healthz`
|
||||
- `Dockerfile` 的 `HEALTHCHECK` 同样指向 `/health` → 已改为 `/healthz`
|
||||
|
||||
---
|
||||
|
||||
## 0. 改造目标
|
||||
|
||||
| # | 目标 | 验收标准 |
|
||||
|---|---|---|
|
||||
| 1 | **收口健康/指标端点**：`/metrics`、`/health`、`/dashboard` 不再匿名可读 | 未携带管理凭证时不可读到任何健康数据 |
|
||||
| 2 | **补前置缺口**：`RequireAdmin` 在凭证未配置时不再静默放行 | 未配置凭证时管理接口拒绝访问，且启动期有明确信号 |
|
||||
| 3 | **权限隔离**：业务调用凭证不得访问管理接口 | 用 TTS 调用 key 访问 `/api/admin/*` 返回 401 |
|
||||
| 4 | 管理入口统一：`/admin` → `/dashboard`，旧路径 301 兼容 | 访问 `/admin` 301 到 `/dashboard` |
|
||||
| 5 | API 路由分层：`/api/public/*`、`/api/user/*`、`/api/admin/*` | 三条前缀各自挂对应中间件，`/api/user/*` 为桩 |
|
||||
| 6 | 存量管理接口迁移到 `/api/admin/*`，旧路径继续可用 | 新旧路径行为一致，老脚本零改动 |
|
||||
| 7 | 两套用量查询占位接口 | `/api/user/usage`（管理鉴权）、`/v1/dashboard/billing/usage`（Bearer） |
|
||||
| 8 | 文档 / 示例配置 / Docker 注释同步更新，标注 Breaking Change | README、`.env.example`、`docker-compose.yml`、CHANGELOG 一致 |
|
||||
| 9 | **不改动** `adapter/`、`store/` 核心业务模型，**不破坏** `/v1/audio/speech` | TTS 业务接口回归通过 |
|
||||
|
||||
### 重要约束
|
||||
|
||||
- v0.3.0 **仍是单用户模式**；`/api/user/*` 仅骨架 + 桩实现，完整多用户能力放 v0.4.0。
|
||||
- **不引入 Cookie 会话**（理由见 [附录 B](#附录-b为什么不做-cookie-会话)）。管理鉴权继续使用
|
||||
`Authorization: Bearer <key>`，前端继续用 `sessionStorage` 保存凭证。
|
||||
- **每个阶段结束必须可编译、可运行、可本地回归**，拒绝大爆炸式一次性修改。
|
||||
|
||||
---
|
||||
|
||||
## 1. 现状基线（开工前必须知道的事实）
|
||||
|
||||
本项目的真实鉴权现状与初版方案的假设**不同**，照着初版做会返工。以下是核对过代码的结论：
|
||||
|
||||
| 事项 | 真实现状 | 代码位置 |
|
||||
|---|---|---|
|
||||
| 管理鉴权中间件 | **只有 `RequireAdmin`**，Bearer 请求头校验。**不存在 `AdminSessionMiddleware`** | `middleware/admin_auth.go:20` |
|
||||
| 凭证存储 | 前端 `sessionStorage['ttsAdminKey']`，**无 Cookie** | `router/admin-shell.js:10-15` |
|
||||
| 凭证来源 | 数据库 `auth_key` → 回退环境变量 `OPENAI_TTS_API_KEY` | `setting/config.go:384-392` |
|
||||
| 凭证复用 | **同一个 key 既登录后台、又调 TTS 接口**（本次要拆开） | `middleware/auth.go` + `middleware/admin_auth.go` |
|
||||
| 指标实现 | 自研 `telemetry` 包，**未引入 `prometheus/client_golang`**，无 `promhttp` | `router/router.go:136` |
|
||||
| 客户端 IP | 已有 `middleware.GetClientIP`，支持 XFF + `TRUSTED_PROXY_HOPS` | `middleware/ratelimit.go:196` |
|
||||
| CORS | 非白名单 Origin 在中间件层直接 403 | `middleware/cors.go:138-147` |
|
||||
|
||||
### 1.1 匿名可读端点（本次要收口的全部）
|
||||
|
||||
| 端点 | 泄漏内容 | 代码位置 |
|
||||
|---|---|---|
|
||||
| `GET /dashboard` | **HTML 看板，同时拉 `/health` + `/metrics`**，聚合度最高 | `router/router.go:120` |
|
||||
| `GET /metrics` | Prometheus 全量指标（流量、模型名、错误分布、计费字符数） | `router/router.go:136` |
|
||||
| `GET /health` | 版本 / commit / 运行时长 / 内存 / goroutine + 配置错误文本 | `router/router.go:119` |
|
||||
| `GET /api/setup/status` | normal 模式下仍返回 `{installed, mode}` | `router/router.go:75` |
|
||||
|
||||
> `/api/setup/prefill` 在 normal 模式返回 404（handler 内自检），**不可达**，无需处理。
|
||||
|
||||
### 1.2 已有但必须保留的机制
|
||||
|
||||
- `InstallGuard`：安装模式下按白名单放行（`/setup`、`/api/setup`、`/health`、`/metrics`），
|
||||
安装阶段无数据库、无凭证，**不得套用 `RequireAdmin`**。`middleware/installguard.go:19`
|
||||
- 现有 `/api/admin/metrics` 已有 `RequireAdmin`，返回同样的 Prometheus 文本（保留复用）。
|
||||
- 现有静态资源路由 `/admin/admin.css`、`/admin/admin-shell.js`（`router/router.go:90-97`），
|
||||
迁移时必须同步处理，否则页面丢样式。
|
||||
|
||||
---
|
||||
|
||||
## 2. 分阶段实施
|
||||
|
||||
### 阶段 1｜鉴权收紧 + 健康/指标端点收口（本版本核心）
|
||||
|
||||
> 本节由初版方案的「阶段 1（收紧 `RequireAdmin`）」与「阶段 2（收口端点）」**合并**而成。
|
||||
> 合并原因:两者是同一件事的两半 —— 只做前者(收紧空凭证放行)而不同时收口端点,
|
||||
> 结果是"有风险无收益"(旧部署可能起不来,而 `/health`、`/dashboard`、`/metrics` 仍匿名可读)。
|
||||
> 下面 1.1–1.3 对应初版的阶段 1,1.4–1.6 对应初版的阶段 2。
|
||||
|
||||
**为什么先做这一步**：`RequireAdmin` 当前在凭证列表为空时**直接放行**（`middleware/admin_auth.go:29-33`）。
|
||||
不修这个，后面给 `/metrics`、`/health` 套 `RequireAdmin` **等于没套**。
|
||||
|
||||
**改动范围**：`middleware/admin_auth.go`、`middleware/auth.go`、`setting/config.go`、`main.go`
|
||||
|
||||
#### 1.1 空凭证不再放行
|
||||
|
||||
将 `len(keys) == 0 → next.ServeHTTP` 改为拒绝 + 显式日志：
|
||||
|
||||
```go
|
||||
keys := setting.GetAdminKeys()
|
||||
if len(keys) == 0 {
|
||||
log.Printf("[admin_auth] 拒绝访问:未配置管理凭证(admin_key / auth_key 均为空) - 路径=%s", r.URL.Path)
|
||||
denyAdmin(w, r)
|
||||
return
|
||||
}
|
||||
```
|
||||
|
||||
#### 1.2 新增独立 `admin_key`（权限隔离）
|
||||
|
||||
- `store`：新增可选的设置项 `admin_key`（**无需数据库迁移**，`settings` 是键值表）。
|
||||
- `setting`：新增 `GetAdminKeys() []string`，取值优先级：
|
||||
|
||||
```
|
||||
admin_key（DB） → 回退 auth_key（DB） → 回退 OPENAI_TTS_API_KEY（env）
|
||||
```
|
||||
|
||||
- `RequireAdmin` 改用 `GetAdminKeys()`；**`middleware.ValidateAPIKey`（`/v1/audio/speech` 用）保持只看 `auth_key`**。
|
||||
- 效果：配了 `admin_key` 后，业务调用凭证**无法**访问管理接口，隔离成立；不配则行为与旧版完全一致（向后兼容）。
|
||||
|
||||
#### 1.3 启动期校验（fail-fast）
|
||||
|
||||
在 `main.go` normal 模式分支加入：管理凭证为空时**拒绝启动**并打印清晰原因
|
||||
（与现有配置损坏 fail-fast 风格一致）。
|
||||
|
||||
> ⚠️ **破坏性提示**：若你的部署目前未配置任何凭证，本阶段后服务将无法启动。
|
||||
> 这是刻意的——此前那种状态下管理接口是完全裸奔的。请先配好 `auth_key`（或 `admin_key`）再升级。
|
||||
|
||||
#### 1.4 ✅ 鉴权部分回归
|
||||
|
||||
- [ ] `go build ./... && go vet ./...` 通过
|
||||
- [ ] 配置 `auth_key` 后：`/api/admin/overview` 带正确 key 返回 200，错误 key 返回 401
|
||||
- [ ] 不配置任何凭证时启动：进程拒绝启动并给出明确日志
|
||||
- [ ] 配置独立 `admin_key` 后：用 `auth_key` 访问 `/api/admin/*` 返回 401
|
||||
- [ ] `/v1/audio/speech` 用 `auth_key` 调用**不受影响**
|
||||
|
||||
---
|
||||
|
||||
#### 1.5 端点收口（本版本核心目标）
|
||||
|
||||
**改动范围**：`router/router.go`、`controller/tts.go`、`middleware/`（新增 CIDR 白名单）、`setting/config.go`
|
||||
|
||||
#### 1.5.1 `/health` 拆分为两个端点
|
||||
|
||||
| 端点 | 鉴权 | 返回 |
|
||||
|---|---|---|
|
||||
| `GET /healthz` | **无鉴权** | 仅 `200` + 字面量 `ok`，**不含任何字段** |
|
||||
| `GET /health` | `RequireAdmin` | 现有完整 JSON（版本/内存/配置状态等） |
|
||||
|
||||
> ⚠️ **`/healthz` 必须与 `/health` 鉴权在同一次改动内落地**。分开部署会出现探针空窗，
|
||||
> 导致 K8s liveness 失败、Pod 反复重启。
|
||||
|
||||
> 📌 探针迁移提醒：若现有 K8s `livenessProbe` / `readinessProbe` / Docker `HEALTHCHECK`
|
||||
> 指向 `/health`，需同步改指 `/healthz`。README 中要写明。
|
||||
|
||||
#### 1.5.2 `/metrics` 收口 + 可选内网白名单
|
||||
|
||||
新环境变量 `METRICS_ALLOW_CIDR`（逗号分隔多个 CIDR）：
|
||||
|
||||
- **已配置**：在根路径注册 `/metrics`，包裹 `MetricsIPAllowListMiddleware`；
|
||||
非白名单 IP 返回 **404**（不返回 403，避免向扫描者确认端点存在）。
|
||||
- **未配置**：根路径 `/metrics` **完全不注册**，访问 404。
|
||||
- 两种情况都**始终**提供鉴权版 `GET /api/admin/metrics`（已存在，供面板使用）。
|
||||
|
||||
中间件实现要点：复用 `middleware.GetClientIP(r)`（已处理 XFF / `TRUSTED_PROXY_HOPS`），
|
||||
用标准库 `net/netip` 解析 CIDR。
|
||||
|
||||
> ⚠️ **Docker 环境**：`METRICS_ALLOW_CIDR` 必须填**容器内网网段**（如 `172.16.0.0/12`），
|
||||
> **不要填 `127.0.0.1/32`** —— 那是容器自身的回环，Prometheus 在宿主机或其他容器里进不来。
|
||||
|
||||
#### 1.5.3 `/dashboard` 与 `/api/setup/status` 收口
|
||||
|
||||
- `/dashboard`：套 `RequireAdmin`。它是本版本**单点泄漏最严重**的端点（一个 URL 暴露全部健康数据）。
|
||||
- `/api/setup/status`：套 `RequireAdmin`。
|
||||
- **前端状态提示**：`/dashboard` 的 HTML 外壳本身不敏感，前端登录判断逻辑保持现状
|
||||
（`sessionStorage` 无 key → 显示登录视图）。**不在服务端做页面级跳转**，原因见 [附录 B](#附录-b为什么不做-cookie-会话)。
|
||||
|
||||
#### 1.6 ✅ 端点收口回归
|
||||
|
||||
- [ ] 未配置 `METRICS_ALLOW_CIDR`：根 `/metrics`、`/health` 返回 404
|
||||
- [ ] 配置 `METRICS_ALLOW_CIDR=127.0.0.1/32`：本机可访问根 `/metrics`，其他 IP 返回 404
|
||||
- [ ] `/healthz` 无鉴权可访问且**不含任何字段**
|
||||
- [ ] `/health` 无凭证返回 401，带管理凭证返回完整 JSON
|
||||
- [ ] `/dashboard` 无凭证返回 401
|
||||
- [ ] `/api/setup/status` 无凭证返回 401
|
||||
- [ ] 面板内 `/api/admin/metrics`、`/api/admin/health` 正常返回
|
||||
|
||||
---
|
||||
|
||||
### 阶段 2｜路由分层与路径迁移
|
||||
|
||||
**改动范围**：`router/router.go`、`controller/`（新增两个桩 handler + 页面路由别名）
|
||||
|
||||
#### 2.1 分层路由注册
|
||||
|
||||
```go
|
||||
apiPublic := r.PathPrefix("/api/public").Subrouter()
|
||||
// 预留空壳，暂不注册业务
|
||||
|
||||
apiUser := r.PathPrefix("/api/user").Subrouter()
|
||||
apiUser.Use(middleware.RequireAdmin) // 单用户模式下与 admin 等价，v0.4.0 再分化
|
||||
|
||||
apiAdmin := r.PathPrefix("/api/admin").Subrouter()
|
||||
apiAdmin.Use(middleware.RequireAdmin)
|
||||
```
|
||||
|
||||
将现有管理 handler 挂到 `apiAdmin`（**复用 handler 本体，不改业务逻辑**）：
|
||||
|
||||
| 旧路径 | 新路径 |
|
||||
|---|---|
|
||||
| `GET/POST /api/voices` | `GET/POST /api/admin/voices` |
|
||||
| `DELETE /api/voices/{name}` | `DELETE /api/admin/voices/{name}` |
|
||||
| `PATCH /api/voices/{name}/toggle` | `PATCH /api/admin/voices/{name}/toggle` |
|
||||
| `GET/PUT /api/settings` | `GET/PUT /api/admin/settings` |
|
||||
| `PUT /api/settings/api-key` | `PUT /api/admin/settings/api-key` |
|
||||
| `PUT /api/settings/auth-key` | `PUT /api/admin/settings/auth-key` |
|
||||
| `PUT /api/settings/cors` | `PUT /api/admin/settings/cors` |
|
||||
| `GET /api/admin/overview` | 位置不变 |
|
||||
| `GET /api/admin/metrics` | 位置不变 |
|
||||
|
||||
#### 2.2 旧路径兼容：用**别名**，不要重定向
|
||||
|
||||
**旧路径指向同一个 handler，不做 301/308 跳转。**
|
||||
|
||||
理由（三者对比）：
|
||||
|
||||
| 方案 | 问题 |
|
||||
|---|---|
|
||||
| 301 | 会把 POST/PUT/PATCH/DELETE **降级成 GET**（RFC 7231），且浏览器**永久缓存**，客户端察觉不到路径变化 |
|
||||
| 308 | 保留方法和请求体，比 301 好；但多一次往返，对非浏览器脚本仍是行为变化 |
|
||||
| **别名（采用）** | 两个路径直接可用，零往返、零破坏，老脚本完全无感 |
|
||||
|
||||
旧路径在当前版本**保留**，并在代码注释标注"过渡期别名，未来版本移除"。
|
||||
|
||||
#### 2.3 页面路由迁移
|
||||
|
||||
```go
|
||||
// 新入口
|
||||
r.HandleFunc("/dashboard", middleware.RequireAdmin(serveAdmin(dashboardHTML))).Methods("GET")
|
||||
r.HandleFunc("/dashboard/login", serveAdmin(adminLoginHTML)).Methods("GET")
|
||||
r.HandleFunc("/dashboard/voices", middleware.RequireAdmin(serveAdmin(adminVoicesHTML))).Methods("GET")
|
||||
r.HandleFunc("/dashboard/settings", middleware.RequireAdmin(serveAdmin(adminSettingsHTML))).Methods("GET")
|
||||
|
||||
// 静态资源：必须同步迁移，否则面板丢样式/脚本
|
||||
r.HandleFunc("/dashboard/admin.css", ...) // 原 /admin/admin.css
|
||||
r.HandleFunc("/dashboard/admin-shell.js", ...) // 原 /admin/admin-shell.js
|
||||
|
||||
// 旧入口 301 永久重定向（页面用 301 正确）
|
||||
r.HandleFunc("/admin", func(w http.ResponseWriter, r *http.Request) {
|
||||
http.Redirect(w, r, "/dashboard", http.StatusMovedPermanently)
|
||||
}).Methods("GET")
|
||||
```
|
||||
|
||||
前端同步改动（`router/*.html`、`admin-shell.js`）：
|
||||
|
||||
- 页面间跳转与链接：`/admin` → `/dashboard`，`/admin/login` → `/dashboard/login` 等
|
||||
- API 调用地址迁移到 `/api/admin/*`
|
||||
- 静态资源引用 `/admin/admin.css` → `/dashboard/admin.css`（同理 `admin-shell.js`）
|
||||
- `admin-shell.js` 的 401 拦截逻辑改为跳 `/dashboard/login`
|
||||
|
||||
> 📌 注意：`/dashboard` 原本是**服务状态预览页**（`router/health.html`）。迁入后该页面的定位
|
||||
> 变成"管理后台首页"，健康/指标数据改由 `/api/admin/health`、`/api/admin/metrics` 提供。
|
||||
> 若仍希望保留独立的只读状态页，请单独确认（本版本不提供匿名版本）。
|
||||
|
||||
#### 2.4 桩接口
|
||||
|
||||
| 端点 | 鉴权 | 行为 |
|
||||
|---|---|---|
|
||||
| `GET /api/user/usage` | `RequireAdmin` | 单用户模式返回全局用量统计（桩，v0.4.0 改为按用户过滤） |
|
||||
| `GET /v1/dashboard/billing/usage` | Bearer 业务 key | 返回用量统计，对齐 OpenAI 返回格式 |
|
||||
|
||||
#### 2.5 ✅ 阶段 2 回归
|
||||
|
||||
- [ ] `/admin` 301 跳 `/dashboard`；`/dashboard` 各页面与静态资源正常加载（无 404、无样式丢失）
|
||||
- [ ] 面板内音色增删改、全局设置、CORS 配置全部正常
|
||||
- [ ] 旧路径 `/api/voices`、`/api/settings` **直接可用**（不是重定向），行为与新路径一致
|
||||
- [ ] `GET /api/user/usage`、`GET /v1/dashboard/billing/usage` 正常返回
|
||||
- [ ] 用业务 Bearer key 访问 `/api/admin/*` 返回 401
|
||||
- [ ] 完整安装流程跑通，装完跳转 `/dashboard`
|
||||
|
||||
---
|
||||
|
||||
### 阶段 3｜文档、配置、发布
|
||||
|
||||
**改动范围**：`README.md`、`.env.example`、`docker-compose.yml`、`CHANGELOG.md`
|
||||
|
||||
1. **README.md**
|
||||
- WebUI 入口改为 `/dashboard`；注明 `/admin` 为旧兼容重定向
|
||||
- 端点表更新：`/metrics`、`/health` 默认 404；新增 `/healthz`、`METRICS_ALLOW_CIDR`、`admin_key` 说明
|
||||
- 公网部署安全清单更新（整节重写，明确"哪些端点不鉴权、必须靠什么挡"）
|
||||
- 探针迁移提醒：K8s / Docker HEALTHCHECK 改指 `/healthz`
|
||||
2. **`.env.example`**：新增 `METRICS_ALLOW_CIDR` 注释（含 Docker 网段警告）
|
||||
3. **`docker-compose.yml`**：`METRICS_ALLOW_CIDR` 注释示例
|
||||
4. **`CHANGELOG.md`**：v0.3.0 条目，明确列出 Breaking Change
|
||||
|
||||
#### Release Note · Breaking Change 清单
|
||||
|
||||
1. **`/metrics`、`/health`、`/dashboard` 不再匿名可读**。Prometheus 抓取请用
|
||||
`/api/admin/metrics`（带 Bearer），或配置 `METRICS_ALLOW_CIDR`；
|
||||
探针请改用 `/healthz`。
|
||||
2. **未配置任何凭证时服务拒绝启动**（此前管理接口完全裸奔）。
|
||||
3. **管理凭证与业务凭证可分离**：新增 `admin_key`；配了之后业务 key 无法访问管理接口。
|
||||
4. **管理接口迁移到 `/api/admin/*`**；旧路径保留为**别名（非重定向）**，未来版本移除。
|
||||
5. **管理入口迁移到 `/dashboard`**；`/admin` 301 永久重定向。
|
||||
|
||||
---
|
||||
|
||||
#### 阶段 4｜全量回归测试（发布前必须全部通过）
|
||||
|
||||
> ⚠️ **本项目测试文件不入库**（`.gitignore` 的 `*_test.go`），CI 只能守住"编译 + vet"，
|
||||
> **守不住行为回归**。因此下面的手工回归是发布前的唯一防线，必须逐条执行并记录结果。
|
||||
|
||||
### ✨ 安装流程
|
||||
1. 不设 `TTS_ADMIN_KEY` 启动 → 终端打印一次性密钥（带醒目警告）
|
||||
2. 不带密钥 `POST /api/setup` → 401；带密钥 → 安装成功
|
||||
3. 安装完成跳转 `/dashboard`；进程重启后旧一次性密钥失效
|
||||
4. 已安装状态访问 `/setup` → 自动跳 `/dashboard`
|
||||
|
||||
### ✨ 管理面板
|
||||
5. 未登录访问 `/dashboard` → 显示登录视图；登录后完整可用
|
||||
6. 访问 `/admin` → 301 跳 `/dashboard`
|
||||
7. 音色 CRUD、全局设置、CORS 修改全部正常
|
||||
8. 仪表盘通过 `/api/admin/health`、`/api/admin/metrics` 渲染正常
|
||||
9. 用量面板读取 `/api/user/usage` 正常
|
||||
|
||||
### ✨ 指标与健康端点
|
||||
10. 不配 `METRICS_ALLOW_CIDR` → 根 `/metrics`、`/health` 返回 404
|
||||
11. 配 `METRICS_ALLOW_CIDR=127.0.0.1/32` → 本机根路径可访问，其他 IP 404
|
||||
12. `/healthz` 匿名可访问且**响应体不含任何业务字段**
|
||||
|
||||
### ✨ 业务接口
|
||||
13. `/v1/audio/speech` OpenAI TTS 合成完全正常
|
||||
14. `GET /v1/dashboard/billing/usage` 合法 key → 200；非法 key → 401
|
||||
15. 业务 Bearer key 访问 `/api/admin/*` → 401（隔离生效）
|
||||
|
||||
### ✨ 存量兼容
|
||||
16. 旧管理接口路径`/api/voices`、`/api/settings` 直接可用，行为与新路径一致
|
||||
|
||||
### ✨ 安全场景
|
||||
17. 未配置凭证时服务拒绝启动
|
||||
18. 匿名无法获取任何健康 / 指标数据
|
||||
19. 旧 `tts.db` 直接复用升级，**无需数据库迁移**
|
||||
|
||||
### ✨ 本地自动化
|
||||
20. `go build ./... && go vet ./...` 通过
|
||||
21. `go test ./... -count=1` 全绿
|
||||
（含抓出过 `VoiceList` 语义 bug 的那批集成测试，是本次改造最重要的安全网）
|
||||
|
||||
---
|
||||
|
||||
## 3. 发布 v0.3.0
|
||||
|
||||
1. 阶段 4 全部通过；Docker 镜像构建测试通过
|
||||
2. `git tag v0.3.0` 并推送
|
||||
3. 创建 Release，粘贴 Release Notes，**明确列出 5 条 Breaking Change**
|
||||
4. 创建维护分支 `v0.3.x`，用于后续 bugfix 与安全补丁
|
||||
5. `develop` 继续迭代 v0.4.0；上游适配器重构可并行
|
||||
|
||||
---
|
||||
|
||||
## 4. v0.4.0 后续规划（仅规划，不在 v0.3.0 实现）
|
||||
|
||||
v0.3.0 已把**路由分层**和**权限隔离**打好；v0.4.0 只需填充业务逻辑。
|
||||
|
||||
1. `store` 新增 `users` 表，区分普通用户 / 管理员角色
|
||||
2. 引入真正的会话机制（此时才需要 Cookie + CSRF，或采用 Bearer-per-user）
|
||||
3. `/api/user/*` 从桩转真实业务：个人用量、个人 API 密钥管理、个人调用日志
|
||||
4. `/api/admin/*` 实现用户 CRUD、配额管理；音色归属绑定用户
|
||||
5. SPA 扩展个人中心、密钥管理页面
|
||||
6. `/v1/dashboard/billing/usage` 按 API-Key 归属过滤统计
|
||||
|
||||
---
|
||||
|
||||
## 5. 风险注意事项
|
||||
|
||||
| # | 风险 | 对策 |
|
||||
|---|---|---|
|
||||
| 1 | **`/healthz` 与 `/health` 加鉴权分批上线** → 探针空窗、Pod 重启循环 | 必须同一批改动内落地 |
|
||||
| 2 | **未配凭证导致服务启动失败**（阶段 1 的破坏性结果） | 升级前先配 `auth_key`；README 与 Release Note 明确提示 |
|
||||
| 3 | Docker 内 `METRICS_ALLOW_CIDR` 填 `127.0.0.1/32` | 必须填容器内网网段 |
|
||||
| 4 | **禁止把 `RequireAdmin` 套到 `/setup`** | 安装阶段无数据库、无凭证，保留 `InstallGuard` |
|
||||
| 5 | 旧路径若用重定向会导致 POST 降级 / 客户端无感 | 采用**别名**，不重定向 |
|
||||
| 6 | 静态资源路由遗漏导致面板丢样式 | 迁移时同步 `/dashboard/admin.css`、`/dashboard/admin-shell.js` |
|
||||
| 7 | **CI 跑不到测试**（测试文件不入库） | 每阶段结束本地执行 `go test ./... -count=1` |
|
||||
| 8 | 误改 `adapter/`、`store/` 业务模型 | 本改造不涉及；改动仅限 router / middleware / controller / 前端 / 文档 |
|
||||
|
||||
---
|
||||
|
||||
## 附录 A｜与初版方案的差异
|
||||
|
||||
| 初版方案 | 本版 | 原因 |
|
||||
|---|---|---|
|
||||
| 阶段 0 "重命名 `AdminSessionMiddleware`" | **删除该阶段** | 该中间件**不存在**；实为新建 Cookie 会话层，会把"低风险重构"变成破坏性变更 |
|
||||
| 新增 `UserSessionMiddleware` | **不做** | 没有会话机制；`/dashboard` 页面请求不带 `sessionStorage`，服务端无从判断登录态 |
|
||||
| 新增 `CSRFMiddleware` | **不做** | Bearer 认证免疫 CSRF（浏览器不会自动附带 `Authorization`）；CORS 已在中间件层 403 非白名单 Origin |
|
||||
| Cookie `HttpOnly` / `SameSite=Strict` | **不做** | 不使用 Cookie |
|
||||
| `promhttp.Handler()` | `metrics.Meter.Handler()` | 项目未引入 `prometheus/client_golang` |
|
||||
| `controller.AdminSPAPageHandler` / `AdminLoginPageHandler` | `serveAdmin(adminHTML)` 等 | 这两个 handler 不存在 |
|
||||
| 漏点只列 `/metrics`、`/health` | 补入 **`/dashboard`**、`/api/setup/status` | `/dashboard` 聚合度最高；实测确认这两个也匿名可达 |
|
||||
| 旧 API 路径 301 重定向 | **别名**，不重定向 | 301 会把 POST 降级为 GET 且被永久缓存 |
|
||||
| 未提静态资源路由 | 明确 `/dashboard/admin.css` 等 | 遗漏会导致面板丢样式 |
|
||||
| `RequireAdmin` 空凭证放行未处理 | **阶段 1 专门修复 + fail-fast** | 不修则后续所有鉴权改动形同虚设 |
|
||||
|
||||
### 初版保留不变的部分
|
||||
|
||||
分阶段 + 每阶段可编译可回归的原则、`InstallGuard` 保持不动、`/v1/dashboard/billing/usage`
|
||||
走 Bearer、`/api/public` 与 `/api/user` 留桩、Docker CIDR 网段警告、v0.4.0 规划、发布流程。
|
||||
|
||||
---
|
||||
|
||||
## 附录 B｜为什么不做 Cookie 会话
|
||||
|
||||
1. **不解决问题**：目标是"健康数据不外泄"，用现有 `RequireAdmin` 即可 100% 达成，
|
||||
不需要会话层。
|
||||
2. **服务端拿不到 SPA 登录态**：前端凭证存 `sessionStorage`，**不随请求发送**，
|
||||
所以服务端无法判断 `/dashboard` 页面请求是否已登录。初版要的"未登录访问 `/dashboard`
|
||||
自动跳登录页"在服务端**做不到**——除非引入 Cookie，而这正是初版的前提缺失之处。
|
||||
3. **CSRF 需求随之消失**：Cookie 才需要 CSRF 防护；Bearer + `sessionStorage` 天然免疫。
|
||||
不做 Cookie 就不必实现 token 发放与轮换，也避开同源 SPA 下 `SameSite=Strict` 的坑。
|
||||
4. **破坏现有客户端**：现有用 `Authorization: Bearer` 调管理 API 的脚本会全部 401，
|
||||
与"给外部脚本过渡期"的目标冲突。
|
||||
5. **真正的权限问题另有其解**：当前"一个 key 既是管理密码又是业务密钥"才是实质缺陷，
|
||||
用新增可选 `admin_key` 即可分离，成本约 20 行，无需引入会话。
|
||||
|
||||
---
|
||||
|
||||
*文档版本：v2 · 校正基线：`develop` @ `49f57e4`（2026-10-04）*
|
||||
*初版：v1（外部产出）· 校正原因见附录 A*
|
||||
@@ -0,0 +1,140 @@
|
||||
# v0.3.0 Release Notes
|
||||
|
||||
> 发布日期：待定 · 基线：`develop`
|
||||
> 主题：**路由鉴权架构升级 · 健康与指标端点收口 · 管理入口统一**
|
||||
|
||||
---
|
||||
|
||||
## 一句话概括
|
||||
|
||||
v0.3.0 把**默认对外的监控面收窄到只有一个匿名存活探针**，
|
||||
并把**管理凭证与业务调用凭证拆开**，同时把管理入口统一到 `/dashboard`。
|
||||
业务接口 `/v1/audio/speech` 行为不变。
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Breaking Changes（升级前必读）
|
||||
|
||||
### 1. 监控端点不再匿名可读
|
||||
|
||||
| 端点 | v0.2.x | v0.3.0 |
|
||||
|---|---|---|
|
||||
| `/healthz` | 不存在 | **匿名可读**，只回 `200 ok`（不含任何字段） |
|
||||
| `/health` | 匿名，返回完整健康数据 | **需管理凭证**，否则 401 |
|
||||
| `/metrics`（根路径） | 匿名 | **默认 404**；需配置 `METRICS_ALLOW_CIDR` 才注册 |
|
||||
| `/dashboard` | 匿名（服务状态预览页） | **需鉴权**（且已成为管理看板，见第 3 条） |
|
||||
| `/api/setup/status` | 匿名 | **需管理凭证** |
|
||||
|
||||
**你需要做的**：
|
||||
|
||||
- **K8s 探针 / Docker HEALTHCHECK** 改指 **`/healthz`**。
|
||||
继续指向 `/health` 会一律 401 → Pod 反复重启 / 容器被判 unhealthy。
|
||||
（本仓库的 `docker-compose.yml` 与 `Dockerfile` 已同步修改。）
|
||||
- **Prometheus** 二选一：
|
||||
- 改用鉴权版 `/api/admin/metrics`，并在 `scrape_configs` 配
|
||||
`authorization: { credentials: <管理凭证> }`；
|
||||
- 或配置 `METRICS_ALLOW_CIDR` 走根路径白名单。
|
||||
⚠️ Docker 中**不要填 `127.0.0.1/32`**（那是容器自身回环），
|
||||
请填容器内网网段，例如 `172.16.0.0/12`。
|
||||
|
||||
### 2. 未配置管理凭证时服务拒绝启动
|
||||
|
||||
`RequireAdmin` 此前在凭证列表为空时**直接放行**（等于管理接口完全裸奔）。
|
||||
现在该情况返回 401；并且 **normal 模式下若 `admin_key` / `auth_key` /
|
||||
`OPENAI_TTS_API_KEY` 三者皆为空，服务将 fail-fast 拒绝启动**。
|
||||
|
||||
**你需要做的**：升级前确认三者至少配置一个，否则服务起不来。
|
||||
|
||||
### 3. 管理入口从 `/admin` 迁至 `/dashboard`
|
||||
|
||||
- `/dashboard`、`/dashboard/voices`、`/dashboard/settings` 为新入口
|
||||
- 详细服务状态页迁至 **`/dashboard/status`**（原 `/dashboard` 是状态预览页）
|
||||
- `/admin` 及子路径 **301 永久重定向**到对应新路径，书签与脚本请尽快迁移
|
||||
|
||||
### 4. 管理 API 正式路径改为 `/api/admin/*`
|
||||
|
||||
- 新：`/api/admin/voices`、`/api/admin/settings`（含 `api-key` / `auth-key` / `admin-key`）
|
||||
- 旧：`/api/voices`、`/api/settings` **仍可用**（**别名**，不是重定向），计划后续版本移除
|
||||
|
||||
> 为什么用别名而不是 308：301 会把 `POST`/`PUT`/`PATCH`/`DELETE` 降级成 `GET`
|
||||
> 且被浏览器永久缓存；308 虽保留方法，但对非浏览器脚本仍是行为变化。
|
||||
> 别名零往返、零破坏，老脚本完全无感。
|
||||
|
||||
---
|
||||
|
||||
## ✨ 新特性
|
||||
|
||||
### 独立管理凭证 `admin_key`
|
||||
|
||||
管理后台登录凭证与业务调用凭证分离。取值优先级：
|
||||
|
||||
```
|
||||
admin_key（DB） → auth_key（DB） → OPENAI_TTS_API_KEY（env）
|
||||
```
|
||||
|
||||
- **不配置**：回退使用 `auth_key`，**行为与 v0.2.x 完全一致**
|
||||
- **配置后**：业务调用方持有的 `auth_key` **无法访问管理接口**（返回 401）
|
||||
|
||||
配置方式：`PUT /api/admin/settings/admin-key`，或在 `/dashboard → 设置` 中操作。
|
||||
凭证**只写不读** —— `GET /api/admin/settings` 只返回打码值与来源标记。
|
||||
|
||||
### 内网 CIDR 白名单 `METRICS_ALLOW_CIDR`
|
||||
|
||||
逗号分隔，支持裸 IP 自动补掩码。非白名单来源返回 **404**（而非 403，
|
||||
避免向扫描者确认端点存在）。未配置时根路径 `/metrics` **完全不注册**。
|
||||
|
||||
### 匿名存活探针 `/healthz`
|
||||
|
||||
刻意**不返回任何字段**（无版本、无内存、无配置状态、无模式），只回答"进程还在不在"。
|
||||
运维要细节请走鉴权后的 `/health` 或 `/api/admin/health`。
|
||||
|
||||
---
|
||||
|
||||
## 🔧 修复
|
||||
|
||||
- `RequireAdmin` 空凭证放行（安全缺口，见 Breaking Change 第 2 条）
|
||||
- `/api/setup/status` 在 normal 模式下仍匿名暴露 `{installed, mode}`
|
||||
- `docker-compose.yml` / `Dockerfile` 的健康检查端点（随鉴权改动失效）
|
||||
- 指标写入对空接收者安全（`nil *Counter` / `*Gauge` / `*Histogram` 不再 panic）
|
||||
- 上游 `HTTPClient` 未初始化时返回错误而非 panic
|
||||
|
||||
---
|
||||
|
||||
## ✅ 验证方式
|
||||
|
||||
```bash
|
||||
go build ./...
|
||||
go vet ./...
|
||||
go test ./... -count=1
|
||||
```
|
||||
|
||||
> 注意：本仓库测试源码**不入库**（`.gitignore` 的 `*_test.go`），
|
||||
> 干净克隆上 `go test` 只会打印 `no test files`。
|
||||
> 自动化测试需在开发机（测试文件所在处）执行。
|
||||
> 发布前请按 [IMPLEMENT_v0.3.0.md](IMPLEMENT_v0.3.0.md) 第 3 节逐条手工回归。
|
||||
|
||||
端到端实测结果（真实服务器）：
|
||||
|
||||
| 检查 | 结果 |
|
||||
|---|---|
|
||||
| `/healthz` 匿名 | `200` + 字面量 `ok` |
|
||||
| `/health` 无凭证 / 带凭证 | `401` / `200` |
|
||||
| 根 `/metrics` 未配 CIDR | `404`（不注册） |
|
||||
| `/admin`、`/admin/login`、`/admin/voices`、`/admin/settings` | 全部 `301` 至对应 `/dashboard/*` |
|
||||
| `/dashboard*` 浏览器请求 / 脚本请求 | `200` 页面外壳 / `401` |
|
||||
| `/api/admin/*` 与 `/api/*` 别名 | 均 `200`（无 301/308） |
|
||||
| 配独立 `admin_key` 后业务 key 访问管理接口 | `401` |
|
||||
| 业务接口 `/v1/audio/speech` | 行为不变 |
|
||||
|
||||
---
|
||||
|
||||
## 📦 升级步骤
|
||||
|
||||
1. 确认已配置 `admin_key` / `auth_key` / `OPENAI_TTS_API_KEY` 至少一个
|
||||
2. 更新探针指向 `/healthz`
|
||||
3. 更新 Prometheus 抓取配置（鉴权版或 `METRICS_ALLOW_CIDR`）
|
||||
4. 替换镜像 / 二进制并重启
|
||||
5. 访问 `/dashboard` 登录验证；确认旧 `/admin` 书签仍能自动跳转
|
||||
6. 按需在 `/dashboard → 设置` 配置独立 `admin_key`
|
||||
|
||||
**无需数据库迁移** —— 旧的 `tts.db` 可直接复用。
|
||||
@@ -0,0 +1,493 @@
|
||||
# 上游适配器开发指南
|
||||
|
||||
> 面向对象:要为本项目接入**新上游 TTS 服务**的开发者(也包括未来的你)。
|
||||
> 阅读前提:知道 OpenAI `/v1/audio/speech` 的请求/响应形状,能读 Go。
|
||||
>
|
||||
> ⚠️ **本文档分两部分,请先看清区别**:
|
||||
> **第一部分「现状」描述的是代码里已经存在的东西**,可以直接照着读代码。
|
||||
> **第二部分「目标架构」是待实施的设计**,代码里**还不存在** ——
|
||||
> 里面的接口、表结构、目录都是提案,需要先按 §4 的分阶段计划落地。
|
||||
> 不要把第二部分的接口名当成现有 API 去调用。
|
||||
|
||||
---
|
||||
|
||||
## 1. 愿景与现状
|
||||
|
||||
### 1.1 愿景
|
||||
|
||||
把本服务做成**多渠道多上游聚合层**:对外始终是一个 OpenAI 兼容接口,
|
||||
对内可以挂火山、OpenAI、Azure、阿里云、自建 GPT-SoVITS / IndexTTS……等任意上游。
|
||||
调用方不需要知道音频是哪个厂商合成的 —— 换上游对客户端应当**透明**。
|
||||
|
||||
### 1.2 现状(第一部分)
|
||||
|
||||
目前**只有火山一个适配器**,且不是"插件式"的,而是**硬编码进主干**的。
|
||||
这一点必须说清楚,因为它决定了新上游不能"只写一个文件就完事"。
|
||||
|
||||
```
|
||||
入口 controller/tts.go OpenaiTTSHandler
|
||||
│
|
||||
│ opts := setting.GetTTSOptions() ← 类型是 volcano.Options
|
||||
│ volcano.Synthesis(ctx, volcanoClient, opts, ...) ← 直接调实现,无接口
|
||||
▼
|
||||
适配器 adapter/volcano/ Options / Synthesis / ParseStream / UpstreamError
|
||||
▲
|
||||
│ setting.LoadRuntimeConfig 直接构造 volcano.Options / volcano.Additions
|
||||
配置 setting/config.go
|
||||
```
|
||||
|
||||
**关键事实**:主干里有一处 `import "…/adapter/volcano"`,不是注解式的,
|
||||
而是**类型级耦合**。所以"多上游"不是加文件,而是一次重构(见 §4)。
|
||||
|
||||
当前只有火山适配器时,以下代码是合理的;接第二个上游时必须逐个处理,
|
||||
否则会出现"配置是火山的、路由是 OpenAI 的"这种错配。
|
||||
|
||||
---
|
||||
|
||||
## 2. 现有火山适配器契约(照此实现即可)
|
||||
|
||||
新适配器要能替代火山适配器,就必须满足下面这些**已经被主干依赖**的契约。
|
||||
先读这一节,再读 §3 的接口设计。
|
||||
|
||||
### 2.1 包的职责划分
|
||||
|
||||
| 文件 | 职责 | 新适配器对应物 |
|
||||
|---|---|---|
|
||||
| `adapter/volcano/options.go` | 调用参数集合(`Options`)+ 上游扩展参数(`Additions`)+ `IsZero()` | provider 私有 opts |
|
||||
| `adapter/volcano/request.go` | `Options` → 上游请求体;`buildRequest` 做必填校验;`convertSpeedToSpeechRate` 做 OpenAI speed 换算 | 请求构造 |
|
||||
| `adapter/volcano/client.go` | 复用连接的 `*HTTPClient`(keep-alive 调优);`PostStream` 发流式请求 | 传输层 |
|
||||
| `adapter/volcano/synthesis.go` | **唯一入口** `Synthesis(...)`;编排 埋点 → 构造 → 发送 → 解析 → 收尾 | `Synthesize(...)` |
|
||||
| `adapter/volcano/response.go` | `ParseStream` 解析 NDJSON 流;`ParsedStream` 累计结果 | 响应解析 |
|
||||
| `adapter/volcano/errors.go` | `UpstreamError{Code,Message,Stage,Wrapped}` + `IsAuth()` | 错误类型 |
|
||||
| `adapter/volcano/audio.go` | `WrapWAVHeader` —— 上游只给 PCM 时本地拼标准 wav 头 | 格式收尾 |
|
||||
|
||||
### 2.2 主干对适配器的硬性依赖(必须逐条满足)
|
||||
|
||||
| # | 主干行为 | 位置 | 新适配器必须 |
|
||||
|---|---|---|---|
|
||||
| 1 | 用包级 `*HTTPClient` 发请求,连接复用 | `controller/tts.go:27,32` | 提供可复用的 client,不要每次 new |
|
||||
| 2 | 可用 `ctx` 控制超时 | `controller/tts.go:203` | `Synthesize` 必须接受 `context.Context` |
|
||||
| 3 | 埋点接口 **3 个方法** | `adapter/volcano/synthesis.go:20-24` | 见 §2.3 |
|
||||
| 4 | 错误按 `Stage` 分类成 status label | `controller/tts.go:242-256` | 错误必须携带阶段:`request`/`http`/`stream`/`wrap` |
|
||||
| 5 | 错误码进 metrics label | `metrics/metrics.go:160-172` | 非零 code 会被聚合成 `client`/`server`/`upstream` |
|
||||
| 6 | 返回结果结构 | `dto.SynthesisResult` | 见 §2.4 |
|
||||
| 7 | 上游不支持的输出格式要**降级** | `synthesis.go:63-65`、`README` 格式表 | 见 §2.5 |
|
||||
|
||||
### 2.3 埋点接口(MetricsRecorder)
|
||||
|
||||
适配器**不 import telemetry 包**,而是由主干注入一个接口实现
|
||||
(`controller/tts.go:28` 注入 `metrics.AdapterRecorder{}`)。这是刻意的解耦,新适配器请沿用。
|
||||
|
||||
```go
|
||||
type MetricsRecorder interface {
|
||||
UpstreamStarted(speaker, model, format string)
|
||||
UpstreamFinished(speaker, model, format, status string,
|
||||
duration, ttfb time.Duration, chunks, audioBytes, errCode int)
|
||||
UpstreamUsage(model string, textWords int)
|
||||
}
|
||||
```
|
||||
|
||||
现状实现里 `speaker` 是**语料无关的上游音色 ID**,会被 `telemetry.SpeakerLabel`
|
||||
做 `sha1[:8]` 哈希后才当 label(隐私保护,见 `metrics/metrics.go:127`)。
|
||||
新适配器传自己的音色标识即可,主干不解释它的含义。
|
||||
|
||||
`status` 的取值约定(沿用即可,聚合看板依赖它们):
|
||||
`ok` / `request_error` / `transport_error` / `http_<code>` / `stream_error` / `wrap_error`。
|
||||
|
||||
### 2.4 返回结果(dto.SynthesisResult)
|
||||
|
||||
```go
|
||||
type SynthesisResult struct {
|
||||
AudioData []byte // 最终可直接回给客户端的音频字节(已收尾,如 wav 拼好头)
|
||||
Format string // 真实输出格式,决定 Content-Type
|
||||
SampleRate int
|
||||
ReqID string // 回写 X-Request-Id,排障用
|
||||
TextWords int // 上游计费字符数(取不到填 0)
|
||||
Chunks int
|
||||
AudioBytes int
|
||||
TTFB time.Duration // 首字节耗时
|
||||
Duration time.Duration
|
||||
}
|
||||
```
|
||||
|
||||
`Format` 必须是主干认识的取值(见 `controller/tts.go:258` `contentTypeFor`):
|
||||
`mp3` / `wav` / `pcm` / `ogg_opus`(别名 `opus`)。填别的会导致 Content-Type 错。
|
||||
|
||||
### 2.5 格式降级规则(容易踩)
|
||||
|
||||
客户端要的 `response_format` 和上游能给的格式**往往不一致**,必须显式降级:
|
||||
|
||||
| 客户端要 | 火山做法 | 为什么 |
|
||||
|---|---|---|
|
||||
| `wav` | 上游请求 `pcm`,本地 `WrapWAVHeader` 拼头 | 流式 wav 每 chunk 带独立头,拼接即坏 |
|
||||
| `aac` / `flac` | **降级成 mp3**,Content-Type 报 `audio/mpeg` | 火山不支持 |
|
||||
| `opus` | 上游 `ogg_opus` | 命名差异 |
|
||||
|
||||
新适配器同样要回答这个问题:**你要的格式上游给不了时,降级到什么?**
|
||||
并且必须在 `Format` 字段里如实回报真实格式,否则客户端拿到的是"声明 mp3 实际 pcm"。
|
||||
|
||||
### 2.6 实测踩过的坑(上游协议层面)
|
||||
|
||||
这些是火山适配器真实修过的 bug,接新上游时同类问题大概率复现:
|
||||
|
||||
1. **事件分发必须白名单**:`ParseStream` 只把 `event == "sentence"` 或事件为空的帧
|
||||
当音频,未知事件只记日志**绝不拼进音频**(`response.go:71-113`)。
|
||||
早期实现把 `TTSSubtitle` 也当音频,导致音频流被污染。
|
||||
2. **结束帧要提前 break**:上游用 `code == 20000000` 表示流正常结束,收到后要
|
||||
把剩余行读完再 break,否则连接不释放。
|
||||
3. **单行可能很长**:`scanner.Buffer` 上限要放大(火山设到 8MB),否则大 chunk 会 EOF。
|
||||
4. **所有音频帧 base64 解码失败要**返回错误,**不能跳过** —— 跳过等于静默产出半截音频。
|
||||
5. **一个字节音频都没收到要报错**,不能返回空切片当成功(`response.go:125-131`)。
|
||||
6. **错误响应体可能含换行**:直接拼进错误消息会伪造日志行,火山做了
|
||||
`\n`/`\r` 转义(`synthesis.go:99-101`),新适配器照做。
|
||||
|
||||
---
|
||||
|
||||
## 3. 目标架构:Provider 抽象(待实施)
|
||||
|
||||
以下代码**当前不存在**,是建议落地的设计。
|
||||
|
||||
### 3.1 接口定义
|
||||
|
||||
建议新增 `adapter/provider/provider.go`(新包,**不放在** `adapter/volcano` 里,
|
||||
避免主干继续依赖具体实现):
|
||||
|
||||
```go
|
||||
// Provider 是一个上游 TTS 服务的统一抽象。
|
||||
// 实现者只需要关心:把我的能力说清楚、把一次合成做完。
|
||||
type Provider interface {
|
||||
// Name 稳定标识,用于配置键、库表字段、metrics label。
|
||||
// 约定全小写无空格:volcano / openai / azure / aliyun / gpt-sovits。
|
||||
Name() string
|
||||
|
||||
// Capabilities 声明本适配器支持什么。
|
||||
// 主干据此做校验与降级,不靠 if-else 猜实现。
|
||||
Capabilities() Capabilities
|
||||
|
||||
// Synthesize 执行一次合成,阻塞到完成。
|
||||
// 必须遵守:ctx 取消即返回;上游不支持 clientFormat 时按 Capabilities 降级,
|
||||
// 并在 Result.Format 里如实回报真实格式。
|
||||
Synthesize(ctx context.Context, req Request, mtr MetricsRecorder) (*dto.SynthesisResult, error)
|
||||
}
|
||||
|
||||
type Capabilities struct {
|
||||
// 上游原生能产出的格式;客户端要的格式不在其中时,主干负责降级或拒绝。
|
||||
Formats []string
|
||||
// 是否支持用倍率控制语速。不支持时主干忽略 speed 而不是报错。
|
||||
Speed bool
|
||||
// 是否按字符计费并回传用量(决定 UpstreamUsage 是否有意义)。
|
||||
Usage bool
|
||||
// 是否支持多音色路由。不支持时该 provider 只能配一个默认音色。
|
||||
Voices bool
|
||||
// 是否需要资源/部署/项目 ID 这类额外维度(火山需要,OpenAI 不需要)。
|
||||
ExtraScopes bool
|
||||
}
|
||||
|
||||
// Request 是主干交给适配器的、已归一化的合成请求。
|
||||
// 注意:这里刻意不出现任何厂商专属字段。
|
||||
type Request struct {
|
||||
Text string
|
||||
VoiceKey string // voices 表的主键语义(对外 voice 名或上游音色 ID)
|
||||
Model string
|
||||
Format string // 客户端期望格式(主干已归一化:mp3/wav/pcm/ogg_opus)
|
||||
SampleRate int
|
||||
Speed float64 // 1.0 = 原速
|
||||
Language string
|
||||
Extra map[string]string // 厂商专属配置,从 voices/settings 的 JSON 列读
|
||||
|
||||
// Credentials 由 provider 自己解释:
|
||||
// 火山读 api_key + resource_id;OpenAI 只读 api_key。
|
||||
Credentials Credentials
|
||||
}
|
||||
|
||||
type Credentials struct {
|
||||
APIKey string
|
||||
// 厂商额外凭证/路由维度。火山: resource_id;Azure: region;自建: base_url。
|
||||
Scope map[string]string
|
||||
}
|
||||
```
|
||||
|
||||
### 3.2 注册表
|
||||
|
||||
```go
|
||||
// adapter/provider/registry.go
|
||||
func Register(p Provider) // 通常在包的 init() 里调用
|
||||
func Get(name string) (Provider, bool)
|
||||
func Names() []string // admin UI 下拉框用
|
||||
```
|
||||
|
||||
**要点**:注册要放在**主干之外**。建议 `main.go` 显式空导入:
|
||||
|
||||
```go
|
||||
import (
|
||||
_ "github.com/volcano-tts/tts-api/adapter/volcano" // 注册 volcano
|
||||
_ "github.com/volcano-tts/tts-api/adapter/openai" // 注册 openai
|
||||
)
|
||||
```
|
||||
|
||||
这样主干只依赖 `provider` 包,**新增上游不需要改主干任何一行** —— 这是本架构的核心收益,
|
||||
请务必守住。`controller/tts.go` 里不应再出现 `adapter/volcano`。
|
||||
|
||||
---
|
||||
|
||||
## 4. 分阶段实施计划
|
||||
|
||||
**强烈建议按阶段做,每阶段结束都能编译、能跑、行为不变。**
|
||||
一次性重构"配置 + 路由 + 库表 + 前端 + metrics"五个面,几乎必然做出半成品。
|
||||
|
||||
### 阶段 0 · 抽出接口,零行为变更(纯重构)
|
||||
|
||||
目标:主干不再依赖具体实现,但**行为完全不变**,回归风险最低。
|
||||
|
||||
- [ ] 新增 `adapter/provider` 包,放 `Provider` / `Capabilities` / `Request` / `Credentials` / `MetricsRecorder`
|
||||
- [ ] 让 `volcano` 包实现 `Provider`(本质是把 `Options` 包一层适配,`Synthesis` 改成方法)
|
||||
- [ ] `controller/tts.go`:把 `volcanoClient` + `volcano.Synthesis` 换成 `provider.Get(name).Synthesize`
|
||||
- [ ] `MetricsRecorder` 从 `adapter/volcano` **移出**到 `provider` 包(否则接口还是火山专属)
|
||||
- [ ] `setting.LoadRuntimeConfig` 暂时继续构造 `volcano.Options`,通过一个
|
||||
「volcano provider 的配置映射函数」转成 `provider.Request`
|
||||
- [ ] 验收:`go build ./... && go vet ./... && go test ./... -count=1` 全绿,
|
||||
且 `/v1/audio/speech` 行为与重构前逐字节一致(拿同一段文本对比音频长度与格式)
|
||||
|
||||
> 这一阶段**不要**动库表、不要动前端。目标只有一个:主干里那行
|
||||
> `import adapter/volcano` 消失。
|
||||
|
||||
### 阶段 1 · 数据结构:provider 维度入库
|
||||
|
||||
> ⚠️ **先纠正一个常见误解:本项目的迁移框架其实没有接线。**
|
||||
> `store/migrate.go` 里定义了 `Migration` 结构体和 `migrations` 切片,但那个切片是
|
||||
> **空的**,`store/db.go` 的 `migrate()` 也从**不**读取它 —— 注释里写得很明白:
|
||||
> "本期 M0 阶段 schemaVersion=1,migrate() 在 db.go 内做基础建表,**未触发 migrations 调度**"。
|
||||
> 所以 `migrate()` 目前**只做 `CREATE TABLE IF NOT EXISTS`**,没有任何版本比较,
|
||||
> 对已存在的表**完全不做变更**。
|
||||
>
|
||||
> 还有一个既有瑕疵:`db.go:148-150` 的 `INSERT OR IGNORE INTO schema_version (version) VALUES (?)`
|
||||
> 语句里既没有字面量也没传参,绑定到 `?` 的是**零值**,所以表里实际写入的版本号是 **0**,
|
||||
> 不是常量 `schemaVersion`(=1)。做 v2 迁移时请一并修掉,否则版本判断从一开始就是错的。
|
||||
>
|
||||
> **结论**:给 `voices` 加列**不会**自动发生,你必须自己写 `ALTER TABLE`,
|
||||
> 并且在启动时能被重复执行而不报错(老库、新库都要能跑)。
|
||||
|
||||
本阶段要做:
|
||||
|
||||
- [ ] 在 `migrate()`(或新启用的迁移调度)里实现**幂等**加列:
|
||||
先 `PRAGMA table_info(voices)` 查现有列,缺哪个 `ALTER TABLE ... ADD COLUMN` 哪个
|
||||
(SQLite 的 `ADD COLUMN` 不支持 `IF NOT EXISTS`,重复执行会报错,必须先查)
|
||||
- [ ] `voices` 表加列(见 §5.1),老库回填 `provider='volcano'`
|
||||
- [ ] 修正 `schema_version` 写入零值的瑕疵,并写出真实版本号
|
||||
- [ ] 若确实要启用 `migrate.go` 的调度框架,则把 `schemaVersion`(db.go,`=1`)
|
||||
与 `schemaVersionRequested`(migrate.go,`=1`)一并提升到 2;
|
||||
注意 `installer/lock.go` 里的 `schemaVersion = "1"`(字符串)**是另一套东西**——
|
||||
它写在 `installed.lock` 里做安装标记,与库表结构版本是两回事,
|
||||
两者要一起提升就一起提升,不要只改一边造成语义分裂
|
||||
- [ ] `store.Voice` 结构体加字段 + JSON tag
|
||||
- [ ] `store.GetVoiceForTTS` 返回值扩展(见 §5.2),`setting.Store` 接口同步改
|
||||
- [ ] `cmd/dumpdb` 输出新列
|
||||
- [ ] 验收:**用一个装了老数据的 `tts.db`** 启动服务(不要用全新库测),
|
||||
确认自动加列成功、数据不丢、`/v1/audio/speech` 仍可用;
|
||||
再重启一次确认迁移幂等(第二次不报错)
|
||||
|
||||
### 阶段 2 · 配置:按 provider 命名空间化
|
||||
|
||||
现状是 `settings` 表用**扁平键**,且键名全是火山语义(`default_resource_id`、
|
||||
`default_speaker`、`model_type`…)。多上游后必须命名空间化。
|
||||
|
||||
- [ ] 保留全局键:`auth_key` / `cors_*` / `timeout` / `default_provider`
|
||||
- [ ] 厂商专属键改为 `provider.<name>.<key>`,例如
|
||||
`provider.volcano.api_key`、`provider.volcano.resource_id`、
|
||||
`provider.openai.api_key`、`provider.openai.base_url`
|
||||
- [ ] `LoadRuntimeConfig` 只装配**当前 `default_provider`** 的 `Request`,
|
||||
不再构造 `volcano.Options`
|
||||
- [ ] `setting.CheckEnvironmentVariables` / `LogStartupSummary` 去掉
|
||||
`BYTEDANCE_TTS_*` 硬编码名,改成遍历 provider 的必填项(否则 `/health` 会误导运维)
|
||||
- [ ] 迁移:老键 `api_key` → `provider.volcano.api_key` 等,一次性搬完并保留旧键只读兜底一轮
|
||||
- [ ] 验收:除火山外没有任何 provider 时,服务行为仍与阶段 1 相同
|
||||
|
||||
### 阶段 3 · 观测:metrics 加 provider 维度
|
||||
|
||||
- [ ] `tts_upstream_total` / `tts_upstream_duration_seconds` / `tts_upstream_errors_total`
|
||||
等**全部上游指标加 `provider` label**
|
||||
- [ ] `metrics.AdapterRecorder` 增加 provider 字段(构造时注入 name)
|
||||
- [ ] 仪表盘 PromQL 补 `by (provider)`
|
||||
- [ ] ⚠️ **破坏性变更**:加 label 会让现有告警规则里的
|
||||
`tts_upstream_total{...}` 聚合口径变化,发布说明里要写明
|
||||
- [ ] 验收:`/metrics` 上能按 provider 拆分成功率与 P95
|
||||
|
||||
### 阶段 4 · 管理界面:provider 选择与音色归属
|
||||
|
||||
- [ ] `/setup` 向导第 1 步加"上游类型"选择,后续步骤按所选 provider 动态渲染字段
|
||||
(火山显示 resource_id,**OpenAI 显示 base_url 且不显示 resource_id**)
|
||||
- [ ] `router/admin-voices.html` 新增/编辑音色时选 provider 与 model
|
||||
- [ ] `/api/voices` 的请求/响应加 `provider` 字段,`controller/admin.go` 校验
|
||||
"provider 必须已注册",否则 400(不要留到合成时才 500)
|
||||
- [ ] 删除 provider 最后一个音色时的保护逻辑(现在的 `ErrInUse` 只管 `default_speaker`)
|
||||
- [ ] 验收:UI 上能并存火山与 OpenAI 音色,各自路由正确
|
||||
|
||||
### 阶段 5 · 第二个真实适配器(OpenAI 兼容)
|
||||
|
||||
**这一步才是对抽象的真正验收**。选 OpenAI 兼容上游(或其代理)最省事,因为
|
||||
本项目对外就是 OpenAI 形状 —— 可以直接验证"请求/响应穿透"是否正确。
|
||||
|
||||
- [ ] 新建 `adapter/openai/`,只实现 §3.1 的接口
|
||||
- [ ] 全程**不改** `controller/` `setting/` `store/` 任何一行
|
||||
- [ ] 如果为了实现它而必须改主干,说明 §3.1 的抽象漏了维度 —— **回头修接口,而不是打补丁**
|
||||
- [ ] 验收:同一份 `voices` 配置里两个 provider 可同时服务,
|
||||
客户端只看到 `voice` 名不同
|
||||
|
||||
---
|
||||
|
||||
## 5. 数据模型改动细节
|
||||
|
||||
### 5.1 voices 表
|
||||
|
||||
现状(真实 schema,`store/db.go:129-142`):
|
||||
|
||||
```sql
|
||||
CREATE TABLE IF NOT EXISTS voices (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
speaker TEXT NOT NULL, -- 上游音色 ID
|
||||
resource_id TEXT NOT NULL, -- ← 火山专属概念,却写成 NOT NULL 通用列
|
||||
model TEXT DEFAULT '',
|
||||
language TEXT DEFAULT '',
|
||||
description TEXT DEFAULT '',
|
||||
enabled INTEGER NOT NULL DEFAULT 1,
|
||||
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
```
|
||||
|
||||
**问题**:`resource_id` 是火山独有概念(决定模型版本与计费),却成了全表必填列。
|
||||
OpenAI 上游根本没有这个字段 —— 这正是"单上游假设"渗进数据模型的典型症状。
|
||||
|
||||
建议改为:
|
||||
|
||||
```sql
|
||||
ALTER TABLE voices ADD COLUMN provider TEXT NOT NULL DEFAULT 'volcano';
|
||||
ALTER TABLE voices ADD COLUMN vendor_params TEXT NOT NULL DEFAULT '{}'; -- JSON,厂商私有
|
||||
-- resource_id 保留但放宽为可空(或整体搬进 vendor_params,看迁移成本)
|
||||
```
|
||||
|
||||
- `provider` 建索引:`CREATE INDEX idx_voices_provider ON voices(provider)`
|
||||
- `vendor_params` 存厂商私有键值(火山:`{"resource_id":"seed-icl-2.0","model_type":4}`),
|
||||
主干**不解释**它的内容,原样交给对应 provider
|
||||
- 迁移:`UPDATE voices SET provider='volcano' WHERE provider IS NULL OR provider=''`
|
||||
|
||||
### 5.2 GetVoiceForTTS 的签名
|
||||
|
||||
现状(`setting/config.go:426-436`,刻意用 5 个返回值避免循环 import):
|
||||
|
||||
```go
|
||||
GetVoiceForTTS(name string) (speaker, resourceID, model string, found bool, err error)
|
||||
```
|
||||
|
||||
多上游后要扩成:
|
||||
|
||||
```go
|
||||
// 返回该 voice 的 provider 名 + 厂商私有参数,主干据此把请求路由给对应适配器。
|
||||
GetVoiceForTTS(name string) (providerName, speakerID, model string, vendorParams map[string]string, found bool, err error)
|
||||
```
|
||||
|
||||
**注意**:当年之所以不用 `(VoiceRef, error)`,是为了让 `store` 不 import `setting`
|
||||
(避免循环 import)。加字段时**别再引入新的结构体依赖**,继续用扁平返回值或
|
||||
定义在 `store` 包里的中性结构体。
|
||||
|
||||
---
|
||||
|
||||
## 6. 新增一个适配器的完整清单
|
||||
|
||||
假设要加 `foo` 上游:
|
||||
|
||||
**代码**
|
||||
|
||||
1. `adapter/foo/foo.go` —— 实现 `provider.Provider`(`Name()` 返回 `"foo"`)
|
||||
2. `adapter/foo/request.go` —— `provider.Request` → foo 的 HTTP 请求体
|
||||
3. `adapter/foo/response.go` —— 解析 foo 的响应;严格遵守 §2.6 的 6 条协议纪律
|
||||
4. `adapter/foo/errors.go` —— 错误要带阶段,`Stage` 用统一枚举
|
||||
5. `adapter/foo/foo_test.go` —— 至少覆盖:正常流、未知事件不污染音频、空音频报错、
|
||||
base64 解码失败报错、格式降级回报正确 `Format`、`ctx` 取消能及时返回
|
||||
(测试文件按项目策略不入库,本地保留并在合并前手动跑)
|
||||
6. 在 `foo.go` 的 `init()` 里 `provider.Register(...)`
|
||||
7. `main.go` 加一行空导入
|
||||
|
||||
**配置**
|
||||
|
||||
8. 定义必填项清单(供 `/health` 与启动摘要显示),不要写死在前端
|
||||
9. 在 `/setup` 向导里加该 provider 的字段定义(阶段 4 之后是数据驱动,只需加配置)
|
||||
|
||||
**验收**
|
||||
|
||||
10. `go build ./... && go vet ./... && go test ./... -count=1` 全绿
|
||||
11. 起服 → `/setup` 选 foo → 填凭证 → 加一个音色 → `curl /v1/audio/speech` 出声
|
||||
12. 故意填错凭证 → 客户端应拿到明确的 4xx/5xx 与 `code`,日志里凭证是**打码**的
|
||||
13. 不支持的 `response_format` → 按 `Capabilities` 降级,且 Content-Type 与真实字节一致
|
||||
|
||||
---
|
||||
|
||||
## 7. 测试策略(注意本项目的特殊约束)
|
||||
|
||||
**本项目测试文件不入库**(`.gitignore` 里的 `*_test.go`),
|
||||
测试保留在本地磁盘。这带来两个直接后果,必须知道:
|
||||
|
||||
1. **没有任何自动化会跑你的测试**。仓库里不提供 CI 质量门:
|
||||
GitHub 上只有一个 workflow,且它只在**发版打 tag 时构建 Docker 镜像**,
|
||||
既不编译校验也不跑测试。所以适配器测试**必须在本地跑过再合并**:
|
||||
```bash
|
||||
go test ./... -count=1
|
||||
```
|
||||
2. **不要依赖测试文件来传递知识**。协议细节、踩坑记录要写进**代码注释**和本文档,
|
||||
否则对下一个人等于不存在。
|
||||
|
||||
适配器测试的**最小可用集合**(按 §2.6 的坑逐条覆盖):
|
||||
|
||||
| 用例 | 断言 |
|
||||
|---|---|
|
||||
| 正常流 | 音频字节非空;`Chunks` / `TTFB` / `Format` 合理 |
|
||||
| 未知事件帧 | 不进入音频;不报错;不改变 `Chunks` |
|
||||
| 字幕帧 | 进 `Subtitles`,**不进** `AudioData` |
|
||||
| 全流无音频 | 返回错误,不是"成功 + 空字节" |
|
||||
| base64 损坏 | 返回错误,不是跳过继续 |
|
||||
| 超长单行(>1MB) | 不 EOF |
|
||||
| 上游 HTTP 4xx/5xx | 错误 `Stage == "http"`,携带 code |
|
||||
| `ctx` 取消 | 及时返回,不泄漏 goroutine |
|
||||
| 格式降级 | `Result.Format` 是真实格式,不是客户端要的格式 |
|
||||
|
||||
---
|
||||
|
||||
## 8. 反模式清单(明确不要做)
|
||||
|
||||
- ❌ **不要在 `controller/` 里写 `switch providerName` 分发**。
|
||||
分发只能走注册表,否则每加一个上游都要改主干,抽象就白做了。
|
||||
- ❌ **不要让 `provider` 包 import 任何具体适配器**。依赖方向永远是
|
||||
`具体适配器 → provider 包 ← 主干`。
|
||||
- ❌ **不要在 `provider.Request` 里加厂商专属字段**(如 `ResourceID`)。
|
||||
厂商私有参数一律走 `Credentials.Scope` / `Request.Extra` / `voices.vendor_params`。
|
||||
- ❌ **不要把上游返回的原始音频直接当结果返回而不收尾**。
|
||||
PCM 要拼头,降级要如实回报 `Format`(见 §2.5)。
|
||||
- ❌ **不要静默跳过解析失败的帧**(§2.6 第 4 条)。
|
||||
- ❌ **不要在日志里打印明文凭证或音色 ID**。沿用
|
||||
`telemetry.MaskSpeaker` / `MaskResourceID`,新适配器的私有敏感字段也要加等价打码。
|
||||
- ❌ **不要用一个 `settings` 键名承载多个 provider 的配置**。
|
||||
- ❌ **不要为了省事把 provider 名写进 `settings` 的扁平键里当"事实上的路由"**,
|
||||
路由的唯一权威是 `voices.provider` 与 `default_provider`。
|
||||
|
||||
---
|
||||
|
||||
## 9. 关键文件索引
|
||||
|
||||
| 关注点 | 文件 | 说明 |
|
||||
|---|---|---|
|
||||
| 请求入口 / 校验 / 路由 | `controller/tts.go` | `resolveClientFormat`、voice 查库、错误归一 |
|
||||
| 合成编排参考实现 | `adapter/volcano/synthesis.go` | 埋点顺序、格式降级、错误分阶段 |
|
||||
| 流解析参考实现 | `adapter/volcano/response.go` | 事件白名单、结束帧、base64 |
|
||||
| 传输层参考实现 | `adapter/volcano/client.go` | 连接复用、nil 安全 |
|
||||
| 配置装配 | `setting/config.go` | `LoadRuntimeConfig`、`setting.Store` 接口 |
|
||||
| 库表与迁移 | `store/db.go`、`store/migrate.go` | `schemaVersion`、`migrate()`(**迁移框架未接线,见阶段 1 警示**);`installer/lock.go` 的 `schemaVersion` 是另一套 |
|
||||
| 音色模型 | `store/voices.go` | `Voice`、`GetVoiceForTTS` |
|
||||
| 指标 | `metrics/metrics.go` | `AdapterRecorder`、`codeLabel` |
|
||||
| 结果类型 | `dto/tts.go` | `SynthesisResult`、`SubtitleEntry` |
|
||||
| 未来抽象落点 | `adapter/provider/` | **尚不存在,待阶段 0 创建** |
|
||||
|
||||
---
|
||||
|
||||
*文档版本:v1 · 对应代码基线:`develop` @ `ad342ec`(2026-10-03)*
|
||||
*本文「现状」部分与代码逐行核对过;「目标架构」为提案,实施时请同步更新本文档。*
|
||||
@@ -35,6 +35,8 @@ func main() {
|
||||
setting.InitAllConfigs()
|
||||
metrics.Init()
|
||||
middleware.InitRateLimiter()
|
||||
// v0.3.0:根路径 /metrics 的内网白名单(未配置则根路径完全不注册)
|
||||
middleware.InitMetricsAllowList()
|
||||
|
||||
// 2) 启动期关键步骤:打开/建库 → 检测 lock → 判定模式
|
||||
dbPath := ttsDBPath()
|
||||
@@ -85,6 +87,21 @@ func main() {
|
||||
|
||||
// 5) 启动摘要日志(此时 Auth.APIKeys 已是 DB 值,日志反映真实状态)
|
||||
setting.LogStartupSummary()
|
||||
|
||||
// 5.1) v0.3.0 前置校验:normal 模式下必须有管理凭证。
|
||||
// 为什么 fail-fast 而不是警告:mware.RequireAdmin 在凭证为空时**拒绝**访问
|
||||
// (不再像 v0.3.0 之前那样放行)。若此处不拦住,服务会正常起来,
|
||||
// 但 /dashboard 与所有 /api/admin/* 全部 401 —— 相当于把自己锁在门外。
|
||||
// 宁可启动失败并打印明确原因,也不要起来一个进不去后台的实例。
|
||||
if installer.GetMode() == installer.ModeNormal && len(setting.GetAdminKeys()) == 0 {
|
||||
log.Printf("[main][FATAL] normal 模式未配置任何管理凭证:admin_key / auth_key / OPENAI_TTS_API_KEY 均为空。")
|
||||
log.Printf("[main][FATAL] 管理接口(含 /dashboard)将全部返回 401,服务拒绝启动。")
|
||||
log.Fatalf("no admin credential configured; set admin_key (or auth_key) before starting in normal mode")
|
||||
}
|
||||
if installer.GetMode() == installer.ModeNormal {
|
||||
log.Printf("[main] 管理凭证来源: %s", setting.GetAdminKeySource())
|
||||
}
|
||||
|
||||
log.Printf("[main] 当前模式: %s (db=%s lock=%s)", res.Mode, dbPath, res.LockPath)
|
||||
|
||||
controller.InitController()
|
||||
@@ -113,8 +130,13 @@ func main() {
|
||||
log.Printf("OpenAI TTS endpoint: http://localhost:%s/v1/audio/speech", setting.Server.Port)
|
||||
log.Printf("Admin WebUI: http://localhost:%s/admin", setting.Server.Port)
|
||||
}
|
||||
log.Printf("Health check: http://localhost:%s/health", setting.Server.Port)
|
||||
log.Printf("Metrics: http://localhost:%s/metrics", setting.Server.Port)
|
||||
log.Printf("Health check(匿名存活探针): http://localhost:%s/healthz", setting.Server.Port)
|
||||
if middleware.MetricsAllowListConfigured() {
|
||||
log.Printf("Metrics(内网白名单): http://localhost:%s/metrics", setting.Server.Port)
|
||||
} else {
|
||||
log.Printf("Metrics: 根路径 /metrics 未注册(未配置 METRICS_ALLOW_CIDR);请用鉴权版 /api/admin/metrics")
|
||||
}
|
||||
log.Printf("详细健康数据(鉴权): http://localhost:%s/api/admin/health", setting.Server.Port)
|
||||
|
||||
if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
||||
log.Fatalf("Server failed to start: %v", err)
|
||||
|
||||
+17
-10
@@ -9,14 +9,19 @@ import (
|
||||
"github.com/volcano-tts/tts-api/setting"
|
||||
)
|
||||
|
||||
// RequireAdmin 是 /admin 路由的鉴权中间件,复用 OPENAI_TTS_API_KEY。
|
||||
// 行为:
|
||||
// - Auth.APIKeys 为空 → 所有请求放行(等同无鉴权)
|
||||
// - Authorization 头 Bearer token 在列表中 → 放行
|
||||
// - 其它 → 401 + JSON {error: 'unauthorized', code: 'admin_auth_failed'}
|
||||
// RequireAdmin 是管理接口(/api/admin/*、/api/voices*、/api/settings*)的鉴权中间件。
|
||||
//
|
||||
// 设计: 与现有 /v1/audio/speech 用的鉴权 key 列表(setting.GetAuthAPIKeys)共享同一份 keys,
|
||||
// 用户只用管一个 env 变量(OPENAI_TTS_API_KEY)。
|
||||
// 凭证来源:setting.GetAdminKeys(),优先级 admin_key(DB) > auth_key(DB) > OPENAI_TTS_API_KEY(env)。
|
||||
// 与业务侧鉴权(middleware.ValidateAPIKey,只看 auth_key)分离,实现权限隔离:
|
||||
// 配置了独立 admin_key 后,业务调用方持有的 key 无法访问管理接口。
|
||||
//
|
||||
// 行为:
|
||||
// - OPTIONS 预检 → 放行(浏览器预检不带 Authorization)
|
||||
// - 未配置任何凭证 → **拒绝**(401)。这是刻意设计:v0.3.0 之前这里直接放行,
|
||||
// 导致管理接口在"没配 key"的部署上完全裸奔,并让后续给 /metrics、/health
|
||||
// 套本中间件的加固形同虚设。启动期已由 main.go 做 fail-fast 校验。
|
||||
// - Authorization 头 Bearer token 命中凭证列表 → 放行
|
||||
// - 其它 → 401 + JSON {error: {code: 'admin_auth_failed'}}
|
||||
func RequireAdmin(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// 预检: 跨域/OPTIONS 直接放行(让浏览器能发 preflight)
|
||||
@@ -25,10 +30,12 @@ func RequireAdmin(next http.Handler) http.Handler {
|
||||
return
|
||||
}
|
||||
|
||||
keys := setting.GetAuthAPIKeys()
|
||||
keys := setting.GetAdminKeys()
|
||||
if len(keys) == 0 {
|
||||
// 没配 admin key,等同无鉴权
|
||||
next.ServeHTTP(w, r)
|
||||
// 没配管理凭证 → 拒绝(旧行为是放行,见上方注释说明为何改掉)
|
||||
log.Printf("[admin_auth] 拒绝:未配置管理凭证(admin_key/auth_key/OPENAI_TTS_API_KEY 均为空) - 路径=%s 客户端=%s",
|
||||
r.URL.Path, GetClientIP(r))
|
||||
denyAdmin(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,103 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// metricsAllowList 是 METRICS_ALLOW_CIDR 解析出的内网白名单。
|
||||
// 启动期由 InitMetricsAllowList 填充;运行期只读,无并发写。
|
||||
var metricsAllowList []*net.IPNet
|
||||
|
||||
// metricsAllowConfigured 表示是否配置了非空的 METRICS_ALLOW_CIDR。
|
||||
// 决定根路径 /metrics、/health 是否注册(未配置则完全不注册,访问 404)。
|
||||
var metricsAllowConfigured bool
|
||||
|
||||
// InitMetricsAllowList 解析 METRICS_ALLOW_CIDR,启动期调用一次。
|
||||
//
|
||||
// 格式:逗号分隔的 CIDR 列表,例如 "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"。
|
||||
// 也接受裸 IP(自动补 /32 或 /128),方便写 "127.0.0.1"。
|
||||
//
|
||||
// 为什么需要它:根路径 /metrics、/health 是给 Prometheus 抓取 / K8s 探针用的机器端点,
|
||||
// 让它们带 Bearer 会强制改抓取配置;用内网白名单更省事,且默认不暴露。
|
||||
//
|
||||
// 【重要】Docker 环境不要填 127.0.0.1/32 —— 那是容器自身的回环,
|
||||
// Prometheus 在宿主机或另一个容器里根本进不来。请填容器内网网段(如 172.16.0.0/12)。
|
||||
func InitMetricsAllowList() {
|
||||
raw := strings.TrimSpace(os.Getenv("METRICS_ALLOW_CIDR"))
|
||||
metricsAllowList = nil
|
||||
metricsAllowConfigured = false
|
||||
if raw == "" {
|
||||
return
|
||||
}
|
||||
|
||||
for _, part := range strings.Split(raw, ",") {
|
||||
entry := strings.TrimSpace(part)
|
||||
if entry == "" {
|
||||
continue
|
||||
}
|
||||
// 裸 IP 自动补全掩码
|
||||
if !strings.Contains(entry, "/") {
|
||||
if ip := net.ParseIP(entry); ip != nil {
|
||||
if ip.To4() != nil {
|
||||
entry += "/32"
|
||||
} else {
|
||||
entry += "/128"
|
||||
}
|
||||
}
|
||||
}
|
||||
_, ipnet, err := net.ParseCIDR(entry)
|
||||
if err != nil {
|
||||
log.Printf("[metrics-ip] 忽略非法 CIDR 条目 %q: %v", part, err)
|
||||
continue
|
||||
}
|
||||
metricsAllowList = append(metricsAllowList, ipnet)
|
||||
}
|
||||
metricsAllowConfigured = len(metricsAllowList) > 0
|
||||
if metricsAllowConfigured {
|
||||
log.Printf("[metrics-ip] METRICS_ALLOW_CIDR 已启用,根路径 /metrics 仅对 %d 个网段开放", len(metricsAllowList))
|
||||
} else {
|
||||
log.Printf("[metrics-ip] METRICS_ALLOW_CIDR 无有效条目,根路径 /metrics 将不注册")
|
||||
}
|
||||
}
|
||||
|
||||
// MetricsAllowListConfigured 报告是否配置了有效的白名单网段。
|
||||
// router 据此决定是否注册根路径 /metrics / /health。
|
||||
func MetricsAllowListConfigured() bool { return metricsAllowConfigured }
|
||||
|
||||
// MetricsIPAllowList 只放行来源 IP 命中白名单的请求。
|
||||
//
|
||||
// 未命中返回 **404**(而不是 403):不向扫描者确认"这里存在一个只是你没权限的端点"。
|
||||
// 客户端 IP 取自 GetClientIP,它已处理 X-Forwarded-For 与 TRUSTED_PROXY_HOPS,
|
||||
// 所以反代后面的真实来源也能正确判定。
|
||||
func MetricsIPAllowList(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if !ipAllowed(GetClientIP(r)) {
|
||||
// 不打印每个被拒请求,避免扫描流量刷爆日志;只按需在 debug 下输出
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// ipAllowed 判定客户端 IP 是否命中任一白名单网段。
|
||||
// 空 IP(解析失败)一律拒绝 —— 宁可拒绝也不能误放行。
|
||||
func ipAllowed(clientIP string) bool {
|
||||
if clientIP == "" {
|
||||
return false
|
||||
}
|
||||
ip := net.ParseIP(strings.TrimSpace(clientIP))
|
||||
if ip == nil {
|
||||
return false
|
||||
}
|
||||
for _, n := range metricsAllowList {
|
||||
if n.Contains(ip) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -6,7 +6,7 @@
|
||||
<title>管理后台 · 登录</title>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/vue/3.4.21/vue.global.prod.js"></script>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/axios/1.6.7/axios.min.js"></script>
|
||||
<link rel="stylesheet" href="/admin/admin.css">
|
||||
<link rel="stylesheet" href="/dashboard/admin.css">
|
||||
</head>
|
||||
<body>
|
||||
<div id="app">
|
||||
@@ -22,7 +22,7 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/admin/admin-shell.js"></script>
|
||||
<script src="/dashboard/admin-shell.js"></script>
|
||||
<script>
|
||||
const { createApp, ref } = Vue;
|
||||
const { http, setKey, clearKey, getKey } = window.admin;
|
||||
@@ -34,7 +34,7 @@
|
||||
// 已登录则直接跳 dashboard
|
||||
if (getKey()) {
|
||||
http.get('/admin/overview').then(() => {
|
||||
location.href = '/admin';
|
||||
location.href = '/dashboard';
|
||||
}).catch(() => { clearKey(); });
|
||||
}
|
||||
|
||||
@@ -42,7 +42,7 @@
|
||||
loginErr.value = '';
|
||||
try {
|
||||
await window.admin.login(keyInput.value);
|
||||
location.href = '/admin';
|
||||
location.href = '/dashboard';
|
||||
} catch (e) {
|
||||
loginErr.value = '鉴权失败: ' + (e.response?.data?.error?.message || e.message);
|
||||
}
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
<title>火山 TTS · 系统设置</title>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/vue/3.4.21/vue.global.prod.js"></script>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/axios/1.6.7/axios.min.js"></script>
|
||||
<link rel="stylesheet" href="/admin/admin.css">
|
||||
<link rel="stylesheet" href="/dashboard/admin.css">
|
||||
</head>
|
||||
<body>
|
||||
<div id="app">
|
||||
@@ -34,7 +34,7 @@
|
||||
<div class="card-head">
|
||||
<div>
|
||||
<div class="card-title">鉴权 Key</div>
|
||||
<div class="card-sub">客户端调用 <code>/v1/audio/speech</code> 与登录 /admin 共用</div>
|
||||
<div class="card-sub">客户端调用 <code>/v1/audio/speech</code>。管理后台登录改用 <code>admin_key</code>(未配置时回退用本 Key)</div>
|
||||
</div>
|
||||
<span class="pill pill-accent">敏感</span>
|
||||
</div>
|
||||
@@ -143,7 +143,7 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/admin/admin-shell.js"></script>
|
||||
<script src="/dashboard/admin-shell.js"></script>
|
||||
<script>
|
||||
const { createApp, ref, computed, onMounted } = Vue;
|
||||
const { http, getKey, setKey, clearKey, toast, mountShell } = window.admin;
|
||||
@@ -236,7 +236,7 @@
|
||||
authKeyInput.value = '';
|
||||
setTimeout(() => {
|
||||
clearKey();
|
||||
location.href = '/admin/login';
|
||||
location.href = '/dashboard/login';
|
||||
}, 200);
|
||||
toast('ok', 'Auth Key 已更新,请用新 Key 重新登录');
|
||||
} catch (e) {
|
||||
@@ -246,7 +246,7 @@
|
||||
const resetSettingsForm = () => { loadSettings(); };
|
||||
|
||||
onMounted(() => {
|
||||
if (!getKey()) { location.href = '/admin/login'; return; }
|
||||
if (!getKey()) { location.href = '/dashboard/login'; return; }
|
||||
mountShell({
|
||||
activeNav: 'settings',
|
||||
overview: overview.value,
|
||||
|
||||
+10
-4
@@ -112,21 +112,27 @@
|
||||
<nav class="nav">
|
||||
<div class="nav-group">
|
||||
<div class="nav-label">概览</div>
|
||||
<a class="nav-item${activeNav === 'dashboard' ? ' active' : ''}" href="/admin">
|
||||
<a class="nav-item${activeNav === 'dashboard' ? ' active' : ''}" href="/dashboard">
|
||||
<span class="nav-icon">▦</span><span>仪表盘</span>
|
||||
</a>
|
||||
</div>
|
||||
<div class="nav-group">
|
||||
<div class="nav-label">管理</div>
|
||||
<a class="nav-item${activeNav === 'voices' ? ' active' : ''}" href="/admin/voices">
|
||||
<a class="nav-item${activeNav === 'voices' ? ' active' : ''}" href="/dashboard/voices">
|
||||
<span class="nav-icon">♪</span><span>音色</span>
|
||||
<span class="nav-badge">${voiceCount}</span>
|
||||
</a>
|
||||
<a class="nav-item${activeNav === 'settings' ? ' active' : ''}" href="/admin/settings">
|
||||
<a class="nav-item${activeNav === 'settings' ? ' active' : ''}" href="/dashboard/settings">
|
||||
<span class="nav-icon">⚙</span><span>设置</span>
|
||||
${corsConfigured ? '' : '<span class="nav-dot" title="CORS 未配置"></span>'}
|
||||
</a>
|
||||
</div>
|
||||
<div class="nav-group">
|
||||
<div class="nav-label">观测</div>
|
||||
<a class="nav-item${activeNav === 'status' ? ' active' : ''}" href="/dashboard/status">
|
||||
<span class="nav-icon">♥</span><span>详细状态</span>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
<div class="sidebar-foot">
|
||||
<button class="btn-icon" id="btn-reload" title="刷新">↻ 刷新</button>
|
||||
@@ -142,7 +148,7 @@
|
||||
if (btnLogout) btnLogout.addEventListener('click', () => {
|
||||
clearKey();
|
||||
if (typeof options.onLogout === 'function') options.onLogout();
|
||||
else location.href = '/admin/login';
|
||||
else location.href = '/dashboard/login';
|
||||
});
|
||||
return {};
|
||||
};
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
<title>火山 TTS · 音色管理</title>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/vue/3.4.21/vue.global.prod.js"></script>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/axios/1.6.7/axios.min.js"></script>
|
||||
<link rel="stylesheet" href="/admin/admin.css">
|
||||
<link rel="stylesheet" href="/dashboard/admin.css">
|
||||
</head>
|
||||
<body>
|
||||
<div id="app">
|
||||
@@ -159,7 +159,7 @@
|
||||
</teleport>
|
||||
</div>
|
||||
|
||||
<script src="/admin/admin-shell.js"></script>
|
||||
<script src="/dashboard/admin-shell.js"></script>
|
||||
<script>
|
||||
const { createApp, ref, computed, onMounted } = Vue;
|
||||
const { http, getKey, toast, mountShell } = window.admin;
|
||||
@@ -237,7 +237,7 @@
|
||||
};
|
||||
|
||||
onMounted(() => {
|
||||
if (!getKey()) { location.href = '/admin/login'; return; }
|
||||
if (!getKey()) { location.href = '/dashboard/login'; return; }
|
||||
mountShell({
|
||||
activeNav: 'voices',
|
||||
overview: overview.value,
|
||||
|
||||
+3
-3
@@ -6,7 +6,7 @@
|
||||
<title>火山 TTS · 仪表盘</title>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/vue/3.4.21/vue.global.prod.js"></script>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/axios/1.6.7/axios.min.js"></script>
|
||||
<link rel="stylesheet" href="/admin/admin.css">
|
||||
<link rel="stylesheet" href="/dashboard/admin.css">
|
||||
</head>
|
||||
<body>
|
||||
<div id="app">
|
||||
@@ -77,7 +77,7 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/admin/admin-shell.js"></script>
|
||||
<script src="/dashboard/admin-shell.js"></script>
|
||||
<script>
|
||||
const { createApp, ref, onMounted } = Vue;
|
||||
const { http, getKey, formatUptime, shortPath, formatBytes, formatStart, mountShell } = window.admin;
|
||||
@@ -93,7 +93,7 @@
|
||||
};
|
||||
|
||||
onMounted(() => {
|
||||
if (!getKey()) { location.href = '/admin/login'; return; }
|
||||
if (!getKey()) { location.href = '/dashboard/login'; return; }
|
||||
mountShell({ activeNav: 'dashboard', overview: overview.value, voiceCount: overview.value.voice_count, onReload: loadOverview });
|
||||
loadOverview();
|
||||
});
|
||||
|
||||
+10
-3
@@ -6,6 +6,7 @@
|
||||
<title>TTS 服务监控</title>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/vue/3.4.21/vue.global.prod.js"></script>
|
||||
<script src="https://cdn.bootcdn.net/ajax/libs/axios/1.6.7/axios.min.js"></script>
|
||||
<link rel="stylesheet" href="/dashboard/admin.css">
|
||||
<style>
|
||||
:root {
|
||||
--bg: #0b0f1a;
|
||||
@@ -148,6 +149,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="row-flex">
|
||||
<a class="btn" href="/dashboard" style="text-decoration:none;">← 返回控制台</a>
|
||||
<span class="status-badge" :class="health.status === 'ok' ? 'ok' : 'error'">
|
||||
<span class="status-dot" :class="{ live: health.status === 'ok' }"></span>
|
||||
{{ health.status === 'ok' ? '运行中' : (health.status || '加载中') }}
|
||||
@@ -377,8 +379,11 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/dashboard/admin-shell.js"></script>
|
||||
<script>
|
||||
const { createApp, ref, computed, onMounted } = Vue;
|
||||
// v0.3.0:/health 与 /metrics 已收口到鉴权接口,统一走带凭证头的 /api/admin/*
|
||||
const { http, getKey } = window.admin;
|
||||
|
||||
function parseProm(text) {
|
||||
const out = {};
|
||||
@@ -597,16 +602,16 @@
|
||||
|
||||
const fetchHealth = async () => {
|
||||
try {
|
||||
const r = await axios.get("/health");
|
||||
const r = await http.get("/admin/health");
|
||||
health.value = r.data;
|
||||
} catch (e) {
|
||||
error.value = "无法获取健康状态: " + (e.message || "未知错误");
|
||||
error.value = "无法获取健康状态: " + (e.response?.data?.error?.message || e.message || "未知错误");
|
||||
}
|
||||
};
|
||||
|
||||
const fetchMetrics = async () => {
|
||||
try {
|
||||
const r = await axios.get("/metrics");
|
||||
const r = await http.get("/admin/metrics");
|
||||
metrics.value = parseProm(r.data);
|
||||
} catch (e) {
|
||||
// 不覆盖 error,让 health 错误更显眼
|
||||
@@ -650,6 +655,8 @@
|
||||
};
|
||||
|
||||
onMounted(() => {
|
||||
// v0.3.0:本页已收口到管理鉴权,未登录先回登录页
|
||||
if (!getKey()) { location.href = '/dashboard/login'; return; }
|
||||
refresh();
|
||||
setInterval(refresh, 10000);
|
||||
});
|
||||
|
||||
+107
-25
@@ -66,78 +66,160 @@ func Setup() *mux.Router {
|
||||
// /setup 页面本身:装完后必须不可用,否则用户敲 /setup 还会看到安装表单,容易误以为要重装。
|
||||
r.HandleFunc("/setup", func(w http.ResponseWriter, req *http.Request) {
|
||||
if installer.GetMode() == installer.ModeNormal {
|
||||
http.Redirect(w, req, "/admin", http.StatusFound)
|
||||
http.Redirect(w, req, "/dashboard", http.StatusFound) // v0.3.0: 管理入口迁至 /dashboard
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||
_, _ = w.Write(setupHTML)
|
||||
}).Methods("GET")
|
||||
r.HandleFunc("/api/setup/status", controller.SetupStatusHandler).Methods("GET")
|
||||
// v0.3.0:安装状态不再匿名暴露(原本 normal 模式下仍返回 {installed, mode})
|
||||
r.Handle("/api/setup/status", middleware.RequireAdmin(http.HandlerFunc(controller.SetupStatusHandler))).Methods("GET")
|
||||
r.HandleFunc("/api/setup/prefill", controller.SetupPrefillHandler).Methods("GET")
|
||||
r.HandleFunc("/api/setup", controller.SetupSubmitHandler).Methods("POST")
|
||||
|
||||
// /admin 管理后台(M2);HTML 本身公开,鉴权由前端 JS 拦截
|
||||
// (sessionStorage 没 key 就显示登录页;有 key 调 /api/admin/overview 触发 401 跳登录)
|
||||
// API 端点(/api/admin/* /api/voices*)才需要 RequireAdmin。
|
||||
// ===== v0.3.0 阶段 3:管理面板入口从 /admin 迁至 /dashboard =====
|
||||
//
|
||||
// 拆分后 admin.html / admin-login.html / admin-voices.html / admin-settings.html
|
||||
// 各自独立,URL 路由切换;共享 admin.css + admin-shell.js 由 adminStatic 提供。
|
||||
r.HandleFunc("/admin", serveAdmin(adminHTML)).Methods("GET")
|
||||
r.HandleFunc("/admin/login", serveAdmin(adminLoginHTML)).Methods("GET")
|
||||
r.HandleFunc("/admin/voices", serveAdmin(adminVoicesHTML)).Methods("GET")
|
||||
r.HandleFunc("/admin/settings", serveAdmin(adminSettingsHTML)).Methods("GET")
|
||||
// admin 静态资源
|
||||
r.HandleFunc("/admin/admin.css", func(w http.ResponseWriter, _ *http.Request) {
|
||||
// 页面本身走 htmlAwareAdmin:浏览器请求(Accept: text/html)返回页面外壳,
|
||||
// 前端依据 sessionStorage 里的凭证显示登录视图;非 HTML 请求(脚本/抓取)强制鉴权。
|
||||
// 原因:SPA 的登录态存在 sessionStorage、不随请求发送,服务端无从判断是否已登录,
|
||||
// 一律 401 会把"打开 /dashboard 看到登录页"变成"打开 /dashboard 直接报错"。
|
||||
// 页面外壳不含任何数据,数据全部来自鉴权后的 /api/admin/* 接口。
|
||||
// /dashboard 是管理看板(admin.html,与 /dashboard/voices、/dashboard/settings 同属一套 SPA)。
|
||||
// 注意:拆分前的 /dashboard 曾是"服务状态预览页"(health.html),v0.3.0 起
|
||||
// 管理入口统一到 /dashboard,该预览页迁到 /dashboard/status 作为"详细状态"视图。
|
||||
r.Handle("/dashboard", htmlAwareAdmin(serveAdmin(adminHTML))).Methods("GET")
|
||||
r.Handle("/dashboard/voices", htmlAwareAdmin(serveAdmin(adminVoicesHTML))).Methods("GET")
|
||||
r.Handle("/dashboard/settings", htmlAwareAdmin(serveAdmin(adminSettingsHTML))).Methods("GET")
|
||||
r.Handle("/dashboard/status", htmlAwareAdmin(serveAdmin(dashboardHTML))).Methods("GET")
|
||||
// 登录页无数据,保持公开(否则无法登录)
|
||||
r.HandleFunc("/dashboard/login", serveAdmin(adminLoginHTML)).Methods("GET")
|
||||
|
||||
// 静态资源:迁到 /dashboard/ 下,同时**保留 /admin/ 旧路径为别名**,
|
||||
// 这样过渡期内新旧页面都能正确加载样式与脚本,不会出现"页面能开但丢样式"。
|
||||
serveCSS := func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/css; charset=utf-8")
|
||||
_, _ = w.Write(adminCSS)
|
||||
}).Methods("GET")
|
||||
r.HandleFunc("/admin/admin-shell.js", func(w http.ResponseWriter, _ *http.Request) {
|
||||
}
|
||||
serveShellJS := func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/javascript; charset=utf-8")
|
||||
_, _ = w.Write(adminShellJS)
|
||||
}
|
||||
r.HandleFunc("/dashboard/admin.css", serveCSS).Methods("GET")
|
||||
r.HandleFunc("/dashboard/admin-shell.js", serveShellJS).Methods("GET")
|
||||
r.HandleFunc("/admin/admin.css", serveCSS).Methods("GET")
|
||||
r.HandleFunc("/admin/admin-shell.js", serveShellJS).Methods("GET")
|
||||
|
||||
// 旧入口永久重定向(页面用 301 是正确的;API 路径**不用**重定向,见下方别名说明)
|
||||
r.HandleFunc("/admin", func(w http.ResponseWriter, req *http.Request) {
|
||||
http.Redirect(w, req, "/dashboard", http.StatusMovedPermanently)
|
||||
}).Methods("GET")
|
||||
r.HandleFunc("/admin/login", func(w http.ResponseWriter, req *http.Request) {
|
||||
http.Redirect(w, req, "/dashboard/login", http.StatusMovedPermanently)
|
||||
}).Methods("GET")
|
||||
r.HandleFunc("/admin/voices", func(w http.ResponseWriter, req *http.Request) {
|
||||
http.Redirect(w, req, "/dashboard/voices", http.StatusMovedPermanently)
|
||||
}).Methods("GET")
|
||||
r.HandleFunc("/admin/settings", func(w http.ResponseWriter, req *http.Request) {
|
||||
http.Redirect(w, req, "/dashboard/settings", http.StatusMovedPermanently)
|
||||
}).Methods("GET")
|
||||
|
||||
// /api/admin/overview (鉴权)
|
||||
r.Handle("/api/admin/overview", middleware.RequireAdmin(http.HandlerFunc(controller.AdminOverviewHandler))).Methods("GET")
|
||||
// /api/admin/metrics (鉴权);返 Prometheus 文本
|
||||
r.Handle("/api/admin/metrics", middleware.RequireAdmin(http.HandlerFunc(controller.AdminMetricsHandler))).Methods("GET")
|
||||
// v0.3.0:详细健康数据的鉴权版(面板与运维用)。
|
||||
// 与根路径 /health 的区别:这里始终注册且强制鉴权;根路径 /health 默认 404。
|
||||
r.Handle("/api/admin/health", middleware.RequireAdmin(http.HandlerFunc(controller.HealthHandler))).Methods("GET")
|
||||
|
||||
// /api/voices 音色 CRUD (鉴权)
|
||||
//
|
||||
// ⚠️ v0.3.0 阶段 3 路径迁移:/api/admin/voices 是**正式路径**,
|
||||
// /api/voices 保留为**过渡期别名**(同一个 handler,不做重定向)。
|
||||
//
|
||||
// 为什么用别名而不是 301/308:
|
||||
// - 301 会把 POST/PUT/PATCH/DELETE 降级成 GET(RFC 7231),且被浏览器永久缓存,
|
||||
// 客户端根本察觉不到路径变化,"过渡期"名存实亡
|
||||
// - 308 能保留方法,但对非浏览器脚本仍是行为变化,且多一次往返
|
||||
// - 别名让新旧路径都能直接用,零往返、零破坏,老脚本完全无感
|
||||
// 旧别名计划在后续版本移除。
|
||||
r.Handle("/api/admin/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoicesListHandler))).Methods("GET")
|
||||
r.Handle("/api/admin/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceCreateHandler))).Methods("POST")
|
||||
r.Handle("/api/admin/voices/{name}", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceDeleteHandler))).Methods("DELETE")
|
||||
r.Handle("/api/admin/voices/{name}/toggle", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceToggleHandler))).Methods("PATCH")
|
||||
|
||||
r.Handle("/api/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoicesListHandler))).Methods("GET")
|
||||
r.Handle("/api/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceCreateHandler))).Methods("POST")
|
||||
r.Handle("/api/voices/{name}", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceDeleteHandler))).Methods("DELETE")
|
||||
r.Handle("/api/voices/{name}/toggle", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceToggleHandler))).Methods("PATCH")
|
||||
|
||||
// /api/settings 全局设置 (鉴权) — M3
|
||||
// 同样:/api/admin/settings 为正式路径,/api/settings 为过渡期别名。
|
||||
// 注意更长的 /api/admin/settings/admin-key 必须**先注册**(mux 按注册顺序取首个匹配)。
|
||||
r.Handle("/api/admin/settings/admin-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAdminKeyHandler))).Methods("PUT")
|
||||
r.Handle("/api/admin/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsGetHandler))).Methods("GET")
|
||||
r.Handle("/api/admin/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsUpdateHandler))).Methods("PUT")
|
||||
r.Handle("/api/admin/settings/api-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAPIKeyHandler))).Methods("PUT")
|
||||
r.Handle("/api/admin/settings/auth-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAuthKeyHandler))).Methods("PUT")
|
||||
|
||||
r.Handle("/api/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsGetHandler))).Methods("GET")
|
||||
r.Handle("/api/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsUpdateHandler))).Methods("PUT")
|
||||
r.Handle("/api/settings/api-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAPIKeyHandler))).Methods("PUT")
|
||||
r.Handle("/api/settings/auth-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAuthKeyHandler))).Methods("PUT")
|
||||
r.Handle("/api/settings/admin-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAdminKeyHandler))).Methods("PUT")
|
||||
r.Handle("/api/settings/cors", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsCORSHandler))).Methods("PUT")
|
||||
|
||||
// 业务路由
|
||||
r.HandleFunc("/v1/audio/speech", controller.OpenaiTTSHandler).Methods("POST", "OPTIONS")
|
||||
r.HandleFunc("/health", controller.HealthHandler).Methods("GET")
|
||||
r.HandleFunc("/dashboard", func(w http.ResponseWriter, req *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||
_, _ = w.Write(dashboardHTML)
|
||||
}).Methods("GET")
|
||||
|
||||
// v0.3.0 端点收口:
|
||||
// /healthz 匿名存活探针,只回 "ok"(K8s probe / Docker HEALTHCHECK 用)
|
||||
// /health 详细健康数据,**鉴权**(原本匿名,会泄漏版本/内存/配置错误文本)
|
||||
// /dashboard 管理看板(**鉴权**,见上方阶段 3 的注册处)
|
||||
// /api/admin/health 鉴权版详细健康数据(面板拉取用,风格与 /api/admin/* 一致)
|
||||
r.HandleFunc("/healthz", controller.HealthzHandler).Methods("GET")
|
||||
r.Handle("/health", middleware.RequireAdmin(http.HandlerFunc(controller.HealthHandler))).Methods("GET")
|
||||
r.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
|
||||
// 安装模式下,根路径跳 /setup
|
||||
if installer.GetMode() == installer.ModeSetup {
|
||||
http.Redirect(w, req, "/setup", http.StatusFound)
|
||||
return
|
||||
}
|
||||
// 正常模式:跳 /admin(M2 之后优先于 /dashboard)
|
||||
http.Redirect(w, req, "/admin", http.StatusFound)
|
||||
// 正常模式:跳 /dashboard(v0.3.0 管理入口)
|
||||
http.Redirect(w, req, "/dashboard", http.StatusFound)
|
||||
}).Methods("GET")
|
||||
|
||||
// /metrics 不做鉴权(对齐 /health 策略),但仍然走 RateLimit / ConcurrencyLimit。
|
||||
// Prometheus 抓取不带 Origin,因此经过 CORS 中间件时会直接 pass-through。
|
||||
r.Handle("/metrics", metrics.Meter.Handler()).Methods("GET")
|
||||
// 根路径 /metrics 与 /health 的机器访问:
|
||||
// - 配置了 METRICS_ALLOW_CIDR → 注册 /metrics,包裹内网白名单(非白名单返回 404)
|
||||
// - 未配置 → 根路径 /metrics **完全不注册**(访问 404),避免默认对外暴露
|
||||
// /health 已在上面按鉴权注册,不再提供匿名版本。
|
||||
if middleware.MetricsAllowListConfigured() {
|
||||
r.Handle("/metrics", middleware.MetricsIPAllowList(metrics.Meter.Handler())).Methods("GET")
|
||||
}
|
||||
|
||||
return r
|
||||
}
|
||||
|
||||
// htmlAwareAdmin 给**浏览器直接访问的管理页面**套鉴权,但对 HTML 请求做内容协商:
|
||||
//
|
||||
// - Accept 含 text/html(地址栏打开、点链接)→ 照常返回页面外壳。
|
||||
// 此时不做 401:因为前端登录态存在 sessionStorage,**不会随请求发送**,
|
||||
// 服务端无从判断是否已登录;强行 401 会让"打开 /dashboard 看到登录页"
|
||||
// 这一现有体验变成"打开 /dashboard 直接报错"。
|
||||
// 页面外壳本身不含任何数据,数据全部来自鉴权后的 /api/admin/* 接口。
|
||||
// - 其它(脚本、curl、抓取工具)→ 强制 RequireAdmin,无凭证 401。
|
||||
//
|
||||
// 这样既堵住了"匿名抓取健康数据",又不破坏 SPA 的登录流程。
|
||||
func htmlAwareAdmin(html http.Handler) http.Handler {
|
||||
guarded := middleware.RequireAdmin(html)
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if acceptsHTML(r.Header.Get("Accept")) {
|
||||
html.ServeHTTP(w, r)
|
||||
return
|
||||
}
|
||||
guarded.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// acceptsHTML 在 router 包内复刻,middleware 包的版本未导出。
|
||||
// 用途:NotFoundHandler 判断浏览器 Accept。
|
||||
func acceptsHTML(accept string) bool {
|
||||
|
||||
+5
-5
@@ -202,7 +202,7 @@
|
||||
<div class="field">
|
||||
<label>OpenAI 鉴权 Key <span class="req">*</span></label>
|
||||
<input type="password" v-model="form.auth_key" placeholder="自定,例如 my-secret-key-2024" autocomplete="off">
|
||||
<div class="hint">客户端用这个 Key 调 <code>/v1/audio/speech</code>,也是登录 <code>/admin</code> 的密码。装完可在 <code>/admin → 设置</code> 改。</div>
|
||||
<div class="hint">客户端用这个 Key 调 <code>/v1/audio/speech</code>,也是登录 <code>/dashboard</code> 的密码。装完可在 <code>/dashboard → 设置</code> 改(可另配独立 <code>admin_key</code> 用于后台登录,避免与业务 Key 共用)。</div>
|
||||
</div>
|
||||
<div class="field">
|
||||
<label>火山 TTS API Key <span class="req">*</span></label>
|
||||
@@ -216,7 +216,7 @@
|
||||
<div class="card-head">
|
||||
<div>
|
||||
<div class="card-title">默认路由与格式</div>
|
||||
<div class="card-sub">未传 voice/format 时使用。装完可在 <code>/admin → 设置</code> 改。</div>
|
||||
<div class="card-sub">未传 voice/format 时使用。装完可在 <code>/dashboard → 设置</code> 改。</div>
|
||||
</div>
|
||||
<span class="step-badge">第 2 步</span>
|
||||
</div>
|
||||
@@ -261,7 +261,7 @@
|
||||
<div class="card-head">
|
||||
<div>
|
||||
<div class="card-title">音色列表 <span style="font-weight: 400; color: var(--text-dim); font-size: 12px;">(至少 1 条)</span></div>
|
||||
<div class="card-sub">填入火山 TTS 音色 ID(S_ 开头的为复刻音色)。可后续在 /admin 中增删。</div>
|
||||
<div class="card-sub">填入火山 TTS 音色 ID(S_ 开头的为复刻音色)。可后续在 /dashboard 中增删。</div>
|
||||
</div>
|
||||
<span class="step-badge">第 3 步</span>
|
||||
</div>
|
||||
@@ -322,7 +322,7 @@
|
||||
<!-- Nav -->
|
||||
<div class="actions">
|
||||
<button class="btn" @click="prev" :disabled="step===1 || submitting">← 上一步</button>
|
||||
<div class="hint-text">提交后立即进入正常模式;后续管理请访问 <code>/admin</code>。</div>
|
||||
<div class="hint-text">提交后立即进入正常模式;后续管理请访问 <code>/dashboard</code>。</div>
|
||||
<div style="display: flex; gap: 8px;">
|
||||
<button v-if="step < 4" class="btn btn-primary" @click="next">下一步 →</button>
|
||||
<button v-else class="btn btn-primary" @click="submit" :disabled="submitting">
|
||||
@@ -412,7 +412,7 @@
|
||||
},
|
||||
voices: form.value.voices,
|
||||
});
|
||||
window.location.href = r.data.redirect || '/admin';
|
||||
window.location.href = r.data.redirect || '/dashboard';
|
||||
} catch (e) {
|
||||
const msg = e.response?.data?.error?.message || e.message;
|
||||
errorMsg.value = '安装失败: ' + msg;
|
||||
|
||||
@@ -32,6 +32,14 @@ var (
|
||||
ttsTimeout time.Duration = common.DefaultTimeout
|
||||
ttsConfigErr error
|
||||
authAPIKeys []string
|
||||
// adminAPIKeys 是**管理接口专用**凭证(admin_key)。
|
||||
// 与 authAPIKeys(业务侧,/v1/audio/speech 用)分离:
|
||||
// - admin_key 为空时回退到 auth_key/env,老部署行为完全不变
|
||||
// - admin_key 配了之后,业务 key 无法访问 /api/admin/*,权限隔离成立
|
||||
// 详见 docs/IMPLEMENT_v0.3.0.md 阶段 1。
|
||||
adminAPIKeys []string
|
||||
// adminKeySource 记录管理凭证的来源,仅用于启动摘要与排障。
|
||||
adminKeySource string
|
||||
// corsAllowAll / corsOrigins 拆成两个独立字段,各自在 RLock 下读取,
|
||||
// 避免 CORSConfig 整体读时被 Lock 阻塞热路径。
|
||||
corsAllowAll bool
|
||||
@@ -108,6 +116,40 @@ func SetAuthAPIKeys(keys []string) {
|
||||
authAPIKeys = out
|
||||
}
|
||||
|
||||
// GetAdminKeys 读**管理接口专用**凭证列表;返回拷贝防止业务侧持有底层 slice。
|
||||
// 供 middleware.RequireAdmin 使用;业务侧鉴权请用 GetAuthAPIKeys。
|
||||
func GetAdminKeys() []string {
|
||||
ttsMu.RLock()
|
||||
defer ttsMu.RUnlock()
|
||||
if len(adminAPIKeys) == 0 {
|
||||
return nil
|
||||
}
|
||||
out := make([]string, len(adminAPIKeys))
|
||||
copy(out, adminAPIKeys)
|
||||
return out
|
||||
}
|
||||
|
||||
// SetAdminKeys 整体替换管理凭证;入参被复制。source 仅用于启动摘要展示。
|
||||
func SetAdminKeys(keys []string, source string) {
|
||||
ttsMu.Lock()
|
||||
defer ttsMu.Unlock()
|
||||
adminKeySource = source
|
||||
if len(keys) == 0 {
|
||||
adminAPIKeys = nil
|
||||
return
|
||||
}
|
||||
out := make([]string, len(keys))
|
||||
copy(out, keys)
|
||||
adminAPIKeys = out
|
||||
}
|
||||
|
||||
// GetAdminKeySource 返回管理凭证来源:admin_key / auth_key / env / ""(未配置)。
|
||||
func GetAdminKeySource() string {
|
||||
ttsMu.RLock()
|
||||
defer ttsMu.RUnlock()
|
||||
return adminKeySource
|
||||
}
|
||||
|
||||
// GetCORSAllowAll 读 CORS 是否放行所有来源。
|
||||
func GetCORSAllowAll() bool {
|
||||
ttsMu.RLock()
|
||||
@@ -391,6 +433,18 @@ func LoadRuntimeConfig(s Store) error {
|
||||
SetAuthAPIKeys(nil)
|
||||
}
|
||||
|
||||
// 管理凭证:admin_key(DB) > auth_key(DB) > OPENAI_TTS_API_KEY(env)
|
||||
// 分离的目的:业务调用方拿到的 key 不应同时拥有管理后台权限。
|
||||
// 不配 admin_key 时行为与旧版完全一致(回退用 auth_key),保证向后兼容。
|
||||
switch {
|
||||
case all["admin_key"] != "":
|
||||
SetAdminKeys([]string{all["admin_key"]}, "admin_key")
|
||||
case authKey != "":
|
||||
SetAdminKeys([]string{authKey}, "auth_key")
|
||||
default:
|
||||
SetAdminKeys(nil, "")
|
||||
}
|
||||
|
||||
// CORS 配置:DB > env
|
||||
// cors_allow_all (bool): 允许所有来源(*)
|
||||
// cors_origins (string): 逗号分隔白名单
|
||||
@@ -540,6 +594,16 @@ func LogStartupSummary() {
|
||||
log.Printf("OPENAI_TTS_API_KEY: 已设置 %d 个有效密钥", len(authKeys))
|
||||
}
|
||||
|
||||
// v0.3.0:管理凭证独立于业务凭证(admin_key > auth_key > env)
|
||||
switch GetAdminKeySource() {
|
||||
case "admin_key":
|
||||
log.Printf("管理凭证: 使用独立 admin_key(业务 key 无法访问管理接口)")
|
||||
case "auth_key":
|
||||
log.Printf("管理凭证: 未单独配置 admin_key,回退使用 auth_key(业务 key 同时拥有管理权限)")
|
||||
default:
|
||||
log.Printf("管理凭证: ✗ 未配置(normal 模式下服务将拒绝启动)")
|
||||
}
|
||||
|
||||
allowAll := GetCORSAllowAll()
|
||||
origins := GetCORSOrigins()
|
||||
if allowAll {
|
||||
|
||||
Reference in New Issue
Block a user