Skip to content

Commit

Permalink
Add section about permessage compression to README
Browse files Browse the repository at this point in the history
  • Loading branch information
albertas committed Aug 27, 2021
1 parent d120da8 commit 965a00d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,20 @@ should start with a slash, but not end with one; for example::
daphne --root-path=/forum django_project.asgi:application


Permessage compression
----------------------

Daphne supports and by default accepts `permessage-deflate` compression
(`permessage-deflate specification <http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression>`_).
Additional compressions `permessage-bzip2`, `permessage-snappy` might be enabled by installing
`bz2` and `snappy` python packages in daphne environment. These compressions will also be accepted
by default if needed packages were available. The compression implementation is provided by
`Autobahn|Python <https://github.com/crossbario/autobahn-python>`_ package:
`permessage-deflate <https://github.com/crossbario/autobahn-python/blob/master/autobahn/websocket/compress_deflate.py`_,
`permessage-bzip2 <https://github.com/crossbario/autobahn-python/blob/master/autobahn/websocket/compress_bzip2.py`_,
`permessage-snappy <https://github.com/crossbario/autobahn-python/blob/master/autobahn/websocket/compress_snappy.py`_.


Python Support
--------------

Expand Down

0 comments on commit 965a00d

Please sign in to comment.