From ea0a26e6048cab16c90cd54fb86f115a0c327001 Mon Sep 17 00:00:00 2001 From: bitpushr <91350598+bitpushr@users.noreply.github.com> Date: Thu, 25 Apr 2024 04:56:32 +1000 Subject: [PATCH] Update SCALE Docs (#21276) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ Fixes # **⚙️ 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?** **📃 Notes:** **✔️ 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 - [ ] 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/premium/authelia/docs/Setup-Guide.md | 2 +- charts/premium/clusterissuer/docs/how-to.md | 2 +- charts/premium/nextcloud/docs/installation-notes.md | 4 ++-- charts/premium/traefik/docs/how-to.md | 2 +- charts/stable/authentik/docs/how_to.md | 2 +- charts/stable/bitmagnet/docs/installation_notes.md | 2 +- charts/stable/duplicati/docs/ingress.md | 2 +- charts/stable/external-dns/docs/setup-guide.md | 2 +- charts/stable/jellyfin/docs/how-to.md | 2 +- charts/stable/jellyseerr/docs/how-to.md | 2 +- charts/stable/notifiarr/docs/how-to.md | 2 +- charts/stable/organizr/docs/forward_auth.md | 2 +- charts/stable/paperless-ngx/docs/how-to.md | 2 +- 13 files changed, 14 insertions(+), 14 deletions(-) diff --git a/charts/premium/authelia/docs/Setup-Guide.md b/charts/premium/authelia/docs/Setup-Guide.md index 0c35f70dc89..e3896f15d8f 100644 --- a/charts/premium/authelia/docs/Setup-Guide.md +++ b/charts/premium/authelia/docs/Setup-Guide.md @@ -94,7 +94,7 @@ Please see [Authelia Rules](./authelia-rules) for more advanced rules. ![TraefikForwardAuth](./img/TraefikForwardAuth.png) - Name your `forwardauth` something you'll remember, since that's the middleware you'll add to your ingress going forward. Most people use `auth` -- Address: `http://authelia.ix-authelia.svc.cluster.local:9091/api/verify?rd=https://auth.mydomain.com/` and replace the last part based on `mydomain.com`, and if you've changed ports/names you can get that from [`HeavyScript`](/scale/guides/getting-started/#heavyscript) +- Address: `http://authelia.ix-authelia.svc.cluster.local:9091/api/verify?rd=https://auth.mydomain.com/` and replace the last part based on `mydomain.com`, and if you've changed ports/names you can get that from [`HeavyScript`](/scale/#heavyscript) - Check `trustForwardHeader` - Add the following `authResponseHeaders` (press `Add` 4 times) - `Remote-User` diff --git a/charts/premium/clusterissuer/docs/how-to.md b/charts/premium/clusterissuer/docs/how-to.md index 0cade722861..8348a5b3624 100644 --- a/charts/premium/clusterissuer/docs/how-to.md +++ b/charts/premium/clusterissuer/docs/how-to.md @@ -6,7 +6,7 @@ This guide will walk you through setting up `clusterissuer`, certificate managem ## Prerequisites -- Ensure you have the `premium` and `system` trains enabled for `TrueCharts` as discussed [here](/scale/guides/getting-started/#adding-truecharts). +- Ensure you have the `premium` and `system` trains enabled for `TrueCharts` as discussed [here](/scale/#adding-truecharts). - [Traefik](/charts/premium/traefik/) is installed from premium train - [Cert-Mananger](/charts/system/cert-manager/) and [Prometheus-Operator](/charts/system/prometheus-operator/) diff --git a/charts/premium/nextcloud/docs/installation-notes.md b/charts/premium/nextcloud/docs/installation-notes.md index a2e2c4e0b1d..278f7953109 100644 --- a/charts/premium/nextcloud/docs/installation-notes.md +++ b/charts/premium/nextcloud/docs/installation-notes.md @@ -4,10 +4,10 @@ title: Installation Notes ## Requirements -1. The Cloudnative-PG operator is required from the `system` train. More information can be found on our [getting started guide](/scale/guides/getting-started/#prometheus-and-cnpg-system-app-installations) +1. The Cloudnative-PG operator is required from the `system` train. More information can be found on our [getting started guide](/scale/#prometheus-and-cnpg-system-app-installations) 2. Ingress is required to be configured. The preferred and supported method for ingress is Traefik. More information can be - found on our [getting started guide](/scale/guides/getting-started/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps). + found on our [getting started guide](/scale/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps). :::caution[SNAPSHOT DIRECTORY VISIBILITY] diff --git a/charts/premium/traefik/docs/how-to.md b/charts/premium/traefik/docs/how-to.md index aa747e5a7dc..e8e13f085d4 100644 --- a/charts/premium/traefik/docs/how-to.md +++ b/charts/premium/traefik/docs/how-to.md @@ -48,7 +48,7 @@ Ensure you are accessing your WebUI from the new ports before proceeding. :::note -Traefik is part of the `premium` train, so make sure you have it enabled as specified in the [guide](/scale/guides/getting-started/#adding-truecharts). +Traefik is part of the `premium` train, so make sure you have it enabled as specified in the [guide](/scale/#adding-truecharts). ::: diff --git a/charts/stable/authentik/docs/how_to.md b/charts/stable/authentik/docs/how_to.md index bd32326fde3..7e4d6f61ca6 100644 --- a/charts/stable/authentik/docs/how_to.md +++ b/charts/stable/authentik/docs/how_to.md @@ -12,7 +12,7 @@ This can be applied to other systems but this specific guide has been tested and ## Prerequisites -This guide assumes you're using Traefik as your Reverse Proxy / Ingress provider and have through the configuration listen in our [Quick-Start guides](/scale/guides/getting-started/) and/or the [Traefik documents](/charts/premium/traefik/how-to/). Please ensure that you can access your domain properly with Ingress before attempting any further steps. +This guide assumes you're using Traefik as your Reverse Proxy / Ingress provider and have through the configuration listen in our [Quick-Start guides](/scale/) and/or the [Traefik documents](/charts/premium/traefik/how-to/). Please ensure that you can access your domain properly with Ingress before attempting any further steps. ## Authentik Chart Setup diff --git a/charts/stable/bitmagnet/docs/installation_notes.md b/charts/stable/bitmagnet/docs/installation_notes.md index 4726afe978c..d656d26a38b 100644 --- a/charts/stable/bitmagnet/docs/installation_notes.md +++ b/charts/stable/bitmagnet/docs/installation_notes.md @@ -2,7 +2,7 @@ title: Scale App Installation --- -To effortlessly kickstart your journey with bitmagnet, integrate the [TrueCharts catalog](/scale/guides/getting-started/#adding-truecharts) and proceed with app installation on TrueNAS Scale. +To effortlessly kickstart your journey with bitmagnet, integrate the [TrueCharts catalog](/scale/#adding-truecharts) and proceed with app installation on TrueNAS Scale. Optionally, you can configure the `TMDB API Key` by following the guidelines outlined [here](https://bitmagnet.io/setup/configuration.html#obtaining-a-tmdb-api-key). diff --git a/charts/stable/duplicati/docs/ingress.md b/charts/stable/duplicati/docs/ingress.md index 26b1d0255c9..67d5eabd801 100644 --- a/charts/stable/duplicati/docs/ingress.md +++ b/charts/stable/duplicati/docs/ingress.md @@ -6,4 +6,4 @@ This chart requires Ingress to be enabled after initial install due to the confi ![image](https://user-images.githubusercontent.com/89483932/174445638-bac32cc8-375f-4fdb-a99f-f8b75a4613e1.png) -Once this is done you can successful add Ingress using the steps outlined inside our [Quick-Start Guide](/scale/guides/getting-started/). If you require more help or details please refer to our Discord for help from our Support Staff. +Once this is done you can successful add Ingress using the steps outlined inside our [Quick-Start Guide](/scale/). If you require more help or details please refer to our Discord for help from our Support Staff. diff --git a/charts/stable/external-dns/docs/setup-guide.md b/charts/stable/external-dns/docs/setup-guide.md index 331eff7c3b3..e03926816a1 100644 --- a/charts/stable/external-dns/docs/setup-guide.md +++ b/charts/stable/external-dns/docs/setup-guide.md @@ -13,7 +13,7 @@ Inspired by Kubernetes DNS, Kubernetes' cluster-internal DNS server, ExternalDNS - Traefik - Clusterissuer / Cert-manager installed (vital if exposed externally) -Please follow the [Getting Started](/scale/guides/getting-started/) guide on the [Truecharts](https://truecharts.org) website. +Please follow the [Getting Started](/scale/) guide on the [Truecharts](https://truecharts.org) website. ## Installation instructions diff --git a/charts/stable/jellyfin/docs/how-to.md b/charts/stable/jellyfin/docs/how-to.md index 62552380809..e2cb591c8e6 100644 --- a/charts/stable/jellyfin/docs/how-to.md +++ b/charts/stable/jellyfin/docs/how-to.md @@ -8,7 +8,7 @@ and our app is a simple way to install it on your TrueNAS SCALE server. ## Requirements - Jellyfin TrueCharts Chart -- Installation of the TrueCharts Catalog, starting [here](/scale/guides/getting-started/#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/scale/#adding-truecharts) ## Media Storage diff --git a/charts/stable/jellyseerr/docs/how-to.md b/charts/stable/jellyseerr/docs/how-to.md index c9873fa7ef6..283e6009062 100644 --- a/charts/stable/jellyseerr/docs/how-to.md +++ b/charts/stable/jellyseerr/docs/how-to.md @@ -8,7 +8,7 @@ title: Setup Guide - Jellyseerr TrueCharts Chart - Jellyfin TrueCharts Chart -- Installation of the TrueCharts Catalog, starting [here](/scale/guides/getting-started/#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/scale/#adding-truecharts) ## Install Jellyseerr inside TrueNAS SCALE diff --git a/charts/stable/notifiarr/docs/how-to.md b/charts/stable/notifiarr/docs/how-to.md index 6c3025372ef..f32ca7487fd 100644 --- a/charts/stable/notifiarr/docs/how-to.md +++ b/charts/stable/notifiarr/docs/how-to.md @@ -5,7 +5,7 @@ title: Setup Guide ## Requirements - Your 'All integrations' API key from your account on `notifiarr.com` -- Installation of the TrueCharts Catalog, starting [here](/scale/guides/getting-started/#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/scale/#adding-truecharts) ## Install Notifiarr inside TrueNAS SCALE diff --git a/charts/stable/organizr/docs/forward_auth.md b/charts/stable/organizr/docs/forward_auth.md index 6782522f7f9..de6d8aaba33 100644 --- a/charts/stable/organizr/docs/forward_auth.md +++ b/charts/stable/organizr/docs/forward_auth.md @@ -12,7 +12,7 @@ Basic setup guide for enabling Organizr authentication on your apps using Traefi ## Prerequisites This guide assumes you're using Traefik as your Reverse Proxy / Ingress provider and have through the configuration listed in our -[Quick-Start guides](/scale/guides/getting-started/) and/or the [Traefik documents](/charts/premium/traefik/how-to). +[Quick-Start guides](/scale/) and/or the [Traefik documents](/charts/premium/traefik/how-to). Please ensure that you can access your domain properly with Ingress before attempting any further steps. ## Organizr App Setup diff --git a/charts/stable/paperless-ngx/docs/how-to.md b/charts/stable/paperless-ngx/docs/how-to.md index 13cb1b77ded..577a9d77104 100644 --- a/charts/stable/paperless-ngx/docs/how-to.md +++ b/charts/stable/paperless-ngx/docs/how-to.md @@ -7,7 +7,7 @@ online archive. Our app is a simple way to install it on your TrueNAS SCALE serv ## Requirements -- Installation of the TrueCharts Catalog, starting [here](/scale/guides/getting-started/) and the required operators (Prometheus-Operator and Cloudnative-PG). +- Installation of the TrueCharts Catalog, starting [here](/scale/) and the required operators (Prometheus-Operator and Cloudnative-PG). - Paperless-ngx TrueCharts Chart ## Media Storage