Install WAFPass
Complete installation guide for WAFPass CLI, Server, and Dashboard — from a single pip install to a full Docker Compose stack.
Three components. One compliance workflow.
Install just the CLI for CI/CD pipelines, or add the server and dashboard for persistent history and visual exploration.
wafpass CLI
Core evaluation engine. Parses Terraform and AWS CDK, runs in any CI/CD pipeline. No cloud credentials needed.
wafpass-server
FastAPI REST API with PostgreSQL. Stores runs, waivers, risk acceptances, secrets findings, and full audit events.
wafpass-dashboard
React web dashboard. 22+ pages of compliance exploration, auditor-ready evidence export, and RBAC role management.
Docker Compose: Full Stack
The waf++ monorepo ships a unified docker-compose.yml. Clone once, configure your .env, and bring up the entire stack in a single command.
Push your first scan result:
Install Components Individually
Install only what you need. Start with the CLI for immediate CI/CD integration, then add server and dashboard when you're ready for persistent history and visual compliance exploration.
Install wafpass CLI
The core evaluation engine — parse IaC, evaluate controls, generate reports
From PyPI (recommended)
From source
macOS (Apple M-series)
Install wafpass-server
FastAPI persistence layer — stores runs, waivers, secrets findings, and audit events
From PyPI (recommended)
Configure & start
API docs available at http://localhost:8000/api/docs
Install wafpass-dashboard
React web dashboard — 22+ compliance views, evidence export, RBAC
Block non-compliant commits.
WAFPass ships a pre-commit hook that runs compliance checks before every git commit. Non-compliant commits are blocked automatically — no cloud call, no extra CI wait.
Works on macOS, Linux, and Windows (Git Bash / PowerShell).
One-time setup
Get up and running.
Download controls, run your first scan, and open the dashboard to explore your compliance posture.
1. Download Controls
WAF++ controls are published separately and downloaded on demand.
- Visit waf2p.dev/wafpass/
- Click Download Controls
- Extract to your controls directory
2. Run Your First Scan
Point WAFPass at your Terraform or CDK code and get a full compliance report.
3. Open the Dashboard
Explore your compliance posture, manage waivers, and export evidence packages.
- Open
localhost:3000(Docker) orlocalhost:5173(dev) - Login with admin credentials from your
.env - Explore findings, drift, and compliance matrix
Common issues & fixes.
Quick answers to the most frequent setup problems.
Controls not found
If wafpass check reports "controls directory not found", the CLI will display download instructions automatically. Follow the post-installation steps above.
Port already in use
Use a different port for the server or dashboard:
Database connection errors
Verify PostgreSQL is running and your DATABASE_URL is correct:
Docker build fails
Ensure all three repositories are cloned side-by-side in the same parent directory:
Ready to validate your infrastructure?
Download the WAF++ controls, run WAFPass against your Terraform or CDK code, and get a full compliance report in minutes.