添加自托管运行器

你可以向存储库、组织或企业添加自托管运行器。

本文内容

你可以向存储库、组织或企业添加自托管运行器。

如果你是组织或企业管理员，你可能希望在组织或企业级别添加自托管运行器。此方法使运行器可用于组织或企业中的多个存储库，还允许你在一个位置管理运行器。

有关自托管运行器支持的操作系统或使用代理服务器的自托管运行器的信息，请参阅“关于自托管运行器”。

警告：我们建议你仅将自托管运行器与私有存储库配合使用。这是因为公共存储库的分支可能通过创建在工作流中执行代码的拉取请求，在你的自托管运行器机器上运行危险代码。

有关更多信息，请参阅“关于自托管运行器”。

你可以设置自动化以扩展自托管运行器的数量。有关更多信息，请参阅“使用自托管运行器进行自动扩展”。

你可以注册临时运行器，这些运行器在注册通过即时运行器注册清理之前执行一项作业。有关更多信息，请参阅“GitHub 操作的安全强化”。

先决条件

  • 您必须能够访问您将在环境中用作自托管运行程序的机器。

将自托管运行程序添加到存储库

您可以将自托管运行程序添加到单个存储库。要将自托管运行程序添加到用户存储库，您必须是存储库所有者。对于组织存储库，您必须是组织所有者或拥有存储库的管理员访问权限。

有关如何使用 REST API 添加自托管运行程序的信息，请参阅“自托管运行程序的 REST API 端点”。

注意：组织所有者可以选择允许哪些存储库创建存储库级别的自托管运行程序。

有关更多信息，请参阅“禁用或限制组织的 GitHub Actions”。

  1. 在 GitHub.com 上，导航到存储库的主页。

  2. 在存储库名称下方，单击 设置。如果您看不到“设置”选项卡，请选择 下拉菜单，然后单击设置。

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. 在左侧边栏中，单击 操作，然后单击运行程序。

  4. 单击新建自托管运行程序。

  5. 选择自托管运行程序机器的操作系统映像和架构。

    Screenshot of the choice of operating system and architecture. These options are highlighted with a dark orange outline.

  6. 您将看到说明，显示如何下载运行程序应用程序并将其安装在自托管运行程序机器上。

    在自托管运行程序机器上打开一个 shell，并按显示的顺序运行每个 shell 命令。

    注意：在 Windows 上，如果你想将自托管运行器应用程序作为服务安装，你必须使用管理员权限打开一个 shell。我们还建议你使用 C:\actions-runner 作为自托管运行器应用程序的目录，以便 Windows 系统帐户可以访问运行器目录。

    这些说明将指导你完成以下任务

    • 下载并解压自托管运行器应用程序。
    • 运行 config 脚本以配置自托管运行器应用程序并将其注册到 GitHub Actions。config 脚本需要目标 URL 和自动生成的时限令牌来对请求进行身份验证。
      • 在 Windows 上，config 脚本还会询问你是否希望将自托管运行器应用程序作为服务安装。对于 Linux 和 macOS，你可以在完成添加运行器后安装服务。更多信息，请参阅“将自托管运行器应用程序配置为服务”。
    • 运行自托管运行器应用程序以将计算机连接到 GitHub Actions。

检查你的自托管运行器是否已成功添加

完成添加自托管运行器的步骤后，运行器及其状态现在将列在“运行器”下。

自托管运行器应用程序必须处于活动状态，运行器才能接受作业。当运行器应用程序连接到 GitHub 并准备接收作业时，你将在计算机的终端上看到以下消息。

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

更多信息，请参阅“监视和故障排除自托管运行器”。

将自托管运行器添加到组织

你可以在组织级别添加自托管运行器，在该级别，它们可用于处理组织中多个存储库的作业。要将自托管运行器添加到组织，你必须是组织所有者。有关如何使用 REST API 添加自托管运行器的信息，请参阅“自托管运行器的 REST API 端点”。

  1. 在 GitHub.com 上，导航到组织的主页。

  2. 在组织名称下，单击 设置。如果您看不到“设置”选项卡，请选择 下拉菜单，然后单击设置。

    Screenshot of the tabs in an organization's profile. The "Settings" tab is outlined in dark orange.

  3. 在左侧边栏中，单击 操作，然后单击运行程序。

  4. 单击新建运行器，然后单击新建自托管运行器。

  5. 选择自托管运行程序机器的操作系统映像和架构。

    Screenshot of the choice of operating system and architecture. These options are highlighted with a dark orange outline.

  6. 您将看到说明，显示如何下载运行程序应用程序并将其安装在自托管运行程序机器上。

    在自托管运行程序机器上打开一个 shell，并按显示的顺序运行每个 shell 命令。

    注意：在 Windows 上，如果你想将自托管运行器应用程序作为服务安装，你必须使用管理员权限打开一个 shell。我们还建议你使用 C:\actions-runner 作为自托管运行器应用程序的目录，以便 Windows 系统帐户可以访问运行器目录。

    这些说明将指导你完成以下任务

    • 下载并解压自托管运行器应用程序。
    • 运行 config 脚本以配置自托管运行器应用程序并将其注册到 GitHub Actions。config 脚本需要目标 URL 和自动生成的时限令牌来对请求进行身份验证。
      • 在 Windows 上，config 脚本还会询问你是否希望将自托管运行器应用程序作为服务安装。对于 Linux 和 macOS，你可以在完成添加运行器后安装服务。更多信息，请参阅“将自托管运行器应用程序配置为服务”。
    • 运行自托管运行器应用程序以将计算机连接到 GitHub Actions。

检查你的自托管运行器是否已成功添加

完成添加自托管运行器的步骤后，运行器及其状态现在将列在“运行器”下。

自托管运行器应用程序必须处于活动状态，运行器才能接受作业。当运行器应用程序连接到 GitHub 并准备接收作业时，你将在计算机的终端上看到以下消息。

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

更多信息，请参阅“监视和故障排除自托管运行器”。

注意：出于安全原因，默认情况下公共存储库无法使用运行器组中的运行器，但您可以在运行器组的设置中覆盖此设置。有关更多信息，请参阅“使用组管理对自托管运行器的访问”。

将自托管运行器添加到企业

如果您使用 GitHub Enterprise Cloud，则可以将自托管运行器添加到企业，在企业中可以将它们分配给多个组织。组织所有者可以控制哪些存储库可以使用它。有关更多信息，请参阅 GitHub Enterprise Cloud 文档。