Onboard Wizard
The onboard wizard is a web-based setup UI that runs on first launch. It guides you through initializing the project.
Steps
- Project Info — Set your project name and optionally a custom JWT secret
- Admin Account — Create the first admin user (username, email, password)
- Database — Choose SQLite / MySQL / PostgreSQL and configure connection
- Redis — Optionally enable Redis and configure address
- Confirm — Review settings and initialize
How It Works
- On first launch, no
.installedlock file exists - The frontend router redirects all routes to
/onboard - After successful setup, the backend creates
.installedand writesconfig.yaml - Subsequent visits skip the wizard entirely
API Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/onboard/status | Check if system is initialized |
| POST | /api/onboard/setup | Submit setup configuration |
The setup endpoint is blocked once .installed exists (HTTP 403).