mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
121 lines
6.4 KiB
Plaintext
121 lines
6.4 KiB
Plaintext
---
|
|
title: "GitHub Radar Connection"
|
|
description: "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](/documentation/platform/secret-scanning/overview) and require specific permissions and webhook configuration.
|
|
|
|
Check out our [GitHub Connection](/integrations/app-connections/github) for secret management features such as [Secret Syncs](/integrations/secret-syncs/overview).
|
|
</Note>
|
|
|
|
<Accordion title="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.
|
|
|
|
<Steps>
|
|
<Step title="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.
|
|
</Note>
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
Set the following repository permissions:
|
|
- **Contents**: `Read-only`
|
|
- **Metadata**: `Read-only`
|
|
|
|
|
|
|
|
|
|
Subscribe to the following events:
|
|
- **Push**
|
|
|
|
|
|
|
|
Create the Github application.
|
|
|
|
</Step>
|
|
<Step title="Add your application credentials to Infisical">
|
|
Generate a new **Client Secret** for your GitHub application.
|
|
|
|
|
|
Generate a new **Private Key** for your Github application.
|
|
|
|
<Info>You will need to copy the contents of the .pem file downloaded</Info>
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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.
|
|
</Step>
|
|
</Steps>
|
|
</Accordion>
|
|
|
|
## Setup GitHub Radar Connection in Infisical
|
|
|
|
<Steps>
|
|
<Step title="Navigate to App Connections">
|
|
Navigate to the **App Connections** tab on the **Organization Settings** page.
|
|
|
|
</Step>
|
|
<Step title="Add Connection">
|
|
Select the **GitHub Radar Connection** option from the connection options modal.
|
|
|
|
</Step>
|
|
<Step title="Authorize Connection">
|
|
Select the **GitHub App** method and click **Connect to GitHub**.
|
|
|
|
</Step>
|
|
<Step title="Install GitHub App">
|
|
You will 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.
|
|
|
|
</Step>
|
|
<Step title="Connection Created">
|
|
Your **GitHub Radar Connection** is now available for use.
|
|
|
|
</Step>
|
|
</Steps> |