From 1ac1ecbd820b9010d8532e6d310e741c72574aee Mon Sep 17 00:00:00 2001 From: Jonas Janz <5434875+PixelJonas@users.noreply.github.com> Date: Sun, 14 Nov 2021 15:47:30 +0100 Subject: [PATCH] [filebrowser] add new filebrowser chart (#1253) * [filebrowser] add new filebrowser chart Signed-off-by: PixelJonas <5434875+PixelJonas@users.noreply.github.com> * [filebrowser] auto-generate docs Signed-off-by: PixelJonas <5434875+PixelJonas@users.noreply.github.com> * [filebrowser] fix default location of database the database file should be in it's own PVC to ensure, that people can use NFS for the files. Signed-off-by: PixelJonas <5434875+PixelJonas@users.noreply.github.com> * [filebrowser] add code suggestions decrease initial version to 0.0.1 don't set defaults for accessMode or size for PersitentVolumeClaims use template for ConfigMap Signed-off-by: PixelJonas <5434875+PixelJonas@users.noreply.github.com> * [filebrowse] move chart to stable increase version to 1.0.0 re-run helm-docs increase app-version to 2.18.0 Signed-off-by: PixelJonas <5434875+PixelJonas@users.noreply.github.com> --- CODE_OF_CONDUCT.md | 4 +- charts/README.md | 1 + charts/stable/filebrowser/.helmignore | 26 ++++ charts/stable/filebrowser/Chart.yaml | 19 +++ charts/stable/filebrowser/README.md | 117 ++++++++++++++ charts/stable/filebrowser/README.md.gotmpl | 146 ++++++++++++++++++ .../filebrowser/README_CHANGELOG.md.gotmpl | 27 ++++ .../filebrowser/README_CONFIG.md.gotmpl | 9 ++ charts/stable/filebrowser/templates/NOTES.txt | 1 + .../stable/filebrowser/templates/common.yaml | 14 ++ .../filebrowser/templates/configmap.yaml | 9 ++ charts/stable/filebrowser/values.yaml | 53 +++++++ 12 files changed, 424 insertions(+), 2 deletions(-) create mode 100644 charts/stable/filebrowser/.helmignore create mode 100644 charts/stable/filebrowser/Chart.yaml create mode 100644 charts/stable/filebrowser/README.md create mode 100644 charts/stable/filebrowser/README.md.gotmpl create mode 100644 charts/stable/filebrowser/README_CHANGELOG.md.gotmpl create mode 100644 charts/stable/filebrowser/README_CONFIG.md.gotmpl create mode 100644 charts/stable/filebrowser/templates/NOTES.txt create mode 100644 charts/stable/filebrowser/templates/common.yaml create mode 100644 charts/stable/filebrowser/templates/configmap.yaml create mode 100644 charts/stable/filebrowser/values.yaml diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 9fb202cb..d8909ef8 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -118,11 +118,11 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. -Community Impact Guidelines were inspired by +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at -[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org diff --git a/charts/README.md b/charts/README.md index e33364fd..009c8e8c 100644 --- a/charts/README.md +++ b/charts/README.md @@ -29,6 +29,7 @@ | [duplicati](stable/duplicati) | Store securely encrypted backups on cloud storage services! | | [emby](stable/emby) | Emby Server is a home media server | | [esphome](stable/esphome) | ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems. | +| [filebrowser](stable/filebrowser) | filebrowser provides a file managing interface within a specified directory | | [flaresolverr](stable/flaresolverr) | FlareSolverr is a proxy server to bypass Cloudflare protection | | [flood](stable/flood) | Flood is a monitoring service for various torrent clients | | [focalboard](stable/focalboard) | Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana. | diff --git a/charts/stable/filebrowser/.helmignore b/charts/stable/filebrowser/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/filebrowser/.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 diff --git a/charts/stable/filebrowser/Chart.yaml b/charts/stable/filebrowser/Chart.yaml new file mode 100644 index 00000000..591dc30c --- /dev/null +++ b/charts/stable/filebrowser/Chart.yaml @@ -0,0 +1,19 @@ +apiVersion: v2 +appVersion: 2.18.0 +description: filebrowser provides a file managing interface within a specified directory +name: filebrowser +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- filebrowser +home: https://github.com/k8s-at-home/charts/tree/master/charts/incubator/filebrowser +icon: https://raw.githubusercontent.com/filebrowser/logo/master/icon.png +sources: +- https://github.com/filebrowser/filebrowser +maintainers: +- name: PixelJonas + email: 5434875+PixelJonas@users.noreply.github.com +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.0.1 diff --git a/charts/stable/filebrowser/README.md b/charts/stable/filebrowser/README.md new file mode 100644 index 00000000..76004b98 --- /dev/null +++ b/charts/stable/filebrowser/README.md @@ -0,0 +1,117 @@ +# filebrowser + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.18.0](https://img.shields.io/badge/AppVersion-2.18.0-informational?style=flat-square) + +filebrowser helm package + +**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)** + +## Source Code + +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install filebrowser k8s-at-home/filebrowser +``` + +## Installing the Chart + +To install the chart with the release name `filebrowser` + +```console +helm install filebrowser k8s-at-home/filebrowser +``` + +## Uninstalling the Chart + +To uninstall the `filebrowser` deployment + +```console +helm uninstall filebrowser +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +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/k8s-at-home/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). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install filebrowser \ + --set env.TZ="America/New York" \ + k8s-at-home/filebrowser +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install filebrowser k8s-at-home/filebrowser -f values.yaml +``` + +## Custom configuration + +N/A + +## 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/library-charts/tree/main/charts/stable/common) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config | string | `"{\n \"port\": 80,\n \"baseURL\": \"\",\n \"address\": \"\",\n \"log\": \"stdout\",\n \"database\": \"/config/database.db\",\n \"root\": \"/srv/data\"\n}\n"` | | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"filebrowser/filebrowser"` | image repository | +| image.tag | string | `"v2.18.0"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| service | object | See values.yaml | Configures service settings for the chart. | + +## Changelog + +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/library-charts/tree/main/charts/stable/common#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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 + +## 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 + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/stable/filebrowser/README.md.gotmpl b/charts/stable/filebrowser/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/stable/filebrowser/README.md.gotmpl @@ -0,0 +1,146 @@ +{{- 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](https://github.com/k8s-at-home/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" -}} +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/library-charts/tree/main/charts/stable/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" . }} +{{ "" }} diff --git a/charts/stable/filebrowser/README_CHANGELOG.md.gotmpl b/charts/stable/filebrowser/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..06ad5fb3 --- /dev/null +++ b/charts/stable/filebrowser/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/library-charts/tree/main/charts/stable/common#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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 +{{- end -}} diff --git a/charts/stable/filebrowser/README_CONFIG.md.gotmpl b/charts/stable/filebrowser/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/filebrowser/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 -}} diff --git a/charts/stable/filebrowser/templates/NOTES.txt b/charts/stable/filebrowser/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/filebrowser/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/filebrowser/templates/common.yaml b/charts/stable/filebrowser/templates/common.yaml new file mode 100644 index 00000000..1766ca85 --- /dev/null +++ b/charts/stable/filebrowser/templates/common.yaml @@ -0,0 +1,14 @@ +{{/* Append the configMap volume to the volumes */}} +{{- define "filebrowser.configVolume" -}} +enabled: "true" +mountPath: "/.filebrowser.json" +subPath: ".filebrowser.json" +type: "custom" +volumeSpec: + configMap: + name: {{ include "common.names.fullname" . }}-config +{{- end -}} +{{- $_ := set .Values.persistence "filebrowser-config" (include "filebrowser.configVolume" . | fromYaml) -}} + +{{/* Render the templates */}} +{{ include "common.all" . }} diff --git a/charts/stable/filebrowser/templates/configmap.yaml b/charts/stable/filebrowser/templates/configmap.yaml new file mode 100644 index 00000000..9fcc5db3 --- /dev/null +++ b/charts/stable/filebrowser/templates/configmap.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ template "common.names.fullname" . }}-config + labels: + {{- include "common.labels" . | nindent 4 }} +data: + .filebrowser.json: | + {{- tpl .Values.config $ | nindent 4 }} diff --git a/charts/stable/filebrowser/values.yaml b/charts/stable/filebrowser/values.yaml new file mode 100644 index 00000000..656ee9fe --- /dev/null +++ b/charts/stable/filebrowser/values.yaml @@ -0,0 +1,53 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# + +image: + # -- image repository + repository: filebrowser/filebrowser + # -- image tag + tag: v2.18.0 + # -- image pull policy + pullPolicy: IfNotPresent + +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 80 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false + +config: | + { + "port": 80, + "baseURL": "", + "address": "", + "log": "stdout", + "database": "/config/database.db", + "root": "/srv/data" + } + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: + config: + enabled: false + mountpath: /config + data: + enabled: false + mountPath: /srv