Create and deploy docs for forward auth #34

New issue

Open

opened 2026-07-24 10:28:23 +00:00 by frank · 0 comments

frank commented

2026-07-24 10:28:23 +00:00

Owner

Goal

Create and deploy the documentation for the forward-auth milestone release.

Requirements

Decide whether repository Markdown files or a static documentation generator are more appropriate.
Document installation and configuration.
Document the forward-auth request flow and trust boundary.
Document supported headers and group checks.
Provide a working Caddy and Authelia example.
Document development, testing and package usage.
Deploy the generated documentation when a static documentation site is used.
Link the README, documentation pages and relevant issues to each other.

Acceptance criteria

The documentation approach is selected and justified.
A new user can install and configure NiceOAuthForwardAuth.
Usage and technical behavior are documented.
Security assumptions and limitations are clearly stated.
The Caddy and Authelia example is complete and reproducible.
Documentation links back to relevant specifications, Ghost documentation and project issues.
Documentation is published or directly accessible from the repository.
The documented setup is verified against the milestone release.

## Goal Create and deploy the documentation for the forward-auth milestone release. ## Requirements * Decide whether repository Markdown files or a static documentation generator are more appropriate. * Document installation and configuration. * Document the forward-auth request flow and trust boundary. * Document supported headers and group checks. * Provide a working Caddy and Authelia example. * Document development, testing and package usage. * Deploy the generated documentation when a static documentation site is used. * Link the README, documentation pages and relevant issues to each other. ## Acceptance criteria * [ ] The documentation approach is selected and justified. * [ ] A new user can install and configure `NiceOAuthForwardAuth`. * [ ] Usage and technical behavior are documented. * [ ] Security assumptions and limitations are clearly stated. * [ ] The Caddy and Authelia example is complete and reproducible. * [ ] Documentation links back to relevant specifications, Ghost documentation and project issues. * [ ] Documentation is published or directly accessible from the repository. * [ ] The documented setup is verified against the milestone release.

frank added this to the Forward Auth mode milestone

2026-07-24 10:28:23 +00:00

frank added the

type/docs

area/release

labels

2026-07-24 11:21:59 +00:00