From ecbf5ddacfdbaca046c31c2f26d72885bdcfdbeb Mon Sep 17 00:00:00 2001 From: Xstar97TheNoob <9399967+xstar97@users.noreply.github.com> Date: Fri, 22 Mar 2024 06:06:10 -0400 Subject: [PATCH] fix(traefik-forward-auth) fix traefik-forward-auth remove root storage code from gui and update docs. (#19549) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** Remove gui code for the root storage and update docs ⚒️ Fixes # **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [X] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [X] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [X] ⬆️ I increased versions for any altered app according to semantic versioning - [X] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- charts/stable/traefik-forward-auth/Chart.yaml | 2 +- charts/stable/traefik-forward-auth/docs/how-to.md | 13 ++++++++++++- charts/stable/traefik-forward-auth/questions.yaml | 4 +--- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/charts/stable/traefik-forward-auth/Chart.yaml b/charts/stable/traefik-forward-auth/Chart.yaml index fcf9c8d3aae..63eb796aa6f 100644 --- a/charts/stable/traefik-forward-auth/Chart.yaml +++ b/charts/stable/traefik-forward-auth/Chart.yaml @@ -38,4 +38,4 @@ sources: - https://github.com/truecharts/charts/tree/master/charts/stable/traefik-forward-auth - https://hub.docker.com/r/thomseddon/traefik-forward-auth type: application -version: 3.7.1 +version: 3.7.2 diff --git a/charts/stable/traefik-forward-auth/docs/how-to.md b/charts/stable/traefik-forward-auth/docs/how-to.md index 194fc26bd88..69443d22938 100644 --- a/charts/stable/traefik-forward-auth/docs/how-to.md +++ b/charts/stable/traefik-forward-auth/docs/how-to.md @@ -1,15 +1,26 @@ --- title: traefik-forward-auth +description: A How To Guide for Traefik Forward Auth. --- +:::note + +We highly recommend to setup [authelia](/charts/premium/authelia/docs/Setup-Guide.md) instead. + +::: + This app makes it possible to have a layer of security in front of your publicly exposed apps. It supports Google, OIDC, and generic OAuth2. Please read the [GitHub README of the original project](https://github.com/thomseddon/traefik-forward-auth) for your authentication options. -Note: generally, phone apps do not support redirection during their authentication flow, so this middleware is more suitable for +:::note + +generally, phone apps do not support redirection during their authentication flow, so this middleware is more suitable for protecting portals that you would access through a browser. +::: + ## A standard setup (auth host mode) This method will add a middleware to the traefik instance with Google authentication which then you can apply on any apps diff --git a/charts/stable/traefik-forward-auth/questions.yaml b/charts/stable/traefik-forward-auth/questions.yaml index 9d2f89e5314..e98e377b0ae 100644 --- a/charts/stable/traefik-forward-auth/questions.yaml +++ b/charts/stable/traefik-forward-auth/questions.yaml @@ -293,8 +293,6 @@ questions: # Include{serviceExpertRoot} # Include{serviceExpert} # Include{serviceList} -# Include{persistenceRoot} -# Include{persistenceBasic} # Include{persistenceList} # Include{ingressRoot} - variable: main @@ -315,7 +313,7 @@ questions: default: 568 - variable: runAsGroup label: "runAsGroup" - description: "The groupID this App of the user running the application" + description: "The groupID of the user running the application" schema: type: int default: 568