gotenberg

# Default values for gotenberg.

# This is a YAML-formatted file.

# Declare variables to be passed into your templates.

# -- Specifies that chart can be used as a condition when it is a dependency.

# See https://helm.sh/docs/chart_best_practices/dependencies/#conditions-and-tags for more info.

# @ignored

enabled: true

replicaCount: 1

image:

repository: cgr.dev/chainguard-private/gotenberg

pullPolicy: IfNotPresent

# -- Overrides the image tag whose default is the chart appVersion.

tag: 8.38.1-r0@sha256:3dd6952b3eb26e9f8408ccdb3d8aa38b62a31fb37322a17b6afc5bfb8a330d20

imagePullSecrets: []

nameOverride: ""

fullnameOverride: ""

serviceAccount:

# -- Specifies whether a service account should be created

create: false

# -- 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

name: ""

podAnnotations: {}

# -- Set annotations for the helm test pods (for example to disable certain kube-score checks)

testPodAnnotations: {}

# -- Image configuration for the helm test pod

testImage:

# -- Repository for the test image

repository: busybox

# -- Tag for the test image

tag: latest

# -- List of additional pod labels

podLabels: {}

# -- Set to false to stop Kubernetes injecting service discovery environment variables (`<SVCNAME>_SERVICE_HOST`, `<SVCNAME>_PORT`, ...) into the pod. These collide with Gotenberg's own configuration: a Service named `api` in the same namespace injects `API_PORT=tcp://<clusterIP>:<port>`, which Gotenberg reads as an override for `--api-port` and refuses to start.

enableServiceLinks: true

podSecurityContext: {}

# fsGroup: 2000

# -- Define the security context for the container. By default will use upstream recommended values.

# @default -- `{ privileged: false, runAsUser: 1001 }`, except in OpenShift where `runAsUser` is not set.

securityContext: {}

service:

type: ClusterIP

port: 80

# -- Annotations to add to the service

annotations: {}

# -- (DEPRECATED) Static IP address for LoadBalancer type service. Deprecated in Kubernetes 1.24, use provider-specific annotations instead.

loadBalancerIP: ""

# Strategy is utilized to configure the desired upgrade approach and

# configuration for the deployment.

strategy: {}

progressDeadlineSeconds: 120

resources: {}

# We usually recommend not to specify default resources and to leave this as a conscious

# choice for the user. This also increases chances charts run on environments with little

# resources, such as Minikube. If you do want to specify resources, uncomment the following

# lines, adjust them as necessary, and remove the curly braces after 'resources:'.

# limits:

# cpu: 100m

# memory: 128Mi

# requests:

# cpu: 100m

# memory: 128Mi

# -- Define the container lifecycle hooks. A `preStop` hook keeps the server accepting connections while Service endpoints propagate on shutdown, which prevents dropped connections during scale-down and rolling updates. Gotenberg's own graceful shutdown does not cover this: it stops as soon as it is idle, so an idle pod closes its listener within milliseconds of SIGTERM.

lifecycle: {}

# preStop:

# sleep:

# seconds: 5

# -- Define the liveness probe object for the container.

# +docs:property

# livenessProbe: {}

livenessProbe:

httpGet:

path: /health

port: http

# -- Define the readiness probe object for the container.

# +docs:property

# readinessProbe: {}

readinessProbe:

httpGet:

path: /health

port: http

# -- Define the startup probe object for the container.

# +docs:property

# startupProbe: {}

startupProbe:

httpGet:

path: /health

port: http

failureThreshold: 30

periodSeconds: 10

autoscaling:

enabled: false

minReplicas: 1

maxReplicas: 100

behavior: {}

extraMetrics: []

targetCPUUtilizationPercentage: 80

# +docs:property

# targetMemoryUtilizationPercentage: 80

vpa:

# -- Create a VerticalPodAutoscaler resource for right-sizing pod resources.

# Requires the VPA controller to be installed in the cluster.

# See also: https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler

create: false

# -- Update mode for VPA: Auto (resize in-place or restart), Recreate (restart to resize), Initial (set at creation only), Off (recommendations only)

updateMode: "Auto"

# -- Resource policy for VPA to control which containers and resources are autoscaled, see values.yaml for an example.

