treg环境变量完全参考:所有TREG_配置项逐一讲解
发布时间:2026/9/29 12:13:17 锦皓数字建站

treg环境变量完全参考所有TREG_配置项逐一讲解【免费下载链接】tregOpenRouter for agent tools. Join community here: https://discord.gg/6mQYYfFMAn项目地址: https://gitcode.com/GitHub_Trending/treg/tregtregOpenRouter for agent tools是一个 API 工具注册中心用一把统一的 API 密钥调用 2000 个工具端点。它的行为几乎全部由TREG_前缀的环境变量控制——从本地一键跑起来到自托管部署、平台密钥、登录方式都在这份配置里。本文把 src/treg/config.py 中的核心配置项和 src/treg/cli.py 中 CLI 读取的变量逐一讲清楚新手照抄即可。一、treg 如何读取环境变量先理解一个机制后面就不用反复解释所有配置集中在一个Settings类中见 src/treg/config.py#L56-L57声明了env_prefixTREG_和env_file.env。也就是说任何配置项foo_bar都对应环境变量TREG_FOO_BAR并且会自动读取项目根目录的.env文件。配置启动时只读取一次并缓存get_settings()修改后需重启服务生效。 记忆技巧看到配置项名字把下划线大写再加TREG_前缀就是它的环境变量。二、本地跑起来新手最先需要的一组变量变量默认值作用TREG_DATABASE_URL本地 SQLite数据库连接串Postgres 会自动改写为 async 驱动#L68-L83TREG_SECRET_KEY空临时密钥Fernet 加密密钥用python -m treg keygen生成生产环境必填TREG_EMAIL_DEV_MODEfalse开启后邮件验证码直接显示在页面上仅限本地 SQLite 开发TREG_SINGLE_USERfalse免登录单人模式同样仅在本地 SQLite loopback 地址下生效TREG_FRONTEND_DEVfalse用 Vite 开发模式提供前端仅限本地TREG_PORT/PORT18790HTTP 监听端口见 docs/context/ops/deploy.md最省事的本地玩法什么都不设python -m treg默认走 SQLite 临时密钥配合TREG_EMAIL_DEV_MODEtrue就能看到登录验证码。部署示例可参考 deploy/render.example.yaml。三、登录与邮件账号系统相关变量treg 的 Dashboard 支持三种登录方式分别对应不同的变量变量作用TREG_GITHUB_CLIENT_ID/TREG_GITHUB_CLIENT_SECRETGitHub OAuth 登录留空则隐藏按钮#L487-L496TREG_GOOGLE_CLIENT_ID/TREG_GOOGLE_CLIENT_SECRETGoogle OAuth同一应用还支撑 Search Console、Analytics 等工具连接TREG_RESEND_API_KEYResend 邮件发送密钥留空则不发真实邮件#L722-L727TREG_EMAIL_FROM发件人默认tools-registry no-replytreg.to自托管要换成自己验证过的域名TREG_SESSION_SECRET会话 Cookie 的 HMAC 签名密钥未设置时回退到TREG_SECRET_KEYTREG_FIXED_LOGIN_CODES给无法收邮件的账号如审核演示账号配置固定验证码格式emailsha256hexTREG_BLOCKED_EMAIL_DOMAINS逗号分隔的注册封禁域名黑名单配置即生效、无需改代码TREG_ADMIN_TOKEN跨租户超级管理员 Bearer 令牌权限极大务必保密#L115-L118安全设计值得注意TREG_EMAIL_DEV_MODE即使在生产误设只要数据库是 Postgres 就不会泄漏验证码见expose_dev_code属性——防呆做得很足。四、CLI 端变量给 Agent 和开发者用的这一组由 src/treg/cli.py 读取官方说明在 docs/context/interface/cli.md变量作用TREG_TOKEN当前进程的 treg 令牌优先级高于配置文件适合 CI / 多 Agent 并行TREG_ORG与TREG_TOKEN搭配指定操作哪个组织TREG_URL指向自托管的 treg 服务器地址跟TREG_TOKEN一起使用TREG_CONFIG指向替代配置文件路径用于隔离 CI、测试环境#L50-L52TREG_CLIENT手动覆盖客户端身份上报仅用于统计归因不是认证TREG_TELEMETRY设为0/false/off关闭遥测DO_NOT_TRACK1同样有效TREG_CLI_POSTHOG_KEY/TREG_CLI_POSTHOG_HOST自托管实例若要上报产品分析才需要设置TREG_LLM_TOKENtreg upload --llm解析未知密钥时使用的 LLM API token典型场景每个编码 Agent 进程注入自己的TREG_TOKEN互不串号这就是官方推荐的多 Agent 并行调用 treg的姿势。五、自托管部署生产环境核心变量在 deploy/render.example.yaml 的示例中生产部署最关键的 6 个变量是TREG_PUBLIC_URL— 你的对外正式域名用于构造 OAuth 回调地址自托管必改#L479-L480TREG_DATABASE_URL— Postgres 连接串TREG_SECRET_KEY— 真实密钥临时密钥重启即失效TREG_SESSION_SECRET— 会话签名密钥TREG_GITHUB_CLIENT_ID/TREG_GITHUB_CLIENT_SECRET— 登录入口TREG_RESEND_API_KEYTREG_EMAIL_FROM— 邮件验证码与团队邀请。进阶性能变量详见 docs/context/ops/deploy.mdTREG_KV_URL共享 Redis 协议键值存储留空则用进程内回退TREG_READ_DATABASE_URL可选的只读复制库自动加read_only保护TREG_DB_POOL_OVERRIDES按admin.pool_size4,background.pool_size12的格式调连接池改配置而不是改代码。六、平台密钥体系treg 代付模式treg 可以用自己的供应商密钥替调用方服务调用方的预付余额被记账这就是 Tier-4 平台密钥全部配置集中在 src/treg/config.py#L182-L267变量作用TREG_PLATFORM_PROVIDERS总开关 允许清单逗号分隔provider 必须既在清单里又配了密钥才会服务留空整个功能关闭防止误花钱TREG_PLATFORM_KEY_PROVIDER各供应商密钥如TREG_PLATFORM_KEY_TIKHUB、TREG_PLATFORM_KEY_SERPAPI、TREG_PLATFORM_KEY_HUNTER、TREG_PLATFORM_KEY_MINIMAX等命名规律固定TREG_PLATFORM_DAILY_CAP_USD未自设限额的团队的每日平台消费默认上限0不限TREG_OVERFLOW_MODE同厂溢出聚合器off/shadow/on三档#L284-L287TREG_OVERFLOW_DAILY_BUDGET_USD每个聚合器每天UTC的溢出预算默认 $20TREG_OAUTH_BILLED_PROVIDERS列出哪些 OAuth 连接如 X的上游账单由 treg 承担、从组织余额记账⚠️ 这些密钥只存在于环境变量永不落库、永不进日志——这是官方在代码注释中明确承诺的设计。七、命令执行沙箱treg run相关变量变量默认作用TREG_RUN_ALLOWED_BINS空--server模式允许执行的 CLI 白名单逗号分隔防止成员拿bash跑任意代码#L127-L131TREG_RUN_PROOF空本地隔离 runner 的共享密钥凭证成员本机不可持有TREG_RUN_RLIMITStrue服务端运行的 POSIX 资源限制总开关TREG_RUN_CPU_SECONDS300单次服务端运行可用的 CPU 秒数上限TREG_RUN_FSIZE_MB100单次运行可写的最大单文件大小防写爆磁盘八、可选高级开关默认都关着TREG_HUB_ENABLEDTREG_HUB_TEAMS/TREG_HUB_USERS工具 Hub 总开关可用团队/用户清单灰度放量#L455-L467TREG_CLAUDE_CONNECTOR_ENABLED目录型 MCP 连接器默认关闭TREG_CONNECT_DEMO_ENABLEDOAuth/MCP 调试页只建议开在本地/预发TREG_ARCHIVE_MODE响应归档off/shadow/serve另有TREG_ARCHIVE_SERVE_*一族参数控制放量、计价、保留期TREG_SEARCH_EXPERIMENTAI 裁判搜索实验需TREG_TYPESAFE_API_KEY同时也是它的急停开关TREG_ROUTED_DISCOVERY搜索结果是否引导用户走向路由型能力工具off即恢复原样TREG_MCP_ALLOWED_HOSTS/TREG_MCP_ALLOWED_ORIGINS为浏览器端 MCP 客户端追加允许的 host/originsrc/treg/mcp.pyTREG_PROXY_SSRF_CHECK转发时的 SSRF 防护默认开启建议保持。九、测试与开发专用变量变量用途TREG_TEST_DB_URLPostgres 测试库连接串故意与TREG_DATABASE_URL分开防止误用生产库tests/conftest.py#L21TREG_E2E_PORTPlaywright E2E 服务端口未设时自动挑空闲端口frontend/playwright.config.tsTREG_BUILD写入分析事件的构建标识平台未暴露 commit 变量时才需要TREG_INGEST_CACHE目录采集脚本的下载缓存目录默认~/.cache/treg-catalog-ingestscripts/catalog_ingest.py十、一句话最佳实践本地开发TREG_EMAIL_DEV_MODEtrue 默认 SQLite两分钟跑起来自托管必设TREG_PUBLIC_URL、TREG_SECRET_KEY、TREG_SESSION_SECRET邮件三件套齐全后体验完整生产敏感密钥一律走部署平台的 Secret 存储TREG_PLATFORM_PROVIDERS留空直到确认要开启平台代付所有变量都可以写在项目根目录.envTREG_前缀 大写蛇形命名改完重启即生效。完整字段语义以源码为准src/treg/config.py、docs/context/ops/deploy.md 与 docs/context/interface/cli.md。【免费下载链接】tregOpenRouter for agent tools. Join community here: https://discord.gg/6mQYYfFMAn项目地址: https://gitcode.com/GitHub_Trending/treg/treg创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
锦
锦皓数字建站
深耕本土企业品牌数字化升级,专注原创端正雅致商务官网,从视觉设计到稳定运维全程保驾护航。