diff --git a/docs/concepts/core.md b/docs/concepts/core.md index 0744338..537ea4d 100644 --- a/docs/concepts/core.md +++ b/docs/concepts/core.md @@ -83,6 +83,16 @@ It allows users to quickly understand where to focus, without manually reviewing ![Report Summary](../images/guides/report_summaries/report-summary.png){.center style="width:100%"} +## Dashboards + +**Dashboards** let you build a personalized homepage made of **dynamic widgets**: CVE activity, reports by project, saved views, tags, and more. Widgets can be freely positioned, resized, and configured to match your workflow. + +You can create **multiple dashboards** to organize your widgets — for example one per theme, team, or use case — and switch between them as needed. + +![Dashboards](../images/guides/dashboards/dashboards.png){.center style="width:100%"} + +This helps centralize key information, improve visibility over vulnerabilities, and focus on what matters most. For details and setup, see the [Dashboards](../guides/dashboards.md) guide. + ## Users Users are members of your organization who can collaborate within OpenCVE. diff --git a/docs/guides/custom_dashboards.md b/docs/guides/custom_dashboards.md deleted file mode 100644 index b1c9ad5..0000000 --- a/docs/guides/custom_dashboards.md +++ /dev/null @@ -1,62 +0,0 @@ -# Custom Dashboards - -Custom dashboards allow users to create a personalized homepage populated with dynamic widgets. - -Widgets can be freely positioned, resized, and configured. - -## Why Use Custom Dashboards? - -Custom dashboards allow CISOs and security analysts to build a monitoring environment perfectly tailored to their needs. - -By combining dynamic widgets, you can: - -- **Prioritize** vulnerabilities that matter most to your organization, such as CVEs with a high CVSS score or impacting critical assets. -- **Track** the progress of vulnerability management workflows using custom tags (e.g., `to-check`, `in-progress`, `validated`). -- **Monitor** project-specific risks by isolating CVEs related to a given customer, department, or application. -- **Centralize** key information (latest CVE activity, project status, reports) into a single, always up-to-date workspace. - -This approach improves visibility, collaboration, and reaction speed, making it easier to focus on what truly matters in your vulnerability management process. - -![Custom Dashboards](../images/guides/custom_dashboards/draggable-widgets.png){.center style="width:100%"} - -## Available Widgets - -- **CVEs Activity**: Displays the most recent CVE changes across all projects. -- **CVEs by Project**: Displays CVEs associated with a selected project. -- **CVEs by View**: Displays CVEs associated with a selected saved view. -- **Last Reports**: Displays the latest CVE reports generated for your projects. -- **Projects**: Displays the list of all projects within your organization. -- **Tags**: Shows the list of tags you created to categorize CVEs. -- **Views**: Lists your private views and your organization's public views. - -![New Widget](../images/guides/custom_dashboards/new-widget.png){.center style="width:100%"} - -## Create a Dashboard - -Each user can create their own dashboard layout: - -- Go to your organization's dashboard page. -- Click on the **+** button: - -![Add Save Buttons](../images/guides/custom_dashboards/add-save-buttons.png){.center style="width:60%"} - -- Select a widget type and configure it: - -![Configure Widget](../images/guides/custom_dashboards/configure-widget.png){.center style="width:100%"} - -- Position and resize the widget as needed. -- Save your layout once your dashboard is configured. - -## Using Views in Dashboard - -You can create [Views](views.md) based on **advanced queries** to filter CVEs based on specific criteria (CVSS scores, vendors, products, tags, etc.). - -Example query: - -``` -userTags:tocheck AND cvss31>=9 AND vendor:apache -``` - -This view can then be added as a widget to your dashboard with the **CVEs by View** widget. - -![Configure Widget](../images/guides/custom_dashboards/cves-by-view-widget.png){.center style="width:100%"} diff --git a/docs/guides/dashboards.md b/docs/guides/dashboards.md new file mode 100644 index 0000000..a9011ae --- /dev/null +++ b/docs/guides/dashboards.md @@ -0,0 +1,70 @@ +# Dashboards + +Dashboards allow users to create a personalized homepage populated with dynamic widgets. + +Widgets can be freely positioned, resized, and configured. You can create **multiple dashboards** to organize your widgets — for example one per theme, team, or monitoring focus — and switch between them depending on the context. + +![Dashboards](../images/guides/dashboards/dashboards.png){.center style="width:100%"} + +## Why Use Dashboards? + +Dashboards allow CISOs and security analysts to build a monitoring environment perfectly tailored to their needs. + +By combining dynamic widgets, you can: + +- **Prioritize** vulnerabilities that matter most to your organization, such as CVEs with a high CVSS score or impacting critical assets. +- **Track** the progress of vulnerability management workflows: assign CVEs to users per project, set their status (e.g., analysis, risk acceptance), and use custom tags (e.g., `to-check`, `in-progress`, `validated`) to follow your teams' progress. +- **Monitor** project-specific risks by isolating CVEs related to a given customer, department, or application. +- **Centralize** key information (latest CVE activity, project status, reports) into a single, always up-to-date workspace. + +This approach improves visibility, collaboration, and reaction speed, making it easier to focus on what truly matters in your vulnerability management process. + +## Available Widgets + +- **CVEs Activity**: Displays the most recent CVE changes across all projects. +- **CVEs by Assignment**: Displays CVEs filtered by project, assignee and status. +- **CVEs by Project**: Displays CVEs associated with a selected project. +- **CVEs by View**: Displays CVEs associated with a selected saved view. +- **Last Reports**: Displays the latest CVE reports generated for your projects. +- **My Assigned CVEs**: Displays the most recent CVEs assigned to you. +- **Projects**: Displays the list of all projects within your organization. +- **Tags**: Shows the list of tags you created to categorize CVEs. +- **Views**: Lists your private views and your organization's public views. + +## Create a Dashboard + +By default, each organization has a default dashboard. Users can create **additional dashboards** to better organize their widgets (e.g. one for high-priority CVEs, one per project, or one for daily reports). + +To add a new dashboard, click on the **Add** button: + +![Add Dashboard](../images/guides/dashboards/add-dashboard.png){.center style="width:60%"} + +Then add your first widget by clicking on the **New Widget** button: + +![New Widget](../images/guides/dashboards/new-widget.png){.center style="width:100%"} + +Each widget has its own configuration settings: + +![Configure Widget](../images/guides/dashboards/configure-widget.png){.center style="width:80%"} + +You can now rename your dashboard: + +![Rename Dashboard](../images/guides/dashboards/rename-dashboard.png){.center style="width:60%"} + +And position / resize your widgets as you need: + +![Draggable Widget](../images/guides/dashboards/draggable-widget.png){.center style="width:100%"} + +## Using Views in Dashboard + +You can create [Views](views.md) based on **advanced queries** to filter CVEs based on specific criteria (CVSS scores, vendors, products, tags, etc.). + +Example query: + +``` +userTags:tocheck AND cvss31>=9 AND vendor:apache +``` + +This view can then be added as a widget to your dashboard with the **CVEs by View** widget. + +![Configure Widget](../images/guides/dashboards/cves-by-view-widget.png){.center style="width:100%"} diff --git a/docs/guides/views.md b/docs/guides/views.md index 1f8c279..5dac415 100644 --- a/docs/guides/views.md +++ b/docs/guides/views.md @@ -29,7 +29,7 @@ All your saved Views can be managed from the **Views section**. Simply click on ## Using Views in Dashboard -Once you have created and saved a view, you can integrate it directly into your custom dashboard using the **CVEs by View** widget: +Once you have created and saved a view, you can integrate it directly into your dashboard using the **CVEs by View** widget: ![CVEs by view Widget](../images/guides/views/cves-by-view-widget.png){.center style="width:80%"} diff --git a/docs/images/guides/custom_dashboards/add-save-buttons.png b/docs/images/guides/custom_dashboards/add-save-buttons.png deleted file mode 100644 index 34a1b19..0000000 Binary files a/docs/images/guides/custom_dashboards/add-save-buttons.png and /dev/null differ diff --git a/docs/images/guides/custom_dashboards/draggable-widgets.png b/docs/images/guides/custom_dashboards/draggable-widgets.png deleted file mode 100644 index a1e226b..0000000 Binary files a/docs/images/guides/custom_dashboards/draggable-widgets.png and /dev/null differ diff --git a/docs/images/guides/custom_dashboards/new-widget.png b/docs/images/guides/custom_dashboards/new-widget.png deleted file mode 100644 index 3b88e74..0000000 Binary files a/docs/images/guides/custom_dashboards/new-widget.png and /dev/null differ diff --git a/docs/images/guides/dashboards/add-dashboard.png b/docs/images/guides/dashboards/add-dashboard.png new file mode 100644 index 0000000..4dcb2f7 Binary files /dev/null and b/docs/images/guides/dashboards/add-dashboard.png differ diff --git a/docs/images/guides/custom_dashboards/configure-widget.png b/docs/images/guides/dashboards/configure-widget.png similarity index 100% rename from docs/images/guides/custom_dashboards/configure-widget.png rename to docs/images/guides/dashboards/configure-widget.png diff --git a/docs/images/guides/custom_dashboards/cves-by-view-widget.png b/docs/images/guides/dashboards/cves-by-view-widget.png similarity index 100% rename from docs/images/guides/custom_dashboards/cves-by-view-widget.png rename to docs/images/guides/dashboards/cves-by-view-widget.png diff --git a/docs/images/guides/dashboards/dashboards.png b/docs/images/guides/dashboards/dashboards.png new file mode 100644 index 0000000..f8ecdd2 Binary files /dev/null and b/docs/images/guides/dashboards/dashboards.png differ diff --git a/docs/images/guides/dashboards/draggable-widget.png b/docs/images/guides/dashboards/draggable-widget.png new file mode 100644 index 0000000..87c2444 Binary files /dev/null and b/docs/images/guides/dashboards/draggable-widget.png differ diff --git a/docs/images/guides/dashboards/new-widget.png b/docs/images/guides/dashboards/new-widget.png new file mode 100644 index 0000000..4f5a006 Binary files /dev/null and b/docs/images/guides/dashboards/new-widget.png differ diff --git a/docs/images/guides/dashboards/rename-dashboard.png b/docs/images/guides/dashboards/rename-dashboard.png new file mode 100644 index 0000000..3e1dd82 Binary files /dev/null and b/docs/images/guides/dashboards/rename-dashboard.png differ diff --git a/docs/index.md b/docs/index.md index fb528c1..16ee432 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,25 +23,26 @@ Try **for free** OpenCVE on [https://www.opencve.io](https://www.opencve.io) or OpenCVE is a platform designed to help you **manage and monitor** the CVE database. It synchronizes the list of CVE (Common Vulnerabilities and Exposures) and allows you to **search, filter, and organize** them based on various criteria. -Users can **subscribe** to specific vendors or products and **receive notifications** when a new CVE is added or an existing one is updated. These notifications can be delivered via **Email or Webhook** (additional notification methods, such as **Slack**, are planned for future releases). +Users can **subscribe** to specific vendors or products and **receive notifications** when a new CVE is added or an existing one is updated. These notifications can be delivered via **Email, Webhook or Slack** (additional notification methods, such as **Microsoft Teams**, are planned for future releases). OpenCVE cross-references information from multiple reliable sources such as **MITRE**, **Vulnrichment**, **NVD**, and **RedHat**. This ensures that the vulnerability data remains accurate and up-to-date, even if one of the sources is temporarily unavailable. ## Features -- **Explore** the CVE database and filter the results by Vendor, Product, CVSS score or CWE -- **Subscribe** to vendors and products extracted from CPE -- **Organize** your subscription in your organizations and your projects +- **Explore** the CVE database and filter the results by Vendor, Product, CWE, CVSS, KEV or EPSS metrics +- **Subscribe** to vendors and products to follow the technologies you use (e.g. Apache, Microsoft, Fortinet, Cisco...) +- **Organize** your subscription in your organizations and projects - **Invite** other members into your organizations -- **Be notified** for new CVE and for CVE updates based on subscriptions -- **Analyse** all CVE details (vendors, products, CVSS score, CPE, CWE, References...) +- **Track** CVE handling by assigning users to CVEs and setting statuses (e.g. under analysis, risk accepted, to be verified) +- **Be notified** for new CVE and for CVE updates based on filters, on different channels +- **Analyse** all CVE details (vendors, products, versions, CVSS score, KEV, EPSS, CPE, CWE, References...) - **Create** custom tags (unread, important, devteam...) to organize the CVE list - **Display** the history of each CVE and see their last changes in the homepage - **Retrieve** the last changes in custom reports - **Customize** the notification settings (type of change, filter by score...) - **Integrate** OpenCVE with your own tools using the Webhook notification or the Rest API -You can use **for free** these features on the public instance: [https://www.opencve.io](https://www.opencve.io). +You can use these features on the public instance: [https://www.opencve.io](https://www.opencve.io). ## How to Use OpenCVE diff --git a/mkdocs.yml b/mkdocs.yml index db52f81..d0fb0a0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,7 +28,7 @@ nav: - Notifications: 'concepts/notifications.md' - Guides: - Advanced Search: 'guides/advanced_search.md' - - Custom Dashboards: 'guides/custom_dashboards.md' + - Dashboards: 'guides/dashboards.md' - Views: 'guides/views.md' - Social Authentication: 'guides/social_auth.md' - Migrate OpenCVE v1 data: 'guides/migrate_opencve_v1.md'