GitHub Enterprise Server
在你的 GitHub Enterprise Server 实例上安装和配置 Mintlify GitHub 应用，实现文档自动部署和同步。
本指南将逐步引导你在 GitHub Enterprise Server（GHES）实例上配置 Mintlify GitHub App。要将 GHES 实例连接到 Mintlify，你必须在自托管环境中创建该应用的本地版本，用于与我们的远程服务器通信。
如果你使用的是云托管的 GitHub 实例，请参阅 GitHub 页面了解设置方法。
- 在你要安装该应用的 GitHub Enterprise Server 组织中拥有管理员权限
- 能访问你要安装该应用的组织仓库
- 具备与我们外部服务通信的网络连通性（参见下方的 网络要求 部分）
你的 GitHub Enterprise Server 必须能够访问：
- Mintlify 的 API 端点 (https://leaves.mintlify.com)
- Webhook 接收端（443 端口）
请允许以下出站连接：
- 来自 Mintlify 静态 IP 地址的连接：
54.242.90.151 - 到 Mintlify 服务域名的 HTTPS（端口 443）连接
- 对 Mintlify 服务域名的 DNS 解析
有关详细步骤，请参阅 GitHub 文档中的注册 GitHub 应用。
前往组织设置
- 在 GitHub 的任意页面右上角，点击你的个人头像。
- 点击 Your organizations。
- 在你想为其创建应用的组织旁边，点击 Settings。
创建新的 GitHub 应用
- 在左侧边栏中，点击 Developer settings。
- 点击 GitHub Apps。
- 点击 New GitHub App。
配置应用的基本信息
进行如下设置：
- GitHub App name：
Mintlify - Description：
Integration with Mintlify services - Homepage URL：
https://mintlify.com - User authorization callback URL：
https://your-github-server.com/（替换为你实际的 GHES 域名）
设置仓库权限
为该应用设置以下权限。无需为组织（Organization）、账户（Account）或企业（Enterprise）配置任何权限：
- Checks： 读取和写入
- Contents： 读取和写入
- Deployments： 读取和写入
- Metadata： 只读
- Pull Requests： 读取和写入
订阅事件
选择以下 webhook 事件：
- Installation（安装）
- Installation Target（安装目标）
- Create（创建）
- Delete（删除）
- Public（公开）
- Pull Request（拉取请求）
- Push（推送）
- Repository（仓库）
创建应用
点击 Create GitHub App。
GitHub 会将您重定向到该应用的设置页面。
生成私钥
- 向下滚动至 Private keys 部分。
- 点击 Generate a private key。
- 下载
.pem文件并安全保存。
记录应用凭证
记录以下信息：
- App ID（显示在设置页面顶部）
- Client ID（位于 “About” 部分）
- Client Secret（生成后请妥善保存）
导航到应用安装页面
- 在应用设置页面，点击左侧边栏中的 Install App。
- 从列表中选择你的组织。
选择安装范围
选择以下其中一项：
- All repositories（适用于组织内的所有代码仓库）
- Only select repositories（仅选择特定代码仓库）
我们建议选择 “Only select repositories”，并将应用的访问范围限制为存放你文档的那些仓库。
完成安装
- 点击 Install。
- 记录 URL 中的 installation ID。例如，在
https://your-github-server.com/settings/installations/12345中，字符串12345就是 installation ID。
返回应用设置
- 返回你的应用设置页面。
- 向下滚动到 Webhook 部分。
设置 webhook URL
按如下方式配置：
- Webhook URL：
https://leaves.mintlify.com/github-enterprise/:subdomain（将:subdomain替换为我们提供给你的 URL） - Webhook secret： 生成一个随机字符串（32 个以上字符）并妥善保存。Mintlify 也可以为你生成并提供此密钥。
请通过你选择的安全信息传输方式，将以下信息提供给我们的团队。
- GitHub Enterprise Server 基础 URL：https://your-github-server.com
- App ID：（来自步骤 3）
- 应用客户端 ID：（来自步骤 3）
- 应用客户端密钥：（来自步骤 3）
- Installation ID：（来自步骤 4）
- Installation owner：拥有该应用安装的 GitHub 组织名称
- 私钥：
.pem文件的全部内容（请通过安全文件传输方式传递） - Webhook 密钥：（来自步骤 5）
- 仓库名称：你安装该应用的具体仓库
- GitHub Enterprise Server 版本：可在站点管理后台中查看
我们会使用你提供的凭据，并将其加密后安全存储起来。然后我们会与你协作，采用以下两种方式之一：
- 将你的 GHES 环境与现有的 Mintlify 部署集成。
- 将你的 GHES 环境与我们为你准备的新 Mintlify 部署集成。
当你的 GHES 环境与某个 Mintlify 部署完成集成后，你就可以为 GitHub App 启用 webhook 了。
根据我们的配置，webhook 的 URL 可能会发生变化。我们会测试集成，并向你提供新的 URL。
验证 webhook 投递
- 前往 GitHub 应用的设置页面。
- 点击 Advanced 选项卡。
- 在 “Recent Deliveries” 中检查 webhook 是否成功投递。
- 查找 HTTP 200 响应。
测试仓库访问
- 在已安装的仓库中创建一个测试 issue 或 pull request。
- 确认 Mintlify 的响应是否符合预期。