Configuring rate limits

About rate limits for GitHub Enterprise Server

To prevent excessive use of resources on 你的 GitHub Enterprise Server 实例 that could affect the instance's availability or performance for all users, you can configure rate limits. Rate limits are configurable for the GitHub Enterprise Server APIs and GitHub Actions.

Implement rate limits carefully and communicate frequently with your users as you tune the limits. To avoid interrupting your users' work, GitHub recommends that you start with permissive rate limits, and gradually tune the limits to suit your environment.

You can also configure rate limits for authentication attempts to the 管理控制台. For more information, see "管理对管理控制台的访问."

Enabling rate limits for the GitHub Enterprise Server APIs

Excessive numbers of requests to the GitHub Enterprise Server APIs can affect the availability and performance of your instance. For more information about how rate limits for the API affect your users, see "REST API 的速率限制."

You can exempt a list of users from API rate limits using the ghe-config utility in the administrative shell. For more information, see "命令行实用程序."

Note: The 管理控制台 lists the time period (per minute or per hour) for each rate limit.

在 GitHub Enterprise Server 上的管理帐户中，在任一页面的右上角，单击。
如果你尚未在“站点管理员”页上，请在左上角单击“站点管理员”。
在“ 站点管理”边栏中，单击“管理控制台”。
Under "Rate Limiting", select Enable HTTP API Rate Limiting.
Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits.
在“设置”边栏下，单击“保存设置”。

注意：保存管理控制台中的设置会重启系统服务，这可能会导致用户可察觉的停机时间。
等待配置运行完毕。

Enabling secondary rate limits

Setting secondary rate limits protects the overall level of service on 你的 GitHub Enterprise Server 实例.

在 GitHub Enterprise Server 上的管理帐户中，在任一页面的右上角，单击。
如果你尚未在“站点管理员”页上，请在左上角单击“站点管理员”。
在“ 站点管理”边栏中，单击“管理控制台”。
Under "Rate Limiting", select Enable Secondary Rate Limiting.
Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits.
在“设置”边栏下，单击“保存设置”。

注意：保存管理控制台中的设置会重启系统服务，这可能会导致用户可察觉的停机时间。
等待配置运行完毕。

Enabling rate limits for Git

If a member of GitHub's staff has recommended it, you can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load.

Warning: We encourage you to leave this setting disabled unless directly recommended by a member of GitHub's staff. Git operations are rarely the leading driver of CPU and RAM usage. Enabling this feature can make Git operations more likely to fail under high load conditions but does not address the underlying cause of those conditions.

在 GitHub Enterprise Server 上的管理帐户中，在任一页面的右上角，单击。
如果你尚未在“站点管理员”页上，请在左上角单击“站点管理员”。
在“ 站点管理”边栏中，单击“管理控制台”。
Under "Rate Limiting", select Enable Git Rate Limiting.
Under "Repository Network Limit", type a limit for each repository network.
Under "User ID Limit", type a limit for each user ID.
在“设置”边栏下，单击“保存设置”。

注意：保存管理控制台中的设置会重启系统服务，这可能会导致用户可察觉的停机时间。
等待配置运行完毕。

Configuring rate limits for GitHub Actions

You can apply a rate limit to GitHub Actions workflow runs. For more information about GitHub Actions, see "About GitHub Actions for enterprises."

About rate limits for GitHub Actions

Your GitHub Enterprise Server instance assigns each GitHub Actions workflow job to a runner. If your instance cannot immediately assign a job to an available runner, the job will wait in a queue until a runner is available. If GitHub Actions experiences sustained high load, the queue can back up, and the performance of 你的 GitHub Enterprise Server 实例 may degrade.

To avoid this performance degradation, you can configure a rate limit for GitHub Actions. This rate limit is expressed in job runs per minute. GitHub Enterprise Server calculates and applies the rate limit for the sum total of all job runs on the instance. If runs exceed the rate limit, additional runs will fail instead of entering the queue. The following error will appear in the run's annotations.

You've exceeded the rate limit for workflow run requests. Please wait before retrying the run.

An appropriate rate limit protects 你的 GitHub Enterprise Server 实例 from abnormal usage of GitHub Actions without interfering with day-to-day operations. The exact threshold depends on your instance's available resources and overall load profile. For more information about the hardware requirements for GitHub Actions, see "Getting started with GitHub Actions for GitHub Enterprise Server."

By default, the rate limit for GitHub Actions is disabled. Because GitHub Enterprise Server can handle temporary spikes in usage without performance degradation, this rate limit is intended to protect against sustained high load. We recommend leaving the rate limit disabled unless you are experiencing performance problems. In some cases, GitHub 支持 may recommend that you enable a rate limit for GitHub Actions.

Enabling or disabling rate limits for GitHub Actions

通过 SSH 连接到你的 GitHub Enterprise Server 实例。如果实例包含多个节点，例如，如果配置了高可用性或异地复制，则通过 SSH 连接到主节点。如果使用群集，则可以通过 SSH 连接到任何节点。将 HOSTNAME 替换为实例的主机名，或节点的主机名或 IP 地址。有关详细信息，请参阅“访问管理 shell (SSH)”。
Shell
```
ssh -p 122 admin@HOSTNAME
```
```
ssh -p 122 admin@HOSTNAME
```
To enable and configure the rate limit, run the following two commands, replacing RUNS-PER-MINUTE with the value of your choice.
```
ghe-config actions-rate-limiting.enabled true
ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE
```
To disable the rate limit after it's been enabled, run the following command.
```
ghe-config actions-rate-limiting.enabled false
```
To apply the configuration, run the following command.
```
ghe-config-apply
```
Wait for the configuration run to complete.