2b84538d6c
* 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> |
||
|---|---|---|
| .chglog | ||
| .devcontainer | ||
| .github | ||
| .vscode | ||
| charts | ||
| templates | ||
| test | ||
| tools | ||
| .all-contributorsrc | ||
| .gitignore | ||
| .helmdocsignore | ||
| .pre-commit-config.yaml | ||
| .snyk | ||
| CNAME | ||
| Gemfile | ||
| LICENSE | ||
| NOTICE | ||
| mkdocs.yml | ||
.github/README.md
TrueCharts
Community App Catalog for TrueNAS SCALE
TrueCharts is a catalog of highly optimised TrueNAS SCALE Apps. Made for the community, By the community!
Our primary goals are:
-
Micro-Service Centered
-
Native Kubernetes
-
Stability
-
Consistency
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.
Check TrueCharts Quick-Start Guides for more infotmation.
Support
Please check our FAQ, manual and Issue tracker There is a significant chance your issue has been reported before!
Still something not working as expected? Contact us! and we'll figure it out together!
Roadmap
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
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.
For more information on creating SCALE Apps and Helm charts, please check out our development manual
Automation and you
We provide a lot of tools to make it easier to develop charts, templates, automated testing, automated fixes, automated docs. Even automated update is included. We also actively try to collaborate with other k8s community projects on tooling, for the betterment of all!
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
To contact the TrueCharts project:
-
Create an issue on Github issues
-
Open a Support Ticket
-
Send us an email
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 |
Contributors ✨
Thanks goes to these wonderful people (emoji key):
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 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
