Skip to content

Latest commit

 

History

History
90 lines (50 loc) · 3.66 KB

README.md

File metadata and controls

90 lines (50 loc) · 3.66 KB

The BrowserUp Fork of the MITM Proxy

The BrowserUp MITM Proxy allows you to capture HTTP requests, responses and content, and export performance data as a HAR file.

The proxy is a fork of the amazing mitmproxy, with an added performance testing, QA and DevOps flavor.

Along with the standard mitmproxy features, the BrowserUp MITM Proxy adds a REST control API and native language clients in Java, JavaScript, Python and Ruby. It allows HAR capture (websockets and HTTP/2 too), and provides the ability to verify (assert) about network traffic.

BrowserUp MITM Proxy is especially useful when used with Playwright, Cypress or Selenium tests.

The REST API is documented here

Getting started:

Clone our fork:

git clone https://github.com/browserup/mitmproxy.git

Follow the mitmproxy certificate setup instructions

Run one of our examples in clients/examples

The executable for the BrowserUp Proxy, is browserup-proxy, so use that instead of mitmdump.

The standard mitmproxy executables, like mitmweb are also shipped, and should work as normal.

BrowserUp is a code contributor to the upstream project, and we hope to continue to support them with code contributions where possible.

The main changes for our fork are in the folders below/

mitmproxy/addons/browserup/

test/mitmproxy/addons/browserup

clients/

The standard MITMProxy documentation follows below.


mitmproxy

Continuous Integration Status Coverage Status Latest Version Supported Python versions

mitmproxy is an interactive, SSL/TLS-capable intercepting proxy with a console interface for HTTP/1, HTTP/2, and WebSockets.

mitmdump is the command-line version of mitmproxy. Think tcpdump for HTTP.

mitmweb is a web-based interface for mitmproxy.

Installation

The installation instructions are here. If you want to install from source, see CONTRIBUTING.md.

Documentation & Help

General information, tutorials, and precompiled binaries can be found on the mitmproxy website.

mitmproxy.org

The documentation for mitmproxy is available on our website:

mitmproxy documentation stable mitmproxy documentation dev

If you have questions on how to use mitmproxy, please use GitHub Discussions!

mitmproxy discussions

Contributing

As an open source project, mitmproxy welcomes contributions of all forms.

Dev Guide

Also, please feel free to join our developer Slack!

Slack Developer Chat