vilvona 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (812) hide show
  1. package/CHANGELOG.md +12331 -0
  2. package/LICENSE +24 -0
  3. package/README.md +314 -0
  4. package/THIRD_PARTY_NOTICES.md +37 -0
  5. package/docs/.i18n/README.md +81 -0
  6. package/docs/.i18n/ar-navigation.json +18 -0
  7. package/docs/.i18n/de-navigation.json +18 -0
  8. package/docs/.i18n/es-navigation.json +18 -0
  9. package/docs/.i18n/fr-navigation.json +18 -0
  10. package/docs/.i18n/glossary.ar.json +82 -0
  11. package/docs/.i18n/glossary.de.json +82 -0
  12. package/docs/.i18n/glossary.es.json +82 -0
  13. package/docs/.i18n/glossary.fa.json +82 -0
  14. package/docs/.i18n/glossary.fr.json +82 -0
  15. package/docs/.i18n/glossary.id.json +82 -0
  16. package/docs/.i18n/glossary.it.json +82 -0
  17. package/docs/.i18n/glossary.ja-JP.json +102 -0
  18. package/docs/.i18n/glossary.ko.json +82 -0
  19. package/docs/.i18n/glossary.nl.json +82 -0
  20. package/docs/.i18n/glossary.pl.json +82 -0
  21. package/docs/.i18n/glossary.pt-BR.json +82 -0
  22. package/docs/.i18n/glossary.th.json +82 -0
  23. package/docs/.i18n/glossary.tr.json +82 -0
  24. package/docs/.i18n/glossary.uk.json +82 -0
  25. package/docs/.i18n/glossary.vi.json +82 -0
  26. package/docs/.i18n/glossary.zh-CN.json +1182 -0
  27. package/docs/.i18n/glossary.zh-TW.json +162 -0
  28. package/docs/.i18n/id-navigation.json +18 -0
  29. package/docs/.i18n/it-navigation.json +18 -0
  30. package/docs/.i18n/ja-navigation.json +18 -0
  31. package/docs/.i18n/ko-navigation.json +18 -0
  32. package/docs/.i18n/pl-navigation.json +18 -0
  33. package/docs/.i18n/pt-BR-navigation.json +18 -0
  34. package/docs/.i18n/tr-navigation.json +18 -0
  35. package/docs/.i18n/translation-workflow.md +111 -0
  36. package/docs/.i18n/zh-Hans-navigation.json +552 -0
  37. package/docs/AGENTS.md +36 -0
  38. package/docs/agent-runtime-architecture.md +48 -0
  39. package/docs/announcements/bluebubbles-imessage.md +79 -0
  40. package/docs/auth-credential-semantics.md +124 -0
  41. package/docs/automation/auth-monitoring.md +11 -0
  42. package/docs/automation/clawflow.md +12 -0
  43. package/docs/automation/cron-jobs.md +569 -0
  44. package/docs/automation/cron-vs-heartbeat.md +11 -0
  45. package/docs/automation/gmail-pubsub.md +11 -0
  46. package/docs/automation/hooks.md +387 -0
  47. package/docs/automation/index.md +135 -0
  48. package/docs/automation/poll.md +12 -0
  49. package/docs/automation/standing-orders.md +250 -0
  50. package/docs/automation/taskflow.md +155 -0
  51. package/docs/automation/tasks.md +374 -0
  52. package/docs/automation/troubleshooting.md +12 -0
  53. package/docs/automation/webhook.md +12 -0
  54. package/docs/brave-search.md +11 -0
  55. package/docs/channels/access-groups.md +201 -0
  56. package/docs/channels/ambient-room-events.md +214 -0
  57. package/docs/channels/bot-loop-protection.md +131 -0
  58. package/docs/channels/broadcast-groups.md +472 -0
  59. package/docs/channels/channel-routing.md +162 -0
  60. package/docs/channels/clickclack.md +146 -0
  61. package/docs/channels/discord.md +1758 -0
  62. package/docs/channels/feishu.md +654 -0
  63. package/docs/channels/googlechat.md +286 -0
  64. package/docs/channels/group-messages.md +95 -0
  65. package/docs/channels/groups.md +610 -0
  66. package/docs/channels/imessage-from-bluebubbles.md +259 -0
  67. package/docs/channels/imessage.md +864 -0
  68. package/docs/channels/index.md +65 -0
  69. package/docs/channels/irc.md +253 -0
  70. package/docs/channels/line.md +243 -0
  71. package/docs/channels/location.md +71 -0
  72. package/docs/channels/matrix-migration.md +375 -0
  73. package/docs/channels/matrix-presentation.md +77 -0
  74. package/docs/channels/matrix-push-rules.md +150 -0
  75. package/docs/channels/matrix.md +935 -0
  76. package/docs/channels/mattermost.md +542 -0
  77. package/docs/channels/msteams.md +1097 -0
  78. package/docs/channels/nextcloud-talk.md +176 -0
  79. package/docs/channels/nostr.md +253 -0
  80. package/docs/channels/pairing.md +214 -0
  81. package/docs/channels/qqbot.md +317 -0
  82. package/docs/channels/signal.md +417 -0
  83. package/docs/channels/slack.md +1623 -0
  84. package/docs/channels/sms.md +380 -0
  85. package/docs/channels/synology-chat.md +187 -0
  86. package/docs/channels/telegram.md +1121 -0
  87. package/docs/channels/tlon.md +296 -0
  88. package/docs/channels/troubleshooting.md +162 -0
  89. package/docs/channels/twitch.md +431 -0
  90. package/docs/channels/wechat.md +171 -0
  91. package/docs/channels/whatsapp.md +796 -0
  92. package/docs/channels/yuanbao.md +416 -0
  93. package/docs/channels/zalo.md +253 -0
  94. package/docs/channels/zalouser.md +217 -0
  95. package/docs/ci.md +665 -0
  96. package/docs/clawhub/cli.md +82 -0
  97. package/docs/clawhub/publishing.md +96 -0
  98. package/docs/cli/acp.md +370 -0
  99. package/docs/cli/agent.md +109 -0
  100. package/docs/cli/agents.md +253 -0
  101. package/docs/cli/approvals.md +193 -0
  102. package/docs/cli/backup.md +98 -0
  103. package/docs/cli/browser.md +322 -0
  104. package/docs/cli/channels.md +154 -0
  105. package/docs/cli/clawbot.md +25 -0
  106. package/docs/cli/commitments.md +90 -0
  107. package/docs/cli/completion.md +39 -0
  108. package/docs/cli/config.md +504 -0
  109. package/docs/cli/configure.md +77 -0
  110. package/docs/cli/crestodian.md +337 -0
  111. package/docs/cli/cron.md +344 -0
  112. package/docs/cli/daemon.md +67 -0
  113. package/docs/cli/dashboard.md +33 -0
  114. package/docs/cli/devices.md +240 -0
  115. package/docs/cli/directory.md +68 -0
  116. package/docs/cli/dns.md +53 -0
  117. package/docs/cli/docs.md +63 -0
  118. package/docs/cli/doctor.md +254 -0
  119. package/docs/cli/flows.md +52 -0
  120. package/docs/cli/gateway.md +572 -0
  121. package/docs/cli/health.md +43 -0
  122. package/docs/cli/hooks.md +345 -0
  123. package/docs/cli/index.md +406 -0
  124. package/docs/cli/infer.md +364 -0
  125. package/docs/cli/logs.md +68 -0
  126. package/docs/cli/mcp.md +851 -0
  127. package/docs/cli/memory.md +183 -0
  128. package/docs/cli/message.md +317 -0
  129. package/docs/cli/migrate.md +334 -0
  130. package/docs/cli/models.md +239 -0
  131. package/docs/cli/node.md +178 -0
  132. package/docs/cli/nodes.md +76 -0
  133. package/docs/cli/onboard.md +251 -0
  134. package/docs/cli/pairing.md +77 -0
  135. package/docs/cli/path.md +511 -0
  136. package/docs/cli/plugins.md +480 -0
  137. package/docs/cli/policy.md +929 -0
  138. package/docs/cli/proxy.md +89 -0
  139. package/docs/cli/qr.md +56 -0
  140. package/docs/cli/reset.md +39 -0
  141. package/docs/cli/sandbox.md +208 -0
  142. package/docs/cli/secrets.md +202 -0
  143. package/docs/cli/security.md +135 -0
  144. package/docs/cli/sessions.md +178 -0
  145. package/docs/cli/setup.md +60 -0
  146. package/docs/cli/skills.md +156 -0
  147. package/docs/cli/status.md +45 -0
  148. package/docs/cli/system.md +89 -0
  149. package/docs/cli/tasks.md +111 -0
  150. package/docs/cli/transcripts.md +151 -0
  151. package/docs/cli/tui.md +92 -0
  152. package/docs/cli/uninstall.md +45 -0
  153. package/docs/cli/update.md +283 -0
  154. package/docs/cli/voicecall.md +204 -0
  155. package/docs/cli/webhooks.md +117 -0
  156. package/docs/cli/wiki.md +256 -0
  157. package/docs/cli/workboard.md +228 -0
  158. package/docs/concepts/active-memory.md +856 -0
  159. package/docs/concepts/agent-loop.md +185 -0
  160. package/docs/concepts/agent-runtimes.md +276 -0
  161. package/docs/concepts/agent-workspace.md +230 -0
  162. package/docs/concepts/agent.md +142 -0
  163. package/docs/concepts/architecture.md +154 -0
  164. package/docs/concepts/channel-docking.md +145 -0
  165. package/docs/concepts/commitments.md +150 -0
  166. package/docs/concepts/compaction.md +203 -0
  167. package/docs/concepts/context-engine.md +347 -0
  168. package/docs/concepts/context.md +199 -0
  169. package/docs/concepts/delegate-architecture.md +319 -0
  170. package/docs/concepts/dreaming.md +279 -0
  171. package/docs/concepts/experimental-features.md +111 -0
  172. package/docs/concepts/features.md +91 -0
  173. package/docs/concepts/mantis-slack-desktop-runbook.md +231 -0
  174. package/docs/concepts/mantis.md +744 -0
  175. package/docs/concepts/markdown-formatting.md +139 -0
  176. package/docs/concepts/memory-builtin.md +151 -0
  177. package/docs/concepts/memory-honcho.md +144 -0
  178. package/docs/concepts/memory-qmd.md +277 -0
  179. package/docs/concepts/memory-search.md +175 -0
  180. package/docs/concepts/memory.md +299 -0
  181. package/docs/concepts/message-lifecycle-refactor.md +1126 -0
  182. package/docs/concepts/messages.md +216 -0
  183. package/docs/concepts/model-failover.md +405 -0
  184. package/docs/concepts/model-providers.md +719 -0
  185. package/docs/concepts/models.md +371 -0
  186. package/docs/concepts/multi-agent.md +625 -0
  187. package/docs/concepts/oauth.md +218 -0
  188. package/docs/concepts/parallel-specialist-lanes.md +127 -0
  189. package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
  190. package/docs/concepts/presence.md +117 -0
  191. package/docs/concepts/progress-drafts.md +406 -0
  192. package/docs/concepts/qa-e2e-automation.md +979 -0
  193. package/docs/concepts/qa-matrix.md +139 -0
  194. package/docs/concepts/queue-steering.md +90 -0
  195. package/docs/concepts/queue.md +136 -0
  196. package/docs/concepts/retry.md +86 -0
  197. package/docs/concepts/session-pruning.md +104 -0
  198. package/docs/concepts/session-tool.md +201 -0
  199. package/docs/concepts/session.md +164 -0
  200. package/docs/concepts/soul.md +116 -0
  201. package/docs/concepts/streaming.md +258 -0
  202. package/docs/concepts/system-prompt.md +330 -0
  203. package/docs/concepts/timezone.md +47 -0
  204. package/docs/concepts/typebox.md +309 -0
  205. package/docs/concepts/typing-indicators.md +88 -0
  206. package/docs/concepts/usage-tracking.md +72 -0
  207. package/docs/date-time.md +126 -0
  208. package/docs/debug/node-issue.md +90 -0
  209. package/docs/diagnostics/flags.md +182 -0
  210. package/docs/docs.json +1885 -0
  211. package/docs/gateway/authentication.md +286 -0
  212. package/docs/gateway/background-process.md +147 -0
  213. package/docs/gateway/bonjour.md +303 -0
  214. package/docs/gateway/bridge-protocol.md +97 -0
  215. package/docs/gateway/cli-backends.md +463 -0
  216. package/docs/gateway/config-agents.md +1525 -0
  217. package/docs/gateway/config-channels.md +942 -0
  218. package/docs/gateway/config-tools.md +806 -0
  219. package/docs/gateway/configuration-examples.md +706 -0
  220. package/docs/gateway/configuration-reference.md +1449 -0
  221. package/docs/gateway/configuration.md +748 -0
  222. package/docs/gateway/diagnostics.md +213 -0
  223. package/docs/gateway/discovery.md +154 -0
  224. package/docs/gateway/doctor.md +576 -0
  225. package/docs/gateway/external-apps.md +86 -0
  226. package/docs/gateway/gateway-lock.md +37 -0
  227. package/docs/gateway/health.md +73 -0
  228. package/docs/gateway/heartbeat.md +498 -0
  229. package/docs/gateway/index.md +385 -0
  230. package/docs/gateway/local-model-services.md +205 -0
  231. package/docs/gateway/local-models.md +355 -0
  232. package/docs/gateway/logging.md +149 -0
  233. package/docs/gateway/multiple-gateways.md +178 -0
  234. package/docs/gateway/network-model.md +15 -0
  235. package/docs/gateway/openai-http-api.md +379 -0
  236. package/docs/gateway/openresponses-http-api.md +349 -0
  237. package/docs/gateway/openshell.md +316 -0
  238. package/docs/gateway/opentelemetry.md +440 -0
  239. package/docs/gateway/operator-scopes.md +119 -0
  240. package/docs/gateway/pairing.md +207 -0
  241. package/docs/gateway/prometheus.md +249 -0
  242. package/docs/gateway/protocol.md +839 -0
  243. package/docs/gateway/remote-gateway-readme.md +169 -0
  244. package/docs/gateway/remote.md +280 -0
  245. package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +148 -0
  246. package/docs/gateway/sandboxing.md +546 -0
  247. package/docs/gateway/secrets-plan-contract.md +159 -0
  248. package/docs/gateway/secrets.md +805 -0
  249. package/docs/gateway/security/audit-checks.md +127 -0
  250. package/docs/gateway/security/exposure-runbook.md +212 -0
  251. package/docs/gateway/security/index.md +1344 -0
  252. package/docs/gateway/security/secure-file-operations.md +76 -0
  253. package/docs/gateway/security/shrinkwrap.md +111 -0
  254. package/docs/gateway/tailscale.md +180 -0
  255. package/docs/gateway/tools-invoke-http-api.md +175 -0
  256. package/docs/gateway/troubleshooting.md +881 -0
  257. package/docs/gateway/trusted-proxy-auth.md +483 -0
  258. package/docs/help/debugging.md +341 -0
  259. package/docs/help/environment.md +240 -0
  260. package/docs/help/faq-first-run.md +872 -0
  261. package/docs/help/faq-models.md +557 -0
  262. package/docs/help/faq.md +2115 -0
  263. package/docs/help/index.md +39 -0
  264. package/docs/help/scripts.md +56 -0
  265. package/docs/help/testing-live.md +592 -0
  266. package/docs/help/testing-updates-plugins.md +299 -0
  267. package/docs/help/testing.md +977 -0
  268. package/docs/help/troubleshooting.md +500 -0
  269. package/docs/index.md +196 -0
  270. package/docs/install/ansible.md +233 -0
  271. package/docs/install/azure.md +315 -0
  272. package/docs/install/bun.md +59 -0
  273. package/docs/install/clawdock.md +112 -0
  274. package/docs/install/development-channels.md +148 -0
  275. package/docs/install/digitalocean.md +174 -0
  276. package/docs/install/docker-vm-runtime.md +154 -0
  277. package/docs/install/docker.md +564 -0
  278. package/docs/install/exe-dev.md +201 -0
  279. package/docs/install/fly.md +524 -0
  280. package/docs/install/gcp.md +418 -0
  281. package/docs/install/hetzner.md +285 -0
  282. package/docs/install/hostinger.md +98 -0
  283. package/docs/install/index.md +236 -0
  284. package/docs/install/installer.md +447 -0
  285. package/docs/install/kubernetes.md +196 -0
  286. package/docs/install/macos-vm.md +281 -0
  287. package/docs/install/migrating-claude.md +165 -0
  288. package/docs/install/migrating-hermes.md +178 -0
  289. package/docs/install/migrating.md +137 -0
  290. package/docs/install/nix.md +112 -0
  291. package/docs/install/node.md +142 -0
  292. package/docs/install/northflank.mdx +44 -0
  293. package/docs/install/oracle.md +218 -0
  294. package/docs/install/podman.md +216 -0
  295. package/docs/install/railway.mdx +92 -0
  296. package/docs/install/raspberry-pi.md +234 -0
  297. package/docs/install/render.mdx +167 -0
  298. package/docs/install/uninstall.md +140 -0
  299. package/docs/install/updating.md +284 -0
  300. package/docs/install/upstash.md +96 -0
  301. package/docs/logging.md +322 -0
  302. package/docs/maturity-scores.yaml +5361 -0
  303. package/docs/nav-tabs-underline.js +104 -0
  304. package/docs/network.md +72 -0
  305. package/docs/nodes/audio.md +216 -0
  306. package/docs/nodes/camera.md +166 -0
  307. package/docs/nodes/images.md +77 -0
  308. package/docs/nodes/index.md +444 -0
  309. package/docs/nodes/location-command.md +102 -0
  310. package/docs/nodes/media-understanding.md +495 -0
  311. package/docs/nodes/talk.md +160 -0
  312. package/docs/nodes/troubleshooting.md +123 -0
  313. package/docs/nodes/voicewake.md +93 -0
  314. package/docs/openclaw-agent-runtime.md +82 -0
  315. package/docs/perplexity.md +11 -0
  316. package/docs/plan/codex-context-engine-harness.md +624 -0
  317. package/docs/plan/ui-channels.md +284 -0
  318. package/docs/platforms/android.md +286 -0
  319. package/docs/platforms/digitalocean.md +12 -0
  320. package/docs/platforms/easyrunner.md +109 -0
  321. package/docs/platforms/index.md +65 -0
  322. package/docs/platforms/ios.md +287 -0
  323. package/docs/platforms/linux.md +141 -0
  324. package/docs/platforms/mac/bundled-gateway.md +79 -0
  325. package/docs/platforms/mac/canvas.md +128 -0
  326. package/docs/platforms/mac/child-process.md +72 -0
  327. package/docs/platforms/mac/dev-setup.md +112 -0
  328. package/docs/platforms/mac/health.md +39 -0
  329. package/docs/platforms/mac/icon.md +36 -0
  330. package/docs/platforms/mac/logging.md +62 -0
  331. package/docs/platforms/mac/menu-bar.md +93 -0
  332. package/docs/platforms/mac/peekaboo.md +96 -0
  333. package/docs/platforms/mac/permissions.md +73 -0
  334. package/docs/platforms/mac/remote.md +123 -0
  335. package/docs/platforms/mac/signing.md +52 -0
  336. package/docs/platforms/mac/skills.md +45 -0
  337. package/docs/platforms/mac/voice-overlay.md +66 -0
  338. package/docs/platforms/mac/voicewake.md +79 -0
  339. package/docs/platforms/mac/webchat.md +54 -0
  340. package/docs/platforms/mac/xpc.md +66 -0
  341. package/docs/platforms/macos.md +228 -0
  342. package/docs/platforms/oracle.md +12 -0
  343. package/docs/platforms/raspberry-pi.md +13 -0
  344. package/docs/platforms/windows.md +304 -0
  345. package/docs/plugins/adding-capabilities.md +146 -0
  346. package/docs/plugins/admin-http-rpc.md +216 -0
  347. package/docs/plugins/agent-tools.md +13 -0
  348. package/docs/plugins/architecture-internals.md +1203 -0
  349. package/docs/plugins/architecture.md +483 -0
  350. package/docs/plugins/building-extensions.md +13 -0
  351. package/docs/plugins/building-plugins.md +343 -0
  352. package/docs/plugins/bundles.md +310 -0
  353. package/docs/plugins/cli-backend-plugins.md +328 -0
  354. package/docs/plugins/codex-computer-use.md +297 -0
  355. package/docs/plugins/codex-harness-reference.md +480 -0
  356. package/docs/plugins/codex-harness-runtime.md +268 -0
  357. package/docs/plugins/codex-harness.md +800 -0
  358. package/docs/plugins/codex-native-plugins.md +280 -0
  359. package/docs/plugins/community.md +77 -0
  360. package/docs/plugins/compatibility.md +198 -0
  361. package/docs/plugins/copilot.md +355 -0
  362. package/docs/plugins/dependency-resolution.md +176 -0
  363. package/docs/plugins/google-meet.md +1737 -0
  364. package/docs/plugins/hooks.md +525 -0
  365. package/docs/plugins/install-overrides.md +80 -0
  366. package/docs/plugins/llama-cpp.md +58 -0
  367. package/docs/plugins/manage-plugins.md +214 -0
  368. package/docs/plugins/manifest.md +1468 -0
  369. package/docs/plugins/memory-lancedb.md +385 -0
  370. package/docs/plugins/memory-wiki.md +529 -0
  371. package/docs/plugins/message-presentation.md +487 -0
  372. package/docs/plugins/oc-path.md +166 -0
  373. package/docs/plugins/plugin-inventory.md +318 -0
  374. package/docs/plugins/plugin-permission-requests.md +193 -0
  375. package/docs/plugins/reference/acpx.md +23 -0
  376. package/docs/plugins/reference/admin-http-rpc.md +23 -0
  377. package/docs/plugins/reference/alibaba.md +23 -0
  378. package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
  379. package/docs/plugins/reference/amazon-bedrock.md +23 -0
  380. package/docs/plugins/reference/anthropic-vertex.md +29 -0
  381. package/docs/plugins/reference/anthropic.md +23 -0
  382. package/docs/plugins/reference/arcee.md +23 -0
  383. package/docs/plugins/reference/azure-speech.md +23 -0
  384. package/docs/plugins/reference/bonjour.md +19 -0
  385. package/docs/plugins/reference/brave.md +23 -0
  386. package/docs/plugins/reference/browser.md +23 -0
  387. package/docs/plugins/reference/byteplus.md +19 -0
  388. package/docs/plugins/reference/canvas.md +19 -0
  389. package/docs/plugins/reference/cerebras.md +23 -0
  390. package/docs/plugins/reference/chutes.md +23 -0
  391. package/docs/plugins/reference/clickclack.md +23 -0
  392. package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
  393. package/docs/plugins/reference/codex-supervisor.md +27 -0
  394. package/docs/plugins/reference/codex.md +23 -0
  395. package/docs/plugins/reference/comfy.md +23 -0
  396. package/docs/plugins/reference/copilot-proxy.md +19 -0
  397. package/docs/plugins/reference/copilot.md +23 -0
  398. package/docs/plugins/reference/deepgram.md +23 -0
  399. package/docs/plugins/reference/deepinfra.md +23 -0
  400. package/docs/plugins/reference/deepseek.md +23 -0
  401. package/docs/plugins/reference/diagnostics-otel.md +19 -0
  402. package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
  403. package/docs/plugins/reference/diffs-language-pack.md +31 -0
  404. package/docs/plugins/reference/diffs.md +19 -0
  405. package/docs/plugins/reference/discord.md +23 -0
  406. package/docs/plugins/reference/document-extract.md +23 -0
  407. package/docs/plugins/reference/duckduckgo.md +23 -0
  408. package/docs/plugins/reference/elevenlabs.md +23 -0
  409. package/docs/plugins/reference/exa.md +23 -0
  410. package/docs/plugins/reference/fal.md +23 -0
  411. package/docs/plugins/reference/feishu.md +23 -0
  412. package/docs/plugins/reference/file-transfer.md +19 -0
  413. package/docs/plugins/reference/firecrawl.md +23 -0
  414. package/docs/plugins/reference/fireworks.md +23 -0
  415. package/docs/plugins/reference/github-copilot.md +23 -0
  416. package/docs/plugins/reference/gmi.md +23 -0
  417. package/docs/plugins/reference/google-meet.md +23 -0
  418. package/docs/plugins/reference/google.md +23 -0
  419. package/docs/plugins/reference/googlechat.md +23 -0
  420. package/docs/plugins/reference/gradium.md +23 -0
  421. package/docs/plugins/reference/groq.md +23 -0
  422. package/docs/plugins/reference/huggingface.md +23 -0
  423. package/docs/plugins/reference/imessage.md +23 -0
  424. package/docs/plugins/reference/inworld.md +23 -0
  425. package/docs/plugins/reference/irc.md +23 -0
  426. package/docs/plugins/reference/kilocode.md +23 -0
  427. package/docs/plugins/reference/kimi.md +23 -0
  428. package/docs/plugins/reference/line.md +23 -0
  429. package/docs/plugins/reference/litellm.md +23 -0
  430. package/docs/plugins/reference/llama-cpp.md +23 -0
  431. package/docs/plugins/reference/llm-task.md +19 -0
  432. package/docs/plugins/reference/lmstudio.md +23 -0
  433. package/docs/plugins/reference/lobster.md +19 -0
  434. package/docs/plugins/reference/matrix.md +23 -0
  435. package/docs/plugins/reference/mattermost.md +23 -0
  436. package/docs/plugins/reference/memory-core.md +19 -0
  437. package/docs/plugins/reference/memory-lancedb.md +23 -0
  438. package/docs/plugins/reference/memory-wiki.md +23 -0
  439. package/docs/plugins/reference/microsoft-foundry.md +113 -0
  440. package/docs/plugins/reference/microsoft.md +19 -0
  441. package/docs/plugins/reference/migrate-claude.md +19 -0
  442. package/docs/plugins/reference/migrate-hermes.md +19 -0
  443. package/docs/plugins/reference/minimax.md +23 -0
  444. package/docs/plugins/reference/mistral.md +23 -0
  445. package/docs/plugins/reference/moonshot.md +23 -0
  446. package/docs/plugins/reference/msteams.md +23 -0
  447. package/docs/plugins/reference/nextcloud-talk.md +23 -0
  448. package/docs/plugins/reference/nostr.md +23 -0
  449. package/docs/plugins/reference/novita.md +23 -0
  450. package/docs/plugins/reference/nvidia.md +23 -0
  451. package/docs/plugins/reference/oc-path.md +23 -0
  452. package/docs/plugins/reference/ollama.md +24 -0
  453. package/docs/plugins/reference/open-prose.md +19 -0
  454. package/docs/plugins/reference/openai.md +23 -0
  455. package/docs/plugins/reference/opencode-go.md +23 -0
  456. package/docs/plugins/reference/opencode.md +23 -0
  457. package/docs/plugins/reference/openrouter.md +23 -0
  458. package/docs/plugins/reference/openshell.md +19 -0
  459. package/docs/plugins/reference/perplexity.md +23 -0
  460. package/docs/plugins/reference/pixverse.md +23 -0
  461. package/docs/plugins/reference/policy.md +79 -0
  462. package/docs/plugins/reference/qa-channel.md +23 -0
  463. package/docs/plugins/reference/qa-lab.md +19 -0
  464. package/docs/plugins/reference/qa-matrix.md +19 -0
  465. package/docs/plugins/reference/qianfan.md +23 -0
  466. package/docs/plugins/reference/qqbot.md +23 -0
  467. package/docs/plugins/reference/qwen.md +24 -0
  468. package/docs/plugins/reference/runway.md +23 -0
  469. package/docs/plugins/reference/searxng.md +19 -0
  470. package/docs/plugins/reference/senseaudio.md +23 -0
  471. package/docs/plugins/reference/sglang.md +23 -0
  472. package/docs/plugins/reference/signal.md +23 -0
  473. package/docs/plugins/reference/slack.md +23 -0
  474. package/docs/plugins/reference/sms.md +23 -0
  475. package/docs/plugins/reference/stepfun.md +23 -0
  476. package/docs/plugins/reference/synology-chat.md +23 -0
  477. package/docs/plugins/reference/synthetic.md +23 -0
  478. package/docs/plugins/reference/tavily.md +23 -0
  479. package/docs/plugins/reference/telegram.md +23 -0
  480. package/docs/plugins/reference/tencent.md +23 -0
  481. package/docs/plugins/reference/tlon.md +23 -0
  482. package/docs/plugins/reference/together.md +23 -0
  483. package/docs/plugins/reference/tokenjuice.md +23 -0
  484. package/docs/plugins/reference/tts-local-cli.md +19 -0
  485. package/docs/plugins/reference/twitch.md +23 -0
  486. package/docs/plugins/reference/venice.md +23 -0
  487. package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
  488. package/docs/plugins/reference/vllm.md +23 -0
  489. package/docs/plugins/reference/voice-call.md +23 -0
  490. package/docs/plugins/reference/volcengine.md +23 -0
  491. package/docs/plugins/reference/voyage.md +19 -0
  492. package/docs/plugins/reference/vydra.md +23 -0
  493. package/docs/plugins/reference/web-readability.md +19 -0
  494. package/docs/plugins/reference/webhooks.md +23 -0
  495. package/docs/plugins/reference/whatsapp.md +23 -0
  496. package/docs/plugins/reference/workboard.md +23 -0
  497. package/docs/plugins/reference/xai.md +23 -0
  498. package/docs/plugins/reference/xiaomi.md +23 -0
  499. package/docs/plugins/reference/zai.md +23 -0
  500. package/docs/plugins/reference/zalo.md +23 -0
  501. package/docs/plugins/reference/zalouser.md +24 -0
  502. package/docs/plugins/reference.md +19 -0
  503. package/docs/plugins/sdk-agent-harness.md +339 -0
  504. package/docs/plugins/sdk-channel-inbound.md +70 -0
  505. package/docs/plugins/sdk-channel-ingress.md +137 -0
  506. package/docs/plugins/sdk-channel-message.md +18 -0
  507. package/docs/plugins/sdk-channel-outbound.md +113 -0
  508. package/docs/plugins/sdk-channel-plugins.md +770 -0
  509. package/docs/plugins/sdk-channel-turn.md +9 -0
  510. package/docs/plugins/sdk-entrypoints.md +344 -0
  511. package/docs/plugins/sdk-migration.md +1011 -0
  512. package/docs/plugins/sdk-overview.md +525 -0
  513. package/docs/plugins/sdk-provider-plugins.md +1019 -0
  514. package/docs/plugins/sdk-runtime.md +683 -0
  515. package/docs/plugins/sdk-setup.md +550 -0
  516. package/docs/plugins/sdk-subpaths.md +401 -0
  517. package/docs/plugins/sdk-testing.md +403 -0
  518. package/docs/plugins/tool-plugins.md +411 -0
  519. package/docs/plugins/voice-call.md +942 -0
  520. package/docs/plugins/webhooks.md +192 -0
  521. package/docs/plugins/workboard.md +402 -0
  522. package/docs/plugins/zalouser.md +86 -0
  523. package/docs/prose.md +191 -0
  524. package/docs/providers/alibaba.md +158 -0
  525. package/docs/providers/anthropic.md +386 -0
  526. package/docs/providers/arcee.md +144 -0
  527. package/docs/providers/azure-speech.md +119 -0
  528. package/docs/providers/bedrock-mantle.md +224 -0
  529. package/docs/providers/bedrock.md +433 -0
  530. package/docs/providers/cerebras.md +130 -0
  531. package/docs/providers/chutes.md +153 -0
  532. package/docs/providers/claude-max-api-proxy.md +191 -0
  533. package/docs/providers/cloudflare-ai-gateway.md +119 -0
  534. package/docs/providers/comfy.md +362 -0
  535. package/docs/providers/deepgram.md +184 -0
  536. package/docs/providers/deepinfra.md +92 -0
  537. package/docs/providers/deepseek.md +146 -0
  538. package/docs/providers/ds4.md +309 -0
  539. package/docs/providers/elevenlabs.md +130 -0
  540. package/docs/providers/fal.md +240 -0
  541. package/docs/providers/fireworks.md +144 -0
  542. package/docs/providers/github-copilot.md +257 -0
  543. package/docs/providers/gmi.md +92 -0
  544. package/docs/providers/google.md +472 -0
  545. package/docs/providers/gradium.md +123 -0
  546. package/docs/providers/groq.md +171 -0
  547. package/docs/providers/huggingface.md +235 -0
  548. package/docs/providers/index.md +105 -0
  549. package/docs/providers/inferrs.md +272 -0
  550. package/docs/providers/inworld.md +120 -0
  551. package/docs/providers/kilocode.md +135 -0
  552. package/docs/providers/litellm.md +234 -0
  553. package/docs/providers/lmstudio.md +224 -0
  554. package/docs/providers/minimax.md +518 -0
  555. package/docs/providers/mistral.md +235 -0
  556. package/docs/providers/models.md +64 -0
  557. package/docs/providers/moonshot.md +413 -0
  558. package/docs/providers/novita.md +92 -0
  559. package/docs/providers/nvidia.md +208 -0
  560. package/docs/providers/ollama-cloud.md +115 -0
  561. package/docs/providers/ollama.md +1225 -0
  562. package/docs/providers/openai.md +1091 -0
  563. package/docs/providers/opencode-go.md +123 -0
  564. package/docs/providers/opencode.md +149 -0
  565. package/docs/providers/openrouter.md +390 -0
  566. package/docs/providers/perplexity-provider.md +123 -0
  567. package/docs/providers/pixverse.md +165 -0
  568. package/docs/providers/qianfan.md +132 -0
  569. package/docs/providers/qwen-oauth.md +115 -0
  570. package/docs/providers/qwen.md +364 -0
  571. package/docs/providers/runway.md +103 -0
  572. package/docs/providers/senseaudio.md +68 -0
  573. package/docs/providers/sglang.md +161 -0
  574. package/docs/providers/stepfun.md +229 -0
  575. package/docs/providers/synthetic.md +154 -0
  576. package/docs/providers/tencent.md +130 -0
  577. package/docs/providers/together.md +140 -0
  578. package/docs/providers/venice.md +312 -0
  579. package/docs/providers/vercel-ai-gateway.md +128 -0
  580. package/docs/providers/vllm.md +407 -0
  581. package/docs/providers/volcengine.md +199 -0
  582. package/docs/providers/vydra.md +180 -0
  583. package/docs/providers/xai.md +571 -0
  584. package/docs/providers/xiaomi.md +286 -0
  585. package/docs/providers/zai.md +224 -0
  586. package/docs/refactor/access.md +9 -0
  587. package/docs/refactor/acp.md +298 -0
  588. package/docs/refactor/canvas.md +131 -0
  589. package/docs/refactor/database-first.md +2263 -0
  590. package/docs/refactor/ingress-core.md +341 -0
  591. package/docs/reference/AGENTS.default.md +131 -0
  592. package/docs/reference/RELEASING.md +844 -0
  593. package/docs/reference/api-usage-costs.md +208 -0
  594. package/docs/reference/application-modernization-plan.md +208 -0
  595. package/docs/reference/code-mode.md +1058 -0
  596. package/docs/reference/credits.md +33 -0
  597. package/docs/reference/device-models.md +50 -0
  598. package/docs/reference/full-release-validation.md +206 -0
  599. package/docs/reference/memory-config.md +630 -0
  600. package/docs/reference/prompt-caching.md +358 -0
  601. package/docs/reference/release-performance-sweep.md +347 -0
  602. package/docs/reference/rich-output-protocol.md +93 -0
  603. package/docs/reference/rpc.md +43 -0
  604. package/docs/reference/secret-placeholder-conventions.md +33 -0
  605. package/docs/reference/secretref-credential-surface.md +163 -0
  606. package/docs/reference/secretref-user-supplied-credentials-matrix.json +691 -0
  607. package/docs/reference/session-management-compaction.md +474 -0
  608. package/docs/reference/templates/AGENTS.dev.md +90 -0
  609. package/docs/reference/templates/AGENTS.md +227 -0
  610. package/docs/reference/templates/BOOT.md +16 -0
  611. package/docs/reference/templates/BOOTSTRAP.md +66 -0
  612. package/docs/reference/templates/HEARTBEAT.md +24 -0
  613. package/docs/reference/templates/IDENTITY.dev.md +52 -0
  614. package/docs/reference/templates/IDENTITY.md +34 -0
  615. package/docs/reference/templates/SOUL.dev.md +82 -0
  616. package/docs/reference/templates/SOUL.md +49 -0
  617. package/docs/reference/templates/TOOLS.dev.md +29 -0
  618. package/docs/reference/templates/TOOLS.md +51 -0
  619. package/docs/reference/templates/USER.dev.md +23 -0
  620. package/docs/reference/templates/USER.md +28 -0
  621. package/docs/reference/test.md +248 -0
  622. package/docs/reference/token-use.md +246 -0
  623. package/docs/reference/transcript-hygiene.md +226 -0
  624. package/docs/reference/wizard.md +252 -0
  625. package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
  626. package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
  627. package/docs/security/formal-verification.md +170 -0
  628. package/docs/security/incident-response.md +59 -0
  629. package/docs/security/network-proxy.md +268 -0
  630. package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
  631. package/docs/snippets/plugin-publish/minimal-package.json +16 -0
  632. package/docs/specs/claw-supervisor.md +247 -0
  633. package/docs/start/bootstrapping.md +49 -0
  634. package/docs/start/docs-directory.md +69 -0
  635. package/docs/start/getting-started.md +152 -0
  636. package/docs/start/hubs.md +201 -0
  637. package/docs/start/lore.md +223 -0
  638. package/docs/start/onboarding-overview.md +72 -0
  639. package/docs/start/onboarding.md +98 -0
  640. package/docs/start/openclaw.md +246 -0
  641. package/docs/start/quickstart.md +25 -0
  642. package/docs/start/setup.md +178 -0
  643. package/docs/start/showcase.md +371 -0
  644. package/docs/start/wizard-cli-automation.md +232 -0
  645. package/docs/start/wizard-cli-reference.md +331 -0
  646. package/docs/start/wizard.md +142 -0
  647. package/docs/style.css +137 -0
  648. package/docs/tools/acp-agents-setup.md +356 -0
  649. package/docs/tools/acp-agents.md +865 -0
  650. package/docs/tools/agent-send.md +130 -0
  651. package/docs/tools/apply-patch.md +64 -0
  652. package/docs/tools/brave-search.md +139 -0
  653. package/docs/tools/browser-control.md +405 -0
  654. package/docs/tools/browser-linux-troubleshooting.md +173 -0
  655. package/docs/tools/browser-login.md +77 -0
  656. package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
  657. package/docs/tools/browser.md +866 -0
  658. package/docs/tools/btw.md +159 -0
  659. package/docs/tools/capability-cookbook.md +12 -0
  660. package/docs/tools/clawhub.md +5 -0
  661. package/docs/tools/code-execution.md +173 -0
  662. package/docs/tools/creating-skills.md +271 -0
  663. package/docs/tools/diffs.md +527 -0
  664. package/docs/tools/duckduckgo-search.md +109 -0
  665. package/docs/tools/elevated.md +128 -0
  666. package/docs/tools/exa-search.md +152 -0
  667. package/docs/tools/exec-approvals-advanced.md +457 -0
  668. package/docs/tools/exec-approvals.md +520 -0
  669. package/docs/tools/exec.md +294 -0
  670. package/docs/tools/firecrawl.md +155 -0
  671. package/docs/tools/gemini-search.md +114 -0
  672. package/docs/tools/goal.md +217 -0
  673. package/docs/tools/grok-search.md +129 -0
  674. package/docs/tools/image-generation.md +538 -0
  675. package/docs/tools/index.md +176 -0
  676. package/docs/tools/kimi-search.md +105 -0
  677. package/docs/tools/llm-task.md +137 -0
  678. package/docs/tools/lobster.md +365 -0
  679. package/docs/tools/loop-detection.md +154 -0
  680. package/docs/tools/media-overview.md +161 -0
  681. package/docs/tools/minimax-search.md +102 -0
  682. package/docs/tools/multi-agent-sandbox-tools.md +409 -0
  683. package/docs/tools/music-generation.md +372 -0
  684. package/docs/tools/ollama-search.md +153 -0
  685. package/docs/tools/parallel-search.md +154 -0
  686. package/docs/tools/pdf.md +213 -0
  687. package/docs/tools/permission-modes.md +111 -0
  688. package/docs/tools/perplexity-search.md +220 -0
  689. package/docs/tools/plugin.md +378 -0
  690. package/docs/tools/reactions.md +100 -0
  691. package/docs/tools/searxng-search.md +141 -0
  692. package/docs/tools/skill-workshop.md +283 -0
  693. package/docs/tools/skills-config.md +457 -0
  694. package/docs/tools/skills.md +591 -0
  695. package/docs/tools/slash-commands.md +518 -0
  696. package/docs/tools/steer.md +77 -0
  697. package/docs/tools/subagents.md +652 -0
  698. package/docs/tools/tavily.md +162 -0
  699. package/docs/tools/thinking.md +142 -0
  700. package/docs/tools/tokenjuice.md +84 -0
  701. package/docs/tools/tool-search.md +269 -0
  702. package/docs/tools/trajectory.md +229 -0
  703. package/docs/tools/tts.md +1013 -0
  704. package/docs/tools/video-generation.md +555 -0
  705. package/docs/tools/web-fetch.md +210 -0
  706. package/docs/tools/web.md +476 -0
  707. package/docs/tts.md +11 -0
  708. package/docs/vps.md +139 -0
  709. package/docs/web/control-ui.md +530 -0
  710. package/docs/web/dashboard.md +107 -0
  711. package/docs/web/index.md +133 -0
  712. package/docs/web/tui.md +258 -0
  713. package/docs/web/webchat.md +102 -0
  714. package/npm-shrinkwrap.json +3485 -0
  715. package/openclaw.mjs +661 -0
  716. package/package.json +1971 -0
  717. package/patches/.gitkeep +0 -0
  718. package/patches/@agentclientprotocol__claude-agent-acp@0.39.0.patch +40 -0
  719. package/pnpm-workspace.yaml +124 -0
  720. package/scripts/crabbox-wrapper.mjs +2470 -0
  721. package/scripts/lib/official-external-channel-catalog.json +570 -0
  722. package/scripts/lib/official-external-plugin-catalog.json +284 -0
  723. package/scripts/lib/official-external-provider-catalog.json +158 -0
  724. package/scripts/lib/package-dist-imports.mjs +174 -0
  725. package/scripts/npm-runner.mjs +95 -0
  726. package/scripts/postinstall-bundled-plugins.mjs +978 -0
  727. package/scripts/preinstall-package-manager-warning.mjs +74 -0
  728. package/scripts/prepare-git-hooks.mjs +73 -0
  729. package/scripts/windows-cmd-helpers.mjs +29 -0
  730. package/skills/1password/SKILL.md +70 -0
  731. package/skills/1password/references/cli-examples.md +29 -0
  732. package/skills/1password/references/get-started.md +17 -0
  733. package/skills/apple-notes/SKILL.md +77 -0
  734. package/skills/apple-reminders/SKILL.md +118 -0
  735. package/skills/bear-notes/SKILL.md +107 -0
  736. package/skills/blogwatcher/SKILL.md +69 -0
  737. package/skills/blucli/SKILL.md +47 -0
  738. package/skills/camsnap/SKILL.md +45 -0
  739. package/skills/canvas/SKILL.md +78 -0
  740. package/skills/clawhub/SKILL.md +77 -0
  741. package/skills/coding-agent/SKILL.md +143 -0
  742. package/skills/diagram-maker/SKILL.md +53 -0
  743. package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
  744. package/skills/diagram-maker/references/svg-template.md +112 -0
  745. package/skills/discord/SKILL.md +136 -0
  746. package/skills/eightctl/SKILL.md +50 -0
  747. package/skills/gemini/SKILL.md +47 -0
  748. package/skills/gh-issues/SKILL.md +213 -0
  749. package/skills/gifgrep/SKILL.md +85 -0
  750. package/skills/github/SKILL.md +84 -0
  751. package/skills/gog/SKILL.md +116 -0
  752. package/skills/goplaces/SKILL.md +52 -0
  753. package/skills/healthcheck/SKILL.md +105 -0
  754. package/skills/himalaya/SKILL.md +80 -0
  755. package/skills/himalaya/references/configuration.md +184 -0
  756. package/skills/himalaya/references/message-composition.md +199 -0
  757. package/skills/imsg/SKILL.md +122 -0
  758. package/skills/mcporter/SKILL.md +61 -0
  759. package/skills/meme-maker/SKILL.md +42 -0
  760. package/skills/meme-maker/references/templates.json +358 -0
  761. package/skills/meme-maker/scripts/meme.mjs +398 -0
  762. package/skills/model-usage/SKILL.md +71 -0
  763. package/skills/model-usage/references/codexbar-cli.md +33 -0
  764. package/skills/model-usage/scripts/model_usage.py +319 -0
  765. package/skills/model-usage/scripts/test_model_usage.py +40 -0
  766. package/skills/nano-pdf/SKILL.md +38 -0
  767. package/skills/node-connect/SKILL.md +143 -0
  768. package/skills/node-inspect-debugger/SKILL.md +85 -0
  769. package/skills/notion/SKILL.md +150 -0
  770. package/skills/obsidian/SKILL.md +119 -0
  771. package/skills/openai-whisper/SKILL.md +38 -0
  772. package/skills/openai-whisper-api/SKILL.md +71 -0
  773. package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
  774. package/skills/openhue/SKILL.md +112 -0
  775. package/skills/oracle/SKILL.md +126 -0
  776. package/skills/ordercli/SKILL.md +78 -0
  777. package/skills/peekaboo/SKILL.md +198 -0
  778. package/skills/pyproject.toml +10 -0
  779. package/skills/python-debugpy/SKILL.md +73 -0
  780. package/skills/sag/SKILL.md +87 -0
  781. package/skills/session-logs/SKILL.md +151 -0
  782. package/skills/sherpa-onnx-tts/SKILL.md +109 -0
  783. package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
  784. package/skills/skill-creator/SKILL.md +78 -0
  785. package/skills/skill-creator/license.txt +202 -0
  786. package/skills/skill-creator/scripts/init_skill.py +378 -0
  787. package/skills/skill-creator/scripts/package_skill.py +144 -0
  788. package/skills/skill-creator/scripts/quick_validate.py +169 -0
  789. package/skills/skill-creator/scripts/test_package_skill.py +199 -0
  790. package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
  791. package/skills/slack/SKILL.md +78 -0
  792. package/skills/songsee/SKILL.md +49 -0
  793. package/skills/sonoscli/SKILL.md +65 -0
  794. package/skills/spike/SKILL.md +51 -0
  795. package/skills/spotify-player/SKILL.md +64 -0
  796. package/skills/summarize/SKILL.md +87 -0
  797. package/skills/taskflow/SKILL.md +149 -0
  798. package/skills/taskflow/examples/inbox-triage.lobster +33 -0
  799. package/skills/taskflow/examples/pr-intake.lobster +32 -0
  800. package/skills/taskflow-inbox-triage/SKILL.md +119 -0
  801. package/skills/things-mac/SKILL.md +86 -0
  802. package/skills/tmux/SKILL.md +91 -0
  803. package/skills/tmux/scripts/find-sessions.sh +112 -0
  804. package/skills/tmux/scripts/wait-for-text.sh +83 -0
  805. package/skills/trello/SKILL.md +108 -0
  806. package/skills/video-frames/SKILL.md +46 -0
  807. package/skills/video-frames/scripts/frame.sh +81 -0
  808. package/skills/voice-call/SKILL.md +45 -0
  809. package/skills/wacli/SKILL.md +72 -0
  810. package/skills/weather/SKILL.md +87 -0
  811. package/skills/xurl/SKILL.md +120 -0
  812. package/src/agents/templates/HEARTBEAT.md +5 -0
