Browse Source

Added Hypercorn to ASGI deployment guide.

Phil Jones 4 years ago
parent
commit
1bd1264f2e

+ 36 - 0
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/

+ 1 - 0
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

+ 1 - 0
docs/spelling_wordlist

@@ -278,6 +278,7 @@ hstore
 html
 http
 https
+Hypercorn
 hyperlinks
 ie
 ies