GitHub 集成

本指南将向您展示如何在 Coolify 中使用基于 GitHub 的仓库。

公共仓库

您可以直接使用公共仓库，无需任何额外设置。

1. 在 Coolify 创建新资源时，选择 公共仓库 选项。
2. 在输入框中添加您的仓库 URL，例如：https://github.com/coollabsio/coolify-examples

注意

您只能使用 https URL。

3. 完成！Coolify 将自动拉取您仓库的最新版本并部署它。

私有仓库

使用 GitHub App（推荐）

您可以通过 GitHub App 集成使用私有仓库。您将获得与 GitHub 的完全集成，例如自动提交部署和拉取请求部署。

1. 在 Sources 视图中创建一个新的 GitHub App。
2. 创建一个新资源并选择 私有仓库（使用 GitHub App）。
3. 从列表中选择您的仓库。
4. 完成！

使用部署密钥

1. 添加一个私钥（也称为 部署密钥）到 Coolify 以及您 GitHub 仓库的 设置 / 部署密钥 菜单中。

注意

• 您可以使用以下命令生成新的密钥对：

ssh-keygen -t rsa -b 4096 -C "deploy_key"

• 或者您也可以在 Coolify 的 密钥与令牌 菜单中生成一个新密钥。

2. 创建一个新资源并选择 私有仓库（使用部署密钥）
3. 在输入框中添加您的仓库 URL，例如：git@github.com:coollabsio/coolify-examples.git

注意

您需要使用 SSH URL，即以 git@ 开头的 URL。

4. 完成！

使用 webhook 自动部署提交（可选）

您可以向 GitHub 仓库添加自定义 webhook URL，以便在您推送代码到仓库时触发新的部署。

注意

这可以设置在公共或私有仓库上。

如果您使用 GitHub App 集成，则不需要此步骤。

在您的资源中，有一个 Webhooks 菜单。在 手动 Git Webhooks 部分，您可以找到需要在 GitHub 仓库中设置的 URL。

1. 在 GitHub Webhook Secret 输入框中设置一个密钥。

2. 转到 GitHub 上的仓库，打开 设置 / Webhooks 菜单。

3. 将 Coolify 中的 URL 添加到 URL 输入框，并输入密钥。
4. 选择 Push 事件 选项。

5. 完成！现在当您推送到仓库时，GitHub 将向 Coolify 发送 webhook 请求，并触发新的部署。

使用 webhook 进行拉取请求部署（可选）

您可以向 GitHub 仓库添加自定义 webhook URL，以便在创建新的拉取请求时触发新的部署。

注意

这可以设置在公共或私有仓库上。

如果您使用 GitHub App 集成，则不需要此步骤。

过程与前一个相同，但您需要在 设置 / Webhooks 菜单中选择 Pull Request 事件选项。