tsbot.env.example

# TSBot 启动配置
#
# 这里只保留服务启动前必须知道的参数。TeamSpeak、音乐源、缓存、日志、
# 外部 API Token 和界面名称等运行配置，请在 Web 的“系统配置”中修改。
# 升级旧版本时，已有 TSBOT_TS3_* 等环境变量会在数据库没有对应值时导入一次。

# =========================
# 后端与数据库
# =========================

export TSBOT_HOST="127.0.0.1"
export TSBOT_PORT="8009"
export DATABASE_URL="sqlite:///./tsbot.db"

# 加密数据库中的 Cookie、Token、TeamSpeak 密码等敏感配置。
# 已有部署必须继续使用原值，否则旧密文无法解密。
# 新部署可用 `openssl rand -hex 32` 生成。
export TSBOT_COOKIE_KEY="replace_with_a_long_random_key"

# 后端连接 voice-service 的地址。Docker Compose 已在 compose 文件中覆盖此项。
export TSBOT_VOICE_GRPC_ADDR="127.0.0.1:50051"

# 后端写入、voice-service 监听的共享配置文件。
# 两个进程必须能访问同一路径；仓库脚本与 Docker 默认共享 logs 目录。
export TSBOT_VOICE_CONFIG_FILE="./logs/voice-service.json"

# =========================
# 管理员首次登录
# =========================

# 首次启动会自动生成 admin 的随机初始密码，打印到后端日志，并写入下面文件。
# 首次登录后必须更换密码，随后该文件会被删除。
export TSBOT_INITIAL_PASSWORD_FILE="./logs/initial-admin-password.txt"

# 自动化部署可显式提供一次性初始密码；仅在管理员尚未初始化时读取。
# export TSBOT_INITIAL_ADMIN_PASSWORD="replace_with_a_temporary_password"

# =========================
# Web 服务
# =========================

export TSBOT_WEB_HOST="127.0.0.1"
export TSBOT_WEB_PORT="8080"

# 默认按 TSBOT_HOST / TSBOT_PORT 推导，前后端分开部署时再设置。
# export TSBOT_WEB_API_PROXY_TARGET="http://127.0.0.1:8009"

# 通过远程域名访问 Vite 服务时填写，多个域名用逗号分隔。
# export TSBOT_WEB_ALLOWED_HOSTS="music.example.com,.example.com"

# 开发服务器配置。
export VITE_DEV_HOST="127.0.0.1"
export VITE_DEV_PORT="5173"
export VITE_API_BASE="/api"

# =========================
# 预构建镜像（可选）
# =========================

# export TSBOT_IMAGE_REGISTRY="docker.io"
# export TSBOT_IMAGE_NAMESPACE="yumi118"
# export TSBOT_IMAGE_REPO="neteasetsbot"
# export TSBOT_IMAGE_TAG="latest"

# =========================
# 旧版配置迁移说明
# =========================

# 升级时可以暂时保留旧 tsbot.env。后端仅在数据库中没有对应配置项时导入：
# TSBOT_NETEASE_API_BASE、TSBOT_LOG_LEVEL、TSBOT_LOG_FILE、TSBOT_API_TOKEN(S)、
# TSBOT_BILIBILI_*、TSBOT_TS3_* 和 TSBOT_VOICE_STATE_FILE。
# 在 Web 确认配置正确后即可从环境文件移除这些运行配置。
#
# 原 TSBOT_ADMIN_TOKEN 会在尚未初始化管理员账号时作为一次性初始密码导入，
# 登录后仍会强制改密。它不再作为管理接口长期凭据使用。
#
# 忘记密码时，在服务器本地执行：
# .venv/bin/python -m backend.admin_cli reset-password