.. _install_mapfish_framework:

Installation
************

The easiest way to install the MapFish framework is to use the so-called ``go``
script.

The ``go`` script is known to work on Windows, Mac and Linux systems.

.. note::

  To be able to install and use the MapFish framework you need to have Python
  installed, version 2.5 or 2.6. You also need `win32api
  <http://sourceforge.net/projects/pywin32/files/>`_ on Windows.

.. _using_go_script:

Using the ``go`` script
=======================

Download the `go script
<http://www.mapfish.org/downloads/go-mapfish-framework-all.py>`_. On a Unix
system you can use wget::

 wget http://www.mapfish.org/downloads/go-mapfish-framework-<version>.py

Now run the script::

 python go-mapfish-framework-<version>.py venv

.. note::
  
  Replace ``<version>`` with the MapFish version of your choice. 1.2 is
  certainly a good choice.

The command creates a directory named ``venv`` with the MapFish framework and
its dependencies installed into it. ``venv`` is a virtual Python environment,
see the `virtualenv page <http://pypi.python.org/pypi/virtualenv>`_ for more
details.

The MapFish framework is now installed and ready to use!

.. _from_svn:

From SVN trunk
==============

Installing the MapFish framework using the ``go`` script is recommended
(:ref:`using_go_script`). But here is the procedure to install from SVN.

You must first create a virtual Python environment. Unix users can use
the following::

  wget http://pypi.python.org/packages/source/v/virtualenv/virtualenv-1.3.3.tar.gz
  tar xvzf virtualenv-1.3.3.tar.gz
  cp virtualenv-1.3.3/virtualenv.py ./
  rm -rf virtualenv-1.3.3
  rm virtualenv-1.3.3.tar.gz
  python virtualenv.py venv

Windows users will download the ``virtualenv-1.3.3.tar.gz`` archive and extract
it using a tool such as `7-zip <http://www.7-zip.org>`_. The Windows command to
create the virtual environment would be something like this::

  C:\>C:\Python25\python.exe "C:\Documents and Settings\Administrator\virtualenv.py" C:\venv
  New python executable in C:\venv\Scripts\python.exe
  Installing setuptools..............done.

You can now activate the virtual environment. Use this on Unix::

  source venv/bin/activate

and this on Windows::

 C:\venv\Scripts\activate.bat

You can now proceed with checking out the MapFish framework and installing it::

  svn co http://www.mapfish.org/svn/mapfish/framework/server/trunk MapFishFramework
  easy_install --index-url=http://www.mapfish.org/downloads/all/pkg --allow-hosts=www.mapfish.org MapFishFramework

The last thing to do is to checkout and install the client plugin (which
contains the JavaScript libraries)::

  svn co http://www.mapfish.org/svn/mapfish/framework/plugin/client/trunk MapFishPluginClient
  easy_install --index-url=http://www.mapfish.org/downloads/all/pkg --allow-hosts=www.mapfish.org MapFishPluginClient

You're done!