Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/config/_default/hugo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title = "DefectDojo Documentation"
baseurl = "http://localhost/"
disableAliases = true
disableAliases = false
disableHugoGeneratorInject = true
disableKinds = ["taxonomy", "term"]
enableEmoji = true
Expand Down
3 changes: 2 additions & 1 deletion docs/content/admin/notifications/about_notifications.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "About Notifications & 🔔 Alerts"
description: "Learn about notifications, in-app alerts"
aliases:
- /en/customize_dojo/notifications/about_notifications
---

DefectDojo keeps you up to date in a variety of ways. Notifications can be sent for upcoming Engagements, user Mentions, SLA expiry, and other events in the software.

This article contains an overview of notifications at both System\-wide and Personal levels.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Set Personal Notifications"
description: "Configure notifications for a personal account"
aliases:
- /en/customize_dojo/notifications/configure_personal_notifs
---

## Configure Personal notifications

Personal Notifications are sent in addition to System\-Wide Notifications, and will apply to any Product, Product Type or other data type that you have access to. Personal Notification preferences only apply to a single user, and can only be set on the account which is configuring them.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Set System-Wide Notifications"
description: "How to configure Personal & System notifications"
aliases:
- /en/customize_dojo/notifications/configure_system_notifs
---

DefectDojo has two different kinds of notifications: **Personal** (sent to a single account) and **System** (which are sent to all users).

Both an account’s Personal Notifications and the global System Notifications can be configured from the same page: **⚙️Configuration \> Notifications** in the sidebar.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/admin/notifications/email_slack_teams.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Set up Email, Slack or Teams notifications"
description: "Set up Microsoft Teams to receive notifications"
aliases:
- /en/customize_dojo/notifications/email_slack_teams
---

**You will need Superuser access to use the System Settings page, which is required to complete this process.**

Notifications can be pushed to Slack or Teams when certain events trigger in DefectDojo.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: "Permissions in DefectDojo"
description: "Summary of all DefectDojo permission options, in detail"
weight: 2
aliases:
- /en/customize_dojo/user_management/about_perms_and_roles
---

If you have a team of users working in DefectDojo, it's important to set up Role\-Based Access Control (RBAC) appropriately so that users can only access specific data. Security data is highly sensitive, and DefectDojo's options for access control allow you to be specific about each team member’s access to information.

This article is an overview of how permissions in DefectDojo work. If you would prefer to see a detailed breakdown of **each action** that can be controlled by Permissions, see our **[Permissions Chart](../user_permission_chart/)** article.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/admin/user_management/audit_logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: "Audit Logs"
description: "Access audit logs for DefectDojo objects"
weight: 1
aliases:
- /en/customize_dojo/user_management/audit_logging
---

Audit logs for DefectDojo can be accessed in a few different ways.

## Individual Object Logs
Expand Down
3 changes: 2 additions & 1 deletion docs/content/admin/user_management/configure_sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: "SSO Configuration (OAuth, SAML)"
description: "Sign in to DefectDojo using OAuth or SAML login options"
pro-feature: true
aliases:
- /en/customize_dojo/user_management/configure_sso
---

Users can connect to DefectDojo with a Username and Password, but if you prefer, you can allow users to authenticate using a Single Sign\-On or SSO method. You can set up DefectDojo to work with your own SAML Identity Provider, but we also support many OAuth methods for authentication:

