docs(multiple charts): fix asides (#21073)

**Description**
Fixes asides and restores nextcloud migration guide images.

⚒️ 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
- [X] 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._
This commit is contained in:
kqmaverick 2024-04-20 11:03:07 -07:00 committed by GitHub
parent 6e36f6e157
commit ef9315820f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
48 changed files with 63 additions and 57 deletions

2
.github/SUPPORT.md vendored
View File

@ -43,7 +43,7 @@ Support for Talos-OS with either Rancher or FluxCD are in early alpha.
| --------------- | -------- | ---------------------- | ------------------------- | --------------------- | ----- |
| v2.7.9 or prior | `master` | :white_check_mark: | :x: | :x: | |
:::warning Support Guidelines
:::caution[Support Guidelines]
Our [Discord](https://discord.gg/tVsPTHWTtr) support (the ticketing system inside #support) is primarily limited to what is covered by our written guides. This includes installing, linking and editing apps. This doesn't mean the actual setup of the application. All #support tickets covered by the staff are done so in a **best effort** policy.

View File

@ -12,7 +12,7 @@ This quick guide should take you through the steps necessary to setup `Authelia`
## Setup LLDAP
:::warning
:::caution
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).

View File

@ -74,7 +74,7 @@ In the below example I am using Google DNS.
Blocky comes preconfigured with basic Blacklists and Whitelists. DNS Blacklists are used to prevent DNS resolution of advertisement, malware, trackers and adult sites domains. DNS Whitelists are used to always allow DNS resolution of domains regardless of existing blacklists. This is completed with public maintained blocklists. A good source for these is [firebog.net](https://firebog.net).
:::warning Warning
:::caution
While publicly maintained blocklists usually do a good job of allowing legitimate traffic they
can sometimes be too broad and catch traffic that you wish to allow. You may need to disable

View File

@ -10,7 +10,7 @@ This guide will walk you through setting up `clusterissuer`, certificate managem
- [Traefik](/charts/premium/traefik/) is installed from premium train
- [Cert-Mananger](/charts/system/cert-manager/) and [Prometheus-Operator](/charts/system/prometheus-operator/)
:::warning DNS
:::caution[DNS]
As part of the DNS verification process cert-manager will connect to authoritative nameservers to validate the DNS ACME entry. Any firewall or router rules blocking or modifying DNS traffic will cause this process to fail and prevent the issuance of certificates. Ensure no firewall or router rules are in place blocking or modifying DNS traffic to assigned authoritative nameservers. Below is an example of cloudflare assigned authoritative nameservers (these nameservers are unique to each user).

View File

@ -4,7 +4,7 @@ title: MetalLB Basic Setup
The guide walks through a basic configuration of MetalLB for a single address pool on a layer 2 network. This will allow assigning different IP addresses by app.
:::warning
:::caution
With MetalLB installed, apps will not be reachable using the integrated LoadBalancer. You cannot combine two different LoadBalancers in TrueNAS SCALE.
@ -55,7 +55,7 @@ Create a new entry under `Configure L2 Advertisements`.
- **Name**: Enter a basic name for your layer 2 advertisement.
- **Address Pool Entry:** This should match the **name** of the address pool created above (not the IP range itself).
:::info
:::tip
Once installed, `metallb-config` will always show as Stopped.

View File

@ -6,13 +6,13 @@ This guide can will walk through the process of backing up and existing Nextclou
## Backup
:::danger SMB EXTERNAL STORAGE
:::danger[SMB EXTERNAL STORAGE]
If you are using SMB authenticated external storage on your Nextcloud remove it before starting this guide. The migration process will fail if it is not removed.
:::
:::danger TWO FACTOR AUTHENTICATION
:::danger[TWO FACTOR AUTHENTICATION]
If you are using two factor authentication on your Nextcloud accounts disable it before starting this guide. While it can be done via the CLI later it is much easier to disable it before hand.
@ -52,7 +52,7 @@ ls -la
<!-- ![userdata-old](./img/userdata-old.png) -->
:::warning
:::caution
Next steps are destructive without a way to undo. Make sure you have proper backups to avoid data loss.
@ -80,13 +80,19 @@ Nextcloud uses apps for file ownership. Apply permissions as shown below to your
Install with a temporary admin user that you do not currently use for Nextcloud (ie. temp)
:::caution[UNIQUE USER]
If you do not install with a unique user the install will fail because Nexctloud will be unable to create the user folder when one already exists
:::
Setup Nextcloud User Data storage with your previous User Data dataset or the dataset you copied your User Data to.
<!-- ![userdata-setting](./img/userdata-setting.png) -->
### Restore Database
:::caution Nextcloud Installation
:::caution[Nextcloud Installation]
Wait for Nextcloud to fully deploy before proceeding.
@ -108,7 +114,7 @@ Wait for Nextcloud to fully deploy before proceeding.
6. Configure Options as shown below and click restore.
<!-- ![pgadmin-restore4](./img/pgadmin-restore4.png) -->
:::caution PGAdmin Error
:::caution[PGAdmin Error]
PGAdmin may display an error during the restore process. This is known to occur and may be ignored.
@ -122,7 +128,7 @@ k3s kubectl scale deploy nextcloud -n ix-nextcloud --replicas=1
### OCC Commands
:::caution Nextcloud Deploy
:::caution[Nextcloud Deploy]
Wait for Nextcloud to fully deploy before proceeding.

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

View File

@ -9,7 +9,7 @@ title: Installation Notes
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/guides/getting-started/#traefik-installation-for-ingress--reverse-proxy-support-with-truecharts-apps).
:::caution SNAPSHOT DIRECTORY VISIBILITY
:::caution[SNAPSHOT DIRECTORY VISIBILITY]
Nextcloud installation will fail if the application or user data datasets have Snapshot Directory set to Visible (invisible by default). Return this setting to default prior to installation.

View File

@ -30,14 +30,14 @@ after which you will be automatically redirected to your dashboard through one o
If you are not prompted to restart the web server service, you may restart the machine and manually navigate
to the WebUI address followed by one of the new ports eg. `truenas.local:81`.
:::info
:::tip
These are the recommended ports for this procedure. Using different ports may require some
changes to your configuration that are not covered in this tutorial.
:::
:::warning
:::caution
Do not skip this step. Neglecting to change the default ports active may cause your WebUI to become inaccessible after the following step.
Ensure you are accessing your WebUI from the new ports before proceeding.

View File

@ -2,7 +2,7 @@
title: Disabling the Admin Interface
---
:::caution Backup Reminder
:::caution[Backup Reminder]
Before proceeding, ensure that you have backed up important configurations, especially when making changes to configuration files or secrets. It's also advisable to back up the Vaultwarden database to prevent potential data loss.
@ -18,7 +18,7 @@ To start with the deactivation, you must first modify the secret on the host's s
k3s kubectl patch secret vaultwarden-vaultwardensecret -n ix-vaultwarden --type='json' -p='[{"op": "remove", "path": "/data/ADMIN_TOKEN"}]'
```
:::info Command Explanation
:::tip[Command Explanation]
The command above utilizes `kubectl`, a command-line tool for interacting with Kubernetes clusters. Here's a breakdown:
@ -38,7 +38,7 @@ Next, while inside the Vaultwarden container, run the command below to modify th
sed -i.bak '/admin_token/d' /data/config.json
```
:::info Command Explanation
:::tip[Command Explanation]
- The `sed` command is used to search and delete the line containing `admin_token` from the `config.json` file.
- A backup of the original `config.json` is created with the `.bak` extension before making the change.

View File

@ -2,7 +2,7 @@
title: How To
---
:::warning
:::caution
This chart requires **aria2** to be installed or otherwise reachable.

View File

@ -4,7 +4,7 @@ title: Installation Notes
Installation notes and warnings for A.R.M
:::warning
:::caution
This app uses advanced privileges aka "GOD MODE" on the host

View File

@ -2,7 +2,7 @@
title: Channels DVR Installation Notes
---
:::danger TV Everywhere Permissions
:::danger[TV Everywhere Permissions]
If using TV Everywhere, `runAsUser` and `runAsGroup` must both be changed to `0` and `readOnlyRootFilesystem` must be changed to `false`.

View File

@ -4,7 +4,7 @@ title: How-To
This is a quick setup-guide on how-to to use ClamAV with mounting directories using NFS shares and using the integrated cron job to scan these mounted folders.
:::info
:::tip
- ClamAV TrueCharts App
- NFS Shares of the folders you want to scan

View File

@ -2,7 +2,7 @@
title: Installation Notes
---
:::danger Cloudflared Tunnels for Plex, Jellyfin, Emby and other video heavy/streaming apps/sites
:::danger[Cloudflared Tunnels for Plex, Jellyfin, Emby and other video heavy/streaming apps/sites]
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)
@ -54,7 +54,7 @@ Then you need to do the same to set up the subdomain for each app you want to ex
![cloudflare-setup](./img/cloudflare-setup2.png)
:::danger No TLS Verify
:::danger[No TLS Verify]
Please refrain from enabling the "No TLS Verify" option, as doing so will disable TLS verification, thereby allowing any certificate from the origin to be accepted. This option removes certificate security validation, rendering the certificates meaningless for security.

View File

@ -59,7 +59,7 @@ The `ip_version` should always be `ipv4` unless your special :/.
}
```
:::info
:::tip
You can also reach us using Discord for real-time feedback and support
If you found a bug in our chart, open a Github issue but generally it's advised to contact us on Discord first in most cases.

View File

@ -7,7 +7,7 @@ title: Installation Notes
Add your discord bot if you haven't done so and run initial commands to get started with discordGSM.
:::info
:::tip
Checkout discordGSM supported list of game servers [here](https://discordgsm.com/guide/supported-games).

View File

@ -10,7 +10,7 @@ Set the `Quant Type` to the correct option when using a particular model.
Set the `Max Batch Size` to the maximum batch size a model can use.
::: note
:::tip
If you are not using the batching endpoint, /generate, it is best practice to set `Disable Batching` to true. The batching service can interfere with the streaming service, and make it slower.

View File

@ -9,7 +9,7 @@ This guide will cover how to use the TrueCharts/Homepage integration included in
GitHub: <https://github.com/gethomepage/homepage>
Website: <https://gethomepage.dev/>
:::warning INGRESS REQUIRED
:::caution[INGRESS REQUIRED]
For Homepage to "discover" your apps, Ingress is required using our ingress configuration guidelines and the integration options for the chart configuration. Otherwise, all Kubernetes features can be used with manual configuration of Homepage via its configuration YAML files.
:::

View File

@ -24,7 +24,7 @@ Like TrueNAS Scale WebUI.
How to use lancache-prefill sidecar
:::info
:::tip
Shell into the main pod, not the _prefill_ pod.

View File

@ -2,7 +2,7 @@
title: Installation instructions
---
:::warning
:::caution
Ingress for this chart is **required**
@ -28,7 +28,7 @@ We will **unset** every option (key) that has:
The above will only be applied when installed in TrueNAS Scale as an App
::: note
:::note
When you make a change in the UI, you need to manually stop and re-start the app
for the change to take effect.
@ -38,7 +38,7 @@ for the change to take effect.
For SCALE users, you can add additional configuration options that are not exposed in the UI
by using the `Additional MeshCentral Configuration` section.
::: tip
:::tip
However, if you think an option would be used by a lot of users, it would be best to ask us to expose it.
@ -77,7 +77,7 @@ Set like this:
- Key: `domains."".newAccountsRights`
- Value: `[ "item1", "item2" ]`
::: warning
:::caution
Please use the exact casing as in the [MeshCentral's json schema](https://github.com/Ylianst/MeshCentral/blob/master/meshcentral-config-schema.json).

View File

@ -37,7 +37,7 @@ The `/data/permissions.json` should look something like this:
]
```
:::info
:::tip
- You can also reach us using [Discord](https://discord.gg/tVsPTHWTtr) for real-time feedback and support
- If you found a bug in our chart, open a Github [issue](https://github.com/truecharts/apps/issues/new/choose) but generally it's advised to contact us on Discord first in most cases.

View File

@ -258,7 +258,7 @@ map = "Velocity"
show-plugins = false
```
:::info
:::tip
There's currently a known issue with **limbo server** when attemptng to connect to a **1.19.2** velocity proxy server and using **player-info-forwarding-mode = "modern"**. You can track the current issue here [issue 50](https://github.com/LOOHP/Limbo/issues/50).

View File

@ -4,7 +4,7 @@ title: Installation Notes
## TrueNAS SCALE
:::note Written for
:::note[Written for]
- Platform: TrueNAS SCALE Cobia 23.10.1
- App Version: 2023.12.23
@ -12,13 +12,13 @@ title: Installation Notes
:::
:::warning Caution
:::caution
When using a PVC the backup data will be stored on the dataset that holds the app data. If minio is used to store backup data to safe guard your application data it is recommended to configure it on a different zpool, this can be done with a hostpath.
:::
:::note Preparation
:::note[Preparation]
1. Create a dataset for the data mount of minio referred to as <minio_data>
2. Set the proper owner and permissions required for the hostpath, 600 is the minimal permission level required

View File

@ -23,7 +23,7 @@ mosquitto_passwd -c passwordfile username
echo "password_file /mosquitto/configinc/passwordfile" > passwordconfig.conf
```
:::info These commands explained
:::tip[These commands explained]
- Navigate to `/mosquitto/configinc`, the persistent storage location inside the container where the password files go
- Create a password file. This is interactive. Change `username` to your username. It will ask you to input the password twice
@ -31,7 +31,7 @@ echo "password_file /mosquitto/configinc/passwordfile" > passwordconfig.conf
:::
:::caution Restart chart
:::caution[Restart chart]
Restart the chart so Mosquitto loads the new configuration file.

View File

@ -2,7 +2,7 @@
title: Disclaimer
---
:::warning
:::caution
We do not advice anyone to use this, instead use an ingress like Traefik.
This app is **excluded** from support, also same applies for reverse proxing apps using this.

View File

@ -8,7 +8,7 @@ All app configuration defined in the GUI will take precedence over ANY manual co
:::
:::info
:::tip
You may need to restart the chart every 24 to 48hrs to keep the server from running out of memory and crashing.

View File

@ -4,7 +4,7 @@ title: Automatic Split DNS with PiHole
_Using Blocky in conjunction with PiHole enables seamless automated split DNS functionality._
:::danger unrecommended configuration
:::danger[unrecommended configuration]
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.
@ -12,7 +12,7 @@ The below guide is not the recommended DNS solution for TrueCharts. We recommend
## Install Blocky
:::note Blocky
:::note[Blocky]
Blocky includes k8s Gateway which automates the split DNS process. We will be using Blocky in between PiHole and your upstream DNS servers of choice to resolve your domain.

View File

@ -26,7 +26,7 @@ Once qBitrr has started access the `config.toml` file using the previously confi
This section has basic qBitrr settings. You may modify any as you choose but the `CompletedDownloadFolder` option must be set to `"/completed_downloads"` as that is what the App Completed Download Storage is mapped to.
:::warning Completed Download Folder
:::caution[Completed Download Folder]
If `CompletedDownloadFolder` option is not set to `"/completed_downloads"` qBitrr will not be able to find any downloads.

View File

@ -39,7 +39,7 @@ This is ALSO the port Sonarr/Radarr and other services will use to connect to qB
#### Listening Ports
:::tip VPN "With VPN"
:::tip[VPN "With VPN"]
- No need to port forward on your router
- If you want fast seeding, you will need a service that supports port forwarding and set the TCP Listening Port to the port Desired
@ -47,7 +47,7 @@ This is ALSO the port Sonarr/Radarr and other services will use to connect to qB
:::
:::tip NOVPN "Without VPN"
:::tip[NOVPN "Without VPN"]
- You can leave the two ports default without a VPN
- If you want fast seeding though, you will need to port forward this port on your router

View File

@ -2,9 +2,9 @@
title: Automatic Gluetun Port Forwarding
---
qBittorrent can be configured to automatically utilize the VPN forward port when used with Gluetun.
qBittorrent can be configured to automatically utilize the VPN forward port when used with Gluetun for ProtonVPN and PIA, all other VPN providers should be configured manually as the port does not change.
:::danger GLUETUN PORT FORWARDING REQUIRED
:::danger[GLUETUN PORT FORWARDING REQUIRED]
qBittorrent will fail to start if Gluetun is not configured for use with port forwarding enabled.

View File

@ -2,7 +2,7 @@
title: Installation Notes
---
:::info
:::tip
To edit recyclarr's files in the /config dir, I highly recommend using the codeserver Addon-on. It offers a web based file editor. Its meant to be temporarily so you can add/remove it any time.

View File

@ -13,7 +13,7 @@ The current stable version of Sonarr is v3. When configuring Sonarr v3, the defa
For Sonarr v3, we strongly recommend using either "In-App Setting" or "None" for the authentication method.
:::warning
:::caution
We strongly discourage the use of the "Basic" authentication method, as it may potentially impact system probes and security.

View File

@ -2,7 +2,7 @@
title: Disclaimer
---
:::warning
:::caution
You can't access local filesystem from web browser this is the reason that only object storage is available for this image.

View File

@ -4,7 +4,7 @@ title: Installation Notes
Basic Notes for tauticord.
:::note requirements
:::note[requirements]
- A Plex Media Server
- Tautulli (formerly known as PlexPy)
@ -22,7 +22,7 @@ Basic Notes for tauticord.
:::
:::note Common Issues
:::note[Common Issues]
- On startup, Tauticord attempts to upload a set of custom emojis that it will use when displaying stream information ( if they do not already exist). Your bot will need to have the Manage Emojis permission in order to do this.
- Discord has a limit of 50 custom emojis per server. If you have reached this limit, you will need to remove some of your existing emojis before Tauticord can upload its own.

View File

@ -2,7 +2,7 @@
title: Installation Notes
---
:::info
:::tip
This chart requires ingress without it you will NOT be able to access the webGUI.
@ -56,7 +56,7 @@ LISTEN 0.0.0.0 3493
In order to access the webGUI, you will **need** to add `ingress` otherwise it will refuse to connect.
:::info
:::tip
You can also reach us using Discord for real-time feedback and support
If you found a bug in our chart, open a Github issue but generally it's advised to contact us on Discord first in most cases.

View File

@ -46,7 +46,7 @@ Set them to `1` and `Enabled`
### Security and Permissions
:::warning
:::caution
Must change the `PUID` to 0 for this chart to work