Nightlies

In certain circumstances, our Support team might ask you to try a nightly build to see if a fix we built for you works. When running nightlies, keep the following in mind:

  • Nightlies should never be used in production. While they still undergo automated testing, they don’t have the same strict QA as our full releases.

  • There’s no support for migrations in any direction. Since nightlies are cut from our master branch, there’s no guarantee that they’ll be compatible with the next scheduled release, nor is there any guarantee that you can downgrade to the current version. Always run nightlies against a fresh DB and only use test data.

Using Nightlies

To use PSPDFKit for Web Standalone nightlies, you need the PSPDFKit for Web nightlies, which can be retrieved with npm. We recommend using cache buster query parameters when using nightly builds to ensure the nightly build being used is always the latest.

For example:

# npm
npm install --save https://my.pspdfkit.com/download/pspdfkit-web/nightly.tar.gz?cachebust=todaysdate

PSPDFKit for Web

PSPDFKit for Web can be added to your project directly from our nightly tarball:

# npm
npm install --save https://my.pspdfkit.com/download/pspdfkit-web/nightly.tar.gz

# yarn
yarn add https://my.pspdfkit.com/download/pspdfkit-web/nightly.tar.gz

Document Engine

The Document Engine nightly Docker image is provided as a tarball for x86-64 (AMD64/Intel 64) and aarch64 (ARM64) architectures.

  1. Download the nightly image and add it to your local image registry:

curl -L https://my.pspdfkit.com/download/pspdfkit-server/nightly-x86_64.tar.gz -o pspdfkit-nightly-x86_64.tar

docker load < pspdfkit-nightly-x86_64.tar

The final output reads:

Loaded image: pspdfkit/pspdfkit:nightly-x86_64

  1. Replace the pspdfkit/pspdfkit image tag in your docker-compose.yml file with pspdfkit/pspdfkit:nightly-x86_64, and start Document Engine as usual:

version: '3.8'

pspdfkit:
  image: pspdfkit/pspdfkit:nightly-x86_64
  environment:
  ...

  1. Download the nightly image and add it to your local image registry:

curl -L https://my.pspdfkit.com/download/pspdfkit-server/nightly-aarch64.tar.gz -o pspdfkit-nightly-aarch64.tar

docker load < pspdfkit-nightly-aarch64.tar

The final output reads:

Loaded image: pspdfkit/pspdfkit:nightly-aarch64

  1. Replace the pspdfkit/pspdfkit image tag in your docker-compose.yml file with pspdfkit/pspdfkit:nightly-aarch64, and start Document Engine as usual:

version: '3.8'

pspdfkit:
  image: pspdfkit/pspdfkit:nightly-aarch64
  environment:
  ...