Installing  WSO2 Load Balancer (LB) 1.0.0-SNAPSHOT
===================================================

WSO2 LB 1.0.0-SNAPSHOT can be run either in standalone mode or as a webapp within a
servlet container, for webapp deployment please follow the ESB documentation
available at the http://wso2.org/project/esb/java/4.0.0-SNAPSHOT/docs/index.html or
download the WSO2 ESB documentation distribution.

Standalone Mode
=======================
1. The directory containing this INSTALL.txt file will be the root and it will be
   treated as Carbon home directory and let it be CARBON_HOME.

2. All the shell scripts and .bat files are available in CARBON_HOME/bin folder.

3. To start LB one can use either wso2server.sh or daemon.sh in all Unix
   systems & wso2server.bat file on Windows operating systems.

4. Either of the following commands can be used to start ESB
      i)  ./wso2server.sh {console|start|stop|restart|status|dump|version}
     ii)  ./daemon.sh {console|start|stop|restart|status|dump}
    iii)  wso2server.bat {start|stop|version}

        Usage: wso2server.sh [command] [options] [system-properties]

            command:
                --run		    Run the ESB server
                --start		    Start ESB as a Unix daemon in the background
                --console	    Start ESB as a Unix daemon in the foreground
                --stop		    Stop the ESB Unix daemon
                --status	    Get the status of the ESB Unix daemon
                --dump		    Print a thread dump of the ESB Unix daemon
                --restart	    Restart the ESB Unix daemon
                --version	    What version of the ESB server are you running
		--n 		    Start Multiple Instances of the same server after you 
				    have successfully installed the Multiple-instances features
				    from a feature repo.
            options:
                --debug <port> 	Start the server in remote debugging mode.
                                port: The remote debugging port.
                --cleanCache	Clean cache & component repository
                --cleanRegistry	Clean registry space
                --reset		    Clean the cache & component repository and the
                                registry space

            system-properties:
                -DhttpPort		Overrides the HTTP port defined in the
                                transports.xml file
                -DhttpsPort		Overrides the HTTPS port defined in the
                                transports.xml file
                -DuseSynapseXML Reloads the synapse configuration from the
                                synapse.xml file
                -DSynapseServerName=[server-name]
                                Server name of the synapse server
                -DosgiConsole=[port]
                                Start Carbon with Equinox OSGi console.
                                If the optional 'port' parameter is provided, a
                                telnet port will be opened
                -DosgiDebugOptions=[options-file]
                                Start Carbon with OSGi debugging enabled.
                                If the optional 'options-file is provided, the
                                OSGi debug options will be loaded from it.
                -Dsetup			Clean the Registry database & other
                                configuration, recreate DB, re-populate the
                                configuration, and start Carbon
                -Dcarbon.registry.root
                                The root of the Registry used by
                                this Carbon instance
                -Dwso2.transports.xml
                                Location of the transports.xml file.
                -Dweb.location	The directory into which UI artifacts
                                included in an Axis2 AAR file are extracted to

System Requirements
=======================
1. Minimum memory - 256MB
2. Processor      - Pentium 800MHz or equivalent at minimum
3. Java SE Development Kit 1.5.13 or higher
4. The Management Console requires you to enable Javascript of the Web browser,
   with MS IE 6 and 7. In addition to JavaScript, ActiveX should also be enabled
   with IE. This can be achieved by setting your security level to
   medium or lower.
   NOTE:
     On Windows Server 2003, it is not allowed to go below the medium security
     level in Internet Explorer 6.x and the default medium security setting with
     IE does not allow sufficient level of JS or ActiveX enablement for the
     management console to run.
5. To compile and run the sample clients, an Ant version is required. Ant 1.7.0
   version is recommended
6. To build WSO2 ESB from the Source distribution, it is necessary that you have
   JDK 1.5.x version and Maven 2.1.0 or later

For more details see
    http://wso2.org/wiki/display/carbon/System+Requirements.