mconf/bbb-webhooks

bbb-webhooks

概述和主要用途

bbb-webhooks是一个node.js应用程序，用于监听BigBlueButton（BBB）的所有事件，并将这些事件的详细信息通过HTTP POST请求发送到通过API注册的钩子。钩子是指任何能够接收HTTP POST请求的外部URL。完整文档可参考：[***]

核心功能和特性

• 实时监听BigBlueButton平台产生的所有事件
• 自动将事件详情（如会议创建、用户加入、录制完成等）通过POST请求发送到注册的外部钩子URL
• 支持通过配置文件自定义BBB服务器信息、模块启用状态等参数
• 依赖Redis进行数据存储和状态管理，确保事件处理的可靠性
• 提供灵活的配置覆盖机制，支持开发、生产等多环境设置

依赖和前置要求

运行该应用前需安装以下依赖，其最低版本要求如下：

开发环境设置

在具备可用的开发环境后，在bigbluebutton/bbb-webhooks目录中执行以下命令：

1. 安装node依赖：

   bash
   npm install
   

   推荐的Node版本可在.nvmrc文件或package.json的engines.node属性中查看。

2. 配置应用：

   bash
   cp config/default.example.yml config/default.yml
   

   • 此命令复制默认配置模板文件。

   bash
   touch config/development.yml
   

   • 创建开发环境配置文件，用于覆盖默认配置中的特定值。
   • 在新创建的config/development.yml中添加bbb.serverDomain和bbb.sharedSecret值，使其与BBB服务器配置匹配。

3. 停止bbb-webhook服务：

   bash
   sudo systemctl stop bbb-webhooks
   

4. 运行应用：

   bash
   npm start
   

持久化钩子

如需BBB服务器的所有webhook都发送到第三方应用，可修改配置文件添加permanentURLs，定义一个或多个目标服务器URL：

1. 编辑配置文件：

   bash
   sudo nano config/development.yml
   

2. 添加modules."../out/webhooks/index.js".config.permanentURLs属性，示例：

   yaml
   ../out/webhooks/index.js:
     config:
       permanentURLs:
         - url: 'https://staging.example.com/webhook-post-route'
           getRaw: false
         - url: 'https://app.example.com/webhook-post-route'
           getRaw: true
   

   • getRaw属性指定是否发送原始数据，默认值为false。

3. 修改后需重启开发/应用服务器使配置生效。

注意：若已提交过永久钩子配置，后续修改可能需要刷新Redis数据库才能生效：

bash
redis-cli flushall

重要：此命令会清空整个Redis数据库，导致所有会议数据（无论是否处理中）被清除，可能造成当前处理中的会议异常。

手动安装到BBB服务器

在bigbluebutton/bbb-webhooks目录中执行以下命令：

1. 复制webhooks目录：

   bash
   sudo cp -r . /usr/local/bigbluebutton/bbb-webhooks
   

2. 进入目标目录：

   bash
   cd /usr/local/bigbluebutton/bbb-webhooks
   

3. 安装依赖：

   bash
   npm install
   

4. 配置文件设置：

   bash
   sudo cp config/default.example.yml config/default.yml
   

   • 编辑配置文件，更新serverDomain和sharedSecret值以匹配BBB服务器配置：

     bash
     sudo nano config/default.yml
     

5. 启动bbb-webhooks服务：

   bash
   sudo systemctl restart bbb-webhooks
   

通过Docker运行

提供示例docker-compose配置，以便快速构建和运行应用镜像。详情可查看Dockerfile和docker-compose.yml。

构建和运行

在项目根目录执行以下命令构建并启动应用：

bash
docker-compose up -d

停止应用

在项目根目录执行以下命令停止应用：

bash
docker-compose down

容器用户配置

容器默认使用Node容器用户node。如需覆盖，可在docker-compose.yml中设置user属性（例如：user: ${UID}:${GID}）。

Docker环境下的应用配置

可通过创建并编辑/etc/bigbluebutton/bbb-webhooks/production.yml覆盖文件修改应用配置。该文件会挂载到容器中，其内容将与默认配置合并（数组属性会被替换）。

容器使用的默认配置文件路径：config/default.example.yml。

配置示例：如需覆盖bbb.serverDomain、bbb.sharedSecret并启用out/xapi模块，创建以下覆盖文件：

yaml
bbb:
  serverDomain: 'bbb.example.com'
  sharedSecret: 'secret'
modules:
  ../out/xapi/index.js:
    enabled: true

其他可配置属性详见默认配置文件。