基本要求
-
您必须拥有包含 GitHub Insights 的 GitHub Enterprise 许可文件。 在购买 GitHub Insights 后,您可以在 GitHub Enterprise 网站门户中下载更新的许可文件。
-
GitHub Insights 需要一台托管在云端或本地的机器,称为应用程序服务器。 更多信息请参阅“GitHub Insights 的系统概述”。
-
您必须在应用程序服务器上安装依赖项。
- Docker 1.13.0+
- Docker Compose v1.17.0+
注意: 应用程序服务器可能需要 Docker 守护程序以 sudo 身份运行。 不支持 Kubernetes。
创建 GitHub 应用程序
要将 GitHub Insights 连接到 GitHub Enterprise,您必须在 GitHub Enterprise 上的组织中创建 GitHub 应用程序。 当您的集成执行操作时,应用程序名称的缓存版本将显示在 GitHub Enterprise 上。
-
登录到
http(s)://HOSTNAME/login
上的 您的 GitHub Enterprise Server 实例。 -
导航至要连接到 GitHub Insights 的组织。
-
在组织名称下,单击 Settings(设置)。
-
在左侧边栏中,单击 GitHub 应用程序。
-
单击新建 GitHub 应用程序。
-
在“GitHub 应用程序 名称”下,输入应用程序的名称。您的应用程序不能与现有用户或组织同名,除非该名称是您自己拥有的用户或组织名称。
-
在“Homepage URL(主页 URL)”下,输入用于 GitHub Insights 的应用程序服务器的 URL。 更多信息请参阅“GitHub Insights 的系统概述”。
-
在“User authorization callback URL(用户授权回调 URL)”下,输入以下内容,将
<application-server-url>
替换为应用程序服务器的 URL。<application-server-url>/public/applogin
-
在“Setup URL(设置 URL)”下,输入
<application-server-url>/public/setup
。 -
在“Webhook URL(Web 挂钩 URL)”,输入
<application-server-url>/webhooks
。 -
在“Webhook secret(Web 挂钩密码)”下,输入密码,然后记录该密码供以后参考。
-
在“Permissions(权限)”下,使用下拉菜单为应用程序配置以下权限。
- 仓库:
- 内容:Read-only(只读)
- 元数据:Read-only(只读)
- 拉取请求:Read-only(只读)
- 提交状态:Read-only(只读)
- 组织:
- 成员:Read-only(只读)
- 项目:Read-only(只读)
- 仓库:
-
在“Subscribe to events(订阅事件)”下,选择:
- 成员
- 拉取请求
- 推送
- 仓库
- 团队
-
要启用 GitHub 应用程序 访问 您的 GitHub Enterprise Server 实例 中任何用户或组织的数据,请在“此 GitHub 应用程序 可安装在何处?”下,选择 Any account(任何帐户)。
-
单击创建 GitHub 应用程序。
-
检查应用程序的配置。
-
在“Private keys(私钥)”下,单击 Generate a private key(生成私钥)。
-
保存生成的 PEM 文件供以后参考。
-
记录关于应用程序的以下信息,供以后参考。
- 应用程序 ID
- 客户端 ID
- 客户端密钥
- 私钥
- Web 挂钩密码
安装 GitHub Insights
- 从应用程序服务器中
github/insights-releases
的发行版页面上,找到 GitHub Insights 的最新版本。 - 要下载最新版本,请在“Assets(资产)”下单击
insights-VERSION.tar.gz
。 - 解压缩目录。
- 运行 shell 脚本
install.sh
。 - 要启用 SSL,请输入 SSL 证书 (
.crt/.cer/.pem
)。 如果不想启用 SSL,请留空。 - 如果选择启用 SSL,请输入 SSL 密钥 (
.key
)。 否则,请留空。 - 输入主机名,即创建 GitHub 应用程序 时用于应用程序服务器的 URL。
- 安装的运行需要几分钟。 完成后,您将看到终端上显示一条消息。
安装完成 运行 /opt/insights/scripts/start.sh 以启动 GitHub Insights
- 要启动 GitHub Insights,请运行 shell 脚本
/opt/insights/scripts/start.sh
。 - 如果这是第一次启动 GitHub Insights,该脚本需要几分钟才能运行。 完成后,您将看到终端上显示一条消息。
GitHub Insights 正在运行!
配置 GitHub Insights
要配置 GitHub Insights 连接到 GitHub Enterprise Server,您必须提供在前面的步骤中记录的信息。
- 在浏览器中,导航到
<application-server-url>/setup
。 - 在“GitHub API URL”下,输入 用来访问 GitHub Enterprise 的 URL。
- 在 "GitHub Insights 许可"下,单击"Choose Files(选择文件)",然后上传您的 GitHub Enterprise 许可文件。
- 在“App ID(应用程序 ID)”下,输入您在创建应用程序时记录的 GitHub 应用程序 应用程序 ID。
- 在“Client ID(客户端 ID)”下,输入您在创建应用程序时记录的 GitHub 应用程序 客户端 ID。
- 在“Client Secret(客户端密码)”下,输入您在创建应用程序时记录的 GitHub 应用程序 客户端密码。
- 在“Private Key(私钥)”下,输入用于 GitHub 应用程序 的私钥,它包含在您创建应用程序时下载的 PEM 文件中。
- 在“Webhook Secret(web 挂钩密码)”下,输入您在创建应用程序时记录的 GitHub 应用程序 web 挂钩密码。
- 如果在安装过程中无法提供 SSL 证书,请选择 Skip SSL Certificate Check(跳过 SSL 证书检查)。
- 单击 Submit(提交)。
- 单击使用 GitHub 登录。
- 要授权 GitHub 应用程序 并访问 GitHub Insights,请单击授权 GitHub 应用程序。