-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Conversation
You can check the documentation for this PR here -> SaaS Documentation |
docs/tutorials/dashboard.md
Outdated
To run Prowler local dashboard with docker, use: | ||
|
||
```sh | ||
docker run -e dashboard=dashboard <prowler-image> |
There was a problem hiding this comment.
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
?
There was a problem hiding this comment.
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
You can check the documentation for this PR here -> SaaS Documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔝
docs/tutorials/dashboard.md
Outdated
To run Prowler local dashboard with docker, use: | ||
|
||
```sh | ||
docker run <prowler-image> dashboard |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docker run <prowler-image> dashboard | |
docker run toniblyx/prowler:latest dashboard |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
docs/tutorials/dashboard.md
Outdated
@@ -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` |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
d12b636
to
e7a573f
Compare
You can check the documentation for this PR here -> SaaS Documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition @pedrooot 👏
Context
This pr improves dashboard documentation
Description
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.