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

# GitHub Radar connection

> Learn how to configure a GitHub Radar Connection for Infisical.

Infisical supports GitHub App installation for creating a GitHub Radar Connection.

> [!NOTE]
>
> GitHub Radar Connections are specifically configured for [Secret Scanning](https://infisical.com/docs/documentation/platform/secret-scanning/overview.md) and require specific permissions and webhook configuration.
>
> Check out our [GitHub Connection](https://infisical.com/docs/integrations/app-connections/github.md) for secret management features such as [Secret Syncs](https://infisical.com/docs/integrations/secret-syncs/overview).

> [accordion] Self-Hosted Instance
>
> Using a GitHub Radar Connection with app authentication on a self-hosted instance of Infisical requires configuring an application on GitHub
> and registering your instance with it.
>
> **1. Create an application on GitHub**
>
> Navigate to the GitHub App Settings [here](https://github.com/settings/apps). Click **New GitHub App**.
>
> > [!NOTE]
> >
> > If you have a GitHub organization, you can create an application under it
> > in your organization Settings > Developer settings > GitHub Apps > New GitHub App.
>
> ![create github radar app](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-1.png)
>
> Configure the following fields:
>
> 1. **Name** - give your app a name
> 2. **Homepage URL** - your self-hosted domain (i.e. `https://your-domain.com`)
> 3. **Callback URL** - the callback URL for your domain (i.e. `https://your-domain.com/organization/app-connections/github-radar/oauth/callback`)
> 4. **User Authorization** - enable request user authorization on app installation
>
>    ![github radar app details](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-2.png)
>
> Enable and configure the Webhook fields:
>
> * **Webhook URL** - the webhook URL for your domain (i.e. `https://your-domain.com/secret-scanning/webhooks/github`)
> * **Webhook Secret** - a strong, generated secret to verify webhook payloads
> * **SSL Verification** - enable SSL verification
>
>   ![github radar app webhook](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-3.png)
>
> Set the following repository permissions:
>
> * **Checks**: `Read and write`
> * **Contents**: `Read-only`
> * **Metadata**: `Read-only`
> * **Pull requests**: `Read-only`
>
> ![github radar app permissions 1](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-4.png)
>
> ![github radar app permissions 2](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-5.png)
>
> Subscribe to the following events:
>
> * **Check run**
> * **Check suite**
> * **Pull request**
> * **Push**
>
>   ![github radar app events](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-6.png)
>
> Create the GitHub application.
>
> ![github radar app complete](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-7.png)
>
> **2. Add your application credentials to Infisical**
>
> Generate a new **Client Secret** for your GitHub application.
>
> ![github radar app client secret](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-8.png)
>
> Generate a new **Private Key** for your GitHub application.
>
> > [!NOTE]
> >
> > You will need to copy the contents of the .pem file downloaded
>
> ![github radar app private key](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-9.png)
>
> Obtain the following credentials:
>
> 1. **Slug** - the slug of your application found in the URL
> 2. **App ID** - the ID of your application
> 3. **Client ID** - the client ID of your application
> 4. **Client Secret** - the client secret generated above
> 5. **Private Key** - the contents of the private key .pem file generated above
> 6. **Webhook Secret** - the secret generated in the previous step when configuring the webhook
>
>    ![github radar app credentials](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/self-hosted-github-radar-step-10.png)
>
> Back in your Infisical instance, add the six new environment variables for the credentials of your GitHub Radar application:
>
> * `INF_APP_CONNECTION_GITHUB_RADAR_APP_CLIENT_ID`: The **Client ID** of your GitHub application.
> * `INF_APP_CONNECTION_GITHUB_RADAR_APP_CLIENT_SECRET`: The **Client Secret** of your GitHub application.
> * `INF_APP_CONNECTION_GITHUB_RADAR_APP_SLUG`: The **Slug** of your GitHub application. This is the one found in the URL.
> * `INF_APP_CONNECTION_GITHUB_RADAR_APP_ID`: The **App ID** of your GitHub application.
> * `INF_APP_CONNECTION_GITHUB_RADAR_APP_PRIVATE_KEY`: The **Private Key** of your GitHub application.
> * `INF_APP_CONNECTION_GITHUB_RADAR_APP_WEBHOOK_SECRET`: The **Webhook Secret** of your GitHub application.
>
> Once added, restart your Infisical instance and use the GitHub integration via app authentication.

## Setup GitHub Radar connection in Infisical

**1. Navigate to App Connections**

Navigate to the **Integrations** tab in the desired project, then select **App Connections**.

![App Connections Tab](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/general/add-connection.png)

**2. Add Connection**

Select the **GitHub Radar Connection** option from the connection options modal.

![Select GitHub Radar Connection](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/select-github-radar-connection.png)

**3. Authorize Connection**

Select the **GitHub App** method and select **Connect to GitHub**.

![Connect via GitHub App](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/create-github-radar-app-method.png)

**4. Install GitHub App**

You'll then be redirected to the GitHub App installation page.

Install and authorize the GitHub application. This will redirect you back to Infisical's App Connections page.

![Install GitHub App](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/github-radar-authorize.png)

**5. Connection Created**

Your **GitHub Radar Connection** is now available for use.

![GitHub Radar Connection](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/app-connections/github-radar/github-radar-app-created.png)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.