Skip to content

Docker(可选)

Docker 是可选的。仅当你需要容器化网关(Gateway)或验证 Docker 流程时才使用它。


Docker 适合我吗?

  • :你想要一个隔离的、可随时丢弃的网关环境,或者想在不进行本地安装的主机上运行 OpenClaw。
  • :你在自己的机器上运行,只想获得最快的开发循环。请使用常规安装流程。
  • 沙箱说明:智能体(Agent)沙箱(Sandbox)也使用 Docker,但它要求整个网关在 Docker 中运行。参见 沙箱

本指南涵盖:

  • 容器化网关(完整的 OpenClaw 运行在 Docker 中)
  • 按会话(Session)的智能体沙箱(主机网关 + Docker 隔离的智能体工具)

沙箱详情:沙箱


系统要求

  • Docker Desktop(或 Docker Engine)+ Docker Compose v2
  • 足够的磁盘空间用于镜像和日志

容器化网关(Docker Compose)

快速开始(推荐)

从仓库根目录:

bash
./docker-setup.sh

此脚本:

  • 构建网关镜像
  • 运行引导向导
  • 输出可选的提供商设置提示
  • 通过 Docker Compose 启动网关
  • 生成网关 Token 并写入 .env

可选环境变量:

  • OPENCLAW_DOCKER_APT_PACKAGES — 构建时安装额外的 apt 包
  • OPENCLAW_EXTRA_MOUNTS — 添加额外的主机绑定挂载
  • OPENCLAW_HOME_VOLUME — 使用命名卷持久化 /home/node

完成后:

  • 在浏览器中打开 http://127.0.0.1:18789/
  • 将 Token 粘贴到控制面板(Settings → token)。
  • 需要再次获取 URL?运行 docker compose run --rm openclaw-cli dashboard --no-open

配置和工作区(Workspace)写入主机:

  • ~/.openclaw/
  • ~/.openclaw/workspace

在 VPS 上运行?参见 Hetzner(Docker VPS)

Shell 辅助工具(可选)

为了更方便地日常管理 Docker,安装 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

添加到你的 shell 配置(zsh):

bash
echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc

然后使用 clawdock-startclawdock-stopclawdock-dashboard 等命令。运行 clawdock-help 查看所有命令。

详见 ClawDock 辅助工具 README

手动流程(compose)

bash
docker build -t openclaw:local -f Dockerfile .
docker compose run --rm openclaw-cli onboard
docker compose up -d openclaw-gateway

注意:从仓库根目录运行 docker compose ...。如果你启用了 OPENCLAW_EXTRA_MOUNTSOPENCLAW_HOME_VOLUME,设置脚本会写入 docker-compose.extra.yml;在其他地方运行 Compose 时需要包含它:

bash
docker compose -f docker-compose.yml -f docker-compose.extra.yml <command>

控制面板 Token + 配对(Docker)

如果你看到 "unauthorized" 或 "disconnected (1008): pairing required",获取新的面板链接并批准浏览器设备:

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>

更多详情:面板设备

额外挂载(可选)

如果你想将额外的主机目录挂载到容器中,在运行 docker-setup.sh 之前设置 OPENCLAW_EXTRA_MOUNTS。它接受逗号分隔的 Docker 绑定挂载列表,并通过生成 docker-compose.extra.yml 应用到 openclaw-gatewayopenclaw-cli

示例:

bash
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

示例:

bash
export OPENCLAW_HOME_VOLUME="openclaw_home"
./docker-setup.sh

你可以将其与额外挂载组合使用:

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

注意事项:

  • 如果你更改了 OPENCLAW_HOME_VOLUME,重新运行 docker-setup.sh 以重新生成额外的 compose 文件。
  • 命名卷在使用 docker volume rm <name> 删除之前会一直存在。

安装额外的 apt 包(可选)

如果你需要在镜像内安装系统包(例如构建工具或媒体库),在运行 docker-setup.sh 之前设置 OPENCLAW_DOCKER_APT_PACKAGES。这会在镜像构建期间安装这些包, 因此即使容器被删除也会保留。

示例:

bash
export OPENCLAW_DOCKER_APT_PACKAGES="ffmpeg build-essential"
./docker-setup.sh

注意事项:

  • 接受以空格分隔的 apt 包名列表。
  • 如果你更改了 OPENCLAW_DOCKER_APT_PACKAGES,重新运行 docker-setup.sh 以重建镜像。

高级用户 / 全功能容器(可选启用)

默认 Docker 镜像以安全为优先,以非 root 的 node 用户运行。这减小了攻击面,但意味着:

  • 运行时无法安装系统包
  • 默认不含 Homebrew
  • 不包含 Chromium/Playwright 浏览器

如果你想要一个功能更完整的容器,使用以下可选开关:

  1. 持久化 /home/node 以保留浏览器下载和工具缓存:
bash
export OPENCLAW_HOME_VOLUME="openclaw_home"
./docker-setup.sh
  1. 将系统依赖烘焙到镜像中(可重复且持久):
bash
export OPENCLAW_DOCKER_APT_PACKAGES="git curl jq"
./docker-setup.sh
  1. 不使用 npx 安装 Playwright 浏览器(避免 npm 覆盖冲突):
bash
docker compose run --rm openclaw-cli \
  node /app/node_modules/playwright-core/cli.js install chromium

如果你需要 Playwright 安装系统依赖,请使用 OPENCLAW_DOCKER_APT_PACKAGES 重建镜像,而不是在运行时使用 --with-deps

  1. 持久化 Playwright 浏览器下载
  • docker-compose.yml 中设置 PLAYWRIGHT_BROWSERS_PATH=/home/node/.cache/ms-playwright
  • 通过 OPENCLAW_HOME_VOLUME 确保 /home/node 持久化,或通过 OPENCLAW_EXTRA_MOUNTS 挂载 /home/node/.cache/ms-playwright

权限 + EACCES

镜像以 node(uid 1000)用户运行。如果你在 /home/node/.openclaw 上看到权限错误,确保你的主机绑定挂载的所有者是 uid 1000。

示例(Linux 主机):

bash
sudo chown -R 1000:1000 /path/to/openclaw-config /path/to/openclaw-workspace

如果你选择以 root 运行以求方便,你需要接受安全上的妥协。

加速重建(推荐)

为了加速重建,调整你的 Dockerfile 使依赖层被缓存。 这样除非锁文件发生变化,否则不会重新运行 pnpm install

dockerfile
FROM node:22-bookworm

# 安装 Bun(构建脚本需要)
RUN curl -fsSL https://bun.sh/install | bash
ENV PATH="/root/.bun/bin:${PATH}"

RUN corepack enable

WORKDIR /app

# 除非包元数据变化,否则缓存依赖
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 容器配置通道(Channel),然后根据需要重启网关。

WhatsApp(二维码):

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

文档:WhatsAppTelegramDiscord

OpenAI Codex OAuth(无头 Docker)

如果你在向导中选择了 OpenAI Codex OAuth,它会打开一个浏览器 URL 并尝试在 http://127.0.0.1:1455/auth/callback 上捕获回调。在 Docker 或无头环境中, 该回调可能会显示浏览器错误。复制你到达的完整重定向 URL,并将其粘贴回向导以完成认证。

健康检查

bash
docker compose exec openclaw-gateway node dist/index.js health --token "$OPENCLAW_GATEWAY_TOKEN"

E2E 冒烟测试(Docker)

bash
scripts/e2e/onboard-docker.sh

二维码导入冒烟测试(Docker)

bash
pnpm test:docker:qr

注意事项

  • 网关绑定默认为 lan 以供容器使用。
  • Dockerfile CMD 使用 --allow-unconfigured;已挂载的配置中如果 gateway.mode 不是 local 仍会启动。覆盖 CMD 以强制执行检查。
  • 网关容器是会话(Session)的权威来源(~/.openclaw/agents/<agentId>/sessions/)。

智能体沙箱(主机网关 + Docker 工具)

深入了解:沙箱

功能说明

