Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yourhq.ai/llms.txt

Use this file to discover all available pages before exploring further.

HQ’s default Compose stack has four services that work together.

ui

Next.js dashboard. Renders the workspace — agents, CRM, tasks, documents, settings — and writes to Supabase through server actions. Port 3000.

gateway

Agent runtime host. Runs OpenClaw, Chrome/Chromium, XFCE desktop, noVNC, and the files API. This is where agents live. Ports 6901 (noVNC), 18790 (files API).

dispatcher

Inbox daemon. Watches agent_inbox_items for new work, filters to agents on the local gateway, checks budget status, and wakes agents through OpenClaw.

runner

Command daemon. Watches agent_commands, leases commands for the local gateway, executes lifecycle and auth operations, and reports results back to Supabase.

​
Shared state

The gateway, dispatcher, and runner containers share the gateway-state Docker volume (mounted at /home/openclaw/.openclaw). This volume holds OpenClaw config, the bare git repo, agent worktrees, browser profiles, and auth state. The runner additionally mounts /var/run/docker.sock so it can restart sibling containers when needed.
For single-host installs, all four services run together via docker compose up -d. For multi-host setups, run ui separately from the gateway services. See Add a gateway.