Export 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.
# Setting up the application using a Docker container
-
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.
-
Containerize the application using
docker
ordocker-compose
. -
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] docker.cke-cs.com/pdf-converter:[version]
If you want 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] docker.cke-cs.com/pdf-converter:[version]
You can read more about using authorization in the authorization section.
# Containerize example using docker-compose
- Create the
docker-compose.yml
file:
version: "3.8"
services:
image: docker.cke-cs.com/pdf-converter:[version]
ports:
- "8080:8080"
restart: always
init: true
environment:
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.
- Run:
docker-compose up
# Notes
- Without a correct
LICENSE_KEY
the application will not start. If the license is invalid, you’ll get aWrong 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 ishttps://pdf-internal
.
# 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.
# Windows fonts support
If you want to use Windows fonts like Arial, Verdana, etc. in your PDF files, you can use pdf-converter-windows
Docker image and run it on Windows operating system.
See Fonts section for more details.