This Docker image is now deprecated. There's no need to use it, you can just use Uvicorn with --workers. ✨
Read more about it below.
python3.11,latest(Dockerfile)python3.10, (Dockerfile)python3.9, (Dockerfile)python3.11-slim(Dockerfile)python3.10-slim(Dockerfile)python3.9-slim(Dockerfile)
🚨 These tags are no longer supported or maintained, they are removed from the GitHub repository, but the last versions pushed might still be available in Docker Hub if anyone has been pulling them:
python3.9-alpine3.14python3.8python3.8-slimpython3.8-alpine3.10python3.7python3.7-alpine3.8python3.6python3.6-alpine3.8
The last date tags for these versions are:
python3.9-alpine3.14-2024-03-11python3.8-2024-11-02python3.8-slim-2024-11-02python3.8-alpine3.10-2024-03-11python3.7-2024-11-02python3.7-alpine3.8-2024-03-11python3.6-2022-11-25python3.6-alpine3.8-2022-11-25
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/uvicorn-gunicorn:python3.11-2024-11-02.
Docker image with Uvicorn managed by Gunicorn for high-performance web applications in Python with performance auto-tuning.
GitHub repo: https://github.com/tiangolo/uvicorn-gunicorn-docker
Docker Hub image: https://hub.docker.com/r/tiangolo/uvicorn-gunicorn/
Python web applications running with Uvicorn (using the "ASGI" specification for Python asynchronous web applications) have shown to have some of the best performances, as measured by third-party benchmarks.
The achievable performance is on par with (and in many cases superior to) Go and Node.js frameworks.
This image has an auto-tuning mechanism included to start a number of worker processes based on the available CPU cores. That way you can just add your code and get high performance automatically, which is useful in simple deployments.
You are probably using Kubernetes or similar tools. In that case, you probably don't need this image (or any other similar base image). You are probably better off building a Docker image from scratch as explained in the docs for FastAPI in Containers - Docker: Build a Docker Image for FastAPI, that same process and ideas could be applied to other ASGI frameworks.
If you have a cluster of machines with Kubernetes, Docker Swarm Mode, Nomad, or other similar complex system to manage distributed containers on multiple machines, then you will probably want to handle replication at the cluster level instead of using a process manager (like Gunicorn with Uvicorn workers) in each container, which is what this Docker image does.
In those cases (e.g. using Kubernetes) you would probably want to build a Docker image from scratch, installing your dependencies, and running a single Uvicorn process instead of this image.
For example, your Dockerfile could look like:
FROM python:3.9
WORKDIR /code
COPY ./requirements.txt /code/requirements.txt
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
COPY ./app /code/app
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]You can read more about this in the FastAPI documentation about: FastAPI in Containers - Docker as the same ideas would apply to other ASGI frameworks.
If you definitely want to have multiple workers on a single container, Uvicorn now supports handling subprocesses, including restarting dead ones. So there's no need for Gunicorn to manage multiple workers in a single container.
You could modify the example Dockerfile from above, adding the --workers option to Uvicorn, like:
FROM python:3.9
WORKDIR /code
COPY ./requirements.txt /code/requirements.txt
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
COPY ./app /code/app
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80", "--workers", "4"]That's all you need. You don't need this Docker image at all. 😅
You can read more about it in the FastAPI Docs about Deployment with Docker.
Uvicorn didn't have support for managing worker processing including restarting dead workers. But now it does.
Before that, Gunicorn could be used as a process manager, running Uvicorn workers. This added complexity that is no longer necessary.
The rest of this document is kept for historical reasons, but you probably don't need it. 😅
This image will set a sensible configuration based on the server it is running on (the amount of CPU cores available) without making sacrifices.
It has sensible defaults, but you can configure it with environment variables or override the configuration files.
There is also a slim version. If you want one of those, use one of the tags from above.
This image was created to be the base image for:
But could be used as the base image to run any Python web application that uses the ASGI specification.
If you are creating a new Starlette web application you should use tiangolo/uvicorn-gunicorn-starlette instead.
If you are creating a new FastAPI web application you should use tiangolo/uvicorn-gunicorn-fastapi instead.
Note: FastAPI is based on Starlette and adds several features on top of it. Useful for APIs and other cases: data validation, data conversion, documentation with OpenAPI, dependency injection, security/authentication and others.
Note: Unless you are doing something more technically advanced, you probably should be using Starlette with tiangolo/uvicorn-gunicorn-starlette or FastAPI with tiangolo/uvicorn-gunicorn-fastapi.
You don't need to clone the GitHub repo.
You can use this image as a base image for other images.
Assuming you have a file requirements.txt, you could have a Dockerfile like this:
FROM tiangolo/uvicorn-gunicorn:python3.11
COPY ./requirements.txt /app/requirements.txt
RUN pip install --no-cache-dir --upgrade -r /app/requirements.txt
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 "ASGI" application.
Then you can build your image from the directory that has your Dockerfile, e.g:
docker build -t myimage ./- Run a container based on your image:
docker run -d --name mycontainer -p 80:80 myimageYou should be able to check it in your Docker container's URL, for example: http://192.168.99.100/ or http://127.0.0.1/ (or equivalent, using your Docker host).
You will probably also want to add any dependencies for your app and pin them to a specific version, probably including Uvicorn and Gunicorn.
This way you can make sure your app always works as expected.
You could install packages with pip commands in your Dockerfile, using a requirements.txt, or even using Poetry.
And then you can upgrade those dependencies in a controlled way, running your tests, making sure that everything works, but without breaking your production application if some new version is not compatible.
Here's a small example of one of the ways you could install your dependencies making sure you have a pinned version for each package.
Let's say you have a project managed with Poetry, so, you have your package dependencies in a file pyproject.toml. And possibly a file poetry.lock.
Then you could have a Dockerfile using Docker multi-stage building with:
FROM python:3.9 as requirements-stage
WORKDIR /tmp
RUN pip install poetry
COPY ./pyproject.toml ./poetry.lock* /tmp/
RUN poetry export -f requirements.txt --output requirements.txt --without-hashes
FROM tiangolo/uvicorn-gunicorn:python3.11
COPY --from=requirements-stage /tmp/requirements.txt /app/requirements.txt
RUN pip install --no-cache-dir --upgrade -r /app/requirements.txt
COPY ./app /appThat will:
- Install poetry and configure it for running inside of the Docker container.
- Copy your application requirements.
- Because it uses
./poetry.lock*(ending with a*), it won't crash if that file is not available yet.
- Because it uses
- Install the dependencies.
- Then copy your app code.
It's important to copy the app code after installing the dependencies, that way you can take advantage of Docker's cache. That way it won't have to install everything from scratch every time you update your application files, only when you add new dependencies.
This also applies for any other way you use to install your dependencies. If you use a requirements.txt, copy it alone and install all the dependencies on the top of the Dockerfile, and add your app code after it.
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 ASGI application.
By default:
app
For example, if your main Python file has something like:
from fastapi import FastAPI
api = FastAPI()
@api.get("/")
def read_root():
return {"message": "Hello world!"}In this case api would be the variable with the "ASGI 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" myimageYou can use the config file from this image as a starting point for yours.
This 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:
1
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.
Note: By default, if WORKERS_PER_CORE is 1 and the server has only 1 CPU core, instead of starting 1 single worker, it will start 2. This is to avoid bad performance and blocking applications (server application) on small machines (server machine/cloud/etc). This can be overridden using WEB_CONCURRENCY.
Set the maximum number of workers to use.
You can use it to let the image compute the number of workers automatically but making sure it's limited to a maximum.
This can be useful, for example, if each worker uses a database connection and your database has a maximum limit of open connections.
By default it's not set, meaning that it's unlimited.
You can set it like:
docker run -d -p 80:80 -e MAX_WORKERS="24" myimageThis would make the image start at most 24 workers, independent of how many CPU cores are available in the server.
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 to2.
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 class to be used by Gunicorn for the workers.
By default, set to uvicorn.workers.UvicornWorker.
The fact that it uses Uvicorn is what allows using ASGI applications like FastAPI and Starlette, and that is also what provides the maximum performance.
You probably shouldn't change it.
But if for some reason you need to use the alternative Uvicorn worker: uvicorn.workers.UvicornH11Worker you can set it with this environment variable.
You can set it like:
docker run -d -p 80:8080 -e WORKER_CLASS="uvicorn.workers.UvicornH11Worker" myimageWorkers silent for more than this many seconds are killed and restarted.
Read more about it in the Gunicorn docs: timeout.
By default, set to 120.
Notice that Uvicorn and ASGI frameworks like FastAPI and Starlette are async, not sync. So it's probably safe to have higher timeouts than for sync workers.
You can set it like:
docker run -d -p 80:8080 -e TIMEOUT="20" myimageThe number of seconds to wait for requests on a Keep-Alive connection.
Read more about it in the Gunicorn docs: keepalive.
By default, set to 2.
You can set it like:
docker run -d -p 80:8080 -e KEEP_ALIVE="20" myimageTimeout for graceful workers restart.
Read more about it in the Gunicorn docs: graceful-timeout.
By default, set to 120.
You can set it like:
docker run -d -p 80:8080 -e GRACEFUL_TIMEOUT="20" myimageThe access log file to write to.
By default "-", which means stdout (print in the Docker logs).
If you want to disable ACCESS_LOG, set it to an empty value.
For example, you could disable it with:
docker run -d -p 80:8080 -e ACCESS_LOG= myimageThe error log file to write to.
By default "-", which means stderr (print in the Docker logs).
If you want to disable ERROR_LOG, set it to an empty value.
For example, you could disable it with:
docker run -d -p 80:8080 -e ERROR_LOG= myimageAny additional command line settings for Gunicorn can be passed in the GUNICORN_CMD_ARGS environment variable.
Read more about it in the Gunicorn docs: Settings.
These settings will have precedence over the other environment variables and any Gunicorn config file.
For example, if you have a custom TLS/SSL certificate that you want to use, you could copy them to the Docker image or mount them in the container, and set --keyfile and --certfile to the location of the files, for example:
docker run -d -p 80:8080 -e GUNICORN_CMD_ARGS="--keyfile=/secrets/key.pem --certfile=/secrets/cert.pem" -e PORT=443 myimageNote: instead of handling TLS/SSL yourself and configuring it in the container, it's recommended to use a "TLS Termination Proxy" like Traefik. You can read more about it in the FastAPI documentation about HTTPS.
The path where to find the pre-start script.
By default, set to /app/prestart.sh.
You can set it like:
docker run -d -p 80:8080 -e PRE_START_PATH="/custom/script.sh" 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.pyYou can customize the location of the prestart script with the environment variable PRE_START_PATH described above.
The default program that is run is at /start.sh. It does everything described above.
There's also a version for development with live auto-reload at:
/start-reload.shFor development, it's useful to be able to mount the contents of the application code inside of the container as a Docker "host volume", to be able to change the code and test it live, without having to build the image every time.
In that case, it's also useful to run the server with live auto-reload, so that it re-starts automatically at every code change.
The additional script /start-reload.sh runs Uvicorn alone (without Gunicorn) and in a single process.
It is ideal for development.
For example, instead of running:
docker run -d -p 80:80 myimageYou could run:
docker run -d -p 80:80 -v $(pwd):/app myimage /start-reload.sh-v $(pwd):/app: means that the directory$(pwd)should be mounted as a volume inside of the container at/app.$(pwd): runspwd("print working directory") and puts it as part of the string.
/start-reload.sh: adding something (like/start-reload.sh) at the end of the command, replaces the default "command" with this one. In this case, it replaces the default (/start.sh) with the development alternative/start-reload.sh.
As /start-reload.sh doesn't run with Gunicorn, any of the configurations you put in a gunicorn_conf.py file won't apply.
But these environment variables will work the same as described above:
MODULE_NAMEVARIABLE_NAMEAPP_MODULEHOSTPORTLOG_LEVEL
In short: You probably shouldn't use Alpine for Python projects, instead use the slim Docker image versions.
Do you want more details? Continue reading 👇
Alpine is more useful for other languages where you build a static binary in one Docker image stage (using multi-stage Docker building) and then copy it to a simple Alpine image, and then just execute that binary. For example, using Go.
But for Python, as Alpine doesn't use the standard tooling used for building Python extensions, when installing packages, in many cases Python (pip) won't find a precompiled installable package (a "wheel") for Alpine. And after debugging lots of strange errors you will realize that you have to install a lot of extra tooling and build a lot of dependencies just to use some of these common Python packages. 😩
This means that, although the original Alpine image might have been small, you end up with a an image with a size comparable to the size you would have gotten if you had just used a standard Python image (based on Debian), or in some cases even larger. 🤯
And in all those cases, it will take much longer to build, consuming much more resources, building dependencies for longer, and also increasing its carbon footprint, as you are using more CPU time and energy for each build. 🌳
If you want slim Python images, you should instead try and use the slim versions that are still based on Debian, but are smaller. 🤓
All the image tags, configurations, environment variables and application options are tested.
- 👷 Avoid creating unnecessary
*.pycfiles withPYTHONDONTWRITEBYTECODE=1and ensure logs are printed immediately withPYTHONUNBUFFERED=1. PR #192 by @estebanx64.
- ⬆️ Bump uvicorn[standard] from 0.32.0 to 0.32.1. PR #249 by @dependabot[bot].
- ⬆️ Bump uvicorn[standard] from 0.21.0 to 0.32.0. PR #244 by @dependabot[bot].
- 🔥 Drop support for Python 3.7 and 3.8. PR #246 by @tiangolo.
- ⬆️ Bump gunicorn from 21.2.0 to 22.0.0. PR #210 by @dependabot[bot].
- ⬆️ Bump gunicorn from 21.2.0 to 22.0.0 in /docker-images. PR #209 by @dependabot[bot].
- ⬆️ Bump tiangolo/latest-changes from 0.3.1 to 0.3.2. PR #248 by @dependabot[bot].
- 🔥 Remove old unused files. PR #247 by @tiangolo.
- ⬆️ Bump actions/checkout from 4.1.7 to 4.2.2. PR #245 by @dependabot[bot].
- ⬆️ Bump tiangolo/issue-manager from 0.5.0 to 0.5.1. PR #239 by @dependabot[bot].
- 👷 Update
issue-manager.yml. PR #237 by @tiangolo. - 👷 Update
latest-changesGitHub Action. PR #236 by @tiangolo. - ⬆️ Bump docker/build-push-action from 5 to 6. PR #217 by @dependabot[bot].
- ⬆️ Bump gunicorn from 22.0.0 to 23.0.0. PR #222 by @dependabot[bot].
- ⬆️ Bump actions/checkout from 4.1.0 to 4.1.7. PR #216 by @dependabot[bot].
- ⬆️ Bump docker/login-action from 1 to 3. PR #211 by @dependabot[bot].
- 👷 Update issue-manager.yml GitHub Action permissions. PR #219 by @tiangolo.
- ⬆️ Bump peter-evans/dockerhub-description from 3 to 4. PR #203 by @dependabot[bot].
- ⬆️ Bump docker/build-push-action from 2 to 5. PR #202 by @dependabot[bot].
- ⬆️ Bump tiangolo/issue-manager from 0.4.0 to 0.5.0. PR #201 by @dependabot[bot].
- ⬆️ Bump docker/setup-buildx-action from 1 to 3. PR #200 by @dependabot[bot].
- ⬆️ Bump actions/setup-python from 4 to 5. PR #199 by @dependabot[bot].
- 🔧 Add GitHub templates for discussions and issues, and security policy. PR #205 by @alejsdev.
- 🔧 Update
latest-changes.yml. PR #198 by @alejsdev.
- ✨ Add support for multi-arch builds, including support for
arm64(e.g. Mac M1). PR #195 by @tiangolo.
- ⬆️ Bump gunicorn from 20.1.0 to 21.2.0. PR #185 by @dependabot[bot].
- ⬆️ Bump uvicorn[standard] from 0.20.0 to 0.21.0. PR #174 by @dependabot[bot].
- ⬆️ Bump actions/checkout from 3.3.0 to 4.1.0. PR #189 by @dependabot[bot].
- ⬆️ Update mypy requirement from ^0.991 to ^1.1. PR #173 by @dependabot[bot].
- ⬆️ Update black requirement from ^22.10 to ^23.1. PR #171 by @dependabot[bot].
- ⬆️ Bump actions/checkout from 3.1.0 to 3.3.0. PR #170 by @dependabot[bot].
- 👷 Update latest changes token. PR #178 by @tiangolo.
- 👷 Add GitHub Action to update Docker Hub description, fix. PR #168 by @tiangolo.
- 👷 Add GitHub Action for Docker Hub description. PR #167 by @tiangolo.
The highlights of this release are:
- Support for Python 3.10 and 3.11.
- Deprecation of Python 3.6.
- The last Python 3.6 image tag was pushed and is available in Docker Hub, but it won't be updated or maintained anymore.
- The last image with a date tag is
python3.6-2022-11-25.
- Upgraded versions of all the dependencies.
- ✨ Add support for Python 3.11. PR #159 by @tiangolo.
- ⬆️ Upgrade Uvicorn version. PR #161 by @tiangolo.
- ✨ Add support for Python 3.10. PR #99 by @tiangolo.
- ⬆️ Upgrade Uvicorn to the last version supporting Python 3.6. PR #155 by @tiangolo.
- ✨ Add Python 3.9 and Alpine Python 3.9. PR #52 by @graue70.
- ⬆️ Install uvicorn[standard] to include uvloop and Gunicorn support. PR #54 by @tiangolo.
- ✏️ Fix typo, delete repeated line in README. PR #147 by @jiyeonseo.
- 📝 Add note to discourage Alpine with Python. PR #96 by @tiangolo.
- 📝 Add warning for Kubernetes, when to use this image. PR #95 by @tiangolo.
- ✏️ Fix typo duplicate "Note" in Readme. PR #92 by @tiangolo.
- ✏️ Fix typo (type annotation) in tests. PR #55 by @tiangolo.
- ⬆️ Update mypy requirement from ^0.971 to ^0.991. PR #166 by @dependabot[bot].
- ⬆️ Update autoflake requirement from ^1.3.1 to ^2.0.0. PR #165 by @dependabot[bot].
- ⬆️ Update black requirement from ^20.8b1 to ^22.10. PR #164 by @dependabot[bot].
- ⬆️ Update docker requirement from ^5.0.3 to ^6.0.1. PR #163 by @dependabot[bot].
- 🔧 Update Dependabot config. PR #162 by @tiangolo.
- 👷 Add scheduled CI every Monday. PR #158 by @tiangolo.
- 👷 Do not run double CI for PRs, run on push only on master. PR #157 by @tiangolo.
- 👷 Add GitHub Action alls-green. PR #156 by @tiangolo.
- ⬆️ Update black requirement from ^19.10b0 to ^20.8b1. PR #87 by @dependabot[bot].
- ⬆️ Update mypy requirement from ^0.770 to ^0.971. PR #143 by @dependabot[bot].
- ⬆️ Update docker requirement from ^4.2.0 to ^5.0.3. PR #97 by @dependabot[bot].
- ⬆️ Bump actions/setup-python from 1 to 4.1.0. PR #142 by @dependabot[bot].
- ⬆️ Update isort requirement from ^4.3.21 to ^5.8.0. PR #88 by @dependabot[bot].
- ⬆️ Bump tiangolo/issue-manager from 0.2.0 to 0.4.0. PR #85 by @dependabot[bot].
- ⬆️ Update pytest requirement from ^5.4.1 to ^7.0.1. PR #123 by @dependabot[bot].
- ⬆️ Bump actions/checkout from 2 to 3.1.0. PR #145 by @dependabot[bot].
- 📌 Add external dependencies and Dependabot to get automatic upgrade PRs. PR #84 by @tiangolo.
- 👷 Update Latest Changes. PR #83 by @tiangolo.
- 🔥 Remove unused Travis and old GitHub Actions configs. PR #56 by @tiangolo.
- 👷 Add GitHub Action latest-changes, update issue-manager, add funding. PR #53 by @tiangolo.
- Add docs about installing and pinning dependencies. PR #41.
- Add
slimversion. PR #40. - Remove leftover unneeded config for tests. PR #39.
- Add extra configs, tests, and docs for:
WORKER_CLASSTIMEOUTKEEP_ALIVEGRACEFUL_TIMEOUTACCESS_LOGERROR_LOGGUNICORN_CMD_ARGSMAX_WORKERS- PR #38
- Set up CI using GitHub actions, they provide more free instances, so builds finish faster (4 min vs 9 min). PR #37.
- Add support for Python 3.8. PR #36.
- Refactor tests to remove custom testing Dockerfiles, generate them during tests. PR #35.
- Refactor and simplify build process to reduce code duplication. PR #34.
- Disable
pipcache during installation with--no-cache-dir. PR #13 by @pmav99. - Migrate local development from Pipenv to Poetry. PR #31.
- Add tests and docs for custom
PRE_START_PATHenv var. PR #30. - Add support for custom
PRE_START_PATHenv var. PR #12 by @mgfinch.
- Refactor tests to use env vars and add image tags for each build date, like
tiangolo/uvicorn-gunicorn:python3.7-2019-10-15. PR #15. - Update Gunicorn worker heartbeat directory to
/dev/shmto improve performance. PR #9 by @wshayes. - Upgrade Travis. PR #7.
- Add support for live auto-reload with an additional custom script
/start-reload.sh, check the updated documentation. PR #6.
- Set
WORKERS_PER_COREby default to1, as it shows to have the best performance on benchmarks. - Make the default web concurrency, when
WEB_CONCURRENCYis not set, to a minimum of 2 workers. This is to avoid bad performance and blocking applications (server application) on small machines (server machine/cloud/etc). This can be overridden usingWEB_CONCURRENCY. This applies for example in the case whereWORKERS_PER_COREis set to1(the default) and the server has only 1 CPU core. PR #5.
- Make
/start.shrun independently, reading and generating used default environment variables. And remove/entrypoint.shas it doesn't modify anything in the system, only reads environment variables. PR #4.
- Whenever this image is built (and each of its tags/versions), trigger a build for the children images (FastAPI and Starlette).
- Add support for
/app/prestart.sh.
This project is licensed under the terms of the MIT license.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
