![Gotenberg]()
Gotenberg
Container
Docker-powered stateless API for PDF files: conversions, generation, merging, and more. Source: https://github.com/gotenberg/gotenberg
Image details
Source details
Configuration
TypeContainerlinuxgotenberg/gotenberg:83000:3000/tcpunless-stoppedStandalone Install
Select an install method, to see config/commands for deploying Gotenberg
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Gotenberg, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see gotenberg/gotenberg for app-specific guidance.
Quick Reference
- Source code:
https://github.com/gotenberg/gotenberg - Releases notes:
https://github.com/gotenberg/gotenberg/releases - Supported architectures: (more info)
amd64,arm64v8,arm32v7,i386,ppc64le - Where to get help:
the Gotenberg Community Forums - Where to file issues:
https://github.com/gotenberg/gotenberg/issues
Tags
- Standard:
latest,8
We adhere to Semantic Versioning (SemVer), using the format MAJOR.MINOR.PATCH. See the tags list if you're looking for a specific version. - Chromium-Only:
latest-chromium,8-chromium
Drops LibreOffice, python3, and hyphenation packages. ~30% smaller than the full image. See the tags list if you're looking for a specific version. - LibreOffice-Only:
latest-libreoffice,8-libreoffice
Drops Chromium and its dependencies. ~38% smaller than the full image. See the tags list if you're looking for a specific version. - Cloud Run Optimized:
latest-cloudrun,8-cloudrun,latest-chromium-cloudrun,8-chromium-cloudrun,latest-libreoffice-cloudrun,8-libreoffice-cloudrun
We adhere to Semantic Versioning (SemVer), using the format MAJOR.MINOR.PATCH. See the tags list if you're looking for a specific version. - AWS Lambda Optimized:
latest-aws-lambda,8-aws-lambda,latest-chromium-aws-lambda,8-chromium-aws-lambda,latest-libreoffice-aws-lambda,8-libreoffice-aws-lambda
We adhere to Semantic Versioning (SemVer), using the format MAJOR.MINOR.PATCH. See the tags list if you're looking for a specific version. - Development:
edge,edge-chromium,edge-libreofficeedge-cloudrun,edge-chromium-cloudrun,edge-libreoffice-cloudrun,edge-aws-lambda,edge-chromium-aws-lambda,edge-libreoffice-aws-lambda
The latest development build from themainbranch. - Snapshots:
https://hub.docker.com/r/gotenberg/snapshot
What is Gotenberg?
Gotenberg is a Docker-based API for converting documents to PDF. Trusted in production by thousands of companies. Also adopted by notable open-source projects.Send your files via
multipart/form-data, get a PDF back. No need to manage Chromium, LibreOffice, or fonts yourself.Quick Start
docker run --rm -p 3000:3000 gotenberg/gotenberg:8Convert a URL to PDF:
curl \
--request POST http://localhost:3000/forms/chromium/convert/url \
--form url=https://sparksuite.github.io/simple-html-invoice-template/ \
-o invoice.pdfFeatures
- HTML, URL, Markdown to PDF via Headless Chromium
- Office documents to PDF via LibreOffice (100+ formats)
- Merge, split, rotate, flatten PDFs
- Watermark, stamp, encrypt PDFs
- PDF/A and PDF/UA compliance
- Screenshots of URLs and HTML
- Read/write metadata and bookmarks
- See the full documentation.
Serve Gotenberg on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying gotenberg.example.com to http://gotenberg:3000
Add this to your Caddyfile
gotenberg.example.com {
reverse_proxy http://gotenberg:3000
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs gotenberg - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:3000 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :3000 - Stop the other service, or pick a different host port. In
3000:3000only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, gotenberg can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 3000
Image won't pull
Test the pull directly on the host: docker pull gotenberg/gotenberg:8
- "manifest unknown" means the tag no longer exists.
- "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm/v7, 386, ppc64le - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect gotenberg --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Data disappears when the container is recreated
This template doesn't define any volumes, so everything gotenberg saves lives inside the container and is lost on update or recreate.
- Add a volume mapping for gotenberg's data folder before storing anything you care about.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on gotenberg/gotenberg
- Template not working: Open an issue within the template's repo
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Gotenberg runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Gotenberg needs bundled into one download. This template pulls gotenberg/gotenberg:8, which Docker fetches once (about 418 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Gotenberg's comes from Docker Hub, published by gotenberg.
Version tags
The bit after the colon in the image name is the version tag. This one pins 8, so every redeploy gives you that exact build until you bump it yourself.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, 386, ppc64le, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 3000:3000 means it's reachable on port 3000 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3000 in a browser. It opens:
3000:3000, likely the web interface
No stored data
This template doesn't mount any storage, so whatever Gotenberg writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.
Restart policy
The restart policy here is unless-stopped, so Docker restarts Gotenberg after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so Gotenberg sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container gotenberg. That's what you'll spot in the containers list and use in commands like docker logs gotenberg.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
Gotenberg is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Gotenberg up. Add the template list to Portainer once, then deploying Gotenberg is a click rather than a wall of config.