Community Helm Chart Repository
Go to file
truecharts-bot d182fa2a67 chore: Auto-update chart README [skip ci] 2022-09-29 07:22:22 +00:00
.chglog fix(docs): fix links (#3362) 2022-08-08 23:57:58 +02:00
.devcontainer fix(lancache): fix port assignments (#3798) 2022-09-25 21:46:16 +02:00
.github chore(deps): update renovatebot/github-action action to v32.208.2 2022-09-29 09:05:07 +02:00
.vscode run prettier as pre-commit hook (#3264) 2022-07-22 20:23:01 +02:00
charts chore: Auto-update chart README [skip ci] 2022-09-29 07:22:22 +00:00
templates chore(deps): update helm chart common to v10.6.5 (#3947) 2022-09-28 22:58:36 +03:00
test add empty tests 2022-03-30 10:57:47 +02:00
tools Update build-release.sh 2022-09-27 12:15:58 +02:00
.all-contributorsrc docs: add karlshea as a contributor for bug (#3933) 2022-09-27 23:29:28 +03:00
.editorconfig Add EditorConfig (#3126) 2022-07-11 11:40:59 +02:00
.gitignore update gitignore 2022-09-27 22:15:37 +02:00
.helmdocsignore
.markdownlint.yaml chore(docs): extend linter and apply lint (#3200) 2022-07-17 13:14:52 +02:00
.pre-commit-config.yaml whoops 2022-07-22 20:33:57 +02:00
.snyk feat(ci): add snyk ignore 2021-12-03 17:32:03 +01:00
CNAME
Gemfile (tests) move back to ruby based tests (#1051) 2021-09-28 15:11:36 +02:00
LICENSE
NOTICE
cspell.config.yaml feat(immich): add immich (#3942) 2022-09-29 01:08:30 +03:00

.github/README.md

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:



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

📖

Ben Woods

💻

Karl Shea

🐛

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