gotenberg README

The project's README from github.com/gotenberg/gotenberg. As one markdown file: README.md.

Gotenberg Logo

Gotenberg

A Docker-based API for converting documents to PDF

Total downloads (gotenberg/gotenberg) Continuous Integration Go Reference

gotenberg%2Fgotenberg | Trendshift

Documentation · Live Demo · Community


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:8

Convert 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.pdf

Features

See the full documentation.

Contributing

Questions and feedback: GitHub Discussions. Bug reports: GitHub Issues.

Sponsors

If Gotenberg powers your workflow or your business, consider becoming a sponsor.

Historic & GitHub Sponsors

Powered By

gotenberg (gotenberg/gotenberg)

Searching Database…

13.3K ·GitHub
What is this?Gotenberg is a Docker-based API that converts documents like HTML, URLs, Markdown and Office files into PDFs, and can also merge, split, watermark and screenshot them.
Is this a code library I import, or a standalone service I call?It is a standalone HTTP service you run as a Docker container; you send your files as multipart/form-data over HTTP and get a PDF back instead of linking a library into your code.
How do I get it running?Pull and run the Gotenberg Docker image, then call its HTTP endpoints to convert — for example the Quick Start example converts a URL to PDF with a single request.
Do I need to install Chromium or LibreOffice myself first?No, the Docker image already bundles Headless Chromium, LibreOffice and the fonts needed for conversion, so nothing extra has to be installed on the host.
Can I install this natively on Windows or macOS instead of using Docker?Gotenberg is only distributed as a Docker image, so you run it as a container rather than installing it natively on a particular OS.
What file types can it convert to PDF?HTML, plain URLs and Markdown are converted via Headless Chromium, while Office documents in over 100 formats are converted via bundled LibreOffice.
Can it do anything besides converting files to PDF?Yes, it can merge, split, rotate and flatten PDFs, add watermarks, stamps or encryption, enforce PDF/A or PDF/UA compliance, and read or write metadata and bookmarks.
Can it take screenshots of web pages too?Yes, Gotenberg can generate screenshots of URLs and raw HTML, not just PDFs.
Is Gotenberg actually used in production anywhere?The project says it is trusted in production by thousands of companies and has been adopted by several notable open-source projects.
Creator
gotenberg
Size
23.6 MB
Stars
13.3K
Age
8y
Commits · 90 Days