698622495c
**Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._
157 lines
4.7 KiB
Go Template
157 lines
4.7 KiB
Go Template
{{- define "custom.repository.organization" -}}
|
|
TrueCharts
|
|
{{- end -}}
|
|
{{- define "custom.repository.url" -}}
|
|
https://github.com/truecharts/charts
|
|
{{- end -}}
|
|
{{- define "custom.helm.url" -}}
|
|
https://charts.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.
|
|
|
|
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/TRAINPLACEHOLDER/{{ 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/charts/issues/new/choose)**
|
|
{{- end -}}
|
|
{{- define "custom.requirements" -}}
|
|
## Requirements
|
|
|
|
{{ template "chart.kubeVersionLine" . }}
|
|
{{- end -}}
|
|
{{- define "custom.dependencies" -}}
|
|
## Dependencies
|
|
|
|
{{ template "chart.requirementsTable" . }}
|
|
{{- end -}}
|
|
{{- define "custom.install" -}}
|
|
## Installing the Chart
|
|
|
|
### TrueNAS SCALE
|
|
|
|
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/SCALE/guides/scale-intro).
|
|
|
|
### 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" . }}
|
|
```
|
|
{{- end -}}
|
|
{{- define "custom.uninstall" -}}
|
|
## Uninstall
|
|
|
|
### TrueNAS SCALE
|
|
|
|
**Upgrading, Rolling Back and Uninstalling the Chart**
|
|
|
|
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/SCALE/guides/scale-intro).
|
|
|
|
### Helm
|
|
|
|
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
|
|
```console
|
|
helm uninstall {{ template "chart.name" . }}
|
|
```
|
|
{{- end -}}
|
|
{{- define "custom.configuration.header" -}}
|
|
## Configuration
|
|
|
|
### Helm
|
|
|
|
{{- end -}}
|
|
{{- define "custom.configuration.readValues" -}}
|
|
#### Available Settings
|
|
|
|
Read through the 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/truecharts/library-charts/tree/main/charts/common).
|
|
{{- end -}}
|
|
{{- define "custom.configuration.example.set" -}}
|
|
#### Configure using the command line
|
|
|
|
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 charts
|
|
|
|
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Apps Internally](https://truecharts.org/manual/SCALE/guides/linking-apps) quick-start guide.
|
|
{{- end -}}
|
|
{{- define "custom.support" -}}
|
|
## Support
|
|
|
|
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/manual/SCALE/guides/scale-intro).
|
|
- See the [Website](https://truecharts.org)
|
|
- 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/sponsor) or contributing back to the project any way you can!
|
|
{{- end -}}
|
|
{{- define "custom.copyright" -}}
|
|
All Rights Reserved - The TrueCharts Project
|
|
{{- end -}}
|
|
{{ template "chart.header" . }}
|
|
|
|
{{ template "chart.description" . }}
|
|
|
|
{{ template "chart.deprecationWarning" . }}
|
|
|
|
{{ template "custom.notes" . }}
|
|
|
|
{{ template "chart.sourcesSection" . }}
|
|
|
|
{{ template "custom.requirements" . }}
|
|
|
|
{{ template "custom.dependencies" . }}
|
|
|
|
{{ template "custom.install" . }}
|
|
|
|
{{ template "custom.uninstall" . }}
|
|
|
|
{{ template "custom.configuration.header" . }}
|
|
|
|
{{ template "custom.configuration.readValues" . }}
|
|
|
|
{{ template "custom.configuration.example.set" . }}
|
|
|
|
{{ template "custom.configuration.example.file" . }}
|
|
|
|
{{ template "custom.linking" . }}
|
|
|
|
{{ template "custom.support" . }}
|
|
|
|
|
|
---
|
|
|
|
{{ template "custom.sponsors" . }}
|
|
|
|
---
|
|
|
|
{{ template "custom.copyright" . }}
|