Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sensiolabs/gotenbergbundle
A Symfony Bundle for interacting with Gotenberg. Integrates natively with twig, router, PHPStorm and more !
https://github.com/sensiolabs/gotenbergbundle
csv gotenberg html markdown office pdf pdf-generation php screenshot symfony symfony-bundle
Last synced: 3 days ago
JSON representation
A Symfony Bundle for interacting with Gotenberg. Integrates natively with twig, router, PHPStorm and more !
- Host: GitHub
- URL: https://github.com/sensiolabs/gotenbergbundle
- Owner: sensiolabs
- License: mit
- Created: 2023-12-06T16:07:11.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-19T14:36:38.000Z (8 days ago)
- Last Synced: 2024-09-20T06:18:27.646Z (7 days ago)
- Topics: csv, gotenberg, html, markdown, office, pdf, pdf-generation, php, screenshot, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 379 KB
- Stars: 21
- Watchers: 6
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gotenberg Bundle
[](https://github.com/sensiolabs/GotenbergBundle/releases)
[](https://packagist.org/packages/sensiolabs/gotenberg-bundle)
[](https://packagist.org/packages/sensiolabs/gotenberg-bundle)
[](LICENCE)
[](https://github.com/sensiolabs/GotenbergBundle/actions/workflows/static.yml?query=branch%3Amain)
[](https://github.com/sensiolabs/GotenbergBundle/actions/workflows/tests.yml?query=branch%3Amain)
> [!WARNING]
> This Bundle is experimental and subject to change in a future release.
## What is it ?
This bundle allows you to generate, stream and save PDF locally from URL, HTML, Markdown or any
Office file. Different options are available depending on the source.
It also helps you to generate, stream and save images locally from URL, HTML and Markdown using
a screenshot.
## How to install
Install the bundle using composer :
```bash
composer require sensiolabs/gotenberg-bundle
```
### With Symfony Flex
If you accept the Symfony Flex recipe during installation, the bundle is registered, the configuration
skeleton file is created, the .env file is updated with `GOTENBERG_DSN` and dockerfile is also created
to get the [gotenberg image](https://hub.docker.com/r/gotenberg/gotenberg), you need to configure the ports
related to `GOTENBERG_DSN` in your .env file.
The host could be updated too since it's localhost by default.
If your script is run in a container, the host will be `gotenberg`.
You can now adapt the configuration file to your needs.
### Without Symfony Flex
> [!CAUTION]
> To use this bundle, you first need to install and configure [Gotenberg 8.x](https://gotenberg.dev/docs/getting-started/installation).
Enable the bundle by adding it to the list of registered bundles in the ``config/bundles.php`` file of your project:
```php
// config/bundles.php
return [
// ...
SensioLabs\GotenbergBundle\SensioLabsGotenbergBundle::class => ['all' => true],
];
```
## Basic Usage
### PDF
You can generate a PDF locally from URL, HTML, Markdown or any Office files.
#### URL
After injecting ``GotenbergPdfInterface`` you simply need to call the method ``url``,
which will return a ``UrlPdfBuilder`` instance.
``UrlPdfBuilder`` lets you pass the URL of the page you want to convert into PDF
to the method ``url``.
```php
namespace App\Controller;
use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;
class YourController
{
public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
{
return $gotenberg->url()
->url('https://sensiolabs.com/fr/')
->generate()
->stream() // will return directly a stream response
;
}
}
```
> [!TIP]
> For more information go to [Gotenberg documentations](https://gotenberg.dev/docs/routes#url-into-pdf-route).
#### Twig
> [!WARNING]
> Every twig templates you pass to Gotenberg need to have the following structure.
> Even Header or Footer parts.
> ```html
>
>
>
>
> My PDF
>
>
>
>
>
> ```
```php
namespace App\Controller;
use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;
class YourController
{
public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
{
return $gotenberg->html()
->content('twig_simple_pdf.html.twig', [
'my_var' => 'value'
])
->generate()
->stream() // will return directly a stream response
;
}
}
```
If a template needs to link to a static asset (e.g. an image), this bundle provides a `{{ gotenberg_asset() }}`
Twig function to generate the correct path AND add it to the builder automatically.
This function work as [asset() Twig function](https://symfony.com/doc/current/templates.html#linking-to-css-javascript-and-image-assets)
and fetch your assets in the `assets` folder of your application
If your files are in another folder, you can override the default value of ``assets_directory`` in your
configuration file ``config/sensiolabs_gotenberg.yml``.
The path provided can be relative as well as absolute.
```html
PDF body
Hello world!
%20}})
%20}})
```
> [!TIP]
> For more information go to [Gotenberg documentations](https://gotenberg.dev/docs/routes#html-file-into-pdf-route).
### Screenshot
You can generate a screenshot locally from URL, HTML and Markdown.
#### URL
After injecting ``GotenbergScreenshotInterface`` you simply need to call the method ``url``,
which will return a ``UrlScreenshotBuilder`` instance.
``UrlScreenshotBuilder`` lets you pass the URL of the page you want to convert into screenshot
to the method ``url``.
```php
namespace App\Controller;
use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
class YourController
{
public function yourControllerMethod(GotenbergScreenshotInterface $gotenberg): Response
{
return $gotenberg->url()
->url('https://sensiolabs.com/fr/')
->generate()
->stream()
;
}
}
```
#### Twig
After injecting ``GotenbergScreenshotInterface`` you simply need to call the method ``html``,
which will return a ``HtmlScreenshotBuilder`` instance.
``HtmlScreenshotBuilder`` lets you pass the content of the page you want to convert into screenshot
to the method ``content``.
```php
namespace App\Controller;
use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
class YourController
{
public function yourControllerMethod(GotenbergScreenshotInterface $gotenberg): Response
{
return $gotenberg->html()
->content('twig_simple_pdf.html.twig', [
'my_var' => 'value'
])
->generate()
->stream()
;
}
}
```
> [!TIP]
> For more information go to [Gotenberg documentations](https://gotenberg.dev/docs/routes#screenshots-route).
### Advanced Usage
1. [Configuration](./docs/configuration.md)
2. [Working with assets](./docs/assets.md)
3. [Builders API](./docs/builders_api.md)
#### PDF
1. [Add header / footer](./docs/pdf/header-footer.md)
2. [HTML Builder](./docs/pdf/html-builder.md)
3. [Markdown Builder](./docs/pdf/markdown-builder.md)
4. [Url Builder](./docs/pdf/url-builder.md)
5. [Office Builder](./docs/pdf/office-builder.md) (available extensions for conversion below)
`123`, `602`, `abw`, `bib`, `bmp`, `cdr`, `cgm`, `cmx`, `csv`, `cwk`, `dbf`, `dif`, `doc`, `docm`,
`docx`, `dot`, `dotm`, `dotx`, `dxf`, `emf`, `eps`, `epub`, `fodg`, `fodp`, `fods`, `fodt`, `fopd`,
`gif`, `htm`, `html`, `hwp`, `jpeg`, `jpg`, `key`, `ltx`, `lwp`, `mcw`, `met`, `mml`, `mw`, `numbers`,
`odd`, `odg`, `odm`, `odp`, `ods`, `odt`, `otg`, `oth`, `otp`, `ots`, `ott`, `pages`, `pbm`, `pcd`,
`pct`, `pcx`, `pdb`, `pdf`, `pgm`, `png`, `pot`, `potm`, `potx`, `ppm`, `pps`, `ppt`, `pptm`, `pptx`,
`psd`, `psw`, `pub`, `pwp`, `pxl`, `ras`, `rtf`, `sda`, `sdc`, `sdd`, `sdp`, `sdw`, `sgl`, `slk`,
`smf`, `stc`, `std`, `sti`, `stw`, `svg`, `svm`, `swf`, `sxc`, `sxd`, `sxg`, `sxi`, `sxm`, `sxw`,
`tga`, `tif`, `tiff`, `txt`, `uof`, `uop`, `uos`, `uot`, `vdx`, `vor`, `vsd`, `vsdm`, `vsdx`, `wb2`,
`wk1`, `wks`, `wmf`, `wpd`, `wpg`, `wps`, `xbm`, `xhtml`, `xls`, `xlsb`, `xlsm`, `xlsx`, `xlt`, `xltm`,
`xltx`, `xlw`, `xml`, `xpm`, `zabw`
6. [Merge Builder](./docs/pdf/merge-builder.md)
7. [Convert Builder](./docs/pdf/convert-builder.md)
8. [PDF customization](./docs/pdf/customization.md) (available for every builder except LibreOffice and Merge)
#### Screenshot
1. [HTML Builder](./docs/screenshot/html-builder.md)
2. [Markdown Builder](./docs/screenshot/markdown-builder.md)
3. [Url Builder](./docs/screenshot/url-builder.md)
4. [Screenshot customization](./docs/screenshot/customization.md)
### Profiler
Comes with a built-in profiler panel to help you during your development.
## Credits
This bundle was inspired by [Gotenberg PHP](https://github.com/gotenberg/gotenberg-php).
- [Steven RENAUX](https://github.com/StevenRenaux)
- [Adrien ROCHES](https://github.com/Neirda24)
- [Hubert LENOIR](https://github.com/Jean-Beru)
- [All Contributors](../../contributors)
## Licence
MIT License (MIT): see the [License File](LICENSE) for more details.
## FAQ
My PDF / Screenshot is blank but I have no errors !
It may be because Gotenberg is trying to access an invalid URL (when using the `->url()` or `->route()` modes).
For example if Gotenberg tries to access a page on `https://localhost:8001` but the SSL is a local provided one. Then Chromium won't be able to authorize access to the website.
To fix this you can update your Gotenberg docker service as followed :
```diff
--- a/compose.yaml
+++ b/compose.yaml
@@ -1,6 +1,9 @@
services:
gotenberg:
image: 'gotenberg/gotenberg:8'
+ command:
+ - 'gotenberg'
+ - '--chromium-ignore-certificate-errors'
```
It can also be because from Gotenberg PoV the URL of your Symfony app is not reachable.
Let's say you are using [symfony CLI](https://symfony.com/download) to run your project locally with Gotenberg running in Docker.
You need to configure the request_context like so :
```diff
--- a/config/packages/gotenberg.yaml
+++ b/config/packages/gotenberg.yaml
@@ -6,5 +6,5 @@ framework:
sensiolabs_gotenberg:
http_client: 'gotenberg.client'
+ request_context:
+ base_uri: 'http://host.docker.internal:8000' # 8000 is the port Symfony CLI is running my app on.
```