.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/vscode/devcontainers/go:1-1.23
+FROM mcr.microsoft.com/vscode/devcontainers/go:1-1.21
 
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 

.github/FUNDING.yml

@@ -1,15 +0,0 @@
-# These are supported funding model platforms
-
-github: tuunit # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: oauth2-proxy # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-polar: # Replace with a single Polar username
-buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
-thanks_dev: # Replace with a single thanks.dev username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -18,7 +18,6 @@ body:
         - azure
         - bitbucket
         - digitalocean
-        - entra-id
         - facebook
         - gitea
         - github

.github/ISSUE_TEMPLATE/configuration-support.yml

@@ -18,7 +18,6 @@ body:
         - azure
         - bitbucket
         - digitalocean
-        - entra-id
         - facebook
         - gitea
         - github

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -34,7 +34,6 @@ body:
         - azure
         - bitbucket
         - digitalocean
-        - entra-id
         - facebook
         - gitea
         - github

.github/labeler.yml

@@ -9,7 +9,7 @@ docs:
       - '**/*.md'
 
 changelog:
-  - changed-files:
+  - cNhanged-files:
     - any-glob-to-any-file:
       - 'CHAGELOG.md'
 

.github/renovate.json5

@@ -1,44 +1,18 @@
 {
   $schema: "https://docs.renovatebot.com/renovate-schema.json",
-  semanticCommits: "enabled",
-  schedule: [
-    "after 8am on sunday"
-  ],
-  prConcurrentLimit: 0,
-  prHourlyLimit: 0,
+  semanticCommits: "auto",
   enabledManagers: [
     "dockerfile",
-    "docker-compose",
     "gomod",
     "github-actions",
-    "helmv3",
     "npm",
     "regex",
   ],
-  packageRules: [
-    {
-      matchManagers: [
-        "dockerfile",
-        "docker-compose",
-        "gomod",
-        "helmv3",
-        "npm",
-      ],
-      groupName: "{{{manager}}}",
-    },
-    {
-      matchDepNames: [
-        "docker.io/library/golang",
-        "mcr.microsoft.com/vscode/devcontainers/go",
-      ],
-      groupName: "golang",
-    },
-  ],
   customManagers: [
     {
       customType: "regex",
       fileMatch: [
-        "^Makefile",
+        "^Makefile"
       ],
       matchStrings: [
         "DOCKER_BUILD_RUNTIME_IMAGE_ALPINE\\s+?\\?= alpine:(?<currentValue>.*)\\s"
@@ -46,13 +20,5 @@
       depNameTemplate: "alpine",
       datasourceTemplate: "docker",
     },
-    {
-      customType: "regex",
-      fileMatch: ["(^|/)\\.github/workflows/[^/]+\\.ya?ml$"],
-      matchStrings: [
-        "# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s+?[\\w\\s-]*?version: (?<currentValue>.*)\\s",
-        "# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s+?[\\w\\s]*?_VERSION: (?<currentValue>.*)\\s",
-      ],
-    },
   ],
 }

.github/workflows/ci.yaml

@@ -4,30 +4,31 @@ on:
   push:
     branches:
       - '**'
+      # - $default-branch
   pull_request:
     branches:
       - '**'
+      # - $default-branch
+
 jobs:
   build:
-    runs-on: ubuntu-latest
     env:
       COVER: true
+    runs-on: ubuntu-22.04
     steps:
-    - name: Check out code
-      uses: actions/checkout@v5
 
-    - name: Set up Go
-      uses: actions/setup-go@v6
+    - name: Check out code
+      uses: actions/checkout@v4
+
+    - name: Set up Go 1.21
+      uses: actions/setup-go@v5
       with:
-        go-version-file: go.mod
+        go-version: 1.21
       id: go
 
     - name: Get dependencies
-      env:
-        # renovate: datasource=github-tags depName=golangci/golangci-lint
-        GOLANGCI_LINT_VERSION: v2.5.0
       run: |
-        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
+        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.55.2
         curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
         chmod +x ./cc-test-reporter
 
@@ -40,16 +41,9 @@ jobs:
         make lint
 
     - name: Build
-      if: (!startsWith(github.head_ref, 'release'))
       run: |
         make build
 
-    # For release testing
-    - name: Build All
-      if: github.base_ref == 'master' && startsWith(github.head_ref, 'release')
-      run: |
-        make release
-
     - name: Test
       env:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
@@ -57,10 +51,11 @@ jobs:
         ./.github/workflows/test.sh
 
   docker:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
+
     - name: Check out code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v4
 
     - name: Set up QEMU
       uses: docker/setup-qemu-action@v3
@@ -70,12 +65,5 @@ jobs:
       uses: docker/setup-buildx-action@v3
 
     - name: Docker Build
-      if: (!startsWith(github.head_ref, 'release'))
       run: |
-        make build-docker
-
-    # For release testing
-    - name: Docker Build All
-      if: github.base_ref == 'master' && startsWith(github.head_ref, 'release')
-      run: |
-        make build-docker-all
+        make docker

.github/workflows/codeql.yml

@@ -2,22 +2,10 @@ name: "Code scanning - action"
 
 on:
   push:
-    branches:
-      - master
-    paths-ignore:
-      - '.devcontainer/**'
-      - '.vscode/**'
-      - 'contrib/**'
-      - 'docs/**'
+    branches: [master, ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches:
-      - master
-    paths-ignore:
-      - '.devcontainer/**'
-      - '.vscode/**'
-      - 'contrib/**'
-      - 'docs/**'
+    branches: [master]
   schedule:
     - cron: '0 15 * * 2'
       
@@ -32,7 +20,16 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v4
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/create-release.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Check out code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v4
       with:
         ref: master
         fetch-depth: 0
@@ -54,9 +54,9 @@ jobs:
         git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
     
     - name: Setup node
-      uses: actions/setup-node@v6
+      uses: actions/setup-node@v4
       with:
-        node-version-file: docs/package.json
+        node-version: latest
       
     - name: Update documentation
       run: |
@@ -66,7 +66,7 @@ jobs:
         VERSION=${FULL_VERSION%.*}.x
 
         if [ ! -d "versioned_docs/version-${VERSION}" ]; then
-          npm install
+          npm ci
           npm run docusaurus docs:version ${VERSION}
 
           git add .
@@ -90,8 +90,6 @@ jobs:
         ## Important Notes
 
         ## Breaking Changes
-
-        ## Changes since v${VERSION}
         EOF
 
         echo -e "$(cat /tmp/CHANGELOG.prepend)\n\n$(cat CHANGELOG.md)" > CHANGELOG.md

.github/workflows/docs.yaml

@@ -14,38 +14,38 @@ jobs:
     if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
 
       - name: Setup Pages
         id: pages
-        uses: actions/configure-pages@v5
+        uses: actions/configure-pages@v4
       
-      - uses: actions/setup-node@v6
+      - uses: actions/setup-node@v4
         with:
-          # renovate: datasource=node-version depName=node
-          node-version: 22
+          node-version: 20
+          cache: npm
+          cache-dependency-path: "./docs/package-lock.json"
 
       - name: Test Build
         working-directory: ./docs
         run: |
-          npm install
+          npm ci
           npm run build
 
   build-docs:
     if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v6
+      - uses: actions/setup-node@v4
         with:
-          # renovate: datasource=node-version depName=node
-          node-version: 22
+          node-version: 20
 
       - name: Build docusaurus
         working-directory: ./docs
         run: |
-          npm install
+          npm ci
           npm run build
       
       - name: Upload artifact

.github/workflows/e2e.yml

@@ -1,14 +0,0 @@
-name: E2E
-
-on:
-  issue_comment:
-    types: [created]
-
-jobs:
-  e2e:
-    uses: oauth2-proxy/e2e-suite/.github/workflows/e2e.yml@main
-    permissions:
-      contents: read
-      statuses: write
-      issues: write
-      pull-requests: write

.github/workflows/labeler.yaml

@@ -9,7 +9,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/labeler@v6
+      - uses: actions/labeler@v5
         with:
           sync-labels: true
           dot: true

.github/workflows/nightly.yml

@@ -12,7 +12,7 @@ jobs:
     if: github.repository == 'oauth2-proxy/oauth2-proxy'
     steps:
     - name: Check out code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v4
       with:
         ref: master
         fetch-depth: 0
@@ -34,8 +34,8 @@ jobs:
 
     - name: Build images
       run: |
-        make nightly-build
+        make docker-nightly-build
 
     - name: Push images
       run: |
-        make nightly-push
+        make docker-nightly-push

.github/workflows/publish-release.yml

@@ -20,7 +20,7 @@ jobs:
       tag: ${{ steps.tag.outputs.version }}
     steps:
     - name: Check out code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.pull_request.merge_commit_sha }}
         fetch-depth: 0
@@ -43,16 +43,13 @@ jobs:
       id: tag
     
     - name: Set up go
-      uses: actions/setup-go@v6
+      uses: actions/setup-go@v5
       with:
-        go-version-file: go.mod
+        go-version: 1.21
 
     - name: Get dependencies
-      env:
-        # renovate: datasource=github-tags depName=golangci/golangci-lint
-        GOLANGCI_LINT_VERSION: v2.5.0
       run: |
-        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
+        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.55.2
         curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
         chmod +x ./cc-test-reporter
 
@@ -64,7 +61,7 @@ jobs:
     
     # Upload artifacts in case of workflow failure
     - name: Upload Artifacts
-      uses: actions/upload-artifact@v5
+      uses: actions/upload-artifact@v4
       with:
         name: oauth2-proxy-artifacts
         path: |
@@ -100,7 +97,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Check out code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v4
       with:
         ref: ${{ needs.publish.outputs.tag }}
         fetch-depth: 0
@@ -122,8 +119,8 @@ jobs:
 
     - name: Build images
       run: |
-        make build-docker-all
+        make docker-all
     
     - name: Push images
       run: |
-        make push-docker-all
+        make docker-push-all

.github/workflows/stale.yml

@@ -10,12 +10,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/stale@v10
+    - uses: actions/stale@v9
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        days-before-stale: 180
-        days-before-close: 14
-        stale-issue-message: 'This issue has been inactive for 180 days. If the issue is still relevant please comment to re-activate the issue. If no action is taken within 14 days, the issue will be marked closed.'
-        stale-pr-message: 'This pull request has been inactive for 180 days. If the pull request is still relevant please comment to re-activate the pull request. If no action is taken within 14 days, the pull request will be marked closed.'
-        exempt-issue-labels: bug,high-priority
-        exempt-pr-labels: bug,high-priority
+        stale-issue-message: 'This issue has been inactive for 60 days. If the issue is still relevant please comment to re-activate the issue. If no action is taken within 7 days, the issue will be marked closed.'
+        stale-pr-message: 'This pull request has been inactive for 60 days. If the pull request is still relevant please comment to re-activate the pull request. If no action is taken within 7 days, the pull request will be marked closed.'

.github/workflows/test.sh

@@ -17,7 +17,7 @@ if [ -z $CC_TEST_REPORTER_ID ]; then
   echo "3. CC_TEST_REPORTER_ID is unset, skipping"
 else
   echo "3. Running after-build"
-  ./cc-test-reporter after-build --exit-code $TEST_STATUS --prefix $(go list -m)
+  ./cc-test-reporter after-build --exit-code $TEST_STATUS -t gocov --prefix $(go list -m)
 fi
 
 if [ "$TEST_STATUS" -ne 0 ]; then

.gitignore

@@ -17,7 +17,6 @@ c.out
 # Folders
 _obj
 _test
-.DS_Store
 .idea/
 .vscode/*
 !/.vscode/tasks.json

.golangci.yml

@@ -1,69 +1,45 @@
-version: "2"
+run:
+  deadline: 120s
 linters:
-  default: none
   enable:
-    - bodyclose
-    - copyloopvar
-    - dogsled
-    - goconst
-    - gocritic
-    - goprintffuncname
-    - gosec
     - govet
     - ineffassign
-    - misspell
-    - prealloc
-    - revive
-    - staticcheck
-    - unconvert
-    - unused
-  exclusions:
-    generated: lax
-    presets:
-      - comments
-      - common-false-positives
-      - legacy
-      - std-error-handling
-    rules:
-      - linters:
-          - bodyclose
-          - goconst
-          - gocritic
-          - gosec
-          - revive
-          - scopelint
-          - unconvert
-        path: _test\.go
-      - linters:
-          - revive
-        path: _test\.go
-        text: 'dot-imports:'
-      # # If we have tests in shared test folders, these can be less strictly linted
-      - linters:
-          - bodyclose
-          - revive
-          - staticcheck
-        path: tests/.*_tests\.go
-      # See https://github.com/oauth2-proxy/oauth2-proxy/issues/3060
-      # https://staticcheck.dev/docs/checks/#QF1008
-      - linters:
-          - staticcheck
-        text: QF1008
-      - linters:
-          - revive
-        path: util/.*\.go$
-        text: "var-naming: avoid meaningless package names"
-    paths:
-      - third_party$
-      - builtin$
-      - examples$
-formatters:
-  enable:
+    - goconst
     - gofmt
     - goimports
-  exclusions:
-    generated: lax
-    paths:
-      - third_party$
-      - builtin$
-      - examples$
+    - gosec
+    - gosimple
+    - staticcheck
+    - typecheck
+    - unused
+    - bodyclose
+    - dogsled
+    - goprintffuncname
+    - misspell
+    - prealloc
+    - exportloopref
+    - stylecheck
+    - unconvert
+    - gocritic
+    - revive
+  disable-all: true
+issues:
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - scopelint
+        - bodyclose
+        - unconvert
+        - gocritic
+        - gosec
+        - goconst
+    - path: _test\.go
+      linters:
+        - revive
+      text: "dot-imports:"
+    # If we have tests in shared test folders, these can be less strictly linted
+    - path: tests/.*_tests\.go
+      linters:
+        - revive
+        - bodyclose
+        - stylecheck

ADOPTERS.md

@@ -1,28 +0,0 @@
-# Adopters
-
-This list showcases organizations that leverage OAuth2-Proxy within their
-infrastructure. If your organization uses OAuth2-Proxy and isn't yet listed, we
-encourage you to add it!
-
-This list aims to be a comprehensive and trusted resource for the OAuth2-Proxy
-community, demonstrating successful adoption across all kinds of industries.
-
-Contributing to this list is a simple way to impact the project's growth,
-maturity, and momentum. Thank you to all adopters and contributors of the
-OAuth2-Proxy project!
-
-## Updating this list
-
-To add your organization to this list, you can just [open a PR](https://github.com/oauth2-proxy/oauth2-proxy/pulls)
-to directly update this list.
-
-Add your organization name, your github username and if you desire a short
-description on how you utilize oauth2-proxy.
-
-## OAuth2-Proxy Adopters
-
-This list is sorted in the order that organizations were added to it.
-
-| Organization | Contact | Description of Use |
-| ------------ | ------- | ------------------ |
-|              |         |                    |

CHANGELOG.md

@@ -6,261 +6,8 @@
 
 ## Breaking Changes
 
-## Changes since v7.12.0
-
-- [#3228](https://github.com/oauth2-proxy/oauth2-proxy/pull/3228) fix: use GetSecret() in ticket.go makeCookie to respect cookie-secret-file (@stagswtf)
-- [#3244](https://github.com/oauth2-proxy/oauth2-proxy/pull/3244) chore(deps): upgrade to latest go1.25.3 (@tuunit)
-- [#3238](https://github.com/oauth2-proxy/oauth2-proxy/pull/3238) chore: Replace pkg/clock with narrowly targeted stub clocks (@dsymonds)
-
-# V7.12.0
-
-## Release Highlights
-
-- 🕵️‍♀️ Vulnerabilities have been addressed
-  - [CVE-2025-47907](https://pkg.go.dev/vuln/GO-2025-3849)
-- 🦸 Support for Cidaas IDP
-- 🐛 Squashed some bugs
-
-
-## Important Notes
-
-## Breaking Changes
-
-## Changes since v7.11.0
-
-- [#2273](https://github.com/oauth2-proxy/oauth2-proxy/pull/2273) feat: add Cidaas provider (@Bibob7, @Teko012)
-- [#3166](https://github.com/oauth2-proxy/oauth2-proxy/pull/3166) chore(dep): upgrade to latest golang 1.24.6 (@tuunit)
-- [#3156](https://github.com/oauth2-proxy/oauth2-proxy/pull/3156) feat: allow disable-keep-alives configuration for upstream (@jet-go)
-- [#3150](https://github.com/oauth2-proxy/oauth2-proxy/pull/3150) fix: Gitea team membership (@MagicRB, @tuunit)
-
-# V7.11.0
-
-## Release Highlights
-
-- 🏢 Support for SourceHut (sr.ht) provider
-- 🔍️ Support for more fine-grained control over the google admin-sdk scopes and optional google groups
-- 🐛 Squashed some bugs
-
-
-## Important Notes
-
-Firstly, fixed critical vulnerability where `skip_auth_routes` regex patterns matched against the full request URI (path + query parameters) instead of just the path, allowing authentication bypass attacks.
-
-Secondly, fixed double-escaping of `$` in regexes for Alpha Config upstreams path and rewriteTargets:
-
-```yaml
-# Before
-upstreams:
-  - id: web
-    path: ^/(.*)$$
-    rewriteTarget: /$$1
-
-# After
-upstreams:
-  - id: web
-    path: ^/(.*)$
-    rewriteTarget: /$1
-```
-
-
-## Breaking Changes
-
-If your configuration relies on matching query parameters in `skip_auth_routes` patterns, you must update your regex patterns to match paths only. Review all `skip_auth_routes` entries for potential impact.
-
-**Example of affected configuration:**
-```yaml
-# This pattern previously matched both:
-# - /api/foo/status (intended)
-# - /api/private/sensitive?path=/status (bypass - now fixed)
-skip_auth_routes: ["^/api/.*/status"]
-```
-
-For detailed information, migration guidance, and security implications, see the [security advisory](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-7rh7-c77v-6434).
-
-## Changes since v7.10.0
-
-- [#2615](https://github.com/oauth2-proxy/oauth2-proxy/pull/2615) feat(cookies): add option to set a limit on the number of per-request CSRF cookies oauth2-proxy sets (@bh-tt)
-- [#2605](https://github.com/oauth2-proxy/oauth2-proxy/pull/2605) fix: show login page on broken cookie (@Primexz)
-- [#2743](https://github.com/oauth2-proxy/oauth2-proxy/pull/2743) feat: allow use more possible google admin-sdk api scopes (@BobDu)
-- [#2359](https://github.com/oauth2-proxy/oauth2-proxy/pull/2359) feat: add SourceHut (sr.ht) provider(@bitfehler)
-- [#2524](https://github.com/oauth2-proxy/oauth2-proxy/pull/2524) fix: regex substitution for $ signs in upstream path handling before running envsubst (@dashkan / @tuunit)
-- [#3104](https://github.com/oauth2-proxy/oauth2-proxy/pull/3104) feat(cookie): add feature support for cookie-secret-file (@sandy2008)
-- [#3055](https://github.com/oauth2-proxy/oauth2-proxy/pull/3055) feat: support non-default authorization request response mode also for OIDC providers (@stieler-it)
-- [#3138](https://github.com/oauth2-proxy/oauth2-proxy/pull/3138) feat: make google_groups argument optional when using google provider (@sourava01)
-- [#3093](https://github.com/oauth2-proxy/oauth2-proxy/pull/3093) feat: differentiate between "no available key" and error for redis sessions (@nobletrout)
-- [GHSA-7rh7-c77v-6434](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-7rh7-c77v-6434) fix: skip_auth_routes bypass through query parameter inclusion
-
-
-# V7.10.0
-
-## Release Highlights
-- 🏢 Support for multiple orgs using the GitHub / Gitea provider
-- 🔵 Golang version upgrade to v1.24.5
-- 🕵️‍♀️ Vulnerabilities have been addressed
-  - [CVE-2025-4673](https://access.redhat.com/security/cve/CVE-2025-4673)
-  - [CVE-2025-22872](https://access.redhat.com/security/cve/CVE-2025-22872)
-  - [CVE-2025-09130](https://nvd.nist.gov/vuln/detail/CVE-2025-09130)
-  - [CVE-2025-22871](https://access.redhat.com/security/cve/CVE-2025-22871)
-- 🐛 Squashed some bugs
-
-## Important Notes
-
-## Breaking Changes
-
-## Changes since v7.9.0
-
-- [#3072](https://github.com/oauth2-proxy/oauth2-proxy/pull/3072) feat: support for multiple github orgs #3072 (@daniel-mersch)
-- [#3116](https://github.com/oauth2-proxy/oauth2-proxy/pull/3116) feat: bump to go1.24.5 and full dependency update (@wardviaene / @dolmen)
-- [#3097](https://github.com/oauth2-proxy/oauth2-proxy/pull/3097) chore(deps): update alpine base image to v3.22.0
-- [#3101](https://github.com/oauth2-proxy/oauth2-proxy/pull/3101) fix: return error for empty Redis URL list (@dgivens)
-
-# V7.9.0
-
-## Release Highlights
-- 📨 OAuth 2.0 Multiple Response Type Encoding
-- 📦️ Support for JWT encoded profile claims
-- 🔵 Golang version upgrade to v1.23.8
-- 🕵️‍♀️ Vulnerabilities have been addressed
-  - [CVE-2025-22871](https://github.com/advisories/GHSA-g9pc-8g42-g6vq)
-- 🐛 Squashed some bugs
-
-## Important Notes
-
-## Breaking Changes
-
-## Changes since v7.8.2
-
-- [#3031](https://github.com/oauth2-proxy/oauth2-proxy/pull/3031) Fixes Refresh Token bug with Entra ID and Workload Identity (#3027)[https://github.com/oauth2-proxy/oauth2-proxy/issues/3028] by using client assertion when redeeming the token (@richard87)
-- [#3001](https://github.com/oauth2-proxy/oauth2-proxy/pull/3001) Allow to set non-default authorization request response mode (@stieler-it)
-- [#3041](https://github.com/oauth2-proxy/oauth2-proxy/pull/3041) chore(deps): upgrade to latest golang v1.23.x release (@TheImplementer)
-- [#1916](https://github.com/oauth2-proxy/oauth2-proxy/pull/1916) fix: role extraction from access token in keycloak oidc (@Elektordi / @tuunit)
-- [#3014](https://github.com/oauth2-proxy/oauth2-proxy/pull/3014) feat: ability to parse JWT encoded profile claims (@ikarius)
-
-# V7.8.2
-
-## Release Highlights
-- 🐛 Cookie Expiration bug has been squashed
-- 🔵 Golang version upgrade to v1.23.7
-- 🕵️‍♀️ Vulnerabilities have been addressed
-  - CVE-2025-30204
-  - CVE-2025-27144
-  - CVE-2024-45336
-  - CVE-2025-22866
-  - CVE-2025-22870
-  - CVE-2024-45341
-  - CVE-2025-29923
-  - CVE-2025-22866
-  - CVE-2024-34156
-
-## Important Notes
-
-## Breaking Changes
-
-## Changes since v7.8.1
-
-- [#2918](https://github.com/oauth2-proxy/oauth2-proxy/issues/2918) feat: add --bearer-token-login-fallback (@carillonator)
-- [#2927](https://github.com/oauth2-proxy/oauth2-proxy/pull/2927) chore(deps/build): bump golang to 1.23 and use go.mod as single point of truth for all build files (@tuunit)
-- [#2697](https://github.com/oauth2-proxy/oauth2-proxy/pull/2697) Use `Max-Age` instead of `Expires` for cookie expiration (@matpen-wi)
-- [#2969](https://github.com/oauth2-proxy/oauth2-proxy/pull/2969) Update golang.org/x/oauth2 to v0.27.0 to address CVE-2025-22868 (@dsymonds)
-- [#2977](https://github.com/oauth2-proxy/oauth2-proxy/pull/2977) Update golang.org/x/net to v0.36.0 to address CVE-2025-22870 (@dsymonds)
-- [#2982](https://github.com/oauth2-proxy/oauth2-proxy/pull/2982) chore(deps): remove go:generate tool from go.mod (@dolmen)
-- [#3011](https://github.com/oauth2-proxy/oauth2-proxy/pull/3011) chore(deps): update golang dependencies and pin to latest golang v1.23.x release (@tuunit)
-- [#2967](https://github.com/oauth2-proxy/oauth2-proxy/pull/2967) Update HashNonce to use crypto/sha256 (@egibs)
-
-# V7.8.1
-
-## Release Highlights
-
-- 🐛 Two bugs have been squashed
-
-## Important Notes
-
-## Breaking Changes
-
-## Changes since v7.8.0
-
-- [#2887](https://github.com/oauth2-proxy/oauth2-proxy/issues/2887) fix: jwt regex validation error during skip-jwt-bearer-tokens flow
-- [#2920](https://github.com/oauth2-proxy/oauth2-proxy/pull/2920) fix: missing oauth2-proxy version for docker builds
-
-# V7.8.0
-
-## Release Highlights
-
-- ☁️ Introducing support for Microsoft Entra ID
-  - Including Support for Azure Workload Identity as well
-  - Including full e2e testing using Azure Credits from MS sponsoring
-  - Deprecated old Azure AD provider
-- 🪪 Static local JWKS file support
-- Support for systemd sockets
-- 🐛 Several bugs have been squashed
-- 🕵️‍♀️ Vulnerabilities have been addressed
-  - CVE-2024-45338
-
-## Important Notes
-
-## Breaking Changes
-
-## Changes since v7.7.1
-
-- [#2390](https://github.com/oauth2-proxy/oauth2-proxy/pull/2390) feat: add Microsoft Entra ID provider (@jjlakis / @tuunit)
-- [#2902](https://github.com/oauth2-proxy/oauth2-proxy/pull/2902) feat(entra): add Workload Identity support for Entra ID (@jjlakis)
-- [#2800](https://github.com/oauth2-proxy/oauth2-proxy/pull/2800) doc: add some opencontainer labels to docker image (@halkeye)
-- [#2755](https://github.com/oauth2-proxy/oauth2-proxy/pull/2755) feat: add X-Envoy-External-Address as supported header (@bjencks)
-- [#1985](https://github.com/oauth2-proxy/oauth2-proxy/pull/1985) feat: add support for systemd socket (@isodude)
-- [#2916](https://github.com/oauth2-proxy/oauth2-proxy/pull/2916) fix: systemd socket support build handling for windows (@tuunit)
-- [#2300](https://github.com/oauth2-proxy/oauth2-proxy/pull/2300) fix: add fix for websocket path rewrite (@rekup)
-- [#2821](https://github.com/oauth2-proxy/oauth2-proxy/pull/2821) feat: add CF-Connecting-IP as supported real ip header (@ondrejsika)
-- [#2620](https://github.com/oauth2-proxy/oauth2-proxy/pull/2620) fix: update code_verifier to use recommended method (@vishvananda)
-- [#2376](https://github.com/oauth2-proxy/oauth2-proxy/pull/2376) feat: static public keys file support for oidc provider (@axel7083 / @jjlakis)
-- [#2392](https://github.com/oauth2-proxy/oauth2-proxy/pull/2392) chore: extend test cases for oidc provider and documentation regarding implicit setting of the groups scope when no scope was specified in the config (@jjlakis / @tuunit)
-
-# V7.7.1
-
-## Release Highlights
-
-- 🐛 Several bugs have been squashed
-
-## Important Notes
-
-## Breaking Changes
-
-## Changes since v7.7.0
-
-- [#2803](https://github.com/oauth2-proxy/oauth2-proxy/pull/2803) fix: self signed certificate handling in v7.7.0 (@tuunit)
-- [#2619](https://github.com/oauth2-proxy/oauth2-proxy/pull/2619) fix: unable to use hyphen in JSON path for oidc-groups-claim option (@rd-danny-fleer)
-- [#2311](https://github.com/oauth2-proxy/oauth2-proxy/pull/2311) fix: runtime error: index out of range (0) with length 0 (@miguelborges99 / @tuunit)
-
-# V7.7.0
-
-## Release Highlights
-
-- 🌐 Custom user agent "oauth2-proxy/<version>"
-- 💾 Added s390x architecture support
-- 🕵️‍♀️ Vulnerabilities have been addressed
-  - CVE-2024-24786
-  - CVE-2024-24791
-  - CVE-2024-24790
-  - CVE-2024-24784
-- 📖 Improved docs
-
-## Important Notes
-- Remove support of arm/v6 for distroless image runtime. Alpine tags still support arm/v6.
-
-## Breaking Changes
-
 ## Changes since v7.6.0
 
-- [#2539](https://github.com/oauth2-proxy/oauth2-proxy/pull/2539) pkg/http: Fix leaky test (@isodude)
-- [#4917](https://github.com/oauth2-proxy/oauth2-proxy/pull/4917) Upgraded all modules to the latest version (@pierluigilenoci)
-- [#2570](https://github.com/oauth2-proxy/oauth2-proxy/pull/2570) Set default user agent to oauth2-proxy/$version (from default Golang one)
-- [#2674](https://github.com/oauth2-proxy/oauth2-proxy/pull/2674) docs: additional notes about available claims for HeaderValue (@vegetablest)
-- [#2459](https://github.com/oauth2-proxy/oauth2-proxy/pull/2459) chore(deps): Updated to ginkgo v2 (@kvanzuijlen, @tuunit)
-- [#2112](https://github.com/oauth2-proxy/oauth2-proxy/pull/2112) docs: update list of providers which support refresh tokens (@mikefab-msf)
-- [#2734](https://github.com/oauth2-proxy/oauth2-proxy/pull/2734) Added s390x architecture option support (@priby05)
-- [#2589](https://github.com/oauth2-proxy/oauth2-proxy/pull/2589) Added support for regex path matching and rewriting when using a static `file:` upstream (@ianroberts)
-- [#2790](https://github.com/oauth2-proxy/oauth2-proxy/pull/2790) chore(deps): update all golang dependencies (@tuunit)
-- [#2607](https://github.com/oauth2-proxy/oauth2-proxy/pull/2607) fix(csrf): fix possible infinite loop (@Primexz)
-
 # V7.6.0
 
 ## Release Highlights

Dockerfile

@@ -1,18 +1,11 @@
-# The image ARGs have to be at the top, otherwise the docker daemon cannot validate
-# the FROM statements and overall Dockerfile
-#
-# Argument for setting the build image
-ARG BUILD_IMAGE=placeholder
-# Argument for setting the runtime image
-ARG RUNTIME_IMAGE=placeholder
-# Argument for setting the oauth2-proxy build version
-ARG VERSION
+# This ARG has to be at the top, otherwise the docker daemon does not known what to do with FROM ${RUNTIME_IMAGE}
+ARG RUNTIME_IMAGE=gcr.io/distroless/static:nonroot
 
 # All builds should be done using the platform native to the build node to allow
 #  cache sharing of the go mod download step.
 # Go cross compilation is also faster than emulation the go compilation across
 #  multiple platforms.
-FROM --platform=${BUILDPLATFORM} ${BUILD_IMAGE} AS builder
+FROM --platform=${BUILDPLATFORM} docker.io/library/golang:1.21-bookworm AS builder
 
 # Copy sources
 WORKDIR $GOPATH/src/github.com/oauth2-proxy/oauth2-proxy
@@ -24,14 +17,12 @@ RUN go mod download
 # Now pull in our code
 COPY . .
 
-# Arguments go here so that the previous steps can be cached if no external sources
-# have changed. These arguments are automatically set by the docker engine.
+# Arguments go here so that the previous steps can be cached if no external
+#  sources have changed.
+ARG VERSION
 ARG TARGETPLATFORM
 ARG BUILDPLATFORM
 
-# Reload version argument
-ARG VERSION
-
 # Build binary and make sure there is at least an empty key file.
 #  This is useful for GCP App Engine custom runtime builds, because
 #  you cannot use multiline variables in their app.yaml, so you have to
@@ -42,33 +33,19 @@ ARG VERSION
 #  automatically set by the docker engine.
 RUN case ${TARGETPLATFORM} in \
          "linux/amd64")  GOARCH=amd64  ;; \
-         # arm64 and arm64v8 are equivalent in go and do not require a goarm
+         # arm64 and arm64v8 are equivilant in go and do not require a goarm
          # https://github.com/golang/go/wiki/GoArm
          "linux/arm64" | "linux/arm/v8")  GOARCH=arm64  ;; \
          "linux/ppc64le")  GOARCH=ppc64le  ;; \
-         "linux/s390x")  GOARCH=s390x  ;; \
          "linux/arm/v6") GOARCH=arm GOARM=6  ;; \
          "linux/arm/v7") GOARCH=arm GOARM=7 ;; \
     esac && \
     printf "Building OAuth2 Proxy for arch ${GOARCH}\n" && \
     GOARCH=${GOARCH} VERSION=${VERSION} make build && touch jwt_signing_key.pem
 
-# Reload runtime image
-ARG RUNTIME_IMAGE
 # Copy binary to runtime image
 FROM ${RUNTIME_IMAGE}
-# Reload version
-ARG VERSION
-
 COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/oauth2-proxy /bin/oauth2-proxy
 COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/jwt_signing_key.pem /etc/ssl/private/jwt_signing_key.pem
 
-LABEL org.opencontainers.image.licenses=MIT \
-      org.opencontainers.image.description="A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers." \
-      org.opencontainers.image.documentation=https://oauth2-proxy.github.io/oauth2-proxy/ \
-      org.opencontainers.image.source=https://github.com/oauth2-proxy/oauth2-proxy \
-      org.opencontainers.image.url=https://quay.io/oauth2-proxy/oauth2-proxy \
-      org.opencontainers.image.title=oauth2-proxy \
-      org.opencontainers.image.version=${VERSION}
-
 ENTRYPOINT ["/bin/oauth2-proxy"]

MAINTAINERS

@@ -1,5 +1,4 @@
-Joel Speed <joel@oauth2-proxy.dev> (@JoelSpeed)
-Nick Meves <nick@oauth2-proxy.dev> (@NickMeves)
-Braunson <braunson@oauth2-proxy.dev> (@braunsonm)
-Jan Larwig <jan@oauth2-proxy.dev> (@tuunit)
-Koen van Zuijlen <koen@oauth2-proxy.dev> (@kvanzuijlen)
+Joel Speed <joel.speed@hotmail.co.uk> (@JoelSpeed)
+Nick Meves <gills-vector-0p@icloud.com> (@NickMeves)
+Jan Larwig <jan@larwig.com> (@tuunit)
+Koen van Zuijlen <kvz.public@gmail.com> (@kvanzuijlen)

Makefile

@@ -1,29 +1,3 @@
-#!/usr/bin/env bash
-
-#
-# Makefile with some common workflow for dev, build and test
-#
-
-##@ General
-
-# The help target prints out all targets with their descriptions organized
-# beneath their categories. The categories are represented by '##@' and the
-# target descriptions by '##'. The awk command is responsible for reading the
-# entire set of makefiles included in this invocation, looking for lines of the
-# file as xyz: ## something, and then pretty-format the target and help. Then,
-# if there's a line with ##@ something, that gets pretty-printed as a category.
-# More info on the usage of ANSI control characters for terminal formatting:
-# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
-# More info on the awk command:
-# http://linuxcommand.org/lc3_adv_awk.php
-
-# The following help command is Licensed under the Apache License, Version 2.0 (the "License")
-# Copyright 2023 The Kubernetes Authors.
-.PHONY: help
-help: ## Display this help
-	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
-
-
 GO ?= go
 GOLANGCILINT ?= golangci-lint
 
@@ -36,128 +10,115 @@ REPOSITORY ?= oauth2-proxy
 DATE := $(shell date +"%Y%m%d")
 .NOTPARALLEL:
 
-# The go version in go.mod used for the Docker build toolchain, without the patch
-GO_MOD_VERSION_MINOR := $(shell $(GO) list -f '{{printf "%.4s" .Module.GoVersion}}' )
-
-# From go1.21 go will transparently download the toolchain declared in go.mod. https://go.dev/doc/toolchain
-# We don't need to keep this message updated: the important info is in go.mod.
-GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least go1.21
+GO_MAJOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f1)
+GO_MINOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f2)
+MINIMUM_SUPPORTED_GO_MAJOR_VERSION = 1
+MINIMUM_SUPPORTED_GO_MINOR_VERSION = 20
+GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION).$(MINIMUM_SUPPORTED_GO_MINOR_VERSION)
 
 ifeq ($(COVER),true)
 TESTCOVER ?= -coverprofile c.out
 endif
 
-##@ Build
+.PHONY: all
+all: lint $(BINARY)
+
+.PHONY: clean
+clean:
+	-rm -rf release
+	-rm -f $(BINARY)
+
+.PHONY: distclean
+distclean: clean
+	rm -rf vendor
+
+.PHONY: lint
+lint: validate-go-version
+	GO111MODULE=on $(GOLANGCILINT) run
 
 .PHONY: build
-build: validate-go-version clean $(BINARY) ## Build and create oauth2-proxy binary from current source code
+build: validate-go-version clean $(BINARY)
 
 $(BINARY):
-	CGO_ENABLED=0 $(GO) build -a -installsuffix cgo -ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" -o $@ github.com/oauth2-proxy/oauth2-proxy/v7
+	CGO_ENABLED=0 $(GO) build -a -installsuffix cgo -ldflags="-X main.VERSION=${VERSION}" -o $@ github.com/oauth2-proxy/oauth2-proxy/v7
 
-DOCKER_BUILDX_COMMON_ARGS     ?= --build-arg BUILD_IMAGE=docker.io/library/golang:$(GO_MOD_VERSION_MINOR)-bookworm --build-arg VERSION=$(VERSION)
-
-DOCKER_BUILD_PLATFORM         ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v7,linux/s390x
+DOCKER_BUILD_PLATFORM         ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v7
 DOCKER_BUILD_RUNTIME_IMAGE    ?= gcr.io/distroless/static:nonroot
-DOCKER_BUILDX_ARGS            ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE} ${DOCKER_BUILDX_COMMON_ARGS}
+DOCKER_BUILDX_ARGS            ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE} --build-arg VERSION=${VERSION}
 DOCKER_BUILDX                 := docker buildx build ${DOCKER_BUILDX_ARGS} --pull
 DOCKER_BUILDX_X_PLATFORM      := $(DOCKER_BUILDX) --platform ${DOCKER_BUILD_PLATFORM}
 DOCKER_BUILDX_PUSH            := $(DOCKER_BUILDX) --push
 DOCKER_BUILDX_PUSH_X_PLATFORM := $(DOCKER_BUILDX_PUSH) --platform ${DOCKER_BUILD_PLATFORM}
 
-DOCKER_BUILD_PLATFORM_ALPINE         ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v6,linux/arm/v7,linux/s390x
-DOCKER_BUILD_RUNTIME_IMAGE_ALPINE    ?= alpine:3.22.2
-DOCKER_BUILDX_ARGS_ALPINE            ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE_ALPINE} ${DOCKER_BUILDX_COMMON_ARGS}
+DOCKER_BUILD_PLATFORM_ALPINE         ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v6,linux/arm/v7
+DOCKER_BUILD_RUNTIME_IMAGE_ALPINE    ?= alpine:3.19.0
+DOCKER_BUILDX_ARGS_ALPINE            ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE_ALPINE} --build-arg VERSION=${VERSION}
 DOCKER_BUILDX_X_PLATFORM_ALPINE      := docker buildx build ${DOCKER_BUILDX_ARGS_ALPINE} --platform ${DOCKER_BUILD_PLATFORM_ALPINE}
 DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE := $(DOCKER_BUILDX_X_PLATFORM_ALPINE) --push
 
-.PHONY: build-docker
-build-docker: build-distroless build-alpine ## Build multi architecture docker images in both flavours (distroless / alpine)
-
-.PHONY: build-distroless
-build-distroless: ## Build multi architecture distroless based docker image
+.PHONY: docker
+docker:
 	$(DOCKER_BUILDX_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY):latest -t $(REGISTRY)/$(REPOSITORY):${VERSION} .
-
-.PHONY: build-alpine
-build-alpine: ## Build multi architecture alpine based docker image
 	$(DOCKER_BUILDX_X_PLATFORM_ALPINE) -t $(REGISTRY)/$(REPOSITORY):latest-alpine -t $(REGISTRY)/$(REPOSITORY):${VERSION}-alpine .
 
-.PHONY: build-docker-all
-build-docker-all: build-docker ## Build docker images for all supported architectures in both flavours (distroless / alpine)
+.PHONY: docker-push
+docker-push:
+	$(DOCKER_BUILDX_PUSH_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY):latest -t $(REGISTRY)/$(REPOSITORY):${VERSION} .
+	$(DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE) -t $(REGISTRY)/$(REPOSITORY):latest-alpine -t $(REGISTRY)/$(REPOSITORY):${VERSION}-alpine .
+
+.PHONY: docker-all
+docker-all: docker
 	$(DOCKER_BUILDX) --platform linux/amd64   -t $(REGISTRY)/$(REPOSITORY):latest-amd64   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-amd64 .
 	$(DOCKER_BUILDX) --platform linux/arm64   -t $(REGISTRY)/$(REPOSITORY):latest-arm64   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-arm64 .
 	$(DOCKER_BUILDX) --platform linux/ppc64le -t $(REGISTRY)/$(REPOSITORY):latest-ppc64le -t $(REGISTRY)/$(REPOSITORY):${VERSION}-ppc64le .
+	$(DOCKER_BUILDX) --platform linux/arm/v6  -t $(REGISTRY)/$(REPOSITORY):latest-armv6   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv6 .
 	$(DOCKER_BUILDX) --platform linux/arm/v7  -t $(REGISTRY)/$(REPOSITORY):latest-armv7   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv7 .
-	$(DOCKER_BUILDX) --platform linux/s390x   -t $(REGISTRY)/$(REPOSITORY):latest-s390x -t $(REGISTRY)/$(REPOSITORY):${VERSION}-s390x .
 
-
-##@ Publish
-
-.PHONY: push-docker
-push-docker: push-distroless push-alpine ## Push multi architecture docker images for both flavours (distroless / alpine)
-
-.PHONY: push-distroless
-push-distroless: ## Push multi architecture distroless based docker image
-	$(DOCKER_BUILDX_PUSH_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY):latest -t $(REGISTRY)/$(REPOSITORY):${VERSION} .
-
-.PHONY: push-alpine
-push-alpine: ## Push multi architecture alpine based docker image
-	$(DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE) -t $(REGISTRY)/$(REPOSITORY):latest-alpine -t $(REGISTRY)/$(REPOSITORY):${VERSION}-alpine .
-
-.PHONY: push-docker-all
-push-docker-all: push-docker ## Push docker images for all supported architectures for both flavours (distroless / alpine)
+.PHONY: docker-push-all
+docker-push-all: docker-push
 	$(DOCKER_BUILDX_PUSH) --platform linux/amd64   -t $(REGISTRY)/$(REPOSITORY):latest-amd64   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-amd64 .
 	$(DOCKER_BUILDX_PUSH) --platform linux/arm64   -t $(REGISTRY)/$(REPOSITORY):latest-arm64   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-arm64 .
 	$(DOCKER_BUILDX_PUSH) --platform linux/ppc64le -t $(REGISTRY)/$(REPOSITORY):latest-ppc64le -t $(REGISTRY)/$(REPOSITORY):${VERSION}-ppc64le .
+	$(DOCKER_BUILDX_PUSH) --platform linux/arm/v6  -t $(REGISTRY)/$(REPOSITORY):latest-armv6   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv6 .
 	$(DOCKER_BUILDX_PUSH) --platform linux/arm/v7  -t $(REGISTRY)/$(REPOSITORY):latest-armv7   -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv7 .
-	$(DOCKER_BUILDX_PUSH) --platform linux/s390x   -t $(REGISTRY)/$(REPOSITORY):latest-s390x -t $(REGISTRY)/$(REPOSITORY):${VERSION}-s390x .
 
-
-##@ Nightly scheduling
-
-.PHONY: nightly-build
-nightly-build: ## Nightly build command for docker images in both flavours (distroless / alpine)
+.PHONY: docker-nightly-build
+docker-nightly-build:
 	$(DOCKER_BUILDX_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY)-nightly:latest -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE} .
 	$(DOCKER_BUILDX_X_PLATFORM_ALPINE) -t ${REGISTRY}/$(REPOSITORY)-nightly:latest-alpine -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE}-alpine .
 
-.PHONY: nightly-push
-nightly-push: ## Nightly push command for docker images in both flavours (distroless / alpine)
+.PHONY: docker-nightly-push
+docker-nightly-push:
 	$(DOCKER_BUILDX_PUSH_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY)-nightly:latest -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE} .
 	$(DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE) -t ${REGISTRY}/$(REPOSITORY)-nightly:latest-alpine -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE}-alpine .
 
-
-##@ Docs
-
 .PHONY: generate
-generate: ## Generate alpha config docs from golang structs
+generate:
 	go generate ./pkg/...
 
 .PHONY: verify-generate
-verify-generate: generate ## Verify command to check if alpha config docs are in line with golang struct changes
+verify-generate: generate
 	git diff --exit-code
 
-##@ Miscellaneous
-
 .PHONY: test
-test: lint ## Run all Go tests
+test: lint
 	GO111MODULE=on $(GO) test $(TESTCOVER) -v -race ./...
 
 .PHONY: release
-release: validate-go-version lint test ## Create a full release for all architectures (binaries and checksums)
+release: validate-go-version lint test
 	BINARY=${BINARY} VERSION=${VERSION} ./dist.sh
 
-.PHONY: clean
-clean: ## Cleanup release and build files
-	-rm -rf release
-	-rm -f $(BINARY)
-
-.PHONY: lint
-lint: validate-go-version ## Lint all files using golangci-lint
-	GO111MODULE=on $(GOLANGCILINT) run
-
 .PHONY: validate-go-version
-validate-go-version: ## Validate Go environment requirements
-	@$(GO) list . >/dev/null || { echo '$(GO_VERSION_VALIDATION_ERR_MSG)'; exit 1; }
+validate-go-version:
+	@if [ $(GO_MAJOR_VERSION) -gt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
+		exit 0 ;\
+	elif [ $(GO_MAJOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
+		echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
+		exit 1; \
+	elif [ $(GO_MINOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MINOR_VERSION) ] ; then \
+		echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
+		exit 1; \
+	fi
 
 # local-env can be used to interact with the local development environment
 # eg:

README.md

@@ -1,86 +1,77 @@
-[![Continuous Integration](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yml/badge.svg)](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yml)
+![OAuth2 Proxy](docs/static/img/logos/OAuth2_Proxy_horizontal.svg)
+
+[![Continuous Integration](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yaml/badge.svg)](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yaml)
 [![Go Report Card](https://goreportcard.com/badge/github.com/oauth2-proxy/oauth2-proxy)](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy)
 [![GoDoc](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy?status.svg)](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a58ff79407212e2beacb/maintainability)](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a58ff79407212e2beacb/test_coverage)](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/test_coverage)
 
-![OAuth2 Proxy](docs/static/img/logos/OAuth2_Proxy_horizontal.svg)
+A reverse proxy and static file server that provides authentication using Providers (Google, Keycloak, GitHub and others)
+to validate accounts by email, domain or group.
 
-OAuth2-Proxy is a flexible, open-source tool that can act as either a standalone reverse proxy or a middleware component integrated into existing reverse proxy or load balancer setups. It provides a simple and secure way to protect your web applications with OAuth2 / OIDC authentication. As a reverse proxy, it intercepts requests to your application and redirects users to an OAuth2 provider for authentication. As a middleware, it can be seamlessly integrated into your existing infrastructure to handle authentication for multiple applications.
+**Note:** This repository was forked from [bitly/OAuth2_Proxy](https://github.com/bitly/oauth2_proxy) on 27/11/2018.
+Versions v3.0.0 and up are from this fork and will have diverged from any changes in the original fork.
+A list of changes can be seen in the [CHANGELOG](CHANGELOG.md).
 
-OAuth2-Proxy supports a lot of OAuth2 as well as OIDC providers. Either through a generic OIDC client or a specific implementation for Google, Microsoft Entra ID, GitHub, login.gov and others. Through specialised provider implementations oauth2-proxy can extract more details about the user like preferred usernames and groups. Those details can then be forwarded as HTTP headers to your upstream applications.
+**Note:** This project was formerly hosted as `pusher/oauth2_proxy` but has been renamed as of 29/03/2020 to `oauth2-proxy/oauth2-proxy`.
+Going forward, all images shall be available at `quay.io/oauth2-proxy/oauth2-proxy` and binaries will be named `oauth2-proxy`.
 
-![Simplified Architecture](docs/static/img/simplified-architecture.svg)
+![Sign In Page](docs/static/img/sign-in-page.png)
 
-## Get Started
+## Installation
 
-OAuth2-Proxy's [Installation Docs](https://oauth2-proxy.github.io/oauth2-proxy/installation) cover how to install and configure your setup. Additionally you can take a further look at the [example setup files](https://github.com/oauth2-proxy/oauth2-proxy/tree/master/contrib/local-environment).
+1.  Choose how to deploy:
 
-## Releases
+    a. Using a [Prebuilt Binary](https://github.com/oauth2-proxy/oauth2-proxy/releases) (current release is `v7.6.0`)
 
-### Binaries
-We publish oauth2-proxy as compiled binaries on GitHub for all major architectures as well as more exotic ones like `ppc64le` as well as `s390x`.
+    b. Using Go to install the latest release
+    ```bash
+    $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest
+    # which will put the binary in `$GOROOT/bin`
+    ```
+    c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available)
 
-Check out the [latest release](https://github.com/oauth2-proxy/oauth2-proxy/releases/latest).
+    d. Using a [Pre-Release Nightly Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy-nightly) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available)
 
-### Images
+    e. Using the official [Kubernetes manifest](https://github.com/oauth2-proxy/manifests) (Helm)
 
-From `v7.6.0` and up the base image has been changed from Alpine to [GoogleContainerTools/distroless](https://github.com/GoogleContainerTools/distroless).
-This image comes with even fewer installed dependencies and thus should improve security. The image therefore is also slightly smaller than Alpine.
-For debugging purposes (and those who really need it. e.g. `armv6`) we still provide images based on Alpine. The tags of these images are suffixed with `-alpine`.
+    Prebuilt binaries can be validated by extracting the file and verifying it against the `sha256sum.txt` checksum file provided for each release starting with version `v3.0.0`.
 
-Since 2023-11-18 we build nightly images directly from the `master` branch and provide them at `quay.io/oauth2-proxy/oauth2-proxy-nightly`.
-These images are considered unstable and therefore should **NOT** be used for production purposes unless you know what you're doing.
+    ```
+    sha256sum -c sha256sum.txt 2>&1 | grep OK
+    oauth2-proxy-x.y.z.linux-amd64: OK
+    ```
 
-## Sponsors
+2.  [Select a Provider and Register an OAuth Application with a Provider](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider)
+3.  [Configure OAuth2 Proxy using config file, command line options, or environment variables](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/overview)
+4.  [Configure SSL or Deploy behind a SSL endpoint](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/tls) (example provided for Nginx)
 
-![Microsoft](https://upload.wikimedia.org/wikipedia/commons/9/96/Microsoft_logo_%282012%29.svg)
-Microsoft Azure credits for open source projects
-
-Would you like to sponsor the project then please contact us at [sponsors@oauth2-proxy.dev](mailto:sponsors@oauth2-proxy.dev)
-
-## Getting Involved
-[![Slack](https://img.shields.io/badge/slack-Gopher_%23oauth2--proxy-red?logo=slack)](https://gophers.slack.com/archives/CM2RSS25N)
-
-Join the #oauth2-proxy [Slack channel](https://gophers.slack.com/archives/CM2RSS25N) to chat with other users of oauth2-proxy or reach out to the maintainers directly. Use the [public invite link](https://invite.slack.golangbridge.org/) to get an invite for the Gopher Slack space.
-
-OAuth2-Proxy is a community-driven project. We rely on the contribut️ions of our users to continually improve it. While review times can vary, we appreciate your patience and understanding. As a volunteer-driven project, we strive to keep this project stable and might take longer to merge changes.
-
-If you want to contribute to the project. Please see our [Contributing](https://oauth2-proxy.github.io/oauth2-proxy/community/contribution) guide.
-
-Who uses OAuth2-Proxy? Have a look at our new [ADOPTERS](ADOPTERS.md) file and
-feel free to open a PR to add your organisation.
-
-Thanks to all the people who already contributed ❤
-
-<a href="https://github.com/oauth2-proxy/oauth2-proxy/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=oauth2-proxy/oauth2-proxy&columns=15&max=75" />
-  <img src="https://img.shields.io/github/contributors/oauth2-proxy/oauth2-proxy" />
-</a>
-
-Made with [contrib.rocks](https://contrib.rocks).
 
 ## Security
 
-If you believe you have found a vulnerability within OAuth2 Proxy or any of its dependencies, please do **NOT** open an issue or PR on GitHub, please do **NOT** post any details publicly.
-
-Security disclosures **MUST** be done in private. If you have found an issue that you would like to bring to the attention of the maintainers, please compose an email and send it to the list of people listed in our [MAINTAINERS](MAINTAINERS) file.
-
-For more details read our full [Security Docs](https://oauth2-proxy.github.io/oauth2-proxy/community/security#security-disclosures)
-
-### Security Notice for v6.0.0 and older
-
-If you are running a version older than v6.0.0 we **strongly recommend** to the current version.
-
+If you are running a version older than v6.0.0 we **strongly recommend you please update** to a current version.
 See [open redirect vulnerability](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-5m6c-jp6f-2vcv) for details.
 
-## Repository History
+## Docs
 
-**2018-11-27:** This repository was forked from [bitly/OAuth2_Proxy](https://github.com/bitly/oauth2_proxy). Versions v3.0.0 and up are from this fork and will have diverged from any changes in the original fork. A list of changes can be seen in the [CHANGELOG](CHANGELOG.md).
+Read the docs on our [Docs site](https://oauth2-proxy.github.io/oauth2-proxy/docs/).
 
-**2020-03-29:** This project was formerly hosted as `pusher/oauth2_proxy` but has been renamed to `oauth2-proxy/oauth2-proxy`. Going forward, all images shall be available at `quay.io/oauth2-proxy/oauth2-proxy` and binaries will be named `oauth2-proxy`.
+![OAuth2 Proxy Architecture](docs/static/img/architecture.svg)
 
-## License
+## Images
 
-OAuth2-Proxy is distributed under [The MIT License](LICENSE).
+From `v7.6.0` and up the base image has been changed from Alpine to [GoogleContainerTools/distroless](https://github.com/GoogleContainerTools/distroless).
+This image comes with even fewer installed dependencies and thus should improve security. The image therefore is also slightly smaller than Alpine.
+For debugging purposes (and those who really need it (i.e. `armv6`)) we still provide images based on Alpine. The tags of these images are suffixed with `-alpine`.
+
+Since 2023-11-18 we provide nightly images. These images are build and pushed nightly to `quay.io/oauth2-proxy/oauth2-proxy-nightly` from `master`.
+These images should be considered alpha and therefore *should not* be used for production purposes unless you know what you're doing.
+
+## Getting Involved
+
+If you would like to reach out to the maintainers, come talk to us in the `#oauth2-proxy` channel in the [Gophers slack](http://gophers.slack.com/).
+
+## Contributing
+
+Please see our [Contributing](CONTRIBUTING.md) guidelines. For releasing see our [release creation guide](RELEASE.md).

RELEASE.md

@@ -41,8 +41,8 @@ Note this uses `v4.1.0` as an example release number.
 10. Publish release in Github
 11. Make and push docker images to Quay
   ```
-  make build-docker-all
-  make push-docker-all
+  make docker-all
+  make docker-push-all
   ```
   Note: Ensure the docker tags don't include `-dirty`. This means you have uncommitted changes.
 

SECURITY.md

@@ -1,3 +1,3 @@
 # Security Disclosures
 
-Please see [our community docs](https://oauth2-proxy.github.io/oauth2-proxy/community/security) for our security policy.
+Please see [our community docs](https://oauth2-proxy.github.io/oauth2-proxy/docs/community/security) for our security policy.

contrib/local-environment/dex.yaml

@@ -1,7 +1,7 @@
 # This configuration is intended to be used with the docker-compose testing
 # environment.
-# This should configure Dex to run on port 5556 and provides a static login
-issuer: http://dex.localtest.me:5556/dex
+# This should configure Dex to run on port 4190 and provides a static login
+issuer: http://dex.localtest.me:4190/dex
 storage:
   type: etcd
   config:
@@ -9,7 +9,7 @@ storage:
     - http://etcd:2379
     namespace: dex/
 web:
-  http: 0.0.0.0:5556
+  http: 0.0.0.0:4190
 oauth2:
   skipApprovalScreen: true
 expiry:

contrib/local-environment/docker-compose-alpha-config.yaml

@@ -13,7 +13,6 @@
 version: '3.0'
 services:
   oauth2-proxy:
-    image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
     command: --config /oauth2-proxy.cfg --alpha-config /oauth2-proxy-alpha-config.yaml
     volumes:
       - "./oauth2-proxy-alpha-config.cfg:/oauth2-proxy.cfg"

contrib/local-environment/docker-compose-gitea.yaml

@@ -14,7 +14,7 @@ version: '3.0'
 services:
   oauth2-proxy:
     container_name: oauth2-proxy
-    image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
+    image: gitea-oauth #quay.io/oauth2-proxy/oauth2-proxy:v7.6.0
     command: --config /oauth2-proxy.cfg
     hostname: oauth2-proxy
     volumes:
@@ -34,12 +34,15 @@ services:
     container_name: httpbin
     image: kennethreitz/httpbin:latest
     hostname: httpbin
-    ports: []
+    ports:
+      - 8080:80
     networks:
-      httpbin: {}
+      httpbin:
+        aliases:
+          - httpbin.localtest.me
 
   gitea:
-    image: gitea/gitea:1.24.7
+    image: gitea/gitea:latest
     container_name: gitea
     environment:
       - USER_UID=1000

contrib/local-environment/docker-compose-keycloak.yaml

@@ -14,7 +14,7 @@ version: '3.0'
 services:
   oauth2-proxy:
     container_name: oauth2-proxy
-    image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
+    image: quay.io/oauth2-proxy/oauth2-proxy:v7.6.0
     command: --config /oauth2-proxy.cfg
     hostname: oauth2-proxy
     volumes:
@@ -34,24 +34,32 @@ services:
     container_name: httpbin
     image: kennethreitz/httpbin:latest
     hostname: httpbin
-    ports: []
+    ports:
+      - 8080:80/tcp
     networks:
-      httpbin: {}
+      httpbin:
+        aliases:
+          - httpbin.localtest.me
 
   keycloak:
     container_name: keycloak
-    image: keycloak/keycloak:25.0
+    image: jboss/keycloak:10.0.0
     hostname: keycloak
     command:
-      - 'start-dev'
-      - '--http-port=9080'
-      - '--import-realm'
+      [
+        '-b',
+        '0.0.0.0',
+        '-Djboss.socket.binding.port-offset=1000',
+        '-Dkeycloak.migration.action=import',
+        '-Dkeycloak.migration.provider=dir',
+        '-Dkeycloak.migration.dir=/realm-config',
+        '-Dkeycloak.migration.strategy=IGNORE_EXISTING'
+      ]
     volumes:
-      - ./keycloak:/opt/keycloak/data/import
+      - ./keycloak:/realm-config
     environment:
-      KC_HTTP_PORT: 9080
-      KEYCLOAK_ADMIN: admin@example.com
-      KEYCLOAK_ADMIN_PASSWORD: password
+      KEYCLOAK_USER: admin@example.com
+      KEYCLOAK_PASSWORD: password
     ports:
       - 9080:9080/tcp
     networks:

contrib/local-environment/docker-compose-nginx.yaml

@@ -22,26 +22,15 @@
 version: '3.0'
 services:
   oauth2-proxy:
-    image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
     ports: []
     hostname: oauth2-proxy
-    container_name: oauth2-proxy
-    command: --config /oauth2-proxy.cfg
     volumes:
       - "./oauth2-proxy-nginx.cfg:/oauth2-proxy.cfg"
     networks:
       oauth2-proxy: {}
-      dex: {}
-      etcd: {}
-      httpbin: {}
-    depends_on:
-      - dex
-      - httpbin
   nginx:
-    depends_on:
-      - oauth2-proxy
     container_name: nginx
-    image: nginx:1.29
+    image: nginx:1.18
     restart: unless-stopped
     ports:
       - 80:80/tcp
@@ -50,43 +39,6 @@ services:
       - "./nginx.conf:/etc/nginx/conf.d/default.conf"
     networks:
       oauth2-proxy: {}
-      dex: {}
-      etcd: {}
       httpbin: {}
-  dex:
-    container_name: dex
-    image: ghcr.io/dexidp/dex:v2.44.0
-    command: dex serve /dex.yaml
-    hostname: dex
-    volumes:
-      - "./dex.yaml:/dex.yaml"
-    restart: unless-stopped
-    ports:
-      - 5556:4181/tcp
-    networks:
-      dex:
-        aliases:
-          - dex.localtest.me
-      etcd: {}
-    depends_on:
-      - etcd
-  httpbin:
-    container_name: httpbin
-    image: kennethreitz/httpbin
-    ports: []
-    networks:
-      httpbin: {}
-  etcd:
-    container_name: etcd
-    image: gcr.io/etcd-development/etcd:v3.6.5
-    entrypoint: /usr/local/bin/etcd
-    command:
-      - --listen-client-urls=http://0.0.0.0:2379
-      - --advertise-client-urls=http://etcd:2379
-    networks:
-      etcd: {}
 networks:
-  dex: {}
-  etcd: {}
-  httpbin: {}
   oauth2-proxy: {}

contrib/local-environment/docker-compose-traefik.yaml

@@ -23,7 +23,6 @@ version: '3.0'
 services:
 
   oauth2-proxy:
-    image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
     ports: []
     hostname: oauth2-proxy
     volumes:
@@ -34,7 +33,7 @@ services:
   # Reverse proxy
   gateway:
     container_name: traefik
-    image: traefik:v2.11.29
+    image: traefik:2.4.2
     volumes:
       - "./traefik:/etc/traefik"
     ports:

contrib/local-environment/docker-compose.yaml

@@ -13,7 +13,7 @@ version: '3.0'
 services:
   oauth2-proxy:
     container_name: oauth2-proxy
-    image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
+    image: quay.io/oauth2-proxy/oauth2-proxy:v7.6.0
     command: --config /oauth2-proxy.cfg
     hostname: oauth2-proxy
     volumes:
@@ -29,14 +29,14 @@ services:
       - httpbin
   dex:
     container_name: dex
-    image: ghcr.io/dexidp/dex:v2.44.0
+    image: ghcr.io/dexidp/dex:v2.30.3
     command: dex serve /dex.yaml
     hostname: dex
     volumes:
       - "./dex.yaml:/dex.yaml"
     restart: unless-stopped
     ports:
-      - 5556:5556/tcp
+      - 4190:4190/tcp
     networks:
       dex:
         aliases:
@@ -47,12 +47,15 @@ services:
   httpbin:
     container_name: httpbin
     image: kennethreitz/httpbin
-    ports: []
+    ports:
+      - 8080:80/tcp
     networks:
-      httpbin: {}
+      httpbin:
+        aliases:
+          - httpbin.localtest.me
   etcd:
     container_name: etcd
-    image: gcr.io/etcd-development/etcd:v3.6.5
+    image: gcr.io/etcd-development/etcd:v3.4.7
     entrypoint: /usr/local/bin/etcd
     command:
       - --listen-client-urls=http://0.0.0.0:2379

contrib/local-environment/keycloak/master-users-0.json

@@ -0,0 +1,27 @@
+{
+  "realm" : "master",
+  "users" : [ {
+    "id" : "3356c0a0-d4d5-4436-9c5a-2299c71c08ec",
+    "createdTimestamp" : 1591297959169,
+    "username" : "admin@example.com",
+    "email" : "admin@example.com",
+    "enabled" : true,
+    "totp" : false,
+    "emailVerified" : true,
+    "credentials" : [ {
+      "id" : "a1a06ecd-fdc0-4e67-92cd-2da22d724e32",
+      "type" : "password",
+      "createdDate" : 1591297959315,
+      "secretData" : "{\"value\":\"6rt5zuqHVHopvd0FTFE0CYadXTtzY0mDY2BrqnNQGS51/7DfMJeGgj0roNnGMGvDv30imErNmiSOYl+cL9jiIA==\",\"salt\":\"LI0kqr09JB7J9wvr2Hxzzg==\"}",
+      "credentialData" : "{\"hashIterations\":27500,\"algorithm\":\"pbkdf2-sha256\"}"
+    } ],
+    "disableableCredentialTypes" : [ ],
+    "requiredActions" : [ ],
+    "realmRoles" : [ "offline_access", "admin", "uma_authorization" ],
+    "clientRoles" : {
+      "account" : [ "view-profile", "manage-account" ]
+    },
+    "notBefore" : 0,
+    "groups" : [ ]
+  } ]
+}

contrib/local-environment/keycloak/oauth2-proxy-users-0.json

@@ -1,38 +0,0 @@
-{
-  "realm": "oauth2-proxy",
-  "users": [
-    {
-      "id": "3356c0a0-d4d5-4436-9c5a-2299c71c08ec",
-      "createdTimestamp": 1591297959169,
-      "username": "admin@example.com",
-      "email": "admin@example.com",
-      "enabled": true,
-      "totp": false,
-      "emailVerified": true,
-      "credentials": [
-        {
-          "id": "a1a06ecd-fdc0-4e67-92cd-2da22d724e32",
-          "type": "password",
-          "createdDate": 1591297959315,
-          "secretData": "{\"value\":\"6rt5zuqHVHopvd0FTFE0CYadXTtzY0mDY2BrqnNQGS51/7DfMJeGgj0roNnGMGvDv30imErNmiSOYl+cL9jiIA==\",\"salt\":\"LI0kqr09JB7J9wvr2Hxzzg==\"}",
-          "credentialData": "{\"hashIterations\":27500,\"algorithm\":\"pbkdf2-sha256\"}"
-        }
-      ],
-      "disableableCredentialTypes": [],
-      "requiredActions": [],
-      "realmRoles": [
-        "offline_access",
-        "admin",
-        "uma_authorization"
-      ],
-      "clientRoles": {
-        "account": [
-          "view-profile",
-          "manage-account"
-        ]
-      },
-      "notBefore": 0,
-      "groups": []
-    }
-  ]
-}

contrib/local-environment/kubernetes/Chart.lock

@@ -1,15 +1,15 @@
 dependencies:
 - name: dex
-  repository: https://charts.dexidp.io
-  version: 0.24.0
+  repository: https://charts.helm.sh/stable
+  version: 2.11.0
 - name: oauth2-proxy
-  repository: https://oauth2-proxy.github.io/manifests
-  version: 7.18.0
+  repository: https://charts.helm.sh/stable
+  version: 3.1.0
 - name: httpbin
   repository: https://conservis.github.io/helm-charts
-  version: 1.1.0
+  version: 1.0.1
 - name: hello-world
   repository: https://conservis.github.io/helm-charts
-  version: 1.1.0
-digest: sha256:fee913531bfb67e5555e995d8fb040c330e6eb4b5a8c777ceb9841135ea9bb84
-generated: "2025-10-28T06:46:35.38300324Z"
+  version: 1.0.1
+digest: sha256:e325948ece1706bd9d9e439568985db41e9a0d57623d0f9638249cb0d23821b8
+generated: "2020-11-23T11:45:07.908898-08:00"

contrib/local-environment/kubernetes/Chart.yaml

@@ -1,18 +1,19 @@
 apiVersion: v2
 description: K8S example based on https://kind.sigs.k8s.io
 name: kubernetes
+version: 5.1.1
+appVersion: 5.1.1
 dependencies:
   - name: dex
-    version: 0.24.0
-    repository: https://charts.dexidp.io
+    version: 2.11.0
+    repository: https://charts.helm.sh/stable
   - name: oauth2-proxy
-    version: &chartVersion 7.18.0
-    repository: https://oauth2-proxy.github.io/manifests
+    version: 3.1.0
+    repository: https://charts.helm.sh/stable
   # https://github.com/postmanlabs/httpbin/issues/549 is still in progress, for now using a non-official chart
   - name: httpbin
-    version: 1.1.0
+    version: 1.0.1
     repository: https://conservis.github.io/helm-charts
   - name: hello-world
-    version: 1.1.0
+    version: 1.0.1
     repository: https://conservis.github.io/helm-charts
-version: *chartVersion

contrib/local-environment/kubernetes/Makefile

@@ -30,13 +30,15 @@ delete-cluster:
 	kind delete cluster --name oauth2-proxy
 
 .PHONY: deploy
-deploy: helm-deploy
+deploy:
+	kubectl apply -f oauth2-proxy-example-full.yaml
 	kubectl rollout status --timeout 5m deployment/oauth2-proxy-example-oauth2-proxy-sample
 	kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-httpbin
 	kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-hello-world
 
 .PHONY: undeploy
-undeploy: helm-undeploy
+undeploy:
+	kubectl delete -f oauth2-proxy-example-full.yaml
 
 ######################
 ###### HELM CMDs #####
@@ -57,3 +59,9 @@ helm-deploy: helm-init
 .PHONY: helm-undeploy
 helm-undeploy:
 	helm del oauth2-proxy-example
+
+# creates K8S manifest from helm chart
+.PHONY: helm-create-manifest
+helm-create-manifest: helm-init
+	echo "# WARNING: This file is auto-generated by 'make helm-create-manifest'! DO NOT EDIT MANUALLY!" > oauth2-proxy-example-full.yaml
+	helm template --namespace default oauth2-proxy-example . >> oauth2-proxy-example-full.yaml

contrib/local-environment/kubernetes/README.md

@@ -8,15 +8,16 @@ Before you start:
 _Required_
 * install [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
 * install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
-* install [helm](https://helm.sh/docs/intro/quickstart/#install-helm).
+
+_Optional_
+* install [helm 3](https://helm.sh/docs/intro/quickstart/#install-helm).
 
 Then: 
 
 * `make create-cluster`
-* `make deploy`
+* `make deploy` OR `make helm-deploy` for helm
 
 Visit http://httpbin.localtest.me or http://hello-world.localtest.me/
-Note: When accessing the service for the first time you will need to authenticate with Dex. It is configured using static credentials for testing. With username `admin@example.com` and password set to `password`.
 
 ## Uninstall
 

contrib/local-environment/kubernetes/custom-dns.yaml

@@ -1,8 +1,4 @@
 apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: coredns
-  namespace: kube-system
 data:
   Corefile: |
     .:53 {
@@ -28,3 +24,7 @@ data:
             fallthrough
         }
     }
+kind: ConfigMap
+metadata:
+  name: coredns
+  namespace: kube-system

contrib/local-environment/kubernetes/kind-cluster.yaml

@@ -1,5 +1,5 @@
-apiVersion: kind.x-k8s.io/v1alpha4
 kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
 nodes:
   - role: control-plane
     kubeadmConfigPatches:

contrib/local-environment/kubernetes/oauth2-proxy-example-full.yaml

@@ -0,0 +1,564 @@
+# WARNING: This file is auto-generated by 'make helm-create-manifest'! DO NOT EDIT MANUALLY!
+---
+# Source: kubernetes/charts/dex/templates/serviceaccount.yaml
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  labels:
+    app.kubernetes.io/name: dex
+    helm.sh/chart: dex-2.11.0
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "2.23.0"
+    app.kubernetes.io/managed-by: Helm
+  name: oauth2-proxy-example-dex
+---
+# Source: kubernetes/charts/hello-world/templates/serviceaccount.yaml
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: oauth2-proxy-example-hello-world
+  labels:
+    helm.sh/chart: hello-world-1.0.1
+    app.kubernetes.io/name: hello-world
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "1.0.0"
+    app.kubernetes.io/managed-by: Helm
+---
+# Source: kubernetes/charts/httpbin/templates/serviceaccount.yaml
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: oauth2-proxy-example-httpbin
+  labels:
+    helm.sh/chart: httpbin-1.0.1
+    app.kubernetes.io/name: httpbin
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "latest"
+    app.kubernetes.io/managed-by: Helm
+---
+# Source: kubernetes/charts/oauth2-proxy/templates/serviceaccount.yaml
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  labels:
+    app: oauth2-proxy-sample
+    chart: oauth2-proxy-3.1.0
+    release: oauth2-proxy-example
+    heritage: Helm
+  name: oauth2-proxy-example-oauth2-proxy-sample
+---
+# Source: kubernetes/charts/dex/templates/secret.yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  labels:
+    app.kubernetes.io/name: dex
+    helm.sh/chart: dex-2.11.0
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "2.23.0"
+    app.kubernetes.io/managed-by: Helm
+  name: oauth2-proxy-example-dex
+stringData:
+  config.yaml: |-
+    issuer: http://dex.localtest.me
+    storage:
+      config:
+        inCluster: true
+      type: kubernetes
+    logger:
+      level: debug
+    web:
+      http: 0.0.0.0:5556
+    oauth2: 
+      alwaysShowLoginScreen: false
+      skipApprovalScreen: true
+    staticClients:
+    - id: oauth2-proxy
+      name: OAuth2 Proxy
+      redirectURIs:
+      - http://oauth2-proxy.localtest.me/oauth2/callback
+      secret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK
+    enablePasswordDB: true
+    staticPasswords:
+    - email: admin@example.com
+      hash: $2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W
+      userID: 08a8684b-db88-4b73-90a9-3cd1661f5466
+      username: admin
+    expiry:
+      idTokens: 1h
+      signingKeys: 4h
+---
+# Source: kubernetes/charts/oauth2-proxy/templates/configmap.yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  labels:
+    app: oauth2-proxy-sample
+    chart: oauth2-proxy-3.1.0
+    heritage: Helm
+    release: oauth2-proxy-example
+  name: oauth2-proxy-example-oauth2-proxy-sample
+data:
+  oauth2_proxy.cfg: "cookie_secret=\"OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w=\"\ncookie_domain=\".localtest.me\"\nwhitelist_domains=[\".localtest.me\"]\n# only users with this domain will be let in\nemail_domains=[\"example.com\"]\n\nclient_id=\"oauth2-proxy\"\nclient_secret=\"b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK\"\ncookie_secure=\"false\"\n\nredirect_url=\"http://oauth2-proxy.localtest.me/oauth2/callback\"\n\n# we don't want to proxy anything so pick a non-existent directory\nupstreams = [ \"file:///dev/null\" ]\n\n# return authenticated user to nginx\nset_xauthrequest = true\n# using http://dex.localtest.me/.well-known/openid-configuration oauth2-proxy will populate\n# login_url, redeem_url, and oidc_jwks_url\nprovider=\"oidc\"\noidc_issuer_url=\"http://dex.localtest.me\""
+---
+# Source: kubernetes/charts/dex/templates/clusterrole.yaml
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    app.kubernetes.io/name: dex
+    helm.sh/chart: dex-2.11.0
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "2.23.0"
+    app.kubernetes.io/managed-by: Helm
+  name: oauth2-proxy-example-dex
+rules:
+- apiGroups: ["dex.coreos.com"] # API group created by dex
+  resources: ["*"]
+  verbs: ["*"]
+- apiGroups: ["apiextensions.k8s.io"]
+  resources: ["customresourcedefinitions"]
+  verbs: ["create"] # To manage its own resources, dex must be able to create customresourcedefinitions
+---
+# Source: kubernetes/charts/dex/templates/clusterrolebinding.yaml
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  labels:
+    app.kubernetes.io/name: dex
+    helm.sh/chart: dex-2.11.0
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "2.23.0"
+    app.kubernetes.io/managed-by: Helm
+  name: oauth2-proxy-example-dex
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: oauth2-proxy-example-dex
+subjects:
+  - kind: ServiceAccount
+    name: oauth2-proxy-example-dex
+    namespace: default
+---
+# Source: kubernetes/charts/dex/templates/service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: oauth2-proxy-example-dex
+  labels:
+    app.kubernetes.io/name: dex
+    helm.sh/chart: dex-2.11.0
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "2.23.0"
+    app.kubernetes.io/managed-by: Helm
+spec:
+  type: ClusterIP
+  sessionAffinity: None
+  ports:
+  - name: http
+    targetPort: http
+    port: 32000
+  selector:
+    app.kubernetes.io/name: dex
+    app.kubernetes.io/instance: oauth2-proxy-example
+---
+# Source: kubernetes/charts/hello-world/templates/service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: oauth2-proxy-example-hello-world
+  labels:
+    helm.sh/chart: hello-world-1.0.1
+    app.kubernetes.io/name: hello-world
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "1.0.0"
+    app.kubernetes.io/managed-by: Helm
+spec:
+  type: ClusterIP
+  ports:
+    - port: 9080
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    app.kubernetes.io/name: hello-world
+    app.kubernetes.io/instance: oauth2-proxy-example
+---
+# Source: kubernetes/charts/httpbin/templates/service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: oauth2-proxy-example-httpbin
+  labels:
+    helm.sh/chart: httpbin-1.0.1
+    app.kubernetes.io/name: httpbin
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "latest"
+    app.kubernetes.io/managed-by: Helm
+spec:
+  type: ClusterIP
+  ports:
+    - port: 80
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    app.kubernetes.io/name: httpbin
+    app.kubernetes.io/instance: oauth2-proxy-example
+---
+# Source: kubernetes/charts/oauth2-proxy/templates/service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app: oauth2-proxy-sample
+    chart: oauth2-proxy-3.1.0
+    release: oauth2-proxy-example
+    heritage: Helm
+  name: oauth2-proxy-example-oauth2-proxy-sample
+spec:
+  type: ClusterIP
+  ports:
+    - port: 80
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    app: oauth2-proxy-sample
+    release: oauth2-proxy-example
+---
+# Source: kubernetes/charts/dex/templates/deployment.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: oauth2-proxy-example-dex
+  labels:
+    app.kubernetes.io/name: dex
+    helm.sh/chart: dex-2.11.0
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "2.23.0"
+    app.kubernetes.io/managed-by: Helm
+    app.kubernetes.io/component: dex
+spec:
+  replicas: 1
+  strategy:
+    rollingUpdate:
+      maxSurge: 0
+      maxUnavailable: 1
+    type: RollingUpdate
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: dex
+      app.kubernetes.io/instance: oauth2-proxy-example
+      app.kubernetes.io/component: dex
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: dex
+        app.kubernetes.io/instance: oauth2-proxy-example
+        app.kubernetes.io/component: dex
+      annotations:
+        checksum/config: 185f32cfabdf4f7467868dc301d4bd33e68951e12eddeb69f23ebc1d0f91ba28
+    spec:
+      serviceAccountName: oauth2-proxy-example-dex
+      nodeSelector:
+          {}
+      containers:
+      - name: main
+        image: "quay.io/dexidp/dex:v2.23.0"
+        imagePullPolicy: IfNotPresent
+        command:
+        - /usr/local/bin/dex
+        - serve
+        - /etc/dex/cfg/config.yaml
+        resources:
+          null
+        ports:
+        - name: http
+          containerPort: 5556
+          protocol: TCP
+        livenessProbe:
+          httpGet:
+            path: /healthz
+            port: http
+          initialDelaySeconds: 1
+          periodSeconds: 10
+          timeoutSeconds: 1
+          failureThreshold: 1
+        readinessProbe:
+          httpGet:
+            path: /healthz
+            port: http
+          initialDelaySeconds: 1
+          periodSeconds: 10
+          timeoutSeconds: 1
+          failureThreshold: 1
+        env:
+          []
+        volumeMounts:
+        - mountPath: /etc/dex/cfg
+          name: config
+      volumes:
+      - secret:
+          defaultMode: 420
+          items:
+          - key: config.yaml
+            path: config.yaml
+          secretName: oauth2-proxy-example-dex
+        name: config
+---
+# Source: kubernetes/charts/hello-world/templates/deployment.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: oauth2-proxy-example-hello-world
+  labels:
+    helm.sh/chart: hello-world-1.0.1
+    app.kubernetes.io/name: hello-world
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "1.0.0"
+    app.kubernetes.io/managed-by: Helm
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: hello-world
+      app.kubernetes.io/instance: oauth2-proxy-example
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: hello-world
+        app.kubernetes.io/instance: oauth2-proxy-example
+    spec:
+      serviceAccountName: oauth2-proxy-example-hello-world
+      securityContext:
+        {}
+      containers:
+        - name: hello-world
+          securityContext:
+            {}
+          image: "conservis/hello-world:1.0.0"
+          imagePullPolicy: IfNotPresent
+          ports:
+            - name: http
+              containerPort: 9080
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {}
+---
+# Source: kubernetes/charts/httpbin/templates/deployment.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: oauth2-proxy-example-httpbin
+  labels:
+    helm.sh/chart: httpbin-1.0.1
+    app.kubernetes.io/name: httpbin
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "latest"
+    app.kubernetes.io/managed-by: Helm
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: httpbin
+      app.kubernetes.io/instance: oauth2-proxy-example
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: httpbin
+        app.kubernetes.io/instance: oauth2-proxy-example
+    spec:
+      serviceAccountName: oauth2-proxy-example-httpbin
+      securityContext:
+        {}
+      containers:
+        - name: httpbin
+          securityContext:
+            {}
+          image: "kennethreitz/httpbin:latest"
+          imagePullPolicy: IfNotPresent
+          ports:
+            - name: http
+              containerPort: 80
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {}
+---
+# Source: kubernetes/charts/oauth2-proxy/templates/deployment.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app: oauth2-proxy-sample
+    chart: oauth2-proxy-3.1.0
+    heritage: Helm
+    release: oauth2-proxy-example
+  name: oauth2-proxy-example-oauth2-proxy-sample
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: oauth2-proxy-sample
+      release: oauth2-proxy-example
+  template:
+    metadata:
+      annotations:
+        checksum/config: 5d8892a7b1d9eb03f9d59b787ce339b374fa2be51991e4e7533cb0a541984fac
+        checksum/config-emails: 01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b
+        checksum/secret: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+        checksum/google-secret: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      labels:
+        app: oauth2-proxy-sample
+        release: "oauth2-proxy-example"
+    spec:
+      serviceAccountName: oauth2-proxy-example-oauth2-proxy-sample
+      containers:
+      - name: oauth2-proxy
+        image: "quay.io/pusher/oauth2_proxy:v5.1.0"
+        imagePullPolicy: IfNotPresent
+        args:
+          - --http-address=0.0.0.0:4180
+          - --config=/etc/oauth2_proxy/oauth2_proxy.cfg
+        ports:
+          - containerPort: 4180
+            name: http
+            protocol: TCP
+        livenessProbe:
+          httpGet:
+            path: /ping
+            port: http
+            scheme: HTTP
+          initialDelaySeconds: 0
+          timeoutSeconds: 1
+        readinessProbe:
+          httpGet:
+            path: /ready
+            port: http
+            scheme: HTTP
+          initialDelaySeconds: 0
+          timeoutSeconds: 5
+          successThreshold: 1
+          periodSeconds: 10
+        resources:
+          {}
+        volumeMounts:
+        - mountPath: /etc/oauth2_proxy
+          name: configmain
+      volumes:
+      - configMap:
+          defaultMode: 420
+          name: oauth2-proxy-example-oauth2-proxy-sample
+        name: configmain
+      tolerations:
+        []
+---
+# Source: kubernetes/charts/dex/templates/ingress.yaml
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: oauth2-proxy-example-dex
+  labels:
+    app.kubernetes.io/name: dex
+    helm.sh/chart: dex-2.11.0
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "2.23.0"
+    app.kubernetes.io/managed-by: Helm
+spec:
+  rules:
+    - host: "dex.localtest.me"
+      http:
+        paths:
+          - path: /
+            backend:
+              serviceName: oauth2-proxy-example-dex
+              servicePort: 32000
+---
+# Source: kubernetes/charts/hello-world/templates/ingress.yaml
+apiVersion: networking.k8s.io/v1beta1
+kind: Ingress
+metadata:
+  name: oauth2-proxy-example-hello-world
+  labels:
+    helm.sh/chart: hello-world-1.0.1
+    app.kubernetes.io/name: hello-world
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "1.0.0"
+    app.kubernetes.io/managed-by: Helm
+  annotations:
+    nginx.ingress.kubernetes.io/auth-response-headers: X-Auth-Request-User,X-Auth-Request-Email
+    nginx.ingress.kubernetes.io/auth-signin: http://oauth2-proxy.localtest.me/oauth2/start
+    nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy-example-oauth2-proxy-sample.default.svc.cluster.local/oauth2/auth
+spec:
+  rules:
+    - host: hello-world.localtest.me
+      http:
+        paths:
+          - path: /
+            backend:
+              serviceName: oauth2-proxy-example-hello-world
+              servicePort: 9080
+---
+# Source: kubernetes/charts/httpbin/templates/ingress.yaml
+apiVersion: networking.k8s.io/v1beta1
+kind: Ingress
+metadata:
+  name: oauth2-proxy-example-httpbin
+  labels:
+    helm.sh/chart: httpbin-1.0.1
+    app.kubernetes.io/name: httpbin
+    app.kubernetes.io/instance: oauth2-proxy-example
+    app.kubernetes.io/version: "latest"
+    app.kubernetes.io/managed-by: Helm
+  annotations:
+    nginx.ingress.kubernetes.io/auth-response-headers: X-Auth-Request-User,X-Auth-Request-Email
+    nginx.ingress.kubernetes.io/auth-signin: http://oauth2-proxy.localtest.me/oauth2/start
+    nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy-example-oauth2-proxy-sample.default.svc.cluster.local/oauth2/auth
+spec:
+  rules:
+    - host: httpbin.localtest.me
+      http:
+        paths:
+          - path: /
+            backend:
+              serviceName: oauth2-proxy-example-httpbin
+              servicePort: 80
+---
+# Source: kubernetes/charts/oauth2-proxy/templates/ingress.yaml
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  labels:
+    app: oauth2-proxy-sample
+    chart: oauth2-proxy-3.1.0
+    heritage: Helm
+    release: oauth2-proxy-example
+  name: oauth2-proxy-example-oauth2-proxy-sample
+  annotations:
+    nginx.ingress.kubernetes.io/server-snippet: |
+      large_client_header_buffers 4 32k;
+spec:
+  rules:
+    - host: oauth2-proxy.localtest.me
+      http:
+        paths:
+          - path: /
+            backend:
+              serviceName: oauth2-proxy-example-oauth2-proxy-sample
+              servicePort: 80

contrib/local-environment/kubernetes/values.yaml

@@ -2,12 +2,8 @@ dex:
   ingress:
     enabled: true
     hosts:
-      - host: dex.localtest.me
-        paths:
-        - path: /
-          pathType: ImplementationSpecific
-  grpc: 
-    enabled: false
+      - dex.localtest.me
+  grpc: false
   certs:
     grpc:
       create: false
@@ -16,11 +12,6 @@ dex:
 
   config:
     issuer: http://dex.localtest.me
-    storage:
-      type: kubernetes
-      config:
-        inCluster: true
-    enablePasswordDB: true
     expiry:
       signingKeys: "4h"
       idTokens: "1h"
@@ -44,6 +35,9 @@ oauth2-proxy:
     enabled: true
     hosts:
       - oauth2-proxy.localtest.me
+    annotations:
+      nginx.ingress.kubernetes.io/server-snippet: |
+        large_client_header_buffers 4 32k;
   # pick up client_id and client_secret from configFile as opposed to helm .Values.config.clientID and .Values.config.clientSecret
   proxyVarsAsSecrets: false
   config:

contrib/local-environment/oauth2-proxy-alpha-config.yaml

@@ -20,4 +20,4 @@ providers:
   clientSecret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK
   clientID: oauth2-proxy
   oidcConfig:
-    issuerURL: http://dex.localhost:5556/dex
+    issuerURL: http://dex.localhost:4190/dex

contrib/local-environment/oauth2-proxy-keycloak.cfg

@@ -2,8 +2,8 @@ http_address="0.0.0.0:4180"
 cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
 email_domains="example.com"
 cookie_secure="false"
-upstreams="http://httpbin"
-cookie_domains=["oauth2-proxy.localtest.me:4080", "keycloak.localtest.me:9080"] # Required so cookie can be read on all subdomains.
+upstreams="http://httpbin.localtest.me:8080"
+cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.
 whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.
 
 # keycloak provider
@@ -12,7 +12,7 @@ client_id="oauth2-proxy"
 redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"
 
 # in this case oauth2-proxy is going to visit
-# http://keycloak.localtest.me:9080/realms/oauth2-proxy/.well-known/openid-configuration for configuration
-oidc_issuer_url="http://keycloak.localtest.me:9080/realms/oauth2-proxy"
+# http://keycloak.localtest.me:9080/auth/realms/master/.well-known/openid-configuration for configuration
+oidc_issuer_url="http://keycloak.localtest.me:9080/auth/realms/master"
 provider="oidc"
 provider_display_name="Keycloak"

contrib/local-environment/oauth2-proxy-nginx.cfg

@@ -2,7 +2,7 @@ http_address="0.0.0.0:4180"
 cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
 provider="oidc"
 email_domains="example.com"
-oidc_issuer_url="http://dex.localtest.me:5556/dex"
+oidc_issuer_url="http://dex.localtest.me:4190/dex"
 client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
 client_id="oauth2-proxy"
 cookie_secure="false"

contrib/local-environment/oauth2-proxy-traefik.cfg

@@ -2,7 +2,7 @@ http_address="0.0.0.0:4180"
 cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
 provider="oidc"
 email_domains=["example.com"]
-oidc_issuer_url="http://dex.localhost:5556/dex"
+oidc_issuer_url="http://dex.localhost:4190/dex"
 client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
 client_id="oauth2-proxy"
 cookie_secure="false"
@@ -13,7 +13,7 @@ whitelist_domains=".oauth2-proxy.localhost" # Required to allow redirection back
 
 # Mandatory option when using oauth2-proxy with traefik
 reverse_proxy="true"
-# Required for traefik with ForwardAuth and static upstream configuration
+# Required for traefik with ForwardAuth and static upstream configuration 
 upstreams="static://202"
 # The following option skip the page requesting the user
 # to click on a button to be redirected to the identity provider

contrib/local-environment/oauth2-proxy.cfg

@@ -2,7 +2,7 @@ http_address="0.0.0.0:4180"
 cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
 email_domains="example.com"
 cookie_secure="false"
-upstreams="http://httpbin"
+upstreams="http://httpbin.localtest.me:8080"
 cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.
 whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.
 
@@ -11,6 +11,6 @@ client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
 client_id="oauth2-proxy"
 redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"
 
-oidc_issuer_url="http://dex.localtest.me:5556/dex"
+oidc_issuer_url="http://dex.localtest.me:4190/dex"
 provider="oidc"
 provider_display_name="Dex"

contrib/oauth2-proxy.cfg.example

@@ -52,10 +52,6 @@
 # client_id = "123456.apps.googleusercontent.com"
 # client_secret = ""
 
-## Scopes Added to the request
-## It has the same behavior as the --scope flag
-# scope = "openid email profile"
-
 ## Pass OAuth Access token to upstream via "X-Forwarded-Access-Token"
 # pass_access_token = false
 

contrib/oauth2-proxy.service.example

@@ -1,33 +1,22 @@
+# Systemd service file for oauth2-proxy daemon
+#
+# Date: Feb 9, 2016
+# Author: Srdjan Grubor <sgnn7@sgnn7.org>
+
 [Unit]
 Description=oauth2-proxy daemon service
-After=network.target network-online.target nss-lookup.target basic.target
-Wants=network-online.target nss-lookup.target
-StartLimitIntervalSec=30
-StartLimitBurst=3
+After=syslog.target network.target
 
 [Service]
-User=oauth2-proxy
-Group=oauth2-proxy
-Restart=on-failure
-RestartSec=30
-WorkingDirectory=/etc/oauth2-proxy
-ExecStart=/usr/bin/oauth2-proxy --config=/etc/oauth2-proxy/oauth2-proxy.cfg
+# www-data group and user need to be created before using these lines
+User=www-data
+Group=www-data
+
+ExecStart=/usr/local/bin/oauth2-proxy --config=/etc/oauth2-proxy.cfg
 ExecReload=/bin/kill -HUP $MAINPID
-LimitNOFILE=65535
-NoNewPrivileges=true
-ProtectHome=true
-ProtectSystem=full
-ProtectHostname=true
-ProtectControlGroups=true
-ProtectKernelModules=true
-ProtectKernelTunables=true
-LockPersonality=true
-RestrictRealtime=yes
-RestrictNamespaces=yes
-MemoryDenyWriteExecute=yes
-PrivateDevices=yes
-PrivateTmp=true
-CapabilityBoundingSet=
+
+KillMode=process
+Restart=always
 
 [Install]
 WantedBy=multi-user.target

dist.sh

@@ -16,7 +16,6 @@ ARCHS=(
   linux-armv6
   linux-armv7
   linux-ppc64le
-  linux-s390x
   freebsd-amd64
   windows-amd64
 )
@@ -33,12 +32,10 @@ for ARCH in "${ARCHS[@]}"; do
 	# Create architecture specific binaries
 	if [[ ${GO_ARCH} == armv* ]]; then
 	  GO_ARM=$(echo $GO_ARCH | awk -Fv '{print $2}')
-		GO111MODULE=on GOOS=${GO_OS} GOARCH=arm GOARM=${GO_ARM} CGO_ENABLED=0 go build \
-			-ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" \
+		GO111MODULE=on GOOS=${GO_OS} GOARCH=arm GOARM=${GO_ARM} CGO_ENABLED=0 go build -ldflags="-X main.VERSION=${VERSION}" \
 			-o release/${BINARY}-${VERSION}.${ARCH}/${BINARY} .
 	else
-		GO111MODULE=on GOOS=${GO_OS} GOARCH=${GO_ARCH} CGO_ENABLED=0 go build \
-			-ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" \
+		GO111MODULE=on GOOS=${GO_OS} GOARCH=${GO_ARCH} CGO_ENABLED=0 go build -ldflags="-X main.VERSION=${VERSION}" \
 			-o release/${BINARY}-${VERSION}.${ARCH}/${BINARY} .
 	fi
 

docs/.gitignore

@@ -1,8 +1,5 @@
 # Dependencies
 /node_modules
-package-lock.json
-pnpm-lock.yaml
-yarn.lock
 
 # Production
 /build

docs/README.md

@@ -19,7 +19,7 @@ This command starts a local development server and open up a browser window. Mos
 ## Build
 
 ```console
-npm run build
+npm build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.

docs/docs/community/contribution.md

@@ -15,9 +15,7 @@ We suggest using [Visual Studio Code](https://code.visualstudio.com/docs/languag
 
 # Go version
 
-See the `go.mod` file in the root of this repository for the version of Go used by this project.
-You can follow [the installation guide for Go](https://go.dev/doc/install),
-and you can find this specific Go version on [the Go downloads page](https://go.dev/dl/).
+This project is currently still using go 1.19. You can follow the installation guide for go [here.](https://go.dev/doc/install) And you can find go version 1.19 in the archived section [here.](https://go.dev/dl/)
 
 # Preparing your fork
 Clone your fork, create a feature branch and update the depedencies to get started.
@@ -46,7 +44,7 @@ For starting oauth2-proxy locally open the debugging tab and create the `launch.
             "program": "${workspaceFolder}",
             "args": [
                 "--config",
-                // The following configuration contains settings for a locally deployed
+                // The following configuration contains settings for a locally deployed 
                 // upstream and dex as an idetity provider
                 "contrib/local-environment/oauth2-proxy.cfg"
             ]
@@ -59,7 +57,7 @@ For starting oauth2-proxy locally open the debugging tab and create the `launch.
             "program": "${workspaceFolder}",
             "args": [
                 "--config",
-                // The following configuration contains settings for a locally deployed
+                // The following configuration contains settings for a locally deployed 
                 // upstream and keycloak as an idetity provider
                 "contrib/local-environment/oauth2-proxy-keycloak.cfg"
             ]
@@ -70,22 +68,11 @@ For starting oauth2-proxy locally open the debugging tab and create the `launch.
 
 Before you can start your local version of oauth2-proxy, you will have to use the provided docker compose files to start a local upstream service and identity provider. We suggest using [httpbin](https://hub.docker.com/r/kennethreitz/httpbin) as your upstream for testing as it allows for request and response introspection of all things HTTP.
 
-Inside the `contrib/local-environment` directory you can use the `Makefile` for
-starting different example setups:
+Open a terminal and switch to the `contrib/local-environment` directory.
 
-- Dex as your IdP: `make up` or `make down`
-- Dex as your IdP using the alpha-config: `make alpha-config-up`
-- Keycloak as your IdP: `make keycloak-up`
-- Dex as your IdP & nginx reverse proxy: `make nginx-up`
-- and many more...
+- Dex as your IdP: `docker compose -f docker-compose.yaml up dex etcd httpbin`
+- Keycloak as your IdP: `docker compose -f docker-compose-keycloak.yaml up keycloak httpbin`
 
-Check out the `Makefile` to see what is available.
-
-The username and password for all setups is usually `admin@example.com` and `password`.
-
-The docker compose setups expose the services with a dynamic reverse DNS resolver: localtest.me
-
-- OAuth2-Proxy: http://oauth2-proxy.localtest.me:4180
-- Upstream: http://httpbin.localtest.me:8080
-- Dex: http://dex.localtest.me:5556
+The username for both is `admin@example.com` and password is `password`.
 
+Start oauth2-proxy from the debug tab and open http://oauth2-proxy.localtest.me:4180/ for testing.

docs/docs/configuration/alpha_config.md

@@ -137,7 +137,6 @@ You must remove these options before starting OAuth2 Proxy with `--alpha-config`
 :::
 
 ## Configuration Reference
-
 <!--- THIS FILE IS AUTOGENERATED!!! DO NOT EDIT!!! -->
 
 ### ADFSOptions
@@ -168,7 +167,7 @@ They may change between releases without notice.
 | `injectResponseHeaders` | _[[]Header](#header)_ | InjectResponseHeaders is used to configure headers that should be added<br/>to responses from the proxy.<br/>This is typically used when using the proxy as an external authentication<br/>provider in conjunction with another proxy such as NGINX and its<br/>auth_request module.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
 | `server` | _[Server](#server)_ | Server is used to configure the HTTP(S) server for the proxy application.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
 | `metricsServer` | _[Server](#server)_ | MetricsServer is used to configure the HTTP(S) server for metrics.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
-| `providers` | _[Providers](#providers)_ | Providers is used to configure your provider. **Multiple-providers is not<br/>yet working.** [This feature is tracked in<br/>#925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926) |
+| `providers` | _[Providers](#providers)_ | Providers is used to configure multiple providers. |
 
 ### AzureOptions
 
@@ -200,7 +199,7 @@ ClaimSource allows loading a header value from a claim within the session
 
 | Field | Type | Description |
 | ----- | ---- | ----------- |
-| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. Available claims: `access_token` `id_token` `created_at`<br/>`expires_on` `refresh_token` `email` `user` `groups` `preferred_username`. |
+| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. |
 | `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |
 | `basicAuthPassword` | _[SecretSource](#secretsource)_ | BasicAuthPassword converts this claim into a basic auth header.<br/>Note the value of claim will become the basic auth username and the<br/>basicAuthPassword will be used as the password value. |
 
@@ -214,6 +213,7 @@ A duration string is a is a possibly signed sequence of decimal numbers,
 each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".
 Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
 
+
 ### GitHubOptions
 
 (**Appears on:** [Provider](#provider))
@@ -278,7 +278,7 @@ make up the header value
 | `value` | _[]byte_ | Value expects a base64 encoded string value. |
 | `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |
 | `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |
-| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. Available claims: `access_token` `id_token` `created_at`<br/>`expires_on` `refresh_token` `email` `user` `groups` `preferred_username`. |
+| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. |
 | `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |
 | `basicAuthPassword` | _[SecretSource](#secretsource)_ | BasicAuthPassword converts this claim into a basic auth header.<br/>Note the value of claim will become the basic auth username and the<br/>basicAuthPassword will be used as the password value. |
 
@@ -385,17 +385,6 @@ character.
 | `default` | _[]string_ |  _(Optional)_ Default specifies a default value or values that will be<br/>passed to the IdP if not overridden. |
 | `allow` | _[[]URLParameterRule](#urlparameterrule)_ |  _(Optional)_ Allow specifies rules about how the default (if any) may be<br/>overridden via the query string to `/oauth2/start`.  Only<br/>values that match one or more of the allow rules will be<br/>forwarded to the IdP. |
 
-### MicrosoftEntraIDOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `allowedTenants` | _[]string_ | AllowedTenants is a list of allowed tenants. In case of multi-tenant apps, incoming tokens are<br/>issued by different issuers and OIDC issuer verification needs to be disabled.<br/>When not specified, all tenants are allowed. Redundant for single-tenant apps<br/>(regular ID token validation matches the issuer). |
-| `federatedTokenAuth` | _bool_ | FederatedTokenAuth enable oAuth2 client authentication with federated token projected<br/>by Entra Workload Identity plugin, instead of client secret. |
-
 ### OIDCOptions
 
 (**Appears on:** [Provider](#provider))
@@ -410,7 +399,6 @@ character.
 | `insecureSkipNonce` | _bool_ | InsecureSkipNonce skips verifying the ID Token's nonce claim that must match<br/>the random nonce sent in the initial OAuth flow. Otherwise, the nonce is checked<br/>after the initial OAuth redeem & subsequent token refreshes.<br/>default set to 'true'<br/>Warning: In a future release, this will change to 'false' by default for enhanced security. |
 | `skipDiscovery` | _bool_ | SkipDiscovery allows to skip OIDC discovery and use manually supplied Endpoints<br/>default set to 'false' |
 | `jwksURL` | _string_ | JwksURL is the OpenID Connect JWKS URL<br/>eg: https://www.googleapis.com/oauth2/v3/certs |
-| `publicKeyFiles` | _[]string_ | PublicKeyFiles is a list of paths pointing to public key files in PEM format to use<br/>for verifying JWT tokens |
 | `emailClaim` | _string_ | EmailClaim indicates which claim contains the user email,<br/>default set to 'email' |
 | `groupsClaim` | _string_ | GroupsClaim indicates which claim contains the user groups<br/>default set to 'groups' |
 | `userIDClaim` | _string_ | UserIDClaim indicates which claim contains the user ID<br/>default set to 'email' |
@@ -430,7 +418,6 @@ Provider holds all configuration for a single provider
 | `clientSecretFile` | _string_ | ClientSecretFile is the name of the file<br/>containing the OAuth Client Secret, it will be used if ClientSecret is not set. |
 | `keycloakConfig` | _[KeycloakOptions](#keycloakoptions)_ | KeycloakConfig holds all configurations for Keycloak provider. |
 | `azureConfig` | _[AzureOptions](#azureoptions)_ | AzureConfig holds all configurations for Azure provider. |
-| `microsoftEntraIDConfig` | _[MicrosoftEntraIDOptions](#microsoftentraidoptions)_ | MicrosoftEntraIDConfig holds all configurations for Entra ID provider. |
 | `ADFSConfig` | _[ADFSOptions](#adfsoptions)_ | ADFSConfig holds all configurations for ADFS provider. |
 | `bitbucketConfig` | _[BitbucketOptions](#bitbucketoptions)_ | BitbucketConfig holds all configurations for Bitbucket provider. |
 | `githubConfig` | _[GitHubOptions](#githuboptions)_ | GitHubConfig holds all configurations for GitHubC provider. |
@@ -445,7 +432,6 @@ Provider holds all configuration for a single provider
 | `useSystemTrustStore` | _bool_ | UseSystemTrustStore determines if your custom CA files and the system trust store are used<br/>If set to true, your custom CA files and the system trust store are used otherwise only your custom CA files. |
 | `loginURL` | _string_ | LoginURL is the authentication endpoint |
 | `loginURLParameters` | _[[]LoginURLParameter](#loginurlparameter)_ | LoginURLParameters defines the parameters that can be passed from the start URL to the IdP login URL |
-| `authRequestResponseMode` | _string_ | AuthRequestResponseMode defines the response mode to request during authorization request |
 | `redeemURL` | _string_ | RedeemURL is the token redemption endpoint |
 | `profileURL` | _string_ | ProfileURL is the profile access endpoint |
 | `skipClaimsFromProfileURL` | _bool_ | SkipClaimsFromProfileURL allows to skip request to Profile URL for resolving claims not present in id_token<br/>default set to 'false' |
@@ -466,17 +452,15 @@ Valid options are: adfs, azure, bitbucket, digitalocean facebook, github,
 gitlab, google, keycloak, keycloak-oidc, linkedin, login.gov, nextcloud
 and oidc.
 
+
 ### Providers
 
 #### ([[]Provider](#provider) alias)
 
 (**Appears on:** [AlphaOptions](#alphaoptions))
 
-The provider can be selected using the `provider` configuration value, or
-set in the [`providers` array using
-AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).
-However, [**the feature to implement multiple providers is not
-complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
+Providers is a collection of definitions for providers.
+
 
 ### SecretSource
 
@@ -542,7 +526,7 @@ Requests will be proxied to this upstream if the path matches the request path.
 | ----- | ---- | ----------- |
 | `id` | _string_ | ID should be a unique identifier for the upstream.<br/>This value is required for all upstreams. |
 | `path` | _string_ | Path is used to map requests to the upstream server.<br/>The closest match will take precedence and all Paths must be unique.<br/>Path can also take a pattern when used with RewriteTarget.<br/>Path segments can be captured and matched using regular experessions.<br/>Eg:<br/>- `^/foo$`: Match only the explicit path `/foo`<br/>- `^/bar/$`: Match any path prefixed with `/bar/`<br/>- `^/baz/(.*)$`: Match any path prefixed with `/baz` and capture the remaining path for use with RewriteTarget |
-| `rewriteTarget` | _string_ | RewriteTarget allows users to rewrite the request path before it is sent to<br/>the upstream server (for an HTTP/HTTPS upstream) or mapped to the filesystem<br/>(for a `file:` upstream).<br/>Use the Path to capture segments for reuse within the rewrite target.<br/>Eg: With a Path of `^/baz/(.*)`, a RewriteTarget of `/foo/$1` would rewrite<br/>the request `/baz/abc/123` to `/foo/abc/123` before proxying to the<br/>upstream server.  Or if the upstream were `file:///app`, a request for<br/>`/baz/info.html` would return the contents of the file `/app/foo/info.html`. |
+| `rewriteTarget` | _string_ | RewriteTarget allows users to rewrite the request path before it is sent to<br/>the upstream server.<br/>Use the Path to capture segments for reuse within the rewrite target.<br/>Eg: With a Path of `^/baz/(.*)`, a RewriteTarget of `/foo/$1` would rewrite<br/>the request `/baz/abc/123` to `/foo/abc/123` before proxying to the<br/>upstream server. |
 | `uri` | _string_ | The URI of the upstream server. This may be an HTTP(S) server of a File<br/>based URL. It may include a path, in which case all requests will be served<br/>under that path.<br/>Eg:<br/>- http://localhost:8080<br/>- https://service.localhost<br/>- https://service.localhost/path<br/>- file://host/path<br/>If the URI's path is "/base" and the incoming request was for "/dir",<br/>the upstream request will be for "/base/dir". |
 | `insecureSkipTLSVerify` | _bool_ | InsecureSkipTLSVerify will skip TLS verification of upstream HTTPS hosts.<br/>This option is insecure and will allow potential Man-In-The-Middle attacks<br/>between OAuth2 Proxy and the upstream server.<br/>Defaults to false. |
 | `static` | _bool_ | Static will make all requests to this upstream have a static response.<br/>The response will have a body of "Authenticated" and a response code<br/>matching StaticCode.<br/>If StaticCode is not set, the response will return a 200 response. |
@@ -551,7 +535,6 @@ Requests will be proxied to this upstream if the path matches the request path.
 | `passHostHeader` | _bool_ | PassHostHeader determines whether the request host header should be proxied<br/>to the upstream server.<br/>Defaults to true. |
 | `proxyWebSockets` | _bool_ | ProxyWebSockets enables proxying of websockets to upstream servers<br/>Defaults to true. |
 | `timeout` | _[Duration](#duration)_ | Timeout is the maximum duration the server will wait for a response from the upstream server.<br/>Defaults to 30 seconds. |
-| `disableKeepAlives` | _bool_ | DisableKeepAlives disables HTTP keep-alive connections to the upstream server.<br/>Defaults to false. |
 
 ### UpstreamConfig
 

docs/docs/configuration/integration.md

@@ -1,310 +0,0 @@
----
-id: integration
-title: Integration
----
-
-## Configuring for use with the Nginx `auth_request` directive
-
-**This option requires `--reverse-proxy` option to be set.**
-
-The [Nginx `auth_request` directive](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html) allows Nginx to authenticate requests via the oauth2-proxy's `/auth` endpoint, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the request through. For example:
-
-```nginx
-server {
-  listen 443 ssl;
-  server_name ...;
-  include ssl/ssl.conf;
-
-  location /oauth2/ {
-    proxy_pass       http://127.0.0.1:4180;
-    proxy_set_header Host                    $host;
-    proxy_set_header X-Real-IP               $remote_addr;
-    proxy_set_header X-Auth-Request-Redirect $request_uri;
-    # or, if you are handling multiple domains:
-    # proxy_set_header X-Auth-Request-Redirect $scheme://$host$request_uri;
-  }
-  location = /oauth2/auth {
-    proxy_pass       http://127.0.0.1:4180;
-    proxy_set_header Host             $host;
-    proxy_set_header X-Real-IP        $remote_addr;
-    proxy_set_header X-Forwarded-Uri  $request_uri;
-    # nginx auth_request includes headers but not body
-    proxy_set_header Content-Length   "";
-    proxy_pass_request_body           off;
-  }
-
-  location / {
-    auth_request /oauth2/auth;
-    error_page 401 =403 /oauth2/sign_in;
-
-    # pass information via X-User and X-Email headers to backend,
-    # requires running with --set-xauthrequest flag
-    auth_request_set $user   $upstream_http_x_auth_request_user;
-    auth_request_set $email  $upstream_http_x_auth_request_email;
-    proxy_set_header X-User  $user;
-    proxy_set_header X-Email $email;
-
-    # if you enabled --pass-access-token, this will pass the token to the backend
-    auth_request_set $token  $upstream_http_x_auth_request_access_token;
-    proxy_set_header X-Access-Token $token;
-
-    # if you enabled --cookie-refresh, this is needed for it to work with auth_request
-    auth_request_set $auth_cookie $upstream_http_set_cookie;
-    add_header Set-Cookie $auth_cookie;
-
-    # When using the --set-authorization-header flag, some provider's cookies can exceed the 4kb
-    # limit and so the OAuth2 Proxy splits these into multiple parts.
-    # Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,
-    # so if your cookies are larger than 4kb, you will need to extract additional cookies manually.
-    auth_request_set $auth_cookie_name_upstream_1 $upstream_cookie_auth_cookie_name_1;
-
-    # Extract the Cookie attributes from the first Set-Cookie header and append them
-    # to the second part ($upstream_cookie_* variables only contain the raw cookie content)
-    if ($auth_cookie ~* "(; .*)") {
-        set $auth_cookie_name_0 $auth_cookie;
-        set $auth_cookie_name_1 "auth_cookie_name_1=$auth_cookie_name_upstream_1$1";
-    }
-
-    # Send both Set-Cookie headers now if there was a second part
-    if ($auth_cookie_name_upstream_1) {
-        add_header Set-Cookie $auth_cookie_name_0;
-        add_header Set-Cookie $auth_cookie_name_1;
-    }
-
-    proxy_pass http://backend/;
-    # or "root /path/to/site;" or "fastcgi_pass ..." etc
-  }
-}
-```
-
-When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:
-
-```yaml
-nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"
-nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"
-```
-
-This minimal configuration works for standard authentication flows. Lua/cookie handling is only needed for advanced scenarios (e.g., multi-part cookies, custom session logic). See the official ingress-nginx example: https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/.
-
-It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
-
-You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable  should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
-
-## Configuring for use with the Traefik (v2) `ForwardAuth` middleware
-
-**This option requires `--reverse-proxy` option to be set.**
-
-### ForwardAuth with 401 errors middleware
-
-The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
-
-```yaml
-http:
-  routers:
-    a-service:
-      rule: "Host(`a-service.example.com`)"
-      service: a-service-backend
-      middlewares:
-        - oauth-errors
-        - oauth-auth
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    oauth:
-      rule: "Host(`a-service.example.com`, `oauth.example.com`) && PathPrefix(`/oauth2/`)"
-      middlewares:
-        - auth-headers
-      service: oauth-backend
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-
-  services:
-    a-service-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.2:7555
-    oauth-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.1:4180
-
-  middlewares:
-    auth-headers:
-      headers:
-        sslRedirect: true
-        stsSeconds: 315360000
-        browserXssFilter: true
-        contentTypeNosniff: true
-        forceSTSHeader: true
-        sslHost: example.com
-        stsIncludeSubdomains: true
-        stsPreload: true
-        frameDeny: true
-    oauth-auth:
-      forwardAuth:
-        address: https://oauth.example.com/oauth2/auth
-        trustForwardHeader: true
-    oauth-errors:
-      errors:
-        status:
-          - "401-403"
-        service: oauth-backend
-        query: "/oauth2/sign_in?rd={url}"
-```
-
-### ForwardAuth with static upstreams configuration
-
-Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
-
-**Following options need to be set on `oauth2-proxy`:**
-- `--upstream=static://202`: Configures a static response for authenticated sessions
-- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly
-
-```yaml
-http:
-  routers:
-    a-service-route-1:
-      rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/`)"
-      service: a-service-backend
-      middlewares:
-        - oauth-auth-redirect # redirects all unauthenticated to oauth2 signin
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    a-service-route-2:
-      rule: "Host(`a-service.example.com`) && PathPrefix(`/no-auto-redirect`)"
-      service: a-service-backend
-      middlewares:
-        - oauth-auth-wo-redirect # unauthenticated session will return a 401
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    services-oauth2-route:
-      rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/oauth2/`)"
-      middlewares:
-        - auth-headers
-      service: oauth-backend
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    oauth2-proxy-route:
-      rule: "Host(`oauth.example.com`) && PathPrefix(`/`)"
-      middlewares:
-        - auth-headers
-      service: oauth-backend
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-
-  services:
-    a-service-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.2:7555
-    b-service-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.3:7555
-    oauth-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.1:4180
-
-  middlewares:
-    auth-headers:
-      headers:
-        sslRedirect: true
-        stsSeconds: 315360000
-        browserXssFilter: true
-        contentTypeNosniff: true
-        forceSTSHeader: true
-        sslHost: example.com
-        stsIncludeSubdomains: true
-        stsPreload: true
-        frameDeny: true
-    oauth-auth-redirect:
-      forwardAuth:
-        address: https://oauth.example.com/
-        trustForwardHeader: true
-        authResponseHeaders:
-          - X-Auth-Request-Access-Token
-          - Authorization
-    oauth-auth-wo-redirect:
-      forwardAuth:
-        address: https://oauth.example.com/oauth2/auth
-        trustForwardHeader: true
-        authResponseHeaders:
-          - X-Auth-Request-Access-Token
-          - Authorization
-```
-
-## Configuring for use with the Caddy (v2) `forward_auth` directive
-
-The [Caddy `forward_auth` directive](https://caddyserver.com/docs/caddyfile/directives/forward_auth) allows Caddy to authenticate requests via the `oauth2-proxy`'s `/auth`.
-
-This example is for a simple reverse proxy setup where the `/oauth2/` path is kept under the same domain and failed auth requests (401 status returned) will be caught and redirected to the `sign_in` endpoint.
-
-**Following options need to be set on `oauth2-proxy`:**
-- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly
-
-```nginx title="Caddyfile"
-example.com {
-	# Requests to /oauth2/* are proxied to oauth2-proxy without authentication.
-	# You can't use `reverse_proxy /oauth2/* oauth2-proxy.internal:4180` here because the reverse_proxy directive has lower precedence than the handle directive.
-	handle /oauth2/* {
-		reverse_proxy oauth2-proxy.internal:4180 {
-			# oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.
-			# The reverse_proxy directive automatically sets X-Forwarded-{For,Proto,Host} headers.
-			header_up X-Real-IP {remote_host}
-			header_up X-Forwarded-Uri {uri}
-		}
-	}
-
-	# Requests to other paths are first processed by oauth2-proxy for authentication.
-	handle {
-		forward_auth oauth2-proxy.internal:4180 {
-			uri /oauth2/auth
-
-			# oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.
-			# The forward_auth directive automatically sets the X-Forwarded-{For,Proto,Host,Method,Uri} headers.
-			header_up X-Real-IP {remote_host}
-
-			# If needed, you can copy headers from the oauth2-proxy response to the request sent to the upstream.
-			# Make sure to configure the --set-xauthrequest flag to enable this feature.
-			#copy_headers X-Auth-Request-User X-Auth-Request-Email
-
-			# If oauth2-proxy returns a 401 status, redirect the client to the sign-in page.
-			@error status 401
-			handle_response @error {
-				redir * /oauth2/sign_in?rd={scheme}://{host}{uri}
-			}
-		}
-
-		# If oauth2-proxy returns a 2xx status, the request is then proxied to the upstream.
-		reverse_proxy upstream.internal:3000
-	}
-}
-```
-
-:::note
-If you set up your OAuth2 provider to rotate your client secret, you can use the `client-secret-file` option to reload the secret when it is updated.
-:::

docs/docs/configuration/overview.md

@@ -5,7 +5,7 @@ title: Overview
 
 `oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
 
-## Generating a Cookie Secret
+### Generating a Cookie Secret
 
 To generate a strong cookie secret use one of the below commands:
 
@@ -15,274 +15,220 @@ import TabItem from '@theme/TabItem';
 <Tabs defaultValue="python">
   <TabItem value="python" label="Python">
 
-```shell
-python -c 'import os,base64; print(base64.urlsafe_b64encode(os.urandom(32)).decode())'
-```
-
+  ```shell
+  python -c 'import os,base64; print(base64.urlsafe_b64encode(os.urandom(32)).decode())'
+  ```
+  
   </TabItem>
   <TabItem value="bash" label="Bash">
 
-```shell
-dd if=/dev/urandom bs=32 count=1 2>/dev/null | base64 | tr -d -- '\n' | tr -- '+/' '-_' ; echo
-```
-
+  ```shell
+  dd if=/dev/urandom bs=32 count=1 2>/dev/null | base64 | tr -d -- '\n' | tr -- '+/' '-_' ; echo
+  ```
+  
   </TabItem>
   <TabItem value="openssl" label="OpenSSL">
 
-```shell
-openssl rand -base64 32 | tr -- '+/' '-_'
-```
+  ```shell
+  openssl rand -base64 32 | tr -- '+/' '-_'
+  ```
 
   </TabItem>
   <TabItem value="powershell" label="PowerShell">
 
-```powershell
-# Add System.Web assembly to session, just in case
-Add-Type -AssemblyName System.Web
-[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes([System.Web.Security.Membership]::GeneratePassword(32,4))).Replace("+","-").Replace("/","_")
-```
+  ```powershell
+  # Add System.Web assembly to session, just in case
+  Add-Type -AssemblyName System.Web
+  [Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes([System.Web.Security.Membership]::GeneratePassword(32,4))).Replace("+","-").Replace("/","_")
+  ```
 
   </TabItem>
   <TabItem value="terraform" label="Terraform">
 
-```hcl
-# Valid 32 Byte Base64 URL encoding set that will decode to 24 []byte AES-192 secret
-resource "random_password" "cookie_secret" {
-  length           = 32
-  override_special = "-_"
-}
-```
+  ```hcl
+  # Valid 32 Byte Base64 URL encoding set that will decode to 24 []byte AES-192 secret
+  resource "random_password" "cookie_secret" {
+    length           = 32
+    override_special = "-_"
+  }
+  ```
 
   </TabItem>
 </Tabs>
 
-## Config File
+### Config File
 
 Every command line argument can be specified in a config file by replacing hyphens (-) with underscores (\_). If the argument can be specified multiple times, the config option should be plural (trailing s).
 
 An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/contrib/oauth2-proxy.cfg.example) config file is in the contrib directory. It can be used by specifying `--config=/etc/oauth2-proxy.cfg`
 
-## Config Options
-
 ### Command Line Options
 
-| Flag        | Description          |
-| ----------- | -------------------- |
-| `--config`  | path to config file  |
-| `--version` | print version string |
+| Option | Type | Description | Default |
+| ------ | ---- | ----------- | ------- |
+| `--acr-values` | string | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues) | `""` |
+| `--allow-query-semicolons` | bool | allow the use of semicolons in query args ([required for some legacy applications](https://github.com/golang/go/issues/25192)) | `false` |
+| `--api-route` | string \| list | return HTTP 401 instead of redirecting to authentication server if token is not valid. Format: path_regex | |
+| `--approval-prompt` | string | OAuth approval_prompt | `"force"` |
+| `--auth-logging` | bool | Log authentication attempts | true |
+| `--auth-logging-format` | string | Template for authentication log lines | see [Logging Configuration](#logging-configuration) |
+| `--authenticated-emails-file` | string | authenticate against emails via file (one per line) | |
+| `--azure-tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` |
+| `--backend-logout-url` | string | URL to perform backend logout, if you use `{id_token}` in the url it will be replaced by the actual `id_token` of the user session | |
+| `--basic-auth-password` | string | the password to set when passing the HTTP Basic Auth header | |
+| `--client-id` | string | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"` | |
+| `--client-secret` | string | the OAuth Client Secret | |
+| `--client-secret-file` | string | the file with OAuth Client Secret | |
+| `--code-challenge-method` | string | use PKCE code challenges with the specified method. Either 'plain' or 'S256' (recommended) | |
+| `--config` | string | path to config file | |
+| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
+| `--cookie-expire` | duration | expire timeframe for cookie. If set to 0, cookie becomes a session-cookie which will expire when the browser is closed. | 168h0m0s |
+| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
+| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
+| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers&nbsp;[^1] | |
+| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
+| `--cookie-secure` | bool | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag) | true |
+| `--cookie-samesite` | string | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`). | `""` |
+| `--cookie-csrf-per-request` | bool | Enable having different CSRF cookies per request, making it possible to have parallel requests. | false |
+| `--cookie-csrf-expire` | duration | expire timeframe for CSRF cookie | 15m |
+| `--custom-templates-dir` | string | path to custom html templates | |
+| `--custom-sign-in-logo` | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo. |
+| `--display-htpasswd-form` | bool | display username / password login form if an htpasswd file is provided | true |
+| `--email-domain` | string \| list | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email | |
+| `--errors-to-info-log` | bool | redirects error-level logging to default log channel instead of stderr | false |
+| `--extra-jwt-issuers` | string | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` (see a token's `iss`, `aud` fields) pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`) | |
+| `--exclude-logging-path` | string | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"` |`""` (no paths excluded) |
+| `--flush-interval` | duration | period between flushing response buffers when streaming responses | `"1s"` |
+| `--force-https` | bool | enforce https redirect | `false` |
+| `--force-json-errors` | bool | force JSON errors instead of HTTP error pages or redirects | `false` |
+| `--banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |
+| `--footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | |
+| `--github-org` | string | restrict logins to members of this organisation | |
+| `--github-team` | string | restrict logins to members of any of these teams (slug), separated by a comma | |
+| `--github-repo` | string | restrict logins to collaborators of this repository formatted as `orgname/repo` | |
+| `--github-token` | string | the token to use when verifying repository collaborators (must have push access to the repository) | |
+| `--github-user` | string \| list | To allow users to login by username even if they do not belong to the specified org and team or collaborators | |
+| `--gitlab-group` | string \| list | restrict logins to members of any of these groups (slug), separated by a comma | |
+| `--gitlab-projects` | string \| list | restrict logins to members of any of these projects (may be given multiple times) formatted as `orgname/repo=accesslevel`. Access level should be a value matching [Gitlab access levels](https://docs.gitlab.com/ee/api/members.html#valid-access-levels), defaulted to 20 if absent | |
+| `--google-admin-email` | string | the google admin to impersonate for api calls | |
+| `--google-group` | string | restrict logins to members of this google group (may be given multiple times). | |
+| `--google-service-account-json` | string | the path to the service account json credentials | |
+| `--google-use-application-default-credentials` | bool | use application default credentials instead of service account json (i.e. GKE Workload Identity) | |
+| `--google-target-principal` | bool | the target principal to impersonate when using ADC | defaults to the service account configured for ADC |
+| `--htpasswd-file` | string | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption | |
+| `--htpasswd-user-group` | string \| list | the groups to be set on sessions for htpasswd users | |
+| `--http-address` | string | `[http://]<addr>:<port>` or `unix://<path>` to listen on for HTTP clients. Square brackets are required for ipv6 address, e.g. `http://[::1]:4180` | `"127.0.0.1:4180"` |
+| `--https-address` | string | `[https://]<addr>:<port>` to listen on for HTTPS clients. Square brackets are required for ipv6 address, e.g. `https://[::1]:443` | `":443"` |
+| `--logging-compress` | bool | Should rotated log files be compressed using gzip | false |
+| `--logging-filename` | string | File to log requests to, empty for `stdout` | `""` (stdout) |
+| `--logging-local-time` | bool | Use local time in log files and backup filenames instead of UTC | true (local time) |
+| `--logging-max-age` | int | Maximum number of days to retain old log files | 7 |
+| `--logging-max-backups` | int | Maximum number of old log files to retain; 0 to disable | 0 |
+| `--logging-max-size` | int | Maximum size in megabytes of the log file before rotation | 100 |
+| `--jwt-key` | string | private key in PEM format used to sign JWT, so that you can say something like `--jwt-key="${OAUTH2_PROXY_JWT_KEY}"`: required by login.gov | |
+| `--jwt-key-file` | string | path to the private key file in PEM format used to sign the JWT so that you can say something like `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem`: required by login.gov | |
+| `--login-url` | string | Authentication endpoint | |
+| `--insecure-oidc-allow-unverified-email` | bool | don't fail if an email address in an id_token is not verified | false |
+| `--insecure-oidc-skip-issuer-verification` | bool | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility) | false |
+| `--insecure-oidc-skip-nonce` | bool | skip verifying the OIDC ID Token's nonce claim | true |
+| `--oidc-issuer-url` | string | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"` | |
+| `--oidc-jwks-url` | string | OIDC JWKS URI for token verification; required if OIDC discovery is disabled | |
+| `--oidc-email-claim` | string | which OIDC claim contains the user's email | `"email"` |
+| `--oidc-groups-claim` | string | which OIDC claim contains the user groups | `"groups"` |
+| `--oidc-audience-claim` | string | which OIDC claim contains the audience | `"aud"` |
+| `--oidc-extra-audience` | string \| list | additional audiences which are allowed to pass verification | `"[]"` |
+| `--pass-access-token` | bool | pass OAuth access_token to upstream via X-Forwarded-Access-Token header. When used with `--set-xauthrequest` this adds the X-Auth-Request-Access-Token header to the response | false |
+| `--pass-authorization-header` | bool | pass OIDC IDToken to upstream via Authorization Bearer header | false |
+| `--pass-basic-auth` | bool | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
+| `--prefer-email-to-user` | bool | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers` | false |
+| `--pass-host-header` | bool | pass the request Host Header to upstream | true |
+| `--pass-user-headers` | bool | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
+| `--profile-url` | string | Profile access endpoint | |
+| `--skip-claims-from-profile-url` | bool | skip request to Profile URL for resolving claims not present in id_token | false |
+| `--prompt` | string | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored | `""` |
+| `--provider` | string | OAuth provider | google |
+| `--provider-ca-file` | string \| list | Paths to CA certificates that should be used when connecting to the provider. If not specified, the default Go trust sources are used instead. |
+| `--use-system-trust-store` | bool | Determines if `provider-ca-file` files and the system trust store are used. If set to true, your custom CA files and the system trust store are used otherwise only your custom CA files. | false |
+| `--provider-display-name` | string | Override the provider's name with the given string; used for the sign-in page | (depends on provider) |
+| `--ping-path` | string | the ping endpoint that can be used for basic health checks | `"/ping"` |
+| `--ping-user-agent` | string | a User-Agent that can be used for basic health checks | `""` (don't check user agent) |
+| `--ready-path` | string | the ready endpoint that can be used for deep health checks | `"/ready"` |
+| `--metrics-address` | string | the address prometheus metrics will be scraped from | `""` |
+| `--proxy-prefix` | string | the url root path that this proxy should be nested under (e.g. /`<oauth2>/sign_in`) | `"/oauth2"` |
+| `--proxy-websockets` | bool | enables WebSocket proxying | true |
+| `--pubjwk-url` | string | JWK pubkey access endpoint: required by login.gov | |
+| `--real-client-ip-header` | string | Header used to determine the real IP of the client, requires `--reverse-proxy` to be set (one of: X-Forwarded-For, X-Real-IP, or X-ProxyUser-IP) | X-Real-IP |
+| `--redeem-url` | string | Token redemption endpoint | |
+| `--redirect-url` | string | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"` | |
+| `--relative-redirect-url` | bool | allow relative OAuth Redirect URL.` | |
+| `--redis-cluster-connection-urls` | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster` | |
+| `--redis-connection-url` | string | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`) | |
+| `--redis-insecure-skip-tls-verify` | bool | skip TLS verification when connecting to Redis | false |
+| `--redis-password` | string | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url` | |
+| `--redis-sentinel-password` | string | Redis sentinel password. Used only for sentinel connection; any redis node passwords need to use `--redis-password` | |
+| `--redis-sentinel-master-name` | string | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel` | |
+| `--redis-sentinel-connection-urls` | string \| list | List of Redis sentinel connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-sentinel` | |
+| `--redis-use-cluster` | bool | Connect to redis cluster. Must set `--redis-cluster-connection-urls` to use this feature | false |
+| `--redis-use-sentinel` | bool | Connect to redis via sentinels. Must set `--redis-sentinel-master-name` and `--redis-sentinel-connection-urls` to use this feature | false |
+| `--redis-connection-idle-timeout` | int | Redis connection idle timeout seconds. If Redis [timeout](https://redis.io/docs/reference/clients/#client-timeouts) option is set to non-zero, the `--redis-connection-idle-timeout` must be less than Redis timeout option. Example: if either redis.conf includes `timeout 15` or using `CONFIG SET timeout 15` the `--redis-connection-idle-timeout` must be at least `--redis-connection-idle-timeout=14` | 0 |
+| `--request-id-header` | string | Request header to use as the request ID in logging | X-Request-Id |
+| `--request-logging` | bool | Log requests | true |
+| `--request-logging-format` | string | Template for request log lines | see [Logging Configuration](#logging-configuration) |
+| `--resource` | string | The resource that is protected (Azure AD only) | |
+| `--reverse-proxy` | bool | are we running behind a reverse proxy, controls whether headers like X-Real-IP are accepted and allows X-Forwarded-\{Proto,Host,Uri\} headers to be used on redirect selection | false |
+| `--scope` | string | OAuth scope specification | |
+| `--session-cookie-minimal` | bool | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only) | false |
+| `--session-store-type` | string | [Session data storage backend](sessions.md); redis or cookie | cookie |
+| `--set-xauthrequest` | bool | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode). When used with `--pass-access-token`, X-Auth-Request-Access-Token is added to response headers. | false |
+| `--set-authorization-header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false |
+| `--set-basic-auth` | bool | set HTTP Basic Auth information in response (useful in Nginx auth_request mode) | false |
+| `--show-debug-on-error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false |
+| `--signature-key` | string | GAP-Signature request signature key (algorithm:secretkey) | |
+| `--silence-ping-logging` | bool | disable logging of requests to ping & ready endpoints | false |
+| `--skip-auth-preflight` | bool | will skip authentication for OPTIONS requests | false |
+| `--skip-auth-regex` | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times) | |
+| `--skip-auth-route` | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR method!=path_regex. For all methods: path_regex OR !=path_regex | |
+| `--skip-auth-strip-headers` | bool | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy | true |
+| `--skip-jwt-bearer-tokens` | bool | will skip requests that have verified JWT bearer tokens (the token must have [`aud`](https://en.wikipedia.org/wiki/JSON_Web_Token#Standard_fields) that matches this client id or one of the extras from `extra-jwt-issuers`) | false |
+| `--skip-oidc-discovery` | bool | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case | false |
+| `--skip-provider-button` | bool | will skip sign-in-page to directly reach the next step: oauth/start | false |
+| `--ssl-insecure-skip-verify` | bool | skip validation of certificates presented when using HTTPS providers | false |
+| `--ssl-upstream-insecure-skip-verify` | bool | skip validation of certificates presented when using HTTPS upstreams | false |
+| `--standard-logging` | bool | Log standard runtime information | true |
+| `--standard-logging-format` | string | Template for standard log lines | see [Logging Configuration](#logging-configuration) |
+| `--tls-cert-file` | string | path to certificate file | |
+| `--tls-cipher-suite` | string \| list | Restricts TLS cipher suites used by server to those listed (e.g. TLS_RSA_WITH_RC4_128_SHA) (may be given multiple times). If not specified, the default Go safe cipher list is used. List of valid cipher suites can be found in the [crypto/tls documentation](https://pkg.go.dev/crypto/tls#pkg-constants). | |
+| `--tls-key-file` | string | path to private key file | |
+| `--tls-min-version` | string | minimum TLS version that is acceptable, either `"TLS1.2"` or `"TLS1.3"` | `"TLS1.2"` |
+| `--upstream` | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://<status_code>` for static response. Routing is based on the path | |
+| `--upstream-timeout` | duration | maximum amount of time the server will wait for a response from the upstream | 30s |
+| `--allowed-group` | string \| list | restrict logins to members of this group (may be given multiple times) | |
+| `--allowed-role` | string \| list | restrict logins to users with this role (may be given multiple times). Only works with the keycloak-oidc provider. | |
+| `--validate-url` | string | Access token validation endpoint | |
+| `--version` | n/a | print version string | |
+| `--whitelist-domain` | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` or a `*.` to allow subdomains (e.g. `.example.com`, `*.example.com`)&nbsp;[^2] | |
+| `--trusted-ip` | string \| list | list of IPs or CIDR ranges to allow to bypass authentication (may be given multiple times). When combined with `--reverse-proxy` and optionally `--real-client-ip-header` this will evaluate the trust of the IP stored in an HTTP header by a reverse proxy rather than the layer-3/4 remote address. WARNING: trusting IPs has inherent security flaws, especially when obtaining the IP address from an HTTP header (reverse-proxy mode). Use this option only if you understand the risks and how to manage them. | |
+| `--encode-state` | bool | encode the state parameter as UrlEncodedBase64 | false |
 
+[^1]: Only these providers support `--cookie-refresh`: GitLab, Google and OIDC
+[^2]: When using the `whitelist-domain` option, any domain prefixed with a `.` or a `*.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URLs protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
 
-### General Provider Options
+See below for provider specific options
 
-Provider specific options can be found on their respective subpages.
-
-| Flag / Config Field                                                                                 | Type           | Description                                                                                                                                                                                              | Default               |
-| --------------------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| flag: `--acr-values`<br/>toml: `acr_values`                                                         | string         | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues)                                                                                                          | `""`                  |
-| flag: `--allowed-group`<br/>toml: `allowed_groups`                                                  | string \| list | Restrict login to members of a group or list of groups. Furthermore, if you aren't setting the `scope` and use `allowed_groups` with the generic OIDC provider the scope `groups` gets added implicitly. |                       |
-| flag: `--approval-prompt`<br/>toml: `approval_prompt`                                               | string         | OAuth approval_prompt                                                                                                                                                                                    | `"force"`             |
-| flag: `--backend-logout-url`<br/>toml: `backend_logout_url`                                         | string         | URL to perform backend logout, if you use `{id_token}` in the url it will be replaced by the actual `id_token` of the user session                                                                       |                       |
-| flag: `--client-id`<br/>toml: `client_id`                                                           | string         | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"`                                                                                                                                          |                       |
-| flag: `--client-secret-file`<br/>toml: `client_secret_file`                                         | string         | the file with OAuth Client Secret                                                                                                                                                                        |                       |
-| flag: `--client-secret`<br/>toml: `client_secret`                                                   | string         | the OAuth Client Secret                                                                                                                                                                                  |                       |
-| flag: `--code-challenge-method`<br/>toml: `code_challenge_method`                                   | string         | use PKCE code challenges with the specified method. Either 'plain' or 'S256' (recommended)                                                                                                               |                       |
-| flag: `--insecure-oidc-allow-unverified-email`<br/>toml: `insecure_oidc_allow_unverified_email`     | bool           | don't fail if an email address in an id_token is not verified                                                                                                                                            | false                 |
-| flag: `--insecure-oidc-skip-issuer-verification`<br/>toml: `insecure_oidc_skip_issuer_verification` | bool           | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility)                                                                                          | false                 |
-| flag: `--insecure-oidc-skip-nonce`<br/>toml: `insecure_oidc_skip_nonce`                             | bool           | skip verifying the OIDC ID Token's nonce claim                                                                                                                                                           | true                  |
-| flag: `--jwt-key-file`<br/>toml: `jwt_key_file`                                                     | string         | path to the private key file in PEM format used to sign the JWT so that you can say something like `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem`: required by login.gov                          |                       |
-| flag: `--jwt-key`<br/>toml: `jwt_key`                                                               | string         | private key in PEM format used to sign JWT, so that you can say something like `--jwt-key="${OAUTH2_PROXY_JWT_KEY}"`: required by login.gov                                                              |                       |
-| flag: `--login-url`<br/>toml: `login_url`                                                           | string         | Authentication endpoint                                                                                                                                                                                  |                       |
-| flag: `--auth-request-response-mode`<br/>toml: `auth-request-response-mode`                         | string         | Response mode to ask for during authentication request                                                                                                                                                   |                       |
-| flag: `--oidc-audience-claim`<br/>toml: `oidc_audience_claims`                                      | string         | which OIDC claim contains the audience                                                                                                                                                                   | `"aud"`               |
-| flag: `--oidc-email-claim`<br/>toml: `oidc_email_claim`                                             | string         | which OIDC claim contains the user's email                                                                                                                                                               | `"email"`             |
-| flag: `--oidc-extra-audience`<br/>toml: `oidc_extra_audiences`                                      | string \| list | additional audiences which are allowed to pass verification                                                                                                                                              | `"[]"`                |
-| flag: `--oidc-groups-claim`<br/>toml: `oidc_groups_claim`                                           | string         | which OIDC claim contains the user groups                                                                                                                                                                | `"groups"`            |
-| flag: `--oidc-issuer-url`<br/>toml: `oidc_issuer_url`                                               | string         | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"`                                                                                                                                      |                       |
-| flag: `--oidc-jwks-url`<br/>toml: `oidc_jwks_url`                                                   | string         | OIDC JWKS URI for token verification; required if OIDC discovery is disabled and public key files are not provided                                                                                       |                       |
-| flag: `--oidc-public-key-file`<br/>toml: `oidc_public_key_files`                                    | string         | Path to public key file in PEM format to use for verifying JWT tokens (may be given multiple times). Required if OIDC discovery is disabled na JWKS URL isn't provided                                   | string \| list        |
-| flag: `--profile-url`<br/>toml: `profile_url`                                                       | string         | Profile access endpoint                                                                                                                                                                                  |                       |
-| flag: `--prompt`<br/>toml: `prompt`                                                                 | string         | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored                                                                               | `""`                  |
-| flag: `--provider-ca-file`<br/>toml: `provider_ca_files`                                            | string \| list | Paths to CA certificates that should be used when connecting to the provider. If not specified, the default Go trust sources are used instead.                                                           |
-| flag: `--provider-display-name`<br/>toml: `provider_display_name`                                   | string         | Override the provider's name with the given string; used for the sign-in page                                                                                                                            | (depends on provider) |
-| flag: `--provider`<br/>toml: `provider`                                                             | string         | OAuth provider                                                                                                                                                                                           | google                |
-| flag: `--pubjwk-url`<br/>toml: `pubjwk_url`                                                         | string         | JWK pubkey access endpoint: required by login.gov                                                                                                                                                        |                       |
-| flag: `--redeem-url`<br/>toml: `redeem_url`                                                         | string         | Token redemption endpoint                                                                                                                                                                                |                       |
-| flag: `--scope`<br/>toml:`scope`                                                                    | string         | OAuth scope specification. Every provider has a default list of scopes which will be used in case no scope is configured.                                                                                |                       |
-| flag: `--skip-claims-from-profile-url`<br/>toml: `skip_claims_from_profile_url`                     | bool           | skip request to Profile URL for resolving claims not present in id_token                                                                                                                                 | false                 |
-| flag: `--skip-oidc-discovery`<br/>toml: `skip_oidc_discovery`                                       | bool           | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case                                                                                      | false                 |
-| flag: `--use-system-trust-store`<br/>toml: `use_system_trust_store`                                 | bool           | Determines if `provider-ca-file` files and the system trust store are used. If set to true, your custom CA files and the system trust store are used otherwise only your custom CA files.                | false                 |
-| flag: `--validate-url`<br/>toml: `validate_url`                                                     | string         | Access token validation endpoint                                                                                                                                                                         |                       |
-
-### Cookie Options
-
-| Flag / Config Field                                                               | Type           | Description                                                                                                                                                                                                                                       | Default           |
-| --------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
-| flag: `--cookie-csrf-expire`<br/>toml: `cookie_csrf_expire`                       | duration       | expire timeframe for CSRF cookie                                                                                                                                                                                                                  | 15m               |
-| flag: `--cookie-csrf-per-request`<br/>toml:`cookie_csrf_per_request`              | bool           | Enable having different CSRF cookies per request, making it possible to have parallel requests.                                                                                                                                                   | false             |
-| flag: `--cookie-csrf-per-request-limit`<br/>toml: `cookie_csrf_per_request_limit` | int            | Sets a limit on the number of CSRF requests cookies that oauth2-proxy will create. The oldest cookie will be removed. Useful if users end up with 431 Request headers too large status codes. Only effective if --cookie-csrf-per-request is true | "infinite"        |
-| flag: `--cookie-domain`<br/>toml: `cookie_domains`                                | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match).                                                          |                   |
-| flag: `--cookie-expire`<br/>toml: `cookie_expire`                                 | duration       | expire timeframe for cookie. If set to 0, cookie becomes a session-cookie which will expire when the browser is closed.                                                                                                                           | 168h0m0s          |
-| flag: `--cookie-httponly`<br/>toml: `cookie_httponly`                             | bool           | set HttpOnly cookie flag                                                                                                                                                                                                                          | true              |
-| flag: `--cookie-name`<br/>toml: `cookie_name`                                     | string         | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set.                | `"_oauth2_proxy"` |
-| flag: `--cookie-path`<br/>toml: `cookie_path`                                     | string         | an optional cookie path to force cookies to (e.g. `/poc/`)                                                                                                                                                                                        | `"/"`             |
-| flag: `--cookie-refresh`<br/>toml: `cookie_refresh`                               | duration       | refresh the cookie after this duration; `0` to disable; not supported by all providers&nbsp;[^1]                                                                                                                                                  |                   |
-| flag: `--cookie-samesite`<br/>toml: `cookie_samesite`                             | string         | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`).                                                                                                                                                                           | `""`              |
-| flag: `--cookie-secret`<br/>toml: `cookie_secret`                                 | string         | the seed string for secure cookies (optionally base64 encoded)                                                                                                                                                                                    |                   |
-| flag: `--cookie-secret-file`<br/>toml: `cookie_secret_file`                       | string         | For defining a separate cookie secret file to read the encryption key from                                                                                                                                                                        |                   |
-| flag: `--cookie-secure`<br/>toml: `cookie_secure`                                 | bool           | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag)                                                                                                                                                        | true              |
-
-[^1]: The following providers support `--cookie-refresh`: ADFS, Azure, GitLab, Google, Keycloak and all other Identity Providers which support the full [OIDC specification](https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens)
-
-### Header Options
-
-| Flag / Config Field                                                       | Type   | Description                                                                                                                                                                                                                                                      | Default |
-| ------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| flag: `--basic-auth-password`<br/>toml: `basic_auth_password`             | string | the password to set when passing the HTTP Basic Auth header                                                                                                                                                                                                      |         |
-| flag: `--set-xauthrequest`<br/>toml: `set_xauthrequest`                   | bool   | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode). When used with `--pass-access-token`, X-Auth-Request-Access-Token is added to response headers. | false   |
-| flag: `--set-authorization-header`<br/>toml: `set_authorization_header`   | bool   | set Authorization Bearer response header (useful in Nginx auth_request mode)                                                                                                                                                                                     | false   |
-| flag: `--set-basic-auth`<br/>toml: `set_basic_auth`                       | bool   | set HTTP Basic Auth information in response (useful in Nginx auth_request mode)                                                                                                                                                                                  | false   |
-| flag: `--skip-auth-strip-headers`<br/>toml: `skip_auth_strip_headers`     | bool   | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy                                                                                                                                                | true    |
-| flag: `--pass-access-token`<br/>toml: `pass_access_token`                 | bool   | pass OAuth access_token to upstream via X-Forwarded-Access-Token header. When used with `--set-xauthrequest` this adds the X-Auth-Request-Access-Token header to the response                                                                                    | false   |
-| flag: `--pass-authorization-header`<br/>toml: `pass_authorization_header` | bool   | pass OIDC IDToken to upstream via Authorization Bearer header                                                                                                                                                                                                    | false   |
-| flag: `--pass-basic-auth`<br/>toml: `pass_basic_auth`                     | bool   | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream                                                                                                                                             | true    |
-| flag: `--prefer-email-to-user`<br/>toml: `prefer_email_to_user`           | bool   | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers`                       | false   |
-| flag: `--pass-user-headers`<br/>toml: `pass_user_headers`                 | bool   | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream                                                                                                                                          | true    |
-
-### Logging Options
-
-| Flag / Config Field                                                   | Type   | Description                                                                  | Default                                             |
-| --------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------- | --------------------------------------------------- |
-| flag: `--auth-logging-format`<br/>toml: `auth_logging_format`         | string | Template for authentication log lines                                        | see [Logging Configuration](#logging-configuration) |
-| flag: `--auth-logging`<br/>toml: `auth_logging`                       | bool   | Log authentication attempts                                                  | true                                                |
-| flag: `--errors-to-info-log`<br/>toml: `errors_to_info_log`           | bool   | redirects error-level logging to default log channel instead of stderr       | false                                               |
-| flag: `--exclude-logging-path`<br/>toml: `exclude_logging_paths`      | string | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"` | `""` (no paths excluded)                            |
-| flag: `--logging-compress`<br/>toml: `logging_compress`               | bool   | Should rotated log files be compressed using gzip                            | false                                               |
-| flag: `--logging-filename`<br/>toml: `logging_filename`               | string | File to log requests to, empty for `stdout`                                  | `""` (stdout)                                       |
-| flag: `--logging-local-time`<br/>toml: `logging_local_time`           | bool   | Use local time in log files and backup filenames instead of UTC              | true (local time)                                   |
-| flag: `--logging-max-age`<br/>toml: `logging_max_age`                 | int    | Maximum number of days to retain old log files                               | 7                                                   |
-| flag: `--logging-max-backups`<br/>toml: `logging_max_backups`         | int    | Maximum number of old log files to retain; 0 to disable                      | 0                                                   |
-| flag: `--logging-max-size`<br/>toml: `logging_max_size`               | int    | Maximum size in megabytes of the log file before rotation                    | 100                                                 |
-| flag: `--request-id-header`<br/>toml: `request_id_header`             | string | Request header to use as the request ID in logging                           | X-Request-Id                                        |
-| flag: `--request-logging-format`<br/>toml: `request_logging_format`   | string | Template for request log lines                                               | see [Logging Configuration](#logging-configuration) |
-| flag: `--request-logging`<br/>toml: `request_logging`                 | bool   | Log requests                                                                 | true                                                |
-| flag: `--silence-ping-logging`<br/>toml: `silence_ping_logging`       | bool   | disable logging of requests to ping & ready endpoints                        | false                                               |
-| flag: `--standard-logging-format`<br/>toml: `standard_logging_format` | string | Template for standard log lines                                              | see [Logging Configuration](#logging-configuration) |
-| flag: `--standard-logging`<br/>toml: `standard_logging`               | bool   | Log standard runtime information                                             | true                                                |
-
-### Page Template Options
-
-| Flag / Config Field                                               | Type   | Description                                                                                                                 | Default |
-| ----------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- | ------- |
-| flag: `--banner`<br/>toml: `banner`                               | string | custom (html) banner string. Use `"-"` to disable default banner.                                                           |         |
-| flag: `--custom-sign-in-logo`<br/>toml: `custom_sign_in_logo`     | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo.                              |
-| flag: `--custom-templates-dir`<br/>toml: `custom_templates_dir`   | string | path to custom html templates                                                                                               |         |
-| flag: `--display-htpasswd-form`<br/>toml: `display_htpasswd_form` | bool   | display username / password login form if an htpasswd file is provided                                                      | true    |
-| flag: `--footer`<br/>toml: `footer`                               | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version)                    |         |
-| flag: `--show-debug-on-error`<br/>toml: `show_debug_on_error`     | bool   | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false   |
-
-### Probe Options
-
-| Flag / Config Field                                     | Type   | Description                                                | Default                       |
-| ------------------------------------------------------- | ------ | ---------------------------------------------------------- | ----------------------------- |
-| flag: `--ping-path`<br/>toml: `ping_path`               | string | the ping endpoint that can be used for basic health checks | `"/ping"`                     |
-| flag: `--ping-user-agent`<br/>toml: `ping_user_agent`   | string | a User-Agent that can be used for basic health checks      | `""` (don't check user agent) |
-| flag: `--ready-path`<br/>toml: `ready_path`             | string | the ready endpoint that can be used for deep health checks | `"/ready"`                    |
-| flag: `--gcp-healthchecks`<br/>toml: `gcp_healthchecks` | bool   | Enable GCP/GKE healthcheck endpoints (deprecated)          | false                         |
-
-### Proxy Options
-
-| Flag / Config Field                                                           | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Default     |
-| ----------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| flag: `--allow-query-semicolons`<br/>toml: `allow_query_semicolons`           | bool           | allow the use of semicolons in query args ([required for some legacy applications](https://github.com/golang/go/issues/25192))                                                                                                                                                                                                                                                                                                                                                                                        | `false`     |
-| flag: `--api-route`<br/>toml: `api_routes`                                    | string \| list | Requests to these paths must already be authenticated with a cookie, or a JWT if `--skip-jwt-bearer-tokens` is set. No redirect to login will be done. Return 401 if not. Format: path_regex                                                                                                                                                                                                                                                                                                                          |             |
-| flag: `--authenticated-emails-file`<br/>toml: `authenticated_emails_file`     | string         | authenticate against emails via file (one per line)                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |             |
-| flag: `--bearer-token-login-fallback`<br/>toml: `bearer_token_login_fallback` | bool           | if `--skip-jwt-bearer-tokens` is set, if a request includes an invalid JWT (expired, malformed, missing required audiences, etc), fall back to normal login redirect as if the token were not sent at all. If false, respond 403                                                                                                                                                                                                                                                                                      | true        |
-| flag: `--email-domain`<br/>toml: `email_domains`                              | string \| list | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email                                                                                                                                                                                                                                                                                                                                                                                                        |             |
-| flag: `--encode-state`<br/>toml: `encode_state`                               | bool           | encode the state parameter as UrlEncodedBase64                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | false       |
-| flag: `--extra-jwt-issuers`<br/>toml: `extra_jwt_issuers`                     | string         | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` (see a token's `iss`, `aud` fields) pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`)                                                                                                                                                                                                                                                                                                    |             |
-| flag: `--force-https`<br/>toml: `force_https`                                 | bool           | enforce https redirect                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `false`     |
-| flag: `--force-json-errors`<br/>toml: `force_json_errors`                     | bool           | force JSON errors instead of HTTP error pages or redirects                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `false`     |
-| flag: `--htpasswd-file`<br/>toml: `htpasswd_file`                             | string         | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption                                                                                                                                                                                                                                                                                                                                                                                                   |             |
-| flag: `--htpasswd-user-group`<br/>toml: `htpasswd_user_groups`                | string \| list | the groups to be set on sessions for htpasswd users                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |             |
-| flag: `--proxy-prefix`<br/>toml: `proxy_prefix`                               | string         | the url root path that this proxy should be nested under (e.g. /`<oauth2>/sign_in`)                                                                                                                                                                                                                                                                                                                                                                                                                                   | `"/oauth2"` |
-| flag: `--real-client-ip-header`<br/>toml: `real_client_ip_header`             | string         | Header used to determine the real IP of the client, requires `--reverse-proxy` to be set (one of: X-Forwarded-For, X-Real-IP, X-ProxyUser-IP, X-Envoy-External-Address, or CF-Connecting-IP)                                                                                                                                                                                                                                                                                                                          | X-Real-IP   |
-| flag: `--redirect-url`<br/>toml: `redirect_url`                               | string         | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"`                                                                                                                                                                                                                                                                                                                                                                                                                                  |             |
-| flag: `--relative-redirect-url`<br/>toml: `relative_redirect_url`             | bool           | allow relative OAuth Redirect URL.`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | false       |
-| flag: `--reverse-proxy`<br/>toml: `reverse_proxy`                             | bool           | are we running behind a reverse proxy, controls whether headers like X-Real-IP are accepted and allows X-Forwarded-\{Proto,Host,Uri\} headers to be used on redirect selection                                                                                                                                                                                                                                                                                                                                        | false       |
-| flag: `--signature-key`<br/>toml: `signature_key`                             | string         | GAP-Signature request signature key (algorithm:secretkey)                                                                                                                                                                                                                                                                                                                                                                                                                                                             |             |
-| flag: `--skip-auth-preflight`<br/>toml: `skip_auth_preflight`                 | bool           | will skip authentication for OPTIONS requests                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | false       |
-| flag: `--skip-auth-regex`<br/>toml: `skip_auth_regex`                         | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times)                                                                                                                                                                                                                                                                                                                                                                                                |             |
-| flag: `--skip-auth-route`<br/>toml: `skip_auth_routes`                        | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR method!=path_regex. For all methods: path_regex OR !=path_regex                                                                                                                                                                                                                                                                                                                                                         |             |
-| flag: `--skip-jwt-bearer-tokens`<br/>toml: `skip_jwt_bearer_tokens`           | bool           | will skip requests that have verified JWT bearer tokens (the token must have [`aud`](https://en.wikipedia.org/wiki/JSON_Web_Token#Standard_fields) that matches this client id or one of the extras from `extra-jwt-issuers`)                                                                                                                                                                                                                                                                                         | false       |
-| flag: `--skip-provider-button`<br/>toml: `skip_provider_button`               | bool           | will skip sign-in-page to directly reach the next step: oauth/start                                                                                                                                                                                                                                                                                                                                                                                                                                                   | false       |
-| flag: `--ssl-insecure-skip-verify`<br/>toml: `ssl_insecure_skip_verify`       | bool           | skip validation of certificates presented when using HTTPS providers                                                                                                                                                                                                                                                                                                                                                                                                                                                  | false       |
-| flag: `--trusted-ip`<br/>toml: `trusted_ips`                                  | string \| list | list of IPs or CIDR ranges to allow to bypass authentication (may be given multiple times). When combined with `--reverse-proxy` and optionally `--real-client-ip-header` this will evaluate the trust of the IP stored in an HTTP header by a reverse proxy rather than the layer-3/4 remote address. WARNING: trusting IPs has inherent security flaws, especially when obtaining the IP address from an HTTP header (reverse-proxy mode). Use this option only if you understand the risks and how to manage them. |             |
-| flag: `--whitelist-domain`<br/>toml: `whitelist_domains`                      | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` or a `*.` to allow subdomains (e.g. `.example.com`, `*.example.com`)&nbsp;[^2]                                                                                                                                                                                                                                                                                                                                                         |             |
-
-[^2]: When using the `whitelist-domain` option, any domain prefixed with a `.` or a `*.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URL's protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
-
-### Server Options
-
-| Flag / Config Field                                                 | Type           | Description                                                                                                                                                                                                                                                                                                   | Default            |
-| ------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
-| flag: `--http-address`<br/>toml: `http_address`                     | string         | `[http://]<addr>:<port>` or `unix://<path>` or `fd:<int>` (case insensitive) to listen on for HTTP clients. Square brackets are required for ipv6 address, e.g. `http://[::1]:4180`                                                                                                                           | `"127.0.0.1:4180"` |
-| flag: `--https-address`<br/>toml: `https_address`                   | string         | `[https://]<addr>:<port>` to listen on for HTTPS clients. Square brackets are required for ipv6 address, e.g. `https://[::1]:443`                                                                                                                                                                             | `":443"`           |
-| flag: `--metrics-address`<br/>toml: `metrics_address`               | string         | the address prometheus metrics will be scraped from                                                                                                                                                                                                                                                           | `""`               |
-| flag: `--metrics-secure-address`<br/>toml: `metrics_secure_address` | string         | the address prometheus metrics will be scraped from if using HTTPS                                                                                                                                                                                                                                            | `""`               |
-| flag: `--metrics-tls-cert-file`<br/>toml: `metrics_tls_cert_file`   | string         | path to certificate file for secure metrics server                                                                                                                                                                                                                                                            | `""`               |
-| flag: `--metrics-tls-key-file`<br/>toml: `metrics_tls_key_file`     | string         | path to private key file for secure metrics server                                                                                                                                                                                                                                                            | `""`               |
-| flag: `--tls-cert-file`<br/>toml: `tls_cert_file`                   | string         | path to certificate file                                                                                                                                                                                                                                                                                      |                    |
-| flag: `--tls-key-file`<br/>toml: `tls_key_file`                     | string         | path to private key file                                                                                                                                                                                                                                                                                      |                    |
-| flag: `--tls-cipher-suite`<br/>toml: `tls_cipher_suites`            | string \| list | Restricts TLS cipher suites used by server to those listed (e.g. TLS_RSA_WITH_RC4_128_SHA) (may be given multiple times). If not specified, the default Go safe cipher list is used. List of valid cipher suites can be found in the [crypto/tls documentation](https://pkg.go.dev/crypto/tls#pkg-constants). |                    |
-| flag: `--tls-min-version`<br/>toml: `tls_min_version`               | string         | minimum TLS version that is acceptable, either `"TLS1.2"` or `"TLS1.3"`                                                                                                                                                                                                                                       | `"TLS1.2"`         |
-
-### Session Options
-
-| Flag / Config Field                                                                 | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                   | Default |
-| ----------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| flag: `--session-cookie-minimal`<br/>toml: `session_cookie_minimal`                 | bool           | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only)                                                                                                                                                                                                                                                                                                               | false   |
-| flag: `--session-store-type`<br/>toml: `session_store_type`                         | string         | [Session data storage backend](sessions.md); redis or cookie                                                                                                                                                                                                                                                                                                                                                  | cookie  |
-| flag: `--redis-cluster-connection-urls`<br/>toml: `redis_cluster_connection_urls`   | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster`                                                                                                                                                                                                                                                                                            |         |
-| flag: `--redis-connection-url`<br/>toml: `redis_connection_url`                     | string         | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`)                                                                                                                                                                                                                                                                                                                                    |         |
-| flag: `--redis-insecure-skip-tls-verify`<br/>toml: `redis_insecure_skip_tls_verify` | bool           | skip TLS verification when connecting to Redis                                                                                                                                                                                                                                                                                                                                                                | false   |
-| flag: `--redis-password`<br/>toml: `redis_password`                                 | string         | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url`                                                                                                                                                                                                                                                                                           |         |
-| flag: `--redis-sentinel-password`<br/>toml: `redis_sentinel_password`               | string         | Redis sentinel password. Used only for sentinel connection; any redis node passwords need to use `--redis-password`                                                                                                                                                                                                                                                                                           |         |
-| flag: `--redis-sentinel-master-name`<br/>toml: `redis_sentinel_master_name`         | string         | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel`                                                                                                                                                                                                                                                                                                                                   |         |
-| flag: `--redis-sentinel-connection-urls`<br/>toml: `redis_sentinel_connection_urls` | string \| list | List of Redis sentinel connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-sentinel`                                                                                                                                                                                                                                                                                          |         |
-| flag: `--redis-use-cluster`<br/>toml: `redis_use_cluster`                           | bool           | Connect to redis cluster. Must set `--redis-cluster-connection-urls` to use this feature                                                                                                                                                                                                                                                                                                                      | false   |
-| flag: `--redis-use-sentinel`<br/>toml: `redis_use_sentinel`                         | bool           | Connect to redis via sentinels. Must set `--redis-sentinel-master-name` and `--redis-sentinel-connection-urls` to use this feature                                                                                                                                                                                                                                                                            | false   |
-| flag: `--redis-connection-idle-timeout`<br/>toml: `redis_connection_idle_timeout`   | int            | Redis connection idle timeout seconds. If Redis [timeout](https://redis.io/docs/reference/clients/#client-timeouts) option is set to non-zero, the `--redis-connection-idle-timeout` must be less than Redis timeout option. Example: if either redis.conf includes `timeout 15` or using `CONFIG SET timeout 15` the `--redis-connection-idle-timeout` must be at least `--redis-connection-idle-timeout=14` | 0       |
-
-### Upstream Options
-
-| Flag / Config Field                                                                       | Type           | Description                                                                                                                                            | Default |
-| ----------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
-| flag: `--flush-interval`<br/>toml: `flush_interval`                                       | duration       | period between flushing response buffers when streaming responses                                                                                      | `"1s"`  |
-| flag: `--pass-host-header`<br/>toml: `pass_host_header`                                   | bool           | pass the request Host Header to upstream                                                                                                               | true    |
-| flag: `--proxy-websockets`<br/>toml: `proxy_websockets`                                   | bool           | enables WebSocket proxying                                                                                                                             | true    |
-| flag: `--ssl-upstream-insecure-skip-verify`<br/>toml: `ssl_upstream_insecure_skip_verify` | bool           | skip validation of certificates presented when using HTTPS upstreams                                                                                   | false   |
-| flag: `--disable-keep-alives`<br/>toml: `disable_keep_alives`                             | bool           | disable HTTP keep-alive connections to the upstream server                                                                                             | false   |
-| flag: `--upstream-timeout`<br/>toml: `upstream_timeout`                                   | duration       | maximum amount of time the server will wait for a response from the upstream                                                                           | 30s     |
-| flag: `--upstream`<br/>toml: `upstreams`                                                  | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://<status_code>` for static response. Routing is based on the path |         |
-
-## Upstreams Configuration
+### Upstreams Configuration
 
 `oauth2-proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers, unix socket or serve static files from the file system.
 
-To configure **HTTP and HTTPS upstreams**, provide such a URL in `--upstream=URL`. The scheme+host portion and the path portion are extracted to configure proxying behavior. When processing incoming requests, the path portion becomes a lookup key for selecting the destination server of the proxied request.
+HTTP and HTTPS upstreams are configured by providing a URL such as `http://127.0.0.1:8080/` for the upstream parameter. . This will forward all authenticated requests to the upstream server. If you instead provide `http://127.0.0.1:8080/some/path/` then it will only be requests that start with `/some/path/` which are forwarded to the upstream.
 
-* Upstream URLs *without a trailing slash,* like in `--upstream=http://service2.internal/foo`, will match an incoming request exactly to `/foo` in `https://this.o2p.example.com/foo`, and forward the request on to service2.internal, but not match a request to `https://this.o2p.example.com/foo/more` nor ...`.com/food`.
-* Upstream URLs *with a trailing slash,* like in `--upstream=http://service1.internal/foo/`, will match any incoming request to any incoming requests's path *starting with* `/foo/`, like `/foo/` and `/foo/more` and `/foo/lots/more?etc`.
+Unix socket upstreams are configured as `unix:///path/to/unix.sock`.
 
-If multiple `--upstream` URLs' paths match an incoming request, the one with the longest matching path (the most specific match) takes priority over shorter (less specific) ones.
-
-**Unix socket upstreams** are configured as `unix:///path/to/unix.sock`.
-
-**Static file paths** are configured as a file:// URL. `file:///var/www/static/` will serve the files from that directory at `http://[oauth2-proxy url]/var/www/static/`, which may not be what you want. You can provide the path to where the files should be available by adding a fragment to the configured URL. The value of the fragment will then be used to specify which path the files are available at, e.g. `file:///var/www/static/#/static/` will make `/var/www/static/` available at `http://[oauth2-proxy url]/static/`.
+Static file paths are configured as a file:// URL. `file:///var/www/static/` will serve the files from that directory at `http://[oauth2-proxy url]/var/www/static/`, which may not be what you want. You can provide the path to where the files should be available by adding a fragment to the configured URL. The value of the fragment will then be used to specify which path the files are available at, e.g. `file:///var/www/static/#/static/` will make `/var/www/static/` available at `http://[oauth2-proxy url]/static/`.
 
 Multiple upstreams can either be configured by supplying a comma separated list to the `--upstream` parameter, supplying the parameter multiple times or providing a list in the [config file](#config-file). When multiple upstreams are used routing to them will be based on the path they are set up with.
 
-## Environment variables
+### Environment variables
 
 Every command line argument can be specified as an environment variable by
 prefixing it with `OAUTH2_PROXY_`, capitalising it, and replacing hyphens (`-`)
@@ -292,15 +238,8 @@ environment variable should be plural (trailing `S`).
 This is particularly useful for storing secrets outside a configuration file
 or the command line.
 
-For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.
-If a flag has the type `string | list` like the `--email-domain` flag it is
-available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS`
-
-Values for type `string | list` usually have a plural environment variable name
-and need to be seperated by `,` e.g.
-`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"`
-
-Please check the type for each [config option](#config-options) first.
+For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`,
+and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`.
 
 ## Logging Configuration
 
@@ -314,12 +253,11 @@ Each type of logging has its own configurable format and variables. By default,
 
 Logging of requests to the `/ping` endpoint (or using `--ping-user-agent`) and the `/ready` endpoint can be disabled with `--silence-ping-logging` reducing log volume.
 
-## Auth Log Format
-
+### Auth Log Format
 Authentication logs are logs which are guaranteed to contain a username or email address of a user attempting to authenticate. These logs are output by default in the below format:
 
 ```
-<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [2015/03/19 17:20:19] [<STATUS>] <MESSAGE>
+<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [19/Mar/2015:17:20:19 -0400] [<STATUS>] <MESSAGE>
 ```
 
 The status block will contain one of the below strings:
@@ -337,25 +275,24 @@ The default format is configured as follows:
 
 Available variables for auth logging:
 
-| Variable      | Example                              | Description                                                                                              |
-| ------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
-| Client        | 74.125.224.72                        | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
-| Host          | domain.com                           | The value of the Host header.                                                                            |
-| Message       | Authenticated via OAuth2             | The details of the auth attempt.                                                                         |
-| Protocol      | HTTP/1.0                             | The request protocol.                                                                                    |
-| RequestID     | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty                               |
-| RequestMethod | GET                                  | The request method.                                                                                      |
-| Timestamp     | 2015/03/19 17:20:19                  | The date and time of the logging event.                                                                  |
-| UserAgent     | -                                    | The full user agent as reported by the requesting client.                                                |
-| Username      | username@email.com                   | The email or username of the auth request.                                                               |
-| Status        | AuthSuccess                          | The status of the auth request. See above for details.                                                   |
-
-## Request Log Format
+| Variable | Example | Description |
+| --- | --- | --- |
+| Client | 74.125.224.72 | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
+| Host  | domain.com | The value of the Host header. |
+| Message | Authenticated via OAuth2 | The details of the auth attempt. |
+| Protocol | HTTP/1.0 | The request protocol. |
+| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |
+| RequestMethod | GET | The request method. |
+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |
+| UserAgent | - | The full user agent as reported by the requesting client. |
+| Username | username@email.com | The email or username of the auth request. |
+| Status | AuthSuccess | The status of the auth request. See above for details. |
 
+### Request Log Format
 HTTP request logs will output by default in the below format:
 
 ```
-<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [2015/03/19 17:20:19] <HOST_HEADER> GET <UPSTREAM_HOST> "/path/" HTTP/1.1 "<USER_AGENT>" <RESPONSE_CODE> <RESPONSE_BYTES> <REQUEST_DURATION>
+<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [19/Mar/2015:17:20:19 -0400] <HOST_HEADER> GET <UPSTREAM_HOST> "/path/" HTTP/1.1 "<USER_AGENT>" <RESPONSE_CODE> <RESPONSE_BYTES> <REQUEST_DURATION>
 ```
 
 If you require a different format than that, you can configure it with the `--request-logging-format` flag.
@@ -367,28 +304,27 @@ The default format is configured as follows:
 
 Available variables for request logging:
 
-| Variable        | Example                              | Description                                                                                              |
-| --------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
-| Client          | 74.125.224.72                        | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
-| Host            | domain.com                           | The value of the Host header.                                                                            |
-| Protocol        | HTTP/1.0                             | The request protocol.                                                                                    |
-| RequestDuration | 0.001                                | The time in seconds that a request took to process.                                                      |
-| RequestID       | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty                               |
-| RequestMethod   | GET                                  | The request method.                                                                                      |
-| RequestURI      | "/oauth2/auth"                       | The URI path of the request.                                                                             |
-| ResponseSize    | 12                                   | The size in bytes of the response.                                                                       |
-| StatusCode      | 200                                  | The HTTP status code of the response.                                                                    |
-| Timestamp       | 2015/03/19 17:20:19                  | The date and time of the logging event.                                                                  |
-| Upstream        | -                                    | The upstream data of the HTTP request.                                                                   |
-| UserAgent       | -                                    | The full user agent as reported by the requesting client.                                                |
-| Username        | username@email.com                   | The email or username of the auth request.                                                               |
-
-## Standard Log Format
+| Variable | Example | Description |
+| --- | --- | --- |
+| Client | 74.125.224.72 | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
+| Host  | domain.com | The value of the Host header. |
+| Protocol | HTTP/1.0 | The request protocol. |
+| RequestDuration | 0.001 | The time in seconds that a request took to process. |
+| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |
+| RequestMethod | GET | The request method. |
+| RequestURI | "/oauth2/auth" | The URI path of the request. |
+| ResponseSize | 12 | The size in bytes of the response. |
+| StatusCode | 200 | The HTTP status code of the response. |
+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |
+| Upstream | - | The upstream data of the HTTP request. |
+| UserAgent | - | The full user agent as reported by the requesting client. |
+| Username | username@email.com | The email or username of the auth request. |
 
+### Standard Log Format
 All other logging that is not covered by the above two types of logging will be output in this standard logging format. This includes configuration information at startup and errors that occur outside of a session. The default format is below:
 
 ```
-[2015/03/19 17:20:19] [main.go:40] <MESSAGE>
+[19/Mar/2015:17:20:19 -0400] [main.go:40] <MESSAGE>
 ```
 
 If you require a different format than that, you can configure it with the `--standard-logging-format` flag. The default format is configured as follows:
@@ -399,8 +335,274 @@ If you require a different format than that, you can configure it with the `--st
 
 Available variables for standard logging:
 
-| Variable  | Example                           | Description                                        |
-| --------- | --------------------------------- | -------------------------------------------------- |
-| Timestamp | 2015/03/19 17:20:19               | The date and time of the logging event.            |
-| File      | main.go:40                        | The file and line number of the logging statement. |
-| Message   | HTTP: listening on 127.0.0.1:4180 | The details of the log statement.                  |
+| Variable | Example | Description |
+| --- | --- | --- |
+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |
+| File | main.go:40 | The file and line number of the logging statement. |
+| Message | HTTP: listening on 127.0.0.1:4180 | The details of the log statement. |
+
+## Configuring for use with the Nginx `auth_request` directive
+
+**This option requires `--reverse-proxy` option to be set.**
+
+The [Nginx `auth_request` directive](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html) allows Nginx to authenticate requests via the oauth2-proxy's `/auth` endpoint, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the request through. For example:
+
+```nginx
+server {
+  listen 443 ssl;
+  server_name ...;
+  include ssl/ssl.conf;
+
+  location /oauth2/ {
+    proxy_pass       http://127.0.0.1:4180;
+    proxy_set_header Host                    $host;
+    proxy_set_header X-Real-IP               $remote_addr;
+    proxy_set_header X-Auth-Request-Redirect $request_uri;
+    # or, if you are handling multiple domains:
+    # proxy_set_header X-Auth-Request-Redirect $scheme://$host$request_uri;
+  }
+  location = /oauth2/auth {
+    proxy_pass       http://127.0.0.1:4180;
+    proxy_set_header Host             $host;
+    proxy_set_header X-Real-IP        $remote_addr;
+    proxy_set_header X-Forwarded-Uri  $request_uri;
+    # nginx auth_request includes headers but not body
+    proxy_set_header Content-Length   "";
+    proxy_pass_request_body           off;
+  }
+
+  location / {
+    auth_request /oauth2/auth;
+    error_page 401 =403 /oauth2/sign_in;
+
+    # pass information via X-User and X-Email headers to backend,
+    # requires running with --set-xauthrequest flag
+    auth_request_set $user   $upstream_http_x_auth_request_user;
+    auth_request_set $email  $upstream_http_x_auth_request_email;
+    proxy_set_header X-User  $user;
+    proxy_set_header X-Email $email;
+
+    # if you enabled --pass-access-token, this will pass the token to the backend
+    auth_request_set $token  $upstream_http_x_auth_request_access_token;
+    proxy_set_header X-Access-Token $token;
+
+    # if you enabled --cookie-refresh, this is needed for it to work with auth_request
+    auth_request_set $auth_cookie $upstream_http_set_cookie;
+    add_header Set-Cookie $auth_cookie;
+
+    # When using the --set-authorization-header flag, some provider's cookies can exceed the 4kb
+    # limit and so the OAuth2 Proxy splits these into multiple parts.
+    # Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,
+    # so if your cookies are larger than 4kb, you will need to extract additional cookies manually.
+    auth_request_set $auth_cookie_name_upstream_1 $upstream_cookie_auth_cookie_name_1;
+
+    # Extract the Cookie attributes from the first Set-Cookie header and append them
+    # to the second part ($upstream_cookie_* variables only contain the raw cookie content)
+    if ($auth_cookie ~* "(; .*)") {
+        set $auth_cookie_name_0 $auth_cookie;
+        set $auth_cookie_name_1 "auth_cookie_name_1=$auth_cookie_name_upstream_1$1";
+    }
+
+    # Send both Set-Cookie headers now if there was a second part
+    if ($auth_cookie_name_upstream_1) {
+        add_header Set-Cookie $auth_cookie_name_0;
+        add_header Set-Cookie $auth_cookie_name_1;
+    }
+
+    proxy_pass http://backend/;
+    # or "root /path/to/site;" or "fastcgi_pass ..." etc
+  }
+}
+```
+
+When you use ingress-nginx in Kubernetes, you MUST use `kubernetes/ingress-nginx` (which includes the Lua module) and the following configuration snippet for your `Ingress`.
+Variables set with `auth_request_set` are not `set`-able in plain nginx config when the location is processed via `proxy_pass` and then may only be processed by Lua.
+Note that `nginxinc/kubernetes-ingress` does not include the Lua module.
+
+```yaml
+nginx.ingress.kubernetes.io/auth-response-headers: Authorization
+nginx.ingress.kubernetes.io/auth-signin: https://$host/oauth2/start?rd=$escaped_request_uri
+nginx.ingress.kubernetes.io/auth-url: https://$host/oauth2/auth
+nginx.ingress.kubernetes.io/configuration-snippet: |
+  auth_request_set $name_upstream_1 $upstream_cookie_name_1;
+
+  access_by_lua_block {
+    if ngx.var.name_upstream_1 ~= "" then
+      ngx.header["Set-Cookie"] = "name_1=" .. ngx.var.name_upstream_1 .. ngx.var.auth_cookie:match("(; .*)")
+    end
+  }
+```
+It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
+
+You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable  should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
+
+## Configuring for use with the Traefik (v2) `ForwardAuth` middleware
+
+**This option requires `--reverse-proxy` option to be set.**
+
+### ForwardAuth with 401 errors middleware
+
+The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
+
+```yaml
+http:
+  routers:
+    a-service:
+      rule: "Host(`a-service.example.com`)"
+      service: a-service-backend
+      middlewares:
+        - oauth-errors
+        - oauth-auth
+      tls:
+        certResolver: default
+        domains:
+          - main: "example.com"
+            sans:
+              - "*.example.com"
+    oauth:
+      rule: "Host(`a-service.example.com`, `oauth.example.com`) && PathPrefix(`/oauth2/`)"
+      middlewares:
+        - auth-headers
+      service: oauth-backend
+      tls:
+        certResolver: default
+        domains:
+          - main: "example.com"
+            sans:
+              - "*.example.com"
+
+  services:
+    a-service-backend:
+      loadBalancer:
+        servers:
+          - url: http://172.16.0.2:7555
+    oauth-backend:
+      loadBalancer:
+        servers:
+          - url: http://172.16.0.1:4180
+
+  middlewares:
+    auth-headers:
+      headers:
+        sslRedirect: true
+        stsSeconds: 315360000
+        browserXssFilter: true
+        contentTypeNosniff: true
+        forceSTSHeader: true
+        sslHost: example.com
+        stsIncludeSubdomains: true
+        stsPreload: true
+        frameDeny: true
+    oauth-auth:
+      forwardAuth:
+        address: https://oauth.example.com/oauth2/auth
+        trustForwardHeader: true
+    oauth-errors:
+      errors:
+        status:
+          - "401-403"
+        service: oauth-backend
+        query: "/oauth2/sign_in?rd={url}"
+```
+
+### ForwardAuth with static upstreams configuration
+
+Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
+
+**Following options need to be set on `oauth2-proxy`:**
+- `--upstream=static://202`: Configures a static response for authenticated sessions
+- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly
+
+```yaml
+http:
+  routers:
+    a-service-route-1:
+      rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/`)"
+      service: a-service-backend
+      middlewares:
+        - oauth-auth-redirect # redirects all unauthenticated to oauth2 signin
+      tls:
+        certResolver: default
+        domains:
+          - main: "example.com"
+            sans:
+              - "*.example.com"
+    a-service-route-2:
+      rule: "Host(`a-service.example.com`) && PathPrefix(`/no-auto-redirect`)"
+      service: a-service-backend
+      middlewares:
+        - oauth-auth-wo-redirect # unauthenticated session will return a 401
+      tls:
+        certResolver: default
+        domains:
+          - main: "example.com"
+            sans:
+              - "*.example.com"
+    services-oauth2-route:
+      rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/oauth2/`)"
+      middlewares:
+        - auth-headers
+      service: oauth-backend
+      tls:
+        certResolver: default
+        domains:
+          - main: "example.com"
+            sans:
+              - "*.example.com"
+    oauth2-proxy-route:
+      rule: "Host(`oauth.example.com`) && PathPrefix(`/`)"
+      middlewares:
+        - auth-headers
+      service: oauth-backend
+      tls:
+        certResolver: default
+        domains:
+          - main: "example.com"
+            sans:
+              - "*.example.com"
+
+  services:
+    a-service-backend:
+      loadBalancer:
+        servers:
+          - url: http://172.16.0.2:7555
+    b-service-backend:
+      loadBalancer:
+        servers:
+          - url: http://172.16.0.3:7555
+    oauth-backend:
+      loadBalancer:
+        servers:
+          - url: http://172.16.0.1:4180
+
+  middlewares:
+    auth-headers:
+      headers:
+        sslRedirect: true
+        stsSeconds: 315360000
+        browserXssFilter: true
+        contentTypeNosniff: true
+        forceSTSHeader: true
+        sslHost: example.com
+        stsIncludeSubdomains: true
+        stsPreload: true
+        frameDeny: true
+    oauth-auth-redirect:
+      forwardAuth:
+        address: https://oauth.example.com/
+        trustForwardHeader: true
+        authResponseHeaders:
+          - X-Auth-Request-Access-Token
+          - Authorization
+    oauth-auth-wo-redirect:
+      forwardAuth:
+        address: https://oauth.example.com/oauth2/auth
+        trustForwardHeader: true
+        authResponseHeaders:
+          - X-Auth-Request-Access-Token
+          - Authorization
+```
+
+:::note
+If you set up your OAuth2 provider to rotate your client secret, you can use the `client-secret-file` option to reload the secret when it is updated.
+:::

docs/docs/configuration/providers/azure.md

@@ -3,15 +3,6 @@ id: azure
 title: Azure
 ---
 
-## Config Options
-
-| Flag             | Toml Field     | Type   | Description                                                      | Default    |
-| ---------------- | -------------- | ------ | ---------------------------------------------------------------- | ---------- |
-| `--azure-tenant` | `azure_tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` |
-| `--resource`     | `resource`     | string | The resource that is protected (Azure AD only)                   |            |
-
-## Usage
-
 1. Add an application: go to [https://portal.azure.com](https://portal.azure.com), choose **Azure Active Directory**, select
    **App registrations** and then click on **New registration**.
 2. Pick a name, check the supported account type(single-tenant, multi-tenant, etc). In the **Redirect URI** section create a new

docs/docs/configuration/providers/azure_ad.md

@@ -0,0 +1,9 @@
+---
+id: azure_ad
+title: Microsoft Azure AD
+---
+
+For adding an application to the Microsoft Azure AD follow [these steps to add an application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app).
+
+Take note of your `TenantId` if applicable for your situation. The `TenantId` can be used to override the default 
+`common` authorization server with a tenant specific server.

docs/docs/configuration/providers/cidaas.md

@@ -1,37 +0,0 @@
----
-id: cidaas
-title: Cidaas
----
-
-[Cidaas](https://www.cidaas.com/) is an Identity as a Service (IDaaS) solution that provides authentication and authorization services. 
-It supports various protocols including OpenID Connect, OAuth 2.0, and SAML.
-
-However, Cidaas provides groups and their roles as hierarchical claims, which are not supported by oauth2-proxy yet.
-The Cidaas provider transforms the hierarchical claims into a flat list of groups, which can be used by oauth2-proxy.
-
-Example of groups and roles in Cidaas:
-
-```json
-{
-  "groups": [
-    {
-      "groupId": "group1",
-      "roles": ["role1", "role2"]
-    },
-    {
-      "groupId": "group2",
-      "roles": ["role3"]
-    }
-  ]
-}
-```
-
-This will be transformed into a flat list of groups:
-
-```json
-{
-  "groups": ["group1:role1", "group2:role2", "group2:role3"]
-}
-```
-
-Apart from that the Cidaas provider inherits all the features of the [OpenID Connect provider](openid_connect.md).

docs/docs/configuration/providers/gitea.md

@@ -1,12 +1,8 @@
 ---
 id: gitea
-title: Gitea / Forgejo
+title: Gitea
 ---
 
-:::note
-This is not actually a fully serparate provider. For more details and options please refer to the [GitHub Provider Options](github.md)
-:::
-
 1. Create a new application: `https://< your gitea host >/user/settings/applications`
 2. Under `Redirect URI` enter the correct URL i.e. `https://<proxied host>/oauth2/callback`
 3. Note the Client ID and Client Secret.

docs/docs/configuration/providers/github.md

@@ -3,18 +3,6 @@ id: github
 title: GitHub
 ---
 
-## Config Options
-
-| Flag             | Toml Field     | Type           | Description                                                                                                   | Default |
-| ---------------- | -------------- | -------------- | ------------------------------------------------------------------------------------------------------------- | ------- |
-| `--github-org`   | `github_org`   | string         | restrict logins to members of this organisation                                                               |         |
-| `--github-team`  | `github_team`  | string         | restrict logins to members of any of these teams (slug) or (org:team), comma separated                        |         |
-| `--github-repo`  | `github_repo`  | string         | restrict logins to collaborators of this repository formatted as `orgname/repo`                               |         |
-| `--github-token` | `github_token` | string         | the token to use when verifying repository collaborators (must have push access to the repository)            |         |
-| `--github-user`  | `github_users` | string \| list | To allow users to login by username even if they do not belong to the specified org and team or collaborators |         |
-
-## Usage
-
 1.  Create a new project: https://github.com/settings/developers
 2.  Under `Authorization callback URL` enter the correct url ie `https://internal.yourcompany.com/oauth2/callback`
 
@@ -24,36 +12,23 @@ team level access, or to collaborators of a repository. Restricting by these opt
 NOTE: When `--github-user` is set, the specified users are allowed to log in even if they do not belong to the specified 
 org and team or collaborators.
 
-To restrict access to your organization:
+To restrict by organization only, include the following flag:
 
 ```shell
-    # restrict logins to members of this organisation
-    --github-org="your-org"
+    --github-org=""  # restrict logins to members of this organisation
 ```
 
-To restrict access to specific teams within an organization:
+To restrict within an organization to specific teams, include the following flag in addition to `-github-org`:
 
 ```shell
-    --github-org="your-org"
-    # restrict logins to members of any of these teams (slug), comma separated
-    --github-team="team1,team2,team3"
-```
-
-To restrict to teams within different organizations, keep the organization flag empty and use `--github-team` like so:
-
-```shell
-    # keep empty
-    --github-org=""
-    # restrict logins to members to any of the following teams (format <org>:<slug>, like octo:team1), comma separated
-    --github-team="org1:team1,org2:team1,org3:team42,octo:cat"
+    --github-team=""  # restrict logins to members of any of these teams (slug), separated by a comma
 ```
 
 If you would rather restrict access to collaborators of a repository, those users must either have push access to a 
 public repository or any access to a private repository:
 
 ```shell
-    # restrict logins to collaborators of this repository formatted as orgname/repo
-    --github-repo=""
+    --github-repo=""  # restrict logins to collaborators of this repository formatted as orgname/repo
 ```
 
 If you'd like to allow access to users with **read only** access to a **public** repository you will need to provide a 
@@ -61,15 +36,14 @@ If you'd like to allow access to users with **read only** access to a **public**
 created with at least the `public_repo` scope:
 
 ```shell
-    # the token to use when verifying repository collaborators
-    --github-token=""
+    --github-token=""  # the token to use when verifying repository collaborators
 ```
 
-To allow a user to log in with their username even if they do not belong to the specified org and team or collaborators:
+To allow a user to log in with their username even if they do not belong to the specified org and team or collaborators, 
+separated by a comma
 
 ```shell
-    # allow logins by username, comma separated
-    --github-user=""
+    --github-user="" #allow logins by username, separated by a comma
 ```
 
 If you are using GitHub enterprise, make sure you set the following to the appropriate url:

docs/docs/configuration/providers/gitlab.md

@@ -3,20 +3,11 @@ id: gitlab
 title: GitLab
 ---
 
-## Config Options
-
-| Flag                | Toml Field        | Type           | Description                                                                                                                                                                                                                                                                           | Default |
-| ------------------- | ----------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| `--gitlab-group`    | `gitlab_groups`   | string \| list | restrict logins to members of any of these groups (slug), separated by a comma                                                                                                                                                                                                        |         |
-| `--gitlab-projects` | `gitlab_projects` | string \| list | restrict logins to members of any of these projects (may be given multiple times) formatted as `orgname/repo=accesslevel`. Access level should be a value matching [Gitlab access levels](https://docs.gitlab.com/ee/api/members.html#valid-access-levels), defaulted to 20 if absent |         |
-
-## Usage
-
 This auth provider has been tested against Gitlab version 12.X. Due to Gitlab API changes, it may not work for version 
 prior to 12.X (see [994](https://github.com/oauth2-proxy/oauth2-proxy/issues/994)).
 
 Whether you are using GitLab.com or self-hosting GitLab, follow 
-[these steps to add an application](https://docs.gitlab.com/integration/oauth_provider/). Make sure to enable at
+[these steps to add an application](https://docs.gitlab.com/ce/integration/oauth_provider.html). Make sure to enable at 
 least the `openid`, `profile` and `email` scopes, and set the redirect url to your application url e.g. 
 https://myapp.com/oauth2/callback.
 

docs/docs/configuration/providers/google.md

@@ -3,18 +3,6 @@ id: google
 title: Google (default)
 ---
 
-## Config Options
-
-| Flag                                           | Toml Field                                   | Type   | Description                                                                                      | Default                                            |
-| ---------------------------------------------- | -------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
-| `--google-admin-email`                         | `google_admin_email`                         | string | the google admin to impersonate for api calls                                                    |                                                    |
-| `--google-group`                               | `google_groups`                              | string | restrict logins to members of this google group (may be given multiple times). If not specified and service account or default credentials are configured, all user groups will be allowed.                   |                                                    |
-| `--google-service-account-json`                | `google_service_account_json`                | string | the path to the service account json credentials                                                 |                                                    |
-| `--google-use-application-default-credentials` | `google_use_application_default_credentials` | bool   | use application default credentials instead of service account json (i.e. GKE Workload Identity) |                                                    |
-| `--google-target-principal`                    | `google_target_principal`                    | bool   | the target principal to impersonate when using ADC                                               | defaults to the service account configured for ADC |
-
-## Usage
-
 For Google, the registration steps are:
 
 1.  Create a new project: https://console.developers.google.com/project
@@ -37,17 +25,18 @@ account is still authorized.
 
 #### Restrict auth to specific Google groups on your domain. (optional)
 
-1.  Create a [service account](https://developers.google.com/identity/protocols/oauth2/service-account) and configure it 
+1.  Create a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) and configure it 
     to use [Application Default Credentials / Workload Identity / Workload Identity Federation (recommended)](#using-application-default-credentials-adc--workload-identity--workload-identity-federation-recommended) or, 
     alternatively download the JSON.
 2.  Make note of the Client ID for a future step.
 3.  Under "APIs & Auth", choose APIs.
 4.  Click on Admin SDK and then Enable API.
-5.  Follow the steps on [Set up domain-wide delegation for a service account](https://developers.google.com/workspace/guides/create-credentials#optional_set_up_domain-wide_delegation_for_a_service_account)
+5.  Follow the steps on https://developers.google.com/admin-sdk/directory/v1/guides/delegation#delegate_domain-wide_authority_to_your_service_account 
     and give the client id from step 2 the following oauth scopes:
 
     ```
-    https://www.googleapis.com/auth/admin.directory.group.member.readonly
+    https://www.googleapis.com/auth/admin.directory.group.readonly
+    https://www.googleapis.com/auth/admin.directory.user.readonly
     ```
 
 6.  Follow the steps on https://support.google.com/a/answer/60757 to enable Admin API access.
@@ -58,7 +47,6 @@ account is still authorized.
     of this flag with different groups and the user will be checked against all the provided groups.
 
 (Only if using a JSON file (see step 1))
-
 9.  Lock down the permissions on the json file downloaded from step 1 so only oauth2-proxy is able to read the file and 
     set the path to the file in the `google-service-account-json` flag.
 10. Restart oauth2-proxy.

docs/docs/configuration/providers/index.md

@@ -8,26 +8,23 @@ with Redirect URI(s) for the domain you intend to run `oauth2-proxy` on.
 
 Valid providers are :
 
-- [ADFS](adfs.md)
-- [Bitbucket](bitbucket.md)
-- [Cidaas](cidaas.md)
-- [DigitalOcean](digitalocean.md)
-- [Facebook](facebook.md)
-- [Gitea](gitea.md)
-- [GitHub](github.md)
-- [GitLab](gitlab.md)
 - [Google](google.md) _default_
-- [Keycloak](keycloak.md) (Deprecated)
-- [Keycloak OIDC](keycloak_oidc.md)
+- [Azure](azure.md)
+- [ADFS](adfs.md)
+- [Facebook](facebook.md)
+- [GitHub](github.md)
+- [Gitea](gitea.md)
+- [Keycloak](keycloak.md)/[Keycloak OIDC](keycloak_oidc.md)
+- [GitLab](gitlab.md)
 - [LinkedIn](linkedin.md)
-- [login.gov](login_gov.md)
-- [Microsoft Azure](ms_azure_ad.md) (Deprecated)
-- [Microsoft Entra ID](ms_entra_id.md)
-- [Nextcloud](nextcloud.md)
+- [Microsoft Azure AD](azure_ad.md)
 - [OpenID Connect](openid_connect.md)
-- [SourceHut](sourcehut.md)
+- [login.gov](login_gov.md)
+- [Nextcloud](nextcloud.md)
+- [DigitalOcean](digitalocean.md)
+- [Bitbucket](bitbucket.md)
 
-The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
+The provider can be selected using the `provider` configuration value.
 
 Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the 
 OpenID Connect provider.

docs/docs/configuration/providers/keycloak.md

@@ -1,10 +1,10 @@
 ---
 id: keycloak
-title: Keycloak (Deprecated)
+title: Keycloak
 ---
 
 :::note
-This is the legacy and deprecated provider for Keycloak, use [Keycloak OIDC Auth Provider](keycloak_oidc.md) if possible.
+This is the legacy provider for Keycloak, use [Keycloak OIDC Auth Provider](keycloak_oidc.md) if possible.
 :::
 
 1.  Create new client in your Keycloak realm with **Access Type** 'confidential' and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'

docs/docs/configuration/providers/keycloak_oidc.md

@@ -3,14 +3,6 @@ id: keycloak_oidc
 title: Keycloak OIDC
 ---
 
-## Config Options
-
-| Flag             | Toml Field      | Type           | Description                                                                                                        | Default |
-| ---------------- | --------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ | ------- |
-| `--allowed-role` | `allowed_roles` | string \| list | restrict logins to users with this role (may be given multiple times). Only works with the keycloak-oidc provider. |         |
-
-## Usage
-
 ```
     --provider=keycloak-oidc
     --client-id=<your client's id>

docs/docs/configuration/providers/ms_azure_ad.md

@@ -1,59 +0,0 @@
----
-id: azure
-title: Azure (Deprecated)
----
-
-:::note
-This is the legacy and deprecated provider for Azure, use [Microsoft Entra ID](ms_entra_id.md) if possible.
-:::
-
-## Config Options
-
-| Flag             | Toml Field     | Type   | Description                                                      | Default    |
-| ---------------- | -------------- | ------ | ---------------------------------------------------------------- | ---------- |
-| `--azure-tenant` | `azure_tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` |
-| `--resource`     | `resource`     | string | The resource that is protected (Azure AD only)                   |            |
-
-## Usage
-
-1. Add an application: go to [https://portal.azure.com](https://portal.azure.com), choose **Azure Active Directory**, select
-   **App registrations** and then click on **New registration**.
-2. Pick a name, check the supported account type(single-tenant, multi-tenant, etc). In the **Redirect URI** section create a new
-   **Web** platform entry for each app that you want to protect by the oauth2 proxy(e.g.
-   https://internal.yourcompanycom/oauth2/callback). Click **Register**.
-3. Next we need to add group read permissions for the app registration, on the **API Permissions** page of the app, click on
-   **Add a permission**, select **Microsoft Graph**, then select **Application permissions**, then click on **Group** and select
-   **Group.Read.All**. Hit **Add permissions** and then on **Grant admin consent** (you might need an admin to do this).
-   <br/>**IMPORTANT**: Even if this permission is listed with **"Admin consent required=No"** the consent might actually 
-   be required, due to AAD policies you won't be able to see. If you get a **"Need admin approval"** during login, 
-   most likely this is what you're missing!
-4. Next, if you are planning to use v2.0 Azure Auth endpoint, go to the **Manifest** page and set `"accessTokenAcceptedVersion": 2`
-   in the App registration manifest file.
-5. On the **Certificates & secrets** page of the app, add a new client secret and note down the value after hitting **Add**.
-6. Configure the proxy with:
-- for V1 Azure Auth endpoint (Azure Active Directory Endpoints - https://login.microsoftonline.com/common/oauth2/authorize)
-
-```
-   --provider=azure
-   --client-id=<application ID from step 3>
-   --client-secret=<value from step 5>
-   --azure-tenant={tenant-id}
-   --oidc-issuer-url=https://sts.windows.net/{tenant-id}/
-```
-
-- for V2 Azure Auth endpoint (Microsoft Identity Platform Endpoints - https://login.microsoftonline.com/common/oauth2/v2.0/authorize)
-```
-   --provider=azure
-   --client-id=<application ID from step 3>
-   --client-secret=<value from step 5>
-   --azure-tenant={tenant-id}
-   --oidc-issuer-url=https://login.microsoftonline.com/{tenant-id}/v2.0
-```
-
-***Notes***:
-- When using v2.0 Azure Auth endpoint (`https://login.microsoftonline.com/{tenant-id}/v2.0`) as `--oidc_issuer_url`, in conjunction
-  with `--resource` flag, be sure to append `/.default` at the end of the resource name. See
-  https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent#the-default-scope for more details.
-- When using the Azure Auth provider with nginx and the cookie session store you may find the cookie is too large and doesn't
-  get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the 
-  [redis session storage](../sessions.md#redis-storage) should resolve this.

docs/docs/configuration/providers/ms_entra_id.md

@@ -1,197 +0,0 @@
----
-id: ms_entra_id
-title: Microsoft Entra ID
----
-
-Provider for Microsoft Entra ID. Fully compliant with OIDC, with support for group overage and multi-tenant apps.
-
-## Config Options
-
-The provider is OIDC-compliant, so all the OIDC parameters are honored. Additional provider-specific configuration parameters are:
-
-| Flag                        | Toml Field                 | Type           | Description                                                                                                                                                                                                                                                                               | Default |
-| --------------------------- | -------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| `--entra-id-allowed-tenant` | `entra_id_allowed_tenants` | string \| list | List of allowed tenants. In case of multi-tenant apps, incoming tokens are issued by different issuers and OIDC issuer verification needs to be disabled. When not specified, all tenants are allowed. Redundant for single-tenant apps (regular ID token validation matches the issuer). |         |
-| `--entra-id-federated-token-auth` | `entra_id_federated_token_auth` | boolean | Enable oAuth2 client authentication with federated token projected by Entra Workload Identity plugin, instead of client secret.   | false |
-
-## Configure App registration
-To begin, create an App registration, set a redirect URI, and generate a secret. All account types are supported, including single-tenant, multi-tenant, multi-tenant with Microsoft accounts, and Microsoft accounts only.
-
-<details>
-    <summary>See Azure Portal example</summary>
-    <div class="videoBlock">
-        <iframe src="https://www.youtube.com/embed/IUNfxhOzr4E"></iframe>
-    </div>
-</details>
-
-<details>
-    <summary>See Terraform example</summary>
-```
-    resource "azuread_application" "auth" {
-        display_name     = "oauth2-proxy"
-        sign_in_audience = "AzureADMyOrg" # Others are also supported
-
-        web {
-            redirect_uris = [
-                "https://podinfo.lakis.tech/oauth2/callback",
-            ]
-        }
-        // We don't specify any required API permissions - we allow user consent only
-    }
-
-    resource "azuread_service_principal" "sp" {
-        client_id                    = azuread_application.auth.client_id
-        app_role_assignment_required = false
-    }
-
-    resource "azuread_service_principal_password" "pass" {
-        service_principal_id = azuread_service_principal.sp.id
-    }
-
-```
-</details>
-
-### Configure groups
-If you want to make use of groups, you can configure *groups claim* to be present in ID Tokens issued by the App registration.
-<details>
-    <summary>See Azure Portal example</summary>
-    <div class="videoBlock">
-        <div class="videoBlock">
-            <iframe src="https://www.youtube.com/embed/QZmP5MKEJis"></iframe>
-        </div>
-    </div>
-</details>
-<details>
-    <summary>See Terraform example</summary>
-```
-    resource "azuread_application" "auth" {
-        display_name     = "oauth2-proxy"
-        sign_in_audience = "AzureADMyOrg"
-
-        group_membership_claims = [
-            "SecurityGroup"
-        ]
-
-        web {
-            redirect_uris = [
-                "https://podinfo.lakis.tech/oauth2/callback",
-            ]
-        }
-    }
-
-    resource "azuread_service_principal" "sp" {
-        client_id                    = azuread_application.auth.client_id
-        app_role_assignment_required = false
-    }
-
-    resource "azuread_service_principal_password" "pass" {
-        service_principal_id = azuread_service_principal.sp.id
-    }
-
-```
-</details>
-
-### Scopes and claims
-For single-tenant and multi-tenant apps without groups, the only required scope is `openid` (See: [Scopes and permissions](https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc#the-openid-scope)).
-
-To make use of groups - for example use `allowed_groups` setting or authorize based on groups inside your service - you need to enable *groups claims* in the App Registration. When enabled, list of groups is present in the issued ID token. No additional scopes are required besides `openid`. This works up to 200 groups.
-
-When user has more than 200 group memberships, OAuth2-Proxy attempts to retrieve the complete list from Microsoft Graph API's [`transitiveMemberOf`](https://learn.microsoft.com/en-us/graph/api/user-list-transitivememberof). Endpoint requires `User.Read` scope (delegated permission). This permission can be by default consented by user during first login. Set scope to `openid User.Read` to request user consent. Without proper scope, user with 200+ groups will authenticate with 0 groups. See: [group overages](https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles#group-overages).
-
-Alternatively to user consent, both `openid` and `User.Read` permissions can be consented by admistrator. Then, user is not asked for consent on the first login, and group overage works with `openid` scope only. Admin consent can also be required for some tenants. It can be granted with [azuread_service_principal_delegated_permission_grant](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/service_principal_delegated_permission_grant) terraform resource.
-
-For personal microsoft accounts, required scope is `openid profile email`.
-
-See: [Overview of permissions and consent in the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/permissions-consent-overview).
-
-### Multi-tenant apps
-To authenticate apps from multiple tenants (including personal Microsoft accounts), set the common OIDC issuer url and disable verification:
-```toml
-oidc_issuer_url=https://login.microsoftonline.com/common/v2.0
-insecure_oidc_skip_issuer_verification=true
-```
-`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
-* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
-* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by different tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
-
-To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
-
-### Workload Identity
-Provider supports authentication with federated token, without need of using client secret. Following conditions have to be met:
-
-* Cluster has public OIDC provider URL. For major cloud providers, it can be enabled with a single flag, for example for [Azure Kubernetes Service deployed with Terraform](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/kubernetes_cluster), it's `oidc_issuer_enabled`.
-* Workload Identity admission webhook is deployed on the cluster. For AKS, it can be enabled with a flag (`workload_identity_enabled` in Terraform resource), for clusters outside of Azure, it can be installed from [helm chart](https://github.com/Azure/azure-workload-identity).
-* Appropriate federated credential is added to application registration.
-<details>
-    <summary>See federated credential terraform example</summary>
-```
-    resource "azuread_application_federated_identity_credential" "fedcred" {
-        application_id = azuread_application.application.id # ID of your application
-        display_name   = "federation-cred"
-        description    = "Workload identity for oauth2-proxy"
-        audiences      = ["api://AzureADTokenExchange"] # Fixed value
-        issuer         = "https://cluster-oidc-issuer-url..."
-        subject        = "system:serviceaccount:oauth2-proxy-namespace-name:oauth2-proxy-sa-name" # set proper NS and SA name
-    }
-```
-</details>
-
-* Kubernetes service account associated with oauth2-proxy deployment, is annotated with `azure.workload.identity/client-id: <app-registration-client-id>`
-* oauth2-proxy pod is labeled with `azure.workload.identity/use: "true"`
-* oauth2-proxy is configured with `entra_id_federated_token_auth` set to `true`.
-
-`client_secret` setting can be omitted when using federated token authentication.
-
-See: [Azure Workload Identity documentation](https://azure.github.io/azure-workload-identity/docs/).
-
-### Example configurations
-Single-tenant app without groups (*groups claim* not enabled). Consider using generic OIDC provider:
-```toml
-provider="entra-id"
-oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
-client_id="<client-id>"
-client_secret="<client-secret>"
-scope="openid"
-```
-
-Single-tenant app with up to 200 groups (*groups claim* enabled). Consider using generic OIDC provider:
-```toml
-provider="entra-id"
-oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
-client_id="<client-id>"
-client_secret="<client-secret>"
-scope="openid"
-allowed_groups=["ac51800c-2679-4ecb-8130-636380a3b491"]
-```
-
-Single-tenant app with more than 200 groups:
-```toml
-provider="entra-id"
-oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
-client_id="<client-id>"
-client_secret="<client-secret>"
-scope="openid User.Read"
-allowed_groups=["968b4844-d5e7-4e18-a834-59927959369f"]
-```
-
-Single-tenant app with more than 200 groups and workload identity enabled:
-```toml
-provider="entra-id"
-oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
-client_id="<client-id>"
-scope="openid User.Read"
-allowed_groups=["968b4844-d5e7-4e18-a834-59927959369f"]
-entra_id_federated_token_auth=true
-```
-
-Multi-tenant app with Microsoft personal accounts & one Entra tenant allowed, with group overage considered:
-```toml
-provider="entra-id"
-oidc_issuer_url="https://login.microsoftonline.com/common/v2.0"
-client_id="<client-id>"
-client_secret="<client-secret>"
-insecure_oidc_skip_issuer_verification=true
-scope="openid profile email User.Read"
-entra_id_allowed_tenants=["9188040d-6c67-4c5b-b112-36a304b66dad","<my-tenant-id>"] # Allow only <my-tenant-id> and Personal MS Accounts tenant
-email_domains="*"
-```

docs/docs/configuration/providers/sourcehut.md

@@ -1,25 +0,0 @@
----
-id: sourcehut
-title: SourceHut
----
-
-1.  Create a new OAuth client: https://meta.sr.ht/oauth2
-2.  Under `Redirection URI` enter the correct URL, i.e.
-    `https://internal.yourcompany.com/oauth2/callback`
-
-To use the provider, start with `--provider=sourcehut`.
-
-If you are hosting your own SourceHut instance, make sure you set the following
-to the appropriate URLs:
-
-```shell
-    --login-url="https://<meta.your.instance>/oauth2/authorize"
-    --redeem-url="https://<meta.your.instance>/oauth2/access-token"
-    --profile-url="https://<meta.your.instance>/query"
-    --validate-url="https://<meta.your.instance>/profile"
-```
-
-The default configuration allows everyone with an account to authenticate.
-Restricting access is currently only supported by
-[email](index.md#email-authentication).
-

docs/docs/configuration/sessions.md

@@ -60,15 +60,13 @@ Two settings are used to configure the OAuth2 Proxy cookie lifetime:
 
 The "cookie-expire" value should be equal to the lifetime of the Refresh-Token that is issued by the OAuth2 authorization server.
 If it expires earlier and is deleted by the browser, OAuth2 Proxy cannot find the stored Refresh-Tokens in Redis and thus cannot start
-the refresh flow to get a new Access-Token. If it is longer, it might be that the old Refresh-Token will be found in Redis but has already
+the refresh flow to get new Access-Tokens. If it is longer, it might be that the old Refresh-Token will be found in Redis but has already
 expired.
 
 The "cookie-refresh" value controls when OAuth2 Proxy tries to refresh an Access-Token. If it is set to "0", the
-Access-Token will never be refreshed, even if it is already expired and a valid Refresh-Token is available. If set, OAuth2-Proxy will
-refresh the Access-Token after this many seconds whether it is still valid or not. According to the official OAuth2.0 specification 
-Access-Tokens are not required to follow a specific format. Therefore OAuth2-Proxy cannot check for any expiry date without an 
-introspection endpoint. If an Access-Token expires and you have not set a corresponding "cookie-refresh" value, you will likely 
-encounter expiry issues.
+Access-Token will never be refreshed, even it is already expired and there would be a valid Refresh-Token in the
+available. If set, OAuth2 Proxy will refresh the Access-Token after this many seconds even if it is still valid.
+Of course, it will also be refreshed after it has expired, as long as a Refresh Token is available.
 
 Caveat: It can happen that the Access-Token is valid for e.g. "1m" and a request happens after exactly "59s".
 It would pass OAuth2 Proxy and be forwarded to the backend but is just expired when the backend tries to validate

docs/docs/configuration/systemd_socket.md

@@ -1,43 +0,0 @@
----
-id: systemd_socket
-title: Systemd Socket Activation
----
-
-Pass an existing listener created by systemd.socket to oauth2-proxy.
-
-To do this create a socket:
-
-oauth2-proxy.socket
-```
-[Socket]
-ListenStream=%t/oauth2.sock
-SocketGroup=www-data
-SocketMode=0660
-```
-
-Now it's possible to call this socket from e.g. nginx:
-```
-server {
-    location /oauth2/ {
-      proxy_pass http://unix:/run/oauth2-proxy/oauth2.sock;
-}
-```
-
-The oauth2-proxy should have `--http-address=fd:3` as a parameter.
-Here fd is case insensitive and means file descriptor. The number 3 refers to the first non-stdin/stdout/stderr file descriptor,
-systemd-socket-activate (which is what systemd.socket uses), listens to what it is told and passes
-the listener it created onto the process, starting with file descriptor 3.
-
-```
-./oauth2-proxy \
-    --http-address="fd:3" \
-    --email-domain="yourcompany.com"  \
-    --upstream=http://127.0.0.1:8080/ \
-    --cookie-secret=... \
-    --cookie-secure=true \
-    --provider=... \
-    --client-id=... \
-    --client-secret=...
-```
-
-Currently TLS is not supported (but it's doable).

docs/docs/features/endpoints.md

@@ -14,7 +14,7 @@ OAuth2 Proxy responds directly to the following endpoints. All other endpoints w
 - /oauth2/start - a URL that will redirect to start the OAuth cycle
 - /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.
 - /oauth2/userinfo - the URL is used to return user's email from the session in JSON format.
-- /oauth2/auth - only returns a 202 Accepted response or a 401 Unauthorized response; for use with the [Nginx `auth_request` directive](../configuration/integration#configuring-for-use-with-the-nginx-auth_request-directive)
+- /oauth2/auth - only returns a 202 Accepted response or a 401 Unauthorized response; for use with the [Nginx `auth_request` directive](../configuration/overview.md#configuring-for-use-with-the-nginx-auth_request-directive)
 - /oauth2/static/\* - stylesheets and other dependencies used in the sign_in and error pages
 
 ### Sign out

docs/docs/installation.md

@@ -5,15 +5,14 @@ title: Installation
 
 1.  Choose how to deploy:
 
-    a. Using a [Prebuilt Binary](https://github.com/oauth2-proxy/oauth2-proxy/releases) (current release is `v7.12.0`)
+    a. Using a [Prebuilt Binary](https://github.com/oauth2-proxy/oauth2-proxy/releases) (current release is `v7.6.0`)
 
     b. Using Go to install the latest release
     ```bash
     $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest
+    # which will put the binary in `$GOROOT/bin`
     ```
-    This will install the binary into `$GOPATH/bin`. Make sure you include `$GOPATH` in your `$PATH`. Otherwise your system won't find binaries installed via `go install`
-
-    c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, S390x, ARMv6, ARMv7, and ARM64 available)
+    c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available)
 
     d. Using a [Pre-Release Nightly Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy-nightly) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available)
 
@@ -29,4 +28,3 @@ title: Installation
 2.  [Select a Provider and Register an OAuth Application with a Provider](configuration/providers/index.md)
 3.  [Configure OAuth2 Proxy using config file, command line options, or environment variables](configuration/overview.md)
 4.  [Configure SSL or Deploy behind an SSL endpoint](configuration/tls.md) (example provided for Nginx)
-5.  [Configure OAuth2 Proxy using systemd.socket](configuration/systemd_socket.md) (example provided for Nginx/Systemd)

docs/docs/welcome.md

@@ -20,4 +20,4 @@ A list of changes can be seen in the [CHANGELOG](https://github.com/oauth2-proxy
 
 ## Architecture
 
-![OAuth2 Proxy Architecture](/img/simplified-architecture.svg)
+![OAuth2 Proxy Architecture](/img/architecture.svg)

docs/docusaurus.config.js

@@ -62,17 +62,6 @@ const config = {
       /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
       ({
         hashed: true,
-        docsDir: "docs",             // only index the latest docs
-        language: ["en"],
-        indexDocs: true,
-        indexBlog: false,
-        indexPages: false,
-        docsRouteBasePath: "/",      // fix the default /docs path
-        searchResultLimits: 10,
-        searchBarShortcut: true,
-        removeDefaultStemmer: true,  // allow for partial word matching
-        searchBarShortcutHint: true,
-        highlightSearchTermsOnTargetPage: true,
       }),
     ]
   ],
@@ -123,7 +112,7 @@ const config = {
       prism: {
         theme: prismThemes.github,
         darkTheme: prismThemes.dracula,
-        additionalLanguages: ['hcl', 'nginx', 'powershell'],
+        additionalLanguages: ['hcl', 'powershell'],
       },
     }),
 };

docs/package.json

@@ -14,10 +14,10 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.3.2",
-    "@docusaurus/preset-classic": "^3.3.2",
-    "@docusaurus/theme-mermaid": "^3.3.2",
-    "@easyops-cn/docusaurus-search-local": "^0.52.0",
+    "@docusaurus/core": "3.1.0",
+    "@docusaurus/preset-classic": "3.1.0",
+    "@docusaurus/theme-mermaid": "^3.1.0",
+    "@easyops-cn/docusaurus-search-local": "^0.40.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",
@@ -25,8 +25,8 @@
     "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.3.2",
-    "@docusaurus/types": "^3.3.2"
+    "@docusaurus/module-type-aliases": "3.1.0",
+    "@docusaurus/types": "3.1.0"
   },
   "browserslist": {
     "production": [

docs/sidebars.js

@@ -22,7 +22,6 @@ const sidebars = {
       collapsed: false,
       items: [
         'configuration/overview',
-        'configuration/integration',
         {
           type: 'category',
           label: 'OAuth Provider Configuration',
@@ -31,23 +30,22 @@ const sidebars = {
             id: 'configuration/providers/index',
           },
           items: [
-            "configuration/providers/adfs",
-            "configuration/providers/azure",
-            "configuration/providers/bitbucket",
-            "configuration/providers/digitalocean",
-            "configuration/providers/facebook",
-            "configuration/providers/gitea",
-            "configuration/providers/github",
-            "configuration/providers/gitlab",
-            "configuration/providers/google",
-            "configuration/providers/keycloak",
-            "configuration/providers/keycloak_oidc",
-            "configuration/providers/linkedin",
-            "configuration/providers/login_gov",
-            "configuration/providers/ms_entra_id",
-            "configuration/providers/nextcloud",
-            "configuration/providers/openid_connect",
-            "configuration/providers/sourcehut"
+            'configuration/providers/google',
+            'configuration/providers/azure',
+            'configuration/providers/adfs',
+            'configuration/providers/facebook',
+            'configuration/providers/github',
+            'configuration/providers/gitea',
+            'configuration/providers/keycloak',
+            'configuration/providers/keycloak_oidc',
+            'configuration/providers/gitlab',
+            'configuration/providers/linkedin',
+            'configuration/providers/azure_ad',
+            'configuration/providers/openid_connect',
+            'configuration/providers/login_gov',
+            'configuration/providers/nextcloud',
+            'configuration/providers/digitalocean',
+            'configuration/providers/bitbucket',
           ],
         },
         'configuration/session_storage',

docs/src/css/custom.css

@@ -23,17 +23,3 @@
   margin: 0 calc(-1 * var(--ifm-pre-padding));
   padding: 0 var(--ifm-pre-padding);
 }
-
-.videoBlock {
-  position: relative;
-  padding-bottom: 75%;
-  height: 0;
-}
-
-.videoBlock iframe {
-  position: absolute;
-  top: 0;
-  left: 0;
-  width: 100%;
-  height: 100%;
-}

docs/versioned_docs/version-7.0.x/configuration/overview.md

@@ -90,7 +90,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
 | `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
 | `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
 | `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
-| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers [^1] | |
+| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
 | `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
 | `--cookie-secure` | bool | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag) | true |
 | `--cookie-samesite` | string | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`). | `""` |
@@ -189,12 +189,12 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
 | `--allowed-group` | string \| list | restrict logins to members of this group (may be given multiple times) | |
 | `--validate-url` | string | Access token validation endpoint | |
 | `--version` | n/a | print version string | |
-| `--whitelist-domain` | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` to allow subdomains (e.g. `.example.com`) [^2] | |
+| `--whitelist-domain` | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` to allow subdomains (e.g. `.example.com`) \[[2](#footnote2)\] | |
 | `--trusted-ip` | string \| list | list of IPs or CIDR ranges to allow to bypass authentication (may be given multiple times). When combined with `--reverse-proxy` and optionally `--real-client-ip-header` this will evaluate the trust of the IP stored in an HTTP header by a reverse proxy rather than the layer-3/4 remote address. WARNING: trusting IPs has inherent security flaws, especially when obtaining the IP address from an HTTP header (reverse-proxy mode). Use this option only if you understand the risks and how to manage them. | |
 
-[^1]: Only these providers support `--cookie-refresh`: GitLab, Google and OIDC
+\[<a name="footnote1">1</a>\]: Only these providers support `--cookie-refresh`: GitLab, Google and OIDC
 
-[^2]: When using the `whitelist-domain` option, any domain prefixed with a `.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URL's protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
+\[<a name="footnote2">2</a>\]: When using the `whitelist-domain` option, any domain prefixed with a `.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URL's protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
 
 See below for provider specific options
 
@@ -417,7 +417,7 @@ You have to substitute *name* with the actual cookie name you configured via --c
 
 ### ForwardAuth with 401 errors middleware
 
-The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
+The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
 
 ```yaml
 http:
@@ -482,7 +482,7 @@ http:
 
 ### ForwardAuth with static upstreams configuration
 
-Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
+Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
 
 **Following options need to be set on `oauth2-proxy`:**
 - `--upstream=static://202`: Configures a static response for authenticated sessions

docs/versioned_docs/version-7.1.x/configuration/overview.md

@@ -17,136 +17,136 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
 
 ### Command Line Options
 
-| Option                                     | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Default                                             |
-| ------------------------------------------ | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
-| `--acr-values`                             | string         | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues)                                                                                                                                                                                                                                                                                                                                                                                                                       | `""`                                                |
-| `--approval-prompt`                        | string         | OAuth approval_prompt                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `"force"`                                           |
-| `--auth-logging`                           | bool           | Log authentication attempts                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | true                                                |
-| `--auth-logging-format`                    | string         | Template for authentication log lines                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | see [Logging Configuration](#logging-configuration) |
-| `--authenticated-emails-file`              | string         | authenticate against emails via file (one per line)                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                     |
-| `--azure-tenant`                           | string         | go to a tenant-specific or common (tenant-independent) endpoint.                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `"common"`                                          |
-| `--basic-auth-password`                    | string         | the password to set when passing the HTTP Basic Auth header                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                     |
-| `--client-id`                              | string         | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"`                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                     |
-| `--client-secret`                          | string         | the OAuth Client Secret                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                     |
-| `--client-secret-file`                     | string         | the file with OAuth Client Secret                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                     |
-| `--config`                                 | string         | path to config file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                     |
-| `--cookie-domain`                          | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match).                                                                                                                                                                                                                                                                                                                              |                                                     |
-| `--cookie-expire`                          | duration       | expire timeframe for cookie                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | 168h0m0s                                            |
-| `--cookie-httponly`                        | bool           | set HttpOnly cookie flag                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | true                                                |
-| `--cookie-name`                            | string         | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set.                                                                                                                                                                                                                                                                                    | `"_oauth2_proxy"`                                   |
-| `--cookie-path`                            | string         | an optional cookie path to force cookies to (e.g. `/poc/`)                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `"/"`                                               |
-| `--cookie-refresh`                         | duration       | refresh the cookie after this duration; `0` to disable; not supported by all providers [^1]                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                     |
-| `--cookie-secret`                          | string         | the seed string for secure cookies (optionally base64 encoded)                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                     |
-| `--cookie-secure`                          | bool           | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag)                                                                                                                                                                                                                                                                                                                                                                                                                            | true                                                |
-| `--cookie-samesite`                        | string         | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`).                                                                                                                                                                                                                                                                                                                                                                                                                                               | `""`                                                |
-| `--custom-templates-dir`                   | string         | path to custom html templates                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                     |
-| `--custom-sign-in-logo`                    | string         | path to an custom image for the sign_in page logo. Use \"-\" to disable default logo.                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| `--display-htpasswd-form`                  | bool           | display username / password login form if an htpasswd file is provided                                                                                                                                                                                                                                                                                                                                                                                                                                                | true                                                |
-| `--email-domain`                           | string \| list | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email                                                                                                                                                                                                                                                                                                                                                                                                        |                                                     |
-| `--errors-to-info-log`                     | bool           | redirects error-level logging to default log channel instead of stderr                                                                                                                                                                                                                                                                                                                                                                                                                                                | false                                               |
-| `--extra-jwt-issuers`                      | string         | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` (see a token's `iss`, `aud` fields) pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`)                                                                                                                                                                                                                                                                                                    |                                                     |
-| `--exclude-logging-path`                   | string         | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"`                                                                                                                                                                                                                                                                                                                                                                                                                                          | `""` (no paths excluded)                            |
-| `--flush-interval`                         | duration       | period between flushing response buffers when streaming responses                                                                                                                                                                                                                                                                                                                                                                                                                                                     | `"1s"`                                              |
-| `--force-https`                            | bool           | enforce https redirect                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `false`                                             |
-| `--banner`                                 | string         | custom (html) banner string. Use `"-"` to disable default banner.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                     |
-| `--footer`                                 | string         | custom (html) footer string. Use `"-"` to disable default footer.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                     |
-| `--github-org`                             | string         | restrict logins to members of this organisation                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                     |
-| `--github-team`                            | string         | restrict logins to members of any of these teams (slug), separated by a comma                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                     |
-| `--github-repo`                            | string         | restrict logins to collaborators of this repository formatted as `orgname/repo`                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                     |
-| `--github-token`                           | string         | the token to use when verifying repository collaborators (must have push access to the repository)                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                     |
-| `--github-user`                            | string \| list | To allow users to login by username even if they do not belong to the specified org and team or collaborators                                                                                                                                                                                                                                                                                                                                                                                                         |                                                     |
-| `--gitlab-group`                           | string \| list | restrict logins to members of any of these groups (slug), separated by a comma                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                     |
-| `--gitlab-projects`                        | string \| list | restrict logins to members of any of these projects (may be given multiple times) formatted as `orgname/repo=accesslevel`. Access level should be a value matching [Gitlab access levels](https://docs.gitlab.com/ee/api/members.html#valid-access-levels), defaulted to 20 if absent                                                                                                                                                                                                                                 |                                                     |
-| `--google-admin-email`                     | string         | the google admin to impersonate for api calls                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                     |
-| `--google-group`                           | string         | restrict logins to members of this google group (may be given multiple times).                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                     |
-| `--google-service-account-json`            | string         | the path to the service account json credentials                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                     |
-| `--htpasswd-file`                          | string         | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption                                                                                                                                                                                                                                                                                                                                                                                                   |                                                     |
-| `--htpasswd-user-group`                    | string \| list | the groups to be set on sessions for htpasswd users                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                     |
-| `--http-address`                           | string         | `[http://]<addr>:<port>` or `unix://<path>` to listen on for HTTP clients                                                                                                                                                                                                                                                                                                                                                                                                                                             | `"127.0.0.1:4180"`                                  |
-| `--https-address`                          | string         | `<addr>:<port>` to listen on for HTTPS clients                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `":443"`                                            |
-| `--logging-compress`                       | bool           | Should rotated log files be compressed using gzip                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | false                                               |
-| `--logging-filename`                       | string         | File to log requests to, empty for `stdout`                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | `""` (stdout)                                       |
-| `--logging-local-time`                     | bool           | Use local time in log files and backup filenames instead of UTC                                                                                                                                                                                                                                                                                                                                                                                                                                                       | true (local time)                                   |
-| `--logging-max-age`                        | int            | Maximum number of days to retain old log files                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | 7                                                   |
-| `--logging-max-backups`                    | int            | Maximum number of old log files to retain; 0 to disable                                                                                                                                                                                                                                                                                                                                                                                                                                                               | 0                                                   |
-| `--logging-max-size`                       | int            | Maximum size in megabytes of the log file before rotation                                                                                                                                                                                                                                                                                                                                                                                                                                                             | 100                                                 |
-| `--jwt-key`                                | string         | private key in PEM format used to sign JWT, so that you can say something like `--jwt-key="${OAUTH2_PROXY_JWT_KEY}"`: required by login.gov                                                                                                                                                                                                                                                                                                                                                                           |                                                     |
-| `--jwt-key-file`                           | string         | path to the private key file in PEM format used to sign the JWT so that you can say something like `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem`: required by login.gov                                                                                                                                                                                                                                                                                                                                       |                                                     |
-| `--login-url`                              | string         | Authentication endpoint                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                     |
-| `--insecure-oidc-allow-unverified-email`   | bool           | don't fail if an email address in an id_token is not verified                                                                                                                                                                                                                                                                                                                                                                                                                                                         | false                                               |
-| `--insecure-oidc-skip-issuer-verification` | bool           | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility)                                                                                                                                                                                                                                                                                                                                                                                                       | false                                               |
-| `--oidc-issuer-url`                        | string         | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"`                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                     |
-| `--oidc-jwks-url`                          | string         | OIDC JWKS URI for token verification; required if OIDC discovery is disabled                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                     |
-| `--oidc-email-claim`                       | string         | which OIDC claim contains the user's email                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `"email"`                                           |
-| `--oidc-groups-claim`                      | string         | which OIDC claim contains the user groups                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | `"groups"`                                          |
-| `--pass-access-token`                      | bool           | pass OAuth access_token to upstream via X-Forwarded-Access-Token header. When used with `--set-xauthrequest` this adds the X-Auth-Request-Access-Token header to the response                                                                                                                                                                                                                                                                                                                                         | false                                               |
-| `--pass-authorization-header`              | bool           | pass OIDC IDToken to upstream via Authorization Bearer header                                                                                                                                                                                                                                                                                                                                                                                                                                                         | false                                               |
-| `--pass-basic-auth`                        | bool           | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream                                                                                                                                                                                                                                                                                                                                                                                                  | true                                                |
-| `--prefer-email-to-user`                   | bool           | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers`                                                                                                                                                                                                                                                                            | false                                               |
-| `--pass-host-header`                       | bool           | pass the request Host Header to upstream                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | true                                                |
-| `--pass-user-headers`                      | bool           | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream                                                                                                                                                                                                                                                                                                                                                                                               | true                                                |
-| `--profile-url`                            | string         | Profile access endpoint                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                     |
-| `--prompt`                                 | string         | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored                                                                                                                                                                                                                                                                                                                                                                                            | `""`                                                |
-| `--provider`                               | string         | OAuth provider                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | google                                              |
-| `--provider-ca-file`                       | string \| list | Paths to CA certificates that should be used when connecting to the provider.  If not specified, the default Go trust sources are used instead.                                                                                                                                                                                                                                                                                                                                                                       |
-| `--provider-display-name`                  | string         | Override the provider's name with the given string; used for the sign-in page                                                                                                                                                                                                                                                                                                                                                                                                                                         | (depends on provider)                               |
-| `--ping-path`                              | string         | the ping endpoint that can be used for basic health checks                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `"/ping"`                                           |
-| `--ping-user-agent`                        | string         | a User-Agent that can be used for basic health checks                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `""` (don't check user agent)                       |
-| `--metrics-address`                        | string         | the address /metrics will be served on                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `""`                                                |
-| `--metrics-secure-address`                 | string         | the address /metrics will be served on via HTTPS                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `""`                                                |
-| `--metrics-tls-cert-file`                  | string         | path to certificate file for secure metrics server                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | `""`                                                |
-| `--metrics-tls-key-file`                   | string         | path to private key file for secure metrics server                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | `""`                                                |
-| `--proxy-prefix`                           | string         | the url root path that this proxy should be nested under (e.g. /`<oauth2>/sign_in`)                                                                                                                                                                                                                                                                                                                                                                                                                                   | `"/oauth2"`                                         |
-| `--proxy-websockets`                       | bool           | enables WebSocket proxying                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | true                                                |
-| `--pubjwk-url`                             | string         | JWK pubkey access endpoint: required by login.gov                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                     |
-| `--real-client-ip-header`                  | string         | Header used to determine the real IP of the client, requires `--reverse-proxy` to be set (one of: X-Forwarded-For, X-Real-IP, or X-ProxyUser-IP)                                                                                                                                                                                                                                                                                                                                                                      | X-Real-IP                                           |
-| `--redeem-url`                             | string         | Token redemption endpoint                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                     |
-| `--redirect-url`                           | string         | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"`                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                     |
-| `--redis-cluster-connection-urls`          | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster`                                                                                                                                                                                                                                                                                                                                                                                                    |                                                     |
-| `--redis-connection-url`                   | string         | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`)                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                     |
-| `--redis-password`                         | string         | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url`                                                                                                                                                                                                                                                                                                                                                                                                   |                                                     |
-| `--redis-sentinel-password`                | string         | Redis sentinel password. Used only for sentinel connection; any redis node passwords need to use `--redis-password`                                                                                                                                                                                                                                                                                                                                                                                                   |                                                     |
-| `--redis-sentinel-master-name`             | string         | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel`                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                     |
-| `--redis-sentinel-connection-urls`         | string \| list | List of Redis sentinel connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-sentinel`                                                                                                                                                                                                                                                                                                                                                                                                  |                                                     |
-| `--redis-use-cluster`                      | bool           | Connect to redis cluster. Must set `--redis-cluster-connection-urls` to use this feature                                                                                                                                                                                                                                                                                                                                                                                                                              | false                                               |
-| `--redis-use-sentinel`                     | bool           | Connect to redis via sentinels. Must set `--redis-sentinel-master-name` and `--redis-sentinel-connection-urls` to use this feature                                                                                                                                                                                                                                                                                                                                                                                    | false                                               |
-| `--request-id-header`                      | string         | Request header to use as the request ID in logging                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | X-Request-Id                                        |
-| `--request-logging`                        | bool           | Log requests                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | true                                                |
-| `--request-logging-format`                 | string         | Template for request log lines                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | see [Logging Configuration](#logging-configuration) |
-| `--resource`                               | string         | The resource that is protected (Azure AD only)                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                     |
-| `--reverse-proxy`                          | bool           | are we running behind a reverse proxy, controls whether headers like X-Real-IP are accepted and allows X-Forwarded-\{Proto,Host,Uri\} headers to be used on redirect selection                                                                                                                                                                                                                                                                                                                                        | false                                               |
-| `--scope`                                  | string         | OAuth scope specification                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                     |
-| `--session-cookie-minimal`                 | bool           | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only)                                                                                                                                                                                                                                                                                                                                                                                                                       | false                                               |
-| `--session-store-type`                     | string         | [Session data storage backend](sessions.md); redis or cookie                                                                                                                                                                                                                                                                                                                                                                                                                                                          | cookie                                              |
-| `--set-xauthrequest`                       | bool           | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode). When used with `--pass-access-token`, X-Auth-Request-Access-Token is added to response headers.                                                                                                                                                                                                                                                      | false                                               |
-| `--set-authorization-header`               | bool           | set Authorization Bearer response header (useful in Nginx auth_request mode)                                                                                                                                                                                                                                                                                                                                                                                                                                          | false                                               |
-| `--set-basic-auth`                         | bool           | set HTTP Basic Auth information in response (useful in Nginx auth_request mode)                                                                                                                                                                                                                                                                                                                                                                                                                                       | false                                               |
-| `--show-debug-on-error`                    | bool           | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production)                                                                                                                                                                                                                                                                                                                                                                                           | false                                               |
-| `--signature-key`                          | string         | GAP-Signature request signature key (algorithm:secretkey)                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                     |
-| `--silence-ping-logging`                   | bool           | disable logging of requests to ping endpoint                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | false                                               |
-| `--skip-auth-preflight`                    | bool           | will skip authentication for OPTIONS requests                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | false                                               |
-| `--skip-auth-regex`                        | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times)                                                                                                                                                                                                                                                                                                                                                                                                |                                                     |
-| `--skip-auth-route`                        | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods                                                                                                                                                                                                                                                                                                                                                                                        |                                                     |
-| `--skip-auth-strip-headers`                | bool           | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy                                                                                                                                                                                                                                                                                                                                                                                                     | true                                                |
-| `--skip-jwt-bearer-tokens`                 | bool           | will skip requests that have verified JWT bearer tokens (the token must have [`aud`](https://en.wikipedia.org/wiki/JSON_Web_Token#Standard_fields) that matches this client id or one of the extras from `extra-jwt-issuers`)                                                                                                                                                                                                                                                                                         | false                                               |
-| `--skip-oidc-discovery`                    | bool           | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case                                                                                                                                                                                                                                                                                                                                                                                                   | false                                               |
-| `--skip-provider-button`                   | bool           | will skip sign-in-page to directly reach the next step: oauth/start                                                                                                                                                                                                                                                                                                                                                                                                                                                   | false                                               |
-| `--ssl-insecure-skip-verify`               | bool           | skip validation of certificates presented when using HTTPS providers                                                                                                                                                                                                                                                                                                                                                                                                                                                  | false                                               |
-| `--ssl-upstream-insecure-skip-verify`      | bool           | skip validation of certificates presented when using HTTPS upstreams                                                                                                                                                                                                                                                                                                                                                                                                                                                  | false                                               |
-| `--standard-logging`                       | bool           | Log standard runtime information                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | true                                                |
-| `--standard-logging-format`                | string         | Template for standard log lines                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | see [Logging Configuration](#logging-configuration) |
-| `--tls-cert-file`                          | string         | path to certificate file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                     |
-| `--tls-key-file`                           | string         | path to private key file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                     |
-| `--upstream`                               | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://<status_code>` for static response. Routing is based on the path                                                                                                                                                                                                                                                                                                                                                                |                                                     |
-| `--allowed-group`                          | string \| list | restrict logins to members of this group (may be given multiple times)                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                     |
-| `--validate-url`                           | string         | Access token validation endpoint                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                     |
-| `--version`                                | n/a            | print version string                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                     |
-| `--whitelist-domain`                       | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` to allow subdomains (e.g. `.example.com`)&nbsp;[^2]                                                                                                                                                                                                                                                                                                                                                                                    |                                                     |
-| `--trusted-ip`                             | string \| list | list of IPs or CIDR ranges to allow to bypass authentication (may be given multiple times). When combined with `--reverse-proxy` and optionally `--real-client-ip-header` this will evaluate the trust of the IP stored in an HTTP header by a reverse proxy rather than the layer-3/4 remote address. WARNING: trusting IPs has inherent security flaws, especially when obtaining the IP address from an HTTP header (reverse-proxy mode). Use this option only if you understand the risks and how to manage them. |                                                     |
+| Option | Type | Description | Default |
+| ------ | ---- | ----------- | ------- |
+| `--acr-values` | string | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues) | `""` |
+| `--approval-prompt` | string | OAuth approval_prompt | `"force"` |
+| `--auth-logging` | bool | Log authentication attempts | true |
+| `--auth-logging-format` | string | Template for authentication log lines | see [Logging Configuration](#logging-configuration) |
+| `--authenticated-emails-file` | string | authenticate against emails via file (one per line) | |
+| `--azure-tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` |
+| `--basic-auth-password` | string | the password to set when passing the HTTP Basic Auth header | |
+| `--client-id` | string | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"` | |
+| `--client-secret` | string | the OAuth Client Secret | |
+| `--client-secret-file` | string | the file with OAuth Client Secret | |
+| `--config` | string | path to config file | |
+| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
+| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
+| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
+| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
+| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers&nbsp;\[[1](#footnote1)\] | |
+| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
+| `--cookie-secure` | bool | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag) | true |
+| `--cookie-samesite` | string | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`). | `""` |
+| `--custom-templates-dir` | string | path to custom html templates | |
+| `--custom-sign-in-logo` | string | path to an custom image for the sign_in page logo. Use \"-\" to disable default logo. |
+| `--display-htpasswd-form` | bool | display username / password login form if an htpasswd file is provided | true |
+| `--email-domain` | string \| list  | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email | |
+| `--errors-to-info-log` | bool | redirects error-level logging to default log channel instead of stderr | false |
+| `--extra-jwt-issuers` | string | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` (see a token's `iss`, `aud` fields) pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`) | |
+| `--exclude-logging-path` | string | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"` |`""` (no paths excluded) |
+| `--flush-interval` | duration | period between flushing response buffers when streaming responses | `"1s"` |
+| `--force-https` | bool | enforce https redirect | `false` |
+| `--banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |
+| `--footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | |
+| `--github-org` | string | restrict logins to members of this organisation | |
+| `--github-team` | string | restrict logins to members of any of these teams (slug), separated by a comma | |
+| `--github-repo` | string | restrict logins to collaborators of this repository formatted as `orgname/repo` | |
+| `--github-token` | string | the token to use when verifying repository collaborators (must have push access to the repository) | |
+| `--github-user` | string \| list | To allow users to login by username even if they do not belong to the specified org and team or collaborators | |
+| `--gitlab-group` | string \| list | restrict logins to members of any of these groups (slug), separated by a comma | |
+| `--gitlab-projects` | string \| list | restrict logins to members of any of these projects (may be given multiple times) formatted as `orgname/repo=accesslevel`. Access level should be a value matching [Gitlab access levels](https://docs.gitlab.com/ee/api/members.html#valid-access-levels), defaulted to 20 if absent | |
+| `--google-admin-email` | string | the google admin to impersonate for api calls | |
+| `--google-group` | string | restrict logins to members of this google group (may be given multiple times). | |
+| `--google-service-account-json` | string | the path to the service account json credentials | |
+| `--htpasswd-file` | string | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption | |
+| `--htpasswd-user-group` | string \| list | the groups to be set on sessions for htpasswd users | |
+| `--http-address` | string | `[http://]<addr>:<port>` or `unix://<path>` to listen on for HTTP clients | `"127.0.0.1:4180"` |
+| `--https-address` | string | `<addr>:<port>` to listen on for HTTPS clients | `":443"` |
+| `--logging-compress` | bool | Should rotated log files be compressed using gzip | false |
+| `--logging-filename` | string | File to log requests to, empty for `stdout` | `""` (stdout) |
+| `--logging-local-time` | bool | Use local time in log files and backup filenames instead of UTC | true (local time) |
+| `--logging-max-age` | int | Maximum number of days to retain old log files | 7 |
+| `--logging-max-backups` | int | Maximum number of old log files to retain; 0 to disable | 0  |
+| `--logging-max-size` | int | Maximum size in megabytes of the log file before rotation | 100 |
+| `--jwt-key` | string | private key in PEM format used to sign JWT, so that you can say something like `--jwt-key="${OAUTH2_PROXY_JWT_KEY}"`: required by login.gov | |
+| `--jwt-key-file` | string | path to the private key file in PEM format used to sign the JWT so that you can say something like `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem`: required by login.gov | |
+| `--login-url` | string | Authentication endpoint | |
+| `--insecure-oidc-allow-unverified-email` | bool | don't fail if an email address in an id_token is not verified | false |
+| `--insecure-oidc-skip-issuer-verification` | bool | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility) | false |
+| `--oidc-issuer-url` | string | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"` | |
+| `--oidc-jwks-url` | string | OIDC JWKS URI for token verification; required if OIDC discovery is disabled | |
+| `--oidc-email-claim` | string | which OIDC claim contains the user's email | `"email"` |
+| `--oidc-groups-claim` | string | which OIDC claim contains the user groups | `"groups"` |
+| `--pass-access-token` | bool | pass OAuth access_token to upstream via X-Forwarded-Access-Token header. When used with `--set-xauthrequest` this adds the X-Auth-Request-Access-Token header to the response | false |
+| `--pass-authorization-header` | bool | pass OIDC IDToken to upstream via Authorization Bearer header | false |
+| `--pass-basic-auth` | bool | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
+| `--prefer-email-to-user` | bool | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers` | false |
+| `--pass-host-header` | bool | pass the request Host Header to upstream | true |
+| `--pass-user-headers` | bool | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
+| `--profile-url` | string | Profile access endpoint | |
+| `--prompt` | string | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored | `""` |
+| `--provider` | string | OAuth provider | google |
+| `--provider-ca-file` |  string \| list |  Paths to CA certificates that should be used when connecting to the provider.  If not specified, the default Go trust sources are used instead. |
+| `--provider-display-name` | string | Override the provider's name with the given string; used for the sign-in page | (depends on provider) |
+| `--ping-path` | string | the ping endpoint that can be used for basic health checks | `"/ping"` |
+| `--ping-user-agent` | string | a User-Agent that can be used for basic health checks | `""` (don't check user agent) |
+| `--metrics-address` | string | the address /metrics will be served on | `""` |
+| `--metrics-secure-address` | string | the address /metrics will be served on via HTTPS | `""` |
+| `--metrics-tls-cert-file` | string | path to certificate file for secure metrics server | `""` |
+| `--metrics-tls-key-file` | string | path to private key file for secure metrics server | `""` |
+| `--proxy-prefix` | string | the url root path that this proxy should be nested under (e.g. /`<oauth2>/sign_in`) | `"/oauth2"` |
+| `--proxy-websockets` | bool | enables WebSocket proxying | true |
+| `--pubjwk-url` | string | JWK pubkey access endpoint: required by login.gov | |
+| `--real-client-ip-header` | string | Header used to determine the real IP of the client, requires `--reverse-proxy` to be set (one of: X-Forwarded-For, X-Real-IP, or X-ProxyUser-IP) | X-Real-IP |
+| `--redeem-url` | string | Token redemption endpoint | |
+| `--redirect-url` | string | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"` | |
+| `--redis-cluster-connection-urls` | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster` | |
+| `--redis-connection-url` | string | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`) | |
+| `--redis-password` | string | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url` | |
+| `--redis-sentinel-password` | string | Redis sentinel password. Used only for sentinel connection; any redis node passwords need to use `--redis-password` | |
+| `--redis-sentinel-master-name` | string | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel` | |
+| `--redis-sentinel-connection-urls` | string \| list | List of Redis sentinel connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-sentinel` | |
+| `--redis-use-cluster` | bool | Connect to redis cluster. Must set `--redis-cluster-connection-urls` to use this feature | false |
+| `--redis-use-sentinel` | bool | Connect to redis via sentinels. Must set `--redis-sentinel-master-name` and `--redis-sentinel-connection-urls` to use this feature | false |
+| `--request-id-header` | string | Request header to use as the request ID in logging | X-Request-Id |
+| `--request-logging` | bool | Log requests | true |
+| `--request-logging-format` | string | Template for request log lines | see [Logging Configuration](#logging-configuration) |
+| `--resource` | string | The resource that is protected (Azure AD only) | |
+| `--reverse-proxy` | bool | are we running behind a reverse proxy, controls whether headers like X-Real-IP are accepted and allows X-Forwarded-\{Proto,Host,Uri\} headers to be used on redirect selection | false |
+| `--scope` | string | OAuth scope specification | |
+| `--session-cookie-minimal` | bool | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only) | false |
+| `--session-store-type` | string | [Session data storage backend](sessions.md); redis or cookie | cookie |
+| `--set-xauthrequest` | bool | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode). When used with `--pass-access-token`, X-Auth-Request-Access-Token is added to response headers.  | false |
+| `--set-authorization-header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false |
+| `--set-basic-auth` | bool | set HTTP Basic Auth information in response (useful in Nginx auth_request mode) | false |
+| `--show-debug-on-error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false |
+| `--signature-key` | string | GAP-Signature request signature key (algorithm:secretkey) | |
+| `--silence-ping-logging` | bool | disable logging of requests to ping endpoint | false |
+| `--skip-auth-preflight` | bool | will skip authentication for OPTIONS requests | false |
+| `--skip-auth-regex` | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times) | |
+| `--skip-auth-route` | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods | |
+| `--skip-auth-strip-headers` | bool | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy | true |
+| `--skip-jwt-bearer-tokens` | bool | will skip requests that have verified JWT bearer tokens (the token must have [`aud`](https://en.wikipedia.org/wiki/JSON_Web_Token#Standard_fields) that matches this client id or one of the extras from `extra-jwt-issuers`) | false |
+| `--skip-oidc-discovery` | bool | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case | false |
+| `--skip-provider-button` | bool | will skip sign-in-page to directly reach the next step: oauth/start | false |
+| `--ssl-insecure-skip-verify` | bool | skip validation of certificates presented when using HTTPS providers | false |
+| `--ssl-upstream-insecure-skip-verify` | bool | skip validation of certificates presented when using HTTPS upstreams | false |
+| `--standard-logging` | bool | Log standard runtime information | true |
+| `--standard-logging-format` | string | Template for standard log lines | see [Logging Configuration](#logging-configuration) |
+| `--tls-cert-file` | string | path to certificate file | |
+| `--tls-key-file` | string | path to private key file | |
+| `--upstream` | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://<status_code>` for static response. Routing is based on the path | |
+| `--allowed-group` | string \| list | restrict logins to members of this group (may be given multiple times) | |
+| `--validate-url` | string | Access token validation endpoint | |
+| `--version` | n/a | print version string | |
+| `--whitelist-domain` | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` to allow subdomains (e.g. `.example.com`)&nbsp;\[[2](#footnote2)\] | |
+| `--trusted-ip` | string \| list | list of IPs or CIDR ranges to allow to bypass authentication (may be given multiple times). When combined with `--reverse-proxy` and optionally `--real-client-ip-header` this will evaluate the trust of the IP stored in an HTTP header by a reverse proxy rather than the layer-3/4 remote address. WARNING: trusting IPs has inherent security flaws, especially when obtaining the IP address from an HTTP header (reverse-proxy mode). Use this option only if you understand the risks and how to manage them. | |
 
-[^1]: Only these providers support `--cookie-refresh`: GitLab, Google and OIDC
+\[<a name="footnote1">1</a>\]: Only these providers support `--cookie-refresh`: GitLab, Google and OIDC
 
-[^2]: When using the `whitelist-domain` option, any domain prefixed with a `.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URL's protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
+\[<a name="footnote2">2</a>\]: When using the `whitelist-domain` option, any domain prefixed with a `.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URL's protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
 
 See below for provider specific options
 
@@ -205,18 +205,18 @@ The default format is configured as follows:
 
 Available variables for auth logging:
 
-| Variable      | Example                              | Description                                                                                              |
-| ------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
-| Client        | 74.125.224.72                        | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
-| Host          | domain.com                           | The value of the Host header.                                                                            |
-| Message       | Authenticated via OAuth2             | The details of the auth attempt.                                                                         |
-| Protocol      | HTTP/1.0                             | The request protocol.                                                                                    |
-| RequestID     | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty                               |
-| RequestMethod | GET                                  | The request method.                                                                                      |
-| Timestamp     | 19/Mar/2015:17:20:19 -0400           | The date and time of the logging event.                                                                  |
-| UserAgent     | -                                    | The full user agent as reported by the requesting client.                                                |
-| Username      | username@email.com                   | The email or username of the auth request.                                                               |
-| Status        | AuthSuccess                          | The status of the auth request. See above for details.                                                   |
+| Variable | Example | Description |
+| --- | --- | --- |
+| Client | 74.125.224.72 | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
+| Host  | domain.com | The value of the Host header. |
+| Message | Authenticated via OAuth2 | The details of the auth attempt. |
+| Protocol | HTTP/1.0 | The request protocol. |
+| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |
+| RequestMethod | GET | The request method. |
+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |
+| UserAgent | - | The full user agent as reported by the requesting client. |
+| Username | username@email.com | The email or username of the auth request. |
+| Status | AuthSuccess | The status of the auth request. See above for details. |
 
 ### Request Log Format
 HTTP request logs will output by default in the below format:
@@ -234,21 +234,21 @@ The default format is configured as follows:
 
 Available variables for request logging:
 
-| Variable        | Example                              | Description                                                                                              |
-| --------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
-| Client          | 74.125.224.72                        | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
-| Host            | domain.com                           | The value of the Host header.                                                                            |
-| Protocol        | HTTP/1.0                             | The request protocol.                                                                                    |
-| RequestDuration | 0.001                                | The time in seconds that a request took to process.                                                      |
-| RequestID       | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty                               |
-| RequestMethod   | GET                                  | The request method.                                                                                      |
-| RequestURI      | "/oauth2/auth"                       | The URI path of the request.                                                                             |
-| ResponseSize    | 12                                   | The size in bytes of the response.                                                                       |
-| StatusCode      | 200                                  | The HTTP status code of the response.                                                                    |
-| Timestamp       | 19/Mar/2015:17:20:19 -0400           | The date and time of the logging event.                                                                  |
-| Upstream        | -                                    | The upstream data of the HTTP request.                                                                   |
-| UserAgent       | -                                    | The full user agent as reported by the requesting client.                                                |
-| Username        | username@email.com                   | The email or username of the auth request.                                                               |
+| Variable | Example | Description |
+| --- | --- | --- |
+| Client | 74.125.224.72 | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
+| Host  | domain.com | The value of the Host header. |
+| Protocol | HTTP/1.0 | The request protocol. |
+| RequestDuration | 0.001 | The time in seconds that a request took to process. |
+| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |
+| RequestMethod | GET | The request method. |
+| RequestURI | "/oauth2/auth" | The URI path of the request. |
+| ResponseSize | 12 | The size in bytes of the response. |
+| StatusCode | 200 | The HTTP status code of the response. |
+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |
+| Upstream | - | The upstream data of the HTTP request. |
+| UserAgent | - | The full user agent as reported by the requesting client. |
+| Username | username@email.com | The email or username of the auth request. |
 
 ### Standard Log Format
 All other logging that is not covered by the above two types of logging will be output in this standard logging format. This includes configuration information at startup and errors that occur outside of a session. The default format is below:
@@ -265,11 +265,11 @@ If you require a different format than that, you can configure it with the `--st
 
 Available variables for standard logging:
 
-| Variable  | Example                           | Description                                        |
-| --------- | --------------------------------- | -------------------------------------------------- |
-| Timestamp | 19/Mar/2015:17:20:19 -0400        | The date and time of the logging event.            |
-| File      | main.go:40                        | The file and line number of the logging statement. |
-| Message   | HTTP: listening on 127.0.0.1:4180 | The details of the log statement.                  |
+| Variable | Example | Description |
+| --- | --- | --- |
+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |
+| File | main.go:40 | The file and line number of the logging statement. |
+| Message | HTTP: listening on 127.0.0.1:4180 | The details of the log statement. |
 
 ## Configuring for use with the Nginx `auth_request` directive
 
@@ -371,7 +371,7 @@ You have to substitute *name* with the actual cookie name you configured via --c
 
 ### ForwardAuth with 401 errors middleware
 
-The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
+The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
 
 ```yaml
 http:
@@ -436,7 +436,7 @@ http:
 
 ### ForwardAuth with static upstreams configuration
 
-Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
+Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
 
 **Following options need to be set on `oauth2-proxy`:**
 - `--upstream=static://202`: Configures a static response for authenticated sessions

docs/versioned_docs/version-7.10.x/behaviour.md

@@ -1,11 +0,0 @@
----
-id: behaviour
-title: Behaviour
----
-
-1. Any request passing through the proxy (and not matched by `--skip-auth-regex`) is checked for the proxy's session cookie (`--cookie-name`) (or, if allowed, a JWT token - see `--skip-jwt-bearer-tokens`).
-2. If authentication is required but missing then the user is asked to log in and redirected to the authentication provider (unless it is an Ajax request, i.e. one with `Accept: application/json`, in which case 401 Unauthorized is returned)
-3. After returning from the authentication provider, the oauth tokens are stored in the configured session store (cookie, redis, ...) and a cookie is set
-4. The request is forwarded to the upstream server with added user info and authentication headers (depending on the configuration)
-
-Notice that the proxy also provides a number of useful [endpoints](features/endpoints.md).

docs/versioned_docs/version-7.10.x/community/contribution.md

@@ -1,89 +0,0 @@
----
-id: contribution
-title: Contribution Guide
----
-
-We track bugs and issues using Github.
-
-If you find a bug, please open an Issue. When opening an Issue or Pull Request please follow the preconfigured template and take special note of the checkboxes.
-
-If you want to fix a bug, add a new feature or extend existing functionality, please create a fork, create a feature branch and open a PR back to this repo.
-Please mention open bug issue number(s) within your PR if applicable.
-
-We suggest using [Visual Studio Code](https://code.visualstudio.com/docs/languages/go) with the official [Go for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=golang.go) extension.
-
-
-# Go version
-
-This project is currently still using go 1.22. You can follow the installation guide for go [here.](https://go.dev/doc/install) And you can find go version 1.22 in the archived section [here.](https://go.dev/dl/)
-
-# Preparing your fork
-Clone your fork, create a feature branch and update the depedencies to get started.
-```bash
-git clone git@github.com:<YOUR_FORK>/oauth2-proxy
-cd oauth2-proxy
-git branch feature/<BRANCH_NAME>
-git push --set-upstream origin feature/<BRANCH_NAME>
-go mod download
-```
-
-
-# Testing / Debugging
-For starting oauth2-proxy locally open the debugging tab and create the `launch.json` and select `Go: Launch Package`.
-
-![Debugging Tab](/img/debug-tab.png)
-```json
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Launch OAuth2-Proxy with Dex",
-            "type": "go",
-            "request": "launch",
-            "mode": "auto",
-            "program": "${workspaceFolder}",
-            "args": [
-                "--config",
-                // The following configuration contains settings for a locally deployed
-                // upstream and dex as an idetity provider
-                "contrib/local-environment/oauth2-proxy.cfg"
-            ]
-        },
-        {
-            "name": "Launch OAuth2-Proxy with Keycloak",
-            "type": "go",
-            "request": "launch",
-            "mode": "auto",
-            "program": "${workspaceFolder}",
-            "args": [
-                "--config",
-                // The following configuration contains settings for a locally deployed
-                // upstream and keycloak as an idetity provider
-                "contrib/local-environment/oauth2-proxy-keycloak.cfg"
-            ]
-        }
-    ]
-}
-```
-
-Before you can start your local version of oauth2-proxy, you will have to use the provided docker compose files to start a local upstream service and identity provider. We suggest using [httpbin](https://hub.docker.com/r/kennethreitz/httpbin) as your upstream for testing as it allows for request and response introspection of all things HTTP.
-
-Inside the `contrib/local-environment` directory you can use the `Makefile` for
-starting different example setups:
-
-- Dex as your IdP: `make up` or `make down`
-- Dex as your IdP using the alpha-config: `make alpha-config-up`
-- Keycloak as your IdP: `make keycloak-up`
-- Dex as your IdP & nginx reverse proxy: `make nginx-up`
-- and many more...
-
-Check out the `Makefile` to see what is available.
-
-The username and password for all setups is usually `admin@example.com` and `password`.
-
-The docker compose setups expose the services with a dynamic reverse DNS resolver: localtest.me
-
-- OAuth2-Proxy: http://oauth2-proxy.localtest.me:4180
-- Upstream: http://httpbin.localtest.me:8080
-- Dex: http://dex.localtest.me:5556
-

docs/versioned_docs/version-7.10.x/community/security.md

@@ -1,49 +0,0 @@
----
-id: security
-title: Security
----
-
-:::note
-OAuth2 Proxy is a community project.
-Maintainers do not work on this project full time, and as such,
-while we endeavour to respond to disclosures as quickly as possible,
-this may take longer than in projects with corporate sponsorship.
-:::
-
-## Security Disclosures
-
-:::important
-If you believe you have found a vulnerability within OAuth2 Proxy or any of its
-dependencies, please do NOT open an issue or PR on GitHub, please do NOT post
-any details publicly.
-:::
-
-Security disclosures MUST be done in private.
-If you have found an issue that you would like to bring to the attention of the
-maintenance team for OAuth2 Proxy, please compose an email and send it to the
-list of maintainers in our [MAINTAINERS](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/MAINTAINERS) file.
-
-Please include as much detail as possible.
-Ideally, your disclosure should include:
-- A reproducible case that can be used to demonstrate the exploit
-- How you discovered this vulnerability
-- A potential fix for the issue (if you have thought of one)
-- Versions affected (if not present in master)
-- Your GitHub ID
-
-### How will we respond to disclosures?
-
-We use [GitHub Security Advisories](https://docs.github.com/en/github/managing-security-vulnerabilities/about-github-security-advisories)
-to privately discuss fixes for disclosed vulnerabilities.
-If you include a GitHub ID with your disclosure we will add you as a collaborator
-for the advisory so that you can join the discussion and validate any fixes
-we may propose.
-
-For minor issues and previously disclosed vulnerabilities (typically for
-dependencies), we may use regular PRs for fixes and forego the security advisory.
-
-Once a fix has been agreed upon, we will merge the fix and create a new release.
-If we have multiple security issues in flight simultaneously, we may delay
-merging fixes until all patches are ready.
-We may also backport the fix to previous releases,
-but this will be at the discretion of the maintainers.

docs/versioned_docs/version-7.10.x/configuration/alpha_config.md

@@ -1,564 +0,0 @@
----
-id: alpha-config
-title: Alpha Configuration
----
-
-:::warning
-This page contains documentation for alpha features.
-We reserve the right to make breaking changes to the features detailed within this page with no notice.
-
-Options described in this page may be changed, removed, renamed or moved without prior warning.
-Please beware of this before you use alpha configuration options.
-:::
-
-This page details a set of **alpha** configuration options in a new format.
-Going forward we are intending to add structured configuration in YAML format to
-replace the existing TOML based configuration file and flags.
-
-Below is a reference for the structure of the configuration, with
-[AlphaOptions](#alphaoptions) as the root of the configuration.
-
-When using alpha configuration, your config file will look something like below:
-
-```yaml
-upstreams:
-  - id: ...
-    ...: ...
-injectRequestHeaders:
-  - name: ...
-    ...: ...
-injectResponseHeaders:
-  - name: ...
-    ...: ...
-```
-
-Please browse the [reference](#configuration-reference) below for the structure
-of the new configuration format.
-
-## Using Alpha Configuration
-
-To use the new **alpha** configuration, generate a YAML file based on the format
-described in the [reference](#configuration-reference) below.
-
-Provide the path to this file using the `--alpha-config` flag.
-
-:::note
-When using the `--alpha-config` flag, some options are no longer available.
-See [removed options](#removed-options) below for more information.
-:::
-
-### Converting configuration to the new structure
-
-Before adding the new `--alpha-config` option, start OAuth2 Proxy using the
-`convert-config-to-alpha` flag to convert existing configuration to the new format.
-
-```bash
-oauth2-proxy --convert-config-to-alpha --config ./path/to/existing/config.cfg
-```
-
-This will convert any options supported by the new format to YAML and print the
-new configuration to `STDOUT`.
-
-Copy this to a new file, remove any options from your existing configuration
-noted in [removed options](#removed-options) and then start OAuth2 Proxy using
-the new config.
-
-```bash
-oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg
-```
-
-## Using ENV variables in the alpha configuration
-
-The alpha package supports the use of environment variables in place of yaml keys, allowing sensitive values to be pulled from somewhere other than the yaml file.
-When using environment variables, your yaml will look like this:
-
-```yaml
-    providers:
-    - provider: azure
-      clientSecret: ${CLIENT_SECRET}
-      ...
-```
-Where CLIENT_SECRET is an environment variable.
-More information and available patterns can be found [here](https://github.com/a8m/envsubst#docs)
-
-## Removed options
-
-The following flags/options and their respective environment variables are no
-longer available when using alpha configuration:
-
-<!-- Legacy Upstream FlagSet -->
-- `flush-interval`/`flush_interval`
-- `pass-host-header`/`pass_host_header`
-- `proxy-websockets`/`proxy_websockets`
-- `ssl-upstream-insecure-skip-verify`/`ssl_upstream_insecure_skip_verify`
-- `upstream`/`upstreams`
-
-<!-- Legacy Headers FlagSet -->
-- `pass-basic-auth`/`pass_basic_auth`
-- `pass-access-token`/`pass_access_token`
-- `pass-user-headers`/`pass_user_headers`
-- `pass-authorization-header`/`pass_authorization_header`
-- `set-basic-auth`/`set_basic_auth`
-- `set-xauthrequest`/`set_xauthrequest`
-- `set-authorization-header`/`set_authorization_header`
-- `prefer-email-to-user`/`prefer_email_to_user`
-- `basic-auth-password`/`basic_auth_password`
-- `skip-auth-strip-headers`/`skip_auth_strip_headers`
-
-<!-- Legacy provider FlagSet -->
-- `client-id`/`client_id`
-- `client-secret`/`client_secret`, and `client-secret-file`/`client_secret_file`
-- `provider`
-- `provider-display-name`/`provider_display_name`
-- `provider-ca-file`/`provider_ca_files`
-- `login-url`/`login_url`
-- `redeem-url`/`redeem_url`
-- `profile-url`/`profile_url`
-- `resource`
-- `validate-url`/`validate_url`
-- `scope`
-- `prompt`
-- `approval-prompt`/`approval_prompt`
-- `acr-values`/`acr_values`
-- `user-id-claim`/`user_id_claim`
-- `allowed-group`/`allowed_groups`
-- `allowed-role`/`allowed_roles`
-- `jwt-key`/`jwt_key`
-- `jwt-key-file`/`jwt_key_file`
-- `pubjwk-url`/`pubjwk_url`
-
-and all provider-specific options, i.e. any option whose name includes `oidc`,
-`azure`, `bitbucket`, `github`, `gitlab`, `google` or `keycloak`.  Attempting to
-use any of these options via flags or via config when `--alpha-config` is
-set will result in an error.
-
-:::important
-You must remove these options before starting OAuth2 Proxy with `--alpha-config`
-:::
-
-## Configuration Reference
-
-<!--- THIS FILE IS AUTOGENERATED!!! DO NOT EDIT!!! -->
-
-### ADFSOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `skipScope` | _bool_ | Skip adding the scope parameter in login request<br/>Default value is 'false' |
-
-### AlphaOptions
-
-AlphaOptions contains alpha structured configuration options.
-Usage of these options allows users to access alpha features that are not
-available as part of the primary configuration structure for OAuth2 Proxy.
-
-:::warning
-The options within this structure are considered alpha.
-They may change between releases without notice.
-:::
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `upstreamConfig` | _[UpstreamConfig](#upstreamconfig)_ | UpstreamConfig is used to configure upstream servers.<br/>Once a user is authenticated, requests to the server will be proxied to<br/>these upstream servers based on the path mappings defined in this list. |
-| `injectRequestHeaders` | _[[]Header](#header)_ | InjectRequestHeaders is used to configure headers that should be added<br/>to requests to upstream servers.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
-| `injectResponseHeaders` | _[[]Header](#header)_ | InjectResponseHeaders is used to configure headers that should be added<br/>to responses from the proxy.<br/>This is typically used when using the proxy as an external authentication<br/>provider in conjunction with another proxy such as NGINX and its<br/>auth_request module.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
-| `server` | _[Server](#server)_ | Server is used to configure the HTTP(S) server for the proxy application.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
-| `metricsServer` | _[Server](#server)_ | MetricsServer is used to configure the HTTP(S) server for metrics.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
-| `providers` | _[Providers](#providers)_ | Providers is used to configure your provider. **Multiple-providers is not<br/>yet working.** [This feature is tracked in<br/>#925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926) |
-
-### AzureOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `tenant` | _string_ | Tenant directs to a tenant-specific or common (tenant-independent) endpoint<br/>Default value is 'common' |
-| `graphGroupField` | _string_ | GraphGroupField configures the group field to be used when building the groups list from Microsoft Graph<br/>Default value is 'id' |
-
-### BitbucketOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `team` | _string_ | Team sets restrict logins to members of this team |
-| `repository` | _string_ | Repository sets restrict logins to user with access to this repository |
-
-### ClaimSource
-
-(**Appears on:** [HeaderValue](#headervalue))
-
-ClaimSource allows loading a header value from a claim within the session
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. Available claims: `access_token` `id_token` `created_at`<br/>`expires_on` `refresh_token` `email` `user` `groups` `preferred_username`. |
-| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |
-| `basicAuthPassword` | _[SecretSource](#secretsource)_ | BasicAuthPassword converts this claim into a basic auth header.<br/>Note the value of claim will become the basic auth username and the<br/>basicAuthPassword will be used as the password value. |
-
-### Duration
-#### (`string` alias)
-
-(**Appears on:** [Upstream](#upstream))
-
-Duration is as string representation of a period of time.
-A duration string is a is a possibly signed sequence of decimal numbers,
-each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".
-Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
-
-### GitHubOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `org` | _string_ | Org sets restrict logins to members of this organisation |
-| `team` | _string_ | Team sets restrict logins to members of this team |
-| `repo` | _string_ | Repo sets restrict logins to collaborators of this repository |
-| `token` | _string_ | Token is the token to use when verifying repository collaborators<br/>it must have push access to the repository |
-| `users` | _[]string_ | Users allows users with these usernames to login<br/>even if they do not belong to the specified org and team or collaborators |
-
-### GitLabOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `group` | _[]string_ | Group sets restrict logins to members of this group |
-| `projects` | _[]string_ | Projects restricts logins to members of these projects |
-
-### GoogleOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `group` | _[]string_ | Groups sets restrict logins to members of this Google group |
-| `adminEmail` | _string_ | AdminEmail is the Google admin to impersonate for api calls |
-| `serviceAccountJson` | _string_ | ServiceAccountJSON is the path to the service account json credentials |
-| `useApplicationDefaultCredentials` | _bool_ | UseApplicationDefaultCredentials is a boolean whether to use Application Default Credentials instead of a ServiceAccountJSON |
-| `targetPrincipal` | _string_ | TargetPrincipal is the Google Service Account used for Application Default Credentials |
-
-### Header
-
-(**Appears on:** [AlphaOptions](#alphaoptions))
-
-Header represents an individual header that will be added to a request or
-response header.
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. |
-| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only applies to injected request headers.<br/>Defaults to false (headers that match this header will be stripped). |
-| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |
-
-### HeaderValue
-
-(**Appears on:** [Header](#header))
-
-HeaderValue represents a single header value and the sources that can
-make up the header value
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `value` | _[]byte_ | Value expects a base64 encoded string value. |
-| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |
-| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |
-| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. Available claims: `access_token` `id_token` `created_at`<br/>`expires_on` `refresh_token` `email` `user` `groups` `preferred_username`. |
-| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |
-| `basicAuthPassword` | _[SecretSource](#secretsource)_ | BasicAuthPassword converts this claim into a basic auth header.<br/>Note the value of claim will become the basic auth username and the<br/>basicAuthPassword will be used as the password value. |
-
-### KeycloakOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `groups` | _[]string_ | Group enables to restrict login to members of indicated group |
-| `roles` | _[]string_ | Role enables to restrict login to users with role (only available when using the keycloak-oidc provider) |
-
-### LoginGovOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `jwtKey` | _string_ | JWTKey is a private key in PEM format used to sign JWT, |
-| `jwtKeyFile` | _string_ | JWTKeyFile is a path to the private key file in PEM format used to sign the JWT |
-| `pubjwkURL` | _string_ | PubJWKURL is the JWK pubkey access endpoint |
-
-### LoginURLParameter
-
-(**Appears on:** [Provider](#provider))
-
-LoginURLParameter is the configuration for a single query parameter that
-can be passed through from the `/oauth2/start` endpoint to the IdP login
-URL.  The "default" option specifies the default value or values (if any)
-that will be passed to the IdP for this parameter, and "allow" is a list
-of options for ways in which this parameter can be set or overridden via
-the query string to `/oauth2/start`.
-If _only_ a default is specified and no "allow" then the parameter is
-effectively fixed - the default value will always be used and anything
-passed to the start URL will be ignored.  If _only_ "allow" is specified
-but no default then the parameter will only be passed on to the IdP if
-the caller provides it, and no value will be sent otherwise.
-
-Examples:
-
-# A parameter whose value is fixed
-
-```
-name: organization
-default:
-- myorg
-```
-
-A parameter that is not passed by default, but may be set to one of a
-fixed set of values
-
-```
-name: prompt
-allow:
-- value: login
-- value: consent
-- value: select_account
-```
-
-A parameter that is passed by default but may be overridden by one of
-a fixed set of values
-
-```
-name: prompt
-default: ["login"]
-allow:
-- value: consent
-- value: select_account
-```
-
-A parameter that may be overridden, but only by values that match a
-regular expression.  For example to restrict `login_hint` to email
-addresses in your organization's domain:
-
-```
-name: login_hint
-allow:
-- pattern: '^[^@]*@example\.com$'
-# this allows at most one "@" sign, and requires "example.com" domain.
-```
-
-Note that the YAML rules around exactly which characters are allowed
-and/or require escaping in different types of string literals are
-convoluted.  For regular expressions the single quoted form is simplest
-as backslash is not considered to be an escape character.  Alternatively
-use the "chomped block" format `|-`:
-
-```
-  - pattern: |-
-    ^[^@]*@example\.com$
-
-```
-
-The hyphen is important, a `|` block would have a trailing newline
-character.
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `name` | _string_ | Name specifies the name of the query parameter. |
-| `default` | _[]string_ |  _(Optional)_ Default specifies a default value or values that will be<br/>passed to the IdP if not overridden. |
-| `allow` | _[[]URLParameterRule](#urlparameterrule)_ |  _(Optional)_ Allow specifies rules about how the default (if any) may be<br/>overridden via the query string to `/oauth2/start`.  Only<br/>values that match one or more of the allow rules will be<br/>forwarded to the IdP. |
-
-### MicrosoftEntraIDOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `allowedTenants` | _[]string_ | AllowedTenants is a list of allowed tenants. In case of multi-tenant apps, incoming tokens are<br/>issued by different issuers and OIDC issuer verification needs to be disabled.<br/>When not specified, all tenants are allowed. Redundant for single-tenant apps<br/>(regular ID token validation matches the issuer). |
-| `federatedTokenAuth` | _bool_ | FederatedTokenAuth enable oAuth2 client authentication with federated token projected<br/>by Entra Workload Identity plugin, instead of client secret. |
-
-### OIDCOptions
-
-(**Appears on:** [Provider](#provider))
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `issuerURL` | _string_ | IssuerURL is the OpenID Connect issuer URL<br/>eg: https://accounts.google.com |
-| `insecureAllowUnverifiedEmail` | _bool_ | InsecureAllowUnverifiedEmail prevents failures if an email address in an id_token is not verified<br/>default set to 'false' |
-| `insecureSkipIssuerVerification` | _bool_ | InsecureSkipIssuerVerification skips verification of ID token issuers. When false, ID Token Issuers must match the OIDC discovery URL<br/>default set to 'false' |
-| `insecureSkipNonce` | _bool_ | InsecureSkipNonce skips verifying the ID Token's nonce claim that must match<br/>the random nonce sent in the initial OAuth flow. Otherwise, the nonce is checked<br/>after the initial OAuth redeem & subsequent token refreshes.<br/>default set to 'true'<br/>Warning: In a future release, this will change to 'false' by default for enhanced security. |
-| `skipDiscovery` | _bool_ | SkipDiscovery allows to skip OIDC discovery and use manually supplied Endpoints<br/>default set to 'false' |
-| `jwksURL` | _string_ | JwksURL is the OpenID Connect JWKS URL<br/>eg: https://www.googleapis.com/oauth2/v3/certs |
-| `publicKeyFiles` | _[]string_ | PublicKeyFiles is a list of paths pointing to public key files in PEM format to use<br/>for verifying JWT tokens |
-| `emailClaim` | _string_ | EmailClaim indicates which claim contains the user email,<br/>default set to 'email' |
-| `groupsClaim` | _string_ | GroupsClaim indicates which claim contains the user groups<br/>default set to 'groups' |
-| `userIDClaim` | _string_ | UserIDClaim indicates which claim contains the user ID<br/>default set to 'email' |
-| `audienceClaims` | _[]string_ | AudienceClaim allows to define any claim that is verified against the client id<br/>By default `aud` claim is used for verification. |
-| `extraAudiences` | _[]string_ | ExtraAudiences is a list of additional audiences that are allowed<br/>to pass verification in addition to the client id. |
-
-### Provider
-
-(**Appears on:** [Providers](#providers))
-
-Provider holds all configuration for a single provider
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `clientID` | _string_ | ClientID is the OAuth Client ID that is defined in the provider<br/>This value is required for all providers. |
-| `clientSecret` | _string_ | ClientSecret is the OAuth Client Secret that is defined in the provider<br/>This value is required for all providers. |
-| `clientSecretFile` | _string_ | ClientSecretFile is the name of the file<br/>containing the OAuth Client Secret, it will be used if ClientSecret is not set. |
-| `keycloakConfig` | _[KeycloakOptions](#keycloakoptions)_ | KeycloakConfig holds all configurations for Keycloak provider. |
-| `azureConfig` | _[AzureOptions](#azureoptions)_ | AzureConfig holds all configurations for Azure provider. |
-| `microsoftEntraIDConfig` | _[MicrosoftEntraIDOptions](#microsoftentraidoptions)_ | MicrosoftEntraIDConfig holds all configurations for Entra ID provider. |
-| `ADFSConfig` | _[ADFSOptions](#adfsoptions)_ | ADFSConfig holds all configurations for ADFS provider. |
-| `bitbucketConfig` | _[BitbucketOptions](#bitbucketoptions)_ | BitbucketConfig holds all configurations for Bitbucket provider. |
-| `githubConfig` | _[GitHubOptions](#githuboptions)_ | GitHubConfig holds all configurations for GitHubC provider. |
-| `gitlabConfig` | _[GitLabOptions](#gitlaboptions)_ | GitLabConfig holds all configurations for GitLab provider. |
-| `googleConfig` | _[GoogleOptions](#googleoptions)_ | GoogleConfig holds all configurations for Google provider. |
-| `oidcConfig` | _[OIDCOptions](#oidcoptions)_ | OIDCConfig holds all configurations for OIDC provider<br/>or providers utilize OIDC configurations. |
-| `loginGovConfig` | _[LoginGovOptions](#logingovoptions)_ | LoginGovConfig holds all configurations for LoginGov provider. |
-| `id` | _string_ | ID should be a unique identifier for the provider.<br/>This value is required for all providers. |
-| `provider` | _[ProviderType](#providertype)_ | Type is the OAuth provider<br/>must be set from the supported providers group,<br/>otherwise 'Google' is set as default |
-| `name` | _string_ | Name is the providers display name<br/>if set, it will be shown to the users in the login page. |
-| `caFiles` | _[]string_ | CAFiles is a list of paths to CA certificates that should be used when connecting to the provider.<br/>If not specified, the default Go trust sources are used instead |
-| `useSystemTrustStore` | _bool_ | UseSystemTrustStore determines if your custom CA files and the system trust store are used<br/>If set to true, your custom CA files and the system trust store are used otherwise only your custom CA files. |
-| `loginURL` | _string_ | LoginURL is the authentication endpoint |
-| `loginURLParameters` | _[[]LoginURLParameter](#loginurlparameter)_ | LoginURLParameters defines the parameters that can be passed from the start URL to the IdP login URL |
-| `authRequestResponseMode` | _string_ | AuthRequestResponseMode defines the response mode to request during authorization request |
-| `redeemURL` | _string_ | RedeemURL is the token redemption endpoint |
-| `profileURL` | _string_ | ProfileURL is the profile access endpoint |
-| `skipClaimsFromProfileURL` | _bool_ | SkipClaimsFromProfileURL allows to skip request to Profile URL for resolving claims not present in id_token<br/>default set to 'false' |
-| `resource` | _string_ | ProtectedResource is the resource that is protected (Azure AD and ADFS only) |
-| `validateURL` | _string_ | ValidateURL is the access token validation endpoint |
-| `scope` | _string_ | Scope is the OAuth scope specification |
-| `allowedGroups` | _[]string_ | AllowedGroups is a list of restrict logins to members of this group |
-| `code_challenge_method` | _string_ | The code challenge method |
-| `backendLogoutURL` | _string_ | URL to call to perform backend logout, `{id_token}` would be replaced by the actual `id_token` if available in the session |
-
-### ProviderType
-#### (`string` alias)
-
-(**Appears on:** [Provider](#provider))
-
-ProviderType is used to enumerate the different provider type options
-Valid options are: adfs, azure, bitbucket, digitalocean facebook, github,
-gitlab, google, keycloak, keycloak-oidc, linkedin, login.gov, nextcloud
-and oidc.
-
-### Providers
-
-#### ([[]Provider](#provider) alias)
-
-(**Appears on:** [AlphaOptions](#alphaoptions))
-
-The provider can be selected using the `provider` configuration value, or
-set in the [`providers` array using
-AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).
-However, [**the feature to implement multiple providers is not
-complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
-
-### SecretSource
-
-(**Appears on:** [ClaimSource](#claimsource), [HeaderValue](#headervalue), [TLS](#tls))
-
-SecretSource references an individual secret value.
-Only one source within the struct should be defined at any time.
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `value` | _[]byte_ | Value expects a base64 encoded string value. |
-| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |
-| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |
-
-### Server
-
-(**Appears on:** [AlphaOptions](#alphaoptions))
-
-Server represents the configuration for an HTTP(S) server
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `BindAddress` | _string_ | BindAddress is the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. |
-| `SecureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. |
-| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic and further configuration for the TLS server. |
-
-### TLS
-
-(**Appears on:** [Server](#server))
-
-TLS contains the information for loading a TLS certificate and key
-as well as an optional minimal TLS version that is acceptable.
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `Key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use.<br/>Typically this will come from a file. |
-| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. |
-| `MinVersion` | _string_ | MinVersion is the minimal TLS version that is acceptable.<br/>E.g. Set to "TLS1.3" to select TLS version 1.3 |
-| `CipherSuites` | _[]string_ | CipherSuites is a list of TLS cipher suites that are allowed.<br/>E.g.:<br/>- TLS_RSA_WITH_RC4_128_SHA<br/>- TLS_RSA_WITH_AES_256_GCM_SHA384<br/>If not specified, the default Go safe cipher list is used.<br/>List of valid cipher suites can be found in the [crypto/tls documentation](https://pkg.go.dev/crypto/tls#pkg-constants). |
-
-### URLParameterRule
-
-(**Appears on:** [LoginURLParameter](#loginurlparameter))
-
-URLParameterRule represents a rule by which query parameters
-passed to the `/oauth2/start` endpoint are checked to determine whether
-they are valid overrides for the given parameter passed to the IdP's
-login URL.  Either Value or Pattern should be supplied, not both.
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `value` | _string_ | A Value rule matches just this specific value |
-| `pattern` | _string_ | A Pattern rule gives a regular expression that must be matched by<br/>some substring of the value.  The expression is _not_ automatically<br/>anchored to the start and end of the value, if you _want_ to restrict<br/>the whole parameter value you must anchor it yourself with `^` and `$`. |
-
-### Upstream
-
-(**Appears on:** [UpstreamConfig](#upstreamconfig))
-
-Upstream represents the configuration for an upstream server.
-Requests will be proxied to this upstream if the path matches the request path.
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `id` | _string_ | ID should be a unique identifier for the upstream.<br/>This value is required for all upstreams. |
-| `path` | _string_ | Path is used to map requests to the upstream server.<br/>The closest match will take precedence and all Paths must be unique.<br/>Path can also take a pattern when used with RewriteTarget.<br/>Path segments can be captured and matched using regular experessions.<br/>Eg:<br/>- `^/foo$`: Match only the explicit path `/foo`<br/>- `^/bar/$`: Match any path prefixed with `/bar/`<br/>- `^/baz/(.*)$`: Match any path prefixed with `/baz` and capture the remaining path for use with RewriteTarget |
-| `rewriteTarget` | _string_ | RewriteTarget allows users to rewrite the request path before it is sent to<br/>the upstream server (for an HTTP/HTTPS upstream) or mapped to the filesystem<br/>(for a `file:` upstream).<br/>Use the Path to capture segments for reuse within the rewrite target.<br/>Eg: With a Path of `^/baz/(.*)`, a RewriteTarget of `/foo/$1` would rewrite<br/>the request `/baz/abc/123` to `/foo/abc/123` before proxying to the<br/>upstream server.  Or if the upstream were `file:///app`, a request for<br/>`/baz/info.html` would return the contents of the file `/app/foo/info.html`. |
-| `uri` | _string_ | The URI of the upstream server. This may be an HTTP(S) server of a File<br/>based URL. It may include a path, in which case all requests will be served<br/>under that path.<br/>Eg:<br/>- http://localhost:8080<br/>- https://service.localhost<br/>- https://service.localhost/path<br/>- file://host/path<br/>If the URI's path is "/base" and the incoming request was for "/dir",<br/>the upstream request will be for "/base/dir". |
-| `insecureSkipTLSVerify` | _bool_ | InsecureSkipTLSVerify will skip TLS verification of upstream HTTPS hosts.<br/>This option is insecure and will allow potential Man-In-The-Middle attacks<br/>between OAuth2 Proxy and the upstream server.<br/>Defaults to false. |
-| `static` | _bool_ | Static will make all requests to this upstream have a static response.<br/>The response will have a body of "Authenticated" and a response code<br/>matching StaticCode.<br/>If StaticCode is not set, the response will return a 200 response. |
-| `staticCode` | _int_ | StaticCode determines the response code for the Static response.<br/>This option can only be used with Static enabled. |
-| `flushInterval` | _[Duration](#duration)_ | FlushInterval is the period between flushing the response buffer when<br/>streaming response from the upstream.<br/>Defaults to 1 second. |
-| `passHostHeader` | _bool_ | PassHostHeader determines whether the request host header should be proxied<br/>to the upstream server.<br/>Defaults to true. |
-| `proxyWebSockets` | _bool_ | ProxyWebSockets enables proxying of websockets to upstream servers<br/>Defaults to true. |
-| `timeout` | _[Duration](#duration)_ | Timeout is the maximum duration the server will wait for a response from the upstream server.<br/>Defaults to 30 seconds. |
-
-### UpstreamConfig
-
-(**Appears on:** [AlphaOptions](#alphaoptions))
-
-UpstreamConfig is a collection of definitions for upstream servers.
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| `proxyRawPath` | _bool_ | ProxyRawPath will pass the raw url path to upstream allowing for urls<br/>like: "/%2F/" which would otherwise be redirected to "/" |
-| `upstreams` | _[[]Upstream](#upstream)_ | Upstreams represents the configuration for the upstream servers.<br/>Requests will be proxied to this upstream if the path matches the request path. |

docs/versioned_docs/version-7.10.x/configuration/alpha_config.md.tmpl

@@ -1,139 +0,0 @@
----
-id: alpha-config
-title: Alpha Configuration
----
-
-:::warning
-This page contains documentation for alpha features.
-We reserve the right to make breaking changes to the features detailed within this page with no notice.
-
-Options described in this page may be changed, removed, renamed or moved without prior warning.
-Please beware of this before you use alpha configuration options.
-:::
-
-This page details a set of **alpha** configuration options in a new format.
-Going forward we are intending to add structured configuration in YAML format to
-replace the existing TOML based configuration file and flags.
-
-Below is a reference for the structure of the configuration, with
-[AlphaOptions](#alphaoptions) as the root of the configuration.
-
-When using alpha configuration, your config file will look something like below:
-
-```yaml
-upstreams:
-  - id: ...
-    ...: ...
-injectRequestHeaders:
-  - name: ...
-    ...: ...
-injectResponseHeaders:
-  - name: ...
-    ...: ...
-```
-
-Please browse the [reference](#configuration-reference) below for the structure
-of the new configuration format.
-
-## Using Alpha Configuration
-
-To use the new **alpha** configuration, generate a YAML file based on the format
-described in the [reference](#configuration-reference) below.
-
-Provide the path to this file using the `--alpha-config` flag.
-
-:::note
-When using the `--alpha-config` flag, some options are no longer available.
-See [removed options](#removed-options) below for more information.
-:::
-
-### Converting configuration to the new structure
-
-Before adding the new `--alpha-config` option, start OAuth2 Proxy using the
-`convert-config-to-alpha` flag to convert existing configuration to the new format.
-
-```bash
-oauth2-proxy --convert-config-to-alpha --config ./path/to/existing/config.cfg
-```
-
-This will convert any options supported by the new format to YAML and print the
-new configuration to `STDOUT`.
-
-Copy this to a new file, remove any options from your existing configuration
-noted in [removed options](#removed-options) and then start OAuth2 Proxy using
-the new config.
-
-```bash
-oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg
-```
-
-## Using ENV variables in the alpha configuration
-
-The alpha package supports the use of environment variables in place of yaml keys, allowing sensitive values to be pulled from somewhere other than the yaml file.
-When using environment variables, your yaml will look like this:
-
-```yaml
-    providers:
-    - provider: azure
-      clientSecret: ${CLIENT_SECRET}
-      ...
-```
-Where CLIENT_SECRET is an environment variable.
-More information and available patterns can be found [here](https://github.com/a8m/envsubst#docs)
-
-## Removed options
-
-The following flags/options and their respective environment variables are no
-longer available when using alpha configuration:
-
-<!-- Legacy Upstream FlagSet -->
-- `flush-interval`/`flush_interval`
-- `pass-host-header`/`pass_host_header`
-- `proxy-websockets`/`proxy_websockets`
-- `ssl-upstream-insecure-skip-verify`/`ssl_upstream_insecure_skip_verify`
-- `upstream`/`upstreams`
-
-<!-- Legacy Headers FlagSet -->
-- `pass-basic-auth`/`pass_basic_auth`
-- `pass-access-token`/`pass_access_token`
-- `pass-user-headers`/`pass_user_headers`
-- `pass-authorization-header`/`pass_authorization_header`
-- `set-basic-auth`/`set_basic_auth`
-- `set-xauthrequest`/`set_xauthrequest`
-- `set-authorization-header`/`set_authorization_header`
-- `prefer-email-to-user`/`prefer_email_to_user`
-- `basic-auth-password`/`basic_auth_password`
-- `skip-auth-strip-headers`/`skip_auth_strip_headers`
-
-<!-- Legacy provider FlagSet -->
-- `client-id`/`client_id`
-- `client-secret`/`client_secret`, and `client-secret-file`/`client_secret_file`
-- `provider`
-- `provider-display-name`/`provider_display_name`
-- `provider-ca-file`/`provider_ca_files`
-- `login-url`/`login_url`
-- `redeem-url`/`redeem_url`
-- `profile-url`/`profile_url`
-- `resource`
-- `validate-url`/`validate_url`
-- `scope`
-- `prompt`
-- `approval-prompt`/`approval_prompt`
-- `acr-values`/`acr_values`
-- `user-id-claim`/`user_id_claim`
-- `allowed-group`/`allowed_groups`
-- `allowed-role`/`allowed_roles`
-- `jwt-key`/`jwt_key`
-- `jwt-key-file`/`jwt_key_file`
-- `pubjwk-url`/`pubjwk_url`
-
-and all provider-specific options, i.e. any option whose name includes `oidc`,
-`azure`, `bitbucket`, `github`, `gitlab`, `google` or `keycloak`.  Attempting to
-use any of these options via flags or via config when `--alpha-config` is
-set will result in an error.
-
-:::important
-You must remove these options before starting OAuth2 Proxy with `--alpha-config`
-:::
-
-## Configuration Reference

docs/versioned_docs/version-7.10.x/configuration/integration.md

@@ -1,310 +0,0 @@
----
-id: integration
-title: Integration
----
-
-## Configuring for use with the Nginx `auth_request` directive
-
-**This option requires `--reverse-proxy` option to be set.**
-
-The [Nginx `auth_request` directive](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html) allows Nginx to authenticate requests via the oauth2-proxy's `/auth` endpoint, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the request through. For example:
-
-```nginx
-server {
-  listen 443 ssl;
-  server_name ...;
-  include ssl/ssl.conf;
-
-  location /oauth2/ {
-    proxy_pass       http://127.0.0.1:4180;
-    proxy_set_header Host                    $host;
-    proxy_set_header X-Real-IP               $remote_addr;
-    proxy_set_header X-Auth-Request-Redirect $request_uri;
-    # or, if you are handling multiple domains:
-    # proxy_set_header X-Auth-Request-Redirect $scheme://$host$request_uri;
-  }
-  location = /oauth2/auth {
-    proxy_pass       http://127.0.0.1:4180;
-    proxy_set_header Host             $host;
-    proxy_set_header X-Real-IP        $remote_addr;
-    proxy_set_header X-Forwarded-Uri  $request_uri;
-    # nginx auth_request includes headers but not body
-    proxy_set_header Content-Length   "";
-    proxy_pass_request_body           off;
-  }
-
-  location / {
-    auth_request /oauth2/auth;
-    error_page 401 =403 /oauth2/sign_in;
-
-    # pass information via X-User and X-Email headers to backend,
-    # requires running with --set-xauthrequest flag
-    auth_request_set $user   $upstream_http_x_auth_request_user;
-    auth_request_set $email  $upstream_http_x_auth_request_email;
-    proxy_set_header X-User  $user;
-    proxy_set_header X-Email $email;
-
-    # if you enabled --pass-access-token, this will pass the token to the backend
-    auth_request_set $token  $upstream_http_x_auth_request_access_token;
-    proxy_set_header X-Access-Token $token;
-
-    # if you enabled --cookie-refresh, this is needed for it to work with auth_request
-    auth_request_set $auth_cookie $upstream_http_set_cookie;
-    add_header Set-Cookie $auth_cookie;
-
-    # When using the --set-authorization-header flag, some provider's cookies can exceed the 4kb
-    # limit and so the OAuth2 Proxy splits these into multiple parts.
-    # Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,
-    # so if your cookies are larger than 4kb, you will need to extract additional cookies manually.
-    auth_request_set $auth_cookie_name_upstream_1 $upstream_cookie_auth_cookie_name_1;
-
-    # Extract the Cookie attributes from the first Set-Cookie header and append them
-    # to the second part ($upstream_cookie_* variables only contain the raw cookie content)
-    if ($auth_cookie ~* "(; .*)") {
-        set $auth_cookie_name_0 $auth_cookie;
-        set $auth_cookie_name_1 "auth_cookie_name_1=$auth_cookie_name_upstream_1$1";
-    }
-
-    # Send both Set-Cookie headers now if there was a second part
-    if ($auth_cookie_name_upstream_1) {
-        add_header Set-Cookie $auth_cookie_name_0;
-        add_header Set-Cookie $auth_cookie_name_1;
-    }
-
-    proxy_pass http://backend/;
-    # or "root /path/to/site;" or "fastcgi_pass ..." etc
-  }
-}
-```
-
-When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:
-
-```yaml
-nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"
-nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"
-```
-
-This minimal configuration works for standard authentication flows. Lua/cookie handling is only needed for advanced scenarios (e.g., multi-part cookies, custom session logic). See the official ingress-nginx example: https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/.
-
-It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
-
-You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable  should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
-
-## Configuring for use with the Traefik (v2) `ForwardAuth` middleware
-
-**This option requires `--reverse-proxy` option to be set.**
-
-### ForwardAuth with 401 errors middleware
-
-The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
-
-```yaml
-http:
-  routers:
-    a-service:
-      rule: "Host(`a-service.example.com`)"
-      service: a-service-backend
-      middlewares:
-        - oauth-errors
-        - oauth-auth
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    oauth:
-      rule: "Host(`a-service.example.com`, `oauth.example.com`) && PathPrefix(`/oauth2/`)"
-      middlewares:
-        - auth-headers
-      service: oauth-backend
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-
-  services:
-    a-service-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.2:7555
-    oauth-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.1:4180
-
-  middlewares:
-    auth-headers:
-      headers:
-        sslRedirect: true
-        stsSeconds: 315360000
-        browserXssFilter: true
-        contentTypeNosniff: true
-        forceSTSHeader: true
-        sslHost: example.com
-        stsIncludeSubdomains: true
-        stsPreload: true
-        frameDeny: true
-    oauth-auth:
-      forwardAuth:
-        address: https://oauth.example.com/oauth2/auth
-        trustForwardHeader: true
-    oauth-errors:
-      errors:
-        status:
-          - "401-403"
-        service: oauth-backend
-        query: "/oauth2/sign_in?rd={url}"
-```
-
-### ForwardAuth with static upstreams configuration
-
-Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
-
-**Following options need to be set on `oauth2-proxy`:**
-- `--upstream=static://202`: Configures a static response for authenticated sessions
-- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly
-
-```yaml
-http:
-  routers:
-    a-service-route-1:
-      rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/`)"
-      service: a-service-backend
-      middlewares:
-        - oauth-auth-redirect # redirects all unauthenticated to oauth2 signin
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    a-service-route-2:
-      rule: "Host(`a-service.example.com`) && PathPrefix(`/no-auto-redirect`)"
-      service: a-service-backend
-      middlewares:
-        - oauth-auth-wo-redirect # unauthenticated session will return a 401
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    services-oauth2-route:
-      rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/oauth2/`)"
-      middlewares:
-        - auth-headers
-      service: oauth-backend
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-    oauth2-proxy-route:
-      rule: "Host(`oauth.example.com`) && PathPrefix(`/`)"
-      middlewares:
-        - auth-headers
-      service: oauth-backend
-      tls:
-        certResolver: default
-        domains:
-          - main: "example.com"
-            sans:
-              - "*.example.com"
-
-  services:
-    a-service-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.2:7555
-    b-service-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.3:7555
-    oauth-backend:
-      loadBalancer:
-        servers:
-          - url: http://172.16.0.1:4180
-
-  middlewares:
-    auth-headers:
-      headers:
-        sslRedirect: true
-        stsSeconds: 315360000
-        browserXssFilter: true
-        contentTypeNosniff: true
-        forceSTSHeader: true
-        sslHost: example.com
-        stsIncludeSubdomains: true
-        stsPreload: true
-        frameDeny: true
-    oauth-auth-redirect:
-      forwardAuth:
-        address: https://oauth.example.com/
-        trustForwardHeader: true
-        authResponseHeaders:
-          - X-Auth-Request-Access-Token
-          - Authorization
-    oauth-auth-wo-redirect:
-      forwardAuth:
-        address: https://oauth.example.com/oauth2/auth
-        trustForwardHeader: true
-        authResponseHeaders:
-          - X-Auth-Request-Access-Token
-          - Authorization
-```
-
-## Configuring for use with the Caddy (v2) `forward_auth` directive
-
-The [Caddy `forward_auth` directive](https://caddyserver.com/docs/caddyfile/directives/forward_auth) allows Caddy to authenticate requests via the `oauth2-proxy`'s `/auth`.
-
-This example is for a simple reverse proxy setup where the `/oauth2/` path is kept under the same domain and failed auth requests (401 status returned) will be caught and redirected to the `sign_in` endpoint.
-
-**Following options need to be set on `oauth2-proxy`:**
-- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly
-
-```nginx title="Caddyfile"
-example.com {
-	# Requests to /oauth2/* are proxied to oauth2-proxy without authentication.
-	# You can't use `reverse_proxy /oauth2/* oauth2-proxy.internal:4180` here because the reverse_proxy directive has lower precedence than the handle directive.
-	handle /oauth2/* {
-		reverse_proxy oauth2-proxy.internal:4180 {
-			# oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.
-			# The reverse_proxy directive automatically sets X-Forwarded-{For,Proto,Host} headers.
-			header_up X-Real-IP {remote_host}
-			header_up X-Forwarded-Uri {uri}
-		}
-	}
-
-	# Requests to other paths are first processed by oauth2-proxy for authentication.
-	handle {
-		forward_auth oauth2-proxy.internal:4180 {
-			uri /oauth2/auth
-
-			# oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.
-			# The forward_auth directive automatically sets the X-Forwarded-{For,Proto,Host,Method,Uri} headers.
-			header_up X-Real-IP {remote_host}
-
-			# If needed, you can copy headers from the oauth2-proxy response to the request sent to the upstream.
-			# Make sure to configure the --set-xauthrequest flag to enable this feature.
-			#copy_headers X-Auth-Request-User X-Auth-Request-Email
-
-			# If oauth2-proxy returns a 401 status, redirect the client to the sign-in page.
-			@error status 401
-			handle_response @error {
-				redir * /oauth2/sign_in?rd={scheme}://{host}{uri}
-			}
-		}
-
-		# If oauth2-proxy returns a 2xx status, the request is then proxied to the upstream.
-		reverse_proxy upstream.internal:3000
-	}
-}
-```
-
-:::note
-If you set up your OAuth2 provider to rotate your client secret, you can use the `client-secret-file` option to reload the secret when it is updated.
-:::

docs/versioned_docs/version-7.10.x/configuration/overview.md

@@ -1,402 +0,0 @@
----
-id: overview
-title: Overview
----
-
-`oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
-
-## Generating a Cookie Secret
-
-To generate a strong cookie secret use one of the below commands:
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<Tabs defaultValue="python">
-  <TabItem value="python" label="Python">
-
-```shell
-python -c 'import os,base64; print(base64.urlsafe_b64encode(os.urandom(32)).decode())'
-```
-
-  </TabItem>
-  <TabItem value="bash" label="Bash">
-
-```shell
-dd if=/dev/urandom bs=32 count=1 2>/dev/null | base64 | tr -d -- '\n' | tr -- '+/' '-_' ; echo
-```
-
-  </TabItem>
-  <TabItem value="openssl" label="OpenSSL">
-
-```shell
-openssl rand -base64 32 | tr -- '+/' '-_'
-```
-
-  </TabItem>
-  <TabItem value="powershell" label="PowerShell">
-
-```powershell
-# Add System.Web assembly to session, just in case
-Add-Type -AssemblyName System.Web
-[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes([System.Web.Security.Membership]::GeneratePassword(32,4))).Replace("+","-").Replace("/","_")
-```
-
-  </TabItem>
-  <TabItem value="terraform" label="Terraform">
-
-```hcl
-# Valid 32 Byte Base64 URL encoding set that will decode to 24 []byte AES-192 secret
-resource "random_password" "cookie_secret" {
-  length           = 32
-  override_special = "-_"
-}
-```
-
-  </TabItem>
-</Tabs>
-
-## Config File
-
-Every command line argument can be specified in a config file by replacing hyphens (-) with underscores (\_). If the argument can be specified multiple times, the config option should be plural (trailing s).
-
-An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/contrib/oauth2-proxy.cfg.example) config file is in the contrib directory. It can be used by specifying `--config=/etc/oauth2-proxy.cfg`
-
-## Config Options
-
-### Command Line Options
-
-| Flag        | Description          |
-| ----------- | -------------------- |
-| `--config`  | path to config file  |
-| `--version` | print version string |
-
-### General Provider Options
-
-Provider specific options can be found on their respective subpages.
-
-| Flag / Config Field                                                                                 | Type           | Description                                                                                                                                                                                              | Default               |
-| --------------------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| flag: `--acr-values`<br/>toml: `acr_values`                                                         | string         | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues)                                                                                                          | `""`                  |
-| flag: `--allowed-group`<br/>toml: `allowed_groups`                                                  | string \| list | Restrict login to members of a group or list of groups. Furthermore, if you aren't setting the `scope` and use `allowed_groups` with the generic OIDC provider the scope `groups` gets added implicitly. |                       |
-| flag: `--approval-prompt`<br/>toml: `approval_prompt`                                               | string         | OAuth approval_prompt                                                                                                                                                                                    | `"force"`             |
-| flag: `--backend-logout-url`<br/>toml: `backend_logout_url`                                         | string         | URL to perform backend logout, if you use `{id_token}` in the url it will be replaced by the actual `id_token` of the user session                                                                       |                       |
-| flag: `--client-id`<br/>toml: `client_id`                                                           | string         | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"`                                                                                                                                          |                       |
-| flag: `--client-secret-file`<br/>toml: `client_secret_file`                                         | string         | the file with OAuth Client Secret                                                                                                                                                                        |                       |
-| flag: `--client-secret`<br/>toml: `client_secret`                                                   | string         | the OAuth Client Secret                                                                                                                                                                                  |                       |
-| flag: `--code-challenge-method`<br/>toml: `code_challenge_method`                                   | string         | use PKCE code challenges with the specified method. Either 'plain' or 'S256' (recommended)                                                                                                               |                       |
-| flag: `--insecure-oidc-allow-unverified-email`<br/>toml: `insecure_oidc_allow_unverified_email`     | bool           | don't fail if an email address in an id_token is not verified                                                                                                                                            | false                 |
-| flag: `--insecure-oidc-skip-issuer-verification`<br/>toml: `insecure_oidc_skip_issuer_verification` | bool           | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility)                                                                                          | false                 |
-| flag: `--insecure-oidc-skip-nonce`<br/>toml: `insecure_oidc_skip_nonce`                             | bool           | skip verifying the OIDC ID Token's nonce claim                                                                                                                                                           | true                  |
-| flag: `--jwt-key-file`<br/>toml: `jwt_key_file`                                                     | string         | path to the private key file in PEM format used to sign the JWT so that you can say something like `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem`: required by login.gov                          |                       |
-| flag: `--jwt-key`<br/>toml: `jwt_key`                                                               | string         | private key in PEM format used to sign JWT, so that you can say something like `--jwt-key="${OAUTH2_PROXY_JWT_KEY}"`: required by login.gov                                                              |                       |
-| flag: `--login-url`<br/>toml: `login_url`                                                           | string         | Authentication endpoint                                                                                                                                                                                  |                       |
-| flag: `--auth-request-response-mode`<br/>toml: `auth-request-response-mode`                         | string         | Response mode to ask for during authentication request                                                                                                                                               |                       |
-| flag: `--oidc-audience-claim`<br/>toml: `oidc_audience_claims`                                      | string         | which OIDC claim contains the audience                                                                                                                                                                   | `"aud"`               |
-| flag: `--oidc-email-claim`<br/>toml: `oidc_email_claim`                                             | string         | which OIDC claim contains the user's email                                                                                                                                                               | `"email"`             |
-| flag: `--oidc-extra-audience`<br/>toml: `oidc_extra_audiences`                                      | string \| list | additional audiences which are allowed to pass verification                                                                                                                                              | `"[]"`                |
-| flag: `--oidc-groups-claim`<br/>toml: `oidc_groups_claim`                                           | string         | which OIDC claim contains the user groups                                                                                                                                                                | `"groups"`            |
-| flag: `--oidc-issuer-url`<br/>toml: `oidc_issuer_url`                                               | string         | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"`                                                                                                                                      |                       |
-| flag: `--oidc-jwks-url`<br/>toml: `oidc_jwks_url`                                                   | string         | OIDC JWKS URI for token verification; required if OIDC discovery is disabled and public key files are not provided                                                                                       |                       |
-| flag: `--oidc-public-key-file`<br/>toml: `oidc_public_key_files`                                    | string         | Path to public key file in PEM format to use for verifying JWT tokens (may be given multiple times). Required if OIDC discovery is disabled na JWKS URL isn't provided                                   | string \| list        |
-| flag: `--profile-url`<br/>toml: `profile_url`                                                       | string         | Profile access endpoint                                                                                                                                                                                  |                       |
-| flag: `--prompt`<br/>toml: `prompt`                                                                 | string         | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored                                                                               | `""`                  |
-| flag: `--provider-ca-file`<br/>toml: `provider_ca_files`                                            | string \| list | Paths to CA certificates that should be used when connecting to the provider. If not specified, the default Go trust sources are used instead.                                                           |
-| flag: `--provider-display-name`<br/>toml: `provider_display_name`                                   | string         | Override the provider's name with the given string; used for the sign-in page                                                                                                                            | (depends on provider) |
-| flag: `--provider`<br/>toml: `provider`                                                             | string         | OAuth provider                                                                                                                                                                                           | google                |
-| flag: `--pubjwk-url`<br/>toml: `pubjwk_url`                                                         | string         | JWK pubkey access endpoint: required by login.gov                                                                                                                                                        |                       |
-| flag: `--redeem-url`<br/>toml: `redeem_url`                                                         | string         | Token redemption endpoint                                                                                                                                                                                |                       |
-| flag: `--scope`<br/>toml:`scope`                                                                    | string         | OAuth scope specification. Every provider has a default list of scopes which will be used in case no scope is configured.                                                                                |                       |
-| flag: `--skip-claims-from-profile-url`<br/>toml: `skip_claims_from_profile_url`                     | bool           | skip request to Profile URL for resolving claims not present in id_token                                                                                                                                 | false                 |
-| flag: `--skip-oidc-discovery`<br/>toml: `skip_oidc_discovery`                                       | bool           | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case                                                                                      | false                 |
-| flag: `--use-system-trust-store`<br/>toml: `use_system_trust_store`                                 | bool           | Determines if `provider-ca-file` files and the system trust store are used. If set to true, your custom CA files and the system trust store are used otherwise only your custom CA files.                | false                 |
-| flag: `--validate-url`<br/>toml: `validate_url`                                                     | string         | Access token validation endpoint                                                                                                                                                                         |                       |
-
-### Cookie Options
-
-| Flag / Config Field                                                  | Type           | Description                                                                                                                                                                                                                        | Default           |
-| -------------------------------------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
-| flag: `--cookie-csrf-expire`<br/>toml: `cookie_csrf_expire`          | duration       | expire timeframe for CSRF cookie                                                                                                                                                                                                   | 15m               |
-| flag: `--cookie-csrf-per-request`<br/>toml:`cookie_csrf_per_request` | bool           | Enable having different CSRF cookies per request, making it possible to have parallel requests.                                                                                                                                    | false             |
-| flag: `--cookie-domain`<br/>toml: `cookie_domains`                   | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match).                                           |                   |
-| flag: `--cookie-expire`<br/>toml: `cookie_expire`                    | duration       | expire timeframe for cookie. If set to 0, cookie becomes a session-cookie which will expire when the browser is closed.                                                                                                            | 168h0m0s          |
-| flag: `--cookie-httponly`<br/>toml: `cookie_httponly`                | bool           | set HttpOnly cookie flag                                                                                                                                                                                                           | true              |
-| flag: `--cookie-name`<br/>toml: `cookie_name`                        | string         | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
-| flag: `--cookie-path`<br/>toml: `cookie_path`                        | string         | an optional cookie path to force cookies to (e.g. `/poc/`)                                                                                                                                                                         | `"/"`             |
-| flag: `--cookie-refresh`<br/>toml: `cookie_refresh`                  | duration       | refresh the cookie after this duration; `0` to disable; not supported by all providers&nbsp;[^1]                                                                                                                                   |                   |
-| flag: `--cookie-samesite`<br/>toml: `cookie_samesite`                | string         | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`).                                                                                                                                                            | `""`              |
-| flag: `--cookie-secret`<br/>toml: `cookie_secret`                    | string         | the seed string for secure cookies (optionally base64 encoded)                                                                                                                                                                     |                   |
-| flag: `--cookie-secure`<br/>toml: `cookie_secure`                    | bool           | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag)                                                                                                                                         | true              |
-
-[^1]: The following providers support `--cookie-refresh`: ADFS, Azure, GitLab, Google, Keycloak and all other Identity Providers which support the full [OIDC specification](https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens)
-
-### Header Options
-
-| Flag / Config Field                                                       | Type   | Description                                                                                                                                                                                                                                                      | Default |
-| ------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| flag: `--basic-auth-password`<br/>toml: `basic_auth_password`             | string | the password to set when passing the HTTP Basic Auth header                                                                                                                                                                                                      |         |
-| flag: `--set-xauthrequest`<br/>toml: `set_xauthrequest`                   | bool   | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode). When used with `--pass-access-token`, X-Auth-Request-Access-Token is added to response headers. | false   |
-| flag: `--set-authorization-header`<br/>toml: `set_authorization_header`   | bool   | set Authorization Bearer response header (useful in Nginx auth_request mode)                                                                                                                                                                                     | false   |
-| flag: `--set-basic-auth`<br/>toml: `set_basic_auth`                       | bool   | set HTTP Basic Auth information in response (useful in Nginx auth_request mode)                                                                                                                                                                                  | false   |
-| flag: `--skip-auth-strip-headers`<br/>toml: `skip_auth_strip_headers`     | bool   | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy                                                                                                                                                | true    |
-| flag: `--pass-access-token`<br/>toml: `pass_access_token`                 | bool   | pass OAuth access_token to upstream via X-Forwarded-Access-Token header. When used with `--set-xauthrequest` this adds the X-Auth-Request-Access-Token header to the response                                                                                    | false   |
-| flag: `--pass-authorization-header`<br/>toml: `pass_authorization_header` | bool   | pass OIDC IDToken to upstream via Authorization Bearer header                                                                                                                                                                                                    | false   |
-| flag: `--pass-basic-auth`<br/>toml: `pass_basic_auth`                     | bool   | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream                                                                                                                                             | true    |
-| flag: `--prefer-email-to-user`<br/>toml: `prefer_email_to_user`           | bool   | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers`                       | false   |
-| flag: `--pass-user-headers`<br/>toml: `pass_user_headers`                 | bool   | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream                                                                                                                                          | true    |
-
-### Logging Options
-
-| Flag / Config Field                                                   | Type   | Description                                                                  | Default                                             |
-| --------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------- | --------------------------------------------------- |
-| flag: `--auth-logging-format`<br/>toml: `auth_logging_format`         | string | Template for authentication log lines                                        | see [Logging Configuration](#logging-configuration) |
-| flag: `--auth-logging`<br/>toml: `auth_logging`                       | bool   | Log authentication attempts                                                  | true                                                |
-| flag: `--errors-to-info-log`<br/>toml: `errors_to_info_log`           | bool   | redirects error-level logging to default log channel instead of stderr       | false                                               |
-| flag: `--exclude-logging-path`<br/>toml: `exclude_logging_paths`      | string | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"` | `""` (no paths excluded)                            |
-| flag: `--logging-compress`<br/>toml: `logging_compress`               | bool   | Should rotated log files be compressed using gzip                            | false                                               |
-| flag: `--logging-filename`<br/>toml: `logging_filename`               | string | File to log requests to, empty for `stdout`                                  | `""` (stdout)                                       |
-| flag: `--logging-local-time`<br/>toml: `logging_local_time`           | bool   | Use local time in log files and backup filenames instead of UTC              | true (local time)                                   |
-| flag: `--logging-max-age`<br/>toml: `logging_max_age`                 | int    | Maximum number of days to retain old log files                               | 7                                                   |
-| flag: `--logging-max-backups`<br/>toml: `logging_max_backups`         | int    | Maximum number of old log files to retain; 0 to disable                      | 0                                                   |
-| flag: `--logging-max-size`<br/>toml: `logging_max_size`               | int    | Maximum size in megabytes of the log file before rotation                    | 100                                                 |
-| flag: `--request-id-header`<br/>toml: `request_id_header`             | string | Request header to use as the request ID in logging                           | X-Request-Id                                        |
-| flag: `--request-logging-format`<br/>toml: `request_logging_format`   | string | Template for request log lines                                               | see [Logging Configuration](#logging-configuration) |
-| flag: `--request-logging`<br/>toml: `request_logging`                 | bool   | Log requests                                                                 | true                                                |
-| flag: `--silence-ping-logging`<br/>toml: `silence_ping_logging`       | bool   | disable logging of requests to ping & ready endpoints                        | false                                               |
-| flag: `--standard-logging-format`<br/>toml: `standard_logging_format` | string | Template for standard log lines                                              | see [Logging Configuration](#logging-configuration) |
-| flag: `--standard-logging`<br/>toml: `standard_logging`               | bool   | Log standard runtime information                                             | true                                                |
-
-### Page Template Options
-
-| Flag / Config Field                                               | Type   | Description                                                                                                                 | Default |
-| ----------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- | ------- |
-| flag: `--banner`<br/>toml: `banner`                               | string | custom (html) banner string. Use `"-"` to disable default banner.                                                           |         |
-| flag: `--custom-sign-in-logo`<br/>toml: `custom_sign_in_logo`     | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo.                              |
-| flag: `--custom-templates-dir`<br/>toml: `custom_templates_dir`   | string | path to custom html templates                                                                                               |         |
-| flag: `--display-htpasswd-form`<br/>toml: `display_htpasswd_form` | bool   | display username / password login form if an htpasswd file is provided                                                      | true    |
-| flag: `--footer`<br/>toml: `footer`                               | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version)                    |         |
-| flag: `--show-debug-on-error`<br/>toml: `show_debug_on_error`     | bool   | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false   |
-
-### Probe Options
-
-| Flag / Config Field                                     | Type   | Description                                                | Default                       |
-| ------------------------------------------------------- | ------ | ---------------------------------------------------------- | ----------------------------- |
-| flag: `--ping-path`<br/>toml: `ping_path`               | string | the ping endpoint that can be used for basic health checks | `"/ping"`                     |
-| flag: `--ping-user-agent`<br/>toml: `ping_user_agent`   | string | a User-Agent that can be used for basic health checks      | `""` (don't check user agent) |
-| flag: `--ready-path`<br/>toml: `ready_path`             | string | the ready endpoint that can be used for deep health checks | `"/ready"`                    |
-| flag: `--gcp-healthchecks`<br/>toml: `gcp_healthchecks` | bool   | Enable GCP/GKE healthcheck endpoints (deprecated)          | false                         |
-
-### Proxy Options
-
-| Flag / Config Field                                                       | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Default     |
-| ------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| flag: `--allow-query-semicolons`<br/>toml: `allow_query_semicolons`       | bool           | allow the use of semicolons in query args ([required for some legacy applications](https://github.com/golang/go/issues/25192))                                                                                                                                                                                                                                                                                                                                                                                        | `false`     |
-| flag: `--api-route`<br/>toml: `api_routes`                                | string \| list | Requests to these paths must already be authenticated with a cookie, or a JWT if `--skip-jwt-bearer-tokens` is set. No redirect to login will be done. Return 401 if not. Format: path_regex                                                                                                                                                                                                                                                                                                                                                                                                             |             |
-| flag: `--authenticated-emails-file`<br/>toml: `authenticated_emails_file` | string         | authenticate against emails via file (one per line)                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |             |
-| flag: `--bearer-token-login-fallback`<br/>toml: `bearer_token_login_fallback`       | bool           | if `--skip-jwt-bearer-tokens` is set, if a request includes an invalid JWT (expired, malformed, missing required audiences, etc), fall back to normal login redirect as if the token were not sent at all. If false, respond 403 | true       |
-| flag: `--email-domain`<br/>toml: `email_domains`                          | string \| list | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email                                                                                                                                                                                                                                                                                                                                                                                                        |             |
-| flag: `--encode-state`<br/>toml: `encode_state`                           | bool           | encode the state parameter as UrlEncodedBase64                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | false       |
-| flag: `--extra-jwt-issuers`<br/>toml: `extra_jwt_issuers`                 | string         | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` (see a token's `iss`, `aud` fields) pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`)                                                                                                                                                                                                                                                                                                    |             |
-| flag: `--force-https`<br/>toml: `force_https`                             | bool           | enforce https redirect                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `false`     |
-| flag: `--force-json-errors`<br/>toml: `force_json_errors`                 | bool           | force JSON errors instead of HTTP error pages or redirects                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `false`     |
-| flag: `--htpasswd-file`<br/>toml: `htpasswd_file`                         | string         | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption                                                                                                                                                                                                                                                                                                                                                                                                   |             |
-| flag: `--htpasswd-user-group`<br/>toml: `htpasswd_user_groups`            | string \| list | the groups to be set on sessions for htpasswd users                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |             |
-| flag: `--proxy-prefix`<br/>toml: `proxy_prefix`                           | string         | the url root path that this proxy should be nested under (e.g. /`<oauth2>/sign_in`)                                                                                                                                                                                                                                                                                                                                                                                                                                   | `"/oauth2"` |
-| flag: `--real-client-ip-header`<br/>toml: `real_client_ip_header`         | string         | Header used to determine the real IP of the client, requires `--reverse-proxy` to be set (one of: X-Forwarded-For, X-Real-IP, X-ProxyUser-IP, X-Envoy-External-Address, or CF-Connecting-IP)                                                                                                                                                                                                                                                                                                                          | X-Real-IP   |
-| flag: `--redirect-url`<br/>toml: `redirect_url`                           | string         | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"`                                                                                                                                                                                                                                                                                                                                                                                                                                  |             |
-| flag: `--relative-redirect-url`<br/>toml: `relative_redirect_url`         | bool           | allow relative OAuth Redirect URL.`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | false       |
-| flag: `--reverse-proxy`<br/>toml: `reverse_proxy`                         | bool           | are we running behind a reverse proxy, controls whether headers like X-Real-IP are accepted and allows X-Forwarded-\{Proto,Host,Uri\} headers to be used on redirect selection                                                                                                                                                                                                                                                                                                                                        | false       |
-| flag: `--signature-key`<br/>toml: `signature_key`                         | string         | GAP-Signature request signature key (algorithm:secretkey)                                                                                                                                                                                                                                                                                                                                                                                                                                                             |             |
-| flag: `--skip-auth-preflight`<br/>toml: `skip_auth_preflight`             | bool           | will skip authentication for OPTIONS requests                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | false       |
-| flag: `--skip-auth-regex`<br/>toml: `skip_auth_regex`                     | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times)                                                                                                                                                                                                                                                                                                                                                                                                |             |
-| flag: `--skip-auth-route`<br/>toml: `skip_auth_routes`                    | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR method!=path_regex. For all methods: path_regex OR !=path_regex                                                                                                                                                                                                                                                                                                                                                         |             |
-| flag: `--skip-jwt-bearer-tokens`<br/>toml: `skip_jwt_bearer_tokens`       | bool           | will skip requests that have verified JWT bearer tokens (the token must have [`aud`](https://en.wikipedia.org/wiki/JSON_Web_Token#Standard_fields) that matches this client id or one of the extras from `extra-jwt-issuers`)                                                                                                                                                                                                                                                                                         | false       |
-| flag: `--skip-provider-button`<br/>toml: `skip_provider_button`           | bool           | will skip sign-in-page to directly reach the next step: oauth/start                                                                                                                                                                                                                                                                                                                                                                                                                                                   | false       |
-| flag: `--ssl-insecure-skip-verify`<br/>toml: `ssl_insecure_skip_verify`   | bool           | skip validation of certificates presented when using HTTPS providers                                                                                                                                                                                                                                                                                                                                                                                                                                                  | false       |
-| flag: `--trusted-ip`<br/>toml: `trusted_ips`                              | string \| list | list of IPs or CIDR ranges to allow to bypass authentication (may be given multiple times). When combined with `--reverse-proxy` and optionally `--real-client-ip-header` this will evaluate the trust of the IP stored in an HTTP header by a reverse proxy rather than the layer-3/4 remote address. WARNING: trusting IPs has inherent security flaws, especially when obtaining the IP address from an HTTP header (reverse-proxy mode). Use this option only if you understand the risks and how to manage them. |             |
-| flag: `--whitelist-domain`<br/>toml: `whitelist_domains`                  | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` or a `*.` to allow subdomains (e.g. `.example.com`, `*.example.com`)&nbsp;[^2]                                                                                                                                                                                                                                                                                                                                                         |             |
-
-[^2]: When using the `whitelist-domain` option, any domain prefixed with a `.` or a `*.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URL's protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
-
-### Server Options
-
-| Flag / Config Field                                                 | Type           | Description                                                                                                                                                                                                                                                                                                   | Default            |
-| ------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
-| flag: `--http-address`<br/>toml: `http_address`                     | string         | `[http://]<addr>:<port>` or `unix://<path>` or `fd:<int>` (case insensitive) to listen on for HTTP clients. Square brackets are required for ipv6 address, e.g. `http://[::1]:4180`                                                                                                                           | `"127.0.0.1:4180"` |
-| flag: `--https-address`<br/>toml: `https_address`                   | string         | `[https://]<addr>:<port>` to listen on for HTTPS clients. Square brackets are required for ipv6 address, e.g. `https://[::1]:443`                                                                                                                                                                             | `":443"`           |
-| flag: `--metrics-address`<br/>toml: `metrics_address`               | string         | the address prometheus metrics will be scraped from                                                                                                                                                                                                                                                           | `""`               |
-| flag: `--metrics-secure-address`<br/>toml: `metrics_secure_address` | string         | the address prometheus metrics will be scraped from if using HTTPS                                                                                                                                                                                                                                            | `""`               |
-| flag: `--metrics-tls-cert-file`<br/>toml: `metrics_tls_cert_file`   | string         | path to certificate file for secure metrics server                                                                                                                                                                                                                                                            | `""`               |
-| flag: `--metrics-tls-key-file`<br/>toml: `metrics_tls_key_file`     | string         | path to private key file for secure metrics server                                                                                                                                                                                                                                                            | `""`               |
-| flag: `--tls-cert-file`<br/>toml: `tls_cert_file`                   | string         | path to certificate file                                                                                                                                                                                                                                                                                      |                    |
-| flag: `--tls-key-file`<br/>toml: `tls_key_file`                     | string         | path to private key file                                                                                                                                                                                                                                                                                      |                    |
-| flag: `--tls-cipher-suite`<br/>toml: `tls_cipher_suites`            | string \| list | Restricts TLS cipher suites used by server to those listed (e.g. TLS_RSA_WITH_RC4_128_SHA) (may be given multiple times). If not specified, the default Go safe cipher list is used. List of valid cipher suites can be found in the [crypto/tls documentation](https://pkg.go.dev/crypto/tls#pkg-constants). |                    |
-| flag: `--tls-min-version`<br/>toml: `tls_min_version`               | string         | minimum TLS version that is acceptable, either `"TLS1.2"` or `"TLS1.3"`                                                                                                                                                                                                                                       | `"TLS1.2"`         |
-
-### Session Options
-
-| Flag / Config Field                                                                 | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                   | Default |
-| ----------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| flag: `--session-cookie-minimal`<br/>toml: `session_cookie_minimal`                 | bool           | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only)                                                                                                                                                                                                                                                                                                               | false   |
-| flag: `--session-store-type`<br/>toml: `session_store_type`                         | string         | [Session data storage backend](sessions.md); redis or cookie                                                                                                                                                                                                                                                                                                                                                  | cookie  |
-| flag: `--redis-cluster-connection-urls`<br/>toml: `redis_cluster_connection_urls`   | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster`                                                                                                                                                                                                                                                                                            |         |
-| flag: `--redis-connection-url`<br/>toml: `redis_connection_url`                     | string         | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`)                                                                                                                                                                                                                                                                                                                                    |         |
-| flag: `--redis-insecure-skip-tls-verify`<br/>toml: `redis_insecure_skip_tls_verify` | bool           | skip TLS verification when connecting to Redis                                                                                                                                                                                                                                                                                                                                                                | false   |
-| flag: `--redis-password`<br/>toml: `redis_password`                                 | string         | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url`                                                                                                                                                                                                                                                                                           |         |
-| flag: `--redis-sentinel-password`<br/>toml: `redis_sentinel_password`               | string         | Redis sentinel password. Used only for sentinel connection; any redis node passwords need to use `--redis-password`                                                                                                                                                                                                                                                                                           |         |
-| flag: `--redis-sentinel-master-name`<br/>toml: `redis_sentinel_master_name`         | string         | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel`                                                                                                                                                                                                                                                                                                                                   |         |
-| flag: `--redis-sentinel-connection-urls`<br/>toml: `redis_sentinel_connection_urls` | string \| list | List of Redis sentinel connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-sentinel`                                                                                                                                                                                                                                                                                          |         |
-| flag: `--redis-use-cluster`<br/>toml: `redis_use_cluster`                           | bool           | Connect to redis cluster. Must set `--redis-cluster-connection-urls` to use this feature                                                                                                                                                                                                                                                                                                                      | false   |
-| flag: `--redis-use-sentinel`<br/>toml: `redis_use_sentinel`                         | bool           | Connect to redis via sentinels. Must set `--redis-sentinel-master-name` and `--redis-sentinel-connection-urls` to use this feature                                                                                                                                                                                                                                                                            | false   |
-| flag: `--redis-connection-idle-timeout`<br/>toml: `redis_connection_idle_timeout`   | int            | Redis connection idle timeout seconds. If Redis [timeout](https://redis.io/docs/reference/clients/#client-timeouts) option is set to non-zero, the `--redis-connection-idle-timeout` must be less than Redis timeout option. Example: if either redis.conf includes `timeout 15` or using `CONFIG SET timeout 15` the `--redis-connection-idle-timeout` must be at least `--redis-connection-idle-timeout=14` | 0       |
-
-### Upstream Options
-
-| Flag / Config Field                                                                       | Type           | Description                                                                                                                                            | Default |
-| ----------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
-| flag: `--flush-interval`<br/>toml: `flush_interval`                                       | duration       | period between flushing response buffers when streaming responses                                                                                      | `"1s"`  |
-| flag: `--pass-host-header`<br/>toml: `pass_host_header`                                   | bool           | pass the request Host Header to upstream                                                                                                               | true    |
-| flag: `--proxy-websockets`<br/>toml: `proxy_websockets`                                   | bool           | enables WebSocket proxying                                                                                                                             | true    |
-| flag: `--ssl-upstream-insecure-skip-verify`<br/>toml: `ssl_upstream_insecure_skip_verify` | bool           | skip validation of certificates presented when using HTTPS upstreams                                                                                   | false   |
-| flag: `--upstream-timeout`<br/>toml: `upstream_timeout`                                   | duration       | maximum amount of time the server will wait for a response from the upstream                                                                           | 30s     |
-| flag: `--upstream`<br/>toml: `upstreams`                                                  | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://<status_code>` for static response. Routing is based on the path |         |
-
-## Upstreams Configuration
-
-`oauth2-proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers, unix socket or serve static files from the file system.
-
-To configure **HTTP and HTTPS upstreams**, provide such a URL in `--upstream=URL`. The scheme+host portion and the path portion are extracted to configure proxying behavior. When processing incoming requests, the path portion becomes a lookup key for selecting the destination server of the proxied request.
-
-* Upstream URLs *without a trailing slash,* like in `--upstream=http://service2.internal/foo`, will match an incoming request exactly to `/foo` in `https://this.o2p.example.com/foo`, and forward the request on to service2.internal, but not match a request to `https://this.o2p.example.com/foo/more` nor ...`.com/food`.
-* Upstream URLs *with a trailing slash,* like in `--upstream=http://service1.internal/foo/`, will match any incoming request to any incoming requests's path *starting with* `/foo/`, like `/foo/` and `/foo/more` and `/foo/lots/more?etc`.
-
-If multiple `--upstream` URLs' paths match an incoming request, the one with the longest matching path (the most specific match) takes priority over shorter (less specific) ones.
-
-**Unix socket upstreams** are configured as `unix:///path/to/unix.sock`.
-
-**Static file paths** are configured as a file:// URL. `file:///var/www/static/` will serve the files from that directory at `http://[oauth2-proxy url]/var/www/static/`, which may not be what you want. You can provide the path to where the files should be available by adding a fragment to the configured URL. The value of the fragment will then be used to specify which path the files are available at, e.g. `file:///var/www/static/#/static/` will make `/var/www/static/` available at `http://[oauth2-proxy url]/static/`.
-
-Multiple upstreams can either be configured by supplying a comma separated list to the `--upstream` parameter, supplying the parameter multiple times or providing a list in the [config file](#config-file). When multiple upstreams are used routing to them will be based on the path they are set up with.
-
-## Environment variables
-
-Every command line argument can be specified as an environment variable by
-prefixing it with `OAUTH2_PROXY_`, capitalising it, and replacing hyphens (`-`)
-with underscores (`_`). If the argument can be specified multiple times, the
-environment variable should be plural (trailing `S`).
-
-This is particularly useful for storing secrets outside a configuration file
-or the command line.
-
-For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.
-If a flag has the type `string | list` like the `--email-domain` flag it is
-available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS`
-
-Values for type `string | list` usually have a plural environment variable name
-and need to be seperated by `,` e.g.
-`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"`
-
-Please check the type for each [config option](#config-options) first.
-
-## Logging Configuration
-
-By default, OAuth2 Proxy logs all output to stdout. Logging can be configured to output to a rotating log file using the `--logging-filename` command.
-
-If logging to a file you can also configure the maximum file size (`--logging-max-size`), age (`--logging-max-age`), max backup logs (`--logging-max-backups`), and if backup logs should be compressed (`--logging-compress`).
-
-There are three different types of logging: standard, authentication, and HTTP requests. These can each be enabled or disabled with `--standard-logging`, `--auth-logging`, and `--request-logging`.
-
-Each type of logging has its own configurable format and variables. By default, these formats are similar to the Apache Combined Log.
-
-Logging of requests to the `/ping` endpoint (or using `--ping-user-agent`) and the `/ready` endpoint can be disabled with `--silence-ping-logging` reducing log volume.
-
-## Auth Log Format
-
-Authentication logs are logs which are guaranteed to contain a username or email address of a user attempting to authenticate. These logs are output by default in the below format:
-
-```
-<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [2015/03/19 17:20:19] [<STATUS>] <MESSAGE>
-```
-
-The status block will contain one of the below strings:
-
-- `AuthSuccess` If a user has authenticated successfully by any method
-- `AuthFailure` If the user failed to authenticate explicitly
-- `AuthError` If there was an unexpected error during authentication
-
-If you require a different format than that, you can configure it with the `--auth-logging-format` flag.
-The default format is configured as follows:
-
-```
-{{.Client}} - {{.RequestID}} - {{.Username}} [{{.Timestamp}}] [{{.Status}}] {{.Message}}
-```
-
-Available variables for auth logging:
-
-| Variable      | Example                              | Description                                                                                              |
-| ------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
-| Client        | 74.125.224.72                        | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
-| Host          | domain.com                           | The value of the Host header.                                                                            |
-| Message       | Authenticated via OAuth2             | The details of the auth attempt.                                                                         |
-| Protocol      | HTTP/1.0                             | The request protocol.                                                                                    |
-| RequestID     | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty                               |
-| RequestMethod | GET                                  | The request method.                                                                                      |
-| Timestamp     | 2015/03/19 17:20:19                  | The date and time of the logging event.                                                                  |
-| UserAgent     | -                                    | The full user agent as reported by the requesting client.                                                |
-| Username      | username@email.com                   | The email or username of the auth request.                                                               |
-| Status        | AuthSuccess                          | The status of the auth request. See above for details.                                                   |
-
-## Request Log Format
-
-HTTP request logs will output by default in the below format:
-
-```
-<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [2015/03/19 17:20:19] <HOST_HEADER> GET <UPSTREAM_HOST> "/path/" HTTP/1.1 "<USER_AGENT>" <RESPONSE_CODE> <RESPONSE_BYTES> <REQUEST_DURATION>
-```
-
-If you require a different format than that, you can configure it with the `--request-logging-format` flag.
-The default format is configured as follows:
-
-```
-{{.Client}} - {{.RequestID}} - {{.Username}} [{{.Timestamp}}] {{.Host}} {{.RequestMethod}} {{.Upstream}} {{.RequestURI}} {{.Protocol}} {{.UserAgent}} {{.StatusCode}} {{.ResponseSize}} {{.RequestDuration}}
-```
-
-Available variables for request logging:
-
-| Variable        | Example                              | Description                                                                                              |
-| --------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
-| Client          | 74.125.224.72                        | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
-| Host            | domain.com                           | The value of the Host header.                                                                            |
-| Protocol        | HTTP/1.0                             | The request protocol.                                                                                    |
-| RequestDuration | 0.001                                | The time in seconds that a request took to process.                                                      |
-| RequestID       | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty                               |
-| RequestMethod   | GET                                  | The request method.                                                                                      |
-| RequestURI      | "/oauth2/auth"                       | The URI path of the request.                                                                             |
-| ResponseSize    | 12                                   | The size in bytes of the response.                                                                       |
-| StatusCode      | 200                                  | The HTTP status code of the response.                                                                    |
-| Timestamp       | 2015/03/19 17:20:19                  | The date and time of the logging event.                                                                  |
-| Upstream        | -                                    | The upstream data of the HTTP request.                                                                   |
-| UserAgent       | -                                    | The full user agent as reported by the requesting client.                                                |
-| Username        | username@email.com                   | The email or username of the auth request.                                                               |
-
-## Standard Log Format
-
-All other logging that is not covered by the above two types of logging will be output in this standard logging format. This includes configuration information at startup and errors that occur outside of a session. The default format is below:
-
-```
-[2015/03/19 17:20:19] [main.go:40] <MESSAGE>
-```
-
-If you require a different format than that, you can configure it with the `--standard-logging-format` flag. The default format is configured as follows:
-
-```
-[{{.Timestamp}}] [{{.File}}] {{.Message}}
-```
-
-Available variables for standard logging:
-
-| Variable  | Example                           | Description                                        |
-| --------- | --------------------------------- | -------------------------------------------------- |
-| Timestamp | 2015/03/19 17:20:19               | The date and time of the logging event.            |
-| File      | main.go:40                        | The file and line number of the logging statement. |
-| Message   | HTTP: listening on 127.0.0.1:4180 | The details of the log statement.                  |

docs/versioned_docs/version-7.10.x/configuration/providers/adfs.md

@@ -1,19 +0,0 @@
----
-id: adfs
-title: ADFS
----
-
-1. Open the ADFS administration console on your Windows Server and add a new Application Group
-2. Provide a name for the integration, select Server Application from the Standalone applications section and click Next
-3. Follow the wizard to get the client-id, client-secret and configure the application credentials
-4. Configure the proxy with
-
-```
-   --provider=adfs
-   --client-id=<application ID from step 3>
-   --client-secret=<value from step 3>
-```
-
-Note: When using the ADFS Auth provider with nginx and the cookie session store you may find the cookie is too large and 
-doesn't get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the 
-[redis session storage](../sessions.md#redis-storage) should resolve this.

docs/versioned_docs/version-7.10.x/configuration/providers/bitbucket.md

@@ -1,25 +0,0 @@
----
-id: bitbucket
-title: BitBucket
----
-
-1. [Add a new OAuth consumer](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html)
-    * In "Callback URL" use `https://<oauth2-proxy>/oauth2/callback`, substituting `<oauth2-proxy>` with the actual 
-      hostname that oauth2-proxy is running on.
-    * In Permissions section select:
-        * Account -> Email
-        * Team membership -> Read
-        * Repositories -> Read
-2. Note the Client ID and Client Secret.
-
-To use the provider, pass the following options:
-
-```
-   --provider=bitbucket
-   --client-id=<Client ID>
-   --client-secret=<Client Secret>
-```
-
-The default configuration allows everyone with Bitbucket account to authenticate. To restrict the access to the team 
-members use additional configuration option: `--bitbucket-team=<Team name>`. To restrict the access to only these users 
-who have access to one selected repository use `--bitbucket-repository=<Repository name>`.

docs/versioned_docs/version-7.10.x/configuration/providers/digitalocean.md

@@ -1,21 +0,0 @@
----
-id: digitalocean
-title: DigitalOcean
----
-
-1. [Create a new OAuth application](https://cloud.digitalocean.com/account/api/applications)
-    * You can fill in the name, homepage, and description however you wish.
-    * In the "Application callback URL" field, enter: `https://oauth-proxy/oauth2/callback`, substituting `oauth2-proxy` 
-      with the actual hostname that oauth2-proxy is running on. The URL must match oauth2-proxy's configured redirect URL.
-2. Note the Client ID and Client Secret.
-
-To use the provider, pass the following options:
-
-```
-   --provider=digitalocean
-   --client-id=<Client ID>
-   --client-secret=<Client Secret>
-```
-
-Alternatively, set the equivalent options in the config file. The redirect URL defaults to 
-`https://<requested host header>/oauth2/callback`. If you need to change it, you can use the `--redirect-url` command-line option.

docs/versioned_docs/version-7.10.x/configuration/providers/facebook.md

@@ -1,7 +0,0 @@
----
-id: facebook
-title: Facebook
----
-
-1.  Create a new FB App from https://developers.facebook.com/
-2.  Under FB Login, set your Valid OAuth redirect URIs to `https://internal.yourcompany.com/oauth2/callback`

docs/versioned_docs/version-7.10.x/configuration/providers/gitea.md

@@ -1,24 +0,0 @@
----
-id: gitea
-title: Gitea
----
-
-:::note
-This is not actually its own provider. For more details and options please refer to the [GitHub Provider Options](github.md)
-:::
-
-1. Create a new application: `https://< your gitea host >/user/settings/applications`
-2. Under `Redirect URI` enter the correct URL i.e. `https://<proxied host>/oauth2/callback`
-3. Note the Client ID and Client Secret.
-4. Pass the following options to the proxy:
-
-```
-    --provider="github"
-    --redirect-url="https://<proxied host>/oauth2/callback"
-    --provider-display-name="Gitea"
-    --client-id="< client_id as generated by Gitea >"
-    --client-secret="< client_secret as generated by Gitea >"
-    --login-url="https://< your gitea host >/login/oauth/authorize"
-    --redeem-url="https://< your gitea host >/login/oauth/access_token"
-    --validate-url="https://< your gitea host >/api/v1/user/emails"
-```

docs/versioned_docs/version-7.10.x/configuration/providers/github.md

@@ -1,81 +0,0 @@
----
-id: github
-title: GitHub
----
-
-## Config Options
-
-| Flag             | Toml Field     | Type           | Description                                                                                                   | Default |
-| ---------------- | -------------- | -------------- | ------------------------------------------------------------------------------------------------------------- | ------- |
-| `--github-org`   | `github_org`   | string         | restrict logins to members of this organisation                                                               |         |
-| `--github-team`  | `github_team`  | string         | restrict logins to members of any of these teams (slug) or (org:team), comma separated                        |         |
-| `--github-repo`  | `github_repo`  | string         | restrict logins to collaborators of this repository formatted as `orgname/repo`                               |         |
-| `--github-token` | `github_token` | string         | the token to use when verifying repository collaborators (must have push access to the repository)            |         |
-| `--github-user`  | `github_users` | string \| list | To allow users to login by username even if they do not belong to the specified org and team or collaborators |         |
-
-## Usage
-
-1.  Create a new project: https://github.com/settings/developers
-2.  Under `Authorization callback URL` enter the correct url ie `https://internal.yourcompany.com/oauth2/callback`
-
-The GitHub auth provider supports two additional ways to restrict authentication to either organization and optional 
-team level access, or to collaborators of a repository. Restricting by these options is normally accompanied with `--email-domain=*`. Additionally, all the organizations and teams a user belongs to are set as part of the `X-Forwarded-Groups` header. e.g. `org1:team1,org1:team2,org2:team1`
-
-NOTE: When `--github-user` is set, the specified users are allowed to log in even if they do not belong to the specified 
-org and team or collaborators.
-
-To restrict access to your organization:
-
-```shell
-    # restrict logins to members of this organisation
-    --github-org="your-org"
-```
-
-To restrict access to specific teams within an organization:
-
-```shell
-    --github-org="your-org"
-    # restrict logins to members of any of these teams (slug), comma separated
-    --github-team="team1,team2,team3"
-```
-
-To restrict to teams within different organizations, keep the organization flag empty and use `--github-team` like so:
-
-```shell
-    # keep empty
-    --github-org=""
-    # restrict logins to members to any of the following teams (format <org>:<slug>, like octo:team1), comma separated
-    --github-team="org1:team1,org2:team1,org3:team42,octo:cat"
-```
-
-If you would rather restrict access to collaborators of a repository, those users must either have push access to a 
-public repository or any access to a private repository:
-
-```shell
-    # restrict logins to collaborators of this repository formatted as orgname/repo
-    --github-repo=""
-```
-
-If you'd like to allow access to users with **read only** access to a **public** repository you will need to provide a 
-[token](https://github.com/settings/tokens) for a user that has write access to the repository. The token must be 
-created with at least the `public_repo` scope:
-
-```shell
-    # the token to use when verifying repository collaborators
-    --github-token=""
-```
-
-To allow a user to log in with their username even if they do not belong to the specified org and team or collaborators:
-
-```shell
-    # allow logins by username, comma separated
-    --github-user=""
-```
-
-If you are using GitHub enterprise, make sure you set the following to the appropriate url:
-
-```shell
-    --login-url="http(s)://<enterprise github host>/login/oauth/authorize"
-    --redeem-url="http(s)://<enterprise github host>/login/oauth/access_token"
-    --validate-url="http(s)://<enterprise github host>/api/v3"
-```