Skip to main content

Connect from anywhere

Without extra setup, your phone can only reach your agent while both are on the same Wi-Fi. To reach it from anywhere, connect the machine to the Herald relay. The machine dials out, so you don't need to open ports or touch your router.

Set it up​

Run these on the machine where Hermes runs:

pip install "git+https://github.com/Mohit-Ak/herald-relay#subdirectory=plugin"
herald-tunnel setup

setup registers the machine, saves its settings and starts a background service. Running it again keeps the same registration, so phones you've already paired keep working.

Then run the pairing command again. It detects the relay and puts the relay address in the QR code, so the agent works on mobile data too.

Check it​

herald-tunnel status

You should see OK for local Hermes, the relay and this machine's tunnel.

Keep it running after you log out​

The background service stops when you log out unless you allow it to linger:

sudo loginctl enable-linger $USER

Commands​

CommandWhat it does
herald-tunnel setupRegister this machine and start the service
herald-tunnel setup --new-tokenRegister again with a fresh token (pair your phone again afterwards)
herald-tunnel setup --no-systemdSave settings only; run the tunnel yourself
herald-tunnel runRun the tunnel in the foreground
herald-tunnel statusCheck the connection end to end