TrueChartsClone/.github

TrueCharts:
Community App Catalog for TrueNAS SCALE

Truecharts is an innitiative to provide high quality Apps to use with the TrueNAS SCALE App Ecosystem. Our primary goals are:

• Freedom
• Stability
• Consistancy

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, still requires the CLI. However it's not hard:

• Go to you shell of choice (either SSH or the TrueNAS webui shell)
• enter cli
• enter app catalog create repository="https://github.com/truecharts/truecharts" label="TrueCharts"

FAQ

• Q: Isn't there more documentation for app x
  A: No, currently during TrueNAS SCALE ALPHA/BETA we focus on the technical aspects.

• Q: Function x doesn't seem to be working, should it be working?
  A: Maybe, please file an issue

• Q: I'm missing a lot of configuration opions in the install GUI.
  A: We try to aim for a balance in the amount of options vs the simplicity of installation. Suggestions are always welcome

• Q: The portal button isn't working.
  A: Portal buttons are current't not implemented very well and are considered "not supported" for the time being

Getting into creating Apps

Creating charts takes some getting used to, as it's based on Helm charts. We highly suggest prior knowhow on creation/modifying Helm Charts, before taking on the challenge of creating SCALE Apps.

The specifications of TrueNAS SCALE apps, is layed out in the wiki

Licence

SPDX-License-Identifier: BSD-3-Clause

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