gotenberg

module
v7.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 7, 2021 License: MIT

README

Gotenberg Logo

Gotenberg

A Docker-powered stateless API for PDF files

Documentation · 🔥 Live Demo


Gotenberg provides a developer-friendly API to interact with powerful tools like Chromium and LibreOffice to convert many documents (HTML, Markdown, Word, Excel, etc.) to PDF, transform them, merge them, and more!

Quick Start

Open a terminal and run the following command:

docker run --rm -p 3000:3000 gotenberg/gotenberg:7

Alternatively, using the historic Docker repository from our sponsor TheCodingMachine:

docker run --rm -p 3000:3000 thecodingmachine/gotenberg:7

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

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

Sponsors

TheCodingMachine Logo

Badges

Docker pulls Docker pulls Continuous Integration Go Reference Codecov Go Report Card

Directories

Path Synopsis
cmd
pkg
gotenberg
Package gotenberg provides most of the logic of the module system.
Package gotenberg provides most of the logic of the module system.
modules/api
Package api provides a module which is an HTTP server.
Package api provides a module which is an HTTP server.
modules/chromium
Package chromium provides a module which adds routes for converting HTML documents to PDF.
Package chromium provides a module which adds routes for converting HTML documents to PDF.
modules/gc
Package gc provides a module for removing files and directories that have expired.
Package gc provides a module for removing files and directories that have expired.
modules/libreoffice
Package libreoffice provides a module which adds a route for converting document to PDF with LibreOffice.
Package libreoffice provides a module which adds a route for converting document to PDF with LibreOffice.
modules/libreoffice/pdfengine
Package pdfengine provides a module which abstracts the CLI tool unoconv and implements the gotenberg.PDFEngine interface.
Package pdfengine provides a module which abstracts the CLI tool unoconv and implements the gotenberg.PDFEngine interface.
modules/libreoffice/unoconv
Package unoconv provides a module which abstracts the CLI tool unoconv.
Package unoconv provides a module which abstracts the CLI tool unoconv.
modules/logging
Package logging provides a module which creates a zap.Logger for other modules.
Package logging provides a module which creates a zap.Logger for other modules.
modules/pdfcpu
Package pdfcpu provides a module which wraps the https://github.com/pdfcpu/pdfcpu library and implements the gotenberg.PDFEngine interface.
Package pdfcpu provides a module which wraps the https://github.com/pdfcpu/pdfcpu library and implements the gotenberg.PDFEngine interface.
modules/pdfengines
Package pdfengines provides a module which gathers modules that implements the gotenberg.PDFEngine interface.
Package pdfengines provides a module which gathers modules that implements the gotenberg.PDFEngine interface.
modules/pdftk
Package pdftk provides a module which abstracts the CLI tool PDFtk and implements the gotenberg.PDFEngine interface.
Package pdftk provides a module which abstracts the CLI tool PDFtk and implements the gotenberg.PDFEngine interface.
modules/prometheus
Package prometheus provides a module which collects metrics and exposes them via an HTTP route.
Package prometheus provides a module which collects metrics and exposes them via an HTTP route.
modules/webhook
Package webhook provides a module which adds a middleware for uploading output files to any destinations in an asynchronous fashion.
Package webhook provides a module which adds a middleware for uploading output files to any destinations in an asynchronous fashion.
standard
Package standard imports the application's default modules.
Package standard imports the application's default modules.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL