waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document ext-multiaddr-only option (#130)

This commit is contained in:
LordGhostX 2023-10-31 13:13:15 +01:00 committed by GitHub
parent 0e655b98c0
commit 7a975c8045
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/guides/nwaku/configure-nwaku.md
View File

@ -196,7 +196,7 @@ Consider a `nwaku` node that enabled the REST `admin` and `private` API with a m
## Configure Filter Protocol
To enable `nwaku` to serve light clients, enable the [Filter protocol](/overview/concepts/protocols#filter) using the following configuration options:
To enable `nwaku` to serve light clients, enable the [Filter protocol](/overview/concepts/protocols#filter) using `filter` option:
```bash
./build/wakunode2 --filter=true
@ -224,7 +224,7 @@ If you omit the `filter-timeout` option, it will default to `14400` seconds (4 h
## Configure Light Push Protocol
To enable `nwaku` to serve light clients, enable the [Light Push protocol](/overview/concepts/protocols#light-push) using the following configuration options:
To enable `nwaku` to serve light clients, enable the [Light Push protocol](/overview/concepts/protocols#light-push) using the `lightpush` option:
```bash
./build/wakunode2 --lightpush=true
@ -240,4 +240,18 @@ For example, consider a `nwaku` node that requests lightpush of published messag
```bash
./build/wakunode2 --lightpushnode=/dns4/node-01.ac-cn-hongkong-c.wakuv2.prod.statusim.net/tcp/30303/p2p/16Uiu2HAm4v86W3bmT1BiH6oSPzcsSr24iDQpSN5Qa992BCjjwgrD
```
```
## Run a Node Behind a Reverse Proxy
When using a reverse proxy server for SSL/TLS encryption, you only want to announce the proxy server's IP or domain. Nwaku provides the `ext-multiaddr-only` and `ext-multiaddr` options for specifying published multiaddr:
```bash
./build/wakunode2 \
--ext-multiaddr-only=true \
--ext-multiaddr=[MULTIADDR TO PUBLISH]
```
:::info
The `ext-multiaddr-only` option takes precedence over the `nat` and `dns4-domain-name` options, using the values provided by the `ext-multiaddr` option instead.
:::