From b56c4340f77191e3dc08c8abc37875626d9d3f26 Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Mon, 5 Dec 2022 16:25:37 +0100 Subject: [PATCH] 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> --- README.md | 9 +++++---- docs/operators/quickstart.md | 16 ++++++++++++++++ 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a824aaa77..d1d506a1a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/operators/quickstart.md b/docs/operators/quickstart.md index 360b63af9..7f14b2d26 100644 --- a/docs/operators/quickstart.md +++ b/docs/operators/quickstart.md @@ -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,