From a9e48d153ee28e84cd1bd48860db5b8bd166a2f6 Mon Sep 17 00:00:00 2001
From: James <thumbscrw@pm.me>
Date: Wed, 14 Feb 2024 21:35:57 +0000
Subject: [PATCH] create README with helm-docs

---
 charts/silverbullet/README.md                 | 55 +++++++++++++++++++
 charts/silverbullet/templates/deployment.yaml |  2 +
 charts/silverbullet/values.yaml               | 11 ++--
 3 files changed, 64 insertions(+), 4 deletions(-)
 create mode 100644 charts/silverbullet/README.md

diff --git a/charts/silverbullet/README.md b/charts/silverbullet/README.md
new file mode 100644
index 0000000..a08f504
--- /dev/null
+++ b/charts/silverbullet/README.md
@@ -0,0 +1,55 @@
+# silverbullet
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.7.1](https://img.shields.io/badge/AppVersion-0.7.1-informational?style=flat-square)
+
+A Helm chart for SilverBullet - a note-taking application optimized for people with a hacker mindset
+
+**Homepage:** <https://silverbullet.md/>
+
+## Source Code
+
+* <https://github.com/silverbulletmd/silverbullet>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"zefhemel/silverbullet"` |  |
+| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"silverbullet.local"` |  |
+| ingress.hosts[0].paths[0].path | string | `"/"` |  |
+| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
+| ingress.tls | list | `[]` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| persistence.accessMode | string | `"ReadWriteOnce"` |  |
+| persistence.annotations | object | `{}` |  |
+| persistence.enabled | bool | `false` | Persistence config for the /space volume |
+| persistence.existingClaim | string | `""` |  |
+| persistence.size | string | `"1Gi"` |  |
+| persistence.storageClass | string | `""` |  |
+| podAnnotations | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| resources | object | `{}` |  |
+| securityContext.readOnlyRootFilesystem | bool | `true` |  |
+| securityContext.runAsNonRoot | bool | `true` |  |
+| securityContext.runAsUser | int | `1000` |  |
+| service.port | int | `3000` |  |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` |  |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| silverbullet.authentication | bool | `true` | Enable/disable user and password authentication |
+| silverbullet.pass | string | `"silverbullet"` | Password to use for logging in |
+| silverbullet.user | string | `"admin"` | Username to use for logging in |
+| tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
diff --git a/charts/silverbullet/templates/deployment.yaml b/charts/silverbullet/templates/deployment.yaml
index 933ec9c..00bfb23 100644
--- a/charts/silverbullet/templates/deployment.yaml
+++ b/charts/silverbullet/templates/deployment.yaml
@@ -38,8 +38,10 @@ spec:
               containerPort: {{ .Values.service.port }}
               protocol: TCP
           env:
+          {{- if .Values.silverbullet.authentication }}
             - name: SB_USER
               value: "{{ .Values.silverbullet.user }}:{{ .Values.silverbullet.pass }}"
+          {{- end }}
           livenessProbe:
             httpGet:
               path: /
diff --git a/charts/silverbullet/values.yaml b/charts/silverbullet/values.yaml
index 679c8d4..bb12882 100644
--- a/charts/silverbullet/values.yaml
+++ b/charts/silverbullet/values.yaml
@@ -5,7 +5,7 @@
 image:
   repository: zefhemel/silverbullet
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
 imagePullSecrets: []
@@ -13,12 +13,11 @@ nameOverride: ""
 fullnameOverride: ""
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
   # Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
-  # If not set and create is true, a name is generated using the fullname template
+  # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template
   name: ""
 
 podAnnotations: {}
@@ -39,11 +38,15 @@ service:
   port: 3000
 
 silverbullet:
+  # -- Enable/disable user and password authentication
   authentication: true
+  # -- Username to use for logging in
   user: admin
+  # -- Password to use for logging in
   pass: silverbullet
 
 persistence:
+  # -- Persistence config for the /space volume
   enabled: false
   existingClaim: ""
   annotations: {}