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 is self-hosted software. The minimum setup is one machine that can run Docker and one Supabase project.
For a first install, use a laptop or small VPS. You can add more gateways later after the workspace is working.

Required pieces

Docker host

A laptop, Mac mini, Raspberry Pi, VPS, home server, or cloud VM that can run Docker Compose.

Supabase project

Stores your workspace data, auth users, realtime events, command queues, and agent state metadata.

Model provider

Any provider — OpenAI, Anthropic, Gemini, Ollama, or 25+ others. HQ is model-agnostic.

Gateway token

A GATEWAY_AUTH_TOKEN shared by the UI and gateway files API. The installer can generate this for you.

Tailscale

The easiest safe way to reach Your HQ from another device without opening public ports.

Dedicated Supabase project

Keeps HQ data and permissions separate from other apps.

Backups

Back up Supabase, .env, and the gateway-state Docker volume before running real workflows.

Pinned images

Pin image versions once you depend on HQ for daily work.

Host sizing

Active browser agents use memory and CPU, so plan capacity around active agents, not just total agents.
HostRAMComfortable for
Raspberry Pi 58 GB1–2 agents
t3.small / Hetzner CX222 GB1 idle agent
t3.medium / Mac mini4 GB2–3 active agents
t3.large or larger8+ GB5+ active agents

Security assumptions

HQ is single-operator admin software. Anyone with access to your Supabase auth user, service role key, gateway state volume, or Docker host should be treated as trusted. Read Security policy before exposing HQ beyond localhost.