diff options
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/config.toml | 2 | ||||
| -rw-r--r-- | docs/src/content/addons-overview.md | 6 | ||||
| -rw-r--r-- | docs/src/content/concepts-certificates.md | 6 | ||||
| -rw-r--r-- | docs/src/content/concepts-filters.md | 32 | ||||
| -rw-r--r-- | docs/src/content/concepts-options.md | 33 | ||||
| -rw-r--r-- | docs/src/content/howto-transparent.md | 2 | ||||
| -rw-r--r-- | docs/src/content/overview-installation.md | 8 | ||||
| -rw-r--r-- | docs/src/generated/.gitkeep | 0 | ||||
| -rw-r--r-- | docs/src/layouts/shortcodes/readfile.html | 6 | ||||
| -rw-r--r-- | docs/src/themes/mitmproxydocs/static/css/style.css | 15 |
10 files changed, 41 insertions, 69 deletions
diff --git a/docs/src/config.toml b/docs/src/config.toml index ee2b9224..1ab5f052 100644 --- a/docs/src/config.toml +++ b/docs/src/config.toml @@ -4,7 +4,7 @@ title = "mitmproxy.org docs" theme = "mitmproxydocs" publishDir = "../public" RelativeURLs = true -googleAnalytics = "UA-4150636" +googleAnalytics = "UA-4150636-13" [indexes] tag = "tags" diff --git a/docs/src/content/addons-overview.md b/docs/src/content/addons-overview.md index 6aa1207e..bfde7f27 100644 --- a/docs/src/content/addons-overview.md +++ b/docs/src/content/addons-overview.md @@ -35,7 +35,7 @@ Here, for example, is a command that shows the API documentation for the mitmproxy's HTTP flow classes: {{< highlight bash >}} -pydoc mimtproxy.http +pydoc mitmproxy.http {{< /highlight >}} You will be referring to the mitmproxy API documentation frequently, so keep @@ -64,11 +64,11 @@ Here are a few things to note about the code above: finds into the addons mechanism. - Addons are just objects - in this case our addon is an instance of `Counter`. - The `request` method is an example of an **event**. Addons simply implement a - method for each event they wan to handle. Each event has a signature + method for each event they want to handle. Each event has a signature consisting of arguments that are passed to the method. For `request`, this is an instance of `mitmproxy.http.HTTPFlow`. - Finally, the `ctx` module is a holdall module that exposes a set of standard objects that are commonly used in addons. We could pass a `ctx` object as the first parameter to every event, but we've found it neater to just expose it as an importable global. In this case, we're using the `ctx.log` object to do our - logging.
\ No newline at end of file + logging. diff --git a/docs/src/content/concepts-certificates.md b/docs/src/content/concepts-certificates.md index e6586576..d7f53127 100644 --- a/docs/src/content/concepts-certificates.md +++ b/docs/src/content/concepts-certificates.md @@ -143,14 +143,14 @@ mitmproxy --cert *.example.com=cert.pem By default, mitmproxy will use `~/.mitmproxy/mitmproxy-ca.pem` as the certificate authority to generate certificates for all domains for which no custom certificate is provided (see above). You can use your own -certificate authority by passing the `--cadir DIRECTORY` option to +certificate authority by passing the `--set cadir=DIRECTORY` option to mitmproxy. Mitmproxy will then look for `mitmproxy-ca.pem` in the specified directory. If no such file exists, it will be generated automatically. ## Using a client side certificate -You can use a client certificate by passing the `--client-certs DIRECTORY|FILE` +You can use a client certificate by passing the `--set client_certs=DIRECTORY|FILE` option to mitmproxy. Using a directory allows certs to be selected based on hostname, while using a filename allows a single specific certificate to be used for all SSL connections. Certificate files must be in the PEM format and should @@ -158,7 +158,7 @@ contain both the unencrypted private key and the certificate. ### Multiple client certificates -You can specify a directory to `--client-certs`, in which case the matching +You can specify a directory to `--set client_certs=DIRECTORY`, in which case the matching certificate is looked up by filename. So, if you visit example.org, mitmproxy looks for a file named `example.org.pem` in the specified directory and uses this as the client cert. diff --git a/docs/src/content/concepts-filters.md b/docs/src/content/concepts-filters.md index ada24e32..f0b9a4b2 100644 --- a/docs/src/content/concepts-filters.md +++ b/docs/src/content/concepts-filters.md @@ -10,37 +10,7 @@ menu: Many commands in the mitmproxy tool make use of filter expressions. Filter expressions consist of the following operators: - -<table class="table filtertable"><tbody> -<tr><th>~a</th><td>Match asset in response: CSS, Javascript, Flash, images.</td></tr> -<tr><th>~b regex</th><td>Body</td></tr> -<tr><th>~bq regex</th><td>Request body</td></tr> -<tr><th>~bs regex</th><td>Response body</td></tr> -<tr><th>~c int</th><td>HTTP response code</td></tr> -<tr><th>~d regex</th><td>Domain</td></tr> -<tr><th>~dst regex</th><td>Match destination address</td></tr> -<tr><th>~e</th><td>Match error</td></tr> -<tr><th>~h regex</th><td>Header</td></tr> -<tr><th>~hq regex</th><td>Request header</td></tr> -<tr><th>~hs regex</th><td>Response header</td></tr> -<tr><th>~http</th><td>Match HTTP flows</td></tr> -<tr><th>~m regex</th><td>Method</td></tr> -<tr><th>~marked</th><td>Match marked flows</td></tr> -<tr><th>~q</th><td>Match request with no response</td></tr> -<tr><th>~s</th><td>Match response</td></tr> -<tr><th>~src regex</th><td>Match source address</td></tr> -<tr><th>~t regex</th><td>Content-type header</td></tr> -<tr><th>~tcp</th><td>Match TCP flows</td></tr> -<tr><th>~tq regex</th><td>Request Content-Type header</td></tr> -<tr><th>~ts regex</th><td>Response Content-Type header</td></tr> -<tr><th>~u regex</th><td>URL</td></tr> -<tr><th>~websocket</th><td>Match WebSocket flows</td></tr> -<tr><th>!</th><td>unary not</td></tr> -<tr><th>&</th><td>and</td></tr> -<tr><th>|</th><td>or</td></tr> -<tr><th>(...)</th><td>grouping</td></tr> -</tbody></table> - +{{< readfile file="/generated/filters.html" >}} - Regexes are Python-style - Regexes can be specified as quoted strings diff --git a/docs/src/content/concepts-options.md b/docs/src/content/concepts-options.md index 18776841..b533c175 100644 --- a/docs/src/content/concepts-options.md +++ b/docs/src/content/concepts-options.md @@ -34,33 +34,14 @@ interactively have immediate effect in the running instance, and can be made persistent by saving the settings out to a YAML configuration file (please see the specific tool's interactive help for details on how to do this). -For all tools, options can be set directly by name using the `--set` command-line -option. Please see the command-line help (`--help`) for usage. +For all tools, options can be set directly by name using the `--set` +command-line option. Please see the command-line help (`--help`) for usage. -## Example - -Here is an excerpt showing the first few lines of the complete `--options` -output: - -{{< highlight yaml >}} - -# Add all certificates of the upstream server to the certificate chain -# that will be served to the proxy client, as extras. Type bool. -add_upstream_certs_to_client_chain: false - -# Allow remote clients to connect to proxy. If set to false, client will -# not be able to connect to proxy unless it is on the same network or -# the proxyauth option is set Type bool. -allow_remote: false - -# Strip out request headers that might cause the server to return -# 304-not-modified. Type bool. -anticache: false - -# Try to convince servers to send us un-compressed data. Type bool. -anticomp: false - -{{< /highlight >}} +## Available Options +This list might not reflect what is actually available in your current mitmproxy +environment. For an up-to-date list please use the `--options` flag for each of +the mitmproxy tools. +{{< readfile file="/generated/options.html" >}} diff --git a/docs/src/content/howto-transparent.md b/docs/src/content/howto-transparent.md index ea1b1076..07a21ec9 100644 --- a/docs/src/content/howto-transparent.md +++ b/docs/src/content/howto-transparent.md @@ -172,7 +172,7 @@ rdr on en0 inet proto tcp to any port {80, 443} -> 127.0.0.1 port 8080 These rules tell pf to redirect all traffic destined for port 80 or 443 to the local mitmproxy instance running on port 8080. You should replace -`en2` with the interface on which your test device will appear. +`en0` with the interface on which your test device will appear. ### 3. Configure pf with the rules. diff --git a/docs/src/content/overview-installation.md b/docs/src/content/overview-installation.md index 00941cb8..d69805db 100644 --- a/docs/src/content/overview-installation.md +++ b/docs/src/content/overview-installation.md @@ -73,14 +73,14 @@ security considerations apply as for our binary packages. ## Installation on Linux via pip3 -Please make sure to install Python 3.5 (or higher) and pip3 for your +Please make sure to install Python 3.6 (or higher) and pip3 for your distribution. If your distribution does not provide a suitable Python version, you can use [pyenv](https://github.com/yyuu/pyenv) to get a recent Python environment. {{< highlight bash >}} -sudo apt install python3-pip # Debian 8 or higher, Ubuntu 16.04 or higher -sudo dnf install python3-pip # Fedora 24 or higher +sudo apt install python3-pip # Debian 10 or higher, Ubuntu 17.10 or higher +sudo dnf install python3-pip # Fedora 26 or higher sudo pacman -S python-pip # Arch Linux {{< / highlight >}} @@ -98,7 +98,7 @@ sudo pip3 install mitmproxy ## Installation on Windows via pip3 -First, install the latest version of Python 3.5 or higher from the +First, install the latest version of Python 3.6 or higher from the [Python website](https://www.python.org/downloads/windows/). During installation, make sure to select Add Python to PATH. There are no other dependencies on Windows. diff --git a/docs/src/generated/.gitkeep b/docs/src/generated/.gitkeep new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/src/generated/.gitkeep diff --git a/docs/src/layouts/shortcodes/readfile.html b/docs/src/layouts/shortcodes/readfile.html new file mode 100644 index 00000000..6860b0f1 --- /dev/null +++ b/docs/src/layouts/shortcodes/readfile.html @@ -0,0 +1,6 @@ +{{$file := .Get "file"}} +{{- if eq (.Get "markdown") "true" -}} +{{- $file | readFile | markdownify -}} +{{- else -}} +{{ $file | readFile | safeHTML }} +{{- end -}} diff --git a/docs/src/themes/mitmproxydocs/static/css/style.css b/docs/src/themes/mitmproxydocs/static/css/style.css index db5a36cf..d42e307e 100644 --- a/docs/src/themes/mitmproxydocs/static/css/style.css +++ b/docs/src/themes/mitmproxydocs/static/css/style.css @@ -250,6 +250,21 @@ .chroma .gu { color: #75715e; } +.badge { + color: #fff; + background-color: #6c757d; + display: inline-block; + padding: .25em .4em; + font-size: 75%; + font-weight: 1; + line-height: 1; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + border-radius: 0.25rem; } + .badge:empty { + display: none; } + @keyframes spinAround { from { transform: rotate(0deg); } |