diff --git a/.github/scripts/build-catalog.sh b/.github/scripts/build-catalog.sh index 4d06595c699..52c11c5819f 100755 --- a/.github/scripts/build-catalog.sh +++ b/.github/scripts/build-catalog.sh @@ -223,7 +223,12 @@ patch_apps() { # Generate SCALE App description file cat ${target}/Chart.yaml | yq .description -r >> ${target}/app-readme.md echo "" >> ${target}/app-readme.md - echo "This App is supplied by TrueCharts, for more information please visit https://truecharts.org" >> ${target}/app-readme.md + echo "This App is supplied by TrueCharts, for more information visit https://truecharts.org" >> ${target}/app-readme.md + echo "" >> ${target}/app-readme.md + echo "---" >> ${target}/app-readme.md + echo "" >> ${target}/app-readme.md + echo "TrueCharts can only exist due to the incredible effort of our staff." >> ${target}/app-readme.md + echo "Please consider making a [donation](https://truecharts.org/docs/about/sponsor) or contributing back to the project any way you can!" >> ${target}/app-readme.md } export -f patch_apps diff --git a/templates/docs/README.md.gotmpl b/templates/docs/README.md.gotmpl index 0d966a65b03..71eb418cd96 100644 --- a/templates/docs/README.md.gotmpl +++ b/templates/docs/README.md.gotmpl @@ -5,16 +5,20 @@ TrueCharts {{- end -}} {{- define "custom.repository.url" -}} -https://github.com/truecharts/apps +https://github.com/truecharts/charts {{- end -}} {{- define "custom.helm.url" -}} -https://truecharts.org +https://helm.truecharts.org {{- end -}} {{- define "custom.helm.path" -}} {{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} {{- end -}} {{- define "custom.notes" -}} -TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE. Please refer to your specific platform for more detailed instructions. +TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE. + +This readme is just an automatically generated general guide on installing our Helm Charts and Apps. +For more information, please click here: [{{ template "chart.name" . }}](https://truecharts.org/charts/stable/{{ template "chart.name" . }}) + **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)** {{- end -}} {{- define "custom.requirements" -}} @@ -61,13 +65,43 @@ To uninstall the `{{ template "chart.name" . }}` deployment helm uninstall {{ template "chart.name" . }} ``` {{- end -}} +{{- define "custom.configuration.header" -}} +## Configuration +### Helm + +{{- end -}} +{{- define "custom.configuration.readValues" -}} +#### Available Settings + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). +{{- end -}} +{{- define "custom.configuration.example.set" -}} +#### Configure using the Commandline + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} +{{- define "custom.configuration.example.file" -}} +#### Configure using a yaml file + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} {{- define "custom.linking" -}} #### Connecting to other apps If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our [Linking Apps Internally](https://truecharts.org/manual/Quick-Start%20Guides/06-linking-apps/) quick-start guide. {{- end -}} - {{- define "custom.support" -}} ## Support @@ -76,6 +110,12 @@ If you need to connect this App to other Apps on TrueNAS SCALE, please refer to - Check our [Discord](https://discord.gg/tVsPTHWTtr) - Open a [issue](https://github.com/truecharts/apps/issues/new/choose) {{- end -}} +{{- define "custom.sponsors" -}} +## Sponsor TrueCharts + +TrueCharts can only exist due to the incredible effort of our staff. +Please consider making a [donation](https://truecharts.org/docs/about/sponsor) or contributing back to the project any way you can! +{{- end -}} {{- define "custom.copyright" -}} All Rights Reserved - The TrueCharts Project {{- end -}} @@ -97,10 +137,25 @@ All Rights Reserved - The TrueCharts Project {{ template "custom.uninstall" . }} +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + {{ template "custom.linking" . }} {{ template "custom.support" . }} + +--- + +{{ template "custom.sponsors" . }} + --- {{ template "custom.copyright" . }}