Django

Estimated reading time: 6 minutes

Django is a free web application framework, written in Python.

GitHub repo: https://github.com/docker-library/django

Library reference

This content is imported from the official Docker Library docs, and is provided by the original uploader. You can view the Docker Store page for this repo at https://store.docker.com/images/django.

DEPRECATED

This image is officially deprecated in favor of the standard python image, and will receive no further updates after 2016-12-31 (Dec 31, 2016). Please adjust your usage accordingly.

For most usages of this image, it was already not bringing in django from this image, but actually from your project’s requirements.txt, so the only “value” being added here was the pre-installing of mysql-client, postgresql-client, and sqlite3 for various uses of the django framework.

For example, a Dockerfile similar to the following would be a good starting point for a Django project using PostgreSQL:

FROM python:3.4

RUN apt-get update \
	&& apt-get install -y --no-install-recommends \
		postgresql-client \
	&& rm -rf /var/lib/apt/lists/*

WORKDIR /usr/src/app
COPY requirements.txt ./
RUN pip install -r requirements.txt
COPY . .

EXPOSE 8000
CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

Supported tags and respective Dockerfile links

For detailed information about the published artifacts of each of the above supported tags (image metadata, transfer size, etc), please see the repos/django directory in the docker-library/repo-info GitHub repo.

For more information about this image and its history, please see the relevant manifest file (library/django). This image is updated via pull requests to the docker-library/official-images GitHub repo.

What is Django?

Django is a free and open source web application framework, written in Python, which follows the model-view-controller architectural pattern. Django’s primary goal is to ease the creation of complex, database-driven websites with an emphasis on reusability and “pluggability” of components.

wikipedia.org/wiki/Django_(web_framework)

logo

How to use this image

Create a Dockerfile in your Django app project

FROM django:onbuild

Put this file in the root of your app, next to the requirements.txt.

This image includes multiple ONBUILD triggers which should cover most applications. The build will COPY . /usr/src/app, RUN pip install, EXPOSE 8000, and set the default command to python manage.py runserver.

You can then build and run the Docker image:

$ docker build -t my-django-app .
$ docker run --name some-django-app -d my-django-app

You can test it by visiting http://container-ip:8000 in a browser or, if you need access outside the host, on http://localhost:8000 with the following command:

$ docker run --name some-django-app -p 8000:8000 -d my-django-app

Without a Dockerfile

Of course, if you don’t want to take advantage of magical and convenient ONBUILD triggers, you can always just use docker run directly to avoid having to add a Dockerfile to your project.

$ docker run --name some-django-app -v "$PWD":/usr/src/app -w /usr/src/app -p 8000:8000 -d django bash -c "pip install -r requirements.txt && python manage.py runserver 0.0.0.0:8000"

Bootstrap a new Django Application

If you want to generate the scaffolding for a new Django project, you can do the following:

$ docker run -it --rm --user "$(id -u):$(id -g)" -v "$PWD":/usr/src/app -w /usr/src/app django django-admin.py startproject mysite

This will create a sub-directory named mysite inside your current directory.

Image Variants

The django images come in many flavors, each designed for a specific use case.

django:<version>

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.

django:onbuild

This image makes building derivative images easier. For most use cases, creating a Dockerfile in the base of your project directory with the line FROM django:onbuild will be enough to create a stand-alone image for your project.

While the onbuild variant is really useful for “getting off the ground running” (zero to Dockerized in a short period of time), it’s not recommended for long-term usage within a project due to the lack of control over when the ONBUILD triggers fire (see also docker/docker#5714, docker/docker#8240, docker/docker#11917).

Once you’ve got a handle on how your project functions within Docker, you’ll probably want to adjust your Dockerfile to inherit from a non-onbuild variant and copy the commands from the onbuild variant Dockerfile (moving the ONBUILD lines to the end and removing the ONBUILD keywords) into your own file so that you have tighter control over them and more transparency for yourself and others looking at your Dockerfile as to what it does. This also makes it easier to add additional requirements as time goes on (such as installing more packages before performing the previously-ONBUILD steps).

License

View license information for the software contained in this image.

Supported Docker versions

This image is officially supported on Docker version 17.04.0-ce.

Support for older versions (down to 1.6) is provided on a best-effort basis.

Please see the Docker installation documentation for details on how to upgrade your Docker daemon.

User Feedback

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue. If the issue is related to a CVE, please check for a cve-tracker issue on the official-images repository first.

You can also reach many of the official image maintainers via the #docker-library IRC channel on Freenode.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Documentation

Documentation for this image is stored in the django/ directory of the docker-library/docs GitHub repo. Be sure to familiarize yourself with the repository’s README.md file before attempting a pull request.

library, sample, Django