-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(changelog): clarify webrtc in v0.24
This sets the expectations (not production ready) and gives users hint how to enable it by adding `/udp/4001/webrtc-direct` listener.
- Loading branch information
Showing
2 changed files
with
33 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2076,13 +2076,25 @@ Type: `flag` | |
#### `Swarm.Transports.Network.WebRTCDirect` | ||
|
||
**Experimental:** the support for WebRTC Direct is currently experimental. | ||
|
||
A new feature of [`go-libp2p`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0) | ||
is the [WebRTC Direct](https://github.com/libp2p/go-libp2p/pull/2337) transport. | ||
|
||
WebRTC Direct is a transport protocol that provides another way for browsers to connect to the rest of the libp2p network. WebRTC Direct allows for browser nodes to connect to other nodes without special configuration, such as TLS certificates. This can be useful for browser nodes that do not yet support WebTransport, for example. | ||
|
||
Note that, at the moment, WebRTC Direct cannot be used to connect to a browser node to a node that is behind a NAT or firewall. This is being worked on [`go-libp2p#2009`](https://github.com/libp2p/go-libp2p/issues/2009). | ||
This feature was introduced in [`[email protected]`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0). | ||
|
||
[WebRTC Direct](https://github.com/libp2p/specs/blob/master/webrtc/webrtc-direct.md) | ||
is a transport protocol that provides another way for browsers to | ||
connect to the rest of the libp2p network. WebRTC Direct allows for browser | ||
nodes to connect to other nodes without special configuration, such as TLS | ||
certificates. This can be useful for browser nodes that do not yet support | ||
[WebTransport](https://blog.libp2p.io/2022-12-19-libp2p-webtransport/). | ||
|
||
Enabling this transport allows Kubo node to act on `/udp/4001/webrtc-direct` | ||
listeners defined in `Addresses.Swarm`, `Addresses.Announce` or | ||
`Addresses.AppendAnnounce`. | ||
|
||
**NOTE:** at the moment, WebRTC Direct cannot be used to connect to a browser | ||
node to a node that is behind a NAT or firewall. | ||
This requires using normal | ||
[WebRTC](https://github.com/libp2p/specs/blob/master/webrtc/webrtc.md), | ||
which is currently being worked on in | ||
[go-libp2p#2009](https://github.com/libp2p/go-libp2p/issues/2009). | ||
|
||
Default: Disabled | ||
|
||
|