Upgrading from Processor for Linux
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.5.0:
pspdfkit/document-engine:1.5.0
We publish our images to DockerHub and AWS ECR. Refer to our Docker registries guide to learn more.
Always use a specific image version tag; never rely on
:latest
.
License Changes
Document Engine uses a new license format that streamlines licensing. Refer to our licensing guide to learn more about Document Engine licensing.
No migration is necessary for your license at this point. Existing Processor licenses will continue to work just like before, and you can continue using them with Document Engine without any problems.
Once your license is migrated, you’ll receive additional information about the license update.
We plan to drop support for legacy licenses in Document Engine builds produced after 15 May 2024.
Configuration Changes
The following configuration option needs to be updated (if you’re using it):
-
PROCESSOR_REQUEST_TIMEOUT
has been renamed toSERVER_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.