Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code

update some doc links

This commit is contained in:
Stavros Kois 2024-06-09 14:26:32 +03:00 committed by GitHub
parent 5db83e2cf1
commit 2faffd0000
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
charts/premium/authelia/docs/Setup-Guide.md
View File

@ -94,7 +94,7 @@ Please see [Authelia Rules](./authelia-rules) for more advanced rules.
![TraefikForwardAuth](./img/TraefikForwardAuth.png) ![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` - 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` - Check `trustForwardHeader`
- Add the following `authResponseHeaders` (press `Add` 4 times) - Add the following `authResponseHeaders` (press `Add` 4 times)
- `Remote-User` - `Remote-User`

2
charts/premium/clusterissuer/docs/how-to.md
View File

@ -6,7 +6,7 @@ This guide will walk you through setting up `clusterissuer`, certificate managem
## Prerequisites ## 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 - [Traefik](/charts/premium/traefik/) is installed from premium train
- [Cert-Mananger](/charts/system/cert-manager/) and [Prometheus-Operator](/charts/system/prometheus-operator/) - [Cert-Mananger](/charts/system/cert-manager/) and [Prometheus-Operator](/charts/system/prometheus-operator/)

4
charts/premium/nextcloud/docs/installation-notes.md
View File

@ -4,10 +4,10 @@ title: Installation Notes
## Requirements ## 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 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] :::caution[SNAPSHOT DIRECTORY VISIBILITY]

2
charts/premium/traefik/docs/how-to.md
View File

@ -48,7 +48,7 @@ Ensure you are accessing your WebUI from the new ports before proceeding.
:::note :::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).
::: :::

2
charts/stable/authentik/docs/how_to.md
View File

@ -12,7 +12,7 @@ This can be applied to other systems but this specific guide has been tested and
## Prerequisites ## 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 ## Authentik Chart Setup

2
charts/stable/bitmagnet/docs/installation_notes.md
View File

@ -2,7 +2,7 @@
title: Scale App Installation 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). 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).

2
charts/stable/cloudreve/docs/installation_notes.md
View File

@ -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: 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. - 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. - Absolute Path: Set this to a custom persistent mount that you've created for this cloudreve app, and have also mounted to Aria2.

2
charts/stable/duplicati/docs/ingress.md
View File

@ -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) ![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.

2
charts/stable/external-dns/docs/setup-guide.md
View File

@ -13,7 +13,7 @@ Inspired by Kubernetes DNS, Kubernetes' cluster-internal DNS server, ExternalDNS
- Traefik - Traefik
- Clusterissuer / Cert-manager installed (vital if exposed externally) - 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 ## Installation instructions

6
charts/stable/jellyfin/docs/how-to.md
View File

@ -8,17 +8,17 @@ and our app is a simple way to install it on your TrueNAS SCALE server.
## Requirements ## Requirements
- Jellyfin 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)
## Media Storage ## Media Storage
- We recommend having configured your media before installing the chart. - We recommend having configured your media before installing the chart.
Most people will have their media inside their TrueNAS box, 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. guide to `Add Additional App Storage` to **Jellyfin** for their media folder.
- However some will prefer `NFS Shares` for this storage, - However some will prefer `NFS Shares` for this storage,
as they may need to share these folders with other users on other 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 ## Install Jellyfin inside TrueNAS SCALE

2
charts/stable/jellyseerr/docs/how-to.md
View File

@ -8,7 +8,7 @@ title: Setup Guide
- Jellyseerr TrueCharts Chart - Jellyseerr TrueCharts Chart
- Jellyfin 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 ## Install Jellyseerr inside TrueNAS SCALE

2
charts/stable/notifiarr/docs/how-to.md
View File

@ -5,7 +5,7 @@ title: Setup Guide
## Requirements ## Requirements
- Your 'All integrations' API key from your account on `notifiarr.com` - 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 ## Install Notifiarr inside TrueNAS SCALE

2
charts/stable/organizr/docs/forward_auth.md
View File

@ -12,7 +12,7 @@ Basic setup guide for enabling Organizr authentication on your apps using Traefi
## Prerequisites ## Prerequisites
This guide assumes you're using Traefik as your Reverse Proxy / Ingress provider and have through the configuration listed in our 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. Please ensure that you can access your domain properly with Ingress before attempting any further steps.
## Organizr App Setup ## Organizr App Setup

8
charts/stable/paperless-ngx/docs/how-to.md
View File

@ -7,14 +7,14 @@ online archive. Our app is a simple way to install it on your TrueNAS SCALE serv
## Requirements ## 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 - Paperless-ngx TrueCharts Chart
## Media Storage ## Media Storage
- If you plan on importing documents into Paperless-ngx via a network share, for example from a computer or scanner, it - 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 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 ## 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 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. 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 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 of work. See also the [FAQ](/general/faq/) regarding this
topic. topic.
This guide will only describe the Paperless-ngx specific options required to set up importing documents from a network 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 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 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. same folder for Windows computers or scanners offering this functionality.

2
charts/stable/qbittorrent/docs/installation.md
View File

@ -76,7 +76,7 @@ I always mount to the root directory of the container
### VPN ### 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/)
<br /> <br />

8
templates/README.md.tpl
View File

@ -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` `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 ### 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 ## 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 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. 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 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 ## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff. 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_ _All Rights Reserved - The TrueCharts Project_