在 GitHub Classroom 中注册学习管理系统

关于将 LMS 注册到您的课堂

在将 LMS 连接到课堂之前，您的 LMS 实例的管理员需要先在 LMS 中配置以允许 GitHub Classroom，然后在 GitHub Classroom 中注册您的 LMS 以启动 OAuth 握手。管理员只需完成一次此注册过程，之后任何使用该 LMS 实例的教师都可以将其 LMS 课程同步到课堂。有关将 LMS 课程连接到课堂的更多信息，请参阅将学习管理系统课程连接到课堂。

注意

Google Classroom 并未使用 LTI 协议，因此在导入名单之前无需先将其连接到 GitHub Classroom。更多信息请参阅将学习管理系统课程连接到课堂。

受支持的 LMS

GitHub Classroom 支持与实现学习工具互操作性（LTI）标准的 LMS 进行连接。

LTI 版本 1.3
LTI Advantage

使用 LTI 有助于保持您的信息安全可靠。LTI 是业界标准协议，GitHub Classroom 对 LTI 的使用已通过教学管理系统（IMS）全球学习联盟的认证。欲了解更多信息，请访问 IMS 全球学习联盟网站的 Learning Tools Interoperability 与 About IMS Global Learning Consortium 页面。

GitHub 已对以下 LMS 进行注册、连接以及名单数据导入的测试和验证，确认可在 GitHub Classroom 中使用。

Blackboard（这是社区支持的选项）
Canvas
Moodle
Sakai
Google Classroom

注意

实现 LTI 1.3 的其他 LMS 也可能与 GitHub Classroom 兼容，但尚未经过验证。LMS 管理员可能需要针对隐私和按钮位置进行自定义设置，并可能需要向教师提供如何从 LMS 启动 GitHub Classroom 的文档。

Google Classroom 并未使用 LTI 协议，因此在导入名单之前无需先将其连接到 GitHub Classroom。更多信息请参阅将学习管理系统课程连接到课堂。

为 GitHub Classroom 配置 Blackboard

您可以将 Blackboard 安装注册到 GitHub Classroom，以便教师将名单数据导入其课堂。有关 Blackboard 的更多信息，请访问 Blackboard 网站。

步骤 1：在 Anthology 开发者门户注册 GitHub Classroom 开发者密钥

登录 Anthology 开发者门户。
在我的应用页面点击加号。
在下拉菜单中点击 手动注册。

在“注册新应用”配置屏幕上，将字段设置为以下值。

新应用配置中的字段	值或设置
应用名称	`GitHub Classroom` 您可以使用任意名称，仅向管理员显示。
描述	`Sync Blackboard course roster to GitHub Classroom`（或类似内容）
域名	`classroom.github.com`
组	保留默认值，或根据机构需求进行更改。
我的集成支持 LTI 1.3	启用该标志。
登录发起 URL	`https://classroom.github.com/lti1p3/openid-connect/auth`
工具重定向 URL（多个）	`https://classroom.github.com/lti1p3/openid-connect/redirect,https://classroom.github.com/context-link`
工具 JWKS URL	`https://classroom.github.com/.well-known/jwks.json`
签名算法下拉框	`RS256`
自定义参数	留空。

点击 注册应用。
开发者门户将显示一个包含您在下面的 Blackboard 实例以及 GitHub Classroom 中注册时需要输入的重要信息的页面。请将其记录在安全位置后点击完成。
在“我的应用”页面的表格中，找到 GitHub Classroom 应用所在行，点击三点图标，然后在下拉菜单中选择 管理部署。
点击加号。

在“注册新部署”配置屏幕上，将字段设置为以下值。

新部署配置中的字段	值或设置
部署名称	`GitHub Classroom` 您可以使用任意名称，但如果更改，请确保通知教师。
描述	`Sync Blackboard course roster to GitHub Classroom`（或类似内容）
类型下拉框	课程工具
允许学生访问	不要启用此标志。
在新窗口中启动	除非您希望提供此用户体验，否则不要启用此标志。
目标链接 URI	`https://classroom.github.com/context-link`
图标 URL	留空或提供图标的静态 URL。如有需要，稍后可在 Blackboard 中手动上传。
自定义参数	留空。

点击 注册部署。

步骤 2：在 Blackboard 中注册 GitHub Classroom 开发者密钥

