Skip to content

Commit 965a00d

Browse files
committedAug 27, 2021
Add section about permessage compression to README
1 parent d120da8 commit 965a00d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed
 

‎README.rst

+14
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,20 @@ should start with a slash, but not end with one; for example::
105105
daphne --root-path=/forum django_project.asgi:application
106106

107107

108+
Permessage compression
109+
----------------------
110+
111+
Daphne supports and by default accepts `permessage-deflate` compression
112+
(`permessage-deflate specification <http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression>`_).
113+
Additional compressions `permessage-bzip2`, `permessage-snappy` might be enabled by installing
114+
`bz2` and `snappy` python packages in daphne environment. These compressions will also be accepted
115+
by default if needed packages were available. The compression implementation is provided by
116+
`Autobahn|Python <https://github.com/crossbario/autobahn-python>`_ package:
117+
`permessage-deflate <https://github.com/crossbario/autobahn-python/blob/master/autobahn/websocket/compress_deflate.py`_,
118+
`permessage-bzip2 <https://github.com/crossbario/autobahn-python/blob/master/autobahn/websocket/compress_bzip2.py`_,
119+
`permessage-snappy <https://github.com/crossbario/autobahn-python/blob/master/autobahn/websocket/compress_snappy.py`_.
120+
121+
108122
Python Support
109123
--------------
110124

0 commit comments

Comments
 (0)