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
This commit is contained in:
@@ -1,20 +0,0 @@
|
||||
apiVersion: v2
|
||||
appVersion: 2.2.2
|
||||
description: An Application dashboard and launcher
|
||||
name: heimdall
|
||||
version: 1.3.1
|
||||
upstream_version: 4.1.1
|
||||
keywords:
|
||||
- heimdall
|
||||
home: https://github.com/truecharts/charts/tree/dev/charts/heimdall
|
||||
icon: https://i.imgur.com/mM4tcO5.png
|
||||
sources:
|
||||
- https://github.com/k8s-at-home/charts/blob/master/charts/heimdall/Chart.yaml
|
||||
- https://github.com/Sonarr/Sonarr
|
||||
- https://hub.docker.com/r/linuxserver/sonarr
|
||||
maintainers:
|
||||
- name: TrueCharts
|
||||
dependencies:
|
||||
- name: common
|
||||
repository: https://charts.truecharts.org/
|
||||
version: 1.3.0
|
||||
@@ -1,95 +0,0 @@
|
||||
{{- define "custom.introheader" -}}
|
||||
# Introduction
|
||||
{{- end -}}
|
||||
|
||||
{{- 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 are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**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
|
||||
|
||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.uninstall" -}}
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.configuration.header" -}}
|
||||
## Configuration
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.support" -}}
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.introheader" . }}
|
||||
|
||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
||||
|
||||
{{ template "chart.description" . }}
|
||||
|
||||
{{ template "custom.notes" . }}
|
||||
|
||||
{{ template "chart.sourcesSection" . }}
|
||||
|
||||
{{ template "custom.requirements" . }}
|
||||
|
||||
{{ template "custom.dependencies" . }}
|
||||
|
||||
{{ template "custom.install" . }}
|
||||
|
||||
{{ template "custom.uninstall" . }}
|
||||
|
||||
{{ template "custom.support" . }}
|
||||
|
||||
{{ template "helm-docs.versionFooter" . }}
|
||||
@@ -1,5 +0,0 @@
|
||||
{{- define "custom.notes" -}}
|
||||
{{- end -}}
|
||||
|
||||
{{ template "chart.description" . }}
|
||||
{{ template "custom.notes" . }}
|
||||
@@ -0,0 +1,29 @@
|
||||
apiVersion: v2
|
||||
kubeVersion: ">=1.16.0-0"
|
||||
name: heimdall
|
||||
version: 1.3.2
|
||||
upstream_version: 4.1.1
|
||||
appVersion: 2.2.2
|
||||
description: An Application dashboard and launcher
|
||||
type: application
|
||||
deprecated: false
|
||||
home: https://github.com/truecharts/charts/tree/master/charts/heimdall
|
||||
icon: https://i.imgur.com/mM4tcO5.png
|
||||
keywords:
|
||||
- heimdall
|
||||
sources:
|
||||
- https://github.com/truecharts/charts/tree/master/charts/heimdall
|
||||
- https://github.com/k8s-at-home/charts/tree/master/charts/heimdall
|
||||
dependencies:
|
||||
- name: common
|
||||
repository: https://charts.truecharts.org/
|
||||
version: 1.3.0
|
||||
# condition:
|
||||
# tags:
|
||||
# import-values:
|
||||
# alias:
|
||||
maintainers:
|
||||
- name: TrueCharts
|
||||
email: info@truecharts.org
|
||||
url: truecharts.org
|
||||
# annotations:
|
||||
@@ -8,7 +8,7 @@ groups:
|
||||
- name: "Storage"
|
||||
description: "configure app volume mounts"
|
||||
- name: "Ingress"
|
||||
description: "Ingress configuration"
|
||||
description: "Reverse Proxy configuration"
|
||||
|
||||
portals:
|
||||
web_portal:
|
||||
@@ -231,13 +231,13 @@ questions:
|
||||
type: dict
|
||||
attrs:
|
||||
- variable: webui
|
||||
label: "Web Ingress Configuration"
|
||||
label: "Web Reverse Proxy Configuration"
|
||||
group: "Ingress"
|
||||
schema:
|
||||
type: dict
|
||||
attrs:
|
||||
- variable: enabled
|
||||
label: "Enable Web Ingress"
|
||||
label: "Enable Web Reverse Proxy"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
Reference in New Issue
Block a user