==============
 Installation
==============

Prerequisites
=============

You only need Python 2.4 or 2.5.

Install
=======

CAUTION: icemac.addressbook can't be installed using easy_install, you
have to follow these steps:

- Download the source distribution (see Download_).

- Extract the downloaded file.

- Run ``install.py`` using your desired python, e. g.::

  $ python2.5 install.py
 
Neither you need any root privileges nor it installs anything outside
its directory.

Running
=======

The server runs on 127.0.0.1:8080. To change this edit deploy.ini.

To run in foreground start using::

  $ bin/addressbook fg

To run as a demon process start using::

  $ bin/addressbook start

To stop the demon process call::

  $ bin/addressbook stop

To run the tests call::

  $ bin/test

Update
======

- Stop the application.

- Create a backup of the ZODB using::

  $ bin/backup

- Do the steps described in Install_.

- Copy the backup directory (var/backups) to the new directory.

- Restore the backup using::

  $ bin/restore

- Restart the application.
