Skip to content

Commit

Permalink
Update Uvicorn Gunicorn worker info in docs
Browse files Browse the repository at this point in the history
- Mention deprecation in Uvicorn
- Mention addition of workers to this project
- Remove links to Uvicorn docs
  • Loading branch information
br3ndonland committed Jan 4, 2025
1 parent 35d8d86 commit 319c07b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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

Expand Down

0 comments on commit 319c07b

Please sign in to comment.