mitmproxy/release/docker/DockerHub-README.md

mitmproxy

Containerized version of mitmproxy: an interactive, SSL/TLS-capable intercepting proxy for HTTP/1, HTTP/2, and WebSockets.

Usage

To launch the terminal user interface of mitmproxy:

$ docker run --rm -it -v ~/.mitmproxy:/home/mitmproxy/.mitmproxy -p 8080:8080 mitmproxy/mitmproxy

Note: The -v for volume mount is optional. It allows to persist and reuse the generated CA certificates between runs, and for you to access them. Without it, a new root CA would be generated on each container restart.

Once started, mitmproxy listens as an HTTP proxy on localhost:8080:

$ http_proxy=http://localhost:8080/ curl http://example.com/
$ https_proxy=http://localhost:8080/ curl -k https://example.com/

You can also start mitmdump by just adding that to the end of the command-line:

$ docker run --rm -it -p 8080:8080 mitmproxy/mitmproxy mitmdump
Proxy server listening at http://*:8080
[...]

For mitmweb, you also need to expose port 8081:

# this makes :8081 accessible to the local machine only
$ docker run --rm -it -p 8080:8080 -p 127.0.0.1:8081:8081 mitmproxy/mitmproxy mitmweb --web-host 0.0.0.0
Web server listening at http://0.0.0.0:8081/
No web browser found. Please open a browser and point it to http://0.0.0.0:8081/
Proxy server listening at http://*:8080
[...]

You can also pass options directly via the CLI:

$ docker run --rm -it -p 8080:8080 mitmproxy/mitmproxy mitmdump --set ssl_insecure=true
Proxy server listening at http://*:8080
[...]

If ~/.mitmproxy/mitmproxy-ca.pem is present in the container, mitmproxy will assume uid and gid from the file owner. For further details, please consult the mitmproxy documentation.

Tags

The available release tags can be seen here.

• dev always tracks the git-master branch and represents the unstable development tree.
• latest always points to the same image as the most recent stable release, including bugfix releases (e.g., 4.0.0 and 4.0.1).
• X.Y.Z tags contain the mitmproxy release with this version number.

Security Notice

Dependencies in the Docker images 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 Docker images simply to update dependencies (though we may do so if we become aware of a really serious issue).