Skip to content

Commit 73df054

Browse files
committed
Update README: remove legacy views, add installation and configuration sections
1 parent 0c8058a commit 73df054

1 file changed

Lines changed: 73 additions & 5 deletions

File tree

README.md

Lines changed: 73 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MITRE Caldera Plugin: Debrief
22

3-
A Caldera plugin: https://github.com/mitre/caldera
3+
A plugin for [MITRE Caldera](https://github.com/mitre/caldera)
44

55
Debrief is a plugin for gathering overall campaign information and analytics for
66
operations. It provides a centralized view of operation metadata, network topology
@@ -33,9 +33,77 @@ tactics & techniques with ATT&CK v18 detection strategy mapping, and step output
3333
- **ATT&CK v18 Detection Mapping** — Maps operation techniques to MITRE ATT&CK v18 detection strategies and analytics
3434
- **Dark Theme UI** — Styled tables and cards matching Caldera's purple theme
3535

36-
## Legacy Views
36+
## Installation
3737

38-
![Operation Overview](docs/DebriefOverview.png)
39-
![Tactics and Techniques Table](docs/TacticsAndTechniquesTable.png)
38+
### As a Caldera Submodule (Recommended)
4039

41-
Example generated PDF: [Caldera Debrief Report](docs/Demo-Operation_Debrief_Example.pdf)
40+
Clone Caldera with the debrief plugin included:
41+
42+
```bash
43+
git clone https://github.com/mitre/caldera.git --recursive
44+
```
45+
46+
If Caldera is already cloned, add debrief as a plugin:
47+
48+
```bash
49+
cd caldera/plugins
50+
git clone https://github.com/mitre/debrief.git
51+
```
52+
53+
### Enable the Plugin
54+
55+
Add `debrief` to the list of enabled plugins in your Caldera configuration file (`conf/local.yml` or `conf/default.yml`):
56+
57+
```yaml
58+
plugins:
59+
- debrief
60+
```
61+
62+
### Install Python Dependencies
63+
64+
From your Caldera virtual environment:
65+
66+
```bash
67+
pip install reportlab svglib lxml aiohttp-jinja2
68+
```
69+
70+
### Build the Vue UI
71+
72+
Debrief uses the Magma Vue.js framework. Rebuild Magma to include the debrief plugin UI:
73+
74+
```bash
75+
cd caldera/plugins/magma
76+
npm install
77+
npm run build
78+
```
79+
80+
Or start Caldera with the `--build` flag:
81+
82+
```bash
83+
python server.py --insecure --build
84+
```
85+
86+
> **Note:** Requires Node.js >= 20.19 or >= 22.12 for Vite 7.
87+
88+
### Start Caldera
89+
90+
```bash
91+
cd caldera
92+
python server.py --insecure
93+
```
94+
95+
Navigate to the Caldera UI and click on the **debrief** plugin in the sidebar.
96+
97+
## Running Tests
98+
99+
```bash
100+
cd caldera/plugins/debrief
101+
pip install pytest pytest-asyncio
102+
python -m pytest tests/ -v
103+
```
104+
105+
## Configuration
106+
107+
Plugin configuration options can be set in `plugins/debrief/conf/default.yml`:
108+
109+
- `reportlab_trusted_hosts` — List of trusted hosts for ReportLab SVG rendering (optional)

0 commit comments

Comments
 (0)