The highest tagged major version is
README
¶
Gotenberg
A Docker-powered stateless API for PDF files
Gotenberg provides a developer-friendly API to interact with powerful tools like Chromium and LibreOffice for converting numerous document formats (HTML, Markdown, Word, Excel, etc.) into PDF files, 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
Badges
Directories
¶
| Path | Synopsis |
|---|---|
|
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/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 library.
|
Package pdfcpu provides an implementation of the gotenberg.PdfEngine interface using the pdfcpu library. |
|
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. |
Click to show internal directories.
Click to hide internal directories.