This document is an older, unmaintained guide. There may be a new guide available for this software.
Django is a web development framework for the Python programing language. It was initially developed for use in a newspaper's website division, and as a result the Django framework is very well suited to developing content-centric applications.
This guide provides an introduction to getting started with the Django framework, using the mod_wsgi method of deploying python applications. Please complete the the getting started guide prior to beginning this guide on an up to date system. Furthermore, you will want a running Apache web server and a functional MySQL database system installed.
Before you begin installing and configuring the components described in this guide, please make sure you've followed our instructions for setting your hostname. Issue the following commands to make sure it is set properly:
hostname hostname -f
The first command should show your short hostname, and the second should show your fully qualified domain name (FQDN).
Issue the following commands to ensure that your system's package repositories and installed programs are up to date:
apt-get update apt-get upgrade apt-get install python-setuptools libapache2-mod-wsgi
Additionally, you will need to install a database system and a Python driver for this database system. If you want to run the MySQL database engine, issue the following command:
apt-get install mysql-server python-mysqldb
If you want to run the PostgreSQL database server, issue the following command:
apt-get install postgresql python-psycopg2
If you want to use the SQLite embedded database, issue the following command:
apt-get install sqlite3 python-sqlite
Your application may require additional dependencies. You may install these using the Ubuntu package tools or by using the easy_install command included in python-setuptools.
There are two methods for installing Django. You may choose to install the Django packages from the Ubuntu repositories, or you can install using the python easy_install method. If you choose to install using the Ubuntu packages, you will work with the 1.2.3 version of the framework, but you will have the benefit of ongoing security and bug fixes from the Ubuntu maintainers. To install Django from the Ubuntu repositories, issue the following command:
apt-get install python-django
If you want to install Django using the easy_install tool, issue the following command:
At the time of writing, this will install version 1.2.5 of the Django framework, but may update to a more recent version. Consider the package information for Django for more information.
In order for mod_wsgi to be able to provide access to your Django application, you will need to create a django.wsgi file inside of your application directory. For the purposes of this example, we assume that your application will be located outside of your DocumentRoot in the directory /srv/www/ducklington.org/application. Modify this example and all following examples to conform to the actual files and locations used in your deployment.
import os import sys sys.path.append('/srv/www/ducklington.org/application') os.environ['PYTHON_EGG_CACHE'] = '/srv/www/ducklington.org/.python-egg' os.environ['DJANGO_SETTINGS_MODULE'] = 'settings' import django.core.handlers.wsgi application = django.core.handlers.wsgi.WSGIHandler()
You must append the path of your application to the system path as above. Additionally, declaration of the PYTHON_EGG_CACHE variable is optional, but may be required for some applications when WSGI scripts are executed with the permissions of the web server. Finally, the DJANGO_SETTINGS_MODULE must refer to the Django settings.py file for your project. You will need to restart Apache after modifying the django.wsgi file.
Consider the following example virtual host configuration:
File excerpt:Apache Virtual Host Configuration
<VirtualHost ducklington.org:80> ServerName ducklington.org ServerAlias www.ducklington.org ServerAdmin email@example.com DocumentRoot /srv/www/ducklington.org/public_html WSGIScriptAlias / /srv/www/ducklington.org/application/django.wsgi <Directory /srv/www/ducklington.org/application> Order allow,deny Allow from all </Directory> Alias /robots.txt /srv/www/ducklington.org/public_html/robots.txt Alias /favicon.ico /srv/www/ducklington.org/public_html/favicon.ico Alias /images /srv/www/ducklington.org/public_html/images Alias /static /srv/www/ducklington.org/public_html/static ErrorLog /srv/www/ducklington.org/logs/error.log CustomLog /srv/www/ducklington.org/logs/access.log combined </VirtualHost>
In this example, the WSGIScriptAlias directive tells Apache that for this virtual host, all requests below / should be handled by the WSGI script specified. In the directory block that follows, we allow Apache to serve these requests. Finally, the series of four Alias directives allow Apache to serve the robots.txt and favicon.ico files as well as all resources beneath the /images and /static locations, directly from the DocumentRoot. You can add as many Alias directives as you need to.
When you have successfully configured your Apache virtual host, issue the following command to restart the web server:
You will need to restart the web server every time the django.wsgi file changes. However, all other modifications to your application do not require a web server restart. Congratulations! You have now successfully deployed a Django application using mod_wsgi.
You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.
This guide is licensed under a Creative Commons Attribution-NoDerivs 3.0 United States License.
Last edited by Matthew Cone on Monday, October 8th, 2012 (r3090).