From 023f31665046fa323e303783ca0a7bd43e8fd0bc Mon Sep 17 00:00:00 2001
From: Thonier Florian <florian.thonier@inria.fr>
Date: Fri, 10 Jan 2025 12:00:42 +0100
Subject: [PATCH] Update readme to add information on node-reporter

---
 readme.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 2f18363..aad156a 100644
--- a/readme.md
+++ b/readme.md
@@ -49,6 +49,13 @@ You can also use a SSL certificate for API as described in [vidjil documentation
 On target server, you need to set up a metrics user if not already done. 
 See this [page](https://www.vidjil.org/doc/admin/#server-monitoring) for more information on how to do that.
 
+#### Node reporter
+
+Node reporter isa dedicated service to follow hardware of a server (CPU and memory usage, disk space, ...).
+It should be launch on each target and declared in prometheus as specified below.
+
+You can use for that dedicated `docker-compose-node.yml` file. 
+
 
 ## Launch services
 
@@ -59,7 +66,8 @@ docker-compose up -d
 ```
 
 Note that for the moment, no image is avaialbe for vidjil metrics.
-At first lauch, you should add `--build` at `docker compsoe up -d` to build metrics server image.
+At first lauch, you should launch `make build_metrics` to build metrics docker images that will be used. 
+Note that if you made some dev and want to build again this image, you can add `--build` at `docker compsoe up -d` to build metrics server image at launch.
 
 By default, only grafana server will be serve on port 3000.
 As metrics and prometheus don't allow to manage user and credential, 
-- 
GitLab