Community Helm Chart Repository
Go to file
kjeld Schouten-Lebbing a04ae5ebc1
revert some changes
2021-09-07 14:09:49 +02:00
.github revert some changes 2021-09-07 14:09:49 +02:00
.vs KAH Port project (#635) 2021-07-01 20:26:22 +02:00
.vscode port most recent changes from KAH (#478) 2021-05-19 20:51:35 +02:00
charts chore(deps): update container image mikenye/piaware to v6.0 (#914) 2021-09-07 12:54:19 +02:00
containers fix another mistake in release container 2021-09-07 13:30:15 +02:00
docs Daily Housekeeping 2021-09-07 03:11:33 +00:00
promo upload artwork 2021-08-07 13:28:24 +02:00
templates Fix copyright header and common docs copying 2021-08-31 12:21:54 +02:00
tests/helmunit port most recent changes from KAH (#478) 2021-05-19 20:51:35 +02:00
tools cleanup tools, templates and workflows 2021-08-19 11:47:00 +02:00
.all-contributorsrc docs: add ksimm1 as a contributor (#441) 2021-05-06 19:36:35 +02:00
.devcontainer.json fix devcontainer build process 2021-05-30 13:28:06 +02:00
.gitignore Restructure repo to be a little cleaner (#445) 2021-05-09 18:11:00 +02:00
.helmdocsignore Cleanup, Fixes and Review Feedback 2021-03-12 17:18:46 +01:00
.pre-commit-config.yaml [] Update precommit hook pre-commit/pre-commit-hooks to v4 (#489) 2021-05-23 23:07:40 +02:00
CNAME Create CNAME 2021-03-17 12:44:06 +01:00
LICENSE Update LICENSE 2021-02-22 14:07:43 +01:00
NOTICE Add Notice file and seperate "legal" docs catagory 2021-03-03 12:28:56 +01:00
go.mod Bump helm.sh/helm/v3 from 3.5.4 to 3.6.1 (#721) 2021-07-27 20:04:26 +02:00
go.sum Bump helm.sh/helm/v3 from 3.5.4 to 3.6.1 (#721) 2021-07-27 20:04:26 +02:00
index.yaml Update index.yaml 2021-09-07 10:59:11 +00:00
mkdocs.yml Change colors 2021-08-08 14:35:40 +02:00

.github/README.md

TrueCharts

Community App Catalog for TrueNAS SCALE

docs Discord GitHub last commit


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

docs


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

pre-commit renovate GitHub last commit


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

Discord


To contact the TrueCharts project:



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

All 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

License


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


built-with-resentment contains-technical-debt