登录您的 Blackboard 实例。
在首页左侧边栏，点击管理，然后点击 LTI 工具提供者。
在 “LTI 工具提供者” 页面，点击 注册 LTI 1.3/Advantage 工具。
粘贴从开发者门户获取的 客户端 ID / 应用 ID，然后点击提交。
Blackboard 将显示所有应用数据。在此页面中
1. 确认 工具状态 为 已批准。
2. 确认已为 “课程角色” 、 “姓名” 、 “电子邮件地址” 启用 要发送的用户字段 标记。
3. 确认 允许标记服务访问 单选框设置为 “否”。若需启用此选项，请在管理面板的 LTI 工具提供者中
  - 选择 “管理全局属性”。
  - 在 “创建工具提供者链接” 下，选择单选框 “允许链接到任何工具提供者，但对每个新提供者需要批准”。
4. 确认 允许成员服务访问 单选框设置为 “是”。
点击提交。

步骤 3：在 GitHub Classroom 中注册您的开发者密钥

前往 https://classroom.github.com/register-lms。
填写以下信息
- 在 “LMS 类型” 下拉菜单中，选择 “其他”。
- “发行者标识符”：https://blackboard.com
- “域名”：您 Blackboard 实例的基础 URL
- “客户端 ID”：从 Anthology 开发者门户注册的应用中获取的 “客户端 ID” / “应用 ID”。
- “OIDC 发起 URL”：从 Anthology 开发者门户注册的应用中获取的 “OIDC 授权请求端点”。
- “OAuth 2.0 令牌检索 URL”：从 Anthology 开发者门户注册的应用中获取的 “授权令牌端点”。
- “密钥集 URL”：从 Anthology 开发者门户注册的应用中获取的 “公钥密钥集 URL”。
点击注册。
您应在屏幕顶部看到 “成功注册 LMS” 横幅，这表示已成功注册您的 LMS 实例，教师现在可以将其课堂链接起来。

为 GitHub Classroom 配置 Canvas

您可以将 Canvas 安装注册到 GitHub Classroom，以便教师将名单数据导入其课堂。有关 Canvas 的更多信息，请访问 Canvas 网站。

1. 在 Canvas 中注册 GitHub Classroom 开发者密钥

登录 Canvas。
在首页左侧边栏，点击管理，然后点击 站点管理员。
点击 开发者密钥。
在 “开发者密钥” 区域，点击 + 开发者密钥 按钮，然后在下拉菜单中选择 + LTI 密钥。

在 “密钥设置” 配置屏幕上，将字段设置为以下值。

Canvas 应用配置中的字段	值或设置
方法	`手动输入`
标题	`GitHub Classroom` 注意：您可以使用任意名称，但如果更改，请确保通知教师。
描述	`Sync Canvas course rosters to GitHub Classroom`（或类似内容）
目标链接 URI	`https://classroom.github.com/context-link`
OpenID Connect 发起 URL	`https://classroom.github.com/lti1p3/openid-connect/auth`
JWK 方法	`公共 JWK URL`
公共 JWK URL	`https://classroom.github.com/.well-known/jwks.json`
重定向 URI（多个）	`https://classroom.github.com/lti1p3/openid-connect/redirect`
LTI Advantage 服务下拉框	选择 “可以检索与工具所在上下文关联的用户数据” 复选框。
其他设置下拉框	在 “隐私级别” 下，选择 `Public`
部署	选择 `Course Settings Sub Navigation`。注意：如果将部署改为其他名称，请务必告知教师。我们的文档会默认该按钮位于此部署位置。

点击保存。
在 “开发者密钥” 页面表格中，找到 GitHub Classroom 开发者密钥所在行，记录 “详细信息” 列中的客户端 ID——此信息需提供给教师以完成设置。
在 “开发者密钥” 页面表格的 “状态” 列中，将密钥状态切换为 “开启”。

2. 在 GitHub Classroom 中注册您的开发者密钥

前往 https://classroom.github.com/register-lms。
填写以下信息
- 在 “LMS 类型” 下拉菜单中，选择 “Canvas”。
- “发行者标识符”：https://canvas.instructure.com
- “域名”：您 Canvas 实例的基础 URL
- “客户端 ID”：您在上一步创建的开发者密钥 “详细信息” 中的 “客户端 ID”。
- “OIDC 授权端点”：在您 Canvas 实例基础 URL 后追加 /api/lti/authorize_redirect。
- “OAuth 2.0 令牌检索 URL”：在您 Canvas 实例基础 URL 后追加 /login/oauth2/token。
- “密钥集 URL”：在您 Canvas 实例基础 URL 后追加 /api/lti/security/jwks。
点击注册。
您应在屏幕顶部看到 “成功注册 LMS” 横幅，这表示已成功注册您的 LMS 实例，教师现在可以将其课堂链接起来。

