English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย

基础

Gateway 网关架构

概览

  • 单个长期运行的 Gateway 网关 拥有所有消息表面（通过 Baileys 的 WhatsApp、通过 grammY 的 Telegram、Slack、Discord、Signal、iMessage、WebChat）。
  • 控制平面客户端（macOS 应用、CLI、Web UI、自动化）通过配置的绑定主机上的 WebSocket 连接到 Gateway 网关（默认 127.0.0.1:18789）。
  • 节点（macOS/iOS/Android/headless）也通过 WebSocket 连接，但会声明带有显式能力/命令的 role: node。
  • 每台主机一个 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 / headless）

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

协议详情：

WebChat

  • 使用 Gateway 网关 WS API 获取聊天历史并发送消息的静态 UI。
  • 在远程设置中，通过与其他客户端相同的 SSH/Tailscale 隧道连接。

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

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
snapshot: presence + health

    Gateway-->>Client: event:presence
    Gateway-->>Client: event:tick

    Client->>Gateway: req:agent
    Gateway-->>Client: res:agent
ack {runId, status:"accepted"}
    Gateway-->>Client: event:agent
(streaming)
    Gateway-->>Client: res:agent
final {runId, status, summary}

线缆协议（摘要）

  • 传输：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) 或非回环 gateway.auth.mode: "trusted-proxy"，会从请求标头满足认证，而不是使用 connect.params.auth.*。
  • 私有入口 gateway.auth.mode: "none" 会完全禁用共享密钥认证；不要在公共/不受信任的入口上启用该模式。
  • 对有副作用的方法（send、agent），需要幂等键才能安全重试；服务器会保留一个短生命周期的去重缓存。
  • 节点必须在 connect 中包含 role: "node" 以及能力/命令/权限。

配对 + 本地信任

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

详情：Gateway 网关协议、配对、 安全。

协议类型和代码生成

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

远程访问

  • 首选：Tailscale 或 VPN。

  • 替代方案：SSH 隧道

    ssh -N -L 18789:127.0.0.1:18789 user@host

  • 同样的握手 + 认证令牌适用于隧道连接。

  • 在远程设置中，可以为 WS 启用 TLS + 可选固定。

运维快照

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

不变量

  • 每台主机只有一个 Gateway 网关控制单个 Baileys 会话。
  • 握手是强制性的；任何非 JSON 或首帧非 connect 的情况都会强制关闭。
  • 事件不会重放；客户端必须在出现间隙时刷新。

相关