Skip to main content

Getting started

Run it​

cd frontend && pnpm install && pnpm build
cd ../backend && cp .env.example .env && go run .

The backend serves the API, the built UI (STATIC_DIR) and the Swagger UI at /swagger/index.html.

Database​

Set DB_DRIVER to postgres (default), mariadb or sqlite, and the single entries DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_NAME (and DB_SSLMODE for postgres). For sqlite, DB_NAME is the file path. Migrations run on start.

Other settings​

VariableMeaning
PORTListen port, default 8080
LOG_LEVELERROR, WARN, INFO, DEBUG
JWT_SECRETSigns session cookies. If unset, a random one is used and sessions end on restart
COOKIE_SECUREtrue to send the session cookie over HTTPS only
VAPID_PUBLIC_KEY, VAPID_PRIVATE_KEYWeb Push keys. If unset they are generated once and stored in the database
WEBAUTHN_RP_ID, WEBAUTHN_ORIGINSPasskey relying party, e.g. pager.example.com and https://pager.example.com. Optional: by default taken from the browser's Origin header. The Helm chart sets them from ingress.hosts
PUBLIC_URLExternal address, used for the SSO redirect URI. Optional: by default taken from the request (X-Forwarded-Proto and Host). The Helm chart sets it from ingress.hosts
VAPID_SUBJECTContact for push services, e.g. mailto:ops@example.com

Register​

Open the app and choose Register. This creates your organisation (tenant) and makes you its owner.

Registration form