Skip to main content

​
Web (Gateway)

The Gateway serves a small browser Control UI (Vite + Lit) from the same port as the Gateway WebSocket:
  • default: http://<host>:18789/
  • optional prefix: set gateway.controlUi.basePath (e.g. /clawdbot)
Capabilities live in Control UI. This page focuses on bind modes, security, and web-facing surfaces.

​
Webhooks

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

​
Config (default-on)

The Control UI is enabled by default when assets are present (dist/control-ui). You can control it via config: 
{
  gateway: {
    controlUi: { enabled: true, basePath: "/clawdbot" } // basePath optional
  }
}

​
Tailscale access

Keep the Gateway on loopback and let Tailscale Serve proxy it: 
{
  gateway: {
    bind: "loopback",
    tailscale: { mode: "serve" }
  }
}
Then start the gateway: 
clawdbot gateway
Open:
  • https://<magicdns>/ (or your configured gateway.controlUi.basePath)

​
Tailnet bind + token

{
  gateway: {
    bind: "tailnet",
    controlUi: { enabled: true },
    auth: { mode: "token", token: "your-token" }
  }
}
Then start the gateway (token required for non-loopback binds): 
clawdbot gateway
Open:
  • http://<tailscale-ip>:18789/ (or your configured gateway.controlUi.basePath)

​
Public internet (Funnel)

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

​
Security notes

  • Binding the Gateway to a non-loopback address requires auth (gateway.auth or CLAWDBOT_GATEWAY_TOKEN).
  • The wizard generates a gateway token by default (even on loopback).
  • The UI sends connect.params.auth.token or connect.params.auth.password.
  • With Serve, Tailscale identity headers can satisfy auth when gateway.auth.allowTailscale is true (no token/password required). Set gateway.auth.allowTailscale: false to require explicit credentials. See Tailscale and Security.
  • gateway.tailscale.mode: "funnel" requires gateway.auth.mode: "password" (shared password).

​
Building the UI

The Gateway serves static files from dist/control-ui. Build them with: 
pnpm ui:build # auto-installs UI deps on first run