Example Projects

Document Engine offers the following example projects:

• Ruby on Rails example project(opens in a new tab)
• Node.js example project(opens in a new tab)

These examples demonstrate how to integrate Document Engine with your backend.

To start, set up an instance of Document Engine using the getting started guide that describes the necessary docker-compose.yml file in detail.

1. Install and run Docker(opens in a new tab). Refer to the choose a Docker registry guide to learn about all the installation options.
2. Reboot your machine.
3. Verify that Docker works correctly by typing docker info in the terminal. Check that the output contains OSType: linux. Document Engine is a Linux-based container and requires a Docker environment capable of running Linux containers.
4. Pull the pspdfkit image from Docker Hub:

docker pull pspdfkit/pspdfkit

5. Use one of the following example projects:

   • Ruby on Rails(opens in a new tab)
   • Node.js(opens in a new tab)

   The examples provide Dockerfile and docker-compose.yml files that work without additional configuration. To clone an example to your machine and switch to its directory, run one of the following commands:

   • NODE.JS
   • RAILS
   NODE.JS

   git clone https://github.com/PSPDFKit/pspdfkit-server-example-nodejs.git
   cd pspdfkit-server-example-nodejs

   If the command doesn’t work, try installing Git(opens in a new tab) first.

6. If you have an activation key (also called a license key), add it to Docker using the code below. It’ll remain activated until you reset it. To start in trial mode without an activation key, skip this step.

   • SHELL
   • SHELL (WINDOWS)
   • POWERSHELL
   SHELL

   ACTIVATION_KEY=YOUR_ACTIVATION_KEY_GOES_HERE docker-compose up

7. Open http://localhost:3000 in a browser. When the website asks your username, type something to proceed. Alternatively, open Document Engine’s dashboard at http://localhost:5000/dashboard and log in with the username dashboard and the password secret.

   To stop the container, use the Control-C keyboard shortcut.

8. Optional: To test PSPDFKit for Web on different devices in your local network, edit the PSPDFKIT_SERVER_EXTERNAL_URL environment variable in the docker-compose.yaml file and set it to an address that’s accessible from your device.

   If you get an error, try installing docker-compose.yaml separately(opens in a new tab).
   
   The following message might appear:
   ERROR: Couldn’t connect to Docker daemon at http+docker://localunixsocket - is it running?
   If so, check if the service is running using the docker info command or the sudo docker info command.

9. Follow the getting started guides for PSPDFKit Instant for Android, iOS, Web, Flutter or React Native.