PDF generation with Gotenberg

Published November 4, 2023・Last updated October 23, 2024・1 min read

Gotenberg is a Docker-based stateless API for PDF generation from HTML and Markdown files.

To get started, configure Docker compose and run the docker-compose up command.

version: '3.8'
services:
  gotenberg:
    image: gotenberg/gotenberg:7
    ports:
      - 3000:3000

API is available on http://localhost:3000 address.

Run the following commands to generate PDFs

from the given URL

curl \
  --request POST 'http://localhost:3000/forms/chromium/convert/url' \
  --form 'url="https://sparksuite.github.io/simple-html-invoice-template/"' \
  --form 'pdfFormat="PDF/A-1a"' \
  -o curl-url-response.pdf

from the given HTML file

curl \
  --request POST 'http://localhost:3000/forms/chromium/convert/html' \
  --form 'files=@"./index.html"' \
  --form 'pdfFormat="PDF/A-1a"' \
  -o curl-html-response.pdf

PDF/A-1a format is used for the long-term preservation of electronic documents, ensuring that documents can be accessed and read even as technology changes.

Demo

The demo with the mentioned examples is available here. It also contains examples using Fetch API and Axios package.