Deployment Guide

Backend deployment notes for AuthOS.

AuthOS release 0.8.2 API v1 Latest-only documentation
Updated Jul 15, 2026
On this page

This guide covers runtime expectations for AuthOS deployments.

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

Use the image variant that matches your database backend:

  • SQLite: editoredit/sso:latest or editoredit/sso:sqlite-latest
  • PostgreSQL: editoredit/sso:psql-latest
  • MySQL: editoredit/sso:mysql-latest

For pinned deployments, use the corresponding release tag instead of latest.

Deployment checklist

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