From 0cd63e8dc5f953652eaa899daebdfdcd8447fe2f Mon Sep 17 00:00:00 2001 From: Kjeld Schouten Date: Sat, 16 Mar 2024 11:47:30 +0100 Subject: [PATCH] chore(docs/ci): ensure docs and ci reflect new train names (#19211) 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._ --- .github/CODEOWNERS | 4 ++-- .github/ct-install.yaml | 4 ++-- .github/ct-lint.yaml | 4 ++-- .github/renovate.json5 | 14 +++++++------- .github/scripts/install_dependencies.sh | 10 +++++----- charts/incubator/immich/docs/install_notes.md | 4 ++-- charts/premium/authelia/docs/Setup-Guide.md | 12 ++++++------ .../clusterissuer/docs/cluster-certificates.md | 2 +- charts/premium/clusterissuer/docs/how-to.md | 6 +++--- charts/premium/metallb-config/docs/setup-guide.md | 8 ++++---- .../traefik/docs/Authelia-LLDAP-forwardauth.md | 2 +- charts/premium/traefik/docs/how-to.md | 2 +- charts/stable/authentik/docs/how_to.md | 2 +- charts/stable/bitmagnet/docs/installation_notes.md | 2 +- .../stable/cloudflared/docs/installation_notes.md | 2 +- charts/stable/cloudflareddns/docs/setup-guide.md | 2 +- .../lldap/docs/authelia-lldap-forwardauth.md | 2 +- charts/stable/lldap/docs/authelia.md | 2 +- charts/stable/organizr/docs/forward_auth.md | 2 +- charts/stable/paperless-ngx/docs/how-to.md | 8 ++++---- charts/stable/pihole/docs/split-dns.md | 4 ++-- charts/stable/strapi/docs/installation_notes.md | 2 +- 22 files changed, 50 insertions(+), 50 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 6176140ab9a..75b629ba1e5 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -2,8 +2,8 @@ * @ornias1993 /charts/stable/ @truecharts/stable-maintainers @ornias1993 /charts/incubator/ @truecharts/incubator-maintainers @Ornias1993 -/charts/dependency/ @truecharts/enterprise-maintainers @ornias1993 -/charts/enterprise/ @truecharts/enterprise-maintainers @ornias1993 +/charts/dependency/ @truecharts/premium-maintainers @ornias1993 +/charts/premium/ @truecharts/premium-maintainers @ornias1993 /charts/dev/ @ornias1993 /charts/unstable/ @ornias1993 /.github/ @truecharts/ci-maintainers @ornias1993 diff --git a/.github/ct-install.yaml b/.github/ct-install.yaml index a0053e6844a..40da0e546d2 100644 --- a/.github/ct-install.yaml +++ b/.github/ct-install.yaml @@ -7,8 +7,8 @@ chart-dirs: - charts/stable - charts/dependency - charts/dev - - charts/enterprise - - charts/operators + - charts/premium + - charts/system excluded-charts: - charts/dependency/subchart - charts/incubator/alienswarm diff --git a/.github/ct-lint.yaml b/.github/ct-lint.yaml index bd4f81a27a8..fc6fde06f48 100644 --- a/.github/ct-lint.yaml +++ b/.github/ct-lint.yaml @@ -7,8 +7,8 @@ chart-dirs: - charts/stable - charts/dependency - charts/dev - - charts/enterprise - - charts/operators + - charts/premium + - charts/system excluded-charts: [] chart-repos: - jetstack=https://charts.jetstack.io diff --git a/.github/renovate.json5 b/.github/renovate.json5 index 6a00de8380a..0cb66eea420 100644 --- a/.github/renovate.json5 +++ b/.github/renovate.json5 @@ -112,7 +112,7 @@ "labels": ["update/helm/general/major"], "automerge": false, "groupName": ["helm general major"], - "matchPaths": ["charts/stable/**", "charts/enterprise/**", "charts/operators/**"], + "matchPaths": ["charts/stable/**", "charts/premium/**", "charts/system/**"], "schedule": [ "before 10pm on tuesday" ], @@ -128,7 +128,7 @@ "bumpVersion": "minor", "labels": ["update/helm/general/minor", "automerge"], "groupName": "helm general minor", - "matchPaths": ["charts/stable/**", "charts/enterprise/**", "charts/operators/**"], + "matchPaths": ["charts/stable/**", "charts/premium/**", "charts/system/**"], "schedule": [ "before 10pm on tuesday" ], @@ -145,7 +145,7 @@ "bumpVersion": "patch", "labels": ["update/helm/general/non-major", "automerge"], "groupName": "helm general non-major", - "matchPaths": ["charts/stable/**", "charts/enterprise/**", "charts/operators/**"], + "matchPaths": ["charts/stable/**", "charts/premium/**", "charts/system/**"], "schedule": [ "before 10pm on tuesday" ], @@ -159,7 +159,7 @@ "bumpVersion": "minor", "enabled": true, "labels": ["update/docker/general/major"], - "matchPaths": ["charts/dependency/**", "charts/stable/**", "charts/incubator/**", "charts/enterprise/**", "charts/operators/**"], + "matchPaths": ["charts/dependency/**", "charts/stable/**", "charts/incubator/**", "charts/premium/**", "charts/system/**"], "schedule": [ "before 10pm on monday" ], @@ -174,7 +174,7 @@ "bumpVersion": "minor", "enabled": true, "labels": ["update/docker/general/non-major", "automerge"], - "matchPaths": ["charts/dependency/**", "charts/stable/**", "charts/incubator/**", "charts/enterprise/**", "charts/operators/**"], + "matchPaths": ["charts/dependency/**", "charts/stable/**", "charts/incubator/**", "charts/premium/**", "charts/system/**"], "schedule": [ "before 10pm on monday" ], @@ -190,7 +190,7 @@ "bumpVersion": "patch", "enabled": true, "labels": ["update/docker/general/non-major", "automerge"], - "matchPaths": ["charts/dependency/**", "charts/stable/**", "charts/incubator/**", "charts/enterprise/**", "charts/operators/**"], + "matchPaths": ["charts/dependency/**", "charts/stable/**", "charts/incubator/**", "charts/premium/**", "charts/system/**"], "schedule": [ "before 10pm on monday" ], @@ -601,7 +601,7 @@ { "matchDatasources": ["docker"], "versioning": "regex:^release-(?\\d*)\\.(?\\d*)$", - "matchPackageNames": ["mattermost/mattermost-enterprise-edition"], + "matchPackageNames": ["mattermost/mattermost-premium-edition"], "automerge": true, }, { diff --git a/.github/scripts/install_dependencies.sh b/.github/scripts/install_dependencies.sh index dde17d3a89e..002f87f9552 100755 --- a/.github/scripts/install_dependencies.sh +++ b/.github/scripts/install_dependencies.sh @@ -10,7 +10,7 @@ fi echo "Chart name: $curr_chart" -if [[ "$curr_chart" == "charts/enterprise/metallb-config" ]]; then +if [[ "$curr_chart" == "charts/premium/metallb-config" ]]; then echo "Installing metallb chart" helm install metallb oci://tccr.io/truecharts/metallb --namespace metallb --create-namespace --wait if [[ "$?" != "0" ]]; then @@ -21,7 +21,7 @@ if [[ "$curr_chart" == "charts/enterprise/metallb-config" ]]; then fi -if [[ "$curr_chart" == "charts/enterprise/clusterissuer" ]]; then +if [[ "$curr_chart" == "charts/premium/clusterissuer" ]]; then echo "Installing cert-manager chart" helm install cert-manager oci://tccr.io/truecharts/cert-manager --namespace cert-manager --create-namespace --wait if [[ "$?" != "0" ]]; then @@ -31,7 +31,7 @@ if [[ "$curr_chart" == "charts/enterprise/clusterissuer" ]]; then echo "Done installing cert-manager chart" fi -if [[ "$curr_chart" != "charts/operators/prometheus-operator" ]]; then +if [[ "$curr_chart" != "charts/system/prometheus-operator" ]]; then echo "Installing prometheus-operator chart" helm install prometheus-operator oci://tccr.io/truecharts/prometheus-operator --namespace prometheus-operator --create-namespace --wait if [[ "$?" != "0" ]]; then @@ -41,7 +41,7 @@ if [[ "$curr_chart" != "charts/operators/prometheus-operator" ]]; then echo "Done installing prometheus-operator chart" fi -if [[ "$curr_chart" != "charts/operators/cloudnative-pg" ]]; then +if [[ "$curr_chart" != "charts/system/cloudnative-pg" ]]; then echo "Installing cloudnative-pg chart" helm install cloudnative-pg oci://tccr.io/truecharts/cloudnative-pg --namespace cloudnative-pg --create-namespace --wait if [[ "$?" != "0" ]]; then @@ -51,7 +51,7 @@ if [[ "$curr_chart" != "charts/operators/cloudnative-pg" ]]; then echo "Done installing cloudnative-pg chart" fi -if [[ "$curr_chart" != "charts/enterprise/traefik" ]]; then +if [[ "$curr_chart" != "charts/premium/traefik" ]]; then echo "Installing traefik chart" helm install traefik oci://tccr.io/truecharts/traefik --namespace traefik --create-namespace --wait \ --set "service.main.type=ClusterIP" --set "service.tcp.type=ClusterIP" diff --git a/charts/incubator/immich/docs/install_notes.md b/charts/incubator/immich/docs/install_notes.md index cd690eecae9..e52d282a4fa 100644 --- a/charts/incubator/immich/docs/install_notes.md +++ b/charts/incubator/immich/docs/install_notes.md @@ -15,12 +15,12 @@ This chart now requires the following hcarts to be installed before you can inst - cloudnative-pg - prometheus-operator -These are in the operators train. +These are in the system train. To enable this in TrueNAS scale - Apps - Manage Catalogs. - Edit the TrueCharts Catalog (under the three dots). -- Enable the operators train under 'Perferred Trains'. +- Enable the system train under 'Perferred Trains'. - Install the required charts in Available Applications diff --git a/charts/premium/authelia/docs/Setup-Guide.md b/charts/premium/authelia/docs/Setup-Guide.md index fce6d68fe3b..1a160649309 100644 --- a/charts/premium/authelia/docs/Setup-Guide.md +++ b/charts/premium/authelia/docs/Setup-Guide.md @@ -6,19 +6,19 @@ This quick guide should take you through the steps necessary to setup `Authelia` ## Prerequisites -- Traefik installed (enable the `enterprise train`) +- Traefik installed (enable the `premium train`) - Clusterissuer for certificates -- CloudnativePG operator (enable the `operators train`) +- CloudnativePG operator (enable the `system train`) ## Setup LLDAP :::warning -LLDAP is a `Stable` train chart and therefore isn't supported at the same level as the charts in the `Enterprise` train (Authelia and Traefik). +LLDAP is a `Stable` train chart and therefore isn't supported at the same level as the charts in the `premium` train (Authelia and Traefik). ::: -- Follow the steps included in the [Installation Notes](https://truecharts.org/charts/stable/lldap/installation-notes) for [LLDAP](https://truecharts.org/charts/stable/lldap/). Pretty straightforward. Change `dc=example,dc=com` to your domain, i.e. `dc=MYDOMAIN,dc=net` and then change your password. Also make sure you have the `Operators` train enabled and `CloudnativePG` operator installed, since you'll need it for `LLDAP` and `Authelia` +- Follow the steps included in the [Installation Notes](https://truecharts.org/charts/stable/lldap/installation-notes) for [LLDAP](https://truecharts.org/charts/stable/lldap/). Pretty straightforward. Change `dc=example,dc=com` to your domain, i.e. `dc=MYDOMAIN,dc=net` and then change your password. Also make sure you have the `system` train enabled and `CloudnativePG` operator installed, since you'll need it for `LLDAP` and `Authelia` ![LLDAP Config](./img/LLDAPCatalogConfig.png) @@ -87,7 +87,7 @@ Please see [Authelia Rules](./authelia-rules) for more advanced rules. ## Traefik ForwardAuth Setup -- This part is straight forward as long as you have a working `Traefik` install, please see our [How-To](https://truecharts.org/charts/enterprise/traefik/how-to) if you need more info on getting that running. +- This part is straight forward as long as you have a working `Traefik` install, please see our [How-To](https://truecharts.org/charts/premium/traefik/how-to) if you need more info on getting that running. - Scroll down to `forwardAuth` and click `Add` @@ -104,7 +104,7 @@ Please see [Authelia Rules](./authelia-rules) for more advanced rules. ### Adding the forwardauth to your Apps -The last step is adding the `forwardauth` along with the standard `ingress` settings for your app, for more info on setting ingress see the [ClusterIssuer Guide](https://truecharts.org/charts/enterprise/clusterissuer/how-to). What changes versus a standard setup is the `Traefik Middlewares` section, where you must add your `forwardauth` to the section. +The last step is adding the `forwardauth` along with the standard `ingress` settings for your app, for more info on setting ingress see the [ClusterIssuer Guide](https://truecharts.org/charts/premium/clusterissuer/how-to). What changes versus a standard setup is the `Traefik Middlewares` section, where you must add your `forwardauth` to the section. - In this example we use the same name as above, or `auth`. Click `Add` to the `Traefik Middlewares` section, and enter your `forwardauth` name. diff --git a/charts/premium/clusterissuer/docs/cluster-certificates.md b/charts/premium/clusterissuer/docs/cluster-certificates.md index a4d65317cb0..2ebcd9627a7 100644 --- a/charts/premium/clusterissuer/docs/cluster-certificates.md +++ b/charts/premium/clusterissuer/docs/cluster-certificates.md @@ -13,7 +13,7 @@ Since this is an advanced feature, it is not covered by Truecharts support. ## Prerequisites - Ensure you have completed the [clusterissuer Setup Guide](how-to) -- Install the `kubernetes-reflector` app from the `enterprise` train +- Install the `kubernetes-reflector` app from the `premium` train ## Creating a cluster certificate diff --git a/charts/premium/clusterissuer/docs/how-to.md b/charts/premium/clusterissuer/docs/how-to.md index e9afa6ff83a..a8aedac7a2a 100644 --- a/charts/premium/clusterissuer/docs/how-to.md +++ b/charts/premium/clusterissuer/docs/how-to.md @@ -6,9 +6,9 @@ This guide will walk you through setting up `clusterissuer`, certificate managem ## Prerequisites -- Ensure you have the `enterprise` and `operators` trains enabled for `TrueCharts` as discussed [here](https://truecharts.org/manual/SCALE/guides/getting-started#adding-truecharts). -- [Traefik](https://truecharts.org/charts/enterprise/traefik/) is installed from enterprise train -- [Cert-Mananger](https://truecharts.org/charts/operators/cert-manager/) and [Prometheus-Operator](https://truecharts.org/charts/operators/prometheus-operator/) are installed from the operators train +- Ensure you have the `premium` and `system` trains enabled for `TrueCharts` as discussed [here](https://truecharts.org/manual/SCALE/guides/getting-started#adding-truecharts). +- [Traefik](https://truecharts.org/charts/premium/traefik/) is installed from premium train +- [Cert-Mananger](https://truecharts.org/charts/system/cert-manager/) and [Prometheus-Operator](https://truecharts.org/charts/system/prometheus-operator/) are installed from the system train :::warning DNS diff --git a/charts/premium/metallb-config/docs/setup-guide.md b/charts/premium/metallb-config/docs/setup-guide.md index 278f8dcd3aa..4eaa30dd688 100644 --- a/charts/premium/metallb-config/docs/setup-guide.md +++ b/charts/premium/metallb-config/docs/setup-guide.md @@ -12,7 +12,7 @@ With MetalLB installed, apps will not be reachable using the integrated LoadBala ## Prerequisites -- Add the Operators & Enterprise trains to your TrueCharts Catalog. +- Add the system & premium trains to your TrueCharts Catalog. ![metallb-addtrains](./img/metallb_guide_trains.png) @@ -22,11 +22,11 @@ Our customized version of MetalLB is only intended for use with other TrueCharts ::: -## 1. Install MetalLB Operator from Operators Train +## 1. Install MetalLB Operator from system Train ![metallb-apps](./img/metallb_guide_apps.png) -Install `metallb` from `operators` train first. There is no config, so just hit save. +Install `metallb` from `system` train first. There is no config, so just hit save. If you encounter an error upon install, run the following command as root from system settings -> shell and attempt the install again: `k3s kubectl delete --grace-period 30 --v=4 -k https://github.com/truecharts/manifests/delete` @@ -35,7 +35,7 @@ If you previously had `metallb` installed and encounter an error, delete the old ## 2. Set Address Pool & L2 Advertisement in MetalLB-Config -Install `metallb-config` from enterprise train and create a new entry under `Configure IP Address Pools Object` +Install `metallb-config` from premium train and create a new entry under `Configure IP Address Pools Object` ![metallb-addpoolbasic](./img/metallb_guide_addresspool_basic.png) diff --git a/charts/premium/traefik/docs/Authelia-LLDAP-forwardauth.md b/charts/premium/traefik/docs/Authelia-LLDAP-forwardauth.md index 5b7cba542f7..a7f768274dd 100644 --- a/charts/premium/traefik/docs/Authelia-LLDAP-forwardauth.md +++ b/charts/premium/traefik/docs/Authelia-LLDAP-forwardauth.md @@ -2,4 +2,4 @@ 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`. +Please refer to the full [Authelia + LLDAP + Traefik ForwardAuth Setup guide](https://truecharts.org/charts/premium/authelia/Setup-Guide) for a quick guide should take you through the steps necessary to setup `Authelia` as your `forwardAuth` for `Traefik`. diff --git a/charts/premium/traefik/docs/how-to.md b/charts/premium/traefik/docs/how-to.md index 9177779cccb..a19eb757d6a 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 `enterprise` train, so make sure you have it enabled as specified in the [guide](https://truecharts.org/manual/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](https://truecharts.org/manual/SCALE/guides/getting-started#adding-truecharts). ::: diff --git a/charts/stable/authentik/docs/how_to.md b/charts/stable/authentik/docs/how_to.md index b3be70acb97..0745888c772 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](https://truecharts.org/docs/manual/SCALE%20Apps/adding-letsencrypt) and/or the [Traefik documents](https://truecharts.org/charts/enterprise/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](https://truecharts.org/docs/manual/SCALE%20Apps/adding-letsencrypt) and/or the [Traefik documents](https://truecharts.org/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 e58d71be3bd..9e8a4661ab3 100644 --- a/charts/stable/bitmagnet/docs/installation_notes.md +++ b/charts/stable/bitmagnet/docs/installation_notes.md @@ -6,4 +6,4 @@ To effortlessly kickstart your journey with bitmagnet, integrate the [TrueCharts 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). -Worth noting, the PostgreSQL database is seamlessly configured and installed alongside the app. Just ensure to meticulously adhere to the getting started guide, installing all the recommended operators before initiating the app installation process. +Worth noting, the PostgreSQL database is seamlessly configured and installed alongside the app. Just ensure to meticulously adhere to the getting started guide, installing all the recommended system before initiating the app installation process. diff --git a/charts/stable/cloudflared/docs/installation_notes.md b/charts/stable/cloudflared/docs/installation_notes.md index 7dd80c116d0..773e0f92d72 100644 --- a/charts/stable/cloudflared/docs/installation_notes.md +++ b/charts/stable/cloudflared/docs/installation_notes.md @@ -7,7 +7,7 @@ title: Installation Notes Using Cloudflare Tunnels with video streaming or sharing sites goes against the Cloudflare ToS, see full terms on the [Cloudflare Website](https://www.cloudflare.com/service-specific-terms-application-services/#content-delivery-network-terms) Content Delivery Network (Free, Pro, or Business) (Current on 2024-03-14) -Cloudflare’s content delivery network (the “CDN”) Service can be used to cache and serve web pages and websites. Unless you are an Enterprise customer, Cloudflare offers specific Paid Services (e.g., the Developer Platform, Images, and Stream) that you must use in order to serve video and other large files via the CDN. Cloudflare reserves the right to disable or limit your access to or use of the CDN, or to limit your End Users’ access to certain of your resources through the CDN, if you use or are suspected of using the CDN without such Paid Services to serve video or a disproportionate percentage of pictures, audio files, or other large files. We will use reasonable efforts to provide you with notice of such action. +Cloudflare’s content delivery network (the “CDN”) Service can be used to cache and serve web pages and websites. Unless you are an premium customer, Cloudflare offers specific Paid Services (e.g., the Developer Platform, Images, and Stream) that you must use in order to serve video and other large files via the CDN. Cloudflare reserves the right to disable or limit your access to or use of the CDN, or to limit your End Users’ access to certain of your resources through the CDN, if you use or are suspected of using the CDN without such Paid Services to serve video or a disproportionate percentage of pictures, audio files, or other large files. We will use reasonable efforts to provide you with notice of such action. ::: diff --git a/charts/stable/cloudflareddns/docs/setup-guide.md b/charts/stable/cloudflareddns/docs/setup-guide.md index dde9f5f4ba1..e4c90d2ce32 100644 --- a/charts/stable/cloudflareddns/docs/setup-guide.md +++ b/charts/stable/cloudflareddns/docs/setup-guide.md @@ -19,7 +19,7 @@ Cloudflareddns chart ## Prerequisites -This guide assumes you've followed our [clusterissuer guide](https://truecharts.org/charts/enterprise/clusterissuer/how-to) with your domain on TrueNAS and done the configuration for your DNS on Cloudflare +This guide assumes you've followed our [clusterissuer guide](https://truecharts.org/charts/premium/clusterissuer/how-to) with your domain on TrueNAS and done the configuration for your DNS on Cloudflare The recommended way is to setup CNAMEs for your subdomains (charts) and keep your A record pointed to your base domain, such as below diff --git a/charts/stable/lldap/docs/authelia-lldap-forwardauth.md b/charts/stable/lldap/docs/authelia-lldap-forwardauth.md index 5b7cba542f7..a7f768274dd 100644 --- a/charts/stable/lldap/docs/authelia-lldap-forwardauth.md +++ b/charts/stable/lldap/docs/authelia-lldap-forwardauth.md @@ -2,4 +2,4 @@ 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`. +Please refer to the full [Authelia + LLDAP + Traefik ForwardAuth Setup guide](https://truecharts.org/charts/premium/authelia/Setup-Guide) for a quick guide should take you through the steps necessary to setup `Authelia` as your `forwardAuth` for `Traefik`. diff --git a/charts/stable/lldap/docs/authelia.md b/charts/stable/lldap/docs/authelia.md index d08b370122e..4c09d00d2fd 100644 --- a/charts/stable/lldap/docs/authelia.md +++ b/charts/stable/lldap/docs/authelia.md @@ -2,7 +2,7 @@ title: Authelia Setup --- -Authelia which is available in the Enterprise train can act as the authentication provider for your apps and services either through OAuth or forward authentication. LLDAP can be used to manage your Authelia users and groups. To enable this as an option follow the steps outlined below. References to the specific questions as they appear in the TrueNAS SCALE UI are included in the guide and highlighted along with the answers you should use. Authelia is the recommended authentication provider for TrueCharts however you can use any other provider you wish for Authentik is available in the Stable train. +Authelia which is available in the premium train can act as the authentication provider for your apps and services either through OAuth or forward authentication. LLDAP can be used to manage your Authelia users and groups. To enable this as an option follow the steps outlined below. References to the specific questions as they appear in the TrueNAS SCALE UI are included in the guide and highlighted along with the answers you should use. Authelia is the recommended authentication provider for TrueCharts however you can use any other provider you wish for Authentik is available in the Stable train. This guide has been written as LLDAP has specific requirements for the LDAP setup of Authelia. If you are using another LDAP provider you will need to follow the setup instructions for that provider. diff --git a/charts/stable/organizr/docs/forward_auth.md b/charts/stable/organizr/docs/forward_auth.md index b4eba88f1fc..ce740c3ee14 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](https://truecharts.org/manual/guides/adding-letsencrypt) and/or the [Traefik documents](https://truecharts.org/charts/enterprise/traefik/how-to). +[Quick-Start guides](https://truecharts.org/manual/guides/adding-letsencrypt) and/or the [Traefik documents](https://truecharts.org/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 1a32862c792..0e987a0431a 100644 --- a/charts/stable/paperless-ngx/docs/how-to.md +++ b/charts/stable/paperless-ngx/docs/how-to.md @@ -9,7 +9,7 @@ online archive. Our app is a simple way to install it on your TrueNAS SCALE serv - Installation of the TrueCharts Catalog, starting [here](/manual/SCALE/guides/getting-started) - [`Cloudnative-PG` - operator](/manual/SCALE/guides/getting-started/#cnpgprometheus-operators-installation-and-migration-guide-for-older-users) + operator](/manual/SCALE/guides/getting-started/#cnpgprometheus-system-installation-and-migration-guide-for-older-users) - Paperless-ngx TrueCharts Chart ## Media Storage @@ -33,7 +33,7 @@ online archive. Our app is a simple way to install it on your TrueNAS SCALE serv installation, you can change them later in the app. - Enter the URL your Paperless-ngx will be accessible under in `PAPERLESS_URL` if you plan on making your app accessible from the web. -- If you have set up [Traefik](/charts/enterprise/traefik/how-to/) for ingress click `Enable Ingress` and enter your +- If you have set up [Traefik](/charts/premium/traefik/how-to/) for ingress click `Enable Ingress` and enter your Paperless-ngx domain in the Hosts section. ![Configure paperless-ngx](./img/configure_paperless-ngx.png) @@ -99,14 +99,14 @@ in the import share will not be imported anymore though. ### Configure ForwardAuth authentication -Users that have set up [Traefik with ForwardAuth, for example with Authelia](/charts/enterprise/authelia/Setup-Guide/) +Users that have set up [Traefik with ForwardAuth, for example with Authelia](/charts/premium/authelia/Setup-Guide/) can take advantage of authentication through Authelia for their Paperless-ngx installation. Paperless-ngx will honor logins passed from Authelia but not the e-mail address nor the groups of the logged-in user, those will be internal to Paperless-ngx and separate from those in Authelia. ForwardAuth can be added to an existing Paperless-ngx installation as long as the logins of Authelia users match the logins of Paperless-ngx users. This guide will only describe the Paperless-ngx specific options required to set up ForwardAuth. Please refer to the -[Traefik + Authelia ForwardAuth setup guide](/charts/enterprise/authelia/Setup-Guide/) on how to prepare ForwardAuth. +[Traefik + Authelia ForwardAuth setup guide](/charts/premium/authelia/Setup-Guide/) on how to prepare ForwardAuth. Once you have set up ForwardAuth in your Traefik installation, configure ForwardAuth in Paperless-ngx as follows: diff --git a/charts/stable/pihole/docs/split-dns.md b/charts/stable/pihole/docs/split-dns.md index 2191e22f56a..f7dd46292a0 100644 --- a/charts/stable/pihole/docs/split-dns.md +++ b/charts/stable/pihole/docs/split-dns.md @@ -6,7 +6,7 @@ _Using Blocky in conjunction with PiHole enables seamless automated split DNS fu :::danger unrecommended configuration -The below guide is not the recommended DNS solution for TrueCharts. We recommend running Blocky from the Enterprise train in a standalone configuration. Setting up your DNS as outlined below adds complexity and will reduce reliability. +The below guide is not the recommended DNS solution for TrueCharts. We recommend running Blocky from the premium train in a standalone configuration. Setting up your DNS as outlined below adds complexity and will reduce reliability. ::: @@ -18,7 +18,7 @@ Blocky includes k8s Gateway which automates the split DNS process. We will be us ::: -1. Install Blocky from the Enterprise train with all defaults except for the following. +1. Install Blocky from the premium train with all defaults except for the following. 2. Override Default Upstreams diff --git a/charts/stable/strapi/docs/installation_notes.md b/charts/stable/strapi/docs/installation_notes.md index e7ed13019b7..09df236685b 100644 --- a/charts/stable/strapi/docs/installation_notes.md +++ b/charts/stable/strapi/docs/installation_notes.md @@ -8,7 +8,7 @@ title: Installation Notes - `['keya', 'keyb']`. - Set `Node Environment` to **Development** initially. - Optionally set `Public URL` to a FDQN with https, ex: `https://api.example.com`. -- Optionally set `Strapi License` to activate the Enterprise Edition. +- Optionally set `Strapi License` to activate the premium Edition. - Enable/Disable `Strapi Disable Update Notifications` for strapi update notifications. - Enable/Disable `Fast Refresh` for react near-instant feedback. - `Extra Args` can be left empty for the standard defaults or get args from [strapi-new](https://strapi.io/documentation/developer-docs/latest/developer-resources/cli/CLI.html#strapi-new).