# Add a Project to CodeScan from GitHub Enterprise Cloud (with GitHub App)

## Prerequisites 

Please ensure the person performing the setup has administrator privileges for both GitHub Enterprise and CodeScan. These are required:

* Admin access to GitHub Enterprise
* Admin access to CodeScan

## Create a GitHub app 

Log in to your GitHub Enterprise Server with an Admin account and select one of the following approaches to create a GitHub app.

### a. Recommended approach

To create a GitHub App, just copy the URL below:

`https://YOUR_GHES_HOSTNAME/settings/apps/new?name=codescan-enterprise-app&description=GitHub App for CodeScan integration&url=https://YOUR_PUBLIC_BASE&callback_urls[]=https://YOUR_PUBLIC_BASE/_codescan/oauth2/authorize&request_oauth_on_install=true&public=true&contents=read&metadata=read&repository_hooks=write&setup_on_update=true&webhook_active=false` 

Customize the URL by replacing the following attributes: 

YOUR\_GHES\_HOSTNAME = Your GitHub Enterprise URL (Example: [*github.company.com*](http://github.company.com/)) 

YOUR\_PUBLIC\_BASE = URL of the CodeScan instance (Example: [*app.codescan.io*](https://app.codescan.io/)) 

Click **Save**.

### b. Manual creation

1. Log in to your GitHub Enterprise Server as an Admin (make sure to switch to Enterprise Level), and navigate to **Settings**.

Under **Settings**, select GitHub App → Create **New GitHub App.**

Provide details:

* **GitHub App name:** codescan-enterprise-app  

{% hint style="info" %}
App name should be **codescan-enterprise-app,** please do not modify.
{% endhint %}

* **Homepage URL:** your CodeScan URL

For example:

[*https://app.codescan.io*](https://app.codescan.io/) 

[*https://app-eu.codescan.io*](https://app-eu.codescan.io/) 

[*https://app-aus.codescan.io*](https://app-aus.codescan.io/) 

* **Callback URL:** in the format \[CodeScanURL]/\_codescan/oauth2/authorize 

For example:

[*https://app.codescan.io/\_codescan/oauth2/authorize*](https://app.codescan.io/_codescan/oauth2/authorize) 

[*https://app-eu.codescan.io/\_codescan/oauth2/authorize*](https://app-eu.codescan.io/_codescan/oauth2/authorize) 

[*https://app-aus.codescan.io/\_codescan/oauth2/authorize*](https://app-aus.codescan.io/_codescan/oauth2/authorize) 

<img src="/files/j3DtzyZejiY7KTl5bvNi" alt="" height="230" width="601">

* **Post Installation:**&#x20;

Check **Redirect on update**:&#x20;

<img src="/files/TEv1GLJDG3fp3f3DXSjt" alt="" height="129" width="380">

* Webhook:&#x20;

Uncheck **Active:**

<img src="/files/6xEGR1a0gLNZTqYwlmZm" alt="" height="203" width="352">

* **Repository Permissions:**&#x20;

Contents: Read-only&#x20;

Metadata: Read-only&#x20;

Webhooks: Read and write&#x20;

2. Keep the app public by enabling Any Account.&#x20;

<img src="/files/rw70uf12IsPkBgEfKo0l" alt="" height="154" width="404">

3. Click **Create GitHub App.**

## Trigger Analysis from CodeScan&#x20;

1. Log in to your CodeScan account as an Admin.
2. In the top right corner, click on the **'+'** icon and select **Analyze new project**.

<figure><img src="/files/7dXaEnsFgeqyeV5UpVol" alt=""><figcaption></figcaption></figure>

3. Choose the **Organization** for which you'd like to create a project. Click **Set Up**.

<figure><img src="/files/6IGJBhx4NW8mrhQoQBKw" alt="" width="563"><figcaption></figcaption></figure>

4. On the next window, click on **Add Analysis Project**.

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

5. You will now see a new pop-up window; select **GitHub:**

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

6. Once you select **GitHub**, it will redirect you to the GitHub login page to validate your credentials:

<img src="/files/rQN9XqdOdtr89Brn7cpB" alt="" height="226" width="382">

{% hint style="info" %}
Make sure you select “Install app.codescan.io” for your Enterprise organization, not a personal org.
{% endhint %}

7. On the next screen, fill in the details below:

* Choose the **Repository** to add, followed by the **Project Branch** name.

{% hint style="info" %}
If you do not specify the Branch Name during GitHub integration, then it will take the main branch by default.
{% endhint %}

* Make sure you select the checkbox under **Check Pull Requests**.&#x20;

{% hint style="info" %}
Admin permissions in GitHub are **required,** otherwise pull requests will not be triggered, even though a user may be able to select the box to "check pull requests" during GitHub integration.
{% endhint %}

* The **Project Key** and the **Project Name** are automatically generated. You can edit these values as needed.
* Click on **Add and Run Now:**

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

8. This triggers the project analysis and adds the project to your CodeScan organization.
9. You can view the project analysis report by clicking on **Details** from your repository:

<figure><img src="/files/YqEFgUL5uNlEJulQXDdT" alt="" width="563"><figcaption></figcaption></figure>

10. When you click the link, it will take you to the **CodeScan Project** page, where you can view your project analysis report:

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

&#x20;

&#x20;


---

# Agent Instructions: 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:

```
GET https://knowledgebase.autorabit.com/product-guides/codescan/getting-started/using-codescan/adding-projects-to-codescan/add-a-project-to-codescan-from-github-enterprise-cloud-with-github-app.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.