ben.carrasco/prowler
1
0
Fork 0
mirror of https://github.com/prowler-cloud/prowler.git synced 2026-07-23 12:31:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): add key path to github docs

Browse Source
This commit is contained in:
Daniel Barranquero
2025-10-03 09:50:00 +02:00
parent a0c00ab2e7
commit 1e813dbace
3 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/tutorials/github/authentication.md
+1 -2
View File
@@ -136,7 +136,7 @@ GitHub Apps provide the recommended integration method for accessing multiple re
- **GitHub App name**: Unique application name
- **Homepage URL**: Application homepage
- **Webhook URL**: Webhook payload URL (optional)
- **Permissions**: Application permission requirements
- **Permissions**: Configure application permission requirements following the next step
3. **Configure Permissions**
To enable Prowler functionality, configure these permissions:
@@ -208,4 +208,3 @@ Choose the appropriate method based on use case:
### Organization Settings
- Some organizations restrict third-party applications
- Contact organization administrator if access is denied
docs/tutorials/github/getting-started-github.md
+4 -2
View File
@@ -59,7 +59,8 @@ If no login method is explicitly provided, Prowler will automatically attempt to
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)
3. `GITHUB_APP_ID` and `GITHUB_APP_KEY_PATH` (where the key path is the path to the private key file)
4. `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.
@@ -86,5 +87,6 @@ prowler github --oauth-app-token oauth_token
Use GitHub App credentials by specifying the App ID and the private key path.
```console
prowler github --github-app-id app_id --github-app-key-path app_key_path
prowler github --github-app-id app_id --github-app-key-path path/to/app_key.pem
prowler github --github-app-id app_id --github-app-key $APP_KEY_CONTENT
```