Catalyst / admin/Synapse-Sonar 14.8 GB / 57.8 GB 40.0 GB free
Help Sign in

admin / Synapse-Sonar

public

Attack Surface Simulation

Code Issues Pull requests Pipelines Packages Security Insights Wiki Settings
Synapse-Sonar / synapse-sonar / docs / README.md 803 B · main
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
# Synapse Sonar — Documentation

Generated PDF guides for Synapse Sonar.

| File | Audience |
|------|----------|
| [Synapse-Sonar-User-Admin-Guide.pdf](Synapse-Sonar-User-Admin-Guide.pdf) | End users & Tenant Admins — using and administering the web app |
| [Synapse-Sonar-Agent-Setup-Guide.pdf](Synapse-Sonar-Agent-Setup-Guide.pdf) | Operators deploying the collectors (Linux/Windows agents, passive sensor, NetscanXi feed) |

## Regenerating

The PDFs are produced from [`generate_guides.py`](generate_guides.py) (ReportLab).
Output is written next to the script, in this folder.

```bash
pip install reportlab
python generate_guides.py
```

Edit the content in `generate_guides.py` and re-run to update the PDFs. The
version/date stamp is set by the `VERSION` and `DATE` constants near the top.