Docs Index

Docs index (main repo)

Canonical long-form docs live in the repository under docs/. This wiki is the map + quick answers.

Doc	Topic
README	Overview, downloads, quick start
CONTRIBUTING	How to PR
SECURITY	Security policy
docs/TUTORIAL.md	Windows walkthrough
docs/CLI.md	Commands
docs/OPTIONS.md	Flags
docs/WORKFLOW.md	scan → e2e → configs (+ flat generate dns)
docs/CLIENTS.md	NetMod / DMVPN / SlipNet
docs/SANITIZE.md	Input list cleanup
docs/WEB.md	Web panel
docs/SECURITY_WEB.md	Web security details
docs/FFI_PYTHON.md	DLL / SO / Android FFI
docs/ENV.md	.env
docs/DOCKER.md	Docker
docs/SLIPNET.md	Slipnet offline / fetch
docs/BUILD.md	Build notes
docs/CROSS_PLATFORM.md	Platforms
docs/BACKUP.md	Backup helpers
docs/MEMORY.md	Large lists / low RAM (stream-to-disk)
docs/TESTING.md	Tests
LICENSE	Non-commercial license

Wiki shortcuts: Quick-Start · CLI-Cheat-Sheet · FAQ