patterns/docs/index.md
Fabrizio Salmi ea474cbcf2 Add VitePress documentation with GitHub Pages deployment
- Create docs/ directory with VitePress configuration
- Add documentation for all web servers (Nginx, Apache, Traefik, HAProxy)
- Add bad bot detection and API reference documentation
- Add GitHub Actions workflow for automatic deployment to GitHub Pages
- Configure VitePress with sidebar, navigation, and search
2025-12-09 08:07:06 +01:00

2.1 KiB

layout hero features
home
name text tagline image actions
Patterns OWASP WAF Rules for Web Servers Automated OWASP CRS patterns and Bad Bot detection for Nginx, Apache, Traefik, and HAProxy
src alt
/shield.svg Patterns
theme text link
brand Get Started /getting-started
theme text link
alt View on GitHub https://github.com/fabriziosalmi/patterns
icon title details
🛡️ OWASP CRS Protection Leverages OWASP Core Rule Set for web application firewall defense against SQLi, XSS, RCE, and LFI attacks.
icon title details
🤖 Bad Bot Blocking Blocks known malicious bots and scrapers using regularly updated public bot lists.
icon title details
⚙️ Multi-Server Support Generates WAF configs for Nginx, Apache, Traefik, and HAProxy with consistent protection across platforms.
icon title details
🔄 Daily Updates GitHub Actions automatically fetch new OWASP rules daily and push updated configurations.
icon title details
📦 Pre-Generated Configs Download ready-to-use WAF configurations from GitHub Releases without building from source.
icon title details
🧩 Extensible Design Modular architecture makes it easy to extend support to other web servers or load balancers.

Quick Start

Download the latest configurations from GitHub Releases or build from source:

git clone https://github.com/fabriziosalmi/patterns.git
cd patterns
pip install -r requirements.txt
python owasp2json.py
python json2nginx.py  # or json2apache.py, json2traefik.py, json2haproxy.py

Supported Platforms

Platform Config Format Documentation
Nginx .conf files Read more →
Apache ModSecurity rules Read more →
Traefik Middleware TOML Read more →
HAProxy ACL files Read more →

::: tip Using Caddy? Check out the caddy-waf project for Caddy-specific WAF support. :::