mirror of
https://github.com/logos-messaging/docs.waku.org.git
synced 2026-01-03 13:23:06 +00:00
Merge branch 'develop' into shard-info-js-waku
This commit is contained in:
LordGhostX
GitHub
commit
399e7a4227
@ -87,7 +87,6 @@ Here are the available node configuration options, along with their default valu
|
||||
| ----------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `filter` | `false` | Enable filter protocol: true\|false |
|
||||
| `filternode` | | Peer multiaddr to request content filtering of messages |
|
||||
| `filter-timeout` | `14400 # 4 hours` | Timeout for filter node in seconds |
|
||||
| `filter-subscription-timeout` | `300 # 5 minutes` | Timeout for filter subscription without ping or refresh it, in seconds. Only for v2 filter protocol |
|
||||
| `filter-max-peers-to-serve` | `1000` | Maximum number of peers to serve at a time. Only for v2 filter protocol |
|
||||
| `filter-max-criteria` | `1000` | Maximum number of pubsub and content topic combinations per peer at a time. Only for v2 filter protocol |
|
||||
|
||||
@ -24,7 +24,7 @@ Check out the [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to learn h
|
||||
- [Git](https://git-scm.com/) or [GitHub Desktop](https://desktop.github.com/)
|
||||
- [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/)
|
||||
- [Ethereum Sepolia WebSocket Endpoint](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md#3-access-a-node-on-the-sepolia-testnet-using-infura)
|
||||
- [Wallet with Sepolia Ethereum](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md#2-obtain-sepolia-eth-from-faucet) (less than 0.01 Sepolia ETH)
|
||||
- [Wallet with Sepolia Ethereum](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md#2-obtain-sepolia-eth-from-faucet) (~0.6 Sepolia ETH)
|
||||
- A password to protect your RLN membership
|
||||
|
||||
:::info
|
||||
@ -40,7 +40,7 @@ cd nwaku-compose
|
||||
|
||||
## Configure the setup
|
||||
|
||||
Docker Compose [reads the ./.env file](https://docs.docker.com/compose/environment-variables/set-environment-variables/#additional-information-3) from the filesystem. You can use `.env.example` as a template to provide the above values. The recommended process for working with `.env` files is to duplicate `.env.example`, rename it as `.env`, and then make the necessary value edits.
|
||||
Docker Compose [reads the .env file](https://docs.docker.com/compose/environment-variables/set-environment-variables/#additional-information-3) from the filesystem. You can use `.env.example` as a template to provide the configuration values. The recommended process for working with `.env` files is to duplicate `.env.example`, rename it as `.env`, and then make the necessary value edits.
|
||||
|
||||
```shell
|
||||
cp .env.example .env
|
||||
@ -48,20 +48,20 @@ ${EDITOR} .env
|
||||
```
|
||||
|
||||
:::caution
|
||||
Ensure that you do **NOT** include any secrets in the `.env.example` file, as it could accidentally be shared in the Git repository.
|
||||
Ensure that you do **NOT** include any secrets in the `.env.example` file, as it could accidentally be shared in your Git repository.
|
||||
:::
|
||||
|
||||
## Register for RLN membership
|
||||
|
||||
The RLN membership is your access key to The Waku Network. Its registration is done on-chain, allowing your `nwaku` node to send messages decentralised and privately, respecting some rate limits. Other peers won't relay messages that exceed the rate limit.
|
||||
|
||||
This command registers your membership and saves it in the `keystore/keystore.json` file:
|
||||
This command registers your membership and saves it in the `keystore/keystore.json` file. You should have Docker running at this step:
|
||||
|
||||
```shell
|
||||
./register_rln.sh
|
||||
```
|
||||
|
||||
:::info
|
||||
:::tip
|
||||
If you only want to relay traffic without sending messages to the network, you don't need to register for RLN membership.
|
||||
:::
|
||||
|
||||
|
||||
@ -103,10 +103,6 @@ const config = {
|
||||
{
|
||||
title: "Guides",
|
||||
items: [
|
||||
{
|
||||
to: "/",
|
||||
label: "Getting Started",
|
||||
},
|
||||
{
|
||||
to: "/guides/nwaku/run-docker-compose",
|
||||
label: "Run a Nwaku Node",
|
||||
@ -120,35 +116,39 @@ const config = {
|
||||
{
|
||||
title: "Community",
|
||||
items: [
|
||||
{
|
||||
href: "https://discord.waku.org/",
|
||||
label: "Discord",
|
||||
},
|
||||
{
|
||||
href: "https://twitter.com/waku_org/",
|
||||
label: "X",
|
||||
},
|
||||
{
|
||||
href: "https://discord.waku.org/",
|
||||
label: "Discord",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/waku-org/",
|
||||
label: "GitHub",
|
||||
},
|
||||
{
|
||||
href: "https://www.youtube.com/@wakuorg",
|
||||
label: "YouTube",
|
||||
},
|
||||
{
|
||||
href: "https://www.linkedin.com/company/waku-org",
|
||||
label: "LinkedIn",
|
||||
},
|
||||
{
|
||||
href: "https://warpcast.com/waku",
|
||||
label: "Farcaster",
|
||||
},
|
||||
{
|
||||
href: "https://t.me/waku_org/",
|
||||
label: "Telegram",
|
||||
},
|
||||
{
|
||||
href: "https://forum.vac.dev/",
|
||||
label: "Vac Forum",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/waku-org/bounties/",
|
||||
label: "Bounties",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "Resources",
|
||||
items: [
|
||||
{
|
||||
href: "https://github.com/waku-org/",
|
||||
label: "GitHub",
|
||||
},
|
||||
{
|
||||
href: "https://blog.waku.org/",
|
||||
label: "Blog",
|
||||
@ -157,6 +157,10 @@ const config = {
|
||||
href: "https://rfc.vac.dev/waku",
|
||||
label: "Waku RFCs",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/waku-org/bounties/",
|
||||
label: "Bounties",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/waku-org/awesome-waku/",
|
||||
label: "Awesome Waku",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user