先决条件
在添加自托管运行器之前,您应了解它们的概念和工作原理。请参阅 自托管运行器。
此外,您必须满足以下要求
- 您必须能够访问将在环境中用作自托管运行器的机器。
将自托管运行器添加到仓库
您可以向单个仓库添加自托管运行器。要向用户仓库添加自托管运行器,您必须是仓库所有者。对组织仓库而言,您必须是组织所有者或拥有该仓库的管理员权限。
有关如何使用 REST API 添加自托管运行器的信息,请参阅 自托管运行器的 REST API 端点。
-
在 GitHub 上,导航至仓库的主页面。
-
在您的仓库名称下,点击 设置。如果看不到“设置”标签,请选择 下拉菜单,然后单击 设置。

-
在左侧侧栏,点击 操作,然后点击 运行器。
-
点击 新建自托管运行器。
-
选择自托管运行器机器的操作系统映像和架构。

-
您将看到指示,告诉您如何下载运行器应用程序并将其安装到自托管运行器机器上。
在自托管运行器机器上打开终端,并按示例顺序运行每条 shell 命令。
注意
在 Windows 上,如果您希望将自托管运行器应用程序安装为服务,必须以管理员权限打开终端。我们也建议您使用
C:\actions-runner作为自托管运行器应用程序的目录,以便 Windows 系统账户能够访问运行器目录。这些说明将指导您完成以下任务
- 下载并解压自托管运行器应用程序。
- 运行
config脚本以配置自托管运行器应用程序并向 GitHub Actions 注册。config脚本需要目标 URL 和一个自动生成的、有限时效的令牌来对请求进行身份验证。该令牌在一小时后过期。- 在 Windows 上,
config脚本还会询问您是否希望将自托管运行器应用程序安装为服务。对于 Linux 和 macOS,您可以在完成添加运行器后再安装服务。欲了解更多信息,请参阅 将自托管运行器应用程序配置为服务。
- 在 Windows 上,
- 运行自托管运行器应用程序,将机器连接到 GitHub Actions。
检查您的自托管运行器是否已成功添加
完成添加自托管运行器的步骤后,运行器及其状态将显示在 “运行器” 列表中。
自托管运行器应用程序必须保持激活状态,运行器才能接受作业。当运行器应用程序已连接到 GitHub 并准备好接受作业时,您将在机器的终端上看到如下信息。
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
欲了解更多信息,请参阅 监控和排查自托管运行器。
将自托管运行器添加到组织
您可以在组织层面添加自托管运行器,随后它们可用于处理组织中多个仓库的作业。要向组织添加自托管运行器,您必须是组织所有者。有关如何使用 REST API 添加自托管运行器的信息,请参阅 自托管运行器的 REST API 端点。
-
在 GitHub 上,前往该组织的首页。
-
在您的组织名称下,点击 设置。如果看不到“设置”标签,请选择 下拉菜单,然后单击 设置。

-
在左侧侧栏,点击 操作,然后点击 运行器。
-
点击 新建运行器,然后点击 新建自托管运行器。
-
选择自托管运行器机器的操作系统映像和架构。

-
您将看到指示,告诉您如何下载运行器应用程序并将其安装到自托管运行器机器上。
在自托管运行器机器上打开终端,并按示例顺序运行每条 shell 命令。
注意
在 Windows 上,如果您希望将自托管运行器应用程序安装为服务,必须以管理员权限打开终端。我们也建议您使用
C:\actions-runner作为自托管运行器应用程序的目录,以便 Windows 系统账户能够访问运行器目录。这些说明将指导您完成以下任务
- 下载并解压自托管运行器应用程序。
- 运行
config脚本以配置自托管运行器应用程序并向 GitHub Actions 注册。config脚本需要目标 URL 和一个自动生成的、有限时效的令牌来对请求进行身份验证。该令牌在一小时后过期。- 在 Windows 上,
config脚本还会询问您是否希望将自托管运行器应用程序安装为服务。对于 Linux 和 macOS,您可以在完成添加运行器后再安装服务。欲了解更多信息,请参阅 将自托管运行器应用程序配置为服务。
- 在 Windows 上,
- 运行自托管运行器应用程序,将机器连接到 GitHub Actions。
检查您的自托管运行器是否已成功添加
完成添加自托管运行器的步骤后,运行器及其状态将显示在 “运行器” 列表中。
自托管运行器应用程序必须保持激活状态,运行器才能接受作业。当运行器应用程序已连接到 GitHub 并准备好接受作业时,您将在机器的终端上看到如下信息。
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
欲了解更多信息,请参阅 监控和排查自托管运行器。
注意
出于安全原因,公共仓库默认无法使用运行器组中的运行器,但您可以在运行器组的设置中覆盖此限制。更多信息请参阅 使用组管理自托管运行器的访问。
将自托管运行器添加到企业
如果您使用 GitHub Enterprise Cloud,您可以将自托管运行器添加到企业中,并可将其分配给多个组织。组织所有者可以控制哪些仓库可以使用该运行器。更多信息请参阅 GitHub Enterprise Cloud 文档。
后续步骤
您可以设置自动化来扩展自托管运行器的数量。更多信息请参阅 自托管运行器参考。