agents.defaults.sandbox 启用时,非主会话在 Docker 容器内运行工具。 网关保留在主机上,但工具执行是隔离的:

  • 作用域:默认为 "agent"(每个智能体一个容器 + 工作区)
  • 作用域:"session" 表示按会话隔离
  • 按作用域的工作区文件夹挂载到 /workspace
  • 可选的智能体工作区访问(agents.defaults.sandbox.workspaceAccess
  • 允许/拒绝工具策略(拒绝优先)
  • 入站媒体被复制到活动沙箱工作区(media/inbound/*),以便工具可以读取(使用 workspaceAccess: "rw" 时,这会落在智能体工作区中)

警告:scope: "shared" 会禁用跨会话隔离。所有会话共享一个容器和一个工作区。

按智能体的沙箱配置(多智能体)

如果你使用多智能体路由,每个智能体可以覆盖沙箱和工具设置: agents.list[].sandboxagents.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
  • 自动清理:空闲 > 24 小时 或 存在时间 > 7 天
  • 网络:默认为 none(如需出站访问请显式开启)
  • 默认允许:execprocessreadwriteeditsessions_listsessions_historysessions_sendsessions_spawnsession_status
  • 默认拒绝:browsercanvasnodescrondiscordgateway

启用沙箱

如果你计划在 setupCommand 中安装包,请注意:

  • 默认 docker.network"none"(无出站访问)。
  • readOnlyRoot: true 会阻止包安装。
  • user 必须是 root 才能执行 apt-get(省略 user 或设置 user: "0:0")。 当 setupCommand(或 docker 配置)发生变化时,OpenClaw 会自动重建容器, 除非容器最近被使用过(约 5 分钟内)。活跃容器会记录一条警告,并附带确切的 openclaw sandbox recreate ... 命令。
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 禁用空闲清理
          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 下: networkuserpidsLimitmemorymemorySwapcpusulimitsseccompProfileapparmorProfilednsextraHosts

多智能体:通过 agents.list[].sandbox.{docker,browser,prune}.* 按智能体覆盖 agents.defaults.sandbox.{docker,browser,prune}.* (当 agents.defaults.sandbox.scope / agents.list[].sandbox.scope"shared" 时忽略)。

构建默认沙箱镜像

bash
scripts/sandbox-setup.sh

这会使用 Dockerfile.sandbox 构建 openclaw-sandbox:bookworm-slim

沙箱通用镜像(可选)

如果你想要一个包含常用构建工具(Node、Go、Rust 等)的沙箱镜像,构建通用镜像:

bash
scripts/sandbox-common-setup.sh

这会构建 openclaw-sandbox-common:bookworm-slim。使用方法:

json5
{
  agents: {
    defaults: {
      sandbox: { docker: { image: "openclaw-sandbox-common:bookworm-slim" } },
    },
  },
}

沙箱浏览器镜像

要在沙箱内运行浏览器工具,构建浏览器镜像:

bash
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 提供显示。

使用配置:

json5
{
  agents: {
    defaults: {
      sandbox: {
        browser: { enabled: true },
      },
    },
  },
}

自定义浏览器镜像:

json5
{
  agents: {
    defaults: {
      sandbox: { browser: { image: "my-openclaw-browser" } },
    },
  },
}

启用后,智能体将获得:

  • 一个沙箱浏览器控制 URL(用于 browser 工具)
  • 一个 noVNC URL(如果已启用且 headless=false)

请记住:如果你使用工具白名单,需要添加 browser(并从拒绝列表中移除),否则该工具仍会被阻止。 清理规则(agents.defaults.sandbox.prune)也适用于浏览器容器。

自定义沙箱镜像

构建你自己的镜像并在配置中指向它:

bash
docker build -t my-openclaw-sbx -f Dockerfile.sandbox .
json5
{
  agents: {
    defaults: {
      sandbox: { docker: { image: "my-openclaw-sbx" } },
    },
  },
}

工具策略(允许/拒绝)

  • deny 优先于 allow
  • 如果 allow 为空:所有工具(除了 deny 中的)可用。
  • 如果 allow 非空:仅 allow 中的工具可用(减去 deny 中的)。

清理策略

两个控制项:

  • prune.idleHours:移除 X 小时内未使用的容器(0 = 禁用)
  • prune.maxAgeDays:移除超过 X 天的容器(0 = 禁用)

示例:

  • 保留活跃会话但限制生命周期: idleHours: 24maxAgeDays: 7
  • 永不清理: idleHours: 0maxAgeDays: 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/ 下添加脚本。

用工程视角拆解 AI 智能体框架