|
|
|
@@ -1,14 +1,14 @@
|
|
|
|
|
# TrueCharts
|
|
|
|
|
|
|
|
|
|
**Community App Catalog for TrueNAS SCALE**
|
|
|
|
|
**Community Chart Catalog for TrueNAS SCALE**
|
|
|
|
|
|
|
|
|
|
[](https://truecharts.org/)
|
|
|
|
|
[](https://discord.gg/Js6xv9nGuU)
|
|
|
|
|
[](https://github.com/truecharts/apps/commits)
|
|
|
|
|
[](https://github.com/truecharts/charts/commits)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
TrueCharts is a catalog of highly optimised TrueNAS SCALE Apps. Made for the community, By the community!
|
|
|
|
|
TrueCharts is a catalog of highly optimised TrueNAS SCALE Charts. Made for the community, By the community!
|
|
|
|
|
|
|
|
|
|
Our primary goals are:
|
|
|
|
|
|
|
|
|
@@ -20,7 +20,7 @@ Our primary goals are:
|
|
|
|
|
|
|
|
|
|
- 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.
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
@@ -54,13 +54,13 @@ _The current project is hitting internal performance issues, for this reason we
|
|
|
|
|
|
|
|
|
|
**Refactor the Common Chart - TrueNAS SCALE "Bluefin" 22.xx ALPHA 2**
|
|
|
|
|
|
|
|
|
|
_The shared Common (chart) basis, used by all our Apps, needs some significant code cleanup. Primarily all code needs to follow a standardised format and comply to the same standard_
|
|
|
|
|
_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_
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
**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 App changes_
|
|
|
|
|
_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_
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
@@ -68,18 +68,18 @@ _With most parts of our project somewhat cleaned up, we need to work on increasi
|
|
|
|
|
|
|
|
|
|
[](https://github.com/pre-commit/pre-commit)
|
|
|
|
|
[](https://github.com/renovatebot/renovate)
|
|
|
|
|
[](https://github.com/truecharts/apps/commits)
|
|
|
|
|
[](https://github.com/truecharts/charts/commits)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
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 Apps
|
|
|
|
|
### 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](https://truecharts.org/)
|
|
|
|
|
For more information on creating SCALE Apps and Helm charts, please check out our [development manual](https://truecharts.org/docs/manual/development/License-headers)
|
|
|
|
|
|
|
|
|
|
### Automation and you
|
|
|
|
|
|
|
|
|
@@ -97,13 +97,13 @@ Those tools do, however, take time to develop and are certainly not bug free. If
|
|
|
|
|
|
|
|
|
|
To contact the TrueCharts project:
|
|
|
|
|
|
|
|
|
|
- Create an issue on [Github issues](https://github.com/truecharts/apps/issues)
|
|
|
|
|
- Create an issue on [Github issues](https://github.com/truecharts/charts/issues)
|
|
|
|
|
|
|
|
|
|
- Open a [Support Ticket](https://truecharts.org/discord)
|
|
|
|
|
- Open a [Support Ticket](https://discord.com/channels/830763548678291466/936275413179723826)
|
|
|
|
|
|
|
|
|
|
- Send us an [email](mailto://info@truecharts.org)
|
|
|
|
|
|
|
|
|
|
- Or [join our Discord server](https://truecharts.org/discord)
|
|
|
|
|
- Or [join our Discord server](https://discord.gg/tVsPTHWTtr)
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
@@ -294,13 +294,13 @@ This project follows the [all-contributors](https://github.com/all-contributors/
|
|
|
|
|
|
|
|
|
|
## Licence
|
|
|
|
|
|
|
|
|
|
[](https://github.com/truecharts/apps/blob/master/docs/LICENSE.BSD3)
|
|
|
|
|
[](https://github.com/truecharts/charts/blob/master/docs/LICENSE.BSD3)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
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 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 the Chart 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.
|
|
|
|
|
Some Charts 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`
|
|
|
|
|
|
|
|
|
|