You are not viewing the most up to date version of the documentation.
Click here
to view the latest version.
# Getting Started
We assume you have already installed mitmproxy on your machine.
# Launch the tool you need
You can start any of our three tools from the command line / terminal.
- mitmproxy gives you an interactive TUI
- mitmweb gives you a browser-based GUI
- mitmdump gives you a plain and simple terminal output
In case you use the console-based version of mitmproxy, we highly recommend you to take the tutorial to get started.
# Configure your browser or device
For the basic setup as regular proxy, you need to configure your browser or device to route all web traffic through mitmproxy as HTTP proxy. Browser versions and configurations options frequently change, so we recommend to simply search the web on how to configure an HTTP proxy for your system. Some operating system have a global settings, some browser have their own, other applications use environment variables, etc.
You can check that your web traffic is going through mitmproxy by browsing to http://mitm.it - it should present you with a simple page to install the mitmproxy Certificate Authority - which is also the next steps. Follow the instructions for your OS / system and install the CA (and make sure to enable it, some system require multiple steps!).
# Verifying everything works
At this point your running mitmproxy instance should already show the first HTTP flows from your client. You can test that all TLS-encrypted web traffic is working as expected by browsing to https://mitmproxy.org - it should show up as new flow and you can inspect it.
# Resources
- StackOverflow: If you want to ask usage questions, please do so on StackOverflow.
- GitHub: If you want to contribute to mitmproxy or submit a bug report, please do so on GitHub.
- Slack: If you want to get in touch with the developers or other users, please use our Slack channel.