Skip to content
plugboard.appRequest a demo

Start here

Quick start

These steps apply once a compatible native package is available for your deployment. The current native release target is Linux x64 (Intel/AMD). Check the download centre first: a configured build target does not mean an installer has been published.

From the download centre. The link is in your setup email; sign in with the same address and it emails you a fresh one.

Linux x64 package formatFilename pattern, when published
Debian packageplugboard_<version>_amd64.deb
RPM packageplugboard-<version>.x86_64.rpm

Verify it against the SHA256SUMS published beside it:

Terminal
sha256sum -c SHA256SUMS --ignore-missing

Windows, macOS and Linux ARM native release targets are disabled, so there are no packages to download for them. See installing it for the current scope.

As an administrator. It installs the bundle, registers a service, starts it, and opens the status panel at http://localhost:9090.

The panel asks who administers this install, for your licence key, and for the address staff will type. It applies them on restart.

If you were sent a configuration file during onboarding, drop it into the install directory first and there is nothing left to answer.

The panel shows Create your first administrator with a one-time link. Follow it and choose your own password.

No password is generated, shown or emailed. The link lasts 72 hours, and restarting from the panel issues a fresh one if it lapses.

A fresh install starts with an empty desk.

To explore with fictional sample data instead, set PLUGBOARD_DEMO_DATA=1 before the first start. It applies to a new database only.

  1. Open Settings, Modules and turn off the modules you will never use. See modules.
  2. Open Settings, Connectors and switch one on in demo mode. Every feature that depends on it works against fictional data, so you can see what the product does before credentials arrive.
  3. Open a ticket and work it through to closed, so you have seen the lifecycle.
  4. Open /portal in another tab to see what a student sees.

Then follow the setup checklist. It is ordered so no step depends on a decision you have not made yet.

A Linux x64 package can be evaluated on any compatible machine or VM. If no matching asset is listed, arrange an evaluation deployment instead. Skip the certificate and the public address: it serves plain HTTP on the machine itself and says so in the log.

Removing the program preserves data; follow the uninstall guidance.