Authora documentation
The documentation follows the Diátaxis framework and has four parts. Each part answers a different kind of question, so pick the one that fits what you need right now.
| Part | Read it when you want to… | |
|---|---|---|
| 🎓 | Tutorials | learn Authora by doing, step by step, from nothing to a working result |
| 🛠️ | How-to guides | get a specific job done, e.g. deploy Authora or rotate a key |
| 📖 | Reference | look up exact facts: settings, endpoints, claims, events |
| 💡 | Explanation | understand how Authora works and why it is designed that way |
Tutorials
Start here if you are new to Authora.
- Getting started: run Authora with Docker Compose and sign in to the admin interface.
- Your first application: register an application, sign a user in with the Authorization Code flow and PKCE, and read the ID Token and UserInfo.
How-to guides
Running Authora:
- Deploy to production
- Configure a reverse proxy
- Apply database migrations and upgrade
- Persist Data Protection keys
- Rotate signing keys
- Back up and restore
- Run Authora from source
Using Authora:
- Connect an application
- Protect an API with introspection
- Manage users and access
- Call the admin API
- Check the integrity of the audit log
Reference
- Configuration: every setting, its default and its limits
- OAuth endpoints: authorize, token, revoke, introspect
- OpenID Connect: discovery, Scopes and claims, ID Tokens, UserInfo, JWKS
- Admin API: endpoints and the Permission each one needs
- Audit events: event types, fields, search and verification
- HTTP security headers and cookies
- Health checks
- Log events
- Standards and limitations
Explanation
- Architecture
- The access model: Users, Groups, Roles, Permissions, Scopes and Clients
- Tokens, Grants and Sessions
- Security model
- The admin interface
- Audit log integrity
Terms
Authora capitalizes the names of its own objects (User, Group, Role, Permission, Scope, Client, Grant, Session) to tell them apart from the everyday words. A Client is an application registered at Authora; a User is a person who signs in to Authora.