Quick Start (local)

This guide starts Clavis locally for development and testing.

Prerequisites

• Docker 24+ and Docker Compose v2 installed
• Git installed

Step 1: Clone the repository

git clone https://github.com/Clavis-Rallye/App.git
cd App

Step 2: Configure environment variables

cp deployment/.env.example .env

Open .env and set at minimum:

• JWT_SECRET_KEY — random string (≥32 characters)
• HMAC_AUDIT_KEY — random string (≥32 characters)
• POSTGRES_PASSWORD — database password

All other variables have sensible defaults for local development.

Step 3: Start services

docker compose up --build

On the first start, all images are built and the database is initialized. This takes a few minutes.

Step 4: Access

Service	URL
Frontend	http://localhost:8000
API documentation	http://localhost:8000/api/docs
ReDoc	http://localhost:8000/api/redoc
MinIO console	http://localhost:9001

Stop

docker compose down

Database data is preserved in the Docker volume.