INSTALL.txt

Installing  WSO2 Identity Server 5.1.0
======================================

WSO2 Identity Server 5.1.0 can be run either in standalone mode or as a web application within a
servlet container.

1. The directory containing this INSTALL file will 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 directory.

3. To start Carbon, use wso2server.sh in all *nix
   system & wso2server.bat file on Windows operating systems.

4. Either of the following commands can be used to start Carbon
      i)  ./wso2server.sh {start|stop|restart|version}
     ii)  wso2server.bat {start|stop|version}

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

            command:
                --debug <port> 	Start the server in remote debugging mode.
                        port: The remote debugging port.
                --start		Start Carbon using nohup
                --stop		Stop the Carbon server process
                --restart	Restart the Carbon server process
                --version	What version of the product are you running?


            system-properties:
                -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 & other configuration,
                     	           	recreate DB, re-populate the configuration,
                                	and start Carbon
                -Dcarbon.registry.root	The root of the Registry used by
                                        this Carbon instance
                -DserverRoles=<roles>	A comma separated list of roles. Used in deploying cApps
                -Dcarbon.use.registry.repo	Use registry based repository.
                -Dweb.location		The directory into which UI artifacts
                                    	included in an Axis2 AAR file are extracted to



Hardware Requirements
-------------------
1. Minimum memory - 1GB
2. Processor      - Pentium 800MHz or equivalent at minimum

Software Requirements
-------------------
1. Java SE Development Kit - 1.6 (1.6.0_24 onwards)
3. The Management Console requires full Javascript enablement of the Web browser.
   

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