From 279e611c017b5fcc055263e760de1495a9098ede Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Tue, 7 Mar 2023 19:47:55 +0100 Subject: [PATCH] Refs #31626 -- Noted that Daphne provides a runserver command. --- docs/howto/deployment/asgi/daphne.txt | 19 +++++++++++++++++++ docs/ref/django-admin.txt | 7 +++++++ 2 files changed, 26 insertions(+) diff --git a/docs/howto/deployment/asgi/daphne.txt b/docs/howto/deployment/asgi/daphne.txt index 5948288f07..48c0ab41c1 100644 --- a/docs/howto/deployment/asgi/daphne.txt +++ b/docs/howto/deployment/asgi/daphne.txt @@ -33,3 +33,22 @@ For a typical Django project, invoking Daphne would look like: This will start one process listening on ``127.0.0.1:8000``. It requires that your project be on the Python path; to ensure that run this command from the same directory as your ``manage.py`` file. + +.. _daphne-runserver: + +Integration with ``runserver`` +============================== + +Daphne provides a :djadmin:`runserver` command to serve your site under ASGI +during development. + +This can be enabled by adding ``daphne`` to the start of your +:setting:`INSTALLED_APPS` and adding an ``ASGI_APPLICATION`` setting pointing +to your ASGI application object:: + + INSTALLED_APPS = [ + "daphne", + ..., + ] + + ASGI_APPLICATION = "myproject.asgi.application" diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt index 56e29861ee..290d31f253 100644 --- a/docs/ref/django-admin.txt +++ b/docs/ref/django-admin.txt @@ -1013,6 +1013,13 @@ By default, the development server doesn't serve any static files for your site you want to configure Django to serve static media, read :doc:`/howto/static-files/index`. +Serving with ASGI in development +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Django's ``runserver`` command provides a WSGI server. In order to run under +ASGI you will need to use an :doc:`ASGI server `. +The Django Daphne project provides :ref:`daphne-runserver` that you can use. + ``sendtestemail`` -----------------