Post Code-Freeze Review, Bugsfixes and Documentation
- Fix traefik Portal Button - Touchup Security Policies - Update Support Policies - Re-Add Deluge as incubator App - Add Canary to Security Policies - Add all-contributors basic config
This commit is contained in:
+3
-9
@@ -1,14 +1,14 @@
|
||||
# FAQ
|
||||
|
||||
- Q: I tried to run TrueCharts on TrueNAS SCALE 20.12 and it doesn't work.<br>
|
||||
A: TrueNAS SCALE 20.12 has never supported custom charts in any way, shape or form. Hence TrueCharts is 21.02+ only
|
||||
- Q: I tried to run TrueCharts on TrueNAS SCALE 20.12 or 21.02 and it doesn't work.<br>
|
||||
A: TrueNAS SCALE 20.12 has never supported custom charts in any way, shape or form. Hence TrueCharts is 21.04+ only
|
||||
|
||||
- Q: Please include app X<br>
|
||||
A: Please file an issue about it, after checking the wiki to make sure it hasn't been discussed already:
|
||||
https://github.com/truecharts/apps/wiki/k8s-at-home-to-SCALE-App-migration-list
|
||||
|
||||
- Q: Isn't there more documentation for app x<br>
|
||||
A: If it's not on our [wiki](https://wiki.truecharts.org), we do not. Currently during TrueNAS SCALE ALPHA/BETA we focus on the technical aspects.
|
||||
A: If it's not on our [website](https://truecharts.org), we do not. There might be other sources for documentation however!
|
||||
|
||||
- Q: Function x doesn't seem to be working, should it be working?<br>
|
||||
A: Maybe, please file an issue
|
||||
@@ -16,12 +16,6 @@ A: Maybe, please file an issue
|
||||
- Q: I'm missing a lot of configuration opions in the install GUI.<br>
|
||||
A: We try to aim for a balance in the amount of options vs the simplicity of installation. Suggestions are always welcome
|
||||
|
||||
- Q: The portal button isn't working.<br>
|
||||
A: Portal buttons are current't not implemented very well and are considered "not supported" for the time being
|
||||
|
||||
- Q: I selected letsencrypt but still get a traefik certificate.<br>
|
||||
A: Cert Manager might take up to 10 minutes to fetch the right certificate and requires free access to 1.1.1.1:53. Until the right certificate is fetched, it will use the Traefik Default cert.
|
||||
|
||||
- Q: Is my data guaranteed to be secure?<br>
|
||||
A: ix_volumes (the auto generated storage) is considered relatively secure as long as you don't delete the App, but we can't give an absolute guarantee. data mounted using a hostPath, is as secure as the application that is using the data, our charts do not actively alter said dataset/folder. However: SCALE is still ALPHA, so breaking changes in the storage design are very likely.
|
||||
|
||||
|
||||
+14
-7
@@ -5,7 +5,8 @@
|
||||
---
|
||||
Truecharts is an innitiative to provide high quality Apps to use with the TrueNAS SCALE App Ecosystem.
|
||||
Our primary goals are:
|
||||
- Freedom
|
||||
- Micro-Service Centered
|
||||
- Native Kubernetes
|
||||
- Stability
|
||||
- Consistancy
|
||||
|
||||
@@ -13,13 +14,10 @@ All our apps are supposed to work together, be easy to setup using the TrueNAS U
|
||||
|
||||
|
||||
## Getting started using TrueCharts
|
||||
Installing TrueCharts within TrueNAS SCALE, still requires the CLI. However it's not hard:
|
||||
- Go to you shell of choice (either SSH or the TrueNAS webui shell)
|
||||
- enter `cli`
|
||||
- enter `app catalog create repository="https://github.com/truecharts/apps" label="TrueCharts"`
|
||||
Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list.
|
||||
|
||||
For more information, please visit our website:
|
||||
https://truecharts.org
|
||||
For more information:
|
||||
https://truecharts.org/manual/adding-truecharts/
|
||||
|
||||
## FAQ
|
||||
|
||||
@@ -30,6 +28,15 @@ There is a significant chance your issue has been reported before!
|
||||
|
||||
Creating charts takes some getting used to, as it's based on Helm charts. We highly suggest prior knowhow on creation/modifying Helm Charts, before taking on the challenge of creating SCALE Apps.
|
||||
|
||||
## 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:
|
||||
|
||||
| <a href="https://www.truenas.com/truenas-scale/"> <img src="https://user-images.githubusercontent.com/7613738/113836934-a1764e00-978d-11eb-8e19-a087c5c1f99b.png" width="150" height="150" /> </a> | <a href="https://k8s-at-home.com/"> <img src="https://user-images.githubusercontent.com/7613738/113837194-e26e6280-978d-11eb-9632-2e1529946302.png" width="150" height="150" /> </a> | <a href="https://traefik.io/traefik/"> <img src="https://user-images.githubusercontent.com/7613738/113837353-0b8ef300-978e-11eb-873e-14769acfe1f1.png" width="150" height="150" /> </a> |
|
||||
| :---------------: | :---------------: | :---------------: |
|
||||
| <a href="https://www.truenas.com/truenas-scale/">TrueNAS SCALE</a> | <a href="https://k8s-at-home.com/">K8S-At-Home</a> | <a href="https://traefik.io/traefik/">Traefik</a> |
|
||||
|
||||
|
||||
## Licence
|
||||
|
||||
`SPDX-License-Identifier: BSD-3-Clause`
|
||||
|
||||
@@ -9,12 +9,13 @@ _Please note: We always prefer maintainers that have worked on one of our Apps b
|
||||
|
||||
### Current Apps without maintainers
|
||||
|
||||
- bazarr
|
||||
- Calibre-web
|
||||
- deluge
|
||||
- freshrss
|
||||
- gaps
|
||||
- grocy
|
||||
- heimdall
|
||||
- lazylibrarian
|
||||
- lychee
|
||||
- navidrome
|
||||
- node-red
|
||||
@@ -26,3 +27,4 @@ _Please note: We always prefer maintainers that have worked on one of our Apps b
|
||||
- sabnzbd
|
||||
- truecommand
|
||||
- tvheadend
|
||||
- unifi
|
||||
|
||||
Reference in New Issue
Block a user