Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down Expand Up @@ -227,6 +228,7 @@ The following flags allow you to configure the Webhook module:

| Flag | Description | Default |
|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|---------|
| <span class="badge badge--secondary">--webhook-enable-sync-mode</span> | Enable synchronous mode for the webhook feature. | false |
| <span class="badge badge--secondary">--webhook-allow-list</span> | Set the allowed URLs for the webhook feature using a regular expression. | All |
| <span class="badge badge--secondary">--webhook-deny-list</span> | Set the denied URLs for the webhook feature using a regular expression. | None |
| <span class="badge badge--secondary">--webhook-error-allow-list</span> | Set the allowed URLs in case of an error for the webhook feature using a regular expression. | All |
Expand Down Expand Up @@ -290,6 +292,14 @@ sequence.

:::

## Hide Banner

The following flag allows you to hide the startup banner with:

| Flag | Description | Default |
|---------------------------------------------------------------------|------------------|---------|
| <span class="badge badge--secondary">--gotenberg-hide-banner</span> | Hide the banner. | false |

## Docker Image

### Fonts
Expand Down
51 changes: 29 additions & 22 deletions docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,36 +157,43 @@ 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).

:::

## 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` architectures:

```
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
Expand Down
4 changes: 2 additions & 2 deletions docs/routes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2528,7 +2528,7 @@ Content-Type: text/plain; charset=UTF-8
Gotenberg-Trace: {trace}
Body:

8.21.1
8.22.0
```

</TabItem>
Expand All @@ -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`.

:::

Expand Down