Prerequisites
-------------
I Server prerequisites
----------------------
1. A Java development kit (run-time is not enough).

1.1 Recommended version of Java
j2sdk1.4.X (personalization features require Java >= 1.4)
Note that you could build IronMailer with older versions, but you will
need to add additional libraries to the classpath, such as jaas.jar

1.2 Check your Java environment
Java binaries such as "jar" should be in your path

2. A Java servlet engine
Recommended: Tomcat 3.3.X or 4.1.X
Others: should work, as long as the implement the Servlet API >= 2.2

3. An IMAP service (for e-mails). For help regarding the IMAP service,
the file IMAP_NOTES.txt may contain some useful information.
You should test if your IMAP service works, for example with the
Mozilla mail client. If your IMAP does not work, you will not be able
to login into IronMailer.

4. Optional: Jakarta ant
If you want to rebuild the Ironmailer application from source,
jakarta ant is useful (the ant build file is provided)



Installing IronMailer in your servlet container
-------------------------------------------------
1. Install the application as a normal webapp (Java Web Application):
   create a directory for ironmailer and 
   - uncompress the IronMailer Web archive in your deployment directory:
       jar xf <path-to-packages>/ironmailer-<version>.war
   - uncompress the IronMailer third party libraries in the same directory:
       unzip <path-to-packages>/ironmailer-thirdparty.zip
   - if you are not within an existing Cocoon environment,
     also uncompress the required Cocoon libraries in the same directory:
       unzip <path-to-packages>/ironmailer-thirdparty-cocoon-required.zip

1.1 Example Installation for Tomcat 4.1.X
    - go to the webapps subdirectory of Tomcat
    - copy the ironmailer.xml configuration file from the 
        doc/howto/tomcat/tomcat4 directory
    - create a directory called "ironmailer" and go into
      this directory
    - unpack the ironmailer packages as described above
    - start (or stop and restart) the Tomcat server

1.2 Example installation for Tomcat 3.3.X
    - go to the configuration subdirectory of Tomcat
    - copy the apps-ironmailer.xml configuration file from the 
        doc/howto/tomcat/tomcat3 directory
    - edit this file and set whatever location you want
      for the sources of the webapplication
    - go to the location you just chose
    - unpack the ironmailer packages as described above
    - start (or stop and restart) the Tomcat server

2. Use IronMailer
    - in your browser, request the URL:
        http://localhost:8080/ironmailer
    this is assuming you are on the same host where Tomcat is running,
    and that you are running Tomcat on the port 8080 (this is default).
    If not, change the URL accordingly.
    - You should now see the IronMailer login screen. Login with the
    same user and password that you normally use on this machine.    


3. Optional: logging configuration
IronMailer uses log4j for application logging. Create a log4j
configuration file in the configuration directory of your servlet
container. The subdirectory howto has an example log4j configuration
files

4. Optional: additional configuration
All other IronMailer configuration is handled through the file 
called "sitemap.xmap", which is in the root directory of the
web application.
