Home

Jump to bottom

Rajeev Sharma edited this page Oct 4, 2025 · 1 revision

Welcome to the mad-proxy Wiki!

This Wiki serves as a collaborative space to:

Outline the roadmap and future plans of mad-proxy,
Show the current development and project status,
Document installation, configuration, usage, and troubleshooting,
Share development guides and contribution info,
Maintain detailed APIs, policy formats, and security information.

Feel free to explore, contribute, and help make mad-proxy better!

Upcoming Features

Advanced traffic analytics module
Real-time alert notifications
Docker containerization
Support for complex regex-based domain policies

Current Focus

Stabilize proxy engine performance
Enhance policy validation and error reporting
Improve documentation and user guides

Installation

Ensure Python 3.8+ is installed.
Install mad-proxy via pip:

pip install mad-proxy

Install mitmproxy and trust its root certificate for HTTPS interception.
Configure config.yaml for domain blocking rules.

Usage

Basic command to start mad-proxy:

mad-proxy --config=config.yaml

Check logs for traffic allowed/blocked. Update policy file to refine control.

Contribution Guidelines

Fork the repo and create feature branches.
Write tests for new features or bug fixes.
Follow PEP8 and security best practices.
Submit pull requests with clear descriptions.

Security

Refer to the SECURITY.md file for detailed security policies, reporting, and best practices.