README
¶
Gotenberg
A containerized API for seamless PDF conversion
Read the Documentation · Try the Live Demo 🔥
Gotenberg is a containerized API that abstracts the complexity of PDF conversion.
It provides a multipart/form-data interface for interacting with powerful engines like Chromium and LibreOffice.
Instead of managing heavy dependencies, browser versions, or fonts in your own backend, simply send your files to
Gotenberg and get a PDF in return.
Quick Start
Open a terminal and run the following command:
docker run --rm -p 3000:3000 gotenberg/gotenberg:8
With the API running at http://localhost:3000, you are now ready to head
to the Full Documentation to discover how to convert URLs,
local files, inject custom CSS, merge PDFs, and more.
Sponsors
Open-source development takes a significant amount of time, energy, and dedication. If Gotenberg helps streamline your workflow or powers your business, please consider supporting its continuous improvement by becoming a sponsor! ❤️
GitHub Sponsors
Powered By
Directories
¶
| Path | Synopsis |
|---|---|
|
gotenberg
command
|
|
|
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/exiftool
Package exiftool provides an implementation of the gotenberg.PdfEngine interface using the ExifTool command-line tool.
|
Package exiftool provides an implementation of the gotenberg.PdfEngine interface using the ExifTool command-line tool. |
|
modules/libreoffice
Package libreoffice provides a module which adds a route for converting documents to PDF with LibreOffice.
|
Package libreoffice provides a module which adds a route for converting documents to PDF with LibreOffice. |
|
modules/libreoffice/api
Package api provides a module which manages a LibreOffice instance and interacts with it via the UNO (Universal Network Objects) API.
|
Package api provides a module which manages a LibreOffice instance and interacts with it via the UNO (Universal Network Objects) API. |
|
modules/libreoffice/pdfengine
Package pdfengine provides a module which interacts with LibreOffice via the UNO (Universal Network Objects) API and implements the gotenberg.PdfEngine interface.
|
Package pdfengine provides a module which interacts with LibreOffice via the UNO (Universal Network Objects) API and implements the gotenberg.PdfEngine interface. |
|
modules/logging
Package logging provides a module which creates a zap.Logger instance for other modules.
|
Package logging provides a module which creates a zap.Logger instance for other modules. |
|
modules/pdfcpu
Package pdfcpu provides an implementation of the gotenberg.PdfEngine interface using the pdfcpu command-line tool.
|
Package pdfcpu provides an implementation of the gotenberg.PdfEngine interface using the pdfcpu command-line tool. |
|
modules/pdfengines
Package pdfengines a way to gather and manage multiple modules that implement the gotenberg.PdfEngine interface.
|
Package pdfengines a way to gather and manage multiple modules that implement the gotenberg.PdfEngine interface. |
|
modules/pdftk
Package pdftk provides an implementation of the gotenberg.PdfEngine interface using the PDFtk command-line tool.
|
Package pdftk provides an implementation of the gotenberg.PdfEngine interface using the PDFtk command-line tool. |
|
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/qpdf
Package qpdf provides an implementation of the gotenberg.PdfEngine interface using the QPDF command-line tool.
|
Package qpdf provides an implementation of the gotenberg.PdfEngine interface using the QPDF command-line tool. |
|
modules/webhook
Package webhook provides a module which adds a middleware for uploading output files to any destination in an asynchronous fashion.
|
Package webhook provides a module which adds a middleware for uploading output files to any destination in an asynchronous fashion. |
|
standard
Package standard imports the application's default modules.
|
Package standard imports the application's default modules. |
|
test
|
|
|
integration
Package integration contains everything related to integration testing.
|
Package integration contains everything related to integration testing. |
|
integration/scenario
Package scenario gathers all steps used in the features.
|
Package scenario gathers all steps used in the features. |