|
| 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. |
0 commit comments