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(readme): fold Render into deployment guide
Xubin Ren3f602fbc8c10
diff --git a/README.md b/README.mdindex 8f7858e8f..fea316ff6 100644--- a/README.md+++ b/README.md@@ -46,18 +46,7 @@| Connect Telegram, Discord, WeChat, Slack, Email, Mattermost, or another chat app | [Chat Apps](./docs/chat-apps.md) || Configure providers, fallback models, Langfuse, MCP, web tools, or security | [Docs](./docs/README.md) and [Configuration](./docs/configuration.md) || Understand or extend the internals | [Architecture](./docs/architecture.md) and [Development](./docs/development.md) |-| Deploy to the cloud in one click | [Deploy to Render](#deploy-to-render) |--## Deploy to Render--Run nanobot online without managing a server. The blueprint deploys the gateway and bundled WebUI together, with a persistent disk so sessions, memory, and chat history survive restarts.--> [!IMPORTANT]-> This setup requires a paid Render service because persistent disks are not available on the free tier. During setup, provide `ANTHROPIC_API_KEY` and set `NANOBOT_WEB_TOKEN` to a strong private password (for example, generate one with `openssl rand -hex 32`).--[](https://render.com/deploy?repo=https://github.com/HKUDS/nanobot)--[Review the deployment blueprint](./render.yaml)+| Deploy to the cloud or keep nanobot running as a service | [Deployment](./docs/deployment.md), including [one-click Render setup](./docs/deployment.md#render) |## What can nanobot do?diff --git a/docs/deployment.md b/docs/deployment.mdindex fa06dfaf3..8ab63cf02 100644--- a/docs/deployment.md+++ b/docs/deployment.md@@ -4,7 +4,7 @@ Use this page after `nanobot agent -m "Hello!"` works locally. Deployment keeps## Before You Deploy-Check these once before Docker, systemd, or LaunchAgent:+Check these once before Render, Docker, systemd, or LaunchAgent:| Check | Why it matters ||---|---|@@ -22,11 +22,23 @@ Restart the deployed process after editing `config.json`. Long-running processes| Runtime | Use it for | State location | Useful first command ||---|---|---|---|+| Render | One-click hosted gateway and WebUI | Persistent disk at `/home/nanobot/.nanobot` | [Deploy to Render](#render) || Docker Compose | Repeatable container runs on Linux servers or workstations | Bind-mount `~/.nanobot` to `/home/nanobot/.nanobot` | `docker compose run --rm nanobot-cli agent -m "Hello!"` || Docker CLI | Manual container testing or small one-off hosts | Bind-mount `~/.nanobot` to `/home/nanobot/.nanobot` | `docker run -v ~/.nanobot:/home/nanobot/.nanobot --rm nanobot status` || systemd user service | Linux user-level gateway that restarts automatically | Host user's `~/.nanobot` unless you pass explicit paths | `systemctl --user status nanobot-gateway` || macOS LaunchAgent | macOS gateway that starts after login | Host user's `~/.nanobot` unless the plist passes explicit paths | `launchctl list | grep ai.nanobot.gateway` |+## Render++Run nanobot online without managing a server. The blueprint deploys the gateway and bundled WebUI together, with a persistent disk so sessions, memory, and chat history survive restarts.++> [!IMPORTANT]+> This setup requires a paid Render service because persistent disks are not available on the free tier. During setup, provide `ANTHROPIC_API_KEY` and set `NANOBOT_WEB_TOKEN` to a strong private password (for example, generate one with `openssl rand -hex 32`).++[](https://render.com/deploy?repo=https://github.com/HKUDS/nanobot)++[Review the deployment blueprint](../render.yaml)+## Docker> [!TIP]