Skip to content

Commit e278f42

Browse files
committed
Merge branch 'staging-new-docs' into metrics-draft
2 parents 62addef + 73a21a4 commit e278f42

65 files changed

Lines changed: 631 additions & 309 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

components/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "defectdojo",
3-
"version": "2.55.0-dev",
3+
"version": "2.54.1",
44
"license" : "BSD-3-Clause",
55
"private": true,
66
"dependencies": {
-64.9 KB
Loading

docs/assets/js/custom.js

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,60 @@
1-
// Put your custom JS code here
1+
// custom js
2+
3+
4+
// version toggler
5+
(() => {
6+
"use strict";
7+
8+
console.log("[VersionToggle] custom.js loaded");
9+
10+
const setVersion = (version) => {
11+
console.log("[VersionToggle] Setting version to:", version);
12+
13+
document.querySelectorAll(".version-opensource, .version-pro").forEach(el => {
14+
el.style.display = el.classList.contains(`version-${version}`) ? "" : "none";
15+
});
16+
17+
localStorage.setItem("version", version);
18+
console.log("[VersionToggle] localStorage updated:", localStorage.getItem("version"));
19+
20+
// Update dropdown
21+
const selects = document.querySelectorAll("#version-select");
22+
selects.forEach(sel => {
23+
sel.value = version;
24+
sel.dataset.version = version;
25+
sel.style.visibility = "visible";
26+
});
27+
28+
// unhide sidebar after version is applied
29+
const sidebar = document.querySelector(".docs-sidebar");
30+
if (sidebar) {
31+
sidebar.style.visibility = "visible";
32+
console.log("[VersionToggle] Sidebar revealed");
33+
}
34+
};
35+
36+
const initVersionToggle = () => {
37+
const storedVersion = localStorage.getItem("version") || "opensource";
38+
console.log("[VersionToggle] Stored version:", storedVersion);
39+
setVersion(storedVersion);
40+
};
41+
42+
// Delegated listener on body
43+
document.body.addEventListener("change", (e) => {
44+
if (e.target && e.target.id === "version-select") {
45+
console.log("[VersionToggle] Dropdown changed to:", e.target.value);
46+
setVersion(e.target.value);
47+
}
48+
});
49+
50+
// Run on DOM ready
51+
window.addEventListener("DOMContentLoaded", initVersionToggle);
52+
53+
// MutationObserver to detect dynamically replaced sidebar
54+
const observer = new MutationObserver(() => {
55+
// Re-run init to make sure menus match stored version
56+
initVersionToggle();
57+
});
58+
observer.observe(document.body, { childList: true, subtree: true });
59+
60+
})();

docs/assets/scss/common/_custom.scss

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,22 @@
5959

6060
html {
6161
font-size: 85%; /* scales all rem/em fonts */
62+
}
63+
64+
/* Hide sidebar until version is resolved */
65+
.docs-sidebar {
66+
visibility: hidden;
67+
}
68+
69+
70+
#version-select[data-version="opensource"] {
71+
background-color: #003964b7;
72+
border: 2px solid #003864;
73+
color: white;
74+
}
75+
76+
#version-select[data-version="pro"] {
77+
background-color: #a84e32b7;
78+
border: 2px solid #a84e32;
79+
color: white;
6280
}

docs/config/_default/menus/menus.en.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[[main]]
77
name = "Import data ⏷"
8-
url = "/import_data/"
8+
url = "/import_data/import_intro/comparison/"
99
weight = 12
1010

1111
[[main]]

docs/content/get_started/about/new_user_checklist.md renamed to docs/content/get_started/about/OS__new_user_checklist.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,12 @@ title: "☑️ New User Checklist"
33
description: "Get Started With DefectDojo"
44
draft: "false"
55
weight: 3
6-
chapter: true
6+
audience: opensource
77
---
88

9-
Here's a quick reference you can use to ensure successful implementation, from a blank canvas to a fully functional app.
9+
Here's a quick reference you can use to ensure successful implementation, from a blank canvas to a fully functional app. This article assumes you have **DefectDojo Community Edition** installed and running in your environment.
1010

