Clarity installation instructions
=================================

There are two possible options of Clarity installation:

   1. Installing as separate service on Windows or Unix/Linux system;
   2. Installing as web-application under Java servlet container (for example Apache Tomcat);

This page contains detail step-by-step instructions for both available options.
	

Installing Clarity as separate service
--------------------------------------
This option can be used to install Clarity both for common use on some dedicated server or for personal use on the computer running Windows or Unix/Linux operating system. The only thing necessary to run Clarity in this mode is Java Runtime Environment version 5.0 or later which can be freely downloaded and installed on your computer.
Step-by-step instructions:

   1. Download Clarity trial version (clarity.zip file) from our site;
   2. Unpack clarity.zip archive content to some place on your hard drive. You will get the following list of files:
          * clarity-X.XX.jar
          * clarity.conf
          * clarity.bat
          * clarity.sh.
   3. To start Clarity under Windows just run clarity.bat file. To stop it - close running .bat file by pressing Ctrl+C or using "Close" button at the right-top corner of the window;
   4. To start Clarity on Linux system use clarity.sh command file. Available options are:
          * clarity.sh start - runs Clarity in background mode;
          * clarity.sh stop - stops Clarity which is run in background mode;
          * clarity.sh run - runs Clarity with output to console;
   5. After that you can access it using browser by http://servername:port address where servername is name or IP address of the computer where Clarity was launched (for example localhost) and port is a port number used to access it (by default 8080 - you can specify another port number in clarity.conf file);
   6. Accessing this address at the first time you will see Clarity configuration page. Follow the instructions published there to finish the setup process.

	

Installing Clarity under servlet container (e.g. Tomcat)
--------------------------------------------------------
Use this option if you do not have access to dedicated server or plan to install and run only one copy of Clarity for common access through several addresses. For example one group of users will work with their projects and issues through http://someserver.com/clarity1/ address, other group - through http://someserver.com/clarity2/ and so on. In such case each group of users will know nothing about others and will work with Clarity exactly like in case they use it exclusively.
Installation instructions (we suppose using Tomcat as servlet container):

   1. Check if servlet container (Tomcat) is installed and run on the system where you plan to launch Clarity. Contact your server administrator or hosting service provider for details;
   2. Download Clarity trial version for running under servlet container (clarity.war file) from our site;
   3. Next step can vary depending on your preferences:
      Case #1: You can ask your administrator to place clarity.war into TOMCAT_HOME/webapps directory and restart Tomcat. After that Clarity will be accessible through http://servername:port/clarity address;
      Case #2: You can manually unpack the content of clarity.war file into Document Base folder of the context which you plan to use Clarity with. For example: you plan to access Clarity by http://yourservername.com/team/ address. In such case you should place the content of clarity.war file into Document Base folder for /team context of yourservername.com host. For more information about Tomcat hosts and contexts configuration please read Tomcat configuration reference.
      After that you can either restart Tomcat or restart only web application (context) which Clarity will be used with (/team in our example). Second variant can be performed using Tomcat Manager application.;
   4. When the steps listed above have been performed you can access Clarity using web-browser by http://servername:port/claritycontext address where servername is name or IP address of the computer where Clarity was launched (for example localhost), port is a port number used to access Tomcat web applications (8080 by default) and claritycontext - web application context where Clarity was installed to (will be /clarity if you selected "Case #1" in step 2 of setup process or your own context name otherwise). Port number can be omitted if Tomcat was configured to work with default port used for HTTP protocol (80). The example of such configuration you can see in our Clarity online demo available at http://clarity.korzh.com/demo/. Here clarity.korzh.com is address of the server and /demo is the context name where Clarity was installed to.
   5. Accessing this address at the first time you will see Clarity configuration page. Follow the instructions published there to finish the setup process.

 

Support/contacts
================
Clarity web-page: http://devtools.korzh.com/clarity/
Clarity forum: http://devtools.korzh.com/forums/viewforum.php?f=9
Clarity Online demo: http://clarity.korzh.com/demo/
Questions, suggestions: http://devtools.korzh.com/support.jsp?product=CLAR




