Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(dashboard): improve dashboard documentation #3688

Merged
merged 4 commits into from
Apr 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/tutorials/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
<img src="./img/dashboard/dashboard-banner.png">

Expand All @@ -26,6 +32,37 @@ This page shows all the info related to the compliance selected, you can apply m

<img src="./img/dashboard/dashboard-compliance.png">

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:
Expand Down