yggpeers

A webapp that tracks the reachability of public peers for the Yggdrasil network. Supports JSON and CSV output, a peer world map, statistics, and more.

Deploying

Container (recommended)

docker run -p 8080:8080 gitfield.org/fsky/yggpeers:latest

A Quadlet unit file is available at contrib/quadlet/yggpeers.container for deploying with Podman and systemd.

From source

Requires Go 1.26+.

make build
./build/yggpeers

Use make run to start directly with go run. make test, make lint, and make fmt run the common test, vet, and formatting commands; make check runs the full checks.

Then open http://localhost:8080 in your browser.

See make help for available commands.

Map

Country and territory boundaries are bundled as vector tiles in a PMTiles archive. The browser downloads only the portions needed for the current view, with finer detail as you zoom in. No map tile service or API key is required. Hong Kong, Singapore, and other small places with peers have hoverable markers when zoomed out; clicking a marker zooms to its boundary.

The archive is about 4.9 MB on the server, not a full download per visitor. Peer counts are fetched separately, and switching Total/Online reuses the loaded geometry. The map uses Natural Earth's 1:10 million boundaries, which provide regional rather than street-level detail.

Map assets are embedded in the binary. Normal Go and container builds need no extra tools. See map maintenance and verification to regenerate the assets or run the browser checks. A reverse proxy must preserve HTTP byte-range responses for /static/countries.pmtiles and must not apply whole-file gzip/Brotli compression to that archive.

Configuration

Configuration is handled through environment variables:

License

The code of this project is released under the Unlicense. See the LICENSE file for details.

Bundled map data is public-domain Natural Earth data. The PMTiles reader and its bundled dependency retain their third-party licenses.