Your lightweight open-source personal agent.
Python agent-frameworkai-agentai-agentschatbotchatopsdiscord-botllm-agentsllmslocal-llmmcpmodel-context-protocolmulti-agentopenai-compatibleopenclawpersonal-ai-assistantpythonself-hostedtelegram-bot-ai-assistantwebuiworkflow-automation
docs(deployment): match docker run gateway example to docker-compose.yml (refs #3873)
voidborne-dbf8a6e35fdd7
diff --git a/docs/deployment.md b/docs/deployment.mdindex 746c35218..8a2cd89eb 100644--- a/docs/deployment.md+++ b/docs/deployment.md@@ -10,6 +10,18 @@> [!IMPORTANT]> Official Docker usage currently means building from this repository with the included `Dockerfile`. Docker Hub images under third-party namespaces are not maintained or verified by HKUDS/nanobot; do not mount API keys or bot tokens into them unless you trust the publisher.+> [!IMPORTANT]+> The gateway and WebSocket channel default to `host: "127.0.0.1"` in `config.json` (set in `nanobot/config/schema.py`). Docker `-p` port forwarding cannot reach a container's loopback interface, so for the host or LAN to reach the exposed ports you must set both binds to `0.0.0.0` in `~/.nanobot/config.json` before starting the container:+>+> ```json+> {+> "gateway": { "host": "0.0.0.0" },+> "channels": { "websocket": { "host": "0.0.0.0" } }+> }+> ```+>+> When `host` is `0.0.0.0`, the gateway refuses to start unless `token` or `tokenIssueSecret` is also configured on the WebSocket channel — see [`webui/README.md`](../webui/README.md) for details.+### Docker Compose```bash@@ -36,8 +48,20 @@ docker run -v ~/.nanobot:/home/nanobot/.nanobot --rm nanobot onboard# Edit config on host to add API keysvim ~/.nanobot/config.json-# Run gateway (connects to enabled channels, e.g. Telegram/Discord/Mochat)-docker run -v ~/.nanobot:/home/nanobot/.nanobot -p 18790:18790 nanobot gateway+# Run gateway (connects to enabled channels, e.g. Telegram/Discord/Mochat).+# Mirrors the security caps and port mappings declared in docker-compose.yml:+# - `--cap-drop ALL --cap-add SYS_ADMIN` + unconfined apparmor/seccomp are required+# when `tools.exec.sandbox: "bwrap"` is enabled (bwrap needs CAP_SYS_ADMIN for+# user namespaces). Without them, `bwrap` exits with `clone3: Operation not permitted`.+# - `-p 8765:8765` exposes the WebSocket channel / WebUI alongside the gateway health+# endpoint on 18790.+docker run \+ --cap-drop ALL --cap-add SYS_ADMIN \+ --security-opt apparmor=unconfined \+ --security-opt seccomp=unconfined \+ -v ~/.nanobot:/home/nanobot/.nanobot \+ -p 18790:18790 -p 8765:8765 \+ nanobot gateway# Or run a single commanddocker run -v ~/.nanobot:/home/nanobot/.nanobot --rm nanobot agent -m "Hello!"