Official documentation site for AuthEngine, built with MkDocs Material and published at docs.authengine.org.
Covers local development, production deployment (K3s + Rancher + Helm), API reference, OAuth/OIDC integration, architecture, and security.
| Section | Pages |
|---|---|
| Getting started | Quick Start · Deployment |
| Platform | Architecture · Security |
| Integration | API Reference · OAuth2 / OIDC |
| Community | Contributing · Security Policy |
Edit and preview locally:
cd auth-engine-docs
python -m venv .venv-docs && source .venv-docs/bin/activate
pip install -r requirements-docs.txt
mkdocs serve # http://127.0.0.1:8000Deploy to GitHub Pages: run workflow docs-deploy (workflow_dispatch).
Platform deployment (not the docs site itself):
| Path | Guide |
|---|---|
| Local VM + Cloudflare Tunnel | Deployment — local VM |
| AWS EC2 or any cloud VM | Deployment — cloud VM |
Docs site hosting: GitHub Pages → docs.authengine.org (deploy via the docs-deploy workflow in this repo).
auth-engine · auth-engine-dashboard · auth-engine-data · auth-engine-infra