Skip to content

Commit

Permalink
document ext-multiaddr-only option
Browse files Browse the repository at this point in the history
  • Loading branch information
LordGhostX committed Oct 30, 2023
1 parent 0e655b9 commit 24affad
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/guides/nwaku/configure-nwaku.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
:::

0 comments on commit 24affad

Please sign in to comment.