= Installation Guide =

=== System Requirements ===
To build and use Multistage, you must have JDK 1.6 or better installed on your system. JAVA_HOME environment variable should also be set to this version of the JDK. For windows NT/2000/XP, here is a brief description on how to set JAVA environmental variables in your system:

 1. Go to Control Panel, click on 'System' icon, and then select the 'Advanced' Tab.
 1. Click on the 'Environmental Variables' Icon;
 1. Under the user variables, add 'New' Variable: JAVA_HOME, with value pointing where your jdk is installed: e.g. JAVA_HOME: c:\jdk1.6
 1. Modify your 'PATH' variable by adding 'New Variable: PATH, with value: %PATH%;%JAVA_HOME%\bin
 1. Click OK (twice) to exit.
 1. Open a Dos Command Prompt, and type command: 'java', at the shell prompt. If you see the message: Usage: java [-options]..., that means you have successfully added the JAVA environmental variable.

    
=== Build Notes ===
Type "build targets" at command prompt of installed multistage directory to print a list of options on the screen. Then run the desired target by typing "build (target name)", where (target name) is the option from list (i.e. "build distx").

=== Quick Installation and Configuration: ===
You MUST follow these steps prior to running Multistage for the first time:

 1. To specify log directories and other log details, you must modify the 'conf/log4j.properties' file for server-side and 'conf/clientlog.properties' for client side.
 1. To specify the server (ip) address of the multistage server, you must modify the 'conf/[wiki:mult-client.properties]' file where it says "defaultHost=". (Example: defaultHost = 128.97.190.171)
 1. To enable testing mode, you must modify the 'conf/[wiki:mult-client.properties]' file where it says "defaultMode =". Enter "testing" to enable testing mode, or "normal" for normal mode. Refer to 'Automated testing' under Optional Services.

=== Running Multistage ===
Run "server-multistage.bat", or "client-multistage.bat" from the /bin directory in the installed Multistage directory.

A more detailed guide to running multistage can be found in the [wiki:UserGuide User Guide].

=== Troubleshooting ===

 1. "When I run 'client-multistage.bat' there are several log4j errors even though the client seems to work fine after."
      Make sure that all log details are configured correctly in the 'conf/clientlog.properties'. (i.e. double check all file paths)
 1. "When I run 'client-multistage.bat' the login window appears but I cannot edit any or some of the fields."
      Most likely testing mode is enabled in the '/conf/[wiki:mult-client.properties]' file. See user manual for more details.