Skip to main content

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

Run bbbmon config --new to create a new default configuration file. bbbmon will always ask you before it creates or overwrites anything.

Within the config you can define one or more endpoints with running bbb instances – 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/

[Föö]
securitySalt=MY_SUPER_SECRET_SECRET2
bigbluebutton.web.serverURL=https://bbb.foo.com/

The section names in the square brackets can be chosen arbitrarily (as long as they are unique) and will be used as display names (they support utf-8). It makes sense to keep them short as they can be used for filtering and/or ordering:

bbbmon meetings -e Föö

Usage

For help run:

bbbmon -h

bbbmon supports command abbreviations – these commands produce the same result:

bbbmon meetings
bbbmon meeting
bbbmon mee
bbbmon m

This works as long as there is no other command starting with the same letters.

Metadata

Release files for bbbmon 0.1.33

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bbbmon 0.1.33
File Size Uploaded
bbbmon-0.1.33.tar.gz 25.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bbbmon 0.1.33
File Interpreter ABI Platform
bbbmon-0.1.33-py3-none-any.whl Python 3 none any Details

Total release size: 52.9 kB

Release files / bbbmon-0.1.33.tar.gz

Download URL bbbmon-0.1.33.tar.gz
Size 25.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4045f8116e2278804ba37a648784114ef9fe23749f656a9fff20f049ebf5b77a
BLAKE2b-256 checksum
How to use checksums
63cb87c944c6ad4c216a5978cf398ab5a7497d6eaba2307d0970e9176c4c7444
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.5 Linux/5.8.0-59-generic

Release files / bbbmon-0.1.33-py3-none-any.whl

Download URL bbbmon-0.1.33-py3-none-any.whl
Size 27.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
51358e84023c05f82b1ff75560b713f3d302ec733bb92605402ac9ae751b5399
BLAKE2b-256 checksum
How to use checksums
9db63bbbb0e4742cbeb0781fc222873ee9f05db8cb2ac9122169bcadf3956dcb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.5 Linux/5.8.0-59-generic

Release history Release notifications | RSS feed

This release

0.1.33 This release

2 release files

0.1.32

2 release files

0.1.31

2 release files

0.1.30

2 release files

0.1.29

2 release files

0.1.28

2 release files

0.1.27

2 release files

0.1.26

2 release files

0.1.25

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.20

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page