OmniRoute/docs/guides/DOCKER_GUIDE.md

title, version, lastUpdated

title	version	lastUpdated
🐳 Docker Guide — OmniRoute	3.8.40	2026-06-28

🐳 Docker Guide — OmniRoute

Complete Docker deployment reference. For a quick start, see the README Docker section.

Table of Contents

• Quick Run
• With Environment File
• Docker Compose
• Available Profiles
• Redis Sidecar
• Production Compose
• Dockerfile Stages
• Critical Environment Variables
• Docker Compose with Caddy (HTTPS)
• Cloudflare Quick Tunnel
• Image Tags
• Important Notes

---

Quick Run

docker run -d \
  --name omniroute \
  --restart unless-stopped \
  --stop-timeout 40 \
  -p 20128:20128 \
  -v omniroute-data:/app/data \
  diegosouzapw/omniroute:latest

With Environment File

# Copy and edit .env first
cp .env.example .env

docker run -d \
  --name omniroute \
  --restart unless-stopped \
  --stop-timeout 40 \
  --env-file .env \
  -p 20128:20128 \
  -v omniroute-data:/app/data \
  diegosouzapw/omniroute:latest

Docker Compose

# Base profile (no CLI tools)
docker compose --profile base up -d

# CLI profile (Claude Code, Codex, OpenClaw built-in)
docker compose --profile cli up -d

# Host profile (Linux-first; mounts host CLI binaries read-only)
docker compose --profile host up -d

# Combine CLI + CLIProxyAPI sidecar
docker compose --profile cli --profile cliproxyapi up -d

Available Profiles

OmniRoute ships four Compose profiles. Pick the one that matches your environment.

Profile	Service	When to use	Command
base (default)	omniroute-base	Headless server / minimal runtime, no provider CLIs bundled	docker compose --profile base up -d
cli	omniroute-cli	Agentic workflows that call omniroute providers/setup/doctor and bundled CLIs (Codex, Claude Code, Droid, OpenClaw)	docker compose --profile cli up -d
host	omniroute-host	Linux hosts that want network_mode-like access to host CLIs by mounting ~/.local/bin, ~/.codex, ~/.claude, etc. read-only	docker compose --profile host up -d
cliproxyapi	cliproxyapi	Run the CLIProxyAPI sidecar on port 8317 for upstream CLI proxying	docker compose --profile cliproxyapi up -d

Multiple profiles can be combined: docker compose --profile cli --profile cliproxyapi up -d.

Redis Sidecar

OmniRoute relies on Redis to back the distributed rate limiter and shared cache. The redis service is always defined in docker-compose.yml (it has no profile gate) and starts alongside any other profile.

Detail	Value
Image	redis:7-alpine
Container name	omniroute-redis
Internal port	6379
Host port (override)	REDIS_PORT (defaults to 6379)
Host bind (override)	REDIS_BIND_HOST (defaults to 127.0.0.1)
Volume	omniroute-redis-data → /data
Healthcheck	redis-cli ping (10s interval)

Related environment variables:

