chore: Fix .md docs (fix broken links, add QUIC notes) (#3988)

This commit is contained in:
Fabiana Cecin 2026-06-25 04:11:52 -03:00 committed by GitHub
parent 5c20f48ab3
commit 56b92cfd71
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 50 additions and 4 deletions

View File

@ -11,7 +11,7 @@ private communications.
- Examples.
- Various tests of above.
For more details see the [source code](waku/README.md)
For more details see the [source code](logos_delivery/waku/README.md)
## How to Build & Run ( Linux, MacOS & WSL )
@ -48,11 +48,14 @@ make wakunode2 NIMFLAGS="-d:chronicles_colors:none -d:disableMarchNative"
# Run with DNS bootstrapping
./build/wakunode2 --dns-discovery --dns-discovery-url=DNS_BOOTSTRAP_NODE_URL
# Run with the QUIC transport enabled
./build/wakunode2 --quic-support=true
# See available command line options
./build/wakunode2 --help
```
To join the network, you need to know the address of at least one bootstrap node.
Please refer to the [Waku README](https://github.com/logos-messaging/logos-delivery/blob/master/waku/README.md) for more information.
Please refer to the [Waku README](https://github.com/logos-messaging/logos-delivery/blob/master/logos_delivery/waku/README.md) for more information.
For more on how to run `wakunode2`, refer to:
- [Run using binaries](https://docs.waku.org/run-node/build-source)

View File

@ -0,0 +1,20 @@
# Configure QUIC transport
QUIC is a UDP-based transport. Enabling it allows peers to connect to your node over QUIC, in addition to the default TCP transport.
To enable QUIC, use the `--quic-support` option.
Note, the default port for QUIC is 60000.
```shell
wakunode2 --quic-support=true
```
To listen on a different UDP port, use `--quic-port`:
```shell
wakunode2 --quic-support=true --quic-port=<port>
```
QUIC runs alongside the existing TCP transport. The node keeps listening on TCP and announces a `/udp/<port>/quic-v1` address in its ENR, so peers that support QUIC can connect over it while others continue to use TCP.
If you restrict the node's announced addresses with `--ext-multiaddr-only`, the QUIC address is no longer announced automatically. In that case, include the QUIC multiaddr in `--ext-multiaddr` yourself, for example `/ip4/<ip>/udp/<port>/quic-v1`.

View File

@ -132,5 +132,6 @@ This is an index of tutorials explaining how to configure your nwaku node for di
4. [Configure store protocol and message store](./configure-store.md)
5. [Generate and configure a node key](./configure-key.md)
6. [Configure websocket transport](./configure-websocket.md)
7. [Run nwaku with rate limiting enabled](./run-with-rln.md)
8. [Configure a REST API node](./configure-rest-api.md)
7. [Configure QUIC transport](./configure-quic.md)
8. [Run nwaku with rate limiting enabled](./run-with-rln.md)
9. [Configure a REST API node](./configure-rest-api.md)

View File

@ -56,6 +56,12 @@ and websocket address
/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H
```
If your node is running with QUIC enabled, the log also includes a QUIC address
```
/ip4/0.0.0.0/udp/60000/quic-v1/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H
```
You can also query a running node for its listening addresses
using the REST API.

View File

@ -232,4 +232,20 @@ However, they can be used for local testing purposes:
mkdir -p ./ssl_dir/
openssl req -x509 -newkey rsa:4096 -keyout ./ssl_dir/key.pem -out ./ssl_dir/cert.pem -sha256 -nodes
wakunode2 --websocket-secure-support=true --websocket-secure-key-path="./ssl_dir/key.pem" --websocket-secure-cert-path="./ssl_dir/cert.pem"
```
## Enabling QUIC
QUIC is a UDP-based transport that peers can use to connect to your node.
The default port for QUIC is 60000.
```shell
wakunode2 --quic-support=true
```
To listen on a different UDP port, use `--quic-port`:
```shell
wakunode2 --quic-support=true --quic-port=<port>
```