跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
概览

  • 单个长期运行的 Gateway 网关 负责所有消息界面（通过 Baileys 接入 WhatsApp、通过 grammY 接入 Telegram、以及 Slack、Discord、Signal、iMessage、WebChat）。
  • 控制平面客户端（macOS 应用、CLI、web UI、自动化）通过配置的绑定主机上的 WebSocket 连接到 Gateway 网关（默认 127.0.0.1:18789）。
  • 节点（macOS/iOS/Android/无头）也通过 WebSocket 连接，但会声明 role: node，并带有显式 caps/commands。
  • 每台主机只运行一个 Gateway 网关；它是唯一会打开 WhatsApp 会话的地方。
  • canvas host 由 Gateway 网关 HTTP 服务器提供，路径为：
    • /__openclaw__/canvas/（智能体可编辑的 HTML/CSS/JS）
    • /__openclaw__/a2ui/（A2UI host） 它与 Gateway 网关使用相同端口（默认 18789）。

​
组件与流程

​
Gateway 网关（守护进程）

  • 维护提供商连接。
  • 暴露类型化的 WS API（请求、响应、服务器推送事件）。
  • 根据 JSON Schema 验证入站帧。
  • 发出 agent、chat、presence、health、heartbeat、cron 等事件。

​
客户端（mac 应用 / CLI / web 管理界面）

  • 每个客户端一个 WS 连接。
  • 发送请求（health、status、send、agent、system-presence）。
  • 订阅事件（tick、agent、presence、shutdown）。

​
节点（macOS / iOS / Android / 无头）

  • 以 role: node 连接到同一个 WS 服务器。
  • 在 connect 中提供设备身份；配对是基于设备的（角色 node），批准信息保存在设备配对存储中。
  • 暴露 canvas.*、camera.*、screen.record、location.get 等命令。
协议细节：

​
WebChat

  • 使用 Gateway 网关 WS API 处理聊天记录和发送的静态 UI。
  • 在远程设置中，通过与其他客户端相同的 SSH/Tailscale 隧道连接。

​
连接生命周期（单客户端）

​
线协议（摘要）

  • 传输：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，具体取决于已配置的 gateway 认证模式。
  • 像 Tailscale Serve 这类携带身份的模式 （gateway.auth.allowTailscale: true）或非 loopback gateway.auth.mode: "trusted-proxy"，会通过请求头而不是 connect.params.auth.* 满足认证。
  • 私有入口 gateway.auth.mode: "none" 会完全禁用共享密钥认证；请勿在公共/不受信任入口上使用该模式。
  • 对于有副作用的方法（send、agent），必须提供幂等键，才能安全重试；服务器会保留一个短生命周期的去重缓存。
  • 节点必须在 connect 中包含 role: "node"，以及 caps/commands/permissions。

​
配对 + 本地信任

  • 所有 WS 客户端（操作端 + 节点）都会在 connect 中包含设备身份。
  • 新设备 ID 需要配对批准；Gateway 网关会签发一个设备 token，供后续连接使用。
  • 直接的本地 loopback 连接可以自动批准，以保持同主机 UX 顺畅。
  • OpenClaw 还为受信任的共享密钥辅助流程提供一条受限的后端/容器本地自连接路径。
  • tailnet 和 LAN 连接，包括同主机 tailnet 绑定，仍然需要显式配对批准。
  • 所有连接都必须对 connect.challenge nonce 进行签名。
  • 签名载荷 v3 还会绑定 platform + deviceFamily；gateway 会在重连时固定已配对元数据，并在元数据变化时要求修复性重新配对。
  • 非本地连接仍然需要显式批准。
  • Gateway 网关认证（gateway.auth.*）仍适用于所有连接，无论本地还是远程。
详情请参见：Gateway protocol、Pairing、 Security。

​
协议类型与代码生成

  • TypeBox schema 定义协议。
  • JSON Schema 从这些 schema 中生成。
  • Swift 模型从 JSON Schema 中生成。

​
远程访问

  • 首选：Tailscale 或 VPN。
  • 备选：SSH 隧道 
    ssh -N -L 18789:127.0.0.1:18789 user@host
  • 通过隧道时，使用相同的握手 + 认证 token。
  • 在远程设置中，可以为 WS 启用 TLS + 可选 pinning。

​
运维快照

  • 启动：openclaw gateway（前台运行，日志输出到 stdout）。
  • 健康检查：通过 WS 使用 health（也包含在 hello-ok 中）。
  • 监管：使用 launchd/systemd 实现自动重启。

​
不变量

  • 每台主机恰好由一个 Gateway 网关控制一个 Baileys 会话。
  • 握手是强制的；任何非 JSON 或首帧不是 connect 的情况都会被强制关闭连接。
  • 事件不会重放；客户端必须在出现缺口时主动刷新。

​
相关内容