Packages

lockspire

1.6.1
1.6.1 1.6.0 1.5.1 1.5.0 1.4.0 1.3.0 1.2.0 1.1.2 1.1.1 1.1.0 1.0.0 0.2.0 0.1.2

Embedded OAuth/OIDC authorization server library for Phoenix applications

HexDocs Report package

Current section

Files

Jump to
Documentation
Changelog
License
Security
13 Versions
14 Dependencies
Dependants
Files
Activity
lockspire docs getting-started.md
Raw

docs/getting-started.md 

# Getting Started

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](supported-surface.md). If you want a plain-language introduction to OAuth/OIDC roles, tokens, and consent, read [OAuth/OIDC for Phoenix adopters](oauth-oidc-for-phoenix-adopters.md).

When you're ready to install, follow the [canonical install and onboarding guide](install-and-onboard.md). 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](saas-adoption-recipe.md). The [adoption demo](adoption-demo.md) is a local example that uses synthetic Billingo data.