Debian Codegraph @

docs/howto/deployment/asgi/daphne.txt

raw
1 =============================
2 How to use Django with Daphne
3 =============================
4
5 :pypi:`Daphne <daphne>` is a pure-Python ASGI server for UNIX, maintained by
6 members of the Django project. It acts as the reference server for ASGI.
7
8 Installing Daphne
9 ===================
10
11 You can install Daphne with ``pip``:
12
13 .. code-block:: shell
14
15 python -m pip install daphne
16
17 Running Django in Daphne
18 ========================
19
20 When Daphne is installed, a ``daphne`` command is available which starts the
21 Daphne server process. At its simplest, Daphne needs to be called with the
22 location of a module containing an ASGI application object, followed by what
23 the application is called (separated by a colon).
24
25 For a typical Django project, invoking Daphne would look like:
26
27 .. code-block:: shell
28
29 daphne myproject.asgi:application
30
31 This will start one process listening on ``127.0.0.1:8000``. It requires that
32 your project be on the Python path; to ensure that run this command from the
33 same directory as your ``manage.py`` file.
34
35 .. _daphne-runserver:
36
37 Integration with ``runserver``
38 ==============================
39
40 Daphne provides a :djadmin:`runserver` command to serve your site under ASGI
41 during development.
42
43 This can be enabled by adding ``daphne`` to the start of your
44 :setting:`INSTALLED_APPS` and adding an ``ASGI_APPLICATION`` setting pointing
45 to your ASGI application object::
46
47 INSTALLED_APPS = [
48 "daphne",
49 ...,
50 ]
51
52 ASGI_APPLICATION = "myproject.asgi.application"