* chore(release): open v3.8.36 development cycle * refactor(chatCore): extrai resolveCompressionSettings (#3501) (#4826) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 1/13) * refactor(chatCore): extrai predicados puros de combo de compressão (#3501) (#4824) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 2/13) * refactor(chatCore): extrai emitOutputStyleTelemetry (#3501) (#4811) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 3/13) * refactor(chatCore): extrai writeCompressionAnalytics (bloco analytics completo, #3501) (#4817) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 4/13) * refactor(chatCore): extrai runPluginOnRequestHook (#3501) (#4827) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 5/13) * refactor(chatCore): extrai applyClientUsageBuffer (buffer/estimate de usage non-streaming, #3501) (#4832) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 6/13) * refactor(chatCore): extrai buildPostCallGuardrailContext (contexto guardrail post-call, #3501) (#4831) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 7/13) * refactor(chatCore): extrai storeSemanticCacheResponse (cache-store non-streaming, #3501) (#4828) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 8/13) * refactor(chatCore): extrai buildNonStreamingResponseHeaders (headers de resposta non-streaming, #3501) (#4835) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 9/13) * refactor(chatCore): extrai maybeConvertJsonBodyToSse (#3089 JSON→SSE streaming, #3501) (#4833) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 10/13) * refactor(chatCore): extrai assembleStreamingResponseHeaders (headers de resposta streaming, #3501) (#4836) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 11/13) * refactor(chatCore): extrai storeStreamingSemanticCacheResponse (cache-store streaming, #3501) (#4829) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 12/13) * refactor(chatCore): extrai assembleStreamingPipeline (chain de transforms streaming, #3501) (#4837) Integrated into release/v3.8.36 (#3501 chatCore extraction stack 13/13) * ci(quality): shift heavy validations to the PR→release fast-path (release-acceleration) (#4857) * feat(quality): add check:test-runner-api gate (vitest-only dirs must use vitest API) * feat(release): reusable CHANGELOG i18n-mirror sync script * chore(ops): add prune-stale-worktrees.sh (dry-run by default) * ci(quality): run test-runner-api + docs-all + vitest + full unit suite on PR->release fast-path --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(quota): cota exclusiva lista qtSd/ no /v1/models (#4806) + limite EPSILON não bloqueia (#4830) Integrated into release/v3.8.36 — quota-exclusive qtSd/ listing (#4806) + EPSILON placeholder no longer blocks; rebuilt from stale base (3 defining commits cherry-picked clean over release tip) * feat(sse): add Google Flow video-generation provider (#4569) (#4769) Integrated into release/v3.8.36 — Google Flow video-generation provider (#4569), release-green validated (typecheck + 21 tests + file-size) * fix(api): auth on compression run-telemetry + document OMNIROUTE_EVAL_CREDENTIALS (#4694, #4720) (#4796) Integrated into release/v3.8.36 — auth on compression run-telemetry + OMNIROUTE_EVAL_CREDENTIALS doc, release-green validated (typecheck + 3 tests + env-doc-sync) * fix(translator): strip top-level client_metadata on the OpenAI passthrough (port from 9router#1157) (#4624) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(translator): normalize `developer` role to `system` for OpenAI-format providers (#4625) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(translator): emit </think> close marker for Anthropic thinking blocks (#4633) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(translator): normalize tools to Anthropic-native shape for non-Anthropic providers (#4650) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(gemini): preserve `pattern` in antigravity tool schema sanitizer (#4651) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(perplexity): validate API keys via /v1/models endpoint (#4654) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(image): prevent compatible nodes from shadowing provider aliases (#4656) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(cli-tools): tolerate JSONC (comments, trailing commas) in tool settings (#4659) Integrated into release/v3.8.36 — port (rebuilt from stale base; defining commit cherry-picked clean over release tip, release-green validated) * fix(security): validate kiro region to prevent SSRF (GHSA-6mwv-4mrm-5p3m) (#4629) Integrated into release/v3.8.36 — kiro region SSRF guard (GHSA-6mwv-4mrm-5p3m), port rebuilt clean over release tip * fix(cli): harden the systray2 tray runtime (port of 9router#1080) (#4628) Integrated into release/v3.8.36 — port rebuilt clean over release tip, release-green validated * fix(test): validate anthropic-compatible connections via POST /v1/messages (#4657) Integrated into release/v3.8.36 — anthropic-compat validation via POST /v1/messages (port 584cf66a), rebuilt clean + baseline; release-green * fix(executors): strip params unsupported by the target provider/model (#4658) Integrated into release/v3.8.36 — port rebuilt clean over release tip, release-green validated * fix(claude-oauth): respect 429 backoff on usage endpoint to reduce spam (#4655) Integrated into release/v3.8.36 — port rebuilt clean over release tip, release-green validated * feat(api/v1): include alias-backed models in /v1/models listing (#4630) Integrated into release/v3.8.36 — port rebuilt clean over release tip, release-green validated * chore(quality): rebaseline catalog.ts 1574->1577 (#4630 aliases sobre quota-exclusive da release) (#4879) rebaseline * feat(compression): Kiro/CodeWhisperer tool-result compression engine (#4635) Integrated into release/v3.8.36 — port rebuilt clean, release-green * fix(security): don't trust loopback socket as local when behind reverse proxy (#4632) Integrated into release/v3.8.36 — port rebuilt clean, release-green * fix(opencode): preserve DeepSeek reasoning content in streamed responses (#4631) Integrated into release/v3.8.36 — DeepSeek reasoning_content injection (port #1099); release-green * fix(copilot,antigravity): cap maxOutputTokens at 16384 to stop "Invalid Argument" 400 (#4636) Integrated into release/v3.8.36 — cap maxOutputTokens 16384 antigravity (port #779); release-green * fix(dashboard): show custom vision models in LLM selector (#4653) Integrated into release/v3.8.36 — custom vision models in LLM selector (port 5e5e78d3); release-green * fix(claude): omit adaptive thinking + output_config.effort for haiku (#4661) Integrated into release/v3.8.36 — haiku adaptive-thinking omit (port); release-green * feat(provider): CodeBuddy CN (copilot.tencent.com) — full stack (#4664) Integrated into release/v3.8.36 — CodeBuddy CN provider (port efd20be8); usage.ts import + public-creds allowlist line reconciled; release-green * feat(combo): Fusion strategy — parallel panel + judge synthesis (16th strategy) (#4652) Integrated into release/v3.8.36 — Fusion combo strategy (16th, port 87e5c1c6); combo.ts baseline reconciled; release-green * feat(proxy-pool): Deno Deploy relays + group action buttons (#4643) Integrated into release/v3.8.36 — Deno Deploy relays (port #1437); proxies.ts baseline reconciled + env docs restored; release-green * fix(security): pin image fetch DNS resolution to prevent SSRF rebinding (GHSA-cmhj-wh2f-9cgx) (#4634) Integrated into release/v3.8.36 — pin DNS for image fetch SSRF rebinding guard (GHSA-cmhj-wh2f-9cgx, port c7d07448); caller DNS stubs + test-file baseline reconciled; release-green * fix(github): route Copilot Codex models to /responses (port from 9router#102) (#4626) Integrated into release/v3.8.36 — route Copilot Codex models to /responses (port #102); release-green * fix(copilot): never route Gemini/Claude variants to /responses (chat-completions only) (#4627) Integrated into release/v3.8.36 — never route Gemini/Claude to /responses (port #1536); fused with #4626 codex routing via supportsResponsesEndpoint gate; release-green * docs(ops): add canonical incident response runbook (#4868) Integrated into release/v3.8.36 * docs(perf): add per-endpoint p50/p95/p99 latency + cost budgets (#4867) Integrated into release/v3.8.36 * fix(proxy): fan out direct dispatcher streams (#4803) Integrated into release/v3.8.36 * fix(antigravity): exclude standard Gemini rate limit message from quota exhaustion keywords (#4810) Integrated into release/v3.8.36 * fix(sse): skip third-party tool-name cloak for Anthropic server tools (#4808) Integrated into release/v3.8.36 * fix(install): make transformers optional for CUDA-host installs (#4807) Integrated into release/v3.8.36 * fix(combo): propagate selected connection ID to fallback error responses for correct model lockout (#4809) Integrated into release/v3.8.36 * fix db storage tuning settings (#4834) Integrated into release/v3.8.36 * fix(sse): drop ccp pin when pinned provider is durably unhealthy (failover + anti-flap) (#4864) Integrated into release/v3.8.36 * fix(claude): skip mcp__ tool-name cloak + guard missing connectionId (#4861) Integrated into release/v3.8.36 * chore(quality): reconcile env-doc + file-size base-reds in release/v3.8.36 (#4886) - env-doc-sync: document PIN_DROP_BACKOFF_LEVEL / PIN_DROP_GRACE_MS (added by the ccp-pin health gate #4864) in .env.example + ENVIRONMENT.md. - file-size: rebaseline image-generation-handler.test.ts 1996 -> 2019 to its actual size (pre-existing drift). Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(codex): drop non-standard codex.* events that break responses.stream (env-gated, #4602) (#4715) Integrated into release/v3.8.36 * feat(routing): honor X-Route-Model header to override body.model (#4863) Integrated into release/v3.8.36 * feat(live-ws): allow non-loopback clients via LIVE_WS_ALLOWED_HOSTS (closes #4873) (#4877) Integrated into release/v3.8.36 (live-ws + combo-api commits; Tailscale CGNAT commit held pending opt-in/opt-out decision) * chore(claude,codex): bump pinned CLI identity — Claude 2.1.158→2.1.187, Codex 0.132.0→0.142.0 (#4883) Integrated into release/v3.8.36 * fix(security): SSRF allowlist bypass via x-relay-path nos relays Deno/Vercel (#4899) Integrated into release/v3.8.36 * feat(quota): recuperação proativa de conexões em cooldown (cron heal) [Fase 3 #8] (#4900) Integrated into release/v3.8.36 * fix(quota): policy inválida não vaza allow + guard connectionIds vazio [Fase 3 #10] (#4901) Integrated into release/v3.8.36 * feat(quota): saturação real do Claude no fair-share via /api/oauth/usage (#4885) Integrated into release/v3.8.36 * chore(dashboard): rename Qoder display label from "Qoder AI" to "Qoder" (#4733) Integrated into release/v3.8.36 * fix(ci): include coverage/lcov.info in coverage-report artifact for SonarQube (#4670) Integrated into release/v3.8.36 * fix(cli): bump better-sqlite3 runtime pin to 12.10.1 for Node 26 (#4685) Integrated into release/v3.8.36 * docs: clarify Kiro is ~50 credits/month per account, not unlimited (#4690) Integrated into release/v3.8.36 * docs(agentbridge): document Electron NODE_EXTRA_CA_CERTS, real model IDs, identity caveat (#4718) Integrated into release/v3.8.36 * docs(ops): document the release-green family (green-prs, check:release-green, babysit, nightly) (#4679) Integrated into release/v3.8.36 * fix(translator): replay reasoning_content on plain Xiaomi MiMo turns (port from 9router#1321) (#4639) Integrated into release/v3.8.36 * feat(opencode-go): advertise glm-5.2 and kimi-k2.7-code (align with official Go endpoints) (#4711) Integrated into release/v3.8.36 * feat(db): track API endpoint dimension on usage_history (#4676) Integrated into release/v3.8.36 (migration renumbered 103→105; endpoint plumbed through extracted usage-stats helpers) * fix(cli): SIGKILL systray child PID before IPC close to avoid macOS NSStatusItem orphan (#4732) Integrated into release/v3.8.36 * feat(proxy-pool): Cloudflare Workers proxy deployer + pool integration (#4640) Integrated into release/v3.8.36 (relay type added to RELAY_TYPES set; dropdown UX preserved + Cloudflare item added; proxies.ts file-size rebaselined 1057→1060) * chore(quality): conserta base-red de release/v3.8.36 (gates + 7 testes + build MDX) (#4915) A base tinha base-red sistêmica herdada de PRs de outras sessões, bloqueando TODOS os PRs do ciclo (o TIA roda a suíte full em fail-safe p/ diffs hub). 4 Fast Quality Gates: - test-discovery (#4877): live-server-allowlist.test.ts em tests/unit/server/ (não-coletado) + vitest → nunca rodava. Convertido p/ node:test em tests/unit/security/. - any-budget:t11 (#4664): 3 explicit-any em tokenRefresh.ts tipados (sem crescer file-size). - docs-symbols (#4868): rotas inexistentes → /api/system/version e PUT /api/providers/{id} {isActive:false}. - docs-all fabricated-claim (#4868 + #4718): 5 bin/*.sh reais criados (rollback, snapshot-data, restore-data, restore-policies, cold-start-bench) + _ops-common.sh (snapshot VACUUM INTO, guards de confirmação/TTY, testes de contrato); NODE_EXTRA_CA_CERTS (env de runtime Node) na allowlist do checker. 7 testes unit base-red (de features alheias à quota): - oauth-providers-config (#4664): teste alinhado ao provider codebuddy-cn do registry. - antigravity-model-aliases (#4636): maxOutputTokens esperado 32769→16384 (cap intencional). - provider-request-capture #4091 (#4861): exemplo do teste trocado de mcp__ (que #4861 isenta de cloak por causa dos 400s de assimetria de histórico) para um tool de terceiro cloakável — preserva o invariante de #4091 SEM reverter #4861. - combo-error-response: convertido de vitest p/ node:test (era coletado pelo glob node:test e crashava); api/** e server/** removidos do vitest.config (config morta). Build MDX (dast-smoke, #4679): - docs/ops/RELEASE_GREEN.md não tinha frontmatter `title` → fumadocs-mdx rejeitava no webpack compile ("invalid frontmatter: title expected string"), quebrando o next build (e o deploy). Frontmatter title adicionado (único doc do collection sem ele). 17/17 Fast Quality Gates + suíte unit completa (17737 testes, 0 fail) + vitest verdes localmente. Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * feat(quota): saturação proativa por headers de tokens (universal) [Fase 3 #2] (#4907) storeRateLimitHeaders só capturava os headers de REQUESTS (RPM/min), que não refletem a pressão de TOKENS. Agora também parseia os headers de tokens (em toda resposta, sucesso também) para throttle proativo antes do 429: - Anthropic: anthropic-ratelimit-tokens-{limit,remaining,reset} (+ input/output), RFC3339. - OpenAI: x-ratelimit-{limit,remaining,reset}-tokens, reset em duração (6m0s). saturation = 1 − remaining/limit; resetAt normalizado a epoch (parse de duração ReDoS-safe). getTokenHeaderSaturation por (provider, connectionId). fetchGeneric- Saturation passa a usar esse sinal (complementa o oauth/usage do #1, que segue primário p/ Claude). Fail-open, cache mantido, request-path inalterado. 16 testes novos + regressão (oauth/usage #1 8/8, signals 6/6) = 30/30; typecheck:core + eslint limpos. Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * feat(quota): estratégia de combo "headroom" — seleção por folga de cota [Fase 3 #4] (#4908) Nova estratégia de roteamento que escolhe a conexão com MAIS folga de plano: headroom = 1 − max(util_5h, util_7d) (técnica do dario), via getSaturation (melhorado p/ Claude no #1). Proativo em vez de só fill-first reativo. - Helper PURO headroomRanking.ts (computeHeadroom + rankByHeadroom; saturação injetada, não-mutante, tie-break estável, fail-open). - Orderer async em combo/quotaStrategies.ts (reusa a maquinaria reset-aware de expansão de conexões + concorrência limitada; seam injetável). - Registrada como "headroom" em routingStrategies (combo-only); fill-first segue default — nenhuma estratégia existente tocada. - baseline file-size combo.ts 3168->3180 (só +12L de dispatch; lógica fora do god-file). 16 testes novos + combo-strategies 15/15 = 31/31; typecheck:core + eslint + file-size limpos. Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * feat(quota): cap per-(key,model) — quota_allocation_model_caps [Fase 3 #7] (#4927) * feat(quota): cap per-(key,model) com tabela quota_allocation_model_caps [Fase 3 #7] Fecha o buraco onde uma API key pode drenar o pool inteiro consumindo um único modelo. Tabela nova: quota_allocation_model_caps(pool_id, api_key_id, model, cap_value, cap_unit) PK composta (pool_id, api_key_id, model). cap_unit alinhado ao QuotaUnit existente. Comportamento: keyA acima do cap para modelo M → bloqueada somente em M; ainda permitida em qualquer outro modelo no mesmo pool. Cap <= EPSILON → ignorado (seed). Consumo por-(key,model) usa bucket segregado no quota_consumption existente (poolId mangled ':model:<model>') com window fixa 'hourly'; nenhuma nova tabela ou método de store necessário. Módulo novo: src/lib/db/quotaModelCaps.ts (getModelCap/setModelCap/deleteModelCap/listModelCaps) enforce.ts ganha o pre-check em enforceQuotaShare + recording em recordConsumption. EnforceInput e RecordConsumptionInput ganham model?: string (backward-compatible). localDb.ts re-exporta os 4 helpers (Hard Rule #2). TDD: tests/unit/quota-per-key-model.test.ts — 4 cenários (bloqueia em M, permite em M2, sem cap → sem bloqueio, EPSILON → ignorado). Todos os gates de qualidade passam. * feat(quota): plumba model resolvido no hot path para ativar o per-(key,model) cap [Fase 3 #7] A tabela/enforce do commit anterior estavam INERTES: o hot path não passava `model` ao enforce nem ao record, então nenhum model-cap disparava em produção. Plumbagem (model resolvido = mesma var usada no log/roteamento, pós background-redirect/alias): - chatCore.ts: enforceQuotaShare ganha `model`; scheduleQuotaShareConsumption recebe `model`. - chatCore/quotaShareConsumption.ts: threade `model` no RecordConsumptionInput (non-streaming). - spendRecorder.ts: recordStreamingConsumption já recebia `model` — agora o coloca no RecordConsumptionInput (streaming accrue por-modelo). - embeddings.ts: enforce + record ganham `model`. Namespace do cap = id do modelo RESOLVIDO (o mesmo de modelForScope/pendingScope/getUnsupportedParams), não o requestedModel cru nem o finalModelToUpstream (sem prefixo de provider). Operador configura o cap contra esse id. `model || undefined` em todos os pontos: vazio/null → check pulado (fail-safe, zero latência — só um campo no objeto). Teste de integração novo (tests/unit/quota-per-key-model-hotpath.test.ts): prova end-to-end que N consumos via scheduleQuotaShareConsumption({model}) → enforceQuotaShare({model}) bloqueia, e que outro modelo no mesmo pool ainda passa; + guard de que enforce SEM model nunca dispara model-cap. --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * feat(quota): session stickiness p/ integridade de prompt-cache [Fase 3 #5] (#4929) * feat(quota): session stickiness p/ integridade de prompt-cache [Fase 3 #5] Adiciona stickiness de sessão ao roteamento de combo: uma conversa multi-turno é roteada para a MESMA conexão enquanto ela permanecer saudável, evitando a perda do prompt-cache do provider (custo 5-10× sem stickiness, efeito conhecido no dario/clewdr). Implementação: - `open-sse/services/combo/sessionStickiness.ts` (novo, <800 linhas): mapa em memória (messageHash → connectionId) com TTL 15 min + cap 500 entradas; `applySessionStickiness` promove a conexão sticky ao índice 0 dos targets ordenados pelo strategy, guardado por `computeHeadroom > 0.15` (threshold); quando saturada (headroom ≤ 0.15), o binding é limpo e a seleção normal reage. Hash da sessão = SHA-256 dos primeiros chars da 1ª mensagem user → 16 hex chars. Seam de teste: `__setStickinessHeadroomFetcherForTests`. - `open-sse/services/combo.ts`: import + 2 pontos de integração (pré-eval-scores e pós-success), dentro do orçamento congelado de 3180 linhas. - `tests/unit/combo-session-stickiness.test.ts`: 19 testes node:test + assert/strict, todos via injeção de fetcher (zero rede/DB). Threshold 0.15: conexão a >85% de utilização está a um burst de rate-limit; o benefício de cache não compensa manter-se numa conexão degradada. Valor alinhado com a zona de soft-penalty do restante do engine de quota-share. * test(combo): isola combo-strategies da session stickiness (#5) selectedConnectionFor reusa o mesmo body, então o sticky map (#5) fixava a connection após a 1ª chamada e quebrava o round-robin tie-break do teste reset-aware. Limpa o sticky map no início da helper — a stickiness tem suíte própria (combo-session-stickiness). Sem enfraquecer asserts. --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * feat(quota): buckets multi-janela por conexão (5h/7d/per-model) [Fase 3 #3] (#4928) Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * refactor(providers): decompõe catálogo providers.ts em módulos de dados (godfile sweep, #3501) (#4917) Integrado em release/v3.8.36 (godfile sweep providers.ts, #3501) * refactor(pricing): decompõe pricing.ts em shared-tiers + DEFAULT_PRICING particionado (godfile sweep, #3501) (#4918) Integrado em release/v3.8.36 (godfile sweep pricing.ts, #3501) * refactor(api): extrai camada-folha pura de validation.ts (URL/headers/transport) (#4921) Integrado em release/v3.8.36 (validation.ts split fatia 1 — leaf layer) * refactor(api): extrai validators web-cookie + Meta AI de validation.ts (#4922) Integrado em release/v3.8.36 (validation.ts split fatia 2 — web-cookie + Meta AI) * refactor(api): extrai validators enterprise-cloud + probe compartilhado de validation.ts (#4923) Integrado em release/v3.8.36 (validation.ts split fatia 3 — enterprise-cloud + probe) * refactor(api): extrai validators áudio/speech + misc apikey de validation.ts (#4930) Integrado em release/v3.8.36 (validation.ts split fatia 4 — áudio/speech + misc apikey) * feat(quota): estratégia dedicada de quota-share (DRR + P2C in-flight + gating per-model) [Fase 3 #9] (#4939) * feat(quota): estratégia dedicada de quota-share (DRR + P2C in-flight + gating per-model) [Fase 3 #9] Estratégia interna "quota-share" isolada num módulo dedicado — NÃO toca a seleção/ fair-share genérica (decisão do dono: não mexer no que já funciona). Os combos qtSd/ (quotaCombos.ts) passam de fill-first para essa strategy; combo.ts ganha só 1 branch de dispatch que delega 100% ao módulo (nenhum case existente alterado). - quotaShareStrategy.ts: gating per-model (isBucketSaturated do #3) + DRR (quantum proporcional ao weight) + P2C sobre carga in-flight. - quotaShareInflight.ts: contador in-flight com TTL/lease de 120s — fallback do decrement-on-abort sem precisar instrumentar o combo genérico. - "quota-share" registrada como strategy INTERNA (não exposta na UI). - testes de síntese (quota-combo-balancing, quota-multiprovider) alinhados: a strategy esperada dos combos qtSd/ passa de "fill-first" para "quota-share" (alinhamento ao novo comportamento intencional, não mascaramento — os 73 testes de qtSd/ seguem verdes). * test(quota-share): alinha 2 scope-guards ao godfile sweep (base-reds que bloqueavam o CI) Dois testes de "arquivo contém X" quebraram por decomposições de godfile que outras sessões mergearam no release DURANTE a validação de #9 — NÃO são regressão de #9 (que não toca validation/oauth). Alinhados ao novo layout, asserts preservados: - proxy-bypass-scope-guard #3226: bypassProxyPatch foi extraído de validation.ts para validation/headers.ts (split #4921–#4930) → o teste lê a camada de validação. - sse-error-passthrough #3324: a windsurf authHint foi extraída de providers.ts para providers/oauth.ts → o teste lê o novo local. --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * refactor(api): extrai validators search + embedding/rerank de validation.ts (#4932) Integrated into release/v3.8.36 * refactor(api): extrai format-validators (OpenAI/Anthropic) de validation.ts (#4933) Integrated into release/v3.8.36 * refactor(db): extrai model-permission matching de db/apiKeys.ts (#4936) Integrated into release/v3.8.36 * refactor(db): extrai row-parsers + tipos compartilhados de db/apiKeys.ts (#4943) Integrated into release/v3.8.36 * refactor(db): extrai column-mapping (snake↔camel) de db/core.ts (#4947) Integrated into release/v3.8.36 * refactor(db): extrai schema-column reconciliation de db/core.ts (#4948) Integrated into release/v3.8.36 * refactor(sse): extrai scalar/format helpers de services/usage.ts (#4949) Integrated into release/v3.8.36 * refactor(sse): extrai quota-core (UsageQuota + builders) de services/usage.ts (#4950) Integrated into release/v3.8.36 * fix(translator): regroup parallel tool results adjacent to their assistant (#4714) (#4882) Integrated into release/v3.8.36 (fixes #4714) * fix(qoder): exchange PAT for jt-* job token before Cosy chat (#4683) (#4884) Integrated into release/v3.8.36 (fixes #4683) * refactor(sse): dedup fallback tool_call id helper (#4736) Integrated into release/v3.8.36 * refactor(open-sse): extract safeParseJSON util, dedup tryParseJSON (#4735) Integrated into release/v3.8.36 * fix(compression): eliminate ReDoS in math_inline preservation pattern (#4795) (#4838) Integrated into release/v3.8.36 (fixes #4795) * fix(combo): fetch models dynamically from custom provider endpoints (#4860) Integrated into release/v3.8.36 * feat(providers): update volcengine-ark model list with DeepSeek V4 (#4905) Integrated into release/v3.8.36 * fix(translator): provider thinking compatibility (DeepSeek/Gemini) (#4946) Integrated into release/v3.8.36 * feat(combo): task-aware routing strategy (#4945) Integrated into release/v3.8.36 * refactor(sse): extrai a família MiniMax de services/usage.ts (#4952) Integrated into release/v3.8.36 * refactor(sse): extrai a família GLM de services/usage.ts (#4953) Integrated into release/v3.8.36 * refactor(sse): extrai a família Antigravity de services/usage.ts (#4956) Integrated into release/v3.8.36 * fix(dashboard): show custom provider given-name instead of internal id across dashboard pages (#4603) (#4960) Integrated into release/v3.8.36 (fixes #4603) * fix(api): evict stale in-memory rate-limit windows to stop slow heap leak (#4041) (#4957) Integrated into release/v3.8.36 (fixes #4041) * fix(api): parse /v1/responses body once instead of 3-4x on the hot path (#4041) (#4958) Integrated into release/v3.8.36 (fixes #4041) * fix(translator): preserve legitimate empty-string tool arguments in openai-to-claude streaming (#4951) (#4959) Integrated into release/v3.8.36 (fixes #4951) * chore(quality): reconcile file-size baseline for #4960 provider-display-name (#4961) Integrated into release/v3.8.36 * fix(dashboard): restore home provider-topology card hidden by #4596 default (#4963) Integrated into release/v3.8.36 — restores home topology card (#4596 regression) * fix(build): drop @omniroute/open-sse from optimizePackageImports (build OOM) (#4968) Integrated into release/v3.8.36 — fixes build OOM (optimizePackageImports open-sse) * fix(quota): migração 107 ativa estratégia quota-share nos combos qtSd/ existentes [Fase 3 #9] (#4962) Integrated into release/v3.8.36 * feat(quota): respeita max_concurrent por conexão no roteamento (#4965) Integrated into release/v3.8.36 * feat(quota): combo quota-share espera cooldown curto e re-despacha (Variante A) (#4967) Integrated into release/v3.8.36 * fix(quality): resolve base-reds da release — db-rules allowlist + task-aware router precedence (#4973) Dois base-reds pré-existentes que reprovavam o CI da release v3.8.36 (Fast Quality Gates + Unit Tests fast-path), independentes de qualquer feature em voo: 1. check:db-rules / allowlist: os módulos db-internal caseMapping (#4947) e schemaColumns (#4948), extraídos de db/core.ts e importados só por ele, não estavam em INTENTIONALLY_INTERNAL. Registrados na allowlist (correção canônica — são internos legítimos, não re-exportados pelo localDb). 2. auto-strategy honra LKGP/cost (combo-routing-engine.test.ts, 2 testes): o task-aware reordering (#4945, reorderByTaskWeight) roda para strategy "auto" e era aplicado DEPOIS do router explícito (selectWithStrategy: lkgp/cost), sobrescrevendo o orderedTargets[0] que o operador escolheu. Instrumentação provou: post-filter [0]=claude (LKGP) → post-task [0]=gpt-oss. Correção: quando o auto usa router explícito, preserva o [0] dele e deixa o task-aware refinar só a cauda de fallback. gpt-oss-120b PERMANECE tool-capable (não é mudança de catálogo; o model-capabilities-registry test segue verde). Validado: 121 testes (combo-routing-engine + combo-task-aware + registry) verdes, red-check confirmado, db-rules/file-size/typecheck/lint/prettier OK. Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * feat(quota): serializa concorrência por conexão no caminho quota-share (FASE 2.1) (#4970) O gating de quota-share em selectQuotaShareTarget é fail-open: uma conexão at-cap só é despriorizada, nunca bloqueada. Com 1 conexão por conta de assinatura (caso comum), chamadas concorrentes ainda floodam a conta (→ 429 + cooldown) — provado live na .15: 3 chamadas concorrentes com max_concurrent=1 despacharam todas em 94ms. Adiciona um semáforo POR CONEXÃO em torno do dispatch quota-share: chamadas excedentes esperam na fila em vez de floodar (key qsconn:<connectionId>, cap = max_concurrent da conexão). Fail-open em fila saturada/timeout para nunca piorar disponibilidade. Gated por strategy===quota-share + kill-switch resilienceSettings.quotaShareConcurrencyLimit (default on; UI no ResilienceTab). Lógica extraível isolada no leaf puro combo/quotaShareConcurrency.ts (unit-testado: estabilidade da key, no-op sem cap, serialização real, fail-open). Settings + schema + UI espelham comboCooldownWait. Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * docs(resilience): document Quota-Share Concurrency Control (max_concurrent + serialization + cooldown-wait) (#4980) Documents the v3.8.36 quota-share concurrency layers in RESILIENCE_GUIDE.md: per-connection max_concurrent cap, the quota-share request serialization semaphore (FASE 2.1, qsconn:<connectionId>, fail-open, kill-switch), and the combo cooldown-aware retry — so operators know how to cap a subscription account's concurrency and why the routing gate alone cannot contain a single-connection flood. Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(dashboard): proxy-pool success gating, sync timestamp, opt-in Redis (#4878) (#4988) Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(sse): fail over on 400 responses carrying rate-limit text (#4976) (#4986) * fix(sse): fail over on 400 responses carrying rate-limit text (#4976) * chore(quality): rebaseline accountFallback.ts file-size for #4976 fix --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(compression): stop RTK over-truncating file-read tool results (#4559) (#4987) * fix(compression): stop RTK over-truncating file-read tool results (#4559) * chore(quality): trim #4559 comment to keep rtk/index.ts within size cap --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(sse): honor per-account proxies and fingerprint rotation in opencode executor (#4954) (#4989) * fix(sse): honor per-account proxies and fingerprint rotation in opencode executor (#4954) * chore(quality): rebaseline auth.ts file-size for #4954 (+39: synthetic no-auth providerSpecificData hydration of fingerprints/accountProxies; irreducible credential-path wiring, covered by opencode-proxy-rotation-4954.test.ts + 159 auth/noauth regression) --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(sse): soft-penalize exhausted providers in auto-combo scoring (#4540) (#4990) * fix(sse): soft-penalize exhausted providers in auto-combo scoring (#4540) * chore(quality): document STATUS_SOFT_DEPRIORITIZE_FACTOR + rebaseline combo.ts for #4540 --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(dashboard): switch to visible filter after auto-hiding failed models in test-all (#4887) (#4991) * fix(dashboard): switch to visible filter after auto-hiding failed models in OAuth provider test-all (#4887) * test(dashboard): move #4887 test into tests/unit/ui so a CI runner collects it --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(pollinations): only enable jsonMode when JSON output is requested (#3981) (#5009) Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(antigravity): default safetySettings to all-OFF for parity with native Gemini paths (#5003) (#5008) * fix(antigravity): default safetySettings to all-OFF for parity with native Gemini paths (#5003) * docs(changelog): restore #3981 pollinations entry eaten by merge --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * fix(chatgpt-web): map advertised gpt-5.5/5.4-pro/5.2-pro slugs to prevent silent model substitution (#4665) (#5010) * fix(chatgpt-web): map advertised gpt-5.5/5.4-pro/5.2-pro slugs to prevent silent model substitution (#4665) MODEL_MAP was missing the advertised catalog ids gpt-5.5, gpt-5.5-pro, gpt-5.4-pro and gpt-5.2-pro, so MODEL_MAP[model] ?? model sent the dot-form id verbatim to the ChatGPT backend-api, which silently rejected it and served the default Plus model. Map each to its dash-form slug. gpt-4-5 is already dash-form and falls through correctly, so it is intentionally left unmapped. Extends the executor MODEL_MAP test with the four ids and adds a drift guard asserting every advertised dot-form catalog id reaches the backend in dash-form (never verbatim), guarding future catalog<->map drift. file-size: tests/unit/chatgpt-web.test.ts frozen baseline 2809->2855 (+46) for the added test cases and drift-guard test; executor source unchanged in baseline. * docs(changelog): restore #3981/#5003 entries eaten by merge --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * feat(combos): add editable per-combo description field persisted via /api/combos (#5005) (#5011) * feat(combos): add editable per-combo description field persisted via /api/combos (#5005) * docs(changelog): restore #3981/#5003/#4665 entries eaten by merge --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> * Fix Ollama Cloud max reasoning effort (#4993) Integrated into release/v3.8.36 * fix(copilot): replace execSync with execFile to prevent command injection (#5024) Integrated into release/v3.8.36 * fix(plugin): auth.json dual-key fallback for auto-prefix migration (#5027) Integrated into release/v3.8.36 * feat(endpoint): per-endpoint custom system prompt injection (#5022) Integrated into release/v3.8.36 * fix(headroom): translate openai-responses input through OpenAI for compression (#5023) Integrated into release/v3.8.36 * docs(changelog): add entries for #4993, #5024, #5027 (release notes credit) * fix(api): stop /api/system/env/repair 500 on packaged install (#5006) (#5028) * fix(api): stop /api/system/env/repair 500 on packaged install — lazy createRequire in sync-env.mjs (#5006) scripts/dev/sync-env.mjs ran createRequire(import.meta.url) at module top-level. When webpack bundles it into the standalone env-repair route, import.meta.url is frozen to the build-machine path (file:///home/runner/...) and createRequire throws during module evaluation, so the whole route module fails to load and every GET returns HTTP 500 — breaking the onboarding wizard on packaged/global installs. - Move createRequire into the guarded better-sqlite3 block (only place that needs it); a bad import.meta.url now returns the safe default. - resolveRootDir() falls back to process.cwd() when fileURLToPath throws. - route.ts passes an explicit rootDir (process.cwd()) so the helper never derives the root from the frozen import.meta.url, matching the .env target used by createEnvBackup(). - Regression guard: assert sync-env.mjs has no top-level createRequire + getEnvSyncPlan(oauth) works with explicit rootDir without throwing. * docs(changelog): restore #4993/#5023/#5024/#5027 + custom-system-prompt/headroom entries eaten by release merge * chore(quality): rebaseline 3 inherited base-reds from release merge Files NOT touched by this PR — grew on release/v3.8.36 via --admin merges and inherited here through 'git merge origin/release': - open-sse/executors/base.ts 1414->1416 (#4993 Ollama Cloud max-effort) - src/lib/db/settings.ts 1149->1151 (#5023 custom system prompt) - src/app/(dashboard)/.../endpoint/EndpointPageClient.tsx 2570->2612 (custom system prompt UI) * chore(release): finalize v3.8.36 CHANGELOG + docs (2026-06-25) --------- Co-authored-by: Diego Rodrigues de Sa e Souza <souzamiriamrodrigues790@gmail.com> Co-authored-by: KooshaPari <42529354+KooshaPari@users.noreply.github.com> Co-authored-by: Makcim Ivanov <makcimbx@gmail.com> Co-authored-by: Chewji <126886556+Chewji9875@users.noreply.github.com> Co-authored-by: Anton <39598727+NomenAK@users.noreply.github.com> Co-authored-by: Demiurge The Single <megamen932@gmail.com> Co-authored-by: Randi <55005611+rdself@users.noreply.github.com> Co-authored-by: Éder Costa <eder.almeida.costa@gmail.com> Co-authored-by: Jefferson Felizardo <jeffer1312@gmail.com> Co-authored-by: Arthur Bodera <abodera@gmail.com> Co-authored-by: Hamsa_M <116961508+hamsa0x7@users.noreply.github.com> Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com>
195 KiB
title, version, lastUpdated
| title | version | lastUpdated |
|---|---|---|
| Environment Variables Reference | 3.8.31 | 2026-06-20 |
Environment Variables Reference
Complete reference for every environment variable recognized by OmniRoute. For a quick-start template, see
.env.example.
Important
Every variable documented here must also appear in
.env.example, and every variable in.env.examplemust appear here.npm run check:env-doc-syncenforces this on commit and in CI. To omit a variable on purpose, add it to the allowlist insidescripts/check/check-env-doc-sync.mjs.
Table of Contents
- 1. Required Secrets
- 2. Storage & Database
- 3. Network & Ports
- 4. Security & Authentication
- 5. Input Sanitization & PII Protection
- 6. Tool & Routing Policies
- 7. URLs & Cloud Sync
- 8. Outbound Proxy
- 9. CLI Tool Integration
- 10. Internal Agent & MCP Integrations
- 11. OAuth Provider Credentials
- 12. Provider User-Agent Overrides
- 13. CLI Fingerprint Compatibility
- 14. API Key Providers
- 15. Timeout Settings
- 16. Logging
- 17. Memory Optimization
- 18. Pricing Sync
- 19. Model Sync (Dev)
- 20. Provider-Specific Settings
- 21. Proxy Health
- 22. Debugging
- 23. GitHub Integration
- 24. Skills Sandbox (v3.8.0+)
- Deployment Scenarios
- Audit: Removed / Dead Variables
1. Required Secrets
These must be set before the first run. Without them, the application will either refuse to start or operate with insecure defaults.
| Variable | Required | Default | Source File | Description |
|---|---|---|---|---|
JWT_SECRET |
Yes | (none) | src/lib/auth |
Signs/verifies all dashboard session cookies (JWT). Generate with openssl rand -base64 48. |
API_KEY_SECRET |
Yes | (none) | src/lib/db/apiKeys.ts |
AES encryption key for API key values at rest in SQLite. Generate with openssl rand -hex 32. |
INITIAL_PASSWORD |
Yes | CHANGEME |
Bootstrap script | Sets the initial admin dashboard password (matches .env.example default — kept obviously insecure to force a change). Change before first use. After login, change via Dashboard → Settings → Security. |
OMNIROUTE_WS_BRIDGE_SECRET |
Yes (production) | (unset) | src/app/api/internal/codex-responses-ws/route.ts |
Shared secret for the internal Codex Responses WebSocket bridge. Authenticates bridge requests between the Electron/browser WS relay and OmniRoute. ⚠️ REQUIRED in production — when unset, all WS bridge requests are rejected. Generate with openssl rand -base64 32. |
OMNIROUTE_PEER_STAMP_TOKEN |
No (auto) | (auto per boot) | src/server/authz/policies/management.ts |
Per-process secret proving the trusted peer-IP stamp came from OmniRoute's own HTTP server (scripts/dev/peer-stamp.mjs). The authz middleware trusts request locality (loopback/LAN gating of LOCAL_ONLY routes) only when the stamp carries this token. Auto-generated each boot — leave unset; only pin it for multi-process setups that must share the stamp. |
Generation Commands
# Generate all four secrets at once:
echo "JWT_SECRET=$(openssl rand -base64 48)"
echo "API_KEY_SECRET=$(openssl rand -hex 32)"
echo "INITIAL_PASSWORD=$(openssl rand -base64 16)"
echo "OMNIROUTE_WS_BRIDGE_SECRET=$(openssl rand -base64 32)"
Caution
Never commit
.envfiles with real secrets to version control. The.gitignorealready excludes.env, but verify before pushing.
2. Storage & Database
OmniRoute uses SQLite (via better-sqlite3) for all persistence. These variables control data location, encryption, and lifecycle.
| Variable | Default | Source File | Description |
|---|---|---|---|
DATA_DIR |
~/.omniroute/ |
src/lib/db/core.ts |
Root directory for SQLite DB, backups, and data files. Override for Docker volumes or custom paths. |
STORAGE_ENCRYPTION_KEY |
(empty = disabled) | src/lib/db/encryption.ts |
AES key for full SQLite database encryption at rest. Generate with openssl rand -hex 32. |
STORAGE_ENCRYPTION_KEY_VERSION |
v1 |
scripts/build/bootstrap-env.mjs, electron/main.js |
Version label for the encryption key. Increment when performing key rotation to support decryption of old backups. |
DISABLE_SQLITE_AUTO_BACKUP |
false |
src/lib/db/backup.ts |
When true, skips the automatic database backup that runs before migrations on every startup. |
OMNIROUTE_CRYPT_KEY |
(unset) | src/lib/db/encryption.ts |
Legacy alias for STORAGE_ENCRYPTION_KEY. Accepted as a fallback when the primary variable is absent. |
OMNIROUTE_API_KEY_BASE64 |
(unset) | src/lib/db/encryption.ts |
Legacy alias (Base64-encoded form) accepted as a fallback. Decoded automatically before use. |
OMNIROUTE_DB_HEALTHCHECK_INTERVAL_MS |
(unset) | src/lib/db/core.ts |
Override the periodic SQLite healthcheck interval (ms). When unset, defaults are derived from NODE_ENV. |
OMNIROUTE_SKIP_DB_HEALTHCHECK |
0 |
src/lib/db/core.ts, src/lib/db/healthCheck.ts |
Set to 1 to skip the DB healthcheck entirely on startup. Useful for short-lived tasks and integration tests. |
OMNIROUTE_FORCE_DB_HEALTHCHECK |
0 |
src/lib/db/core.ts |
Set to 1 to force the DB healthcheck loop on, even when it would normally be skipped (e.g., short-lived tasks). |
OMNIROUTE_SKIP_POSTINSTALL |
0 |
scripts/postinstall.mjs |
Set to 1 to skip the native-runtime warm-up during npm install. Useful in CI/headless installs where sqlite is already built. |
OMNIROUTE_MIGRATIONS_DIR |
(auto-detect) | src/lib/db/migrationRunner.ts |
Override the directory that the migration runner scans. Useful when shipping bundled migrations in custom builds. |
OMNIROUTE_MAX_PENDING_MIGRATIONS |
50 |
src/lib/db/migrationRunner.ts |
Mass-pending-migrations safety threshold (#3416). Startup aborts if more than this many migrations are pending on an existing DB (guards against a wiped tracking table). Raise it to restore an older backup; set to 0 to disable the check. |
OMNIROUTE_SPEND_FLUSH_INTERVAL_MS |
(default in code) | src/lib/spend/batchWriter.ts |
Flush interval (ms) for the batched spend/cost writer. Lower values reduce write coalescing; higher values reduce DB contention. |
OMNIROUTE_SPEND_MAX_BUFFER_SIZE |
(default in code) | src/lib/spend/batchWriter.ts |
Max buffered spend entries before a forced flush. Raise on high-QPS deployments; lower when bounded memory matters more. |
OMNIROUTE_PROXY_FETCH_DEBUG |
(unset) | open-sse/utils/proxyFetch.ts |
Set to "true" to emit [ProxyFetch] debug logs on the Vercel relay path. Off by default to avoid leaking routing hints. |
BATCH_RETRY_DURATION_MS |
86400000 (24h) |
open-sse/services/batchProcessor.ts |
Maximum retry window for individual batch items (ms). Items exceeding this duration are marked failed. |
BATCH_BACKOFF_BASE_MS |
5000 |
open-sse/services/batchProcessor.ts |
Base delay (ms) for exponential backoff on batch item retries. |
BATCH_BACKOFF_MAX_MS |
3600000 (1h) |
open-sse/services/batchProcessor.ts |
Cap (ms) for exponential backoff between batch item retries. |
BATCH_MAX_CONCURRENT |
1 |
open-sse/services/batchProcessor.ts |
Maximum number of batches processed concurrently. Raise to increase throughput; keep low to avoid rate-limit storms. |
Scenarios
| Scenario | Configuration |
|---|---|
| Local development | Leave all defaults. DB lives at ~/.omniroute/omniroute.db. |
| Docker | DATA_DIR=/data + mount a volume at /data. |
| Encrypted at rest | Set STORAGE_ENCRYPTION_KEY + keep backups of the key! Losing it = losing data. |
| CI/Testing | DATA_DIR=/tmp/omniroute-test — ephemeral, no encryption needed. |
3. Network & Ports
| Variable | Default | Source File | Description |
|---|---|---|---|
PORT |
20128 |
src/lib/runtime/ports.ts |
Primary port for both Dashboard UI and API endpoints (single-port mode). |
API_PORT |
(unset) | src/lib/runtime/ports.ts |
When set, serves the /v1/* proxy API on this separate port. |
API_HOST |
0.0.0.0 |
src/lib/runtime/ports.ts |
Bind address for the API port. |
DASHBOARD_PORT |
(unset) | src/lib/runtime/ports.ts |
When set, serves the Dashboard UI on this separate port. |
PROD_DASHBOARD_PORT |
20130 |
docker-compose.prod.yml |
Host-side published port for the Dashboard in Docker production mode. |
PROD_API_PORT |
20131 |
docker-compose.prod.yml |
Host-side published port for the API in Docker production mode. |
OMNIROUTE_PORT |
(unset) | src/lib/runtime/ports.ts |
Takes precedence over PORT when running inside Electron or other wrappers. |
LIVE_WS_PORT |
20129 |
src/server/ws/liveServer.ts |
Port for the real-time WebSocket live monitoring server. |
LIVE_WS_HOST |
127.0.0.1 |
src/server/ws/liveServer.ts |
Bind address for the live WebSocket server. Set to 0.0.0.0 to expose on LAN (also configure LIVE_WS_ALLOWED_ORIGINS). |
LIVE_WS_ALLOWED_ORIGINS |
(unset) | src/server/ws/liveServer.ts |
Comma-separated extra origins allowed to open a live WebSocket. Loopback dashboard origins are already permitted by default. |
OMNIROUTE_ENABLE_LIVE_WS |
true |
src/server/ws/liveServer.ts |
Set to 0 or false to disable the real-time WebSocket server (enabled by default, loopback-bound). |
OMNIROUTE_DISABLE_LIVE_WS |
false |
scripts/start-ws-server.mjs |
CI/harness toggle that disables the standalone live WebSocket helper script. |
RELAY_IP_PER_MINUTE |
30 |
src/app/api/v1/relay/chat/completions/route.ts |
Per-(token, IP) relay rate limit, requests/minute. In-memory, per instance. 0 or negative disables the IP-dimension gate (per-token DB limit still applies). |
NODE_ENV |
production |
Next.js core | Controls logging verbosity, caching, error detail exposure, and Next.js optimizations. |
OMNIROUTE_USE_TURBOPACK |
1 (default in .env.example) |
package.json / Next.js 16 |
Toggles the Next.js 16 Turbopack bundler in npm run dev and npm run build. Set to 0 on Windows or when running into native binding incompatibilities. |
OMNIROUTE_SKIP_DB_HEALTHCHECK |
(unset) | src/lib/db/core.ts / src/lib/db/healthCheck.ts |
Set to 1 to skip the SQLite integrity health check on startup. Useful for faster boot on large databases. |
CREDENTIAL_HEALTH_CHECK_INTERVAL |
300000 |
open-sse/config/constants.ts / src/lib/credentialHealth/scheduler.ts |
Interval (ms) for the background credential health check scheduler. Minimum: 10000 (10s). |
CREDENTIAL_HEALTH_CACHE_TTL |
300000 |
open-sse/config/constants.ts / src/lib/credentialHealth/cache.ts |
TTL (ms) for cached credential health status. |
OMNIROUTE_DISABLE_CREDENTIAL_HEALTH_CHECK |
false |
src/lib/credentialHealth/scheduler.ts |
Set to 1 or true to disable background periodic testing of provider connections. |
HOST |
0.0.0.0 |
scripts/dev/run-next.mjs |
Bind address for the Next.js dev/start server. Overrides the default 0.0.0.0 when set. |
HOSTNAME |
127.0.0.1 |
scripts/dev/run-next-playwright.mjs |
Bind address used by the Playwright runner when launching Next.js. Defaults to 127.0.0.1 for hermetic tests. |
Port Modes
┌─────────────────────────── Single Port (default) ──────────────────────────┐
│ PORT=20128 │
│ → Dashboard: http://localhost:20128 │
│ → API: http://localhost:20128/v1/chat/completions │
└─────────────────────────────────────────────────────────────────────────────┘
┌─────────────────────────── Split Ports ─────────────────────────────────────┐
│ DASHBOARD_PORT=20128 │
│ API_PORT=20129 │
│ API_HOST=0.0.0.0 │
│ → Dashboard: http://localhost:20128 │
│ → API: http://0.0.0.0:20129/v1/chat/completions │
│ Use case: Expose API to LAN while restricting Dashboard to localhost. │
└─────────────────────────────────────────────────────────────────────────────┘
┌─────────────────────────── Docker Production ──────────────────────────────┐
│ PROD_DASHBOARD_PORT=443 PROD_API_PORT=8443 │
│ → Maps container ports to host ports in docker-compose.prod.yml. │
└─────────────────────────────────────────────────────────────────────────────┘
4. Security & Authentication
| Variable | Default | Source File | Description |
|---|---|---|---|
MACHINE_ID_SALT |
endpoint-proxy-salt |
src/lib/auth |
Salt combined with hardware identifiers for machine fingerprinting. Change per-deployment for isolation. |
OMNIROUTE_CLI_SALT |
omniroute-cli-auth-v1 |
src/lib/machineToken.ts |
HMAC salt for deriving the local CLI auth token. Changing this value rotates all CLI tokens on the machine. See docs/security/CLI_TOKEN.md. |
AUTH_COOKIE_SECURE |
false |
src/lib/auth |
Sets the Secure flag on session cookies. Must be true when running behind HTTPS. |
REQUIRE_API_KEY |
false |
API middleware | When true, all /v1/* proxy requests must include a valid API key. |
ALLOW_API_KEY_REVEAL |
false |
src/shared/constants/featureFlagDefinitions.ts |
Allows revealing full API key values in the Dashboard UI. Configurable from Dashboard Feature Flags; security risk on shared instances. |
NO_LOG_API_KEY_IDS |
(empty) | src/lib/compliance/index.ts |
Comma-separated API key IDs that bypass request logging (GDPR compliance). |
DEFAULT_RATE_LIMIT_PER_DAY |
1000 |
src/shared/utils/apiKeyPolicy.ts |
Fallback per-day request budget applied to API keys whose rate_limits column is null. Default (unset/empty/malformed) keeps the legacy 1000/day, 5000/week, 20000/month windows. Set explicitly to 0 to opt out (unlimited). Any positive integer N enables N/day, 5N/week, 20N/month. Zod-validated; invalid values log a warning and use the legacy default. |
MAX_BODY_SIZE_BYTES |
10485760 (10 MB) |
src/shared/middleware/bodySizeGuard.ts |
Maximum allowed request body size. Rejects payloads exceeding this limit. |
CORS_ORIGIN |
* |
Next.js middleware | CORS Access-Control-Allow-Origin value. Restrict for production. |
OUTBOUND_SSRF_GUARD_ENABLED |
true |
src/shared/network/outboundUrlGuard.ts |
Block provider calls targeting private/loopback/link-local IP ranges. Disable only in isolated test envs. |
OMNIROUTE_ALLOW_PRIVATE_PROVIDER_URLS |
false |
src/shared/network/outboundUrlGuard.ts |
Allow provider URLs pointing to private/local networks (localhost, 192.168.x.x, 10.x.x.x, etc.). REQUIRED for self-hosted providers (LM Studio, Ollama, vLLM, Llamafile, Triton, SearXNG). When false, the dashboard rejects validation of local URLs. |
Hardening Checklist
# Production security minimum:
AUTH_COOKIE_SECURE=true # Requires HTTPS
REQUIRE_API_KEY=true # Authenticate all proxy calls
ALLOW_API_KEY_REVEAL=false # Never expose keys in UI
CORS_ORIGIN=https://your.domain.com
MAX_BODY_SIZE_BYTES=5242880 # 5 MB limit
5. Input Sanitization & PII Protection
OmniRoute provides a two-layer defense: request-side injection scanning and response-side PII stripping.
Request-Side: Prompt Injection Guard
| Variable | Default | Source File | Description |
|---|---|---|---|
INPUT_SANITIZER_ENABLED |
false |
src/middleware/promptInjectionGuard.ts |
Enable scanning of incoming messages for prompt injection patterns. |
INPUT_SANITIZER_MODE |
warn |
src/middleware/promptInjectionGuard.ts |
warn = log only, block = reject request with 400, redact = strip suspicious patterns. |
INJECTION_GUARD_MODE |
(unset) | src/middleware/promptInjectionGuard.ts |
Legacy alias for INPUT_SANITIZER_MODE — same behavior. |
PII_REDACTION_ENABLED |
false |
src/middleware/promptInjectionGuard.ts |
Detect PII (emails, phones, SSNs) in incoming requests. |
Response-Side: PII Sanitizer
| Variable | Default | Source File | Description |
|---|---|---|---|
PII_RESPONSE_SANITIZATION |
false |
src/lib/piiSanitizer.ts |
Scan LLM responses for leaked PII before returning to client. |
PII_RESPONSE_SANITIZATION_MODE |
redact |
src/lib/piiSanitizer.ts |
redact = mask PII, warn = log only, block = drop entire response. |
VS Code Tokenized-Route Context Sanitizer
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_VSCODE_SANITIZE_CONTEXT |
1 |
src/app/api/v1/vscode/contextSanitizer.ts |
Strips implicit active-editor context (editorContext, activeEditor, currentFile, selection, openTabs…) from /v1/vscode/[token]/* requests and redacts content of explicitly-attached sensitive files. Secure-by-default; set to 0 to disable. |
Scenarios
| Scenario | Configuration |
|---|---|
| Enterprise compliance | INPUT_SANITIZER_ENABLED=true, INPUT_SANITIZER_MODE=block, PII_REDACTION_ENABLED=true, PII_RESPONSE_SANITIZATION=true |
| Monitoring only | INPUT_SANITIZER_ENABLED=true, INPUT_SANITIZER_MODE=warn — logs but never blocks |
| Personal use | Leave all disabled — zero overhead |
6. Tool & Routing Policies
| Variable | Default | Source File | Description |
|---|---|---|---|
TOOL_POLICY_MODE |
disabled |
src/lib/toolPolicy.ts |
Controls LLM tool/function-calling access. allowlist = only listed tools, denylist = all except listed, disabled = no restrictions. |
OMNIROUTE_PAYLOAD_RULES_PATH |
./config/payloadRules.json |
open-sse/services/payloadRules.ts |
Path to payload manipulation rules JSON file (per-model/protocol upstream tweaks). |
OMNIROUTE_PAYLOAD_RULES_RELOAD_MS |
5000 |
open-sse/services/payloadRules.ts |
Reload interval (ms) for hot-reloading the payload rules file. Minimum 1000. |
OMNIROUTE_PREFER_CLAUDE_CODE_FOR_UNPREFIXED_CLAUDE_MODELS |
false |
open-sse/services/model.ts |
Opt-in: route bare claude-* model IDs from Claude Code clients through the Claude Code OAuth account instead of requiring a provider prefix. Explicit provider prefixes still win. Also configurable via a dashboard toggle on the Claude provider page. |
7. URLs & Cloud Sync
| Variable | Default | Source File | Description |
|---|---|---|---|
BASE_URL |
http://localhost:20128 |
src/lib/cloudSync.ts |
Server-side URL for internal sync jobs to call /api/sync/cloud. |
CLOUD_URL |
(empty) | src/lib/cloudSync.ts |
Cloud relay endpoint URL (premium feature). |
CLOUD_SYNC_TIMEOUT_MS |
12000 |
src/lib/cloudSync.ts |
HTTP timeout for cloud sync requests. |
OMNIROUTE_BUILD_PROFILE |
full |
Webpack build config | Build-time profile (set to minimal to physically exclude privileged modules from bundle). |
OMNIROUTE_CLOUD_SYNC_SECRET |
(empty) | src/lib/cloudSync.ts |
Shared secret used to verify the HMAC-SHA256 signature of Cloud Sync responses. |
OMNIROUTE_CLOUD_SYNC_SECRETS |
false |
src/lib/cloudSync.ts |
Set to true to allow the Cloud Sync endpoint to overwrite local credentials. Default is false. |
OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP |
false |
src/app/api/providers/zed/import/route.ts |
Set to true to fall back to the v3.8.5 one-step "import everything" behavior without user confirmation. |
NEXT_PUBLIC_BASE_URL |
http://localhost:20128 |
OAuth, Dashboard, sync | Public-facing URL for OAuth redirect_uri, Dashboard links. Must match your public URL behind reverse proxy. |
NEXT_PUBLIC_CLOUD_URL |
(empty) | Client-side | Client-side mirror of CLOUD_URL. |
NEXT_PUBLIC_APP_URL |
(unset) | src/shared/services/cloudSyncScheduler.ts |
Legacy fallback for NEXT_PUBLIC_BASE_URL. |
OMNIROUTE_PUBLIC_BASE_URL |
(unset) | open-sse/executors/chatgpt-web.ts |
Browser-facing OmniRoute origin used for image URLs in API responses (e.g., /v1/chatgpt-web/image/<id>). Set this when OpenWebUI or another relay reaches OmniRoute by an internal URL but the user's browser must fetch images from a LAN, tunnel, or public origin. Do not include /v1. |
OMNIROUTE_CGPT_WEB_IMAGE_TIMEOUT_MS |
180000 (3 min) |
open-sse/executors/chatgpt-web.ts |
Max wait time for an async chatgpt-web image to land via the celsius WebSocket. Increase during upstream queue-deep windows. |
OMNIROUTE_CGPT_WEB_IMAGE_CACHE_MAX_MB |
256 |
open-sse/services/chatgptImageCache.ts |
Total in-memory byte budget (MB) for the chatgpt-web image cache serving /v1/chatgpt-web/image/<id>. Lower on memory-constrained hosts; raise if image generation is heavy and clients race the 30-minute TTL. |
THEOLDLLM_NAV_TIMEOUT_MS |
30000 (30s) |
open-sse/executors/theoldllm.ts |
Playwright navigation timeout (ms) for the browser-backed token capture used by the The Old LLM (theoldllm) free provider. Raise on slow networks if the relay page is slow to settle. |
KIE_CALLBACK_URL |
(unset) | open-sse/utils/kieTask.ts |
Public callback URL for asynchronous kie.ai jobs. Highest-priority override before OMNIROUTE_KIE_CALLBACK_URL and OMNIROUTE_PUBLIC_URL. |
OMNIROUTE_KIE_CALLBACK_URL |
(unset) | open-sse/utils/kieTask.ts |
Alternate spelling of KIE_CALLBACK_URL. Falls back when the primary variable is unset. |
OMNIROUTE_PUBLIC_URL |
(unset) | open-sse/utils/kieTask.ts |
Public origin used to compose async callback URLs. Lowest-priority fallback for kie.ai callbacks; also used as a generic public URL for other relays. |
OMNIROUTE_CROF_USAGE_URL |
https://crof.ai/usage_api/ |
open-sse/services/usage.ts |
CrofAI quota lookup endpoint used by the Usage page. Override for relays / test fixtures. |
OMNIROUTE_GEMINI_CLI_USAGE_URL |
https://cloudcode-pa.googleapis.com/v1internal:loadCodeAssist |
open-sse/services/usage.ts |
Gemini CLI quota lookup endpoint. Override for relays / test fixtures. |
OMNIROUTE_OPENCODE_QUOTA_URL |
https://opencode.ai/zen/go/v1/quota |
open-sse/services/opencodeQuotaFetcher.ts |
OpenCode (zen/go) quota lookup endpoint used by the Usage page. Override for relays / test fixtures. |
OMNIROUTE_OPENCODE_GO_QUOTA_URL |
https://api.z.ai/api/monitor/usage/quota/limit |
open-sse/services/usage.ts |
OpenCode Go quota lookup endpoint used by the Usage page. Override for relays / test fixtures. |
OMNIROUTE_OPENCODE_GO_DASHBOARD_URL |
https://opencode.ai/workspace |
open-sse/services/usage.ts |
OpenCode Go dashboard base URL used for quota scraping when a workspace ID and auth cookie are configured. Override for relays / test fixtures. |
OPENCODE_GO_WORKSPACE_ID |
(unset) | open-sse/services/usage.ts |
OpenCode Go workspace ID used for dashboard quota scraping. Prefer the per-connection Dashboard field when multiple accounts are configured. |
OMNIROUTE_OPENCODE_GO_WORKSPACE_ID |
(unset) | open-sse/services/usage.ts |
Alternate OpenCode Go workspace ID env var used before the shorter alias. Prefer the per-connection Dashboard field when multiple accounts are configured. |
OPENCODE_GO_AUTH_COOKIE |
(unset) | open-sse/services/usage.ts |
OpenCode Go auth cookie used for dashboard quota scraping. Sensitive; prefer the per-connection Dashboard field when multiple accounts are configured. |
OMNIROUTE_OPENCODE_GO_AUTH_COOKIE |
(unset) | open-sse/services/usage.ts |
Alternate OpenCode Go auth cookie env var used before the shorter alias. Sensitive; prefer the per-connection Dashboard field when multiple accounts are configured. |
OMNIROUTE_OLLAMA_CLOUD_USAGE_URL |
https://ollama.com/settings |
open-sse/services/usage.ts |
Ollama Cloud settings URL used for quota scraping. Override for relays / test fixtures. |
OLLAMA_USAGE_COOKIE |
(unset) | open-sse/services/usage.ts |
Ollama Cloud __Secure-session cookie used for settings-page quota scraping. Sensitive; prefer the per-connection Dashboard field when multiple accounts are configured. |
OLLAMA_CLOUD_USAGE_COOKIE |
(unset) | open-sse/services/usage.ts |
Alternate Ollama Cloud __Secure-session cookie env var. Sensitive; prefer the per-connection Dashboard field when multiple accounts are configured. |
OMNIROUTE_OLLAMA_USAGE_COOKIE |
(unset) | open-sse/services/usage.ts |
Alternate Ollama Cloud __Secure-session cookie env var used before the shorter aliases. Sensitive; prefer the per-connection Dashboard field when multiple accounts are configured. |
OMNIROUTE_CODEWHISPERER_BASE_URL |
https://codewhisperer.us-east-1.amazonaws.com |
open-sse/services/usage.ts |
CodeWhisperer (AWS Kiro) usage limits endpoint. Override for relays / test fixtures. |
Important
When deploying behind a reverse proxy (nginx, Caddy),
NEXT_PUBLIC_BASE_URLmust be set to your public URL (e.g.,https://omniroute.example.com). Without this, OAuth callbacks will fail because the redirect_uri won't match.
8. Outbound Proxy
Route upstream LLM provider calls through an HTTP or SOCKS5 proxy for egress control, geo-routing, or IP masking.
| Variable | Default | Source File | Description |
|---|---|---|---|
ENABLE_SOCKS5_PROXY |
true |
open-sse/executors |
Enable SOCKS5 proxy agent for upstream calls. Opt-out with false. |
NEXT_PUBLIC_ENABLE_SOCKS5_PROXY |
true |
Client-side | Client-side awareness of SOCKS5 availability. |
HTTP_PROXY |
(unset) | Node.js standard | HTTP proxy for upstream calls. |
HTTPS_PROXY |
(unset) | Node.js standard | HTTPS proxy for upstream calls. |
ALL_PROXY |
(unset) | Node.js standard | Universal proxy (supports socks5://). |
NO_PROXY |
(unset) | Node.js standard | Comma-separated hostnames/IPs to bypass the proxy. |
OMNIROUTE_PROXY_DISPATCHER_CONNECTIONS |
32 |
open-sse/utils/proxyDispatcher.ts |
Max concurrent sockets per cached HTTP/SOCKS proxy dispatcher. Long-lived SSE streams such as Codex /v1/responses need more than one connection when several requests share the same account-level proxy. Values above 256 are capped. |
PROXY_FAIL_OPEN |
false |
src/sse/handlers/chatHelpers.ts |
When false (default), a request whose assigned proxy fails to resolve is refused (fail-closed) rather than falling back to a direct connection — prevents real-IP leaks. Set true to restore the legacy DIRECT fallback. |
ENABLE_TLS_FINGERPRINT |
false |
open-sse/executors |
Spoof TLS fingerprint using wreq-js (mimics Chrome 124). Counters JA3/JA4 blocking. |
OMNIROUTE_TURNSTILE_IGNORE_TLS_ERRORS |
false |
open-sse/services/claudeTurnstileSolver.ts |
Allow the Claude Turnstile Playwright browser context to ignore HTTPS certificate errors. |
Scenarios
| Scenario | Configuration |
|---|---|
| SOCKS5 through SSH tunnel | ALL_PROXY=socks5://127.0.0.1:7890, ENABLE_SOCKS5_PROXY=true |
| Corporate HTTP proxy | HTTP_PROXY=http://proxy.corp.com:3128, HTTPS_PROXY=http://proxy.corp.com:3128, NO_PROXY=localhost,internal.corp.com |
| Anti-fingerprint | ENABLE_TLS_FINGERPRINT=true — requires wreq-js (included) |
| Egress-controlled / no direct access | Leave PROXY_FAIL_OPEN=false (default). Requests fail hard when the proxy is unavailable instead of leaking via direct. |
| Legacy / dev — allow direct fallback | PROXY_FAIL_OPEN=true. Restores pre-hardening behaviour: direct connection used when proxy resolution fails. |
Note (NVIDIA validation bypass — #3226): NVIDIA's API-key validation endpoint stalls when routed through the global proxy/TLS-patched fetch (undici dispatcher → 504).
src/lib/providers/validation.ts::directHttpsRequest()intentionally bypasses the proxy patch for that one validation call usingsafeOutboundFetch({ bypassProxyPatch: true }). This is a documented, scoped exception — it does not affect chat/usage egress. The bypass is scope-pinned bytests/unit/proxy-bypass-scope-guard-3226.test.ts.
9. CLI Tool Integration
Controls how OmniRoute discovers and launches CLI sidecars (Claude Code, Codex, etc.).
| Variable | Default | Source File | Description |
|---|---|---|---|
CLI_MODE |
auto |
src/shared/services/cliRuntime.ts |
auto = search system PATH; manual = use explicit paths only. |
CLI_EXTRA_PATHS |
(unset) | src/shared/services/cliRuntime.ts |
Additional PATH entries for CLI binary discovery (colon-separated). |
CLI_CONFIG_HOME |
(unset) | src/shared/services/cliRuntime.ts |
Override home directory for reading CLI configs (~/.claude, ~/.codex). |
CLI_ALLOW_CONFIG_WRITES |
false |
src/shared/services/cliRuntime.ts |
Allow OmniRoute to write CLI config files (token refresh, session data). |
CLI_CLAUDE_BIN |
claude |
src/shared/services/cliRuntime.ts |
Custom path to Claude CLI binary. |
CLI_CODEX_BIN |
codex |
src/shared/services/cliRuntime.ts |
Custom path to Codex CLI binary. |
CLI_DROID_BIN |
droid |
src/shared/services/cliRuntime.ts |
Custom path to Droid CLI binary. |
CLI_OPENCLAW_BIN |
openclaw |
src/shared/services/cliRuntime.ts |
Custom path to OpenClaw CLI binary. |
CLI_CURSOR_BIN |
agent |
src/shared/services/cliRuntime.ts |
Custom path to Cursor agent binary. |
CLI_CLINE_BIN |
cline |
src/shared/services/cliRuntime.ts |
Custom path to Cline CLI binary. |
CLI_CONTINUE_BIN |
cn |
src/shared/services/cliRuntime.ts |
Custom path to Continue CLI binary. |
CLI_QODER_BIN |
qoder |
src/shared/services/cliRuntime.ts |
Custom path to Qoder CLI binary. |
CLI_QWEN_BIN |
qwen |
src/shared/services/cliRuntime.ts |
Custom path to the Qwen Code CLI binary. |
CLI_DEVIN_BIN |
devin |
open-sse/executors/devin-cli.ts |
Custom path to the Devin CLI binary (v3.8.0). Used by the Windsurf/Devin executor. |
HERMES_HOME |
~/.hermes |
src/lib/cli-helper/config-generator/hermesHome.ts |
Hermes Agent home directory where OmniRoute reads/writes the Hermes CLI config. Matches the env var the Hermes PowerShell installer sets on Windows (%LOCALAPPDATA%\hermes). |
Docker Example
# Mount host binaries into the container and tell OmniRoute where they are:
CLI_EXTRA_PATHS=/host-cli/bin
CLI_CONFIG_HOME=/root
CLI_ALLOW_CONFIG_WRITES=true
CLI_CLAUDE_BIN=/host-cli/bin/claude
CLI Binary (omniroute) helpers
These variables tune the omniroute CLI binary's own behavior (not the sidecar
detection above).
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_LANG |
(system) | bin/cli/i18n.mjs |
Force CLI output language. BCP-47 locale (e.g. en, pt-BR). Overrides system locale env vars (LC_ALL, LC_MESSAGES). |
OMNIROUTE_SHOW_LOG |
(unset) | bin/cli/runtime/processSupervisor.mjs |
Set to 1 to forward server stdout/stderr to the terminal in supervised mode. Equivalent to --log flag on omniroute serve. |
OMNIROUTE_CLI_TOKEN |
(unset) | bin/cli/api.mjs |
Machine-auth token injected as x-omniroute-cli-token header. Auto-generated in task 8.12. |
OMNIROUTE_HTTP_TIMEOUT_MS |
30000 |
bin/cli/api.mjs |
Per-attempt HTTP timeout (ms) for CLI → server requests. |
OMNIROUTE_VERBOSE |
0 |
bin/cli/api.mjs |
Set to 1 to print retry/backoff diagnostics to stderr during CLI commands. |
OMNIROUTE_PLUGIN_PATH |
(unset) | bin/cli/plugins.mjs |
Custom directory for CLI plugin discovery (omniroute-cmd-* packages). Defaults to ~/.omniroute/plugins/ when unset. |
OMNIROUTE_PLUGINS_ALLOW_EXEC |
0 |
src/lib/plugins/pluginWorker.ts |
Set to 1 to allow plugins to request the exec permission (spawn child processes from the worker sandbox). Local operator only. |
10. Internal Agent & MCP Integrations
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_BASE_URL |
auto-detect | open-sse/mcp-server/server.ts |
Explicit URL for MCP/A2A tools to reach OmniRoute. Overrides localhost auto-detection. |
OMNIROUTE_API_KEY |
(unset) | MCP/A2A modules | API key for internal MCP tool and A2A skill calls. |
OMNIROUTE_API_KEY_ID |
(unset) | open-sse/mcp-server/audit.ts |
Key ID for MCP audit log attribution. |
ROUTER_API_KEY |
(unset) | Legacy | Legacy alias for OMNIROUTE_API_KEY. |
OMNIROUTE_CONTEXT |
(active context) | bin/cli/program.mjs, bin/cli/api.mjs |
CLI remote-mode context/profile for omniroute commands; overrides the active context in the local contexts store. Equivalent to --context <name>. |
OMNIROUTE_MCP_ENFORCE_SCOPES |
false |
open-sse/mcp-server/server.ts |
Enforce scope-based access control on MCP tool calls. |
OMNIROUTE_MCP_SCOPES |
(all) | open-sse/mcp-server/server.ts |
Comma-separated scopes: admin, combos, health, models, routing, budget, metrics, pricing, memory, skills. |
OMNIROUTE_MCP_COMPRESS_DESCRIPTIONS |
enabled | open-sse/mcp-server/descriptionCompressor.ts |
Compress MCP tool descriptions before serializing the manifest. Disable values: 0, false, off. |
OMNIROUTE_MCP_DESCRIPTION_COMPRESSION |
rtk |
open-sse/mcp-server/descriptionCompressor.ts |
Compression algorithm/profile. Disable values: 0, false, off. |
MODEL_SYNC_INTERVAL_HOURS |
24 |
src/shared/services/modelSyncScheduler.ts |
Model catalog sync interval in hours. |
PROVIDER_LIMITS_SYNC_INTERVAL_MINUTES |
70 |
src/server-init.ts |
Provider rate-limit and quota polling interval. |
PROVIDER_LIMITS_SYNC_SPACING_MS |
1500 |
src/lib/usage/providerLimits.ts |
Gap (ms) between consecutive OAuth quota fetches in a bulk sync; OAuth connections are fetched one at a time to avoid bursting an upstream. 0 opts out (concurrent). |
PROVIDER_LIMITS_POST_USAGE_REFRESH_DELAY_MS |
5000 |
src/lib/usage/providerLimits.ts |
Delay (ms) before refreshing provider limits after a real usage event, giving the upstream quota API time to register consumption. |
OMNIROUTE_DISABLE_BACKGROUND_SERVICES |
false |
src/instrumentation-node.ts |
Disable all background services (sync, pricing, model refresh). Useful for CI/test. |
OMNIROUTE_ENABLE_RUNTIME_BACKGROUND_TASKS |
(unset) | src/lib/config/runtimeSettings.ts |
Force background tasks on under automated test detection. Set 1 to override the test heuristic. |
OMNIROUTE_BUDGET_RESET_JOB_INTERVAL_MS |
600000 |
src/lib/jobs/budgetResetJob.ts |
Budget reset check cadence (ms). Floor 10000. |
OMNIROUTE_CONNECTION_RECOVERY_INTERVAL_MS |
60000 |
src/lib/quota/connectionRecovery.ts |
Proactive connection-cooldown recovery cadence (ms): re-validates connections whose transient rate_limited_until has elapsed, off the request hot path. Floor 5000. |
OMNIROUTE_DISABLE_CONNECTION_RECOVERY |
false |
src/lib/quota/connectionRecovery.ts |
Disable the proactive connection-cooldown recovery scheduler (lazy recovery in getProviderCredentials still applies). |
OMNIROUTE_REASONING_CACHE_CLEANUP_INTERVAL_MS |
1800000 |
src/lib/jobs/reasoningCacheCleanupJob.ts |
Reasoning cache cleanup cadence (ms). Floor 60000. |
OMNIROUTE_CONFIG_HOT_RELOAD_MS |
5000 |
src/lib/config/hotReload.ts |
Polling interval (ms) for config hot-reload. Lower than 1000 is rejected. |
OMNIROUTE_DISABLE_REDIS_AUTH_CACHE |
(enabled) | src/lib/db/apiKeys.ts |
Set 1 to bypass the Redis-backed API-key auth cache (forces DB reads). |
OMNIROUTE_RTK_TRUST_PROJECT_FILTERS |
0 |
open-sse/services/compression/engines/rtk/filterLoader.ts |
Trust user-managed RTK project filter rules without strict signature checks. |
OMNIROUTE_BOOTSTRAPPED |
false |
src/app/(dashboard)/dashboard/page.tsx |
Set true by bootstrap script after initial setup. Controls setup wizard visibility. |
OMNIROUTE_ALLOW_BODY_PROJECT_OVERRIDE |
0 |
open-sse/executors/antigravity.ts |
Escape hatch: allow request body to override the Antigravity project field. |
ANTIGRAVITY_CREDITS |
(unset) | open-sse/services/antigravityCredits.ts |
Override Antigravity's advertised remaining credits (testing / forced values). |
AGY_TOKEN_FILE |
~/.gemini/antigravity-cli/antigravity-oauth-token |
src/app/api/providers/agy-auth/apply-local/route.ts |
Override the Antigravity CLI (agy) token-file path for the auto-detect local login import. |
OAuth CLI Bridge (Internal)
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_SERVER |
auto-detect | src/lib/oauth/config/index.ts |
Server URL for CLI↔OmniRoute auth bridge. |
OMNIROUTE_TOKEN |
(unset) | src/lib/oauth/config/index.ts |
Auth token for CLI bridge. |
OMNIROUTE_USER_ID |
cli |
src/lib/oauth/config/index.ts |
User ID for CLI bridge sessions. |
SERVER_URL |
(unset) | src/lib/oauth/config/index.ts |
Legacy alias for OMNIROUTE_SERVER. |
CLI_TOKEN |
(unset) | src/lib/oauth/config/index.ts |
Legacy alias for OMNIROUTE_TOKEN. |
CLI_USER_ID |
(unset) | src/lib/oauth/config/index.ts |
Legacy alias for OMNIROUTE_USER_ID. |
11. OAuth Provider Credentials
Built-in credentials for localhost development. For remote deployments, register your own at each provider's developer console.
| Variable | Provider | Notes |
|---|---|---|
CLAUDE_OAUTH_CLIENT_ID |
Claude Code (Anthropic) | Public client — no secret needed. |
CLAUDE_CODE_REDIRECT_URI |
Claude Code | Override redirect URI. Default: https://platform.claude.com/oauth/code/callback |
CODEX_OAUTH_CLIENT_ID |
Codex / OpenAI | Public client. |
GEMINI_OAUTH_CLIENT_ID |
Gemini (Google) | Requires matching _SECRET. |
GEMINI_OAUTH_CLIENT_SECRET |
Gemini (Google) | — |
GEMINI_CLI_OAUTH_CLIENT_ID |
Gemini CLI | Usually same as Gemini. |
GEMINI_CLI_OAUTH_CLIENT_SECRET |
Gemini CLI | — |
QWEN_OAUTH_CLIENT_ID |
Qwen (Alibaba) | Public client. |
KIMI_CODING_OAUTH_CLIENT_ID |
Kimi Coding (Moonshot) | Public client. |
ANTIGRAVITY_OAUTH_CLIENT_ID |
Antigravity (Google) | Requires matching _SECRET. |
ANTIGRAVITY_OAUTH_CLIENT_SECRET |
Antigravity (Google) | — |
GITHUB_OAUTH_CLIENT_ID |
GitHub Copilot | Public client. |
WINDSURF_FIREBASE_API_KEY |
Windsurf / Devin (v3.8) | Public Firebase Web API key used by Windsurf's Secure Token Service to refresh short-lived browser-flow tokens. Client-side credential (not a secret). Long-lived import tokens skip this entirely. Source: extracted from Devin CLI binary. |
WINDSURF_API_KEY |
Windsurf / Devin (v3.8) | API key fallback used by open-sse/executors/devin-cli.ts when no per-connection credential is available. Optional. |
CLI_DEVIN_BIN |
Devin CLI (v3.8) | Custom path to the Devin CLI binary (devin). Resolved by open-sse/executors/devin-cli.ts. |
GITLAB_DUO_OAUTH_CLIENT_ID |
GitLab Duo (v3.8) | OAuth client ID for GitLab Duo. Register an app at https://gitlab.com/-/profile/applications with redirect URI <NEXT_PUBLIC_BASE_URL>/callback and scopes api, read_user, openid, profile, email. Falls back to GITLAB_OAUTH_CLIENT_ID. |
GITLAB_DUO_OAUTH_CLIENT_SECRET |
GitLab Duo (v3.8) | OAuth client secret for GitLab Duo. Optional — PKCE flow does not require a secret. Falls back to GITLAB_OAUTH_CLIENT_SECRET. |
GITLAB_DUO_BASE_URL |
GitLab Duo (v3.8) | Override GitLab base URL (self-hosted GitLab). Defaults to https://gitlab.com. Falls back to GITLAB_BASE_URL. |
GITLAB_BASE_URL |
GitLab Duo (v3.8) | Legacy fallback for GITLAB_DUO_BASE_URL. Used when the _DUO_ variant is unset. |
GITLAB_OAUTH_CLIENT_ID |
GitLab Duo (v3.8) | Legacy fallback for GITLAB_DUO_OAUTH_CLIENT_ID consumed by src/lib/oauth/constants/oauth.ts. |
GITLAB_OAUTH_CLIENT_SECRET |
GitLab Duo (v3.8) | Legacy fallback for GITLAB_DUO_OAUTH_CLIENT_SECRET consumed by src/lib/oauth/constants/oauth.ts. |
QODER_OAUTH_CLIENT_SECRET |
Qoder | — |
QODER_OAUTH_AUTHORIZE_URL |
Qoder | Set to enable Qoder OAuth. |
QODER_OAUTH_TOKEN_URL |
Qoder | — |
QODER_OAUTH_USERINFO_URL |
Qoder | — |
QODER_OAUTH_CLIENT_ID |
Qoder | — |
QODER_PERSONAL_ACCESS_TOKEN |
Qoder | Direct API key fallback (bypasses OAuth). |
QODER_CLI_WORKSPACE |
Qoder | Workspace ID for Qoder CLI. |
OMNIROUTE_QODER_WORKSPACE |
Qoder | Alias for QODER_CLI_WORKSPACE. |
BLACKBOX_WEB_VALIDATED_TOKEN |
Blackbox Web | Frontend tk token to send as validated on /api/chat. Required when Blackbox enforces token matching; otherwise OmniRoute falls back to a random UUID. See issue #2252. |
VISION_BRIDGE_BASE_URL |
Vision Bridge guardrail | OpenAI-compatible base URL for non-Anthropic vision-bridge calls. Defaults to the legacy OpenAI URL env or api.openai.com. Point at OmniRoute's /v1 self-loop or any OpenAI-compat endpoint (Gemini OpenAI-compat, OpenRouter). Issue #2232. |
VISION_BRIDGE_API_KEY |
Vision Bridge guardrail | API key for the URL above. Overrides per-provider OpenAI / Google env vars for non-Anthropic vision-bridge calls. Anthropic models keep their dedicated Anthropic key path. Issue #2232. |
Warning
Google OAuth (Antigravity, Gemini CLI) credentials only work on localhost. For remote servers:
- Go to Google Cloud Console → Credentials
- Create an OAuth 2.0 Client ID (type: "Web application")
- Add your server URL as Authorized redirect URI
- Replace the credential values in
.env.
12. Provider User-Agent Overrides
Override the User-Agent header sent to each upstream provider. This is dynamically resolved at runtime by the executor base class:
process.env[`${PROVIDER_ID}_USER_AGENT`]
Source:
open-sse/executors/base.ts→buildHeaders()
| Variable | Default Value | When to Update | |
|---|---|---|---|
CLAUDE_USER_AGENT |
claude-cli/2.1.145 (external, cli) |
When Anthropic releases a new CLI version | |
CLAUDE_DISABLE_TOOL_NAME_CLOAK |
false |
executors/base.ts + executors/cliproxyapi.ts |
Set to 1/true to forward third-party harness tool names verbatim to Anthropic on both Anthropic-bound paths (native OAuth and CLIProxyAPI). By default the executor deterministically aliases non-Claude-Code tool names (Claude Code canonical mapping where one exists, otherwise PascalCase) and reverses them on the response via _toolNameMap, so harnesses with snake_case tools are not refused as fingerprinted third-party clients. Debugging only. |
CODEX_USER_AGENT |
codex-cli/0.142.0 (Windows 10.0.26200; x64) |
When OpenAI updates the Codex CLI | |
CODEX_CLIENT_VERSION |
0.131.0 |
Override Codex client version independently of full UA string | |
GITHUB_USER_AGENT |
GitHubCopilotChat/0.45.1 |
When GitHub Copilot Chat updates | |
ANTIGRAVITY_USER_AGENT |
antigravity/2.0.1 darwin/arm64 |
When Antigravity IDE updates | |
KIRO_USER_AGENT |
AWS-SDK-JS/3.0.0 kiro-ide/1.0.0 |
When Kiro IDE updates | |
KIRO_OAUTH_CLIENT_ID |
kiro-cli |
Override the Kiro social device-code clientId (public id) |
|
KIRO_VERIFY_FULL_CRC |
false |
Opt-in: full per-frame message CRC validation on the Kiro event stream (debug corrupted streams) | |
QODER_USER_AGENT |
Qoder-Cli |
When Qoder CLI updates | |
QWEN_USER_AGENT |
QwenCode/0.15.9 (linux; x64) |
When Qwen Code updates | |
CURSOR_USER_AGENT |
Cursor/3.3 |
When Cursor updates | |
GEMINI_CLI_USER_AGENT |
google-api-nodejs-client/10.3.0 |
When Google API client updates |
Tip
You can add User-Agent overrides for any provider using the pattern
{PROVIDER_ID}_USER_AGENT. The executor dynamically constructs the env var name.
13. CLI Fingerprint Compatibility
When enabled, OmniRoute reorders HTTP headers and JSON body fields to match the exact signature of official CLI tools. This reduces the risk of account flagging while preserving your proxy IP.
Source: open-sse/config/cliFingerprints.ts, open-sse/executors/base.ts
Per-Provider
| Variable | Activation | Effect |
|---|---|---|
CLI_COMPAT_CODEX |
=1 |
Mimics Codex CLI request signature |
CLI_COMPAT_CLAUDE |
=1 |
Mimics Claude Code request signature |
CLI_COMPAT_GITHUB |
=1 |
Mimics GitHub Copilot request signature |
CLI_COMPAT_ANTIGRAVITY |
=1 |
Mimics Antigravity request signature |
CLI_COMPAT_CURSOR |
=1 |
Mimics Cursor request signature |
CLI_COMPAT_KIMI_CODING |
=1 |
Mimics Kimi Coding request signature |
CLI_COMPAT_KILOCODE |
=1 |
Mimics Kilo Code request signature |
CLI_COMPAT_CLINE |
=1 |
Mimics Cline request signature |
CLI_COMPAT_QWEN |
=1 |
Mimics Qwen Code request signature |
Global
| Variable | Activation | Effect |
|---|---|---|
CLI_COMPAT_ALL |
=1 |
Enable fingerprint compatibility for all providers at once. |
Kimi Coding CLI identity overrides
| Variable | Default | Source File | Description |
|---|---|---|---|
KIMI_CLI_VERSION |
1.36.0 |
src/lib/oauth/providers/kimi-coding.ts |
Override the Kimi CLI version sent during OAuth/API calls. |
KIMI_CODING_DEVICE_ID |
(captured default) | src/lib/oauth/providers/kimi-coding.ts |
Override the captured Kimi device ID used in client headers. |
Note
This feature works alongside the User-Agent overrides (§12). The fingerprint system handles header ordering and body field ordering, while User-Agent overrides handle the specific UA string. Both can be enabled independently.
14. API Key Providers
API keys for providers that use direct authentication. Preferred setup: Dashboard → Providers → Add API Key.
Setting via environment variables is an alternative for Docker or headless deployments.
Recognized pattern: {PROVIDER_ID}_API_KEY
| Variable | Provider |
|---|---|
DEEPSEEK_API_KEY |
DeepSeek |
NVIDIA_API_KEY |
NVIDIA NIM |
Note
Static
${PROVIDER}_API_KEYentries for Groq, xAI, Mistral, Perplexity, Together AI, Fireworks, Cerebras, Cohere, Nebius, and Qianfan were removed in v3.8.0 because the runtime no longer reads them — those providers rely exclusively on Dashboard /data/provider-credentials.json/ the encrypted DB. See the Audit: Removed / Dead Variables section at the bottom of this document for the migration path.
Tip
Keys set via the Dashboard are stored encrypted in SQLite and take precedence over environment variables.
15. Timeout Settings
All values are in milliseconds. Centralized resolution in src/shared/utils/runtimeTimeouts.ts.
Timeout Hierarchy
REQUEST_TIMEOUT_MS (global override)
├─→ FETCH_TIMEOUT_MS (upstream provider calls, default: 600000)
│ ├─→ FETCH_HEADERS_TIMEOUT_MS (inherits from FETCH_TIMEOUT_MS)
│ ├─→ FETCH_BODY_TIMEOUT_MS (inherits from FETCH_TIMEOUT_MS)
│ ├─→ TLS_CLIENT_TIMEOUT_MS (inherits from FETCH_TIMEOUT_MS)
│ ├── FETCH_CONNECT_TIMEOUT_MS (independent, default: 30000)
│ └── FETCH_KEEPALIVE_TIMEOUT_MS (independent, default: 4000)
├─→ STREAM_IDLE_TIMEOUT_MS (inherits from REQUEST_TIMEOUT_MS, default: 600000)
├─→ STREAM_READINESS_TIMEOUT_MS (inherits from REQUEST_TIMEOUT_MS, default: 80000)
└─→ API_BRIDGE_PROXY_TIMEOUT_MS (inherits from REQUEST_TIMEOUT_MS, default: 30000)
├─→ API_BRIDGE_SERVER_REQUEST_TIMEOUT_MS (derived, default: 300000)
├── API_BRIDGE_SERVER_HEADERS_TIMEOUT_MS (default: 60000)
├── API_BRIDGE_SERVER_KEEPALIVE_TIMEOUT_MS (default: 5000)
└── API_BRIDGE_SERVER_SOCKET_TIMEOUT_MS (default: 0 = disabled)
| Variable | Default | Description |
|---|---|---|
REQUEST_TIMEOUT_MS |
(unset) | Global shortcut — overrides both FETCH_TIMEOUT_MS and STREAM_IDLE_TIMEOUT_MS defaults. |
FETCH_TIMEOUT_MS |
600000 |
Total HTTP request timeout for upstream provider calls. |
STREAM_IDLE_TIMEOUT_MS |
600000 |
Max silence between SSE chunks before aborting. Extended-thinking models rarely pause >90s. |
STREAM_READINESS_TIMEOUT_MS |
80000 |
Time to receive the first non-ping SSE event. Inherits REQUEST_TIMEOUT_MS when set. |
OMNIROUTE_CODEX_DROP_NONSTANDARD_EVENTS |
(off) | Strip non-standard codex.* SSE events (e.g. codex.rate_limits) that break the OpenAI SDK's responses.stream() with a 502. Set true/1/yes to enable. |
FETCH_HEADERS_TIMEOUT_MS |
= FETCH_TIMEOUT_MS |
Time to receive response headers. |
FETCH_BODY_TIMEOUT_MS |
= FETCH_TIMEOUT_MS |
Time to receive the full response body. |
FETCH_CONNECT_TIMEOUT_MS |
30000 |
TCP connection establishment timeout. |
FETCH_KEEPALIVE_TIMEOUT_MS |
4000 |
Keep-alive socket idle timeout. |
TLS_CLIENT_TIMEOUT_MS |
= FETCH_TIMEOUT_MS |
TLS fingerprint proxy (wreq-js) timeout. |
API_BRIDGE_PROXY_TIMEOUT_MS |
30000 |
Proxy hop timeout for /v1 bridge requests. |
API_BRIDGE_SERVER_REQUEST_TIMEOUT_MS |
300000 |
Overall server request timeout for the bridge. |
API_BRIDGE_SERVER_HEADERS_TIMEOUT_MS |
60000 |
Time to send response headers via the bridge. |
API_BRIDGE_SERVER_KEEPALIVE_TIMEOUT_MS |
5000 |
Bridge keep-alive idle timeout. |
API_BRIDGE_SERVER_SOCKET_TIMEOUT_MS |
0 |
Raw socket timeout (0 = disabled). |
SHUTDOWN_TIMEOUT_MS |
30000 |
Grace period on SIGTERM/SIGINT before force-exit. |
OMNIROUTE_DEFAULT_FETCH_TIMEOUT_MS |
120000 |
Fallback used by src/shared/utils/fetchTimeout.ts when FETCH_TIMEOUT_MS is unset. |
OMNIROUTE_CHATGPT_TLS_TIMEOUT_MS |
60000 |
Wire-level timeout for the bogdanfinn/tls-client koffi binding (chatgptTlsClient.ts). |
OMNIROUTE_CHATGPT_TLS_GRACE_MS |
10000 |
JS-side grace added on top of the wire timeout when the native binding is wedged. |
OMNIROUTE_CLAUDE_TLS_TIMEOUT_MS |
60000 |
Wire-level timeout for the bogdanfinn/tls-client koffi binding (claudeTlsClient.ts). |
OMNIROUTE_CLAUDE_TLS_GRACE_MS |
10000 |
JS-side grace added on top of the wire timeout when the native binding is wedged. |
OMNIROUTE_PPLX_TLS_TIMEOUT_MS |
30000 |
Wire-level timeout for the bogdanfinn/tls-client koffi binding (perplexityTlsClient.ts). |
OMNIROUTE_PPLX_TLS_GRACE_MS |
10000 |
JS-side grace added on top of the wire timeout when the native binding is wedged. |
OMNIROUTE_GROK_TLS_TIMEOUT_MS |
60000 |
Wire-level timeout for the bogdanfinn/tls-client koffi binding (grokTlsClient.ts). |
OMNIROUTE_GROK_TLS_GRACE_MS |
10000 |
JS-side grace added on top of the wire timeout when the native binding is wedged. |
OMNIROUTE_BROWSER_POOL |
on |
Shared Playwright browser pool for browser-backed web-cookie chat (browserPool.ts); set off to disable. |
WEB_COOKIE_USE_BROWSER |
0 |
Opt a web-cookie chat request into the browser-backed path (browserBackedChat.ts); 1 to enable. |
Combo target attempts inherit the resolved upstream request timeout (FETCH_TIMEOUT_MS, or
REQUEST_TIMEOUT_MS when it supplies the fetch default). Set targetTimeoutMs in a combo,
combo defaults, or provider override only to make combo fallback faster; values above the
current upstream timeout are capped to the upstream timeout.
Circuit Breaker Thresholds
Provider-level circuit breaker tuning. Defaults reflect the scaled values used since v3.6 for 500+ connections.
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_CIRCUIT_BREAKER_OAUTH_THRESHOLD |
8 |
open-sse/config/constants.ts |
Consecutive failure threshold for OAuth providers before the breaker trips. |
OMNIROUTE_CIRCUIT_BREAKER_OAUTH_RESET_MS |
60000 |
open-sse/config/constants.ts |
Reset window (ms) for OAuth provider breaker. |
OMNIROUTE_CIRCUIT_BREAKER_API_KEY_THRESHOLD |
12 |
open-sse/config/constants.ts |
Consecutive failure threshold for API-key providers. |
OMNIROUTE_CIRCUIT_BREAKER_API_KEY_RESET_MS |
30000 |
open-sse/config/constants.ts |
Reset window (ms) for API-key provider breaker. |
OMNIROUTE_CIRCUIT_BREAKER_LOCAL_THRESHOLD |
2 |
open-sse/config/constants.ts |
Consecutive failure threshold for local providers (Ollama, LM Studio, ...). |
OMNIROUTE_CIRCUIT_BREAKER_LOCAL_RESET_MS |
15000 |
open-sse/config/constants.ts |
Reset window (ms) for local provider breaker. |
PIN_DROP_BACKOFF_LEVEL |
2 |
open-sse/services/combo.ts |
Backoff depth at which a context-cache pin's provider is deemed durably unhealthy and the pin is dropped for failover. |
PIN_DROP_GRACE_MS |
20000 |
open-sse/services/combo.ts |
Anti-flap window (ms) tolerating brief transient cooldowns before dropping a context-cache pin. |
Scenarios
| Scenario | Configuration |
|---|---|
| Long-running code generation | REQUEST_TIMEOUT_MS=900000 (15 min) |
| Fast-fail for production API | API_BRIDGE_PROXY_TIMEOUT_MS=10000 |
| Extended thinking models | STREAM_IDLE_TIMEOUT_MS=300000 (5 min between chunks) |
16. Logging
The logging system writes to both stdout and rotated log files. All configuration is read by src/lib/logEnv.ts.
| Variable | Default | Description |
|---|---|---|
APP_LOG_LEVEL |
info |
Minimum log level: debug, info, warn, error. |
APP_LOG_FORMAT |
text |
Output format: text (human-readable) or json (structured). |
APP_LOG_TO_FILE |
true |
Write logs to file alongside stdout. |
APP_LOG_FILE_PATH |
logs/application/app.log |
Log file path (relative to project root or DATA_DIR). |
APP_LOG_MAX_FILE_SIZE |
50M |
Max file size before rotation. Accepts: 50M, 1G, 512K, or plain bytes. |
APP_LOG_RETENTION_DAYS |
7 |
Days to keep rotated application log files. |
APP_LOG_MAX_FILES |
20 |
Maximum rotated log file backups. |
CALL_LOG_RETENTION_DAYS |
7 |
Days to keep request/call log entries in the database. |
CALL_LOG_MAX_ENTRIES |
10000 |
Max call log entries in the in-memory buffer. |
CALL_LOGS_TABLE_MAX_ROWS |
100000 |
Max rows in the call_logs SQLite table before pruning. |
MAX_PENDING_REQUEST_AGE_MS |
3600000 (1 hour) |
Max age for orphaned active request log entries before in-memory cleanup. |
CALL_LOG_PIPELINE_CAPTURE_STREAM_CHUNKS |
true |
Store stream chunks in pipeline artifacts when call_log_pipeline_enabled=true. |
CALL_LOG_PIPELINE_MAX_SIZE_KB |
512 |
Max pipeline call log artifact size in KB when call_log_pipeline_enabled=true. |
PROXY_LOGS_TABLE_MAX_ROWS |
100000 |
Max rows in the proxy_logs SQLite table before pruning. |
APP_LOG_ROTATION_CHECK_INTERVAL_MS |
60000 (1 min) |
How often src/lib/logRotation.ts re-checks the active log file size. |
CHAT_LOG_TEXT_LIMIT |
65536 |
Max string length retained in chat log artifacts (default 64 KB). |
CHAT_LOG_ARRAY_TAIL_ITEMS |
24 |
Number of array items retained from the tail when truncating chat log payloads. |
CHAT_LOG_MAX_DEPTH |
6 |
Max nesting depth before chat log payloads are truncated. |
CHAT_LOG_MAX_OBJECT_KEYS |
80 |
Max object keys retained in chat log payloads (0 = unlimited). |
CHAT_DEBUG_FILE |
false |
When true, serializeArtifactForStorage skips size-based truncation. Debug only. |
17. Memory Optimization
| Variable | Default | Description |
|---|---|---|
OMNIROUTE_MEMORY_MB |
512 |
Runtime V8 heap limit. Docker standalone and omniroute serve use it to set --max-old-space-size. |
PROMPT_CACHE_MAX_SIZE |
50 |
Max cached system prompt entries. |
PROMPT_CACHE_MAX_BYTES |
2097152 (2 MB) |
Max total prompt cache size. |
PROMPT_CACHE_TTL_MS |
300000 (5 min) |
Prompt cache entry TTL. |
SEMANTIC_CACHE_MAX_SIZE |
100 |
Max cached temperature=0 responses. |
SEMANTIC_CACHE_MAX_BYTES |
4194304 (4 MB) |
Max total semantic cache size. |
SEMANTIC_CACHE_TTL_MS |
1800000 (30 min) |
Semantic cache entry TTL. |
STREAM_HISTORY_MAX |
50 |
Max recent stream events in the Dashboard live view buffer. |
CONTEXT_LENGTH_DEFAULT |
128000 |
Global fallback max context length for models without explicit config. |
USAGE_TOKEN_BUFFER |
100 |
Extra token headroom reserved when tracking usage quotas. |
Compression
| Variable | Default | Description |
|---|---|---|
OMNIROUTE_RTK_TRUST_PROJECT_FILTERS |
unset | Trust project .rtk/filters.json without a .rtk/trust.json hash. Use only in controlled local development. |
Memory Engine (plan 21)
Embedding layer, vector store and reranking knobs for the persistent memory subsystem (src/lib/memory/).
| Variable | Default | Description |
|---|---|---|
MEMORY_EMBEDDING_CACHE_TTL_MS |
300000 (5 min) |
TTL for the in-memory embedding cache (per source/model/dim signature). |
MEMORY_EMBEDDING_CACHE_MAX |
1000 |
Max LRU entries kept in the embedding cache. |
MEMORY_TRANSFORMERS_MODEL |
Xenova/all-MiniLM-L6-v2 |
HF repo id for the opt-in @huggingface/transformers local MiniLM pipeline (~23 MB int8, ~400 MB RAM). |
MEMORY_STATIC_MODEL |
minishlab/potion-base-8M |
HF repo id for the static potion/Model2Vec lookup-table embedder. Downloaded lazily into the cache dir. |
MEMORY_STATIC_CACHE_DIR |
<DATA_DIR>/embeddings |
Directory used to cache the static potion model files. Defaults under DATA_DIR when unset. |
MEMORY_VEC_TOP_K |
20 |
Default top-K used by the sqlite-vec brute-force vector search inside src/lib/memory/vectorStore.ts. |
MEMORY_RRF_K |
60 |
Reciprocal Rank Fusion constant k for hybrid FTS5 + vector retrieval (sqlite-vec recipe). |
HF_HUB_ENDPOINT |
https://huggingface.co |
Override Hugging Face Hub base URL used by staticPotion.ts (e.g. mirror endpoint for air-gapped setups). |
Low-RAM Docker Example
OMNIROUTE_MEMORY_MB=128
PROMPT_CACHE_MAX_SIZE=20
PROMPT_CACHE_MAX_BYTES=524288 # 512 KB
SEMANTIC_CACHE_MAX_SIZE=25
SEMANTIC_CACHE_MAX_BYTES=1048576 # 1 MB
STREAM_HISTORY_MAX=10
18. Pricing Sync
Automatic model pricing data synchronization from external sources.
| Variable | Default | Source File | Description |
|---|---|---|---|
PRICING_SYNC_ENABLED |
false |
src/lib/pricingSync.ts |
Opt-in periodic pricing sync. |
PRICING_SYNC_INTERVAL |
86400 (24h) |
src/lib/pricingSync.ts |
Sync interval in seconds. |
PRICING_SYNC_SOURCES |
litellm |
src/lib/pricingSync.ts |
Comma-separated data sources. |
Arena ELO Sync
| Variable | Default | Source File | Description |
|---|---|---|---|
ARENA_ELO_SYNC_ENABLED |
true |
src/shared/constants/featureFlagDefinitions.ts |
Periodic Arena AI leaderboard ELO sync, configurable from Dashboard Feature Flags or with false to opt out. |
ARENA_ELO_SYNC_INTERVAL |
86400 (24h) |
src/lib/arenaEloSync.ts |
Sync interval in seconds. |
19. Model Sync (Dev)
| Variable | Default | Source File | Description |
|---|---|---|---|
MODELS_DEV_SYNC_INTERVAL |
86400 (24h) |
src/lib/modelsDevSync.ts |
Development-time model catalog sync interval in seconds. |
20. Provider-Specific Settings
| Variable | Default | Source File | Description |
|---|---|---|---|
OPENROUTER_CATALOG_TTL_MS |
86400000 (24h) |
src/lib/catalog/openrouterCatalog.ts |
OpenRouter model catalog cache TTL. |
MODEL_CATALOG_INCLUDE_NAMES |
true |
src/shared/constants/featureFlagDefinitions.ts |
Include display-friendly name fields in /v1/models responses. Disable for clients that expect IDs only. |
NANOBANANA_POLL_TIMEOUT_MS |
120000 |
open-sse/handlers/imageGeneration.ts |
Max wait for NanoBanana image generation jobs. |
NANOBANANA_POLL_INTERVAL_MS |
2500 |
open-sse/handlers/imageGeneration.ts |
NanoBanana job polling frequency. |
AWS_REGION |
(unset) | src/lib/providers/validation.ts, open-sse/handlers/audioSpeech.ts |
Region used to construct AWS Bedrock endpoints (Kiro, audio). |
AWS_DEFAULT_REGION |
(unset) | src/lib/providers/validation.ts, open-sse/handlers/audioSpeech.ts |
Fallback when AWS_REGION is not set. |
CLOUDFLARE_ACCOUNT_ID |
(unset) | open-sse/executors/cloudflare-ai.ts |
Account ID for Cloudflare Workers AI. |
CLOUDFLARE_API_BASE |
https://api.cloudflare.com/client/v4 |
src/app/api/settings/proxy/cloudflare-deploy/route.ts |
Override the Cloudflare REST API base used by the proxy-pool Workers relay deployer (#4640 / 9router#1360). |
NEXT_PUBLIC_CLOUDFLARE_RELAY_DEFAULT_PROJECT |
omniroute-relay |
src/app/(dashboard)/dashboard/settings/components/proxy/CloudflareRelayModal.tsx |
Default worker project name suggested in the proxy-pool "Deploy Relay" modal. |
NEXT_PUBLIC_CLOUDFLARE_RELAY_ENABLED |
true |
src/app/(dashboard)/dashboard/settings/components/proxy/ProxyPoolTab.tsx |
Set to false to hide the Cloudflare Workers relay option from the Proxy Pool tab. |
CLOUDFLARED_BIN |
auto-detect | src/lib/cloudflaredTunnel.ts |
Custom path to cloudflared binary. |
DENO_DEPLOY_API_BASE |
https://api.deno.com/v2 |
src/app/api/settings/proxy/deno-deploy/route.ts |
Override the Deno Deploy REST API base used by the proxy-pool relay deployer (#4643 / 9router#1437). |
NEXT_PUBLIC_DENO_RELAY_DEFAULT_PROJECT |
omniroute-deno-relay |
src/app/(dashboard)/dashboard/settings/components/proxy/DenoRelayModal.tsx |
Default Deno Deploy app name suggested in the proxy-pool "Deploy Relay" modal. |
NEXT_PUBLIC_DENO_RELAY_ENABLED |
true |
src/app/(dashboard)/dashboard/settings/components/proxy/ProxyPoolTab.tsx |
Set to false to hide the Deno Deploy relay option from the Proxy Pool tab. |
SEARCH_CACHE_TTL_MS |
300000 (5 min) |
open-sse/services/searchCache.ts |
TTL for search API (Perplexity, Brave, etc.) response caching. |
ALLOW_MULTI_CONNECTIONS_PER_COMPAT_NODE |
false |
src/app/api/providers/route.ts |
Allow multiple simultaneous connections per OpenAI-compatible provider. |
ENABLE_CC_COMPATIBLE_PROVIDER |
false |
src/shared/utils/featureFlags.ts |
Reveal the experimental CC-compatible provider UI for Claude Code-only relays. |
NINEROUTER_HOST |
127.0.0.1 |
open-sse/executors/ninerouter.ts |
Override the host where the embedded 9router instance listens. |
NINEROUTER_PORT |
20130 |
open-sse/executors/ninerouter.ts |
Override the port where the embedded 9router instance listens. |
EMBED_WS_PROXY_HOST |
127.0.0.1 |
src/lib/services/embedWsProxy.ts |
Bind host for the embedded-service WebSocket proxy (loopback only by default). |
EMBED_WS_PROXY_PORT |
20131 |
src/lib/services/embedWsProxy.ts |
Port for the embedded-service WebSocket proxy server. |
CLIPROXYAPI_HOST |
127.0.0.1 |
open-sse/executors/cliproxyapi.ts |
CLIProxyAPI bridge host (legacy integration). |
CLIPROXYAPI_PORT |
5544 |
open-sse/executors/cliproxyapi.ts |
CLIProxyAPI bridge port. |
CLIPROXYAPI_CONFIG_DIR |
~/.cli-proxy-api |
src/lib/versionManager/processManager.ts |
CLIProxyAPI config directory. |
LOCAL_HOSTNAMES |
(empty) | open-sse/config/providerRegistry.ts |
Comma-separated additional hostnames treated as "local" (Docker service names, etc.). |
ENABLE_CC_COMPATIBLE_PROVIDER is only for third-party relays that accept Claude Code clients
exclusively. OmniRoute rewrites requests so those relays accept them. If you only want to use
Claude Code CLI, or you are not sure what these relays are, keep this disabled and add a regular
Anthropic-compatible provider instead.
21. Proxy Health
| Variable | Default | Source File | Description |
|---|---|---|---|
PROXY_FAST_FAIL_TIMEOUT_MS |
2000 |
src/lib/proxyHealth.ts |
Fast-fail health check timeout. |
PROXY_HEALTH_CACHE_TTL_MS |
30000 |
src/lib/proxyHealth.ts |
Health check result cache TTL. |
OMNIROUTE_CONTROL_PLANE_PROXY_DIRECT_FALLBACK |
false |
src/shared/constants/featureFlagDefinitions.ts |
Allow OAuth and provider validation flows to bypass a pinned proxy and connect directly when proxy reachability pre-checks fail. Effective precedence is Feature Flags DB override > env var > default. |
RATE_LIMIT_MAX_WAIT_MS |
120000 (2 min) |
open-sse/services/rateLimitManager.ts |
Max time to wait on a 429 before failing the request. |
RATE_LIMIT_AUTO_ENABLE |
(unset) | open-sse/services/rateLimitManager.ts |
Force the auto-enable rate limit safety net on/off regardless of the persisted Dashboard setting. Accepts true/1/on to force on, false/0/off to force off. |
PROVIDER_COOLDOWN_ENABLED |
(unset → off) | open-sse/services/providerCooldownTracker.ts |
Opt-in global cross-request provider/connection cooldown tracking. OFF by default (overlaps Connection Cooldown / Provider Circuit Breaker). Accepts true/1/on to enable. |
PROVIDER_COOLDOWN_MIN_MS |
5000 |
open-sse/services/providerCooldownTracker.ts |
Minimum cooldown (ms) before a failed provider/connection is retried. Scaled exponentially with consecutive failures. Only used when PROVIDER_COOLDOWN_ENABLED. |
PROVIDER_COOLDOWN_MAX_MS |
300000 (5 min) |
open-sse/services/providerCooldownTracker.ts |
Maximum cooldown (ms) cap before a failed provider/connection is retried regardless. Only used when PROVIDER_COOLDOWN_ENABLED. |
STREAM_RECOVERY_ENABLED |
(unset → off) | src/lib/resilience/settings.ts (seed) → open-sse/services/streamRecovery.ts (logic) |
What: transparent recovery of truncated upstream streams (free-claude-code port). Holds the opening SSE window up to STREAM_RECOVERY.HOLDBACK_MS (750 ms) so a pre-commit cutoff — one that happens before any byte reaches the client — is re-opened and retried invisibly. When to enable: flaky/upstreams that frequently 0-byte-truncate at stream start; leave OFF if you cannot afford up to 750 ms of added time-to-first-token on every stream. Accepts true/1/on. Seeds the persisted Resilience setting; the Dashboard setting wins once set. |
STREAM_RECOVERY_MIDSTREAM_ENABLED |
(unset → off) | src/lib/resilience/settings.ts (seed) → open-sse/services/streamRecovery.ts (logic) |
What: mid-stream continuation (Fase 4.4) — after a post-commit truncation (bytes already reached the client), re-request with the partial text as an assistant prefill and stitch the missing suffix. Plain-text OpenAI-compatible streams only; never fires with a tool call in flight. When to enable: long generations that get cut mid-answer and you accept the recovered tail arriving as one burst rather than token-by-token. Independent of STREAM_RECOVERY_ENABLED (different risk profile). Accepts true/1/on. |
HEALTHCHECK_STAGGER_MS |
3000 |
src/lib/tokenHealthCheck.ts |
Stagger interval (ms) between provider token healthchecks at startup. |
REQUEST_RETRY |
2 |
src/sse/services/cooldownAwareRetry.ts |
Number of automatic retries on model-scoped cooldown responses before returning error to client. |
MAX_RETRY_INTERVAL_SEC |
30 |
src/sse/services/cooldownAwareRetry.ts |
Max backoff interval (seconds) between cooldown retries. Capped by this value regardless of upstream Retry-After. |
Stream-recovery tuning constants (not env vars)
The two STREAM_RECOVERY_* flags above are the only operator-facing toggles. The
recovery behavior is otherwise tuned by hardcoded constants in
open-sse/config/constants.ts (STREAM_RECOVERY), shown here for reference —
changing them requires a code edit, not an env var:
STREAM_RECOVERY.HOLDBACK_MS = 750— how long the opening SSE window is held so an early truncation can be retried before any byte is committed to the client.STREAM_RECOVERY.BUFFER_MAX_BYTES = 65536— hard cap on the held window; commit (flush + passthrough) as soon as this many bytes accumulate, regardless of the timer.STREAM_RECOVERY.EARLY_RETRY_MAX = 4— max transparent re-opens of the upstream stream while the holdback is still uncommitted.
Per-provider sliding-window rate limit (no env var): the FCC-ported per-provider sliding-window rate-limit fallback exists in code (
open-sse/services/providerDefaultRateLimit.ts, wired throughopen-sse/services/rateLimitManager.ts) but ships with an empty default map and has no operator env var today — it is enabled only via a test hook / code edit. It is intentionally not listed in the table above. The per-(token, IP)relay limiter that does have a knob isRELAY_IP_PER_MINUTE(§3 Network & Ports).
22. Debugging
Caution
These variables produce verbose output and may leak sensitive data. Never enable in production.
| Variable | Default | Source File | Description |
|---|---|---|---|
CURSOR_DEBUG |
(unset) | open-sse/executors/cursor.ts |
Set 1 to enable verbose Cursor executor logs (decoded SSE chunks, etc.). |
CURSOR_STREAM_DEBUG |
(unset) | open-sse/executors/cursor.ts |
Backward-compatible alias of CURSOR_DEBUG. |
CURSOR_DUMP_FILE |
(unset) | open-sse/executors/cursor.ts |
Optional file path that receives raw decoded Cursor chunks when CURSOR_DEBUG=1. |
CURSOR_STREAM_TIMEOUT_MS |
300000 |
open-sse/executors/cursor.ts |
Stream idle timeout (ms) for the Cursor executor. |
CURSOR_TOOL_DIRECTIVE |
enabled (!== "0") |
open-sse/executors/cursor.ts |
Tool-commit directive that makes composer-2.5 reliably issue tool calls. Set 0 to disable. |
CURSOR_IMAGE_FETCH_TIMEOUT_MS |
15000 |
open-sse/utils/cursorImages.ts |
Per-image fetch timeout (ms) for remote image_url vision input. |
CURSOR_STATE_DB_PATH |
(probed) | open-sse/utils/cursorVersionDetector.ts |
Override the Cursor state DB lookup used for version detection. |
CURSOR_TOKEN |
(unset) | scripts/ad-hoc/cursor-tap.cjs |
Direct Cursor bearer token used by developer tooling. |
OMNIROUTE_LOG_REQUEST_SHAPE |
enabled (!== "0") |
src/app/api/v1/chat/completions/route.ts |
Log content-type/length markers for large chat payloads. Set "0" to silence. |
DEBUG_RESPONSES_SSE_TO_JSON |
(unset) | open-sse/handlers/responseTranslator.ts |
Set true to log Responses API SSE→JSON translation details. |
NEXT_PUBLIC_OMNIROUTE_E2E_MODE |
(unset) | E2E test harness | Set true to enable E2E test mode (relaxed auth, test hooks). |
23. GitHub Integration
Allow users to report issues directly from the Dashboard.
| Variable | Default | Source File | Description |
|---|---|---|---|
GITHUB_ISSUES_REPO |
(unset) | src/app/api/v1/issues/report/route.ts |
Repository in owner/repo format. |
GITHUB_ISSUES_TOKEN |
(unset) | src/app/api/v1/issues/report/route.ts |
GitHub Personal Access Token with issues:write scope. |
GITHUB_TOKEN |
(unset) | issue triage / cloud agent helpers | Generic GitHub access token used as fallback for GITHUB_ISSUES_TOKEN and consumed by cloud agent helpers in src/lib/cloudAgent/*. |
Deployment Scenarios
Minimal Local Development
JWT_SECRET=$(openssl rand -base64 48)
API_KEY_SECRET=$(openssl rand -hex 32)
INITIAL_PASSWORD=dev123
PORT=20128
NODE_ENV=development
Docker Production
JWT_SECRET=<generated>
API_KEY_SECRET=<generated>
INITIAL_PASSWORD=<generated>
STORAGE_ENCRYPTION_KEY=<generated>
DATA_DIR=/data
PORT=20128
API_PORT=20129
NODE_ENV=production
AUTH_COOKIE_SECURE=true
REQUIRE_API_KEY=true
NEXT_PUBLIC_BASE_URL=https://omniroute.example.com
BASE_URL=http://localhost:20128
OMNIROUTE_MEMORY_MB=512
CORS_ORIGIN=https://your-frontend.example.com
Air-Gapped / CI
JWT_SECRET=test-jwt-secret-for-ci
API_KEY_SECRET=test-api-key-secret-for-ci
INITIAL_PASSWORD=testpass
NODE_ENV=production
OMNIROUTE_DISABLE_BACKGROUND_SERVICES=true
APP_LOG_TO_FILE=false
VPS with Reverse Proxy (nginx + Cloudflare)
JWT_SECRET=<generated>
API_KEY_SECRET=<generated>
STORAGE_ENCRYPTION_KEY=<generated>
PORT=20128
AUTH_COOKIE_SECURE=true
REQUIRE_API_KEY=true
NEXT_PUBLIC_BASE_URL=https://omniroute.example.com
BASE_URL=http://127.0.0.1:20128
CORS_ORIGIN=https://omniroute.example.com
ENABLE_TLS_FINGERPRINT=true
CLI_COMPAT_ALL=1
24. Skills Sandbox (v3.8.0+)
Limits and safety knobs applied when the Skills framework (src/lib/skills/) executes user-defined automations in a sandboxed environment.
| Variable | Default | Source File | Description |
|---|---|---|---|
SKILLS_SANDBOX_TIMEOUT_MS |
10000 (10 s) |
src/lib/skills/builtins.ts |
Per-execution wall-clock timeout for sandboxed skill code. Hard cap; anything longer is killed. |
SKILLS_EXECUTION_TIMEOUT_MS |
(falls back to SKILLS_SANDBOX_TIMEOUT_MS) |
src/lib/skills/ |
High-level skill orchestration timeout. Set higher than SKILLS_SANDBOX_TIMEOUT_MS to allow multi-step workflows. |
SKILLS_MAX_FILE_BYTES |
1048576 (1 MB) |
src/lib/skills/builtins.ts |
Max bytes a skill may read from any single sandboxed file. |
SKILLS_MAX_HTTP_RESPONSE_BYTES |
256000 (250 KB) |
src/lib/skills/builtins.ts |
Max bytes captured from any single HTTP response inside a skill. |
SKILLS_MAX_SANDBOX_OUTPUT_CHARS |
100000 |
src/lib/skills/builtins.ts |
Hard cap on stdout/stderr characters returned from a sandbox invocation. |
SKILLS_SANDBOX_NETWORK_ENABLED |
false |
src/lib/skills/builtins.ts |
Set 1/true to allow outbound network from inside the sandbox. Defaults to isolated for safety. |
SKILLS_ALLOWED_SANDBOX_IMAGES |
(empty) | src/lib/skills/builtins.ts |
Comma-separated allowlist of container images permitted for sandbox execution. Empty means built-in default only. |
SKILLS_SANDBOX_DOCKER_IMAGE |
(built-in default) | src/lib/skills/ |
Container image used when spawning a Docker-backed sandbox. Override to pin a custom hardened base image. |
Caution
Enabling
SKILLS_SANDBOX_NETWORK_ENABLED=trueopens an egress path from arbitrary skill code. Pair withOUTBOUND_SSRF_GUARD_ENABLED=trueand a strictCORS_ORIGIN/proxy policy in shared deployments.
25. Provider Quotas, Tunnels, Backups & Misc Runtime
Provider quota endpoints, network tunnels (Tailscale, Ngrok, MITM debug proxy), the 1Proxy egress pool, database backups and small per-feature overrides referenced by the executor layer or scripts.
| Variable | Default | Source File | Description |
|---|---|---|---|
REDIS_URL |
redis://localhost:6379 |
src/shared/utils/rateLimiter.ts |
Redis connection string for the rate limiter backend. |
ALIBABA_CODING_PLAN_HOST |
(production host) | open-sse/services/bailianQuotaFetcher.ts |
Override the host used to fetch Alibaba Bailian coding-plan quotas. |
ALIBABA_CODING_PLAN_QUOTA_URL |
derived from host | open-sse/services/bailianQuotaFetcher.ts |
Full quota URL override for Alibaba Bailian. |
CONTEXT_RESERVE_TOKENS |
1024 |
open-sse/services/contextManager.ts |
Tokens reserved for completion output when computing prompt budgets. |
MODEL_ALIAS_COMPAT_ENABLED |
enabled | open-sse/services/model.ts |
Toggle the legacy model-alias compatibility layer used by older clients. |
OMNIROUTE_EMERGENCY_FALLBACK |
enabled | open-sse/services/emergencyFallback.ts |
Set false (or 0) to disable the emergency budget-exhaustion fallback that reroutes failed requests to the free nvidia/openai/gpt-oss-120b model. Effective precedence is Feature Flags DB override > env var > default; if unavailable, the service falls back to the raw env value. |
COMMAND_CODE_CALLBACK_PORT |
(unset) | src/app/api/providers/command-code/auth/shared.ts |
Local port used for OAuth-style callbacks from the Command Code CLI helper. |
COMMAND_CODE_VERSION |
0.33.2 |
open-sse/executors/commandCode.ts |
Value sent as the x-command-code-version header to the Command Code upstream. Override to bump the CLI version. |
MITM_LOCAL_PORT |
443 |
src/mitm/server.cjs |
Local bind port for the MITM debug proxy. |
MITM_DISABLE_TLS_VERIFY |
0 |
src/mitm/server.cjs |
Set 1 to disable upstream TLS verification (development only). |
MITM_IDLE_TIMEOUT_MS |
60000 |
src/mitm/socketTimeouts.ts, src/mitm/server.cjs |
Idle socket timeout (ms) for proxied connections; idle sockets past this are torn down to avoid leaking half-open tunnels. |
MITM_VERBOSE |
1 |
src/mitm/server.cjs, src/mitm/_internal/bypass.cjs |
Routing-decision log verbosity: 0 silences, higher values log more bypass/route decisions. |
ONEPROXY_ENABLED |
true |
src/lib/oneproxySync.ts |
Enable the 1Proxy egress pool sync. |
ONEPROXY_API_URL |
https://1proxy-api.aitradepulse.com |
src/lib/oneproxySync.ts |
1Proxy service API URL override. |
ONEPROXY_MAX_PROXIES |
500 |
src/lib/oneproxySync.ts |
Maximum proxies imported per sync. |
ONEPROXY_MIN_QUALITY_THRESHOLD |
50 |
src/lib/oneproxySync.ts |
Minimum quality score for imported proxies. |
FREE_PROXY_1PROXY_ENABLED |
true |
src/lib/freeProxyProviders/oneproxy.ts |
Enable the 1proxy free proxy source. Set to false to disable. |
FREE_PROXY_1PROXY_API_URL |
(see oneproxy.ts) | src/lib/freeProxyProviders/oneproxy.ts |
1proxy API URL override. |
FREE_PROXY_1PROXY_MAX |
500 |
src/lib/freeProxyProviders/oneproxy.ts |
Maximum proxies fetched per sync from 1proxy. |
FREE_PROXY_1PROXY_MIN_QUALITY |
50 |
src/lib/freeProxyProviders/oneproxy.ts |
Minimum quality score threshold for 1proxy imports. |
FREE_PROXY_PROXIFLY_ENABLED |
true |
src/lib/freeProxyProviders/proxifly.ts |
Enable the Proxifly free proxy source. Set to false to disable. |
FREE_PROXY_PROXIFLY_QUANTITY |
100 |
src/lib/freeProxyProviders/proxifly.ts |
Number of proxies to fetch per Proxifly sync. |
FREE_PROXY_PROXIFLY_ANONYMITY |
elite |
src/lib/freeProxyProviders/proxifly.ts |
Anonymity level filter for Proxifly (elite, anonymous, transparent). |
FREE_PROXY_IPLOCATE_ENABLED |
false |
src/lib/freeProxyProviders/iplocate.ts |
Enable the IPLocate free proxy source. Opt-in only. |
FREE_PROXY_IPLOCATE_BASE_URL |
https://raw.githubusercontent.com/iplocate/free-proxy-list/main/protocols |
src/lib/freeProxyProviders/iplocate.ts |
IPLocate proxy list base URL override. |
NEXT_PUBLIC_VERCEL_RELAY_ENABLED |
true |
src/app/(dashboard)/…/ProxyPoolTab.tsx |
Show/hide the Deploy Vercel Relay button in the Proxy Pool tab. |
VERCEL_API_BASE |
https://api.vercel.com |
src/app/api/settings/proxy/vercel-deploy/route.ts |
Vercel API base URL override (for testing). |
NEXT_PUBLIC_VERCEL_RELAY_DEFAULT_PROJECT |
omniroute-relay |
src/app/(dashboard)/…/VercelRelayModal.tsx |
Default project name pre-filled in the Vercel Relay deploy modal. |
TAILSCALE_BIN |
(auto-detect) | src/lib/tailscaleTunnel.ts |
Explicit path to the tailscale binary. |
TAILSCALED_BIN |
(auto-detect) | src/lib/tailscaleTunnel.ts |
Explicit path to the tailscaled daemon binary. |
TAILSCALE_AUTHKEY |
(unset) | src/lib/tailscaleTunnel.ts |
Pre-shared Tailscale auth key for non-interactive / headless tailscale up (passed via --auth-key=). When unset, login falls back to the interactive browser auth URL. |
NGROK_AUTHTOKEN |
(unset) | src/lib/ngrokTunnel.ts |
Authenticates outbound ngrok tunnels. |
DB_BACKUP_MAX_FILES |
20 |
src/lib/db/backup.ts |
Maximum SQLite backup files retained on disk. Overrides the value saved from Settings → Database backup retention. |
DB_BACKUP_RETENTION_DAYS |
0 |
src/lib/db/backup.ts |
Maximum age (days) of retained backups. 0 disables age-based pruning. Overrides the value saved from Settings → Database backup retention. |
OMNIROUTE_TLS_PROXY_URL |
(unset) | open-sse/services/chatgptTlsClient.ts |
Override the TLS sidecar URL for tests. Production should leave unset. |
CONTAINER_HOST |
docker |
scripts/check-permissions.sh |
Container runtime hint for the entrypoint permission check. Set to podman under rootless Podman so the fix instructions use podman unshare chown instead of sudo chown. |
QUOTA_STORE_DRIVER |
sqlite |
src/lib/quota/storeFactory.ts |
Quota-share consumption store backend: sqlite (default) or redis. |
QUOTA_STORE_REDIS_URL |
(unset) | src/lib/quota/storeFactory.ts |
Redis connection string used when QUOTA_STORE_DRIVER=redis (e.g. redis://localhost:6379). |
QUOTA_SATURATION_THRESHOLD |
0.5 |
src/lib/quota/enforce.ts |
Pool saturation ratio (0..1); at/above it the pool enters strict mode (no borrowing). |
QUOTA_SOFT_DEPRIORITIZE_FACTOR |
0.7 |
open-sse/services/combo.ts |
Score multiplier (0..1) applied to a target when the soft quota policy deprioritizes it. |
STATUS_SOFT_DEPRIORITIZE_FACTOR |
0.5 |
open-sse/services/combo/autoStrategy.ts |
Score multiplier (0..1) applied to an exhausted provider (credits_exhausted/rate_limited) in auto-combo scoring when the preflight quota cutoff is OFF (#4540). |
QUOTA_CONSUMPTION_RETENTION_DAYS |
14 |
src/lib/db/quotaConsumption.ts |
Retention window (days) for quota_consumption buckets before GC (gcQuotaConsumption). |
QUOTA_PREFLIGHT_CUTOFF_ENABLED |
false |
src/lib/resilience/settings.ts |
Opt-in (default OFF): enables the auto-routing hard quota cutoff that drops low-quota candidates before scoring. |
OMNIROUTE_AUTO_FREE_FALLBACK_TO_FULL_POOL |
false |
open-sse/services/autoCombo/virtualFactory.ts |
Opt-in (default OFF): when an auto/<category>:<tier> filter matches no connected candidates, restore the legacy behavior of falling back to the full (unfiltered) pool instead of returning an empty pool. Default OFF makes :free mean "free tier only". |
AGENTBRIDGE_UPSTREAM_CA_CERT |
(unset) | src/mitm/manager.ts |
Extra CA certificate (PEM) trusted for AgentBridge upstream TLS connections. |
INSPECTOR_BUFFER_SIZE |
1000 |
src/mitm/inspector/buffer.ts |
Max captured requests held in the Traffic Inspector ring buffer. |
INSPECTOR_MAX_BODY_KB |
1024 |
src/mitm/inspector/buffer.ts |
Max captured request/response body size (KB) before truncation. |
INSPECTOR_HTTP_PROXY_PORT |
8080 |
src/mitm/inspector/httpProxyServer.ts |
Local port for the Traffic Inspector HTTP proxy. |
INSPECTOR_HTTP_PROXY_AUTOSTART |
false |
src/mitm/inspector/httpProxyServer.ts |
Auto-start the inspector HTTP proxy on boot. |
INSPECTOR_TLS_INTERCEPT |
false |
src/lib/inspector/captureState.ts |
Enable TLS interception (MITM) for captured HTTPS traffic. |
INSPECTOR_LLM_HOSTS_EXTRA |
(unset) | src/lib/inspector/captureState.ts |
Extra hostnames (comma-separated) treated as LLM endpoints for capture. |
INSPECTOR_MASK_SECRETS |
true |
src/mitm/inspector/buffer.ts |
Mask secrets (auth headers / API keys) in captured traffic. |
INSPECTOR_SYSTEM_PROXY_GUARD_MINUTES |
30 |
src/app/api/tools/traffic-inspector/capture-modes/system-proxy/route.ts |
Minutes before the system-proxy guard auto-reverts OS proxy settings. |
INSPECTOR_INTERNAL_INGEST_TOKEN |
(auto) | src/app/api/tools/traffic-inspector/internal/ingest/route.ts |
Token authenticating internal capture ingest into the inspector. |
PLAYGROUND_COMPARE_MAX_COLUMNS |
4 |
src/app/(dashboard)/dashboard/playground/ |
Max number of side-by-side columns in the Playground compare mode. |
PLAYGROUND_IMPROVE_PROMPT_DEFAULT_MODEL |
(unset) | src/app/(dashboard)/dashboard/playground/ |
Default model for the Playground 'improve prompt' action (falls back to the active model when unset). |
BIFROST_ENABLED |
1 |
src/app/api/v1/relay/chat/completions/bifrost/route.ts |
Master kill switch for the bifrost sidecar proxy. When set to 0, the route returns 503 with the X-Bifrost-Killswitch header and the operator is bounced to the TS path. Use to disable the sidecar without redeploying (tier-1 router incident, key rotation). |
BIFROST_BASE_URL |
(unset) | src/app/api/v1/relay/chat/completions/bifrost/route.ts |
When set, the Bifrost sidecar proxy route forwards /v1/chat/completions traffic to this Go gateway instead of the TS relay handler. Unset → 503-with-fallback. Trailing slash is stripped. |
BIFROST_API_KEY |
(unset) | src/app/api/v1/relay/chat/completions/bifrost/route.ts |
API key for the Bifrost gateway (sent as Authorization: Bearer ...). If unset, the route expects the request to carry a valid OmniRoute API key; this key is for gateway-side auth only. |
BIFROST_STREAMING_ENABLED |
true |
src/app/api/v1/relay/chat/completions/bifrost/route.ts |
When true, the Bifrost sidecar route streams responses back via SSE through the gateway rather than the TS streaming executor. Set to 0 to force non-streaming JSON responses through the gateway. |
BIFROST_TIMEOUT_MS |
30000 |
src/app/api/v1/relay/chat/completions/bifrost/route.ts |
Per-request timeout when proxying to the Bifrost gateway (ms). On timeout the route returns the TS relay path via the X-Bifrost-Fallback header. |
OMNIROUTE_BIFROST_KEY |
(unset) | src/app/api/v1/relay/chat/completions/bifrost/route.ts |
Alias for BIFROST_API_KEY (used by scripts that read the env via OMNIROUTE_*). Falls back to BIFROST_API_KEY when unset. |
OMNIROUTE_LOCAL_ENDPOINTS_ENABLED |
0 |
src/lib/security/localEndpoints.ts |
Master switch for /api/local/* routes. When unset or 0, all /api/local/* routes return 503 in production. Must be 1 in non-loopback deploys to enable the Redis launcher and similar 1-click local service starters. Belt-and-suspenders with isLocalOnlyPath() route-guard classification (LOCAL_ONLY_API_PREFIXES in src/server/authz/routeGuard.ts). |
OMNIROUTE_LOCAL_ENDPOINTS_TOKEN |
(unset) | src/lib/security/localEndpoints.ts |
Bearer token for /api/local/* callers that aren't on loopback (e.g. the desktop app). When set, requests from non-loopback IPs must carry Authorization: Bearer <token>. Required when OMNIROUTE_LOCAL_ENDPOINTS_ENABLED=1 in non-loopback deployments. |
OMNIROUTE_REDIS_CONTAINER_NAME |
omniroute-redis |
bin/cli/commands/redis.mjs |
Container name for the 1-click Redis launcher (omniroute redis up). Used by both the CLI and the RedisLauncherPanel GUI. |
OMNIROUTE_REDIS_HOST_PORT |
6379 |
bin/cli/commands/redis.mjs |
Host port for the 1-click Redis launcher. Bump if the host already binds 6379. The container's internal port stays 6379. |
OMNIROUTE_REDIS_IMAGE |
redis:7-alpine |
bin/cli/commands/redis.mjs |
Redis image used by the 1-click Redis launcher. Override to redis:8-alpine or a private registry mirror as needed. |
QDRANT_HOST |
qdrant |
(opt-in cluster profile) | Hostname of the Qdrant sidecar when --profile memory is active. Default points to the in-network qdrant service name; override for an external deployment. Only consumed when qdrantEnabled is true in code (src/lib/memory/vectorStore.ts:108). |
QDRANT_PORT |
6333 |
(opt-in cluster profile) | REST port of the Qdrant sidecar. |
QDRANT_GRPC_PORT |
6334 |
(opt-in cluster profile) | gRPC port of the Qdrant sidecar. Used by client libraries that prefer gRPC over REST for streaming ops. |
QDRANT_API_KEY |
(unset) | (opt-in cluster profile) | Optional API key for Qdrant Cloud or an authenticated on-prem instance. Empty → no api-key header sent. |
QDRANT_COLLECTION |
omniroute-memory |
(opt-in cluster profile) | Collection name for OmniRoute's conversation memory embeddings. Created on first run with QDRANT_VECTOR_SIZE dimensions. |
QDRANT_EMBEDDING_MODEL |
text-embedding-3-small |
(opt-in cluster profile) | Default embedding model name recorded in the Qdrant collection metadata. Actual embeddings are generated by whatever provider the embeddingModel field in OmniRoute's settings points to. |
QDRANT_VECTOR_SIZE |
1536 |
(opt-in cluster profile) | Embedding vector dimension. Must match the model you embed with (text-embedding-3-small → 1536; ada-002 → 1536; nomic-embed-text → 768). |
QDRANT_HNSW_EF_CONSTRUCT |
128 |
(opt-in cluster profile) | HNSW index construction-time accuracy. Higher = slower build, faster search. |
26. Test & E2E Harness
Used by scripts/dev/run-next-playwright.mjs, scripts/dev/smoke-electron-packaged.mjs,
scripts/dev/run-ecosystem-tests.mjs, and scripts/build/uninstall.mjs. Leave every
value below unset in production deployments.
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_E2E_BOOTSTRAP_MODE |
auth |
scripts/dev/run-next-playwright.mjs |
E2E bootstrap mode (auth, fresh, reuse) for the Playwright runner. |
OMNIROUTE_E2E_PASSWORD |
falls back to INITIAL_PASSWORD |
scripts/dev/run-next-playwright.mjs |
Admin password injected into the Playwright environment. |
OMNIROUTE_DISABLE_LOCAL_HEALTHCHECK |
true |
scripts/dev/run-next-playwright.mjs |
Disable the local healthcheck poll during Playwright runs. |
OMNIROUTE_DISABLE_TOKEN_HEALTHCHECK |
true |
scripts/dev/run-next-playwright.mjs |
Disable the OAuth token healthcheck loop during tests. |
OMNIROUTE_HEALTHCHECK_SKIP_PROVIDERS |
(unset) | src/lib/tokenHealthCheck.ts |
Comma-separated providers excluded from the proactive token-refresh sweep (e.g. codex,openai). Targeted alternative to fully disabling the healthcheck — short-TTL providers keep refreshing while cascade providers stay reactive-only. |
OMNIROUTE_HIDE_HEALTHCHECK_LOGS |
true |
scripts/dev/run-next-playwright.mjs |
Silence healthcheck noise in Playwright stdout. |
OMNIROUTE_PLAYWRIGHT_SKIP_BUILD |
0 |
scripts/dev/run-next-playwright.mjs |
Skip the Next.js production build before Playwright starts (CI optimization). |
OMNIROUTE_SKIP_UNINSTALL_HOOK |
0 |
scripts/build/uninstall.mjs |
Skip the OmniRoute uninstall hook (used by CI to keep node_modules intact). |
ECOSYSTEM_SERVER_WAIT_MS |
180000 |
scripts/dev/run-ecosystem-tests.mjs |
Wait time (ms) for the server to become healthy before running ecosystem/protocol tests. |
ELECTRON_SMOKE_URL |
http://127.0.0.1:20128/login |
scripts/dev/smoke-electron-packaged.mjs |
URL the Electron smoke harness expects the packaged app to serve. |
ELECTRON_SMOKE_TIMEOUT_MS |
45000 |
scripts/dev/smoke-electron-packaged.mjs |
Total timeout (ms) before the smoke harness gives up. |
ELECTRON_SMOKE_SETTLE_MS |
2000 |
scripts/dev/smoke-electron-packaged.mjs |
Settle window (ms) after the page loads. |
ELECTRON_SMOKE_APP_EXECUTABLE |
(auto) | scripts/dev/smoke-electron-packaged.mjs |
Explicit path to the packaged Electron executable. |
ELECTRON_SMOKE_DATA_DIR |
(tmpdir) | scripts/dev/smoke-electron-packaged.mjs |
Data directory for the Electron smoke run. |
ELECTRON_SMOKE_KEEP_DATA |
0 |
scripts/dev/smoke-electron-packaged.mjs |
Set 1 to preserve the smoke data directory after the run. |
ELECTRON_SMOKE_STREAM_LOGS |
0 |
scripts/dev/smoke-electron-packaged.mjs |
Set 1 to stream Electron logs to stdout during the run. |
CLI_DEVIN_BIN |
(PATH lookup) | open-sse/executors/devin-cli.ts |
Override the Devin CLI binary path. |
Docs translation pipeline
Used by scripts/i18n/run-translation.mjs (the npm run i18n:run command).
All five variables are unset by default — set them in .env only on machines
that should be able to run the docs translator.
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_TRANSLATION_API_URL |
(unset) | scripts/i18n/run-translation.mjs |
OpenAI-compatible base URL for the translation backend. |
OMNIROUTE_TRANSLATION_API_KEY |
(unset) | scripts/i18n/run-translation.mjs |
Bearer token for the translation backend (never logged). |
OMNIROUTE_TRANSLATION_MODEL |
(unset) | scripts/i18n/run-translation.mjs |
Model id, e.g. gpt-4o-mini or cx/gpt-5.4-mini. |
OMNIROUTE_TRANSLATION_TIMEOUT_MS |
60000 |
scripts/i18n/run-translation.mjs |
Per-request timeout in milliseconds. |
OMNIROUTE_TRANSLATION_CONCURRENCY |
4 |
scripts/i18n/run-translation.mjs |
Parallel translation requests when running over multiple files / locales. |
Audit: Removed / Dead Variables
The following variables appeared in previous versions of .env.example but have no runtime references in the current codebase. They have been removed:
| Variable | Reason |
|---|---|
STORAGE_DRIVER=sqlite |
Never read by any source file. SQLite is the only supported driver — no selection needed. |
INSTANCE_NAME=omniroute |
Present in old docs/env templates but unused at runtime. May return in a future multi-instance feature. |
SQLITE_MAX_SIZE_MB=2048 |
Not referenced in source code. Database size is not artificially limited. |
SQLITE_CLEAN_LEGACY_FILES=true |
Not referenced in source code. Legacy cleanup was likely removed. |
CLI_ROO_BIN |
Not registered in src/shared/services/cliRuntime.ts. |
CLI_KIMI_CODING_BIN |
Not registered in src/shared/services/cliRuntime.ts (Kimi Coding uses OAuth, not a CLI binary). |
IFLOW_OAUTH_CLIENT_ID / IFLOW_OAUTH_CLIENT_SECRET |
Not referenced anywhere in source code. |
CEREBRAS_API_KEY / COHERE_API_KEY / FIREWORKS_API_KEY / GROQ_API_KEY / MISTRAL_API_KEY / NEBIUS_API_KEY / PERPLEXITY_API_KEY / TOGETHER_API_KEY / XAI_API_KEY |
Removed in v3.8.0. The runtime no longer reads these env vars — credentials come from Dashboard / data/provider-credentials.json / encrypted DB. |
CURSOR_PROTOBUF_DEBUG |
Removed in v3.8.0. Cursor executor uses CURSOR_DEBUG / CURSOR_STREAM_DEBUG (see §22). |
CLI_COMPAT_KIRO |
Removed in v3.8.0. Kiro is in CLI_COMPAT_OMITTED_PROVIDER_IDS — its toggle has no effect. |
QIANFAN_API_KEY |
Removed alongside other unused provider API key stubs in v3.8.0. |
Default Value Corrections
| Variable | Old .env.example Value |
Actual Code Default | Fixed |
|---|---|---|---|
APP_LOG_RETENTION_DAYS |
90 |
7 |
✅ Removed misleading value; documented 7 as default |
CALL_LOG_RETENTION_DAYS |
90 |
7 |
✅ Removed misleading value; documented 7 as default |
OpenCode config regeneration (ad-hoc tooling)
Used by scripts/ad-hoc/regen-opencode-config.ts to regenerate an opencode.json
with accurate limit.context and limit.output values pulled from the running
OmniRoute instance. None of these are required for normal operation — the script
is developer tooling only.
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_URL |
http://localhost:20128 |
scripts/ad-hoc/regen-opencode-config.ts |
Base URL of the OmniRoute instance to query for /v1/models. |
OMNIROUTE_KEY |
(unset) | scripts/ad-hoc/regen-opencode-config.ts |
API key to authenticate against the OmniRoute /v1/models endpoint. Falls back to OPENCODE_API_KEY when unset. |
OPENCODE_API_KEY |
(unset) | scripts/ad-hoc/regen-opencode-config.ts |
OpenCode-style API key (sk-...) written into the regenerated opencode.json. Falls back to OMNIROUTE_KEY when unset. |
Compression offline-eval harness (ad-hoc tooling)
Used by scripts/compression-eval/index.ts, the offline compression evaluation CLI.
Not required for normal operation — developer tooling only.
| Variable | Default | Source File | Description |
|---|---|---|---|
OMNIROUTE_EVAL_CREDENTIALS |
{} (empty) |
scripts/compression-eval/index.ts |
Operator-supplied JSON credentials for the provider exercised by the offline compression-eval CLI (parsed with JSON.parse). Leave unset for a dry run. |