diff --git a/docs/snippets/subscription-banner.mdx b/docs/snippets/subscription-banner.mdx new file mode 100644 index 0000000000..8313997c84 --- /dev/null +++ b/docs/snippets/subscription-banner.mdx @@ -0,0 +1,8 @@ +export const SubscriptionBanner = ({ children }) => { + return ( + + This feature is available exclusively in Prowler Cloud and Prowler Enterprise with a subscription. + {children} + + ); +}; diff --git a/docs/user-guide/tutorials/prowler-alerts.mdx b/docs/user-guide/tutorials/prowler-alerts.mdx index e4475849ae..9f01a77910 100644 --- a/docs/user-guide/tutorials/prowler-alerts.mdx +++ b/docs/user-guide/tutorials/prowler-alerts.mdx @@ -4,14 +4,13 @@ description: 'Create email alerts from Prowler Cloud findings to monitor relevan --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { SubscriptionBanner } from "/snippets/subscription-banner.mdx" Alerts notify recipients by email when security findings match saved filter conditions. Use Alerts to track high-priority findings, monitor specific providers or services, and keep teams informed about scan results that match defined criteria. - -This feature is available exclusively in **Prowler Cloud** and **Prowler Enterprise** with a [subscription](https://prowler.com/pricing). - + ## Prerequisites diff --git a/docs/user-guide/tutorials/prowler-app.mdx b/docs/user-guide/tutorials/prowler-app.mdx index 5e99a41ae7..19bd48ee60 100644 --- a/docs/user-guide/tutorials/prowler-app.mdx +++ b/docs/user-guide/tutorials/prowler-app.mdx @@ -18,17 +18,14 @@ After [installing](/getting-started/installation/prowler-app) **Prowler App**, a To view the auto-generated **Prowler API** documentation, navigate to [http://localhost:8080/api/v1/docs](http://localhost:8080/api/v1/docs). This documentation provides details on available endpoints, parameters, and responses. -## **Step 1: Sign Up** - -### **Sign Up with Email** - +## Step 1: Sign Up +### Sign Up with Email To get started, sign up using your email and password: Sign Up Button Sign Up -### **Sign Up with Social Login** - +### Sign Up with Social Login If Social Login is enabled, you can sign up using your preferred provider (e.g., Google, GitHub). @@ -44,16 +41,14 @@ If your email is not registered, a new account will be created using your social See [how to configure Social Login for Prowler](/user-guide/tutorials/prowler-app-social-login) to enable this feature in your own deployments. -## **Step 2: Log In** - +## Step 2: Log In Once registered, log in with your email and password to access Prowler App. Log In Upon logging in, the Overview page will display. At this stage, no data is present: add a provider to begin scanning your cloud environment. -## **Step 3: Add a Provider** - +## Step 3: Add a Provider To perform security scans, link a cloud provider account. Prowler supports the following providers and more: - **AWS** @@ -77,8 +72,7 @@ Steps to add a provider: Add Provider -## **Step 4: Configure the Provider** - +## Step 4: Configure the Provider Select the cloud provider to scan and configure authentication credentials. Each provider has specific requirements and authentication methods. Select a Provider @@ -111,14 +105,12 @@ For detailed instructions on configuring credentials for each provider, refer to Scan IaC public or private repositories for security issues. -## **Step 5: Test Connection** - +## Step 5: Test Connection After adding your credentials of your cloud account, click the `Launch` button to verify that Prowler App can successfully connect to your provider: Test Connection -## **Step 6: Scan started** - +## Step 6: Scan Started After successfully adding and testing your credentials, Prowler will start scanning your cloud environment, click the `Go to Scans` button to see the progress: Start Now @@ -127,8 +119,7 @@ After successfully adding and testing your credentials, Prowler will start scann Prowler will automatically scan all configured providers every **24 hours**, ensuring your cloud environment stays continuously monitored. -## **Step 7: Monitor Scan Progress** - +## Step 7: Monitor Scan Progress Track the progress of your scan in the `Scans` section: Scan Progress @@ -146,8 +137,7 @@ Each dashboard handles scan data differently: When a new scan completes or a new data ingestion is processed, the dashboards automatically reflect the updated results. -## **Step 8: Analyze the Findings** - +## Step 8: Analyze the Findings While the scan is running, start exploring the findings in these sections: - **Overview**: High-level summary of the scans. @@ -168,8 +158,7 @@ While the scan is running, start exploring the findings in these sections: To view all `new` findings that have not been seen prior to this scan, click the `Delta` filter and select `new`. To view all `changed` findings that have had a status change (from `PASS` to `FAIL` for example), click the `Delta` filter and select `changed`. -## **Step 9: Download the Outputs** - +## Step 9: Download the Outputs Once a scan is complete, navigate to the Scan Jobs section to download the output files generated by Prowler: Scan Jobs section @@ -190,8 +179,7 @@ The `zip` file unpacks into a folder named like `prowler-output-- -## **Step 10: Download specified compliance report** - +## Step 10: Download Specified Compliance Report Once your scan has finished, you don’t need to grab the entire ZIP—just pull down the specific compliance report you want: - Navigate to the **Compliance** section of the UI. diff --git a/docs/user-guide/tutorials/prowler-cloud-aws-organizations.mdx b/docs/user-guide/tutorials/prowler-cloud-aws-organizations.mdx index d0c71c7e40..2a6128e92e 100644 --- a/docs/user-guide/tutorials/prowler-cloud-aws-organizations.mdx +++ b/docs/user-guide/tutorials/prowler-cloud-aws-organizations.mdx @@ -4,14 +4,15 @@ description: 'Onboard all AWS accounts in your Organization through a single gui --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { SubscriptionBanner } from "/snippets/subscription-banner.mdx" Prowler Cloud enables you to onboard all AWS accounts in your Organization through a single guided wizard. Instead of connecting accounts one by one, you can discover every account in your AWS Organization, select the ones you want to monitor, test connectivity, and launch scans — all from the Prowler Cloud UI. - -This feature is available exclusively in **Prowler Cloud** and **Prowler Enterprise** with a [subscription](https://prowler.com/pricing). For CLI-based multi-account scanning, see [AWS Organizations in Prowler CLI](/user-guide/providers/aws/organizations). - + +For CLI-based multi-account scanning, see [AWS Organizations in Prowler CLI](/user-guide/providers/aws/organizations). + ## Overview diff --git a/docs/user-guide/tutorials/prowler-import-findings.mdx b/docs/user-guide/tutorials/prowler-import-findings.mdx index 6a3276e403..e02f3ee7a5 100644 --- a/docs/user-guide/tutorials/prowler-import-findings.mdx +++ b/docs/user-guide/tutorials/prowler-import-findings.mdx @@ -4,16 +4,15 @@ description: 'Upload OCSF scan results to Prowler Cloud from external sources or --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { SubscriptionBanner } from "/snippets/subscription-banner.mdx" Findings Ingestion enables uploading OCSF (Open Cybersecurity Schema Framework) scan results to Prowler Cloud. This feature supports importing findings from Prowler CLI output files that use the [Detection Finding](https://schema.ocsf.io/classes/detection_finding) class. - -This feature is available exclusively in **Prowler Cloud** and **Prowler Enterprise** with a [subscription](https://prowler.com/pricing). - + -## OCSF Detection Finding format +## OCSF Detection Finding Format The ingestion API accepts `.ocsf.json` files containing a JSON array of OCSF Detection Finding records. Each finding represents a security check result from Prowler. @@ -130,7 +129,7 @@ The ingestion API accepts `.ocsf.json` files containing a JSON array of OCSF Det Only **Detection Finding** (`class_uid: 2004`) records are accepted. Other OCSF classes are not supported for ingestion. -## Required permissions +## Required Permissions The **Manage Ingestions** RBAC permission controls access to the ingestion endpoints. Without this permission, findings cannot be submitted via the API or `--push-to-cloud`. @@ -145,7 +144,7 @@ The `--push-to-cloud` flag uploads scan results directly to Prowler Cloud after - A valid Prowler Cloud API key (see [API Keys](/user-guide/tutorials/prowler-app-api-keys)) - The `PROWLER_CLOUD_API_KEY` environment variable configured -### Basic usage +### Basic Usage ```bash export PROWLER_CLOUD_API_KEY="pk_your_api_key_here" @@ -153,7 +152,7 @@ export PROWLER_CLOUD_API_KEY="pk_your_api_key_here" prowler aws --push-to-cloud ``` -### Combining with output formats +### Combining with Output Formats When using `--push-to-cloud` with custom output formats that exclude OCSF, Prowler generates a temporary OCSF file for upload: @@ -169,7 +168,7 @@ When default output formats include OCSF, Prowler reuses the existing file. Defa prowler aws --services accessanalyzer --push-to-cloud -o /tmp/scan-output ``` -### CLI output examples +### CLI Output Examples **Successful upload:** ``` @@ -228,7 +227,7 @@ curl -X POST \ https://api.prowler.com/api/v1/ingestions ``` -### Submit an ingestion batch +### Submit an Ingestion Batch Upload a `.ocsf.json` file containing a JSON array of OCSF Detection Finding records. See [OCSF Detection Finding format](#ocsf-detection-finding-format) for the expected structure. @@ -266,7 +265,7 @@ curl -X POST \ } ``` -### Get ingestion status +### Get Ingestion Status Monitor the progress of an ingestion job. @@ -304,7 +303,7 @@ curl -X GET \ } ``` -### List ingestion jobs +### List Ingestion Jobs Retrieve a list of ingestion jobs for the tenant. @@ -332,7 +331,7 @@ curl -X GET \ "https://api.prowler.com/api/v1/ingestions?filter[status]=completed&page[size]=10" ``` -### Get ingestion errors +### Get Ingestion Errors Retrieve error details for a specific ingestion job. @@ -346,7 +345,7 @@ curl -X GET \ https://api.prowler.com/api/v1/ingestions/3650fef9-8e5f-4808-a95f-74f0afae8499/errors ``` -## Ingestion status values +## Ingestion Status Values | Status | Description | |--------|-------------| @@ -355,7 +354,7 @@ curl -X GET \ | `completed` | All records processed successfully | | `failed` | Job encountered errors during processing | -## CI/CD integration +## CI/CD Integration Automate findings ingestion in CI/CD pipelines by setting the API key as a secret. @@ -391,7 +390,7 @@ prowler_scan: PROWLER_CLOUD_API_KEY: $PROWLER_CLOUD_API_KEY ``` -## Billing impact +## Billing Impact Each unique cloud account discovered in ingested OCSF findings counts as one **provider** in the Prowler Cloud subscription. diff --git a/docs/user-guide/tutorials/prowler-scan-scheduling.mdx b/docs/user-guide/tutorials/prowler-scan-scheduling.mdx index 7b9173de05..961d32ad14 100644 --- a/docs/user-guide/tutorials/prowler-scan-scheduling.mdx +++ b/docs/user-guide/tutorials/prowler-scan-scheduling.mdx @@ -4,14 +4,13 @@ description: 'Create, edit, and monitor recurring scans in Prowler Cloud and Ent --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { SubscriptionBanner } from "/snippets/subscription-banner.mdx" Scan Scheduling lets Prowler run recurring scans for connected providers. Use it to keep findings, compliance results, and resource inventory up to date without launching every scan manually. - -This feature is available exclusively in **Prowler Cloud** and **Prowler Enterprise** with a [subscription](https://prowler.com/pricing). - + ## Prerequisites