From 5c34665efcbfe2a69668646b0ad78d6a208fdbc7 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Sat, 16 Aug 2025 12:05:19 +0200 Subject: [PATCH 1/7] docs(configuration): add --webhook-enable-sync-mod flag --- docs/configuration.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/configuration.mdx b/docs/configuration.mdx index 606ab5f..396c861 100644 --- a/docs/configuration.mdx +++ b/docs/configuration.mdx @@ -227,6 +227,7 @@ The following flags allow you to configure the Webhook module: | Flag | Description | Default | |------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|---------| +| --webhook-enable-sync-mode | Enable synchronous mode for the webhook feature. | false | | --webhook-allow-list | Set the allowed URLs for the webhook feature using a regular expression. | All | | --webhook-deny-list | Set the denied URLs for the webhook feature using a regular expression. | None | | --webhook-error-allow-list | Set the allowed URLs in case of an error for the webhook feature using a regular expression. | All | From 9e4963f95f99e978cb0a220097b4ae2c1914a5a4 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Mon, 18 Aug 2025 21:05:28 +0200 Subject: [PATCH 2/7] docs(installation): add Cloud Run defaults --- docs/getting-started/installation.mdx | 29 +++++++-------------------- 1 file changed, 7 insertions(+), 22 deletions(-) diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx index d55fa1e..142eb2e 100644 --- a/docs/getting-started/installation.mdx +++ b/docs/getting-started/installation.mdx @@ -157,31 +157,16 @@ Alternatively, using the historic Docker repository from our sponsor [TheCodingM thecodingmachine/gotenberg:8-cloudrun ``` -Using the Google Cloud CLI: +This image is preconfigured for Cloud Run: -```bash -gcloud run deploy {deployment_name} \ ---memory=1Gi \ ---image=gotenberg/gotenberg:8-cloudrun \ ---args=gotenberg \ ---args="--gotenberg-build-debug-data=false" ---args="--api-port-from-env=PORT" \ ---args="--log-enable-gcp-fields=true" \ ---args="--webhook-disable=true" \ ---args="--chromium-auto-start=true" \ ---args="--libreoffice-auto-start=true" -``` +* Uses the `PORT` environment variable provided by Cloud Run. +* Logs in a format compatible with Cloud Run. +* Auto-starts Chromium and LibreOffice for faster readiness. +* Uses synchronous webhook mode, since Cloud Run may stop the container if there’s no HTTP activity. -* At least `1Gi` of memory is required for a [smooth experience](https://github.com/gotenberg/gotenberg/issues/950#issuecomment-2329228662). -* Not building the debug data can drastically decrease startup time. -* By default, requests are sent to port *8080*, but you can configure Cloud Run to send requests to the port of your choice. -Cloud Run injects the `PORT` environment variable into the ingress container. -* Log using fields supported by Cloud Run. -* The webhook feature does not work properly, as Cloud Run may stop the container if there is no HTTP activity, regardless -of the asynchronous processes. -* Enabling Chromium and/or LibreOffice auto-start improves the readiness of Gotenberg in a serverless context. +:::tip -:::info +At least `1Gi` of memory is required for a [smooth experience](https://github.com/gotenberg/gotenberg/issues/950#issuecomment-2329228662). Consider using HTTP/2 to bypass the [32MB request size limit](https://cloud.google.com/run/quotas?hl=en). From 537774ccef6cebed916256a77d717c5f33d76ddd Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Mon, 18 Aug 2025 21:11:53 +0200 Subject: [PATCH 3/7] docs(configuration): all arch on Chromium --- docs/configuration.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/configuration.mdx b/docs/configuration.mdx index 396c861..ba85b7f 100644 --- a/docs/configuration.mdx +++ b/docs/configuration.mdx @@ -98,7 +98,8 @@ To maintain performance under a heavy load, consider increasing the number of Go :::caution -The `amd64` Docker image uses Google Chrome stable, while other architectures use Chromium. +Before Gotenberg *8.22.0*, the `amd64` image used Google Chrome (stable), while other architectures used Chromium. +Now all architectures use Chromium. ::: From 33819c8ab0daf16746c4a4d3a4ba328e7a160c7d Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Mon, 18 Aug 2025 21:16:58 +0200 Subject: [PATCH 4/7] docs(configuration): add --gotenberg-hide-banner --- docs/configuration.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/configuration.mdx b/docs/configuration.mdx index ba85b7f..e28ce6f 100644 --- a/docs/configuration.mdx +++ b/docs/configuration.mdx @@ -292,6 +292,14 @@ sequence. ::: +## Hide Banner + +The following flag allows you to hide the startup banner with: + +| Flag | Description | Default | +|---------------------------------------------------------------------|------------------|---------| +| --gotenberg-hide-banner | Hide the banner. | false | + ## Docker Image ### Fonts From 8c159c8dc520ad5e76aae454623a68d8e0138b54 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Mon, 18 Aug 2025 21:23:35 +0200 Subject: [PATCH 5/7] docs(installation): add AWS Lambda --- docs/getting-started/installation.mdx | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx index 142eb2e..ab9f2c1 100644 --- a/docs/getting-started/installation.mdx +++ b/docs/getting-started/installation.mdx @@ -172,6 +172,28 @@ Consider using HTTP/2 to bypass the [32MB request size limit](https://cloud.goog ::: +## AWS Lambda + +If cost-efficiency is a priority, [AWS Lambda](https://docs.aws.amazon.com/lambda) can be a good option. + +We provide a dedicated Docker image tag, available on both `linux/amd64` and `linux/arm64` architecures: + +``` +gotenberg/gotenberg:8-aws-lambda +``` + +Alternatively, using the historic Docker repository from our sponsor [TheCodingMachine](https://www.thecodingmachine.com): + +``` +thecodingmachine/gotenberg:8-aws-lambda +``` + +This image is preconfigured for AWS Lambda: + +* Uses the `AWS_LWA_PORT` environment variable to configure its port. +* Auto-starts Chromium and LibreOffice for faster readiness. +* Uses synchronous webhook mode, since AWS may stop the container if there’s no HTTP activity. + ## What's next? Now that you have Gotenberg up and running, you can start using it. Install a custom [client](clients) or From f7db8be4130c913a52ff919b8cd1f0c6b1312dac Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Mon, 18 Aug 2025 21:24:33 +0200 Subject: [PATCH 6/7] docs(route): update Gotenberg version --- docs/routes.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/routes.mdx b/docs/routes.mdx index d4ad6a1..5711c23 100644 --- a/docs/routes.mdx +++ b/docs/routes.mdx @@ -2528,7 +2528,7 @@ Content-Type: text/plain; charset=UTF-8 Gotenberg-Trace: {trace} Body: -8.21.1 +8.22.0 ``` @@ -2538,7 +2538,7 @@ Body: Custom variants of Gotenberg may not print a strict semver version. -For instance, the live demo prints `8.21.1-live-demo-snapshot`. +For instance, the live demo prints `8.22.0-live-demo-snapshot`. ::: From 761785a5ab1d91c0bf0a8f4023d057d67a16ded1 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Tue, 19 Aug 2025 08:47:03 +0200 Subject: [PATCH 7/7] docs(installation): fix typo architecures => architectures --- docs/getting-started/installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx index ab9f2c1..95e591c 100644 --- a/docs/getting-started/installation.mdx +++ b/docs/getting-started/installation.mdx @@ -176,7 +176,7 @@ Consider using HTTP/2 to bypass the [32MB request size limit](https://cloud.goog If cost-efficiency is a priority, [AWS Lambda](https://docs.aws.amazon.com/lambda) can be a good option. -We provide a dedicated Docker image tag, available on both `linux/amd64` and `linux/arm64` architecures: +We provide a dedicated Docker image tag, available on both `linux/amd64` and `linux/arm64` architectures: ``` gotenberg/gotenberg:8-aws-lambda