Upgrading from PSPDFKit Processor

PSPDFKit Processor no longer receives updates as of version 2023.11.1 and has been replaced by Document Engine. This guide will walk you through the necessary steps to migrate your existing Processor instance to Document Engine.

Before the update

If you haven’t done so yet, now is a good time to carefully read our overview of the upgrade process.

Update the Docker image

To upgrade to Document Engine, you’ll need to change Processor’s Docker image from pspdfkit/processor to pspdfkit/document-engine.

Use the following image for the Document Engine version 1.16.0:

pspdfkit/document-engine:1.16.0

We publish our images to Docker Hub and AWS ECR. Refer to our Docker registries guide to learn more.

License changes

Document Engine uses a new license format that streamlines licensing. Refer to our licensing guide to learn more about Document Engine licensing.

As of Document Engine 1.16.0, legacy Processor and Nutrient Web SDK (server-backed) activation and license keys are no longer supported, including legacy offline license keys.

Before upgrading, replace any legacy Processor or Nutrient Web SDK (server-backed) activation or license key with a Document Engine activation key or offline license key. Document Engine activation keys are expected to start with the 3- prefix.

If an existing installation was previously activated with a legacy Processor or Nutrient Web SDK (server-backed) activation or license key, the stored activated license in the database or persistent storage can also block startup after upgrade. In that case, clear the stored activated license, configure a valid Document Engine activation key or offline license key, and start Document Engine again.

Configuration changes

The following configuration option needs to be updated (if you’re using it):

• PROCESSOR_REQUEST_TIMEOUT has been renamed to SERVER_REQUEST_TIMEOUT.

API changes

Document Engine provides APIs that are compatible with PSPDFKit Processor. However, legacy Processor endpoints have been renamed:

• The /build endpoint has been renamed to /api/build.
• The /validate_pdfa endpoint has been renamed to /api/validate_pdfa.
• The /process endpoint has been renamed to /api/build. Refer to the Processor 2023.3 migration guide to review the endpoints that have been changed.
• The /render endpoint has been removed. Refer to our rendering guide for the current API.