Skip to content

chore: dep update + ensure iroh 1.0 is backwards compatible with 0.94 #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rustonbsd merged 2 commits into from
Oct 5, 2026
Merged

chore: dep update + ensure iroh 1.0 is backwards compatible with 0.94 #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83ebed4
chore: dep update + iroh 1.0 backwards compatible with 0.94
rustonbsd Jun 24, 2026
1148547
chore: update custom relay setup docs
rustonbsd Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CUSTOM_RELAY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Custom Relay Setup

This version of `iroh-ssh` is built on iroh version `0.94`. If you want to use a custom relay server as seen in the examples below, you need to use the matching `iroh-relay` of version `0.94`. See [setup relay server](#setup-relay-server) for more information on how to set up a relay server.
This version of `iroh-ssh` is built on iroh version `1.0.0`. This is tested to be compatible with `0.94.0` and I assume it works with the intermediate versions as well. See [setup relay server](#setup-relay-server) for more information on how to set up a relay server.

## Usage --relay-url

Expand All @@ -20,13 +20,13 @@ The easiest way is to use `n0-computers` own `iroh-relay` Docker image:

```bash
# Creates a relay server bound to 'http://localhost:3340'
> docker run n0computer/iroh-relay:v0.94.0 --dev
> docker run n0computer/iroh-relay:v1.0.0 --dev
```

The best resource for setting up your own relay server beyond the `--dev` testing mode is the [iroh-relay README](https://github.com/n0-computer/iroh/tree/main/iroh-relay). To run securely with TLS you can pass a config `--config-path <PATH>` option as follows:

```bash
> docker run -d -p 80:80 -p 443:443 -v /path/with/config/:/app n0computer/iroh-relay:v0.94.0 --config-path /app/relay-config.toml
> docker run -d -p 80:80 -p 443:443 -v /path/with/config/:/app n0computer/iroh-relay:v1.0.0 --config-path /app/relay-config.toml
```

and to get you started, here my example `relay-config.toml`:
Expand Down
Loading
Loading