Skip to main content

Deployment

This guide explains how to deploy bkhtmltopdf Enterprise Edition (EE) using Docker. The Enterprise Edition supports headless mode, making it suitable for production environments.

After purchase, you will receive an activation email containing the Docker image file (.tar format) and the activation code (LICENSE).

warning

bkhtmltopdf Enterprise Edition only supports deployment via Docker and is compatible with Docker CE and Docker EE ( version 20.10+).

Prerequisites​

Install Docker​

For detailed installation instructions, refer to the official documentation: https://docs.docker.com/engine/install/

Verify the installation:

docker --version

The output should be similar to: Docker version 27.0.3, build 7d4bcd8.

tip

Make sure the Docker service is running and there is enough disk space (at least 10GB for images and data).

Deployment Steps​

Load Image​

After downloading the .tar file from the email, load it into Docker using the following command:

docker load < bkhtmltopdf-ee-x.y.z.tar

Replace bkhtmltopdf-ee-x.y.z.tar with the actual file name (e.g., bkhtmltopdf-ee-1.0.0.tar).

Verify Image Load​

docker images | grep bkhtmltopdf

The image bkhtmltopdf-ee:x.y.z should be displayed.

Start Container​

Start the container using the activation code. Recommended configuration:

  • --shm-size=256mb: Allocate shared memory to improve Chromium rendering performance.
  • -e BKHTMLTOPDF_LICENSE="YOUR_LICENSE": Replace with the activation code from the email.
  • -p 8080:8080: Map the port to host 8080.
  • --restart always: Enable automatic restart.
docker run --shm-size=256mb --name bkhtmltopdf-ee \
  -e BKHTMLTOPDF_LICENSE="YOUR_LICENSE" \
  -itd --restart always -p 8080:8080 bkhtmltopdf-ee:x.y.z
  • Replace YOUR_LICENSE with the actual activation code.
  • Replace x.y.z with the version number (e.g., 1.0.0).

Check the logs:

docker logs bkhtmltopdf-ee

The startup success log should look like:

Tomcat started on port 8080 (http) with context path '/'
Started Application in 1.792 seconds

Verify Deployment​

BKHTMLTOPDF EE