diff --git a/.github/README.md b/.github/README.md
index 6456c9bd7f2..7938c53f8a4 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -1,4 +1,5 @@
-# TrueCharts
+# TrueCharts
+
**Community App Catalog for TrueNAS SCALE**
[](https://truecharts.org/)
@@ -6,6 +7,7 @@
[](https://github.com/truecharts/apps/commits)
---
+
TrueCharts is a catalog of highly optimised TrueNAS SCALE Apps. Made for the community, By the community!
Our primary goals are:
@@ -20,12 +22,14 @@ Our primary goals are:
All our apps are supposed to work together, be easy to setup using the TrueNAS UI and, above all, give the average user more than enough options to tune things to their liking.
-
+
## Getting started using TrueCharts
+
[](https://truecharts.org/)
---
+
Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list.
Check TrueCharts [Quick-Start Guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) for more infotmation.
@@ -40,29 +44,28 @@ Still something not working as expected? [Contact us!](https://truecharts.org/ab
For big changes we do have a roadmap, every spot on the roadmap is synced to a TrueNAS SCALE Release and should be read as "Should be added at or before this release"
-
-
+
**Restructure of the Project - TrueNAS SCALE "Bluefin" 22.xx ALPHA 1**
_The current project is hitting internal performance issues, for this reason we need to rework the structure and split some parts of the project into seperate repositories._
-
+
**Refactor the Common Chart - TrueNAS SCALE "Bluefin" 22.xx ALPHA 2**
_The shared Common (chart) basis, used by all our Apps, needs some significant code cleanup. Primarily all code needs to follow a standardised format and comply to the same standard_
-
+
**Increased test coverage - TrueNAS SCALE "Bluefin" 22.xx BETA 1**
_With most parts of our project somewhat cleaned up, we need to work on increasing the coverage of our test system. Our unittests should cover all features and we should also take upgrades into account when testing App changes_
-
-
+
## Development
+
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/renovatebot/renovate)
[](https://github.com/truecharts/apps/commits)
@@ -72,7 +75,6 @@ _With most parts of our project somewhat cleaned up, we need to work on increasi
Our development process is fully distributed and agile, so every chart-maintainer is free to set their own roadmap and development speed and does not have to comply to a centralised roadmap.
This ensures freedom and flexibility for everyone involved and makes sure you, the end user, always has the latest and greatest of every App installed.
-
### Getting into creating Apps
Creating charts takes some getting used to, as it's based on Helm charts. We highly suggest prior know-how on creation/modifying Helm Charts, before taking on the challenge of creating SCALE Apps.
@@ -85,10 +87,10 @@ We provide a lot of tools to make it easier to develop charts, templates, automa
Those tools do, however, take time to develop and are certainly not bug free. If you find mistakes in our tooling, please feel free to repost issues or submit any fixes you feel appropriate!
-
-
+
## Contact and Support
+
[](https://discord.gg/tVsPTHWTtr)
---
@@ -103,29 +105,30 @@ To contact the TrueCharts project:
- Or [join our Discord server](https://truecharts.org/discord)
-
+
-
-
+
## Featured Projects
A lot of our work is based on the great effort of others. We would love to extend special thanks to these projects we owe a lot to:
| 
| 
| 
| 
|
-| :---------------: | :---------------: | :---------------: | :---------------: |
-| TrueNAS SCALE | K8S-At-Home | Traefik | Authelia |
-
-
+| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: |
+| TrueNAS SCALE | K8S-At-Home | Traefik | Authelia |
+
## Contributors ✨
+
[](#contributors)
+
+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
---
@@ -281,19 +284,18 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
-
-
## Licence
+
[](https://github.com/truecharts/apps/blob/master/docs/LICENSE.BSD3)
---
-Truecharts as a whole, is based on a BSD-3-clause license, this ensures almost everyone can use and modify our charts. However: As a lot of Apps are based on upstream Helm Charts, Licences can vary on a per-App basis. This can easily be seen by the presence of a "LICENSE" file in the App root folder.
+Truecharts as a whole, is based on a BSD-3-clause license, this ensures almost everyone can use and modify our charts. However: As a lot of Apps are based on upstream Helm Charts, Licences can vary on a per-App basis. This can easily be seen by the presence of a "LICENSE" file in the App root folder.
Some Apps may also contain parts in other licenses, such as libraries or templates, these files can be recognised by their individual headers.
-
`SPDX-License-Identifier: BSD-3-Clause`
---
- 
+
+ 
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
new file mode 100644
index 00000000000..64fbb2a0ee3
--- /dev/null
+++ b/.markdownlint.yaml
@@ -0,0 +1,13 @@
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
+# Do not warn for "Inline HTML"
+MD033: false
+
+# https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md#md036
+# Do not warn for "Emphasis used instead of a heading"
+MD036: false
+
+# https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md#md013
+# Do not warn for Line length
+MD013:
+ # We can lower this and wrap lines. Markdown does not care.
+ line_length: 999
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index e889104925c..d18beb0d978 100644
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@@ -1,5 +1,7 @@
{
"recommendations": [
+ "streetsidesoftware.code-spell-checker",
+ "davidanson.vscode-markdownlint",
"editorconfig.editorconfig",
"ms-vscode-remote.remote-containers",
"rebornix.ruby"
diff --git a/charts/dependency/collabora-online/docs/installation_notes.md b/charts/dependency/collabora-online/docs/installation_notes.md
index 50d89398cec..028c09fc434 100644
--- a/charts/dependency/collabora-online/docs/installation_notes.md
+++ b/charts/dependency/collabora-online/docs/installation_notes.md
@@ -1,8 +1,9 @@
# Installation Notes
-* If you don't enable `Reverse Proxy` on `Collabora` (It's not recommended as it is unsecure), in order for it to work you have to
- * Remove `-o:ssl.termination=true -o:ssl.enable=false` from `Extra Parameters`.
- * Set `Server Name` to `hostIP:port` (The port number you set for `NodePort`)
- * Set `Service type` to `NodePort`
- * Set `Port type` to `HTTPS`
- * Disable certificate validation in the app you are going to use it. (eg. Nextcloud have a checkbox under Collabora's URL to disable Cert Validtation)
+If you don't enable `Reverse Proxy` on `Collabora` (It's not recommended as it is unsecure), in order for it to work you have to
+
+* Remove `-o:ssl.termination=true -o:ssl.enable=false` from `Extra Parameters`.
+* Set `Server Name` to `hostIP:port` (The port number you set for `NodePort`)
+* Set `Service type` to `NodePort`
+* Set `Port type` to `HTTPS`
+* Disable certificate validation in the app you are going to use it. (eg. Nextcloud have a checkbox under Collabora's URL to disable Cert Validation)
diff --git a/charts/dependency/collabora-online/questions.yaml b/charts/dependency/collabora-online/questions.yaml
index aced1fbad84..7f07e47018c 100644
--- a/charts/dependency/collabora-online/questions.yaml
+++ b/charts/dependency/collabora-online/questions.yaml
@@ -124,7 +124,7 @@ questions:
default: "de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru"
- variable: extra_params
label: "Extra Parameters to add"
- description: 'e.g. "--o:welcome.enable=false", See more on /etc/loolwsd/loowsd.xml. Separate params with space'
+ description: 'e.g. "--o:welcome.enable=false", See more on /etc/loolwsd/loolwsd.xml. Separate params with space'
schema:
type: string
default: "--o:welcome.enable=false --o:logging.level=information --o:user_interface.mode=notebookbar --o:ssl.termination=true --o:ssl.enable=false"
diff --git a/charts/incubator/avidemux/docs/installation_notes.md b/charts/incubator/avidemux/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/incubator/avidemux/docs/installation_notes.md
+++ b/charts/incubator/avidemux/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/incubator/dupeguru/docs/installation_notes.md b/charts/incubator/dupeguru/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/incubator/dupeguru/docs/installation_notes.md
+++ b/charts/incubator/dupeguru/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/incubator/filebot/docs/installation_notes.md b/charts/incubator/filebot/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/incubator/filebot/docs/installation_notes.md
+++ b/charts/incubator/filebot/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/incubator/mediainfo/docs/installation_notes.md b/charts/incubator/mediainfo/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/incubator/mediainfo/docs/installation_notes.md
+++ b/charts/incubator/mediainfo/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/incubator/mkvcleaver/docs/installation_notes.md b/charts/incubator/mkvcleaver/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/incubator/mkvcleaver/docs/installation_notes.md
+++ b/charts/incubator/mkvcleaver/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/incubator/qdirstat/docs/installation_notes.md b/charts/incubator/qdirstat/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/incubator/qdirstat/docs/installation_notes.md
+++ b/charts/incubator/qdirstat/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/incubator/tsmuxer/docs/installation_notes.md.md b/charts/incubator/tsmuxer/docs/installation_notes.md
similarity index 80%
rename from charts/incubator/tsmuxer/docs/installation_notes.md.md
rename to charts/incubator/tsmuxer/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/incubator/tsmuxer/docs/installation_notes.md.md
+++ b/charts/incubator/tsmuxer/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/stable/deepstack/docs/installation_notes.md b/charts/stable/deepstack/docs/installation_notes.md
index 74c318f63bd..6f3bf9be6ef 100644
--- a/charts/stable/deepstack/docs/installation_notes.md
+++ b/charts/stable/deepstack/docs/installation_notes.md
@@ -1,5 +1,6 @@
-d# Installation Notes
+# Installation Notes
## Custom Models
+
If you have custom models and you wan to use them, you have to add customStorage to this app. The default path to map is `/modelstore/detection`.
In case you like to change it, you also have to change `Custom Models Path` field to the path you mapped as customStorage.
diff --git a/charts/stable/duplicati/docs/ingress.md b/charts/stable/duplicati/docs/ingress.md
index e6e9e82a385..93fde802a57 100644
--- a/charts/stable/duplicati/docs/ingress.md
+++ b/charts/stable/duplicati/docs/ingress.md
@@ -1,4 +1,4 @@
-## Ingress
+# Ingress
This chart requires Ingress to be enabled after initial install due to the configuration of the application upstream (see [Duplicati forum post](https://forum.duplicati.com/t/error-message-in-browser-the-host-header-sent-by-the-client-is-not-allowed/5806)). Please install the application without Ingress, access settings of the application and add your hostname inside the settings of the app.
diff --git a/charts/stable/fireflyiii/docs/installation_notes.md b/charts/stable/fireflyiii/docs/installation_notes.md
index e88e4d60daa..ef75ce3d383 100644
--- a/charts/stable/fireflyiii/docs/installation_notes.md
+++ b/charts/stable/fireflyiii/docs/installation_notes.md
@@ -1,4 +1,5 @@
# Important Notes
-The FireFlyiii developers have decided to split their program into multiple different add-on containers, implementing these ourselves into the App is EXTREMELY time-consuming. While we would appreciate people with experience building Helm Charts and adding the feature containers, we have decided to flag them "out of scope" for True Charts.
+
+The Firefly III developers have decided to split their program into multiple different add-on containers, implementing these ourselves into the App is EXTREMELY time-consuming. While we would appreciate people with experience building Helm Charts and adding the feature containers, we have decided to flag them "out of scope" for True Charts.
If you really want to use them, you can use custom-app or big-blue-button. However, we do not actively support such a setup.
diff --git a/charts/stable/handbrake/docs/installation_notes.md b/charts/stable/handbrake/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/stable/handbrake/docs/installation_notes.md
+++ b/charts/stable/handbrake/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/stable/jdownloader2/docs/installation_notes.md b/charts/stable/jdownloader2/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/stable/jdownloader2/docs/installation_notes.md
+++ b/charts/stable/jdownloader2/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/stable/makemkv/docs/installation_notes.md b/charts/stable/makemkv/docs/installation_notes.md
index 0afc9505bfe..776edbdc850 100644
--- a/charts/stable/makemkv/docs/installation_notes.md
+++ b/charts/stable/makemkv/docs/installation_notes.md
@@ -1,8 +1,10 @@
# Installation Notes
- If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
-- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
- `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
- `SECURE_CONNECTION` affects both `WebUI` and `VNC`.
+---
+
- If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
diff --git a/charts/stable/meshroom/docs/installation_notes.md b/charts/stable/meshroom/docs/installation_notes.md
index aa2ae16a2c8..5e32d9eea0b 100644
--- a/charts/stable/meshroom/docs/installation_notes.md
+++ b/charts/stable/meshroom/docs/installation_notes.md
@@ -1,9 +1,6 @@
# Notes
-Meshroom in docker does not have weUIUI.
-
+Meshroom in docker does not have a webUI.
You need an ssh client capable of X forwarding.
-
-You SSH into the app, with `ssh -p 10243 -X root@ /opt/Meshroom_bundle/Meshroom`
-
+You SSH into the app, with `ssh -p 10243 -X root@ /opt/Meshroom_bundle/Meshroom`
Default password is `meshroom`
diff --git a/charts/stable/minecraft-java/docs/community-guide.md b/charts/stable/minecraft-java/docs/community-guide.md
index 7eb01f1ebd9..8b864db8c90 100644
--- a/charts/stable/minecraft-java/docs/community-guide.md
+++ b/charts/stable/minecraft-java/docs/community-guide.md
@@ -2,50 +2,40 @@
⚠️ **Warning This guide contains information that uses Advanced/Expert settings. As a result this will be outside the scope of support!** ⚠️
-# Running Multiple MC-Java Servers
+---
+
+## Running Multiple MC-Java Servers
You can easily run Multiple MC Servers. You simply need to change the external ports, Be sure to use an unused port. There is no need to change the Minecraft port or RCON port in the server.properties
MC Server 1
-
-
-
-
-
-
-
-
-
-
-
-
-