# TrueCharts **Community Chart Catalog for TrueNAS SCALE** [![docs](https://img.shields.io/badge/docs-rtfm-yellow?logo=gitbook&logoColor=white&style=for-the-badge)](https://truecharts.org/) [![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=for-the-badge)](https://discord.gg/Js6xv9nGuU) [![GitHub last commit](https://img.shields.io/github/last-commit/truecharts/charts?color=brightgreen&logoColor=white&style=for-the-badge)](https://github.com/truecharts/charts/commits) --- TrueCharts is a catalog of highly optimised TrueNAS SCALE Charts. Made for the community, By the community! Our primary goals are: - Micro-Service Centered - Native Kubernetes - Stability - Consistency All our charts 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 [![docs](https://img.shields.io/badge/docs-rtfm-yellow?logo=gitbook&logoColor=white&style=for-the-badge)](https://truecharts.org/) --- Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list. Check TrueCharts [Quick-Start Guides](https://truecharts.org/docs/manual/SCALE%20Apps/Adding-TrueCharts) for more information. ### Support Please check our [FAQ](https://truecharts.org/docs/about/intro), [manual](https://truecharts.org/docs/manual/SUPPORT/) and [Issue tracker](https://github.com/truecharts/charts/issues) There is a significant chance your issue has been reported before! Still something not working as expected? [Contact us!](https://truecharts.org/docs/about/contact/) 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 Charts, 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 Chart changes_
## Development [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge)](https://github.com/pre-commit/pre-commit) [![renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjUgNSAzNzAgMzcwIj48Y2lyY2xlIGN4PSIxODkiIGN5PSIxOTAiIHI9IjE4NCIgZmlsbD0iI2ZlMiIvPjxwYXRoIGZpbGw9IiM4YmIiIGQ9Ik0yNTEgMjU2bC0zOC0zOGExNyAxNyAwIDAxMC0yNGw1Ni01NmMyLTIgMi02IDAtN2wtMjAtMjFhNSA1IDAgMDAtNyAwbC0xMyAxMi05LTggMTMtMTNhMTcgMTcgMCAwMTI0IDBsMjEgMjFjNyA3IDcgMTcgMCAyNGwtNTYgNTdhNSA1IDAgMDAwIDdsMzggMzh6Ii8+PHBhdGggZmlsbD0iI2Q1MSIgZD0iTTMwMCAyODhsLTggOGMtNCA0LTExIDQtMTYgMGwtNDYtNDZjLTUtNS01LTEyIDAtMTZsOC04YzQtNCAxMS00IDE1IDBsNDcgNDdjNCA0IDQgMTEgMCAxNXoiLz48cGF0aCBmaWxsPSIjYjMwIiBkPSJNMjg1IDI1OGw3IDdjNCA0IDQgMTEgMCAxNWwtOCA4Yy00IDQtMTEgNC0xNiAwbC02LTdjNCA1IDExIDUgMTUgMGw4LTdjNC01IDQtMTIgMC0xNnoiLz48cGF0aCBmaWxsPSIjYTMwIiBkPSJNMjkxIDI2NGw4IDhjNCA0IDQgMTEgMCAxNmwtOCA3Yy00IDUtMTEgNS0xNSAwbC05LThjNSA1IDEyIDUgMTYgMGw4LThjNC00IDQtMTEgMC0xNXoiLz48cGF0aCBmaWxsPSIjZTYyIiBkPSJNMjYwIDIzM2wtNC00Yy02LTYtMTctNi0yMyAwLTcgNy03IDE3IDAgMjRsNCA0Yy00LTUtNC0xMSAwLTE2bDgtOGM0LTQgMTEtNCAxNSAweiIvPjxwYXRoIGZpbGw9IiNiNDAiIGQ9Ik0yODQgMzA0Yy00IDAtOC0xLTExLTRsLTQ3LTQ3Yy02LTYtNi0xNiAwLTIybDgtOGM2LTYgMTYtNiAyMiAwbDQ3IDQ2YzYgNyA2IDE3IDAgMjNsLTggOGMtMyAzLTcgNC0xMSA0em0tMzktNzZjLTEgMC0zIDAtNCAybC04IDdjLTIgMy0yIDcgMCA5bDQ3IDQ3YTYgNiAwIDAwOSAwbDctOGMzLTIgMy02IDAtOWwtNDYtNDZjLTItMi0zLTItNS0yeiIvPjxwYXRoIGZpbGw9IiMxY2MiIGQ9Ik0xNTIgMTEzbDE4LTE4IDE4IDE4LTE4IDE4em0xLTM1bDE4LTE4IDE4IDE4LTE4IDE4em0tOTAgODlsMTgtMTggMTggMTgtMTggMTh6bTM1LTM2bDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMxZGQiIGQ9Ik0xMzQgMTMxbDE4LTE4IDE4IDE4LTE4IDE4em0tMzUgMzZsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzJiYiIgZD0iTTExNiAxNDlsMTgtMTggMTggMTgtMTggMTh6bTU0LTU0bDE4LTE4IDE4IDE4LTE4IDE4em0tODkgOTBsMTgtMTggMTggMTgtMTggMTh6bTEzOS04NWwyMyAyM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTI0LTI0Yy00LTQtNC0xMSAwLTE1bDEwMS0xMDFjNS01IDEyLTUgMTYgMHoiLz48cGF0aCBmaWxsPSIjM2VlIiBkPSJNMTM0IDk1bDE4LTE4IDE4IDE4LTE4IDE4em0tNTQgMThsMTgtMTcgMTggMTctMTggMTh6bTU1LTUzbDE4LTE4IDE4IDE4LTE4IDE4em05MyA0OGwtOC04Yy00LTUtMTEtNS0xNiAwTDEwMyAyMDFjLTQgNC00IDExIDAgMTVsOCA4Yy00LTQtNC0xMSAwLTE1bDEwMS0xMDFjNS00IDEyLTQgMTYgMHoiLz48cGF0aCBmaWxsPSIjOWVlIiBkPSJNMjcgMTMxbDE4LTE4IDE4IDE4LTE4IDE4em01NC01M2wxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjMGFhIiBkPSJNMjMwIDExMGwxMyAxM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTEzLTEzYzQgNCAxMSA0IDE1IDBsMTAxLTEwMWM1LTUgNS0xMSAwLTE2eiIvPjxwYXRoIGZpbGw9IiMxYWIiIGQ9Ik0xMzQgMjQ4Yy00IDAtOC0yLTExLTVsLTIzLTIzYTE2IDE2IDAgMDEwLTIzTDIwMSA5NmExNiAxNiAwIDAxMjIgMGwyNCAyNGM2IDYgNiAxNiAwIDIyTDE0NiAyNDNjLTMgMy03IDUtMTIgNXptNzgtMTQ3bC00IDItMTAxIDEwMWE2IDYgMCAwMDAgOWwyMyAyM2E2IDYgMCAwMDkgMGwxMDEtMTAxYTYgNiAwIDAwMC05bC0yNC0yMy00LTJ6Ii8+PC9zdmc+)](https://github.com/renovatebot/renovate) [![GitHub last commit](https://img.shields.io/github/last-commit/truecharts/charts?color=brightgreen&logoColor=white&style=for-the-badge)](https://github.com/truecharts/charts/commits) --- 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 Chart installed. ### Getting into creating Charts 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](https://truecharts.org/docs/manual/development/License-headers) ### 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 [![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=for-the-badge)](https://discord.gg/tVsPTHWTtr) --- To contact the TrueCharts project: - Create an issue on [Github issues](https://github.com/truecharts/charts/issues) - Open a [Support Ticket](https://discord.com/channels/830763548678291466/936275413179723826) - Send us an [email](mailto://info@truecharts.org) - Or [join our Discord server](https://discord.gg/tVsPTHWTtr)

