Repository files navigation

Daphne is a HTTP, HTTP2 and WebSocket protocol server forASGI andASGI-HTTP,developed to power Django Channels.

It supports automatic negotiation of protocols; there's no need for URLprefixing to determine WebSocket endpoints versus HTTP endpoints.

Simply point Daphne to your ASGI application, and optionallyset 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 UNIXsockets to communicate between the two:

daphne -u /tmp/daphne.sock django_project.asgi:application

If daphne is being run inside a process manager, you mightwant 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 tousingtwisted's endpoint description stringsby 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.pemexist 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 thetxacme endpoint syntax to get automatic certificatesfrom Let's Encrypt, which you can read more about athttp://txacme.readthedocs.io/en/stable/.

To see all available command line options run daphne with the-h flag.

Daphne supports terminating HTTP/2 connections natively. You'llneed to do a couple of things to get it working, though. First, you need tomake sure you install the Twistedhttp2 andtls extras:

pip install -U "Twisted[tls,http2]"

Next, because all current browsers only support HTTP/2 when using TLS, you willneed 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 thetxacme endpoint syntax or anything else thatenables TLS under the hood.

You will also need to be on a system that hasOpenSSL 1.0.2 or greater; if you areusing 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 beworking. It's often hard to tell that HTTP/2 is working, as the log Daphne gives youwill be identical (it's HTTP, after all), and most browsers don't make it obviousin their network inspector windows. There are browser extensions that will letyou know clearly if it's working or not.

Daphne only supports "normal" requests over HTTP/2 at this time; there is notyet support for extended features like Server Push. It will, however, result inmuch faster connections and lower overheads.

If you have a reverse proxy in front of your site to serve static files orsimilar, HTTP/2 will only work if that proxy understands and passes through theconnection correctly.

In order to set the root path for Daphne, which is the equivalent of theWSGISCRIPT_NAME setting, you have two options:

• Pass a header valueDaphne-Root-Path, with the desired root path as aURLencoded ASCII value. This header will not be passed down to applications.
• Set the--root-path commandline option with the desired root path as aURLencoded ASCII value.

The header takes precedence if both are set. As withSCRIPT_ALIAS, the valueshould start with a slash, but not end with one; for example:

daphne --root-path=/forum django_project.asgi:application

Daphne requires Python 3.9 or later.

Please refer to themain Channels contributing docs.

To run tests, make sure you have installed thetests extra with the package:

cd daphne/pip install -e '.[tests]'pytest

To report security issues, please contactsecurity@djangoproject.com. For GPGsignatures and more security process information, seehttps://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 themain Channels readme.