PSPDFKit Server Documentation

High level overview

PSPDFKit Server is our server-side component that is used by PSPDFKit for Web and PSPDFKit Instant.

It is delivered as a Docker container that you deploy on your own infrastructure. Your PSPDFKit-powered apps then connect to it.

The server requires a PostgreSQL database as well as dedicated file storage, using either a local Docker volume or any S3-compatible object storage.

  1. PSPDFKit for Web

    PSPDFKit Server pre-processes uploaded documents into a format that PSPDFKit for Web can render and stores annotations. PSPDFKit for Web intelligently downloads pages on demand so even large documents can be browsed quickly.

    More information can be found in the PSPDFKit for Web guides.

  2. PSPDFKit Instant

    As with PSPDFKit for Web, PSPDFKit Server stores uploaded documents and annotations. PSPDFKit for Android, iOS and Web connect to PSPDFKit Server to synchronize annotations and download documents.

    More information can be found in the guides for each platform.

Document Management

Users upload documents to your backend, which simply forwards the uploaded PDF file to PSPDFKit Server and receives a document identifier. In your server, you only have to store this identifier - we store the PDF document, its annotations and meta information.

PSPDFKit Server is used to store the PDF document and it's annotations. Your server has access to a rich HTTP API.

We regularly release new updates. Those will be announced via Twitter, our blog and a regular newsletter, that you can subscribe to on our blog.

Please see the Changelog for details of what is new in each release.

If you experience any problems with, please look at our Troubleshooting section or contact support.