mirror of
https://github.com/logos-messaging/docs.waku.org.git
synced 2026-01-06 23:03:10 +00:00
update node running guide
This commit is contained in:
LordGhostX
parent
ec78bab962
commit
3f13f20e03
@ -19,7 +19,7 @@ graph LR
|
||||
<iframe class="yt-video" src="https://www.youtube.com/watch?v=PYQaXCxUCwA" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
|
||||
:::tip
|
||||
Check out our [Learn section](/learn/waku-network), [YouTube Channel](https://www.youtube.com/@wakuorg), and [Blog](https://blog.waku.org/) to dive into how Waku works behind the scenes!
|
||||
Check out our [Learn section](/learn/waku-network), [YouTube channel](https://www.youtube.com/@wakuorg), and [Blog](https://blog.waku.org/) to dive into how Waku works behind the scenes!
|
||||
:::
|
||||
|
||||
## What isn’t Waku?
|
||||
@ -43,9 +43,7 @@ Check out our [Learn section](/learn/waku-network), [YouTube Channel](https://ww
|
||||
Looking for what to build with Waku? Discover a collection of sample ideas and use cases for inspiration, curated by our community at: https://ideas.waku.org/ and [Awesome Waku](https://github.com/waku-org/awesome-waku/).
|
||||
:::
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Run a Waku node
|
||||
## Run a Waku node
|
||||
|
||||
Waku is a decentralised, permissionless system where anyone can run a node, use the network, and contribute to its support. We recommend following the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide and [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to easily run a node.
|
||||
|
||||
@ -55,7 +53,7 @@ Waku is a decentralised, permissionless system where anyone can run a node, use
|
||||
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||
:::
|
||||
|
||||
### Integrate using SDKs
|
||||
## Integrate using SDKs
|
||||
|
||||
Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
|
||||
|
||||
@ -72,5 +70,5 @@ Waku is implemented in multiple SDKs, allowing it to integrate with different la
|
||||
| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `@waku/sdk` project from various example templates | [Scaffold DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) |
|
||||
|
||||
:::tip
|
||||
Explore some example apps built using Waku at https://examples.waku.org/ and view a list of projects and workshops from previous hackathons at https://github.com/waku-org/awesome-waku.
|
||||
Explore some example apps built using Waku at https://examples.waku.org/ and view a list of projects and workshops from previous hackathons at [Awesome Waku](https://github.com/waku-org/awesome-waku/).
|
||||
:::
|
||||
|
||||
@ -3,13 +3,15 @@ title: Run Nwaku with Docker Compose
|
||||
hide_table_of_contents: true
|
||||
---
|
||||
|
||||
`nwaku-compose` is a ready-to-use Docker Compose setup that runs the following:
|
||||
[nwaku-compose](https://github.com/waku-org/nwaku-compose) is a ready-to-use Docker Compose setup that configures the following automatically:
|
||||
|
||||
- `nwaku` node running [Relay](/learn/concepts/protocols#relay) and [Store](/learn/concepts/protocols#store) protocols with [RLN](/learn/concepts/protocols#rln-relay) enabled.
|
||||
- Simple frontend to interact with the node and Waku network to send and receive messages.
|
||||
- [Grafana](https://grafana.com/) metrics dashboard for advanced users and node operators to monitor the node.
|
||||
|
||||
This guide provides detailed steps to configure, run, monitor, and interact with a `nwaku` node with [nwaku-compose](https://github.com/waku-org/nwaku-compose).
|
||||
## Video tutorial
|
||||
|
||||
<iframe class="yt-video" src="https://www.youtube.com/watch?v=fs0ynLk4z0I" title="How to run a Waku node using Nwaku Compose" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -19,6 +21,10 @@ This guide provides detailed steps to configure, run, monitor, and interact with
|
||||
- [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)
|
||||
- A password to protect your RLN membership
|
||||
|
||||
:::info
|
||||
We recommend running a `nwaku` node with at least 2GB of RAM, especially if `WSS` is enabled. If running just a `Relay` node, 0.5GB of RAM is sufficient.
|
||||
:::
|
||||
|
||||
## Clone the repository
|
||||
|
||||
```shell
|
||||
@ -55,7 +61,7 @@ If you only want to relay traffic without sending messages to the network, you d
|
||||
|
||||
## Run the node
|
||||
|
||||
Start all processes: `nwaku` node, database for storing messages, and Grafana for metrics. Your RLN membership is loaded into nwaku under the hood:
|
||||
Launch all the processes: `nwaku` node, database for storing messages, and Grafana for metrics with the following command. Your RLN membership is loaded into `nwaku` under the hood:
|
||||
|
||||
```shell
|
||||
docker-compose up -d
|
||||
@ -67,7 +73,7 @@ View the logs of the node to confirm that it is running correctly:
|
||||
docker-compose logs -f nwaku
|
||||
```
|
||||
|
||||
## Interact with the node
|
||||
## Monitor the node
|
||||
|
||||
Visit <http://localhost:3000/d/yns_4vFVk/nwaku-monitoring> to view your node metrics in real time.
|
||||
|
||||
@ -77,7 +83,7 @@ Visit <http://localhost:3000/d/yns_4vFVk/nwaku-monitoring> to view your node met
|
||||
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.
|
||||
:::
|
||||
|
||||
## Use the REST API
|
||||
## Interact with the node
|
||||
|
||||
Your `nwaku` node provides a [REST API](https://waku-org.github.io/waku-rest-api/) on port `8645` for interacting with it:
|
||||
|
||||
|
||||
@ -5,6 +5,8 @@ hide_table_of_contents: true
|
||||
|
||||
Nwaku is a lightweight and robust Nim client for running a Waku node, equipped with tools to monitor and maintain a running node. Nwaku is highly configurable, enabling operators to select the [protocols](/learn/concepts/protocols) they want to support based on their needs, motivations, and available resources.
|
||||
|
||||
|
||||
|
||||
This guide provides detailed steps to download, build, configure, and connect a `nwaku` node to the Waku Network. It also includes interacting with the node and finding its addresses.
|
||||
|
||||
:::info
|
||||
|
||||
@ -4,6 +4,6 @@ hide_table_of_contents: true
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
**Research and Studies**: Protocol simulations and theoretical analysis to support the design of Waku protocols. The protocol definitions are on the [Vac RFC](https://rfc.vac.dev/) website.
|
||||
**Research and Studies**: Protocol simulations and theoretical analysis to support the design of Waku protocols. The protocol definitions are on the [Waku RFCs](https://rfc.vac.dev/waku) website.
|
||||
|
||||
**Benchmarks**: Results of implementations and engineering-related benchmarks for Waku clients.
|
||||
|
||||
@ -154,7 +154,7 @@ const config = {
|
||||
},
|
||||
{
|
||||
href: "https://rfc.vac.dev/waku",
|
||||
label: "Vac RFCs",
|
||||
label: "Waku RFCs",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/waku-org/awesome-waku/",
|
||||
|
||||
BIN
static/img/architecture.png
Normal file
BIN
static/img/architecture.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 87 KiB |
Loading…
x
Reference in New Issue
Block a user