INSTALL.txt

(1) Installing  @product.name@, v@product.version@
================================================

@product.name@ @product.version@ can be run either in standalone mode or as a webapp within a
servlet container.


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

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

3. To start @product.name@ you can use either wso2server.sh or daemon.sh in all *nix
   systems & wso2server.bat file on Windows operating systems.

4. Some of the commands that can be used to start @product.name@:
      i)  ./wso2server.sh {console|start|stop|restart|status|dump|version}
     ii)  wso2server.bat {start|stop|version}

            Usage: wso2server.sh [commands] [system-properties]

            commands:
                --debug <port>     
                                Start the server in remote debugging mode.
                                port: The remote debugging port.
                --run        
                                Run the server.
                --start        
                                Start Carbon as a Unix daemon in the background.
                --console    
                                Start Carbon as a Unix daemon in the foreground.
                --stop        
                                Stop the Carbon Unix daemon.
                --status    
                                Get the status of the Carbon Unix daemon.
                --dump        
                                Print a thread dump of the Carbon Unix daemon.
                --restart    
                                Restart the Carbon Unix daemon.
                --version    
                                The version of the product you are running.

            system-properties:
                -DhttpPort    
                                Overrides the HTTP port defined in the
                                transports.xml file.
                -DhttpsPort        
                                Overrides the HTTPS port defined in the
                                transports.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 and other configuration,
                                recreate DB, re-populate the configuration,
                                and start Carbon.

                                Note: If you have changed the webapp context of
                                carbon from ROOT to foo, you will have to use 
                                -Dsetup=foo instead.
                -Dcarbon.registry.root    
                                The root of the Registry used by
                                this Carbon instance.

                                Note: Use this property if you want to have chroot
                                behavior when sharing the database between
                                multiple products.

                -DapplyPatches	Use this system property when there are patches to be applied/reverted to/from the system.
                                Drop the patches to $CARBON_HOME/repository/componenets/patches directory and restart
                                the system with this property.When you want to revert a patch, delete it from the
                                patches directory and restart the system with this property

                -Duddi=enable  To make Governance Registry UDDI enable start the server with this property.

                -Dprofile=<profile-name>  Server can be started with a subset of features which is grouped as a profile.
                                          "repository" and "uddi-registry" are available profiles.
                                          Ex. -Dprofile=repository


System Requirements
-------------------
1. Minimum memory - 2GB

2. Processor      - Pentium 800MHz or equivalent at minimum

3. Java SE Development Kit(JDK)  1.7.* or 1.8.*

4. The Management Console requires you to enable JavaScript of the Web browser,
   with MS IE 10, Google Chrome or Mozilla Firefox. 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 @product.name@ from the Source distribution, it is also necessary that you
   have Maven 3.0.5 or later.

For more details see
    http://docs.wso2.org/display/@product.version.docs@/Installation+Prerequisites



(2) Running Samples
===================

@product.name@ samples are available at the CARBON_HOME/samples directory.
The instructions to run sample are given in README.txt file of the respective
samples, which is found in the relevant bin (binary) and src (source) directories.