* **[Auth0](./#auth0-setup)**
Expand Down
3 changes: 2 additions & 1 deletion docs/content/admin/user_management/create_user_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: "Share permissions: User Groups"
description: "Share and maintain permissions for many users"
weight: 3
aliases:
- /en/customize_dojo/user_management/create_user_group
---

If you have a significant number of DefectDojo users, you may want to create one or more **Groups**, in order to set the same Role\-Based Access Control (RBAC) rules for many users simultaneously. Only Superusers can create User Groups.

Groups can work in multiple ways:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Set Permissions in Pro"
description: "Overhaul, pro feature"
weight: 3
audience: pro
aliases:
- /en/customize_dojo/user_management/pro_permissions_overhaul
---

## Introduction to Permission Types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Set a User's permissions"
description: "How to grant Roles & Permissions to a user, as well as superuser status"
weight: 2
audience: opensource
aliases:
- /en/customize_dojo/user_management/set_user_permissions
---

## Introduction to Permission Types

Individual users have four different kinds of permission that they can be assigned:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: "Action permission charts"
description: "All user permissions in detail"
weight: 4
aliases:
- /en/customize_dojo/user_management/user_permission_chart
---

## Role Permission Chart

This chart is intended to list all permissions related to a Product or Product Type, as well as which permissions are available to each role.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "SLA Configuration"
description: "Configure Service Level Agreements for different Products"
weight: 2
audience: opensource
aliases:
- /en/working_with_findings/sla_configuration
---

Each Product in DefectDojo can have its own Service Level Agreement (SLA) configuration, which represents the days your organization has to remediate or otherwise manage a Finding.

SLA can be set based on either **[Finding Severity](/asset_modelling/hierarchy/product_hierarchy/#findings)** or **[Finding Risk](/asset_modelling/hierarchy/pro__priority_sla/)** (in DefectDojo Pro).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "Integration of repositories to navigate to the location of finding
draft: false
weight: 5
audience: opensource
aliases:
- /en/working_with_findings/organizing_engagements_tests/source-code-repositories
---

Certain tools (particularly SAST tools) will include the associated file name and line number in vulnerability data. If the repository of the source code is specified in the Engagement, DefectDojo will present the filepath as a link and the user can navigate directly to the location of the vulnerability.

## Setting the repository in the Engagement and Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Assets and Organization structure"
description: "DefectDojo Pro - Product Hierarchy Overhaul"
audience: pro
weight: 1
aliases:
- /en/working_with_findings/organizing_engagements_tests/pro_assets_organizations
---

DefectDojo Pro is extending the Product/Product Type object classes to provide greater flexibility with the data model.

Currently, this feature is in Beta. Pro users who are interested in opting in can do so by emailing [support@defectdojo.com](mailto:support@defectdojo.com).
Expand Down
3 changes: 3 additions & 0 deletions docs/content/asset_modelling/hierarchy/PRO__priority_sla.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: "Assign Priority, Risk and SLAs"
description: "How DefectDojo ranks your Findings"
weight: 1
audience: pro
aliases:
- /en/working_with_findings/finding_priority
- /en/working_with_findings/priority_adjustments
---

![image](images/pro_finding_priority.png)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Product Health Grade"
description: "How DefectDojo calculates a Product Health Grade"
aliases:
- /en/working_with_findings/organizing_engagements_tests/product_health_grade
---

DefectDojo can calculate a grade for your Products based on the amount of Findings contained within. Grades are ranked from A \- F.

Note that only Active \& Verified Findings contribute to a Product Grade \- unverified Findings will not have an impact.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Product Hierarchy: Overview"
description: "Understand Product Types, Products, Engagements, Tests and Findings"
weight: 1
audience: opensource
aliases:
- /en/working_with_findings/organizing_engagements_tests/product_hierarchy
---

DefectDojo uses five main data classes to organize your work: **Product Types, Products**, **Engagements**, **Tests**, and **Findings**.

DefectDojo is made to be flexible to conform to your team, rather than making your team conform to the tool. You'll be able to design a robust, adaptable workspace once you understand how these data classes can be used to organize your work.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ draft: false
weight: 2
exclude_search: false
audience: pro
aliases:
- /en/working_with_findings/organizing_engagements_tests/tagging_objects
---

Tags are ideal for grouping objects in a manner that can be filtered out into smaller, more digestible chunks. They can be used to denote status, or to create custom sets of Product Type, Products, Engagements or Findings across the data model.

In DefectDojo, tags are a first class citizen and are recognized as the facilitators
Expand Down
3 changes: 2 additions & 1 deletion docs/content/automation/api/api-v2-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "DefectDojo API v2"
description: "DefectDojo's API lets you automate tasks, e.g. uploading scan reports in CI/CD pipelines."
draft: false
weight: 2
aliases:
- /en/api/api-v2-docs
---

DefectDojo\'s API is created using [Django Rest
Framework](http://www.django-rest-framework.org/). The documentation of
each endpoint is available within each DefectDojo installation at
Expand Down
3 changes: 2 additions & 1 deletion docs/content/automation/rules_engine/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Rules Engine Automation"
description: "Working with Rules Engine Automation"
weight: 1
audience: pro
aliases:
- /en/customize_dojo/rules_engine
---

<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Rules Engine is a DefectDojo Pro-only feature.</span>

DefectDojo's Rules Engine allows you to build custom workflows and bulk actions to handle Findings and other objects. Rules Engine allows you to build automated actions that are triggered when an object matches a Rule.
Expand Down
2 changes: 2 additions & 0 deletions docs/content/get_started/about/PRO__new_user_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: "Get Started With DefectDojo"
draft: "false"
weight: 3
audience: pro
aliases:
- /en/about_defectdojo/new_user_checklist
---

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.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/about/about_defectdojo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ date: 2021-02-02T20:46:29+01:00
draft: false
type: docs
weight: 1
aliases:
- /en/about_defectdojo/about_docs
---

![image](images/dashboard.png)


Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "DefectDojo FAQ"
draft: "false"
weight: 2
chapter: true
aliases:
- /en/about_defectdojo/faq
---

Here are some frequently asked questions about working with DefectDojo - both in DefectDojo Pro or DefectDojo OS.

## General Questions
Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/about/ui_pro_vs_os.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "Working with different UIs in DefectDojo"
draft: "false"
weight: 5
audience: pro
aliases:
- /en/about_defectdojo/ui_pro_vs_os
---

In late 2023, DefectDojo Inc. released a new UI for DefectDojo Pro, which is now the default UI for this edition.

The Pro UI brings the following enhancements to DefectDojo:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "Use Cases and examples"
draft: "false"
weight: 2
chapter: true
aliases:
- /en/about_defectdojo/examples_of_use
---

This article is based on DefectDojo Inc's February 2025 Office Hours: "Tackling Common Use Cases".
<iframe width="560" height="315" src="https://www.youtube.com/embed/44vv-KspHBs?si=ilRBlfo-wvX5DPVg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/open_source/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "The DefectDojo platform consists of several components that work t
draft: false
weight: 1
audience: opensource
aliases:
- /en/open_source/installation/architecture
---

![image](images/dd-architecture.png)

## NGINX
Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/open_source/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "DefectDojo is highly configurable."
draft: false
weight: 2
audience: opensource
aliases:
- /en/open_source/installation/configuration
---

## dojo/settings/settings.dist.py

The main settings are stored in [`dojo/settings/settings.dist.py`](https://github.com/DefectDojo/django-DefectDojo/blob/master/dojo/settings/settings.dist.py). It is great to use this file as a reference for what can be configured, but it shouldn\'t be edited directly, because changes will be overwritten when updating DefectDojo. There are several methods to change the default settings:
Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/open_source/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "DefectDojo supports various installation options."
draft: false
weight: 1
audience: opensource
aliases:
- /en/open_source/installation/installation
---

## **Recommended Options**
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "For use in Production environments, performance tweaks and backups
draft: false
weight: 4
audience: opensource
aliases:
- /en/open_source/installation/running-in-production
---

## Production Use (with Docker compose)

The docker-compose.yml file in this repository is fully functional to evaluate DefectDojo in your local environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Set up an additional Cloud instance"
description: "Add a test, dev, or other DefectDojo instance to your account"
weight: 3
audience: pro
aliases:
- /en/cloud_management/additional-cloud-instance
---

The process for adding a second Cloud instance is more or less the same as adding your first instance. This guide assumes you've already set up your initial DefectDojo server, and have an agreement with our Sales team to add another instance.

If you have not already requested an additional Cloud instance, please contact [info@defectdojo.com](mailto:info@defectdojo.com) before proceeding.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Connectivity Troubleshooting"
description: "Reconnect to your DefectDojo Instance"
weight: 2
audience: pro
aliases:
- /en/cloud_management/connectivity-troubleshooting
---

If you have difficulty accessing your DefectDojo instance, here are some steps you can follow to get reconnected:

## I can access the site, but I can't log in
Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/pro/cloud/using-cloud-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "Manage your subscription and account settings"
weight: 1
collapsed: true
audience: pro
aliases:
- /en/cloud_management/using-cloud-manager
---

Logging into DefectDojo's Cloud Manager allows you to configure your account settings and manage your subscription with DefectDojo Cloud.

## **New Subscription**
Expand Down
3 changes: 2 additions & 1 deletion docs/content/get_started/pro/pro_features.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ weight: 4
chapter: true
exclude_search: true
audience: pro
aliases:
- /en/about_defectdojo/pro_features
---

Here is a list of DefectDojo Pro’s many additional features, along with links to documentation to see them in action:

## Improved UX
Expand Down
3 changes: 2 additions & 1 deletion docs/content/help/contact_sales.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "How to request and work with a trial of DefectDojo Cloud"
draft: "false"
weight: 6
pro-feature: true
aliases:
- /en/about_defectdojo/request_a_trial
---

If your team requires an on-premise DefectDojo installation, please connect with our Sales team by emailing → [hello@defectdojo.com](mailto:hello@defectdojo.com) . This trial setup process only applies to DefectDojo Cloud users.

All DefectDojo plans include a free 2-week trial, which you can use to evaluate our software. DefectDojo Trial instances are fully-featured and can be immediately converted into paid instances by our team; no need to set everything up again, or reupload any data when your trial period ends.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/help/contact_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "For Pro users: support@defectdojo.com + other options"
draft: "false"
pro-feature: true
weight: 7
aliases:
- /en/about_defectdojo/contact_defectdojo_support
---

Need help with DefectDojo? Here are some ways to get assistance.

## Open-Source Support
Expand Down
3 changes: 2 additions & 1 deletion docs/content/import_data/import_intro/comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: "Import Method Comparison"
description: "Learn how to import data manually, through the API, or via a connector"
weight: 1
aliases:
- /en/connecting_your_tools/import_intro
---

One of the things we understand at DefectDojo is that every company’s security needs are completely different. There is no one-size-fits-all approach. As your organization changes, having a flexible approach is key, and DefectDojo allows you to connect your security tools in a flexible way to match those changes.

## Scan Upload Methods
Expand Down
Loading