Docker(可選)¶
只有在你想要容器化的 gateway,或驗證 Docker 流程時才使用。 否則請使用一般的安裝流程。
Docker 適合我嗎?¶
- 是:你想要一個隔離、可丟棄的 Gateway 閘道器環境,或在沒有本機安裝的主機上執行 OpenClaw。
- 否:你是在自己的機器上執行,只想要最快的開發迴圈。請改用一般安裝流程。 請參閱 Sandboxing。
- 沙箱隔離注意事項:代理程式沙箱隔離也會使用 Docker,但不需要整個 Gateway 閘道器都在 Docker 中執行。請參閱 Sandboxing。 在 repo 根目錄執行:
本指南涵蓋:
- 容器化 Gateway 閘道器(在 Docker 中執行完整的 OpenClaw)
- 每個工作階段的代理程式沙箱(主機上的 Gateway 閘道器 + Docker 隔離的代理程式工具)
沙箱隔離詳情:Sandboxing
需求¶
- Docker Desktop(或 Docker Engine)+ Docker Compose v2
- 足夠的磁碟空間用於映像檔與記錄
容器化 Gateway 閘道器(Docker Compose)¶
快速開始(建議)¶
此腳本:
./docker-setup.sh
建置 gateway 映像
- 執行上線精靈
- 執行 onboarding 精靈
- 印出可選的提供者設定提示
- 透過 Docker Compose 啟動 Gateway 閘道器
- 產生 Gateway 閘道器權杖,並寫入
.env
將 token 貼到 Control UI(Settings → token)。
OPENCLAW_DOCKER_APT_PACKAGES— 在建置期間安裝額外的 apt 套件OPENCLAW_EXTRA_MOUNTS— 新增額外的主機綁定掛載OPENCLAW_HOME_VOLUME— 以具名磁碟區保存/home/node
完成後:
- 在瀏覽器中開啟
http://127.0.0.1:18789/。 - 需要再次取得 URL?
- 在 VPS 上執行? 需要再次取得 URL?請執行
docker compose run --rm openclaw-cli dashboard --no-open。
它會在主機上寫入設定/工作區:
~/.openclaw/~/.openclaw/workspace
在 VPS 上執行? 在 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 compose ...。如果你啟用了
OPENCLAW_EXTRA_MOUNTS 或 OPENCLAW_HOME_VOLUME,設定腳本會寫入
docker-compose.extra.yml;在其他地方執行 Compose 時請一併包含:
docker compose -f docker-compose.yml -f docker-compose.extra.yml <command>
控制 UI 權杖 + 配對(Docker)¶
如果你看到「unauthorized」或「disconnected (1008): pairing required」,請取得新的儀表板連結並核准瀏覽器裝置:
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-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是自動產生的。請勿手動編輯。 Don’t hand-edit it.
保存整個容器 home(可選)¶
這會建立一個 Docker volume 並掛載到
/home/node,同時保留標準的設定/工作區 bind mounts。 這會建立一個 Docker volume 並將其掛載到
/home/node,同時保留標準的設定/工作區 bind mount。 你可以將此與額外掛載一起使用:
範例:
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 套件(可選)¶
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.
範例:
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 瀏覽器
如果你想要功能更完整的容器,請使用以下選用開關:
- 保存
/home/node,讓瀏覽器下載與工具快取得以保留:
export OPENCLAW_HOME_VOLUME="openclaw_home"
./docker-setup.sh
- 將系統相依套件烘焙進映像檔(可重複且持久):
export OPENCLAW_DOCKER_APT_PACKAGES="git curl jq"
./docker-setup.sh
- 在不使用
npx的情況下安裝 Playwright 瀏覽器(避免 npm 覆寫衝突):
docker compose run --rm openclaw-cli \
node /app/node_modules/playwright-core/cli.js install chromium
如果你需要讓 Playwright 安裝系統相依套件,請使用
OPENCLAW_DOCKER_APT_PACKAGES 重新建置映像檔,而不是在執行時使用 --with-deps。
- 保存 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¶
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.
範例(Linux 主機):
sudo chown -R 1000:1000 /path/to/openclaw-config /path/to/openclaw-workspace
如果你為了方便而選擇以 root 執行,代表你接受相應的安全性取捨。
更快的重新建置(建議)¶
為了加速重新建置,請調整 Dockerfile 的順序,讓相依套件層能被快取。
如此一來,除非鎖定檔變更,否則不需要重新執行 pnpm install:
This avoids re-running pnpm install unless lockfiles change:
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 容器來設定頻道,必要時再重新啟動 Gateway 閘道器。
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>"
OpenAI Codex OAuth(無頭 Docker)¶
如果你在精靈中選擇 OpenAI Codex OAuth,它會開啟一個瀏覽器 URL,並嘗試在
http://127.0.0.1:1455/auth/callback 上接收回呼。在 Docker 或無頭環境中,該回呼可能會顯示瀏覽器錯誤。請複製你最終到達的完整重新導向 URL,並貼回精靈以完成身分驗證。 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.
健康檢查¶
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
注意事項¶
- Gateway 閘道器綁定預設為
lan,以供容器使用。 - Dockerfile 的 CMD 使用
--allow-unconfigured;使用gateway.mode而非local掛載的設定仍可啟動。若要強制檢查,請覆寫 CMD。 Override CMD to enforce the guard. - Gateway 閘道器容器是工作階段(
~/.openclaw/agents/<agentId>/sessions/)的事實來源。
代理程式沙箱(主機 Gateway 閘道器 + Docker 工具)¶
深入說明:Sandboxing
What it does¶
當啟用 agents.defaults.sandbox 時,非主要工作階段 會在 Docker
容器中執行工具。Gateway 閘道器仍留在你的主機上,但工具執行會被隔離: The gateway stays on your host, but the tool execution is isolated:
- 範圍:預設為
"agent"(每個代理程式一個容器 + 工作區) - 範圍:
"session"用於每個工作階段的隔離 - 每個範圍的工作區資料夾會掛載於
/workspace - 可選的代理程式工作區存取(
agents.defaults.sandbox.workspaceAccess) - allow/deny tool policy (deny wins)
- 進站媒體會被複製到作用中的沙箱工作區(
media/inbound/*),讓工具可讀取(搭配workspaceAccess: "rw"時,會落在代理程式工作區)
Warning: scope: "shared" disables cross-session isolation. All sessions share
one container and one workspace.
每個代理程式的沙箱設定檔(多代理程式)¶
如果你使用多代理程式路由,每個代理程式都可以覆寫沙箱與工具設定:
agents.list[].sandbox 與 agents.list[].tools(以及 agents.list[].tools.sandbox.tools)。這讓你能在同一個 Gateway 閘道器中執行混合存取等級: This lets you run
mixed access levels in one gateway:
- 完整存取(個人代理程式)
- 唯讀工具 + 唯讀工作區(家庭/工作代理程式)
- 無檔案系統/殼層工具(公開代理程式)
範例、優先順序與疑難排解,請參閱 Multi-Agent Sandbox & Tools。
Default behavior¶
- 映像檔:
openclaw-sandbox:bookworm-slim - 每個代理程式一個容器
- 代理程式工作區存取:
workspaceAccess: "none"(預設)使用~/.openclaw/sandboxes "ro"會將沙箱工作區保留在/workspace,並將代理程式工作區以唯讀方式掛載於/agent(停用write/edit/apply_patch)"rw"會將代理程式工作區以讀/寫方式掛載於/workspace- 自動修剪:閒置 > 24 小時 或 存在時間 > 7 天
- 網路:預設為
none(若需要對外連線請明確啟用) - 預設允許:
exec、process、read、write、edit、sessions_list、sessions_history、sessions_send、sessions_spawn、session_status - Default deny:
browser,canvas,nodes,cron,discord,gateway
啟用沙箱隔離¶
如果你打算在 setupCommand 中安裝套件,請注意:
- 預設的
docker.network為"none"(無對外連線)。 readOnlyRoot: true會阻止套件安裝。usermust be root forapt-get(omituseror setuser: "0:0"). OpenClaw auto-recreates containers whensetupCommand(or docker config) changes unless the container was recently used (within ~5 minutes). Hot containers log a warning with the exactopenclaw sandbox recreate ...command.
{
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"],
},
},
},
}
強化設定位於 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" 時會被忽略)。
Build the default sandbox image¶
scripts/sandbox-setup.sh
這會使用 Dockerfile.sandbox 建置 openclaw-sandbox:bookworm-slim。
沙箱通用映像檔(可選)¶
如果你想要包含常見建置工具(Node、Go、Rust 等)的沙箱映像檔,請建置通用映像檔:
scripts/sandbox-common-setup.sh
這會建置 openclaw-sandbox-common:bookworm-slim。要使用它: To use it:
{
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:
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).
注意事項:
- 有頭(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)
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.
自訂沙箱映像檔¶
建置你自己的映像檔,並在設定中指向它:
docker build -t my-openclaw-sbx -f Dockerfile.sandbox .
{
agents: {
defaults: {
sandbox: { docker: { image: "my-openclaw-sbx" } },
},
},
}
工具政策(允許/拒絕)¶
denywins overallow.- 若
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)。
- Host-only tools like browser/camera/canvas are blocked by default.
- 在沙箱中允許
browser會破壞隔離(瀏覽器會在主機上執行)。
Troubleshooting¶
- 找不到映像檔:請使用
scripts/sandbox-setup.sh建置,或設定agents.defaults.sandbox.docker.image。 - 容器未執行:它會在每個工作階段需要時自動建立。
- 沙箱中的權限錯誤:將
docker.user設為符合你掛載之工作區擁有權的 UID:GID(或對工作區資料夾執行 chown)。 - Custom tools not found: OpenClaw runs commands with
sh -lc(login shell), which sources/etc/profileand may reset PATH. 找不到自訂工具:OpenClaw 以sh -lc(登入殼層)執行命令,會載入/etc/profile並可能重設 PATH。請設定docker.env.PATH以在前置加入你的自訂工具路徑(例如/custom/bin:/usr/local/share/npm-global/bin),或在 Dockerfile 中於/etc/profile.d/下新增腳本。