Skip to content

Commit b9f45e0

Browse files
committed
doc: relay section added to the readme
1 parent 141472e commit b9f45e0

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,3 +173,38 @@ echo request1.bin | dumbpipe connect <ticket> --custom-alpn utf8:/iroh-bytes/2 >
173173

174174
if request1.bin contained a valid request for the `/iroh-bytes/2` protocol, response1.bin will
175175
now contain the response.
176+
177+
## Custom Relay Configuration
178+
179+
By default, dumbpipe uses iroh's automatic relay selection, which picks the fastest responding relay server from the n0 network. You can customize this behavior using the `--relay` option:
180+
181+
### Disable relays entirely
182+
183+
If you want to force direct connections only:
184+
185+
```bash
186+
dumbpipe listen --relay disabled
187+
dumbpipe connect <ticket> --relay disabled
188+
```
189+
190+
This will only attempt direct peer-to-peer connections and won't fall back to relay servers.
191+
192+
### Use default relays (default behavior)
193+
194+
```bash
195+
dumbpipe listen --relay default
196+
dumbpipe connect <ticket> --relay default
197+
```
198+
199+
This is the default behavior when no `--relay` option is specified.
200+
201+
### Use a custom relay server
202+
203+
If you're running your own relay server or want to use a specific one:
204+
205+
```bash
206+
dumbpipe listen --relay https://your-relay-server.com
207+
dumbpipe connect <ticket> --relay https://your-relay-server.com
208+
```
209+
210+
**Note**: Both the listener and connector should use the same relay configuration for optimal connectivity.

0 commit comments

Comments
 (0)