## 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 ✨ [![All Contributors](https://img.shields.io/badge/all_contributors-128-orange.svg?style=for-the-badge)](#contributors) Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): ---

_{Kjeld Schouten-Lebbing} 💻 🚇 📖 👀 💵	_{Justin Clift} 📖	_whiskerz007 💻	_{Stavros Kois} 💻 📖 🐛 👀 💵	_allen-4 💻	_{Troy Prelog} 💻 📖 💵	_{Dan Sheridan} 💻
_{Sebastien Dupont} 📖 💵	_Vegetto 👀	_{Ellie Nieuwdorp} 💻	_{Nate Walck} 💻	_Lloyd 💻 💵	_{Dave Withnall} 📖	_ksimm1 📖 🐛 💵 🧑‍🏫
_{Aaron Johnson} 📖	_Ralph 💻	_{Joachim Baten} 💻 🐛	_{Michael Yang} 💻	_{Ciaran Farley} 📖	_{Heavybullets8} 📖 💻 🐛 📹 🧑‍🏫 💵	₆₆₂ 💻
_alex171 📖	_{Techno Tim} 📖	_{Mingyao Liu} 💻 🐛	_NightShaman 💻 📖 🐛 💵 🧑‍🏫	_{Andrew Smith} 📖 ⚠️	_{Bob Klosinski} 💻	_Sukarn 💻 📖
_sebs 💻	_{Dyllan Tinoco} 💻	_{StevenMcElligott} 💻 💵 📖 🐛 🧑‍🏫	_brothergomez 💻 🐛	_sagit 💻 🐛 📹 📖 🧑‍🏫	_{Nevan Chow} 💻	_{Daniel Carlsson} 🐛
_{Devon Louie} 🐛	_{Alex-Orsholits} 🐛	_Tails32 🐛	_Menaxerius 🐛	_hidefog 🐛	_{Darren Gibbard} 🐛	_Barti 🐛
_Sunii 🐛	_trbmchs 🐛	_Light 🐛	_Boostflow 🐛	_Trigardon 🐛	_dbb12345 🐛 💻	_karypid 🐛
_Philipp 🐛	_John 🐛	_{John Parton} 🐛	_Marc 🐛	_fdzaebel 🐛	_kloeckwerx 🐛	_{Bradley Bare} 🐛
_{Alexander Thamm} 🐛	_rexit1982 🐛	_iaxx 🐛	_Xstar97 🐛 💻 🧑‍🏫	_ornias 📹	_{Josh Asplund} 💵	_{midnight33233} 💵
_kbftech 💵	_hogenf 💵	_Hawks 💵	_{Jim Russell} 💵	_TheGovnah 💵	_famewolf 💵 🐛	_{Konrad Bujak} 📖
_190n 💻 📖	_{Alexej Kubarev} 📖	_r-vanooyen 📖	_shadofall 📖 🧑‍🏫	_agreppin 💻	_{Stavros Ntentos} 💻 🤔	_{Vlad-Florin Ilie} 💻
_huma2000 🐛	_hugalafutro 🐛 💵	_{yehia Amer} 📖	_{Tyler Stransky} 🐛	_juggie 🐛	_{Ben Tilford} 🐛 💻	_I-nebukad-I 🐛 💻
_{Ethan Leisinger} 💻 📖	_{Cullen Murphy} 💻 🐛	_{Jason Thatcher} 💻 🐛 📖	_{Stefan Schramek} 🐛	_nokaka 🐛	_{Gal Szkolnik} 🐛	_{Evgeny Stepanovych} 🐛
_{Waqar Ahmed} 🐛	_DrSKiZZ 💵	_{Jan Puciłowski} 💻 ⚠️	_{Shaun Coyne} 💵	_Christoph 💵	_{Brandon Rutledge} 🐛	_{Michael Bestas} 🐛
_{Jurģis Rudaks} 🐛	_brunofatia 💵	_TopicsLP 📖	_{Michael Schnerring} 🐛 💻	_{Tamas Nagy} 🐛	_{OpenSpeedTest™️} 💻	_{Richard James Acton} 📖
_lps-rocks 🐛	_Faust 🐛	_uranderu 🐛	_{Tom Cassady} 🐛	_Huftierchen 🐛	_ZasX 📖 🧑‍🏫	_{Kevin T.} 🐛
_{Steven Scott} 📖	_{Watteel Pascal} 💻	_{JamesOsborn-SE} 💻 📖	_NeoToxic 🧑‍🏫	_jab416171 📖	_Anna 📖	_ChaosBlades 🐛
_{Patric Stout} 💻	_{Ben Kochie} 💻	_{Jeff Bachtel} 📖	_{Ben Woods} 💻	_{Karl Shea} 🐛	_{Balakumaran MN} 📖	_Jesperbelt 📖
_cccs31 🐛	_{Sam Smucny} 💻	_{Keith Cirkel} 💻

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## Licence [![License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg?style=for-the-badge)](https://github.com/truecharts/charts/blob/master/docs/LICENSE.BSD3) --- Truecharts, is primarily based on a BSD-3-clause license, this ensures almost everyone can use and modify our charts. As a lot of Charts are based on upstream Helm Charts, Licences can vary on a per-Chart basis. This can easily be seen by the presence of a "LICENSE" file in said folder. An exception to this, has been made for every document inside folders labeled as `docs` or `doc` and their subfolders: those folders are not licensed under BSD-3-clause and are considered "all rights reserved". Said content can be modified and changes submitted per PR, in accordance to the github End User License Agreement. `SPDX-License-Identifier: BSD-3-Clause` --- ![built-with-resentment](http://forthebadge.com/images/badges/built-with-resentment.svg) ![contains-technical-debt](http://forthebadge.com/images/badges/contains-technical-debt.svg)