Quickstart

Prerequisites

• Docker ≥ 24
• Docker Compose v2

1. Clone the repository

git clone https://github.com/Vaultaris/vaultaris.git
cd vaultaris

2. Start services

docker compose up -d

This starts:

• PostgreSQL 16 on port 5432
• Redis 7 on port 6379
• Vaultaris on port 8080

Vaultaris runs database migrations automatically on first boot. Check the logs:

docker compose logs -f vaultaris

You should see:

INFO  vaultaris::main — Vaultaris server listening addr=0.0.0.0:8080

3. Explore the API

Open the interactive API documentation in your browser:

http://localhost:8080/api/v1/docs

This is the Scalar UI generated from the OpenAPI spec. Every endpoint is documented with request/response schemas.

4. Health check

curl http://localhost:8080/health

{
  "status": "healthy",
  "version": "0.8.0",
  "uptime_seconds": 12
}

5. Create your first tenant

curl -X POST http://localhost:8080/api/v1/tenants \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Corp", "slug": "acme"}'

The response includes a tenant_id UUID. Save it — you'll need it for all subsequent calls.

6. Register a user

curl -X POST http://localhost:8080/api/v1/tenants/{tenant_id}/users \
  -H "Content-Type: application/json" \
  -d '{
    "email": "admin@acme.example",
    "password": "correct-horse-battery-staple",
    "first_name": "Alice",
    "last_name": "Admin"
  }'

7. Request a password reset token (or verify email)

By default email sending is disabled (EMAIL_ENABLED=false). Token values are logged to stdout. In production, configure SMTP — see Configuration.

Next steps