=========================
 Installing Eleusis 0.1
=========================

:Last update:   $Date: 2008-11-03 12:25:48 $
:Revision:      $Revision: 1.0 $

.. contents:: Contents
.. section-numbering::

This document contains instructions for installing the Eleusis passwordstore application

For information on the capabilities and features of Eleusis, see the file
README_ in the top-level directory of the Eleusis distribution.


Obtaining Eleusis
==================

Eleusis can be obtained from the authors website

   http://h4des.org/index.php?inhalt=eleusis


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

To function properly, Eleusis **requires** the following:

1. A working Horde installation.

   Eleusis runs within the `Horde Application Framework`_, a set of common
   tools for Web applications written in PHP. You must install Horde before
   installing Eleusis.

   .. Important:: Eleusis 1.0 requires version 3.0+ of the Horde Framework -
                  earlier versions of Horde will **not** work.

   .. _`Horde Application Framework`: http://www.horde.org/horde/

   The Horde Framework can be obtained from the Horde website and FTP server,
   at

      http://www.horde.org/horde/

      ftp://ftp.horde.org/pub/horde/

   Many of Eleusis's prerequisites are also Horde prerequisites.

   .. Important:: Be sure to have completed all of the steps in the
                  `horde/docs/INSTALL`_ file for the Horde Framework before
                  installing Eleusis.

2. Install the MCrypt module for php.

   Eleusis uses the MCrypt module for php to encrypt/decrypt passwords.

   For further informations and to get MCrypt take a look at

   http://mcrypt.sourceforge.net/

   and

   http://php.net/manual/en/mcrypt.setup.php


Installing Eleusis
===================

Eleusis is written in PHP, and must be installed in a web-accessible
directory. The precise location of this directory will differ from system to
system. Eleusis must be installed directly underneath Horde in the
web server's document tree.

Since Eleusis is written in PHP, there is no compilation necessary; simply
expand the distribution where you want it to reside and rename the root
directory of the distribution to whatever you wish to appear in the URL. For
example, with the Apache web server's default document root of
``/var/www``, you would type::

   cd /var/www/horde
   tar zxvf /path/to/eleusis-0.1.tar.gz
   mv eleusis-0.1 eleusis

and would then find Eleusis at the URL::

   http://your-server/horde/eleusis/


Configuring Eleusis
====================

1. Configuring Horde for Eleusis

   Register the application

      In ``horde/config/registry.php``, add the following lines:

      $this->applications['eleusis'] = array(
          'fileroot' => dirname(__FILE__) . '/../eleusis',
          'webroot' => $this->applications['horde']['webroot'] . '/eleusis',
          'name' => _("Passwordstore"),
          'status' => 'active',
      );

2. Write Permissions for Eleusis

   Before you can use Eleusis, you need to give the right permissions on the
   Eleusis directory. Make the ``passwordstore`` directory, the ``passwords``
   directory and the ``indexfile`` writable by the webserver. If your webserver
   runs as ``www.www``, do as follows:

   chown -R www:www /var/www/horde/eleusis/passwordstore
   chmod 770 /var/www/horde/eleusis/passwordstore
   chmod 770 /var/www/horde/eleusis/passwordstore/indexfile
   chmod 770 /var/www/horde/eleusis/passwordstore/passwords

3. Securing Eleusis

   To ensure you have a secure passwordstore application you must use _https_
   instead of http.

4. Testing Eleusis

   Once you have installed Eleusis, you can click on the ``Passwordstore`` link
   in the Horde menu. Create a passwordstore for yourself and add some passwords. 
   When you do so, you can see if Eleusis is working.


Obtaining Support
=================

If you encounter problems with Eleusis, help is available! Please contact the 
author of Eleusis.

Thanks for using Eleusis!

The Eleusis team
