Note: GitHub-hosted runners are not currently supported on GitHub Enterprise Server. You can see more information about planned future support on the GitHub public roadmap.
About GitHub Actions on GitHub Enterprise Server
This article explains how site administrators can configure GitHub Enterprise Server to use GitHub Actions.
GitHub Actions is available in GitHub Enterprise Server 3.0 or higher. If you're using an earlier version of GitHub Enterprise Server, you'll have to upgrade to use GitHub Actions. For more information about upgrading your GitHub Enterprise Server instance, see "About upgrades to new releases."
GitHub Actions is not enabled for GitHub Enterprise Server by default. You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from GitHub Actions without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts generated by workflow runs. Then, you'll enable GitHub Actions for your enterprise, manage access permissions, and add self-hosted runners to run workflows.
Before you get started, you should make a plan for how you'll introduce GitHub Actions to your enterprise. For more information, see "Introducing GitHub Actions to your enterprise."
If you're migrating your enterprise to GitHub Actions from another provider, there are additional considerations. For more information, see "Migrating your enterprise to GitHub Actions."
Review hardware requirements
Note: If you're upgrading an existing GitHub Enterprise Server instance to 3.0 or later and want to configure GitHub Actions, note that the minimum hardware requirements have increased. For more information, see "Upgrading GitHub Enterprise Server."
The CPU and memory resources available to your GitHub Enterprise Server instance determine the maximum job throughput for GitHub Actions. GitHub recommends a minimum of 8 vCPU and 64 GB memory to run GitHub Actions.
Internal testing at GitHub demonstrated the following maximum throughput for GitHub Enterprise Server instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance.
| vCPUs | Memory | Maximum job throughput |
|---|---|---|
| 4 | 32 GB | Demo or light testing |
| 8 | 64 GB | 25 jobs |
| 16 | 160 GB | 35 jobs |
| 32 | 256 GB | 100 jobs |
If you plan to enable GitHub Actions for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of GitHub Enterprise Server, see "Monitoring your appliance."
For more information about minimum hardware requirements for your GitHub Enterprise Server instance, see the hardware considerations for your instance's platform.
For more information about adjusting resources for an existing instance, see "Increasing storage capacity" and "Increasing CPU or memory resources."
External storage requirements
To enable GitHub Actions on GitHub Enterprise Server, you must have access to external blob storage.
GitHub Actions uses blob storage to store artifacts generated by workflow runs, such as workflow logs and user-uploaded build artifacts. The amount of storage required depends on your usage of GitHub Actions. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time.
GitHub Actions supports these storage providers:
- Azure Blob storage
- Amazon S3
- S3-compatible MinIO Gateway for NAS
Note: These are the only storage providers that GitHub supports and can provide assistance with. Other S3 API-compatible storage providers are unlikely to work due to differences from the S3 API. Contact us to request support for additional storage providers.
Before you enable GitHub Actions, you can test your storage configuration from the administrative shell with the ghe-actions-precheck utility. For more information, see "Command-line utilities" and "Accessing the administrative shell (SSH)."
Networking considerations
If GitHub Actions is enabled for your enterprise, only HTTP proxies are supported. SOCK5 and HTTPS proxies and Polipo are not supported. For more information about using a proxy with GitHub Enterprise Server, see "Configuring an outbound web proxy server."
Enabling GitHub Actions with your storage provider
Follow one of the procedures below to enable GitHub Actions with your chosen storage provider:
- Enabling GitHub Actions with Azure Blob storage
- Enabling GitHub Actions with Amazon S3 storage
- Enabling GitHub Actions with MinIO Gateway for NAS storage
Managing access permissions for GitHub Actions in your enterprise
You can use policies to manage access to GitHub Actions. For more information, see "Enforcing GitHub Actions policies for your enterprise."
Adding self-hosted runners
Note: GitHub-hosted runners are not currently supported on GitHub Enterprise Server. You can see more information about planned future support on the GitHub public roadmap.
To run GitHub Actions workflows, you need to add self-hosted runners. You can add self-hosted runners at the enterprise, organization, or repository levels. For more information, see "Adding self-hosted runners."
Managing which actions can be used in your enterprise
You can control which actions your users are allowed to use in your enterprise. This includes setting up GitHub Connect for automatic access to actions from GitHub.com, or manually syncing actions from GitHub.com.
For more information, see "About using actions in your enterprise."
General security hardening for GitHub Actions
If you want to learn more about security practices for GitHub Actions, see "Security hardening for GitHub Actions."
Reserved Names
When you enable GitHub Actions for your enterprise, two organizations are created: github and actions. If your enterprise already uses the github organization name, github-org (or github-github-org if github-org is also in use) will be used instead. If your enterprise already uses the actions organization name, github-actions (or github-actions-org if github-actions is also in use) will be used instead. Once actions is enabled, you won't be able to use these names anymore.