Skip to content

Commit 1eb78ee

Browse files
committed
feat: add the custom dashboard guide
Signed-off-by: Nicolas Crocfer <[email protected]>
1 parent b751537 commit 1eb78ee

File tree

9 files changed

+71
-0
lines changed

9 files changed

+71
-0
lines changed

docs/guides/custom_dashboards.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Custom Dashboards
2+
3+
Custom dashboards allow users to create a personalized homepage populated with dynamic widgets.
4+
5+
Widgets can be freely positioned, resized, and configured.
6+
7+
## Why Use Custom Dashboards?
8+
9+
Custom dashboards allow CISOs and security analysts to build a monitoring environment perfectly tailored to their needs.
10+
11+
By combining dynamic widgets, you can:
12+
13+
- **Prioritize** vulnerabilities that matter most to your organization, such as CVEs with a high CVSS score or impacting critical assets.
14+
- **Track** the progress of vulnerability management workflows using custom tags (e.g., `to-check`, `in-progress`, `validated`).
15+
- **Monitor** project-specific risks by isolating CVEs related to a given customer, department, or application.
16+
- **Centralize** key information (latest CVE activity, project status, reports) into a single, always up-to-date workspace.
17+
18+
This approach improves visibility, collaboration, and reaction speed, making it easier to focus on what truly matters in your vulnerability management process.
19+
20+
![Custom Dashboards](../images/guides/custom_dashboards/draggable-widgets.png){.center style="width:100%"}
21+
22+
## Available Widgets
23+
24+
- **CVEs Activity**: Displays the most recent CVE changes across all projects.
25+
- **CVEs by Project**: Displays CVEs associated with a selected project.
26+
- **CVEs by View**: Displays CVEs associated with a selected saved view.
27+
- **Last Reports**: Displays the latest CVE reports generated for your projects.
28+
- **Projects**: Displays the list of all projects within your organization.
29+
- **Tags**: Shows the list of tags you created to categorize CVEs.
30+
- **Views**: Lists your private views and your organization's public views.
31+
32+
![New Widget](../images/guides/custom_dashboards/new-widget.png){.center style="width:100%"}
33+
34+
## Create a Dashboard
35+
36+
Each user can create their own dashboard layout:
37+
38+
- Go to your organization's dashboard page.
39+
- Click on the **+** button:
40+
41+
![Add Save Buttons](../images/guides/custom_dashboards/add-save-buttons.png){.center style="width:60%"}
42+
43+
- Select a widget type and configure it:
44+
45+
![Configure Widget](../images/guides/custom_dashboards/configure-widget.png){.center style="width:100%"}
46+
47+
- Position and resize the widget as needed.
48+
- Save your layout once your dashboard is configured.
49+
50+
## Using Views in Dashboard
51+
52+
You can create [Views](views.md) based on **advanced queries** to filter CVEs based on specific criteria (CVSS scores, vendors, products, tags, etc.).
53+
54+
Example query:
55+
56+
```
57+
userTags:tocheck AND cvss31>=9 AND vendor:apache
58+
```
59+
60+
This view can then be added as a widget to your dashboard with the **CVEs by View** widget.
61+
62+
![Configure Widget](../images/guides/custom_dashboards/cves-by-view-widget.png){.center style="width:100%"}

docs/guides/views.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,11 @@ Save it, and your query is now available for quick access using the **Load** but
2626
![Load Query](../images/guides/views/load-query.png){.center style="width:100%"}
2727

2828
All your saved Views can be managed from the **Views section**. Simply click on a View to apply its query instantly or edit/delete it when needed.
29+
30+
## Using Views in Dashboard
31+
32+
Once you have created and saved a view, you can integrate it directly into your custom dashboard using the **CVEs by View** widget:
33+
34+
![CVEs by view Widget](../images/guides/views/cves-by-view-widget.png){.center style="width:80%"}
35+
36+
This allows you to monitor the CVEs matching your saved query without having to manually re-run searches.
73.7 KB
Loading
60.5 KB
Loading
141 KB
Loading
686 KB
Loading
440 KB
Loading
141 KB
Loading

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ nav:
2828
- Notifications: 'notifications.md'
2929
- Guides:
3030
- Advanced Search: 'guides/advanced_search.md'
31+
- Custom Dashboards: 'guides/custom_dashboards.md'
3132
- Views: 'guides/views.md'
3233
- Social Authentication: 'guides/social_auth.md'
3334
- Migrate OpenCVE v1 data: 'guides/migrate_opencve_v1.md'

0 commit comments

Comments
 (0)