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

# GitHub

You can either onboard using a Honeydew-managed **GitHub** private repository, or use your own GitHub repository.
If you would like to use your own repository, please complete the following steps:

<Steps>
  <Step title="Create a GitHub Repository">
    Create a new **GitHub** private repository using one of these options:

    * Create a new repository
    * Clone from the [Honeydew quick-start](https://github.com/honeydew-ai/honeydew-quickstart) example.
  </Step>

  <Step title="Install the Honeydew GitHub Application">
    Install the [Honeydew GitHub application](https://github.com/apps/honeydew-ai), and provide it with access to the newly created repository.
  </Step>

  <Step title="Configure allowed IP addresses">
    If you are restricting access to your GitHub organization using IP addresses allow list,
    add the IP addresses displayed in the GitHub connection screen in [Honeydew App settings page](https://app.honeydew.cloud/settings)
    to the "IP Allow List" of your GitHub organization.

    <Note>
      For the Honeydew Cloud deployment, the following IP addresses are used:

      * `34.86.209.90`
      * `34.145.147.92`

      If you are using a private Honeydew deployment, the IP addresses will be different.
      You can find them in the GitHub connection screen in [Honeydew App settings page](https://app.honeydew.cloud/settings).
    </Note>
  </Step>

  <Step title="Set up Honeydew">
    <Tabs>
      <Tab title="Self-Service Setup">
        1. Go to the [GitHub connection](https://app.honeydew.cloud/settings/github) screen in Honeydew Studio settings page
        2. Click on the **Connect to GitHub** button and login to your GitHub account
        3. Select the newly created repository from the list and click **Save**

        You are all set! Honeydew will now use this GitHub repository for storing a version controlled semantic layer.
      </Tab>

      <Tab title="Setup with Honeydew Support">
        Provide the following details to [support@honeydew.ai](mailto:support@honeydew.ai):

        1. The full name of the GitHub repository created in Step 1.

           The full repository name would look like `org-name/repository-name` (e.g. `honeydew-ai/honeydew-quickstart`).

        2. The app installation id.

           This is the number at the end of the app URL,
           like `11122333` for [https://github.com/apps/honeydew-ai/installations/11122333](https://github.com/apps/honeydew-ai/installations/11122333)).

           To get to the url that contains your installation id, go to
           `https://github.com/organizations/<your-github-organization>/settings/installations`,
           and then click on the `Honeydew.ai` application.
      </Tab>
    </Tabs>
  </Step>
</Steps>

<Tip>
  If you have protection rules for new repositories, you may need to grant the Honeydew GitHub application the ability to bypass these rules.
  Specifically, please disable rules requiring at least one reviewer for pull requests for the Honeydew GitHub application.
</Tip>