Getting Started

Copy Markdown

Lockspire lets partner apps request access to a Phoenix app with OAuth 2.0 and sign users in with OpenID Connect (OIDC). The host app keeps its accounts, sign-in, branding, and product rules.

First, check the supported capabilities and limits. If you want a plain-language introduction to OAuth/OIDC roles, tokens, and consent, read OAuth/OIDC for Phoenix adopters.

When you're ready to install, follow the canonical install and onboarding guide. It is the single source for setup commands, generated host files, migrations, mix lockspire.verify, and the host checks that verifier cannot replace.

For a practical first-client example after installation, see the SaaS adoption recipe. The adoption demo is a local example that uses synthetic Billingo data.