Start here · Infra and platform teams

For infra and platform teams

A self-hosted JoobQUI is one binary (joobqui-selfhosted) with PostgreSQL and Redis beside it. Its state lives in those two stores, so you scale it by running more instances behind a load balancer, with no sticky sessions. Workers in any language reach it over HTTPS with one SDK token and never hold the Redis credentials.

Stand it up

QuickstartThe Compose file: secrets, migrate, start, the first admin.Self-hosted serverWhat it needs, how to start, check and stop it, health checks.ConfigurationEvery environment variable, from the example env file.Licence and Pro keyInstall and renew the deployment licence and the Pro key.

Run it

Workers and instancesSDK and Crystal workers, several server instances, leader leases.MonitoringPrometheus metrics at /metrics and what to watch.Backups and retentionWhat to back up, retention, the workflow archive, erasure.UpgradingVersions that must match and the order to upgrade in.Accounts, SSO, 2FA, rolesSign-up policy, API tokens, two-factor, OpenID Connect.AuditingWhat is recorded, and how to export it.

What runs where

The processes, what lives in Redis and in PostgreSQL, and how instances share work are in Architecture and deployment. The Command line lists the tasks (migrate, doctor, accounts:create, license:status, ...), and Troubleshooting the answers you are most likely to meet (402, 503 sdk_token_not_configured, LeaseExpired, jobs that are not picked up).