docker-python-web Docs

Introduction

This is the documentation site for cal-itp/docker-python-web.

docker-python-web is a base Docker image for Cal-ITP Python web applications.

Features

• Base image python:3.11
• Image configured with non-root user (calitp by default)
• nginx configured as a reverse proxy listening on container port 8000
• gunicorn configured as a WSGI application server, communicates with nginx over Unix socket
• gunicorn default configuration location in $GUNICORN_CONF
• gettext for use with web frameworks like Django
• WORKDIR set to /home/$USER/app; gunicorn configuration in /home/$USER/run

Non-Features

• Bring Your Own Web Framework
• see benefits for a Django example
• see eligibility-server for a Flask example
• Bring Your Own CMD: drop in to bash with the default ENTRYPOINT.

Usage

Reference one of the image:tag from GitHub Container Registry in a Dockerfile. E.g. for the main branch:

FROM ghcr.io/cal-itp/docker-python-web:main

COPY my_app my_app

CMD "nginx && python -m gunicorn -c $GUNICORN_CONF my_app.wsgi"

Or from the command line:

docker pull ghcr.io/cal-itp/docker-python-web:main

Development

Development for this repo is done within a Visual Studio Code devcontainer.

Warning

You must build the base Docker image cal-itp/docker-python-web:app before running the devcontainer. In a terminal, run:

docker compose build app

Then, with the Remote - Containers extension enabled, open the folder containing this repository inside Visual Studio Code.