composer require sensiolabs/gotenberg-bundle
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 by taking a screenshot.
Note
This bundle interacts with the amazing Gotenberg API which is used under the hood.
🔎 Profiler
✅ Testing
🙋 FAQ
❤️ Credits
📃 Licence
Note
You first need to install and configure Gotenberg 8.x by yourself.
Install the bundle using composer:
composer require sensiolabs/gotenberg-bundleIf you accept the Symfony Flex recipe during installation:
- The bundle will be automatically registered.
- A configuration skeleton file will be created.
- Docker Compose will be updated with a new gotenberg service.
- The
.envfile will be updated with aGOTENBERG_DSNvalue pointing togotenberg:3000. You can update this value if your Gotenberg instance is hosted elsewhere.
Manually enable the bundle by adding it to the list of registered bundles in your config/bundles.php file:
// config/bundles.php
return [
// ...
SensioLabs\GotenbergBundle\SensioLabsGotenbergBundle::class => ['all' => true],
];Create a configuration and adapt to your needs:
# ./config/packages/sensiolabs_gotenberg.yaml
framework:
http_client:
scoped_clients:
gotenberg.client:
base_uri: 'http://gotenberg:3000'
sensiolabs_gotenberg:
http_client: 'gotenberg.client'You can generate a PDF locally from URL, HTML, Markdown or any Office files.
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.
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.
Warning
Every Twig template you pass to Gotenberg must have the following structure. Even Header or Footer parts.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>My PDF</title>
</head>
<body>
<!-- Your code goes here -->
</body>
</html>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 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.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>PDF body</title>
</head>
<body>
<main>
<h1>Hello world!</h1>
<img src="{{ gotenberg_asset('public/img/ceo.jpeg') }}" alt="CEO"/>
<img src="{{ gotenberg_asset('public/img/admin.jpeg') }}" alt="Admin"/>
</main>
</body>
</html>Tip
For more information go to Gotenberg documentations.
You can generate a screenshot locally from URL, HTML and Markdown.
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.
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()
;
}
}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.
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.
- Configuration
- Processing (saving for example)
- Working with assets
- Builders API
- Async & Webhooks
- Working with fonts
-
Office Builder (available extensions for conversion below)
📝
doc,docx,docm,dot,dotx,dotm,odt,ott,sdw,stw,sxw,sxg,fodt,rtf,txt,abw,zabw,cwk,psw,lwp,mcw,wpd,wps,pages,hwp,uof,uot📊
xls,xlsx,xlsm,xlsb,xlt,xltx,xltm,xlw,ods,ots,sdc,stc,sxc,uos,csv,dif,slk,123,wk1,wks,wb2📽️
ppt,pptx,pptm,pot,potx,potm,pps,odp,otp,sdd,sdp,sxi,sti,uop,key🖼️
svg,cdr,odg,otg,sda,sxd,std,svm,fodg,eps,emf,wmf,dxf,cgm,cmx,met,mml,vdx,vsd,vsdx,vsdm,vor,bmp,gif,jpeg,jpg,png,tif,tiff,pbm,pgm,ppm,ras,pcx,pcd,pct,psd,tga,xbm,xpm,wpg📚
epub,pdf,odd,odm,oth,html,htm,xhtml,xml,pub,pwp,bib,ltx🗃️
dbf,pdb,wb2,mw🧩
swf,smf🏗️
dxf,vdx,vsd,vsdx,vsdm🧪
sxm,mml,ltx,mw -
PDF customization (available for HTML, Markdown and Url builder)
Comes with a built-in profiler panel to help you during your development.
This bundle provides classes to assist with testing when using PHPUnit.
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:--- 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 to run your
project locally with Gotenberg running in Docker. You need to configure the
request_context like so:
--- 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.This bundle was inspired by Gotenberg PHP.
MIT License (MIT): see the License File for more details.
