ScanNinja documentation¶
Documentation portal for the ScanNinja security platform.
-
What ScanNinja is, how the pieces fit, what's on the roadmap.
-
The Rust scanner agent — install on the hosts you want to monitor.
-
The Angular web UI for managing scanners, scans, findings, and reports.
-
The Azure function that mirrors and enriches the NVD CVE feed.
-
Cross-walks to PCI DSS 4.0, SOC 2 TSC, ISO 27001:2022, CMMC.
How this site is structured¶
Each product team owns its own section. Pages under Agent, Dashboard, and CVE function are synced from the matching source repo on every merge to that repo's main — don't edit them here, edit in the source.
Native pages (Platform, Compliance) live in this repo and are edited directly.
For contributors¶
# Local preview
python3.12 -m venv .docs-venv
.docs-venv/bin/pip install -r requirements-docs.txt
.docs-venv/bin/mkdocs serve
# → http://127.0.0.1:8000
The deploy workflow (.github/workflows/deploy.yml) publishes to GitHub Pages on every push to main. The sync workflow (.github/workflows/sync-from-source.yml) fires on repository_dispatch events from each source repo. See scripts/sync-source.sh for the rsync mechanics.