> For the complete documentation index, see [llms.txt](https://docs.brainboard.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brainboard.co/settings/integrations/git-configuration/github.md).

# GitHub

### Configure GitHub integration

To create integration between Brainboard and GitHub:

1. Go to the [Git integration](https://app.brainboard.co/settings/integrations/git) settings page.
2. Click on `Integrations`
3. Click on `Connect with GitHub`

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FS4zLx42QupEgLEJ0ydLD%2FCleanShot%202025-04-11%20at%2016.11.13%402x.png?alt=media&amp;token=463d82a2-1ac2-425e-b4a9-b5ee8b86ab05" alt=""><figcaption></figcaption></figure>

You'll be redirected to the GitHub website, where you can choose the organization for which you want to configure access:

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2Fgit-blob-860c341da5dc19cabdff94671d07552adce69ebc%2Fgithub-first-page.png?alt=media" alt=""><figcaption></figcaption></figure>

After selecting the organization, you are prompted to specify the repositories:

**N.B:** Brainboard requires `read-write` access to be able to do pull requests.

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2Fgit-blob-07a2dbf97dbc8bfca06e4aca5a6e2fcec290fad5%2Fgithub-project-access.png?alt=media" alt=""><figcaption></figcaption></figure>

After selecting the repositories, you'll be automatically redirected to Brainboard Git app settings page. Now the button should have changed to `View GitHub integration`.

Once the connection is configured successfully, it will be you should it with a green indication

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FpGwzfUnU8DqDcnlFIbMt%2FCleanShot%202025-04-11%20at%2016.08.49%402x.png?alt=media&amp;token=4e7887e2-4b36-4cdb-a974-ac6c53ab8232" alt=""><figcaption></figcaption></figure>

### Enable personal connection

1. Once the GitHub app integration is done you need to click on `Add connection` in `Personal connections` section. This will open the settings where you can allow Brainboard to do pull requests on your behalf by clicking on `Connect with Github`<br>

   <figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FQ5fQtAr0ONirdYA0K898%2FCleanShot%202025-04-11%20at%2016.47.00%402x.png?alt=media&amp;token=b54bb600-5473-43d0-b013-3e88db42b365" alt=""><figcaption></figcaption></figure>

   If the Git app integration is not configured, Brainboard will display a warning as it has to be done first<br>

   <figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2F90LoQPGvn2d8347j0QVK%2FCleanShot%202025-04-11%20at%2016.11.41%402x.png?alt=media&amp;token=809a249e-f333-4657-9a04-5cb7dfafa2d8" alt=""><figcaption></figcaption></figure>
2. The GitHub website will open in a new tab, asking you to authorize Brainboard app to access your GitHub account. Click on the `Authorize Brainboard` button:

   ![Github authorize](https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2Fgit-blob-41d2429ef0481481bfcd4c0d19eaec89f726c601%2Fgithub-authorize-app.png?alt=media)
3. You will then be redirected to Brainboard personal git tokens page, with a confirmation that the GitHub connection was successful:

   ![Github\_connection\_success](https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2Fgit-blob-0959546c36259978ea997f732826cc6f7d201e9d%2Fgithub-connect-success.png?alt=media)

### Using your own GitHub app

{% hint style="info" %}
Required if you want to integrate with GHE / GHES
{% endhint %}

Register a new app (see <https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app>) with the following information:

* Name: `Brainboard`
* Homepage URL: `https://www.brainboard.co`
* Callback URLs:&#x20;
  * `https://app.brainboard.co/settings/integrations/git/callback/github/organization`
  * `https://app.brainboard.co/settings/integrations/git/callback/github/user`
* Setup URL: `https://app.brainboard.co/settings/integrations/git`
* Webhook URL: `https://api.us1.brainboard.co/webhooks/github`
* Permissions:
  * Content: Read and write
  * Pull requests: Read and write
* Subscribe to events: none

Once created, generate a **client secret** and a **private key** then configure it in Brainboard.

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FZHcH69aHJaCiMWLrV2aA%2FklwbONs2lEIhX5pf.png?alt=media&amp;token=42e2fb58-1117-4957-b4a7-924de45a1975" alt=""><figcaption></figcaption></figure>

### Edit GitHub integration

To edit the GitHub integration:

1. Go to the [Git integration](https://app.brainboard.co/settings/integrations/git) settings page.
2. Click on `Integrations`
3. Click on `Access GitHub`
4. You'll be redirected to the GitHub website, where you can edit the integration with Brainboard.

### Delete GitHub integration

To delete integration with GitHub:

1. Go to the [Git integration](https://app.brainboard.co/settings/integrations/git) settings page.
2. Click on `Integrations`
3. You need to delete your personal connection first by clicking on it in the section `Personal connectio` then click on `Delete configuration`

   <figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2F1The1GjIVZGzQQXis5sr%2FCleanShot%202025-04-11%20at%2017.40.54%402x.png?alt=media&amp;token=418e87c9-eacb-43d4-9f68-2ddaeefb89f3" alt=""><figcaption></figcaption></figure>
4. Go back to the page of Git connections and click on `Access GitHub`
5. You'll be redirected to the GitHub website, where you can delete the integration with Brainboard.<br>

   <figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FXGnAybi8wIJ9OxrkQx36%2FCleanShot%202025-04-11%20at%2016.44.39%402x.png?alt=media&amp;token=bf50ee88-17c5-4ee5-a19f-4efaa7352b5a" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The update will be immediate, and you will no longer be able to do pull requests.
{% endhint %}
