# Gotenberg

Gotenberg is a developer-friendly API for converting HTML, Markdown, and Office documents into PDFs using Chromium and LibreOffice. It is open source and self-hosted, installable on Proxmox, Kubernetes (Helm), Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/44/gotenberg

## Description

Gotenberg is a developer-friendly API for converting HTML, Markdown, and Office documents into PDFs using Chromium and LibreOffice. It is pre-configured for Paperless-ngx, making it a practical option for self-hosted document pipelines.

## Platform availability

Available on 3 of 9 platforms: Unraid, Proxmox, Helm.

## Health score

83/100 (Excellent), based on 5 of 5 factors.
- Maintained: 100 (last commit 17 days ago)
- Popular: 82 (13,235 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)
- Light to run: 80 (1 GB minimum RAM, runs on ARM)
- Security check: 79 (no serious findings, CI, tests, OpenSSF Scorecard 4.8/10)

## Links

- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=gotenberg
- Kubernetes (Helm): https://artifacthub.io/packages/helm/maikumori/gotenberg
- Docker Hub: https://hub.docker.com/r/gotenberg/gotenberg
- Unraid: https://ca.unraid.net/apps/gotenberg-0hpw0ui0jbf37q?q=gotenberg
- Official website: https://gotenberg.dev/
- GitHub: https://github.com/gotenberg/gotenberg
- Documentation: https://gotenberg.dev/docs/configuration

## Common questions

### How do I change Gotenberg settings when running it in Docker?

Configure it with CLI flags or environment variables by overriding the Docker image's default command.

### Which port should I expose for the Gotenberg API?

Expose port 3000, for example with -p 3000:3000, because conversion requests are sent to this HTTP API.

### Can Gotenberg convert Microsoft Word files?

Yes, it converts Word, Excel, PowerPoint, and 100+ other formats to PDF using LibreOffice.

### How do I wait for JavaScript-heavy pages to finish before creating a PDF?

Use options to wait for network idle, JavaScript expressions, or specific DOM selectors before rendering SPAs.

### How can I confirm a restored Gotenberg setup works?

Recreate Gotenberg on another host and verify custom fonts, templates, and command flags reproduce known document page counts.

### Where should I look if a conversion problem is not documented?

Check the GitHub issues and discussions, or open a new issue.

---
Source: Our Local Host (https://ourlocalhost.com/app/44/gotenberg), the self-hosted and open-source app directory.
