Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
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
7 changes: 2 additions & 5 deletions docs/content/help/contact_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,9 @@ Customers/Pro Users can always email our team directly at [support@defectdojo.co

### Within DefectDojo

You can contact the Support team through the DefectDojo App in two ways:
Open **Settings → Support** from the left sidebar. In the reorganized settings menu, open **Settings → License & Support → Support**. You can also go to **{your-instance}/ui/cloud/support**.

1. by opening **Cloud Manager > Contact Support** from the left sidebar
2. through **{your-instance}.defectdojo.com/cloud_portal/support**.

![image](images/contact_defectdojo_support.png)
On the Support page you can file a request, follow its status, and vote on community requests. On an airgapped instance, the page shows the support e-mail address instead. See [Support](/navigation/pro__support/) for details.

### Through the Cloud Portal

Expand Down
4 changes: 2 additions & 2 deletions docs/content/navigation/PRO__sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Settings is divided into eight groups, named for what you are trying to do rathe
| **Configuration** | Environments, Regulations, Note Types, Test Types, CI/CD Infrastructure, Tool Types, Tool Configurations |
| **Notifications** | Notification Events, Notification Webhooks |
| **Operations** | Audit Logs, Usage Logs, Schedules, Celery Status, and on DefectDojo Cloud, Message Portal, Firewall Rules, Maintenance Windows |
| **License & Support** | License Manager, Version Manager, Contact Support |
| **License & Support** | License Manager, Version Manager, Support |

**Feature Flags sits above the groups**, directly under All Settings, rather than inside any of them. It is the page administrators open most often, and it reads alongside All Settings: one lists what exists, the other controls what is switched on. It is still filed under System in the All Settings directory.

Expand Down Expand Up @@ -192,7 +192,7 @@ If you are used to the previous layout:
| Settings → Configuration → All Schedules | Settings → Operations → Schedules |
| Settings → Pro Settings → Celery Status | Settings → Operations → Celery Status |
| Settings → Cloud Manager → *(cloud pages)* | Settings → Operations |
| Settings → License Manager / Version Manager / Contact Support | Settings → License & Support |
| Settings → License Manager / Version Manager / Support | Settings → License & Support |

The group that was named after your license package, **Pro Settings** on a Pro instance and **Enterprise Settings** on an Enterprise one, no longer exists. Its pages are distributed across System, Finding Workflow, Notifications and Operations.

Expand Down
67 changes: 67 additions & 0 deletions docs/content/navigation/PRO__support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Support"
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
---

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

Open **Support** from **Settings → Support**, or from **Settings → License & Support → Support** in the reorganized settings menu. It shows on cloud, self-hosted and airgapped instances. The page (`/ui/cloud/support`) holds a search box, a request form behind a link, and a 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. |

A fifth choice, **Security disclosure**, files nothing. The form points you to DefectDojo's coordinated disclosure program on HackerOne instead.

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** (`/ui/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**. When a topic you voted on changes status, DefectDojo e-mails the address on your DefectDojo user, provided it is at your organization's e-mail domain (the domain of your Cloud Portal account).

A request you file does not reach the board on its own. DefectDojo staff decide what to publish there.

## 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. A tag on each result says **community request** or **documentation**. 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.

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.

## Self-hosted instances

Support works the same way on a self-hosted instance. The 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.

The instance calls `cloud.defectdojo.com` for support requests and the community board, and `docs.defectdojo.com` for the documentation search. Allow outbound HTTPS to both. If the instance has no route off its network, turn on **Airgapped instance** instead (see below).

**One instance per license holds the enrolment.** The first instance to enrol keeps it. A second instance running the same license is refused: it writes an error to its log naming its own key, and its support pages stay unavailable. To move the enrolment, ask DefectDojo support to reset it, then open the support pages on the instance that must keep it. The next instance to make a support call enrols.

A key that DefectDojo staff revoke stops working at once. The instance cannot replace it on its own, and its support pages stay unavailable until staff reset the enrolment.

A connector request from a self-hosted instance cannot carry tool details or credentials, because DefectDojo accepts those only from a cloud instance. The form says so. Send the request, then e-mail the details to `support@defectdojo.com`.

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. 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. Its **Go back** button returns you to the page you came from. 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

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`.
Loading