From 2f049eec844d771efcaa7a3d4539a9d4a7e0d5bc Mon Sep 17 00:00:00 2001 From: Yasen Pramatarov Date: Tue, 4 Jun 2024 20:10:49 +0300 Subject: [PATCH] Adds short description in the readme. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c8e622..6b8b161 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # jilo -JItsi Logs Observer \ No newline at end of file +JItsi Logs Observer + +Currently this has two components: + +- **jilo** is the script for collecting data from the logs. +It is meant to be installed and run on the server and it needs read permissions for the logs. +Currently it works with Videobridge and Jicofo log files. +You can run it with cron to periodically update the new data from the logs. + +- **jilo-cli** is a command line client for displaying stats from an already populated jilo database +It needs access to the jilo database. + +The database can be an SQLite file or MySQL/MariaDB database. The default is local sqlite file. + +The config file **jilo.conf** overrides the default settings. +For more details check the comments in the scripts or use the --help option