coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-23 19:37:46 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs(changelog): clarify webrtc in v0.24

Browse Source 
This sets the expectations (not production ready) and
gives users hint how to enable it by adding `/udp/4001/webrtc-direct`
listener.
This commit is contained in:
Marcin Rataj 2023-11-09 01:42:04 +01:00 committed by Henrique Dias
parent 9655d92908
commit 7834a26d03
2 changed files with 29 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/changelogs/v0.24.md
View File

@ -71,14 +71,20 @@ cached more efficiently and load faster in browser contexts.
#### Experimental Transport: WebRTC Direct
[WebRTC Direct](https://github.com/libp2p/go-libp2p/pull/2337) has now been introduced
in [`go-libp2p`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0) v0.32.0. This
transport protocol allows browser nodes to connect to other nodes without special configuration,
such as TLS certificates. This can be useful for browsers that do not yet support
WebTransport, for example.
This Kubo release includes the initial work towards WebRTC Direct
introduced in [`go-libp2p`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0) v0.32:
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).
> [WebRTC Direct](https://github.com/libp2p/specs/blob/master/webrtc/webrtc-direct.md)
> allows browser nodes to connect to go-libp2p nodes directly,
> without any configuration (e.g. TLS certificates) needed on the go-libp2p
> side. This is useful for browser nodes that aren’t able to use
> [WebTransport](https://blog.libp2p.io/2022-12-19-libp2p-webtransport/).
The `/webrtc-direct` transport is disabled by default in Kubo 0.24,
and not ready for production use yet, but we plan to enable it in a future release.
See [`Swarm.Transports.Network.WebRTCDirect`](https://github.com/ipfs/kubo/blob/master/docs/config.md#swarmtransportsnetworkwebrtcdirect)
to learn how to enable it manually, and what current limitations are.
### 📝 Changelog

20
docs/config.md
View File

@ -2076,13 +2076,25 @@ Type: `flag`
#### `Swarm.Transports.Network.WebRTCDirect`
**Experimental:** the support for WebRTC Direct is currently experimental.
This feature was introduced in [`go-libp2p@v0.32.0`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0).
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](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/).
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.
Enabling this transport allows Kubo node to act on `/udp/4001/webrtc-direct`
listeners defined in `Addresses.Swarm`, `Addresses.Announce` or
`Addresses.AppendAnnounce`.
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).
**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