2021-02-23 12:21:54 -05:00
{{- define "custom.repository.organization" -}}
TrueCharts
{{- end -}}
{{- define "custom.repository.url" -}}
2022-07-19 07:53:25 -04:00
https://github.com/truecharts/charts
2021-02-23 12:21:54 -05:00
{{- end -}}
{{- define "custom.helm.url" -}}
2022-08-02 05:23:26 -04:00
https://charts.truecharts.org
2021-02-23 12:21:54 -05:00
{{- end -}}
{{- define "custom.helm.path" -}}
{{ template "custom.repository.organization" . }} / {{ template "chart.name" . }}
{{- end -}}
{{- define "custom.notes" -}}
2022-07-19 07:53:25 -04:00
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.
2022-07-22 12:19:56 -04:00
For more information, please click here: [ {{ template "chart.name" . }} ](https://truecharts.org/docs/charts/stable/ {{ template "chart.name" . }} )
2022-07-19 07:53:25 -04:00
2022-07-22 12:19:56 -04:00
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
2021-02-23 12:21:54 -05:00
{{- end -}}
{{- define "custom.requirements" -}}
## Requirements
{{ template "chart.kubeVersionLine" . }}
{{- end -}}
{{- define "custom.dependencies" -}}
## Dependencies
{{ template "chart.requirementsTable" . }}
{{- end -}}
{{- define "custom.install" -}}
## Installing the Chart
2022-07-19 07:16:03 -04:00
### TrueNAS SCALE
2022-08-08 17:57:58 -04:00
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Installing-an-App).
2022-07-19 07:16:03 -04:00
### Helm
To install the chart with the release name ` {{ template "chart.name" . }} `
```console
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
helm repo update
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
```
2021-02-23 12:21:54 -05:00
{{- end -}}
{{- define "custom.uninstall" -}}
2022-07-19 07:16:03 -04:00
## Uninstall
2022-07-19 07:16:16 -04:00
2022-07-19 07:16:03 -04:00
### TrueNAS SCALE
**Upgrading, Rolling Back and Uninstalling the Chart**
2021-02-23 12:21:54 -05:00
2022-08-08 17:57:58 -04:00
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Upgrade-rollback-delete-an-App).
2022-07-19 07:16:03 -04:00
2022-07-19 07:16:16 -04:00
### Helm
2022-07-19 07:16:03 -04:00
To uninstall the ` {{ template "chart.name" . }} ` deployment
```console
helm uninstall {{ template "chart.name" . }}
```
2021-02-23 12:21:54 -05:00
{{- end -}}
2022-07-19 07:53:25 -04:00
{{- 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" -}}
2022-08-08 17:57:58 -04:00
#### Configure using the command line
2022-07-11 17:13:55 -04:00
2022-07-19 07:53:25 -04:00
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 -}}
2022-07-12 12:54:35 -04:00
{{- define "custom.linking" -}}
2022-08-08 17:57:58 -04:00
#### Connecting to other charts
2022-07-19 07:16:03 -04:00
2022-08-08 17:57:58 -04:00
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/linking-apps) quick-start guide.
2022-07-11 17:13:55 -04:00
{{- end -}}
2021-02-23 12:21:54 -05:00
{{- define "custom.support" -}}
## Support
2022-07-19 07:16:03 -04:00
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Important-MUST-READ).
- See the [Website](https://truecharts.org)
2021-08-19 05:38:55 -04:00
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
2021-03-17 12:20:26 -04:00
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
{{- end -}}
2022-07-19 07:53:25 -04:00
{{- 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 -}}
2021-03-17 12:20:26 -04:00
{{- define "custom.copyright" -}}
All Rights Reserved - The TrueCharts Project
2021-02-23 12:21:54 -05:00
{{- end -}}
2022-07-19 08:03:28 -04:00
{{ template "chart.header" . }}
{{ template "chart.versionBadge" . }} {{ template "chart.typeBadge" . }} {{ template "chart.appVersionBadge" . }}
2021-02-23 12:21:54 -05:00
{{ template "chart.description" . }}
2021-08-19 05:55:12 -04:00
{{ template "chart.deprecationWarning" . }}
2021-02-23 12:21:54 -05:00
{{ template "custom.notes" . }}
{{ template "chart.sourcesSection" . }}
{{ template "custom.requirements" . }}
{{ template "custom.dependencies" . }}
{{ template "custom.install" . }}
{{ template "custom.uninstall" . }}
2022-07-19 07:53:25 -04:00
{{ template "custom.configuration.header" . }}
{{ template "custom.configuration.readValues" . }}
{{ template "custom.configuration.example.set" . }}
{{ template "custom.configuration.example.file" . }}
2022-07-11 17:13:55 -04:00
{{ template "custom.linking" . }}
2021-02-23 12:21:54 -05:00
{{ template "custom.support" . }}
2022-07-12 16:38:48 -04:00
2022-07-19 07:53:25 -04:00
---
{{ template "custom.sponsors" . }}
2021-08-31 05:20:18 -04:00
---
2022-07-12 16:38:48 -04:00
2021-03-17 12:20:26 -04:00
{{ template "custom.copyright" . }}