Installation instructions

HOW TO INSTALL ENCHANTED2.0 WEBMAL

NOTE: These instructions are tested with Ubuntu 8.10

====================================================
WARNING: ENCHANTED2.0 IS UNDER DEVELOPMENT AND IT'S
         NOT READY FOR PRODUCTION
====================================================

INDEX:
  1. Requirements
  2. Enchanted library and imap proxy installation
  3. Enchanted Webmail installation
  4. Other

1. REQUIREMENTS

1.1 Install the following twisted packages:
 - python-twisted
 - python-twisted-bin
 - python-twisted-conch
 - python-twisted-core
 - python-twisted-lore
 - python-twisted-mail
 - python-twisted-names
 - python-twisted-news
 - python-twisted-runner
 - python-twisted-web
 - python-twisted-web2
 - python-twisted-words

1.2 Install django (you can find django in the repository (universe) in
the python-django package, but I prefer the svn version).

1.3 Install the bzr package.

1.4 A database is needed. The supported databases are the same supported
    by Django: 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3'
    'ado_mssql'

2. ENCHANTED LIBRARY AND PROXY

First of all, install the needed library (enchantedlib) and the imapproxy.
So, open a terminal, choose a location where you want to put the sources:
we choose the directory ~/sources. So:

----------------------------------------------------
$ mkdir -p sources/enchantedimapproxy
$ cd sources/enchantedimapproxy
$ bzr branch lp:~lorenzosfarra/enchanted/enchantedimapproxy
$ cd enchantedimapproxy
----------------------------------------------------

Now you have to edit imapproxysettings.py to change the default values
(if you need it), the comments in the file itself should be enough.

Then, proceed with the library installation (you need the root privileges,
here I'm using sudo):

----------------------------------------------------
$ sudo python setup.py install # --clean to remove a previous version
----------------------------------------------------

Now, the proxy is ready to be launched with twisted. So, something like:

----------------------------------------------------
$ twistd -noy imapproxy.py
----------------------------------------------------

3. ENCHANTED WEBMAIL INSTALLATION

Open a terminal, choose a location where you want to put the sources:
again, we choose the directory ~/sources. So:

----------------------------------------------------
$ mkdir -p sources/enchanted
$ cd sources/enchanted
$ bzr branch lp:~lorenzosfarra/enchanted/enchanted
$ cd enchanted
----------------------------------------------------

Now, create /var/log/enchanted and set the rw permission to the user
who will run the webmail software (in later revisions I'll add the
support for different logs position).

Then, edit settings.py and change the values you need to change. Again,
the comments in the file itself should be enough.

To run the webmail, simply launch the following command:

----------------------------------------------------
$ python manage.py runserver # --traceback
----------------------------------------------------

But this is only for "demo". If you want a serious installation, you
can check the django documentation.
Take a look at http://docs.djangoproject.com/en/dev/howto/deployment/ .

4. OTHER

Feedbacks and suggestions are always welcome!
And if you want to join the project, simply write me an email
and start developing enchanted!