Merge pull request #32 from MaikuMori/gotenberg-8.5.0

Bump gotenberg from `8.1.0` to `8.5.0`, add basic auth
MaikuMori · Apr 30, 2024 · 40957c8 · 40957c8
2 parents 64cbf35 + ee7be07
commit 40957c8
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 6 deletions.
diff --git a/charts/gotenberg/CHANGELOG.md b/charts/gotenberg/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.2.0
+
+- Bump `gotenberg` version `8.1.0` -> `8.5.0`.
+- Add new options:
+
+  - `enableBasicAuth`
+  - `basicAuthUsername`
+  - `basicAuthPassword`
+
 ## 1.1.0
 
 - Bump `gotenberg` version `8.0.2` -> `8.1.0`.

diff --git a/charts/gotenberg/Chart.yaml b/charts/gotenberg/Chart.yaml
@@ -16,13 +16,13 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: "1.1.0"
+version: "1.2.0"
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "8.1.0"
+appVersion: "8.5.0"
 
 keywords:
   - gotenberg

diff --git a/charts/gotenberg/README.md b/charts/gotenberg/README.md
@@ -1,7 +1,7 @@
 # Gotenberg
 
-[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/gotenberg)](https://artifacthub.io/packages/search?repo=gotenberg)
-![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 8.1.0](https://img.shields.io/badge/AppVersion-8.1.0-informational?style=flat-square)
+[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/gotenberg)](https://artifacthub.io/packages/helm/maikumori/gotenberg)
+![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 8.5.0](https://img.shields.io/badge/AppVersion-8.5.0-informational?style=flat-square)
 
 This is a HELM chart for Gotenberg.
 
@@ -49,7 +49,10 @@ helm upgrade my-release maikumori/gotenberg --install
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
+| api.basicAuthPassword | string | `nil` | Set the basic authentication password |
+| api.basicAuthUsername | string | `nil` | Set the basic authentication username |
 | api.disableHealthCheckLogging | bool | `false` | Disable health check logging |
+| api.enableBasicAuth | bool | `false` | Enable basic authentication, see also the basicAuthUsername and basicAuthPassword values |
 | api.port | int | `3000` | Set the port on which the API should listen (default 3000) |
 | api.rootPath | string | `""` | Set the root path of the API - for service discovery via URL paths (default "/") |
 | api.timeout | string | `""` | Set the time limit for requests (default 30s) |

diff --git a/charts/gotenberg/README.md.gotmpl b/charts/gotenberg/README.md.gotmpl
@@ -1,6 +1,6 @@
 # Gotenberg
 
-[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/gotenberg)](https://artifacthub.io/packages/search?repo=gotenberg)
+[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/gotenberg)](https://artifacthub.io/packages/helm/maikumori/gotenberg)
 {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
 
 This is a HELM chart for Gotenberg.

diff --git a/charts/gotenberg/templates/deployment.yaml b/charts/gotenberg/templates/deployment.yaml
@@ -51,6 +51,9 @@ spec:
           {{- if .Values.api.disableHealthCheckLogging }}
           - --api-disable-health-check-logging
           {{- end }}
+          {{- if .Values.api.enableBasicAuth }}
+          - --api-enable-basic-auth
+          {{- end }}
 
           {{- if .Values.chromium.restartAfter }}
           - --chromium-restart-after={{ .Values.chromium.restartAfter }}
@@ -181,6 +184,13 @@ spec:
           {{- if .Values.gotenberg.gracefulShutdownDurationSec }}
           - --gotenberg-graceful-shutdown-duration={{ .Values.gotenberg.gracefulShutdownDurationSec }}s
           {{- end }}
+          env:
+          {{- if and .Values.api.enableBasicAuth .Values.api.basicAuthUsername .Values.api.basicAuthPassword }}
+            - name: GOTENBERG_API_BASIC_AUTH_USERNAME
+              value: {{ .Values.api.basicAuthUsername }}
+            - name: GOTENBERG_API_BASIC_AUTH_PASSWORD
+              value: {{ .Values.api.basicAuthPassword }}
+          {{- end }}
           ports:
             - name: http
               containerPort: {{ .Values.api.port }}
@@ -213,4 +223,4 @@ spec:
       {{- with .Values.volumes }}
       volumes:
         {{- toYaml . | nindent 8 }}
-      {{- end }}
+      {{- end }}
diff --git a/charts/gotenberg/values.yaml b/charts/gotenberg/values.yaml
@@ -112,6 +112,12 @@ api:
   traceHeader: ""
   # -- Disable health check logging
   disableHealthCheckLogging: false
+  # -- Enable basic authentication, see also the basicAuthUsername and basicAuthPassword values
+  enableBasicAuth: false
+  # -- Set the basic authentication username
+  basicAuthUsername:
+  # -- Set the basic authentication password
+  basicAuthPassword:
 
 # The Chromium module interacts with the Chromium browser to convert HTML documents to PDF.
 # https://gotenberg.dev/docs/modules/chromium