Setting up a GitHub Integration

The GitHub integration supports two authentication methods: Personal Access Token (PAT) and GitHub App authentication. Choose the method that best aligns with your organization's security requirements.

Create the integration

1. In CloudQuery Platform, go to Data Pipelines → Integrations. Click Create Integration and type Github to find the Github integration.

2. Choose the method to authenticate.

GitHub App Authentication

Create GitHub App

For App authentication, you need to create a GitHub App and install it on your organization. GitHub App authentication provides higher rate limits and better security through fine-grained permissions. For detailed instructions, see the guide.

To set up:

1. Create a GitHub App in your organization:

   • Go to Organization Settings > GitHub Apps > New GitHub App

   • Configure the app with read-only permissions for the resources you need

   • Generate and download the private key

2. Install the app in your organization

3. Note down the following details:

   • App ID: Found in the app's settings

   • Installation ID: Found in the URL when viewing the app installation

   • Private key: The downloaded RSA key

4. Back in CloudQuery Platform, select the GitHub App Authentication and fill in the values from the previous step.

Personal Access Token

Keep in mind rate limits for GitHub Apps are higher than for personal access tokens. Review GitHub rate limits documentation for details

Generate the Personal Access Token

Personal Access Tokens provide a simple way to authenticate with GitHub APIs. For detailed instructions, see the guide.

To authenticate using a Personal Access Token:

1. Go to your GitHub account settings

2. Navigate to Developer settings > Personal access tokens > Tokens (classic)

3. Click Generate new token and select Generate new token (classic)

4. Name your token and set the read-only permissions to the resources you need

5. Save generated token

6. Back in CloudQuery Platform, select the Access Token and enter the token in the designated input.

1. If using GitHub Enterprise, expand the GitHub Enterprise Configuration and provide the the base URL and upload URL.

   By default, the GitHub Enterprise URL format should be http(s)://[hostname]/api/v3/ or you will always receive the 406 status code. The upload URL format should be http(s)://[hostname]/api/uploads/

2. Specify the repositories or the GitHub organization to sync from. Separate the names by spaces.

1. Click the Continue button to proceed to the selection of tables.

2. Select the tables to sync. To learn more about the tables and their schema, see the GitHub plugin documentation.

1. Click the Test and save button to test the connection and create the integration.

Next Steps

With your GitHub integration created, you can now proceed to use it in a new sync. This will give you the opportunity to specify when your GitHub sync should be run, and to which destination databases.