From 2faffd0000550fb157a327728aa12ff0c22d4afe Mon Sep 17 00:00:00 2001 From: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Date: Sun, 9 Jun 2024 14:26:32 +0300 Subject: [PATCH] update some doc links --- 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/cloudreve/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 | 6 +++--- 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 | 8 ++++---- charts/stable/qbittorrent/docs/installation.md | 2 +- templates/README.md.tpl | 8 ++++---- 16 files changed, 25 insertions(+), 25 deletions(-) diff --git a/charts/premium/authelia/docs/Setup-Guide.md b/charts/premium/authelia/docs/Setup-Guide.md index e3896f15d8f..a165db0b0f9 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/#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`](/deprecated/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 8348a5b3624..69c0eed0b3b 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/#adding-truecharts). +- Ensure you have the `premium` and `system` trains enabled for `TrueCharts` as discussed [here](/deprecated/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 128b68f3fdc..19dc042d3fe 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/#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](/deprecated/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/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps). + found on our [getting started guide](/deprecated/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 e8e13f085d4..3221b9747ca 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/#adding-truecharts). +Traefik is part of the `premium` train, so make sure you have it enabled as specified in the [guide](/deprecated/scale/#adding-truecharts). ::: diff --git a/charts/stable/authentik/docs/how_to.md b/charts/stable/authentik/docs/how_to.md index 7e4d6f61ca6..12dcebf2df2 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/) 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](/deprecated/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 d656d26a38b..2e20e1c1f76 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/#adding-truecharts) and proceed with app installation on TrueNAS Scale. +To effortlessly kickstart your journey with bitmagnet, integrate the [TrueCharts catalog](/deprecated/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/cloudreve/docs/installation_notes.md b/charts/stable/cloudreve/docs/installation_notes.md index 65697755446..e309ebdcedf 100644 --- a/charts/stable/cloudreve/docs/installation_notes.md +++ b/charts/stable/cloudreve/docs/installation_notes.md @@ -36,7 +36,7 @@ To use cloudreve with aria2, install the [TrueCharts aria2 app](/charts/stable/a Once aria2 is installed, open cloudreve's webpage and navigate to the Dashboard (Click on profile icon in top right corner -> Dashboard). In the dashboard, select `Nodes` and then click the edit icon beside `Master (Local Machine)`. In the edit dialog, click `Enable` and then fill out the settings: -- RPC Server: find with `heavyscript dns`, and read about internal DNS [here](/scale/guides/linking-apps/). +- RPC Server: find with `heavyscript dns`, and read about internal DNS [here](/deprecated/scale/guides/linking-apps/). - RPC Secret: Set the shared secret here. Must also be set in the Aria2 app. - Absolute Path: Set this to a custom persistent mount that you've created for this cloudreve app, and have also mounted to Aria2. diff --git a/charts/stable/duplicati/docs/ingress.md b/charts/stable/duplicati/docs/ingress.md index 67d5eabd801..b0882dc3435 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/). 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](/deprecated/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 e03926816a1..67f0b7b12c7 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/) guide on the [Truecharts](https://truecharts.org) website. +Please follow the [Getting Started](/deprecated/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 e2cb591c8e6..53bebf52f7a 100644 --- a/charts/stable/jellyfin/docs/how-to.md +++ b/charts/stable/jellyfin/docs/how-to.md @@ -8,17 +8,17 @@ 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/#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/deprecated/scale/#adding-truecharts) ## Media Storage - We recommend having configured your media before installing the chart. Most people will have their media inside their TrueNAS box, - and for that you can simply follow our [Adding Storage](/scale/guides/add-storage) + and for that you can simply follow our [Adding Storage](/deprecated/scale/guides/add-storage) guide to `Add Additional App Storage` to **Jellyfin** for their media folder. - However some will prefer `NFS Shares` for this storage, as they may need to share these folders with other users on other - devices outside of TrueNAS, so we recommend following the [using NFS Shares guide](/scale/guides/nfs-share/). + devices outside of TrueNAS, so we recommend following the [using NFS Shares guide](/deprecated/scale/guides/nfs-share/). ## Install Jellyfin inside TrueNAS SCALE diff --git a/charts/stable/jellyseerr/docs/how-to.md b/charts/stable/jellyseerr/docs/how-to.md index 283e6009062..58cd99f0dbe 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/#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/deprecated/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 f32ca7487fd..b76380a0581 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/#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/deprecated/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 de6d8aaba33..a50d241284b 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/) and/or the [Traefik documents](/charts/premium/traefik/how-to). +[Quick-Start guides](/deprecated/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 577a9d77104..141aeec1250 100644 --- a/charts/stable/paperless-ngx/docs/how-to.md +++ b/charts/stable/paperless-ngx/docs/how-to.md @@ -7,14 +7,14 @@ 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/) and the required operators (Prometheus-Operator and Cloudnative-PG). +- Installation of the TrueCharts Catalog, starting [here](/deprecated/scale/) and the required operators (Prometheus-Operator and Cloudnative-PG). - Paperless-ngx TrueCharts Chart ## Media Storage - If you plan on importing documents into Paperless-ngx via a network share, for example from a computer or scanner, it is recommended to set up an `NFS Share` for the shared folder. See the [NFS Shares - guide](/scale/guides/nfs-share) for further information. + guide](/deprecated/scale/guides/nfs-share) for further information. ## Install Paperless inside TrueNAS SCALE @@ -62,13 +62,13 @@ to a shared folder on your TrueNAS SCALE from your computer or directly from you up the documents from there. See the explanation of the feature linked above and its [configuration options](https://docs.paperless-ngx.com/configuration/#consume_config) for more information. -Due to the [Hast Path Validation Safety](/scale/guides/add-storage/#host-path-validation-safety) checks of TrueNAS +Due to the [Hast Path Validation Safety](/deprecated/scale/guides/add-storage/#host-path-validation-safety) checks of TrueNAS SCALE, using storage for an application on your TrueNAS SCALE and with a network share at the same time requires a bit of work. See also the [FAQ](/general/faq/) regarding this topic. This guide will only describe the Paperless-ngx specific options required to set up importing documents from a network -share. Please refer to Part 1 of the [NFS shares with TrueChart apps guide](/scale/guides/nfs-share) to prepare +share. Please refer to Part 1 of the [NFS shares with TrueChart apps guide](/deprecated/scale/guides/nfs-share) to prepare the NFS share you want to use with Paperless-ngx and note its path. Refer to the [TrueNAS SCALE adding SMB shares guide](https://www.truenas.com/docs/scale/scaletutorials/shares/smb/addsmbshares/) to set up network sharing of that same folder for Windows computers or scanners offering this functionality. diff --git a/charts/stable/qbittorrent/docs/installation.md b/charts/stable/qbittorrent/docs/installation.md index 479fba2ac0c..1c3ebca347f 100644 --- a/charts/stable/qbittorrent/docs/installation.md +++ b/charts/stable/qbittorrent/docs/installation.md @@ -76,7 +76,7 @@ I always mount to the root directory of the container ### VPN -Use the [Gluetun VPN Add-on Setup Guide](/scale/guides/vpn-setup/) +Use the [Gluetun VPN Add-on Setup Guide](/deprecated/scale/guides/vpn-setup/)
diff --git a/templates/README.md.tpl b/templates/README.md.tpl index fdcb2bd008e..56d73add0ec 100644 --- a/templates/README.md.tpl +++ b/templates/README.md.tpl @@ -19,12 +19,12 @@ To install TrueCharts Helm charts using Helm, you can use our OCI Repository. `helm install mychart oci://tccr.io/truecharts/CHARTNAME` -For more information on how to install TrueCharts Helm charts, checkout the instructions on the website: https://truecharts.org/general/support-policy/ +For more information on how to install TrueCharts Helm charts, checkout the [instructions on the website](/guides) ### TrueNAS SCALE Apps -For more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the [quick-start guides for TrueNAS SCALE](https://truecharts.org/deprecated/scale). +For more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the [quick-start guides for TrueNAS SCALE](/deprecated/scale). ## Chart Specific Guides and information @@ -41,7 +41,7 @@ To view the chart specific options, please view Values.yaml included in the char The most recent version of which, is available here: https://github.com/truecharts/charts/charts/TRAINPLACEHOLDER/CHARTPLACEHOLDER/values.yaml All our Charts use a shared "common" library chart that contains most of the templating and options. -For the complete overview of all available options, please checkout the documentation for them on the website: https://truecharts.org/common/ +For the complete overview of all available options, please checkout the documentation for them on the [common docs on our website](/common) For information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/truecharts/library-charts/blob/main/library/common/values.yaml @@ -56,6 +56,6 @@ For information about the common chart and all defaults included with it, please ## Sponsor TrueCharts TrueCharts can only exist due to the incredible effort of our staff. -Please consider making a [donation](https://truecharts.org/general/sponsor) or contributing back to the project any way you can! +Please consider making a [donation](/general/sponsor) or contributing back to the project any way you can! _All Rights Reserved - The TrueCharts Project_