Skip to content

Web (网关)

网关提供一个小型的浏览器控制 UI(Vite + Lit),与网关 WebSocket 使用同一端口:

  • 默认: http://<host>:18789/
  • 可选前缀: 设置 gateway.controlUi.basePath (例如 /openclaw)

功能位于 控制 UI。 本页重点介绍绑定模式、安全性和 Web 界面。

Webhooks

hooks.enabled=true 时,网关还会在同一 HTTP 服务器上公开一个小型 webhook 端点。 有关认证和载荷,请参阅 网关配置hooks

配置 (默认启用)

当资源存在时(dist/control-ui),控制 UI 默认启用。 您可以通过配置控制它:

json5
{
  gateway: {
    controlUi: { enabled: true, basePath: "/openclaw" }, // basePath optional
  },
}

Tailscale 访问

集成 Serve (推荐)

将网关保持在本地回环上,让 Tailscale Serve 代理它:

json5
{
  gateway: {
    bind: "loopback",
    tailscale: { mode: "serve" },
  },
}

然后启动网关:

bash
openclaw gateway

打开:

  • https://<magicdns>/ (或您配置的 gateway.controlUi.basePath)

Tailnet 绑定 + 令牌

json5
{
  gateway: {
    bind: "tailnet",
    controlUi: { enabled: true },
    auth: { mode: "token", token: "your-token" },
  },
}

然后启动网关(非本地回环绑定需要令牌):

bash
openclaw gateway

打开:

  • http://<tailscale-ip>:18789/ (或您配置的 gateway.controlUi.basePath)

公共互联网 (Funnel)

json5
{
  gateway: {
    bind: "loopback",
    tailscale: { mode: "funnel" },
    auth: { mode: "password" }, // or OPENCLAW_GATEWAY_PASSWORD
  },
}

安全说明

  • 默认情况下需要网关认证(令牌/密码或 Tailscale 身份标头)。
  • 非本地回环绑定仍然需要共享令牌/密码(gateway.auth 或环境变量)。
  • 向导默认生成网关令牌(即使在本地回环上)。
  • UI 发送 connect.params.auth.tokenconnect.params.auth.password
  • 控制 UI 发送反点击劫持标头,并且仅接受同源浏览器 WebSocket 连接,除非设置了 gateway.controlUi.allowedOrigins
  • 使用 Serve 时,当 gateway.auth.allowTailscaletrue 时,Tailscale 身份标头可以满足认证要求(无需令牌/密码)。设置 gateway.auth.allowTailscale: false 以要求显式凭据。请参阅 Tailscale安全性
  • gateway.tailscale.mode: "funnel" 需要 gateway.auth.mode: "password" (共享密码)。

构建 UI

网关从 dist/control-ui 提供静态文件。使用以下命令构建:

bash
pnpm ui:build # auto-installs UI deps on first run