Add Forward Authentication documentation - #415
Open
GKestenberg wants to merge 4 commits into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
GKestenberg
force-pushed
the
gk/forward-auth
branch
from
August 27, 2026 16:11
e18a148 to
775b409
Compare
georgez98
reviewed
Aug 27, 2026
Contributor
There was a problem hiding this comment.
nit: forward-authentication.mdx instead of abbreviating
georgez98
reviewed
Aug 27, 2026
| unauthenticated users are redirected to log in first. | ||
|
|
||
| This is handled by an [oauth2-proxy](https://oauth2-proxy.github.io/oauth2-proxy/) that runs in your | ||
| cluster. You configure it in `Infrastructure -> Cluster -> Config` with with your provider credentials. Once configured, you can enable it for individual services. |
georgez98
reviewed
Aug 27, 2026
| This is handled by an [oauth2-proxy](https://oauth2-proxy.github.io/oauth2-proxy/) that runs in your | ||
| cluster. You configure it in `Infrastructure -> Cluster -> Config` with with your provider credentials. Once configured, you can enable it for individual services. | ||
|
|
||
| We recommend Forward Auth for **internal apps** and **vibe-coded apps** where you want a simple, robust login gate without building and maintaining authentication into the application itself. |
Contributor
There was a problem hiding this comment.
I'm genuinely not sure, but do we want to use the 'vibe-coded' terminology here?
georgez98
reviewed
Aug 27, 2026
| - Generic OIDC (for any provider that speaks OpenID Connect) | ||
|
|
||
| <Tip> | ||
| Forward Auth is most useful when you point it at your own **identity provider** (for example your company's Google Workspace, Okta, or Entra ID tenant) rather than a generic public auth provider. Backing it with your IdP means only members of your organization can reach that app. |
Contributor
There was a problem hiding this comment.
Backing it with your IdP --> Backing it with your own provider
Let's avoid acronyms if possible
georgez98
reviewed
Aug 27, 2026
|
|
||
| # Enabling Forward Auth on a cluster | ||
|
|
||
| Once the feature has been enabled for your project by support, go to **Infrastructure → Config**. There |
Contributor
There was a problem hiding this comment.
Remove "by support" here
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
2 participants
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.
Adds a new Forward Auth documentation page covering the beta feature that puts an OAuth sign-on in front of applications. The page explains how it works via an in-cluster oauth2-proxy, lists all supported identity providers, and walks through enabling it at both the cluster and service levels — including declarative configuration via porter.yaml. It also documents the X-Auth-Request-User and X-Auth-Request-Email headers forwarded to applications, with a short Express code example. The page is registered in mint.json under the security and compliance section.