django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2024-11-24 08:53:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add section about permessage compression to README

Browse Source
This commit is contained in:
Albertas Gimbutas 2021-08-28 02:47:53 +03:00
parent d120da8d29
commit 78542781c6
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -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 ``permessage-bzip2``, ``permessage-snappy`` compressions will be also enabled by default if
``bz2`` and `snappy <https://snappy.math.uic.edu/>`_ python packages are available in daphne environment.
The compression implementation is provided by
`Autobahn|Python <https://github.com/crossbario/autobahn-python>`_ package, see:
`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
--------------