Configure Conversion Service plugins

Plugins are non-standard components used for extending the Conversion Service with custom workflows.

Manage plugins

Depending on your installation, plugins are managed differently.

Windows

You can install plugins using the Plugins tab of the Conversion Service Configurator GUI. The tab is only displayed if the corresponding license feature is active. All installed plugins are listed here.

To install a new plugin, click Install Plugin and choose the ZIP file containing it. To update or delete a plugin, click on the respective icon.

info

You must restart the service for any changes in plugins to take effect.

Docker

To run a Conversion Service with a plugin, a custom image must be created. The csconfig command can be used in the Dockerfile to install the plugin:

Example of Install \Path{Plugin-x.y.0.zip dockerfile for Conversion Service version 4.0.0

  FROM pdftoolsag/conversion-service:4.0.0

  USER root

  COPY Plugin-x.y.0.zip .
  RUN bin/csconfig plugins install Plugin-x.y.0.zip \
    && rm Plugin-x.y.0.zip

  COPY ProfileExport-(*@\ProductVersion @*).export .
  RUN bin/csconfig profiles import -r ProfileExport-4.0.0.export \
    && rm ProfileExport-4.0.0.export

  USER convsrv

Each plugin version is designed for a specific version of the Conversion Service. So when upgrading the Conversion Service, all plugins must be upgraded as well. Unless the plugins are updated, the service is not operational.