diff --git a/dashboard/lib/layouts.py b/dashboard/lib/layouts.py index 5bcb52f99f..3842492d44 100644 --- a/dashboard/lib/layouts.py +++ b/dashboard/lib/layouts.py @@ -79,11 +79,6 @@ def create_layout_overview( className="flex justify-between items-center", ), html.Div(id="table", className="grid"), - html.Img( - referrerPolicy="no-referrer-when-downgrade", - src="https://prowlerpro.matomo.cloud/matomo.php?idsite=2&rec=1&action_name=dashboard-overview", - alt="", - ), ], className="grid gap-x-8 gap-y-8 2xl:container mx-auto", ) @@ -147,11 +142,6 @@ def create_layout_compliance( className="text-prowler-stone-900 text-lg font-bold", ), html.Div(className="flex flex-wrap", id="output"), - html.Img( - referrerPolicy="no-referrer-when-downgrade", - src="https://prowlerpro.matomo.cloud/matomo.php?idsite=2&rec=1&action_name=dashboard-compliance", - alt="", - ), ], className="grid gap-x-8 gap-y-8 2xl:container mx-auto", ) diff --git a/docs/tutorials/compliance.md b/docs/tutorials/compliance.md index bef1a26976..400d869855 100644 --- a/docs/tutorials/compliance.md +++ b/docs/tutorials/compliance.md @@ -1,7 +1,7 @@ # Compliance Prowler allows you to execute checks based on requirements defined in compliance frameworks. By default, it will execute and give you an overview of the status of each compliance framework: - + > You can find CSVs containing detailed compliance results inside the compliance folder within Prowler's output folder. @@ -12,7 +12,7 @@ prowler --compliance ``` Standard results will be shown and additionally the framework information as the sample below for CIS AWS 1.5. For details a CSV file has been generated as well. - + ## List Available Compliance Frameworks In order to see which compliance frameworks are cover by Prowler, you can use option `--list-compliance`: diff --git a/docs/tutorials/dashboard.md b/docs/tutorials/dashboard.md new file mode 100644 index 0000000000..f3f59a1c8c --- /dev/null +++ b/docs/tutorials/dashboard.md @@ -0,0 +1,53 @@ +# Dashboard +Prowler allows you to run your own local dashboards using the csv outputs provided by Prowler + +```sh +prowler dashboard +``` + +The banner and additional info about the dashboard will be shown on your console: + + +## Overview Page + +The overview page provides a full impression of your findings obtained from Prowler: + + + +In this page you can do multiple functions: +* Apply filters (Assessment Date / Account / Region) +* See wich files has been scaned to generate the dashboard placing your mouse on the `?` icon: + +* Download the `Top 25 Failed Findings by Severity` table using the button `DOWNLOAD THIS TABLE AS CSV` + +## Compliance Page + +This page shows all the info related to the compliance selected, you can apply multiple filters depending on your preferences. + + + +## S3 Integration + +If you are a Prowler Saas customer and you want to use your data from your S3 bucket, you can run: + +```sh +aws s3 cp s3:///output/csv ./output --recursive +``` +to load the dashboard with the new files. + +## Output Path + +Prowler will use the outputs from the folder `/output` (for common prowler outputs) and `/output/compliance` (for prowler compliance outputs) to generate the dashboard. + +To change the path modify the values `folder_path_overview` or `folder_path_compliance` from `/dashboard/config.py` + +## Output Support + +Prowler dashboard supports the detailed outputs: + +| Provider | V3 | V4 | COMPLIANCE-V3 | COMPLIANCE-V4| +|---|---|---|---|---| +| AWS | ✅ | ✅ | ✅ | ✅ | +| Azure | ❌ | ✅ | ❌ | ✅ | +| Kubernetes | ❌ | ✅ | ❌ | ✅ | +| GCP | ❌ | ✅ | ❌ | ✅ | diff --git a/docs/tutorials/img/compliance-cis-sample1.png b/docs/tutorials/img/compliance/compliance-cis-sample1.png similarity index 100% rename from docs/tutorials/img/compliance-cis-sample1.png rename to docs/tutorials/img/compliance/compliance-cis-sample1.png diff --git a/docs/tutorials/img/compliance.png b/docs/tutorials/img/compliance/compliance.png similarity index 100% rename from docs/tutorials/img/compliance.png rename to docs/tutorials/img/compliance/compliance.png diff --git a/docs/tutorials/img/dashboard/dashboard-banner.png b/docs/tutorials/img/dashboard/dashboard-banner.png new file mode 100644 index 0000000000..c232f422fe Binary files /dev/null and b/docs/tutorials/img/dashboard/dashboard-banner.png differ diff --git a/docs/tutorials/img/dashboard/dashboard-compliance.png b/docs/tutorials/img/dashboard/dashboard-compliance.png new file mode 100644 index 0000000000..2dcf539497 Binary files /dev/null and b/docs/tutorials/img/dashboard/dashboard-compliance.png differ diff --git a/docs/tutorials/img/dashboard/dashboard-files-scanned.png b/docs/tutorials/img/dashboard/dashboard-files-scanned.png new file mode 100644 index 0000000000..2629a8ac77 Binary files /dev/null and b/docs/tutorials/img/dashboard/dashboard-files-scanned.png differ diff --git a/docs/tutorials/img/dashboard/dashboard-overview.png b/docs/tutorials/img/dashboard/dashboard-overview.png new file mode 100644 index 0000000000..d69f19f0b2 Binary files /dev/null and b/docs/tutorials/img/dashboard/dashboard-overview.png differ diff --git a/mkdocs.yml b/mkdocs.yml index e3634c305e..fa4dea4776 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,6 +37,7 @@ nav: - Miscellaneous: tutorials/misc.md - Reporting: tutorials/reporting.md - Compliance: tutorials/compliance.md + - Dashboard: tutorials/dashboard.md - Quick Inventory: tutorials/quick-inventory.md - Slack Integration: tutorials/integrations.md - Configuration File: tutorials/configuration_file.md