Guide

Set up the Relay — Quick setup

For anyone who already runs a Raspberry Pi or Linux box with systemd on their network. The Relay is up in about three minutes.

approx. 3 min Beginner-friendly Last updated:

What you need

No device running yet? Then take the detailed guide — it sets up a Raspberry Pi from scratch.

Install the Relay

Open a terminal on the device (over SSH or directly) and run the install command:

curl -fsSL https://get.poolpilot.eu/install.sh | bash

The installer detects your architecture, downloads the matching version, verifies it cryptographically (SHA-256 checksum, and a minisign signature when that tool is available) and sets up a systemd service. Just before it needs system privileges, it prints the exact steps and then asks for your sudo password.

Pair it in the app

Open the PoolPilot app on a device that’s on the same network. The app discovers the Relay automatically — just follow the prompts to pair.

If it isn’t found automatically, show the pairing code right on the Relay:

sudo poolpilot-relay show-pairing

This prints three things: a QR code you scan with the PoolPilot app or simply your phone’s camera, the same link as text — open it on your phone (tap it or open it in the phone’s browser) and it opens the PoolPilot app — and the Relay’s fingerprint, which you can type into the app by hand.

ProCon.IP settings, Remote access section: a “PoolPilot Relay” entry marked “discovered nearby” (labels in German).
In the ProCon.IP settings: the app has found the relay on the network.
“PoolPilot Relay” screen: a “PoolPilot Relay found” card with a “Set up relay” button, plus “Scan pairing code” and “Enter fingerprint manually” (labels in German).
One tap on “Set up relay” — or pair via pairing code or fingerprint.
PoolPilot app, “PoolPilot Relay” screen: status card with green checkmarks — relay connected, connected, and pool controller reachable (labels in German).
Paired and connected: “Relay connected” and “Controller reachable”, all green.

Check that it’s running

Back on the Relay device, look at the status and logs:

systemctl status poolpilot-relay
journalctl -u poolpilot-relay -f

Shortly after boot you should see a line like agent starting version=…. That’s it — the Relay is up, and depending on your pool controller, remote access, push and sharing now run through it.

Good to know

  • Configuration: everything important is set in the app. You normally never need to touch the file /etc/poolpilot-relay/config — if you do, it’s all under Updates & settings.
  • Updates: the Relay updates itself overnight. “Update now” and the automatic-updates toggle belong to the household owner — other paired phones can see the status and ask for an update check. UPDATE_DISABLED=1 in the config turns updates off entirely, and then “Update now” stops working too.
  • Removing it: the full uninstall commands are under Help & commands.

Relay repository & docs