Skip to content

Commit b20ca24

Browse files
Maffoochclaude
andauthored
docs: split Attaching Files into OS and Pro guides with screenshots (#15104)
Replace the outdated, Findings-only add_files.md (which incorrectly claimed image-only support) with an audience-scoped OS/Pro pair, following the OS__/PRO__ convention already used by the risk_acceptance docs. - OS__add_files.md: Manage Files workflow for Findings, Engagements, and Tests; corrected the supported file-type list to match DD_FILE_UPLOAD_TYPES; added fresh screenshots. - PRO__add_files.md: documents the Pro UI flow (gear > Add File, the Files tab, and the row menu's Edit File Name / Delete File). - Add OS_/PRO_ prefixed screenshots; preserve the old /add_files/ URL via an alias on the OS page. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent ffeddce commit b20ca24

8 files changed

Lines changed: 123 additions & 24 deletions

File tree

7.74 KB
Loading
76.6 KB
Loading
26.6 KB
Loading
150 KB
Loading
137 KB
Loading
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: "Attaching Files"
3+
description: "Upload screenshots, reports, or other supporting files to a Finding, Engagement, or Test in DefectDojo OS"
4+
audience: opensource
5+
weight: 3
6+
aliases:
7+
- /triage_findings/findings_workflows/add_files/
8+
---
9+
10+
You can attach files to a **Finding**, an **Engagement**, or a **Test** to provide
11+
supporting context — for example a proof-of-concept screenshot, a raw scanner report, a
12+
network diagram, or a spreadsheet that backs up a result.
13+
14+
Each object keeps its own set of files, and you can attach **up to 10 files** to a single
15+
object.
16+
17+
## Supported File Types
18+
19+
By default the following extensions are accepted:
20+
21+
```
22+
.txt .pdf .json .xml .csv .yml .png .jpeg
23+
.sarif .xlsx .doc .html .js .nessus .zip .fpr
24+
```
25+
26+
Administrators can change this list with the `DD_FILE_UPLOAD_TYPES` environment variable.
27+
Uploading a file whose extension is not in the list is rejected by the form.
28+
29+
Image files (such as `.png` and `.jpeg`) are rendered as a thumbnail preview, while other
30+
file types are shown with a generic file icon. In both cases, clicking the file downloads
31+
it.
32+
33+
## How to Attach a File to a Finding
34+
35+
1. Open the Finding you want to attach a file to.
36+
2. Open the actions menu (the **** button in the top-right of the Finding) and click
37+
**Manage Files**.
38+
39+
![Manage Files in the Finding actions menu](images/OS_manage_files_menu.png)
40+
41+
3. On the **Add files** page, enter a **Title** for the file and choose the file from your
42+
computer. You can add up to three files at a time; save and return to add more if needed.
43+
44+
![The Manage Files upload form](images/OS_manage_files_form.png)
45+
46+
4. Click **Save**.
47+
48+
The file is then listed in the **Files** panel of the Finding. Image files appear as a
49+
thumbnail:
50+
51+
![Files panel on a Finding showing an attached screenshot](images/OS_finding_files_panel.png)
52+
53+
## Attaching Files to Engagements and Tests
54+
55+
Engagements and Tests use the same **Manage Files** workflow:
56+
57+
- On an **Engagement** or **Test** detail page, open the **Files** panel and click its edit
58+
(pencil) button, then add files exactly as you would for a Finding.
59+
60+
As with Findings, image attachments render as a thumbnail and other file types show a
61+
generic file icon.
62+
63+
## Viewing and Downloading Files
64+
65+
Attached files appear in the **Files** panel on the object's detail page. Click any file to
66+
download it. Access is permission-checked: a user must have **view** permission on the
67+
parent Finding, Engagement, or Test to download its files.
68+
69+
## Deleting Files
70+
71+
To remove a file, open **Manage Files** for the object, check the **Delete** checkbox under
72+
the file you want to remove, and click **Save**.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "Attaching Files"
3+
description: "Upload screenshots, reports, or other supporting files to a Finding, Engagement, or Test in DefectDojo Pro"
4+
audience: pro
5+
weight: 3
6+
---
7+
8+
You can attach files to a **Finding**, an **Engagement**, or a **Test** to provide
9+
supporting context — for example a proof-of-concept screenshot, a raw scanner report, a
10+
network diagram, or a spreadsheet that backs up a result.
11+
12+
Each object keeps its own set of files, and you can attach **up to 10 files** to a single
13+
object.
14+
15+
## Supported File Types
16+
17+
By default the following extensions are accepted:
18+
19+
```
20+
.txt .pdf .json .xml .csv .yml .png .jpeg
21+
.sarif .xlsx .doc .html .js .nessus .zip .fpr
22+
```
23+
24+
Administrators can change this list with the `DD_FILE_UPLOAD_TYPES` environment variable.
25+
Uploading a file whose extension is not in the list is rejected.
26+
27+
## How to Attach a File to a Finding
28+
29+
1. Open the Finding you want to attach a file to.
30+
2. Click the **gear (⚙) menu** in the top-right of the Finding and choose **Add File**.
31+
3. Enter a **Title** for the file and choose the file from your computer, then save.
32+
33+
![The Add File action in the Finding gear menu, with the Files tab below](images/PRO_attach_files_menu.png)
34+
35+
The same gear menu is available on **Engagement** and **Test** pages, so files can be
36+
attached to any of these objects the same way.
37+
38+
## Viewing and Downloading Files
39+
40+
Attached files are listed under the **Files** tab of the **Finding Overview** (and the
41+
equivalent section on Engagements and Tests). Click a file's title to download it.
42+
43+
![The Files tab on a Finding listing an attached file](images/PRO_finding_files_tab.png)
44+
45+
Access is permission-checked: a user must have **view** permission on the parent Finding,
46+
Engagement, or Test to download its files.
47+
48+
## Deleting Files
49+
50+
To remove a file, open the file's row menu (the **** icon) in the **Files** tab and choose
51+
**Delete File**. The same menu also offers **Edit File Name** to rename an attachment.

docs/content/triage_findings/findings_workflows/add_files.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)