docs: split out tool documentation
This commit is contained in:
parent
3ec3e4bcc9
commit
fe4c371001
|
@ -8,6 +8,9 @@ menu:
|
|||
|
||||
# Introduction
|
||||
|
||||
The mitmproxy project's tools are a set of front-ends that expose common
|
||||
underlying functionality.
|
||||
|
||||
**mitmproxy** is an interactive man-in-the-middle proxy for HTTP and HTTPS
|
||||
with a console interface.
|
||||
|
||||
|
|
|
@ -1,46 +1,11 @@
|
|||
---
|
||||
title: "Tools"
|
||||
menu: "overview"
|
||||
title: "mitmdump"
|
||||
menu: "tools"
|
||||
menu:
|
||||
overview:
|
||||
weight: 3
|
||||
tools:
|
||||
weight: 2
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
You should think of the mitmproxy project's tools as a set of front-ends that
|
||||
expose the same underlying functionality. We aim to have feature parity across
|
||||
all of our tooling, and all tools share a common configuration mechanism and
|
||||
most command-line options.
|
||||
|
||||
## mitmproxy
|
||||
|
||||
{{< figure src="/screenshots/mitmproxy.png" >}}
|
||||
|
||||
**mitmproxy** is a console tool that allows interactive examination and
|
||||
modification of HTTP traffic. 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. Use the `?` shortcut key to view, context-sensitive
|
||||
documentation from any **mitmproxy** screen.
|
||||
|
||||
|
||||
## mitmweb
|
||||
|
||||
{{< figure src="/screenshots/mitmweb.png" >}}
|
||||
|
||||
**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.
|
||||
|
||||
{{% note %}}
|
||||
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.
|
||||
{{% /note %}}
|
||||
|
||||
|
||||
## mitmdump
|
||||
|
||||
**mitmdump** is the command-line companion to mitmproxy. It provides
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: "mitmproxy"
|
||||
menu: "tools"
|
||||
menu:
|
||||
tools:
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## mitmproxy
|
||||
|
||||
{{< figure src="/screenshots/mitmproxy.png" >}}
|
||||
|
||||
**mitmproxy** is a console tool that allows interactive examination and
|
||||
modification of HTTP traffic. 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. Use the `?` shortcut key to view, context-sensitive
|
||||
documentation from any **mitmproxy** screen.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: "mitmweb"
|
||||
menu: "tools"
|
||||
menu:
|
||||
tools:
|
||||
weight: 3
|
||||
---
|
||||
|
||||
## mitmweb
|
||||
|
||||
{{< figure src="/screenshots/mitmweb.png" >}}
|
||||
|
||||
**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.
|
||||
|
||||
{{% note %}}
|
||||
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.
|
||||
{{% /note %}}
|
|
@ -8,6 +8,9 @@
|
|||
<p class="menu-label"> Overview </p>
|
||||
{{ partial "sidemenu" (dict "ctx" . "menuname" "overview") }}
|
||||
|
||||
<p class="menu-label">Tools</p>
|
||||
{{ partial "sidemenu" (dict "ctx" . "menuname" "tools") }}
|
||||
|
||||
<p class="menu-label">Core concepts</p>
|
||||
{{ partial "sidemenu" (dict "ctx" . "menuname" "concepts") }}
|
||||
|
||||
|
|
Loading…
Reference in New Issue