2020-12-13 15:14:13 +00:00
|
|
|
# mitmproxy
|
|
|
|
|
|
2021-03-16 15:17:27 +00:00
|
|
|
[](https://github.com/mitmproxy/mitmproxy/actions?query=branch%3Amain)
|
|
|
|
|
[](https://codecov.io/gh/mitmproxy/mitmproxy)
|
2020-12-13 15:14:13 +00:00
|
|
|
[](https://pypi.python.org/pypi/mitmproxy)
|
|
|
|
|
[](https://pypi.python.org/pypi/mitmproxy)
|
|
|
|
|
|
|
|
|
|
``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](https://docs.mitmproxy.org/stable/overview-installation).
|
2021-01-04 06:09:35 +00:00
|
|
|
If you want to install from source, see [CONTRIBUTING.md](./CONTRIBUTING.md).
|
2020-12-13 15:14:13 +00:00
|
|
|
|
|
|
|
|
## Documentation & Help
|
|
|
|
|
|
|
|
|
|
General information, tutorials, and precompiled binaries can be found on the mitmproxy website.
|
|
|
|
|
|
|
|
|
|
[](https://mitmproxy.org/)
|
|
|
|
|
|
|
|
|
|
The documentation for mitmproxy is available on our website:
|
|
|
|
|
|
|
|
|
|
[](https://docs.mitmproxy.org/stable/)
|
2021-03-16 15:17:27 +00:00
|
|
|
[](https://docs.mitmproxy.org/main/)
|
2020-12-13 15:14:13 +00:00
|
|
|
|
|
|
|
|
If you have questions on how to use mitmproxy, please
|
2021-11-16 09:26:38 +00:00
|
|
|
use GitHub Discussions!
|
2020-12-13 15:14:13 +00:00
|
|
|
|
2021-11-16 09:26:38 +00:00
|
|
|
[](https://github.com/mitmproxy/mitmproxy/discussions)
|
2020-12-13 15:14:13 +00:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2021-03-11 18:13:02 +00:00
|
|
|
As an open source project, mitmproxy welcomes contributions of all forms.
|
2020-12-13 15:14:13 +00:00
|
|
|
|
|
|
|
|
[](./CONTRIBUTING.md)
|
|
|
|
|
|
|
|
|
|
Also, please feel free to join our developer Slack!
|
|
|
|
|
|
|
|
|
|
[](http://slack.mitmproxy.org/)
|
