环境变量参考

本页对应仓库根目录 .env.example。建议生产环境按需覆盖,不要把真实密钥提交到代码仓库。

字段约定:

  • 必填: 表示生产必须配置; 表示可使用默认值或留空
  • 敏感: 表示包含密钥/口令,禁止泄露

Core

变量 默认值 必填 敏感 说明
PYTHONUNBUFFERED 1 Python 日志实时输出。
WEB_PORT 8080 对外 Web 端口。

MySQL(容器)

变量 默认值 必填 敏感 说明
MYSQL_ROOT_PASSWORD change_me_root MySQL root 密码。
MYSQL_DATABASE worktool_bridge 初始化数据库名。
MYSQL_USER worktool 业务账号用户名。
MYSQL_PASSWORD change_me_app 业务账号密码。

App MySQL(后端连接)

变量 默认值 必填 敏感 说明
APP_MYSQL_HOST mysql 后端连接 MySQL 的地址。
APP_MYSQL_PORT 3306 后端连接 MySQL 端口。
APP_MYSQL_USER worktool 后端数据库账号。
APP_MYSQL_PASSWORD change_me_app 后端数据库密码。
APP_MYSQL_DATABASE worktool_bridge 后端数据库名。
APP_MYSQL_TIME_ZONE +08:00 MySQL 会话时区。

认证与平台功能

变量 默认值 必填 敏感 说明
AUTH_JWT_SECRET change_me_to_random_32_plus_chars JWT 签名密钥,需高强度随机。
AUTH_JWT_EXPIRE_DAYS 30 登录态有效天数。
AUTH_PBKDF2_ITERATIONS 390000 密码哈希迭代次数。
AUTH_SMS_ENABLED false 是否启用短信注册/找回。
ENABLE_RUNTIME_WORKTOOL_SETTINGS false 是否开放运行时修改 WorkTool 基础配置。
WORKTOOL_API_BASE https://api.worktool.ymdyes.cn WorkTool API 基础地址。
CALLBACK_PUBLIC_BASE_URL 平台公开回调域名前缀。
ADMIN_PHONE_WHITELIST 视情况 管理员手机号白名单,逗号分隔。
DEMO_ROBOT_IDS 演示机器人 ID 列表(逗号分隔)。
ENABLE_ADMIN_IP_BLACKLIST false 是否显示“黑名单管理”模块。
ENABLE_ADMIN_ENTERPRISE_AUTH false 是否显示“企业定制开通”模块。
ENABLE_OPEN_TROUBLESHOOT_API false 是否开启开放排查 API。
OPEN_TROUBLESHOOT_API_KEY 开启时是 开放排查 API 的访问密钥。
OPEN_TROUBLESHOOT_ALLOWED_ROBOT_IDS 开放排查 API 允许查询的机器人范围。

WorkTool 扩展接口路径(可选)

变量 默认值 必填 敏感 说明
WORKTOOL_IPACL_QUERY_PATH 黑名单功能开启时是 黑名单查询接口 path。
WORKTOOL_IPACL_ADD_PATH 黑名单功能开启时是 黑名单新增接口 path。
WORKTOOL_IPACL_DELETE_PATH 黑名单功能开启时是 黑名单删除接口 path。
WORKTOOL_WEWORK_AUTH_LIST_PATH 企业授权功能开启时是 企业授权列表接口 path。
WORKTOOL_WEWORK_AUTH_SAVE_PATH 企业授权功能开启时是 企业授权保存接口 path。
WORKTOOL_WEWORK_AUTH_DELETE_PATH 企业授权功能开启时是 企业授权删除接口 path。
WORKTOOL_DB_HOST 预留 WorkTool DB 连接地址。
WORKTOOL_DB_PORT 3306 预留 WorkTool DB 端口。
WORKTOOL_DB_USER 预留 WorkTool DB 用户名。
WORKTOOL_DB_PASSWORD 预留 WorkTool DB 密码。
WORKTOOL_DB_NAME 预留 WorkTool DB 库名。

短信(华瑞)

变量 默认值 必填 敏感 说明
SMS_HUARUI_API_URL 短信开启时是 短信服务地址。
SMS_HUARUI_APPKEY 短信开启时是 短信 appkey。
SMS_HUARUI_APPSECRET 短信开启时是 短信 appsecret。
SMS_CODE_EXPIRE_MINUTES 15 短信验证码有效期(分钟)。

默认测试引擎与回调并发

变量 默认值 必填 敏感 说明
DEFAULT_TEST_PROVIDER_ENABLED false 是否启用系统级测试 AI 引擎。
DEFAULT_TEST_PROVIDER_NAME AI模型(仅测试用) 测试引擎名称。
DEFAULT_TEST_PROVIDER_BASE_URL https://ark.cn-beijing.volces.com/api/coding/v3/chat/completions 开启时是 测试引擎地址。
DEFAULT_TEST_PROVIDER_API_KEY 开启时是 测试引擎 token。
DEFAULT_TEST_PROVIDER_MODEL doubao-seed-2.0-lite 测试引擎 model。
QA_CALLBACK_WORKER_CONCURRENCY 16 QA 回调异步 worker 数。
QA_CALLBACK_QUEUE_MAXSIZE 2000 QA 回调队列长度。
ROBOT_SHOW_NAME_CACHE_TTL_SECONDS 600 机器人昵称缓存秒数。

对话上下文记忆(轻量)

变量 默认值 必填 敏感 说明
CHAT_CONTEXT_ENABLED true 是否启用群聊/私聊上下文记忆。
CHAT_CONTEXT_MAX_MESSAGES 20 单会话最多保留消息数。
CHAT_CONTEXT_RETENTION_DAYS 7 上下文数据保留天数。

生产建议

  1. AUTH_JWT_SECRETMYSQL_PASSWORDAPP_MYSQL_PASSWORD、各类 *_KEY/*_SECRET 必须替换成强随机值。
  2. 开源场景建议默认关闭:ENABLE_ADMIN_IP_BLACKLISTENABLE_ADMIN_ENTERPRISE_AUTHENABLE_OPEN_TROUBLESHOOT_API
  3. 小流量先用:QA_CALLBACK_WORKER_CONCURRENCY=8~16;高峰再按监控调优。
  4. 上下文记忆建议保持轻量:CHAT_CONTEXT_MAX_MESSAGES=20CHAT_CONTEXT_RETENTION_DAYS=7