Configuration

While PSPDFKit Processor works out of the box, some parts need to be configured to work. Configuration options for the server are exposed via environment variables in your docker-compose.yml file.

  • LICENSE_KEY — This is the license key used to activate PSPDFKit Processor. If this isn’t specified or if it’s incorrect, PSPDFKit Processor won’t start up.
  • JWT_PUBLIC_KEY — This key has to correspond to the private key you’ll use when generating JSON Web Tokens (JWTs) in your app. See the Authentication guide for details.
  • JWT_ALGORITHM — This is the algorithm used for JWT verification. This should be the same as the one you’ll use for signing JWTs in your app. Supported algorithms: RS256, RS512, ES256, ES512. See RFC 7518 for details about specific algorithms.

There are also some optional configuration options:

  • PORT — The port PSPDFKit Processor is listening on. Defaults to 5000.
  • HTTP_PROXY or HTTPS_PROXY — A proxy server used for fetching remote documents.
  • STATSD_HOST and STATSD_PORT — Host and port of a running StatsD daemon that PSPDFKit Processor can report telemetry data to.
  • REMOTE_URL_FETCH_TIMEOUT — The timeout in ms applied when fetching documents from a remote URL. Defaults to 5,000 ms.
  • MAX_UPLOAD_SIZE_BYTES — The maximum size in bytes uploaded documents can be. This applies to all upload types, including remote documents. Defaults to 1,000,000,000 bytes, or about 950 MB.
  • LIBREOFFICE_CONVERSION_TIMEOUT — The timeout in ms applied when converting an Office document using LibreOffice. Any conversion taking longer than the configured timeout will fail. Defaults to 60,000 ms.