wkhtmltopdf migration

Migrate CakePdf off wkhtmltopdf

Keep your CakePdf view and engine. Change the program that turns the view into a PDF.

Marqius

Four printed variations of a shared document layout

Your CakePHP app gets a receipt ready, with the right order details and layout. CakePdf still needs a program to turn that page into a file.

Marqius is a drop-in replacement for wkhtmltopdf. Your app can keep using CakePdf to ask for a PDF.

Why this helps

Keep the CakePdf engine setting your app already uses and change the path to the program it starts. That lets you test the receipt without rebuilding the CakePHP view.

Make your first PDF

Start with Invoice 1001 for 120.00 EUR. Open the example PDF to see what this library’s test should produce. The kit includes all 14 sample projects and a more detailed print demo for checking tables and page breaks. Open START-HERE.html after unzipping. Download the library starter kit (ZIP) · Open the library example PDF

With Docker running, unzip the demo to a fresh folder and open a terminal in the folder containing examples/. You can also start in an empty folder. The command in step 3 will fetch the files for you inside the container.

1. Open a fresh test container

Terminal
docker run --rm -it --mount "type=bind,source=$PWD,target=/proof" debian:trixie-slim bash

Run the rest of the steps in the shell that just opened. The container is a fresh Linux test environment. Your host folder is mounted as /proof, so you can open the saved PDF after the test.

2. Install the tools and Marqius

Terminal
apt-get update
DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends ca-certificates curl unzip fonts-dejavu-core poppler-utils php-cli composer php-intl php-mbstring php-xml php-gd
mkdir -p /work
cd /work
curl -fsSLo install-marqius.sh https://marqius.com/marqius-wkhtmltopdf.sh
bash install-marqius.sh --version 0.12.8 --prefix /work/bin
export PATH="/work/bin:$PATH"
export WKHTMLTOPDF_BINARY=/work/bin/marqius-wkhtmltopdf
export COMPOSER_ALLOW_SUPERUSER=1
"$WKHTMLTOPDF_BINARY" --version
wkhtmltopdf --version

The version output should include marqius-wkhtmltopdf 0.12.8. Marqius supplies the wkhtmltopdf command inside this test container.

3. Bring the demo project into the test container

Terminal
cd /work
if [ -d /proof/examples/cakepdf ]; then
  cp -R /proof/examples .
else
  curl -fsSLo wrapper-demos.zip https://marqius.com/download/wkhtmltopdf-demo/0.12.8/marqius-wrapper-demos.zip &&
    unzip -oq wrapper-demos.zip
fi

4. Install the PHP library

Terminal
cd examples/cakepdf
composer install --no-interaction --prefer-dist

5. Make the invoice through PHP

Terminal
php render.php /proof/invoice.pdf

6. Check that the PDF contains the right invoice

Terminal
pdfinfo /proof/invoice.pdf | grep '^Pages:'
pdftotext /proof/invoice.pdf - | grep -F 'Invoice 1001'
pdftotext /proof/invoice.pdf - | grep -F '120.00'
chmod a+r /proof/invoice.pdf

Look for one page, the invoice number and the amount. Type exit to close the test container. Open invoice.pdf in the folder you created on your computer.

How to switch your own app to Marqius

Keep the WkHtmlToPdfEngine and set its engine.binary value in the existing CakePdf configuration.

Install Marqius alongside the original. Set WKHTMLTOPDF_BINARY in the application process to the new executable's full path unless the example specifies a framework-specific variable. The Debian APT package installs /usr/bin/marqius-wkhtmltopdf. Debian installation guide · Downloads for other environments

Apply the change in The CakePHP application configuration where you set the CakePdf engine. Retain the existing rendering options unless your comparison identifies a reason to change them.

php
\Cake\Core\Configure::write('CakePdf.engine', [
    'className' => \CakePdf\Pdf\Engine\WkHtmlToPdfEngine::class,
    'binary' => getenv('WKHTMLTOPDF_BINARY'),
]);

Try it with a document you know

Merge this setting into your existing engine array if it carries other options. Produce a PDF using the actual CakePdf view and layout, including the header and footer. The standalone sample verifies the engine call. Your project renders the view before the engine receives HTML.

If CakePdf reports an engine lookup error, confirm the class name against the installed plugin version. If the engine loads but fails to start, check the binary path inside the app container.

Check the old and new PDFs

Save a PDF from the old setup. Make it again with the same data and fonts. Check the words, amounts and page breaks. Keep the old program path handy so you can switch back if you need to. The runnable CakePdf example exercises a sample PDF through the wrapper. The developer manual chapter records the test conditions and constraints. The public comparison scoreboard reports differences for the wkhtmltopdf and Marqius renderers.

All 14 library guides · phpwkhtmltopdf · KnpLabs Snappy · Try Marqius for 30 days

Reader questions

Do I need to select a different CakePdf engine class?

The existing WkHtmlToPdfEngine continues to start the converter. Set its binary path and preserve the other view and engine settings.