guideExport to PDF On-Premises installation

A valid license key is needed in order to install Export to PDF On-Premises.
Contact us for a trial license key.

# Supported technologies

The application is provided as a docker image by default.

It can be run with any Open Container runtime tool e.g. Kubernetes, OpenShift, Podman, Docker and many others.

Refer to the Requirements guide for more information about the hardware and software requirements to run the Export to PDF On-Premises.

# Setting up the application using Kubernetes with Helm charts

Use the provided Helm chart to set up the Export to PDF On-Premises.
More instructions and the Helm chart you will find in our repository.

# Setting up the application using a Docker container

  1. Use instructions from the CKEditor Ecosystem customer dashboard to log into the Export to PDF On-Premises (PDF converter) Docker registry and pull the Docker image.

  2. Containerize the application using docker or docker-compose.

  3. Use a demo page to verify if the application works properly.

# Containerize example using docker

Launch the Docker container:

docker run --init -p 8080:8080 -e LICENSE_KEY=[your_license_key][version]

If you want to use authorization you should provide SECRET_KEY:

docker run --init -p 8080:8080 -e LICENSE_KEY=[your_license_key] -e SECRET_KEY=[your_secret_key][version]

You can read more about using authorization in the authorization section.

# Containerize example using docker-compose

  1. Create the docker-compose.yml file:
version: "3.8"
        - "8080:8080"
      restart: always
      init: true
        LICENSE_KEY: your_license_key
        # Secret Key is optional
        SECRET_KEY: secret_key
        # Custom request origin is optional
        CUSTOM_REQUEST_ORIGIN: https://your_custom_origin

For details on SECRET_KEY usage check the authorization section.

  1. Run:
docker-compose up

# Notes

  • Without a correct LICENSE_KEY the application will not start. If the license is invalid, you’ll get a Wrong license key error in the logs and the application will not run.
  • You should override the SECRET_KEY variable using a unique and hard to guess string for security reasons.
  • If your infrastructure has strict CORS enabled, then you can use the CUSTOM_REQUEST_ORIGIN variable to set the origin of requests made by the converter. The default value is https://pdf-internal.

# Windows fonts support

If you want to use Windows fonts like Calibri, Verdana, etc. in your PDF files, you can use the pdf-converter-windows Docker image and run it on a Windows operating system.

See Fonts section for more details.

# Next steps

Use the http://localhost:8080/v1/convert endpoint to export PDF files. Check out the authorization section to learn more about tokens and token endpoints.

You can also use the demo page available on http://localhost:8080/demo to generate an example PDF file.

Refer to the Export to PDF REST API documentation on http://localhost:8080/docs for more details.