chore(docs): make links relative
This commit is contained in:
Stavros Kois
GitHub
parent
8eb844e991
commit
5ba71e6ec3
|
|
@ -18,7 +18,7 @@ LLDAP is a `Stable` train chart and therefore isn't supported at the same level
|
|||
|
||||
:::
|
||||
|
||||
- Follow the easy steps included in the [Installation Notes](https://truecharts.org/charts/stable/lldap/installation-notes) for [LLDAP](https://truecharts.org/charts/stable/lldap/). 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`.
|
||||
- Follow the easy steps included in the [Installation Notes](/charts/stable/lldap/installation-notes) for [LLDAP](/charts/stable/lldap/). 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`.
|
||||
|
||||
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ LLDAP is a `Stable` train chart and therefore isn't supported at the same level
|
|||
|
||||
## Setup Authelia
|
||||
|
||||
- The setup for Authelia is very specific and the logs won't tell you where you've messed up, but there's precise steps used to integrate `LLDAP` into `Authelia`. The info comes from the [LLDAP Authelia Docs](https://truecharts.org/charts/stable/lldap/authelia) and the upstream repo.
|
||||
- The setup for Authelia is very specific and the logs won't tell you where you've messed up, but there's precise steps used to integrate `LLDAP` into `Authelia`. The info comes from the [LLDAP Authelia Docs](/charts/stable/lldap/authelia) and the upstream repo.
|
||||
|
||||
### App Configuration
|
||||
|
||||
|
|
@ -87,14 +87,14 @@ 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/premium/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](/charts/premium/traefik/how-to) if you need more info on getting that running.
|
||||
|
||||
- Scroll down to `forwardAuth` and click `Add`
|
||||
|
||||
|
||||
|
||||
- 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`](https://truecharts.org/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`](/manual/SCALE/guides/getting-started/#heavyscript)
|
||||
- Check `trustForwardHeader`
|
||||
- Add the following `authResponseHeaders` (press `Add` 4 times)
|
||||
- `Remote-User`
|
||||
|
|
@ -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/premium/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](/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.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,9 +6,9 @@ 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](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
|
||||
- Ensure you have the `premium` and `system` trains enabled for `TrueCharts` as discussed [here](/manual/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/)
|
||||
|
||||
:::warning DNS
|
||||
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/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](/manual/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
|
||||
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/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](/manual/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](https://truecharts.org/manual/SCALE/guides/getting-started/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps).
|
||||
found on our [getting started guide](/manual/SCALE/guides/getting-started/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps).
|
||||
|
||||
:::caution SNAPSHOT DIRECTORY VISIBILITY
|
||||
|
||||
|
|
|
|||
|
|
@ -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/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`.
|
||||
|
|
|
|||
|
|
@ -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](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](/manual/SCALE/guides/getting-started#adding-truecharts).
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -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/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](/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.
|
||||
|
||||
## Authentik Chart Setup
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Scale App Installation
|
||||
---
|
||||
|
||||
To effortlessly kickstart your journey with bitmagnet, integrate the [TrueCharts catalog](https://truecharts.org/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](/manual/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).
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Cloudflareddns chart
|
|||
|
||||
## Prerequisites
|
||||
|
||||
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
|
||||
This guide assumes you've followed our [clusterissuer guide](/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
|
||||
|
||||
|
|
|
|||
|
|
@ -32,11 +32,11 @@ To retrieve the password in TrueNAS SCALE, wait for the app to finish deploying
|
|||
|
||||
## Aria2
|
||||
|
||||
To use cloudreve with aria2, install the [TrueCharts aria2 app](https://truecharts.org/charts/stable/aria2/). The installation dialog will ask for a RPC Secret, which should be a securely generated string that will be copied to cloudreve later. See below for an example.
|
||||
To use cloudreve with aria2, install the [TrueCharts aria2 app](/charts/stable/aria2/). The installation dialog will ask for a RPC Secret, which should be a securely generated string that will be copied to cloudreve later. See below for an example.
|
||||
|
||||
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](https://truecharts.org/manual/SCALE/guides/linking-apps/).
|
||||
- RPC Server: find with `heavyscript dns`, and read about internal DNS [here](/manual/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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/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](/manual/SCALE/options/ingress) for an overview on using Ingress with your chart.
|
||||
|
||||
## Support
|
||||
|
||||
|
|
|
|||
|
|
@ -6,4 +6,4 @@ This chart requires Ingress to be enabled after initial install due to the confi
|
|||
|
||||
|
||||
|
||||
Once this is done you can successful add Ingress using the steps outlined inside our [Quick-Start Guide](https://truecharts.org/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](/manual/SCALE/options/ingress). If you require more help or details please refer to our Discord for help from our Support Staff.
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/manual/SCALE/guides/getting-started) guide on the [Truecharts](https://truecharts.org) website.
|
||||
Please follow the [Getting Started](/manual/SCALE/guides/getting-started) guide on the [Truecharts](https://truecharts.org) website.
|
||||
|
||||
## Installation instructions
|
||||
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/manual/SCALE/guides/getting-started#adding-truecharts)
|
||||
- Installation of the TrueCharts Catalog, starting [here](/manual/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](https://truecharts.org/manual/SCALE/guides/add-storage)
|
||||
and for that you can simply follow our [Adding Storage](/manual/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](https://truecharts.org/manual/SCALE/guides/nfs-share/).
|
||||
devices outside of TrueNAS, so we recommend following the [using NFS Shares guide](/manual/SCALE/guides/nfs-share/).
|
||||
|
||||
## Install Jellyfin inside TrueNAS SCALE
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ title: Setup Guide
|
|||
|
||||
- Jellyseerr TrueCharts Chart
|
||||
- Jellyfin TrueCharts Chart
|
||||
- Installation of the TrueCharts Catalog, starting [here](https://truecharts.org/manual/SCALE/guides/getting-started#adding-truecharts)
|
||||
- Installation of the TrueCharts Catalog, starting [here](/manual/SCALE/guides/getting-started#adding-truecharts)
|
||||
|
||||
## Install Jellyseerr inside TrueNAS SCALE
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Like TrueNAS Scale WebUI.
|
|||
|
||||
## Lancache-dns
|
||||
|
||||
- It's highly recommended to also install the [lancache-dns](https://truecharts.org/charts/stable/lancache-dns/) chart along side the monolithic chart.
|
||||
- It's highly recommended to also install the [lancache-dns](/charts/stable/lancache-dns/) chart along side the monolithic chart.
|
||||
|
||||
## Lancache-Prefill
|
||||
|
||||
|
|
|
|||
|
|
@ -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/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`.
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/manual/SCALE/guides/getting-started#adding-truecharts)
|
||||
- Installation of the TrueCharts Catalog, starting [here](/manual/SCALE/guides/getting-started#adding-truecharts)
|
||||
|
||||
## Install Notifiarr inside TrueNAS SCALE
|
||||
|
||||
|
|
|
|||
|
|
@ -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/premium/traefik/how-to).
|
||||
[Quick-Start guides](/manual/guides/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.
|
||||
|
||||
## Organizr App Setup
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Installation Notes
|
|||
|
||||
- Please create an [app](https://trakt.tv/oauth/applications/new) in trakt.tv.
|
||||
- Set the trakt app name to whatever you like for ex: `plaxt`.
|
||||
- Optionally set an icon, you can download this [icon](https://truecharts.org/img/hotlink-ok/chart-icons/plaxt.png).
|
||||
- Optionally set an icon, you can download this [icon](/img/hotlink-ok/chart-icons/plaxt.png).
|
||||
- Set the redirect uri to for ex (must end with `/authorize`):
|
||||
- `https://plaxt.mydomain.com/authorize`.
|
||||
- `https://my_public_ip:8000/authorize`.
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ I always mount to the root directory of the container
|
|||
|
||||
### VPN
|
||||
|
||||
Use the [Gluetun VPN Add-on Setup Guide](https://truecharts.org/manual/SCALE/guides/vpn-setup)
|
||||
Use the [Gluetun VPN Add-on Setup Guide](/manual/SCALE/guides/vpn-setup)
|
||||
|
||||
<br />
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Installation Notes
|
|||
|
||||
## MQTT setup
|
||||
|
||||
- I used the chart called `mosquitto` install it as normal and set `Authentication` to **true**. here's the [auth guide](https://truecharts.org/charts/stable/mosquitto/setup-guide).
|
||||
- I used the chart called `mosquitto` install it as normal and set `Authentication` to **true**. here's the [auth guide](/charts/stable/mosquitto/setup-guide).
|
||||
|
||||
## Ring-MQTT setup
|
||||
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/manual/SCALE/options/ingress) on adding ingress to a chart.
|
||||
- Please follow this [guide](/manual/SCALE/options/ingress) on adding ingress to a chart.
|
||||
|
||||
## Disable authentication
|
||||
|
||||
|
|
|
|||
|
|
@ -10,4 +10,4 @@ This chart requires a `PUID` of `0` to run, however the default is `568`
|
|||
|
||||
## Setup-Guide
|
||||
|
||||
For more details please see the [setup guide](https://truecharts.org/charts/stable/wg-easy/setup-guide) on how to configure the charts and to open ports on your Firewall and/or enable the proper `sysctls` for passing through traffic.
|
||||
For more details please see the [setup guide](/charts/stable/wg-easy/setup-guide) on how to configure the charts and to open ports on your Firewall and/or enable the proper `sysctls` for passing through traffic.
|
||||
|
|
|
|||
|
|
@ -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](https://truecharts.org/manual/FAQ#prometheus-operator) to resolve it
|
||||
you should follow instructions from the [FAQ](/manual/FAQ#prometheus-operator) to resolve it
|
||||
|
||||
### Helm
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue