Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mconf/bigbluebot
BigBlueButton bots
https://github.com/mconf/bigbluebot
Last synced: 3 days ago
JSON representation
BigBlueButton bots
- Host: GitHub
- URL: https://github.com/mconf/bigbluebot
- Owner: mconf
- License: mit
- Created: 2018-11-30T00:37:37.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-26T02:25:16.000Z (6 months ago)
- Last Synced: 2024-12-22T14:08:15.428Z (10 days ago)
- Language: JavaScript
- Size: 10.7 MB
- Stars: 58
- Watchers: 12
- Forks: 29
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BigBlueBot
BigBlueButton bots
## Requirements
A BigBlueButton's server and API's secret
## Instructions
**IMPORTANT**: do not run this lib with `root` privileges
`npm i @mconf/bigbluebot`
`cp node_modules/bigbluebot/.env.template .env`
### Set your environment variables
At the `.env` file you just copied, set:
- your BigBlueButton server URL
```
BIGBLUEBOT_HOST=https://your.bigbluebutton.server
```
- your BigBlueButton server API secret
```
BIGBLUEBOT_SECRET=yourbigbluebuttonsecret
```
- your BigBlueButton server running version (currently 2.5)
```
BIGBLUEBOT_VERSION=2.5
```
- [optional] room name or meetingID
```
BIGBLUEBOT_ROOM=yourbigbluebuttonroomidentifier
```
If you would like the bots to join an existing room, you may fill
out the password variables and use the `meetingID` value as `BIGBLUEBOT_ROOM`
To find out these data, you may call the `getMeetings` route of your BBB
instance as described [here](https://docs.bigbluebutton.org/dev/api.html#getmeetings).
- [optional] the `attendeePW` and `moderatorPW` as shown in getMeetings
```
BIGBLUEBOT_ATTENDEE_PW=yourattendeepassword
BIGBLUEBOT_MODERATOR_PW=yourmoderatorpassword
```
- [optional] number of bots to join the room
```
BIGBLUEBOT_BOTS=1
```
- [optional] time (milliseconds) between bots to join
```
BIGBLUEBOT_WAIT=2000
```
- [optional] time (milliseconds) of a bot life span
```
BIGBLUEBOT_LIFE=60000
```
- [optional] external browser to be used
```
BIGBLUEBOT_BROWSER=/path/to/your/browser
```
- [optional] endpoint browser websocket to be used
```
BIGBLUEBOT_ENDPOINT=wss://your.browser.websocket
```
- [optional] endpoint authentication token
```
BIGBLUEBOT_TOKEN=yourauthenticationtoken
```
- [optional] log level
```
BIGBLUEBOT_LOG=info
```
- [optional] Ignore HTTPS errors during navigation
```
BIGBLUEBOT_IGNORE_HTTPS_ERRORS=false
```
### Make a run script
Create your script, e.g. `run.js`:
Join audio with microphone
```js
const bigbluebot = require('@mconf/bigbluebot');
const actions = async page => {
await bigbluebot.audio.modal.microphone(page);
};
bigbluebot.run(actions);
```
Join audio as a listener
```js
const bigbluebot = require('@mconf/bigbluebot');
const actions = async page => {
await bigbluebot.audio.modal.listen(page);
};
bigbluebot.run(actions);
```
Join video
```js
const bigbluebot = require('@mconf/bigbluebot');
const actions = async page => {
await bigbluebot.video.join(page);
};
bigbluebot.run(actions);
```
Write in chat
```js
const bigbluebot = require('@mconf/bigbluebot');
const actions = async page => {
await bigbluebot.chat.send(page);
};
bigbluebot.run(actions);
```
#### Runtime options
You can pass options as a run parameter
```js
const bigbluebot = require('@mconf/bigbluebot');
const actions = async page => {
await bigbluebot.audio.modal.microphone(page);
await bigbluebot.video.join(page);
await bigbluebot.chat.send(page);
};
const options = {
host: 'https://your.bigbluebutton.server',
secret: 'yourbigbluebuttonsecret',
version: '2.2' OR '2.3',
room: 'yourbigbluebuttonroomidentifier',
password: {
moderator: 'yourmoderatorpassword',
attendee: 'yourattendeepassword',
},
moderator: true OR false,
userdata: {
"userdata-bbb_first_userdata": value,
"userdata-bbb_second_userdata": value,
"userdata-bbb_third_userdata": value,
},
};
bigbluebot.run(actions, options);
```
### Run your script
`node run.js`