Getting Started with GitHub¶
Prowler App¶
Walkthrough video onboarding a GitHub Account using GitHub App.
Step 1: Access Prowler Cloud/App¶
- Navigate to Prowler Cloud or launch Prowler App
-
Go to "Configuration" > "Cloud Providers"
-
Click "Add Cloud Provider"
-
Select "GitHub"
-
Add the GitHub Account ID (username or organization name) and an optional alias, then click "Next"
Step 2: Choose the preferred authentication method¶
-
Choose the preferred authentication method:
-
Configure the authentication method:
For more details on how to create a Personal Access Token, see Authentication > Personal Access Token.
For more details on how to create an OAuth App Token, see Authentication > OAuth App Token.
For more details on how to create a GitHub App, see Authentication > GitHub App.
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:
GITHUB_PERSONAL_ACCESS_TOKEN
GITHUB_OAUTH_APP_TOKEN
GITHUB_APP_ID
andGITHUB_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.
OAuth App Token¶
Authenticate using an OAuth app token.
GitHub App Credentials¶
Use GitHub App credentials by specifying the App ID and the private key path.