chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589)
**Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 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?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 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 - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ 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._
This commit is contained in:
Stavros Kois
File diff suppressed because it is too large
Load Diff
@@ -1,3 +1,5 @@
|
||||
# Authelia + LLDAP + Traefik ForwardAuth Setup guide
|
||||
---
|
||||
title: Authelia + LLDAP + Traefik ForwardAuth Setup guide
|
||||
---
|
||||
|
||||
Please refer to the full [Authelia + LLDAP + Traefik ForwardAuth Setup guide](https://truecharts.org/charts/enterprise/authelia/Setup-Guide) for a quick guide should take you through the steps necessary to setup `Authelia` as your `forwardAuth` for `Traefik`.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Adding or removing headers
|
||||
---
|
||||
title: Adding or removing headers
|
||||
---
|
||||
|
||||
The `customRequestHeaders` and `customResponseHeaders` middlewares will allow you to add or remove headers from the request or response.
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Installing Traefik
|
||||
---
|
||||
title: Installing Traefik
|
||||
---
|
||||
|
||||
Within TrueCharts, our aim is to make it as easy as possible to secure your Apps.
|
||||
To support this, we supply a separate Traefik "ingress" app, which has been pre-configured to provide secure and fast connections.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Redirect Regex
|
||||
---
|
||||
title: Redirect Regex
|
||||
---
|
||||
|
||||
The Redirect Regex middleware redirects a request using regex matching and replacement.
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Theme Park
|
||||
---
|
||||
title: Theme Park
|
||||
---
|
||||
|
||||
Theme park is a middleware to inject [supported stylesheets (css)](https://docs.theme-park.dev/theme-options)
|
||||
into [supported apps](https://docs.theme-park.dev/themes).
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
# Add Traefik Basic Auth to Apps
|
||||
---
|
||||
title: Add Traefik Basic Auth to Apps
|
||||
---
|
||||
|
||||
Our `traefik` chart has the ability to add various `middlewares` to the chart can add extra functionality to your setup. You can see the full list of `middlewares` inside the `traefik` menu options. In this guide we'll go over setting up the `Basic Auth` traefik middleware.
|
||||
|
||||
# Prerequisites
|
||||
## Prerequisites
|
||||
|
||||
- Traefik installed (see previous steps of `SCALE Apps Manual`)
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
Once `traefik` is installed, scroll down to the `Middlewares` section
|
||||
|
||||
@@ -17,7 +19,7 @@ When there, you can fill out the `Configure basicAuth` section with as follows
|
||||
- Name the `basicAuth`, most people choose `basic`
|
||||
- Add as name users as necessary, choosing a specific `Username` and `Password` for each user.
|
||||
|
||||
# Adding it to Apps using Ingress
|
||||
## Adding it to Apps using Ingress
|
||||
|
||||
Once you have your `basicAuth` setup, you need to add it to apps that have `Ingress`(Traefik) enabled, otherwise you cannot use this middleware.
|
||||
|
||||
@@ -30,7 +32,7 @@ Scroll to the section `Configure Traefik Middlewares`
|
||||
|
||||
|
||||
|
||||
# Verify Authentication
|
||||
## Verify Authentication
|
||||
|
||||
Once the `basicAuth` is installed, please visit the `URL` that you configured the `Ingress` for. If everything is setup correctly you should see the Pop-Up below.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user