About Us

Site Map

Contact Us

Claros inTouch Installation

This page provides information on how to install Claros In Touch using Tomcat and MySQL. All installation parts are described as single steps. After completing each step you are strongly advised to verify the success of your work.

Install the Java 2 SDK, version 1.5 or newer

Install the Java 2 SDK, version 1.5 or newer (from SUN http://java.sun.com/products/j2se/). For details on how to install these components on your operating system, see the documentation that comes with them. You must install the Java SDK, not the JRE (Java Runtime Environment) that is also available from SUN.

Important : Claros In Touch 1.x and 2.x were tested with 1.5 and 1.6 only. Some features regarding file encoding were used that are not available with Java releases before 1.5.

Please note: FreeBSD users may need to setup new entropy sources in the O/S using rndcontrol. Otherwise the installation process may hang. For example, on a machine with a network interface card on IRQs 9, you can execute

rndcontrol -s 9

Install Tomcat

Claros In Touch is only tested on WebSphere Application Server, Resin, Tomcat 5.x, Jboss, Sun App Server and Jetty. Older versions of Tomcat (4.x and earlier) may not (probably will not) be usable for Claros In Touch 2.x.

Install Tomcat from http://jakarta.apache.org/tomcat/index.html into a folder of your choice. This is the CATALINA_HOME folder. Don’t forget to set the environment variables CATALINA_HOME and JAVA_HOME.

Windows users: please do not put any spaces in the installation path for tomcat. E.g: c:\program files\tomcat will not work. Install it under c:\tomcat for example.

Test the installation by running Tomcat in standalone mode and check the examples.

Note: Tomcat uses port 8080 in standalone mode.

Please note: If you wish, you can combine the servlet-engine with a webserver like the Apache Web Server (http://www.apache.org/httpd.html).

Please note: On Linux systems, sometimes you might need to run JDK with some extra environment variables. To do so, append :

export JAVA_OPTS="-Djava.net.preferIPv4Stack=true"

to one of your Linux startup scripts.

Install MySQL

Install MySQL from http://www.mysql.com/downloads/index.html (see the MySQL documentation on http://www.mysql.com/documentation/index.html). On Windows-based systems MySQL has to be installed on the C:\ drive and should be registered as service using %MYSQL_HOME%/bin/mysqld -install .

Claros In Touch can be used with MySQL 3.2, 4.0 and 4.1 and 5.X. For performance reasons we recommend MySQL 4.1+, or at least 4.0.

Start the MySQL server by running the service (WIN32) or executing %MYSQL_HOME%/bin/mysqld (UNIX).

Check that MySQL is running before you continue by starting the MySQL monitor (execute mysql in your MySQL bin folder). The database works correctly if a MySQL prompt appears after calling the monitor. Quit the MySQL monitor by typing exit and go to the next step.

Important: You will have to increase the MySQL configuration variable max_allowed_packet located in the MySQL configuration file (usually called my.ini or my.cnf). For Claros In Touch, the limit should be as high as possible, a setting of max_allowed_packet=16M is recommended.

MySQL users can find the SQL query to create the initial tables in the SQL folder of the package. Create a user, run the permissions and grant select, insert, delete, update rights to that user. More information on how to do these can be found at MySQL official page.

Deploy the intouch2.war file

Copy the intouch2.war file from the binary distribution ZIP file to CATALINA_HOME/web-apps/. Replace CATALINA_HOME with the real path to your Tomcat installation.

Start (or restart) Tomcat. Tomcat will now deploy the web application Claros In Touch.

Important: Claros In Touch requires that it’s *.war file is unpacked. Claros In Touch can not be deployed as war file only. Make sure Tomcat does unpack the war file and creates the CATALINA_HOME/webapps/intouch2/ directory, placing the Claros In Touch files in this directory.

The default configuration for your Servlet containers / environment could be to not unpack the deployed *.war file. If this is the case you must unpack the intouch2.war file manually. Use an unzip tool for this, *.war files are just *.zip files with a different extension.

Prepare a writable temporary directory

Claros inTouch 2 needs a temporary directory to store uploaded attachments. Please create a folder and indicate it in the config.xml file at the following step. Follow these easy steps :


mkdir CATALINA_HOME/WEB-INF/tmp
chown tomcat:tomcat -R CATALINA_HOME/WEB-INF/tmp
chmod 777 -R CATALINA_HOME/WEB-INF/tmp

Edit The config.xml file.

Open CATALINA_HOME/webapps/intouch2/WEB-INF/config/config.xml file with your favorite editor and edit the main configurations. Replace CATALINA_HOME with the real path to your Tomcat installation.

Please do not forget to state the <tmp-dir></tmp-dir> (see previous step)DO NOT PUT A SLASH (/) AT THE END OF THE FILE PATH

Please also do not forget to have a look at the namespaces. If you are using Courier or Cyrus IMAP implementation you probably are using namespaces for IMAP folder mechanism, so your namespace setting should be like the following(don't forget the dot character) . If your IMAP server doesn't use namespaces leave this field blank.

<folder-namespace>INBOX.</folder-namespace>

Important: Tomcat must be restarted each time config.xml is edited. This is because config.xml file is read only once at the initialization phase. So please restart your Tomcat server once more to start using Claros In Touch.

Now your system is ready

Now your system is ready to use. You can create a new e-mail user with standard tools you used before depending on the mail server you use. Claros In Touch does not create an e-mail account for you. You need to do it for yourself. After you created your e-mail account you can login with the username/password you assigned while you were creating the e-mail account.

Security issues

After you installed Claros In Touch, make sure noone else other than the user you are running Tomcat has read/write permissions on the CATALINA_HOME/webapps/intouch2/WEB-INF/config/config.xml file. It is a regular plain text XML file and anyone who has permission to read the file can access the credentials to access the Claros database. Please protect it.

 


Most Popular Howto & Guidelines
Claros inTouch 2.1
Claros inTouch Devel 2.2 Beta
Claros Chat 1.0
Claros Mini 1.0

Claros inTouch Installation,

Install the Java 2 SDK, version 1.4 or newer (from SUN). For details on how to install these components on your operating system, see the documentation that comes with them. You must install the Java SDK, not the JRE (Java Runtime Environment) that is also available from SUN.

Important : Claros In Touch 1.x and 2.x were tested with Java 1.4 and 1.5 only. Some features regarding file encoding were used that are not available with Java releases before 1.4.

Please note: FreeBSD users may need to setup new entropy sources in the O/S using...


Claros is revolutionary software. I love how it has a notebook, email, RSS reader and chat built in to one great web application. It simplifies doing all of my tasks whether it be reading the latest technology news, sending an email or chatting with colleagues and friends.
Technologics Servers Inc.