> ## Documentation Index
> Fetch the complete documentation index at: https://docs.entire.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub IP Allow Lists

> Let Entire reach a GitHub organization that restricts access with an IP allow list.

If your GitHub organization or enterprise has an IP allow list, GitHub refuses requests that do not come from an address on the list. This includes requests from the Entire GitHub App. Until you allow Entire's addresses, Entire cannot read your repositories through the GitHub App.

This means:

* mirrors cannot be created, and existing mirrors stop syncing new pushes
* repository and checkpoint activity stops updating in entire.com

> [!NOTE]
>
> IP allow lists are a GitHub Enterprise Cloud feature. If your organization does not have one, you do not need this page.

## Allow the Entire GitHub App

The Entire GitHub App declares the addresses Entire connects from. Select **Enable IP allow list configuration for installed GitHub Apps** in your GitHub settings to add them to your allow list. GitHub then keeps them in sync when Entire changes them.

> [tab] Organization
>
> An organization owner makes this change.
>
> **1. Open Organization Settings**
>
> On GitHub, open your organization and click **Settings**.
>
> **2. Open Authentication Security**
>
> In the "Security" section of the sidebar, click **Authentication security**.
>
> **3. Allow Installed GitHub Apps**
>
> Under "IP allow list", select **Enable IP allow list configuration for installed GitHub Apps**.
>
> **4. Save**
>
> Click **Save**.

> [tab] Enterprise
>
> If your enterprise manages the allow list, an enterprise owner makes this change.
>
> **1. Open Enterprise Settings**
>
> On GitHub, open your enterprise from the [Enterprises](https://github.com/settings/enterprises) page and click **Settings**.
>
> **2. Open Authentication Security**
>
> Under **Settings**, click **Authentication security**.
>
> **3. Allow Installed GitHub Apps**
>
> Under "IP allow list", select **Enable IP allow list configuration for installed GitHub Apps**.
>
> **4. Save**
>
> Click **Save**.
>
> > [!NOTE]
> >
> > With Enterprise Managed Users and OIDC, this setting is available only when **IP allow list configuration** is set to **GitHub**. If your enterprise uses your identity provider's allow list instead, GitHub does not apply it to the Entire GitHub App's own requests, so mirrors keep syncing. Requests made with your own GitHub sign-in are still checked. To allow them, add [Entire's addresses](#egress-ip-addresses) to your identity provider's policy, or select **Skip IdP check for applications** in the enterprise's **Authentication security** settings.

After you save, your allow list shows Entire's addresses with the description **Managed by the Entire GitHub App**. You cannot edit or delete these entries; they follow the Entire GitHub App's settings. Changes usually take a few minutes to take effect.

When the addresses are allowed, the next push to the GitHub repository syncs the mirror again. Mirror access for your organization's collaborators can take up to a day to catch up.

## Egress IP Addresses

Entire publishes the addresses it connects to GitHub from at [`https://entire.com/api/v1/meta`](https://entire.com/api/v1/meta). Use them if you cannot turn on the GitHub App setting, for example to add them to your allow list by hand or to a firewall rule.

The `egress` field lists every address in CIDR notation, and `updated` is the date the list last changed. To print every address:

```bash theme={null}
curl -s https://entire.com/api/v1/meta | jq -r '.egress[]'
```

The `egress_by_region` field lists the same addresses grouped by AWS region:

```bash theme={null}
curl -s https://entire.com/api/v1/meta | jq -r '.egress_by_region | to_entries[] | "\(.key): \(.value | join(", "))"'
```

Allow every address, not only the region where your repositories are hosted. Entire can reach GitHub from any of them.

> [!WARNING]
>
> If you add the addresses by hand, your list does not update when Entire's addresses change. Check `updated` in `https://entire.com/api/v1/meta`, or use the GitHub App setting so GitHub tracks the changes for you.

## What This Covers

Entire's addresses cover the requests Entire makes as the installed Entire GitHub App, such as:

* requesting installation access tokens for the Entire GitHub App
* fetching from your repositories to create and sync mirrors
* reading repository collaborators to keep mirror access in sync with GitHub

The GitHub App setting does not cover actions that use your own GitHub sign-in, such as listing your GitHub App installations or merging a trail into a GitHub branch. GitHub checks these against your allow list as requests from you.

If GitHub refuses one of these actions, add [Entire's addresses](#egress-ip-addresses) to your allow list by hand. If it is still refused, contact [support](mailto:support@entire.io) and include your organization name.

## Verify Access

1. In your organization's **Authentication security** settings, under "IP allow list", confirm that the list shows entries with the description **Managed by the Entire GitHub App**.
2. Under "Check IP address", enter one of the addresses from `https://entire.com/api/v1/meta`, without the `/32` suffix, and confirm that GitHub allows it.
3. Push a commit to a mirrored repository and confirm that the mirror updates in entire.com.

If the mirror still does not update, see [Troubleshooting](https://docs.entire.com/guides/repositories/troubleshooting.md).

## Continue With

> [card] [Install the Entire GitHub App](https://docs.entire.com/guides/repositories/github-app-access.md)
>
> Choose which repositories Entire can access.

> [card] [Mirrors](https://docs.entire.com/guides/repositories/mirrors.md)
>
> Create and use repository mirrors.
