Log inGet started

Download

Install PortPilot on the machine you want to see.

Windows MSI or Linux systemd installer. Local ports work without an account. Pair when you want the dashboard.

Current version: 0.1.0

Windows MSI (URL not published yet)

Installer artefacts are not linked on this deployment yet (unsigned MSI builds are not published for paid traffic until Authenticode + NEXT_PUBLIC_DOWNLOAD_WINDOWS_MSI_URL are set). Follow the Windows and Linux instructions below, and the install docs. Unsigned builds may trigger SmartScreen — see the FAQ.

Windows 10 / 11 x64

Use the MSI named PortPilot-Setup-x64-v0.1.0.msi. ARM64 is not supported.

  1. Run the installer as Administrator.
  2. Finish can launch PortPilot Desktop. Wait if it cannot reach the agent yet.
  3. Open a new terminal for portpilot (PATH updates apply to new shells).

Requirements: Windows 10 or 11 x64. After install, a standard user can run Desktop and CLI.

First run: choose Enter pairing code or Use locally. Pair later from Machine.

Upgrade: run the newer MSI. Do not uninstall first. %ProgramData%\PortPilot is kept.

Uninstall: Add/Remove Programs → PortPilot. Data is kept unless you purge.

Full walkthrough: Windows docs. Pairing: pairing.

Linux x86_64 (systemd)

Supported in QA: Ubuntu 24.04, Debian 13, Fedora, Arch. There is no .deb or .rpm yet.

Requirements: x86_64, systemd, sudo. Outbound HTTPS to the API if you will pair.

Install after you have the release binaries and install.sh:

sudo ./install.sh \
  ./portpilot-agent \
  ./portpilot-helper \
  ./portpilot

Optional fourth argument: desktop app on GUI hosts.

This creates user portpilot, /var/lib/portpilot, enables portpilot-agent (and helper), and puts env in /etc/profile.d/portpilot.sh.

Upgrade: run install.sh again. Data is kept. Existing /etc/portpilot/agent.env is not overwritten.

Uninstall:

sudo ./uninstall.sh

Add PURGE_DATA=1 to delete /var/lib/portpilot.

Pair / setup: portpilot pair or portpilot pair XXXX-XXXX. New SSH session after install so PATH applies.

If status cannot find the token: export PORTPILOT_DATA_DIR=/var/lib/portpilot.

Agent down: sudo systemctl restart portpilot-agent.

Full walkthrough: Linux docs.

CLI reference · Troubleshooting · Getting started