mirror of
https://github.com/logos-messaging/docs.waku.org.git
synced 2026-05-27 10:39:28 +00:00
add config examples guide
This commit is contained in:
parent
9741d01dab
commit
ad9cd9b0e3
@ -11,7 +11,7 @@ This guide provides detailed steps to build a `nwaku` node from the source code
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
To build `nwaku`, you need the standard developer tools, including a C compiler, GNU Make, Bash, Git, Rustup and PostgreSQL client library.
|
To build `nwaku`, you need the standard developer tools, including a C compiler, GNU Make, Bash, Git, Rustup, and PostgreSQL client library.
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
@ -109,3 +109,7 @@ Run the tests for Waku:
|
|||||||
```bash
|
```bash
|
||||||
make test
|
make test
|
||||||
```
|
```
|
||||||
|
|
||||||
|
:::tip Congratulations!
|
||||||
|
You have successfully built the `nwaku` binary from the source code. Have a look at the [Nwaku Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||||
|
:::
|
||||||
14
docs/guides/nwaku/configure-nwaku.md
Normal file
14
docs/guides/nwaku/configure-nwaku.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
title: Nwaku Configuration Examples
|
||||||
|
---
|
||||||
|
|
||||||
|
This guide provides detailed steps to configure a `nwaku` node for different use cases.
|
||||||
|
|
||||||
|
## Connect to Other Peers
|
||||||
|
|
||||||
|
To join the Waku Network, nodes must [bootstrap](/overview/reference/glossary#bootstrapping) for an entry point before discovering more peers. Nwaku provides multiple [peer discovery](/overview/concepts/peer-discovery) mechanisms:
|
||||||
|
|
||||||
|
- [Configure Static Peers](/guides/nwaku/configure-discovery#configure-static-peers)
|
||||||
|
- [Configure DNS Discovery](/guides/nwaku/configure-discovery#configure-dns-discovery)
|
||||||
|
- [Configure Discv5](/guides/nwaku/configure-discovery#configure-discv5)
|
||||||
|
- [Configure Peer Exchange](/guides/nwaku/configure-discovery#configure-peer-exchange)
|
||||||
@ -39,4 +39,8 @@ Visit <http://localhost:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1> to view your
|
|||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
To access Grafana from outside your machine, remove `127.0.0.1` and open the port. Consider setting up a password for Grafana to ensure security.
|
To access Grafana from outside your machine, remove `127.0.0.1` and open the port. Consider setting up a password for Grafana to ensure security.
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::tip Congratulations!
|
||||||
|
You have successfully started a `nwaku` node using Docker Compose. Have a look at the [Nwaku Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||||
:::
|
:::
|
||||||
@ -53,4 +53,8 @@ dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'
|
|||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers).
|
We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers).
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::tip Congratulations!
|
||||||
|
You have successfully built and started a `nwaku` node in a Docker container. Have a look at the [Nwaku Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||||
:::
|
:::
|
||||||
@ -45,7 +45,7 @@ Once you have gotten the `nwaku` binary, run it using the [default configuration
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
For more advanced configurations like enabling other protocols or maintaining a consistent `PeerID`, have a look at the [Node Configuration Methods](/guides/reference/node-config-methods) guide.
|
To learn how to customise the configuration of a `nwaku` node, have a look at the [Node Configuration Methods](/guides/reference/node-config-methods) and [Node Configuration Options](/guides/reference/node-config-options) guides.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Bootstrap the Node
|
## Bootstrap the Node
|
||||||
@ -161,4 +161,8 @@ INF 2023-06-15 16:09:54.448+01:00 Discv5: discoverable ENR top
|
|||||||
```bash
|
```bash
|
||||||
# ENR the node addresses are encoded in
|
# ENR the node addresses are encoded in
|
||||||
enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
|
enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
|
||||||
```
|
```
|
||||||
|
|
||||||
|
:::tip Congratulations!
|
||||||
|
You have successfully started, configured, and connected a `nwaku` node to the Waku Network. Have a look at the [Nwaku Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||||
|
:::
|
||||||
@ -61,6 +61,7 @@ const sidebars = {
|
|||||||
"guides/nwaku/run-docker",
|
"guides/nwaku/run-docker",
|
||||||
"guides/nwaku/run-docker-compose",
|
"guides/nwaku/run-docker-compose",
|
||||||
"guides/nwaku/configure-discovery",
|
"guides/nwaku/configure-discovery",
|
||||||
|
"guides/nwaku/configure-nwaku"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user