添加自托管运行器

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

本文内容

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

如果您是组织或企业管理员，您可能希望在组织或企业级别添加您的自托管运行器。这种方法使运行器可用于组织或企业中的多个代码库，并允许您在一个地方管理运行器。

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

警告

我们建议您仅将自托管运行器与私有代码库一起使用。这是因为您的公共代码库的分支可以通过创建一个执行工作流中代码的拉取请求，从而有可能在您的自托管运行器机器上运行危险的代码。

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

您可以设置自动化来扩展自托管运行器的数量。更多信息，请参阅“自托管运行器的自动缩放”。

您可以注册临时运行器，这些运行器在注册被清理之前执行单个作业，方法是使用即时运行器注册。更多信息，请参阅“GitHub Actions 的安全加固”。

先决条件

  • 您必须可以访问您将在环境中用作自托管运行器的机器。

向代码库添加自托管运行器

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

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

注意

组织所有者可以选择允许哪些代码库创建代码库级别的自托管运行器。

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

  1. 在 GitHub 上，导航到代码库的主页。

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

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

  3. 在左侧边栏中，单击 Actions，然后单击运行器。

  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 上，导航到组织的主页。

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

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

  3. 在左侧边栏中，单击 Actions，然后单击运行器。

  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 文档。