HelpBuoy

Run the server on an always-on machine

Keep the server online all the time, on an always-on Debian machine.

By default the server runs inside your desk app, on your own computer. That’s enough for most people. If several techies share a server, 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-server_*.deb

This runs helpbuoy-server as a hardened system service under its own user, with its data in /var/lib/helpbuoy-server and settings in /etc/default/helpbuoy-server. Use helpbuoy-serverctl to run the commands below as the service user.

Commands

  • helpbuoy-server serve [--listen :5959]
    Run the server on its single port.
  • helpbuoy-server techie list
    List techies with their fingerprints.
  • helpbuoy-server techie add alice 'ssh-ed25519 …'
    Add a techie with the public key copied from their desk app.
  • helpbuoy-server techie remove alice
    Remove a techie; takes effect immediately and closes their open sessions.
  • helpbuoy-server computer list
    List registered PCs: name, fingerprint, registered by and at, last seen.
  • helpbuoy-server computer add 'ssh-ed25519 …' ['Anna laptop']
    Register a PC, like Add computer in the desk app; the name defaults to the key comment.
  • helpbuoy-server computer rename SHA256:… 'Anna laptop'
    Rename a registered PC; every techie sees the new name.
  • helpbuoy-server computer remove SHA256:…
    Remove a registered PC; if it’s online, it’s disconnected.
  • helpbuoy-server title ['Example Inc']
    Print or set the title PCs show while waiting ('' clears it).
  • helpbuoy-server instruction ['Call 06 12 34 56 78']
    Print or set the instruction line ('' restores the default).
  • helpbuoy-server hostkey
    Print the server fingerprint, to compare with what PCs show.
  • helpbuoy-server version
    Print the version.

Every command except version takes --state DIR to use another state directory. Changes made on the command line reach the running server right away, without a restart.

Remember to open TCP port 5959 to the machine, as described in Set up your desk.