aboutsummaryrefslogtreecommitdiffstats
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/content/concepts-modes.md8
-rw-r--r--docs/src/content/howto-transparent-vms.md2
-rw-r--r--docs/src/content/howto-transparent.md14
-rw-r--r--docs/src/content/overview-tools.md2
-rwxr-xr-x[-rw-r--r--]docs/src/static/schematics/proxy-modes-reverse.pngbin16719 -> 12480 bytes
-rwxr-xr-x[-rw-r--r--]docs/src/static/schematics/proxy-modes-transparent-1.pngbin14558 -> 10489 bytes
-rwxr-xr-x[-rw-r--r--]docs/src/static/schematics/proxy-modes-transparent-2.pngbin23375 -> 16951 bytes
-rwxr-xr-x[-rw-r--r--]docs/src/static/schematics/proxy-modes-transparent-3.pngbin23855 -> 17192 bytes
-rwxr-xr-x[-rw-r--r--]docs/src/static/schematics/proxy-modes-transparent-wrong.pngbin14719 -> 11333 bytes
-rwxr-xr-x[-rw-r--r--]docs/src/static/schematics/proxy-modes-upstream.pngbin14781 -> 11537 bytes
10 files changed, 13 insertions, 13 deletions
diff --git a/docs/src/content/concepts-modes.md b/docs/src/content/concepts-modes.md
index 86bb7b0f..7a0b835a 100644
--- a/docs/src/content/concepts-modes.md
+++ b/docs/src/content/concepts-modes.md
@@ -157,20 +157,20 @@ There are various use-cases:
example.com domain and get all requests recorded in mitmproxy.
- Say you have some toy project that should get SSL support. Simply set up
mitmproxy as a reverse proxy on port 443 and you're done (`mitmdump -p 443
- -R http://localhost:80/`). Mitmproxy auto-detects TLS traffic and intercepts
+ --mode reverse:http://localhost:80/`). Mitmproxy auto-detects TLS traffic and intercepts
it dynamically. There are better tools for this specific task, but mitmproxy
is very quick and simple way to set up an SSL-speaking server.
- Want to add a non-SSL-capable compression proxy in front of your server? You
- could even spawn a mitmproxy instance that terminates SSL (`-R http://...`),
+ could even spawn a mitmproxy instance that terminates SSL (`--mode reverse:http://...`),
point it to the compression proxy and let the compression proxy point to a
- SSL-initiating mitmproxy (`-R https://...`), which then points to the real
+ SSL-initiating mitmproxy (`--mode reverse:https://...`), which then points to the real
server. As you see, it's a fairly flexible thing.
### Host Header
In reverse proxy mode, mitmproxy automatically rewrites the Host header to match
the upstream server. This allows mitmproxy to easily connect to existing
-endpoints on the open web (e.g. `mitmproxy -R https://example.com`). You can
+endpoints on the open web (e.g. `mitmproxy --mode reverse:https://example.com`). You can
disable this behaviour with the `keep_host_header` option.
However, keep in mind that absolute URLs within the returned document or HTTP
diff --git a/docs/src/content/howto-transparent-vms.md b/docs/src/content/howto-transparent-vms.md
index b186fd39..1446ede7 100644
--- a/docs/src/content/howto-transparent-vms.md
+++ b/docs/src/content/howto-transparent-vms.md
@@ -106,7 +106,7 @@ sudo iptables -t nat -A PREROUTING -i eth1 -p tcp --dport 443 -j REDIRECT --to-p
Finally, we can run mitmproxy in transparent mode with
{{< highlight bash >}}
-mitmproxy -T
+mitmproxy --mode transparent
{{< / highlight >}}
The proxied machine cannot to leak any data outside of HTTP or DNS requests. If
diff --git a/docs/src/content/howto-transparent.md b/docs/src/content/howto-transparent.md
index 224cb5ee..3d99e9dc 100644
--- a/docs/src/content/howto-transparent.md
+++ b/docs/src/content/howto-transparent.md
@@ -58,7 +58,7 @@ dropped privileges. It can be used as follows:
gcc examples/complex/full_transparency_shim.c -o mitmproxy_shim -lcap
sudo chown root:root mitmproxy_shim
sudo chmod u+s mitmproxy_shim
-./mitmproxy_shim $(which mitmproxy) -T --spoof-source-address
+./mitmproxy_shim $(which mitmproxy) --mode transparent --set spoof-source-address
{{< / highlight >}}
@@ -112,10 +112,10 @@ something like this:
You probably want a command like this:
{{< highlight bash >}}
-mitmproxy -T --host
+mitmproxy --mode transparent --showhost
{{< / highlight >}}
-The `-T` flag turns on transparent mode, and the `--host` argument tells
+The `--mode transparent` option turns on transparent mode, and the `--showhost` argument tells
mitmproxy to use the value of the Host header for URL display.
### 6. Finally, configure your test device
@@ -163,10 +163,10 @@ doas pfctl -e
You probably want a command like this:
{{< highlight bash >}}
-mitmproxy -T --host
+mitmproxy --mode transparent --showhost
{{< / highlight >}}
-The `-T` flag turns on transparent mode, and the `--host` argument tells
+The `--mode transparent` option turns on transparent mode, and the `--showhost` argument tells
mitmproxy to use the value of the Host header for URL display.
### 6. Finally, configure your test device
@@ -245,10 +245,10 @@ tighten the restriction up to the user running mitmproxy.
You probably want a command like this:
{{< highlight bash >}}
-mitmproxy -T --host
+mitmproxy --mode transparent --showhost
{{< / highlight >}}
-The `-T` flag turns on transparent mode, and the `--host` argument tells
+The `--mode transparent` flag turns on transparent mode, and the `--showhost` argument tells
mitmproxy to use the value of the Host header for URL display.
### 6. Finally, configure your test device
diff --git a/docs/src/content/overview-tools.md b/docs/src/content/overview-tools.md
index 7612383a..0200e899 100644
--- a/docs/src/content/overview-tools.md
+++ b/docs/src/content/overview-tools.md
@@ -8,7 +8,7 @@ menu:
# Overview
-You should thin of the mitmproxy project's tools as a set of front-ends that
+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.
diff --git a/docs/src/static/schematics/proxy-modes-reverse.png b/docs/src/static/schematics/proxy-modes-reverse.png
index 071d3fc8..87372688 100644..100755
--- a/docs/src/static/schematics/proxy-modes-reverse.png
+++ b/docs/src/static/schematics/proxy-modes-reverse.png
Binary files differ
diff --git a/docs/src/static/schematics/proxy-modes-transparent-1.png b/docs/src/static/schematics/proxy-modes-transparent-1.png
index 002e0e76..557406f8 100644..100755
--- a/docs/src/static/schematics/proxy-modes-transparent-1.png
+++ b/docs/src/static/schematics/proxy-modes-transparent-1.png
Binary files differ
diff --git a/docs/src/static/schematics/proxy-modes-transparent-2.png b/docs/src/static/schematics/proxy-modes-transparent-2.png
index 41997b05..ecc09f5a 100644..100755
--- a/docs/src/static/schematics/proxy-modes-transparent-2.png
+++ b/docs/src/static/schematics/proxy-modes-transparent-2.png
Binary files differ
diff --git a/docs/src/static/schematics/proxy-modes-transparent-3.png b/docs/src/static/schematics/proxy-modes-transparent-3.png
index ee26cb4f..177aaaef 100644..100755
--- a/docs/src/static/schematics/proxy-modes-transparent-3.png
+++ b/docs/src/static/schematics/proxy-modes-transparent-3.png
Binary files differ
diff --git a/docs/src/static/schematics/proxy-modes-transparent-wrong.png b/docs/src/static/schematics/proxy-modes-transparent-wrong.png
index ca501e93..c69c6b70 100644..100755
--- a/docs/src/static/schematics/proxy-modes-transparent-wrong.png
+++ b/docs/src/static/schematics/proxy-modes-transparent-wrong.png
Binary files differ
diff --git a/docs/src/static/schematics/proxy-modes-upstream.png b/docs/src/static/schematics/proxy-modes-upstream.png
index d40a6494..daa2b9af 100644..100755
--- a/docs/src/static/schematics/proxy-modes-upstream.png
+++ b/docs/src/static/schematics/proxy-modes-upstream.png
Binary files differ