Deployment Guide

This guide covers runtime expectations for AuthOS deployments. Maintainer release and package publishing steps are documented in the repo-level OPERATIONS.md, not here.

Backend variants

AuthOS is compiled into one of three binaries:

Backend	Binary	Feature
SQLite	`sso_sqlite`	`db_sqlite`
PostgreSQL	`sso_psql`	`db_psql`
MySQL	`sso_mysql`	`db_mysql`

Your DATABASE_URL must match the binary you deploy.

Build examples

cargo build --release --no-default-features --features db_sqlite
cargo build --release --no-default-features --features db_psql
cargo build --release --no-default-features --features db_mysql

Required runtime configuration

At minimum, configure:

DATABASE_URL
BASE_URL
PLATFORM_DASHBOARD_BASE_URL
JWT signing keys
ENCRYPTION_KEY

Local-style example

SERVER_HOST=0.0.0.0
SERVER_PORT=3001
BASE_URL=http://localhost:3001
PLATFORM_DASHBOARD_BASE_URL=http://localhost:4000

Health checks

Use both health endpoints in your deployment checks:

curl http://localhost:3001/health
curl http://localhost:3001/health/ready

/health verifies the process is serving requests
/health/ready verifies the process is ready and the database connection is healthy

Docker notes

This repo uses Docker both for local support services and for final backend packaging. Current maintainer packaging is driven by prebuilt binaries and backend-specific image assembly.

If you are operating the repo itself, prefer the maintainer runbook in OPERATIONS.md.

Deployment checklist

Build the correct backend binary.
Set a matching DATABASE_URL.
Provide JWT keys and ENCRYPTION_KEY.
Configure your reverse proxy and public origins.
Verify both /health and /health/ready.