BigBlueButton/bigbluebutton-Github
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
79c13621d7
bigbluebutton-Github/bbb-webhooks
History
italo 24091b9fcb Fix multiple callback when creating permanent hooks
2018-06-15 14:33:17 -03:00
..
config promote bbb-webhooks to a well-supported module (removed from labs) 2015-05-06 00:11:02 -03:00
extra Change compare to 'hasOwnProperty' 2017-11-01 19:10:41 +00:00
log promote bbb-webhooks to a well-supported module (removed from labs) 2015-05-06 00:11:02 -03:00
test Adapt tests to work without depending on bbb 2017-11-06 18:46:12 +00:00
.gitignore Feature: Convert webhooks application to JS ES6 2017-09-11 11:54:15 -03:00
.nvmrc Update .nvmrc to proper node version 2017-11-01 19:09:46 +00:00
app.js Feature: Convert webhooks application to JS ES6 2017-09-11 11:54:15 -03:00
application.js Add a callback to let components know app started 2017-11-06 18:43:05 +00:00
callback_emitter.js New emit state that send Auth header, remove backupUrl 2017-11-01 19:09:09 +00:00
config_local.js.example Change preset config for compatibility 2018-01-08 14:16:51 -02:00
config.js Change preset config for compatibility 2018-01-08 14:16:51 -02:00
hook.js Remove test specific functions 2017-11-06 18:44:20 +00:00
id_mapping.js Feature: Create userId mapping 2017-09-14 17:09:02 +00:00
logger.js Update node version and remove workarounds for older versions 2017-09-11 11:54:36 -03:00
messageMapping.js Treat presenter/rap-publish events 2017-11-01 19:06:22 +00:00
package-lock.json Update package info 2017-09-11 11:54:38 -03:00
package.json Update package info 2017-09-11 11:54:38 -03:00
README.md Fixed formatting of README.md 2017-06-12 17:02:12 -04:00
userMapping.js Fix: Error when expiring users 2017-11-01 19:05:55 +00:00
utils.js Update node version and remove workarounds for older versions 2017-09-11 11:54:36 -03:00
web_hooks.js Add a callback so components know service started 2017-11-06 18:45:35 +00:00
web_server.js Fix multiple callback when creating permanent hooks 2018-06-15 14:33:17 -03:00

README.md

bbb-webhooks

This is a node.js application that listens for all events on BigBlueButton and sends POST requests with details about these events to hooks registered via an API. A hook is any external URL that can receive HTTP POST requests.

You can read the full documentation at: http://docs.bigbluebutton.org/labs/webhooks.html

Development

  1. Install node. You can use NVM if you need multiple versions of node or install it from source. To install from source, first check the exact version you need on package.json and replace the all vX.X.X by the correct version when running the commands below.
wget http://nodejs.org/dist/vX.X.X/node-vX.X.X.tar.gz
tar -xvf node-vX.X.X.tar.gz
cd node-vX.X.X/
./configure
make
sudo make install

  1. Install the dependencies: npm install

  2. Copy and edit the configuration file: cp config_local.coffee.example config_local.coffee

  3. Run the application with:

node app.js
  1. To test it you can use the test application post_catcher.js. It starts a node app that registers a hook on the webhooks app and prints all the events it receives. Open the file at extra/post_catcher.js and edit the salt and domain/IP of your server and then run it with node extra/post_catcher.js. Create meetings and do things on your BigBlueButton server and the events should be shown in the post_catcher.

Another option is to create hooks with the API Mate and catch the callbacks with PostCatcher.

Production

  1. Install node. First check the exact version you need on package.json and replace the all vX.X.X by the correct version in the commands below.
wget http://nodejs.org/dist/vX.X.X/node-vX.X.X.tar.gz
tar -xvf node-vX.X.X.tar.gz
cd node-vX.X.X/
./configure
make
sudo make install

  1. Copy the entire webhooks directory to /usr/local/bigbluebutton/bbb-webhooks and cd into it.

  2. Install the dependencies: npm install

  3. Copy and edit the configuration file to adapt to your server: cp config_local.coffee.example config_local.coffee.

  4. Drop the nginx configuration file in its place: cp config/webhooks.nginx /etc/bigbluebutton/nginx/. If you changed the port of the web server on your configuration file, you will have to edit it in webhooks.nginx as well.

  5. Copy upstart's configuration file and make sure its permissions are ok:

sudo cp config/upstart-bbb-webhooks.conf /etc/init/bbb-webhooks.conf
sudo chown root:root /etc/init/bbb-webhooks.conf

Open the file and edit it. You might need to change things like the user used to run the application.
  1. Copy monit's configuration file and make sure its permissions are ok:
sudo cp config/monit-bbb-webhooks /etc/monit/conf.d/bbb-webhooks
sudo chown root:root /etc/monit/conf.d/bbb-webhooks

Open the file and edit it. You might need to change things like the port used by the application.
  1. Copy logrotate's configuration file and install it:
sudo cp config/bbb-webhooks.logrotate /etc/logrotate.d/bbb-webhooks
sudo chown root:root /etc/logrotate.d/bbb-webhooks
sudo chmod 644 /etc/logrotate.d/bbb-webhooks
sudo logrotate -s /var/lib/logrotate/status /etc/logrotate.d/bbb-webhooks
  1. Start the application:
sudo service bbb-webhooks start
sudo service bbb-webhooks stop