Skip to main content

Conversion Service in Docker

Learn how to run the Conversion Service in Docker to automate document processes.

Request trial or full license​

It's necessary to have a license key to try or fully use the Conversion Service. To get the Conversion Service license key:

  1. Reach out to the sales team through the Contact page and mark the Conversion Service as the product of your interest for a trial license.

Prerequisites​

The following sections use examples running with Docker Compose:

  • Install Docker Compose to pull and use the Conversion Service in Docker.

To configure and run the Conversion Service, you need Conversion Service installed at least on one Windows Server machine to export configuration files. The Windows Server installation requires the following .NET runtimes from the Download .NET website:

  • .NET Framework 4.7
  • .NET Desktop Runtime 8.0 (x64)
  • ASP.NET Core Runtime 8.0 (x64)
note

The indicated versions are the minimal versions supported. You can use a newer version also.

Run Conversion Service in Docker​

To install the Conversion Service on a compatible Linux operating system, you can use a Docker container.

The pdftoolsag/conversion-service container is available in the public repository on Docker Hub.

  1. Ensure that the container can communicate with any services configured in its profiles. For example, a Conversion Service instance running on Windows, a 3-Heights® OCR Service, or a cloud-based digital signature service.

The examples use a bridge network, conversion-service, which can be created using:

docker network create conversion-service

  1. Run the container using the preinstalled configuration.

    docker run -dp 13033:13033 --network conversion-service \
    -e LICENSEKEY=4H-V4-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX \
    pdftoolsag/conversion-service

The container can be configured using environment variables. The only required configuration is the license key, which can be passed using either LICENSEKEY or LICENSEKEY_FILE.

Example: Container configuration with custom profile

docker run -dp 13033:13033 --network conversion-service \
  --mount "type=bind,src=C:\path\to\ProfileExport-(*@\ProductVersion @*).export,\
      dst=/etc/convsrv/ProfileExport.export,readonly" \
  -e IMPORT_PROFILES=/etc/convsrv/ProfileExport.export \
  -e LICENSEKEY=4H-V4-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX \
    -e WINDOWS_SERVICE_ENDPOINT=http://server:13033/conversion/v1.0/rest \
pdftoolsag/conversion-service:(*@\ProductVersion @*)
info

For more details about Docker configuration, see Set up the service in Docker page.

note

If the service uses HTTPS, its host certificate must be trusted by the Docker container running pdfclient. Otherwise, no connection can be established. By default, no trusted certificates are installed.

Configure for your scenario​

Once you have tested the demo conversion, you can start to configure the service to meet your requirements:

Integrate into your system​

There are several ways you can integrate the Conversion Service into your system: