fix(docs): Fix NGINX YAML examples and Update recommended ingress to NGINX. (#34708)
**Description** Updates the recommended reverse proxy tool to NGINX. In addition, fixes the example YAML in the NGINX examples. I will add a task, but I could not get the examples to work with the ingressClassByName: true option. **⚙️ 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 - [x] 📜 Documentation Changes **🧪 How Has This Been Tested?** Used markdown preview in VS Code. **📃 Notes:** Wasn't sure if the customise misspelling was a locale thing. I can easily reverse it. **✔️ 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 changes to the documentation - [ ] 🧪 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 - [x] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ 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`
This commit is contained in:
@@ -9,7 +9,7 @@ Simply put, they specify reverse proxy configuration for a special reverse proxy
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
Before setting up ingress, we advise you to have an ingress controller already set-up. Our recommended ingress controller is [Traefik](https://github.com/traefik/traefik).
|
Before setting up ingress, we advise you to have an ingress controller already set-up. Our recommended ingress controller is [Nginx](https://kubernetes.github.io/ingress-nginx/).
|
||||||
|
|
||||||
## How to Setup
|
## How to Setup
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: NGINX
|
|||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
For NGINX we will setup 2 ingress controllers: Internal and External.
|
For NGINX we will deploy two ingress controllers: Internal and External.
|
||||||
Where External is either forwarded by your router or, for example, a cloudflare tunnel.
|
Where External is either forwarded by your router or, for example, a cloudflare tunnel.
|
||||||
Internal, however, is not routed anywhere and is used as a safe default to just have charts reached from your internal network only.
|
Internal, however, is not routed anywhere and is used as a safe default to just have charts reached from your internal network only.
|
||||||
|
|
||||||
@@ -67,8 +67,6 @@ Please note the IP variables that need to be set to your specific configuration
|
|||||||
#### External
|
#### External
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
||||||
values:
|
|
||||||
controller:
|
controller:
|
||||||
replicaCount: 2
|
replicaCount: 2
|
||||||
service:
|
service:
|
||||||
@@ -126,7 +124,7 @@ or
|
|||||||
|
|
||||||
## Annotations Examples
|
## Annotations Examples
|
||||||
|
|
||||||
Here we will showcase some annotations you can use to customise your NGINX ingress behavior
|
Here we will showcase some annotations you can use to customize your NGINX ingress behavior
|
||||||
|
|
||||||
### Redirect to Https
|
### Redirect to Https
|
||||||
|
|
||||||
@@ -159,7 +157,8 @@ annotations:
|
|||||||
```
|
```
|
||||||
|
|
||||||
For domain-level forward auth, you must configure the embedded outpost first (please refer to
|
For domain-level forward auth, you must configure the embedded outpost first (please refer to
|
||||||
[Authentik's docs](https://truecharts.org/charts/stable/authentik/how_to/)). The basic steps are to create a provider and application, then enable the embedded outpost for your newly created application.
|
[Authentik's docs](https://truecharts.org/charts/stable/authentik/how_to/)). The basic steps are
|
||||||
|
to create a provider and application, then enable the embedded outpost for your newly created application.
|
||||||
|
|
||||||
Once that has been done, configure each service you wish to place behind Authentik as follows:
|
Once that has been done, configure each service you wish to place behind Authentik as follows:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user