docs(config): 配置文件添加完整中文注释

Made-with: Cursor
This commit is contained in:
bujinyuan
2026-02-28 15:23:52 +08:00
parent 323232d875
commit 028cca8695

View File

@@ -1,37 +1,47 @@
# ============================================================
# EchoChat 开发环境配置
# 环境变量覆盖规则ECHOCHAT_{节}_{字段} 如 ECHOCHAT_SERVER_PORT=9090
# ============================================================
# HTTP 服务配置
server: server:
port: 8085 port: 8085 # 服务监听端口
mode: debug mode: debug # 运行模式debug开发/ release生产
# PostgreSQL 数据库配置
database: database:
host: localhost host: localhost # 数据库地址
port: 5432 port: 5432 # 数据库端口
user: echochat user: echochat # 数据库用户名
password: echochat_dev_2026 password: echochat_dev_2026 # 数据库密码
dbname: echochat dbname: echochat # 数据库名称
sslmode: disable sslmode: disable # SSL 模式disable开发/ require生产
max_idle_conns: 10 max_idle_conns: 10 # 连接池最大空闲连接数
max_open_conns: 100 max_open_conns: 100 # 连接池最大打开连接数
# Redis 配置
redis: redis:
host: localhost host: localhost # Redis 地址
port: 6379 port: 6379 # Redis 端口
password: "" password: "" # Redis 密码,开发环境为空
db: 0 db: 0 # Redis 数据库编号0-15
# JWT 认证配置
jwt: jwt:
secret: echochat-dev-jwt-secret-2026-please-change-in-production secret: echochat-dev-jwt-secret-2026-please-change-in-production # JWT 签名密钥,生产环境必须更换
access_expire_min: 120 access_expire_min: 120 # Access Token 有效期(分钟),即 2 小时
refresh_expire_day: 7 refresh_expire_day: 7 # Refresh Token 有效期(天),即 7 天
issuer: echochat issuer: echochat # JWT 签发者标识
# 日志配置
log: log:
level: debug level: debug # 最低输出级别debug / info / warn / error
format: text format: text # 控制台输出格式text彩色可读/ json结构化
output_path: stdout output_path: stdout # 控制台输出目标(保留字段,始终输出到 stdout
file: file:
enable: true enable: true # 是否启用日志文件输出true 时同时写入控制台和文件)
dir: logs dir: logs # 日志文件存放目录(相对于 go-service 工作目录)
max_size: 50 max_size: 50 # 单个日志文件最大大小MB超过后自动切割产生新文件
max_backups: 10 max_backups: 10 # 保留的旧日志归档文件最大数量,超出的自动删除
max_age: 30 max_age: 30 # 旧日志归档文件保留天数,超过天数的自动删除
compress: false compress: false # 是否对归档的旧日志文件进行 gzip 压缩(生产环境建议 true