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

# Configure a GitHub App Installation

> Set up a GitHub App for data collection with higher rate limits.

<img noZoom src="https://mintcdn.com/specterops/tTIczgde9H07oLXf/assets/enterprise-AND-community-edition-pill-tag.svg?fit=max&auto=format&n=tTIczgde9H07oLXf&q=85&s=ad49a576589f4d2a8081df77d07fdf56" alt="Applies to BloodHound Enterprise and CE" width="482" height="45" data-path="assets/enterprise-AND-community-edition-pill-tag.svg" />

GitHub App installations provide a higher API rate limit of **15,000 requests per hour** compared to **5,000** for Personal Access Tokens(PATs).

<Note>This is the recommended authentication method for organizations with 500+ repositories.</Note>

## Install a GitHub App

Follow the steps below to create and configure your own GitHub App.

<Steps>
  <Step title="Navigate to GitHub Apps">
    Navigate to your **Organization Settings** > **Developer settings** > **GitHub Apps**.
  </Step>

  <Step title="Click New GitHub App">
    Click the **New GitHub App** button
  </Step>

  <Step title="Configure the app">
    Configure the app with the following settings:

    * **GitHub App name**: Choose a unique name (e.g., `YourOrg-OpenHound`)
    * **Homepage URL**: Your organization's URL
    * **Webhook**: Uncheck "Active" (not needed for collection)

    Set all required [repository and organization permissions](/openhound/collectors/github/collect-data#required-permissions) to **Read-only**.
    Under "Where can this GitHub App be installed?", select **Only on this account**.
  </Step>

  <Step title="Create the app">
    Click **Create GitHub App** to create the app with the specified settings and permissions.
  </Step>

  <Step title="Generate a private key">
    Scroll down and click **Generate a private key** - save the downloaded `.pem` file securely. Note the **App ID** and **Client ID** displayed on the app settings page.
  </Step>

  <Step title="Install the app">
    Click **Install App** in the left sidebar to install the app to your organization.
  </Step>
</Steps>

## Get the Installation Details

1. Navigate to your **Organization Settings** > **Third-party Access** > **GitHub Apps**.
2. Find the app you just created and click **Configure**.
3. The numeric value in the URL is the **App Installation ID**.
4. Click **App settings** to access the **Client ID** and **App ID**.

## Security Considerations

* Store the `.pem` private key securely and never commit it to version control.
* Rotate keys periodically and revoke old ones.
* Only install the app on organizations that require collection.
* Periodically verify the app has only the minimum required permissions.

## Next Steps

After installing and configuring the GitHub App, proceed to [configure the collector](/openhound/collectors/github/collect-data) to start collection.
