Skip to content

Commit e89bef5

Browse files
authored
Merge pull request #50 from ProgVal/clarify-transport
Clarify the transport does not have to be TCP/IPv4.
2 parents 8066c6c + f687558 commit e89bef5

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ <h2 id="keys-and-identities">Keys and identities</h2>
108108

109109
<h2 id="discovery">Discovery</h2>
110110
<div>
111-
<p>After a user has generated their identity they need to find some peers to connect to. To connect to a peer you need to know its IP address, port number and public key. The Scuttlebutt protocol currently has three methods for peers to discover each other.</p>
111+
<p>After a user has generated their identity they need to find some peers to connect to. To connect to a peer you need its public key and its address using any of the protocol it supports. Typically with TCP/IP, you would need its IP address and port, but the Scuttlebutt protocol is not restricted to TCP/IP as transport. The Scuttlebutt protocol currently has three methods for peers to discover each other.</p>
112112

113113
<h3 id="local-network">Local network</h3>
114114
<p>Peers constantly broadcast UDP packets on their local network advertising their presence. The body of each packet is a string containing the peer’s IP address, port and base64-encoded public key (without <code>@</code> or <code>.ed25519</code>):</p>
@@ -135,6 +135,7 @@ <h5>Implementations</h5>
135135
<img src="img/format_udp_broadcast.png" style="height: 40px;"/>
136136
</div>
137137
</figure>
138+
<p>This message format can be any valid <a href="https://github.com/ssb-js/multiserver#address-format">multiserver address</a>. In local networks, this is usually a <code>net</code> address with an IPv4 or IPv6 address.</p>
138139
<p>Current implementations broadcast one of these packets every second. When a peer sees another peer’s broadcast packet they can connect to exchange messages. Some clients show nearby peers in the user interface so that the user can see other people on the same network as them.</p>
139140
</div>
140141
<aside>

0 commit comments

Comments
 (0)