wkhtmltopdf migration

Migrate Elixir pdf_generator off wkhtmltopdf

Keep your Elixir PDF call. Set the Marqius path in the release’s runtime settings.

Marqius

Four printed variations of a shared document layout

An Elixir app makes PDF receipts on a background worker. A release moves to a new image and the worker can no longer find the old command.

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

Why this helps

Read the program path from the release’s environment. That lets you test a new server or container while keeping the receipt code and the existing PDF call.

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 elixir
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/elixir-pdf-generator ]; 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 Hex and fetch the Elixir library

Terminal
cd examples/elixir-pdf-generator
mix local.hex --force
mix deps.get

5. Make the invoice through pdf_generator

Terminal
mix run render.exs /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

Configure wkhtml_path for the pdf_generator application. Keep your PdfGenerator.generate_binary call and existing rendering options.

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 config/runtime.exs for a Mix release, under the correct environment configuration. Retain the existing rendering options unless your comparison identifies a reason to change them.

elixir
import Config

config :pdf_generator, wkhtml_path: System.fetch_env!("WKHTMLTOPDF_BINARY")

Try it with a document you know

Restart the release and pass the same HTML to the worker that produces the PDF. Check the returned bytes or error and render a receipt containing your currency and locale characters.

If mix run works from a development shell but the built release fails, inspect the environment provided to the release. Runtime config lets you supply the path without embedding a developer machine path at build time.

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 Elixir pdf_generator 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 · Rotativa.AspNetCore · go-wkhtmltopdf · Try Marqius for 30 days

Reader questions

Where should a Mix release read the binary path?

Read the deployed path in runtime configuration and pass it as wkhtml_path to pdf_generator. Set the variable before booting the release.