您可以将自托管运行器添加到存储库、组织或企业。
如果您是组织或企业管理员,您可能希望在组织或企业级别添加自托管运行器。这种方法使运行器可用于组织或企业中的多个存储库,还可以让您在一个地方管理运行器。
有关自托管运行器支持的操作系统或使用自托管运行器与代理服务器的信息,请参阅“关于自托管运行器”。
警告
我们建议您仅将自托管运行器与私有存储库一起使用。这是因为您的公共存储库的分支可以通过创建执行工作流中代码的拉取请求,从而可能在您的自托管运行器机器上运行危险代码。
有关更多信息,请参阅“关于自托管运行器”。
您可以设置自动化以扩展自托管运行器的数量。有关更多信息,请参阅“自托管运行器的自动缩放”。
您可以注册临时运行器,这些运行器在注册被清理之前执行单个作业,方法是使用即时运行器注册。有关更多信息,请参阅“GitHub Actions 的安全加固”。
先决条件
- 您必须可以访问您将在环境中用作自托管运行器的机器。
将自托管运行器添加到存储库
您可以将自托管运行器添加到单个存储库。要将自托管运行器添加到用户存储库,您必须是存储库所有者。对于组织存储库,您必须是组织所有者或对存储库具有管理员访问权限。
有关如何使用 REST API 添加自托管运行器的信息,请参阅“自托管运行器的 REST API 端点”。
-
在 GitHub 上,导航到仓库的主页。
-
在您的仓库名称下,单击 设置。如果您看不到“设置”选项卡,请选择下拉菜单,然后单击设置。
-
在左侧边栏中,单击 Actions,然后单击运行器。
-
单击新建自托管运行器。
-
选择自托管运行器机器的操作系统镜像和架构。
-
您将看到说明,指导您如何在自托管运行器机器上下载运行器应用程序并进行安装。
在您的自托管运行器机器上打开一个 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 端点”。
-
在 GitHub 上,导航到组织的主页。
-
在您的组织名称下,单击 设置。如果您看不到“设置”选项卡,请选择下拉菜单,然后单击设置。
-
在左侧边栏中,单击 Actions,然后单击运行器。
-
单击新建运行器,然后单击新建自托管运行器。
-
选择自托管运行器机器的操作系统镜像和架构。
-
您将看到说明,指导您如何在自托管运行器机器上下载运行器应用程序并进行安装。
在您的自托管运行器机器上打开一个 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 文档。