11-
The essence of DefectDojo is to import security data, organize it, and present it to the folks who need to know. Here are ways to achieve those things in DefectDojo Pro and Open-Source:
12-
13-
### DefectDojo Pro
14-
15-
1. Start by [importing a file](/en/connecting_your_tools/import_scan_files/import_scan_ui) using the UI. This is generally the quickest way to see how your data fits into the DefectDojo model.
16-
17-
2. Now that you have data in DefectDojo, learn more about how to organize it with the [Product Hierarchy Overview](/en/working_with_findings/organizing_engagements_tests/product_hierarchy). The Product Hierarchy creates a working inventory of your apps, which helps you divide your data into logical categories, apply access control rules, sort Findings by [Priority and Risk](/en/working_with_findings/finding_priority/) or to segment your reports to the correct team.
18-
19-
3. Check out your [Metrics pages](/en/customize_dojo/dashboards/pro_dashboards/) which can be used to quickly share Finding reports with key stakeholders.
11+
The essence of DefectDojo is to import security data, organize it, and present it to the folks who need to know. Here are ways to achieve those things in DefectDojo Open-Source:
2012

2113
### DefectDojo Open-Source
2214

@@ -30,13 +22,6 @@ This is the essence of DefectDojo - import security data, organize it, and prese
3022

3123
All of these features can be automated, and because DefectDojo can handle over 200 tools (at time of writing) you should be all set to create a functional security inventory of your entire organizational output.
3224

