> 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/audit/github-audit/overview.md).

# Overview

This document explains the process of creating audits in Nightfall for the GitHub integration. A GitHub audit helps you analyze your historic GitHub data for the presence of sensitive content. 

## Use Cases for GitHub Audit: Hardcoded Secrets in GitHub Code

Modern applications store vast amounts of code in GitHub repositories, making manual scanning for sensitive data impractical. Nightfall audits can efficiently scan billions of bytes of code within minutes, quickly identifying hardcoded secrets such as passwords, API keys, and other sensitive credentials.

## Prerequisites

You must ensure that the GitHub integration is installed in your Nightfall tenant. To learn more about how to install the GitHub integration, refer to this [Nightfall documentation](https://help.nightfall.ai/github/getting_started/installation). 

The process of creating an Audit for the GitHub integration involves the configuration of following settings.

* [Select Integration](/audit/github-audit/select-integration.md)
* [Configure Scope](/audit/github-audit/configure-scope.md)
* [Select Detection Rules](/audit/github-audit/select-detection-rules.md)
* [Review Configurations](/audit/github-audit/review-configurations.md)

<br>


---

# 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/audit/github-audit/overview.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.