aboutsummaryrefslogtreecommitdiffstats
path: root/docs/protocols/websocket.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/protocols/websocket.rst')
-rw-r--r--docs/protocols/websocket.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/protocols/websocket.rst b/docs/protocols/websocket.rst
new file mode 100644
index 00000000..85cff3ac
--- /dev/null
+++ b/docs/protocols/websocket.rst
@@ -0,0 +1,17 @@
+.. _websocket_protocol:
+
+WebSocket
+=========
+
+.. seealso::
+
+ - `RFC6455: The WebSocket Protocol <http://tools.ietf.org/html/rfc6455>`_
+ - `RFC7692: Compression Extensions for WebSocket <http://tools.ietf.org/html/rfc7692>`_
+
+WebSocket support in mitmproxy is based on the amazing work by the python-hyper
+community with the `wsproto <https://github.com/python-hyper/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.