Documentation Overview

Use this page to navigate Relyra docs by job instead of chasing footers.

Day-1 — Install and prove

• Getting Started — canonical install, scaffold, and first-login path
• Batteries Included proof map — drift-checked claim-to-proof artifact

Proof journey (in order):

1. Run mix relyra.install --module MyApp --repo MyApp.Repo and confirm scaffold files land in the host app.
2. Prove local sign-in with the Relyra.TestSupport macro (setup_saml_connection/2, post_saml_response/2) and stub ACS router — see Getting Started §3.
3. Pick exactly one first-class provider runbook and finish it end-to-end:
   • Okta
   • Microsoft Entra ID
   • Google Workspace
   • ADFS
   • Generic SAML — Ping, OneLogin, Shibboleth, Keycloak, and more

Receipt: host-side test passes with assert_saml_login/2, then one hosted IdP login works with a concrete operator receipt.

Day-2 — Operate in production

• Production Ecto path — migrations, Ecto adapters, and replay-store production wiring
• Incident playbook — login trace & evidence surfaces — per-login step timeline (mix relyra.trace / LiveView) for Diagnose steps in SAML incidents
• Identity mapping and provisioning
• Troubleshooting
• Logout recipe
• Operator-managed rollout
• Phoenix SaaS tenant onboarding

Reference

• BATTERIES_INCLUDED.md — drift-checked claim-to-proof map
• SECURITY.md
• Security review packet
• Security boundary
• CONFORMANCE.md
• Jobs To Be Done And User Flows