What: switch to 你/你的 tone; standardize Skills/Gateway网关/local loopback/私信 wording Why: align zh-CN docs with issue 6995 feedback + idiomatic tech style Tests: pnpm docs:build
3.0 KiB
3.0 KiB
read_when, summary, title, x-i18n
| read_when | summary | title | x-i18n | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Gateway网关 Web 界面:控制 UI、绑定模式与安全 | Web |
|
Web(Gateway网关)
Gateway网关在与 Gateway网关 WebSocket 相同的端口上提供一个小型浏览器控制 UI(Vite + Lit):
- 默认:
http://<host>:18789/ - 可选前缀:设置
gateway.controlUi.basePath(例如/openclaw)
功能详情请参阅控制 UI。 本页重点介绍绑定模式、安全和面向 Web 的界面。
Webhook
当 hooks.enabled=true 时,Gateway网关还会在同一 HTTP 服务器上暴露一个小型 webhook 端点。
请参阅 Gateway网关配置 → hooks 了解认证和负载。
配置(默认启用)
当资源文件存在时(dist/control-ui),控制 UI 默认启用。
你可以通过配置控制它:
{
gateway: {
controlUi: { enabled: true, basePath: "/openclaw" }, // basePath 可选
},
}
Tailscale 访问
集成 Serve(推荐)
将 Gateway网关保持在 local loopback 上,让 Tailscale Serve 代理它:
{
gateway: {
bind: "loopback",
tailscale: { mode: "serve" },
},
}
然后启动 Gateway网关:
openclaw gateway
打开:
https://<magicdns>/(或你配置的gateway.controlUi.basePath)
Tailnet 绑定 + 令牌
{
gateway: {
bind: "tailnet",
controlUi: { enabled: true },
auth: { mode: "token", token: "your-token" },
},
}
然后启动 Gateway网关(非 local loopback 绑定需要令牌):
openclaw gateway
打开:
http://<tailscale-ip>:18789/(或你配置的gateway.controlUi.basePath)
公网访问(Funnel)
{
gateway: {
bind: "loopback",
tailscale: { mode: "funnel" },
auth: { mode: "password" }, // 或 OPENCLAW_GATEWAY_PASSWORD
},
}
安全说明
- Gateway网关认证默认必需(令牌/密码或 Tailscale 身份头)。
- 非 local loopback 绑定仍然需要共享令牌/密码(
gateway.auth或环境变量)。 - 向导默认生成 Gateway网关令牌(即使在 local loopback 上)。
- UI 发送
connect.params.auth.token或connect.params.auth.password。 - 使用 Serve 时,当
gateway.auth.allowTailscale为true时,Tailscale 身份头可满足认证要求(无需令牌/密码)。设置gateway.auth.allowTailscale: false以要求显式凭据。请参阅 Tailscale 和安全。 gateway.tailscale.mode: "funnel"需要gateway.auth.mode: "password"(共享密码)。
构建 UI
Gateway网关从 dist/control-ui 提供静态文件。使用以下命令构建:
pnpm ui:build # 首次运行时自动安装 UI 依赖