2023-06-08 13:28:25 +01:00
---
2025-09-29 16:44:24 +10:00
title: Run a Waku Node
2023-11-23 12:01:32 +01:00
hide_table_of_contents: true
2025-09-29 16:34:46 +10:00
displayed_sidebar: runNode
2023-06-08 13:28:25 +01:00
---
2023-11-23 12:01:32 +01:00
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.
2023-06-08 13:28:25 +01:00
2025-09-29 18:31:34 +10:00
## Video Tutorial
2025-09-29 16:40:56 +10:00
< div class = "video-container" >
< iframe class = "yt-video" src = "https://www.youtube.com/embed/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 >
< / div >
2024-05-16 18:22:15 +01:00
2025-09-29 18:31:34 +10:00
## Quick Start with Docker Compose (Recommended)
2023-06-08 13:28:25 +01:00
2025-09-29 18:31:34 +10:00
The easiest way to run a Waku node is using [Docker Compose ](/run-node/run-docker-compose ). This setup automatically configures:
2024-02-09 15:51:51 +01:00
2025-09-29 18:31:34 +10:00
- A `nwaku` node with [Relay ](/learn/concepts/protocols#relay ), [Store ](/learn/concepts/protocols#store ), and [RLN ](/learn/concepts/protocols#rln-relay ) protocols
- A simple web interface to send and receive messages
- Grafana dashboard for monitoring your node
2023-06-08 13:28:25 +01:00
2025-09-29 18:31:34 +10:00
### Prerequisites
2023-06-09 20:32:04 +01:00
2025-09-29 18:31:34 +10:00
- **Git**
- [Docker ](https://docs.docker.com/engine/install/ ) and [Docker Compose ](https://docs.docker.com/compose/install/ )
- **Linea Sepolia RPC endpoint**: You can get a free endpoint from [Infura ](https://www.infura.io/ ) or any other Linea Sepolia RPC provider.
2023-06-19 18:07:45 +01:00
2025-09-29 18:31:34 +10:00
:::info System Requirements
We recommend at least 2GB of RAM, especially if WSS is enabled. For a Relay-only node, 0.5GB of RAM is sufficient.
2023-06-09 20:32:04 +01:00
:::
2025-09-29 18:31:34 +10:00
### Get Started
2023-06-09 20:32:04 +01:00
2023-11-23 12:01:32 +01:00
```shell
2025-09-29 18:31:34 +10:00
# Clone the repository
git clone https://github.com/waku-org/nwaku-compose
cd nwaku-compose
2023-06-09 20:32:04 +01:00
2025-09-29 18:31:34 +10:00
# Configure your node
cp .env.example .env
# Edit .env with your settings
2023-06-08 13:28:25 +01:00
2025-09-29 18:31:34 +10:00
# Start your node
docker-compose up -d
2023-06-10 00:17:41 +01:00
```
2025-09-29 18:31:34 +10:00
For detailed setup instructions, see [Run Nwaku with Docker Compose ](/run-node/run-docker-compose ).
2023-06-14 01:26:55 +01:00
2025-09-29 18:31:34 +10:00
## Alternative Installation Methods
2023-06-15 17:28:53 +01:00
2025-09-29 18:31:34 +10:00
While Docker Compose is recommended, you can also:
2023-06-15 17:28:53 +01:00
2025-09-29 18:31:34 +10:00
- **[Run in Docker Container ](/run-node/run-docker )** - For custom Docker deployments
- **[Build from Source ](/run-node/build-source )** - Compile the latest nwaku code
- **[Download Binary ](https://github.com/waku-org/nwaku/tags )** - Use precompiled releases
2023-06-15 17:28:53 +01:00
2025-09-29 18:31:34 +10:00
## Node Configuration
2023-06-15 17:28:53 +01:00
2025-09-29 18:31:34 +10:00
Once your node is running, you can:
2023-06-15 17:28:53 +01:00
2025-09-29 18:31:34 +10:00
- **[Configure Discovery ](/run-node/configure-discovery )** - Set up peer discovery mechanisms
- **[Configure Your Node ](/run-node/configure-nwaku )** - Customize protocols and settings
- **[Find Node Addresses ](/run-node/find-node-address )** - Locate your node's network addresses
2023-06-15 17:28:53 +01:00
2025-09-29 18:31:34 +10:00
## Monitoring and Maintenance
2023-06-15 17:28:53 +01:00
2025-09-29 18:31:34 +10:00
- Access the Grafana dashboard at `http://localhost:3000` (if using Docker Compose)
- Use the [REST API ](https://waku-org.github.io/waku-rest-api/ ) to interact with your node
- Check node health at `http://localhost:8645/health`
2023-06-15 17:28:53 +01:00
2024-05-16 18:22:15 +01:00
:::tip
2025-09-29 18:31:34 +10:00
Download the [Waku Node Operator Cheatsheet ](/Waku-NodeOperator.pdf ) for quick reference on operating your node.
2024-05-16 18:22:15 +01:00
:::
2023-09-15 21:08:15 +01:00
2025-09-29 18:31:34 +10:00
## Get Help
If you encounter issues or need assistance:
- Visit the #help -desk channel on [Discord ](https://discord.waku.org/ )
- Check the [FAQ ](/run-node/faq ) for common questions
- Review the [upgrade instructions ](/run-node/upgrade-instructions ) when updating your node