Readme hinzugefügt

This commit is contained in:
Reik Kaps 2020-06-23 19:26:30 +02:00
parent b94f27d8cd
commit d48afb4d3f
1 changed files with 27 additions and 0 deletions

27
README.md Normal file
View File

@ -0,0 +1,27 @@
JitsiBadge
==========
Simple Logfile parser and local status server for public jitsi meet instances
## Features
- returns conference state as text or svg badge
## Requirements
- Python 3.5 or newer
- Sh Module https://pypi.org/project/sh/
- pyBadges Module https://pypi.org/project/pybadges/
## Optional (eg for production)
- Reverse HTTP Proxy (Nginx, Apache ...)
- a user to run jitsiBadge on your server
## Setup
- Clone this repo to your jitsi server
- optional: python virtual environment (`python -m venv venv`)
- make sure python requirements are present: `pip install -r requirements.txt`
- run: `python3 jitsi-log.py -l /PATH/2/JICOFO.LOG [ -p PORT]`