Gateway(网关) 架构
- 单个长期运行的 Gateway(网关) 拥有所有消息传递表面(通过 WhatsApp 的 Baileys,通过 Telegram 的 grammY,Slack,Discord,Signal,iMessage,WebChat)。
- 控制平面客户端(macOS 应用、CLI、Web UI、自动化)通过 WebSocket 连接到配置的绑定主机(默认为
127.0.0.1:18789)上的 Gateway(网关)。 - 节点(macOS/iOS/Android/headless)也通过 WebSocket 连接,但使用显式的 caps/commands 声明
role: node。 - 每台主机一个 Gateway(网关);它是唯一打开 WhatsApp 会话的地方。
- 画布主机 由 Gateway(网关) HTTP 服务器提供服务,位于:
/__openclaw__/canvas/(agent-editable HTML/CSS/JS)/__openclaw__/a2ui/(A2UI host) 它使用与 Gateway(网关) 相同的端口(默认为18789)。
Gateway(网关) (daemon)
Section titled “Gateway(网关) (daemon)”- 维护提供商连接。
- 暴露一个类型化的 WS API(请求、响应、服务器推送事件)。
- 根据 JSON Schema 验证入站帧。
- 发出事件,如
agent、chat、presence、health、heartbeat、cron。
客户端 (mac app / CLI / web admin)
Section titled “客户端 (mac app / CLI / web admin)”- 每个客户端一个 WS 连接。
- 发送请求(
health、status、send、agent、system-presence)。 - 订阅事件(
tick、agent、presence、shutdown)。
节点 (macOS / iOS / Android / headless)
Section titled “节点 (macOS / iOS / Android / headless)”- 使用
role: node连接到 同一 WS 服务器。 - 在
connect中提供设备身份;配对是 基于设备的(角色node),并且批准存在于设备配对存储中。 - 公开命令,如
canvas.*、camera.*、screen.record、location.get。
协议详情:
WebChat
Section titled “WebChat”- 使用 Gateway(网关) WS API 获取聊天记录并发送消息的静态 UI。
- 在远程设置中,通过与其他客户端相同的 SSH/Tailscale 隧道进行连接。
连接生命周期(单个客户端)
Section titled “连接生命周期(单个客户端)”sequenceDiagram participant Client participant Gateway
Client->>Gateway: req:connect Gateway-->>Client: res (ok) Note right of Gateway: or res error + close Note left of Client: payload=hello-ok<br>snapshot: presence + health
Gateway-->>Client: event:presence Gateway-->>Client: event:tick
Client->>Gateway: req:agent Gateway-->>Client: res:agent<br>ack {runId, status:"accepted"} Gateway-->>Client: event:agent<br>(streaming) Gateway-->>Client: res:agent<br>final {runId, status, summary}线路协议(摘要)
Section titled “线路协议(摘要)”- 传输:WebSocket,带有 JSON 负载的文本帧。
- 第一帧 必须 是
connect。 - 握手后:
- 请求:
{type:"req", id, method, params}→{type:"res", id, ok, payload|error} - 事件:
{type:"event", event, payload, seq?, stateVersion?}
- 请求:
hello-ok.features.methods/events是发现元数据,而非每个可调用辅助路由的生成转储。- 共享密钥认证使用
connect.params.auth.token或connect.params.auth.password,具体取决于配置的网关认证模式。 - 承载身份的模式(如 Tailscale Serve
(
gateway.auth.allowTailscale: true) 或非环回gateway.auth.mode: "trusted-proxy")通过请求头满足认证, 而非使用connect.params.auth.*。 - 私有入口
gateway.auth.mode: "none"完全禁用共享密钥认证; 请勿将该模式用于公共/不受信任的入口。 - 具有副作用的方法(
send,agent)需要幂等键以安全重试;服务器会保留一个短期的去重缓存。 - 节点必须在
connect中包含role: "node"以及 caps/commands/permissions。
配对 + 本地信任
Section titled “配对 + 本地信任”- 所有 WS 客户端(操作员 + 节点)都必须在
connect上包含 设备标识。 - 新的设备 ID 需要配对批准;Gateway(网关) 会为后续连接签发 设备令牌。
- 直接本地环回连接可以自动批准,以保持同主机用户体验流畅。
- OpenClaw 还有一个狭窄的后端/容器本地自连接路径, 用于受信任的共享密钥辅助流程。
- Tailnet 和 LAN 连接(包括同主机 tailnet 绑定)仍然需要 显式的配对批准。
- 所有连接必须对
connect.challengenonce 进行签名。 - 签名负载
v3还绑定了platform+deviceFamily;网关 会在重新连接时锁定已配对的元数据,并要求进行修复配对以更改元数据。 - 非本地 连接仍然需要显式批准。
- Gateway(网关) 认证 (
gateway.auth.*) 仍然适用于 所有 连接,无论是本地还是远程。
详情:Gateway(网关) protocol、Pairing、 Security。
Protocol typing and codegen
Section titled “Protocol typing and codegen”- TypeBox schemas 定义协议。
- JSON Schema 是从这些 schemas 生成的。
- Swift 模型是从 JSON Schema 生成的。
Remote access
Section titled “Remote access”-
首选:Tailscale 或 VPN。
-
备选:SSH 隧道
Terminal window ssh -N -L 18789:127.0.0.1:18789 user@host -
相同的握手 + auth token 适用于隧道连接。
-
在远程设置中,可以为 WS 启用 TLS + 可选的证书固定。
Operations snapshot
Section titled “Operations snapshot”- 启动:
openclaw gateway(前台运行,日志输出到 stdout)。 - 健康检查:通过 WS 发送
health(也包含在hello-ok中)。 - 监管:使用 launchd/systemd 进行自动重启。
Invariants
Section titled “Invariants”- 每个主机上只有一个 Gateway(网关) 控制一个 Baileys 会话。
- 握手是强制性的;任何非 JSON 或非连接的首帧都会导致强制关闭。
- Events 不会重放;客户端必须在出现间隙时进行刷新。
Related
Section titled “Related”- Agent Loop — 详细的 agent 执行循环
- Gateway(网关) Protocol — WebSocket 协议契约
- Queue — 命令队列和并发
- Security — 信任模型和加固