Skip to content

Commit fa391eb

Browse files
authored
docs(features): document Feature Flags page and correct feature enablement (#15289)
DefectDojo Pro can now turn most optional features on and off from Settings > Feature Flags, rather than requiring a request to support. Add a guide for that page and bring the affected feature docs in line with it. - Add admin/feature_flags/: how superusers view and toggle features, why a feature may be locked or unavailable, and how Cloud vs On-Premise differ. - Point to the Feature Flags guide from the Pro features overview, and add "how to enable" notes to Rules Engine and Rules Engine Scheduling. - Replace stale "contact support to enable" / beta-only wording in the Customizable Dashboards, Report Builder, Asset Hierarchy, Global Component Deduplication, and Integrations docs with the correct self-serve steps, and note which features are Cloud-only or deployment-managed.
1 parent e1e704b commit fa391eb

12 files changed

Lines changed: 156 additions & 17 deletions

File tree

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: "Feature Flags"
3+
description: "Turn optional DefectDojo Pro features on and off from the DefectDojo UI"
4+
weight: 1
5+
audience: pro
6+
---
7+
8+
Feature Flags let you turn optional DefectDojo Pro capabilities on and off for your own instance — features that previously could only be enabled by contacting DefectDojo Support can now be self-served from the UI.
9+
10+
The Feature Flags page is visible to **superusers** only. Other users, including Global Owners, do not see it.
11+
12+
## Opening the Feature Flags page
13+
14+
Go to **Settings > Feature Flags** in the left sidebar.
15+
16+
The page lists every optional feature with:
17+
18+
* **Name** — the feature, with a **BETA** tag when it is still in beta
19+
* **Description** — what the feature does
20+
* **Documentation link** — where documentation exists for that feature
21+
* **Toggle** — whether the feature is currently on
22+
23+
Use the search box to filter the list by feature name or description.
24+
25+
## Turning a feature on or off
26+
27+
1. Find the feature in the list.
28+
2. Click its toggle.
29+
3. The change takes effect immediately. You do not need to restart anything, and other users pick the change up on their next page load.
30+
31+
Some features show a confirmation dialog before the change is applied. This happens when enabling a feature that carries a warning (for example one that requires a restart or may affect existing data), or one that cannot be turned back off.
32+
33+
Turning a feature off is normally just the reverse of turning it on. The exceptions are called out in the next section.
34+
35+
## When a toggle is locked
36+
37+
A feature you cannot change is shown with a lock badge explaining why:
38+
39+
| Badge | What it means | What to do |
40+
| --- | --- | --- |
41+
| **Managed by DefectDojo** | DefectDojo has set this feature centrally for your instance. Your setting cannot override it. | Contact [DefectDojo Support](mailto:support@defectdojo.com) if you need it changed. |
42+
| **Unavailable on This Deployment** | The feature is not offered on your installation type. See [Feature availability](#feature-availability) below. | Nothing. The feature is not applicable to your instance. |
43+
| **Cannot Be Disabled** | The feature is already on and is one way. There is no mechanism to reverse it. | Nothing. This is expected. |
44+
| **Managed by deployment** | The feature is controlled by your deployment configuration rather than by this page. | See [DefectDojo Pro (On-Premise)](#defectdojo-pro-on-premise) below. |
45+
46+
## DefectDojo Pro (Cloud)
47+
48+
On [DefectDojo Pro (Cloud)](/get_started/pro/cloud/), **Settings > Feature Flags** is the only place you need. Toggle a feature on and it is live.
49+
50+
Two things are handled by DefectDojo rather than by you:
51+
52+
* **Managed by DefectDojo** — the feature is pinned centrally. Contact [DefectDojo Support](mailto:support@defectdojo.com) to have it changed.
53+
* **Managed by deployment** — the feature is part of how your instance is provisioned. Contact Support for these as well, since Cloud instances do not expose deployment configuration to customers.
54+
55+
Cloud instances also have access to features that are not offered on-premise. See [Feature availability](#feature-availability).
56+
57+
## DefectDojo Pro (On-Premise)
58+
59+
On [DefectDojo Pro (On-Premise)](/get_started/pro/onprem/), most features work exactly as they do on Cloud: open **Settings > Feature Flags** and toggle them.
60+
61+
A small number of features are read from your deployment configuration instead — they change how the application starts, so they cannot be flipped at runtime. These appear on the page as read-only, labeled **Managed by deployment**, and name the environment variable that controls them, for example `DD_ENABLE_V3_ORGANIZATION_ASSET_RELABEL`.
62+
63+
Because these features require a restart, and some of them cannot be reversed once enabled, check the feature's own documentation before changing one. Several are best enabled with help from [DefectDojo Support](mailto:support@defectdojo.com).
64+
65+
To change one of those features:
66+
67+
1. Set the environment variable on your DefectDojo deployment. The page tells you which variable to set.
68+
2. Restart DefectDojo so the new value is read at startup.
69+
3. Reload the Feature Flags page to confirm the new state.
70+
71+
Because these values are read at startup, changing them in the UI is not possible, and toggling them in your environment without a restart has no effect.
72+
73+
Features that are offered only on Cloud appear as **Unavailable on This Deployment** on an on-premise instance. This is expected and is not a licensing problem.
74+
75+
## Feature availability
76+
77+
Most features are available on both installation types. The exceptions are:
78+
79+
| Feature | Availability | How it is controlled |
80+
| --- | --- | --- |
81+
| Downstream Connections | [DefectDojo Pro (Cloud)](/get_started/pro/cloud/) only | Feature Flags page. Shown as **Unavailable on This Deployment** on-premise, which does not run the required infrastructure. See [Pro Integrations](/issue_tracking/pro_integration/integrations/). |
82+
| Request a New Connector | [DefectDojo Pro (Cloud)](/get_started/pro/cloud/) only | Feature Flags page. Shown as **Unavailable on This Deployment** on-premise. |
83+
| Locations | Both | Deployment configuration. Locations is in Beta and cannot be turned back off once enabled, so contact [DefectDojo Support](mailto:support@defectdojo.com) to have it enabled. See [Locations Overview](/asset_modelling/locations/pro__locations_overview/). |
84+
| Organization / Asset Relabeling | Both | Deployment configuration: `DD_ENABLE_V3_ORGANIZATION_ASSET_RELABEL`. |
85+
86+
Every other optional feature is toggled directly on the Feature Flags page on both Cloud and On-Premise instances.
87+
88+
## Frequently asked questions
89+
90+
**A feature I want is not in the list.**
91+
The list shows optional features only. Capabilities that are always on do not appear. If you expected a feature that is missing, confirm your license includes it, then contact [DefectDojo Support](mailto:support@defectdojo.com).
92+
93+
**I turned a feature on but I do not see it.**
94+
Reload the page — menu entries and routes are evaluated when the page loads, so a newly enabled feature appears on the next load rather than instantly in the current view.
95+
96+
**Will upgrading change my settings?**
97+
No. Upgrading preserves the features you have turned on and the ones you have turned off.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Feature Flags"
3+
description: "Turn optional DefectDojo Pro features on and off for your instance"
4+
summary: ""
5+
date: 2026-07-20T00:00:00+00:00
6+
lastmod: 2026-07-20T00:00:00+00:00
7+
draft: false
8+
weight: 4
9+
chapter: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
robots: "" # custom robot tags (optional)
15+
exclude_search: true
16+
---
17+
18+
Many DefectDojo Pro capabilities ship behind a feature flag so that you can adopt them when you are ready rather than on the release that introduces them.
19+
20+
Feature Flags are a DefectDojo Pro feature. Open-source DefectDojo does not have a feature flag surface.
21+
22+
* [Feature Flags](./pro__feature_flags/) — view every optional feature, turn features on and off, and understand why a feature might be unavailable on your instance.

docs/content/asset_modelling/PRO_hierarchy/assets_organizations.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,24 @@ Currently, this feature is in Beta.
1414

1515
Hierarchy features ship with new versions of DefectDojo Pro by default, but existing customers who wish to migrate these features can do so using the following methods
1616

17-
### Cloud Customers
17+
The two pieces are enabled separately, and by different means.
1818

19-
The hierarchy feature and label changes must be enabled by DefectDojo Support. Email [support@defectdojo.com](mailto:support@defectdojo.com) with your instance URL and request:
19+
### Asset Hierarchy
2020

21-
1. **Asset Hierarchy** — enables parent/child relationships between Assets. Once enabled, the hierarchy can be viewed and managed from the **Product** tab in the navigation.
22-
2. **Label Changes** (optional) — renames "Product Type" to "Organization" and "Product" to "Asset" throughout the UI. This is a separate step from enabling the hierarchy and can be requested at the same time or later.
21+
**Asset Hierarchy** enables parent/child relationships between Assets. Once enabled, the hierarchy can be viewed and managed from the **Product** tab in the navigation.
2322

24-
Note that label changes are cosmetic only: API endpoints and field names remain unchanged, so existing automation will continue to work.
23+
A superuser can turn it on from **Settings > Feature Flags**, on both Cloud and On-Premise instances. See [Feature Flags](/admin/feature_flags/pro__feature_flags/).
24+
25+
### Label Changes (optional)
26+
27+
**Label Changes** renames "Product Type" to "Organization" and "Product" to "Asset" throughout the UI. This is a separate step from enabling the hierarchy and can be done at the same time or later.
2528

26-
### On-Premise Customers
29+
Label changes are read from your deployment configuration when DefectDojo starts, so they are not toggled from the Feature Flags page:
2730

28-
Contact Support for guidance on enabling these features via your instance configuration.
31+
* **[DefectDojo Pro (Cloud)](/get_started/pro/cloud/)** — email [support@defectdojo.com](mailto:support@defectdojo.com) with your instance URL.
32+
* **[DefectDojo Pro (On-Premise)](/get_started/pro/onprem/)** — set `DD_ENABLE_V3_ORGANIZATION_ASSET_RELABEL` and restart DefectDojo. Contact Support if you would like guidance before making the change.
33+
34+
Note that label changes are cosmetic only: API endpoints and field names remain unchanged, so existing automation will continue to work.
2935

3036
## Significant Changes
3137

docs/content/automation/rules_engine/about.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ DefectDojo's Rules Engine allows you to build custom workflows and bulk actions
1212

1313
Rules Engine can only be accessed through the [Pro UI](/get_started/about/ui_pro_vs_os/).
1414

15+
## Enabling Rules Engine
16+
17+
Rules Engine is in Beta and is off by default. A superuser can turn it on from **Settings > Feature Flags**, on both Cloud and On-Premise instances. See [Feature Flags](/admin/feature_flags/pro__feature_flags/).
18+
1519
Currently, Rules can only be created for Findings, however more object types will be supported in the future.
1620

1721
Rules can be triggered manually from the **All Rules** page, or scheduled to run automatically on a recurring schedule. When a rule is triggered, it will be applied to all existing Findings that match the filter conditions set.

docs/content/automation/rules_engine/scheduling.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ audience: pro
88

99
Rules can be scheduled to run automatically rather than triggered manually each time. A scheduled rule will execute against all Findings that match its filter conditions at the configured time.
1010

11+
Scheduling is off by default. A superuser can turn on the **Scheduling Service** from **Settings > Feature Flags**, on both Cloud and On-Premise instances (see [Feature Flags](/admin/feature_flags/pro__feature_flags/)); the **Schedule Rule** option appears once it is enabled.
12+
1113
The user setting up the schedule must have the **Change Scheduling Service Schedule** configuration permission.
1214

1315
## Schedule Types

docs/content/get_started/pro/pro_features.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ See our [Universal Parser Guide](/import_data/pro/specialized_import/universal_p
104104

105105
![image](images/universal_parser_3.png)
106106

107+
## Managing optional features
108+
109+
Many of the capabilities above are optional and ship behind a feature flag, so you can adopt them when you are ready. A superuser can turn most of them on and off directly from **Settings > Feature Flags**, without contacting support.
110+
111+
See the [Feature Flags](/admin/feature_flags/pro__feature_flags/) guide for how to enable a feature, and for why a feature might be locked or unavailable on your installation type.
112+
107113
## Support
108114

109115
DefectDojo Pro subscriptions include world-class support for both on-premise and Cloud installations. Our team is available to help your organization implement and maximize your use of DefectDojo Pro. Your subscription includes:

docs/content/issue_tracking/pro_integration/integrations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ aliases:
77
---
88
**Availability:** Integrations is currently in **Beta** and is only available for **Cloud-hosted** DefectDojo Pro instances. On-premise deployments do not yet have the required infrastructure to support Integrations. If you are an on-premise customer interested in this feature, please contact [support@defectdojo.com](mailto:support@defectdojo.com) for updates on availability.
99

10+
**Enabling Integrations:** On a Cloud instance, a superuser can turn Integrations on from **Settings > Feature Flags**, where it is listed as **Downstream Connections**. See [Feature Flags](/admin/feature_flags/pro__feature_flags/). On an on-premise instance it is shown as **Unavailable on This Deployment**.
11+
1012
DefectDojo Pro's Integrations let you push your Findings and Finding Groups to ticket tracking systems to easily integrate security remediation with your teams existing development workflow.
1113

1214
Supported Integrations:

docs/content/metrics_reports/dashboards/PRO__custom_dashboards.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases:
99
- /en/customize_dojo/dashboards/about_custom_dashboard_tiles
1010
- /metrics_reports/dashboards/about_custom_dashboard_tiles
1111
---
12-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Customizable Dashboards (layouts, widgets, and the widget catalog) are a DefectDojo Pro feature, currently in beta. Beta features are available to DefectDojo Pro Cloud subscriptions — contact DefectDojo support or your customer success advocate to enable it for your instance.</span>
12+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Customizable Dashboards (layouts, widgets, and the widget catalog) are a DefectDojo Pro feature. They are off by default — a superuser can turn them on from **Settings > Feature Flags** on both Cloud and On-Premise instances.</span>
1313

1414
DefectDojo Pro Customizable Dashboards let each user assemble their own home page out of **widgets** — counts, charts, leaderboards, feeds, and notes — arranged on a drag-and-drop grid. Instead of a single fixed dashboard for everyone, you build the **layouts** that matter to you: an executive overview, a triage queue, a remediation-velocity board, a scanner-effectiveness view. You can keep layouts private, publish them to your whole team, set one as your default landing page, and clone any layout (yours or a shared template) as a starting point.
1515

@@ -23,13 +23,13 @@ DefectDojo Pro replaces that fixed page with **per-user customizable dashboards*
2323

2424
> **💡 Tip:** In DefectDojo Pro, **Assets** were formerly called **Products** and **Organizations** were formerly **Product Types**. The UI uses the new wording, but some underlying widget settings still use the legacy names — for example, most widgets take a `model` of `finding`, `product`, `engagement`, or `test`. Where this matters, it is called out below.
2525
26-
## Enabling the beta
26+
## Enabling Customizable Dashboards
2727

28-
Customizable Dashboards are off by default while in beta. Beta features are enabled per instance for DefectDojo Pro Cloud subscriptions — contact DefectDojo support ([support@defectdojo.com](mailto:support@defectdojo.com)) or your customer success advocate to turn on Customizable Dashboards for your instance.
28+
Customizable Dashboards are off by default. A superuser can turn them on from **Settings > Feature Flags**, on both Cloud and On-Premise instances. See [Feature Flags](/admin/feature_flags/pro__feature_flags/).
2929

3030
Once it is enabled, the **🏠 Home** page shows your customizable dashboard and the [Dashboards REST API](../custom-dashboards-api/) becomes available.
3131

32-
> **🔑 Important:** While the flag is off, the home page keeps the previous dashboard and every `/api/v2/dashboards/` endpoint returns `403 Dashboard V2 is not enabled.` Enabling the flag does **not** change anyone's data access — every widget still respects DefectDojo's role-based access control, so each user only ever sees the Findings, Assets, and other records they are authorized to view.
32+
> **🔑 Important:** While the feature is off, the home page keeps the previous dashboard and every `/api/v2/dashboards/` endpoint returns `403 Dashboard V2 is not enabled.` Turning it on does **not** change anyone's data access — every widget still respects DefectDojo's role-based access control, so each user only ever sees the Findings, Assets, and other records they are authorized to view.
3333
3434
## Core concepts
3535

docs/content/metrics_reports/dashboards/PRO__custom_dashboards_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ audience: pro
66
weight: 11
77
slug: custom-dashboards-api
88
---
9-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: The Customizable Dashboards REST API (layouts, widget catalog, and widget data) is a DefectDojo Pro feature, currently in beta. Beta features are available to DefectDojo Pro Cloud subscriptions — contact DefectDojo support or your customer success advocate to enable it for your instance.</span>
9+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: The Customizable Dashboards REST API (layouts, widget catalog, and widget data) is a DefectDojo Pro feature. It is off by default — a superuser can turn on Customizable Dashboards from **Settings > Feature Flags** on both Cloud and On-Premise instances.</span>
1010

1111
The Customizable Dashboards REST API lets you build the same dashboards you assemble by hand in the [Dashboards UI](../custom-dashboards/) — entirely from code. You can discover the widget catalog, create and update layouts, set your default, share layouts with your team, and even render a widget's data on demand without re-implementing DefectDojo's filtering. The layouts surface was designed as the primary entry point for AI agents building dashboards, so the request shapes are deliberately introspectable.
1212

@@ -45,7 +45,7 @@ curl -s \
4545
"https://[YOUR-INSTANCE].cloud.defectdojo.com/api/v2/dashboards/widget_catalog/"
4646
```
4747

48-
> **🔑 Important:** The entire Dashboards API is part of the beta. Until it is enabled for your instance, every endpoint returns `403 Dashboard V2 is not enabled.` — see [Enabling the beta](../custom-dashboards/#enabling-the-beta).
48+
> **🔑 Important:** The entire Dashboards API depends on the Customizable Dashboards feature. Until it is turned on, every endpoint returns `403 Dashboard V2 is not enabled.` — see [Enabling Customizable Dashboards](../custom-dashboards/#enabling-customizable-dashboards).
4949
5050
> **⚠️ Security Notice:** Your API token grants full access to your DefectDojo data. Never paste it into a chat, screenshot, ticket, or committed file. Read it from an environment variable, rotate it if it is ever exposed, and scope tokens to service accounts where possible.
5151

docs/content/metrics_reports/dashboards/PRO__custom_dashboards_llm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ audience: pro
66
weight: 12
77
slug: custom-dashboards-llm
88
---
9-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Automating Customizable Dashboards with the REST API and an LLM is a DefectDojo Pro feature, currently in beta. Beta features are available to DefectDojo Pro Cloud subscriptions — contact DefectDojo support or your customer success advocate to enable it for your instance.</span>
9+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Automating Customizable Dashboards with the REST API and an LLM is a DefectDojo Pro feature. It is off by default — a superuser can turn on Customizable Dashboards from **Settings > Feature Flags** on both Cloud and On-Premise instances.</span>
1010

1111
DefectDojo Pro's Customizable Dashboards are fully driven by the REST API — and the layouts surface was designed with AI agents in mind. That means you can hand the whole job to an LLM: paste one self-contained prompt into Claude, ChatGPT, or any other capable model, describe the dashboards you want, and it will interrogate your tenant's live widget catalog, propose layouts, emit a runnable Python script, create the layouts, verify them, and optionally set your default.
1212

@@ -22,7 +22,7 @@ This guide pairs with the [Dashboards API guide](../custom-dashboards-api/), whi
2222
export DD_IMPORTER_DOJO_API_TOKEN=<paste-token-here>
2323
```
2424

25-
2. **Confirm the beta is enabled.** Customizable Dashboards must be enabled for your instance — contact DefectDojo support or your customer success advocate — otherwise every API call returns `403`.
25+
2. **Confirm the feature is on.** Customizable Dashboards must be turned on for your instance from **Settings > Feature Flags** — otherwise every API call returns `403`.
2626

2727
3. **Decide your dashboards.** The LLM will ask what you want. Common choices:
2828

0 commit comments

Comments
 (0)