Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/.github/README.md

45 lines
2.9 KiB
Markdown
Raw Normal View History

Update README.md
2021-03-11 11:11:26 +00:00
# About TrueCharts<br>
Docs rework fase 2 (#182) * move faq to seperate file * Slight tweaking and adding license file(s) to wiki * Update README.md * Port git guide from UnityStation * Rename Ingress to Reverse Proxy Fixes #183 * Prefer central templates * Add initial information about Storage * Port Chart structure info from TrueNAS/charts readme * Create and document standardised Chart.yaml layout * update tautulli version * Add custom liveness probes for sonarr, radarr, lidarr and readarr * Add Maintainers Wanted page * Update existing Chart.yaml files
2021-02-25 16:09:50 +00:00
**Community App Catalog for TrueNAS SCALE**
Update project documentation
2020-12-30 20:38:12 +00:00
Update README.md
2021-03-03 14:22:26 +00:00
[![GitHub last commit](https://img.shields.io/github/last-commit/truecharts/truecharts/master.svg)](https://github.com/truecharts/truecharts/commits) [![Charts: Release](https://github.com/truecharts/charts/actions/workflows/charts-release.yaml/badge.svg)](https://github.com/truecharts/charts/actions/workflows/charts-release.yaml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts?ref=badge_shield) [![License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/truecharts/truecharts/blob/master/docs/LICENSE.BSD3)
Docs rework fase 2 (#182) * move faq to seperate file * Slight tweaking and adding license file(s) to wiki * Update README.md * Port git guide from UnityStation * Rename Ingress to Reverse Proxy Fixes #183 * Prefer central templates * Add initial information about Storage * Port Chart structure info from TrueNAS/charts readme * Create and document standardised Chart.yaml layout * update tautulli version * Add custom liveness probes for sonarr, radarr, lidarr and readarr * Add Maintainers Wanted page * Update existing Chart.yaml files
2021-02-25 16:09:50 +00:00
---
Update project documentation
2020-12-30 20:38:12 +00:00
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
update the readme with installation instructions
2021-02-08 13:06:07 +00:00
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"`
Update project documentation
2020-12-30 20:38:12 +00:00
Add wiki to readme
2021-02-22 15:07:09 +00:00
For more information, please visit our wiki:
https://wiki.truecharts.org
update the readme with installation instructions
2021-02-08 13:06:07 +00:00
## FAQ
add general QA warning about portal buttons
2021-02-09 10:50:03 +00:00
Fix FAQ link, add issue tracker link (#226) The previous faq url points to a 404 page. Also added a link to the Github issue tracker.
2021-03-06 10:42:32 +00:00
Please refer to our [FAQ](https://wiki.truecharts.org/FAQ) and [Issue tracker](https://github.com/truecharts/charts/issues) before creating an issue.
Docs rework fase 2 (#182) * move faq to seperate file * Slight tweaking and adding license file(s) to wiki * Update README.md * Port git guide from UnityStation * Rename Ingress to Reverse Proxy Fixes #183 * Prefer central templates * Add initial information about Storage * Port Chart structure info from TrueNAS/charts readme * Create and document standardised Chart.yaml layout * update tautulli version * Add custom liveness probes for sonarr, radarr, lidarr and readarr * Add Maintainers Wanted page * Update existing Chart.yaml files
2021-02-25 16:09:50 +00:00
There is a significant chance your issue has been reported before!
Readme: Add explaination about sabnzbd and passwords
2021-02-17 11:38:14 +00:00
Update project documentation
2020-12-30 20:38:12 +00:00
## 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.
## 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.
Add FOSSA tracker
2021-02-15 09:44:12 +00:00
Add License Info on a per-file basis
2021-03-03 13:56:22 +00:00
Some Apps may also contain parts in other licenses, such as libraries or templates, these files can be recognised by their individual headers.
Add FOSSA tracker
2021-02-15 09:44:12 +00:00
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts?ref=badge_large)
Docs rework fase 2 (#182) * move faq to seperate file * Slight tweaking and adding license file(s) to wiki * Update README.md * Port git guide from UnityStation * Rename Ingress to Reverse Proxy Fixes #183 * Prefer central templates * Add initial information about Storage * Port Chart structure info from TrueNAS/charts readme * Create and document standardised Chart.yaml layout * update tautulli version * Add custom liveness probes for sonarr, radarr, lidarr and readarr * Add Maintainers Wanted page * Update existing Chart.yaml files
2021-02-25 16:09:50 +00:00
---
![built-with-resentment](http://forthebadge.com/images/badges/built-with-resentment.svg) ![contains-technical-debt](http://forthebadge.com/images/badges/contains-technical-debt.svg)