wkhtmltopdf migration

Switch Node.js wkhtmltopdf to the Marqius executable

Keep the Node wkhtmltopdf library and its stream. Set the command to Marqius.

Marqius

Four printed variations of a shared document layout

A Node app starts a PDF job and writes the result to a file as it comes in. The job fails on the new image because the old PDF command isn’t there.

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

Why this helps

Change the command the Node library starts. The app can keep writing the PDF through the same stream. Wait for the file to finish before checking it.

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" node:22-bookworm-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
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
"$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/node-wkhtmltopdf ]; 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 Node wkhtmltopdf package

Terminal
cd examples/node-wkhtmltopdf
npm install

5. Wait for the PDF stream to finish

Terminal
node render.js /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

Set the Node wrapper's command property at process start. Keep the returned stream and wait for it to reach the output file before reading the PDF.

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 module where your app initializes the wkhtmltopdf npm package. Retain the existing rendering options unless your comparison identifies a reason to change them.

javascript
const wkhtmltopdf = require('wkhtmltopdf');
wkhtmltopdf.command = process.env.WKHTMLTOPDF_BINARY;

Try it with a document you know

Use your existing pipeline or stream handler and wait for completion. Test an actual request and check PDF text and page count after the stream ends. A process that reads early can mistake an incomplete file for a rendering failure.

On a server or in a container, set the variable in the environment of the Node process. If your template uses JavaScript, test whether all rows and amounts are actually present in the finished PDF.

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 Node.js wkhtmltopdf 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 · go-wkhtmltopdf · Java wkhtmltopdf wrapper · Try Marqius for 30 days

Reader questions

Does this apply to Puppeteer?

This guide applies to the wkhtmltopdf npm package that spawns a CLI. Puppeteer drives Chromium through a different interface.