Peerlify · Documentation
Build, deploy, and operate
a Peerlify network.
Reference docs, guides, and runbooks for engineers and IT admins. Start with the install, then dig into ACLs, identity, and operations.
Quick start
From zero to a device on the network in four commands.
Peerlify ships as a background service plus a CLI, on Windows, macOS, and Linux. Install once per device, sign in through your identity provider, and bring the data plane up. Each command below copies on click.
Install the client
Grab the installer for your platform from the downloads page. On Linux that’s one line; Windows and macOS get a signed installer. The install guide covers all three in detail.shellcurl -fsSL https://pkgs.peerlify.net/install.sh | sh
Sign in
Prints a link. Open it in a browser, sign in, and pick the network for this device.shellpeerlify login
Check the connection
Shows the device’s address in the network and how many peers it can reach.shellpeerlify status
Reach another device
List the devices you can connect to, then test the path to one of them.shellpeerlify list peers peerlify ping build-server
All sections
Browse by topic
Getting started
Install the client
Concepts
How-to guides
Identity providers
Access control
Administration
Troubleshooting
Security
Reference
Command line
Run your network from the terminal.
Log in, check status, list peers, ping across the mesh, and read connection telemetry — all from the peerlify CLI, with JSON output for listing and telemetry commands.