1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
Django Channels
===============
Channels is a project that takes Django and extends its abilities beyond
HTTP - to handle WebSockets, chat protocols, IoT protocols, and more. It's
built on a Python specification called `ASGI <https://asgi.readthedocs.io>`_.
Channels builds upon the native ASGI support in Django. Whilst Django still handles
traditional HTTP, Channels gives you the choice to handle other connections in
either a synchronous or asynchronous style.
To get started understanding Channels, read our :doc:`introduction`,
which will walk through how things work.
.. note::
This is documentation for the **4.x series** of Channels. If you are looking
for documentation for older versions, you can select ``3.x``, ``2.x``, or
``1.x`` from the versions selector in the bottom-left corner.
Projects
--------
Channels is comprised of several packages:
* `Channels <https://github.com/django/channels/>`_, the Django integration layer
* `Daphne <https://github.com/django/daphne/>`_, the HTTP and Websocket termination server
* `asgiref <https://github.com/django/asgiref/>`_, the base ASGI library
* `channels_redis <https://github.com/django/channels_redis/>`_, the Redis channel layer backend (optional)
This documentation covers the system as a whole; individual release notes and
instructions can be found in the individual repositories.
.. _topics:
Topics
------
.. toctree::
:maxdepth: 2
introduction
installation
tutorial/index
topics/consumers
topics/routing
topics/databases
topics/channel_layers
topics/sessions
topics/authentication
topics/security
topics/testing
topics/worker
deploying
topics/troubleshooting
Reference
---------
.. toctree::
:maxdepth: 2
asgi
channel_layer_spec
community
contributing
support
releases/index
|
