Skip to content

环境变量

完整模板见仓库根目录 .env.example。修改后需重启后端(go run ./cmd/serverdocker compose restart)。

Cloud 部署模板:deploy/railway/env.cloud.example

LLM 与基础服务

变量默认说明
LLM_PROVIDERdeepseek提供商:deepseek / openai / openrouter / ollama / custom
LLM_API_KEY模型 API Key(推荐统一使用此变量)
LLM_BASE_URL按提供商只填域名前缀,不要/v1/chat/completions
LLM_MODEL按提供商可选,覆盖预设模型名
DEEPSEEK_API_KEY兼容旧变量;未设 LLM_API_KEY 时生效
DEEPSEEK_BASE_URLhttps://api.deepseek.comDeepSeek API 根地址
PORT8080HTTP 服务端口
HOST_PORT8080Docker 宿主机映射端口;install.sh 在 8080 占用时会自动改写
DATABASE_PATH./data/regulus.dbSQLite 数据库路径
REGULUS_COACH_ROOT镜像内 /app/regulus-coachCoach 资源目录;本地 go run 一般无需设置

教练点亮(教学流程)

教练流程 直接相关。

变量默认说明
REGULUS_STRICT_CONCEPT_COVERAGE1(开)设为 0 关闭「核心概念 ≥3 且未考 ≥2 时建议再练」
REGULUS_REQUIRE_APPLY_EXERCISE1(开)设为 0 关闭熟悉/精通层的应用级练习建议(入门层始终不要求 apply)
REGULUS_LLM_COMPLETION_CHECK1(开)设为 0 关闭点亮前 LLM 综合评估,回退纯规则硬挡 + 传统掌握度评估

组合示例

默认(推荐) — 三项均为 1

  • 规则给出覆盖 / apply 建议
  • LLM 结合对话做最终 ready 裁决,可软豁免
  • 答对但 not ready 时自动连题

严格规则REGULUS_LLM_COMPLETION_CHECK=0

  • 练习答对:规则满足则必须再练,否则直接点亮
  • 申请掌握:not ready 时不自动连题,再次申请可强制完成
  • 适合弱模型或需要确定性行为的自托管

宽松练习REGULUS_STRICT_CONCEPT_COVERAGE=0REGULUS_REQUIRE_APPLY_EXERCISE=0

  • 仅保留 LLM 综合评估(若仍开启 REGULUS_LLM_COMPLETION_CHECK
  • 单题答对更容易点亮;仍会因明显缺口被模型拒绝

LLM 超时与建课

变量默认说明
REGULUS_LLM_TIMEOUT_SEC240单次 LLM HTTP 超时(秒);慢速 API 可调到 300~600
REGULUS_DOMAIN_BUILD_TIMEOUT_SEC360/domain/build、regenerate 整请求超时(秒)
REGULUS_TREE_CRITIQUE1(开)设为 0 关闭建树后 LLM 质检(critique 重生成)

材料导入(C1)

变量默认说明
REGULUS_INGEST_MAX_PDF_BYTES20971520PDF 最大体积(字节,约 20MB)
REGULUS_INGEST_MAX_PDF_PAGES200PDF 最大页数
REGULUS_INGEST_MAX_PDF_CHARS600000PDF 提取正文上限(字符)
REGULUS_INGEST_MAX_URL_CHARS80000网页正文上限(字符)
REGULUS_INGEST_FETCH_TIMEOUT_SEC15抓取 URL 超时(秒)

纵深扩展(C2)

变量默认说明
REGULUS_EXTEND_MIN_RATIO0.8解锁「纵深扩展」所需的课程完成度(80%)

课程体检与优化

变量默认说明
REGULUS_COURSE_AUDIT_LLM1(开)设为 0 仅做规则体检,不调用 LLM 写整树评语
REGULUS_COURSE_OPTIMIZE_LLM1(开)设为 0 关闭 LLM 课程优化(无法生成补丁预览)

入口在课程详情页「课程体检」,说明见 功能一览 · 课程体检与优化

Cloud Demo 专用

本地自托管勿设置 REGULUS_DEPLOYMENT=cloud

变量说明
REGULUS_DEPLOYMENT设为 cloud 启用在线版策略
ADMIN_TOKEN管理接口与 #/admin 登录(cloud 模式必填)
REGULUS_CLOUD_ENCRYPTION_KEYBYOK 加密密钥(openssl rand -hex 32
REGULUS_CLOUD_QUOTA_DAILY_MESSAGES每用户每日免费教练消息数(默认 30)
REGULUS_CLOUD_QUOTA_DAILY_BUILDS每用户每日 LLM 建课/导入/扩展次数(默认 3;内置 Skill 快路径不计入)
REGULUS_CLOUD_GITHUB_URL页脚 GitHub 链接
REGULUS_CLOUD_DOCS_URL页脚文档链接
REGULUS_CLOUD_DEMO_URL页脚在线 Demo 链接
REGULUS_CLOUD_MAX_BUILD_JOBS_GLOBAL全局建课并发上限(默认 5)
REGULUS_CLOUD_MAX_USERS_PER_IP_PER_DAY每 IP 每日可创建学习角色数(默认 5)
REGULUS_CLOUD_RATE_LIMIT_PER_IP每 IP 每分钟请求上限

自托管若需保护管理接口,可单独设置 ADMIN_TOKENAuthorization: Bearer <token>)。

IM Gateway

变量默认说明
GATEWAY_ENABLEDfalse是否启用 IM Gateway
GATEWAY_PUBLIC_URL公网访问地址(展示 webhook 回调 URL)

Telegram

变量默认说明
TELEGRAM_ENABLEDtrueGateway 开启后是否启用 Telegram
TELEGRAM_BOT_TOKEN@BotFather 创建的 Bot Token
TELEGRAM_ALLOWED_USERS可选,逗号分隔 user id 白名单

钉钉

变量说明
DINGTALK_ENABLED是否启用(默认 true,需 Gateway 开)
DINGTALK_CLIENT_ID开放平台 AppKey
DINGTALK_CLIENT_SECRETAppSecret

飞书

变量默认说明
FEISHU_ENABLEDtrue是否启用
FEISHU_MODEwebsocketwebsocket(内网可用)或 webhook(需公网 HTTPS)
FEISHU_APP_ID应用 App ID
FEISHU_APP_SECRET应用 App Secret
FEISHU_VERIFY_TOKENwebhook 模式推荐
FEISHU_ALLOWED_USERS可选,open_id 白名单

企业微信

变量说明
WECOM_ENABLED默认 false;需公网 HTTPS 回调
WECOM_CORP_ID / WECOM_AGENT_ID / WECOM_SECRET应用凭证
WECOM_TOKEN / WECOM_ENCODING_AES_KEY回调加解密
WECOM_ALLOWED_USERS可选用户白名单

IM 配置步骤见 IM 频道;用户向说明见该页,本文仅列变量。

Langfuse(开发期追踪)

默认关闭;Docker / 生产建议保持 false

变量默认说明
LANGFUSE_ENABLEDfalse开启后向 Langfuse 导出 OTLP trace
LANGFUSE_PUBLIC_KEYLangfuse Public Key
LANGFUSE_SECRET_KEYLangfuse Secret Key
LANGFUSE_BASE_URLhttp://localhost:3000Langfuse 根地址
LANGFUSE_ENVIRONMENTdevelopmenttrace 环境标签
LANGFUSE_LOG_CONTENTtruefalse 时不记录 prompt/completion 正文

相关文档