Skip to content
plugboard.appRequest a demo

Reference

Command line

Most care happens in the status panel at localhost:9090. These are the same actions from a terminal, plus a few the panel does not surface.

Run them from an installed native bundle’s directory. The current native release target is Linux x64, whose entry point is plugboard; check available assets before planning an installation. Windows and macOS are not current release targets. Separately built reference launchers use plugboard.cmd on Windows and plugboard on macOS.

CommandDoes
plugboard startRun in this window. Applies pending database changes first
plugboard panelOpen the status panel. Works even when the service is stopped
plugboard service-statusAsk the platform how the service is doing
plugboard update --checkIs there a newer version? Change nothing
plugboard updateDownload and stage one now
plugboard versionPrint the version of this bundle

Running plugboard with no command is the same as plugboard start, which is what double-clicking it does.

There is no separate setup or migrate step. The first plugboard start writes a configuration file with generated secrets, then applies every pending database change on that start and on every one after it.

The installer does this for you. These are for managing it by hand.

CommandDoes
plugboard install-serviceRegister the service so it starts at boot
plugboard uninstall-serviceRemove the registration. Your data is untouched
FlagEffect
--user someoneThe account the Linux service runs as

Needs sudo on Linux and macOS, and an elevated prompt on Windows.

CommandDoes
plugboard admin-resetList the accounts on this deployment
plugboard admin-reset [email protected]Set a new password for that account

This is the way back in when nobody can sign in: after an identity provider outage, a departed administrator or a mistyped SSO domain. It runs on the machine itself, so the only person who can use it is one who already has a shell on it.

See nobody can sign in for what it asks and what it records.

Available Linux packages are non-interactive. The Windows syntax below is for a separately supplied reference installer used with Intune, Group Policy or an RMM; the current release does not include a Windows installer.

plugboard-<version>-x64-setup.exe /S /LICENSEKEY=XXXX-XXXX /ADDRESS=helpdesk.yourschool.org /[email protected]
Terminal
sha256sum -c SHA256SUMS --ignore-missing

To check an available Linux archive from a Windows administration machine:

PowerShell
Get-FileHash -LiteralPath '.\plugboard-linux-x64.tar.gz' -Algorithm SHA256

For an uptime monitor.

EndpointAnswers
/api/health/liveWhether the process responds. It does not touch the database, so a database outage does not fail it
/api/health/readyWhether this instance can serve. It queries the database and returns 503 when it cannot reach it
/api/health/versionThe running version and release channel. No database needed

Point an uptime monitor at ready: it fails when the deployment cannot serve requests.

Terminal
curl -s https://helpdesk.yourschool.org/api/health/ready
curl -s https://helpdesk.yourschool.org/api/health/version

See keeping an eye on it.