For: Builders, Operators. Time: ~5 min per recipe. Prereqs: Quickstart. For concept-level background, see Concepts.
Each subdirectory groups recipes by audience and goal:
| Section | For | Contents |
|---|---|---|
| integrate/ | Builders | Wire Authplane into an existing MCP server or agent in your language. |
| federation/ | Builders + Operators | Connect Authplane to upstream IdPs (Okta, Entra ID, Google Workspace) and XAA flows. |
| upstream-providers/ | Builders | Store and vend third-party OAuth tokens (GitHub, Google, Slack, ...). |
| deploy/ | Operators | Get Authplane running in your environment (Docker, Helm, systemd, Vault Transit, Postgres-HA, observability). |
| operate/ | Operators | Day-2 ops: admin CLI / UI, key rotation, audit & forensics, incident response. |
- Every command-line example cites
docs/reference/cli.md. - Every curl example cites
docs/reference/http-api.md. - Every env-var reference cites
docs/reference/env-vars.md. - Every YAML key reference cites
docs/reference/configuration.md. - Runnable proofs live under
examples/.
- Concepts — what Authplane is and why each piece exists.
- Reference — generated specifications (HTTP API, CLI, env vars, config schema).
- Topologies — named deployment shapes (single MCP, gateway, fan-out, etc.) with end-to-end wiring.
- Grant-type guides — client credentials, JWT bearer (XAA), token exchange.