From fd2b8df1c068178abd5971b52959a0eb5ab0ab7c Mon Sep 17 00:00:00 2001
From: librelois <c@elo.tf>
Date: Sun, 13 Nov 2022 01:47:24 +0100
Subject: [PATCH] doc

---
 README.md                                     | 39 +++++++++++++++++++
 duniter-node/.env                             | 10 ++---
 duniter-node/docker-compose.yml               |  4 +-
 ...dot-essentials-2021.json => template.json} |  0
 4 files changed, 44 insertions(+), 9 deletions(-)
 rename duniter-node/grafana/templates/{polkadot-essentials-2021.json => template.json} (100%)

diff --git a/README.md b/README.md
index 902d682..1faba4a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,41 @@
 # duniter-v2s-monitoring
 
+1. Generate a node key
+
+```
+$ docker run --rm -it --entrypoint duniter duniter/duniter-v2s:v0.4.0 key generate-node-key
+12D3KooWSR6aRZm7s9P7ZV9KvyUMn3UtCvPQGVfuYZxSsX4czKAH
+1acecb65accd9138fac026d5435fe11243b93b35f1c54218688ffad5159669db
+```
+
+The first line should be copy/paste in `.env` at `DUNITER_PEER_ID`.
+The second line should be copy/paste in `.env` at `DUNITER_NODE_KEY`.
+
+For example:
+
+```
+DUNITER_PEER_ID=12D3KooWSR6aRZm7s9P7ZV9KvyUMn3UtCvPQGVfuYZxSsX4czKAH
+DUNITER_NODE_KEY=1acecb65accd9138fac026d5435fe11243b93b35f1c54218688ffad5159669db
+```
+
+2. Configure environment variables in `.env` 
+
+You should at least configure `LIBP2P_DOMAIN` to a domain that point to your server.
+
+3. Copy the folder `duniter-node` in your server.
+
+4. At root of `duniter-node` folder (in the remote server), run:
+
+```
+docker compose up -d
+```
+
+5. Open a ssh bridge to your server to access grafana UI:
+
+```
+ssh -L 3000:localhost:3000 user@ip
+```
+
+6. Open [http://localhost:3000](http://localhost:3000) (credentials are admin/admin)
+
+7. Import a new dashboard (copy the content of json file `duniter-node/grafana/templates/template.json`). 
diff --git a/duniter-node/.env b/duniter-node/.env
index 28292b3..a717b0d 100644
--- a/duniter-node/.env
+++ b/duniter-node/.env
@@ -1,8 +1,4 @@
 LIBP2P_DOMAIN=gdev.elo.tf
-VALIDATOR_CHAIN_NAME=/etc/duniter/keystore/gdev-raw.json
-VALIDATOR_PEER_ID=12D3KooWJoNxU9NKHr7y5pmWYW1LLbMrBMTnEzhm7n9mpbKrt45B
-VALIDATOR_NODE_KEY=8bdba4dab00f43dd6508d4ee818ec8fc5c84a28b1ecba5cfaf611a21b1b92b0e
-VALIDATOR_NODE_NAME="elois-validator"
-VALIDATOR2_PEER_ID=12D3KooWH4gAzvcRRCH8bFGZYomCGn3tosXDGtnL5yVVMkpGRL7B
-VALIDATOR2_NODE_KEY=1d3e4a73144ab07dc766fd5afa89ca05306436bbd1db59cd021e27916169ff91
-VALIDATOR2_NODE_NAME="elois-validator2"
+DUNITER_PEER_ID=12D3KooWH4gAzvcRRCH8bFGZYomCGn3tosXDGtnL5yVVMkpGRL7B
+DUNITER_NODE_KEY=
+DUNITER_NODE_NAME="my-node-name"
diff --git a/duniter-node/docker-compose.yml b/duniter-node/docker-compose.yml
index c9d4e04..5209957 100644
--- a/duniter-node/docker-compose.yml
+++ b/duniter-node/docker-compose.yml
@@ -17,10 +17,10 @@ services:
       - DUNITER_INSTANCE_NAME=${NODE_NAME}
     command:
       - "--keystore-path=/etc/duniter/keystore"
-      - "--node-key=${VALIDATOR2_NODE_KEY}"
+      - "--node-key=${DUNITER_NODE_KEY}"
       - "--prometheus-external"
       - "--pruning=6000"
-      - "--public-addr=/dns/${LIBP2P_DOMAIN}/tcp/30334/p2p/${NODE_PEER_ID}"
+      - "--public-addr=/dns/${LIBP2P_DOMAIN}/tcp/30334/p2p/${DUNITER_NODE_PEER_ID}"
       - "--rpc-methods=Unsafe"
       - "--rpc-cors=all"
       - "--validator"
diff --git a/duniter-node/grafana/templates/polkadot-essentials-2021.json b/duniter-node/grafana/templates/template.json
similarity index 100%
rename from duniter-node/grafana/templates/polkadot-essentials-2021.json
rename to duniter-node/grafana/templates/template.json
-- 
GitLab