resourcePolicy: {}

# containerPolicies:

# - containerName: gotenberg

# minAllowed:

# cpu: 100m

# memory: 256Mi

# maxAllowed:

# cpu: 2

# memory: 4Gi

pdb:

create: false

minAvailable: 1

maxUnavailable: ""

# -- Unhealthy pod eviction policy for the PDB (e.g., AlwaysAllow)

unhealthyPodEvictionPolicy:

nodeSelector: {}

tolerations: []

affinity: {}

topologySpreadConstraints: []

volumes: []

# - name: tmp-volume

# emptyDir:

# medium: Memory

# sizeLimit: 2Gi

volumeMounts: []

# - name: tmp-volume

# mountPath: /tmp

# -- List of extra environment variables for gotenberg container.

# Gotenberg 8.29.0+ supports OpenTelemetry via standard OTEL_* environment variables.

# See https://gotenberg.dev/docs/configuration for details.

extraEnv: []

# - name: OTEL_EXPORTER_OTLP_ENDPOINT

# value: "http://otel-collector:4317"

# - name: OTEL_TRACES_EXPORTER

# value: "otlp"

# - name: OTEL_METRICS_EXPORTER

# value: "otlp"

# - name: OTEL_LOGS_EXPORTER

# value: "otlp"

# -- List of init containers for the gotenberg pod

initContainers: []

# - name: init-myservice

# image: busybox:1.28

# command: ['sh', '-c', 'echo init container']

ingress:

# -- Set to true to enable ingress record generation. WARNING: Gotenberg shouldn't be exposed to the internet.

enabled: false

# -- Set the class name of the ingress

className: ""

# -- Set the annotations of the ingress

annotations: {}

# kubernetes.io/ingress.class: nginx

# kubernetes.io/tls-acme: "true"

# -- Set the labels of the ingress

labels: {}

# -- Set the hostnames of the ingress, see values.yaml for an example.

hosts: []

# - host: chart-example.local

# paths:

# - path: /

# pathType: ImplementationSpecific

# -- Set the TLS configuration for the ingress, see values.yaml for an example.

tls: []

# - secretName: chart-example-tls

# hosts:

# - chart-example.local

# Gateway API HTTPRoute configuration.

# WARNING: Gotenberg shouldn't be exposed to the internet.

# See also: https://gateway-api.sigs.k8s.io/

gateway:

# -- Set to true to create an HTTPRoute resource

enabled: false

# -- Annotations to add to the HTTPRoute

annotations: {}

# -- Labels to add to the HTTPRoute

labels: {}

# -- Parent Gateway references, see values.yaml for an example.

parentRefs: []

# - name: my-gateway

# namespace: default

# sectionName: https

# -- Hostnames to match for routing, see values.yaml for an example.

hostnames: []

# - gotenberg.example.local

# The API module is an HTTP/1 and HTTP/2 (H2C) server. Other modules may add routes, middlewares, and health checks.

# https://gotenberg.dev/docs/configuration#api

api:

# -- Set the port on which the API should listen (default 3000)

port: 3000

# -- Enables TLS on the API server: K8S TLS secret name containing the TLS certificate and key (tls.crt, tls.key)

tlsSecretName: ""

# -- Set the time limit for requests (default 30s)

timeout: ""

# -- Set the request body limit for multipart/form-data (e.g., "100MB")

bodyLimit: ""

# -- Set the root path of the API - for service discovery via URL paths (default "/")

rootPath: ""

# -- (DEPRECATED) Set the header name to use for identifying requests. Use correlationIdHeader instead.

traceHeader: ""

# -- Set the header name to use for identifying requests (default "Gotenberg-Trace")

correlationIdHeader: ""

# -- (DEPRECATED) Disable health check route telemetry. Use disableHealthCheckRouteTelemetry instead.

disableHealthCheckLogging: false

# -- Disable health check route telemetry. Note: upstream default changed to true in Gotenberg 8.29.0 (health check telemetry is disabled by default even without this flag).

disableHealthCheckRouteTelemetry: false

# -- Enable debug route for debugging purposes

enableDebugRoute: false

# -- Set the maximum duration to wait for the API to start

startTimeout: ""

# -- Enable basic authentication, see also the basicAuthUsername and basicAuthPassword values

enableBasicAuth: false

# -- Name of an existing secret containing basic auth credentials (keys: username, password)

existingSecret: ""

# -- Key in existingSecret for the username (default: username)

existingSecretUsernameKey: ""

# -- Key in existingSecret for the password (default: password)

existingSecretPasswordKey: ""

# -- Set the basic authentication username (ignored if existingSecret is set)

basicAuthUsername:

# -- Set the basic authentication password (ignored if existingSecret is set)

basicAuthPassword:

# -- Enable OIDC bearer token authentication. Mutually exclusive with `enableBasicAuth`. Added in Gotenberg 8.36.0.

enableOidcAuth: false

# -- Set the OIDC issuer URL, e.g. `https://tenant.example.com/` - the token `iss` claim must match. Added in Gotenberg 8.36.0.

oidcIssuer: ""

# -- Set the expected OIDC audience - the token `aud` claim must contain it. Added in Gotenberg 8.36.0.

oidcAudience: ""

# -- Set the OIDC JWKS URL. Discovered from the issuer's well-known configuration when empty. Added in Gotenberg 8.36.0.

oidcJwksUrl: ""

# -- Set the allowed URLs for the download from feature using a regular expression

downloadFromAllowList: ""

# -- Set the denied URLs for the download from feature using a regular expression

downloadFromDenyList: ""

# -- Reject `downloadFrom` URLs resolving to a non-public IP (loopback, RFC1918, link-local, IPv6 unique-local). A URL matching `downloadFromAllowList` skips the IP-class check; a URL matching `downloadFromDenyList` is always rejected. Added in Gotenberg 8.32.0.

downloadFromDenyPrivateIps: false

# -- Reject `downloadFrom` URLs resolving to a public IP. Setting both `downloadFromDenyPrivateIps` and `downloadFromDenyPublicIps` to true rejects every URL unless the allow-list matches. Added in Gotenberg 8.32.0.

downloadFromDenyPublicIps: false

# -- Set the maximum number of retries for the download from feature (default 4)

downloadFromMaxRetry: 4

# -- (int) Set the maximum number of concurrent fetches per request for the download from feature. Leave unset for the upstream default (10); set to 0 for no limit. Added in Gotenberg 8.37.0.

downloadFromMaxConcurrency:

# -- Set the maximum number of entries in the `downloadFrom` array. Set to 0 for no limit (default 0). Added in Gotenberg 8.37.0.

downloadFromMaxEntries: 0

# -- Route `downloadFrom` fetches through the proxy defined by the standard `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` variables (set them via `extraEnv`), credentials included. Added in Gotenberg 8.35.0.

downloadFromEnableEnvironmentProxy: false

# -- Disable the download from feature

disableDownloadFrom: false

# -- Disable telemetry on the root route

disableRootRouteTelemetry: false

# -- Disable telemetry on the debug route

disableDebugRouteTelemetry: false

# -- Disable telemetry on the version route

disableVersionRouteTelemetry: false

# The Chromium module interacts with the Chromium browser to convert HTML documents to PDF.

# https://gotenberg.dev/docs/configuration#chromium

chromium:

# -- Number of conversions after which Chromium will automatically restart. Set to 0 to disable this feature (default 100)

restartAfter: ""

# -- Maximum number of concurrent Chromium conversions (default 6)

maxConcurrency: 0

# -- Automatically launch Chromium upon initialization if set to true; otherwise, Chromium will start at the time of the first conversion

autoStart: false

# -- Maximum duration to wait for Chromium to start or restart

startTimeout: ""

# -- Allow file:// URIs to read other file:// URIs

allowFileAccessFromFiles: false

# -- Ignore TLS/SSL errors on localhost

allowInsecureLocalhost: false

# -- Set the allowed URLs for Chromium using a regular expression

allowList: ""

# -- Set the denied URLs for Chromium using a regular expression (default "^file:///[^tmp].*")

denyList: ""

# -- Reject Chromium navigations and sub-resources resolving to a non-public IP (loopback, RFC1918, link-local, IPv6 unique-local). A URL matching `allowList` skips the IP-class check; a URL matching `denyList` is always rejected. Added in Gotenberg 8.32.0. Skipped when `proxyServer` or `hostResolverRules` is set.