@@ -0,0 +1,564 @@
1
+ ---
2
+ summary: "Optional Docker-based setup and onboarding for OpenClaw"
3
+ read_when:
4
+ - You want a containerized gateway instead of local installs
5
+ - You are validating the Docker flow
6
+ title: "Docker"
7
+ ---
8
+
9
+ Docker is **optional**. Use it only if you want a containerized gateway or to validate the Docker flow.
10
+
11
+ ## Is Docker right for me?
12
+
13
+ - **Yes**: you want an isolated, throwaway gateway environment or to run OpenClaw on a host without local installs.
14
+ - **No**: you are running on your own machine and just want the fastest dev loop. Use the normal install flow instead.
15
+ - **Sandboxing note**: the default sandbox backend uses Docker when sandboxing is enabled, but sandboxing is off by default and does **not** require the full gateway to run in Docker. SSH and OpenShell sandbox backends are also available. See [Sandboxing](/gateway/sandboxing).
16
+
17
+ ## Prerequisites
18
+
19
+ - Docker Desktop (or Docker Engine) + Docker Compose v2
20
+ - At least 2 GB RAM for image build (`pnpm install` may be OOM-killed on 1 GB hosts with exit 137)
21
+ - Enough disk for images and logs
22
+ - If running on a VPS/public host, review
23
+ [Security hardening for network exposure](/gateway/security),
24
+ especially Docker `DOCKER-USER` firewall policy.
25
+
26
+ ## Containerized gateway
27
+
28
+ <Steps>
29
+ <Step title="Build the image">
30
+ From the repo root, run the setup script:
31
+
32
+ ```bash
33
+ ./scripts/docker/setup.sh
34
+ ```
35
+
36
+ This builds the gateway image locally. To use a pre-built image instead:
37
+
38
+ ```bash
39
+ export OPENCLAW_IMAGE="ghcr.io/openclaw/openclaw:latest"
40
+ ./scripts/docker/setup.sh
41
+ ```
42
+
43
+ Pre-built images are published at the
44
+ [GitHub Container Registry](https://github.com/openclaw/openclaw/pkgs/container/openclaw).
45
+ Common tags: `main`, `latest`, `<version>` (e.g. `2026.2.26`).
46
+
47
+ </Step>
48
+
49
+ <Step title="Complete onboarding">
50
+ The setup script runs onboarding automatically. It will:
51
+
52
+ - prompt for provider API keys
53
+ - generate a gateway token and write it to `.env`
54
+ - create the auth-profile secret key directory
55
+ - start the gateway via Docker Compose
56
+
57
+ During setup, pre-start onboarding and config writes run through
58
+ `openclaw-gateway` directly. `openclaw-cli` is for commands you run after
59
+ the gateway container already exists.
60
+
61
+ </Step>
62
+
63
+ <Step title="Open the Control UI">
64
+ Open `http://127.0.0.1:18789/` in your browser and paste the configured
65
+ shared secret into Settings. The setup script writes a token to `.env` by
66
+ default; if you switch the container config to password auth, use that
67
+ password instead.
68
+
69
+ Need the URL again?
70
+
71
+ ```bash
72
+ docker compose run --rm openclaw-cli dashboard --no-open
73
+ ```
74
+
75
+ </Step>
76
+
77
+ <Step title="Configure channels (optional)">
78
+ Use the CLI container to add messaging channels:
79
+
80
+ ```bash
81
+ # WhatsApp (QR)
82
+ docker compose run --rm openclaw-cli channels login
83
+
84
+ # Telegram
85
+ docker compose run --rm openclaw-cli channels add --channel telegram --token "<token>"
86
+
87
+ # Discord
88
+ docker compose run --rm openclaw-cli channels add --channel discord --token "<token>"
89
+ ```
90
+
91
+ Docs: [WhatsApp](/channels/whatsapp), [Telegram](/channels/telegram), [Discord](/channels/discord)
92
+
93
+ </Step>
94
+ </Steps>
95
+
96
+ ### Manual flow
97
+
98
+ If you prefer to run each step yourself instead of using the setup script:
99
+
100
+ ```bash
101
+ docker build -t openclaw:local -f Dockerfile .
102
+ docker compose run --rm --no-deps --entrypoint node openclaw-gateway \
103
+ dist/index.js onboard --mode local --no-install-daemon
104
+ docker compose run --rm --no-deps --entrypoint node openclaw-gateway \
105
+ dist/index.js config set --batch-json '[{"path":"gateway.mode","value":"local"},{"path":"gateway.bind","value":"lan"},{"path":"gateway.controlUi.allowedOrigins","value":["http://localhost:18789","http://127.0.0.1:18789"]}]'
106
+ docker compose up -d openclaw-gateway
107
+ ```
108
+
109
+ <Note>
110
+ Run `docker compose` from the repo root. If you enabled `OPENCLAW_EXTRA_MOUNTS`
111
+ or `OPENCLAW_HOME_VOLUME`, the setup script writes `docker-compose.extra.yml`;
112
+ include it after any standard override file, for example
113
+ `-f docker-compose.yml -f docker-compose.override.yml -f docker-compose.extra.yml`
114
+ when both override files exist.
115
+ </Note>
116
+
117
+ <Note>
118
+ Because `openclaw-cli` shares `openclaw-gateway`'s network namespace, it is a
119
+ post-start tool. Before `docker compose up -d openclaw-gateway`, run onboarding
120
+ and setup-time config writes through `openclaw-gateway` with
121
+ `--no-deps --entrypoint node`.
122
+ </Note>
123
+
124
+ ### Environment variables
125
+
126
+ The setup script accepts these optional environment variables:
127
+
128
+ | Variable | Purpose |
129
+ | ------------------------------------------ | --------------------------------------------------------------------- |
130
+ | `OPENCLAW_IMAGE` | Use a remote image instead of building locally |
131
+ | `OPENCLAW_IMAGE_APT_PACKAGES` | Install extra apt packages during build (space-separated) |
132
+ | `OPENCLAW_IMAGE_PIP_PACKAGES` | Install extra Python packages during build (space-separated) |
133
+ | `OPENCLAW_EXTENSIONS` | Pre-install plugin dependencies at build time (space-separated names) |
134
+ | `OPENCLAW_EXTRA_MOUNTS` | Extra host bind mounts (comma-separated `source:target[:opts]`) |
135
+ | `OPENCLAW_HOME_VOLUME` | Persist `/home/node` in a named Docker volume |
136
+ | `OPENCLAW_SANDBOX` | Opt in to sandbox bootstrap (`1`, `true`, `yes`, `on`) |
137
+ | `OPENCLAW_SKIP_ONBOARDING` | Skip the interactive onboarding step (`1`, `true`, `yes`, `on`) |
138
+ | `OPENCLAW_DOCKER_SOCKET` | Override Docker socket path |
139
+ | `OPENCLAW_DISABLE_BONJOUR` | Disable Bonjour/mDNS advertising (defaults to `1` for Docker) |
140
+ | `OPENCLAW_DISABLE_BUNDLED_SOURCE_OVERLAYS` | Disable bundled plugin source bind-mount overlays |
141
+ | `OTEL_EXPORTER_OTLP_ENDPOINT` | Shared OTLP/HTTP collector endpoint for OpenTelemetry export |
142
+ | `OTEL_EXPORTER_OTLP_*_ENDPOINT` | Signal-specific OTLP endpoints for traces, metrics, or logs |
143
+ | `OTEL_EXPORTER_OTLP_PROTOCOL` | OTLP protocol override. Only `http/protobuf` is supported today |
144
+ | `OTEL_SERVICE_NAME` | Service name used for OpenTelemetry resources |
145
+ | `OTEL_SEMCONV_STABILITY_OPT_IN` | Opt in to latest experimental GenAI semantic attributes |
146
+ | `OPENCLAW_OTEL_PRELOADED` | Skip starting a second OpenTelemetry SDK when one is preloaded |
147
+
148
+ The official Docker image does not ship Homebrew. During onboarding, OpenClaw
149
+ hides brew-only skill dependency installers when it is running in a Linux
150
+ container without `brew`; those dependencies must be provided by a custom image
151
+ or installed manually. For dependencies available from Debian packages, use
152
+ `OPENCLAW_IMAGE_APT_PACKAGES` during image build. The legacy
153
+ `OPENCLAW_DOCKER_APT_PACKAGES` name is still accepted.
154
+ For Python dependencies, use `OPENCLAW_IMAGE_PIP_PACKAGES`. This runs
155
+ `python3 -m pip install --break-system-packages` during the image build, so pin
156
+ package versions and use only package indexes you trust.
157
+
158
+ Maintainers can test bundled plugin source against a packaged image by mounting
159
+ one plugin source directory over its packaged source path, for example
160
+ `OPENCLAW_EXTRA_MOUNTS=/path/to/fork/extensions/synology-chat:/app/extensions/synology-chat:ro`.
161
+ That mounted source directory overrides the matching compiled
162
+ `/app/dist/extensions/synology-chat` bundle for the same plugin id.
163
+
164
+ ### Observability
165
+
166
+ OpenTelemetry export is outbound from the Gateway container to your OTLP
167
+ collector. It does not require a published Docker port. If you build the image
168
+ locally and want the bundled OpenTelemetry exporter available inside the image,
169
+ include its runtime dependencies:
170
+
171
+ ```bash
172
+ export OPENCLAW_EXTENSIONS="diagnostics-otel"
173
+ export OTEL_EXPORTER_OTLP_ENDPOINT="http://otel-collector:4318"
174
+ export OTEL_SERVICE_NAME="openclaw-gateway"
175
+ ./scripts/docker/setup.sh
176
+ ```
177
+
178
+ Install the official `@openclaw/diagnostics-otel` plugin from ClawHub in
179
+ packaged Docker installs before enabling export. Custom source-built images can
180
+ still include the local plugin source with
181
+ `OPENCLAW_EXTENSIONS=diagnostics-otel`. To enable export, allow and enable the
182
+ `diagnostics-otel` plugin in config, then set
183
+ `diagnostics.otel.enabled=true` or use the config example in [OpenTelemetry
184
+ export](/gateway/opentelemetry). Collector auth headers are configured through
185
+ `diagnostics.otel.headers`, not through Docker environment variables.
186
+
187
+ Prometheus metrics use the already-published Gateway port. Install
188
+ `clawhub:@openclaw/diagnostics-prometheus`, enable the
189
+ `diagnostics-prometheus` plugin, then scrape:
190
+
191
+ ```text
192
+ http://<gateway-host>:18789/api/diagnostics/prometheus
193
+ ```
194
+
195
+ The route is protected by Gateway authentication. Do not expose a separate
196
+ public `/metrics` port or unauthenticated reverse-proxy path. See
197
+ [Prometheus metrics](/gateway/prometheus).
198
+
199
+ ### Health checks
200
+
201
+ Container probe endpoints (no auth required):
202
+
203
+ ```bash
204
+ curl -fsS http://127.0.0.1:18789/healthz # liveness
205
+ curl -fsS http://127.0.0.1:18789/readyz # readiness
206
+ ```
207
+
208
+ The Docker image includes a built-in `HEALTHCHECK` that pings `/healthz`.
209
+ If checks keep failing, Docker marks the container as `unhealthy` and
210
+ orchestration systems can restart or replace it.
211
+
212
+ Authenticated deep health snapshot:
213
+
214
+ ```bash
215
+ docker compose exec openclaw-gateway node dist/index.js health --token "$OPENCLAW_GATEWAY_TOKEN"
216
+ ```
217
+
218
+ ### LAN vs loopback
219
+
220
+ `scripts/docker/setup.sh` defaults `OPENCLAW_GATEWAY_BIND=lan` so host access to
221
+ `http://127.0.0.1:18789` works with Docker port publishing.
222
+
223
+ - `lan` (default): host browser and host CLI can reach the published gateway port.
224
+ - `loopback`: only processes inside the container network namespace can reach
225
+ the gateway directly.
226
+
227
+ <Note>
228
+ Use bind mode values in `gateway.bind` (`lan` / `loopback` / `custom` /
229
+ `tailnet` / `auto`), not host aliases like `0.0.0.0` or `127.0.0.1`.
230
+ </Note>
231
+
232
+ ### Host Local Providers
233
+
234
+ When OpenClaw runs in Docker, `127.0.0.1` inside the container is the container
235
+ itself, not your host machine. Use `host.docker.internal` for AI providers that
236
+ run on the host:
237
+
238
+ | Provider | Host default URL | Docker setup URL |
239
+ | --------- | ------------------------ | ----------------------------------- |
240
+ | LM Studio | `http://127.0.0.1:1234` | `http://host.docker.internal:1234` |
241
+ | Ollama | `http://127.0.0.1:11434` | `http://host.docker.internal:11434` |
242
+
243
+ The bundled Docker setup uses those host URLs as the LM Studio and Ollama
244
+ onboarding defaults, and `docker-compose.yml` maps `host.docker.internal` to
245
+ Docker's host gateway for Linux Docker Engine. Docker Desktop already provides
246
+ the same hostname on macOS and Windows.
247
+
248
+ Host services must also listen on an address reachable from Docker:
249
+
250
+ ```bash
251
+ lms server start --port 1234 --bind 0.0.0.0
252
+ OLLAMA_HOST=0.0.0.0:11434 ollama serve
253
+ ```
254
+
255
+ If you use your own Compose file or `docker run` command, add the same host
256
+ mapping yourself, for example
257
+ `--add-host=host.docker.internal:host-gateway`.
258
+
259
+ ### Bonjour / mDNS
260
+
261
+ Docker bridge networking usually does not forward Bonjour/mDNS multicast
262
+ (`224.0.0.251:5353`) reliably. The bundled Compose setup therefore defaults
263
+ `OPENCLAW_DISABLE_BONJOUR=1` so the Gateway does not crash-loop or repeatedly
264
+ restart advertising when the bridge drops multicast traffic.
265
+
266
+ Use the published Gateway URL, Tailscale, or wide-area DNS-SD for Docker hosts.
267
+ Set `OPENCLAW_DISABLE_BONJOUR=0` only when running with host networking, macvlan,
268
+ or another network where mDNS multicast is known to work.
269
+
270
+ For gotchas and troubleshooting, see [Bonjour discovery](/gateway/bonjour).
271
+
272
+ ### Storage and persistence
273
+
274
+ Docker Compose bind-mounts `OPENCLAW_CONFIG_DIR` to `/home/node/.openclaw`,
275
+ `OPENCLAW_WORKSPACE_DIR` to `/home/node/.openclaw/workspace`, and
276
+ `OPENCLAW_AUTH_PROFILE_SECRET_DIR` to `/home/node/.config/openclaw`, so those
277
+ paths survive container replacement. When any variable is unset, the bundled
278
+ `docker-compose.yml` falls back under `${HOME}`, or `/tmp` when `HOME` itself is
279
+ also missing. That keeps `docker compose up` from emitting an empty-source
280
+ volume spec on bare environments.
281
+
282
+ That mounted config directory is where OpenClaw keeps:
283
+
284
+ - `openclaw.json` for behavior config
285
+ - `agents/<agentId>/agent/auth-profiles.json` for stored provider OAuth/API-key auth
286
+ - `.env` for env-backed runtime secrets such as `OPENCLAW_GATEWAY_TOKEN`
287
+
288
+ The auth-profile secret key directory stores the local encryption key used for
289
+ OAuth-backed auth profile token material. Keep it with your Docker host state,
290
+ but separate from `OPENCLAW_CONFIG_DIR`.
291
+
292
+ Installed downloadable plugins store their package state under the mounted
293
+ OpenClaw home, so plugin install records and package roots survive container
294
+ replacement. Gateway startup does not generate bundled-plugin dependency trees.
295
+
296
+ For full persistence details on VM deployments, see
297
+ [Docker VM Runtime - What persists where](/install/docker-vm-runtime#what-persists-where).
298
+
299
+ **Disk growth hotspots:** watch `media/`, session JSONL files, the shared
300
+ SQLite state database, installed plugin package roots, and rolling file logs
301
+ under `/tmp/openclaw/`.
302
+
303
+ ### Shell helpers (optional)
304
+
305
+ For easier day-to-day Docker management, install `ClawDock`:
306
+
307
+ ```bash
308
+ mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/openclaw/openclaw/main/scripts/clawdock/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
309
+ echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc
310
+ ```
311
+
312
+ If you installed ClawDock from the older `scripts/shell-helpers/clawdock-helpers.sh` raw path, rerun the install command above so your local helper file tracks the new location.
313
+
314
+ Then use `clawdock-start`, `clawdock-stop`, `clawdock-dashboard`, etc. Run
315
+ `clawdock-help` for all commands.
316
+ See [ClawDock](/install/clawdock) for the full helper guide.
317
+
318
+ <AccordionGroup>
319
+ <Accordion title="Enable agent sandbox for Docker gateway">
320
+ ```bash
321
+ export OPENCLAW_SANDBOX=1
322
+ ./scripts/docker/setup.sh
323
+ ```
324
+
325
+ Custom socket path (e.g. rootless Docker):
326
+
327
+ ```bash
328
+ export OPENCLAW_SANDBOX=1
329
+ export OPENCLAW_DOCKER_SOCKET=/run/user/1000/docker.sock
330
+ ./scripts/docker/setup.sh
331
+ ```
332
+
333
+ The script mounts `docker.sock` only after sandbox prerequisites pass. If
334
+ sandbox setup cannot complete, the script resets `agents.defaults.sandbox.mode`
335
+ to `off`. Codex code-mode turns are still constrained to Codex
336
+ `workspace-write` while the OpenClaw sandbox is active; do not mount the
337
+ host Docker socket into agent sandbox containers.
338
+
339
+ </Accordion>
340
+
341
+ <Accordion title="Automation / CI (non-interactive)">
342
+ Disable Compose pseudo-TTY allocation with `-T`:
343
+
344
+ ```bash
345
+ docker compose run -T --rm openclaw-cli gateway probe
346
+ docker compose run -T --rm openclaw-cli devices list --json
347
+ ```
348
+
349
+ </Accordion>
350
+
351
+ <Accordion title="Shared-network security note">
352
+ `openclaw-cli` uses `network_mode: "service:openclaw-gateway"` so CLI
353
+ commands can reach the gateway over `127.0.0.1`. Treat this as a shared
354
+ trust boundary. The compose config drops `NET_RAW`/`NET_ADMIN` and enables
355
+ `no-new-privileges` on both `openclaw-gateway` and `openclaw-cli`.
356
+ </Accordion>
357
+
358
+ <Accordion title="Docker Desktop DNS failures in openclaw-cli">
359
+ Some Docker Desktop setups fail DNS lookups from the shared-network
360
+ `openclaw-cli` sidecar after `NET_RAW` is dropped, which shows up as
361
+ `EAI_AGAIN` during npm-backed commands such as `openclaw plugins install`.
362
+ Keep the default hardened compose file for normal gateway operation. The
363
+ local override below loosens the CLI container's security posture by
364
+ restoring Docker's default capabilities, so use it only for the one-off CLI
365
+ command that needs package registry access, not as your default Compose
366
+ invocation:
367
+
368
+ ```bash
369
+ printf '%s\n' \
370
+ 'services:' \
371
+ ' openclaw-cli:' \
372
+ ' cap_drop: !reset []' \
373
+ > docker-compose.cli-no-dropped-caps.local.yml
374
+
375
+ docker compose -f docker-compose.yml -f docker-compose.cli-no-dropped-caps.local.yml run --rm openclaw-cli plugins install <package>
376
+ ```
377
+
378
+ If you already created a long-running `openclaw-cli` container, recreate it
379
+ with the same override. `docker compose exec` and `docker exec` cannot
380
+ change Linux capabilities on an already-created container.
381
+
382
+ </Accordion>
383
+
384
+ <Accordion title="Permissions and EACCES">
385
+ The image runs as `node` (uid 1000). If you see permission errors on
386
+ `/home/node/.openclaw`, make sure your host bind mounts are owned by uid 1000:
387
+
388
+ ```bash
389
+ sudo chown -R 1000:1000 /path/to/openclaw-config /path/to/openclaw-workspace
390
+ ```
391
+
392
+ The same mismatch can show up as a plugin warning such as
393
+ `blocked plugin candidate: suspicious ownership (... uid=1000, expected uid=0 or root)`
394
+ followed by `plugin present but blocked`. That means the process uid and the
395
+ mounted plugin directory owner disagree. Prefer running the container as the
396
+ default uid 1000 and fixing the bind mount ownership. Only chown
397
+ `/path/to/openclaw-config/npm` to `root:root` if you intentionally run
398
+ OpenClaw as root long term.
399
+
400
+ </Accordion>
401
+
402
+ <Accordion title="Faster rebuilds">
403
+ Order your Dockerfile so dependency layers are cached. This avoids re-running
404
+ `pnpm install` unless lockfiles change:
405
+
406
+ ```dockerfile
407
+ FROM node:24-bookworm
408
+ RUN curl -fsSL https://bun.sh/install | bash
409
+ ENV PATH="/root/.bun/bin:${PATH}"
410
+ RUN corepack enable
411
+ WORKDIR /app
412
+ COPY package.json pnpm-lock.yaml pnpm-workspace.yaml .npmrc ./
413
+ COPY ui/package.json ./ui/package.json
414
+ COPY scripts ./scripts
415
+ RUN pnpm install --frozen-lockfile
416
+ COPY . .
417
+ RUN pnpm build
418
+ RUN pnpm ui:install
419
+ RUN pnpm ui:build
420
+ ENV NODE_ENV=production
421
+ CMD ["node","dist/index.js"]
422
+ ```
423
+
424
+ </Accordion>
425
+
426
+ <Accordion title="Power-user container options">
427
+ The default image is security-first and runs as non-root `node`. For a more
428
+ full-featured container:
429
+
430
+ 1. **Persist `/home/node`**: `export OPENCLAW_HOME_VOLUME="openclaw_home"`
431
+ 2. **Bake system deps**: `export OPENCLAW_IMAGE_APT_PACKAGES="git curl jq"`
432
+ 3. **Bake Python deps**: `export OPENCLAW_IMAGE_PIP_PACKAGES="requests==2.32.5 humanize==4.14.0"`
433
+ 4. **Bake Playwright Chromium**: `export OPENCLAW_INSTALL_BROWSER=1`
434
+ 5. **Or install Playwright browsers into a persisted volume**:
435
+ ```bash
436
+ docker compose run --rm openclaw-cli \
437
+ node /app/node_modules/playwright-core/cli.js install chromium
438
+ ```
439
+ 6. **Persist browser downloads**: use `OPENCLAW_HOME_VOLUME` or
440
+ `OPENCLAW_EXTRA_MOUNTS`. OpenClaw auto-detects the Docker image's
441
+ Playwright-managed Chromium on Linux.
442
+
443
+ </Accordion>
444
+
445
+ <Accordion title="OpenAI Codex OAuth (headless Docker)">
446
+ If you pick OpenAI Codex OAuth in the wizard, it opens a browser URL. In
447
+ Docker or headless setups, copy the full redirect URL you land on and paste
448
+ it back into the wizard to finish auth.
449
+ </Accordion>
450
+
451
+ <Accordion title="Base image metadata">
452
+ The main Docker runtime image uses `node:24-bookworm-slim` and includes `tini` as the entrypoint init process (PID 1) to ensure zombie processes are reaped and signals are handled correctly in long-running containers. It publishes OCI base-image annotations including `org.opencontainers.image.base.name`,
453
+ `org.opencontainers.image.source`, and others. The Node base digest is
454
+ refreshed through Dependabot Docker base-image PRs; release builds do not run
455
+ a distro upgrade layer. See
456
+ [OCI image annotations](https://github.com/opencontainers/image-spec/blob/main/annotations.md).
457
+ </Accordion>
458
+ </AccordionGroup>
459
+
460
+ ### Running on a VPS?
461
+
462
+ See [Hetzner (Docker VPS)](/install/hetzner) and
463
+ [Docker VM Runtime](/install/docker-vm-runtime) for shared VM deployment steps
464
+ including binary baking, persistence, and updates.
465
+
466
+ ## Agent sandbox
467
+
468
+ When `agents.defaults.sandbox` is enabled with the Docker backend, the gateway
469
+ runs agent tool execution (shell, file read/write, etc.) inside isolated Docker
470
+ containers while the gateway itself stays on the host. This gives you a hard wall
471
+ around untrusted or multi-tenant agent sessions without containerizing the entire
472
+ gateway.
473
+
474
+ Sandbox scope can be per-agent (default), per-session, or shared. Each scope
475
+ gets its own workspace mounted at `/workspace`. You can also configure
476
+ allow/deny tool policies, network isolation, resource limits, and browser
477
+ containers.
478
+
479
+ For full configuration, images, security notes, and multi-agent profiles, see:
480
+
481
+ - [Sandboxing](/gateway/sandboxing) -- complete sandbox reference
482
+ - [OpenShell](/gateway/openshell) -- interactive shell access to sandbox containers
483
+ - [Multi-Agent Sandbox and Tools](/tools/multi-agent-sandbox-tools) -- per-agent overrides
484
+
485
+ ### Quick enable
486
+
487
+ ```json5
488
+ {
489
+ agents: {
490
+ defaults: {
491
+ sandbox: {
492
+ mode: "non-main", // off | non-main | all
493
+ scope: "agent", // session | agent | shared
494
+ },
495
+ },
496
+ },
497
+ }
498
+ ```
499
+
500
+ Build the default sandbox image (from a source checkout):
501
+
502
+ ```bash
503
+ scripts/sandbox-setup.sh
504
+ ```
505
+
506
+ For npm installs without a source checkout, see [Sandboxing § Images and setup](/gateway/sandboxing#images-and-setup) for inline `docker build` commands.
507
+
508
+ ## Troubleshooting
509
+
510
+ <AccordionGroup>
511
+ <Accordion title="Image missing or sandbox container not starting">
512
+ Build the sandbox image with
513
+ [`scripts/sandbox-setup.sh`](https://github.com/openclaw/openclaw/blob/main/scripts/sandbox-setup.sh)
514
+ (source checkout) or the inline `docker build` command from [Sandboxing § Images and setup](/gateway/sandboxing#images-and-setup) (npm install),
515
+ or set `agents.defaults.sandbox.docker.image` to your custom image.
516
+ Containers are auto-created per session on demand.
517
+ </Accordion>
518
+
519
+ <Accordion title="Permission errors in sandbox">
520
+ Set `docker.user` to a UID:GID that matches your mounted workspace ownership,
521
+ or chown the workspace folder.
522
+ </Accordion>
523
+
524
+ <Accordion title="Custom tools not found in sandbox">
525
+ OpenClaw runs commands with `sh -lc` (login shell), which sources
526
+ `/etc/profile` and may reset PATH. Set `docker.env.PATH` to prepend your
527
+ custom tool paths, or add a script under `/etc/profile.d/` in your Dockerfile.
528
+ </Accordion>
529
+
530
+ <Accordion title="OOM-killed during image build (exit 137)">
531
+ The VM needs at least 2 GB RAM. Use a larger machine class and retry.
532
+ </Accordion>
533
+
534
+ <Accordion title="Unauthorized or pairing required in Control UI">
535
+ Fetch a fresh dashboard link and approve the browser device:
536
+
537
+ ```bash
538
+ docker compose run --rm openclaw-cli dashboard --no-open
539
+ docker compose run --rm openclaw-cli devices list
540
+ docker compose run --rm openclaw-cli devices approve <requestId>
541
+ ```
542
+
543
+ More detail: [Dashboard](/web/dashboard), [Devices](/cli/devices).
544
+
545
+ </Accordion>
546
+
547
+ <Accordion title="Gateway target shows ws://172.x.x.x or pairing errors from Docker CLI">
548
+ Reset gateway mode and bind:
549
+
550
+ ```bash
551
+ docker compose run --rm openclaw-cli config set --batch-json '[{"path":"gateway.mode","value":"local"},{"path":"gateway.bind","value":"lan"}]'
552
+ docker compose run --rm openclaw-cli devices list --url ws://127.0.0.1:18789
553
+ ```
554
+
555
+ </Accordion>
556
+ </AccordionGroup>
557
+
558
+ ## Related
559
+
560
+ - [Install Overview](/install) — all installation methods
561
+ - [Podman](/install/podman) — Podman alternative to Docker
562
+ - [ClawDock](/install/clawdock) — Docker Compose community setup
563
+ - [Updating](/install/updating) — keeping OpenClaw up to date
564
+ - [Configuration](/gateway/configuration) — gateway configuration after install