logos-messaging/docs.waku.org
1
0
Fork 0
mirror of https://github.com/logos-messaging/docs.waku.org.git synced 2026-01-03 21:33:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

add filter config

Browse Source
This commit is contained in:
LordGhostX 2023-09-15 04:00:29 +01:00
parent 7a1f2a7f25
commit 7a0a031814
No known key found for this signature in database
GPG Key ID: 520CC5DC4F94FCC7
2 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.cspell.json
View File

@ -70,6 +70,7 @@
"certbot",
"letsencrypt",
"lightpushnode",
"filternode",
],
"flagWords": [],
"ignorePaths": [

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

@ -51,12 +51,12 @@ To enable the [Store protocol](/overview/concepts/protocols#store) in `nwaku`, u
--store-message-db-url=[DATABASE CONNECTION URL]
```
For example, consider a `nwaku` node that is configured to be a `Store` protocol and retain messages received in the last `15,000` seconds:
For example, consider a `nwaku` node that is configured to be a `Store` protocol and retain messages received in the last `21600` seconds (6 hours):
```bash
./build/wakunode2 \
--store=true \
--store-message-retention-policy=time:15000 \
--store-message-retention-policy=time:21600 \
--store-message-db-url=sqlite://store.sqlite3
```
@ -197,6 +197,34 @@ Consider a `nwaku` node that enabled the REST `admin` and `private` API with a m
--rest-relay-cache-capacity=100
```
## Configure Filter Protocol
To enable the [Filter protocol](/overview/concepts/protocols#filter) in `nwaku`, use the `filter` configuration option:
```bash
./build/wakunode2 --filter=true
```
You can configure `nwaku` as a `Filter client` using the `filternode` and `filter-timeout` options. This allows the node to request content filtering of messages from peers.
```bash
./build/wakunode2 \
--filternode=[FILTER PEER MULTIADDR] \
--filter-timeout=[FILTER PEER TIMEOUT]
```
For example, consider a `nwaku` node that requests content filtering of messages from peers with a timeout of `21600` seconds (6 hours):
```bash
./build/wakunode2 \
--filternode=/dns4/node-01.ac-cn-hongkong-c.wakuv2.prod.statusim.net/tcp/30303/p2p/16Uiu2HAm4v86W3bmT1BiH6oSPzcsSr24iDQpSN5Qa992BCjjwgrD \
--filter-timeout=21600
```
:::info
If you omit the `filter-timeout` option, it will default to `14400` seconds (4 hours).
:::
## Configure Light Push Protocol
To enable the [Light Push protocol](/overview/concepts/protocols#light-push) in `nwaku`, use the `lightpush` configuration option: