diff --git a/charts/premium/authelia/docs/Setup-Guide.md b/charts/premium/authelia/docs/Setup-Guide.md index 9d869130be2..be6087612d3 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`](/manual/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`](/platforms/scale/guides/getting-started/#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 8a1cea9f395..8a5c6a919a1 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](/manual/SCALE/guides/getting-started#adding-truecharts). +- Ensure you have the `premium` and `system` trains enabled for `TrueCharts` as discussed [here](/platforms/scale/guides/getting-started/#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/backup-restore-migrate-guide.md b/charts/premium/nextcloud/docs/backup-restore-migrate-guide.md index 29be10e9cb2..1d0adc781ae 100644 --- a/charts/premium/nextcloud/docs/backup-restore-migrate-guide.md +++ b/charts/premium/nextcloud/docs/backup-restore-migrate-guide.md @@ -20,7 +20,7 @@ If you are using two factor authentication on your Nextcloud accounts disable it ### Backup Database -If you have not already done so install PGAdmin and the [tcdbinfo.sh script](/manual/SCALE/guides/sql-export#how-to-list-database-login-info-for-truecharts-apps) +If you have not already done so install PGAdmin and the [tcdbinfo.sh script](/platforms/scale/guides/sql-export/#how-to-list-database-login-info-for-truecharts-apps) 1. Run the tcdbinfo.sh script and take note of the connection info @@ -98,7 +98,7 @@ Wait for Nextcloud to fully deploy before proceeding. k3s kubectl scale deploy nextcloud -n ix-nextcloud --replicas=0 ``` -2. Add Nextcloud to PGAdmin as guided in [steps 1 and 2 here](#backup-nextcloud-database). +2. Add Nextcloud to PGAdmin as guided in [steps 1 and 2 here](#backup-database). 3. In PGAdmin right click on the database and select restore as shown below. 4. Select the database backup you created previously. diff --git a/charts/premium/nextcloud/docs/installation-notes.md b/charts/premium/nextcloud/docs/installation-notes.md index addb80076d3..6925330c4d1 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](/manual/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](/platforms/scale/guides/getting-started/#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](/manual/SCALE/guides/getting-started/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps). + found on our [getting started guide](/platforms/scale/guides/getting-started/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps). :::caution SNAPSHOT DIRECTORY VISIBILITY diff --git a/charts/premium/traefik/docs/Authelia-LLDAP-forwardauth.md b/charts/premium/traefik/docs/Authelia-LLDAP-forwardauth.md index 864439b06e2..304185f1eea 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](/charts/premium/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](/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 95649599700..4e966f7fbae 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](/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](/platforms/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 03f25dcc76c..ffd65b18352 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](/docs/manual/SCALE%20Apps/adding-letsencrypt) 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](/platforms/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. ## Authentik Chart Setup diff --git a/charts/stable/bitmagnet/docs/installation_notes.md b/charts/stable/bitmagnet/docs/installation_notes.md index f149a6a6d14..d6f57c31edd 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](/manual/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](/platforms/scale/guides/getting-started/#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 5ad754c65db..eaf1a952fc7 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](/manual/SCALE/guides/linking-apps/). +- RPC Server: find with `heavyscript dns`, and read about internal DNS [here](/platforms/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/docusaurus/docs/How-To.md b/charts/stable/docusaurus/docs/How-To.md index b6b8b342574..864bf443e27 100644 --- a/charts/stable/docusaurus/docs/How-To.md +++ b/charts/stable/docusaurus/docs/How-To.md @@ -34,7 +34,7 @@ None necessary, a domain name is recommended for usage but not required. ### Ingress -Recommended for use with a domain name but not required as mentioned above. You can refer to our [Quick-Start Guides](/manual/SCALE/options/ingress) for an overview on using Ingress with your chart. +Recommended for use with a domain name but not required as mentioned above. You can refer to our [Quick-Start Guides](/platforms/scale/options/ingress) for an overview on using Ingress with your chart. ## Support diff --git a/charts/stable/duplicati/docs/ingress.md b/charts/stable/duplicati/docs/ingress.md index 11cad9f5511..36ee8533af2 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](/manual/SCALE/options/ingress). 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](/platforms/scale/guides/getting-started/). 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 78d0264654c..b55a0c36023 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](/manual/SCALE/guides/getting-started) guide on the [Truecharts](https://truecharts.org) website. +Please follow the [Getting Started](/platforms/scale/guides/getting-started/) 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 746ef8424c3..84fe1dcff30 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](/manual/SCALE/guides/getting-started#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/platforms/scale/guides/getting-started/#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](/manual/SCALE/guides/add-storage) + and for that you can simply follow our [Adding Storage](/platforms/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](/manual/SCALE/guides/nfs-share/). + devices outside of TrueNAS, so we recommend following the [using NFS Shares guide](/platforms/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 d723614db72..21476449230 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](/manual/SCALE/guides/getting-started#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/platforms/scale/guides/getting-started/#adding-truecharts) ## Install Jellyseerr inside TrueNAS SCALE diff --git a/charts/stable/lldap/docs/authelia-lldap-forwardauth.md b/charts/stable/lldap/docs/authelia-lldap-forwardauth.md index 864439b06e2..304185f1eea 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](/charts/premium/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](/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/notifiarr/docs/how-to.md b/charts/stable/notifiarr/docs/how-to.md index 2cc6605fcef..acf5d78e9ab 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](/manual/SCALE/guides/getting-started#adding-truecharts) +- Installation of the TrueCharts Catalog, starting [here](/platforms/scale/guides/getting-started/#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 cca6f047dc1..c4ea4bf7dcf 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](/manual/guides/adding-letsencrypt) and/or the [Traefik documents](/charts/premium/traefik/how-to). +[Quick-Start guides](/platforms/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. ## Organizr App Setup diff --git a/charts/stable/paperless-ngx/docs/how-to.md b/charts/stable/paperless-ngx/docs/how-to.md index 0e987a0431a..3d51cde44eb 100644 --- a/charts/stable/paperless-ngx/docs/how-to.md +++ b/charts/stable/paperless-ngx/docs/how-to.md @@ -7,16 +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](/manual/SCALE/guides/getting-started) -- [`Cloudnative-PG` - operator](/manual/SCALE/guides/getting-started/#cnpgprometheus-system-installation-and-migration-guide-for-older-users) +- Installation of the TrueCharts Catalog, starting [here](/platforms/scale/guides/getting-started/) 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](/manual/SCALE/guides/nfs-share) for further information. + guide](/platforms/scale/guides/nfs-share) for further information. ## Install Paperless inside TrueNAS SCALE @@ -64,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](/manual/SCALE/guides/add-storage#host-path-validation-safety) checks of TrueNAS +Due to the [Hast Path Validation Safety](/platforms/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](/manual/FAQ#why-i-cant-use-host-path-on-both-my-apps-and-sharing-services) regarding this +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](/manual/SCALE/guides/nfs-share) to prepare +share. Please refer to Part 1 of the [NFS shares with TrueChart apps guide](/platforms/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. @@ -99,14 +97,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/premium/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/premium/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/qbittorrent/docs/installation.md b/charts/stable/qbittorrent/docs/installation.md index a2f044a1b05..f7be3e9419e 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](/manual/SCALE/guides/vpn-setup) +Use the [Gluetun VPN Add-on Setup Guide](/platforms/scale/guides/vpn-setup/)
diff --git a/charts/stable/simply-shorten/docs/installation_notes.md b/charts/stable/simply-shorten/docs/installation_notes.md index 962d7fd6b52..24871e73f37 100644 --- a/charts/stable/simply-shorten/docs/installation_notes.md +++ b/charts/stable/simply-shorten/docs/installation_notes.md @@ -7,7 +7,7 @@ title: Installation Notes - Enable ingress, without doing so `http://IP:PORT` will be used as the short url generator which obviously will be an issue. -- Please follow this [guide](/manual/SCALE/options/ingress) on adding ingress to a chart. +- Please follow this [guide](/platforms/scale/options/ingress) on adding ingress to a chart. ## Disable authentication diff --git a/charts/stable/traefik-forward-auth/docs/how-to.md b/charts/stable/traefik-forward-auth/docs/how-to.md index 83b57178feb..cae5dee483d 100644 --- a/charts/stable/traefik-forward-auth/docs/how-to.md +++ b/charts/stable/traefik-forward-auth/docs/how-to.md @@ -5,7 +5,7 @@ description: A How To Guide for Traefik Forward Auth :::note -We highly recommend to setup [authelia](/charts/premium/authelia/docs/Setup-Guide.md) instead. +We highly recommend to setup [authelia](/charts/premium/authelia/docs/setup-guide.md) instead. ::: diff --git a/charts/system/prometheus-operator/docs/installation.md b/charts/system/prometheus-operator/docs/installation.md index 4c811f0c76f..88c490d05c2 100644 --- a/charts/system/prometheus-operator/docs/installation.md +++ b/charts/system/prometheus-operator/docs/installation.md @@ -12,7 +12,7 @@ If you get > [EFAULT] Failed to install App: Error: INSTALLATION FAILED: rendered manifests contain a resource that already exists. Unable to continue with install: CustomResourceDefinition "alertmanagerconfigs.monitoring.coreos.com" in namespace "" exists and cannot be imported into the current release: invalid ownership metadata; label validation error: missing key "app.kubernetes.io/managed-by": must be set to "Helm"; annotation validation error: missing key "meta.helm.sh/release-name": must be set to "prometheus-operator"; annotation validation error: missing key "meta.helm.sh/release-namespace": must be set to "ix-prometheus-operator" -you should follow instructions from the [FAQ](/manual/FAQ#prometheus-operator) to resolve it +you should follow instructions from the [FAQ](/general/FAQ) to resolve it ### Helm