Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vpavlin/nwaku-compose

Last synced: 26 days ago
JSON representation

Host: GitHub
URL: https://github.com/vpavlin/nwaku-compose
Owner: vpavlin
Created: 2023-04-03T08:17:23.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-07-04T13:43:30.000Z (over 1 year ago)
Last Synced: 2024-04-04T11:53:37.533Z (7 months ago)
Size: 37.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# nwaku-compose

Ready to use docker-compose that runs a [nwaku](https://github.com/waku-org/nwaku) node and monitors it with already set up and configured grafana and prometheus instances. All in just 3 commands.

## Instructions

Note that you must have installed `docker-compose` and `git`.

Get the code:

```console
git clone https://github.com/alrevuelta/nwaku-compose.git
cd nwaku-compose
```

Get your public IP and store it to be used by docker-compose. Note that if you are behind a NAT you should configure it properly.

```console
export MY_EXT_IP=$(dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}')
```

Start everything: `nwaku`, `prometheus` and `grafana`.
```console
docker-compose up -d
```

Go to [http://localhost:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1](http://localhost:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1) and after some seconds, your node metrics will be live there, just like in the picture. As simple as that.

![grafana-dashboard](https://i.ibb.co/C6m7JHN/Screenshot-2022-12-01-at-11-09-28.png)

Notes:
* Feel free to change the image you are using `statusteam/nim-waku:xxx`. You can see the available tags in [docker hub](https://hub.docker.com/r/statusteam/nim-waku).
* If you want to access grafana from outside your machine, feel free to remove `127.0.0.1` and open the port, but in that case you may want to set up a password to your grafana.