Skip to content
plugboard.appRequest a demo

Install it yourself

What you need

The current native release workflow targets Linux x64 (Intel/AMD) only. Choose a host compatible with the selected package and its release notes. Native packaging is optional per release, so confirm an actual asset in the download centre before provisioning the host.

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

Windows, macOS and Linux ARM native release targets are disabled. Source and launcher code retains platform-specific routines, but those need a separately built and validated deployment; they do not establish released installer or archive availability. See portable archive scope.

RequirementNotes
Node.js24.20.0 or later in the 24.x lineSource installs; use the repository’s declared engine range. Native packages carry their own runtime
pnpm10.34.5 for 0.22.1Source installs; use the exact packageManager version and lockfile from the release being built
PostgreSQL14 or later16 is what CI tests against. The bundle carries its own
RedisOptionalOnly the legacy people-sync and digest worker use it
Object storageOptionalS3-compatible. MinIO locally, S3 in cloud. Only for logos, photos and exports

If you are running the bundle, none of the above needs to exist on the machine first.

PortProcessExposure
3000WebBehind your proxy, or direct on a trusted LAN
4000APIBehind your proxy, or direct on a trusted LAN
443Reverse proxyThe only one that should face users
5432PostgreSQLNever exposed beyond the host or the container network

Both application ports are configurable with WEB_PORT and API_PORT.

The Compose stack publishes nothing by default. It listens on the internal network only, and you attach an ingress profile or your own proxy.

The application itself needs no outbound access to run. Connectors do, and only the ones you enable.

If you enableIt reaches
Jamf Prohttps://yourorg.jamfcloud.com
Microsoft Intunelogin.microsoftonline.com, graph.microsoft.com
Kandjihttps://yourorg.api.kandji.io
Mosylemanagerapi.mosyle.com or businessapi.mosyle.com
Chrome Enterpriseoauth2.googleapis.com, admin.googleapis.com
Google Workspace or Sheetsoauth2.googleapis.com, gmail.googleapis.com, sheets.googleapis.com
Zendeskhttps://yourorg.zendesk.com
Twilioapi.twilio.com
Salesforcehttps://yourorg.my.salesforce.com
ThreatLockerYour ThreatLocker portal API
Apple GSX, CompNow, DellThe vendor endpoint you configure
Automatic updatesThe update and download service
Usage telemetryYour telemetry endpoint, if licensed and not disabled

Connectors that reach systems on your own network instead of the internet are LDAP and Active Directory, Synergetic, Web Help Desk, PaperCut and printers over SNMP. A self-hosted install on the same network reaches them directly.

Plugboard blocks outbound requests to private, loopback and link-local addresses by default, so a URL you type into a service monitor or webhook cannot reach an internal host.

An on-premises install that monitors LAN addresses has to opt out:

Terminal
ALLOW_PRIVATE_EGRESS=1

Leave it off if your deployment serves more than one institution. See the security model.

Nothing emails anyone until an email connector exists. Repair tracking links, ready-for-collection notices, purchase receipts, monitor alerts, backup failure alerts and scheduled reports all go through it.

You need either an SMTP server you can authenticate to, or a Google Workspace service account with domain-wide delegation. See SMTP and Google Workspace.

HTTPS is expected. The application starts without it and says so in the log, which is enough for a first look on the machine itself. Anything a staff member reaches needs a certificate.

Any of these work:

  • A public certificate from Let’s Encrypt, issued automatically by the bundled Caddy profile.
  • A wildcard you already own.
  • A certificate from your school’s internal CA, including Active Directory Certificate Services.
  • A PKCS#12 file, which is what most Windows tooling produces.

See HTTPS and certificates.

SLA calculations, scheduled backups, the overnight update check, TOTP two-factor codes and licence expiry all read the machine’s clock. Run NTP.

The overnight update check uses the machine’s own local time, so a server set to UTC in a school in Sydney will update at 1am UTC, which is the middle of the school day. Either fix the timezone or set AUTO_UPDATE_HOUR.

Endpoint protection that scans every file write makes the database slow. Exclude the data directory, .pgdata in the install directory, if you can.