History

kjeld Schouten-Lebbing d04709b0fb try 2 for fixing codeowners		2021-09-04 12:16:16 +02:00
..
ISSUE_TEMPLATE	Default title to a placeholder for the appname (#370 )	2021-04-16 22:51:14 +02:00
containerscan	Integrate Container and Website Repo's + docs restructure	2021-03-17 10:35:56 +01:00
workflows	bumps	2021-09-03 15:06:48 +02:00
CODEOWNERS	try 2 for fixing codeowners	2021-09-04 12:16:16 +02:00
CODE_OF_CONDUCT	Synced the CoC with Discord, added appeals, edited CoC to comply to community goals and updated contact details.	2021-09-03 14:39:45 +02:00
CONTRIBUTING	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
FUNDING.yml	Remove isohunt	2021-05-09 13:54:20 +02:00
PULL_REQUEST_TEMPLATE.md	Update PULL_REQUEST_TEMPLATE.md	2021-06-20 11:00:49 +02:00
README.md	update roadmap in readme	2021-08-30 16:33:12 +02:00
SECURITY.md	Post Code-Freeze Review, Bugsfixes and Documentation	2021-04-09 13:34:29 +02:00
SUPPORT.md	add 21.08 support docs	2021-08-28 15:39:58 +02:00
chart_schema.yaml	Add some more Apps to the incubator train (#553 )	2021-06-11 16:43:41 +02:00
cr.yaml	skip existing releases on CI (CR)	2021-06-14 12:35:06 +02:00
ct-install.yaml	remove unused chart repo's to decrease needless test failures.	2021-08-17 11:54:52 +02:00
ct-lint.yaml	remove unused chart repo's to decrease needless test failures.	2021-08-17 11:54:52 +02:00
renovate.json5	slight ranovate naming fix	2021-09-04 12:03:33 +02:00
stale.yml	Integrate Container and Website Repo's + docs restructure	2021-03-17 10:35:56 +01:00

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.

For more information: https://truecharts.org/manual/Quick-Start%20Guides/02-Adding-TrueCharts/

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 before this release"

Documentation and DNS - TrueNAS SCALE 21.10

We aim to improve our quick-start guides the comming few months and at the same time dail with DNS related Apps such as ExternalDNS

Email and VPN - TrueNAS SCALE 21.12

Our goal these months will be enabling users to run an Email server on their SCALE machine and allow using our software with VPN sidecards

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 discussion on GitHub Discussions
Send us an email
Or join our Discord server

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} 💻 🚇 📖	_{Justin Clift} 📖	_whiskerz007 💻	_{Stavros Kois} 💻 📖	_allen-4 💻	_{Troy Prelog} 💻 📖	_{Dan Sheridan} 💻
_{Sebastien Dupont} 📖	_Vegetto 👀	_{Luuk Nieuwdorp} 💻	_{Nate Walck} 💻	_Lloyd 💻	_{Dave Withnall} 📖	_ksimm1 📖

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