index.md
1 --- 2 title: Run a Waku Node 3 hide_table_of_contents: true 4 displayed_sidebar: runNode 5 --- 6 7 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. 8 9 ## Video Tutorial 10 11 <div class="video-container"> 12 <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> 13 </div> 14 15 ## Quick Start with Docker Compose (Recommended) 16 17 The easiest way to run a Waku node is using [Docker Compose](/run-node/run-docker-compose). This setup automatically configures: 18 19 - A `nwaku` node with [Relay](/learn/concepts/protocols#relay), [Store](/learn/concepts/protocols#store), and [RLN](/learn/concepts/protocols#rln-relay) protocols 20 - A simple web interface to send and receive messages 21 - Grafana dashboard for monitoring your node 22 23 ### Prerequisites 24 25 - **Git** 26 - [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) 27 - **Linea Sepolia RPC endpoint**: You can get a free endpoint from [Infura](https://www.infura.io/) or any other Linea Sepolia RPC provider. 28 29 :::info System Requirements 30 We recommend at least 2GB of RAM, especially if WSS is enabled. For a Relay-only node, 0.5GB of RAM is sufficient. 31 ::: 32 33 ### Get Started 34 35 ```shell 36 # Clone the repository 37 git clone https://github.com/waku-org/nwaku-compose 38 cd nwaku-compose 39 40 # Configure your node 41 cp .env.example .env 42 # Edit .env with your settings 43 44 # Start your node 45 docker-compose up -d 46 ``` 47 48 For detailed setup instructions, see [Run Nwaku with Docker Compose](/run-node/run-docker-compose). 49 50 ## Alternative Installation Methods 51 52 While Docker Compose is recommended, you can also: 53 54 - **[Run in Docker Container](/run-node/run-docker)** - For custom Docker deployments 55 - **[Build from Source](/run-node/build-source)** - Compile the latest nwaku code 56 - **[Download Binary](https://github.com/waku-org/nwaku/tags)** - Use precompiled releases 57 58 ## Node Configuration 59 60 Once your node is running, you can: 61 62 - **[Configure Discovery](/run-node/configure-discovery)** - Set up peer discovery mechanisms 63 - **[Configure Your Node](/run-node/configure-nwaku)** - Customize protocols and settings 64 - **[Find Node Addresses](/run-node/find-node-address)** - Locate your node's network addresses 65 66 ## Monitoring and Maintenance 67 68 - Access the Grafana dashboard at `http://localhost:3000` (if using Docker Compose) 69 - Use the [REST API](https://waku-org.github.io/waku-rest-api/) to interact with your node 70 - Check node health at `http://localhost:8645/health` 71 72 :::tip 73 Download the [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) for quick reference on operating your node. 74 ::: 75 76 ## Get Help 77 78 If you encounter issues or need assistance: 79 80 - Visit the #help-desk channel on [Discord](https://discord.waku.org/) 81 - Check the [FAQ](/run-node/faq) for common questions 82 - Review the [upgrade instructions](/run-node/upgrade-instructions) when updating your node