Installation

Please follow the steps for your operating system.

Once installation is complete, you can run mitmproxy, mitmdump or mitmweb from a terminal.

Installation on macOS

The recommended way to install mitmproxy on macOS is to use Homebrew:

brew install mitmproxy

Alternatively you can download our Self-contained Pre-built Binary Packages from our releases page.

Installation on Linux

The recommended way to install mitmproxy on Linux is to download our Self-contained Pre-built Binary Packages from our releases page.

Some Linux distributions and their community provide mitmproxy packages via their native package repositories (e.g., Arch Linux, Debian, Ubuntu, Kali Linux, OpenSUSE, etc.). While we do encourage seeing mitmproxy in a great variety of repositories and distributions, we are not maintaining or involved with their downstream packaging efforts. If you are looking for the latest version or have other problems, please contact the repository maintainers directly.

Installation on Windows

The recommended way to install mitmproxy on Windows is to download our Self-contained Pre-built Binary Packages from our releases page.

After installation, you’ll find shortcuts for mitmweb (the web-based interface) and mitmdump in the start menu. Both executables are added to your PATH and can be invoked from the command line.

Note

The console interface is not supported on Windows, but you can use mitmweb (the web-based interface) and mitmdump.

Advanced Installation

Self-contained Pre-built Binary Packages

For some platforms we provide pre-built binary packages containing ready-to-run executables. This includes a self-contained Python 3 environment, a recent OpenSSL that support ALPN and HTTP/2, and other dependencies that would otherwise we cumbersome to compile and install.

Please be advised that we do not update these binaries after the initial release. This means we do not include security-related updates of our dependencies in already released mitmproxy versions. If there is a severe issue, we might consider releasing a bugfix release of mitmproxy and corresponding binary packages.

We only support the latest version of mitmproxy with bugfix and security updates through regular minor releases.

Docker Images

You can use the official mitmproxy images from DockerHub. The same security considerations apply as for our binary packages.

Installation on Linux via pip3

Please make sure to install Python 3.5 (or higher) and pip3 for your distribtion. If your distribution does not provide a suitable Python version, you can use pyenv to get a recent Python environment.

sudo apt install python3-pip # Debian 8 or higher, Ubuntu 16.04 or higher
sudo dnf install python3-pip # Fedora 24 or higher
sudo pacman -S python-pip # Arch Linux

Please make sure to upgrade pip3 itself:

sudo pip3 install -U pip

Now you can install mitmproxy via pip3:

sudo pip3 install mitmproxy

Installation on Windows via pip3

Note

The console interface is not supported on Windows, but you can use mitmweb (the web-based interface) and mitmdump.

First, install the latest version of Python 3.5 or higher from the Python website. During installation, make sure to select Add Python to PATH. There are no other dependencies on Windows.

Now you can install mitmproxy via pip3:

pip3 install mitmproxy

Installation from Source Code

If you would like to install mitmproxy directly from source code or the GitHub master branch, please see the our README on GitHub.