Skip to content

Commit f221dc7

Browse files
authored
Merge pull request #16 from n0-computer/rae/iroh-services
After a review from folks, update docs with more iterative improvements
2 parents 613e19f + 9483204 commit f221dc7

File tree

18 files changed

+95
-37
lines changed

18 files changed

+95
-37
lines changed

concepts/discovery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ that endpoint. So the Pkarr packet currently only needs to contain the EndpointI
8585
the relay URL of its preferred relay server (which we call its "home relay").
8686
When Pkarr publishing is enabled on your iroh endpoint, your endpoint will create a
8787
Pkarr packet with its EndpointID and relay URL, sign it, and defaults to publishing
88-
on an `iroh-dns` server that is run by [the n0 team](https://n0.computer).
88+
on an `iroh-dns` server that is run by [n0.computer](https://n0.computer).
8989

9090
From there, others can discover your dialing information by resolving your EndpointID using regular DNS. It's worth noting that others must still learn your endpoint
9191
ID for this to work.

concepts/relays.mdx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ iroh networks. Anecdotal evidence points to roughly 9 out of 10 networking condi
1616

1717
## Public relays
1818

19-
iroh is configured with a set of public relays provided by [The n0
20-
team](https://n0.computer) that are free to use. The public relays rate-limit
19+
iroh is configured with a set of public relays provided by [n0.computer](https://n0.computer) that are free to use. The public relays rate-limit
2120
traffic that flows through the relay. This is to prevent abuse, and ensure the
2221
relays are available to everyone. There are no guarantees around uptime or
2322
performance when using the public relays.
@@ -33,10 +32,6 @@ servers that are either self-hosted or provided as a managed service. Dedicated
3332
relays provide better performance, security, and uptime guarantees compared to
3433
the public relays.
3534

36-
Relay code is open source! You can run your own relay server, or [pick a hosting
37-
provider](/iroh-services).
38-
39-
4035
## Why this architecture is powerful
4136

4237
This approach makes uptime management significantly easier compared to

connecting/custom-relays.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
3+
By default, iroh endpoints will use public relays to facilitate connections when direct
4+
peer-to-peer connections are not possible. These relays are managed and
5+
maintained by [n0.computer](https://n0.computer).
6+
7+
For production use cases, you will want to set up your own private relays, to
8+
ensure that your traffic is not mixed with other users, and to have more control
9+
over the relay infrastructure.
10+
11+
For more information about getting help with hosting, please see our [hosting page](https://iroh.computer/services/hosting) or [professional services](https://iroh.computer/services/support).
12+
13+
## Configuration
14+
15+
```rust
16+
use iroh::Endpoint;
17+
use iroh::relay::RelayUrl;
18+
19+
#[tokio::main]
20+
async fn main() -> anyhow::Result<()> {
21+
// Configure your endpoint with dedicated relays
22+
let relay_url1: RelayUrl = "RELAY_URL_1".parse()?;
23+
let relay_url2: RelayUrl = "RELAY_URL_2".parse()?;
24+
25+
let endpoint = Endpoint::builder()
26+
.relay_mode(iroh::endpoint::RelayMode::Custom(vec![relay_url1, relay_url2]))
27+
.bind()
28+
.await?;
29+
30+
Ok(())
31+
}
32+
```
33+
34+
## Recommended Relay Setup
35+
36+
For production use cases, we recommend setting up at least two relays in
37+
different geographic regions. This ensures that if one relay goes down or
38+
becomes unreachable, your endpoints can still connect through the other relay.
39+
40+
Each relay can handle up to 10,000 concurrent connections, so for larger scale
41+
deployments, you may need to set up multiple relays in each region or [contact
42+
us to increase the size of your relays](https://cal.com/team/number-0/n0-protocol-services).

deployment/dedicated-infrastructure.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ DNS and end-to-end encryption over relays. This infrastructure comprises:
1010

1111
Relays forward traffic when direct connections are not possible as well
1212
as facilitates holepunching for direct connections. These servers are managed and
13-
maintained by [the n0 team](https://n0.computer), and are shared by a global public network of
13+
maintained by [n0.computer](https://n0.computer), and are shared by a global public network of
1414
developers.
1515

1616
We recommend using the public relays for development and testing, as they are
@@ -37,12 +37,10 @@ If you require more control over your relay infrastructure, you can choose to
3737
[self-host your own
3838
relay](https://github.com/n0-computer/iroh/tree/main/iroh-relay) or [upgrade to
3939
a managed relay service](/iroh-services/relays). This managed relay
40-
service is monitored by [the n0 team](https://n0.computer) who maintain the iroh project, and
40+
service is monitored by [n0.computer](https://n0.computer) who maintain the iroh project, and
4141
offers SLAs around uptime and performance.
4242

43-
[Sign up for a free trial of Iroh Services](/iroh-services) to get access
44-
to purchase a managed relay with uptime SLAs.
45-
43+
[Sign up for a free account](https://n0des.iroh.computer) to get started.
4644

4745
## Recommended setup
4846

deployment/metrics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ metrics.pings_recv.inc();
3333
The `iroh-metrics` crate supports exporting metrics in various formats, such
3434
as Prometheus, which can be scraped by monitoring systems.
3535

36-
As a convenience, the iroh team runs a service that collects Prometheus metrics from
36+
As a convenience, [n0.computer](https://n0.computer) runs a service that collects Prometheus metrics from
3737
applications using iroh. To export your metrics to this service, you can use the
3838
`iroh-n0des` crate.
3939

deployment/security-privacy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ endpoint creation.
2424
## Public Relays
2525

2626
iroh is by default configured to use shared public infrastructure that is
27-
operated by [the n0 team](https://n0.computer/). Because traffic is end-to-end
27+
operated by [n0.computer](https://n0.computer) . Because traffic is end-to-end
2828
encrypted, relays are not able to read any of the traffic that they forward or
2929
help connect. However, the relays are able to see metadata about connections,
3030
such as source and destination IP addresses, connection times, and the amount of

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
"group": "Forming a Network",
3838
"pages": [
3939
"connecting/creating-endpoint",
40+
"connecting/custom-relays",
4041
"connecting/dns-discovery",
4142
"connecting/dht-discovery",
4243
"connecting/local-discovery",

images/create-api-key.png

41.8 KB
Loading

images/dns.gif

-23.5 MB
Loading

images/new-project.png

30.9 KB
Loading

0 commit comments

Comments
 (0)