Install Conversion Service

The Conversion Service can be installed on a Windows server or in a Docker container depending on your specific requirements.

Windows

To install the Conversion Service on a compatible Windows server, proceed as follows:

1. Download and install the required .NET runtimes:

   • .NET Framework 4.7
   • Microsoft .NET Desktop Runtime 8.0 (x64) or higher, download the latest version at the Download .NET 8.0 page.
   • Microsoft ASP.NET Core Runtime 8.0 (x64) or higher, download the latest version at the Download .NET 8.0 page.

2. Download and execute the MSI installation package and follow the instructions on screen. The installer installs these components:

   • Conversion Service
   • Configurator GUI
   • Shell and GUI clients (see Integrate the Conversion Service)
   • License manager
   • Watched folder

3. Add your license in the corresponding tab in the configurator (see Licensing).

note

To convert Word, Excel and PowerPoint documents, Office conversion must be configured and be activated in the profile, i.e. using the Configurator GUI.

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

2. 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.