Configuration
The Docker image includes a binary with flags to configure its modules. This guide lists all available flags so you can fine-tune Gotenberg to your needs.
How To
To set one or more flags, it's necessary to override the Docker image's default command.
For example, with the Docker CLI:
docker run --rm -p "3000:3000" gotenberg/gotenberg:8 gotenberg --my-module-property=foo
Or with Docker Compose:
services:
# Your other services.
gotenberg:
image: gotenberg/gotenberg:8
command:
- "gotenberg"
- "--my-module-property=foo"
Do not redefine the Gotenberg Docker image default entrypoint, but override the command instead. See this issue for more details.
Alternatively, you can set environment variables that directly correspond to the command-line flags.
For example, with the Docker CLI:
docker run --rm -p "3000:3000" -e MY_MODULE_PROPERTY=foo gotenberg/gotenberg:8
Or with Docker Compose:
services:
# Your other services.
gotenberg:
image: gotenberg/gotenberg:8
environment:
MY_MODULE_PROPERTY: "foo"
API
The API module is an HTTP/1 and HTTP/2 (with H2C support) server.
The following flags allow you to configure the API module:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --api-port | API_PORT | Set the port on which the API should listen. | 3000 |
| --api-port-from-env | API_PORT_FROM_ENV | Set the environment variable with the port on which the API should listen - override the default port. | None |
| --api-bind-ip | API_BIND_IP | Set the IP address the API should bind to for incoming connections. | 0.0.0.0 |
| --api-tls-cert-file | API_TLS_CERT_FILE | Path to the TLS/SSL certificate file - for HTTPS support. | None |
| --api-tls-key-file | API_TLS_KEY_FILE | Path to the TLS/SSL key file - for HTTPS support. | None |
| --api-start-timeout | API_START_TIMEOUT | Set the time limit for the API to start. | 30s |
| --api-timeout | API_TIMEOUT | Set the time limit for requests. | 30s |
| --api-body-limit | API_BODY_LIMIT | Set the body limit for multipart/form-data requests - it accepts values like 5MB, 1GB, etc. | None |
| --api-root-path | API_ROOT_PATH | Set the root path of the API - for service discovery via URL paths | / |
| --api-trace-header | API_TRACE_HEADER | Set the header name to use for identifying requests. | Gotenberg-Trace |
| --api-enable-basic-auth | API_ENABLE_BASIC_AUTH | Enable basic authentication - will look for the GOTENBERG_API_BASIC_AUTH_USERNAME and GOTENBERG_API_BASIC_AUTH_PASSWORD environment variables. | false |
| --api-download-from-allow-list | API_DOWNLOAD_FROM_ALLOW_LIST | Set the allowed URLs for the download from feature using a regular expression. | All |
| --api-download-from-deny-list | API_DOWNLOAD_FROM_DENY_LIST | Set the denied URLs for the download from feature using a regular expression. | None |
| --api-download-from-max-retry | API_DOWNLOAD_FROM_MAX_RETRY | Set the maximum number of retries for the download from feature. | 4 |
| --api-disable-download-from | API_DISABLE_DOWNLOAD_FROM | Disable the download from feature. | false |
| --api-disable-health-check-logging | API_DISABLE_HEALTH_CHECK_LOGGING | Disable health check logging. | false |
| --api-enable-debug-route | API_ENABLE_DEBUG_ROUTE | Enable debug route. | false |
Chromium
The Chromium module interacts with the Chromium browser to convert HTML documents to PDF.
A single Chromium browser manages the conversions in a stateful mode, enabling quicker single conversions. However, due to a lock mechanism, a Chromium browser cannot execute parallel operations.
During periods of heavy load, incoming requests will accumulate in the queue until they are processed, time out, or the queue reaches its maximum capacity. In the latter case, the request will be terminated prematurely.
To maintain performance under a heavy load, consider increasing the number of Gotenberg instances.
Before Gotenberg 8.22.0, the amd64 image used Google Chrome (stable), while other architectures used Chromium.
Now all architectures use Chromium.
The following flags allow you to configure the Chromium module:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --chromium-restart-after | CHROMIUM_RESTART_AFTER | Number of conversions after which Chromium will automatically restart. Set to 0 to disable this feature. | 10* |
| --chromium-max-queue-size | CHROMIUM_MAX_QUEUE_SIZE | Maximum request queue size for Chromium. Set to 0 to disable this feature. | 0 |
| --chromium-auto-start | CHROMIUM_AUTO_START | Automatically launch Chromium upon initialization if set to true; otherwise, Chromium will start at the time of the first conversion. | false |
| --chromium-start-timeout | CHROMIUM_START_TIMEOUT | Maximum duration to wait for Chromium to start or restart. | 20s |
| --chromium-allow-file-access-from-files | CHROMIUM_ALLOW_FILE_ACCESS_FROM_FILES | Allow file:// URIs to read other file:// URIs. | false |
| --chromium-allow-insecure-localhost | CHROMIUM_ALLOW_INSECURE_LOCALHOST | Ignore TLS/SSL errors on localhost. | false |
| --chromium-allow-list | CHROMIUM_ALLOW_LIST | Set the allowed URLs for Chromium using a regular expression. | All |
| --chromium-deny-list | CHROMIUM_DENY_LIST | Set the denied URLs for Chromium using a regular expression. | ^file:(?!//\/tmp/).* |
| --chromium-ignore-certificate-errors | CHROMIUM_IGNORE_CERTIFICATE_ERRORS | Ignore the certificate errors. | false |
| --chromium-disable-web-security | CHROMIUM_DISABLE_WEB_SECURITY | Don't enforce the same-origin policy. | false |
| --chromium-incognito | CHROMIUM_INCOGNITO | Start Chromium with incognito mode. | false |
| --chromium-host-resolver-rules | CHROMIUM_HOST_RESOLVER_RULES | Set custom mappings to the host resolver. | None |
| --chromium-proxy-server | CHROMIUM_PROXY_SERVER | Set the outbound proxy server; this switch only affects HTTP and HTTPS requests. | None |
| --chromium-clear-cache | CHROMIUM_CLEAR_CACHE | Clear Chromium cache between each conversion. | false |
| --chromium-clear-cookies | CHROMIUM_CLEAR_COOKIES | Clear Chromium cookies between each conversion. | false |
| --chromium-disable-javascript | CHROMIUM_DISABLE_JAVASCRIPT | Disable JavaScript. | false |
| --chromium-disable-routes | CHROMIUM_DISABLE_ROUTES | Disable the routes. | false |
*Prior to Gotenberg 8.15.2, restarting Chromium resulted in zombie processes.
LibreOffice
The LibreOffice module interacts with LibreOffice to convert numerous documents to PDF, thanks to unoconv.
A single LibreOffice instance manages the conversions in a stateful mode, enabling quicker single conversions. However, due to a lock mechanism, a LibreOffice instance cannot execute parallel operations.
During periods of heavy load, incoming requests will accumulate in the queue until they are processed, time out, or the queue reaches its maximum capacity. In the latter case, the request will be terminated prematurely.
To maintain performance under a heavy load, consider increasing the number of Gotenberg instances.
The following flags allow you to configure the LibreOffice module:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --libreoffice-restart-after | LIBREOFFICE_RESTART_AFTER | Number of conversions after which LibreOffice will automatically restart. Set to 0 to disable this feature. | 10 |
| --libreoffice-max-queue-size | LIBREOFFICE_MAX_QUEUE_SIZE | Maximum request queue size for LibreOffice. Set to 0 to disable this feature. | 0 |
| --libreoffice-auto-start | LIBREOFFICE_AUTO_START | Automatically launch LibreOffice upon initialization if set to true; otherwise, LibreOffice will start at the time of the first conversion. | false |
| --libreoffice-start-timeout | LIBREOFFICE_START_TIMEOUT | Maximum duration to wait for LibreOffice to start or restart. | 20s |
| --libreoffice-disable-routes | LIBREOFFICE_DISABLE_ROUTES | Disable the routes. | false |
Switch Language
By default, LibreOffice uses the English language when it converts documents to PDF. You may override this behavior by building your own Docker image.
For instance, with the German language:
FROM gotenberg/gotenberg:8
USER root
RUN apt-get update -qq &&\
DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends -t bookworm-backports libreoffice-l10n-de &&\
sed -i '/de_DE.UTF-8/s/^# //g' /etc/locale.gen &&\
locale-gen &&\
# Cleanup.
# Note: the Debian image does automatically a clean after each install thanks to a hook.
# Therefore, there is no need for apt-get clean.
# See https://stackoverflow.com/a/24417119/3248473.
rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
ENV LANG de_DE.UTF-8
ENV LANGUAGE de_DE:de
ENV LC_ALL de_DE.UTF-8
USER gotenberg
PDF Engines
The PDF Engines module gathers all engines that can manipulate PDF files. It calls each engine until one successfully handles a task. A PDF engine is an external tool that Gotenberg leverages to perform a specific task, such as merging PDF files.
Currently, Gotenberg supports the following PDF engines:
| Engine | Merge | Split | Flatten | Convert into PDF/A & PDF/UA | Read/Write metadata | Name |
|---|---|---|---|---|---|---|
| ExifTool | ❌ | ❌ | ❌ | ❌ | ✅ | exiftool |
| PDFtk | ✅ | ✅ | ❌ | ❌ | ❌ | pdtk |
| pdfcpu | ✅ | ✅ | ❌ | ❌ | ❌ | pdfcpu |
| QPDF | ✅ | ✅ | ✅ | ❌ | ❌ | qpdf |
| UNO | ❌ | ❌ | ❌ | ✅ | ❌ | libreoffice-pdfengine |
PDFtk and QPDF only supports the split mode pages with unification.
The following flags allow you to configure the PDF Engines module:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --pdfengines-merge-engines | PDFENGINES_MERGE_ENGINES | Set the PDF engines and their order for the merge feature - empty means all. | qpdf,pdfcpu,pdftk |
| --pdfengines-split-engines | PDFENGINES_SPLIT_ENGINES | Set the PDF engines and their order for the split feature - empty means all. | pdfcpu,qpdf,pdftk |
| --pdfengines-flatten-engines | PDFENGINES_FLATTEN_ENGINES | Set the PDF engines and their order for the flatten feature - empty means all. | qpdf |
| --pdfengines-convert-engines | PDFENGINES_CONVERT_ENGINES | Set the PDF engines and their order for the convert feature - empty means all. | libreoffice-pdfengine |
| --pdfengines-read-metadata-engines | PDFENGINES_READ_METADATA_ENGINES | Set the PDF engines and their order for the read metadata feature - empty means all. | exiftool |
| --pdfengines-write-metadata-engines | PDFENGINES_WRITE_METADATA_ENGINES | Set the PDF engines and their order for the read metadata feature - empty means all. | exiftool |
| --pdfengines-disable-routes | PDFENGINES_DISABLE_ROUTES | Disable the routes. | false |
As of Gotenberg 8.13.0, the flag --pdfengines-engines has been deprecated.
Webhook
The webhook feature enables Gotenberg to upload the output file originating from multipart/form-data routes to a selected destination.
The following flags allow you to configure the Webhook module:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --webhook-enable-sync-mode | WEBHOOK_ENABLE_SYNC_MODE | Enable synchronous mode for the webhook feature. | false |
| --webhook-allow-list | WEBHOOK_ALLOW_LIST | Set the allowed URLs for the webhook feature using a regular expression. | All |
| --webhook-deny-list | WEBHOOK_DENY_LIST | Set the denied URLs for the webhook feature using a regular expression. | None |
| --webhook-error-allow-list | WEBHOOK_ERROR_ALLOW_LIST | Set the allowed URLs in case of an error for the webhook feature using a regular expression. | All |
| --webhook-error-deny-list | WEBHOOK_ERROR_DENY_LIST | Set the denied URLs in case of an error for the webhook feature using a regular expression. | None |
| --webhook-max-retry | WEBHOOK_MAX_RETRY | Set the maximum number of retries for the webhook feature. | 4 |
| --webhook-retry-min-wait | WEBHOOK_RETRY_MIN_WAIT | Set the minimum duration to wait before trying to call the webhook again. | 1s |
| --webhook-retry-max-wait | WEBHOOK_RETRY_MAX_WAIT | Set the maximum duration to wait before trying to call the webhook again. | 30s |
| --webhook-client-timeout | WEBHOOK_CLIENT_TIMEOUT | Set the time limit for requests to the webhook. | 30s |
| --webhook-disable | WEBHOOK_DISABLE | Disable the webhook feature. | false |
Prometheus
The Prometheus module collects metrics from other modules and exposes an HTTP endpoint that can be scraped by Prometheus.
The following flags allow you to configure the Prometheus module:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --prometheus-collect-interval | PROMETHEUS_COLLECT_INTERVAL | Set the interval for collecting modules' metrics. | 1s |
| --prometheus-namespace | PROMETHEUS_NAMESPACE | Set the namespace of modules' metrics. | gotenberg |
| --prometheus-disable-collect | PROMETHEUS_DISABLE_COLLECT | Disable the collect of metrics. | false |
| --prometheus-disable-route-logging | PROMETHEUS_DISABLE_ROUTE_LOGGING | Disable the route logging. | false |
Logging
Gotenberg employs a logger that generates structured logs. Structured logs are formatted in a standardized, machine-readable way, making them extremely beneficial for centralized log management.
The following flags allow you to configure the logger:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --log-format | LOG_FORMAT | Specify the format of logging. Options include auto, json, or text. | auto |
| --log-level | LOG_LEVEL | Choose the level of logging detail. Options include error, warn, info, or debug. | info |
| --log-fields-prefix | LOG_FIELDS_PREFIX | Prepend a specified prefix to each field in the logs. | None |
| --log-enable-gcp-fields | LOG_ENABLE_GCP_FIELDS | Enable Google Cloud Platform fields - namely: time, message, severity. | None |
As of Gotenberg 8.19.0, the flag --log-enable-gcp-severity has been deprecated in favor of --log-enable-gcp-fields.
Graceful Shutdown
To ensure running tasks have enough time to complete, Gotenberg waits for a specific duration before initiating the shutdown process.
The following flag allows you to configure this duration:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --gotenberg-graceful-shutdown-duration | GOTENBERG_GRACEFUL_SHUTDOWN_DURATION | Set the graceful shutdown duration. | 30s |
For Gotenberg versions prior to 8.21.0, when using the webhook feature, make sure this duration is equal to or longer than the API timeout. This ensures that all asynchronous processes finish before Gotenberg begins its shutdown sequence.
Hide Banner
The following flag allows you to hide the startup banner with:
| Flag | Environment variable | Description | Default |
|---|---|---|---|
| --gotenberg-hide-banner | GOTENBERG_HIDE_BANNER | Hide the banner. | false |
Docker Image
Fonts
The default Docker image is pre-packaged with an extensive assortment of fonts, including Asian ones. If your application requires additional or specific fonts not included in this collection, you'll need to construct a tailored Docker image to incorporate those fonts.
Via .tff files
FROM gotenberg/gotenberg:8
USER root
COPY /local/path/to/{font}.ttf /usr/local/share/fonts/{font}.ttf
USER gotenberg
Or, if you have many fonts:
FROM gotenberg/gotenberg:8
USER root
COPY /local/path/to/fonts/* /usr/local/share/fonts/
USER gotenberg
Via .deb packages
FROM gotenberg/gotenberg:8
USER root
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends my-fonts-package
USER gotenberg
You could also mount a volume containing your fonts to /usr/local/share/fonts/ as suggested in this comment.
Ownership
The Docker image employs a specific non-root user, named gotenberg, with a User ID (uid) and Group ID (gid) of 1001. If you want to change these identifiers, you will have to build a custom Docker image:
FROM gotenberg/gotenberg:8
USER root
RUN usermod -u {uid} -g {gid} gotenberg
USER gotenberg
Since Gotenberg 8.21.0, the image also supports arbitrary user IDs (OpenShift).