OmniRoute/docs/ENVIRONMENT.md

Environment Variables Reference

Complete reference for every environment variable recognized by OmniRoute. For a quick-start template, see .env.example.

---

Table of Contents

• 1. Required Secrets
• 2. Storage & Database
• 3. Network & Ports
• 4. Security & Authentication
• 5. Input Sanitization & PII Protection
• 6. Tool & Routing Policies
• 7. URLs & Cloud Sync
• 8. Outbound Proxy
• 9. CLI Tool Integration
• 10. Internal Agent & MCP Integrations
• 11. OAuth Provider Credentials
• 12. Provider User-Agent Overrides
• 13. CLI Fingerprint Compatibility
• 14. API Key Providers
• 15. Timeout Settings
• 16. Logging
• 17. Memory Optimization
• 18. Pricing Sync
• 19. Model Sync (Dev)
• 20. Provider-Specific Settings
• 21. Proxy Health
• 22. Debugging
• 23. GitHub Integration
• 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	123456	Bootstrap script	Sets the initial admin dashboard password. Change before first use. After login, change via Dashboard → Settings → Security.

Generation Commands

# Generate all three 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)"

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/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.

Scenarios

Scenario	Configuration
Local development	Leave all defaults. DB lives at ~/.omniroute/omniroute.db.
Docker	DATA_DIR=/data + mount a volume at /data.
Encrypted at rest	Set STORAGE_ENCRYPTION_KEY + keep backups of the key! Losing it = losing data.
CI/Testing	DATA_DIR=/tmp/omniroute-test — ephemeral, no encryption needed.

---

3. Network & Ports

