From 1e813dbacee80305c9c79052a789b31152b17b80 Mon Sep 17 00:00:00 2001 From: Daniel Barranquero Date: Fri, 3 Oct 2025 09:50:00 +0200 Subject: [PATCH] feat(docs): add key path to github docs --- docs/basic-usage/prowler-cli.md | 6 ++++-- docs/tutorials/github/authentication.md | 3 +-- docs/tutorials/github/getting-started-github.md | 6 ++++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/basic-usage/prowler-cli.md b/docs/basic-usage/prowler-cli.md index 3681714b70..be8480d76b 100644 --- a/docs/basic-usage/prowler-cli.md +++ b/docs/basic-usage/prowler-cli.md @@ -211,7 +211,8 @@ Prowler enables security scanning of your **GitHub account**, including **Reposi prowler github --oauth-app-token oauth_token # GitHub App Credentials: - prowler github --github-app-id app_id --github-app-key app_key + 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 ``` ???+ note @@ -219,7 +220,8 @@ Prowler enables security scanning of your **GitHub account**, including **Reposi 1. `GITHUB_PERSONAL_ACCESS_TOKEN` 2. `OAUTH_APP_TOKEN` - 3. `GITHUB_APP_ID` and `GITHUB_APP_KEY` + 3. `GITHUB_APP_ID` and `GITHUB_APP_KEY_PATH` + 4. `GITHUB_APP_ID` and `GITHUB_APP_KEY` ## Infrastructure as Code (IaC) diff --git a/docs/tutorials/github/authentication.md b/docs/tutorials/github/authentication.md index 76ebfe9484..c36d93098e 100644 --- a/docs/tutorials/github/authentication.md +++ b/docs/tutorials/github/authentication.md @@ -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 - diff --git a/docs/tutorials/github/getting-started-github.md b/docs/tutorials/github/getting-started-github.md index 598e777182..f19726872a 100644 --- a/docs/tutorials/github/getting-started-github.md +++ b/docs/tutorials/github/getting-started-github.md @@ -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 ```