Skip to main content

Run a Waku Node

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 they want to support based on their needs, motivations, and available resources.

Video Tutorial​

The easiest way to run a Waku node is using Docker Compose. This setup automatically configures:

  • A nwaku node with Relay, Store, and RLN protocols
  • A simple web interface to send and receive messages
  • Grafana dashboard for monitoring your node

Prerequisites​

  • Git
  • Docker and Docker Compose
  • Linea Sepolia RPC endpoint: You can get a free endpoint from Infura or any other Linea Sepolia RPC provider.
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.

Get Started​

# Clone the repository
git clone https://github.com/waku-org/nwaku-compose
cd nwaku-compose

# Configure your node
cp .env.example .env
# Edit .env with your settings

# Start your node
docker-compose up -d

For detailed setup instructions, see Run Nwaku with Docker Compose.

Alternative Installation Methods​

While Docker Compose is recommended, you can also:

Node Configuration​

Once your node is running, you can:

Monitoring and Maintenance​

  • Access the Grafana dashboard at http://localhost:3000 (if using Docker Compose)
  • Use the REST API to interact with your node
  • Check node health at http://localhost:8645/health
tip

Download the Waku Node Operator Cheatsheet for quick reference on operating your node.

Get Help​

If you encounter issues or need assistance: