docs: add OAuth2 upstream auth page - #3042
Open
LeonSGP43 wants to merge 1 commit into
Open
Conversation
Add docs/content/docs/oauth2-upstream.mdx covering the plugins/headroom-oauth2 proxy extension: install/enable commands, the HEADROOM_OAUTH2_* env matrix, effective-backend caveats, and TLS/transport notes — sourced from plugins/headroom-oauth2/README.md and SPEC.md. Register the page in the Integrations nav. Signed-off-by: LeonSGP43 <LeonSGP43@users.noreply.github.com>
LeonSGP43
requested review from
DevanshiVyas,
JerrettDavis and
chopratejas
as code owners
August 15, 2026 04:30
Contributor
PR governanceThis PR follows the template and is marked ready for human review. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
docs/content/docs/oauth2-upstream.mdxand registers it in the Integrations nav.plugins/headroom-oauth2ships with a README + SPEC, but the docs site has no page covering enterprise OAuth2 client-credentials upstream auth — enterprise-gateway users have no discoverable documentation for this path. Content is faithful toplugins/headroom-oauth2/README.md.Type of Change
Changes Made
docs/content/docs/oauth2-upstream.mdx: install, enable, client-credentials config, upstream auth flow, and troubleshooting.docs/content/docs/meta.jsonIntegrations nav.Testing
pytest)ruff check .)mypy headroom)Test Output
Real Behavior Proof
main+ branchdocs/content/docs/meta.jsonafter edit (valid JSON, nav ordering correct); diffed the new page's frontmatter against sibling integration pagesfumadocssite build (requires Node install); content is plain MDX consistent with existing pagesRuntime Rollout Safety
Review Readiness
Checklist
CHANGELOG.md— it is generated by release-please from my Conventional Commit PR titleAdditional Notes
Docs-only PR: pytest/ruff/mypy items intentionally unchecked (no Python code changed).