heartbeat

commit cf5d2406695bca115148d801a5dac4cc9a3d14f0
parent 28d2c8471e84b6a9a21b5552380bfce5d8535d68
Author: Remy Noulin <loader2x@gmail.com>
Date:   Thu, 13 Jul 2023 17:12:35 +0200

add information in README

README.md | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)

Diffstat:
M
README.md
 | 
14
++++++++++++--

1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -2,6 +2,12 @@
 
 `heartbeat` is a simple monitoring system which uses udp to send logs and sends event by mail.
 
+About 300 machines can be monitored simultaneously with this system.
+
+Running `heartbeat` without argument starts the monitoring.
+
+`heartbeat` sends messages to the bridge. When the bridge is not logger, the messages are forwarded to the next bridge. This allows monitoring machines in private networks.
+
 # Install
 
 Install libsodium in debian like this:
@@ -18,13 +24,17 @@ Install sheepy: [sheepy](https://spartatek.se/r/sheepy/file/README.md.html)
 
 Compile `heartbeat`:
 ```
-sheepy -c
+./make.sh
 ```
 
 # Configuration
 
 See `heartbeatConfig.yml`
 
+For `heartbeat` to send mails, mutt has to be configured.
+
 # Setup
 
-agents
+- Generate the configuration script: `./heartbeat config`
+- The configuration script starts `heartbeat` and setups systemd to the start `heartbeat` at boot as a daemon
+- The state is displayed with: `heartbeat monitor`