mirror of
https://github.com/fabriziosalmi/patterns.git
synced 2025-12-29 16:15:12 +00:00
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
This commit is contained in:
63
docs/index.md
Normal file
63
docs/index.md
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
layout: home
|
||||
|
||||
hero:
|
||||
name: Patterns
|
||||
text: OWASP WAF Rules for Web Servers
|
||||
tagline: Automated OWASP CRS patterns and Bad Bot detection for Nginx, Apache, Traefik, and HAProxy
|
||||
image:
|
||||
src: /shield.svg
|
||||
alt: Patterns
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Get Started
|
||||
link: /getting-started
|
||||
- theme: alt
|
||||
text: View on GitHub
|
||||
link: https://github.com/fabriziosalmi/patterns
|
||||
|
||||
features:
|
||||
- icon: 🛡️
|
||||
title: OWASP CRS Protection
|
||||
details: Leverages OWASP Core Rule Set for web application firewall defense against SQLi, XSS, RCE, and LFI attacks.
|
||||
- icon: 🤖
|
||||
title: Bad Bot Blocking
|
||||
details: Blocks known malicious bots and scrapers using regularly updated public bot lists.
|
||||
- icon: ⚙️
|
||||
title: Multi-Server Support
|
||||
details: Generates WAF configs for Nginx, Apache, Traefik, and HAProxy with consistent protection across platforms.
|
||||
- icon: 🔄
|
||||
title: Daily Updates
|
||||
details: GitHub Actions automatically fetch new OWASP rules daily and push updated configurations.
|
||||
- icon: 📦
|
||||
title: Pre-Generated Configs
|
||||
details: Download ready-to-use WAF configurations from GitHub Releases without building from source.
|
||||
- icon: 🧩
|
||||
title: Extensible Design
|
||||
details: Modular architecture makes it easy to extend support to other web servers or load balancers.
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
Download the latest configurations from [GitHub Releases](https://github.com/fabriziosalmi/patterns/releases) or build from source:
|
||||
|
||||
```bash
|
||||
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 →](/nginx) |
|
||||
| **Apache** | ModSecurity rules | [Read more →](/apache) |
|
||||
| **Traefik** | Middleware TOML | [Read more →](/traefik) |
|
||||
| **HAProxy** | ACL files | [Read more →](/haproxy) |
|
||||
|
||||
::: tip Using Caddy?
|
||||
Check out the [caddy-waf](https://github.com/fabriziosalmi/caddy-waf) project for Caddy-specific WAF support.
|
||||
:::
|
||||
Reference in New Issue
Block a user