bbb-status/README.md
2021-02-17 17:39:27 +01:00

59 lines
1.5 KiB
Markdown

# README
Thanks to Bernd Wurst who inspired this project with his gist on github:
* https://gist.github.com/bwurst/7f94e0392c75d273a08d1e686182fc5e
## setup
Execute `bbb-conf --secret` on your server.
This gives you your **API-secret**, the **URL** at which BigBlueButton is running at.
Save these two values in the first line of the following files:
* URL inside `secret/url.txt`
* API-secret inside `secret/secret.txt`
Note: You may `chmod 600` on the two above files.
## run
Start logging in the background:
```shell
docker-compose up -d
```
Generate a new plot based on saved meeting data:
```shell
sudo docker-compose run bbb-status plot
```
## example logging
```shell
sudo docker-compose up -d # start logging in the background
sudo docker-compose logs # inspect container output
```
```shell
Attaching to bbb-status_bbb-status_1
bbb-status_1 | === bbb-status ===
bbb-status_1 |
bbb-status_1 | BBB meetingData logger started!
bbb-status_1 | Saved meetings at /usr/data/20210217_173525_meetings.xml
bbb-status_1 | meetings: [<langfingaz.parseMeetings.Meeting object at 0x7f8382471280>]
bbb-status_1 | pointOfTime: None
bbb-status_1 | recordingCount: 1
bbb-status_1 | participantCount: 4
bbb-status_1 | listenerCount: 0
bbb-status_1 | voiceParticipantCount: 4
bbb-status_1 | videoCount: 4
bbb-status_1 | moderatorCount: 1
bbb-status_1 | >> Sleeping for five minutes <<
```
## example plot
![plot of one month BBB usage](plot-last-month.png)