docs(organizr): helmify docs (#32839)

**Description**
<!--
helmify docs
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ 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?**
<!--
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
- [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`

---

_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:
Boemeltrein
2025-03-03 22:29:55 +01:00
committed by GitHub
parent 63242df4b7
commit b73edb91db
8 changed files with 30 additions and 18 deletions
+30 -18
View File
@@ -6,8 +6,8 @@ Basic setup guide for enabling Organizr authentication on your apps using Traefi
## Requirements ## Requirements
- Organizr TrueCharts App - Organizr TrueCharts Chart
- Traefik TrueCharts App - Traefik TrueCharts Chart
## Prerequisites ## Prerequisites
@@ -15,17 +15,10 @@ This guide assumes you're using Traefik as your Reverse Proxy / Ingress provider
[Quick-Start guides]. [Quick-Start guides].
Please ensure that you can access your domain properly with Ingress before attempting any further steps. Please ensure that you can access your domain properly with Ingress before attempting any further steps.
## Organizr App Setup ## Organizr Chart Setup
All of the defaults are fine to start off, however `ingress` must be set if you wish to use `organizr` with `traefik`. All of the defaults are fine to start off, however `ingress` must be set if you wish to use `organizr` with `traefik`.
In this guide the chart name is `organizr` and ingress is configured as `organizr.example.com`
In this guide the app name is `organizr` and ingress is configured as `organizr.example.com`
**Ingress Example**
![organizr-ingress-section](./img/organizr-ingress-section.png)
(also complete the TLS section for ingress configuration using the same hostname as above)
## Organizr GUI Setup ## Organizr GUI Setup
@@ -40,7 +33,7 @@ No changes needed here for now unless you want to create a custom group
### Configure Traefik Redirect ### Configure Traefik Redirect
Goto Organizr Settings -> Main -> Security Goto Organizr Settings -> System Settings -> Main -> Security
- Set `Enable Traefik Auth Redirect` to on - Set `Enable Traefik Auth Redirect` to on
- Set `Traefik Domain for Return Override` to `https://organizr.example.com` (this should match the address you defined in the Organizr app ingress section) - Set `Traefik Domain for Return Override` to `https://organizr.example.com` (this should match the address you defined in the Organizr app ingress section)
@@ -56,11 +49,21 @@ We will use the Organizr user groups that map to specific forwardAuth URLs.
The below table shows the example forwardAuth entries that correspond to the user groups in Organizr. The below table shows the example forwardAuth entries that correspond to the user groups in Organizr.
The URLs for these entries use the kubernetes internal DNS address & default port (`10022`) for your Organizr app. You can name the forwardAuth entries whatever you like. The URLs for these entries use the kubernetes internal DNS address & default port (`10022`) for your Organizr app. You can name the forwardAuth entries whatever you like.
| forwardAuth Name | forwardAuth Address | screenshot | ```yaml
| :------------------------------------ | :-------------------------------------------------------------------------- | :-------------------------------------------------------------------: | middlewares:
| `organizr-admin` | `http://organizr.ix-organizr.svc.cluster.local:10022/api/v2/auth?group=0` | ![Organizr-admin-forwardAuth](./img/organizr-admin-forwardAuth.png) | forwardAuth:
| `organizr-guest` (optional) | `http://organizr.ix-organizr.svc.cluster.local:10022/api/v2/auth?group=999` | ![Organizr-guest-forwardAuth](./img/organizr-guest-forwardAuth.png) | - name: organizr-admin
| `organizr-custom5` (optional, custom) | `http://organizr.ix-organizr.svc.cluster.local:10022/api/v2/auth?group=5` | ![Organizr-custom-forwardAuth](./img/organizr-custom-forwardAuth.png) | address: http://organizr.organizr.svc.cluster.local:10022/api/v2/auth?group=0
trustForwardHeader: true
#OPTIONAL
- name: organizr-guest
address: http://organizr.organizr.svc.cluster.local:10022/api/v2/auth?group=999
trustForwardHeader: true
#OPTIONAL, CUSTOM
- name: organizr-custom5
address: http://organizr.organizr.svc.cluster.local:10022/api/v2/auth?group=5
trustForwardHeader: true
```
See Organizr [documentation](https://docs.organizr.app/features/server-authentication#using-the-organizr-authorization-api) on "Server Authentication" See Organizr [documentation](https://docs.organizr.app/features/server-authentication#using-the-organizr-authorization-api) on "Server Authentication"
for more details on the predefined groups and their corresponding URL pattern. for more details on the predefined groups and their corresponding URL pattern.
@@ -70,7 +73,16 @@ for more details on the predefined groups and their corresponding URL pattern.
Once that is done all you need to add the `middleware` to your apps under the `Ingress section`, corresponding to the level of Once that is done all you need to add the `middleware` to your apps under the `Ingress section`, corresponding to the level of
permissions the app's user should have to access it. Example below uses `organizr-admin`. permissions the app's user should have to access it. Example below uses `organizr-admin`.
![organizr-traefik-middleware](./img/organizr-traefik-middleware.png) ```yaml
ingress:
main:
integrations:
traefik:
enabled: true
middlewares:
- name: organizr-admin
namespace: traefik
```
## Verify it works ## Verify it works
Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 MiB

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 810 KiB

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB