Merge master

This commit is contained in:
mintlify-bot
2026-08-10 07:45:51 +00:00
2428 changed files with 134745 additions and 24745 deletions
+10 -18
View File
@@ -7,16 +7,16 @@ import { ProviderCards } from "/snippets/provider-cards.mdx"
**Prowler Cloud** is a web application that simplifies running Prowler. This tutorial will guide you through setting up and using it.
We refer to **Prowler App** as the self-hosted version of **Prowler Cloud**.
**Prowler Local Server** is the self-hosted version of **Prowler Cloud**. See [Prowler product families](/getting-started/products) for every official product name.
## Accessing Prowler Cloud and API Documentation
If you are a [Prowler Cloud](https://cloud.prowler.com/sign-in) user, you can access API docs at [https://api.prowler.com/api/v1/docs](https://api.prowler.com/api/v1/docs)
<Note>
**For Prowler App users**
**For Prowler Local Server users**
After [installing](/getting-started/installation/prowler-app) **Prowler App**, access it at [http://localhost:3000](http://localhost:3000).
After [installing](/getting-started/installation/prowler-app) **Prowler Local Server**, access it at [http://localhost:3000](http://localhost:3000).
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.
</Note>
@@ -45,7 +45,7 @@ See [how to configure Social Login for Prowler](/user-guide/tutorials/prowler-ap
</Note>
## Step 2: Log In
Once registered, log in with your email and password to access Prowler App.
Once registered, log in with your email and password to access Prowler Cloud.
<img src="/images/log-in.png" alt="Log In" width="350" />
@@ -85,12 +85,12 @@ For detailed instructions on configuring credentials for each provider, refer to
<ProviderCards />
## 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:
After adding your cloud account credentials, click the `Check connection` button to verify that Prowler can successfully connect to your provider:
<img src="/images/test-connection-button.png" alt="Test Connection" width="700" />
## 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:
After the connection check succeeds, save the provider and start your first scan with the `Launch Scan` button. The `Scans` section shows the scan in progress:
<img src="/images/provider-added.png" alt="Start Now" width="700" />
@@ -127,28 +127,22 @@ While the scan is running, start exploring the findings in these sections:
<img src="/images/compliance.png" alt="Compliance" width="700" />
- **Issues**: Types of issues detected.
<img src="/images/issues.png" alt="Issues" width="300" />
- **Browse All Findings**: Detailed list of findings detected, where you can filter by severity, service, and more.
- **Findings**: Detailed list of findings detected, where you can filter by severity, service, and more.
<img src="/images/findings.png" alt="Findings" width="700" />
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
Once a scan is complete, navigate to the Scan Jobs section to download the output files generated by Prowler:
Once a scan is complete, navigate to the `Scans` section to download the output files generated by Prowler:
<img src="/images/scan_jobs_section.png" alt="Scan Jobs section" width="700" />
You can download the output files generated by Prowler as a single `zip` file. This archive contains the CSV, JSON-OSCF, and HTML reports detailing the findings.
You can download the output files generated by Prowler as a single `zip` file. This archive contains the CSV, JSON-OCSF, and HTML reports detailing the findings.
To download these files, click the **Download** button. This button becomes available only after the scan has finished.
<img src="/images/download_output.png" alt="Download output" width="700" />
The `zip` file unpacks into a folder named like `prowler-output-<provider_id>-<timestamp>`, which includes all of the above outputs. In the example below, you can see the `.csv`, .`json`, and `.html` reports alongside a subfolder for detailed compliance checks.
The `zip` file unpacks into a folder named like `prowler-output-<provider_id>-<timestamp>`, which includes all of the above outputs. In the example below, you can see the `.csv`, `.json`, and `.html` reports alongside a subfolder for detailed compliance checks.
<img src="/images/output_folder.png" alt="Output folder" width="700" />
@@ -163,8 +157,6 @@ Once your scan has finished, you don’t need to grab the entire ZIP—just pull
- Navigate to the **Compliance** section of the UI.
<img src="/images/compliance_section.png" alt="Compliance section" width="700" />
- Find the Framework report you need.
- Click its **Download** icon to retrieve that report’s CSV file with all the detailed findings.