From ed11cd032c8e787a28a0a46c6cf836f980e1e42d Mon Sep 17 00:00:00 2001 From: Sam Date: Thu, 10 Sep 2026 16:05:54 -0500 Subject: [PATCH 1/5] docs(pro): describe the Support pages, the docs search and the airgapped setting --- docs/content/navigation/PRO__support.md | 63 +++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/content/navigation/PRO__support.md diff --git a/docs/content/navigation/PRO__support.md b/docs/content/navigation/PRO__support.md new file mode 100644 index 00000000000..c1a9529ad0a --- /dev/null +++ b/docs/content/navigation/PRO__support.md @@ -0,0 +1,63 @@ +--- +title: "Support" +description: "Filing a support request from DefectDojo Pro, the documentation search above the form, the community board, and the settings that cover self-hosted and airgapped instances" +weight: 11 +audience: pro +--- + +DefectDojo Pro carries two support pages. **Support** is where you file a request and follow it. **Community requests** is the board of topics DefectDojo has published for customers to vote on. + +> The Support pages are a DefectDojo Pro feature. The instance calls DefectDojo from its own server, never from your browser. + +## Support requests + +**Support** (`/cloud/support`) holds one form and one list. + +The form takes four kinds of request: + +| Kind | Use it for | +| --- | --- | +| **Feature request** | Something DefectDojo does not do yet. | +| **Connector or parser request** | A tool you want DefectDojo to read from. | +| **Bug report** | Something that does not work as documented. | +| **General feedback** | Anything that is not one of the three above. | + +Under the form, **My requests** lists everything your account has filed, with the status DefectDojo staff last set on it. If the instance cannot reach DefectDojo, the list falls back to the copy the instance stores locally and the page says the status updates are paused. + +## Community requests + +**Community requests** (`/cloud/support/community`) lists the topics DefectDojo has published. Each row carries a title, a status and a vote button. Vote once per topic to say it matters to you. The count rises and the button locks. + +A request you file does not reach the board on its own. DefectDojo staff decide what to publish there. + +## The documentation search + +A search box sits above the request form. Type a question into it and it lists the documentation pages that match, so you can answer the question before you file anything. Select a page to open it in a new tab. + +The instance's own server reads the published documentation index (see `DOCS_SEARCH_URL` below) and keeps it for an hour. Your browser never calls the documentation site. + +A lookup that fails leaves the form usable. The box shows no matches and you file the request as normal. A failed lookup is remembered for a minute, so an outage at the documentation site does not slow down every keystroke. + +## Self-hosted instances + +A self-hosted instance enrols with DefectDojo using its own signed license rather than a portal secret. Enrolment happens on the first support call and needs no extra configuration. + +**One instance per license holds the enrolment at a time.** If a second instance running the same license enrols, it takes the enrolment over and the first instance can no longer reach DefectDojo. The instance that lost it writes an error to its log naming its own key, and it does not re-enrol on its own. Run one enrolled instance per license, and decide which one that is. + +An enrolment key that DefectDojo staff have revoked cannot be replaced by the instance. The instance logs the refusal and the support pages stay unavailable until staff clear the key. + +If enrolment is refused for any other reason, the log line names the credential the instance presented, so you know whether to check the license or the portal secret. + +## Airgapped instances + +An instance with no route off its network cannot use the support pages at all. Set `DD_AIRGAPPED` and both pages open a dialog that says support tracking is not supported for airgapped instances, with an address to write to instead. + +With the setting on, the instance makes no outbound support call and no documentation call. The dialog opens as soon as the page loads. It does not wait for a call to time out first. + +## Settings + +| Setting | Type | Default | What it does | +| --- | --- | --- | --- | +| `DD_AIRGAPPED` | boolean | `False` | Blocks both support pages and shows the airgapped dialog. | +| `SUPPORT_EMAIL` | string | `support@defectdojo.com` | The address the airgapped dialog tells people to write to. | +| `DOCS_SEARCH_URL` | string | `https://docs.defectdojo.com/search-index.json` | The documentation index the search box reads. | From b32fac4e2cef99b2784d2fcf17852350f1bf0875 Mon Sep 17 00:00:00 2001 From: Sam Date: Fri, 11 Sep 2026 13:50:50 -0500 Subject: [PATCH 2/5] docs(pro): the support search also lists community requests, and the form sits behind a link --- docs/content/navigation/PRO__support.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/content/navigation/PRO__support.md b/docs/content/navigation/PRO__support.md index c1a9529ad0a..05997c4589b 100644 --- a/docs/content/navigation/PRO__support.md +++ b/docs/content/navigation/PRO__support.md @@ -1,6 +1,6 @@ --- title: "Support" -description: "Filing a support request from DefectDojo Pro, the documentation search above the form, the community board, and the settings that cover self-hosted and airgapped instances" +description: "Filing a support request from DefectDojo Pro, the documentation and community search above the form, the community board, and the settings that cover self-hosted and airgapped instances" weight: 11 audience: pro --- @@ -11,7 +11,7 @@ DefectDojo Pro carries two support pages. **Support** is where you file a reques ## Support requests -**Support** (`/cloud/support`) holds one form and one list. +**Support** (`/cloud/support`) holds a search box, a request form behind a link, and a list. The form takes four kinds of request: @@ -30,13 +30,15 @@ Under the form, **My requests** lists everything your account has filed, with th A request you file does not reach the board on its own. DefectDojo staff decide what to publish there. -## The documentation search +## The documentation and community search -A search box sits above the request form. Type a question into it and it lists the documentation pages that match, so you can answer the question before you file anything. Select a page to open it in a new tab. +A search box sits at the top of the page. Type a question into it and it lists the open community requests that match, up to three, then the documentation pages that match, so you can find an answer or an existing request before you file anything. Select a community request to open the community board. Select a documentation page to open it in a new tab. + +The request form stays hidden until you select **Can't find what you're looking for?** under the box. The instance's own server reads the published documentation index (see `DOCS_SEARCH_URL` below) and keeps it for an hour. Your browser never calls the documentation site. -A lookup that fails leaves the form usable. The box shows no matches and you file the request as normal. A failed lookup is remembered for a minute, so an outage at the documentation site does not slow down every keystroke. +A lookup that fails leaves the form reachable. The box shows no matches and you file the request as normal. A failed lookup is remembered for a minute, so an outage at the documentation site does not slow down every keystroke. ## Self-hosted instances From 27e56bffde83ac0481e11fef6877dd76353ac8c8 Mon Sep 17 00:00:00 2001 From: Sam Date: Fri, 11 Sep 2026 14:18:40 -0500 Subject: [PATCH 3/5] docs(pro): the board outlines the request you arrived from --- docs/content/navigation/PRO__support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/navigation/PRO__support.md b/docs/content/navigation/PRO__support.md index 05997c4589b..6b77c8648dd 100644 --- a/docs/content/navigation/PRO__support.md +++ b/docs/content/navigation/PRO__support.md @@ -32,7 +32,7 @@ A request you file does not reach the board on its own. DefectDojo staff decide ## The documentation and community search -A search box sits at the top of the page. Type a question into it and it lists the open community requests that match, up to three, then the documentation pages that match, so you can find an answer or an existing request before you file anything. Select a community request to open the community board. Select a documentation page to open it in a new tab. +A search box sits at the top of the page. Type a question into it and it lists the open community requests that match, up to three, then the documentation pages that match, so you can find an answer or an existing request before you file anything. Select a community request to open the community board with that request outlined and scrolled into view. Select a documentation page to open it in a new tab. The request form stays hidden until you select **Can't find what you're looking for?** under the box. From ef9e1427a5bbb9433befdb66531909af524e26ab Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 14 Sep 2026 17:34:41 -0500 Subject: [PATCH 4/5] docs(support): describe completed and removed community requests --- docs/content/navigation/PRO__support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/navigation/PRO__support.md b/docs/content/navigation/PRO__support.md index 6b77c8648dd..dfde1e44b26 100644 --- a/docs/content/navigation/PRO__support.md +++ b/docs/content/navigation/PRO__support.md @@ -26,7 +26,7 @@ Under the form, **My requests** lists everything your account has filed, with th ## Community requests -**Community requests** (`/cloud/support/community`) lists the topics DefectDojo has published. Each row carries a title, a status and a vote button. Vote once per topic to say it matters to you. The count rises and the button locks. +**Community requests** (`/cloud/support/community`) lists the topics DefectDojo has published. Each row carries a title, a status and a vote button. Vote once per topic to say it matters to you. The count rises and the button locks. Completed topics (Shipped, Merged, Aged out) sit greyed out at the bottom of the board and no longer take votes. If DefectDojo decides not to pursue a topic, it leaves the board; a request you linked to it stays in **My requests**. A request you file does not reach the board on its own. DefectDojo staff decide what to publish there. From a4798d7b950f0b10ba196fe7858aa932b900d4f5 Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 16 Sep 2026 14:22:07 -0500 Subject: [PATCH 5/5] docs(support): airgapped is a feature flag; the support pages need no environment variables --- docs/content/navigation/PRO__support.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docs/content/navigation/PRO__support.md b/docs/content/navigation/PRO__support.md index dfde1e44b26..cf285ac4a2c 100644 --- a/docs/content/navigation/PRO__support.md +++ b/docs/content/navigation/PRO__support.md @@ -36,7 +36,7 @@ A search box sits at the top of the page. Type a question into it and it lists t The request form stays hidden until you select **Can't find what you're looking for?** under the box. -The instance's own server reads the published documentation index (see `DOCS_SEARCH_URL` below) and keeps it for an hour. Your browser never calls the documentation site. +The instance's own server reads the published documentation index at `docs.defectdojo.com` and keeps it for an hour. Your browser never calls the documentation site. A lookup that fails leaves the form reachable. The box shows no matches and you file the request as normal. A failed lookup is remembered for a minute, so an outage at the documentation site does not slow down every keystroke. @@ -52,14 +52,10 @@ If enrolment is refused for any other reason, the log line names the credential ## Airgapped instances -An instance with no route off its network cannot use the support pages at all. Set `DD_AIRGAPPED` and both pages open a dialog that says support tracking is not supported for airgapped instances, with an address to write to instead. +An instance with no route off its network cannot use the support pages at all. Turn on the **Airgapped instance** feature flag under **Settings → Feature Flags**. Both pages then open a dialog that says support tracking is not supported for airgapped instances, with the DefectDojo support address to write to instead. The flag takes effect on the next page load; no restart is needed. With the setting on, the instance makes no outbound support call and no documentation call. The dialog opens as soon as the page loads. It does not wait for a call to time out first. ## Settings -| Setting | Type | Default | What it does | -| --- | --- | --- | --- | -| `DD_AIRGAPPED` | boolean | `False` | Blocks both support pages and shows the airgapped dialog. | -| `SUPPORT_EMAIL` | string | `support@defectdojo.com` | The address the airgapped dialog tells people to write to. | -| `DOCS_SEARCH_URL` | string | `https://docs.defectdojo.com/search-index.json` | The documentation index the search box reads. | +The support pages need no environment variables. The one switch, **Airgapped instance**, is a feature flag under **Settings → Feature Flags** (off by default). The dialog address is `support@defectdojo.com`.