33-
## Other guides
34-
35-
### Pro Features
36-
- If your organization uses ServiceNow, AzureDevops, GitHub or GitLab for issue tracking, check out our [documentation](/en/share_your_findings/integrations/) on those integrations.
37-
- Customize your [main Dashboard](/en/customize_dojo/dashboards/introduction_dashboard/) with filtered tiles to view your environment at a glance.
38-
- Learn how to rapidly import data and mirror your team's existing security environment with [Connectors](/en/connecting_your_tools/connectors/about_connectors/).
39-
4025
### Open-Source Features
4126
- Does your organization use Jira? Learn how to use our [Jira integration](/en/share_your_findings/jira_guide/) to create Jira tickets from the data you ingest.
4227
- Are you expecting to share DefectDojo with many users in your organization? Check out our guides to [user management](/en/customize_dojo/user_management/about_perms_and_roles/) and set up role-based access control (RBAC).
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "☑️ New User Checklist"
3+
description: "Get Started With DefectDojo"
4+
draft: "false"
5+
weight: 3
6+
audience: pro
7+
---
8+
9+
The essence of DefectDojo is to import security data, organize it, and present it to the folks who need to know. Here's a quick reference you can use to ensure successful implementation, from a blank canvas to a fully functional app.
10+
11+
### Discover DefectDojo
12+
13+
1. Start by [importing a file](/en/connecting_your_tools/import_scan_files/import_scan_ui) using the UI. This is generally the quickest way to see how your data fits into the DefectDojo model.
14+
15+
2. Now that you have data in DefectDojo, learn more about how to organize it with the [Product Hierarchy Overview](/en/working_with_findings/organizing_engagements_tests/product_hierarchy). The Product Hierarchy creates a working inventory of your apps, which helps you divide your data into logical categories, apply access control rules, sort Findings by [Priority and Risk](/en/working_with_findings/finding_priority/) or to segment your reports to the correct team.
16+
17+
3. Check out your [Metrics pages](/en/customize_dojo/dashboards/pro_dashboards/) which can be used to quickly share Finding reports with key stakeholders.
18+
19+
This is the essence of DefectDojo - import security data, organize it, and present it to the folks who need to know.
20+
21+
All of these features can be automated, and because DefectDojo can handle over 200 tools (at time of writing) you should be all set to create a functional security inventory of your entire organizational output.
22+
23+
### Pro Features
24+
- If your organization uses Jira, ServiceNow, AzureDevops, GitHub or GitLab for issue tracking, check out our [documentation](/en/share_your_findings/integrations/) on those integrations.
25+
- Customize your [main Dashboard](/en/customize_dojo/dashboards/introduction_dashboard/) with filtered tiles to view your environment at a glance.
26+
- Learn how to rapidly import data and mirror your team's existing security environment with [Connectors](/en/connecting_your_tools/connectors/about_connectors/).
Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,30 @@
11
---
2-
title: "See all products"
2+
title: "Feature comparison"
33
date: 2021-02-02T20:46:29+01:00
44
draft: false
55
type: docs
66
weight: 1
77
---
8+
9+
**DefectDojo Open-Source** is a powerful, free vulnerability management platform with core importing, deduplication, basic dashboards, API access, and essential reporting — ideal for smaller teams or those wanting to self-host and extend the tool using community resources.
10+
11+
**DefectDojo Pro** builds on that foundation with enterprise-oriented features such as advanced dashboards and reporting, automation and scripting via rules engine, connectors to many security tools, optimized import workflows, unified SOC & AppSec support, improved UI/UX, AI integration, enhanced security (SSO/MFA), and premium support options.
12+
13+
| Feature / Capability | DefectDojo Open-Source | DefectDojo Pro |
14+
|---------------------|------------------------|----------------|
15+
| Core vulnerability management | ✔️ Import, track, and manage findings from 200+ security tools | ✔️ Everything in open-source, optimized for scale |
16+
| Finding deduplication | ✔️ Standard deduplication | ✔️ Advanced, configurable deduplication |
17+
| REST API | ✔️ Full REST API | ✔️ Full REST API |
18+
| Authentication & access control | ✔️ Local auth and basic RBAC | ✔️ SSO (SAML/OAuth), MFA, advanced RBAC |
19+
| User interface | ✔️ Community UI | ✔️ Modern Pro UI with performance improvements |
20+
| Dashboards & reporting | ✔️ Basic dashboards and reports | ✔️ Advanced, customizable dashboards and executive reporting |
21+
| Automation & workflows | ❌ Not included | ✔️ Rules Engine and automated workflows |
22+
| Import enhancements | ❌ Standard imports only | ✔️ Background imports, Smart Upload, Universal Parser, CLI uploads |
23+
| Tool integrations | ❌ Manual/API-driven | ✔️ Built-in **API Connectors** for popular AppSec and cloud tools |
24+
| Jira integration | ✔️ Included | ✔️ Included |
25+
| Project management integrations | ❌ Not included | ✔️ integrate with **Azure Devops**, **GitHub**, **GitLab** and **ServiceNow** |
26+
| Finding enhancements | ❌ Not included | ✔️ Automatic KEV, EPSS scoring and Ransomware tracking |
27+
| SOC & AppSec unification | ❌ AppSec-focused only | ✔️ Unified AppSec and SOC findings |
28+
| AI & next-generation features | ❌ Not included | ✔️ AI-assisted workflows, reporting and MCP support |
29+
| Support | Community support (GitHub, Slack, forums) | Commercial support with SLAs |
30+
| Hosting options | Self-hosted | Self-hosted or cloud-hosted |
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "Online Demo"
3+
description: "There is DefectDojo demo site running the latest officially released version"
4+
draft: false
5+
weight: 6
6+
---
7+
8+
Two online demos are available for DefectDojo. Both come pre-loaded with data and are fully functional, running the latest version of DefectDojo.
9+
10+
Demo servers are reset on a daily basis, and are publicly accessible; do not put sensitive data in the demo.
11+
12+
### 🔸 DefectDojo Pro Demo
13+
DefectDojo Pro can be tested at [pro.demo.defectdojo.org](https://pro.demo.defectdojo.org)
14+
15+
Log in with `admin / 1Defectdojo@demo#appsec`.
16+
17+
### 🔹 DefectDojo Community Edition Demo
18+
Our community edition can be tested at [demo.defectdojo.org](https://demo.defectdojo.org)
19+
20+
Log in with `admin / 1Defectdojo@demo#appsec`.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: "🟦 DefectDojo Community Edition (Open Source)"
2+
title: "🔹 DefectDojo Community Edition"
33
date: 2021-02-02T20:46:29+01:00
44
weight: 3
5+
audience: opensource
56
---

0 commit comments

Comments
 (0)