INSTALL.txt

Installing  WSO2 BPS v@product.version@
===================================================

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 BPS 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 BPS
      i)  ./wso2server.sh {console|start|stop|restart|version}
     ii)  wso2server.bat {start|stop|version}

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

            command:
                --start		    Start BPS as a Unix daemon in the background
                --console	    Start BPS as a Unix daemon in the foreground
                --stop		    Stop the BPS Unix daemon
                --restart	    Restart the BPS Unix daemon
                --version	    What version of the BPS server are you running

            options:
                --debug <port> 	Start the server in remote debugging mode.
                                port: The remote debugging port.
                --reset		Clean the cache & component repository and the
                                registry space

            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
                -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
                -DworkerNode=true
                                Set this system property when starting as a worker node.
                                This is required in clustered setups with master and worker nodes.
                -Dprofile=worker   Start the server as a worker node (BPS 3.2.0 onwards)

System Requirements
=======================
1. Minimum memory - 4GB
2. Processor      - 3GHz Dual­core Xeon/Opteron (or latest)
3. Java SE Development Kit 1.7 or higher
4. 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.
5. To build WSO2 BPS from the Source distribution, it is necessary that you have
   JDK 1.7 version and Maven 3.0.4 or later

Running Samples
=======================
BPS samples are available at CARBON_HOME/repository/samples directory.

The samples could be deployed with wso2bps-samples.sh script located in  CARBON_HOME/bin directory.
Ex: Running the following command would deploy the HelloWorld2.zip sample file found in the samples
 folder.
wso2bps-samples.sh -s HelloWorld2.zip