Web

The Gateway serves a small browser Control UI (Vite + Lit) from the same port as the Gateway WebSocket:

• default:
  text

  Copy

  http://<host>:18789/
• with
  text

  Copy

  gateway.tls.enabled: true
  :
  text

  Copy

  https://<host>:18789/
• optional prefix: set
  text

  Copy

  gateway.controlUi.basePath
  (e.g.
  text

  Copy

  /openclaw
  )

Capabilities live in Control UI. The rest of this page focuses on bind modes, security, and web-facing surfaces.

Webhooks

When

, the Gateway also exposes a small webhook endpoint on the same HTTP server. See Gateway configuration → for auth + payloads.

Config (default-on)

The Control UI is enabled by default when assets are present (

). You can control it via config:

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

Tailscale access

Integrated Serve (recommended)

Keep the Gateway on loopback and let Tailscale Serve proxy it:

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

Then start the gateway:

bash
Copy
openclaw gateway

Open:

• text

  Copy

  https://<magicdns>/
  (or your configured
  text

  Copy

  gateway.controlUi.basePath
  )

Tailnet bind + token

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

Then start the gateway (this non-loopback example uses shared-secret token auth):

bash
Copy
openclaw gateway

Open:

• text

  Copy

  http://<tailscale-ip>:18789/
  (or your configured
  text

  Copy

  gateway.controlUi.basePath
  )

Public internet (Funnel)

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

Security notes

• Gateway auth is required by default (token, password, trusted-proxy, or Tailscale Serve identity headers when enabled).
• Non-loopback binds still require gateway auth. In practice that means token/password auth or an identity-aware reverse proxy with
  text

  Copy

  gateway.auth.mode: "trusted-proxy"
  .
• The wizard creates shared-secret auth by default and usually generates a gateway token (even on loopback).
• In shared-secret mode, the UI sends
  text

  Copy

  connect.params.auth.token
  or
  text

  Copy

  connect.params.auth.password
  .
• When
  text

  Copy

  gateway.tls.enabled: true
  , local dashboard and status helpers render
  text

  Copy

  https://
  dashboard URLs and
  text

  Copy

  wss://
  WebSocket URLs.
• In identity-bearing modes such as Tailscale Serve or
  text

  Copy

  trusted-proxy
  , the WebSocket auth check is satisfied from request headers instead.
• For non-loopback Control UI deployments, set
  text

  Copy

  gateway.controlUi.allowedOrigins
  explicitly (full origins). Without it, gateway startup is refused by default.
• text

  Copy

  gateway.controlUi.dangerouslyAllowHostHeaderOriginFallback=true
  enables Host-header origin fallback mode, but is a dangerous security downgrade.
• With Serve, Tailscale identity headers can satisfy Control UI/WebSocket auth when
  text

  Copy

  gateway.auth.allowTailscale
  is
  text

  Copy

  true
  (no token/password required). HTTP API endpoints do not use those Tailscale identity headers; they follow the gateway's normal HTTP auth mode instead. Set
  text

  Copy

  gateway.auth.allowTailscale: false
  to require explicit credentials. See Tailscale and Security. This tokenless flow assumes the gateway host is trusted.
• text

  Copy

  gateway.tailscale.mode: "funnel"
  requires
  text

  Copy

  gateway.auth.mode: "password"
  (shared password).

Building the UI

The Gateway serves static files from

. Build them with:

bash
Copy
pnpm ui:build