`iroh-relay`

Warning

Highly Experimental ™️

Run your own iroh-relay.

Overview

Built from stable v1 iroh
Small footprint with optimised, stripped and upx compressed binary (< 3mb)
Cross platform support with more available on demand

Platform support

x86_64-unknown-linux-musl
aarch64-unknown-linux-musl

Quickstart

Install

x86_64_url="https://git.coopcloud.tech/decentral1se/iroh-relay/raw/branch/main/target/x86_64-unknown-linux-musl/iroh-relay"
wget -q "$x86_64_url" -O iroh-relay
chmod +x iroh-relay

Checksum validation

checksum_url="https://git.coopcloud.tech/decentral1se/iroh-relay/raw/branch/main/target/x86_64-unknown-linux-musl/checksum.txt"
checksum=$(wget -q -O- $checksum_url)
remote_checksum=$(echo "$checksum" | sed -En 's/([0-9a-f]{64})\s+.*/\1/p')
local_checksum=$(sha256sum iroh-relay | sed -En 's/([0-9a-f]{64})\s+.*/\1/p')
if [[ "$remote_checksum" != "$local_checksum" ]]; then
    echo "checksums do not match, abort, abort"
fi

Public relay

iroh-relay comes out-of-the-box with enough default configuration to run standalone without requiring a configuration file. See upstream iroh-relay docs for the various configuration knobs. Comprehensive documentation on all availabe configuration knobs is still coming but you can view all supported option by peeking inside main.rs. TLS with Let's Encrypt is supported also directly, so publicly hosting a relay only requires an ipv4/6 address without a proxy configuration. The iroh-relay uniclipboard docs also have a few useful tips.

Local hacking

RUST_LOG=info,iroh_relay=debug ./iroh-relay --dev

localhost:3340: default endpoint for clients (also available in the browser: localhost:3340)
localhost:9090: metrics endpoint

Build

./scripts/generate.sh

Licenses

Apache 2.0 & MIT, following the upstream licensing choices in iroh.