Add wiki.js to chart (#661)

charts/wikijs/.helmignore

@@ -0,0 +1,26 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
+# OWNERS file for Kubernetes
+OWNERS
+# helm-docs templates
+*.gotmpl

charts/wikijs/Chart.yaml

@@ -0,0 +1,23 @@
+---
+
+apiVersion: v2
+appVersion: 1.0.0
+description: Make documentation a joy to write using Wiki.js's beautiful and intuitive interface!
+name: wikijs
+version: 2.5.191
+kubeVersion: ">=1.16.0-0"
+keywords:
+  - wiki
+  - wikijs
+home: https://github.com/k8s-at-home/charts/tree/master/charts/wikijs
+icon: https://static.requarks.io/logo/wikijs-full.svg
+sources:
+  - https://hub.docker.com/r/linuxserver/wikijs/
+  - https://github.com/Requarks/wiki
+maintainers:
+  - name: rolfberkenbosch
+    email: rolf@berkenbosch.nl
+dependencies:
+  - name: common
+    repository: https://library-charts.k8s-at-home.com
+    version: 1.0.0

charts/wikijs/README.md.gotmpl

@@ -0,0 +1,145 @@
+{{- define "custom.repository.organization" -}}
+k8s-at-home
+{{- end -}}
+
+{{- define "custom.repository.url" -}}
+https://github.com/k8s-at-home/charts
+{{- end -}}
+
+{{- define "custom.helm.url" -}}
+https://k8s-at-home.com/charts/
+{{- end -}}
+
+{{- define "custom.helm.path" -}}
+{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
+{{- end -}}
+
+{{- define "custom.notes" -}}
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
+{{- end -}}
+
+{{- define "custom.requirements" -}}
+## Requirements
+
+{{ template "chart.kubeVersionLine" . }}
+{{- end -}}
+
+{{- define "custom.dependencies" -}}
+## Dependencies
+
+{{ template "chart.requirementsTable" . }}
+{{- end -}}
+
+{{- define "custom.install.tldr" -}}
+## TL;DR
+
+```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.install" -}}
+## Installing the Chart
+
+To install the chart with the release name `{{ template "chart.name" . }}`
+
+```console
+helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
+```
+{{- end -}}
+
+{{- define "custom.uninstall" -}}
+## Uninstalling the Chart
+
+To uninstall the `{{ template "chart.name" . }}` deployment
+
+```console
+helm uninstall {{ template "chart.name" . }}
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+{{- end -}}
+
+{{- define "custom.configuration.header" -}}
+## Configuration
+{{- end -}}
+
+{{- define "custom.configuration.readValues" -}}
+Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
+Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
+{{- end -}}
+
+{{- define "custom.configuration.example.set" -}}
+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" -}}
+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.valuesSection" -}}
+## Values
+
+**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
+
+{{ template "chart.valuesTable" . }}
+{{- end -}}
+
+{{- define "custom.support" -}}
+## Support
+
+- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
+- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
+- Join our [Discord](https://discord.gg/sTMX7Vh) community
+{{- end -}}
+
+{{ template "chart.header" . }}
+
+{{ 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.tldr" . }}
+
+{{ 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.custom.configuration" . }}
+
+{{ template "custom.valuesSection" . }}
+
+{{ template "custom.changelog" . }}
+
+{{ template "custom.support" . }}
+
+{{ template "helm-docs.versionFooter" . }}

charts/wikijs/README_CHANGELOG.md.gotmpl

@@ -0,0 +1,27 @@
+{{- define "custom.changelog.header" -}}
+## Changelog
+{{- end -}}
+
+{{- define "custom.changelog" -}}
+{{ template "custom.changelog.header" . }}
+
+All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+### [0.0.1]
+
+#### Added
+
+- First version of the helm chart for wikijs
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[0.0.1]: #0.0.1
+{{- end -}}

charts/wikijs/README_CONFIG.md.gotmpl

@@ -0,0 +1,9 @@
+{{- define "custom.custom.configuration.header" -}}
+## Custom configuration
+{{- end -}}
+
+{{- define "custom.custom.configuration" -}}
+{{ template "custom.custom.configuration.header" . }}
+
+N/A
+{{- end -}}

charts/wikijs/templates/NOTES.txt

@@ -0,0 +1 @@
+{{- include "common.notes.defaultNotes" . -}}

charts/wikijs/templates/common.yaml

@@ -0,0 +1,3 @@
+---
+
+{{ include "common.all" . }}

charts/wikijs/values.yaml

@@ -0,0 +1,65 @@
+---
+
+#
+# IMPORTANT NOTE
+#
+# This chart inherits from our common library chart. You can check the default values/options here:
+# https://github.com/k8s-at-home/charts/tree/master/charts/common/values.yaml
+#
+
+# -- This is the default, you can also use requarks/wiki
+image:
+  repository: linuxserver/wikijs
+  pullPolicy: IfNotPresent
+  tag: version-2.5.191
+
+strategy:
+  type: Recreate
+
+env:
+  # -- Set the time zone, e.g. Europe/Amsterdam
+  TZ:
+  # -- mysql, postgres, mariadb, mssql or sqlite
+  DB_TYPE: sqlite
+  # -- Path to the SQLite file
+  DB_FILEPATH: /app/wiki/data/db.sqlite
+  # -- Port of the database
+  DB_PORT:
+  # -- Username to connect to the database
+  DB_USER:
+  # -- Password to connect to the database
+  DB_PASS:
+  # -- Database name
+  DB_NAME:
+  # -- Set to either 1 or true to enable. (optional, off if omitted)
+  DB_SSL:
+  # -- Database CA certificate content, as a single line string (without spaces or new lines), without the prefix and suffix lines. (optional, requires 2.3+)
+  DB_SSL_CA:
+  # -- Path to the mapped file containing to the database password. (optional, replaces DB_PASS)
+  DB_PASS_FILE:
+
+service:
+  # -- The default port is 3000 used by wiki.ks
+  port:
+    port: 3000
+    targetPort: 3000
+
+ingress:
+  # enable this if you would like to access you wiki
+  enabled: false
+  ingress.hosts[0].host: "chart-example.local"
+  ingress.hosts[0].paths[0].path: "/"
+  ingress.hosts[0].paths[0].pathType: "Prefix"
+
+persistence:
+  config:
+    enabled: false
+    emptyDir: false
+    accessMode: "ReadWriteOnce"
+    size: "1Gi"
+  data:
+    enabled: false
+    emptyDir: false
+    accessMode: "ReadWriteOnce"
+    mountPath: /app/wiki/data
+    size: "1Gi"