-
-
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.
Merge branch 'master' into twdragon-ppa
- Loading branch information
Showing
19 changed files
with
222 additions
and
178 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
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
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
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 |
---|---|---|
|
@@ -552,7 +552,7 @@ Type: `array[string]` | |
|
||
## `AutoNAT` | ||
|
||
Contains the configuration options for the AutoNAT service. The AutoNAT service | ||
Contains the configuration options for the libp2p's [AutoNAT](https://github.com/libp2p/specs/tree/master/autonat) service. The AutoNAT service | ||
helps other nodes on the network determine if they're publicly reachable from | ||
the rest of the internet. | ||
|
||
|
@@ -561,13 +561,22 @@ the rest of the internet. | |
When unset (default), the AutoNAT service defaults to _enabled_. Otherwise, this | ||
field can take one of two values: | ||
|
||
* "enabled" - Enable the service (unless the node determines that it, itself, | ||
isn't reachable by the public internet). | ||
* "disabled" - Disable the service. | ||
* `enabled` - Enable the V1+V2 service (unless the node determines that it, | ||
itself, isn't reachable by the public internet). | ||
* `legacy-v1` - Same as `enabled` but only V1 service is enabled. Used for testing | ||
during as few releases as we [transition to V2](https://github.com/ipfs/kubo/issues/10091), will be removed in the future. | ||
* `disabled` - Disable the service. | ||
|
||
Additional modes may be added in the future. | ||
|
||
Type: `string` (one of `"enabled"` or `"disabled"`) | ||
> [!IMPORTANT] | ||
> We are in the progress of [rolling out AutoNAT V2](https://github.com/ipfs/kubo/issues/10091). | ||
> Right now, by default, a publicly diallable Kubo provides both V1 and V2 service to other peers, | ||
> but only V1 is used by Kubo as a client. In a future release we will remove V1 and switch client to use V2. | ||
Default: `enabled` | ||
|
||
Type: `optionalString` | ||
|
||
### `AutoNAT.Throttle` | ||
|
||
|
@@ -2144,7 +2153,7 @@ Configuration section for libp2p _network_ transports. Transports enabled in | |
this section will be used for dialing. However, to receive connections on these | ||
transports, multiaddrs for these transports must be added to `Addresses.Swarm`. | ||
|
||
Supported transports are: QUIC, TCP, WS, Relay and WebTransport. | ||
Supported transports are: QUIC, TCP, WS, Relay, WebTransport and WebRTCDirect. | ||
|
||
Each field in this section is a `flag`. | ||
|
||
|
@@ -2195,8 +2204,8 @@ Default: Enabled | |
Type: `flag` | ||
|
||
Listen Addresses: | ||
* /ip4/0.0.0.0/udp/4001/quic-v1 (default) | ||
* /ip6/::/udp/4001/quic-v1 (default) | ||
- `/ip4/0.0.0.0/udp/4001/quic-v1` (default) | ||
- `/ip6/::/udp/4001/quic-v1` (default) | ||
|
||
#### `Swarm.Transports.Network.Relay` | ||
|
||
|
@@ -2243,33 +2252,40 @@ Default: Enabled | |
|
||
Type: `flag` | ||
|
||
#### `Swarm.Transports.Network.WebRTCDirect` | ||
Listen Addresses: | ||
- `/ip4/0.0.0.0/udp/4001/quic-v1/webtransport` (default) | ||
- `/ip6/::/udp/4001/quic-v1/webtransport` (default) | ||
|
||
**Experimental:** the support for WebRTC Direct is currently experimental. | ||
This feature was introduced in [`[email protected]`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0). | ||
#### `Swarm.Transports.Network.WebRTCDirect` | ||
|
||
[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/). | ||
[WebTransport](https://blog.libp2p.io/2022-12-19-libp2p-webtransport/), | ||
which is still relatively new and has [known issues](https://github.com/libp2p/js-libp2p/issues/2572). | ||
|
||
Enabling this transport allows Kubo node to act on `/udp/4002/webrtc-direct` | ||
Enabling this transport allows Kubo node to act on `/udp/4001/webrtc-direct` | ||
listeners defined in `Addresses.Swarm`, `Addresses.Announce` or | ||
`Addresses.AppendAnnounce`. At the moment, WebRTC Direct doesn't support listening on the same port as a QUIC or WebTransport listener | ||
`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). | ||
> [!NOTE] | ||
> WebRTC Direct is browser-to-node. It cannot be used to connect a browser | ||
> node to a node that is behind a NAT or firewall (without UPnP port mapping). | ||
> The browser-to-private 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 | ||
Default: Enabled | ||
|
||
Type: `flag` | ||
|
||
Listen Addresses: | ||
- `/ip4/0.0.0.0/udp/4001/webrtc-direct` (default) | ||
- `/ip6/::/udp/4001/webrtc-direct` (default) | ||
|
||
### `Swarm.Transports.Security` | ||
|
||
Configuration section for libp2p _security_ transports. Transports enabled in | ||
|
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
Oops, something went wrong.