From 7b45ed63cc2ed48b92c3b2fd4dbcd72068977c7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20Mart=C3=ADn?= Date: Mon, 8 Apr 2024 11:10:30 +0200 Subject: [PATCH] docs(dashboard): improve dashboard documentation (#3688) --- docs/tutorials/dashboard.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/tutorials/dashboard.md b/docs/tutorials/dashboard.md index f3f59a1c8c..27dbde73e6 100644 --- a/docs/tutorials/dashboard.md +++ b/docs/tutorials/dashboard.md @@ -5,6 +5,12 @@ Prowler allows you to run your own local dashboards using the csv outputs provid prowler dashboard ``` +To run Prowler local dashboard with docker, use: + +```sh +docker run toniblyx/prowler:latest dashboard +``` + The banner and additional info about the dashboard will be shown on your console: @@ -26,6 +32,37 @@ This page shows all the info related to the compliance selected, you can apply m +To add your own compliance to compliance page, add a file with the compliance name (using `_` instead of `.`) to the path `/dashboard/compliance`. + +In this file use the format present in the others compliance files to create the table. Example for CIS 2.0: +```python +import warnings + +from dashboard.common_methods import get_section_containers_cis + +warnings.filterwarnings("ignore") + + +def get_table(data): + aux = data[ + [ + "REQUIREMENTS_ID", + "REQUIREMENTS_DESCRIPTION", + "REQUIREMENTS_ATTRIBUTES_SECTION", + "CHECKID", + "STATUS", + "REGION", + "ACCOUNTID", + "RESOURCEID", + ] + ].copy() + + return get_section_containers_cis( + aux, "REQUIREMENTS_ID", "REQUIREMENTS_ATTRIBUTES_SECTION" + ) + +``` + ## S3 Integration If you are a Prowler Saas customer and you want to use your data from your S3 bucket, you can run: