Skip to content

Onboard Wizard

The onboard wizard is a web-based setup UI that runs on first launch. It guides you through initializing the project.

Steps

  1. Project Info — Set your project name and optionally a custom JWT secret
  2. Admin Account — Create the first admin user (username, email, password)
  3. Database — Choose SQLite / MySQL / PostgreSQL and configure connection
  4. Redis — Optionally enable Redis and configure address
  5. Confirm — Review settings and initialize

How It Works

  • On first launch, no .installed lock file exists
  • The frontend router redirects all routes to /onboard
  • After successful setup, the backend creates .installed and writes config.yaml
  • Subsequent visits skip the wizard entirely

API Endpoints

MethodPathDescription
GET/api/onboard/statusCheck if system is initialized
POST/api/onboard/setupSubmit setup configuration

The setup endpoint is blocked once .installed exists (HTTP 403).