Piped-Kubernetes/hack/templates/README.md.gotmpl

55 lines
1.2 KiB
Go Template
Raw Normal View History

2023-03-03 23:52:18 +00:00
{{- define "custom.repository.organization" -}}
TeamPiped
{{- end -}}
{{- define "custom.repository.url" -}}
https://github.com/TeamPiped/Piped-Kubernetes
{{- end -}}
{{- define "custom.helm.url" -}}
https://helm.piped.video
{{- end -}}
{{- define "custom.helm.path" -}}
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
{{- end -}}
2024-01-24 11:29:44 +00:00
{{ template "chart.header" . }}
2023-03-03 23:52:18 +00:00
2024-01-24 11:29:44 +00:00
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
{{ template "chart.description" . }}
{{ template "chart.sourcesSection" . }}
2023-03-03 23:52:18 +00:00
## Requirements
{{ template "chart.kubeVersionLine" . }}
## Dependencies
{{ template "chart.requirementsTable" . }}
## Installing the Chart
2024-01-24 11:29:44 +00:00
```bash
# Add the repository
helm repo add {{ template "custom.repository.organization" }} {{template "custom.helm.url"}}
2023-03-03 23:52:18 +00:00
2024-01-24 11:29:44 +00:00
# Install the chart
helm install {{ template "custom.repository.organization" }} piped -f values.yaml
2023-03-03 23:52:18 +00:00
```
## Values
2024-01-24 11:29:44 +00:00
The following table contains an overview of available values and their descriptions / default values.
2023-03-03 23:52:18 +00:00
2024-01-24 11:29:44 +00:00
<details>
<summary>Expand</summary>
2023-03-03 23:52:18 +00:00
2024-01-24 11:29:44 +00:00
{{ template "chart.valuesTable" . }}
2023-03-03 23:52:18 +00:00
2024-01-24 11:29:44 +00:00
</details>
2023-03-03 23:52:18 +00:00
{{ template "helm-docs.versionFooter" . }}