Deploying PDF Processor to a Single Host


PSPDFKit Processor has been deprecated and replaced by PSPDFKit Document Engine. All PSPDFKit Processor licenses will work as before and be supported until 15 May 2024 (we will contact you about license migration). To start using Document Engine, refer to the migration guide. With Document Engine, you’ll have access to robust new capabilities (read the blog for more information).

PSPDFKit Processor is our standalone document processing service. It’s distributed as a Docker image.

For deployment in production, we recommend using Kubernetes or native Docker support by a cloud provider like Amazon Web Services, Google Cloud Platform, or Microsoft Azure. PSPDFKit Processor supports both x86_64- and ARM64-based processors.

The steps below outline how to get a simple setup on a single host up and running via docker-compose.

  1. Make sure you have Docker installed and running.

  2. Create the following docker-compose.yml file somewhere on your file system:

    version: '2'
        image: "pspdfkit/processor:2023.11.1"
          # License key for your PSPDFKit Processor installation.
        restart: always
          - "5000:5000"
  3. In a terminal tab, navigate to the directory where you placed the docker-compose.yml file and execute the following:

    docker-compose up

    Make sure that navigating to http://localhost:5000/ in a web browser shows “PSPDFKit Processor is up and running.”

    You can quit the running containers with Ctrl + C.

  4. Now you’re ready to look at the available configuration options and authentication methods to adapt Processor to your use case.