Docker(可选)
Docker 是可选的。仅在你想要容器化网关或验证 Docker 流程时使用它。
Docker 适合我吗?
- 是:你想要一个隔离的、可丢弃的网关环境,或者在没有本地安装的主机上运行 OpenClaw。
- 否:你在自己的机器上运行,只想要最快的开发循环。改用正常的安装流程。
- 沙箱注意事项:代理沙箱也使用 Docker,但它不需要完整网关在 Docker 中运行。参见 沙箱。
本指南涵盖:
- 容器化网关(Docker 中的完整 OpenClaw)
- 每会话代理沙箱(主机网关 + Docker 隔离的代理工具)
沙箱详细信息:沙箱
要求
- Docker Desktop(或 Docker Engine)+ Docker Compose v2
- 足够的磁盘空间用于镜像 + 日志
容器化网关(Docker Compose)
快速开始(推荐)
从仓库根目录:
./docker-setup.sh
此脚本:
- 构建网关镜像
- 运行入门向导
- 打印可选的提供商设置提示
- 通过 Docker Compose 启动网关
- 生成网关令牌并将其写入 .env
可选的环境变量:
- OPENCLAW_DOCKER_APT_PACKAGES — 在构建期间安装额外的 apt 包
- OPENCLAW_EXTRA_MOUNTS — 添加额外的主机绑定挂载
- OPENCLAW_HOME_VOLUME — 在命名卷中持久化 /home/node
完成后:
- 在浏览器中打开 http://127.0.0.1:18789/。
- 将令牌粘贴到控制 UI(设置 → token)。
它在主机上写入配置/工作区:
- ~/.openclaw/
- ~/.openclaw/workspace
在 VPS 上运行?参见 Hetzner(Docker VPS)。
手动流程(compose)
docker build -t openclaw:local -f Dockerfile .
docker compose run --rm openclaw-cli onboard
docker compose up -d openclaw-gateway
额外挂载(可选)
如果你想将额外的主机目录挂载到容器中,在运行 docker-setup.sh 之前设置 OPENCLAW_EXTRA_MOUNTS。这接受一个逗号分隔的 Docker 绑定挂载列表,并通过生成 docker-compose.extra.yml 将它们应用到 openclaw-gateway 和 openclaw-cli。
示例:
export OPENCLAW_EXTRA_MOUNTS="$HOME/.codex:/home/node/.codex:ro,$HOME/github:/home/node/github:rw"
./docker-setup.sh
注意:
- 路径必须在 macOS/Windows 上与 Docker Desktop 共享。
- 如果你编辑 OPENCLAW_EXTRA_MOUNTS,重新运行 docker-setup.sh 以重新生成 额外的 compose 文件。
- docker-compose.extra.yml 是生成的。不要手动编辑它。
持久化整个容器 home(可选)
如果你想让 /home/node 在容器重新创建时持久化,通过 OPENCLAW_HOME_VOLUME 设置命名卷。这会创建一个 Docker 卷并将其挂载到 /home/node,同时保留标准的配置/工作区绑定挂载。在这里使用命名卷(不是绑定路径);对于绑定挂载,使用 OPENCLAW_EXTRA_MOUNTS。
示例:
export OPENCLAW_HOME_VOLUME="openclaw_home"
./docker-setup.sh
你可以将此与额外挂载结合使用:
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
注意:
- 如果你更改 OPENCLAW_HOME_VOLUME,重新运行 docker-setup.sh 以重新生成 额外的 compose 文件。
- 命名卷会持久化,直到使用 docker volume rm <name> 删除。
安装额外的 apt 包(可选)
如果你需要镜像内的系统包(例如,构建工具或媒体库),在运行 docker-setup.sh 之前设置 OPENCLAW_DOCKER_APT_PACKAGES。 这会在镜像构建期间安装包,因此即使容器被删除,它们也会持久化。
示例:
export OPENCLAW_DOCKER_APT_PACKAGES="ffmpeg build-essential"
./docker-setup.sh
注意:
- 这接受一个以空格分隔的 apt 包名称列表。
- 如果你更改 OPENCLAW_DOCKER_APT_PACKAGES,重新运行 docker-setup.sh 以重建 镜像。
更快的重建(推荐)
要加快重建速度,排序你的 Dockerfile 以便缓存依赖层。 这避免重新运行 pnpm install,除非锁文件更改:
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"]
通道设置(可选)
使用 CLI 容器配置通道,然后在需要时重启网关。
WhatsApp(QR):
docker compose run --rm openclaw-cli channels login
Telegram(机器人令牌):
docker compose run --rm openclaw-cli channels add --channel telegram --token "<token>"
Discord(机器人令牌):
docker compose run --rm openclaw-cli channels add --channel discord --token "<token>"
健康检查
docker compose exec openclaw-gateway node dist/index.js health --token "$OPENCLAW_GATEWAY_TOKEN"
E2E 冒烟测试(Docker)
scripts/e2e/onboard-docker.sh
QR 导入冒烟测试(Docker)
pnpm test:docker:qr
注意事项
- 网关绑定默认为 lan 用于容器使用。
- 网关容器是会话的权威来源(~/.openclaw/agents/<agentId>/sessions/)。
代理沙箱(主机网关 + Docker 工具)
深入了解:沙箱
它的作用
当启用 agents.defaults.sandbox 时,非主会话在 Docker 容器内运行工具。网关保留在你的主机上,但工具执行是隔离的:
- scope:默认为 "agent"(每个代理一个容器 + 工作区)
- scope:"session" 用于每会话隔离
- 每作用域工作区文件夹挂载在 /workspace
- 可选的代理工作区访问(agents.defaults.sandbox.workspaceAccess)
- 允许/拒绝工具策略(拒绝优先)
- 入站媒体被复制到活动沙箱工作区(media/inbound/*),以便工具可以读取它(使用 workspaceAccess: "rw",这会落入代理工作区)
警告:scope: "shared" 禁用跨会话隔离。所有会话共享一个容器和一个工作区。
每代理沙箱配置文件(多代理)
如果你使用多代理路由,每个代理可以覆盖沙箱 + 工具设置: agents.list[].sandbox 和 agents.list[].tools(以及 agents.list[].tools.sandbox.tools)。这让你在一个网关中运行混合访问级别:
- 完全访问(个人代理)
- 只读工具 + 只读工作区(家庭/工作代理)
- 无文件系统/shell 工具(公共代理)
有关示例、优先级和故障排除,请参见 多代理沙箱和工具。
默认行为
- 镜像:openclaw-sandbox:bookworm-slim
- 每个代理一个容器
- 代理工作区访问:workspaceAccess: "none"(默认)使用 ~/.openclaw/sandboxes
- "ro" 将沙箱工作区保留在 /workspace,并将代理工作区以只读方式挂载在 /agent(禁用 write/edit/apply_patch)
- "rw" 将代理工作区以读写方式挂载在 /workspace
- 自动清理:闲置 > 24h 或年龄 > 7d
- 网络:默认 none(如果需要出口,请明确选择)
- 默认允许:exec、process、read、write、edit、sessions_list、sessions_history、sessions_send、sessions_spawn、session_status
- 默认拒绝:browser、canvas、nodes、cron、discord、gateway
启用沙箱
如果你计划在 setupCommand 中安装包,请注意:
- 默认 docker.network 是 "none"(无出口)。
- readOnlyRoot: true 阻止包安装。
- user 必须是 root 才能使用 apt-get(省略 user 或设置 user: "0:0")。 OpenClaw 在 setupCommand(或 docker 配置)更改时自动重新创建容器,除非容器最近使用过(约 5 分钟内)。热容器会记录一条警告,其中包含确切的 openclaw sandbox recreate ... 命令。
{
agents: {
defaults: {
sandbox: {
mode: "non-main", // off | non-main | all
scope: "agent", // session | agent | shared(agent 是默认值)
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 禁用闲置清理
maxAgeDays: 7 // 0 禁用最大年龄清理
}
}
}
},
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"]
}
}
}
}
加固旋钮位于 agents.defaults.sandbox.docker 下: network、user、pidsLimit、memory、memorySwap、cpus、ulimits、 seccompProfile、apparmorProfile、dns、extraHosts。
多代理:通过 agents.list[].sandbox.{docker,browser,prune}.* 覆盖每个代理的 agents.defaults.sandbox.{docker,browser,prune}.* (当 agents.defaults.sandbox.scope / agents.list[].sandbox.scope 为 "shared" 时忽略)。
构建默认沙箱镜像
scripts/sandbox-setup.sh
这使用 Dockerfile.sandbox 构建 openclaw-sandbox:bookworm-slim。
沙箱通用镜像(可选)
如果你想要一个带有常见构建工具(Node、Go、Rust 等)的沙箱镜像,构建通用镜像:
scripts/sandbox-common-setup.sh
这会构建 openclaw-sandbox-common:bookworm-slim。要使用它:
{
agents: { defaults: { sandbox: { docker: { image: "openclaw-sandbox-common:bookworm-slim" } } } }
}
沙箱浏览器镜像
要在沙箱内运行浏览器工具,构建浏览器镜像:
scripts/sandbox-browser-setup.sh
这使用 Dockerfile.sandbox-browser 构建 openclaw-sandbox-browser:bookworm-slim。容器运行启用了 CDP 的 Chromium 和可选的 noVNC 观察器(通过 Xvfb 有头)。
注意:
- 有头(Xvfb)比无头减少机器人阻止。
- 无头仍然可以通过设置 agents.defaults.sandbox.browser.headless=true 使用。
- 不需要完整的桌面环境(GNOME);Xvfb 提供显示。
使用配置:
{
agents: {
defaults: {
sandbox: {
browser: { enabled: true }
}
}
}
}
自定义浏览器镜像:
{
agents: {
defaults: {
sandbox: { browser: { image: "my-openclaw-browser" } }
}
}
}
启用后,代理接收:
- 沙箱浏览器控制 URL(用于 browser 工具)
- noVNC URL(如果启用且 headless=false)
记住:如果你使用工具的允许列表,添加 browser(并从拒绝中删除它)或工具仍然被阻止。 清理规则(agents.defaults.sandbox.prune)也适用于浏览器容器。
自定义沙箱镜像
构建你自己的镜像并将配置指向它:
docker build -t my-openclaw-sbx -f Dockerfile.sandbox .
{
agents: {
defaults: {
sandbox: { docker: { image: "my-openclaw-sbx" } }
}
}
}
工具策略(允许/拒绝)
- deny 优先于 allow。
- 如果 allow 为空:所有工具(除了拒绝)都可用。
- 如果 allow 非空:只有 allow 中的工具可用(减去拒绝)。
清理策略
两个旋钮:
- prune.idleHours:删除在 X 小时内未使用的容器(0 = 禁用)
- prune.maxAgeDays:删除超过 X 天的容器(0 = 禁用)
示例:
- 保留繁忙会话但限制生命周期: idleHours: 24、maxAgeDays: 7
- 永不清理: idleHours: 0、maxAgeDays: 0
安全注意事项
- 硬墙仅适用于工具(exec/read/write/edit/apply_patch)。
- 仅主机工具如 browser/camera/canvas 默认被阻止。
- 在沙箱中允许 browser 破坏隔离(浏览器在主机上运行)。
故障排除
- 镜像缺失:使用 scripts/sandbox-setup.sh 构建或设置 agents.defaults.sandbox.docker.image。
- 容器未运行:它将根据需要在每个会话上自动创建。
- 沙箱中的权限错误:将 docker.user 设置为与挂载的工作区所有权匹配的 UID:GID(或 chown 工作区文件夹)。
- 找不到自定义工具:OpenClaw 使用 sh -lc(登录 shell)运行命令,它会源 /etc/profile 并可能重置 PATH。设置 docker.env.PATH 以前置你的自定义工具路径(例如,/custom/bin:/usr/local/share/npm-global/bin),或在你的 Dockerfile 中的 /etc/profile.d/ 下添加脚本。