From 982508d30f887b4fe8b2a855792ae1e33f378222 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Thu, 22 Feb 2018 17:21:34 +1300 Subject: All new documentation This patch does a lot. - Ditch sphinx in favor of hugo. This gives us complete control of the layout and presentation of our docs. Henceforth, docs will be hosted on our website rather than ReadTheDocs. - Create a simple, clean doc layout and theme. - Remove large parts of the documentaion. I've ditched anything that was a) woefully out of date, b) too detailed, or c) too hard to maintain in the long term. - Huge updates to the docs themselves: completely rewrite addons documentation, add docs for core concepts like commands and options, and revise and tweak a lot of the existing docs. With this patch, we're also changing the way we publish and maintain the docs. From now on, we don't publish docs for every release. Instead, the website will contain ONE set of docs for each major release. The online docs will be updated if needed as minor releases are made. Docs are free to improve during minor releases, but anything that changes behaviour sufficiently to require a doc change warrants a new major release. This also leaves us free to progressively update and improve docs out of step with our release cadence. With this new scheme, I feel CI over the docs is less important. I've removed it for now, but won't object if someone wants to add it back in. --- docs/protocols/http1.rst | 15 --------------- docs/protocols/http2.rst | 16 ---------------- docs/protocols/tcpproxy.rst | 31 ------------------------------- docs/protocols/websocket.rst | 22 ---------------------- 4 files changed, 84 deletions(-) delete mode 100644 docs/protocols/http1.rst delete mode 100644 docs/protocols/http2.rst delete mode 100644 docs/protocols/tcpproxy.rst delete mode 100644 docs/protocols/websocket.rst (limited to 'docs/protocols') diff --git a/docs/protocols/http1.rst b/docs/protocols/http1.rst deleted file mode 100644 index 21e68785..00000000 --- a/docs/protocols/http1.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _http1_protocol: - -HTTP/1.0 and HTTP/1.1 -=========================== - -.. seealso:: - - - `RFC7230: HTTP/1.1: Message Syntax and Routing `_ - - `RFC7231: HTTP/1.1: Semantics and Content `_ - -HTTP/1.0 and HTTP/1.1 support in mitmproxy is based on our custom HTTP stack, -which takes care of all semantics and on-the-wire parsing/serialization tasks. - -mitmproxy currently does not support HTTP trailers - but if you want to send -us a PR, we promise to take look! diff --git a/docs/protocols/http2.rst b/docs/protocols/http2.rst deleted file mode 100644 index b3268ae5..00000000 --- a/docs/protocols/http2.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _http2_protocol: - -HTTP/2 -====== - -.. seealso:: - - - `RFC7540: Hypertext Transfer Protocol Version 2 (HTTP/2) `_ - -HTTP/2 support in mitmproxy is based on the amazing work by the python-hyper -community with the `hyper-h2 `_ -project. It fully encapsulates the internal state of HTTP/2 connections and -provides an easy-to-use event-based API. - -mitmproxy currently does not support HTTP/2 trailers - but if you want to send -us a PR, we promise to take look! diff --git a/docs/protocols/tcpproxy.rst b/docs/protocols/tcpproxy.rst deleted file mode 100644 index 77248573..00000000 --- a/docs/protocols/tcpproxy.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _tcp_proxy: - -TCP Proxy / Fallback -==================== - -In case mitmproxy does not handle a specific protocol, you can exempt -hostnames from processing, so that mitmproxy acts as a generic TCP forwarder. -This feature is closely related to the :ref:`passthrough` functionality, -but differs in two important aspects: - -- The raw TCP messages are printed to the event log. -- SSL connections will be intercepted. - -Please note that message interception or modification are not possible yet. -If you are not interested in the raw TCP messages, you should use the ignore domains feature. - -How it works ------------- - -================== ====================== -command-line ``--tcp HOST`` -mitmproxy shortcut :kbd:`O` then :kbd:`T` -================== ====================== - -For a detailed description how the hostname pattern works, please look at the :ref:`passthrough` -feature. - -.. seealso:: - - - :ref:`passthrough` - - :ref:`streaming` diff --git a/docs/protocols/websocket.rst b/docs/protocols/websocket.rst deleted file mode 100644 index 8a7e807f..00000000 --- a/docs/protocols/websocket.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _websocket_protocol: - -WebSocket -========= - -.. seealso:: - - - `RFC6455: The WebSocket Protocol `_ - - `RFC7692: Compression Extensions for WebSocket `_ - -WebSocket support in mitmproxy is based on the amazing work by the python-hyper -community with the `wsproto `_ -project. It fully encapsulates WebSocket frames/messages/connections and -provides an easy-to-use event-based API. - -mitmproxy fully supports the compression extension for WebSocket messages, -provided by wsproto. - -If an endpoint sends a PING to mitmproxy, a PONG will be sent back immediately -(with the same payload if present). To keep the other connection alive, a new -PING (without a payload) is sent to the other endpoint. Unsolicited PONG's are -not forwarded. All PING's and PONG's are logged (with payload if present). -- cgit v1.2.3