diff --git a/django/README-short.txt b/django/README-short.txt new file mode 100644 index 000000000..9ce9904aa --- /dev/null +++ b/django/README-short.txt @@ -0,0 +1 @@ +Django is a free web application framework, written in Python. diff --git a/django/README.md b/django/README.md new file mode 100644 index 000000000..a51a0740e --- /dev/null +++ b/django/README.md @@ -0,0 +1,89 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.7.1-python2`, `1.7-python2`, `1-python2`, `python2` (*2.7/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/2.7/Dockerfile) +- [`python2-onbuild` (*2.7/onbuild/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/2.7/onbuild/Dockerfile) +- [`1.7.1-python3`, `1.7.1`, `1.7-python3`, `1.7`, `1-python3`, `1`, `python3`, `latest` (*3.4/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/3.4/Dockerfile) +- [`python3-onbuild`, `onbuild` (*3.4/onbuild/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/3.4/onbuild/Dockerfile) + +For more information about this image and its history, please see the [relevant +manifest file +(`library/django`)](https://github.com/docker-library/official-images/blob/master/library/django) +in the [`docker-library/official-images` GitHub +repo](https://github.com/docker-library/official-images). + +# 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)](https://en.wikipedia.org/wiki/Django_%28web_framework%29) + +![logo](https://raw.githubusercontent.com/docker-library/docs/master/django/logo.png) + +# 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. + +# License + +View [license information](https://github.com/django/django/blob/master/LICENSE) +for the software contained in this image. + +# User Feedback + +## Issues + +If you have any problems with or questions about this image, please contact us + through a [GitHub issue](https://github.com/docker-library/django/issues). + +You can also reach many of the official image maintainers via the +`#docker-library` IRC channel on [Freenode](https://freenode.net). + +## 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](https://github.com/docker-library/django/issues), 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. diff --git a/django/content.md b/django/content.md new file mode 100644 index 000000000..37685c5b8 --- /dev/null +++ b/django/content.md @@ -0,0 +1,49 @@ +# 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)](https://en.wikipedia.org/wiki/Django_%28web_framework%29) + +%%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. diff --git a/django/license.md b/django/license.md new file mode 100644 index 000000000..0acfedad6 --- /dev/null +++ b/django/license.md @@ -0,0 +1,2 @@ +View [license information](https://github.com/django/django/blob/master/LICENSE) +for the software contained in this image. diff --git a/django/logo.png b/django/logo.png new file mode 100644 index 000000000..d145c20e9 Binary files /dev/null and b/django/logo.png differ