Skip to content

Docs/gotenberg 8.25 #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gulien merged 5 commits into from
Nov 16, 2025
Merged

Docs/gotenberg 8.25 #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
689ce67
doc(routes): add "embed" route and form field (#32)
Jean-Beru Nov 16, 2025
ebdb924
chore(deps): switch to Node 24.11
gulien Nov 16, 2025
35fc654
docs(embed): add missing parts
gulien Nov 16, 2025
427aa78
docs(encrypt): add documentation related to this feature
gulien Nov 16, 2025
0650bf2
docs(route): update Gotenberg version
gulien Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .node-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
23.9.0
24.11.0
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This command starts a local development server and opens up a browser window. Mo
## Prettier

```bash
npx prettier --write .
npm run format
```

This command formats the source code.
42 changes: 25 additions & 17 deletions docs/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,31 +213,39 @@ PDF files.

Currently, Gotenberg supports the following PDF engines:

| Engine | Merge | Split | Flatten | Convert into PDF/A & PDF/UA | Read/Write metadata | Name |
|----------------------------------------------|-------|-------|---------|-----------------------------|---------------------|-----------------------|
| [ExifTool](https://exiftool.org/) | ❌ | ❌ | ❌ | ❌ | ✅ | exiftool |
| [PDFtk](https://gitlab.com/pdftk-java/pdftk) | ✅ | ✅ | ❌ | ❌ | ❌ | pdtk |
| [pdfcpu](https://github.com/pdfcpu/pdfcpu) | ✅ | ✅ | ❌ | ❌ | ❌ | pdfcpu |
| [QPDF](https://github.com/qpdf/qpdf) | ✅ | ✅ | ✅ | ❌ | ❌ | qpdf |
| [UNO](https://github.com/unoconv/unoconv) | ❌ | ❌ | ❌ | ✅ | ❌ | libreoffice-pdfengine |
| Engine | Merge | Split | Flatten | Convert into PDF/A & PDF/UA | Read/Write metadata | Encrypt | Embed files | Name |
|----------------------------------------------|-------|-------|---------|-----------------------------|---------------------|---------|-------------|-----------------------|
| [ExifTool](https://exiftool.org/) | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | exiftool |
| [PDFtk](https://gitlab.com/pdftk-java/pdftk) | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | pdtk |
| [pdfcpu](https://github.com/pdfcpu/pdfcpu) | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | pdfcpu |
| [QPDF](https://github.com/qpdf/qpdf) | ✅ | ✅ | ✅ | ❌ | ❌ | ✅ | ❌ | qpdf |
| [UNO](https://github.com/unoconv/unoconv) | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | libreoffice-pdfengine |

:::info

PDFtk and QPDF only supports the split mode *pages* with unification.
PDFtk and QPDF only support the split mode *pages* with unification.

:::

:::info

PDFTk’s encryption feature requires both a user password and an owner password, and they must be different.

:::

The following flags allow you to configure the PDF Engines module:

| Flag | Environment variable | Description | Default |
|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-----------------------|
| <span class="badge badge--secondary">--pdfengines-merge-engines</span> | <span class="badge badge--secondary">PDFENGINES_MERGE_ENGINES</span> | Set the PDF engines and their order for the merge feature - empty means all. | qpdf,pdfcpu,pdftk |
| <span class="badge badge--secondary">--pdfengines-split-engines</span> | <span class="badge badge--secondary">PDFENGINES_SPLIT_ENGINES</span> | Set the PDF engines and their order for the split feature - empty means all. | pdfcpu,qpdf,pdftk |
| <span class="badge badge--secondary">--pdfengines-flatten-engines</span> | <span class="badge badge--secondary">PDFENGINES_FLATTEN_ENGINES</span> | Set the PDF engines and their order for the flatten feature - empty means all. | qpdf |
| <span class="badge badge--secondary">--pdfengines-convert-engines</span> | <span class="badge badge--secondary">PDFENGINES_CONVERT_ENGINES</span> | Set the PDF engines and their order for the convert feature - empty means all. | libreoffice-pdfengine |
| <span class="badge badge--secondary">--pdfengines-read-metadata-engines</span> | <span class="badge badge--secondary">PDFENGINES_READ_METADATA_ENGINES</span> | Set the PDF engines and their order for the read metadata feature - empty means all. | exiftool |
| <span class="badge badge--secondary">--pdfengines-write-metadata-engines</span> | <span class="badge badge--secondary">PDFENGINES_WRITE_METADATA_ENGINES</span> | Set the PDF engines and their order for the read metadata feature - empty means all. | exiftool |
| <span class="badge badge--secondary">--pdfengines-disable-routes</span> | <span class="badge badge--secondary">PDFENGINES_DISABLE_ROUTES</span> | Disable the routes. | false |
| Flag | Environment variable | Description | Default |
|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|-----------------------|
| <span class="badge badge--secondary">--pdfengines-merge-engines</span> | <span class="badge badge--secondary">PDFENGINES_MERGE_ENGINES</span> | Set the PDF engines and their order for the merge feature - empty means all. | qpdf,pdfcpu,pdftk |
| <span class="badge badge--secondary">--pdfengines-split-engines</span> | <span class="badge badge--secondary">PDFENGINES_SPLIT_ENGINES</span> | Set the PDF engines and their order for the split feature - empty means all. | pdfcpu,qpdf,pdftk |
| <span class="badge badge--secondary">--pdfengines-flatten-engines</span> | <span class="badge badge--secondary">PDFENGINES_FLATTEN_ENGINES</span> | Set the PDF engines and their order for the flatten feature - empty means all. | qpdf |
| <span class="badge badge--secondary">--pdfengines-convert-engines</span> | <span class="badge badge--secondary">PDFENGINES_CONVERT_ENGINES</span> | Set the PDF engines and their order for the convert feature - empty means all. | libreoffice-pdfengine |
| <span class="badge badge--secondary">--pdfengines-read-metadata-engines</span> | <span class="badge badge--secondary">PDFENGINES_READ_METADATA_ENGINES</span> | Set the PDF engines and their order for the read metadata feature - empty means all. | exiftool |
| <span class="badge badge--secondary">--pdfengines-write-metadata-engines</span> | <span class="badge badge--secondary">PDFENGINES_WRITE_METADATA_ENGINES</span> | Set the PDF engines and their order for the read metadata feature - empty means all. | exiftool |
| <span class="badge badge--secondary">--pdfengines-encrypt-engines</span> | <span class="badge badge--secondary">PDFENGINES_ENCRYPT_ENGINES</span> | Set the PDF engines and their order for the password protection feature - empty means all. | qpdf,pdftk,pdfcpu |
| <span class="badge badge--secondary">--pdfengines-embed-engines</span> | <span class="badge badge--secondary">PDFENGINES_EMBED_ENGINES</span> | Set the PDF engines and their order for the file embedding feature - empty means all. | pdfcpu |
| <span class="badge badge--secondary">--pdfengines-disable-routes</span> | <span class="badge badge--secondary">PDFENGINES_DISABLE_ROUTES</span> | Disable the routes. | false |

:::warning

Expand Down
Loading
Loading