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 uses your Supabase project as the database, auth system, realtime event stream, and storage backbone.
You own this Supabase project. HQ does not use a hosted YourHQ backend for your workspace data.

​
Setup steps

1

Create the project

Sign in to supabase.com, create a new project, and wait for provisioning to finish.
2

Run the migrations

Open SQL Editor and run every file in db/migrations/ in filename order.The migration files are split by domain. Do not only run the first file.
3

Create an auth user

Open Authentication → Users → Add user. For a personal install, auto-confirm the user so you can sign in immediately.
4

Copy API values

Open Project Settings → API and copy:
  • Project URL
  • Anon key
  • Service role key
5

Disable public signup

HQ grants broad access to authenticated users. Disable public email signup unless you intentionally want every signed-up user to have admin-level HQ access.

​
What HQ stores in Supabase

Workspace data

Contacts, organizations, tasks, documents, assets, automations, activity, and notifications.

Agent coordination

Agent commands, inbox items, gateway heartbeats, usage records, budgets, and status.
Continue with Installation.