Run the relay on a server
Keep the relay online all the time, on an always-on Debian machine.
By default the relay runs inside your desk app, on your own computer. That’s enough for most people. If several helpers share a relay, or you want the people you help to see it online even when your computer is off, run it on a machine that’s always on.
Debian package
On Debian 13, install the .deb from the download page:
sudo apt install ./helpbuoy-relay_*.deb
This runs helpbuoy-relay as a hardened system service under its own user, with its data in /var/lib/helpbuoy-relay and settings in /etc/default/helpbuoy-relay. Use helpbuoy-relayctl to run the commands below as the service user.
Standalone
On any other machine, run the helpbuoy-relay program from the desk app archive. It needs no administrator rights:
helpbuoy-relay serve --listen :5959
Commands
| Command | What it does |
|---|---|
helpbuoy-relay agent add alice 'ssh-ed25519 …' |
add a helper with the key from their desk app |
helpbuoy-relay agent remove alice |
remove a helper, effective immediately |
helpbuoy-relay agent list |
list helpers |
helpbuoy-relay client list |
list registered PCs |
helpbuoy-relay client remove SHA256:… |
remove a PC |
helpbuoy-relay title 'Example Inc' |
set the title PCs show while waiting |
helpbuoy-relay instruction 'Call 06 12 34 56 78' |
set the instruction line |
helpbuoy-relay hostkey |
print the relay fingerprint |
Remember to open TCP port 5959 to the machine, as described in Set up your desk.