mirror of
https://github.com/django/daphne.git
synced 2025-04-22 09:42:07 +03:00
eaaf70e935
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’: > Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard. Test Plan: Manually visited all the links I’ve modified.
76 lines
2.9 KiB
ReStructuredText
76 lines
2.9 KiB
ReStructuredText
Django Channels
|
|
===============
|
|
|
|
.. image:: https://api.travis-ci.org/django/channels.svg
|
|
:target: https://travis-ci.org/django/channels
|
|
|
|
.. image:: https://readthedocs.org/projects/channels/badge/?version=latest
|
|
:target: https://channels.readthedocs.io/en/latest/?badge=latest
|
|
|
|
.. image:: https://img.shields.io/pypi/v/channels.svg
|
|
:target: https://pypi.python.org/pypi/channels
|
|
|
|
.. image:: https://img.shields.io/pypi/l/channels.svg
|
|
:target: https://pypi.python.org/pypi/channels
|
|
|
|
Channels loads into Django as a pluggable app to bring WebSocket, long-poll HTTP,
|
|
task offloading and other asynchrony support to your code, using familiar Django
|
|
design patterns and a flexible underlying framework that lets you not only
|
|
customize behaviours but also write support for your own protocols and needs.
|
|
|
|
This is still **beta** software: the API is mostly settled, but might change
|
|
a bit as things develop. Once we hit ``1.0``, it will be stablized and a
|
|
deprecation policy will come in.
|
|
|
|
Documentation, installation and getting started instructions are at
|
|
https://channels.readthedocs.io
|
|
|
|
Support can be obtained either here via issues, or in the ``#django-channels``
|
|
channel on Freenode.
|
|
|
|
You can install channels from PyPI as the ``channels`` package.
|
|
You'll likely also want to ``asgi_redis`` to provide the Redis channel layer.
|
|
See our `installation <https://channels.readthedocs.io/en/latest/installation.html>`_
|
|
and `getting started <https://channels.readthedocs.io/en/latest/getting-started.html>`_ docs for more.
|
|
|
|
|
|
Contributing
|
|
------------
|
|
|
|
To learn more about contributing, please `read our contributing docs <https://channels.readthedocs.io/en/latest/contributing.html>`_.
|
|
|
|
|
|
Maintenance and Security
|
|
------------------------
|
|
|
|
To report security issues, please contact security@djangoproject.com. For GPG
|
|
signatures and more security process information, see
|
|
https://docs.djangoproject.com/en/dev/internals/security/.
|
|
|
|
To report bugs or request new features, please open a new GitHub issue. For
|
|
larger discussions, please post to the
|
|
`django-developers mailing list <https://groups.google.com/d/forum/django-developers>`_.
|
|
|
|
Django Core Shepherd: Andrew Godwin <andrew@aeracode.org>
|
|
|
|
Maintenance team:
|
|
|
|
* Andrew Godwin <andrew@aeracode.org>
|
|
* Steven Davidson
|
|
* Jeremy Spencer
|
|
|
|
If you are interested in joining the maintenance team, please
|
|
`read more about contributing <https://channels.readthedocs.io/en/latest/contributing.html>`_
|
|
and get in touch!
|
|
|
|
|
|
Other Projects
|
|
--------------
|
|
|
|
The Channels project is made up of several packages; the others are:
|
|
|
|
* `Daphne <https://github.com/django/daphne/>`_, the HTTP and Websocket termination server
|
|
* `asgiref <https://github.com/django/asgiref/>`_, the base ASGI library/memory backend
|
|
* `asgi_redis <https://github.com/django/asgi_redis/>`_, the Redis channel backend
|
|
* `asgi_ipc <https://github.com/django/asgi_ipc/>`_, the POSIX IPC channel backend
|