You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some rephrasing in the overview. Mostly about relay servers (#299)
* Some rephrasing in the overview. Mostly about relay servers
* Apply suggestions from code review
Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com>
---------
Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com>
Copy file name to clipboardExpand all lines: src/app/docs/overview/page.mdx
+16-6Lines changed: 16 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ export const metadata = {
8
8
# Overview
9
9
10
10
Iroh lets you establish direct peer-to-peer connections whenever possible, falling back to relay servers if necessary.
11
-
This gives you fast, reliable connections that are authenticated and encrypted end-to-end using QUIC. {{className: 'lead'}}
11
+
This gives you fast, reliable QUIC connections that are authenticated and encrypted end-to-end. {{className: 'lead'}}
12
12
13
13
14
14
## Iroh is "dial by public key"
@@ -17,15 +17,25 @@ In the iroh world, you dial another node by its `NodeId`, a 32-byte ed25519 publ
17
17
You won't have to think about NATs getting in your way, iroh traverses them for you.
18
18
Basing connections on asymmetric public keys is what allows iroh to *always* end-to-end encrypt and authenticate connections.
19
19
20
-
## How it works
21
20
22
-
It's built on peer-to-peer QUIC using both relays and holepunching.
21
+
## Peer to peer
23
22
24
-
Peer to peer connectivity is established with the help of a relay server. The relay server provides Session Traversal Utilities for NAT (STUN) for the peers. If no direct connection can be established, the connection is relayed via the server.
23
+
Iroh is built on peer-to-peer QUIC using both relays and holepunching.
25
24
26
-
Peers must know and do verify the PeerID of each other before they can connect. When using a relay server to aid the connection establishment they will register with a home relay server using their PublicKey. Other peers which can not establish a direct connection can then establish connection via this relay server. This will try to assist establishing a direct connection using STUN and holepunching but continue relaying if not possible.
25
+
Peers must know the NodeId of a peer before connecting to it.
26
+
They verify this NodeId during the connection handshake to provide end-to-end encryption and authentication.
27
27
28
-
Peers can also connect directly without using a relay server. For this, however the listening peer must be directly reachable by the connecting peer via one of it's addresses.
28
+
Peer to peer connectivity is established with the help of a relay server.
29
+
On startup peers register their NodeId with a home relay server.
30
+
The relay server provides assistance to traverse firewalls,
31
+
NATs or others alike.
32
+
If no direct connection can be established,
33
+
the connection is relayed via the server.
34
+
35
+
Peers can also connect directly without using a relay server.
36
+
For this,
37
+
however,
38
+
the listening peer must be directly reachable by the connecting peer via one of it's addresses.
0 commit comments