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.

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:

    Copy
    docker-compose.yml
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    
    version: '2'
    
    services:
      processor:
        image: "pspdfkit/processor:latest"
        environment:
          # License key for your PSPDFKit Processor installation.
          LICENSE_KEY: YOUR_LICENSE_KEY_GOES_HERE
    
          # Public key used for verification of JWTs from web clients. It has to be in the PEM format.
          JWT_PUBLIC_KEY: |
            -----BEGIN PUBLIC KEY-----
            MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBALd41vG5rMzG26hhVxE65kzWC+bYQ94t
            OxsSxIQZMOc1GY8ubuqu2iku5/5isaFfG44e+VAe+YIdVeQY7cUkaaUCAwEAAQ==
            -----END PUBLIC KEY-----
          JWT_ALGORITHM: RS256
        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:

    1
    
    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 our API Overview guide and start integrating PSPDFKit Processor into your app. Or have a look at our Usage Examples guide for some ready-to-run samples.