config.example.yaml

# 配置标记：
# - [必须修改] 首次启动前必须替换，否则服务会拒绝启动或存在安全风险。
# - [按需修改] 仅在部署方式发生变化时调整。
# - [通常不要修改] 已采用推荐默认值。

server:
  # [通常不要修改] Docker 镜像会通过启动参数覆盖为 0.0.0.0:8000。
  listen: "127.0.0.1:8000"
  # [通常不要修改] 单次请求体上限 32 MiB。
  maxBodyBytes: 33554432
  # [通常不要修改] 仅限制客户端上传完整请求体的时间，不限制推理或流式响应。
  readTimeout: 15m
  # [通常不要修改] 管理 API 和非流式请求的最长生命周期。
  requestTimeout: 2h
  # [按需修改] 仅在本地或受信任环境开启，生产环境保持 false。
  swaggerEnabled: false

secrets:
  # [必须修改] 至少 32 个字符。快速生成：openssl rand -hex 32
  jwtSecret: "replace-with-at-least-32-characters"
  # [必须修改] Base64 编码的 32 字节密钥。快速生成：openssl rand -base64 32
  # 首次写入账号后必须长期保留，后续更换会导致已有凭据无法解密。
  credentialEncryptionKey: "replace-with-base64-key"

bootstrapAdmin:
  # [按需修改] 仅在数据库中没有管理员时使用。
  username: "admin"
  # [必须修改] 首次启动前替换为强密码；管理员创建成功后建议删除本段。
  password: "replace-with-a-strong-password"

frontend:
  # [按需修改] 管理端公共 API 地址留空时使用此值；本项也留空则回退到 http://127.0.0.1:8000。
  # 生产环境建议填写外部 HTTPS 地址，例如 https://api.example.com。
  publicApiBaseURL: "http://127.0.0.1:8000"
  # [通常不要修改] Go 服务同源托管的前端构建目录。
  staticPath: "./frontend/dist"

database:
  # [按需修改] 单实例使用 sqlite；多实例改为 postgres。
  driver: sqlite # sqlite | postgres
  sqlite:
    # [通常不要修改] 相对路径以本配置文件所在目录为基准。
    path: "./data/backend.db"
  postgres:
    # [必须修改：仅 driver=postgres] 填写真实 DSN，并按需启用 sslmode。
    dsn: "postgres://user:password@127.0.0.1:5432/grok2api?sslmode=disable"
    # [按需修改] 根据数据库连接容量调整。
    maxOpenConns: 50
    maxIdleConns: 10

runtimeStore:
  # [按需修改] 单实例使用 memory；多实例改为 redis。
  driver: memory # memory | redis
  redis:
    # [必须修改：仅 driver=redis] 填写 Redis 连接信息。
    address: "127.0.0.1:6379"
    username: ""
    password: ""
    database: 0
    # [通常不要修改] 同一 Redis 中部署多个实例组时才需要更换。
    keyPrefix: "grok2api:"
    # [按需修改] Redis 使用 TLS 时设为 true。
    tls: false

auth:
  # [通常不要修改] 管理端访问与刷新令牌有效期。
  accessTokenTTL: 15m
  refreshTokenTTL: 720h
  # [按需修改] 外部地址使用 HTTPS 时必须设为 true。
  secureCookies: false

provider:
  console:
    # [通常不要修改] Grok Console Responses API 地址。
    baseURL: "https://console.x.ai"
    # [通常不要修改] 必须与 Console 出口节点的浏览器指纹保持一致。
    userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/146.0.0.0 Safari/537.36"
    # [按需修改] Console 单次对话超时。
    chatTimeout: 5m

media:
  # [通常不要修改] 当前仅支持 local；容量和清理策略在管理端设置。
  driver: local
  local:
    # [按需修改] 图片二进制目录；数据库只保存资源元数据。
    path: "./data/media"