Basic Deployment

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'
    
    services:
      processor:
        image: "pspdfkit/processor:latest"
        environment:
          # License key for your PSPDFKit Processor installation.
          LICENSE_KEY: YOUR_LICENSE_KEY_GOES_HERE
        restart: always
        ports:
          - "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.