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://github.com/django/asgiref/blob/main/specs/asgi.rst>`_ and
`ASGI-HTTP <https://github.com/django/asgiref/blob/main/specs/www.rst>`_,
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 application, and optionally
set a bind address and port (defaults to localhost, port 8000)::
daphne -b 0.0.0.0 -p 8001 django_project.asgi:application
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:application
If daphne is being run inside a process manager, 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:application
If you want more control over the port/socket bindings you can fall back to
using `twisted's endpoint description strings
<http://twistedmatrix.com/documents/current/api/twisted.internet.endpoints.html#serverFromString>`_
by using the `--endpoint (-e)` flag, which can be used multiple times.
This line would start a SSL server on port 443, assuming that `key.pem` and `crt.pem`
exist in the current directory (requires pyopenssl to be installed)::
daphne -e ssl:443:privateKey=key.pem:certKey=crt.pem django_project.asgi:application
Endpoints even let you use the ``txacme`` endpoint syntax to get automatic certificates
from Let's Encrypt, which you can read more about at http://txacme.readthedocs.io/en/stable/.
To see all available command line options run daphne with the ``-h`` flag.
HTTP/2 Support
--------------
Daphne supports terminating HTTP/2 connections natively. You'll
need to do a couple of things to get it working, though. First, you need to
make sure you install the Twisted ``http2`` and ``tls`` extras::
pip install -U "Twisted[tls,http2]"
Next, because all current browsers only support HTTP/2 when using TLS, you will
need to start Daphne with TLS turned on, which can be done using the Twisted endpoint syntax::
daphne -e ssl:443:privateKey=key.pem:certKey=crt.pem django_project.asgi:application
Alternatively, you can use the ``txacme`` endpoint syntax or anything else that
enables TLS under the hood.
You will also need to be on a system that has **OpenSSL 1.0.2 or greater**; if you are
using Ubuntu, this means you need at least Ubuntu 16.04.
Now, when you start up Daphne, it should tell you this in the log::
2017-03-18 19:14:02,741 INFO Starting server at ssl:port=8000:privateKey=privkey.pem:certKey=cert.pem, channel layer django_project.asgi:channel_layer.
2017-03-18 19:14:02,742 INFO HTTP/2 support enabled
Then, connect with a browser that supports HTTP/2, and everything should be
working. It's often hard to tell that HTTP/2 is working, as the log Daphne gives you
will be identical (it's HTTP, after all), and most browsers don't make it obvious
in their network inspector windows. There are browser extensions that will let
you know clearly if it's working or not.
Daphne only supports "normal" requests over HTTP/2 at this time; there is not
yet support for extended features like Server Push. It will, however, result in
much faster connections and lower overheads.
If you have a reverse proxy in front of your site to serve static files or
similar, HTTP/2 will only work if that proxy understands and passes through the
connection correctly.
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:application
Python Support
--------------
Daphne requires Python 3.8 or later.
Contributing
------------
Please refer to the
`main Channels contributing docs <https://github.com/django/channels/blob/main/CONTRIBUTING.rst>`_.
To run tests, make sure you have installed the ``tests`` extra with the package::
cd daphne/
pip install -e '.[tests]'
pytest
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/main/README.rst>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/django/daphne",
"name": "daphne",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Django Software Foundation",
"author_email": "foundation@djangoproject.com",
"download_url": "https://files.pythonhosted.org/packages/1a/c1/aedf180beb12395835cba791ce7239b8880009d9d37564d72b7590cde605/daphne-4.1.2.tar.gz",
"platform": null,
"description": "daphne\n======\n\n.. image:: https://img.shields.io/pypi/v/daphne.svg\n :target: https://pypi.python.org/pypi/daphne\n\nDaphne is a HTTP, HTTP2 and WebSocket protocol server for\n`ASGI <https://github.com/django/asgiref/blob/main/specs/asgi.rst>`_ and\n`ASGI-HTTP <https://github.com/django/asgiref/blob/main/specs/www.rst>`_,\ndeveloped to power Django Channels.\n\nIt supports automatic negotiation of protocols; there's no need for URL\nprefixing to determine WebSocket endpoints versus HTTP endpoints.\n\n\nRunning\n-------\n\nSimply point Daphne to your ASGI application, and optionally\nset a bind address and port (defaults to localhost, port 8000)::\n\n daphne -b 0.0.0.0 -p 8001 django_project.asgi:application\n\nIf you intend to run daphne behind a proxy server you can use UNIX\nsockets to communicate between the two::\n\n daphne -u /tmp/daphne.sock django_project.asgi:application\n\nIf daphne is being run inside a process manager, you might\nwant it to bind to a file descriptor passed down from a parent process.\nTo achieve this you can use the --fd flag::\n\n daphne --fd 5 django_project.asgi:application\n\nIf you want more control over the port/socket bindings you can fall back to\nusing `twisted's endpoint description strings\n<http://twistedmatrix.com/documents/current/api/twisted.internet.endpoints.html#serverFromString>`_\nby using the `--endpoint (-e)` flag, which can be used multiple times.\nThis line would start a SSL server on port 443, assuming that `key.pem` and `crt.pem`\nexist in the current directory (requires pyopenssl to be installed)::\n\n daphne -e ssl:443:privateKey=key.pem:certKey=crt.pem django_project.asgi:application\n\nEndpoints even let you use the ``txacme`` endpoint syntax to get automatic certificates\nfrom Let's Encrypt, which you can read more about at http://txacme.readthedocs.io/en/stable/.\n\nTo see all available command line options run daphne with the ``-h`` flag.\n\n\nHTTP/2 Support\n--------------\n\nDaphne supports terminating HTTP/2 connections natively. You'll\nneed to do a couple of things to get it working, though. First, you need to\nmake sure you install the Twisted ``http2`` and ``tls`` extras::\n\n pip install -U \"Twisted[tls,http2]\"\n\nNext, because all current browsers only support HTTP/2 when using TLS, you will\nneed to start Daphne with TLS turned on, which can be done using the Twisted endpoint syntax::\n\n daphne -e ssl:443:privateKey=key.pem:certKey=crt.pem django_project.asgi:application\n\nAlternatively, you can use the ``txacme`` endpoint syntax or anything else that\nenables TLS under the hood.\n\nYou will also need to be on a system that has **OpenSSL 1.0.2 or greater**; if you are\nusing Ubuntu, this means you need at least Ubuntu 16.04.\n\nNow, when you start up Daphne, it should tell you this in the log::\n\n 2017-03-18 19:14:02,741 INFO Starting server at ssl:port=8000:privateKey=privkey.pem:certKey=cert.pem, channel layer django_project.asgi:channel_layer.\n 2017-03-18 19:14:02,742 INFO HTTP/2 support enabled\n\nThen, connect with a browser that supports HTTP/2, and everything should be\nworking. It's often hard to tell that HTTP/2 is working, as the log Daphne gives you\nwill be identical (it's HTTP, after all), and most browsers don't make it obvious\nin their network inspector windows. There are browser extensions that will let\nyou know clearly if it's working or not.\n\nDaphne only supports \"normal\" requests over HTTP/2 at this time; there is not\nyet support for extended features like Server Push. It will, however, result in\nmuch faster connections and lower overheads.\n\nIf you have a reverse proxy in front of your site to serve static files or\nsimilar, HTTP/2 will only work if that proxy understands and passes through the\nconnection correctly.\n\n\nRoot Path (SCRIPT_NAME)\n-----------------------\n\nIn order to set the root path for Daphne, which is the equivalent of the\nWSGI ``SCRIPT_NAME`` setting, you have two options:\n\n* Pass a header value ``Daphne-Root-Path``, with the desired root path as a\n URLencoded ASCII value. This header will not be passed down to applications.\n\n* Set the ``--root-path`` commandline option with the desired root path as a\n URLencoded ASCII value.\n\nThe header takes precedence if both are set. As with ``SCRIPT_ALIAS``, the value\nshould start with a slash, but not end with one; for example::\n\n daphne --root-path=/forum django_project.asgi:application\n\n\nPython Support\n--------------\n\nDaphne requires Python 3.8 or later.\n\n\nContributing\n------------\n\nPlease refer to the\n`main Channels contributing docs <https://github.com/django/channels/blob/main/CONTRIBUTING.rst>`_.\n\nTo run tests, make sure you have installed the ``tests`` extra with the package::\n\n cd daphne/\n pip install -e '.[tests]'\n pytest\n\n\nMaintenance and Security\n------------------------\n\nTo report security issues, please contact security@djangoproject.com. For GPG\nsignatures and more security process information, see\nhttps://docs.djangoproject.com/en/dev/internals/security/.\n\nTo report bugs or request new features, please open a new GitHub issue.\n\nThis repository is part of the Channels project. For the shepherd and maintenance team, please see the\n`main Channels readme <https://github.com/django/channels/blob/main/README.rst>`_.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Django ASGI (HTTP/WebSocket) server",
"version": "4.1.2",
"project_urls": {
"Homepage": "https://github.com/django/daphne"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abd6466f9219281472ecc269ab1d351c5b22a3cfca2d52f72881917949e414df",
"md5": "c5893da0eaae72d4fda07597e5ae82ac",
"sha256": "618d1322bb4d875342b99dd2a10da2d9aae7ee3645f765965fdc1e658ea5290a"
},
"downloads": -1,
"filename": "daphne-4.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5893da0eaae72d4fda07597e5ae82ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 30940,
"upload_time": "2024-04-11T13:32:32",
"upload_time_iso_8601": "2024-04-11T13:32:32.634958Z",
"url": "https://files.pythonhosted.org/packages/ab/d6/466f9219281472ecc269ab1d351c5b22a3cfca2d52f72881917949e414df/daphne-4.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ac1aedf180beb12395835cba791ce7239b8880009d9d37564d72b7590cde605",
"md5": "6a00ce30210105fcd0f756d4dc5505f9",
"sha256": "fcbcace38eb86624ae247c7ffdc8ac12f155d7d19eafac4247381896d6f33761"
},
"downloads": -1,
"filename": "daphne-4.1.2.tar.gz",
"has_sig": false,
"md5_digest": "6a00ce30210105fcd0f756d4dc5505f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 37882,
"upload_time": "2024-04-11T13:32:34",
"upload_time_iso_8601": "2024-04-11T13:32:34.594051Z",
"url": "https://files.pythonhosted.org/packages/1a/c1/aedf180beb12395835cba791ce7239b8880009d9d37564d72b7590cde605/daphne-4.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 13:32:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django",
"github_project": "daphne",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "daphne"
}
JSON
