Burrowee Docs

Appearance

Install edge ​

Install burrowee-edge to run your own self-hosted relay — on a machine inside your LAN for fast local hops, or on a public host (a VPS at edge.example.com, say) under your own domain. An edge is account-bound: it carries only your own gateways and is managed from the console.

sh
curl -fsSL --proto '=https' --tlsv1.2 https://release.burrowee.com/edge/install.sh | sh

The installer detects your OS and architecture, downloads the latest edge release, verifies it (minisign signature, then SHA-256 — see the install overview for the full chain), and installs two binaries into $PREFIX/bin (default ~/.local/bin):

  • burrowee — the universal dispatcher; burrowee edge … runs burrowee-edge.
  • burrowee-edge — the relay itself, with its setup and operations subcommands (bootstrap, nginx, service, status, doctor, …).

If ~/.local/bin is not on your PATH, the installer says so and prints the line to add:

sh
export PATH="$HOME/.local/bin:$PATH"

First run ​

On a fresh interactive install (a real terminal, not CI), the installer offers to set the edge up on the spot:

Set up now? Paste the setup blob + PIN from the console (Enter to skip).
blob>

Mint the edge relay in the console first — that is what produces the setup blob and PIN. Paste both at the prompt and the installer runs burrowee edge bootstrap for you. Press Enter to skip and do it later:

sh
burrowee edge bootstrap <blob> <pin>

Two cases where the prompt does not appear:

  • Already set up — if ~/.burrowee/edge/ exists with state in it (the edge identity), re-installing never re-prompts; the binaries are simply updated in place.
  • No terminal (CI, a provisioning script) — the installer just prints the bootstrap command as your next step.

Platform notes ​

  • Linux (typical VPS): make sure minisign and unzip are installed (apt-get install minisign unzip or your distro's equivalent) — verification is mandatory and the installer aborts without them.
  • macOS: the installer removes the Gatekeeper quarantine attribute automatically. If you ever place a binary on PATH by hand and macOS blocks it: xattr -d com.apple.quarantine ~/.local/bin/burrowee-edge.
  • nginx fronting is the default topology for a running edge, but it is configured after install, during setup: a single sudo burrowee edge nginx generates the edge's LAN certificate, writes and verifies the nginx stream config, and reloads nginx. Nothing to do at install time.

Next step ​

Pair the edge to your account, approve it, and start serving: Edge overview.