Chainguard Container for gotenberg

A developer-friendly API for converting numerous document formats into PDF files, and more!

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/gotenberg:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

Chainguard's Gotenberg image is comparable to the 'gotenberg/gotenberg' image on Docker Hub. Unlike the Gotenberg image on Docker Hub, Chainguard's image uses a UID/GID of 65532 instead of 1001 and runs as the user nonroot instead of gotenberg. Chainguard's image contains only the minimum set of dependencies and tools needed to function.

Getting Started

Docker

Getting started with Gotenberg is as easy as running Chainguard's image with Docker:

docker run --rm -p 3000:3000 cgr.dev/ORGANIZATION/gotenberg:latest

The Gotenberg API should now be availble over localhost:3000.

By default, Chromium is configured to use angle with the swiftshader backend in Chainguard's Gotenberg image. Alternative options can be passed to Chromium passing CHROMIUM_USER_FLAGS:

docker run -e CHROMIUM_USER_FLAGS="<FLAGS>" cgr.dev/ORGANIZATION/gotenberg:latest

Helm

Alternatively, an unofficial Helm chart for Gotenberg is actively maintained here.

To deploy Gotenberg with Helm, add the repository:

helm repo add maikumori https://maikumori.github.io/helm-charts
helm repo update

Create a values manifest:

image:
  repository: cgr.dev/ORGANIZATION/gotenberg
  tag: latest
securityContext:
  readOnlyRootFilesystem: false
  allowPrivilegeEscalation: false
  privileged: false
  runAsUser: 65532

Then install the chart:

helm install gotenberg --namespace gotenberg maikumori/gotenberg --values ./values.yaml

Optionally port forward the API:

kubectl port-forward svc/gotenberg 3000:80 &

The Gotenberg API should now be availble over localhost:3000.

You should now be up and running with Gotenberg! For additional information on getting started with Gotenberg, consult the official Getting Started guide.

Resources and Documentation

• Configuring Gotenberg
• Gotenberg API routes
• Gotenberg troubleshooting
• Unofficial Gotenberg Helm chart

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.