django1/docs/install.txt

=====================
How to install Django
=====================

This document will get you up and running with Django.

Install Apache and mod_python
=============================

Currently, Django runs on Apache_ with `mod_python`_, although we're planning
full WSGI support, which means Django will run on a variety of server
platforms.

Make sure you have Apache installed, with the mod_python module activated.

.. _Apache: http://httpd.apache.org/
.. _mod_python: http://www.modpython.org/

Get your database running
=========================

If you plan to use Django's database API functionality, you'll need to
make sure a database server is running. Django works with PostgreSQL_
(recommended) or MySQL_.

Additionally, you'll need to make sure your Python database bindings are
installed. If you're using PostgreSQL, you'll need the psycopg_
package (version 1 -- not version 2, which is still in beta). If you're using
MySQL, you'll need MySQLdb_.

.. _PostgreSQL: http://www.postgresql.org/
.. _MySQL: http://www.mysql.com/
.. _psycopg: http://initd.org/projects/psycopg1
.. _MySQLdb_: http://sourceforge.net/projects/mysql-python

Install the Django code
=======================

Installation instructions are slightly different depending on whether you're
using the latest official version or the latest development version.

It's easy either way.

Installing the official version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Download the tarball of the latest official version from our `download page`_.
2. ``tar xzvf django-1.0.0.tar.gz``
3. ``cd django-1.0.0``
4. ``python setup.py install``

Installing the development version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Make sure you have Subversion_ installed.
2. ``svn co http://code.djangoproject.com/svn/django/trunk/ django_src``
3. Symlink ``django_src/django`` so that ``django`` is within your Python
   ``site-packages`` directory:

   ``ln -s django_src/django /usr/lib/python2.3/site-packages/django``

   (In the above line, change ``python2.3`` to match your current Python version.)

When you want to update your code, just run the command ``svn update`` from
within the ``django_src`` directory.

.. _`download page`: http://www.djangoproject.com/download/
.. _Subversion: http://subversion.tigris.org/