> For the complete documentation index, see [llms.txt](https://help.aikido.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aikido.dev/code-scanning/connect-your-source-code/connect-github-enterprise/connect-github-enterprise-cloud-and-server-broker-set-up.md).

# Connect GitHub Enterprise (Cloud & Server) (Broker Set-Up)

Aikido integrates with [Github Enterprise Cloud](https://docs.github.com/en/get-started/onboarding/getting-started-with-github-enterprise-cloud) and [GitHub Enterprise Server](https://docs.github.com/en/enterprise-server@3.19/admin/overview/about-github-enterprise-server) through a secure, app-based connection. This allows Aikido to access the repositories you choose while keeping full control. The connection can be established also through a broker which this guide covers.

{% hint style="danger" %}
Please read the following requirements carefully before setting up the workspace:

1. **GitHub Organization permissions**: Ensure that the user setting up the workspace has sufficient permissions in the GitHub organization to install the Aikido application. In most cases, this requires Organization Owner or Organization Administrator privileges.
2. **Matching email addresses**: when signing up with Google or Microsoft (see step 1 below), ensure that the email address used for sign-in matches the email address associated with the user's GitHub account. 
   {% endhint %}

### Installation

Aikido connects to your GitHub Enterprise setup by creating a GitHub App on your server. The app includes the permissions and callbacks needed for Aikido to work. After it is created, you can install it in any organisation on your GitHub Server instance that you want to link to Aikido.\
\
To create the GitHub app on your instance, follow the steps below.

{% stepper %}
{% step %}
**Create your account**

To connect your GitHub Enterprise, first sign up or log in to Aikido using Google or Microsoft. On the [signup screen](https://app.aikido.dev/login), click **Google / Microsoft**.
{% endstep %}

{% step %}
**Start the GitHub Enterprise setup**

Once you're authenticated, create a new workspace by clicking GitHub Server in the GitHub section.

<figure><img src="/files/ZbL1PwrQqfVu5qUVXkFU" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Enable Broker access**

Enable the **Aikido broker** by clicking the toggle in the "Advanced Connection Options" section.

Click **Next, Install App** and then switch to [https://app.aikido.dev](https://app.aikido.dev/) where a Local Scan workspace will be created.

<figure><img src="/files/P6c9952JKzLS5ViB0t70" alt="Aikido onboarding: Enter GitHub Enterprise URL to authenticate"><figcaption><p>Aikido onboarding: Enter GitHub Enterprise URL to authenticate</p></figcaption></figure>
{% endstep %}

{% step %}
**Configure the broker**

Configure the Broker using the guide below through the Local Scan workspace. After you deploy it, return here to finish the GitHub Enterprise setup.

{% content-ref url="/pages/h0JtJS4MeX5E8efcCvRF" %}
[Aikido Broker for Internal Applications](/miscellaneous-info/aikido-broker-for-internal-applications.md)
{% endcontent-ref %}

<figure><img src="/files/Pc9Nv97shdA6A1lseDcn" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Install Aikido Github App on your Github Enterprise**

After you create the broker and deploy it in your environment, you can complete the GitHub Enterprise setup.

First, copy the **Broker URL**. It looks similar to this:

```
https://55673-355dsfwea68cb.aikidobroker.com
```

Then click **Complete GitHub Server Setup**.

<figure><img src="/files/YfHEEWLK8D2Dupc3yvS3" alt=""><figcaption></figcaption></figure>

A file named `install.html` is downloaded to your machine. It contains an HTML page with a form that sends a JSON payload to your GitHub Enterprise to create the GitHub App.

Open the file in your browser and select Install to continue the setup process.

<figure><img src="/files/Q07BfiTCvWouJDz4sKTl" alt="" width="375"><figcaption></figcaption></figure>

After clicking "Install" you are redirected to a page on your GitHub Enterprise that prompts you to install the app. Choose `Create GitHub App for User` to create the app on your server.

<figure><img src="/files/axN5WETxHQUfuhUdGn1j" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Authorize Aikido Github app**

Now you need to authorize the new GitHub App with your user account through OAuth. This step confirms that the app was created correctly and that you have permission to use it. The screen you see will be similar to the example below.

<figure><img src="/files/M0kbiOT4djVWnrdFoOii" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Connect Github organization**

Choose the GitHub organisation where you want to install the application and link it to Aikido. You can add more organisations later. After selecting the organisation, confirm the authorization for the GitHub App.

<figure><img src="/files/jzUrqhKLwO5VcO1k6k9U" alt="" width="375"><figcaption></figcaption></figure>

You are now redirected back to Aikido where you can choose which repositories should be scanned. Select the repositories you want and continue. Aikido will start scanning the chosen applications.
{% endstep %}

{% step %}
**Explore Aikido**

After granting access and validating the repositories you want to scan, your workspace will be converted and Aikido will automatically start scanning. After about 1 minute, you should see the first results come in
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.aikido.dev/code-scanning/connect-your-source-code/connect-github-enterprise/connect-github-enterprise-cloud-and-server-broker-set-up.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.