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/macOS commands are conditional reference-launcher instructions for separately built and validated deployments. Those launchers use plugboard.cmd on Windows and plugboard on macOS; they are not current release targets.

Everyday

Command	Does
plugboard start	Run in this window. Applies pending database changes first
plugboard panel	Open the status panel. Works even when the service is stopped
plugboard service-status	Ask the platform how the service is doing
plugboard update --check	Is there a newer version? Change nothing
plugboard update	Download and stage one now
plugboard version	Print 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.

Service registration

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

Command	Does
plugboard install-service	Register the service so it starts at boot
plugboard uninstall-service	Remove the registration. Your data is untouched

Flag	Effect
--user someone	The account the Linux service runs as

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

Getting back in

Command	Does
plugboard admin-reset	List 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, whether from an identity provider outage, a departed administrator, 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.

Silent installation

Available Linux packages are non-interactive. The following Windows syntax is for a separately supplied reference installer used with Intune, Group Policy or an RMM; no Windows installer is promised by the current release configuration.

plugboard-<version>-x64-setup.exe /S /LICENSEKEY=XXXX-XXXX /ADDRESS=helpdesk.yourschool.org /[email protected]

Verifying a download

sha256sum -c SHA256SUMS --ignore-missing

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

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

Health checks

For an uptime monitor. Both answer without a database, so they still work when the deployment does not.

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

See keeping an eye on it.