• REDIS_URL — connection string injected into the app (redis://redis:6379 by default).
• REDIS_PORT — host-side port mapping for the Redis container.
• REDIS_BIND_HOST — host interface the port is published on. Defaults to 127.0.0.1.

Why loopback by default: the sidecar runs without requirepass, and the app containers reach it over the compose network (redis:6379) — the published port is only there for host-side tooling (redis-cli, a local npm run dev). Publishing on 0.0.0.0 would expose an unauthenticated Redis to every host on your LAN. If you set REDIS_BIND_HOST=0.0.0.0, add --requirepass to the service command: as well.

Disabling Redis is not recommended (rate limiter will degrade to in-memory fallback). If you must, either remove/comment the redis: service block in docker-compose.yml or scale it to zero:

docker compose up -d --scale redis=0

Production Compose

For an isolated production snapshot running alongside dev, use docker-compose.prod.yml.

Detail	Value
File	docker-compose.prod.yml
Default dashboard port	PROD_DASHBOARD_PORT=20130 (mapped to internal ${DASHBOARD_PORT:-20128})
Default API port	PROD_API_PORT=20131
Image	omniroute:prod (built from runner-cli target)
Redis container	omniroute-redis-prod (redis:8.6.2, dedicated redis-prod-data volume)
Data volume	omniroute-prod-data (named, persisted across rebuilds)
Healthchecks	node healthcheck.mjs + redis-cli ping, with depends_on gated on Redis health

How to use:

# Build & start the production stack
docker compose -f docker-compose.prod.yml up -d --build

# Stream logs
docker compose -f docker-compose.prod.yml logs -f

# Tear down (keep volumes)
docker compose -f docker-compose.prod.yml down

The prod stack runs in parallel with the dev compose (different container names, ports, and volumes), so you can keep iterating locally while production stays up.

Dockerfile Stages

The repository ships a multi-stage Dockerfile (Dockerfile). Three stages are exposed; pick the right target for your use case.

Stage	Base image	Purpose
builder	node:26-trixie-slim	Installs deps (npm ci --legacy-peer-deps) and runs npm run build (Turbopack by default — see Build-time resources below)
runner-base	node:26-trixie-slim	Production runtime with the Next.js standalone output. No provider CLIs bundled.
runner-cli	runner-base	Adds git, docker.io, docker-compose and global CLIs: @openai/codex, @anthropic-ai/claude-code, droid, openclaw. Pick this for agentic workflows.

Build a specific target manually:

docker build --target runner-base -t omniroute:base .
docker build --target runner-cli  -t omniroute:cli  .

Build-time resources

Two build args control what the builder stage costs. They are build-time only — OMNIROUTE_MEMORY_MB (below) is a separate, runtime knob.

Build arg	Default	Effect
OMNIROUTE_USE_TURBOPACK	1	0 builds with webpack instead. Lower peak memory, slower.
OMNIROUTE_BUILD_MEMORY_MB	4096	V8 heap ceiling (--max-old-space-size) for the spawned next build.

Turbopack compiles in native Rust memory that lives outside the V8 heap, so OMNIROUTE_BUILD_MEMORY_MB does not bound it. On a host with a memory ceiling the build is then SIGKILLed by the OOM killer with no error text at all — it simply stops mid-Creating an optimized production build, which reads like a hang rather than an out-of-memory. If the build host is constrained, switch bundlers:

docker build --target runner-base \
  --build-arg OMNIROUTE_USE_TURBOPACK=0 \
  -t omniroute:base .

webpackBuildWorker is enabled, so next build runs a parent and a worker process and each honours OMNIROUTE_BUILD_MEMORY_MB separately. Size the container ceiling above roughly twice that value, not once.

Measured on this tree (--target runner-base, OMNIROUTE_BUILD_MEMORY_MB=6144):

Bundler	Container ceiling	Result
Turbopack	8 GiB / 16 GiB	OOM-killed at both, silently
webpack	8 GiB	build worker SIGKILLed
webpack	12 GiB	succeeded, peaked at 11.1 GiB

Runtime defaults

Defaults exported by runner-base: PORT=20128, HOSTNAME=0.0.0.0, OMNIROUTE_MEMORY_MB=1024, NODE_OPTIONS=--max-old-space-size=1024, DATA_DIR=/app/data, OMNIROUTE_MIGRATIONS_DIR=/app/migrations.

Memory behavior in Docker:

• The image sets OMNIROUTE_MEMORY_MB=1024 and derives NODE_OPTIONS=--max-old-space-size=1024 from it.
• The actual server process is started by the standalone launcher, which reads OMNIROUTE_MEMORY_MB and appends --max-old-space-size=<OMNIROUTE_MEMORY_MB>.
• Node uses the last repeated --max-old-space-size value, so setting OMNIROUTE_MEMORY_MB controls the effective Docker heap limit.
• Because the image always sets it, the launcher's own RAM-calibrated fallback never applies under Docker. Raise it explicitly (-e OMNIROUTE_MEMORY_MB=2048) on a host with headroom.

Critical Environment Variables

Beyond the defaults documented in ENVIRONMENT.md, the following variables matter most when running under Docker:

Variable	Purpose	Default
OMNIROUTE_WS_BRIDGE_SECRET	Shared secret for the WebSocket bridge. Required in production — set to a strong random string.	unset (must be provided)
REDIS_URL	Connection string for the rate limiter / cache backend	redis://redis:6379
REDIS_PORT	Host-side port for the bundled Redis container	6379
REDIS_BIND_HOST	Host interface the bundled Redis port is published on (loopback unless you add AUTH)	127.0.0.1
AUTO_UPDATE_HOST_REPO_DIR	Host path mounted into cli profile at /workspace/omniroute for self-update workflows	. (current directory)
OMNIROUTE_MEMORY_MB	Runtime Node heap ceiling for the Docker standalone server; overrides the image default above	1024
DASHBOARD_PORT / API_PORT	Override exposed ports for dashboard (20128) and API (20129)	20128 / 20129
OMNIROUTE_BASE_PATH	URL subpath when the app is published behind a reverse proxy (e.g. /omniroute)	(empty = root)
NEXT_PUBLIC_BASE_URL	Public browser origin including the subpath (e.g. https://host/omniroute)	unset
PROD_DASHBOARD_PORT	Host-side dashboard port for docker-compose.prod.yml	20130
CLIPROXYAPI_PORT	Host-side port for the cliproxyapi sidecar	8317

Reverse Proxy on a Subpath (Traefik / nginx)

Next.js basePath is compiled into the standalone bundle. OmniRoute records the baked value in a sentinel file at the app root (written during npm run build; read by scripts/docker/ensure-docker-base-path.mjs) and compares it with OMNIROUTE_BASE_PATH when the container starts. When they differ and the image was built for the domain root, the entrypoint rewrites the standalone manifests and embedded basePath literals before node dev/run-standalone.mjs runs.

Compose build (recommended)

Set both variables in .env, then rebuild so the image and runtime agree:

# .env
OMNIROUTE_BASE_PATH=/omniroute
NEXT_PUBLIC_BASE_URL=https://myhostname.example.com/omniroute

docker compose --profile base up -d --build

docker-compose.yml forwards OMNIROUTE_BASE_PATH as a Docker build-arg and as a runtime environment variable.

Pre-built root image + runtime subpath

Published diegosouzapw/omniroute:* images are built for the domain root. You can still set OMNIROUTE_BASE_PATH at runtime; the container patches the bundle once on startup. Pair it with the matching public origin:

services:
  omniroute:
    image: diegosouzapw/omniroute:latest
    environment:
      OMNIROUTE_BASE_PATH: /omniroute
      NEXT_PUBLIC_BASE_URL: https://myhostname.example.com/omniroute

Configure the reverse proxy to forward the full external path (do not strip the prefix). Traefik should route PathPrefix(/omniroute) to the container without StripPrefix, so Next.js receives /omniroute/... and serves assets from /omniroute/_next/....

The Docker healthcheck probes /api/monitoring/health prefixed with the active OMNIROUTE_BASE_PATH.

Docker Compose with Caddy (HTTPS Auto-TLS)

OmniRoute can be securely exposed using Caddy's automatic SSL provisioning. Ensure your domain's DNS A record points to your server's IP.

services:
  omniroute:
    image: diegosouzapw/omniroute:latest
    container_name: omniroute
    restart: unless-stopped
    volumes:
      - omniroute-data:/app/data
    environment:
      - PORT=20128
      # Browser-facing origin for OAuth callbacks, dashboard links, and generated public URLs.
      - NEXT_PUBLIC_BASE_URL=https://your-domain.com
      # Internal server-to-server URL for scheduled jobs / self-fetches.
      - BASE_URL=http://omniroute:20128
      - AUTH_COOKIE_SECURE=true

  caddy:
    image: caddy:latest
    container_name: caddy
    restart: unless-stopped
    ports:
      - "80:80"
      - "443:443"
    command: caddy reverse-proxy --from https://your-domain.com --to http://omniroute:20128

volumes:
  omniroute-data:

Caddy sets the standard forwarding headers for the upstream container. OmniRoute uses NEXT_PUBLIC_BASE_URL as the canonical public origin for OAuth callbacks and generated public links; authenticated dashboard writes use same-origin requests plus session-bound CSRF protection. Only enable OMNIROUTE_TRUST_PROXY for advanced deployments where you intentionally want OmniRoute to derive the public origin from trusted forwarded headers instead of explicit configuration.

Cloudflare Quick Tunnel

Dashboard support for Docker deployments includes a one-click Cloudflare Quick Tunnel on Dashboard → Endpoints. The first enable downloads cloudflared only when needed, starts a temporary tunnel to your current /v1 endpoint, and shows the generated https://*.trycloudflare.com/v1 URL directly below your normal public URL.

Endpoint tunnel panels (Cloudflare, Tailscale, ngrok) can be shown or hidden from Settings → Appearance without changing active tunnel state.

Tunnel Notes

• Quick Tunnel URLs are temporary and change after every restart.
• Quick Tunnels are not auto-restored after an OmniRoute or container restart. Re-enable them from the dashboard when needed.
• Managed install currently supports Linux, macOS, and Windows on x64 / arm64.
• Managed Quick Tunnels default to HTTP/2 transport to avoid noisy QUIC UDP buffer warnings in constrained container environments. Set CLOUDFLARED_PROTOCOL=quic or auto if you want a different transport.
• Docker images bundle system CA roots and pass them to managed cloudflared, which avoids TLS trust failures when the tunnel bootstraps inside the container.
• Set CLOUDFLARED_BIN=/absolute/path/to/cloudflared if you want OmniRoute to use an existing binary instead of downloading one.

Image Tags

Image	Tag	Size	Description
diegosouzapw/omniroute	latest	~250MB	Latest stable release
diegosouzapw/omniroute	3.8.0	~250MB	Current version

Multi-platform manifest: linux/amd64 + linux/arm64 native (Apple Silicon, AWS Graviton, Raspberry Pi). Docker selects the matching architecture automatically; pass --platform linux/amd64 if you need to force AMD64 emulation on ARM hosts.

Release Channels

OmniRoute publishes separate Docker channels for stable releases, active release-branch testing, and development builds.

Channel	Source	Mutability	Recommended use
:<version> / :<version>-web	Signed/versioned release	Immutable	Production deployments that pin an exact release
:latest / :latest-web	Highest stable release	Mutable stable pointer	Production deployments that intentionally follow stable releases
:next / :next-web	Current default release/v* branch	Mutable pre-release pointer	Testing fixes that have landed on the active release branch but are not yet in a stable release
:main / :main-web	main branch	Mutable development pointer	Development and integration testing only

Using the pre-release channel

The next channel is rebuilt on every push to the current default release/v* branch and is published for both AMD64 and ARM64. Older maintenance branches cannot overwrite it. The channel provides a pullable image for fixes that have merged into the active release branch before the next stable tag is cut.

docker pull diegosouzapw/omniroute:next
docker pull diegosouzapw/omniroute:next-web

For Docker Compose, override the image tag used by the selected profile, then pull and recreate the service:

services:
  omniroute:
    image: diegosouzapw/omniroute:next

docker compose pull
docker compose up -d

Safety and rollback

next is a floating pre-release channel. It may change on any push to the active release branch and is not supported for production use. Pin the image digest while evaluating a specific build:

docker pull diegosouzapw/omniroute:next
docker image inspect diegosouzapw/omniroute:next --format '{{index .RepoDigests 0}}'

Before testing, back up the OmniRoute data volume or bind-mounted data directory. To roll back, restore the previously used stable version or digest and recreate the container:

docker pull diegosouzapw/omniroute:<stable-version>
docker compose up -d

A release-branch build can never move latest; only an eligible stable semantic version may promote the stable pointer. The next images retain the release image inspection and blocking CRITICAL-vulnerability gate.

Important Notes

• SQLite WAL Mode: docker stop should be allowed to finish so OmniRoute can checkpoint the latest changes back into storage.sqlite. The bundled Compose files already set a 40s stop grace period. If you run the image directly, keep --stop-timeout 40.
• DISABLE_SQLITE_AUTO_BACKUP: Set to true if backups are managed externally.
• Data Persistence: Always mount a volume to /app/data to persist your database, keys, and configurations across container restarts.
• Port Configuration: Override PORT environment variable to change the default 20128 port.

See Also

• VM Deployment Guide — VM + nginx + Cloudflare setup
• Fly.io Deployment Guide — Deploy to Fly.io
• Environment Config — Complete .env reference