Raised: $0
0% of monthly goal Help us cross the finish line!
Goal: $12,000
Raised: $0 Goal: $12,000
0% of monthly goal Help us cross the finish line!
Sponsor DDEV

add-on registry tests last commit release

ddev-gotenberg

Overview

This DDEV add-on integrates Gotenberg, a powerful API for PDF generation and document conversions, into your DDEV project. It makes it easy to convert HTML, Markdown, Office documents, and more into PDFs directly from your local dev environment.

Installation

ddev add-on get echavaillaz/ddev-gotenberg
ddev restart

After installation, make sure to commit the .ddev directory to version control.

Usage

Once installed, the add-on runs a Gotenberg service accessible inside your project.

Command Description
ddev describe View service status and ports
ddev logs -s gotenberg Check Gotenberg logs
curl http://gotenberg:3000/health Health check inside the DDEV container
curl -F [email protected] http://gotenberg:3000/forms/libreoffice/convert Convert a DOCX to PDF

By default, your application should connect to Gotenberg at:

http://gotenberg:3000

Advanced Customization

You can change the Gotenberg Docker image or version by overriding the default environment:

ddev dotenv set .ddev/.env.gotenberg --gotenberg-docker-image="gotenberg/gotenberg:8"
ddev add-on get echavaillaz/ddev-gotenberg
ddev restart

Customization options:

Variable Flag Default
GOTENBERG_DOCKER_IMAGE --gotenberg-docker-image gotenberg/gotenberg:8

Commit the .ddev/.env.gotenberg file to share settings across your team.

Credits

Maintained by @echavaillaz. Powered by Gotenberg and DDEV.

Resources