Installation
Choose the Windows MSI or the Linux systemd installer, then pair if you want the dashboard.
PortPilot installs an agent service, an optional helper for privileged actions, a CLI (portpilot), and on GUI hosts a desktop tray app.
Prerequisites
- Supported OS (see table)
- Admin / root for install
- Download only from Download or official GitHub releases
| Platform | Primary artefact | Notes |
|---|---|---|
| Windows 10/11 x64 | PortPilot-Setup-x64-vX.Y.Z.msi | Services, desktop, CLI on PATH |
| Linux x86_64 + systemd | install.sh + release binaries | No .deb / .rpm yet |
Current advertised version is shown on the Download page. If the Download page shows no artefact yet, installers are not published on that deployment (unsigned MSI builds stay gated until Authenticode + download URLs are configured). Unsigned local builds may show a SmartScreen warning on Windows — use More info → Run anyway only from a source you trust.
What gets installed
| Piece | What it does |
|---|---|
| Agent | Discovers ports, health, local IPC for CLI/Desktop |
| Helper | Allowlisted privileged actions (kill, services, firewall) |
| CLI | portpilot |
| Desktop | Tray UI (GUI machines) |
| Local state | Database, token, logs, optional cloud enrollment |
Normal users do not need the layout internals; see Windows and Linux for paths.
Steps
- Download the artefact for your OS.
- Follow the platform guide.
- Open a new terminal and run
portpilot --versionthenportpilot status. - Pair when you want the website dashboard — Pairing.
After install, local ports work immediately. Cloud features need an account and a pairing code.
Expected result
Agent (and helper) running; CLI answers in a new shell; Desktop launches on GUI hosts.