Self-hosted

🚨 WARNING 🚨 This guide is maintained by the community and may not reflect the most up-to-date relay deployment configuration at all times. Please feel free to contribute patches it if you see inconsistencies or have useful additions for the benefit of other relay operators.

Documentation

The official in-repository documentation for self-hosting a relay is here. Deeper technical documentation about the functioning of the relay is available on docs.rs. Documentation of all possible configuration options for the relay is not published currently. For the time bring, you can peek in the source code to see the entire configuration listing.

Install

Binary

The latest binaries are available on the n0-computer/iroh Github releases page.

Image

An image published on hub.docker.com under the following namespace.

n0computer/iroh-relay

All available tags are listed here.

Basic configuration

The relay’s configuration file is in TOML. The example configuration below is all that is required to get your relay online with automatic TLS via ACME. This configuration can be placed in /etc/iroh-relay/config.toml and run with iroh-relay -c config.toml.

http_bind_addr = "[::]:80"

[tls]
https_bind_addr = "[::]:443"
hostname = "relay.example.org"
cert_mode = "LetsEncrypt"
cert_dir = "/var/lib/iroh-relay/certs"
contact = "someone@somewhere.org"

Simple health check

curl --noproxy '*' --fail --show-error \
  https://relay.example.org/healthz

​Documentation

​Install

​Binary

​Image

​Basic configuration

​Simple health check