mconf/bbb-lti-broker

BigBlueButton LTI Broker 文档

镜像概述和主要用途

BigBlueButton LTI Broker是一个Web应用程序，作为LTI Broker（LTI代理），用于连接工具消费者（Tool Consumers）与BigBlueButton工具。其基本部署需两个应用协作：bbb-lti-broker本身和bbb-app-rooms，实现LTI启动请求的处理与转发。

核心功能和特性

• 多协议支持：兼容LTI 1.0/1.1和LTI 1.3协议，满足不同工具消费者的集成需求。
• Docker化部署：支持通过Docker和Docker-Compose快速部署，简化环境配置。
• 灵活配置：可自定义数据库类型（SQLite3/PostgreSQL）、应用挂载路径、默认LTI工具等。
• 工具管理：通过Rake命令添加、编辑、删除LTI工具，支持多工具配置。
• 开发者模式：提供测试LTI应用、OAuth2应用管理UI等开发功能。
• 安全配置：支持URL白名单、密钥对管理，保障LTI通信安全。

使用场景和适用范围

适用于需要将BigBlueButton集成到学习管理系统（LMS）的教育机构或组织，通过LTI协议实现LMS与BigBlueButton的无缝对接，支持在线课堂、虚拟教室等场景的工具调用与管理。

详细使用方法和配置说明

环境要求

• Docker和Docker-Compose已安装

Docker部署步骤

1. 获取配置文件
   从仓库拉取docker-compose.yml和dotenv文件。

2. 初始化数据库
   执行以下命令创建并初始化数据库：

   bash
   docker-compose run app rake db:create
   docker-compose run app rake db:migrate
   docker-compose run app rake db:seed
   

3. 启动服务

   bash
   docker-compose up
   

配置说明

自定义环境变量

复制dotenv为app.env（仅开发环境），根据需求修改以下关键配置：

数据库配置

bash
# 数据库适配器：sqlite3（默认）或postgresql
# DB_ADAPTER=[sqlite3|postgresql]
# DB_HOST=<数据库主机地址>
# DB_NAME=<数据库名称>
# DB_USERNAME=<数据库用户名>
# DB_PASSWORD=<数据库密码>

应用路径配置

bash
# 应用挂载根路径（如"lti"对应http://example.com/lti）
# RELATIVE_URL_ROOT=lti

LTI工具配置

bash
# 默认LTI工具（"default"或"rooms"）
# DEFAULT_LTI_TOOL=rooms

URL白名单与开发者模式

bash
# 白名单配置（ broker所在URL）
# DEVELOPER_MODE_ENABLED=broker.example.com

# 启用开发者模式（支持测试LTI应用、OAuth2应用管理UI）
# DEVELOPER_MODE_ENABLED=true
# OAuth2应用管理UI地址：http://example.com/lti/oauth/applications

默认密钥对（生产环境需修改）

初始化数据（seed）默认设置的LTI密钥对为：

ruby
{
  :key => 'key',
  :secret => 'secret'
}

端口配置

默认使用端口3000，可通过修改docker-compose.yml中app服务的ports配置调整：

yaml
services:
  app:
    ports:
      - "DESIRED_PORT:3000"  # 将DESIRED_PORT替换为目标端口

添加LTI工具

通过Rake命令添加LTI工具，需提供工具名称、主机名、UID和密钥：

bash
docker-compose run app rake "db:apps:add[tool_name,hostname,tool_uid,tool_secret]"

常用Rake命令

Rake命令执行格式：

bash
docker-compose run app rake "RAKE_COMMAND"

关键命令列表：

• rake db:apps:add[name,hostname,uid,secret,root]：添加新BLTI应用
• rake db:apps:delete[name]：删除指定BLTI应用
• rake db:apps:deleteall：删除所有BLTI应用
• rake db:apps:show[name]：查看指定BLTI应用信息
• rake db:apps:showall：查看所有BLTI应用
• rake db:apps:update[name,hostname,uid,secret]：更新指定BLTI应用
• rake db:migrate：执行数据库迁移
• rake db:keys:add[keys]：添加LTI密钥对（如rake db:keys:add[":key => 'new_key', :secret => 'new_secret'"]）
• rake db:registration:new[type]：添加新工具配置（LTI 1.3）

与LMS集成

LTI 1.0/1.1集成

无需注册工具，工具消费者需以下信息：

• Tool URL：http://broker.example.com/lti/TOOL_NAME/messages/blti（替换TOOL_NAME和域名）
• Consumer Key：Broker密钥（默认key，生产环境需修改）
• Shared Secret：Broker密钥（默认secret，生产环境需修改）

LTI 1.3集成

注册LTI 1.3工具

• 开发模式：通过Web UI注册，访问http://broker.example.com/lti/registration/list
• 生产环境：使用Rake命令：

  bash
  rake db:registration:new[key]        # 添加工具配置
  rake db:registration:keygen[key]     # 生成密钥对
  

工具消费者所需信息

• Tool URL：http://broker.example.com/lti/TOOL_NAME/messages/oblti
• Client ID：注册后生成的客户端ID（如Gh4Bj81cK290d）
• Public Key：生成的JWT公钥（A_JWT_KEY）
• Initiate Login URL：http://broker.example.com/lti/TOOL_NAME/auth/login
• Redirection URI(s)：

  http://broker.example.com/lti/TOOL_NAME/messages/oblti
  http://broker.example.com/lti/TOOL_NAME/messages/deep-link
  

注意事项

• 生产环境需修改默认密钥对（key/secret），避免安全风险。
• 数据库默认使用SQLite3，生产环境建议切换为PostgreSQL以提升性能和稳定性。
• 修改RELATIVE_URL_ROOT后需确保所有相关配置（如LTI工具URL、重定向URI）同步更新。