summaryrefslogtreecommitdiff
path: root/docs/howto/deployment/asgi/hypercorn.txt
diff options
context:
space:
mode:
authorPhil Jones <philip.graham.jones@googlemail.com>2020-08-05 11:14:06 +0100
committerGitHub <noreply@github.com>2020-08-05 12:14:06 +0200
commit1bd1264f2eafcef596960535a063c5be9ea5d433 (patch)
tree19d7ccfa79b5236d129a498085ae4119e9f14e5f /docs/howto/deployment/asgi/hypercorn.txt
parent2c2f4b37997daf84834547c8abd146cd6e9eac13 (diff)
Added Hypercorn to ASGI deployment guide.
Diffstat (limited to 'docs/howto/deployment/asgi/hypercorn.txt')
-rw-r--r--docs/howto/deployment/asgi/hypercorn.txt36
1 files changed, 36 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/