waku-org
/
go-waku-compose
mirror of https://github.com/waku-org/go-waku-compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Deployment docker-compose files to deploy a go-waku node
17 Commits 7 Branches 0 Tags 257 KiB
Shell 100%
Go to file
Alvaro Revuelta e75e4ce35c
Update docker-compose.yml 		2023-10-02 15:06:18 +02:00
monitoring grafana.ini: making sure the credentials window appears & update README.md 2023-08-09 16:27:57 +02:00
postgres_cfg Initial release of nwaku-compose 2023-08-09 12:36:03 +02:00
.gitignore Initial release of nwaku-compose 2023-08-09 12:36:03 +02:00
README.md feat: add support for WSS, nodekey and extra args 2023-09-05 17:58:20 +02:00
docker-compose.yml Update docker-compose.yml 2023-10-02 15:06:18 +02:00
run_node.sh update wakuv2 fleet DNS discovery enrtree 2023-09-26 15:16:39 +02:00

README.md

nwaku-compose

Ready to use docker-compose that runs a nwaku node and monitors it with already set up and configured postgres, grafana and prometheus instances. All in just a few steps.

Instructions

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

Get the code:

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

Edit the environment variables present at the beginning of the docker-compose.yml file.

Start everything: nwaku, postgres, prometheus, and grafana.

docker-compose up -d

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

grafana-dashboard

Notes:

  • Feel free to change the image you are using statusteam/nim-waku:xxx. You can see the available tags in docker hub.
  • 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.

Configuration

There are multiple environment variables you can configure to modify behaviour of the Waku node:

  • NWAKU_IMAGE - the image you want to use for the nwaku container (e.g. NWAKU_IMAGE=statusteam/nim-waku:v0.19.0-rc.0)
  • DOMAIN - domain name pointing to the IP address of your node, when configured the run script will request SSL certs from Let's Encrypt and run Waku node with WebSockets Secure (WSS) options enabled (e.g. DOMAIN=waku.example.com)
  • NODEKEY - this env variable allows you to provide a node key as described in operators documentation (e.g. NODEKEY=9f439983aa4851346cfe6e17585e426f482871a43626812e23490895cd602c11)
  • EXTRA_ARGS - this variable allows you to specify additional or overriding CLI option for the Waku node which will be appended to the wakunode2 command. (e.g. EXTRA_ARGS="--store=false --max-connections=3000)