README rewritten from scratch so a newcomer can follow it (closes #154, closes #155)

Browse Source

The old README opened with project history and one list of a hundred
settings. The new one leads with what smallwebwaf is, what it protects
against, how to build and deploy it, how it sits in front of the app,
what happens to a request, the settings most deployments touch, how to
check it works and how to develop it. The reference material, every
setting, bans, rule files, the Core Rule Set, the admin endpoints, the
request log, alerts, metrics, state files, lookups, reputation sources,
the image and gitea, moves to files under docs/, each linked from the
README. Every statement was checked against the code on next.

Model: fable-5-1

...

This commit is contained in:

sneak

2026-10-22 21:02:38 +00:00

parent eafcc3fd73

commit dfb44c5546

14 changed files with 1982 additions and 2344 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

README.md

+315 -2344

File diff suppressed because it is too large Load Diff