diff options
author | Wolfgang Müller | 2025-02-14 12:44:34 +0100 |
---|---|---|
committer | Wolfgang Müller | 2025-02-14 12:44:34 +0100 |
commit | 6c05b9cccbf8c0c0a0e3debdc602a0708f565fd8 (patch) | |
tree | d29f96cb9c7862f4191cd72d22fdc3dc2d66fb4f /docs/setup.rst | |
parent | eacded01ae29d287fb1cbce5a2e88b1cc5737173 (diff) | |
download | hircine-6c05b9cccbf8c0c0a0e3debdc602a0708f565fd8.tar.gz |
docs: Update ASGI server instructions to include uvicorn-worker
Uvicorn will be deprecating the built-in uvicon.workers module sometime
in the future [1] and recommends using uvicorn-worker instead. Follow
suit and point this out in the documentation as well.
[1] https://github.com/encode/uvicorn/pull/2302
Diffstat (limited to '')
-rw-r--r-- | docs/setup.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/setup.rst b/docs/setup.rst index d8962f3..51ec383 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -100,13 +100,14 @@ Starting the web application ---------------------------- To serve the web application, you need a compatible ASGI server. We recommend -`gunicorn <https://gunicorn.org>`_. The endpoint for the web application is the -``app()`` factory in ``hircine.app``: +`gunicorn <https://gunicorn.org>`_ together with `uvicorn-worker +<https://github.com/Kludex/uvicorn-worker>`_. The endpoint for the web +application is the ``app()`` factory in ``hircine.app``: .. code-block:: console - (.venv) $ python -m pip install gunicorn - (.venv) $ gunicorn -k uvicorn.workers.UvicornWorker --bind localhost:8000 "hircine.app:app()" + (.venv) $ python -m pip install gunicorn uvicorn-worker + (.venv) $ gunicorn -k uvicorn_worker.UvicornWorker --bind localhost:8000 "hircine.app:app()" Now you can point your browser to http://localhost:8000 to open the web application. To stop it, simply terminate ``gunicorn`` or the ASGI server of |