gotenberg v0.1.0

Dev tools

Gotenberg — a stateless, Docker-based API for converting HTML, Markdown, Office documents, and URLs into PDFs (and merging/transforming them) via Chromium and LibreOffice. Deployed as a host-networked Nomad service; stateless, so it can scale to multiple instances.

nomad-pack run gotenberg --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- gotenberg

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 13.2k ⚑ Report an issue

1 task http 3015 image gotenberg/gotenberg:8 pinned :8 image bumped today

Variables 8

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run gotenberg -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "gotenberg"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Gotenberg container image. Pin a tag in production.
image = "gotenberg/gotenberg:8"

# Host port for the Gotenberg API (--api-port).
port = 3015

# How many instances to run. Gotenberg is stateless, so you can run several behind a load balancer.
count = 1

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# Resources for the Gotenberg task. Chromium/LibreOffice conversions can spike CPU and memory.
resources = {
    cpu    = 1000
    memory = 1024
  }

Name	Type	Default	Description
job_name	string	"gotenberg"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"gotenberg/gotenberg:8"	The Gotenberg container image. Pin a tag in production.
port	number	3015	Host port for the Gotenberg API (--api-port).
count	number	1	How many instances to run. Gotenberg is stateless, so you can run several behind a load balancer.
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 1000 memory = 1024 }	Resources for the Gotenberg task. Chromium/LibreOffice conversions can spike CPU and memory.

Readme

gotenberg

Gotenberg — a developer-friendly, stateless API for generating PDFs. Convert HTML, Markdown, URLs, and Office documents (via Chromium and LibreOffice), merge PDFs, add screenshots, and more — all over a simple HTTP API.

Single host-networked Nomad service. Stateless (no volumes), so you can raise count and run several instances behind a load balancer.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run gotenberg --registry=nomploy

Configure

Variable	Default	Description
`port`	`3015`	API port (`--api-port`).
`count`	`1`	Instances to run (stateless — safe to scale).
`image`	`gotenberg/gotenberg:8`	Container image. Pin a tag in production.
`resources`	`{ cpu = 1000, memory = 1024 }`	Task resources. Conversions can spike CPU/RAM.

Example — render a URL to PDF:

curl --request POST http://<node-ip>:3015/forms/chromium/convert/url \
  --form url=https://example.com -o out.pdf

The API has no authentication — keep it on an internal network or behind a reverse proxy, and point apps like paperless-ngx or Docmost at it for document conversion.