Caprover logo
Caprover one-click apps browser
Gotenberg logo
Gotenberg
Docker-Powered Stateless API For PDF Files
Official integration
Created - Last update

Gotenberg provides a developer-friendly API to interact with powerful tools like Chromium and LibreOffice for converting numerous document formats (HTML, Markdown, Word, Excel, etc.) into PDF files, and more!

Deployed services
gotenberg
custom
    $$cap_GOTENBERG_API_PORT
    38
    Variables

    General | Version

    Default: 7

    $$cap_GOTENBERG_VERSION
    Check out their valid tags at https://hub.docker.com/r/gotenberg/gotenberg/tags

    General | Graceful Shutdown Duration

    Default: 30s

    $$cap_GOTENBERG_GRACEFUL_SHUTDOWN_DURATION
    Graceful shutdown duration.

    API | Port

    Default: 3000

    $$cap_GOTENBERG_API_PORT
    Port of Gotenberg.

    API | Timeout

    Default: 30s

    $$cap_GOTENBERG_API_TIMEOUT
    Time limit for requests.

    API | Root Path

    Default: /

    $$cap_GOTENBERG_API_ROOT_PATH
    Root path of the API for service discovery via URL paths.

    API | Trace Header

    Default: Gotenberg-Trace

    $$cap_GOTENBERG_API_TRACE_HEADER
    Header name to use for identifying requests.

    API | Disable Health Check

    Default: false

    $$cap_GOTENBERG_API_DISABLE_HEALTH_CHECK
    Whether to disable health check logging.

    Chromium | Allow File Access From Files

    Default: true

    $$cap_GOTENBERG_CHROMIUM_ALLOW_FILE_ACCESS_FROM_FILES
    Whether to allow `file://` URIs to read other `file://` URIs.

    Chromium | Allow Insecure Localhost

    Default: true

    $$cap_GOTENBERG_CHROMIUM_ALLOW_INSECURE_LOCALHOST
    Whether to ignore TLS/SSL errors on `localhost`.

    Chromium | Allow List

    Default: undefined

    $$cap_GOTENBERG_CHROMIUM_ALLOW_LIST
    Allowed URLs for Chromium using a regular expression.

    Chromium | Deny List

    Default: ^file:///[^tmp].*

    $$cap_GOTENBERG_CHROMIUM_DENY_LIST
    Denied URLs for Chromium using a regular expression.

    Chromium | Ignore Certificate Errors

    Default: true

    $$cap_GOTENBERG_CHROMIUM_IGNORE_CERTIFICATE_ERRORS
    Whether to ignore certificate errors.

    Chromium | Disable Web Security

    Default: true

    $$cap_GOTENBERG_CHROMIUM_DISABLE_WEB_SECURITY
    Whether to not enforce the same-origin policy.

    Chromium | Incognito Mode

    Default: false

    $$cap_GOTENBERG_CHROMIUM_INCOGNITO
    Whether to start Chromium with incognito mode.

    Chromium | Host Resolver Rules

    Default: undefined

    $$cap_GOTENBERG_CHROMIUM_HOST_RESOLVER_RULES
    Custom mappings to the host resolver.

    Chromium | Proxy Server

    Default: undefined

    $$cap_GOTENBERG_CHROMIUM_PROXY_SERVER
    Outbound proxy server. This switch only affects HTTP and HTTPS requests.

    Chromium | Disable JavaScript

    Default: false

    $$cap_GOTENBERG_CHROMIUM_DISABLE_JAVASCRIPT
    Whether to disable JavaScript.

    Chromium | Disable Routes

    Default: false

    $$cap_GOTENBERG_CHROMIUM_DISABLE_ROUTES
    Whether to disable the routes for Chromium.

    LibreOffice | Disable Routes

    Default: false

    $$cap_GOTENBERG_LIBREOFFICE_DISABLE_ROUTES
    Whether to disable the routes for LibreOffice.

    LibreOffice | Listener Start Timeout

    Default: 10s

    $$cap_GOTENBERG_LIBREOFFICE_LISTENER_START_TIMEOUT
    Time limit for starting the LibreOffice listener.

    LibreOffice | Listener Restart Threshold

    Default: 10

    $$cap_GOTENBERG_LIBREOFFICE_LISTENER_RESTART_THRESHOLD
    Conversions limit after which the LibreOffice listener is restarted. `0` means no long-running LibreOffice listener.

    PDF Engines | Engines

    Default: undefined

    $$cap_GOTENBERG_PDFENGINES_ENGINES
    PDF engines and their order (e.g. `pdftk,uno-pdfengine`). Leave blank to use all.

    PDF Engines | Disable Routes

    Default: false

    $$cap_GOTENBERG_PDFENGINES_DISABLE_ROUTES
    Whether to disable the routes for PDF Engines.

    Webhook | Allow List

    Default: undefined

    $$cap_GOTENBERG_WEBHOOK_ALLOW_LIST
    Allowed URLs for the webhook feature using a regular expression.

    Webhook | Deny List

    Default: undefined

    $$cap_GOTENBERG_WEBHOOK_DENY_LIST
    Denied URLs for the webhook feature using a regular expression.

    Webhook | Error Allow List

    Default: undefined

    $$cap_GOTENBERG_WEBHOOK_ERROR_ALLOW_LIST
    Allowed URLs in case of an error for the webhook feature using a regular expression.

    Webhook | Error Deny List

    Default: undefined

    $$cap_GOTENBERG_WEBHOOK_ERROR_DENY_LIST
    Denied URLs in case of an error for the webhook feature using a regular expression.

    Webhook | Maximum Retry

    Default: 4

    $$cap_GOTENBERG_WEBHOOK_MAX_RETRY
    Maximum number of retries for the webhook feature.

    Webhook | Minimum Retry Waiting Time

    Default: 1s

    $$cap_GOTENBERG_WEBHOOK_RETRY_MIN_WAIT
    Minimum duration to wait before trying to call the webhook again.

    Webhook | Maximum Retry Waiting Time

    Default: 30s

    $$cap_GOTENBERG_WEBHOOK_RETRY_MAX_WAIT
    Maximum duration to wait before trying to call the webhook again.

    Webhook | Client Timeout

    Default: 30s

    $$cap_GOTENBERG_WEBHOOK_CLIENT_TIMEOUT
    Time limit for requests to the webhook.

    Webhook | Disable

    Default: false

    $$cap_GOTENBERG_WEBHOOK_DISABLE
    Whether to disable the webhook feature.

    Prometheus | Collect Interval

    Default: 1s

    $$cap_GOTENBERG_PROMETHEUS_COLLECT_INTERVAL
    Interval for collecting modules' metrics.

    Prometheus | Namespace

    Default: gotenberg

    $$cap_GOTENBERG_PROMETHEUS_NAMESPACE
    Namespace of modules' metrics.

    Prometheus | Disable Collect

    Default: false

    $$cap_GOTENBERG_PROMETHEUS_DISABLE_COLLECT
    Whether to disable the collect of metrics.

    Prometheus | Disable Route Logging

    Default: false

    $$cap_GOTENBERG_PROMETHEUS_DISABLE_ROUTE_LOGGING
    Whether to disable the route logging.

    Logging | Format

    Default: auto

    $$cap_GOTENBERG_LOG_FORMAT
    Log format (`auto`, `json` or `text`)

    Logging | Level

    Default: info

    $$cap_GOTENBERG_LOG_LEVEL
    Log level (`error`, `warn`, `info` or `debug`)
    © 2025, Built with Gatsby - Source code available on GitHub