wkhtmltopdf migration

Switch Java wkhtmltopdf wrapper to the Marqius executable

Keep your Java PDF calls. Pass the Marqius path when you create the PDF object.

Marqius

Four printed variations of a shared document layout

A Java batch job sends PDF statements at the end of the day. The job still has all the data, but the new Linux image doesn’t have the PDF program at the old path.

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

Why this helps

Pass the new path where the app creates its PDF object. The Java job can keep building statements the same way while you make sure the new image can start Marqius.

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: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 default-jdk-headless maven
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/java-wkhtmltopdf-wrapper ]; 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. Compile the Java example

Terminal
cd examples/java-wkhtmltopdf-wrapper
mvn -B -q compile

5. Run the Java invoice example

Terminal
mvn -B -q exec:java -Dexec.mainClass=Smoke -Dexec.args=/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

Pass the executable path through WrapperConfig when constructing Pdf for the jhonnymertz wrapper.

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 Java factory that constructs com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf. Retain the existing rendering options unless your comparison identifies a reason to change them.

java
import com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig;

Pdf pdf = new Pdf(new WrapperConfig(System.getenv("WKHTMLTOPDF_BINARY")));

Try it with a document you know

Run with the same JDK container and file permissions as the service. Test a document with UTF-8 text and the real font bundle. Inspect the exception or stderr if the wrapper reports that the native process could not start.

An executable copied into a Linux image must match the image's CPU architecture. Confirm with dpkg --print-architecture on Debian-based images and check the binary's --version inside that image.

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

Reader questions

Can the Java dependency install the Linux executable?

The wrapper calls an executable it can reach in the running environment. Install or copy the converter as part of your Linux image build and configure the path.