控制面板(浏览器)

控制面板是一个小型 Vite + Lit 单页应用,由 Gateway 提供服务:

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

它通过同端口直接与 Gateway WebSocket 通信。

快速打开(本地)

如果 Gateway 运行在本机,打开:

如果页面加载失败,先启动 Gateway:openclaw gateway

认证通过 WebSocket 握手提供:

  • connect.params.auth.token
  • connect.params.auth.password 控制面板设置面板为当前浏览器标签页会话和选定的 gateway URL 保存 token;密码不持久化。 引导向导默认生成 gateway token,首次连接时粘贴到这里。

设备配对(首次连接)

从新浏览器或设备连接控制面板时,Gateway 需要一次性配对审批——即使你在同一个 Tailnet 且 gateway.auth.allowTailscale: true。这是防止未授权访问的安全措施。

你会看到: “disconnected (1008): pairing required”

批准设备:

# 列出待处理请求
openclaw devices list

# 按请求 ID 批准
openclaw devices approve <requestId>

批准后设备会被记住,除非你用 openclaw devices revoke --device <id> --role <role> 撤销。设备 CLI 的 token 轮换和撤销详见 设备 CLI

说明:

  • 本地连接(127.0.0.1)自动批准。
  • 远程连接(LAN、Tailnet 等)需要显式批准。
  • 每个浏览器配置文件生成唯一的设备 ID,切换浏览器或清除浏览器数据需要重新配对。

语言支持

控制面板可在首次加载时根据浏览器语言环境进行本地化,之后也可在 Access 卡片的语言选择器中更改。

  • 支持的语言:enzh-CNzh-TWpt-BRdees
  • 非英语翻译在浏览器中按需加载。
  • 选择的语言保存在浏览器存储中,后续访问时复用。
  • 缺失的翻译键回退到英语。

