sun
a4ea53bfa0
修 M2/M3 遗漏:OPENAI_TTS_API_KEY (admin + 合成鉴权) 此前只能从 env 读,setup 前端没收集。装完用户还要回去设 env,体验断,违反 'setup 是单一配置源' 承诺。 改动: - setting/config.go: LoadRuntimeConfig 顺便把 auth_key 灌到 setting.Auth.APIKeys。优先级 DB > env(env 仅作 fallback,首次启 动无 DB 时仍可用,向后兼容)。 - controller/setup.go: validateSetupSettings 加 auth_key 为必填, 写 DB 后立即 setting.Auth.APIKeys = [auth_key](本进程内立刻生效)。 - controller/settings.go: GET /api/settings 返 auth_key (打码) + auth_key_set;新增 SettingsAuthKeyHandler (PUT /api/settings/auth-key), 改完单独刷新 setting.Auth.APIKeys(避免被自踢,只下次请求生效)。 - router/router.go: 挂 /api/settings/auth-key 路由。 - router/setup.html: 加 OpenAI 鉴权 Key 字段(密码框,带提示); 表单 default + submit 都加 auth_key。 - router/admin.html: 设置 tab 拆两张卡 — 鉴权 Key(独立保存按钮, 改完会自踢当前会话)+ 火山 TTS 凭证;vue setup 加 authKeyInput + saveAuthKey 函数。 - main.go: 把 LoadRuntimeConfig(st) 提到 LogStartupSummary 之前, 让启动日志反映真实运行时状态(DB 已加载的 key 数量)而不是 过时的 env 状态。 未 push(等用户当前 M3 测完一起或单独)
404 lines
12 KiB
Go
404 lines
12 KiB
Go
package setting
|
|
|
|
import (
|
|
"crypto/rand"
|
|
"encoding/hex"
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/volcano-tts/tts-api/adapter/volcano"
|
|
"github.com/volcano-tts/tts-api/common"
|
|
"github.com/volcano-tts/tts-api/telemetry"
|
|
)
|
|
|
|
// 全部环境变量读取的单一入口:其它包不允许直接 os.Getenv,只读这里的全局 Config。
|
|
|
|
// TTSOptions 是火山 v3 TTS 调用的完整参数集合,启动期由 LoadRuntimeConfig 从 store 填充。
|
|
// 业务侧(controller)直接读取并传入 volcano.Synthesis。
|
|
var (
|
|
TTSOptions volcano.Options
|
|
TTSConfigErr error
|
|
// TTSTimeout 单次合成请求的超时;controller 用来派生 context。
|
|
TTSTimeout time.Duration = common.DefaultTimeout
|
|
)
|
|
|
|
// AuthConfig OpenAI 兼容接口的客户端 API Key 鉴权配置。
|
|
type AuthConfig struct {
|
|
APIKeys []string
|
|
}
|
|
|
|
var Auth AuthConfig
|
|
|
|
// CORSConfig 跨域白名单配置。
|
|
type CORSConfig struct {
|
|
Origins []string
|
|
AllowAll bool
|
|
}
|
|
|
|
var CORS CORSConfig
|
|
|
|
// ServerConfig HTTP 服务监听配置。
|
|
type ServerConfig struct {
|
|
Port string
|
|
}
|
|
|
|
var Server ServerConfig
|
|
|
|
// TrustedProxyHops 由 middleware.InitRateLimiter 在启动期写入,
|
|
// 表示当前 XFF 解析模式:0=启发式,N>0=精确 N 跳。
|
|
// setting.LogStartupSummary 读这个字段以展示运行期配置,
|
|
// 不直接调用 middleware(避免循环 import)。
|
|
var TrustedProxyHops int
|
|
|
|
// SetupToken 是安装模式下的初始化凭证。
|
|
// - 若 TTS_ADMIN_KEY 环境变量非空,用其值(用户可复现,便于脚本化安装)
|
|
// - 若 TTS_ADMIN_KEY 为空,启动时随机生成 32 字节十六进制,
|
|
// 打印到日志(/api/setup 提交时必须带这个 token)
|
|
//
|
|
// 安装完成后,/api/setup 端点永久关闭,SetupToken 失去意义但保留在内存。
|
|
var SetupToken string
|
|
|
|
// SetupTokenSource 标记 SetupToken 的来源,便于日志区分。
|
|
// "env" = 来自 TTS_ADMIN_KEY
|
|
// "ephemeral"= 启动时随机生成(每次启动变)
|
|
// "" = 未设置
|
|
var SetupTokenSource string
|
|
|
|
// InitAllConfigs 集中初始化所有配置,启动期调用一次。
|
|
func InitAllConfigs() {
|
|
InitServerConfig()
|
|
InitAuthConfig()
|
|
InitCORSConfig()
|
|
InitSetupToken()
|
|
// InitTTSConfig 不再这里调 — 改为启动期从 store 加载(LoadRuntimeConfig)。
|
|
}
|
|
|
|
func InitServerConfig() {
|
|
Server.Port = os.Getenv("PORT")
|
|
if Server.Port == "" {
|
|
Server.Port = common.DefaultPort
|
|
}
|
|
}
|
|
|
|
func InitAuthConfig() {
|
|
raw := os.Getenv("OPENAI_TTS_API_KEY")
|
|
if raw == "" {
|
|
Auth.APIKeys = nil
|
|
return
|
|
}
|
|
parts := strings.Split(raw, ",")
|
|
keys := make([]string, 0, len(parts))
|
|
for _, p := range parts {
|
|
k := strings.TrimSpace(p)
|
|
if k != "" {
|
|
keys = append(keys, k)
|
|
}
|
|
}
|
|
Auth.APIKeys = keys
|
|
}
|
|
|
|
func InitCORSConfig() {
|
|
raw := os.Getenv("ALLOWED_ORIGINS")
|
|
CORS.Origins = nil
|
|
CORS.AllowAll = false
|
|
if raw == "" {
|
|
return
|
|
}
|
|
for _, p := range strings.Split(raw, ",") {
|
|
o := strings.TrimSpace(p)
|
|
if o == "" {
|
|
continue
|
|
}
|
|
if o == "*" {
|
|
CORS.AllowAll = true
|
|
continue
|
|
}
|
|
CORS.Origins = append(CORS.Origins, normalizeOrigin(o))
|
|
}
|
|
}
|
|
|
|
func normalizeOrigin(origin string) string {
|
|
origin = strings.TrimSpace(origin)
|
|
origin = strings.TrimRight(origin, "/")
|
|
return strings.ToLower(origin)
|
|
}
|
|
|
|
// LoadRuntimeConfig 从 store 加载 TTS 全局配置到 TTSOptions / TTSTimeout / Auth.APIKeys 内存。
|
|
// 启动期(master 模式)调一次,或 PUT /api/settings 后调一次(改完立即生效)。
|
|
//
|
|
// 与原 InitTTSConfig 的区别:
|
|
// - 不再读 BYTEDANCE_TTS_* env;全部从 store.Settings 读
|
|
// - 必填项(api_key / default_resource_id / default_speaker)缺失时返 error
|
|
// - 失败时 TTSConfigErr 被设置,/v1/audio/speech 路由会返 503
|
|
// - 成功时清空 TTSConfigErr
|
|
//
|
|
// 字段映射(原 env → store key):
|
|
// BYTEDANCE_TTS_API_KEY → api_key
|
|
// BYTEDANCE_TTS_RESOURCE_ID → default_resource_id
|
|
// BYTEDANCE_TTS_SPEAKER → default_speaker
|
|
// BYTEDANCE_TTS_MODEL → model
|
|
// BYTEDANCE_TTS_FORMAT → default_format (默认 mp3)
|
|
// BYTEDANCE_TTS_SAMPLE_RATE → sample_rate (默认 24000)
|
|
// BYTEDANCE_TTS_BIT_RATE → bit_rate (默认 0)
|
|
// BYTEDANCE_TTS_MODEL_TYPE → model_type (默认 0)
|
|
// BYTEDANCE_TTS_EXPLICIT_LANGUAGE → explicit_language
|
|
// BYTEDANCE_TTS_ENABLE_SUBTITLE → enable_subtitle (默认 false)
|
|
// BYTEDANCE_TTS_TIMEOUT → TTSTimeout (默认 30s)
|
|
//
|
|
// 鉴权 key(auth_key)优先级:DB > env OPENAI_TTS_API_KEY
|
|
// - 首次启动(无 DB 数据):用 env,保证向后兼容
|
|
// - 已 install:用 DB,env 不再读
|
|
// - DB 没 auth_key 但 env 有(env fallback):仍用 env
|
|
func LoadRuntimeConfig(s Store) error {
|
|
all, err := s.SettingsGetAll()
|
|
if err != nil {
|
|
TTSConfigErr = fmt.Errorf("read settings failed: %w", err)
|
|
return TTSConfigErr
|
|
}
|
|
|
|
apiKey := all["api_key"]
|
|
resourceId := all["default_resource_id"]
|
|
speaker := all["default_speaker"]
|
|
missing := []string{}
|
|
if apiKey == "" {
|
|
missing = append(missing, "api_key")
|
|
}
|
|
if resourceId == "" {
|
|
missing = append(missing, "default_resource_id")
|
|
}
|
|
if speaker == "" {
|
|
missing = append(missing, "default_speaker")
|
|
}
|
|
if len(missing) > 0 {
|
|
TTSConfigErr = fmt.Errorf("missing required settings: %v", missing)
|
|
return TTSConfigErr
|
|
}
|
|
|
|
model := all["model"]
|
|
format := all["default_format"]
|
|
if format == "" {
|
|
format = "mp3"
|
|
}
|
|
sampleRate, _ := s.SettingsGetInt("sample_rate", 24000)
|
|
bitRate, _ := s.SettingsGetInt("bit_rate", 0)
|
|
modelType, _ := s.SettingsGetInt("model_type", 0)
|
|
explicitLanguage := all["explicit_language"]
|
|
enableSubtitle, _ := s.SettingsGetBool("enable_subtitle", false)
|
|
|
|
var adds *volcano.Additions
|
|
if modelType != 0 || explicitLanguage != "" {
|
|
adds = &volcano.Additions{}
|
|
if modelType != 0 {
|
|
v := modelType
|
|
adds.ModelType = &v
|
|
}
|
|
if explicitLanguage != "" {
|
|
adds.ExplicitLanguage = explicitLanguage
|
|
}
|
|
}
|
|
|
|
TTSTimeout = common.DefaultTimeout
|
|
if v, err := s.SettingsGetDuration("timeout", common.DefaultTimeout); err == nil {
|
|
TTSTimeout = v
|
|
} else {
|
|
TTSTimeout = common.DefaultTimeout
|
|
}
|
|
|
|
TTSOptions = volcano.Options{
|
|
APIKey: apiKey,
|
|
ResourceID: resourceId,
|
|
UID: "uid",
|
|
Speaker: speaker,
|
|
Model: model,
|
|
Format: format,
|
|
SampleRate: sampleRate,
|
|
BitRate: bitRate,
|
|
SpeechRate: 0,
|
|
LoudnessRate: 0,
|
|
EnableSubtitle: enableSubtitle,
|
|
Additions: adds,
|
|
}
|
|
|
|
// 鉴权 key:DB > env(向后兼容)
|
|
authKey := all["auth_key"]
|
|
if authKey == "" {
|
|
authKey = os.Getenv("OPENAI_TTS_API_KEY")
|
|
}
|
|
// 用临时 slice 避免和 InitAuthConfig 抢同一个 Auth.APIKeys 底层
|
|
if authKey != "" {
|
|
Auth.APIKeys = []string{authKey}
|
|
} else {
|
|
Auth.APIKeys = nil
|
|
}
|
|
|
|
TTSConfigErr = nil
|
|
return nil
|
|
}
|
|
|
|
// Store 是 LoadRuntimeConfig 需要的最小接口(避免 setting 包 import store 产生 cycle)。
|
|
type Store interface {
|
|
SettingsGetAll() (map[string]string, error)
|
|
SettingsGetInt(key string, def int) (int, error)
|
|
SettingsGetBool(key string, def bool) (bool, error)
|
|
SettingsGetDuration(key string, def time.Duration) (time.Duration, error)
|
|
}
|
|
|
|
func getEnvDefault(name, def string) string {
|
|
if v := os.Getenv(name); v != "" {
|
|
return v
|
|
}
|
|
return def
|
|
}
|
|
|
|
func getEnvInt(name string, def int) int {
|
|
v := os.Getenv(name)
|
|
if v == "" {
|
|
return def
|
|
}
|
|
n, err := strconv.Atoi(v)
|
|
if err != nil {
|
|
log.Printf("环境变量 %s=%q 不是合法整数,使用默认 %d", name, v, def)
|
|
return def
|
|
}
|
|
return n
|
|
}
|
|
|
|
func getEnvBool(name string, def bool) bool {
|
|
v := os.Getenv(name)
|
|
if v == "" {
|
|
return def
|
|
}
|
|
b, err := strconv.ParseBool(v)
|
|
if err != nil {
|
|
log.Printf("环境变量 %s=%q 不是合法 bool,使用默认 %v", name, v, def)
|
|
return def
|
|
}
|
|
return b
|
|
}
|
|
|
|
// InitSetupToken 加载或生成安装模式下的初始化凭证。
|
|
// - TTS_ADMIN_KEY 存在:用其值,SetupTokenSource="env"
|
|
// - TTS_ADMIN_KEY 空:随机生成 16 字节 = 32 字符 hex,SetupTokenSource="ephemeral",打印到日志
|
|
func InitSetupToken() {
|
|
v := os.Getenv("TTS_ADMIN_KEY")
|
|
if v != "" {
|
|
SetupToken = v
|
|
SetupTokenSource = "env"
|
|
return
|
|
}
|
|
// 临时 token:16 字节随机 = 32 字符 hex,够用且短
|
|
b := make([]byte, 16)
|
|
if _, err := rand.Read(b); err != nil {
|
|
// 极端情况:随机源失败,降级为时间戳(不应发生)
|
|
log.Printf("[setup] 生成一次性 token 失败,使用时间戳: %v", err)
|
|
SetupToken = fmt.Sprintf("dev-%d", time.Now().UnixNano())
|
|
SetupTokenSource = "ephemeral"
|
|
return
|
|
}
|
|
SetupToken = hex.EncodeToString(b)
|
|
SetupTokenSource = "ephemeral"
|
|
log.Printf("[setup] 一次性安装 token(仅打印一次,公网部署请设置 TTS_ADMIN_KEY): %s", SetupToken)
|
|
}
|
|
|
|
// CheckEnvironmentVariables 返回 /health 用的环境变量状态快照。
|
|
func CheckEnvironmentVariables() map[string]interface{} {
|
|
required := map[string]bool{
|
|
"BYTEDANCE_TTS_API_KEY": TTSOptions.APIKey != "",
|
|
"BYTEDANCE_TTS_RESOURCE_ID": TTSOptions.ResourceID != "",
|
|
"BYTEDANCE_TTS_SPEAKER": TTSOptions.Speaker != "",
|
|
}
|
|
missing := []string{}
|
|
for k, ok := range required {
|
|
if !ok {
|
|
missing = append(missing, k)
|
|
}
|
|
}
|
|
optional := map[string]bool{
|
|
"BYTEDANCE_TTS_MODEL": TTSOptions.Model != "",
|
|
"BYTEDANCE_TTS_FORMAT": TTSOptions.Format != "mp3",
|
|
"BYTEDANCE_TTS_SAMPLE_RATE": TTSOptions.SampleRate != 24000,
|
|
"BYTEDANCE_TTS_EXPLICIT_LANGUAGE": TTSOptions.Additions != nil && TTSOptions.Additions.ExplicitLanguage != "",
|
|
"OPENAI_TTS_API_KEY": len(Auth.APIKeys) > 0,
|
|
"ALLOWED_ORIGINS": CORS.AllowAll || len(CORS.Origins) > 0,
|
|
"PORT": Server.Port != common.DefaultPort,
|
|
}
|
|
return map[string]interface{}{
|
|
"all_required_vars_set": len(missing) == 0,
|
|
"missing_required_vars": missing,
|
|
"required_vars_set": required,
|
|
"optional_vars_set": optional,
|
|
}
|
|
}
|
|
|
|
// LogStartupSummary 启动期一次性打印所有 Config 状态。
|
|
func LogStartupSummary() {
|
|
log.Printf("=== 环境配置汇总 ===")
|
|
log.Printf("服务端口: %s", Server.Port)
|
|
|
|
if len(Auth.APIKeys) == 0 {
|
|
log.Printf("OPENAI_TTS_API_KEY: 未设置(所有请求无需鉴权)")
|
|
} else {
|
|
log.Printf("OPENAI_TTS_API_KEY: 已设置 %d 个有效密钥", len(Auth.APIKeys))
|
|
}
|
|
|
|
if CORS.AllowAll {
|
|
log.Printf("ALLOWED_ORIGINS: *(允许所有跨域;不可与鉴权共用)")
|
|
} else if len(CORS.Origins) == 0 {
|
|
log.Printf("ALLOWED_ORIGINS: 未设置(跨域请求将被拒绝)")
|
|
} else {
|
|
log.Printf("ALLOWED_ORIGINS: 已配置 %d 个允许的跨域来源白名单", len(CORS.Origins))
|
|
}
|
|
|
|
if h := TrustedProxyHops; h == 0 {
|
|
log.Printf("TRUSTED_PROXY_HOPS: 启发式模式(默认,XFF 链尾第一个公网 IP)")
|
|
} else {
|
|
log.Printf("TRUSTED_PROXY_HOPS: 精确模式,信任 %d 跳反代", h)
|
|
}
|
|
|
|
log.Printf("火山 TTS 必填项状态:")
|
|
type ttsCheck struct {
|
|
name string
|
|
value string
|
|
ok bool
|
|
}
|
|
checks := []ttsCheck{
|
|
{"BYTEDANCE_TTS_API_KEY", maskAPIKey(TTSOptions.APIKey), TTSOptions.APIKey != ""},
|
|
{"BYTEDANCE_TTS_RESOURCE_ID", TTSOptions.ResourceID, TTSOptions.ResourceID != ""},
|
|
// speaker 是火山复刻音色 ID(用户付费资产),日志里打码,避免明文落盘
|
|
{"BYTEDANCE_TTS_SPEAKER", telemetry.MaskSpeaker(TTSOptions.Speaker), TTSOptions.Speaker != ""},
|
|
}
|
|
missingCount := 0
|
|
for _, c := range checks {
|
|
mark := "✓"
|
|
if !c.ok {
|
|
mark = "✗"
|
|
missingCount++
|
|
}
|
|
val := c.value
|
|
if val == "" {
|
|
val = "(未设置)"
|
|
}
|
|
log.Printf(" %s %s: %s", mark, c.name, val)
|
|
}
|
|
|
|
if TTSConfigErr != nil {
|
|
log.Printf("火山 TTS 整体: 初始化失败(%d 个必填项缺失),/v1/audio/speech 路由将全部返回 500", missingCount)
|
|
} else {
|
|
log.Printf("火山 TTS 整体: 初始化成功")
|
|
}
|
|
}
|
|
|
|
func maskAPIKey(key string) string {
|
|
if key == "" {
|
|
return ""
|
|
}
|
|
if len(key) <= 8 {
|
|
return "****"
|
|
}
|
|
return key[:4] + "****" + key[len(key)-4:]
|
|
}
|