diff options
| author | Phil Jones <philip.graham.jones@googlemail.com> | 2020-08-05 11:14:06 +0100 |
|---|---|---|
| committer | Carlton Gibson <carlton.gibson@noumenal.es> | 2020-08-05 12:15:12 +0200 |
| commit | 20ec568e46642920179378eecab5c94172f61e20 (patch) | |
| tree | edb8d5eac6843aebfa710a2e4747e5dbc05dda43 | |
| parent | b81cdaf20d7414b4ff5caba23477d8bdb0cb08e8 (diff) | |
[3.1.x] Added Hypercorn to ASGI deployment guide.
Backport of 1bd1264f2eafcef596960535a063c5be9ea5d433 from master
| -rw-r--r-- | docs/howto/deployment/asgi/hypercorn.txt | 36 | ||||
| -rw-r--r-- | docs/howto/deployment/asgi/index.txt | 1 | ||||
| -rw-r--r-- | docs/spelling_wordlist | 1 |
3 files changed, 38 insertions, 0 deletions
diff --git a/docs/howto/deployment/asgi/hypercorn.txt b/docs/howto/deployment/asgi/hypercorn.txt new file mode 100644 index 0000000000..28b5d06b6e --- /dev/null +++ b/docs/howto/deployment/asgi/hypercorn.txt @@ -0,0 +1,36 @@ +================================ +How to use Django with Hypercorn +================================ + +.. highlight:: bash + +Hypercorn_ is an ASGI server that supports HTTP/1, HTTP/2, and HTTP/3 +with an emphasis on protocol support. + +Installing Hypercorn +==================== + +You can install Hypercorn with ``pip``:: + + python -m pip install hypercorn + +Running Django in Hypercorn +=========================== + +When Hypercorn is installed, a ``hypercorn`` command is available +which runs ASGI applications. Hypercorn needs to be called with the +location of a module containing an ASGI application object, followed +by what the application is called (separated by a colon). + +For a typical Django project, invoking Hypercorn would look like:: + + hypercorn myproject.asgi:application + +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. + +For more advanced usage, please read the `Hypercorn documentation +<Hypercorn_>`_. + +.. _Hypercorn: https://pgjones.gitlab.io/hypercorn/ diff --git a/docs/howto/deployment/asgi/index.txt b/docs/howto/deployment/asgi/index.txt index f09d79a67e..1bd04b1fdf 100644 --- a/docs/howto/deployment/asgi/index.txt +++ b/docs/howto/deployment/asgi/index.txt @@ -17,6 +17,7 @@ Django includes getting-started documentation for the following ASGI servers: :maxdepth: 1 daphne + hypercorn uvicorn The ``application`` object diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index b04e3dfc20..c5ec8e4e31 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -278,6 +278,7 @@ hstore html http https +Hypercorn hyperlinks ie ies |