| the IronMailer site |

| Home |

| Technical |

# Installation Notes

PDF

- Prerequisites
- Installing IronMailer into an existing servlet container
- Using IronMailer
- Logging configuration (optional)
- IMAP/SSL configuration (optional)

### Prerequisites

The server on which your webmail will run needs to have these prerequisites.

1. Java. Recommended 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
2. Check your Java environment. Java binaries such as "java" should be in your path
3. A Java servlet engine. Recommended: Tomcat 3.3.X or 4.1.X. Others should work, as long as they implement the Servlet API >= 2.2
4. An IMAP service (for e-mails). The IMAP service need not be on the same machine as the Webserver.
   Note
   For help regarding the IMAP service, the document Imap Notes 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.
5. Optional: Jakarta ant. If you want to rebuild the Ironmailer application from source, jakarta ant is useful (the ant build file is provided)

Note
An integrated package of IronMailer exists, meaning with the servlet engine integrated. This is useful if you want just want to be able to try it out quickly. Check the downloads page.

### Installing IronMailer into an existing servlet container

IronMailer is installed as a normal J2EE web application, however IronMailer is usually packaged into three files, for easier updates. This means the following steps:

1. create a directory for ironmailer within your servlet container application directory
2. uncompress the IronMailer Web archive in your deployment directory:
   jar xf "path-to-package"/ironmailer-"version".war
3. uncompress the IronMailer third party libraries in the same directory:
   unzip "path-to-packages"/ironmailer-thirdparty.zip
4. 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
5. some servlet containers require you to setup an application description file in this directory, called, for instance, ironmailer.xml. See the examples.

Note
Example installation for Tomcat 4.1.X:
- go to the webapps subdirectory of Tomcat
- (optional step) copy the ironmailer.xml.sample configuration file from the doc/howto/tomcat/tomcat4 directory and rename it to the desired web application name (for example, ironmailer.xml). This configuration file, if present, will allow you to override Tomcat's default behavior for this application
- 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
Note
Example installation for Tomcat 3.3.X:
- go to the configuration subdirectory of Tomcat
- copy the apps-ironmailer.xml configuration file 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

### Using IronMailer

In your browser, request the URL: http://localhost:8080/ironmailer

Note
this is assuming your browser is on the same host as your server, so you can use localhost. If not, change the name accordingly.
Note
This also assumes that you are running Tomcat (or other servlet engine) 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.

### Logging configuration (optional)

IronMailer uses log4j for application logging. Create a log4j configuration file in the configuration directory of your servlet container, or in the WEB-INF/classes subdirectory of IronMailer. The subdirectory howto has an example log4j configuration file:

- Log4j configuration sample, in the classic format
- Log4j configuration sample, in XML format

### IMAP/SSL configuration (optional)

If your IMAP backend supports SSL, you can activate SSL in the IronMailer configuration file ironmailer.xconf. See this file for further information.

Copyright © 2004 Jatec and Politux.org All rights reserved.