python3.8,latest(Dockerfile)python3.8-alpine3.11(Dockerfile)python3.7, (Dockerfile)python3.7-alpine3.8(Dockerfile)python3.6(Dockerfile)python3.6-alpine3.8(Dockerfile)python2.7(Dockerfile)
Note: Note: There are tags for each build date. If you need to "pin" the Docker image version you use, you can select one of those tags. E.g. tiangolo/meinheld-gunicorn:python3.7-2019-10-15.
Docker image with Meinheld managed by Gunicorn for high-performance web applications in Python 3.6 and above and Python 2.7, with performance auto-tuning. Optionally with Alpine Linux.
GitHub repo: https://github.com/tiangolo/meinheld-gunicorn-docker
Docker Hub image: https://hub.docker.com/r/tiangolo/meinheld-gunicorn/
Python web applications running with Meinheld controlled by Gunicorn have some of the best performances achievable by (older) Python frameworks based on WSGI (synchronous code, instead of ASGI, which is asynchronous) (*).
This applies to frameworks like Flask and Django.
If you have an already existing application in Flask, Django, or similar frameworks, this image will give you the best performance possible (or close to that).
This image has an "auto-tuning" mechanism included, so that you can just add your code and get good performance automatically. And without making sacrifices (like logging).
If you are starting a new project, you might benefit from a newer and faster framework like FastAPI (based on ASGI instead of WSGI), and a Docker image like tiangolo/uvicorn-gunicorn-fastapi.
It would give you about 200% the performance achievable with an older WSGI framework (like Flask or Django), even when using this image.
Also, if you want to use new technologies like WebSockets it would be easier with a newer framework based on ASGI, like FastAPI. As the standard ASGI was designed to be able to handle asynchronous code like the one needed for WebSockets.
Meinheld is a high-performance WSGI-compliant web server.
You can use Gunicorn to manage Meinheld and run multiple processes of it.
This image was created to be an alternative to tiangolo/uwsgi-nginx, providing about 400% the performance of that image.
And to be the base of tiangolo/meinheld-gunicorn-flask.
- You don't need to clone the GitHub repo. You can use this image as a base image for other images, using this in your
Dockerfile:
FROM tiangolo/meinheld-gunicorn:python3.7
COPY ./app /appIt will expect a file at /app/app/main.py.
Or otherwise a file at /app/main.py.
And will expect it to contain a variable app with your "WSGI" application.
Then you can build your image from the directory that has your Dockerfile, e.g:
docker build -t myimage ./These are the environment variables that you can set in the container to configure it and their default values:
The Python "module" (file) to be imported by Gunicorn, this module would contain the actual application in a variable.
By default:
app.mainif there's a file/app/app/main.pyormainif there's a file/app/main.py
For example, if your main file was at /app/custom_app/custom_main.py, you could set it like:
docker run -d -p 80:80 -e MODULE_NAME="custom_app.custom_main" myimageThe variable inside of the Python module that contains the WSGI application.
By default:
app
For example, if your main Python file has something like:
from flask import Flask
api = Flask(__name__)
@api.route("/")
def hello():
return "Hello World from Flask"In this case api would be the variable with the "WSGI application". You could set it like:
docker run -d -p 80:80 -e VARIABLE_NAME="api" myimageThe string with the Python module and the variable name passed to Gunicorn.
By default, set based on the variables MODULE_NAME and VARIABLE_NAME:
app.main:appormain:app
You can set it like:
docker run -d -p 80:80 -e APP_MODULE="custom_app.custom_main:api" myimageThe path to a Gunicorn Python configuration file.
By default:
/app/gunicorn_conf.pyif it exists/app/app/gunicorn_conf.pyif it exists/gunicorn_conf.py(the included default)
You can set it like:
docker run -d -p 80:80 -e GUNICORN_CONF="/app/custom_gunicorn_conf.py" myimageThis image will check how many CPU cores are available in the current server running your container.
It will set the number of workers to the number of CPU cores multiplied by this value.
By default:
2
You can set it like:
docker run -d -p 80:80 -e WORKERS_PER_CORE="3" myimageIf you used the value 3 in a server with 2 CPU cores, it would run 6 worker processes.
You can use floating point values too.
So, for example, if you have a big server (let's say, with 8 CPU cores) running several applications, and you have an ASGI application that you know won't need high performance. And you don't want to waste server resources. You could make it use 0.5 workers per CPU core. For example:
docker run -d -p 80:80 -e WORKERS_PER_CORE="0.5" myimageIn a server with 8 CPU cores, this would make it start only 4 worker processes.
Override the automatic definition of number of workers.
By default:
- Set to the number of CPU cores in the current server multiplied by the environment variable
WORKERS_PER_CORE. So, in a server with 2 cores, by default it will be set to4.
You can set it like:
docker run -d -p 80:80 -e WEB_CONCURRENCY="2" myimageThis would make the image start 2 worker processes, independent of how many CPU cores are available in the server.
The "host" used by Gunicorn, the IP where Gunicorn will listen for requests.
It is the host inside of the container.
So, for example, if you set this variable to 127.0.0.1, it will only be available inside the container, not in the host running it.
It's is provided for completeness, but you probably shouldn't change it.
By default:
0.0.0.0
The port the container should listen on.
If you are running your container in a restrictive environment that forces you to use some specific port (like 8080) you can set it with this variable.
By default:
80
You can set it like:
docker run -d -p 80:8080 -e PORT="8080" myimageThe actual host and port passed to Gunicorn.
By default, set based on the variables HOST and PORT.
So, if you didn't change anything, it will be set by default to:
0.0.0.0:80
You can set it like:
docker run -d -p 80:8080 -e BIND="0.0.0.0:8080" myimageThe log level for Gunicorn.
One of:
debuginfowarningerrorcritical
By default, set to info.
If you need to squeeze more performance sacrificing logging, set it to warning, for example:
You can set it like:
docker run -d -p 80:8080 -e LOG_LEVEL="warning" myimageThe image includes a default Gunicorn Python config file at /gunicorn_conf.py.
It uses the environment variables declared above to set all the configurations.
You can override it by including a file in:
/app/gunicorn_conf.py/app/app/gunicorn_conf.py/gunicorn_conf.py
If you need to run anything before starting the app, you can add a file prestart.sh to the directory /app. The image will automatically detect and run it before starting everything.
For example, if you want to add Alembic SQL migrations (with SQLAlchemy), you could create a ./app/prestart.sh file in your code directory (that will be copied by your Dockerfile) with:
#! /usr/bin/env bash
# Let the DB start
sleep 10;
# Run migrations
alembic upgrade headand it would wait 10 seconds to give the database some time to start and then run that alembic command.
If you need to run a Python script before starting the app, you could make the /app/prestart.sh file run your Python script, with something like:
#! /usr/bin/env bash
# Run custom Python script before starting
python /app/my_custom_prestart_script.pyAll the image tags, configurations, environment variables and application options are tested.
- 👷 Add latest-changes GitHub Action, update issue-manager, and add sponsors funding. PR #21 by @tiangolo.
- Add Python 3.8 with Alpine 3.11. PR #16.
- Add support for Python 3.8. PR #15.
- Refactor build setup:
- Migrate to GitHub Actions for CI.
- Centralize and simplify code and configs.
- Update tests and types.
- Move from Pipenv to Poetry.
- PR #14.
- Refactor tests to use env vars and add image tags for each build date, like
tiangolo/meinheld-gunicorn:python3.7-2019-10-15. PR #8.
- Add support for
/app/prestart.sh.
This project is licensed under the terms of the MIT license.