Skip to main content

Configure profiles in Docker

In Docker, configure profiles in Configurator Web, the browser-based configuration application that ships with Conversion Service. Refer to Configure profiles using Configurator Web.

If you already maintain profiles on a Windows installation, create a profile there, export it, and import it in Configurator Web. Refer to Optional: Reuse a configuration from Windows.

The version of Conversion Service installed on Windows and the version of the container image must match. To update to a new version, update the Windows service first, because it updates the configured profiles if necessary.

Ensure that all configuration values are valid in your Docker environment, that is, URLs to services and paths to configuration files.

Configure profiles using Configurator Web​

Set up Conversion Service profiles and workflows in Docker with Configurator Web, a cross-platform application that removes the need to manage configuration on Windows machines. For an overview of its pages, refer to Configurator Web.

To run Configurator Web beside Conversion Service and the Connector Service, use the Docker Compose file in Run Conversion Service in Docker. Configurator Web is available at http://localhost:13035 by default.

The Connector Service is required

Configurator Web reads the connection configuration that the Connector Service creates in vol-connector-srv. Without the connector-service container and its shared volume, the Integration page fails to load.

tip

After you configure the profiles in Configurator Web, apply the changes:

  1. Click Save Changes.
  2. Restart the Conversion Service container.

Set a profile when starting the Docker container​

The exported profile file (for example, ProfileExport-6.12.0.export, where the version matches Conversion Service that exported it) must be mounted into the container. Set the IMPORT_PROFILES environment variable to the file path inside the container.

The container imports the file at every start and replaces the profiles of each workflow in the file, including changes that you saved in Configurator Web. To keep editing those workflows in Configurator Web, remove IMPORT_PROFILES after the first import.

Import profiles only​

This profile configuration imports the exported profile file only, which is typically sufficient.

Bind the exported profile file to the container and set the environment variable IMPORT_PROFILES to activate the profile import:

docker run -dp 13033:13033 --network conversion-service \
  --mount "type=bind,src=HOST_PROFILE_DIR\PROFILE_EXPORT_FILE,\
           dst=/etc/convsrv/ProfileExport.export,readonly" \
  -e IMPORT_PROFILES=/etc/convsrv/ProfileExport.export \
  -e LICENSEKEY=LICENSE_KEY_VALUE \
  pdftoolsag/conversion-service:IMAGE_VERSION

Replace the following:

  • HOST_PROFILE_DIR: The directory on the host machine that contains the exported profile (for example, C:\Users\john-doe\Desktop).
  • PROFILE_EXPORT_FILE: The filename of the exported profile (for example, ProfileExport-6.12.0.export).
  • LICENSE_KEY_VALUE: The Conversion Service license key. To use the built-in trial license instead, remove the LICENSEKEY variable.
  • IMAGE_VERSION: The Conversion Service version number (for example, 6.12.0, 6.12, or 6).

When importing profiles of a workflow, you also import the Workflow state, whether the workflow is activated or deactivated.

Import profiles and further configuration files​

This more advanced profile configuration is required for profiles that contain references to files, for example, SSL client certificates for connections to external servers.

  1. When configuring the profiles, use the base path /etc/convsrv for all referenced files.
  2. Create a directory configuration where all configuration files can be written to. Later these files will be copied to a volume and mapped to /etc/convsrv in the container.
  3. Copy the exported profile file and all referenced files to the directory configuration.
  4. Create a volume named after the Conversion Service version (for example, convsrv-etc-6.12.0) containing all configuration files from configuration:
docker volume create --name VOLUME_NAME
docker run --rm \
  --mount "type=bind,src=HOST_CONFIG_DIR,dst=/source" \
  --mount "type=volume,src=VOLUME_NAME,dst=/etc/convsrv" \
  alpine \
  ash -c "cp /source/* /etc/convsrv/"

Replace the following:

  • VOLUME_NAME: A Docker volume name that includes the Conversion Service version (for example, convsrv-etc-6.12.0).
  • HOST_CONFIG_DIR: The directory on the host machine that contains the exported profile and any referenced files (for example, C:\path\to\configuration).
  1. The folder configuration is not required anymore and can be deleted.
  2. Run the image. Mount the volume and set the environment variable IMPORT_PROFILES to activate the profile import:
docker run -dp 13033:13033 --network conversion-service \
  --mount "type=volume,src=VOLUME_NAME,dst=/etc/convsrv,readonly" \
  -e IMPORT_PROFILES=/etc/convsrv/PROFILE_EXPORT_FILE \
  -e LICENSEKEY=LICENSE_KEY_VALUE \
  pdftoolsag/conversion-service:IMAGE_VERSION

Replace the following:

  • VOLUME_NAME: The Docker volume name created in the previous step (for example, convsrv-etc-6.12.0).
  • PROFILE_EXPORT_FILE: The filename of the exported profile (for example, ProfileExport-6.12.0.export).
  • LICENSE_KEY_VALUE: The Conversion Service license key. To use the built-in trial license instead, remove the LICENSEKEY variable.
  • IMAGE_VERSION: The Conversion Service version number (for example, 6.12.0, 6.12, or 6).

Import profiles using Docker Compose​

To import an exported profile in a Docker Compose setup, mount the export file as a volume and set the IMPORT_PROFILES environment variable:

services:
  conversion-service:
    image: pdftoolsag/conversion-service:IMAGE_VERSION
    environment:
      LICENSEKEY: LICENSE_KEY_VALUE
      IMPORT_PROFILES: /etc/convsrv/ProfileExport.export
    ports:
      - "13033:13033"
    volumes:
      - ./PROFILE_EXPORT_FILE:/etc/convsrv/ProfileExport.export

Replace the following:

  • IMAGE_VERSION: The Conversion Service version number (for example, 6.12.0, 6.12, or 6).
  • LICENSE_KEY_VALUE: The Conversion Service license key. To use the built-in trial license instead, remove the LICENSEKEY variable.
  • PROFILE_EXPORT_FILE: The filename of the exported profile on your host machine (for example, ProfileExport-6.12.0.export).

For the full Docker Compose configuration reference, refer to Configure containers using Docker Compose.