Skip to main content

Update Conversion Service in Docker

Learn how to update the Conversion Service to the latest version in Docker.

Automatic update​

If you use the Conversion Service with Docker Compose, you can configure an automatic update. To update the Conversion Service in Docker:

  1. Change the value of the IMAGE_VERSION variable in the docker-compose.env file to the latest version.
  2. Add the Configuration Updater to your docker-compose.yaml file: 
    configuration-updater:
        # Configuration Updater - Updates configuration files for both connector-service and conversion-service.
        image: pdftoolsag/configuration-updater:$IMAGE_VERSION
        volumes:
            # Utilizes vol-conversion-srv for updating Conversion Service configurations.
            - vol-conversion-srv:/app/conversion-config
            # Utilizes vol-connector-srv for updating Connector Service configurations.
            - vol-connector-srv:/app/connector-config
    Replace the IMAGE_VERSION with the Conversion Service version number. For example: 6.12.0, 6.12, 6
  3. Optional: If you are updating the Conversion Service to the new major version, you need to change the license key also.
    For example, change the version 4 license key: 
    4H-V4-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    To the version 6 license key: 
    4H-V6-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    The major version of the Conversion Service for which a specific license key is valid is included in the license key itself. In the previous two examples, you can see the V4 and V6.
  4. Run Docker Compose: 
    docker compose up -d

For more information, see Docker Compose configuration.

Before you begin

All relevant files, such as appsettings.json and workflows, are backed up during the update. Restore your installation using these files in the unlikely event of an error during the update process.

caution

When you update the Conversion Service installation to the latest version, the configuration is no longer compatible with previous versions.

Licensing during updates

Updates keep your existing license and licensing configuration unchanged. A container running version 6.12.0 or later registers the built-in trial license only when it starts without a LICENSEKEY or LICENSEKEY_FILE environment variable. For more details, review Use the Licensing Gateway Service, in the Licenses documentation.

Manual update​

If you are using a standalone Docker container, you can update the Conversion Service manually:

  1. Update the Conversion Service using the Windows Server approach. Review Update Conversion Service on Windows Server.
  2. Import updated profiles to new containers based on the new version of the pdftoolsag/conversion-service image.