prowler/docs/tutorials/github/getting-started-github.md

Getting Started with GitHub

Prowler App

Walkthrough video onboarding a GitHub Account using GitHub App.

Step 1: Access Prowler Cloud/App

1. Navigate to Prowler Cloud or launch Prowler App

2. Go to "Configuration" > "Cloud Providers"

   

3. Click "Add Cloud Provider"

   

4. Select "GitHub"

   

5. Add the GitHub Account ID (username or organization name) and an optional alias, then click "Next"

   

Step 2: Choose the preferred authentication method

6. Choose the preferred authentication method:

   

7. Configure the authentication method:

=== "Personal Access Token"

For more details on how to create a Personal Access Token, see [Authentication > Personal Access Token](./authentication.md#personal-access-token-pat).

=== "OAuth App Token"

![Configure OAuth App Token](./img/auth-oauth.png)

For more details on how to create an OAuth App Token, see [Authentication > OAuth App Token](./authentication.md#oauth-app-token).

=== "GitHub App"

![Configure GitHub App](./img/auth-github-app.png)

For more details on how to create a GitHub App, see [Authentication > GitHub App](./authentication.md#github-app-credentials).

Prowler CLI

Automatic Login Method Detection

If no login method is explicitly provided, Prowler will automatically attempt to authenticate using environment variables in the following order of precedence:

1. GITHUB_PERSONAL_ACCESS_TOKEN
2. GITHUB_OAUTH_APP_TOKEN
3. GITHUB_APP_ID and GITHUB_APP_KEY (where the key is the content of the private key file)

???+ note Ensure the corresponding environment variables are set up before running Prowler for automatic detection when not specifying the login method.

For more details on how to set up authentication with GitHub, see Authentication > GitHub.

Personal Access Token (PAT)

Use this method by providing your personal access token directly.

prowler github --personal-access-token pat

OAuth App Token

Authenticate using an OAuth app token.

prowler github --oauth-app-token oauth_token

GitHub App Credentials

Use GitHub App credentials by specifying the App ID and the private key path.

prowler github --github-app-id app_id --github-app-key-path app_key_path