denyPrivateIps: false

# -- Reject Chromium navigations and sub-resources resolving to a public IP. Setting both `denyPrivateIps` and `denyPublicIps` to true rejects every URL unless the allow-list matches. Added in Gotenberg 8.32.0.

denyPublicIps: false

# -- Ignore the certificate errors

ignoreCertificateErrors: false

# -- Don't enforce the same-origin policy

disableWebSecurity: false

# -- (DEPRECATED) Start Chromium with incognito mode. This flag is deprecated as of Gotenberg 8.25.0 and its value is ignored.

incognito: false

# -- Set custom mappings to the host resolver

hostResolverRules: ""

# -- Set the outbound proxy server; this switch only affects HTTP and HTTPS requests

proxyServer: ""

# -- Route Chromium's outbound requests through the proxy defined by the standard `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` variables (set them via `extraEnv`), credentials included. Use this instead of `proxyServer` for authenticated proxies, and leave `proxyServer` and `hostResolverRules` unset. Added in Gotenberg 8.35.0.

enableEnvironmentProxy: false

# -- Disable JavaScript

disableJavaScript: false

# -- Disable the routes

disableRoutes: false

# -- Share one browser context, with its cookies, cache and storage, across all conversions. Since Gotenberg 8.38.0 each conversion gets its own isolated context by default; enable this only when all callers trust each other. Added in Gotenberg 8.38.0.

sharedBrowserContext: false

# -- Clear Chromium cache between each conversion. Only applies with `sharedBrowserContext` since Gotenberg 8.38.0.

clearCache: false

# -- Clear Chromium cookies between each conversion. Only applies with `sharedBrowserContext` since Gotenberg 8.38.0.

clearCookies: false

# -- Clear Chromium local storage between each conversion. Only applies with `sharedBrowserContext` since Gotenberg 8.38.0. Added in Gotenberg 8.36.0.

clearStorage: false

# -- Maximum request queue size for Chromium. Set to 0 to disable this feature.

maxQueueSize: 0

# -- Duration after which idle Chromium browser processes are shut down (e.g., "30s"). Set to 0s or leave empty to disable (default 0s, disabled).

idleShutdownTimeout: ""

# The LibreOffice module interacts with LibreOffice to convert documents to PDF, thanks to unoconv.

# https://gotenberg.dev/docs/configuration#libreoffice

libreOffice:

# -- Number of conversions after which LibreOffice will automatically restart. Set to 0 to disable this feature (default 10)

restartAfter: ""

# -- Automatically launch LibreOffce upon initialization if set to true; otherwise, LibreOffice will start at the time of the first conversion (default false)

autoStart: false

# -- Maximum duration to wait for LibreOffice to start or restart (default 10s)

startTimeout: ""

# -- Disable the routes

disableRoutes: false

# -- Maximum request queue size for LibreOffice. Set to 0 to disable this feature.

maxQueueSize: 0

# -- Duration after which idle LibreOffice processes are shut down (e.g., "30s"). Set to 0s or leave empty to disable (default 0s, disabled).

idleShutdownTimeout: ""

# -- Set the allowed URLs for LibreOffice outbound fetches (embedded external content in OOXML/RTF/ODF) using a regular expression. Added in Gotenberg 8.32.0.

allowList: ""

# -- Set the denied URLs for LibreOffice outbound fetches using a regular expression. Added in Gotenberg 8.32.0.

denyList: ""

# -- Reject LibreOffice outbound fetches resolving to a non-public IP (loopback, RFC1918, link-local, IPv6 unique-local). A URL matching `allowList` skips the IP-class check; a URL matching `denyList` is always rejected. Added in Gotenberg 8.32.0.

denyPrivateIps: false

# -- Reject LibreOffice outbound fetches resolving to a public IP. Setting both `denyPrivateIps` and `denyPublicIps` to true rejects every URL unless the allow-list matches. Added in Gotenberg 8.32.0.

denyPublicIps: false

# -- Route LibreOffice outbound fetches through the proxy defined by the standard `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` variables (set them via `extraEnv`), credentials included. Added in Gotenberg 8.35.0.

enableEnvironmentProxy: false

