PortPilot documentation
Install PortPilot, pair machines, and manage listening ports, processes, services, and optional Cloud features on Windows and Linux.
PortPilot is a local-first agent for Windows and Linux. It shows every listening port on a machine, explains health, and runs a small allowlisted set of controls. Pair the agent to a PortPilot account when you want a fleet dashboard.
This documentation matches the current product. Features that are not shipped (macOS, Linux .deb/.rpm, Cloudflare tunnels, Docker lifecycle controls) are called out as unavailable.
Who it is for
- Developers who need to see what is listening on a workstation
- Server administrators who manage headless Linux hosts over SSH
- Homelab and small-fleet operators on Windows or Linux x64
Mental model
Account → Machines → Ports → Actions.
| Piece | Role |
|---|---|
| Account | Login, licence, billing, pairing codes |
| Machine | One installed agent (a Windows PC or Linux host) |
| Port | A listening binding: protocol, address, port, owning process |
| Actions | Allowlisted controls on that port (kill, service, firewall, tunnel) |
Where other features sit:
- Tunnels — Pro/Cloud. Public ngrok URL for a chosen local port
- Health / Diagnose — layered checks on a port (loopback, not “the internet can reach you”)
- Firewall — inspect for everyone; mutate PortPilot-named rules on Pro (Windows + UFW)
- Docker — read-only container metadata on host ports
- Reverse proxies — read-only nginx / Apache / Caddy / Traefik detection
What this documentation covers
- Install on Windows and Linux
- Pairing a machine to your account
- Ports, commands, processes, services, diagnostics, firewall, and tunnels
- Optional Cloud sync, notifications, and backups
- Licensing, billing, and AppSumo
What PortPilot is not
It is not a generic DevOps platform, an AI shell, a Docker/Kubernetes control plane, or a replacement for SSH. Docker and reverse proxies are read-only awareness. Tunnels are the ngrok API only (Pro or Cloud).
Supported platforms
- Windows 10 / 11 x64 (ARM64 is not supported)
- Linux x86_64 with systemd
- macOS is not supported
The current advertised installer version is always on Download. Behaviour described here is the current release line; when a step applies only to a newer installer, the page says so.
Continue with Getting started.