mirror of
https://github.com/django/daphne.git
synced 2024-11-25 01:03:45 +03:00
bcaf1de155
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.
71 lines
2.4 KiB
ReStructuredText
71 lines
2.4 KiB
ReStructuredText
daphne
|
|
======
|
|
|
|
.. image:: https://api.travis-ci.org/django/daphne.svg
|
|
:target: https://travis-ci.org/django/daphne
|
|
|
|
.. image:: https://img.shields.io/pypi/v/daphne.svg
|
|
:target: https://pypi.python.org/pypi/daphne
|
|
|
|
Daphne is a HTTP, HTTP2 and WebSocket protocol server for
|
|
`ASGI <https://channels.readthedocs.io/en/latest/asgi.html>`_, and developed
|
|
to power Django Channels.
|
|
|
|
It supports automatic negotiation of protocols; there's no need for URL
|
|
prefixing to determine WebSocket endpoints versus HTTP endpoints.
|
|
|
|
|
|
Running
|
|
-------
|
|
|
|
Simply point Daphne to your ASGI channel layer instance, and optionally
|
|
set a bind address and port (defaults to localhost, port 8000)::
|
|
|
|
daphne -b 0.0.0.0 -p 8001 django_project.asgi:channel_layer
|
|
|
|
|
|
If you intend to run daphne behind a proxy server you can use UNIX
|
|
sockets to communicate between the two::
|
|
|
|
daphne -u /tmp/daphne.sock django_project.asgi:channel_layer
|
|
|
|
|
|
If daphne is being run inside a process manager such as
|
|
`Circus <https://github.com/circus-tent/circus/>`_ you might
|
|
want it to bind to a file descriptor passed down from a parent process.
|
|
To achieve this you can use the --fd flag::
|
|
|
|
daphne --fd 5 django_project.asgi:channel_layer
|
|
|
|
To see all available command line options run daphne with the *-h* flag.
|
|
|
|
Root Path (SCRIPT_NAME)
|
|
-----------------------
|
|
|
|
In order to set the root path for Daphne, which is the equivalent of the
|
|
WSGI ``SCRIPT_NAME`` setting, you have two options:
|
|
|
|
* Pass a header value ``Daphne-Root-Path``, with the desired root path as a
|
|
URLencoded ASCII value. This header will not be passed down to applications.
|
|
|
|
* Set the ``--root-path`` commandline option with the desired root path as a
|
|
URLencoded ASCII value.
|
|
|
|
The header takes precedence if both are set. As with ``SCRIPT_ALIAS``, the value
|
|
should start with a slash, but not end with one; for example::
|
|
|
|
daphne --root-path=/forum django_project.asgi:channel_layer
|
|
|
|
|
|
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.
|
|
|
|
This repository is part of the Channels project. For the shepherd and maintenance team, please see the
|
|
`main Channels readme <https://github.com/django/channels/blob/master/README.rst>`_.
|