INSTALL.txt

Installing  WSO2 Enterprise Service Bus (ESB) 4.9.0-SNAPSHOT
===================================================

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 ESB one can use wso2server.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|version}
     ii)  wso2server.bat {start|stop|version}

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

            command:
                --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
                --restart	    Restart the ESB Unix daemon
                --version	    What version of the ESB server are you running

            options:
                --debug <port> 	Start the server in remote debugging mode.
                                port: The remote debugging port.

            system-properties:
                -DhttpPort		Overrides the HTTP port defined in the
                                catalina-server.xml file
                -DhttpsPort		Overrides the HTTPS port defined in the
                                catalina-server.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             
                -Dweb.location	The directory into which UI artifacts
                                included in an Axis2 AAR file are extracted to
                -DworkerNode=true
                                Set this system property when starting as a worker node.
                                This is required in clustered setups with master and worker nodes.

System Requirements
=======================
1. Minimum memory - 2GB
2. Java SE Development Kit 1.6.24 or higher
3. The Management Console requires you to enable Javascript of the Web browser,
   with MS IE 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.
4. To compile and run the sample clients, an Ant version is required. Ant 1.7.0
   version is recommended
5. To build WSO2 ESB from the Source distribution, it is necessary that you have
   JDK 1.6.24 version and Maven 3.0.4 or later

For more details see
    http://docs.wso2.org/wiki/display/ESB481/Installation+Prerequisites

Running Samples
=======================
ESB samples are available at CARBON_HOME/repository/samples directory.
The instructions to run samples are given in the samples guide in the WSO2 ESB
Documentation, http://docs.wso2.org/display/ESB480/Samples.

To run the ESB server in sample mode use,

    ./wso2esb-samples.sh -sn ${sample-number}
    ./wso2esb-samples.bat -sn ${sample-number}