fb5d8aad32
* docs: update .github/README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl> |
||
|---|---|---|
| .containers | ||
| .devcontainer | ||
| .github | ||
| .tools | ||
| .vscode | ||
| docs | ||
| incubator | ||
| library | ||
| stable | ||
| .all-contributorsrc | ||
| .gitignore | ||
| .helmdocsignore | ||
| .pre-commit-config.yaml | ||
| CNAME | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| NOTICE | ||
| features_capability.json | ||
| index.yaml | ||
| mkdocs.yml | ||
.github/README.md
About TrueCharts
Community App Catalog for TrueNAS SCALE
Truecharts is an innitiative to provide high quality Apps to use with the TrueNAS SCALE App Ecosystem. Our primary goals are:
- Micro-Service Centered
- Native Kubernetes
- Stability
- Consistancy
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
Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list.
For more information: https://truecharts.org/manual/adding-truecharts/
FAQ
Please refer to our FAQ and Issue tracker before creating an issue. There is a significant chance your issue has been reported before!
Getting into creating Apps
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:
 |
 |
 |
|---|---|---|
| TrueNAS SCALE | K8S-At-Home | Traefik |
Contributors ✨
Thanks goes to these wonderful people (emoji key):
 Kjeld Schouten-Lebbing 💻 🚇 📖 |
 allen-4 💻 |
 Troy Prelog 💻 📖 |
 Dan Sheridan 💻 |
 Sebastien Dupont 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
Licence
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 rootfolder.
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