当前功能

  • 通过 Gateway WS 与模型聊天(chat.historychat.sendchat.abortchat.inject
  • 在聊天中流式显示工具调用 + 实时工具输出卡片(agent 事件)
  • 频道:WhatsApp/Telegram/Discord/Slack + 插件频道(Mattermost 等)状态 + QR 登录 + 按频道配置(channels.statusweb.login.*config.patch
  • 实例:在线列表 + 刷新(system-presence
  • 会话:列表 + 按会话的 thinking/fast/verbose/reasoning 覆盖(sessions.listsessions.patch
  • 定时任务:列表/添加/编辑/运行/启用/禁用 + 运行历史(cron.*
  • 技能:状态、启用/禁用、安装、API 密钥更新(skills.*
  • 节点:列表 + 能力(node.list
  • 执行审批:编辑 gateway 或节点白名单 + exec host=gateway/node 的 ask 策略(exec.approvals.*
  • 配置:查看/编辑 ~/.openclaw/openclaw.jsonconfig.getconfig.set
  • 配置:带校验的应用 + 重启(config.apply),并唤醒最近活跃的会话
  • 配置写入包含 base-hash 保护,防止覆盖并发编辑
  • 配置 schema + 表单渲染(config.schema,包括插件 + 频道 schema);原始 JSON 编辑器仍然可用
  • 调试:状态/健康/模型快照 + 事件日志 + 手动 RPC 调用(statushealthmodels.list
  • 日志:gateway 文件日志的实时尾随,带过滤/导出(logs.tail
  • 更新:运行包/git 更新 + 重启(update.run),带重启报告

定时任务面板说明:

  • 对于隔离任务,投递默认为摘要广播。如果只想内部运行,可以切换为 none。
  • 选择 announce 时显示频道/目标字段。
  • Webhook 模式使用 delivery.mode = "webhook"delivery.to 设为有效的 HTTP(S) webhook URL。
  • 对于主会话任务,可用 webhook 和 none 投递模式。
  • 高级编辑控件包括运行后删除、清除 agent 覆盖、cron 精确/随机偏移选项、agent 模型/thinking 覆盖和尽力投递开关。
  • 表单校验为内联字段级错误;无效值禁用保存按钮直到修复。
  • 设置 cron.webhookToken 发送专用 bearer token;省略时 webhook 不带认证头。
  • 弃用回退:存储的旧版 notify: true 任务仍可使用 cron.webhook,待迁移。

聊天行为

  • chat.send非阻塞的:立即确认 { runId, status: "started" },响应通过 chat 事件流式传输。
  • 使用相同 idempotencyKey 重发时,运行中返回 { status: "in_flight" },完成后返回 { status: "ok" }
  • chat.history 响应有大小限制以保护 UI 安全。当对话条目过大时,Gateway 可能截断长文本字段、省略大块元数据,或用占位符替换超大消息([chat.history omitted: message too large])。
  • chat.inject 向会话对话记录追加一条助手备注,并广播 chat 事件用于 UI 更新(不触发 agent 运行,不投递到频道)。
  • 停止:
    • 点击 Stop(调用 chat.abort
    • 输入 /stop(或独立的中止短语如 stopstop actionstop runstop openclawplease stop)进行带外中止
    • chat.abort 支持 { sessionKey }(不需要 runId)来中止该会话的所有活跃运行
  • 中止部分保留:
    • 运行被中止时,部分助手文本仍可在 UI 中显示
    • Gateway 在有缓冲输出时将中止的部分助手文本持久化到对话历史
    • 持久化的条目包含中止元数据,对话消费者可以区分中止的部分输出和正常完成输出

Tailnet 访问(推荐)

集成 Tailscale Serve(首选)

让 Gateway 绑定回环地址,由 Tailscale Serve 代理并提供 HTTPS:

openclaw gateway --tailscale serve

打开:

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

默认情况下,当 gateway.auth.allowTailscaletrue 时,控制面板/WebSocket Serve 请求可通过 Tailscale 身份头(tailscale-user-login)认证。OpenClaw 通过 tailscale whois 解析 x-forwarded-for 地址并与头信息匹配来验证身份,且仅在请求经过回环地址并携带 Tailscale 的 x-forwarded-* 头时接受。设置 gateway.auth.allowTailscale: false(或强制 gateway.auth.mode: "password")可要求即使 Serve 流量也需要 token/密码。 无 token 的 Serve 认证假设 gateway 主机是可信的。如果不受信任的本地代码可能在该主机上运行,请要求 token/密码认证。

绑定 Tailnet + token

openclaw gateway --bind tailnet --token "$(openssl rand -hex 32)"

然后打开:

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

在 UI 设置中粘贴 token(通过 connect.params.auth.token 发送)。

不安全的 HTTP

如果通过明文 HTTP 打开控制面板(http://<lan-ip>http://<tailscale-ip>),浏览器运行在非安全上下文中,会阻止 WebCrypto。默认情况下,OpenClaw 阻止没有设备身份的控制面板连接。

推荐方案: 使用 HTTPS(Tailscale Serve)或在本地打开 UI:

  • https://<magicdns>/(Serve)
  • http://127.0.0.1:18789/(在 gateway 主机上)

不安全认证开关行为:

{
  gateway: {
    controlUi: { allowInsecureAuth: true },
    bind: "tailnet",
    auth: { mode: "token", token: "replace-me" },
  },
}

allowInsecureAuth 仅是本地兼容性开关:

  • 允许 localhost 控制面板会话在非安全 HTTP 上下文中无需设备身份即可继续。
  • 不绕过配对检查。
  • 不放宽远程(非 localhost)设备身份要求。

紧急情况专用:

{
  gateway: {
    controlUi: { dangerouslyDisableDeviceAuth: true },
    bind: "tailnet",
    auth: { mode: "token", token: "replace-me" },
  },
}

dangerouslyDisableDeviceAuth 禁用控制面板设备身份检查,是一个严重的安全降级。紧急使用后请尽快恢复。

HTTPS 配置指引见 Tailscale

构建 UI

Gateway 从 dist/control-ui 提供静态文件。构建命令:

pnpm ui:build # 首次运行时自动安装 UI 依赖

可选的绝对基路径(需要固定资源 URL 时):

OPENCLAW_CONTROL_UI_BASE_PATH=/openclaw/ pnpm ui:build

本地开发(独立开发服务器):

pnpm ui:dev # 首次运行时自动安装 UI 依赖

然后将 UI 指向你的 Gateway WS URL(如 ws://127.0.0.1:18789)。

调试/测试:开发服务器 + 远程 Gateway

控制面板是静态文件;WebSocket 目标可配置,可以和 HTTP 来源不同。这在本地运行 Vite 开发服务器但 Gateway 在其他机器上时很方便。

  1. 启动 UI 开发服务器:pnpm ui:dev
  2. 打开类似以下的 URL:
http://localhost:5173/?gatewayUrl=ws://<gateway-host>:18789

可选的一次性认证(如果需要):

http://localhost:5173/?gatewayUrl=wss://<gateway-host>:18789#token=<gateway-token>

说明:

  • gatewayUrl 加载后存储在 localStorage 中并从 URL 中移除。
  • token 从 URL fragment 导入,存储在当前浏览器标签页会话和选定 gateway URL 的 sessionStorage 中,并从 URL 中剥离;不存储在 localStorage。
  • password 仅保存在内存中。
  • 设置 gatewayUrl 后,UI 不会回退到配置或环境凭据。请显式提供 token(或 password)。缺少显式凭据会报错。
  • Gateway 在 TLS 后面时(Tailscale Serve、HTTPS 代理等)使用 wss://
  • gatewayUrl 仅在顶层窗口中接受(不在嵌入中),防止点击劫持。
  • 非回环的控制面板部署必须显式设置 gateway.controlUi.allowedOrigins(完整 origin)。这包括远程开发环境。
  • gateway.controlUi.dangerouslyAllowHostHeaderOriginFallback=true 启用 Host 头 origin 回退模式,但这是一个危险的安全模式。

示例:

{
  gateway: {
    controlUi: {
      allowedOrigins: ["http://localhost:5173"],
    },
  },
}

远程访问配置详见 远程访问