A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF
Clone or download
Latest commit 2648992 Jan 3, 2019

README.md

Gotenberg logo

Gotenberg

A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.

Documentation · Contributing


At TheCodingMachine, we build a lot of web applications (intranets, extranets and so on) which require to generate PDF from various sources. Each time, we ended up using some well known libraries and kind of lost time by reimplementing a solution from a project to another project. Meh.

Features

  • HTML and Markdown conversions using Google Chrome headless
  • Office conversions (.txt, .rtf, .docx, .doc, .odt, .pptx, .ppt, .odp and so on) using unoconv
  • Performance ⚡️: Google Chrome and Libreoffice (unoconv) started once in the background thanks to PM2
  • Failure prevention 💔: PM2 automatically restarts previous processes if they fail
  • Assets 📦: send your header, footer, images, fonts, stylesheets and so on for converting your HTML and Markdown to beaufitul PDFs!
  • Easily interact with the API using our Go and PHP libraries

Quick start

Open a terminal and run the following command:

$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:3

The API is now available on your host at http://localhost:3000.

Head to the documentation to learn how to interact with it!

Badges

Docker image layers Travis CI GoDoc Go Report Card


Psst: TheCodingMachine is always looking for talented coders.