From 91e860220d424178045d85b71792ddcbf3d3a030 Mon Sep 17 00:00:00 2001 From: Gabriel Mermelstein Date: Thu, 21 Sep 2023 18:40:27 +0300 Subject: [PATCH] Improving README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 16cb97d..a04f734 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,20 @@ cd nwaku-compose Edit the environment variables present at the beginning of the `docker-compose.yml` file. +Get a node's URL: + +It is required to set the `ETH_CLIENT_ADDRESS` environment variable before starting the instance. + +`ETH_CLIENT_ADDRESS` must be a WebSockets URL for your Ethereum Node. +For the current default contract, it must a node for the Sepolia network. +In case you're not running your own node, you can get it from [Infura](https://www.infura.io/) + +You can set the environment variable from inside the `docker-compose.yml` file or you can simply run + +```console +export ETH_CLIENT_ADDRESS= +``` + Start everything: `nwaku`, `postgres`, `prometheus`, and `grafana`. ```console docker-compose up -d