extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2024-12-15 11:21:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add doc

Browse Source
This commit is contained in:
Zoltán Papp 2024-07-29 21:58:27 +02:00
parent 5be33d668b
commit 7942b0ebae
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
relay/doc.go
View File

@ -4,5 +4,11 @@ The `relay` package contains the implementation of the Relay server and client.
messages between peers on a single network channel. In this implementation the transport layer is the WebSocket messages between peers on a single network channel. In this implementation the transport layer is the WebSocket
protocol. protocol.
Between the server and client communication has been design a custom protocol and message format. These messages are
transported over the WebSocket connection. Optionally the server can use TLS to secure the communication.
The service can support multiple Relay server instances. For this purpose the peers must know the server instance URL.
This URL will be sent to the target peer to choose the common Relay server for the communication via Signal service.
*/ */
package relay package relay