添加自托管的运行器

您可以将自托管的运行器添加到 GitHub Actions。

注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。

您可以将自托管的运行器添加到 GitHub Actions。

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

如果需要支持自托管运行器的操作系统的信息,或通过代理服务器的自托管运行器,请参阅“关于自托管运行器”。

警告: 建议仅将自托管运行器用于私有仓库。 这是因为,通过创建在工作流程中执行代码的拉取请求,仓库的复刻可能会在您的自托管运行器上运行危险代码。

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

添加自托管的运行器到仓库

您可以将自托管的运行器添加到单个仓库中。 要将自托管的运行器添加到用户仓库,您必须是仓库所有者。 对于组织仓库,您必须是组织所有者或拥有该仓库管理员的权限。

  1. 在 GitHub Enterprise Server 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Settings(设置)仓库设置按钮

  3. 在左侧边栏中,在左侧栏中,单击 Actions,然后单击 Runners(运行器)

  4. 在 “Runners(运行器)”下,单击 Add runner(添加运行器)

  5. Select the operating system image and architecture of your self-hosted runner machine.

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

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

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

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

    • 下载并提取自托管运行器应用程序。
    • 运行 config 脚本配置自托管运行器应用程序,并向 GitHub Actions 注册。 config 脚本需要目标 URL 和自动生成的时间限制令牌来验证请求。
      • 在 Windows上,config 脚本还会询问您是否想将自托管运行器应用程序安装为服务。 对于 Linux 和 macOS,您可以在完成添加运行器后安装服务。 更多信息请参阅“将自托管运行器应用程序配置为服务”。
    • 运行自托管运行器应用程序以将机器连接到 GitHub Actions。

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

After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".

必须激活自托管运行器应用程序,运行器才能接受作业。 当运行器应用程序连接到 GitHub Enterprise Server 并准备接收作业时,您将在机器的终端上看到以下消息。

√ 已连接到 GitHub

2019-10-24 05:45:56Z: 正在监听作业

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

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

您可以在组织级别添加自托管的运行器,其中它们可被用于处理组织中的多个仓库的作业。 要将自托管的运行器添加到组织,您必须是组织所有者。

  1. 在 GitHub Enterprise Server 上,导航到组织的主页面。

  2. 在组织名称下,单击 Settings.

    组织设置按钮

  3. 在左侧边栏中,在左侧栏中,单击 Actions,然后单击 Runners(运行器)

  4. 在 “Runners(运行器)”下,单击 Add runner(添加运行器)

  5. Select the operating system image and architecture of your self-hosted runner machine.

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

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

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

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

    • 下载并提取自托管运行器应用程序。
    • 运行 config 脚本配置自托管运行器应用程序,并向 GitHub Actions 注册。 config 脚本需要目标 URL 和自动生成的时间限制令牌来验证请求。
      • 在 Windows上,config 脚本还会询问您是否想将自托管运行器应用程序安装为服务。 对于 Linux 和 macOS,您可以在完成添加运行器后安装服务。 更多信息请参阅“将自托管运行器应用程序配置为服务”。
    • 运行自托管运行器应用程序以将机器连接到 GitHub Actions。

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

After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".

必须激活自托管运行器应用程序,运行器才能接受作业。 当运行器应用程序连接到 GitHub Enterprise Server 并准备接收作业时,您将在机器的终端上看到以下消息。

√ 已连接到 GitHub

2019-10-24 05:45:56Z: 正在监听作业

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

注意:出于安全原因,公共仓库默认不能在运行器组中使用运行器,但您可以在运行器组的设置中覆盖此项。 更多信息请参阅“使用组管理对自托管运行器的访问”。

添加自托管运行器到企业

您可以将自托管运行器添加到企业,在该企业中可以将它们分配给多个组织。 然后,组织管理员能够控制哪些仓库可以使用它。

新运行器被分配到默认组。 您可以在注册运行器后修改运行器组。 更多信息请参阅“管理对自托管运行器的访问”。

要在 您的 GitHub Enterprise Server 实例 的企业级删除自托管运行器,您必须是网站管理员。

  1. 在 GitHub Enterprise Server 的右上角,单击您的个人资料照片,然后单击 Enterprise settings(Enterprise 设置)GitHub Enterprise Server 上个人资料照片下拉菜单中的"Enterprise settings(企业设置)"

  2. 在企业账户侧边栏中,单击 Policies(政策)企业帐户侧边栏中的 Policies(政策)选项卡

  3. 在“ Policies(政策)”下,单击 Actions(操作)

  4. 单击 Runners 选项卡。

  5. 单击 Add new(新增),然后单击 New runner(新运行器)

  6. Select the operating system image and architecture of your self-hosted runner machine.

  7. 您将看到指示您如何下载运行器应用程序并安装到自托管运行器机器上的说明。

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

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

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

    • 下载并提取自托管运行器应用程序。
    • 运行 config 脚本配置自托管运行器应用程序,并向 GitHub Actions 注册。 config 脚本需要目标 URL 和自动生成的时间限制令牌来验证请求。
      • 在 Windows上,config 脚本还会询问您是否想将自托管运行器应用程序安装为服务。 对于 Linux 和 macOS,您可以在完成添加运行器后安装服务。 更多信息请参阅“将自托管运行器应用程序配置为服务”。
    • 运行自托管运行器应用程序以将机器连接到 GitHub Actions。

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

After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".

必须激活自托管运行器应用程序,运行器才能接受作业。 当运行器应用程序连接到 GitHub Enterprise Server 并准备接收作业时,您将在机器的终端上看到以下消息。

√ 已连接到 GitHub

2019-10-24 05:45:56Z: 正在监听作业

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

注意:出于安全原因,公共仓库默认不能在运行器组中使用运行器,但您可以在运行器组的设置中覆盖此项。 更多信息请参阅“使用组管理对自托管运行器的访问”。

让企业运行器可用于仓库

在默认情况下,企业的“默认”自托管运行器组的运行器可用于企业中的所有组织,但不可用于每个组织中的所有仓库。

要让企业级自托管运行器组可用于组织仓库,您可能需要更改组织对运行器组的继承设置,使运行器可用于组织中的仓库。

有关更改运行器组访问设置的更多信息,请参阅“使用组管理对自托管运行器的访问”。

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。