wkhtmltopdf migration

Switch django-wkhtmltopdf to the Marqius executable

Keep your Django view and template. Change one setting and test the same download.

Marqius

Four printed variations of a shared document layout

A customer clicks Download Invoice. Django has the page ready, but the PDF tool it tries to start is gone from the new server. The customer is left without a file.

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

Why this helps

Change the program in Django’s settings and keep the same Download Invoice view. That gives you one place to make the switch and one familiar page to test.

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 python3 python3-venv
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/django-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 Django and its PDF library

Terminal
python3 -m venv .venv
.venv/bin/python -m pip install -r examples/django-wkhtmltopdf/requirements.txt

5. Call the Django PDF library

Terminal
.venv/bin/python examples/django-wkhtmltopdf/render.py /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 WKHTMLTOPDF_CMD in Django settings. Keep your PDF response class and templates while evaluating the same view with the new binary.

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 Django settings.py or the production settings module. Retain the existing rendering options unless your comparison identifies a reason to change them.

python
import os

WKHTMLTOPDF_CMD = os.environ['WKHTMLTOPDF_BINARY']

Try it with a document you know

Request the original PDF view in staging. Check the stylesheet, logo and PDF response headers from that same view. Static assets may be reachable in your browser yet unavailable from the service container.

If a shell render succeeds but the response is missing styles, trace how the view resolves static URLs. Keep your WKHTMLTOPDF_CMD_OPTIONS as they were so you can isolate the effect of changing the binary.

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 django-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 · Python pdfkit · Ruby PDFKit · Try Marqius for 30 days

Reader questions

Where should I set the path for Django?

Set WKHTMLTOPDF_CMD in the settings module loaded by the deployed process. Restart the web and job processes that use those settings.