mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-07-31 04:12:10 +03:00
25f794affa
Brings docs/ENVIRONMENT.md in line with the cleaned-up .env.example. Every variable present in .env.example now has a row in ENVIRONMENT.md, and the formatting convention used by the doc tables matches the regex used by scripts/check-env-doc-sync.mjs. Notable additions, per section: - §3 Network & Ports — HOST, HOSTNAME bind overrides. - §6 Tool & Routing Policies — OMNIROUTE_PAYLOAD_RULES_PATH, OMNIROUTE_PAYLOAD_RULES_RELOAD_MS. - §7 URLs & Cloud Sync — KIE_CALLBACK_URL, OMNIROUTE_KIE_CALLBACK_URL, OMNIROUTE_PUBLIC_URL, plus the three new quota endpoint overrides (OMNIROUTE_CROF_USAGE_URL, OMNIROUTE_GEMINI_CLI_USAGE_URL, OMNIROUTE_CODEWHISPERER_BASE_URL). - §9 CLI Tool Integration — CLI_QWEN_BIN. - §10 Internal Agent & MCP — MCP description compression toggles, background-task and healthcheck overrides, RTK trust flag, Redis auth cache toggle, ANTIGRAVITY_CREDITS. - §11 OAuth — GitLab legacy fallback variables (`GITLAB_BASE_URL`, `GITLAB_OAUTH_CLIENT_ID`, `GITLAB_OAUTH_CLIENT_SECRET`). - §13 CLI Fingerprint — Kimi identity overrides + CLI_COMPAT_* table reshaped so the variable names appear in their own backticks (matches the env-doc sync regex). Removed the orphaned CLI_COMPAT_KIRO row. - §14 API Key Providers — pruned the stub rows for providers whose static *_API_KEY is no longer consumed at runtime. Added an audit note pointing to the bottom of the doc. - §15 Timeout Settings — OMNIROUTE_DEFAULT_FETCH_TIMEOUT_MS, OMNIROUTE_CHATGPT_TLS_TIMEOUT_MS/GRACE_MS, and the OMNIROUTE_CIRCUIT_BREAKER_* table. - §16 Logging — APP_LOG_ROTATION_CHECK_INTERVAL_MS and the CHAT_LOG_* / CHAT_DEBUG_FILE knobs. - §21 Proxy Health — RATE_LIMIT_AUTO_ENABLE force-on/off documentation, HEALTHCHECK_STAGGER_MS. - §22 Debugging — Cursor executor toggles (CURSOR_DEBUG / CURSOR_STREAM_DEBUG / CURSOR_DUMP_FILE / CURSOR_STREAM_TIMEOUT_MS / CURSOR_STATE_DB_PATH / CURSOR_TOKEN), OMNIROUTE_LOG_REQUEST_SHAPE. Removed CURSOR_PROTOBUF_DEBUG (orphan). - §23 GitHub — generic GITHUB_TOKEN fallback. - New §25 — Provider quotas, tunnels, backups & misc runtime, covering Alibaba Bailian overrides, model alias compatibility, context reserve, MITM debug proxy, the 1Proxy egress pool, Tailscale binaries, ngrok, DB backups, and OMNIROUTE_TLS_PROXY_URL. Also documents REDIS_URL, which previously lived only in .env.example. - New §26 — Test & E2E harness: OMNIROUTE_E2E_BOOTSTRAP_MODE, OMNIROUTE_E2E_PASSWORD, healthcheck disablers, Playwright skip-build, uninstall-hook skip, ecosystem wait timeout, all ELECTRON_SMOKE_* variables, CLI_DEVIN_BIN. The Audit section is updated with the v3.8.0 removals (provider API key stubs, CURSOR_PROTOBUF_DEBUG, CLI_COMPAT_KIRO, QIANFAN_API_KEY) and a prominent note at the top of the doc explains the sync contract. .env.example: documents OUTBOUND_SSRF_GUARD_ENABLED (legacy SSRF guard flag actually consumed by src/shared/network/outboundUrlGuard.ts) and CODEX_CLIENT_VERSION override. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>