Official Repository

Last pushed: 10 months ago
Short Description
Django is a free web application framework, written in Python.
Full Description

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

Quick reference

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)

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.

Docker Pull Command

Comments (11)
mysticzhong
a year ago

I download it so slow,.......

mths0x5f
a year ago

I'm not the first, but how is this official? Django should never run a server in production!

spirit986
2 years ago

I am attempting to pull this but it hangs in the end with Waiting status? Anybody noticed anything similar? I've just tried with the ngnix container and it pulled with no problems.

mtamazlicaru
2 years ago

Hey @morninj, thank you for sharing!

amosnier
2 years ago

@mes5k: thanks for your question about the onbuild not installing django. I am just starting to study docker, did notice the lack of django in the onbuild Dockerfile, and thought I was the one missing something. So: it's not just you, it's me too!

hiren
2 years ago

The details do not make it clear that this image should not be used in production with the CMD set as it is. It does not mention a proper web server being needed. It is an official image so the default settings can be confused to be sane to use as is in prod. There's a github issue open for it but it wasn't fixed?

mes5k
2 years ago

Am I crazy for thinking that the django:onbuild image should actually install django? It's no problem to add it to the requirements.txt, but isn't django the whole point of this image?

morninj
2 years ago

I've built a production-ready Django image here: https://github.com/morninj/django-docker

It uses Nginx, Gunicorn, and MySQL.

ryuheechul
2 years ago

hope 1.7.4-python2 include bz2!

tback
3 years ago

thanks @wernight for pointing this out.

How on earth is this an official repo?
The django documentation clearly states

DO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone
through security audits or performance tests. (And that’s how it’s gonna stay.
We’re in the business of making Web frameworks, not Web servers, so
improving this server to be able to handle a production environment is
outside the scope of Django.)