Built-In Dashboard

Document Engine comes with an optional built-in dashboard that makes it easier to both see what’s going on in your production installation and improve your developer experience.

It’s available at /dashboard. If you’re testing Document Engine locally, follow the directions for setting up Document Engine and access the dashboard at http://localhost:5000/dashboard.

Document Engine Dashboard

Use Cases

The dashboard enables you to quickly:

  • Inspect the runtime environment.

  • Create new documents (useful while integrating PSPDFKit for Web into your application).

  • Access a link to our current documentation and guides.

  • Validate your generated JSON Web Tokens (JWTs).

For interacting with Document Engine programmatically, use the backend API.

Authentication

The dashboard is secured using HTTP authentication. You can modify the username and password through Helm values:

  • dashboard.auth.username

  • dashboard.auth.password

You can also pass the environment variables passed to the container directly:

  • DASHBOARD_USERNAME

  • DASHBOARD_PASSWORD

Disabling the Dashboard

To disable the dashboard, leave the DASHBOARD_USERNAME and DASHBOARD_PASSWORD environment variables blank, or don’t set them.