#  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 standalone binaries on mitmproxy.org.

#  Linux

The recommended way to install mitmproxy on Linux is to download the standalone binaries on mitmproxy.org.

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 installer from mitmproxy.org. 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

#  Development Setup

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

#  Installation from the Python Package Index (PyPI)

If your mitmproxy addons require the installation of additional Python packages, you can install mitmproxy from PyPI.

While there are plenty of options around¹, we recommend the installation using pipx:

1. Install a recent version of Python (we require at least 3.6).
2. Install pipx.
3. pipx install mitmproxy

To install additional Python packages, run pipx inject mitmproxy <your-package-name>.

#  Docker Images

You can use the official mitmproxy images from DockerHub.

#  Security Considerations for Binary Packages

Our pre-compiled binary packages and Docker images include a self-contained Python 3 environment, a recent version of 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.

As a general principle, mitmproxy does not “phone home” and consequently will not do any update checks.