基于Openclaw(其它分支有nanobot)改造的轻量级 AI 助手框架,可以很快打造商用Sass平台,支持多租户隔离部署、多平台渠道接入、工具调用、定时任务和 Web 实时通信。
在线体验地址,可以直接注册一个账号即可使用, https://ai.infox-med.com:13080/
🔔:simple_web分支是简单的单用户的Web界面。如果单用户的页面测试使用,可以使用simple_web分支。
🔔:nanobot014分支是nanobot的0.1.4版本
🔔:nanobot014v3分支是nanobot的0.1.4 post v3版本
🔔:openclaw_oldfrontend分支是基于openclaw版本的旧版本前端, 🦞 OpenClaw 2026.3.3 (eae1484)
🔔:当前的main分支是的Openclaw的版本:🦞 OpenClaw 2026.3.13 (8a5e642)
原理:
- 新增platform作为控制容器的网关,每个用户单独创建容器进行管理。
- frontend前端页面进行显示,调用platform进行交互, platform调用openclaw bridge对openclaw进行控制。
- openclaw目录就是官方的openclaw,新建了1个openclaw/bridge作为中间层,对openclaw的控制。
- 所以一共分有前端容器,platform容器,openclaw容器(包括bridge被platform控制,和控制openclaw)
- 如果要升级openclaw,只需要替换openclaw整个目录,注意保留bridge目录,运行upgrade_openclaw.py文件。
- 3月18日更新openclaw.json默认配置Agent2Agent模式,远程Terminal连接容器,对话完成的提示
更新:
- 容器的端口信息显示
- 可以直接下载目录了
- 分离代码: frontend/src/components/Brand.tsx 单独设置Logo和简介信息
- 离线部署脚本offline_deploy.py
- 功能特性
- 界面预览
- 运行流程概览
- 多租户部署(Docker Compose)
- 单用户本地运行
- 整体架构
- 核心组件详解
- 安全设计
- 前端
- deploy_copy — 预置 Agent 与技能
- 文件索引
- API 调用示例
本平台是一个功能丰富的多租户 AI 助手平台,支持以下核心功能:
- 创建、配置和管理多个 AI Agents
- 每个 Agent 独立的对话上下文
- Agent 身份设置(名称、Emoji 图标)
- Agent 详情查看和删除
- WebSocket 实时通信
- Markdown 消息渲染(支持代码高亮)
- 斜杠命令自动补全
- 多会话管理
- 语音输入支持
- 文件/图片上传发送
- 固定间隔执行
- Cron 表达式调度
- 单次定时执行
- 任务启用/禁用
- 手动立即执行
- 执行结果通知(可选发送到渠道)
- 每个 Agent 独立的知识库目录
- 支持上传文档、PDF、图片、数据文件
- 文件夹创建和管理
- 文件预览(支持文本、代码、JSON 等)
- 文件下载和删除
- 搜索和安装来自 skills.sh 的 AI 技能
- 技能启用/禁用
- 内置技能 + 用户自定义技能
- Telegram
- Discord
- Email (SMTP)
- WhatsApp Web
- Signal
- Slack
- iMessage
- 其他扩展渠道
- 配置文档: https://my.feishu.cn/wiki/KfTlwurh7ix0PHkQmHic2L0Snue
- API Token 生成和管理
- 支持命令行调用 Agent
- 会话复用
- 外部系统集成
| 提供商 | 模型示例 |
|---|---|
| DashScope | qwen3-coder-plus, qwen-turbo |
| Anthropic | claude-sonnet-4-5, claude-opus-4-5 |
| OpenAI | gpt-4o, gpt-4o-mini, o3-mini |
| DeepSeek | deepseek-chat, deepseek-reasoner |
| AiHubMix | aihubmix/模型名 |
| OpenRouter | openrouter/任意模型(兜底) |
- Agent 总数统计
- 会话总数统计
- 技能总数统计
- Agent 状态概览
- 工作空间文件浏览
- 文件上传/下载
- 目录创建/删除
- 用户管理
- 渠道配置
- AI 模型配置
- 审计日志
- 系统设置
- 每个用户独立 Docker 容器
- 容器级资源隔离(2GB RAM, 4 CPU)
- 按需创建,空闲自动暂停
- 数据完全隔离
本项目的核心思路:用 OpenClaw 替代原来的 nanobot 作为每个用户的 AI Agent 运行时,通过一个 Bridge 适配层将 OpenClaw 接入到平台的多租户体系中。
用户在浏览器输入消息 | v [Frontend] Vite+React (端口 3080) | WebSocket 连接 v [Platform Gateway] FastAPI (端口 8080) --对应platform目录和项目 | 1. JWT 认证 | 2. 查找/启动用户容器 | 3. WebSocket 代理 v [用户容器] — 每个用户一个独立 Docker 容器 | | 容器内部结构: | ┌─────────────────────────────────────────┐ | │ Bridge (Node.js, 端口 18080) │ | │ - HTTP API 服务器 │ | │ - WebSocket 中继 │ | │ | │ | │ v │ | │ OpenClaw Gateway (端口 18789, loopback) │ | │ - Agent 处理引擎 │ | │ - 工具调用 (bash/文件/搜索等) │ | │ - Skills 系统 │ | │ - Session 管理 │ | └─────────────────────────────────────────┘ | | Agent 需要调用 LLM 时: v [Platform Gateway] /llm/v1/chat/completions | 1. 验证容器 Token | 2. 检查用户配额 | 3. 根据模型名匹配 Provider | 4. 注入真实 API Key v [LLM 提供商] (Anthropic / OpenAI / DashScope / DeepSeek / ...) | | 响应沿原路返回 v 用户在浏览器看到回复 核心转发Openclaw的API的流程
1. Frontend (前端) - 运行在 3080 端口 - Vite 配置将 /api 代理到 http://localhost:8080(gateway) 2. Gateway / Platform (平台后端) - 运行在 8080 端口,由 ./platform 构建 - 处理认证、用户管理、数据库 - 对于 /api/openclaw/* 路径,通过 platform/app/routes/proxy.py 反向代理到用户的 OpenClaw 容器 3. OpenClaw Bridge (用户容器内) - 每个用户有独立的 Docker 容器 - Bridge 服务运行在 18080 端口(WebSocket)和 8080 端口(HTTP API) - 提供 agents、sessions、skills、cron 等功能 | 决策 | 说明 |
|---|---|
| OpenClaw 作为 Agent 核心 | 替代原有 nanobot Python Agent,使用 OpenClaw(TypeScript/Node.js)作为每个用户的 AI 运行时,功能更强大 |
| Bridge 适配层 | 在 OpenClaw 外包装一层 Bridge,提供 HTTP API + WS 中继,适配平台的多租户管理 |
| API Key 不进容器 | 所有 LLM API Key 只存在于 Gateway 环境变量中,容器通过 Token 代理访问 |
| 容器级隔离 | 每个用户独立容器、独立 Volume,互不干扰 |
| 按需创建 | 用户首次聊天时才创建容器,空闲 30 分钟暂停,30 天归档 |
浏览器 --> frontend:3080 --(JS请求)--> gateway(platform):8080 --> 用户容器(openclaw) | | postgres:5432 gateway/llm/v1 (用户/配额) (注入API Key) | 实际 LLM 提供商 - Frontend:Vite + React Web 界面,用户注册、登录、聊天
- Gateway:平台网关(Python FastAPI),负责认证、用户容器管理、LLM 代理、配额控制
- 用户容器:每个用户一个独立的 OpenClaw 实例(通过 Bridge 启动),自动创建,数据隔离
- PostgreSQL:存储用户账户、容器元数据、用量记录
- Docker & Docker Compose
- 至少一个 LLM 提供商的 API Key
在项目根目录创建 .env 文件,填入你的 API Key 和配置:
# .env — docker compose 自动读取此文件 # ========== 必填:至少配置一个 LLM 提供商 ========== # 阿里 DashScope(通义千问系列) DASHSCOPE_API_KEY=sk-xxxxxxxxxxxx # Anthropic(Claude 系列) ANTHROPIC_API_KEY=sk-ant-xxxxxxxxxxxx # OpenAI(GPT 系列) OPENAI_API_KEY=sk-xxxxxxxxxxxx # DeepSeek DEEPSEEK_API_KEY=sk-xxxxxxxxxxxx # OpenRouter(支持路由到任意模型,作为兜底) OPENROUTER_API_KEY=sk-or-xxxxxxxxxxxx # AiHubMix AIHUBMIX_API_KEY=sk-xxxxxxxxxxxx # ========== 可选配置 ========== # 默认模型(新用户容器使用此模型) DEFAULT_MODEL=dashscope/qwen3-coder-plus # JWT 密钥(生产环境务必修改) JWT_SECRET=your-secure-random-string配置对应的 API Key 后,用户可以使用以下模型:
| 提供商 | 模型示例 | .env 变量 |
|---|---|---|
| DashScope | dashscope/qwen3-coder-plus, dashscope/qwen-turbo | DASHSCOPE_API_KEY |
| Anthropic | claude-sonnet-4-5, claude-opus-4-5 | ANTHROPIC_API_KEY |
| OpenAI | gpt-4o, gpt-4o-mini, o3-mini | OPENAI_API_KEY |
| DeepSeek | deepseek/deepseek-chat, deepseek/deepseek-reasoner | DEEPSEEK_API_KEY |
| AiHubMix | aihubmix/模型名 | AIHUBMIX_API_KEY |
| OpenRouter | openrouter/任意模型(兜底) | OPENROUTER_API_KEY |
Gateway 根据模型名自动匹配提供商并注入对应的 API Key,用户容器内不存储任何密钥。
方式1:一键部署脚本
# 准备环境(检查 Docker、下载镜像等) python prepare.py # === Docker 部署(推荐) === # 本地 Docker 部署(localhost 访问) python deploy_docker.py # 重新构建指定服务 python deploy_docker.py --rebuild openclaw,gateway,frontend # 仅重建某个服务 python deploy_docker.py --rebuild frontend # 仅构建镜像不启动 python deploy_docker.py --build-only # 完全清理重建,删除部署的数据 python deploy_docker.py --clean # === 本地开发模式 === # 启动所有本地服务(postgres + bridge + gateway + frontend dev server) python start_local.py # 停止所有服务 python start_local.py --stop # 检查服务状态 python check_status.py提示:换网不需要重新 build 前端。前端使用相对路径
/api/...,由 nginx 反代转发,与 IP 无关。
本地测试启动后:
本地开发环境已启动 PostgreSQL http://127.0.0.1:5432 (存储用户表信息,参考doc/table.md) OpenClaw Bridge http://127.0.0.1:18080 (每个用户容器启动时都会创建,用于控制openclaw) Platform Gateway http://127.0.0.1:8080 # 控制openclaw的网关 Frontend Dev http://127.0.0.1:3080 #用户使用界面 Manage Admin http://127.0.0.1:3081 #管理界面 方式2:手动启动
-
PostgreSQL (端口 5432)
docker run -d
--name openclaw-local-postgres
-e POSTGRES_USER=nanobot
-e POSTGRES_PASSWORD=nanobot
-e POSTGRES_DB=nanobot_platform
-v openclaw-local-pgdata:/var/lib/postgresql/data
-p 5432:5432
postgres:16-alpine
- OpenClaw Bridge (端口 18080)
cd openclaw
tsx bridge/start.ts
npx tsx bridge/start.ts
node bridge/dist/start.js
- Platform Gateway (端口 8080)
cd platform
export PLATFORM_DATABASE_URL="postgresql+asyncpg://nanobot:nanobot@localhost:5432/nanobot_platform" export PLATFORM_DEV_OPENCLAW_URL="http://127.0.0.1:18080" export PLATFORM_DEV_GATEWAY_URL="ws://127.0.0.1:18789"
python -m uvicorn app.main:app --host 0.0.0.0 --port 8080 --reload
注意:从项目根目录 .env 文件读取 _API_KEY、_API_BASE、JWT_SECRET、DEFAULT_MODEL 等配置。
- Frontend Dev Server (端口 3080)
cd frontend
npm install
VITE_API_URL=http://127.0.0.1:8080 npm run dev
快速启动单个服务
你也可以用脚本指定只启动某个服务:
✦ # 只启动 bridge python start_local.py --only bridge
python start_local.py --skip db,gateway
python start_local.py --stop
容器方式手动启动
# 1. 构建 openclaw 基础镜像(包含 openclaw + bridge) docker build -f openclaw/Dockerfile.bridge -t openclaw:latest openclaw/ # 2. 构建并启动所有服务 docker compose up -d --build # 查看日志 docker compose logs -f注意:前端使用相对路径
/api/...访问后端,由 nginx 反代到 gateway 容器。 换网或更换 IP 不需要重新 build 前端。
- 打开浏览器访问
http://localhost:3080 - 注册账号并登录
- 开始聊天 — Gateway 会自动为你创建隔离的 OpenClaw 容器
| 服务 | 端口 | 说明 |
|---|---|---|
| Frontend | 3080 (映射 3000) | Web 界面 |
| Gateway | 8080 | API 网关(浏览器直接请求) |
| PostgreSQL | 15432 (映射 5432) | 内部数据库 |
| OpenClaw Bridge (容器内) | 18080 | 容器对外 HTTP + WS |
| OpenClaw Gateway (容器内) | 18789 | 容器内部 Agent 引擎 (loopback) |
| 数据 | 存储方式 |
|---|---|
| 用户账户、配额、容器元数据 | PostgreSQL(pgdata volume) |
| 用户工作区和会话 | Docker named volumes + /data/openclaw-users |
# 查看所有容器 docker ps -a --filter "name=openclaw" # 查看某个用户容器的日志 docker logs -f openclaw-user-xxxxxxxx # 重建 gateway(修改后端代码后) docker compose build --no-cache gateway && docker compose up -d # 重建 frontend(修改前端代码或 API 地址后) docker compose build --no-cache frontend && docker compose up -d # 完全重置(删除所有数据) docker compose down -v docker rm -f $(docker ps -a --filter "name=openclaw-user-" -q) 2>/dev/null适合个人使用或者测试,无需完整多租户架构。
# 启动所有本地服务(推荐) python start_local.py # 或手动分别启动: # 1. PostgreSQL docker run -d --name postgres \ -e POSTGRES_USER=nanobot \ -e POSTGRES_PASSWORD=nanobot \ -e POSTGRES_DB=nanobot_platform \ -v pgdata:/var/lib/postgresql/data \ -p 5432:5432 \ postgres:16-alpine # 2. Platform Gateway cd platform export PLATFORM_DATABASE_URL="postgresql+asyncpg://nanobot:nanobot@localhost:5432/nanobot_platform" python -m app.main # 3. Frontend cd frontend && npm run dev ┌──────────────────────┐ │ 浏览器 (Frontend) │ │ Vite+React :3080 │ └──────────┬───────────┘ │ HTTP + WebSocket v ┌──────────────────────┐ │ Platform Gateway │ │ FastAPI :8080 │ │ ┌────────────────┐ │ │ │ Auth (JWT) │ │ │ │ Container Mgr │ │ │ │ LLM Proxy │ │ │ │ Quota Control │ │ │ └────────────────┘ │ └───┬──────────┬───────┘ │ │ ┌─────────┘ └──────────┐ v v ┌──────────────┐ ┌──────────────────┐ │ PostgreSQL │ │ 用户容器 (N个) │ │ :5432 │ │ ┌──────────────┐ │ │ 用户/配额/ │ │ │ Bridge :18080│ │ │ 容器元数据 │ │ │ HTTP + WS │ │ └──────────────┘ │ └──────┬───────┘ │ │ v │ │ ┌──────────────┐ │ │ │ OpenClaw GW │ │ │ │ :18789 │ │ │ │ (loopback) │ │ │ │ │ │ │ │ Agent Engine │ │ │ │ Tools/Skills │ │ │ │ Sessions │ │ │ └──────────────┘ │ └──────────────────┘ │ LLM 请求通过 Gateway 代理 │ v ┌──────────────────┐ │ LLM Providers │ │ Anthropic/OpenAI │ │ DashScope/... │ └──────────────────┘ OpenClaw 是一个功能丰富的 AI Agent 框架(TypeScript/Node.js),核心能力包括:
- Agent Loop:ReAct 模式的工具调用循环,支持多轮迭代
- 工具系统:Bash 执行、文件读写、Web 搜索/抓取、消息发送等
- Skills 系统:Markdown 格式的技能文件,支持内置 + 用户自定义
- Session 管理:对话历史持久化
- 多 Provider 支持:通过 OpenAI 兼容接口对接各种 LLM
Bridge 是连接平台和 OpenClaw 的关键适配层,在每个用户容器内运行:
| 文件 | 职责 |
|---|---|
bridge/start.ts | 启动入口:写入 OpenClaw 配置 → 启动 OpenClaw Gateway 子进程 → 等待就绪 → 启动 HTTP 服务 |
bridge/server.ts | Express HTTP 服务器(端口 18080),挂载 REST API 路由 + WebSocket 中继 |
bridge/gateway-client.ts | WebSocket 客户端,连接本地 OpenClaw Gateway(端口 18789),Ed25519 握手认证 |
bridge/config.ts | 读取环境变量(代理URL、Token、模型),创建工作目录 |
bridge/routes/*.ts | 各功能 API:sessions、skills、commands、plugins、cron、marketplace 等 |
Bridge 启动流程:
1. 读取环境变量 (NANOBOT_PROXY__URL, NANOBOT_PROXY__TOKEN, 模型名) 2. 写入 ~/.openclaw/openclaw.json(配置 LLM 代理、模型、Gateway 模式) 3. 启动 OpenClaw Gateway 子进程: node openclaw.mjs gateway run --port 18789 --bind loopback 4. 等待 Gateway WebSocket 就绪(最多 60 秒) 5. 建立 Bridge → Gateway 的 WS 连接(Ed25519 握手) 6. 启动 HTTP 服务器(0.0.0.0:18080),对外暴露 API Python FastAPI 应用,是整个平台的控制中心:
| 模块 | 文件 | 职责 |
|---|---|---|
| 认证 | app/auth/service.py | JWT + bcrypt,注册/登录/刷新 Token |
| 容器管理 | app/container/manager.py | Docker API 创建/暂停/归档/销毁用户容器 |
| LLM 代理 | app/llm_proxy/service.py | API Key 注入、配额检查、用量记录 |
| HTTP 代理 | app/routes/proxy.py | 转发 HTTP/WebSocket 请求到用户容器 |
| 数据库 | app/db/models.py | 用户、容器、用量 ORM 模型 |
容器生命周期:
用户首次聊天 → create_container() ├─ 在 DB 中占位(防并发) ├─ 创建 Docker Volume(workspace + sessions) ├─ 启动容器(资源限制:2GB RAM, 4 CPU) └─ 记录容器 IP、Token 空闲 30 分钟 → pause(暂停容器,释放 CPU) 再次访问 → unpause(秒级恢复) 空闲 30 天 → archive(归档) 用户删除 → destroy(移除容器,保留数据 Volume) 容器内的 OpenClaw 调用 LLM 时,不直接访问 LLM API,而是请求 Gateway 代理:
容器内 OpenClaw → POST http://gateway:8080/llm/v1/chat/completions Authorization: Bearer <container-token> Body: { model: "claude-sonnet-4-5", messages: [...] } Gateway 处理: 1. 通过 container-token 查找用户 2. 检查每日 Token 配额(free: 100K, basic: 1M, pro: 10M) 3. 根据模型名匹配 Provider(claude→Anthropic, gpt→OpenAI, qwen→DashScope...) 4. 注入对应的真实 API Key 5. 调用 LLM,流式/非流式返回结果 6. 记录 Token 用量 技能文件位于 openclaw/skills/,每个技能是一个包含 SKILL.md 的目录。用户也可以在自己的工作区中创建自定义技能。
管理接口(通过 Bridge API):
GET /api/skills— 列出所有技能(内置 + 用户自定义)POST /api/skills/upload— 上传技能(ZIP 格式)DELETE /api/skills/:name— 删除用户自定义技能GET /api/skills/:name/download— 导出技能
| 层面 | 措施 |
|---|---|
| API Key 隔离 | 所有 LLM API Key 仅存在于 Gateway 环境变量中,用户容器内无任何密钥 |
| 容器隔离 | 每个用户独立 Docker 容器,独立 Volume,资源限制 |
| 认证链路 | 前端 JWT → Gateway → 容器 Token(一次性,仅标识容器身份) |
| 网络隔离 | 用户容器运行在 openclaw-internal 网络,通过 Gateway 代理访问 LLM |
| 配额控制 | 每日 Token 配额,按用户等级分层 |
| 容器内安全 | OpenClaw Gateway 仅监听 loopback(127.0.0.1),Bridge 握手使用 Ed25519 |
Vite + React Router 单页应用,暗色主题,位于 frontend/ 目录。
| 技术 | 用途 |
|---|---|
| Vite | 构建工具 |
| React + React Router | 路由与 SPA 框架 |
| Tailwind CSS | 样式 |
| react-markdown + remark-gfm | Markdown 渲染(支持代码高亮、表格、复制按钮) |
| lucide-react | 图标 |
frontend/ ├── Dockerfile # 生产镜像(npm build → nginx 静态服务) ├── nginx.conf # nginx 配置:/ 静态文件,/api → gateway 反代 ├── package.json # 依赖管理 ├── vite.config.ts # Vite 配置(开发代理 /api → localhost:8080) ├── tailwind.config.js # Tailwind 主题配色 ├── index.html # SPA 入口 HTML └── src/ ├── main.tsx # React 入口,挂载 <App /> ├── App.tsx # 路由定义(React Router) ├── index.css # 全局样式 + Tailwind @import ├── lib/ │ └── api.ts # API 客户端(fetch + WebSocket,相对路径 /api/...) ├── store/ │ └── agents.ts # Agent 数据请求(fetchAgents、fetchDashboardStats 等) ├── types/ │ └── agent.ts # TypeScript 类型定义(BackendAgent、DashboardStats 等) ├── components/ │ ├── Layout.tsx # 全局布局:Sidebar + TopBar + <Outlet /> │ ├── Sidebar.tsx # 左侧导航栏(仪表盘、Agents、会话、技能…) │ ├── TopBar.tsx # 顶部栏(用户信息、退出登录) │ └── MarkdownContent.tsx # Markdown 渲染组件(代码块 + 复制按钮) └── pages/ ├── Dashboard.tsx # 仪表盘:统计卡片 + Agent 列表概览 ├── Login.tsx # 登录页 ├── Agents.tsx # Agent 列表页 ├── AgentCreate.tsx # 创建 Agent ├── AgentDetail.tsx # Agent 详情(配置、身份编辑) ├── Chat.tsx # 聊天页:会话列表 + 消息区 + WebSocket + 斜杠命令自动补全 ├── Sessions.tsx # 会话管理 ├── SkillStore.tsx # 技能商店(搜索、安装、启用/禁用) ├── CronJobs.tsx # 定时任务管理 ├── KnowledgeBase.tsx # 知识库文件管理 ├── FileManager.tsx # 工作空间文件浏览 ├── Channels.tsx # 渠道配置 ├── AIModels.tsx # AI 模型管理 ├── Plugins.tsx # 插件管理 ├── Nodes.tsx # 节点管理 ├── ApiAccess.tsx # API Token 管理 ├── AuditLog.tsx # 审计日志 └── SystemSettings.tsx # 系统设置 | 路由 | 页面文件 | 功能 |
|---|---|---|
/ | Dashboard.tsx | 仪表盘:Agent/会话/技能统计 + Agent 列表概览 |
/login | Login.tsx | 用户登录 |
/agents | Agents.tsx | Agent 列表 |
/agents/new | AgentCreate.tsx | 创建 Agent |
/agents/:id | AgentDetail.tsx | Agent 详情与配置 |
/agents/:id/chat | Chat.tsx | 与 Agent 对话(WebSocket 实时通信 + Markdown 渲染) |
/sessions | Sessions.tsx | 会话管理 |
/skills | SkillStore.tsx | 技能商店 |
/cron | CronJobs.tsx | 定时任务 |
/knowledge | KnowledgeBase.tsx | 知识库 |
/files | FileManager.tsx | 文件管理 |
/channels | Channels.tsx | 渠道配置 |
/models | AIModels.tsx | 模型管理 |
/plugins | Plugins.tsx | 插件管理 |
/api-access | ApiAccess.tsx | API Token |
/audit | AuditLog.tsx | 审计日志 |
/settings | SystemSettings.tsx | 系统设置 |
- 生产环境:前端通过 nginx 反代
/api/*到 gateway 容器,无需硬编码 IP - 开发环境:Vite 代理
/api/*到http://localhost:8080 - 换网不需要重新 build:前端使用相对路径
/api/...,由反代负责转发
前端 → Gateway → Bridge → OpenClaw Gateway(逐层代理)
// 发送消息 { "type": "req", "id": 1, "method": "chat.send", "params": { "sessionKey": "...", "message": "..." } } // 接收回复 (事件推送) { "type": "event", "event": "chat.message.received", "payload": { "content": "..." } } // 心跳 { "type": "ping" } / { "type": "pong" }deploy_copy/ ├── openclaw_defaults.json # OpenClaw 默认配置(合并到 ~/.openclaw/openclaw.json) ├── Agents/ # 预置 Agent 工作空间 │ ├── hr/ # 人力资源顾问 │ │ ├── SOUL.md # Agent 人格与核心原则 │ │ ├── AGENTS.md # Agent 行为规范与工具指南 │ │ └── USER.md # 用户画像与交互偏好 │ ├── researcher/ # 资深研究员 │ │ ├── SOUL.md │ │ ├── AGENTS.md │ │ └── USER.md │ └── programmer/ # 全栈工程师 │ ├── SOUL.md │ ├── AGENTS.md │ └── USER.md └── skills/ # 预置技能 ├── infoxmed-search/ # 医学信息检索 │ ├── SKILL.md # 技能定义(名称、描述、触发条件) │ └── scripts/infoxmed_search.py # 执行脚本 └── medical-research-agent/ # 医学研究 Agent ├── SKILL.md ├── scripts/search.py └── references/ # 参考资料(模板、工具说明) deploy_copy 是一个部署模板目录,在启动时自动将预置的 Agent 和技能同步到 OpenClaw 运行目录(~/.openclaw/)。
同步流程(幂等,只拷贝不存在的文件):
deploy_copy/Agents/hr/ → ~/.openclaw/workspace-hr/ (Agent 工作空间) ~/.openclaw/agents/hr/ (Agent 注册目录) openclaw.json → agents.list[] (注册到配置文件) deploy_copy/skills/infoxmed-search/ → ~/.openclaw/skills/infoxmed-search/ deploy_copy/openclaw_defaults.json → 合并到 ~/.openclaw/openclaw.json(只添加缺失的 key) 两种部署方式下的实现:
| 部署方式 | 实现文件 | 同步时机 |
|---|---|---|
start_local.py | start_local.py → _sync_agents() + _sync_dir() | Python 脚本启动时,直接操作本机文件系统 |
deploy_docker.py | openclaw/bridge-entrypoint.sh | 容器启动时,entrypoint 脚本从 /deploy-copy/ 同步到 $OPENCLAW_HOME |
Agent 注册的关键步骤:
- 创建 Agent 目录 —
~/.openclaw/agents/<id>/(Gateway 通过扫描此目录发现 Agent) - 同步工作空间 —
~/.openclaw/workspace-<id>/(存放 SOUL.md、AGENTS.md 等文件) - 写入配置 —
openclaw.json的agents.list[]中添加{id, name, workspace}(API 返回 Agent 列表的数据源)
如果只做了第 2 步但缺少第 1、3 步,Agent 不会在 Web UI 中显示。三步缺一不可。
# 1. 创建目录 mkdir -p deploy_copy/Agents/my_agent # 2. 编写 Markdown 配置文件 # SOUL.md — 定义 Agent 的身份、人格、核心原则 # AGENTS.md — 定义行为规范、工具使用指南、输出格式 # USER.md — 定义目标用户画像、交互偏好 # 3. 重新部署 python deploy_docker.py --host localhost # Docker 方式 # 或 python start_local.py # 本地方式(会自动同步)部署后访问 http://localhost:3080/agents 即可看到新 Agent。
项目根目录/ ├── .env # API Key 配置(不提交到 git) ├── .env.example # 环境变量模板 ├── docker-compose.yml # 多租户部署编排(postgres + gateway + frontend) ├── docker-compose.yml.prod # 生产环境 compose 配置 ├── deploy_docker.py # Docker 一键部署脚本(支持本地/远程/重建/清理) ├── start_local.py # 本地开发启动脚本(全服务一键启动) ├── start_local_wins.py # Windows 本地启动脚本 ├── prepare.py # 环境准备脚本(检查 Docker、拉镜像) ├── check_status.py # 服务状态检查 ├── call_agent_api.py # API 调用示例脚本 ├── sync_upstream.py # 上游 OpenClaw 同步工具 ├── inspect_db.py # 数据库检查工具 ├── pyproject.toml # Python 项目配置 │ ├── deploy_copy/ # 部署模板(自动拷贝到用户容器) │ ├── openclaw_defaults.json # OpenClaw 默认配置(合并到 openclaw.json) │ ├── Agents/ # 预置 Agent 工作空间模板 │ │ ├── hr/ # HR 助手(SOUL.md + AGENTS.md + USER.md) │ │ ├── researcher/ # 研究员助手 │ │ └── programmer/ # 程序员助手 │ └── skills/ # 预置技能 │ ├── infoxmed-search/ # 医学信息检索技能 │ └── medical-research-agent/ # 医学研究 Agent 技能 │ ├── openclaw/ # OpenClaw Agent 框架 + Bridge 适配层 ├── platform/ # 多租户平台网关(FastAPI) ├── frontend/ # Web 前端(Vite + React) ├── doc/ # 文档和截图 └── ssh_key/ # SSH 密钥(远程部署用) Bridge 是连接平台和 OpenClaw 的关键中间层,在每个用户容器内运行。
openclaw/ ├── Dockerfile # OpenClaw 基础镜像 ├── Dockerfile.bridge # Bridge 镜像(基于基础镜像 + bridge 代码) ├── bridge-entrypoint.sh # 容器入口脚本(同步 deploy_copy、注册 Agent) ├── package.json # Node.js 依赖 ├── openclaw.mjs # OpenClaw CLI 入口 │ └── bridge/ # Bridge 适配层源码 ├── start.ts # 启动入口:写入配置 → 启动 Gateway 子进程 → 启动 HTTP 服务 ├── server.ts # Express HTTP 服务器(端口 18080)+ WebSocket 中继 ├── gateway-client.ts # 连接本地 OpenClaw Gateway 的 WS 客户端(Ed25519 握手) ├── config.ts # 环境变量读取(代理 URL、Token、模型)、工作目录创建 ├── utils.ts # 通用工具函数 ├── types.d.ts # TypeScript 类型定义 ├── package.json # Bridge 独立依赖 │ └── routes/ # REST API 路由(挂载到 /api/*) ├── agents.ts # Agent 管理:列表、详情、创建、删除、身份配置 ├── sessions.ts # 会话管理:列表、历史消息、创建、删除 ├── skills.ts # 技能管理:列表、上传、删除、导出(扫描 3 个目录) ├── commands.ts # 斜杠命令:列出可用命令供前端自动补全 ├── plugins.ts # 插件管理:列表、安装、卸载 ├── cron.ts # 定时任务:创建、删除、启用/禁用、手动执行 ├── channels.ts # 渠道管理:配置 Telegram/Discord/Email 等 ├── events.ts # SSE 事件流:实时推送 Agent 执行状态 ├── files.ts # 文件操作:上传、下载(知识库用) ├── filemanager.ts # 文件管理器:浏览、创建目录、删除(工作空间用) ├── nodes.ts # 节点管理 ├── settings.ts # 设置:读写 openclaw.json 配置 ├── status.ts # 状态:Gateway 健康检查、版本信息 ├── workspace.ts # 工作空间:文件浏览和编辑 └── marketplaces.ts # 技能市场:搜索和安装 skills.sh 上的技能 Python FastAPI 应用,是整个平台的控制中心。
platform/ ├── Dockerfile # Gateway 镜像(Python 3.11 + uvicorn) ├── pyproject.toml # Python 依赖(fastapi, sqlalchemy, docker, jose...) ├── alembic.ini # 数据库迁移配置 ├── README.md # Platform 说明文档 │ ├── alembic/ # 数据库迁移脚本 │ ├── env.py # Alembic 环境配置 │ └── script.py.mako # 迁移脚本模板 │ └── app/ # FastAPI 应用 ├── __init__.py ├── main.py # 应用入口:创建 FastAPI app、挂载路由、启动事件 ├── config.py # 配置中心:API Key、数据库 URL、配额等级、默认模型 ├── logging_setup.py # 日志配置 │ ├── auth/ # 认证模块 │ ├── __init__.py │ ├── service.py # JWT + bcrypt 认证服务(注册/登录/刷新 Token) │ └── dependencies.py # FastAPI 依赖注入(get_current_user 等) │ ├── container/ # 容器管理模块 │ ├── __init__.py │ └── manager.py # Docker API 封装:创建/暂停/恢复/归档/销毁用户容器 │ ├── db/ # 数据库模块 │ ├── __init__.py │ ├── engine.py # SQLAlchemy 异步引擎 + 会话工厂 │ └── models.py # ORM 模型:User、Container、Usage │ ├── llm_proxy/ # LLM 代理模块 │ ├── __init__.py │ └── service.py # API Key 注入、Provider 匹配、配额检查、用量记录 │ └── routes/ # API 路由 ├── __init__.py ├── auth.py # POST /auth/register, /auth/login, /auth/refresh ├── proxy.py # /api/openclaw/* → 用户容器(HTTP 反代 + WebSocket 代理) ├── llm.py # POST /llm/v1/chat/completions(容器调 LLM 的入口) └── admin.py # 管理接口:用户列表、容器管理、系统状态 详见 第 7 节 前端 的目录结构。
通过 call_agent_api.py 脚本可以从命令行调用 Agent,适合外部系统集成。
# 使用 API Token(从前端 系统→API 页面生成) python call_agent_api.py --api-token "eyJ..." --agent main --message "你好" # 指定 Agent ID python call_agent_api.py --api-token "eyJ..." --agent insurance --message "帮我分析一下保险方案" # 复用已有会话 python call_agent_api.py --api-token "eyJ..." --agent main --message "继续" --session "agent:main:session-123" # 使用用户名密码认证(不推荐) python call_agent_api.py --username admin --password admin123 --agent main --message "你好" # 指定服务器地址 python call_agent_api.py --base-url http://192.168.1.100:8080 --api-token "eyJ..." --agent main --message "hello"- 预览变更(不实际执行)
python upgrade_openclaw.py /Users/admin/git/openclaw --dry-run
- 执行升级
python upgrade_openclaw.py /Users/admin/git/openclaw
核心功能:
- 升级前提醒 — 注意先 git commit 备份,检测未提交更改并警告
- 查看 .gitignore — 跳过 node_modules、dist、pnpm-lock.yaml 等忽略项
- 保护bridge文件 — bridge、bridge-entrypoint.sh、bridge-package.json、bridge-deploy-copy、Dockerfile.bridge、tsconfig.bridge.json 不会被覆盖或删除
- 文件分类 — 分为新增、更新、待删除三类,先打印摘要再执行
- 删除逐个确认 — 本地有但上游没有的文件,逐个询问是否删除
- dry-run 模式 — 用 --dry-run 只看差异不执行操作
- 列出容器所有卷 docker volume ls
- 删除某个用户的挂载数据 docker volume rm xxx, 实际挂载的是/root/.openclaw目录
browser_binding = _published_binding(docker_container, "5900/tcp") service_binding = _published_binding(docker_container, "30000/tcp")









