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
2023-12-31 16:24:05 +02:00
committed by GitHub
parent f51b52481b
commit 12b5c56b24
989 changed files with 210173 additions and 357182 deletions
File diff suppressed because it is too large Load Diff
@@ -1,4 +1,6 @@
# Authelia + LLDAP + Traefik ForwardAuth Setup guide
---
title: Authelia + LLDAP + Traefik ForwardAuth Setup guide
---
This quick guide should take you through the steps necessary to setup `Authelia` as your `forwardAuth` for `Traefik`. We'll be using `LLDAP` as the backend for `Authelia` since it's lightweight and simple enough for most users. A more complete video is available on our YouTube Channel
@@ -1,4 +1,6 @@
# Authelia Rules
---
title: Authelia Rules
---
This is a collection of some common Authelia Rules.
@@ -1,4 +1,6 @@
# Input Validation
---
title: Input Validation
---
**`Default Redirection URL`**
+56 -150
View File
@@ -1,117 +1,89 @@
# Changelog
---
title: Changelog
---
## [blocky-1.1.13](https://github.com/truecharts/charts/compare/blocky-1.1.10...blocky-1.1.13) (2022-11-08)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4349](https://github.com/truecharts/charts/issues/4349))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4349](https://github.com/truecharts/charts/issues/4349))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
## [blocky-1.1.12](https://github.com/truecharts/charts/compare/blocky-1.1.10...blocky-1.1.12) (2022-11-08)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
## [blocky-1.1.12](https://github.com/truecharts/charts/compare/blocky-1.1.10...blocky-1.1.12) (2022-11-08)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
## [blocky-1.1.12](https://github.com/truecharts/charts/compare/blocky-1.1.10...blocky-1.1.12) (2022-11-08)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
## [blocky-1.1.11](https://github.com/truecharts/charts/compare/blocky-1.1.10...blocky-1.1.11) (2022-11-07)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
- Auto-update chart README [skip ci]
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
## [blocky-1.1.11](https://github.com/truecharts/charts/compare/blocky-1.1.10...blocky-1.1.11) (2022-11-06)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
- update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329))
## [blocky-1.1.10](https://github.com/truecharts/charts/compare/blocky-1.1.9...blocky-1.1.10) (2022-11-06)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#4317](https://github.com/truecharts/charts/issues/4317))
- update helm general non-major ([#4317](https://github.com/truecharts/charts/issues/4317))
## [blocky-1.1.9](https://github.com/truecharts/charts/compare/blocky-1.1.8...blocky-1.1.9) (2022-11-05)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#4308](https://github.com/truecharts/charts/issues/4308))
- update helm general non-major ([#4308](https://github.com/truecharts/charts/issues/4308))
## [blocky-1.1.8](https://github.com/truecharts/charts/compare/blocky-1.1.7...blocky-1.1.8) (2022-11-02)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#4261](https://github.com/truecharts/charts/issues/4261))
- update helm general non-major ([#4261](https://github.com/truecharts/charts/issues/4261))
## [blocky-1.1.7](https://github.com/truecharts/charts/compare/blocky-1.1.6...blocky-1.1.7) (2022-10-31)
@@ -119,74 +91,53 @@
- Auto-update chart README [skip ci]
### Fix
### Fix
- fix UI, wrong variable names ([#4258](https://github.com/truecharts/charts/issues/4258))
## [blocky-1.1.6](https://github.com/truecharts/charts/compare/blocky-1.1.5...blocky-1.1.6) (2022-10-25)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#4182](https://github.com/truecharts/charts/issues/4182))
- update helm general non-major ([#4182](https://github.com/truecharts/charts/issues/4182))
## [blocky-1.1.5](https://github.com/truecharts/charts/compare/blocky-1.1.4...blocky-1.1.5) (2022-10-19)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#4122](https://github.com/truecharts/charts/issues/4122))
- update helm general non-major ([#4122](https://github.com/truecharts/charts/issues/4122))
## [blocky-1.1.4](https://github.com/truecharts/charts/compare/blocky-1.1.3...blocky-1.1.4) (2022-10-12)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#4071](https://github.com/truecharts/charts/issues/4071))
- update helm general non-major ([#4071](https://github.com/truecharts/charts/issues/4071))
## [blocky-1.1.3](https://github.com/truecharts/charts/compare/blocky-1.1.2...blocky-1.1.3) (2022-10-07)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major
- Auto-update chart README [skip ci]
- update helm general non-major
## [blocky-1.1.3](https://github.com/truecharts/charts/compare/blocky-1.1.2...blocky-1.1.3) (2022-10-07)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major
- update helm general non-major
## [blocky-1.1.2](https://github.com/truecharts/charts/compare/blocky-1.1.1...blocky-1.1.2) (2022-10-05)
### Chore
- Auto-update chart README [skip ci]
- split addons in smaller templates ([#3979](https://github.com/truecharts/charts/issues/3979))
- update helm general non-major
- split addons in smaller templates ([#3979](https://github.com/truecharts/charts/issues/3979))
- update helm general non-major
## [blocky-1.1.1](https://github.com/truecharts/charts/compare/blocky-1.1.0...blocky-1.1.1) (2022-09-30)
@@ -194,31 +145,22 @@
- Auto-update chart README [skip ci]
### Feat
### Feat
- add blocky documentation links to descriptions ([#3964](https://github.com/truecharts/charts/issues/3964))
## [blocky-1.1.0](https://github.com/truecharts/charts/compare/blocky-1.0.11...blocky-1.1.0) (2022-09-29)
### Feat
- add DoH support on main ingress ([#3959](https://github.com/truecharts/charts/issues/3959))
## [blocky-1.0.10](https://github.com/truecharts/charts/compare/blocky-1.0.9...blocky-1.0.10) (2022-09-27)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#3918](https://github.com/truecharts/charts/issues/3918))
- update helm general non-major ([#3918](https://github.com/truecharts/charts/issues/3918))
## [blocky-1.0.9](https://github.com/truecharts/charts/compare/blocky-1.0.7...blocky-1.0.9) (2022-09-26)
@@ -226,46 +168,34 @@
- Auto-update chart README [skip ci]
## [blocky-1.0.7](https://github.com/truecharts/charts/compare/blocky-1.0.6...blocky-1.0.7) (2022-09-26)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
### Fix
### Fix
- fix GUI apiurl and prometheus metrics ([#3908](https://github.com/truecharts/charts/issues/3908))
## [blocky-1.0.6](https://github.com/truecharts/charts/compare/blocky-1.0.5...blocky-1.0.6) (2022-09-25)
### Chore
- Auto-update chart README [skip ci]
- bump version
- bump version
### Fix
### Fix
- allow port changes, allow dot, fix prometheus and fix api access ([#3899](https://github.com/truecharts/charts/issues/3899))
## [blocky-1.0.5](https://github.com/truecharts/charts/compare/blocky-1.0.4...blocky-1.0.5) (2022-09-25)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#3898](https://github.com/truecharts/charts/issues/3898))
- update helm general non-major ([#3898](https://github.com/truecharts/charts/issues/3898))
## [blocky-1.0.4](https://github.com/truecharts/charts/compare/blocky-1.0.3...blocky-1.0.4) (2022-09-25)
@@ -273,94 +203,70 @@
- Auto-update chart README [skip ci]
### Fix
### Fix
- update redis
## [blocky-1.0.3](https://github.com/truecharts/charts/compare/blocky-1.0.2...blocky-1.0.3) (2022-09-25)
### Chore
- Auto-update chart README [skip ci]
### Fix
### Fix
- use new common SA handler
## [blocky-1.0.2](https://github.com/truecharts/charts/compare/blocky-1.0.1...blocky-1.0.2) (2022-09-25)
### Chore
- Auto-update chart README [skip ci]
### Fix
### Fix
- disable probes until next release ([#3886](https://github.com/truecharts/charts/issues/3886))
## [blocky-1.0.1](https://github.com/truecharts/charts/compare/blocky-1.0.0...blocky-1.0.1) (2022-09-25)
### Chore
- Auto-update chart README [skip ci]
### Fix
### Fix
- set defaults to some durations ([#3885](https://github.com/truecharts/charts/issues/3885))
## [blocky-1.0.0](https://github.com/truecharts/charts/compare/blocky-0.0.4...blocky-1.0.0) (2022-09-24)
### Chore
- move blocky to enterprise ([#3875](https://github.com/truecharts/charts/issues/3875))
## [blocky-0.0.4](https://github.com/truecharts/charts/compare/blocky-0.0.3...blocky-0.0.4) (2022-09-24)
### Chore
- Auto-update chart README [skip ci]
### Fix
### Fix
- Finish up UI ([#3866](https://github.com/truecharts/charts/issues/3866))
## [blocky-0.0.3](https://github.com/truecharts/charts/compare/blocky-0.0.2...blocky-0.0.3) (2022-09-24)
### Chore
- Auto-update chart README [skip ci]
- update docker general non-major ([#3860](https://github.com/truecharts/charts/issues/3860))
- update docker general non-major ([#3860](https://github.com/truecharts/charts/issues/3860))
## [blocky-0.0.2](https://github.com/truecharts/charts/compare/blocky-0.0.1...blocky-0.0.2) (2022-09-23)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update docker general non-major ([#3850](https://github.com/truecharts/charts/issues/3850))
- Auto-update chart README [skip ci]
- update docker general non-major ([#3850](https://github.com/truecharts/charts/issues/3850))
## [blocky-0.0.1]blocky-0.0.1 (2022-09-22)
+8 -3
View File
@@ -1,4 +1,9 @@
# FAQ
---
title: FAQ
---
**Q: the webui is not working**
This is an upstream problem, sadly enough the current state of the webUI is not useable outside of a test environment. However, we added it to prepare for the day it is actually usable.
## Why the WebUI is not working?
This is an upstream problem, sadly enough the current state of
the webUI is not useable outside of a test environment.
However, we added it to prepare for the day it is actually usable.
@@ -1,4 +1,6 @@
# Installation notes
---
title: Installation notes
---
## Default Configuration
+3 -1
View File
@@ -1,4 +1,6 @@
# Blocky Setup Guide
---
title: Blocky Setup Guide
---
This will guide you through the basic setup of Blocky which is the preferred DNS solution for TrueCharts. This guide will cover basic setup options which will get you up and running and is not all inclusive. Configuring your devices to use Blocky is out of scope of this guide.
@@ -1,4 +1,6 @@
# Cluster Certificates Setup Guide
---
title: Cluster Certificates Setup Guide
---
This guide will walk you through setting up and using `cluster certificates`.
@@ -1,5 +1,6 @@
# clusterissuer Setup Guide
---
title: clusterissuer Setup Guide
---
This guide will walk you through setting up `clusterissuer`, certificate management for Kubernetes.
## Prerequisites
@@ -1,4 +1,6 @@
# Input Validation
---
title: Input Validation
---
**`Self Signed Issuer Name`, `ACME Issuer Entry` and `CA Issuer Name`**
Accepted formats are:
File diff suppressed because it is too large Load Diff
@@ -1,4 +1,6 @@
# MetalLB Basic Setup
---
title: MetalLB Basic Setup
---
The guide walks through a basic configuration of MetalLB for a single address pool on a layer 2 network. This will allow assigning different IP addresses by app.
File diff suppressed because it is too large Load Diff
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.
+3 -1
View File
@@ -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`
![ConfigureTraefikMiddlewares](img/ConfigureTraefikMiddlewares.png)
# 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.
File diff suppressed because it is too large Load Diff
@@ -1,4 +1,6 @@
# Disabling the Admin Interface
---
title: Disabling the Admin Interface
---
:::caution Backup Reminder