waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(docs): add docker-compose instructions (#1444) 

* chore(docs): add docker-compose instructions

* Update docs/operators/quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* Update docs/operators/quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
This commit is contained in:
Alvaro Revuelta 2022-12-05 16:25:37 +01:00 committed by GitHub
parent 39a2b5f283
commit b56c4340f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -37,12 +37,13 @@ make wakunode1 wakunode2
# See available command line options
./build/wakunode --help
./build/wakunode2 --help
# Connect the client directly with the Status test fleet
./build/wakunode --log-level:debug --discovery:off --fleet:test --log-metrics
# TODO Equivalent for v2
```
For more on how to run `wakunode2`, refer to:
* [Run using binaries](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-1-run-nwaku-binary)
* [Run using docker](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-2-run-nwaku-in-a-docker-container)
* [Run using docker-compose](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-3-run-nwaku-with-docker-compose)
### Waku Protocol Test Suite
```bash

16
docs/operators/quickstart.md
View File

@ -36,6 +36,22 @@ docker run -i -t -p 60000:60000 -p 9000:9000/udp \
--nat:extip:[yourpublicip] # or, if you are behind a nat: --nat=any
```
## Option 3: run nwaku with docker compose
*Prerequisites: `docker` and `docker-compose`*.
Allows to run `nwaku` with `prometheus` and `grafana`, with an already provisioned dashboard, in a few simple steps.
See [nwaku-compose](https://github.com/alrevuelta/nwaku-compose).
```bash
git clone https://github.com/alrevuelta/nwaku-compose.git
cd nwaku-compose
export MY_EXT_IP=$(dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}')
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.
As simple as that.
## Tips and tricks
To find the public IP of your host,