Edit on GitHub

#  Installation

Please follow the steps for your operating system.

#  macOS

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

brew install mitmproxy

Alternatively you can download the binary-packages from our releases page.

#  Linux

The recommended way to install mitmproxy on Linux is to download the binary-packages from our releases page.

Some Linux distributions provide community-supported mitmproxy packages through their native package repositories (e.g., Arch Linux, Debian, Ubuntu, Kali Linux, OpenSUSE, etc.). We are not involved in the maintenance of downstream packaging efforts, and they often lag behind the current mitmproxy release. Please contact the repository maintainers directly for issues with native packages.

#  Windows

All the mitmproxy tools are fully supported under WSL (Windows Subsystem for Linux). We recommend to install WSL, and then follow the mitmproxy installation instructions for Linux.

We also distribute native Windows packages for all tools other than the mitmproxy console app, which only works under WSL. To install mitmproxy on Windows, download the binary packages from our releases page.

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

#  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 be cumbersome to compile and install.

Dependencies in the binary packages are frozen on release, and can’t be updated in situ. This means that we necessarily capture any bugs or security issues that may be present. We don’t generally release new binary packages simply to update dependencies (though we may do so if we become aware of a really serious issue). If you use our binary packages, please make sure you update regularly to ensure that everything remains current.

#  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.6 (or higher) and pip3 for your distribution. 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 10 or higher, Ubuntu 17.10 or higher
sudo dnf install python3-pip # Fedora 26 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

First, install the latest version of Python 3.6 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

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