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

Conversation

pedrooot
Copy link
Member

@pedrooot pedrooot commented Apr 8, 2024

Context

This pr improves dashboard documentation

Description

  • Use docker to run prowler dashboard
  • Add info about adding an own compliance to compliance page

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@pedrooot pedrooot requested a review from a team April 8, 2024 08:16
Copy link
Contributor

github-actions bot commented Apr 8, 2024

You can check the documentation for this PR here -> SaaS Documentation

To run Prowler local dashboard with docker, use:

```sh
docker run -e dashboard=dashboard <prowler-image>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of -e dashboard=dashboard?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch! I´ve updated it

Copy link
Contributor

github-actions bot commented Apr 8, 2024

You can check the documentation for this PR here -> SaaS Documentation

@jfagoagas jfagoagas self-requested a review April 8, 2024 08:31
Copy link
Member

@jfagoagas jfagoagas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔝

To run Prowler local dashboard with docker, use:

```sh
docker run <prowler-image> dashboard
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
docker run <prowler-image> dashboard
docker run toniblyx/prowler:latest dashboard

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@@ -26,6 +32,8 @@ 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`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate this more?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@pedrooot pedrooot force-pushed the dashboard-documentation branch from d12b636 to e7a573f Compare April 8, 2024 08:47
Copy link
Contributor

github-actions bot commented Apr 8, 2024

You can check the documentation for this PR here -> SaaS Documentation

Copy link
Member

@jfagoagas jfagoagas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition @pedrooot 👏

@jfagoagas jfagoagas merged commit 7b45ed6 into master Apr 8, 2024
10 checks passed
@jfagoagas jfagoagas deleted the dashboard-documentation branch April 8, 2024 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants