Burrowee Docs

Appearance

Edge relays ​

The Edge relays page manages the relays you run yourself — on a VPS to serve your own domain, or on a LAN box for fast local paths. What an edge relay is for, and how to install and operate one, is the Edge guide; this page covers the console side: registering, approving, wiring to gateways, and retiring.

Edge relays require the Pro or Team plan. Each relay row shows its name and hostname, its key fingerprint once enrolled, how many gateways use it, a state badge (pending, active, revoked) and an online dot. LAN-mode relays carry a LAN badge and list their LAN addresses.

Register → bootstrap → approve ​

  1. + Add edge relay. Enter the hostname the relay will answer on (for example relay.example.com) and an optional display name. Tick Local LAN relay if the relay should also serve clients on its own network directly — then the hostname can be a .local mDNS name or LAN IP, and a public domain is optional.

  2. The console mints a one-time setup blob and PIN (shown once, with an expiry — mint again if it lapses), plus the full command:

    sh
    burrowee edge bootstrap <blob> <pin>

    Run it on the relay machine. The relay enrols and appears in the list as pending.

  3. Click Approve. The relay flips to active and starts serving. Approval counts against your plan's edge-relay limit.

The pending step is deliberate: a blob could be run anywhere, so nothing serves your traffic until you confirm the enrolment you expected.

Wiring a relay to a gateway ​

An active relay carries only the gateways you connect to it. Click Add to gateway on the relay row — the console mints another one-time blob + PIN. On the gateway machine, either run:

sh
burrowee gateway relays pair <blob> <pin>

or paste the blob and PIN into the gateway's local console under Relays → Pair a relay. The blob expires; mint again any time.

Endpoints — reported vs published ​

A LAN relay discovers its own addresses and reports them up to the console. Reported addresses are candidates; nothing changes for your devices until you publish them. Expand Endpoints on a LAN relay row to see both sets:

  • Reported — what the relay currently sees (wss://<ip>:<port>), with a published badge where applicable. Hide an address you never want offered (a guest network, a VPN interface); hidden entries sit under Show hidden and can be unhidden later.
  • Published — the addresses your gateways and CLI pairings actually use.

When the relay reports addresses that differ from what is published, the row shows a New LAN addresses reported banner with an Update endpoints button. Publishing pushes the new addresses to connected gateways automatically (or they pick them up on their next sync). CLI clients keep their old addresses until updated manually — re-run burrowee bootstrap on the client, or edit its config.

Revoke and delete ​

  • Remove (on an active relay) revokes it permanently: it stops serving, and the slot frees up for a replacement. There is no un-revoke — add a new relay to replace it.
  • Delete (on a pending or revoked relay) erases the row entirely. An active relay must be revoked first.