diff --git a/modules/core/distribution/INSTALL.txt b/modules/core/distribution/INSTALL.txt index a533f459..959609b2 100644 --- a/modules/core/distribution/INSTALL.txt +++ b/modules/core/distribution/INSTALL.txt @@ -1,18 +1,20 @@ -(1) Installing WSO2 Mobile Device Manager 2.0.0-SNAPSHOT +(1) Installing WSO2 IoT Server 3.0.0 Running the server --------------- -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. +1. The directory containing this INSTALL file will be the root and it will be treated as IoT home directory and let it be IoT_HOME. -2. All the shell scripts and .bat files are available in CARBON_HOME/bin folder. +2. WSO2 IoT Server comes as a composition of three components namely broker, core and analytics. -3. To start WSO2 Enterprise Mobility Management Solution one can use either wso2server.sh or daemon.sh in all *nix - system & wso2server.bat file on Windows operating systems. +3. Starting order of IoT components shuld be broker, core, analytics. +To start/stop/restart the IoT components one can use wso2server.sh for *nix systems & wso2server.bat for Windows systems which can be found in following locations. + IoT_HOME/broker/bin + IoT_HOME/core/bin + IoT_HOME/analytics/bin + +4. The wso2server.sh and wso2server.bat has following commands -4. Either of the following commands can be used to start WSO2 UES 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] @@ -20,9 +22,9 @@ Running the server --debug 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 + --start Start the server as a Unix daemon in the background + --console Start the server as a Unix daemon in the foreground + --stop Stop the server 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 @@ -33,7 +35,7 @@ Running the server System Requirements ------------------- -1. Minimum memory - 2GB +1. Minimum memory - 4GB 2. The Management Console requires full Javascript enablement of the Web browser NOTE: On Windows Server 2003, it is not allowed to go below the medium security diff --git a/modules/core/distribution/README.txt b/modules/core/distribution/README.txt index adf903cc..0420ee50 100644 --- a/modules/core/distribution/README.txt +++ b/modules/core/distribution/README.txt @@ -1,6 +1,6 @@ WSO2 IoT Server ---------------------- -Welcome to the WSO2 IoT Server (IoTS) 1.0.0-ALPHA release +Welcome to the WSO2 IoT Server (IoTS) 3.0.0 release ======= Key Features @@ -11,13 +11,10 @@ Key Features Installation & Running ---------------------- 1. Extract the downloaded zip file -2. Run the wso2server.sh or wso2server.bat file in the bin directory -3. Once the server starts, point your Web browser to - https://localhost:9443/ -4. After publishing these APIs, subscribe to these APIs with default app/any app. - In API store, go to my subscriptions and find client ID and secret. - -5. Please find the maven-archetype in repository/tools to generate the mdm-android-agent project & follow the README file. +2. Follow the INSTALL.txt file for install instructions +3. Once the server starts, point your Web browser to https://localhost:9443/devicemgt to see available device types and operations +4. Navigate to https://localhost:9443/api-store to see the available device APIs, You can subscribe to these APIs with default application (or by creating new application). + In API store, go to my subscriptions and find client ID and secret. Which can be used to invoke these apis. System Requirements ------------------- @@ -28,8 +25,16 @@ System Requirements WSO2 IoT Server (IoTS) Binary Distribution Directory Structure ----------------------------------------------------- - - EMM_HOME + IoT_HOME + . + ├── core //core component + ├── analytics //analytics component + ├── broker //message broker component + ├── samples //sample device types eg. connectedcup + ├── plugins //pre-built device types + +IoT core, analytics and broker has similar directory sctructure. As for example core has following structure + IoT_HOME/core . ├── bin //executables ├── dbscripts //DBScripts @@ -167,4 +172,4 @@ development methodology and is provided by the very same engineers who build the For additional support information please refer to http://wso2.com/support/ --------------------------------------------------------------------------- -(c) Copyright 2016 WSO2 Inc. +(c) Copyright 2017 WSO2 Inc. \ No newline at end of file