waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs.waku.org/docs/guides/nwaku/run-docker-compose.md

1.6 KiB
Raw Blame History

title
Run Nwaku with Docker Compose

nwaku-compose is a ready-to-use Docker Compose setup that runs a nwaku node and monitors it with already configured Prometheus and Grafana instances.

This guide provides detailed steps to build, configure, run, and monitor a nwaku node with nwaku-compose.

Prerequisites

Clone the Repository

git clone https://github.com/waku-org/nwaku-compose
cd nwaku-compose

Configure the Setup

Modify the run_node.sh file to customise your node's configuration and docker-compose.yml to specify particular Docker image tag.

Run Docker Compose

Spin up the containers using docker-compose:

docker-compose up -d

Monitor the Node

Visit http://localhost:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1 to view your node metrics in real-time.

nwaku compose dashboard

:::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. :::

:::tip Congratulations! You have successfully started a nwaku node using Docker Compose. Have a look at the Nwaku Configuration Examples guide to learn how to configure nwaku for different use cases. :::