mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-13 11:00:50 +00:00
* feat(docker): add opt-in sandbox support for Docker deployments Enable Docker-based sandbox isolation via OPENCLAW_SANDBOX=1 env var in docker-setup.sh. This is a prerequisite for agents.defaults.sandbox to function in any Docker deployment (self-hosted, Hostinger, DigitalOcean). Changes: - Dockerfile: add OPENCLAW_INSTALL_DOCKER_CLI build arg (~50MB, opt-in) - docker-compose.yml: add commented-out docker.sock mount with docs - docker-setup.sh: auto-detect Docker socket, inject mount, detect GID, build sandbox image, configure sandbox defaults, add group_add All changes are opt-in. Zero impact on existing deployments. Usage: OPENCLAW_SANDBOX=1 ./docker-setup.sh Closes #29933 Related: #7575, #7827, #28401, #10361, #12505, #28326 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: address code review feedback on sandbox support - Persist OPENCLAW_SANDBOX, DOCKER_GID, OPENCLAW_INSTALL_DOCKER_CLI to .env via upsert_env so group_add survives re-runs - Show config set errors instead of swallowing them silently; report partial failure when sandbox config is incomplete - Warn when Dockerfile.sandbox is missing but sandbox config is still applied (sandbox image won't exist) - Fix non-canonical whitespace in apt sources.list entry by using printf instead of echo with line continuation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: remove `local` outside function and guard sandbox behind Docker CLI check - Remove `local` keyword from top-level `sandbox_config_ok` assignment which caused script exit under `set -euo pipefail` (bash `local` outside a function is an error) - Add Docker CLI prerequisite check for pre-built (non-local) images: runs `docker --version` inside the container and skips sandbox setup with a clear warning if the CLI is missing - Split sandbox block so config is only applied after prerequisites pass Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: defer docker.sock mount until sandbox prerequisites pass Move Docker socket mounting from the early setup phase (before image build/pull) to a dedicated compose overlay created only after: 1. Docker CLI is verified inside the container image 2. /var/run/docker.sock exists on the host Previously the socket was mounted optimistically at startup, leaving the host Docker daemon exposed even when sandbox setup was later skipped due to missing Docker CLI. Now the gateway starts without the socket, and a docker-compose.sandbox.yml overlay is generated only when all prerequisites pass. The gateway restart at the end of sandbox setup picks up both the socket mount and sandbox config. Also moves group_add from write_extra_compose() into the sandbox overlay, keeping all sandbox-specific compose configuration together. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs(docker): fix sandbox docs URL in setup output * Docker: harden sandbox setup fallback behavior * Tests: cover docker-setup sandbox edge paths * Docker: roll back sandbox mode on partial config failure * Tests: assert sandbox mode rollback on partial setup * Docs: document Docker sandbox bootstrap env controls * Changelog: credit Docker sandbox bootstrap hardening * Update CHANGELOG.md * Docker: verify Docker apt signing key fingerprint * Docker: avoid sandbox overlay deps during policy writes * Tests: assert no-deps sandbox rollback gateway recreate * Docs: mention OPENCLAW_INSTALL_DOCKER_CLI in Docker env vars --------- Co-authored-by: Jakub Karwowski <jakubkarwowski@Mac.lan> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Vincent Koc <vincentkoc@ieee.org>
765 lines
25 KiB
Markdown
765 lines
25 KiB
Markdown
---
|
||
summary: "Optional Docker-based setup and onboarding for OpenClaw"
|
||
read_when:
|
||
- You want a containerized gateway instead of local installs
|
||
- You are validating the Docker flow
|
||
title: "Docker"
|
||
---
|
||
|
||
# Docker (optional)
|
||
|
||
Docker is **optional**. Use it only if you want a containerized gateway or to validate the Docker flow.
|
||
|
||
## Is Docker right for me?
|
||
|
||
- **Yes**: you want an isolated, throwaway gateway environment or to run OpenClaw on a host without local installs.
|
||
- **No**: you’re running on your own machine and just want the fastest dev loop. Use the normal install flow instead.
|
||
- **Sandboxing note**: agent sandboxing uses Docker too, but it does **not** require the full gateway to run in Docker. See [Sandboxing](/gateway/sandboxing).
|
||
|
||
This guide covers:
|
||
|
||
- Containerized Gateway (full OpenClaw in Docker)
|
||
- Per-session Agent Sandbox (host gateway + Docker-isolated agent tools)
|
||
|
||
Sandboxing details: [Sandboxing](/gateway/sandboxing)
|
||
|
||
## Requirements
|
||
|
||
- Docker Desktop (or Docker Engine) + Docker Compose v2
|
||
- At least 2 GB RAM for image build (`pnpm install` may be OOM-killed on 1 GB hosts with exit 137)
|
||
- Enough disk for images + logs
|
||
|
||
## Containerized Gateway (Docker Compose)
|
||
|
||
### Quick start (recommended)
|
||
|
||
<Note>
|
||
Docker defaults here assume bind modes (`lan`/`loopback`), not host aliases. Use bind
|
||
mode values in `gateway.bind` (for example `lan` or `loopback`), not host aliases like
|
||
`0.0.0.0` or `localhost`.
|
||
</Note>
|
||
|
||
From repo root:
|
||
|
||
```bash
|
||
./docker-setup.sh
|
||
```
|
||
|
||
This script:
|
||
|
||
- builds the gateway image locally (or pulls a remote image if `OPENCLAW_IMAGE` is set)
|
||
- runs the onboarding wizard
|
||
- prints optional provider setup hints
|
||
- starts the gateway via Docker Compose
|
||
- generates a gateway token and writes it to `.env`
|
||
|
||
Optional env vars:
|
||
|
||
- `OPENCLAW_IMAGE` — use a remote image instead of building locally (e.g. `ghcr.io/openclaw/openclaw:latest`)
|
||
- `OPENCLAW_DOCKER_APT_PACKAGES` — install extra apt packages during build
|
||
- `OPENCLAW_EXTRA_MOUNTS` — add extra host bind mounts
|
||
- `OPENCLAW_HOME_VOLUME` — persist `/home/node` in a named volume
|
||
- `OPENCLAW_SANDBOX` — opt in to Docker gateway sandbox bootstrap. Only explicit truthy values enable it: `1`, `true`, `yes`, `on`
|
||
- `OPENCLAW_INSTALL_DOCKER_CLI` — build arg passthrough for local image builds (`1` installs Docker CLI in the image). `docker-setup.sh` sets this automatically when `OPENCLAW_SANDBOX=1` for local builds.
|
||
- `OPENCLAW_DOCKER_SOCKET` — override Docker socket path (default: `DOCKER_HOST=unix://...` path, else `/var/run/docker.sock`)
|
||
- `OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1` — break-glass: allow trusted private-network
|
||
`ws://` targets for CLI/onboarding client paths (default is loopback-only)
|
||
|
||
After it finishes:
|
||
|
||
- Open `http://127.0.0.1:18789/` in your browser.
|
||
- Paste the token into the Control UI (Settings → token).
|
||
- Need the URL again? Run `docker compose run --rm openclaw-cli dashboard --no-open`.
|
||
|
||
### Enable agent sandbox for Docker gateway (opt-in)
|
||
|
||
`docker-setup.sh` can also bootstrap `agents.defaults.sandbox.*` for Docker
|
||
deployments.
|
||
|
||
Enable with:
|
||
|
||
```bash
|
||
export OPENCLAW_SANDBOX=1
|
||
./docker-setup.sh
|
||
```
|
||
|
||
Custom socket path (for example rootless Docker):
|
||
|
||
```bash
|
||
export OPENCLAW_SANDBOX=1
|
||
export OPENCLAW_DOCKER_SOCKET=/run/user/1000/docker.sock
|
||
./docker-setup.sh
|
||
```
|
||
|
||
Notes:
|
||
|
||
- The script mounts `docker.sock` only after sandbox prerequisites pass.
|
||
- If sandbox setup cannot be completed, the script resets
|
||
`agents.defaults.sandbox.mode` to `off` to avoid stale/broken sandbox config
|
||
on reruns.
|
||
- If `Dockerfile.sandbox` is missing, the script prints a warning and continues;
|
||
build `openclaw-sandbox:bookworm-slim` with `scripts/sandbox-setup.sh` if
|
||
needed.
|
||
- For non-local `OPENCLAW_IMAGE` values, the image must already contain Docker
|
||
CLI support for sandbox execution.
|
||
|
||
### Automation/CI (non-interactive, no TTY noise)
|
||
|
||
For scripts and CI, disable Compose pseudo-TTY allocation with `-T`:
|
||
|
||
```bash
|
||
docker compose run -T --rm openclaw-cli gateway probe
|
||
docker compose run -T --rm openclaw-cli devices list --json
|
||
```
|
||
|
||
If your automation exports no Claude session vars, leaving them unset now resolves to
|
||
empty values by default in `docker-compose.yml` to avoid repeated "variable is not set"
|
||
warnings.
|
||
|
||
### Shared-network security note (CLI + gateway)
|
||
|
||
`openclaw-cli` uses `network_mode: "service:openclaw-gateway"` so CLI commands can
|
||
reliably reach the gateway over `127.0.0.1` in Docker.
|
||
|
||
Treat this as a shared trust boundary: loopback binding is not isolation between these two
|
||
containers. If you need stronger separation, run commands from a separate container/host
|
||
network path instead of the bundled `openclaw-cli` service.
|
||
|
||
To reduce impact if the CLI process is compromised, the compose config drops
|
||
`NET_RAW`/`NET_ADMIN` and enables `no-new-privileges` on `openclaw-cli`.
|
||
|
||
It writes config/workspace on the host:
|
||
|
||
- `~/.openclaw/`
|
||
- `~/.openclaw/workspace`
|
||
|
||
Running on a VPS? See [Hetzner (Docker VPS)](/install/hetzner).
|
||
|
||
### Use a remote image (skip local build)
|
||
|
||
Official pre-built images are published at:
|
||
|
||
- [GitHub Container Registry package](https://github.com/openclaw/openclaw/pkgs/container/openclaw)
|
||
|
||
Use image name `ghcr.io/openclaw/openclaw` (not similarly named Docker Hub
|
||
images).
|
||
|
||
Common tags:
|
||
|
||
- `main` — latest build from `main`
|
||
- `<version>` — release tag builds (for example `2026.2.26`)
|
||
- `latest` — latest stable release tag
|
||
|
||
### Base image metadata
|
||
|
||
The main Docker image currently uses:
|
||
|
||
- `node:22-bookworm`
|
||
|
||
The docker image now publishes OCI base-image annotations (sha256 is an example):
|
||
|
||
- `org.opencontainers.image.base.name=docker.io/library/node:22-bookworm`
|
||
- `org.opencontainers.image.base.digest=sha256:cd7bcd2e7a1e6f72052feb023c7f6b722205d3fcab7bbcbd2d1bfdab10b1e935`
|
||
- `org.opencontainers.image.source=https://github.com/openclaw/openclaw`
|
||
- `org.opencontainers.image.url=https://openclaw.ai`
|
||
- `org.opencontainers.image.documentation=https://docs.openclaw.ai/install/docker`
|
||
- `org.opencontainers.image.licenses=MIT`
|
||
- `org.opencontainers.image.title=OpenClaw`
|
||
- `org.opencontainers.image.description=OpenClaw gateway and CLI runtime container image`
|
||
- `org.opencontainers.image.revision=<git-sha>`
|
||
- `org.opencontainers.image.version=<tag-or-main>`
|
||
- `org.opencontainers.image.created=<rfc3339 timestamp>`
|
||
|
||
Reference: [OCI image annotations](https://github.com/opencontainers/image-spec/blob/main/annotations.md)
|
||
|
||
Release context: this repository's tagged history already uses Bookworm in
|
||
`v2026.2.22` and earlier 2026 tags (for example `v2026.2.21`, `v2026.2.9`).
|
||
|
||
By default the setup script builds the image from source. To pull a pre-built
|
||
image instead, set `OPENCLAW_IMAGE` before running the script:
|
||
|
||
```bash
|
||
export OPENCLAW_IMAGE="ghcr.io/openclaw/openclaw:latest"
|
||
./docker-setup.sh
|
||
```
|
||
|
||
The script detects that `OPENCLAW_IMAGE` is not the default `openclaw:local` and
|
||
runs `docker pull` instead of `docker build`. Everything else (onboarding,
|
||
gateway start, token generation) works the same way.
|
||
|
||
`docker-setup.sh` still runs from the repository root because it uses the local
|
||
`docker-compose.yml` and helper files. `OPENCLAW_IMAGE` skips local image build
|
||
time; it does not replace the compose/setup workflow.
|
||
|
||
### Shell Helpers (optional)
|
||
|
||
For easier day-to-day Docker management, install `ClawDock`:
|
||
|
||
```bash
|
||
mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/openclaw/openclaw/main/scripts/shell-helpers/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
|
||
```
|
||
|
||
**Add to your shell config (zsh):**
|
||
|
||
```bash
|
||
echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc
|
||
```
|
||
|
||
Then use `clawdock-start`, `clawdock-stop`, `clawdock-dashboard`, etc. Run `clawdock-help` for all commands.
|
||
|
||
See [`ClawDock` Helper README](https://github.com/openclaw/openclaw/blob/main/scripts/shell-helpers/README.md) for details.
|
||
|
||
### Manual flow (compose)
|
||
|
||
```bash
|
||
docker build -t openclaw:local -f Dockerfile .
|
||
docker compose run --rm openclaw-cli onboard
|
||
docker compose up -d openclaw-gateway
|
||
```
|
||
|
||
Note: run `docker compose ...` from the repo root. If you enabled
|
||
`OPENCLAW_EXTRA_MOUNTS` or `OPENCLAW_HOME_VOLUME`, the setup script writes
|
||
`docker-compose.extra.yml`; include it when running Compose elsewhere:
|
||
|
||
```bash
|
||
docker compose -f docker-compose.yml -f docker-compose.extra.yml <command>
|
||
```
|
||
|
||
### Control UI token + pairing (Docker)
|
||
|
||
If you see “unauthorized” or “disconnected (1008): pairing required”, fetch a
|
||
fresh dashboard link and approve the browser device:
|
||
|
||
```bash
|
||
docker compose run --rm openclaw-cli dashboard --no-open
|
||
docker compose run --rm openclaw-cli devices list
|
||
docker compose run --rm openclaw-cli devices approve <requestId>
|
||
```
|
||
|
||
More detail: [Dashboard](/web/dashboard), [Devices](/cli/devices).
|
||
|
||
### Extra mounts (optional)
|
||
|
||
If you want to mount additional host directories into the containers, set
|
||
`OPENCLAW_EXTRA_MOUNTS` before running `docker-setup.sh`. This accepts a
|
||
comma-separated list of Docker bind mounts and applies them to both
|
||
`openclaw-gateway` and `openclaw-cli` by generating `docker-compose.extra.yml`.
|
||
|
||
Example:
|
||
|
||
```bash
|
||
export OPENCLAW_EXTRA_MOUNTS="$HOME/.codex:/home/node/.codex:ro,$HOME/github:/home/node/github:rw"
|
||
./docker-setup.sh
|
||
```
|
||
|
||
Notes:
|
||
|
||
- Paths must be shared with Docker Desktop on macOS/Windows.
|
||
- Each entry must be `source:target[:options]` with no spaces, tabs, or newlines.
|
||
- If you edit `OPENCLAW_EXTRA_MOUNTS`, rerun `docker-setup.sh` to regenerate the
|
||
extra compose file.
|
||
- `docker-compose.extra.yml` is generated. Don’t hand-edit it.
|
||
|
||
### Persist the entire container home (optional)
|
||
|
||
If you want `/home/node` to persist across container recreation, set a named
|
||
volume via `OPENCLAW_HOME_VOLUME`. This creates a Docker volume and mounts it at
|
||
`/home/node`, while keeping the standard config/workspace bind mounts. Use a
|
||
named volume here (not a bind path); for bind mounts, use
|
||
`OPENCLAW_EXTRA_MOUNTS`.
|
||
|
||
Example:
|
||
|
||
```bash
|
||
export OPENCLAW_HOME_VOLUME="openclaw_home"
|
||
./docker-setup.sh
|
||
```
|
||
|
||
You can combine this with extra mounts:
|
||
|
||
```bash
|
||
export OPENCLAW_HOME_VOLUME="openclaw_home"
|
||
export OPENCLAW_EXTRA_MOUNTS="$HOME/.codex:/home/node/.codex:ro,$HOME/github:/home/node/github:rw"
|
||
./docker-setup.sh
|
||
```
|
||
|
||
Notes:
|
||
|
||
- Named volumes must match `^[A-Za-z0-9][A-Za-z0-9_.-]*$`.
|
||
- If you change `OPENCLAW_HOME_VOLUME`, rerun `docker-setup.sh` to regenerate the
|
||
extra compose file.
|
||
- The named volume persists until removed with `docker volume rm <name>`.
|
||
|
||
### Install extra apt packages (optional)
|
||
|
||
If you need system packages inside the image (for example, build tools or media
|
||
libraries), set `OPENCLAW_DOCKER_APT_PACKAGES` before running `docker-setup.sh`.
|
||
This installs the packages during the image build, so they persist even if the
|
||
container is deleted.
|
||
|
||
Example:
|
||
|
||
```bash
|
||
export OPENCLAW_DOCKER_APT_PACKAGES="ffmpeg build-essential"
|
||
./docker-setup.sh
|
||
```
|
||
|
||
Notes:
|
||
|
||
- This accepts a space-separated list of apt package names.
|
||
- If you change `OPENCLAW_DOCKER_APT_PACKAGES`, rerun `docker-setup.sh` to rebuild
|
||
the image.
|
||
|
||
### Power-user / full-featured container (opt-in)
|
||
|
||
The default Docker image is **security-first** and runs as the non-root `node`
|
||
user. This keeps the attack surface small, but it means:
|
||
|
||
- no system package installs at runtime
|
||
- no Homebrew by default
|
||
- no bundled Chromium/Playwright browsers
|
||
|
||
If you want a more full-featured container, use these opt-in knobs:
|
||
|
||
1. **Persist `/home/node`** so browser downloads and tool caches survive:
|
||
|
||
```bash
|
||
export OPENCLAW_HOME_VOLUME="openclaw_home"
|
||
./docker-setup.sh
|
||
```
|
||
|
||
2. **Bake system deps into the image** (repeatable + persistent):
|
||
|
||
```bash
|
||
export OPENCLAW_DOCKER_APT_PACKAGES="git curl jq"
|
||
./docker-setup.sh
|
||
```
|
||
|
||
3. **Install Playwright browsers without `npx`** (avoids npm override conflicts):
|
||
|
||
```bash
|
||
docker compose run --rm openclaw-cli \
|
||
node /app/node_modules/playwright-core/cli.js install chromium
|
||
```
|
||
|
||
If you need Playwright to install system deps, rebuild the image with
|
||
`OPENCLAW_DOCKER_APT_PACKAGES` instead of using `--with-deps` at runtime.
|
||
|
||
4. **Persist Playwright browser downloads**:
|
||
|
||
- Set `PLAYWRIGHT_BROWSERS_PATH=/home/node/.cache/ms-playwright` in
|
||
`docker-compose.yml`.
|
||
- Ensure `/home/node` persists via `OPENCLAW_HOME_VOLUME`, or mount
|
||
`/home/node/.cache/ms-playwright` via `OPENCLAW_EXTRA_MOUNTS`.
|
||
|
||
### Permissions + EACCES
|
||
|
||
The image runs as `node` (uid 1000). If you see permission errors on
|
||
`/home/node/.openclaw`, make sure your host bind mounts are owned by uid 1000.
|
||
|
||
Example (Linux host):
|
||
|
||
```bash
|
||
sudo chown -R 1000:1000 /path/to/openclaw-config /path/to/openclaw-workspace
|
||
```
|
||
|
||
If you choose to run as root for convenience, you accept the security tradeoff.
|
||
|
||
### Faster rebuilds (recommended)
|
||
|
||
To speed up rebuilds, order your Dockerfile so dependency layers are cached.
|
||
This avoids re-running `pnpm install` unless lockfiles change:
|
||
|
||
```dockerfile
|
||
FROM node:22-bookworm
|
||
|
||
# Install Bun (required for build scripts)
|
||
RUN curl -fsSL https://bun.sh/install | bash
|
||
ENV PATH="/root/.bun/bin:${PATH}"
|
||
|
||
RUN corepack enable
|
||
|
||
WORKDIR /app
|
||
|
||
# Cache dependencies unless package metadata changes
|
||
COPY package.json pnpm-lock.yaml pnpm-workspace.yaml .npmrc ./
|
||
COPY ui/package.json ./ui/package.json
|
||
COPY scripts ./scripts
|
||
|
||
RUN pnpm install --frozen-lockfile
|
||
|
||
COPY . .
|
||
RUN pnpm build
|
||
RUN pnpm ui:install
|
||
RUN pnpm ui:build
|
||
|
||
ENV NODE_ENV=production
|
||
|
||
CMD ["node","dist/index.js"]
|
||
```
|
||
|
||
### Channel setup (optional)
|
||
|
||
Use the CLI container to configure channels, then restart the gateway if needed.
|
||
|
||
WhatsApp (QR):
|
||
|
||
```bash
|
||
docker compose run --rm openclaw-cli channels login
|
||
```
|
||
|
||
Telegram (bot token):
|
||
|
||
```bash
|
||
docker compose run --rm openclaw-cli channels add --channel telegram --token "<token>"
|
||
```
|
||
|
||
Discord (bot token):
|
||
|
||
```bash
|
||
docker compose run --rm openclaw-cli channels add --channel discord --token "<token>"
|
||
```
|
||
|
||
Docs: [WhatsApp](/channels/whatsapp), [Telegram](/channels/telegram), [Discord](/channels/discord)
|
||
|
||
### OpenAI Codex OAuth (headless Docker)
|
||
|
||
If you pick OpenAI Codex OAuth in the wizard, it opens a browser URL and tries
|
||
to capture a callback on `http://127.0.0.1:1455/auth/callback`. In Docker or
|
||
headless setups that callback can show a browser error. Copy the full redirect
|
||
URL you land on and paste it back into the wizard to finish auth.
|
||
|
||
### Health checks
|
||
|
||
Container probe endpoints (no auth required):
|
||
|
||
```bash
|
||
curl -fsS http://127.0.0.1:18789/healthz
|
||
curl -fsS http://127.0.0.1:18789/readyz
|
||
```
|
||
|
||
Aliases: `/health` and `/ready`.
|
||
|
||
The Docker image includes a built-in `HEALTHCHECK` that pings `/healthz` in the
|
||
background. In plain terms: Docker keeps checking if OpenClaw is still
|
||
responsive. If checks keep failing, Docker marks the container as `unhealthy`,
|
||
and orchestration systems (Docker Compose restart policy, Swarm, Kubernetes,
|
||
etc.) can automatically restart or replace it.
|
||
|
||
Authenticated deep health snapshot (gateway + channels):
|
||
|
||
```bash
|
||
docker compose exec openclaw-gateway node dist/index.js health --token "$OPENCLAW_GATEWAY_TOKEN"
|
||
```
|
||
|
||
### E2E smoke test (Docker)
|
||
|
||
```bash
|
||
scripts/e2e/onboard-docker.sh
|
||
```
|
||
|
||
### QR import smoke test (Docker)
|
||
|
||
```bash
|
||
pnpm test:docker:qr
|
||
```
|
||
|
||
### LAN vs loopback (Docker Compose)
|
||
|
||
`docker-setup.sh` defaults `OPENCLAW_GATEWAY_BIND=lan` so host access to
|
||
`http://127.0.0.1:18789` works with Docker port publishing.
|
||
|
||
- `lan` (default): host browser + host CLI can reach the published gateway port.
|
||
- `loopback`: only processes inside the container network namespace can reach
|
||
the gateway directly; host-published port access may fail.
|
||
|
||
The setup script also pins `gateway.mode=local` after onboarding so Docker CLI
|
||
commands default to local loopback targeting.
|
||
|
||
Legacy config note: use bind mode values in `gateway.bind` (`lan` / `loopback` /
|
||
`custom` / `tailnet` / `auto`), not host aliases (`0.0.0.0`, `127.0.0.1`,
|
||
`localhost`, `::`, `::1`).
|
||
|
||
If you see `Gateway target: ws://172.x.x.x:18789` or repeated `pairing required`
|
||
errors from Docker CLI commands, run:
|
||
|
||
```bash
|
||
docker compose run --rm openclaw-cli config set gateway.mode local
|
||
docker compose run --rm openclaw-cli config set gateway.bind lan
|
||
docker compose run --rm openclaw-cli devices list --url ws://127.0.0.1:18789
|
||
```
|
||
|
||
### Notes
|
||
|
||
- Gateway bind defaults to `lan` for container use (`OPENCLAW_GATEWAY_BIND`).
|
||
- Dockerfile CMD uses `--allow-unconfigured`; mounted config with `gateway.mode` not `local` will still start. Override CMD to enforce the guard.
|
||
- The gateway container is the source of truth for sessions (`~/.openclaw/agents/<agentId>/sessions/`).
|
||
|
||
## Agent Sandbox (host gateway + Docker tools)
|
||
|
||
Deep dive: [Sandboxing](/gateway/sandboxing)
|
||
|
||
### What it does
|
||
|
||
When `agents.defaults.sandbox` is enabled, **non-main sessions** run tools inside a Docker
|
||
container. The gateway stays on your host, but the tool execution is isolated:
|
||
|
||
- scope: `"agent"` by default (one container + workspace per agent)
|
||
- scope: `"session"` for per-session isolation
|
||
- per-scope workspace folder mounted at `/workspace`
|
||
- optional agent workspace access (`agents.defaults.sandbox.workspaceAccess`)
|
||
- allow/deny tool policy (deny wins)
|
||
- inbound media is copied into the active sandbox workspace (`media/inbound/*`) so tools can read it (with `workspaceAccess: "rw"`, this lands in the agent workspace)
|
||
|
||
Warning: `scope: "shared"` disables cross-session isolation. All sessions share
|
||
one container and one workspace.
|
||
|
||
### Per-agent sandbox profiles (multi-agent)
|
||
|
||
If you use multi-agent routing, each agent can override sandbox + tool settings:
|
||
`agents.list[].sandbox` and `agents.list[].tools` (plus `agents.list[].tools.sandbox.tools`). This lets you run
|
||
mixed access levels in one gateway:
|
||
|
||
- Full access (personal agent)
|
||
- Read-only tools + read-only workspace (family/work agent)
|
||
- No filesystem/shell tools (public agent)
|
||
|
||
See [Multi-Agent Sandbox & Tools](/tools/multi-agent-sandbox-tools) for examples,
|
||
precedence, and troubleshooting.
|
||
|
||
### Default behavior
|
||
|
||
- Image: `openclaw-sandbox:bookworm-slim`
|
||
- One container per agent
|
||
- Agent workspace access: `workspaceAccess: "none"` (default) uses `~/.openclaw/sandboxes`
|
||
- `"ro"` keeps the sandbox workspace at `/workspace` and mounts the agent workspace read-only at `/agent` (disables `write`/`edit`/`apply_patch`)
|
||
- `"rw"` mounts the agent workspace read/write at `/workspace`
|
||
- Auto-prune: idle > 24h OR age > 7d
|
||
- Network: `none` by default (explicitly opt-in if you need egress)
|
||
- `host` is blocked.
|
||
- `container:<id>` is blocked by default (namespace-join risk).
|
||
- Default allow: `exec`, `process`, `read`, `write`, `edit`, `sessions_list`, `sessions_history`, `sessions_send`, `sessions_spawn`, `session_status`
|
||
- Default deny: `browser`, `canvas`, `nodes`, `cron`, `discord`, `gateway`
|
||
|
||
### Enable sandboxing
|
||
|
||
If you plan to install packages in `setupCommand`, note:
|
||
|
||
- Default `docker.network` is `"none"` (no egress).
|
||
- `docker.network: "host"` is blocked.
|
||
- `docker.network: "container:<id>"` is blocked by default.
|
||
- Break-glass override: `agents.defaults.sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`.
|
||
- `readOnlyRoot: true` blocks package installs.
|
||
- `user` must be root for `apt-get` (omit `user` or set `user: "0:0"`).
|
||
OpenClaw auto-recreates containers when `setupCommand` (or docker config) changes
|
||
unless the container was **recently used** (within ~5 minutes). Hot containers
|
||
log a warning with the exact `openclaw sandbox recreate ...` command.
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
sandbox: {
|
||
mode: "non-main", // off | non-main | all
|
||
scope: "agent", // session | agent | shared (agent is default)
|
||
workspaceAccess: "none", // none | ro | rw
|
||
workspaceRoot: "~/.openclaw/sandboxes",
|
||
docker: {
|
||
image: "openclaw-sandbox:bookworm-slim",
|
||
workdir: "/workspace",
|
||
readOnlyRoot: true,
|
||
tmpfs: ["/tmp", "/var/tmp", "/run"],
|
||
network: "none",
|
||
user: "1000:1000",
|
||
capDrop: ["ALL"],
|
||
env: { LANG: "C.UTF-8" },
|
||
setupCommand: "apt-get update && apt-get install -y git curl jq",
|
||
pidsLimit: 256,
|
||
memory: "1g",
|
||
memorySwap: "2g",
|
||
cpus: 1,
|
||
ulimits: {
|
||
nofile: { soft: 1024, hard: 2048 },
|
||
nproc: 256,
|
||
},
|
||
seccompProfile: "/path/to/seccomp.json",
|
||
apparmorProfile: "openclaw-sandbox",
|
||
dns: ["1.1.1.1", "8.8.8.8"],
|
||
extraHosts: ["internal.service:10.0.0.5"],
|
||
},
|
||
prune: {
|
||
idleHours: 24, // 0 disables idle pruning
|
||
maxAgeDays: 7, // 0 disables max-age pruning
|
||
},
|
||
},
|
||
},
|
||
},
|
||
tools: {
|
||
sandbox: {
|
||
tools: {
|
||
allow: [
|
||
"exec",
|
||
"process",
|
||
"read",
|
||
"write",
|
||
"edit",
|
||
"sessions_list",
|
||
"sessions_history",
|
||
"sessions_send",
|
||
"sessions_spawn",
|
||
"session_status",
|
||
],
|
||
deny: ["browser", "canvas", "nodes", "cron", "discord", "gateway"],
|
||
},
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
Hardening knobs live under `agents.defaults.sandbox.docker`:
|
||
`network`, `user`, `pidsLimit`, `memory`, `memorySwap`, `cpus`, `ulimits`,
|
||
`seccompProfile`, `apparmorProfile`, `dns`, `extraHosts`,
|
||
`dangerouslyAllowContainerNamespaceJoin` (break-glass only).
|
||
|
||
Multi-agent: override `agents.defaults.sandbox.{docker,browser,prune}.*` per agent via `agents.list[].sandbox.{docker,browser,prune}.*`
|
||
(ignored when `agents.defaults.sandbox.scope` / `agents.list[].sandbox.scope` is `"shared"`).
|
||
|
||
### Build the default sandbox image
|
||
|
||
```bash
|
||
scripts/sandbox-setup.sh
|
||
```
|
||
|
||
This builds `openclaw-sandbox:bookworm-slim` using `Dockerfile.sandbox`.
|
||
|
||
### Sandbox common image (optional)
|
||
|
||
If you want a sandbox image with common build tooling (Node, Go, Rust, etc.), build the common image:
|
||
|
||
```bash
|
||
scripts/sandbox-common-setup.sh
|
||
```
|
||
|
||
This builds `openclaw-sandbox-common:bookworm-slim`. To use it:
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
sandbox: { docker: { image: "openclaw-sandbox-common:bookworm-slim" } },
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
### Sandbox browser image
|
||
|
||
To run the browser tool inside the sandbox, build the browser image:
|
||
|
||
```bash
|
||
scripts/sandbox-browser-setup.sh
|
||
```
|
||
|
||
This builds `openclaw-sandbox-browser:bookworm-slim` using
|
||
`Dockerfile.sandbox-browser`. The container runs Chromium with CDP enabled and
|
||
an optional noVNC observer (headful via Xvfb).
|
||
|
||
Notes:
|
||
|
||
- Headful (Xvfb) reduces bot blocking vs headless.
|
||
- Headless can still be used by setting `agents.defaults.sandbox.browser.headless=true`.
|
||
- No full desktop environment (GNOME) is needed; Xvfb provides the display.
|
||
- Browser containers default to a dedicated Docker network (`openclaw-sandbox-browser`) instead of global `bridge`.
|
||
- Optional `agents.defaults.sandbox.browser.cdpSourceRange` restricts container-edge CDP ingress by CIDR (for example `172.21.0.1/32`).
|
||
- noVNC observer access is password-protected by default; OpenClaw provides a short-lived observer token URL that serves a local bootstrap page and keeps the password in URL fragment (instead of URL query).
|
||
|
||
Use config:
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
sandbox: {
|
||
browser: { enabled: true },
|
||
},
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
Custom browser image:
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
sandbox: { browser: { image: "my-openclaw-browser" } },
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
When enabled, the agent receives:
|
||
|
||
- a sandbox browser control URL (for the `browser` tool)
|
||
- a noVNC URL (if enabled and headless=false)
|
||
|
||
Remember: if you use an allowlist for tools, add `browser` (and remove it from
|
||
deny) or the tool remains blocked.
|
||
Prune rules (`agents.defaults.sandbox.prune`) apply to browser containers too.
|
||
|
||
### Custom sandbox image
|
||
|
||
Build your own image and point config to it:
|
||
|
||
```bash
|
||
docker build -t my-openclaw-sbx -f Dockerfile.sandbox .
|
||
```
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
sandbox: { docker: { image: "my-openclaw-sbx" } },
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
### Tool policy (allow/deny)
|
||
|
||
- `deny` wins over `allow`.
|
||
- If `allow` is empty: all tools (except deny) are available.
|
||
- If `allow` is non-empty: only tools in `allow` are available (minus deny).
|
||
|
||
### Pruning strategy
|
||
|
||
Two knobs:
|
||
|
||
- `prune.idleHours`: remove containers not used in X hours (0 = disable)
|
||
- `prune.maxAgeDays`: remove containers older than X days (0 = disable)
|
||
|
||
Example:
|
||
|
||
- Keep busy sessions but cap lifetime:
|
||
`idleHours: 24`, `maxAgeDays: 7`
|
||
- Never prune:
|
||
`idleHours: 0`, `maxAgeDays: 0`
|
||
|
||
### Security notes
|
||
|
||
- Hard wall only applies to **tools** (exec/read/write/edit/apply_patch).
|
||
- Host-only tools like browser/camera/canvas are blocked by default.
|
||
- Allowing `browser` in sandbox **breaks isolation** (browser runs on host).
|
||
|
||
## Troubleshooting
|
||
|
||
- Image missing: build with [`scripts/sandbox-setup.sh`](https://github.com/openclaw/openclaw/blob/main/scripts/sandbox-setup.sh) or set `agents.defaults.sandbox.docker.image`.
|
||
- Container not running: it will auto-create per session on demand.
|
||
- Permission errors in sandbox: set `docker.user` to a UID:GID that matches your
|
||
mounted workspace ownership (or chown the workspace folder).
|
||
- Custom tools not found: OpenClaw runs commands with `sh -lc` (login shell), which
|
||
sources `/etc/profile` and may reset PATH. Set `docker.env.PATH` to prepend your
|
||
custom tool paths (e.g., `/custom/bin:/usr/local/share/npm-global/bin`), or add
|
||
a script under `/etc/profile.d/` in your Dockerfile.
|