Gotenberg · Integration
Gotenberg integration
At a glance
Section titled “At a glance”Use nextpdf/gotenberg when you delegate conversion to a Gotenberg service. It is a good fit for office documents and HyperText Markup Language (HTML)-to-Portable Document Format (PDF) pipelines that should run outside the PHP process.
Section map
Section titled “Section map”| Page | Use it for |
|---|---|
| Overview | Package boundary and supported workflows. |
| Install | Composer installation and Gotenberg service prerequisites. |
| Quickstart | Your first conversion flow. |
| Configuration | Endpoint, timeout, and security configuration keys. |
| API | Bridge, configuration, payload, result, parser, office format, and pinned transport application programming interfaces (APIs). |
| Developer guide | Service boundary, payload construction, and extension points. |
| Production usage | Deployment and operational patterns. |
| Security and operations | Server-side request forgery (SSRF) controls, Multipurpose Internet Mail Extensions (MIME) handling, size limits, and pinned transport. |
| Troubleshooting | Common conversion and service failures. |
Primary APIs
Section titled “Primary APIs”| Symbol | Role |
|---|---|
NextPDF\Gotenberg\GotenbergBridge | Converts input with a Gotenberg service. |
NextPDF\Gotenberg\GotenbergConfig | Immutable service configuration. |
NextPDF\Gotenberg\GotenbergConvertPayload | Conversion request payload. |
NextPDF\Gotenberg\GotenbergConvertResult | Converted PDF bytes and response metadata. |
NextPDF\Gotenberg\OfficeFormat | Supported office-document format enum. |