# The PDF Engines module gathers all engines that can manipulate PDF files.

# https://gotenberg.dev/docs/configuration#pdf-engines

pdfEngines:

# -- (DEPRECATED) Set the PDF engines and their order. This flag was deprecated in Gotenberg 8.13.0 and its value is ignored. Use the per-feature engine flags instead (mergeEngines, splitEngines, flattenEngines, convertEngines, readMetadataEngines, writeMetadataEngines, encryptEngines, embedEngines).

engines: ""

# -- Set the PDF engines and their order for the merge feature (default qpdf,pdfcpu,pdftk)

mergeEngines: ""

# -- Set the PDF engines and their order for the split feature (default pdfcpu,qpdf,pdftk)

splitEngines: ""

# -- Set the PDF engines and their order for the flatten feature (default qpdf)

flattenEngines: ""

# -- Set the PDF engines and their order for the convert feature (default libreoffice-pdfengine)

convertEngines: ""

# -- Set the PDF engines and their order for the read metadata feature (default exiftool)

readMetadataEngines: ""

# -- Set the PDF engines and their order for the write metadata feature (default exiftool)

writeMetadataEngines: ""

# -- Set the PDF engines and their order for the password protection feature (default qpdf,pdftk,pdfcpu)

encryptEngines: ""

# -- Set the PDF engines and their order for the file embedding feature (default pdfcpu)

embedEngines: ""

# -- Set the PDF engines and their order for the embed metadata feature (default qpdf)

embedMetadataEngines: ""

# -- Set the PDF engines and their order for the watermark feature (default pdfcpu,pdftk)

watermarkEngines: ""

# -- Set the PDF engines and their order for the stamp feature (default pdfcpu,pdftk)

stampEngines: ""

# -- Set the PDF engines and their order for the rotate feature (default pdfcpu,pdftk)

rotateEngines: ""

# -- Set the PDF engines and their order for the read bookmarks feature (default pdfcpu)

readBookmarksEngines: ""

# -- Set the PDF engines and their order for the write bookmarks feature (default pdfcpu,pdftk)

writeBookmarksEngines: ""

# -- Set the PDF engines and their order for the Factur-X XMP metadata feature (default qpdf). Added in Gotenberg 8.34.0.

facturXEngines: ""

# -- Set the PDF engines and their order for the image optimization feature; empty means all (default pdfcpu). Added in Gotenberg 8.36.0.

optimizeImagesEngines: ""

# -- Maximum number of PDF files the per-file features (metadata, encryption, stamps, watermarks, flattening, ...) process at once, across all requests; does not apply to LibreOffice. Set to 0 to use the upstream default (default 1). Added in Gotenberg 8.37.0.

maxConcurrency: 0

# -- Disable the routes

disableRoutes: false

# The Webhook module provides a middleware that allows you to upload the output file

# from multipart/form-data routes to the destination of your choice.

# https://gotenberg.dev/docs/configuration#webhook

webhook:

# -- Enable synchronous mode for the webhook feature

enableSyncMode: false

# -- Set the allowed URLs for the webhook feature using a regular expression. In Gotenberg 8.31.0+ this applies to both regular and error webhooks.

allowList: ""

# -- Set the denied URLs for the webhook feature using a regular expression. In Gotenberg 8.31.0+ this applies to both regular and error webhooks. Note: 8.31.0's permissive-by-default revert means this defaults to empty again in 8.32.0+; opt into IP-class filtering via `denyPrivateIps` / `denyPublicIps`.

denyList: ""

# -- Reject webhook URLs (success, error, events) resolving to a non-public IP (loopback, RFC1918, link-local, IPv6 unique-local). A URL matching `allowList` skips the IP-class check; a URL matching `denyList` is always rejected. Added in Gotenberg 8.32.0.

denyPrivateIps: false

# -- Reject webhook URLs resolving to a public IP. Setting both `denyPrivateIps` and `denyPublicIps` to true rejects every URL unless the allow-list matches. Added in Gotenberg 8.32.0.

denyPublicIps: false

# -- (DEPRECATED) Set the allowed URLs in case of an error for the webhook feature using a regular expression. Use `allowList` instead in Gotenberg 8.31.0+ — it now covers both regular and error webhooks.

