Getting Started

Prerequisites

Node

You need a recent version (10 or newer is recommended) of Node installed locally.

For comprehensive Node documentation, see nodejs.org.

BigBlueButton Server

You need a 2.2.x or 2.3.x version of BigBlueButton server server running. There are multiple ways to deploy the server, depending on your needs.

For comprehensive BigBlueButton documentation, see docs.bigbluebutton.org.

Installation

Using npm:

1

npm i bigbluebutton-js

Configuration

You will need to provide BigBlueButton URL and secret to the script. You can obtain them by logging into you BBB server, and running:

1

bbb-conf --secret

Use the obtained values in your script:

1
2
3
4
5

const bbb = require('bigbluebutton-js')
let api = bbb.api(
    process.env.BBB_URL, 
    process.env.BBB_SECRET
  )

Provide values to the script using environmntal variables:

1

BBB_URL=YOUR_URL BBB_SECRET=YOUR_SECRET node script.js

Alterantively, you can use dotenv file.