Skip to content

raynay-r/truecharts-charts

Β 
Β 

Repository files navigation

TrueCharts

Community Chart Catalog for TrueNAS SCALE

docs Discord GitHub last commit


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


Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list.

Check TrueCharts Quick-Start Guides for more information.

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 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 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 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

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:



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

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

πŸ‘€

Ellie Nieuwdorp

πŸ’»

Nate Walck

πŸ’»

Lloyd

πŸ’» πŸ’΅

Dave Withnall

πŸ“–

ksimm1

πŸ“– πŸ› πŸ’΅ πŸ§‘β€πŸ«

Aaron Johnson

πŸ“–

Ralph

πŸ’»

Joachim Baten

πŸ’» πŸ›

Michael Yang

πŸ’»

Ciaran Farley

πŸ“–

Heavybullets8

πŸ“– πŸ’» πŸ› πŸ“Ή πŸ§‘β€πŸ« πŸ’΅

662

πŸ’»

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

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

Licence

License


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 contains-technical-debt

About

Community App Catalog for TrueNAS SCALE

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Smarty 84.8%
  • Shell 14.5%
  • Other 0.7%