Gotenberg

Gotenberg is a stateless API for converting various document formats into PDF files. For more information, see the Gotenberg documentation.

Supported versions

• 8

You can select the major version. But the latest compatible minor version is applied automatically and can’t be overridden.

Patch versions are applied periodically for bug fixes and the like. When you deploy your app, you always get the latest available patches.

Relationship reference

Example information available through the PLATFORM_RELATIONSHIPS environment variable or by running platform relationships.

GOTENBERG_INSTANCE_IPS=["249.45.240.83"]
GOTENBERG_SCHEME=http
GOTENBERG_HOSTNAME=rssjaxyeoorjje6axcq35xu5gq.gotenberg.service._.eu-5.platformsh.site
GOTENBERG_SERVICE=gotenberg
GOTENBERG_CLUSTER=p2f2xrzyq7a6k-main-bvxea6i
GOTENBERG_IP=169.254.137.3
GOTENBERG_TYPE=gotenberg:8
GOTENBERG_HOST=gotenberg.internal
GOTENBERG_PORT=3000
GOTENBERG_REL=http

{
      "host": "gotenberg.internal",
      "hostname": "rssjaxyeoorjje6axcq35xu5gq.gotenberg.service._.eu-5.platformsh.site",
      "cluster": "p2f2xrzyq7a6k-main-bvxea6i",
      "service": "gotenberg",
      "rel": "http",
      "scheme": "http",
      "port": "3000",
      "type": "gotenberg:8",
      "instance_ips": [
      "249.45.240.83"
      ],
      "ip": "169.254.137.3",
      "url": "http://gotenberg.internal:3000"
    }

# Decode the built-in credentials object variable.
export RELATIONSHIPS_JSON=$(echo $PLATFORM_RELATIONSHIPS | base64 --decode)

# Set environment variables for individual credentials.
export APP_GOTENBERG_HOST=="$(echo $RELATIONSHIPS_JSON | jq -r '.gotenberg[0].host')"

Usage example

1. Configure the service

To define the service, use the gotenberg type:

# The name of the service container. Must be unique within a project.
<SERVICE_NAME>:
    type: gotenberg:<VERSION>

Note that changing the name of the service replaces it with a brand new service and all existing data is lost. Back up your data before changing the service.

2. Add the relationship

To define the relationship, use the http endpoint:

# Relationships enable access from this app to a given service.
relationships:
    <RELATIONSHIP_NAME>: "<SERVICE_NAME>:http"

You can define <SERVICE_NAME> as you like, so long as it’s unique between all defined services and matches in both the application and services configuration.

With the above definition, Platform.sh uses the http endpoint, providing a relationship (the network address a service is accessible from) that is identical to the name of the service.

The application has access to the service via this relationship and its corresponding PLATFORM_RELATIONSHIPS environment variable.

The http endpoint uses port 3000 by default.

Example configuration

Service definition

# The name of the service container. Must be unique within a project.
gotenberg:
    type: gotenberg:8

App configuration

# Relationships enable access from this app to a given service.
relationships:
    gotenberg: "gotenberg:http"

Generate a PDF using Gotenberg

As an example, to generate a PDF file of the Platform.sh website, run the following cURL command:

curl \
--request POST http://yduimhaby523ase4lju3qhimre.gotenberg8.service._.eu-3.platformsh.site/forms/chromium/convert/url \
--form url=https://platform.sh \
--form landscape=true \
--form marginTop=1 \
--form marginBottom=1 \
-o my.pdf