Installation

p2proxy ships pre-built binaries for linux/{amd64,arm64} and darwin/{amd64,arm64}. Windows is not yet supported — use WSL2 as a workaround.

The releases page is the source of truth for every artifact below.

Homebrew (macOS & Linux)

The recommended path on macOS, and the simplest on Linux if you already have Homebrew.

brew install --cask BitpingApp/tap/p2proxy

Verify the install:

p2proxy --version

Debian / Ubuntu

# x86_64
curl -LO https://github.com/BitpingApp/p2proxy/releases/latest/download/p2proxy_<version>_amd64.deb
sudo dpkg -i p2proxy_<version>_amd64.deb

# arm64
curl -LO https://github.com/BitpingApp/p2proxy/releases/latest/download/p2proxy_<version>_arm64.deb
sudo dpkg -i p2proxy_<version>_arm64.deb

Fedora / RHEL

sudo rpm -i https://github.com/BitpingApp/p2proxy/releases/latest/download/p2proxy-<version>-1.x86_64.rpm

Alpine

curl -LO https://github.com/BitpingApp/p2proxy/releases/latest/download/p2proxy_<version>_x86_64.apk
sudo apk add --allow-untrusted p2proxy_<version>_x86_64.apk

Tarball (any Linux / macOS)

Grab the right archive for your <os>-<arch> from the releases page and extract:

tar -xJf p2proxy-<version>-<os>-<arch>.tar.xz
cd p2proxy-<version>-<os>-<arch>
./p2proxy --help

Docker

docker pull ghcr.io/bitpingapp/p2proxy:latest

See Operations → Docker for the recommended docker run invocation and a docker-compose.yml template.

Build from source

Requires a recent stable Rust toolchain (rustup install stable).

git clone https://github.com/BitpingApp/p2proxy.git
cd p2proxy
cargo build --release -p p2proxy
./target/release/p2proxy --help

Verifying downloads

Every release publishes a _SHA256SUMS file. Always verify binaries you download outside of a package manager:

curl -LO https://github.com/BitpingApp/p2proxy/releases/download/v<version>/p2proxy-<version>_SHA256SUMS
sha256sum -c p2proxy-<version>_SHA256SUMS

What success looks like

After installing, p2proxy --version should print the version. Running p2proxy --config Config.yaml against a valid config will bring up the TUI within a second or two, then show peer connections building in the right-hand panel. If you see neither, jump to Troubleshooting.

Quickstart — end-to-end first run.
Configuration — full Config.yaml reference.

Customers

Nodes