📝 (hammond): Add JWT_SECRET to docs

gabe565 · Aug 7, 2023 · 90e0811 · 90e0811
1 parent 8137244
commit 90e0811
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/charts/hammond/Chart.yaml b/charts/hammond/Chart.yaml
@@ -25,6 +25,8 @@ annotations:
       description: Change image from akhilrex/hammond to ghcr.io/alfhou/hammond
     - kind: added
       description: Add dynamic port env
+    - kind: added
+      description: Add JWT_SECRET env to docs
   artifacthub.io/links: |-
     - name: App Source
       url: https://github.com/AlfHou/hammond

diff --git a/charts/hammond/README.md b/charts/hammond/README.md
@@ -85,6 +85,7 @@ N/A
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | env | object | See [values.yaml](./values.yaml) | environment variables. [[ref]](https://github.com/AlfHou/hammond#environment-variables) |
+| env.JWT_SECRET | string | `nil` | The secret used to sign the JWT token. There is a default value, but it is important that you change it to something else. |
 | image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
 | image.repository | string | `"ghcr.io/alfhou/hammond"` | image repository |
 | image.tag | string | `"v0.0.21"` | image tag |

diff --git a/charts/hammond/values.yaml b/charts/hammond/values.yaml
@@ -15,8 +15,10 @@ image:
 
 # -- environment variables. [[ref]](https://github.com/AlfHou/hammond#environment-variables)
 # @default -- See [values.yaml](./values.yaml)
-env: {}
-  # JWT_SECRET: 20
+env:
+  # -- (string) The secret used to sign the JWT token.
+  # There is a default value, but it is important that you change it to something else.
+  JWT_SECRET:
 
 # -- Configures service settings for the chart.
 # @default -- See [values.yaml](./values.yaml)