Quick start

THIS PAGE IS THE ACTUAL FILE THAT SHIPS IN THE REPOSITORY. PUBLISHED SO YOU CAN JUDGE THE OPERATIONAL COST BEFORE YOU PAY.

Goal: a fully working Vigil (app, worker, database, demo data) in under 10 minutes.

Option A. Docker (recommended, ~5 minutes)

Requirements: Docker with Compose.

# 1. Configure the one required secret
echo "BETTER_AUTH_SECRET=$(openssl rand -base64 32)" > .env

# 2. Boot everything: Postgres 18 → migrations → app → worker
docker compose up --build -d

# 3. (Optional) seed the demo organization with 90 days of history
docker compose run --rm worker npx tsx scripts/seed-demo.ts

Open http://localhost:3000.

  • Seeded? Sign in as amelia@altitude.demo / vigil-demo-2026 (owner, see the seed output for admin/responder/viewer accounts), and visit the public page at /status/altitude.
  • Not seeded? Click Get started, create your account and organization, add a monitor. The worker runs its first check within a minute.

Option B. Local development (~10 minutes)

Requirements: Node.js ≥ 20.9, PostgreSQL ≥ 18 (native uuidv7() is used).

npm install
cp .env.example .env        # set DATABASE_URL + BETTER_AUTH_SECRET
npm run db:migrate
npm run db:seed             # optional demo data
npm run dev                 # terminal 1, app on :3000
npm run worker:dev          # terminal 2, background checks

Verify the install

npm run typecheck && npm run lint && npm test   # 4706 tests, ~5s

Turn on automatic recovery (optional, ~5 minutes)

Open any monitor → Automatic recovery: point it at an endpoint in your infrastructure that fixes the failure (a restart hook, a runbook trigger) and enable it. examples/recovery-receiver.mjs is a dependency-free receiver to start from, verify the signature, run one command. Use Send test trigger to prove the wiring before the first real incident.

Where to go next

You want to… Read
Deploy to production docs/DEPLOYMENT.md
Rebrand / extend it docs/CUSTOMIZATION.md
Run a public read-only demo docs/DEMO.md
Understand the design ARCHITECTURE.md
Day-to-day development docs/HANDBOOK.md
Take updates later docs/UPGRADE.md