Variable	Default	Source File	Description
PORT	20128	src/lib/runtime/ports.ts	Primary port for both Dashboard UI and API endpoints (single-port mode).
API_PORT	(unset)	src/lib/runtime/ports.ts	When set, serves the /v1/* proxy API on this separate port.
API_HOST	0.0.0.0	src/lib/runtime/ports.ts	Bind address for the API port.
DASHBOARD_PORT	(unset)	src/lib/runtime/ports.ts	When set, serves the Dashboard UI on this separate port.
PROD_DASHBOARD_PORT	20130	docker-compose.prod.yml	Host-side published port for the Dashboard in Docker production mode.
PROD_API_PORT	20131	docker-compose.prod.yml	Host-side published port for the API in Docker production mode.
OMNIROUTE_PORT	(unset)	src/lib/runtime/ports.ts	Takes precedence over PORT when running inside Electron or other wrappers.
NODE_ENV	production	Next.js core	Controls logging verbosity, caching, error detail exposure, and Next.js optimizations.

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.
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	Dashboard providers page	Allows revealing full API key values in the Dashboard UI. 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).
MAX_BODY_SIZE_BYTES	10485760 (10 MB)	src/shared/middleware/bodySizeGuard.ts	Maximum allowed request body size. Rejects payloads exceeding this limit.
CORS_ORIGIN	*	Next.js middleware	CORS Access-Control-Allow-Origin value. Restrict for production.
OUTBOUND_SSRF_GUARD_ENABLED	true	src/shared/network/outboundUrlGuard.ts	Block provider calls targeting private/loopback/link-local IP ranges. Disable only in isolated test envs.

Hardening Checklist

# Production security minimum:
AUTH_COOKIE_SECURE=true        # Requires HTTPS
REQUIRE_API_KEY=true           # Authenticate all proxy calls
ALLOW_API_KEY_REVEAL=false     # Never expose keys in UI
CORS_ORIGIN=https://your.domain.com
MAX_BODY_SIZE_BYTES=5242880    # 5 MB limit

---

5. Input Sanitization & PII Protection

OmniRoute provides a two-layer defense: request-side injection scanning and response-side PII stripping.

Request-Side: Prompt Injection Guard

Variable	Default	Source File	Description
INPUT_SANITIZER_ENABLED	false	src/middleware/promptInjectionGuard.ts	Enable scanning of incoming messages for prompt injection patterns.
INPUT_SANITIZER_MODE	warn	src/middleware/promptInjectionGuard.ts	warn = log only, block = reject request with 400, redact = strip suspicious patterns.
INJECTION_GUARD_MODE	(unset)	src/middleware/promptInjectionGuard.ts	Legacy alias for INPUT_SANITIZER_MODE — same behavior.
PII_REDACTION_ENABLED	false	src/middleware/promptInjectionGuard.ts	Detect PII (emails, phones, SSNs) in incoming requests.

Response-Side: PII Sanitizer

Variable	Default	Source File	Description
PII_RESPONSE_SANITIZATION	false	src/lib/piiSanitizer.ts	Scan LLM responses for leaked PII before returning to client.
PII_RESPONSE_SANITIZATION_MODE	redact	src/lib/piiSanitizer.ts	redact = mask PII, warn = log only, block = drop entire response.

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.

---

7. URLs & Cloud Sync

Variable	Default	Source File	Description
BASE_URL	http://localhost:20128	src/lib/cloudSync.ts	Server-side URL for internal sync jobs to call /api/sync/cloud.
CLOUD_URL	(empty)	src/lib/cloudSync.ts	Cloud relay endpoint URL (premium feature).
CLOUD_SYNC_TIMEOUT_MS	12000	src/lib/cloudSync.ts	HTTP timeout for cloud sync requests.
NEXT_PUBLIC_BASE_URL	http://localhost:20128	OAuth, Dashboard, sync	Public-facing URL for OAuth redirect_uri, Dashboard links. Must match your public URL behind reverse proxy.
NEXT_PUBLIC_CLOUD_URL	(empty)	Client-side	Client-side mirror of CLOUD_URL.
NEXT_PUBLIC_APP_URL	(unset)	src/shared/services/cloudSyncScheduler.ts	Legacy fallback for NEXT_PUBLIC_BASE_URL.

Important

When deploying behind a reverse proxy (nginx, Caddy), NEXT_PUBLIC_BASE_URL must be set to your public URL (e.g., https://omniroute.example.com). Without this, OAuth callbacks will fail because the redirect_uri won't match.

---

8. Outbound Proxy

Route upstream LLM provider calls through an HTTP or SOCKS5 proxy for egress control, geo-routing, or IP masking.

Variable	Default	Source File	Description
ENABLE_SOCKS5_PROXY	true	open-sse/executors	Enable SOCKS5 proxy agent for upstream calls.
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.
ENABLE_TLS_FINGERPRINT	false	open-sse/executors	Spoof TLS fingerprint using wreq-js (mimics Chrome 124). Counters JA3/JA4 blocking.

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)

---

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.

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

---

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_MCP_ENFORCE_SCOPES	false	open-sse/mcp-server/server.ts	Enforce scope-based access control on MCP tool calls.
OMNIROUTE_MCP_SCOPES	(all)	open-sse/mcp-server/server.ts	Comma-separated scopes: admin, combos, health, models, routing, budget, metrics, pricing, memory, skills.
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.
OMNIROUTE_DISABLE_BACKGROUND_SERVICES	false	src/instrumentation-node.ts	Disable all background services (sync, pricing, model refresh). Useful for CI/test.
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.

OAuth CLI Bridge (Internal)

Variable	Default	Source File	Description
OMNIROUTE_SERVER	auto-detect	src/lib/oauth/config/index.ts	Server URL for CLI↔OmniRoute auth bridge.
OMNIROUTE_TOKEN	(unset)	src/lib/oauth/config/index.ts	Auth token for CLI bridge.
OMNIROUTE_USER_ID	cli	src/lib/oauth/config/index.ts	User ID for CLI bridge sessions.
SERVER_URL	(unset)	src/lib/oauth/config/index.ts	Legacy alias for OMNIROUTE_SERVER.
CLI_TOKEN	(unset)	src/lib/oauth/config/index.ts	Legacy alias for OMNIROUTE_TOKEN.
CLI_USER_ID	(unset)	src/lib/oauth/config/index.ts	Legacy alias for OMNIROUTE_USER_ID.

---

11. OAuth Provider Credentials

Built-in credentials for localhost development. For remote deployments, register your own at each provider's developer console.

Variable	Provider	Notes
CLAUDE_OAUTH_CLIENT_ID	Claude Code (Anthropic)	Public client — no secret needed.
CLAUDE_CODE_REDIRECT_URI	Claude Code	Override redirect URI. Default: https://platform.claude.com/oauth/code/callback
CODEX_OAUTH_CLIENT_ID	Codex / OpenAI	Public client.
GEMINI_OAUTH_CLIENT_ID	Gemini (Google)	Requires matching _SECRET.
GEMINI_OAUTH_CLIENT_SECRET	Gemini (Google)	—
GEMINI_CLI_OAUTH_CLIENT_ID	Gemini CLI	Usually same as Gemini.
GEMINI_CLI_OAUTH_CLIENT_SECRET	Gemini CLI	—
QWEN_OAUTH_CLIENT_ID	Qwen (Alibaba)	Public client.
KIMI_CODING_OAUTH_CLIENT_ID	Kimi Coding (Moonshot)	Public client.
ANTIGRAVITY_OAUTH_CLIENT_ID	Antigravity (Google)	Requires matching _SECRET.
ANTIGRAVITY_OAUTH_CLIENT_SECRET	Antigravity (Google)	—
GITHUB_OAUTH_CLIENT_ID	GitHub Copilot	Public client.
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.

Warning

Google OAuth (Antigravity, Gemini CLI) credentials only work on localhost. For remote servers:

1. Go to Google Cloud Console → Credentials
2. Create an OAuth 2.0 Client ID (type: "Web application")
3. Add your server URL as Authorized redirect URI
4. 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.121 (external, cli)	When Anthropic releases a new CLI version
CODEX_USER_AGENT	codex-cli/0.125.0 (Windows 10.0.26100; x64)	When OpenAI updates the Codex CLI
CODEX_CLIENT_VERSION	0.125.0	Override Codex client version independently of full UA string
GITHUB_USER_AGENT	GitHubCopilotChat/0.45.1	When GitHub Copilot Chat updates
ANTIGRAVITY_USER_AGENT	antigravity/1.107.0 darwin/arm64	When Antigravity IDE updates
KIRO_USER_AGENT	AWS-SDK-JS/3.0.0 kiro-ide/1.0.0	When Kiro IDE updates
QODER_USER_AGENT	Qoder-Cli	When Qoder CLI updates
QWEN_USER_AGENT	QwenCode/0.15.3 (linux; x64)	When Qwen Code updates
CURSOR_USER_AGENT	connect-es/1.6.1	When Cursor updates
GEMINI_CLI_USER_AGENT	google-api-nodejs-client/10.3.0	When Google API client updates

Tip

You can add User-Agent overrides for any provider using the pattern {PROVIDER_ID}_USER_AGENT. The executor dynamically constructs the env var name.

---

13. CLI Fingerprint Compatibility

When enabled, OmniRoute reorders HTTP headers and JSON body fields to match the exact signature of official CLI tools. This reduces the risk of account flagging while preserving your proxy IP.

Source: open-sse/config/cliFingerprints.ts, open-sse/executors/base.ts

Per-Provider

Variable	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_KIRO=1	Mimics Kiro IDE 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	Effect
CLI_COMPAT_ALL=1	Enable fingerprint compatibility for all providers at once.

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
GROQ_API_KEY	Groq
XAI_API_KEY	xAI (Grok)
MISTRAL_API_KEY	Mistral AI
PERPLEXITY_API_KEY	Perplexity
TOGETHER_API_KEY	Together AI
FIREWORKS_API_KEY	Fireworks AI
CEREBRAS_API_KEY	Cerebras
COHERE_API_KEY	Cohere
NVIDIA_API_KEY	NVIDIA NIM
NEBIUS_API_KEY	Nebius (embeddings)
QIANFAN_API_KEY	Baidu Qianfan

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)
└─→ 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.
FETCH_HEADERS_TIMEOUT_MS	= FETCH_TIMEOUT_MS	Time to receive response headers.
FETCH_BODY_TIMEOUT_MS	= FETCH_TIMEOUT_MS	Time to receive the full response body.
FETCH_CONNECT_TIMEOUT_MS	30000	TCP connection establishment timeout.
FETCH_KEEPALIVE_TIMEOUT_MS	4000	Keep-alive socket idle timeout.
TLS_CLIENT_TIMEOUT_MS	= FETCH_TIMEOUT_MS	TLS fingerprint proxy (wreq-js) timeout.
API_BRIDGE_PROXY_TIMEOUT_MS	30000	Proxy hop timeout for /v1 bridge requests.
API_BRIDGE_SERVER_REQUEST_TIMEOUT_MS	300000	Overall server request timeout for the bridge.
API_BRIDGE_SERVER_HEADERS_TIMEOUT_MS	60000	Time to send response headers via the bridge.
API_BRIDGE_SERVER_KEEPALIVE_TIMEOUT_MS	5000	Bridge keep-alive idle timeout.
API_BRIDGE_SERVER_SOCKET_TIMEOUT_MS	0	Raw socket timeout (0 = disabled).
SHUTDOWN_TIMEOUT_MS	30000	Grace period on SIGTERM/SIGINT before force-exit.

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.
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.

---

17. Memory Optimization

Variable	Default	Description
OMNIROUTE_MEMORY_MB	256 (Docker) / system default	V8 heap limit. Sets --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.

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.

---

19. Model Sync (Dev)

Variable	Default	Source File	Description
MODELS_DEV_SYNC_INTERVAL	86400 (24h)	src/lib/modelsDevSync.ts	Development-time model catalog sync interval in seconds.

---

20. Provider-Specific Settings

Variable	Default	Source File	Description
OPENROUTER_CATALOG_TTL_MS	86400000 (24h)	src/lib/catalog/openrouterCatalog.ts	OpenRouter model catalog cache TTL.
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.
CLOUDFLARE_ACCOUNT_ID	(unset)	open-sse/executors/cloudflare-ai.ts	Account ID for Cloudflare Workers AI.
CLOUDFLARED_BIN	auto-detect	src/lib/cloudflaredTunnel.ts	Custom path to cloudflared binary.
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.
CLIPROXYAPI_HOST	127.0.0.1	open-sse/executors/cliproxyapi.ts	CLIProxyAPI bridge host (legacy integration).
CLIPROXYAPI_PORT	5544	open-sse/executors/cliproxyapi.ts	CLIProxyAPI bridge port.
CLIPROXYAPI_CONFIG_DIR	~/.cli-proxy-api	src/lib/versionManager/processManager.ts	CLIProxyAPI config directory.
LOCAL_HOSTNAMES	(empty)	open-sse/config/providerRegistry.ts	Comma-separated additional hostnames treated as "local" (Docker service names, etc.).

ENABLE_CC_COMPATIBLE_PROVIDER is only for third-party relays that accept Claude Code clients exclusively. OmniRoute rewrites requests so those relays accept them. If you only want to use Claude Code CLI, or you are not sure what these relays are, keep this disabled and add a regular Anthropic-compatible provider instead.

---

21. Proxy Health

Variable	Default	Source File	Description
PROXY_FAST_FAIL_TIMEOUT_MS	2000	src/lib/proxyHealth.ts	Fast-fail health check timeout.
PROXY_HEALTH_CACHE_TTL_MS	30000	src/lib/proxyHealth.ts	Health check result cache TTL.
RATE_LIMIT_MAX_WAIT_MS	120000 (2 min)	open-sse/services/rateLimitManager.ts	Max time to wait on a 429 before failing the request.
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.

---

22. Debugging

Caution

These variables produce verbose output and may leak sensitive data. Never enable in production.

Variable	Default	Source File	Description
CURSOR_PROTOBUF_DEBUG	(unset)	open-sse/utils/cursorProtobuf.ts	Set 1 to dump Cursor protobuf decode/encode details.
CURSOR_STREAM_DEBUG	(unset)	open-sse/executors/cursor.ts	Set 1 to dump raw Cursor SSE stream data.
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.

---

Deployment Scenarios

Minimal Local Development

JWT_SECRET=$(openssl rand -base64 48)
API_KEY_SECRET=$(openssl rand -hex 32)
INITIAL_PASSWORD=dev123
PORT=20128
NODE_ENV=development

Docker Production

JWT_SECRET=<generated>
API_KEY_SECRET=<generated>
INITIAL_PASSWORD=<generated>
STORAGE_ENCRYPTION_KEY=<generated>
DATA_DIR=/data
PORT=20128
API_PORT=20129
NODE_ENV=production
AUTH_COOKIE_SECURE=true
REQUIRE_API_KEY=true
NEXT_PUBLIC_BASE_URL=https://omniroute.example.com
BASE_URL=http://localhost:20128
OMNIROUTE_MEMORY_MB=512
CORS_ORIGIN=https://your-frontend.example.com

Air-Gapped / CI

JWT_SECRET=test-jwt-secret-for-ci
API_KEY_SECRET=test-api-key-secret-for-ci
INITIAL_PASSWORD=testpass
NODE_ENV=production
OMNIROUTE_DISABLE_BACKGROUND_SERVICES=true
APP_LOG_TO_FILE=false

VPS with Reverse Proxy (nginx + Cloudflare)

JWT_SECRET=<generated>
API_KEY_SECRET=<generated>
STORAGE_ENCRYPTION_KEY=<generated>
PORT=20128
AUTH_COOKIE_SECURE=true
REQUIRE_API_KEY=true
NEXT_PUBLIC_BASE_URL=https://omniroute.example.com
BASE_URL=http://127.0.0.1:20128
CORS_ORIGIN=https://omniroute.example.com
ENABLE_TLS_FINGERPRINT=true
CLI_COMPAT_ALL=1

---

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.

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