Files

T

wehub-resource-sync d8dcd5f6d1 chore: import upstream snapshot with attribution

2026-07-13 13:39:12 +08:00

233 KiB

Raw Permalink Blame History

title, version, lastUpdated

title	version	lastUpdated
Environment Variables Reference	3.8.40	2026-06-28

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.example must appear here. npm run check:env-doc-sync enforces this on commit and in CI. To omit a variable on purpose, add it to the allowlist inside scripts/check/check-env-doc-sync.mjs.

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 .env files with real secrets to version control. The .gitignore already 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).
`OMNIROUTE_BASE_PATH`	(empty = root)	`next.config.mjs`	URL subpath for serving OmniRoute behind a reverse proxy under a subpath (sets Next.js `basePath`; auth redirects are basePath-aware). E.g. `/omniroute`.
`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.
`LIVE_WS_ALLOWED_HOSTS`	(unset)	`src/server/ws/liveServerAllowList.ts`	Comma-separated extra hostnames allowed for live WebSocket origins. Unlike `LIVE_WS_ALLOWED_ORIGINS` (full origin URLs), matches only the host portion — useful for LAN/Tailscale setups.
`NEXT_PUBLIC_LIVE_WS_PUBLIC_URL`	(unset)	`src/hooks/useLiveDashboard.ts`	Public URL for the live dashboard WebSocket (browser-side). Set when fronting the WS server with a reverse proxy or Cloudflare Tunnel (e.g. `wss://ws.my-ai.com/live-ws`); the browser connects there instead of `ws://hostname:20129`.
`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` (Turbopack — code default)	`package.json` / Next.js 16	Turbopack is the default bundler for `npm run dev` and `npm run build` (2-3× faster builds, benchmarked). Set to `0` to fall back to webpack on Windows or when running into native binding / bundler-compat 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. Do not use for `omniroute serve` — use `OMNIROUTE_SERVER_HOST` instead (POSIX shells auto-set `HOSTNAME` to the machine name; `.env` cannot override it).
`OMNIROUTE_SERVER_HOST`	`0.0.0.0`	`bin/cli/commands/serve.mjs`	Bind address for `omniroute serve`. Avoids collision with the POSIX shell `HOSTNAME` variable (always set to the machine name by bash/zsh). Falls back to `0.0.0.0` when unset. (#6194)

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.
`OMNIROUTE_CHAT_LARGE_BODY_BYTES`	`262144` (256 KB)	`src/shared/middleware/chatBodyAdmission.ts`	Heap-pressure admission threshold for `POST /v1/chat/completions` (#5152). Bodies below this are always admitted and never sample the heap; at or above it the heap-pressure check applies.
`OMNIROUTE_CHAT_HARD_MAX_BODY_BYTES`	`52428800` (50 MB)	`src/shared/middleware/chatBodyAdmission.ts`	Chat-route hard cap. Bodies larger than this are rejected with `413` before being cloned/parsed, regardless of heap state.
`OMNIROUTE_CHAT_HEAP_SHED_RATIO`	`0.75`	`src/shared/middleware/chatBodyAdmission.ts`	Shed a large chat body with `503` + `Retry-After` once `heapUsed / heap_size_limit` reaches this ratio (`0 < r < 1`). Turns a process-wide V8 OOM under concurrent large compacts into a single graceful client retry; a healthy heap admits every body untouched.
`OMNIROUTE_MAX_NONSTREAMING_RESPONSE_BYTES`	`67108864` (64 MB)	`open-sse/handlers/chatCore/nonStreamingResponseBody.ts`	Hard cap for a non-streaming upstream response buffered fully into memory. Past this the upstream reader is cancelled and the request fails fast instead of growing an unbounded string until the heap is exhausted.
`CORS_ORIGIN`	(unset)	`src/server/cors/origins.ts`	Legacy single-origin CORS allowlist. Prefer `CORS_ALLOWED_ORIGINS` for new deployments. CORS is only for cross-origin browser API clients; authenticated dashboard writes use same-origin requests plus session-bound CSRF protection instead.
`CORS_ALLOWED_ORIGINS`	(unset)	`src/server/cors/origins.ts`	Comma-separated CORS allowlist. No wildcard is sent unless `CORS_ALLOW_ALL=true` is explicitly configured.
`CORS_ALLOW_ALL`	`false`	`src/server/cors/origins.ts`	Development-only escape hatch to echo any browser `Origin`. Do not enable on shared or production deployments.
`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.
`OMNIROUTE_ALLOW_LOCAL_PROVIDER_URLS`	`true`	`src/shared/network/outboundUrlGuard.ts`	Allow adding/validating providers on local/private addresses (127.0.0.1, localhost, LAN, private ranges) — scoped to the provider validation path. Default `true` (local-first); set `false` to enforce strict public-only blocking. Cloud-metadata endpoints (169.254.169.254, metadata.google.internal) stay blocked regardless. (#5066)

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_ALLOWED_ORIGINS=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`	`true`	`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`. Keep this as a loopback/container URL even when the app is publicly proxied.
`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, and generated public URLs. Set this to the stable public URL when OAuth callbacks or generated browser links must use a canonical reverse-proxy host.
`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)	Public-origin resolver, image URLs	Highest-priority browser-facing OmniRoute origin used for public URL generation and non-dashboard browser-origin validation (for example `/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_PROVIDER_MANIFEST_URL`	(unset)	`open-sse/config/providerPluginManifestUrl.ts`	Absolute provider plugin manifest URL advertised to sidecar clients. When unset, OmniRoute derives `/api/v1/provider-plugin-manifest` from request origin or HOST/PORT.
`OMNIROUTE_PUBLIC_PROTOCOL`	`http`	`open-sse/config/providerPluginManifestUrl.ts`	Protocol used when deriving the provider plugin manifest URL from HOST/PORT without a request origin. Set to `https` behind a TLS-terminating public proxy when no explicit `OMNIROUTE_PROVIDER_MANIFEST_URL` is set.
`OMNIROUTE_TRUST_PROXY`	(unset)	`src/server/origin/publicOrigin.ts`	Optional trust mode for forwarded public-origin headers. Unset = do not trust `Forwarded` / `X-Forwarded-*` for security decisions. `true` / `loopback` trusts forwarded host/proto only from a token-stamped loopback proxy. `private` / `lan` also trusts private-LAN proxy peers. Prefer explicit `NEXT_PUBLIC_BASE_URL` in production.
`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.
`OMNIROUTE_CGPT_WEB_PRO_TIMEOUT_MS`	`1200000` (20 min)	`open-sse/executors/chatgpt-web.ts`	Overall wait budget for a chatgpt-web GPT-5.5 Pro background-poll handoff. Pro reasoning runs complete out-of-band, so OmniRoute polls until the answer lands or this budget elapses. Raise if Pro requests time out before finishing.
`OMNIROUTE_CGPT_WEB_PRO_POLL_INTERVAL_MS`	`4000` (4s)	`open-sse/executors/chatgpt-web.ts`	Interval between chatgpt-web GPT-5.5 Pro background-poll attempts. Lower for snappier completion at the cost of more upstream polling; raise to reduce request volume.
`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_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.
`OPENCODE_SYNTHESIZE_CLI_HEADERS`	`false`	`open-sse/executors/opencode.ts`	Opt-in: synthesize OpenCode CLI identity headers (User-Agent, x-opencode-client/project, request/session UUIDs) on opencode-go/zen upstream requests the client didn't send, so Cloudflare on VPS egress accepts them (#6210/#5997). Off by default (forward-only is safer).
`OPENCODE_USER_AGENT`	`opencode-cli/1.0.0`	`open-sse/executors/opencode.ts`	Default User-Agent used when `OPENCODE_SYNTHESIZE_CLI_HEADERS` is on and no per-provider `<PROVIDER>_USER_AGENT` override is set. Only applied to opencode executors.
`OPENCODE_CLIENT`	`cli`	`open-sse/executors/opencode.ts`	Value for the synthesized `x-opencode-client` header when `OPENCODE_SYNTHESIZE_CLI_HEADERS` is on.
`OPENCODE_PROJECT`	`default`	`open-sse/executors/opencode.ts`	Value for the synthesized `x-opencode-project` header when `OPENCODE_SYNTHESIZE_CLI_HEADERS` is on.
`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), set NEXT_PUBLIC_BASE_URL to your stable public URL (e.g., https://omniroute.example.com) when OAuth callbacks or generated public links must use that hostname. Without this, OAuth callbacks can fail because the redirect_uri won't match and generated public links can point at the internal container origin.

Keep BASE_URL as an internal loopback/container URL for server-to-server jobs. Do not use a browser Origin or public hostname for credential-bearing internal self-fetches.

Authenticated dashboard writes do not require a static public base URL: the dashboard sends same-origin unsafe requests with a session-bound CSRF token. OmniRoute still centralizes public-origin validation for non-dashboard browser integrations: explicit public URL env vars are trusted first; raw Forwarded / X-Forwarded-* headers are ignored unless OMNIROUTE_TRUST_PROXY is enabled and the immediate proxy peer is token-stamped as trusted. Do not use CORS settings to fix same-origin dashboard requests; CORS is only for cross-origin browser clients.

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.
`SOCKS_HANDSHAKE_TIMEOUT_MS`	`10000`	`open-sse/utils/socksConnectorWithFamily.ts`	SOCKS5 handshake (connect) timeout in ms. Raise it when a single residential gateway host is hit by high concurrency (e.g. 100 simultaneous requests) — the real handshake can exceed 10s under a saturated pool even though the proxy is reachable, which otherwise surfaces as a false `[Proxy Fast-Fail] Proxy unreachable`. Capped at `120000`.
`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 using safeOutboundFetch({ bypassProxyPatch: true }). This is a documented, scoped exception — it does not affect chat/usage egress. The bypass is scope-pinned by tests/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.
`AUGGIE_BIN`	`auggie`	`open-sse/executors/auggie.ts`	Absolute-path override for the Augment (Auggie) CLI binary used by the local `auggie` provider. Falls back to `CLI_AUGGIE_BIN`, then a PATH lookup.
`CLI_AUGGIE_BIN`	`auggie`	`open-sse/executors/auggie.ts`	Alias override for the Augment (Auggie) CLI binary path (checked after `AUGGIE_BIN`).
`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`).

CLI Profile Auto-Sync

These feature flags are opt-in and default off. They can also be toggled from the CLI Code dashboard.

Variable	Default	Source File	Description
`OMNIROUTE_AUTO_SYNC_CODEX_PROFILES`	`false`	`src/shared/constants/featureFlagDefinitions.ts`	After a provider model sync, automatically rewrites `~/.codex/*.config.toml` profile files from the live catalog. Requires `CLI_ALLOW_CONFIG_WRITES`; never changes the active/default Codex config, auth, Codex-lb settings, or provider choice.
`OMNIROUTE_AUTO_SYNC_CLAUDE_PROFILES`	`false`	`src/shared/constants/featureFlagDefinitions.ts`	After a provider model sync, automatically rewrites `~/.claude/profiles/<name>/settings.json` Claude Code profile files from the live catalog. Requires `CLI_ALLOW_CONFIG_WRITES`; never changes the active/default Claude config, auth, or provider choice.

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`	`true`	`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`	`false`	`open-sse/mcp-server/descriptionCompressor.ts`	Compress MCP tool descriptions before serializing the manifest. Enable values: `1`, `true`, `on`.
`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).
`OMNIROUTE_QUOTA_FETCH_MIN_INTERVAL_MS`	`250`	`open-sse/services/quotaFetchThrottle.ts`	Min interval (ms) between consecutive upstream quota fetches on the per-request preflight/monitor path (e.g. Codex `/wham/usage`); spaces concurrent network calls so many accounts on one IP don't burst the upstream (#6009). Cache hits unaffected. `0` disables; clamped `0..5000`.
`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.
`COMPRESSION_PIPELINE_BREAKER_ENABLED`	`false`	`open-sse/services/compression/pipelineEngineBreaker.ts`	T02 stacked-pipeline per-engine circuit-breaker master switch. Opt-in (default off) — when on, an engine that throws repeatedly across requests is skipped (fail-open) for a cooldown; off = byte-identical legacy behavior.
`COMPRESSION_PIPELINE_BREAKER_THRESHOLD`	`3`	`open-sse/services/compression/pipelineEngineBreaker.ts`	Consecutive cross-request failures before an engine's breaker opens.
`COMPRESSION_PIPELINE_BREAKER_COOLDOWN_MS`	`30000`	`open-sse/services/compression/pipelineEngineBreaker.ts`	Milliseconds an opened engine stays skipped before a half-open probe.
`COMPRESSION_CCR_RETRIEVAL_RAMP_FACTOR`	`2`	`open-sse/services/compression/engines/ccr/index.ts`	T08/H8 CCR retrieval-feedback ramp: each prior retrieval of a stored block raises its effective `minChars` linearly (frequently-retrieved content compresses less; `>=3` retrievals = never compressed). `1` disables the ramp (binary skip at the threshold only).
`COMPRESSION_PREFIX_FREEZE_ENABLED`	`false`	`open-sse/services/compression/prefixFreeze.ts`	T08/H5 usage-observed prefix freeze master switch. Opt-in (default off) — when on, a system prompt observed `>=` the threshold is treated as a stable cacheable prefix and preserved from compression even for providers the static cache heuristic misses (freeze only preserves, never mutates).
`COMPRESSION_PREFIX_FREEZE_THRESHOLD`	`3`	`open-sse/services/compression/prefixFreeze.ts`	Observations of a system prompt before it is treated as a frozen stable prefix.
`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)	—
`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`.
`QODER_CLI_CONFIG_DIR`	Qoder	Override the Qoder CLI config dir (isolated PAT session, avoids clobbering a browser login).
`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

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.195 (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.54.0`	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.19.3 (linux; x64)`	When Qwen Code updates
`CURSOR_USER_AGENT`	`Cursor/3.3`	When Cursor 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_KEY entries 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)
├─→ STREAM_READINESS_MAX_TIMEOUT_MS (caps adaptive readiness extensions, default: 180000)
└─→ 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.
`STREAM_READINESS_MAX_TIMEOUT_MS`	`180000`	Maximum adaptive first-event readiness window for large, tool-heavy, or high-reasoning streaming requests.
`OMNIROUTE_AGENT_GOAL_POLICY_ENABLED`	`true`	Kill-switch for the `/goal` heuristic. Set `false`/`0`/`off` to fully disable detection — readiness timeouts and stream recovery are never elevated by request body/headers, mitigating client-controlled timeout amplification.
`OMNIROUTE_AGENT_GOAL_READINESS_MAX_TIMEOUT_MS`	`600000`	Maximum first-event readiness window for detected `/goal` agent runs or requests forced with `x-omniroute-agent-goal`.
`OMNIROUTE_AGENT_GOAL_STREAM_RECOVERY`	`true`	Enable early stream recovery automatically for detected `/goal` agent runs. Set `false`/`0`/`off` to disable the goal-specific opt-in. This can only ADD recovery on top of the operator default — it never overrides an explicit `STREAM_RECOVERY_ENABLED`/DB settings opt-out.
`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.
`FIRECRAWL_BASE_URL`	`https://api.firecrawl.dev`	Point the Firecrawl web-fetch executor at a self-hosted instance (API key optional off-cloud).
`FIRECRAWL_TIMEOUT_MS`	`30000`	Per-request timeout for the Firecrawl web-fetch executor.
`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_CHATGPT_STREAM_FIRST_BYTE_TIMEOUT_MS`	`30000` (30s)	Max wait for the first streamed byte from the ChatGPT TLS sidecar (`chatgptTlsClient.ts`) before aborting a dead stream. Raise if upstream cold-starts exceed the window.
`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`	auto	Runtime V8 heap limit (MB). When unset, calibrated dynamically (~35% of system RAM, clamped to `[512, 4096]`); `512` is only the floor when total memory can't be read. Set explicitly to override. 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).
`MEMORY_TYPED_DECAY_ENABLED`	`false`	TV6 typed memory decay master switch. Opt-in (default off) — the sweep deletes decayed memories. With it off, `access_count`/`last_accessed_at` are pure telemetry and nothing is ever deleted.
`MEMORY_TYPED_DECAY_EPISODIC_DAYS`	`30`	TTL (days) after which an unused `episodic` memory decays. `0` makes episodic immune too. Durable types (`factual`/`procedural`/`semantic`) are always immune. The decay clock re-bases on `last_accessed_at`.
`MEMORY_TYPED_DECAY_ACCESS_IMMUNITY`	`3`	A memory injected `>=` this many times becomes immune to decay regardless of type. `0` disables access immunity.
`MEMORY_TYPED_DECAY_SWEEP_INTERVAL`	`0` (disabled)	Interval (seconds) for the optional periodic decay sweep in `src/lib/memory/typedDecay.ts`. `0`/unset = no periodic sweep. Doubly opt-in: also requires `MEMORY_TYPED_DECAY_ENABLED=true`.

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.
`CONTEXT_WINDOW_RECONCILE_INTERVAL`	`86400` (24h)	`src/lib/contextWindowResolver.ts`	Interval (seconds) for the self-correcting context-window reconciler (5004): pins provider-declared windows from `/models` discovery as `auto:discovery` overrides when they diverge from the catalog. Set to `0` to disable. Reuses already-synced data (no new fetch); never overwrites `manual` overrides.

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.
`MUX_SERVICE_PORT`	`8322`	`src/lib/services/bootstrap.ts`	Override the port where the embedded Mux (coder/mux) agent-orchestration daemon listens (always 127.0.0.1).
`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.
`PROXY_HEALTH_UNHEALTHY_CACHE_TTL_MS`	`2000`	`src/lib/proxyHealth.ts`	Cache TTL for failed proxy health probes. Keep this shorter than `PROXY_HEALTH_CACHE_TTL_MS` so transient proxy timeouts under high concurrency retry quickly without disabling fast-fail for truly dead proxies.
`PROXY_HEALTH_ENABLED`	`true`	`src/lib/proxyHealth/scheduler.ts`	Set `false` to disable the background proxy health scheduler that periodically probes registered proxies.
`PROXY_HEALTH_INTERVAL_MS`	`600000`	`src/lib/proxyHealth/scheduler.ts`	Background health-scheduler sweep interval in ms (minimum `60000`).
`PROXY_HEALTH_TEST_URL`	`https://httpbin.org/ip`	`src/lib/proxyHealth/scheduler.ts`	Reachability probe target used by the scheduler and the `/api/settings/proxies/auto-test` endpoint. Point it at an internal/self-hosted URL to avoid the public default.
`PROXY_HEALTH_AUTO_DEACTIVATE`	`false`	`src/lib/proxyHealth/statusPolicy.ts`	When `false` (default), automated reachability probes (the scheduler + the `/api/settings/proxies/auto-test` "Test All" button) are read-only and never write a proxy's status — only the operator sets active/inactive, so a flaky probe can't strand an assigned proxy (#6246). Set `true` to restore the legacy test-and-set behaviour.
`PROXY_AUTO_REMOVE`	`false`	`src/lib/proxyHealth/scheduler.ts`	Set `true` to let the scheduler auto-remove proxies after repeated consecutive failures.
`PROXY_AUTO_REMOVE_AFTER`	`3`	`src/lib/proxyHealth/scheduler.ts`	Consecutive failures before the scheduler auto-removes a proxy (when `PROXY_AUTO_REMOVE=true`).
`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`.
`HEADROOM_URL`	`http://localhost:8787`	`src/lib/headroom/detect.ts`	Headroom token-saver proxy URL. The dashboard lifecycle (`api/headroom/*`) spawns a local `headroom-ai` CLI on loopback by default; override only to point at an external Docker sidecar proxy.

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 through open-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 is RELAY_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

For relay backend SRE guidance (ts/bifrost/auto behavior, 9router vs CLIProxyAPI placement, and high-throughput fallback strategy), see Relay Backend Strategy.

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=true opens an egress path from arbitrary skill code. Pair with OUTBOUND_SSRF_GUARD_ENABLED=true and a strict CORS_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.
`OMNIROUTE_NO_SUDO`	`0`	`src/mitm/systemCommands.ts`	Set `1` (truthy) to strip the leading `sudo` from MITM cert-trust commands — for root-less / user-namespaced deployments where the operator trusts the CA manually (e.g. via Node's extra-CA-certs mechanism).
`OMNIROUTE_SKIP_SYSTEM_TRUST`	`0`	`src/mitm/cert/install.ts`, `src/mitm/tproxy/caTrust.ts`	Test/CI-only guard: set `1` to make cert trust install/uninstall a no-op so the suite never mutates the OS trust store. Set automatically by the test setup and CI workflows.
`CHANGELOG_BASE_REF`	(auto)	`scripts/check/check-changelog-integrity.mjs`	Explicit base ref for the anti CHANGELOG-eat gate (defaults to the PR base branch in CI, or the highest `release/v*`).
`ALLOW_CHANGELOG_REMOVALS`	`0`	`scripts/check/check-changelog-integrity.mjs`	Set `1` to turn intentional CHANGELOG bullet removals into a report instead of a failure (justify in the PR body).
`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.
`FREE_PROXY_WEBSHARE_ENABLED`	`true`	`src/lib/freeProxyProviders/webshare.ts`	Enable the Webshare proxy pool source. Set to `false` to disable; also requires `FREE_PROXY_WEBSHARE_API_KEY` to be set.
`FREE_PROXY_WEBSHARE_API_KEY`	(none)	`src/lib/freeProxyProviders/webshare.ts`	Webshare account API token (`Authorization: Token <key>`). Required — the provider stays disabled without it.
`FREE_PROXY_WEBSHARE_API_URL`	`https://proxy.webshare.io/api/v2/proxy/list/`	`src/lib/freeProxyProviders/webshare.ts`	Webshare proxy list API URL override.
`FREE_PROXY_WEBSHARE_MAX`	`500`	`src/lib/freeProxyProviders/webshare.ts`	Maximum proxies imported per Webshare sync.
`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_PORT`	`8080`	`src/lib/services/bootstrap.ts`	Port the supervised Bifrost embedded service binds to (`127.0.0.1:<port>`) when OmniRoute manages the Bifrost sidecar lifecycle. Defaults to `8080`.
`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_*`). `BIFROST_API_KEY` takes precedence when both are set.
`OMNIROUTE_RELAY_BACKEND`	`ts` / `auto`	`src/app/api/v1/relay/chat/completions/routingBackend.ts`	Relay backend for `/api/v1/relay/chat/completions`: `ts \| bifrost \| auto`. `ts` = TypeScript relay (default when Bifrost unconfigured); `auto` selects Bifrost when `BIFROST_BASE_URL` is set and `BIFROST_ENABLED` ≠ `0`, with automatic TS fallback if the sidecar is unreachable; `bifrost` forces Bifrost (strict, no fallback). Auth/rate-limit/injection-guard/allowlist always run in the Next route first. Responses carry `X-Routing-Backend` / `X-Routing-Fallback`.
`RELAY_ROUTING_BACKEND`	(unset)	`src/app/api/v1/relay/chat/completions/routingBackend.ts`	Accepted alias for `OMNIROUTE_RELAY_BACKEND` (same `ts \| bifrost \| auto` values). `OMNIROUTE_RELAY_BACKEND` takes precedence when both are set.
`OMNIROUTE_BIFROST_FAILURE_COOLDOWN_MS`	`5000`	`src/app/api/v1/relay/chat/completions/bifrostCooldown.ts`	Cooldown (ms) after a Bifrost sidecar hop fails in `auto` mode before the relay re-attempts the sidecar; it routes straight to the TS path while the cooldown lasts, then probes again. `0` disables. Only applies when `OMNIROUTE_RELAY_BACKEND=auto`.
`OMNIROUTE_TLS_CERT`	(unset)	`bin/cli/commands/serve.mjs`	Path to a PEM TLS certificate to serve `omniroute serve` over HTTPS (equivalent to `--tls-cert`). Must be paired with `OMNIROUTE_TLS_KEY`; the standalone server then terminates TLS on the same listener (`wss://` works unchanged). Unset → plain HTTP. Providing only one of cert/key, or an unreadable path, logs a warning and stays HTTP.
`OMNIROUTE_TLS_KEY`	(unset)	`bin/cli/commands/serve.mjs`	Path to the PEM TLS private key for `omniroute serve` HTTPS (equivalent to `--tls-key`). Must be paired with `OMNIROUTE_TLS_CERT`. See `OMNIROUTE_TLS_CERT`.
`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.

233 KiB Raw Permalink Blame History Unescape Escape

Environment Variables Reference

Table of Contents

1. Required Secrets

Generation Commands

2. Storage & Database

Scenarios

3. Network & Ports

Port Modes

4. Security & Authentication

Hardening Checklist

5. Input Sanitization & PII Protection

Request-Side: Prompt Injection Guard

Response-Side: PII Sanitizer

VS Code Tokenized-Route Context Sanitizer

Scenarios

6. Tool & Routing Policies

7. URLs & Cloud Sync

8. Outbound Proxy

Scenarios

9. CLI Tool Integration

CLI Profile Auto-Sync

Docker Example

CLI Binary (omniroute) helpers

10. Internal Agent & MCP Integrations

OAuth CLI Bridge (Internal)

11. OAuth Provider Credentials

12. Provider User-Agent Overrides

13. CLI Fingerprint Compatibility

Per-Provider

Global

Kimi Coding CLI identity overrides

14. API Key Providers

15. Timeout Settings

Timeout Hierarchy

Circuit Breaker Thresholds

Scenarios

16. Logging

17. Memory Optimization

Compression

Memory Engine (plan 21)

Low-RAM Docker Example

18. Pricing Sync

Arena ELO Sync

19. Model Sync (Dev)

20. Provider-Specific Settings

21. Proxy Health

Stream-recovery tuning constants (not env vars)

22. Debugging

23. GitHub Integration

Deployment Scenarios

Minimal Local Development

Docker Production

Air-Gapped / CI

VPS with Reverse Proxy (nginx + Cloudflare)

24. Skills Sandbox (v3.8.0+)

25. Provider Quotas, Tunnels, Backups & Misc Runtime

26. Test & E2E Harness

Docs translation pipeline

Audit: Removed / Dead Variables

Default Value Corrections

OpenCode config regeneration (ad-hoc tooling)

Compression offline-eval harness (ad-hoc tooling)

233 KiB

Raw Permalink Blame History

CLI Binary (`omniroute`) helpers