docs: add mitmweb stub

2016-12-20 17:30:35 +01:00 · 2016-12-20 17:30:35 +01:00 · 7de3507f9a
parent fc5783c20e
commit 7de3507f9a
3 changed files with 17 additions and 0 deletions
--- a/docs/index.rst
+++ b/docs/index.rst
@ -17,6 +17,7 @@

    mitmproxy
    mitmdump
+    mitmweb
    config

 .. toctree::
--- a/docs/mitmweb.rst
+++ b/docs/mitmweb.rst
@ -0,0 +1,16 @@
+.. _mitmweb:
+.. program:: mitmweb
+
+mitmweb
+=======
+
+**mitmweb** is mitmproxy's web-based user interface that allows interactive examination and modification of HTTP traffic. Like mitmproxy, it differs from mitmdump in that all flows are kept in memory, which means that it's intended for taking and manipulating
+small-ish samples.
+
+.. warning::
+
+  Mitmweb is currently in beta. We consider it stable for all features currently exposed in the UI, but it still misses a lot of mitmproxy's features.
+
+
+.. image:: screenshots/mitmweb.png
+
--- a/docs/screenshots/mitmweb.png
+++ b/docs/screenshots/mitmweb.png