From 319c07b59580d1e7878664a2feb17685f9bf4fc4 Mon Sep 17 00:00:00 2001 From: Brendon Smith Date: Sat, 4 Jan 2025 15:24:50 -0500 Subject: [PATCH] Update Uvicorn Gunicorn worker info in docs - Mention deprecation in Uvicorn - Mention addition of workers to this project - Remove links to Uvicorn docs --- docs/environment.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/environment.md b/docs/environment.md index 5226942..4d0555e 100644 --- a/docs/environment.md +++ b/docs/environment.md @@ -83,7 +83,9 @@ ENV APP_MODULE="package.custom.module:api" WORKERS_PER_CORE="2" !!! info - As described in the [Uvicorn docs](https://www.uvicorn.org), "Uvicorn includes a Gunicorn worker class allowing you to run ASGI applications, with all of Uvicorn's performance benefits, while also giving you Gunicorn's fully-featured process management." + As originally described in the Uvicorn docs, "Uvicorn includes a Gunicorn worker class allowing you to run ASGI applications, with all of Uvicorn's performance benefits, while also giving you Gunicorn's fully-featured process management." + + Uvicorn deprecated the workers module in version 0.30.0. It is now available here at `inboard.gunicorn_workers`. `PROCESS_MANAGER` @@ -94,8 +96,8 @@ ENV APP_MODULE="package.custom.module:api" WORKERS_PER_CORE="2" [`WORKER_CLASS`](https://docs.gunicorn.org/en/latest/settings.html#worker-processes) - Uvicorn worker class for Gunicorn to use. -- Default: `inboard.gunicorn_workers.UvicornWorker` -- Custom: For the [alternate Uvicorn worker](https://www.uvicorn.org/deployment/), `WORKER_CLASS="inboard.gunicorn_workers.UvicornH11Worker"` _(the H11 worker is provided for [PyPy](https://www.pypy.org/))_ +- Default: `inboard.gunicorn_workers.UvicornWorker` (provided with inboard) +- Custom: For the alternate Uvicorn worker, `WORKER_CLASS="inboard.gunicorn_workers.UvicornH11Worker"` _(the H11 worker is provided for [PyPy](https://www.pypy.org/))_ ### Worker process calculation