为 GitHub Classroom 配置 Moodle

您可以将 Moodle 安装注册到 GitHub Classroom，以便教师将名单数据导入其课堂。有关 Moodle 的更多信息，请访问 Moodle 网站。

您必须使用 Moodle 3.0 及以上版本。

1. 在 Moodle 中启用作为 LTI 工具的发布

登录 Moodle。
点击顶部主菜单中的 “站点管理” 选项卡。
在 “站点管理” 页面，点击 “插件” 选项卡，向下滚动至 “身份验证” 部分并点击 管理身份验证。
在 “LTI” 字段旁，点击切换按钮以启用 LTI。
再次点击 “插件” 选项卡，向下滚动至 “注册” 部分并点击 管理注册插件。
在 “作为 LTI 工具发布” 字段旁，点击切换按钮以启用作为 LTI 工具的发布。
返回顶部主菜单的 “站点管理” 页面，向下滚动至 “安全” 部分并点击 HTTP 安全。
在 “允许框架嵌入” 旁勾选复选框以启用框架嵌入，然后点击 保存更改。

2. 将 GitHub Classroom 注册为外部工具

再次通过顶部主菜单的 “站点管理” 选项卡返回 “站点管理” 页面。
点击 “插件” 选项卡，然后在 “活动模块” 部分的 “外部工具” 下点击 管理工具。
点击 手动配置工具。

在以下字段中输入相应值。

Moodle 应用配置中的字段	值或设置
工具名称	`GitHub Classroom` 注意：您可以使用任意名称，但如果更改，请确保通知教师。
工具 URL	`https://classroom.github.com`
LTI 版本	`LTI 1.3`
公钥类型	`密钥集 URL`
公钥密钥集	`https://classroom.github.com/.well-known/jwks.json`
发起登录 URL	`https://classroom.github.com/lti1p3/openid-connect/auth`
重定向 URI（多个）	`https://classroom.github.com/lti1p3/openid-connect/redirect`
默认启动容器	`新窗口`

选中 支持深度链接（内容项消息） 复选框。
在 “服务” 下拉框中，针对 “IMS LTI 名称和角色提供”，选择 “使用此服务根据隐私设置检索成员信息”。
在 “隐私” 下拉框中，将 “与工具共享启动者的名称” 设置为 “始终”，并将 “与工具共享启动者的电子邮件” 设置为 “始终”。
点击 保存更改。
GitHub Classroom 现已注册为外部工具。在 “工具” 下的 “GitHub Classroom” 框中，点击菜单图标以查看 “工具配置详情” 页面。该页面包含您在后续 GitHub Classroom 实例注册步骤中需要输入的重要信息。

3. 将您的 Moodle 实例注册到 GitHub Classroom

前往 https://classroom.github.com/register-lms。
填写以下信息
- 在 “LMS 类型” 下拉菜单中，选择 “Moodle”。
- “发行者标识符”：从您在 Moodle 中创建的外部工具的 “工具配置详情” 中获取的 “平台 ID”。
- “域名”：您 Moodle 实例的基础 URL
- “客户端 ID”：从您在 Moodle 中创建的外部工具的 “工具配置详情” 中获取的 “客户端 ID”。
- “身份验证请求 URL”：从您在 Moodle 中创建的外部工具的 “工具配置详情” 中获取的 “身份验证请求 URL”。
- “访问令牌 URL”：从您在 Moodle 中创建的外部工具的 “工具配置详情” 中获取的 “访问令牌 URL”。
- “密钥集 URL”：从您在 Moodle 中创建的外部工具的 “工具配置详情” 中获取的 “公钥密钥集 URL”。
点击注册。
您应在屏幕顶部看到 “成功注册 LMS” 横幅，这表示已成功注册您的 LMS 实例，教师现在可以将其课堂链接起来。

为 GitHub Classroom 配置 Sakai

1. 将 GitHub Classroom 注册为外部工具

前往 Sakai 并登录。
进入 “管理工作区”，在左侧边栏中选择 外部工具。
点击 安装 LTI 1.x 工具。