mconf/bbb-app-rooms

Rooms工具与LTI-Broker本地部署指南

概述

本文档提供在本地环境部署Rooms工具和LTI-Broker应用，并配置与Moodle等学习管理系统（LMS）集成的详细步骤，包括环境准备、仓库配置、数据库设置、Nginx部署及LMS集成流程。

核心功能与特性

• 本地部署Rooms工具和LTI-Broker应用
• 支持PostgreSQL数据库配置
• 环境变量自定义设置（如密钥、数据库参数、URL路径等）
• Nginx反向代理配置支持
• 与Moodle等LMS系统集成
• 支持自定义参数控制会议功能（如录制、等候主持人等）

使用场景与适用范围

适用于需要在本地环境中部署Rooms工具和LTI-Broker，并将其与学习管理系统集成的开发者、系统管理员或教育机构技术人员。

前提条件

在开始部署前，需确保本地环境已满足以下条件：

• 安装nginx和postgresql
• 安装Ruby on Rails
• https://github.com/jfederico/bbb-lti-run#preliminary-steps
• 安装Moodle（或其他LMS），建议在独立LXC容器中部署，参考Moodle安装指南

详细部署步骤

1. 仓库设置

1.1 克隆仓库

克隆Rooms和LTI-Broker的代码仓库：

bash
git clone https://github.com/bigbluebutton/bbb-app-rooms.git
git clone https://github.com/bigbluebutton/bbb-lti-broker.git

1.2 配置Rooms应用环境变量

进入Rooms应用目录并配置环境变量：

bash
cd bbb-app-rooms
cp dotenv .env
sudo vi .env  # 使用文本编辑器编辑.env文件

编辑以下必要变量值：

## 应用配置
# 运行openssl rand -hex 32生成密钥
SECRET_KEY_BASE=

RELATIVE_URL_ROOT=apps

## 数据库配置
# DB_ADAPTER=[postgresql]
# DB_HOST=<localhost>
# DB_NAME=
# DB_USERNAME=<root>
# DB_PASSWORD=

# BigBlueButton配置
BIGBLUEBUTTON_ENDPOINT=https://bbb.<your-name>.blindside-dev.com/bigbluebutton/api
BIGBLUEBUTTON_SECRET=<服务器密钥>
BIGBLUEBUTTON_MODERATOR_ROLES=Instructor,Faculty,Teacher,Mentor,Administrator,Admin

# BigBlueButton LTI Broker配置
OMNIAUTH_BBBLTIBROKER_SITE=https://lti.<JOHN>.blindside-dev.com
OMNIAUTH_BBBLTIBROKER_ROOT=lti
# 需与添加到Broker时的参数匹配
# rake db:apps:add[rooms,key,secret,https://lti.<JOHN>.blindside-dev.com/apps/rooms/auth/bbbltibroker/callback]
OMNIAUTH_BBBLTIBROKER_KEY=<自定义key>
OMNIAUTH_BBBLTIBROKER_SECRET=<自定义secret>

## 设置域名（必填）
URL_HOST=lti.<JOHN>.blindside-dev.com

## 日志输出到标准输出（可选）
RAILS_LOG_TO_STDOUT=true

## 通过应用提供静态资源（当前必填）
RAILS_SERVE_STATIC_FILES=true

## 启用开发环境特性（可选）
# RAILS_ENV=production

1.3 配置LTI-Broker环境变量

进入LTI-Broker目录并配置环境变量：

bash
cd ~/bbb-lti-broker
cp dotenv .env
sudo vi .env  # 使用文本编辑器编辑.env文件

配置内容：

POSTGRES_PASSWORD=<PostgreSQL数据库密码>
POSTGRES_USER=postgres

# 创建Rails密钥
# 可通过Greenlight Docker镜像生成：
# docker run --rm bigbluebutton/greenlight:v2 bundle exec rake secret
SECRET_KEY_BASE=

# 应用配置
RELATIVE_URL_ROOT=lti

# LTI工具配置
# DEFAULT_LTI_TOOL=rooms

# DEVELOPER_MODE_ENABLED=true

# WHITELIST_HOST=broker.example.com

## 设置域名（必填）
URL_HOST=lti.<JOHN>.blindside-dev.com

## 连接外部PostgreSQL实例（可选）
# DATABASE_URL=postgres://postgres:password@localhost

## 日志输出到标准输出（可选）
RAILS_LOG_TO_STDOUT=true

## 通过应用提供静态资源（当前必填）
RAILS_SERVE_STATIC_FILES=true

## 启用开发环境特性（可选）
# RAILS_ENV=development

1.4 数据库初始化

为两个应用创建并迁移数据库：

bash
# 在Rooms应用目录执行
cd ~/bbb-app-rooms
rake db:create db:migrate db:seed

# 在LTI-Broker目录执行
cd ~/bbb-lti-broker
rake db:create db:migrate db:seed

1.5 将Rooms应用添加到LTI-Broker

使用Rooms环境变量中配置的OMNIAUTH_BBBLTIBROKER_KEY和OMNIAUTH_BBBLTIBROKER_SECRET执行以下命令：

bash
cd ~/bbb-lti-broker
rake db:apps:add[rooms,https://lti.<JOHN>.blindside-dev.com/apps/rooms/auth/bbbltibroker/callback,<key>,<secret>]

# 添加密钥到密钥集
rake db:keys:add[<key>:<secret>]

2. Nginx配置

编辑Nginx配置文件：

bash
sudo vim /etc/nginx/conf.d/default.conf

使用https://github.com/jfederico/bbb-lti-run/blob/master/nginx/.sites.template.local%E6%9B%BF%E6%8D%A2%E6%96%87%E4%BB%B6%E5%86%85%E5%AE%B9%EF%BC%8C%E4%BF%9D%E5%AD%98%E5%90%8E%E9%87%8D%E5%90%AFNginx%EF%BC%9A

bash
sudo systemctl restart nginx

3. 与LMS集成

3.1 运行应用

分别启动Rooms和LTI-Broker应用：

bash
# 启动Rooms（端口3012）
cd ~/bbb-app-rooms
rails s -b 0.0.0.0 -p 3012

# 启动LTI-Broker（端口3011）
cd ~/bbb-lti-broker
rails s -b 0.0.0.0 -p 3011

3.2 获取LMS配置URL

1. 在浏览器访问lti.<JOHN>.blindside-dev.com/lti
2. 点击"View LTI Configuration XML"，获取URL：https://lti.<JOHN>.blindside-dev.com/lti/default/xml_config
3. 将URL中的default替换为rooms，刷新页面：https://lti.<JOHN>.blindside-dev.com/lti/rooms/xml_config

3.3 在LMS中配置

• 复制页面中的secure_launch_url
• 在LMS中添加插件时使用此URL作为启动地址
• consumer_key和shared_secret对应Rooms环境变量中的OMNIAUTH_BBBLTIBROKER_KEY和OMNIAUTH_BBBLTIBROKER_SECRET

自定义参数

启动时支持以下自定义参数控制会议行为：