gunicorn README

The project's README from github.com/benoitc/gunicorn. As one markdown file: README.md.

Gunicorn

Gunicorn is maintained by volunteers. If it powers your production, please consider supporting us:
GitHub Sponsors Revolut

PyPI version Supported Python versions Build Status

Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX. It's a pre-fork worker model ported from Ruby's Unicorn project. The Gunicorn server is broadly compatible with various web frameworks, simply implemented, light on server resource usage, and fairly speedy.

New in v25: Per-app worker allocation for dirty arbiters, HTTP/2 support (beta)!

Quick Start

pip install gunicorn
gunicorn myapp:app --workers 4

For ASGI applications (FastAPI, Starlette):

gunicorn myapp:app --worker-class asgi

Features

Documentation

Full documentation at https://gunicorn.org

Community

Support

Powering Python apps since 2010. Support continued development.

Become a Sponsor

Sponsors

Enki Multimedia

License

Gunicorn is released under the MIT License. See the LICENSE file for details.

gunicorn (benoitc/gunicorn)

Searching Database…

10.7K ·GitHub
What is this?Gunicorn — 'Green Unicorn' — is a Python WSGI HTTP server for UNIX. It's the process that runs your Python web app and serves it to the world.
Is Gunicorn a framework I build my app with, or a server I deploy?Neither a framework nor a library — it's a server you deploy in front of your finished app. It works with essentially any Python web framework: Django, Flask or Pyramid over WSGI; FastAPI, Starlette or Quart over ASGI.
How do I get it serving my app?Install the gunicorn package with pip, then point the gunicorn command at your application; the docs include a Quickstart and a dedicated Quick Start for ASGI apps.
Which Python version does it need?Python 3.10 or newer.
Is everything production-ready, or are there beta bits?The core server has been powering Python apps since 2010, but the two newest features are beta: HTTP/2 with multiplexed streams and Dirty Arbiters, both introduced in v25.
Where does it run — Linux, macOS, Windows?UNIX systems: Linux, macOS and FreeBSD (the repo even runs FreeBSD CI). It will not run on Windows.
Is it free to use, even commercially?Yes — it's MIT licensed and free, with no paid tiers.
What are Dirty Arbiters?A beta Gunicorn feature, new in v25, aimed at heavy workloads like ML models or long-running tasks, with worker allocation done per app. If your app runs slow, resource-hungry jobs, this is the piece to watch.
Do people put it behind nginx?That's the classic setup: Gunicorn speaks the uWSGI binary protocol specifically so nginx can integrate with it directly.
How heavy is it on server resources?Light by design — the README calls it simply implemented, light on server resource usage, and fairly speedy. It's meant to sit in front of your app without eating the box.
Creator
benoitc
Size
10.4 MB
Stars
10.7K
Age
16y
Commits · 90 Days