errorAllowList: ""

# -- (DEPRECATED) Set the denied URLs in case of an error for the webhook feature using a regular expression. Use `denyList` instead in Gotenberg 8.31.0+ — it now covers both regular and error webhooks.

errorDenyList: ""

# -- Set the maximum number of retries for the webhook feature (default 4)

maxRetry: ""

# -- Set the minimum duration to wait before trying to call the webhook again (default 1s)

retryMinWait: ""

# -- Set the maximum duration to wait before trying to call the webhook again (default 30s)

retryMaxWait: ""

# -- Set the time limit for requests to the webhook (default 30s)

clientTimeout: ""

# -- Route webhook callbacks through the proxy defined by the standard `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` variables (set them via `extraEnv`), credentials included. Added in Gotenberg 8.35.0.

enableEnvironmentProxy: false

# -- Disable the webhook feature

disable: false

# The Prometheus module collects metrics from other modules.

# https://gotenberg.dev/docs/configuration#prometheus

prometheus:

# -- Set the interval for collecting modules' metrics (default 1s)

collectInterval: ""

# -- Set the namespace of modules' metrics (default "gotenberg")

namespace: ""

# -- Set the metrics endpoint path (default "/prometheus/metrics")

metricsPath: ""

# -- Disable the collect of metrics

disableCollect: false

# -- (DEPRECATED) Disable the route logging. Use disableRouteTelemetry instead.

disableRouterLogging: false

# -- Disable route telemetry for the Prometheus metrics endpoint

disableRouteTelemetry: false

# The Logging module provides a logger to Gotenberg.

# https://gotenberg.dev/docs/configuration#logging

logging:

# -- (DEPRECATED) Set log format. Use stdFormat instead.

format: ""

# -- Set log standard output format - auto, json, or text (default "auto")

stdFormat: ""

# -- Set the case of the `level` field in standard output - lower or upper (default "lower"). Added in Gotenberg 8.34.0.

stdLevelCase: ""

# -- Set the log level - error, warn, info, or debug (default "info")

level: ""

# -- Prepend a specified prefix to each field in the logs

fieldsPrefix: ""

# -- (DEPRECATED) Enable GCP log field mapping for Cloud Run. Use stdEnableGcpFields instead.

enableGcpFields: false

# -- Enable GCP log standard output field mapping for Cloud Run

stdEnableGcpFields: false

# -- Enable GCP severity field mapping

enableGcpSeverity: false

# Misc.

# https://gotenberg.dev/docs/configuration#graceful-shutdown

gotenberg:

# -- Set the graceful shutdown duration (default 30s)

gracefulShutdownDurationSec: 30

# -- Hide the Gotenberg banner on startup

hideBanner: false

metrics:

serviceMonitor:

# -- Enable ServiceMonitor

enabled: false

# -- (string) Namespace for ServiceMonitor, defaults to release namespace

namespace:

# -- (string) Optional job label for the target service in Prometheus

jobLabel:

# -- (string) Interval at which metrics should be scraped

interval:

# -- (string) Timeout after which the scrape is ended

scrapeTimeout:

# -- HonorLabels chooses the metric’s labels on collisions with target labels

honorLabels: false

# -- List of metric relabel configs to apply to samples before ingestion

metricRelabelings: []

# -- List of relabel configs to apply to samples before scraping

relabelings: []

# -- Additional annotations for the service monitor

annotations: {}

# -- Additional labels for the service monitor

labels: {}

# Enable or Disable Network Policy.

# See also: https://kubernetes.io/docs/concepts/services-networking/network-policies/

networkPolicy:

enabled: false

# Allow all connections from any source. To be set to false if extraIngress is used.

allowIngress: true

# Allow all connections to any destinations. To be set to false if extraEgress is used.

allowEgress: true

# Config custom ingress rules to the NetworkPolicy.

extraIngress: []

# extraIngress:

# - from:

# - podSelector:

# matchLabels:

# component: apache

# ports:

# - port: 8080

# protocol: TCP

# Config custom egress rules to the NetworkPolicy.

extraEgress: []

# extraEgress:

# - to:

# - podSelector:

# matchLabels:

# component: apache

# ports:

# - port: 80

# protocol: TCP