Files
bot/docs/web/dashboard.md
zooqueen 071e3f1082 rebrand: openclaw -> hanzo bot across entire codebase
Automated rebrand of all openclaw references to hanzo bot:
- Package: openclaw -> @hanzo/bot
- Binary: openclaw -> hanzo-bot
- Config: ~/.openclaw -> ~/.hanzo/bot
- Docker: ghcr.io/hanzoai/bot
- Env vars: OPENCLAW_* -> BOT_*
- Bundle IDs: ai.hanzo.bot.*
- Product name: Hanzo Bot
2026-03-19 13:52:32 -07:00

3.4 KiB

summary, read_when, title
summary read_when title
Gateway dashboard (Control UI) access and auth
Changing dashboard authentication or exposure modes
Dashboard

Dashboard (Control UI)

The Gateway dashboard is the browser Control UI served at / by default (override with gateway.controlUi.basePath).

Quick open (local Gateway):

Key references:

Authentication is enforced at the WebSocket handshake via connect.params.auth (token or password). See gateway.auth in Gateway configuration.

Security note: the Control UI is an admin surface (chat, config, exec approvals). Do not expose it publicly. The UI keeps dashboard URL tokens in sessionStorage for the current browser tab session and selected gateway URL, and strips them from the URL after load. Prefer localhost, Tailscale Serve, or an SSH tunnel.

  • After onboarding, the CLI auto-opens the dashboard and prints a clean (non-tokenized) link.
  • Re-open anytime: hanzo-bot dashboard (copies link, opens browser if possible, shows SSH hint if headless).
  • If the UI prompts for auth, paste the token from gateway.auth.token (or BOT_GATEWAY_TOKEN) into Control UI settings.

Token basics (local vs remote)

  • Localhost: open http://127.0.0.1:18789/.
  • Token source: gateway.auth.token (or BOT_GATEWAY_TOKEN); hanzo-bot dashboard can pass it via URL fragment for one-time bootstrap, and the Control UI keeps it in sessionStorage for the current browser tab session and selected gateway URL instead of localStorage.
  • If gateway.auth.token is SecretRef-managed, hanzo-bot dashboard prints/copies/opens a non-tokenized URL by design. This avoids exposing externally managed tokens in shell logs, clipboard history, or browser-launch arguments.
  • If gateway.auth.token is configured as a SecretRef and is unresolved in your current shell, hanzo-bot dashboard still prints a non-tokenized URL plus actionable auth setup guidance.
  • Not localhost: use Tailscale Serve (tokenless for Control UI/WebSocket if gateway.auth.allowTailscale: true, assumes trusted gateway host; HTTP APIs still need token/password), tailnet bind with a token, or an SSH tunnel. See Web surfaces.

If you see "unauthorized" / 1008

  • Ensure the gateway is reachable (local: hanzo-bot status; remote: SSH tunnel ssh -N -L 18789:127.0.0.1:18789 user@host then open http://127.0.0.1:18789/).
  • For AUTH_TOKEN_MISMATCH, clients may do one trusted retry with a cached device token when the gateway returns retry hints. If auth still fails after that retry, resolve token drift manually.
  • For token drift repair steps, follow Token drift recovery checklist.
  • Retrieve or supply the token from the gateway host:
    • Plaintext config: hanzo-bot config get gateway.auth.token
    • SecretRef-managed config: resolve the external secret provider or export BOT_GATEWAY_TOKEN in this shell, then rerun hanzo-bot dashboard
    • No token configured: hanzo-bot doctor --generate-gateway-token
  • In the dashboard settings, paste the token into the auth field, then connect.