Docker(可选)
Docker 是可选的。仅当你想要容器化的 Gateway 网关或验证 Docker 流程时才使用它。Docker 适合我吗?
- 是:你想要一个隔离的、可丢弃的 Gateway 网关环境,或在没有本地安装的主机上运行 OpenClaw。
- 否:你在自己的机器上运行,只想要最快的开发循环。请改用正常的安装流程。
- 沙箱注意事项:智能体沙箱隔离也使用 Docker,但它不需要完整的 Gateway 网关在 Docker 中运行。参阅沙箱隔离。
- 容器化 Gateway 网关(完整的 OpenClaw 在 Docker 中)
- 每会话智能体沙箱(主机 Gateway 网关 + Docker 隔离的智能体工具)
要求
- Docker Desktop(或 Docker Engine)+ Docker Compose v2
- 足够的磁盘空间用于镜像 + 日志
容器化 Gateway 网关(Docker Compose)
快速开始(推荐)
从仓库根目录:- 构建 Gateway 网关镜像
- 运行新手引导向导
- 打印可选的提供商设置提示
- 通过 Docker Compose 启动 Gateway 网关
- 生成 Gateway 网关令牌并写入
.env
OPENCLAW_DOCKER_APT_PACKAGES— 在构建期间安装额外的 apt 包OPENCLAW_EXTRA_MOUNTS— 添加额外的主机绑定挂载OPENCLAW_HOME_VOLUME— 在命名卷中持久化/home/node
- 在浏览器中打开
http://127.0.0.1:18789/。 - 将令牌粘贴到控制 UI(设置 → token)。
- 需要再次获取带令牌的 URL?运行
docker compose run --rm openclaw-cli dashboard --no-open。
~/.openclaw/~/.openclaw/workspace
手动流程(compose)
docker compose ...。如果你启用了 OPENCLAW_EXTRA_MOUNTS 或 OPENCLAW_HOME_VOLUME,设置脚本会写入 docker-compose.extra.yml;在其他地方运行 Compose 时包含它:
控制 UI 令牌 + 配对(Docker)
如果你看到”unauthorized”或”disconnected (1008): pairing required”,获取新的仪表板链接并批准浏览器设备:额外挂载(可选)
如果你想将额外的主机目录挂载到容器中,在运行docker-setup.sh 之前设置 OPENCLAW_EXTRA_MOUNTS。这接受逗号分隔的 Docker 绑定挂载列表,并通过生成 docker-compose.extra.yml 将它们应用到 openclaw-gateway 和 openclaw-cli。
示例:
- 路径必须在 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。
示例:
- 如果你更改
OPENCLAW_HOME_VOLUME,重新运行docker-setup.sh以重新生成额外的 compose 文件。 - 命名卷会持久化直到使用
docker volume rm <name>删除。
安装额外的 apt 包(可选)
如果你需要镜像内的系统包(例如构建工具或媒体库),在运行docker-setup.sh 之前设置 OPENCLAW_DOCKER_APT_PACKAGES。这会在镜像构建期间安装包,因此即使容器被删除它们也会持久化。
示例:
- 这接受空格分隔的 apt 包名称列表。
- 如果你更改
OPENCLAW_DOCKER_APT_PACKAGES,重新运行docker-setup.sh以重建镜像。
高级用户/功能完整的容器(选择加入)
默认的 Docker 镜像是安全优先的,以非 root 的node 用户运行。这保持了较小的攻击面,但这意味着:
- 运行时无法安装系统包
- 默认没有 Homebrew
- 没有捆绑的 Chromium/Playwright 浏览器
- 持久化
/home/node以便浏览器下载和工具缓存能够保留:
- 将系统依赖烘焙到镜像中(可重复 + 持久化):
- 不使用
npx安装 Playwright 浏览器(避免 npm 覆盖冲突):
OPENCLAW_DOCKER_APT_PACKAGES 重建镜像,而不是在运行时使用 --with-deps。
- 持久化 Playwright 浏览器下载:
- 在
docker-compose.yml中设置PLAYWRIGHT_BROWSERS_PATH=/home/node/.cache/ms-playwright。 - 确保
/home/node通过OPENCLAW_HOME_VOLUME持久化,或通过OPENCLAW_EXTRA_MOUNTS挂载/home/node/.cache/ms-playwright。
权限 + EACCES
镜像以node(uid 1000)运行。如果你在 /home/node/.openclaw 上看到权限错误,确保你的主机绑定挂载由 uid 1000 拥有。
示例(Linux 主机):
更快的重建(推荐)
要加速重建,排序你的 Dockerfile 以便依赖层被缓存。这避免了除非锁文件更改否则重新运行pnpm install:
渠道设置(可选)
使用 CLI 容器配置渠道,然后在需要时重启 Gateway 网关。 WhatsApp(QR):OpenAI Codex OAuth(无头 Docker)
如果你在向导中选择 OpenAI Codex OAuth,它会打开浏览器 URL 并尝试在http://127.0.0.1:1455/auth/callback 捕获回调。在 Docker 或无头设置中,该回调可能显示浏览器错误。复制你到达的完整重定向 URL 并将其粘贴回向导以完成认证。
健康检查
E2E 冒烟测试(Docker)
QR 导入冒烟测试(Docker)
注意
- Gateway 网关绑定默认为
lan用于容器使用。 - Dockerfile CMD 使用
--allow-unconfigured;挂载的配置如果gateway.mode不是local仍会启动。覆盖 CMD 以强制执行检查。 - Gateway 网关容器是会话的真实来源(
~/.openclaw/agents/<agentId>/sessions/)。
智能体沙箱(主机 Gateway 网关 + Docker 工具)
深入了解:沙箱隔离它做什么
当启用agents.defaults.sandbox 时,非主会话在 Docker 容器内运行工具。Gateway 网关保持在你的主机上,但工具执行是隔离的:
- 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)。这让你可以在一个 Gateway 网关中运行混合访问级别:
- 完全访问(个人智能体)
- 只读工具 + 只读工作区(家庭/工作智能体)
- 无文件系统/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")。 当setupCommand(或 docker 配置)更改时,OpenClaw 会自动重建容器,除非容器是最近使用的(在约 5 分钟内)。热容器会记录警告,包含确切的openclaw sandbox recreate ...命令。
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" 时忽略)。
构建默认沙箱镜像
Dockerfile.sandbox 构建 openclaw-sandbox:bookworm-slim。
沙箱通用镜像(可选)
如果你想要一个带有常见构建工具(Node、Go、Rust 等)的沙箱镜像,构建通用镜像:openclaw-sandbox-common:bookworm-slim。要使用它:
沙箱浏览器镜像
要在沙箱内运行浏览器工具,构建浏览器镜像:Dockerfile.sandbox-browser 构建 openclaw-sandbox-browser:bookworm-slim。容器运行启用 CDP 的 Chromium 和可选的 noVNC 观察器(通过 Xvfb 有头)。
注意:
- 有头(Xvfb)比无头减少机器人阻止。
- 通过设置
agents.defaults.sandbox.browser.headless=true仍然可以使用无头模式。 - 不需要完整的桌面环境(GNOME);Xvfb 提供显示。
- 沙箱浏览器控制 URL(用于
browser工具) - noVNC URL(如果启用且 headless=false)
browser(并从拒绝中移除它)否则工具仍然被阻止。
清理规则(agents.defaults.sandbox.prune)也适用于浏览器容器。
自定义沙箱镜像
构建你自己的镜像并将配置指向它:工具策略(允许/拒绝)
deny优先于allow。- 如果
allow为空:所有工具(除了 deny)都可用。 - 如果
allow非空:只有allow中的工具可用(减去 deny)。
清理策略
两个选项: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)运行命令,这会 source/etc/profile并可能重置 PATH。设置docker.env.PATH以在前面添加你的自定义工具路径(例如/custom/bin:/usr/local/share/npm-global/bin),或在你的 Dockerfile 中在/etc/profile.d/下添加脚本。