> For the complete documentation index, see [llms.txt](https://help.nightfall.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.nightfall.ai/github/getting_started/installation.md).

# Install Nightfall for GitHub

Learn how to install Nightfall DLP for GitHub.

You can install Nightfall for GitHub via the [Nightfall console](#installing-nightfall-for-github-from-nightfall-console). The Nightfall app for GitHub requests read access to contents, metadata, organization members, and commit statuses, and read and write access to pull requests and issues. Write access is used only to post comments about findings. Nightfall does not block pushes, change code, or scan issues. For what each permission is used for, repository scoping, and personal accounts, see [SaaS App Permissions Reference](/nightfall_integrations/saas-app-permissions-reference.md).

## Installing Nightfall for GitHub from Nightfall console

To install from Nightfall's console,

1. Go to Nightfall's dashboard [here](https://app.nightfall.ai/dashboard).
2. Click **GitHub** under **My Integrations**. The GitHub Account Information screen displays. If GitHub is not listed under My Integrations but is in Available Integrations, please reach out to your Nightfall contact.
3. Click **+ Add Org**. The GitHub sign-in page displays.
4. Log in to the GitHub instance where you wish to install Nightfall for GitHub. If you are already logged in to your GitHub account, you only need to enter the password.

{% hint style="info" %}
If you have enabled multi-factor authentication (MFA) on your GitHub account, you receive an authorization code. You must enter this code to continue the installation process.
{% endhint %}

<div data-full-width="true"><figure><img src="https://2214688951-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mg3wgFIu8T7XAT1u-f_%2Fuploads%2FPbtPQgexvLEMPPp23RMq%2FGIF%20Recording%202023-10-30%20at%203.24.25%20PM.gif?alt=media&amp;token=e56f70ae-338a-4dfc-89fe-25c90a79b9f7" alt=""><figcaption></figcaption></figure></div>

5. Ensure that the **All repositories** radio button is selected on the Authorization page. This ensures that all of your GitHub repositories are monitored by Nightfall. Nightfall recommends you to select this option. To monitor only a specific set of repositories, select Only select repositories radio button and select the required repositories.
6. Click **Install and Authorize**.

![](https://2214688951-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mg3wgFIu8T7XAT1u-f_%2Fuploads%2FeU8SPHXBOH1cnIaTpb7M%2FScreenshot%202023-10-30%20at%203.25.48%E2%80%AFPM.png?alt=media\&token=ed96afd0-b90e-45c6-98bd-4d0b8a1b1b0c)

{% hint style="info" %}
If you select only some specific repositories to be monitored by Nightfall and later on wish to monitor more repositories or all the repositories, refer to [this section.](#add-multiple-repositories)
{% endhint %}

Nightfall for GitHub is now successfully installed. You can check your GitHub username under the Account Information section of the GitHub integration.

## Modify Repository Settings

This section explains how you can modify the repository settings configured while installing Nightfall for GitHub. This section helps you in the following scenarios.

* While installing Nightfall for GitHub, you have allowed only a few repositories to be monitored by Nightfall, and now wish that Nightfall monitors more or all of your GitHub repositories.
* While installing Nightfall for GitHub, you have allowed all your GitHub repositories to be monitored by Nightfall and now wish only a few repositories to be monitored.

To modify Repository settings:

1. Log in to the GitHub account on which Nightfall for GitHub is installed.
2. Click the name icon on the extreme right corner and select Settings.
3. Select **Applications** under the I**ntegrations** section from the left menu.
4. Select **Configure** for the Nightfall for the GitHub application.

<div data-full-width="true"><figure><img src="https://2214688951-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mg3wgFIu8T7XAT1u-f_%2Fuploads%2FxOWX9HZEvuAK45cBehIo%2FGIF%20Recording%202023-10-30%20at%203.54.22%20PM.gif?alt=media&amp;token=d1095a99-9cb8-49ca-b173-c45d3e27a45f" alt=""><figcaption></figcaption></figure></div>

5. Scroll down to the **Repository access** section and make the necessary changes.
6. Click **Save**.

<figure><img src="https://2214688951-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mg3wgFIu8T7XAT1u-f_%2Fuploads%2FkABsMv2ONTs2W209sXBL%2FGIF%20Recording%202023-10-30%20at%203.56.24%20PM.gif?alt=media&amp;token=9044ed64-134e-41f5-9940-1c00fe3b1a29" alt=""><figcaption></figcaption></figure>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.nightfall.ai/github/getting_started/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
