bbbmon 0.1.10

A small CLI utility to monitor bbb usage

bbbmon

A small python based CLI utility to monitor BigBlueButton-Usage.

Installation

The easiest way to install bbbmon is to install it from the Python Package Index (PyPi). This project uses python poetry for dependency management, so you could also run it without installing the package system wide, see instructions below.

Install with pip3

sudo pip3 install bbbmon --upgrade

Then run with:

bbbmon

Run with poetry (without pip)

Clone the repo:

git clone https://code.hfbk.net/bbb/bbbmon.git

Make sure you have poetry installed. Install instruction for poetry can be found here. From inside the project directory run:

poetry install

Run bbbmon with:

poetry run bbbmon

Configuration

Just run bbbmon and it will tell you what it needs.

You can define one or more endpoints in the bbbmon.properties file at the path bbbmon tells you about. In this file you can specify multiple bbb servers each with it's secret and bigbluebutton-URL. You can find the secret on your server in it's config-file via cat /usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties | grep securitySalt=

A example configuration file could look like this:

[bbb.example.com]
securitySalt=MY_SUPER_SECRET_SECRET
bigbluebutton.web.serverURL=https://bbb.example.com/

[Foo's private bbb-server]
securitySalt=MY_SUPER_SECRET_SECRET2
bigbluebutton.web.serverURL=https://bbb.foo.com/

The section names in the square brackets will be used as display names (these support utf-8)

Usage

For help run:

bbbmon --help