feat: add detailed configuration options for TTS service in README

This commit is contained in:
王锦强
2025-03-10 23:29:48 +08:00
parent d7d8d4e4bc
commit f484171c85

View File

@@ -66,6 +66,51 @@ docker run -d -p 9000:9000 -e PORT=9000 --name=tts zuoban/zb-tts
docker run -d -p 8080:8080 -v /path/to/config.yaml:/app/config.yaml --name=tts zuoban/zb-tts
```
### 配置文件详解
TTS 服务使用 YAML 格式的配置文件,默认位置为 `/app/config.yaml`。以下是配置文件的主要选项:
```yaml
server:
port: 8080 # 服务监听端口
read_timeout: 30 # HTTP 读取超时时间(秒)
write_timeout: 30 # HTTP 写入超时时间(秒)
base_path: "" # API 基础路径前缀,如 "/api"
tts:
region: "eastasia" # Azure 语音服务区域
default_voice: "zh-CN-XiaoxiaoNeural" # 默认语音
default_rate: "0" # 默认语速,范围 -100 到 100
default_pitch: "0" # 默认语调,范围 -100 到 100
default_format: "audio-24khz-48kbitrate-mono-mp3" # 默认音频格式
max_text_length: 65535 # 最大文本长度
request_timeout: 30 # 请求 Azure 服务的超时时间(秒)
max_concurrent: 10 # 最大并发请求数
segment_threshold: 300 # 文本分段阈值
min_sentence_length: 200 # 最小句子长度
max_sentence_length: 300 # 最大句子长度
api_key: '替换为您的密钥' # (可选, /tts 接口使用)
# OpenAI 到微软 TTS 中文语音的映射
voice_mapping:
alloy: "zh-CN-XiaoyiNeural" # 中性女声
echo: "zh-CN-YunxiNeural" # 年轻男声
fable: "zh-CN-XiaochenNeural" # 儿童声
onyx: "zh-CN-YunjianNeural" # 成熟男声
nova: "zh-CN-XiaohanNeural" # 活力女声
shimmer: "zh-CN-XiaomoNeural" # 温柔女声
openai:
api_key: '替换为您的密钥' # OpenAI API 密钥可选api 兼容接口使用)
```
您可以根据自己的需求修改这些配置选项。 其中,`api_key` 为接口认证密钥,若不设置,则不需要认证。
以上配置均可通过环境变量进行覆盖,如 `SERVER_PORT``OPENAI_API_KEY` 等。
使用环境变量时,变量名需转换为大写并使用下划线代替点号。
## 本地构建与运行
要从源码构建和运行: