From 0e6ff6b26645cf86a0018582b264b7af1466edc8 Mon Sep 17 00:00:00 2001 From: sinthuja Date: Mon, 20 Mar 2017 17:13:55 +0530 Subject: [PATCH] Further reducing the pack size. --- modules/distribution/src/assembly/bin.xml | 52 +++--- modules/distribution/src/core/INSTALL.txt | 44 ----- modules/distribution/src/core/README.txt | 189 ++++++++++++---------- 3 files changed, 131 insertions(+), 154 deletions(-) delete mode 100644 modules/distribution/src/core/INSTALL.txt diff --git a/modules/distribution/src/assembly/bin.xml b/modules/distribution/src/assembly/bin.xml index 4c25d488..5c534d4c 100755 --- a/modules/distribution/src/assembly/bin.xml +++ b/modules/distribution/src/assembly/bin.xml @@ -612,11 +612,11 @@ **/*.lock **/.data **/.settings - **/features/** + features/** **/org.wso2.carbon.feature.mgt.ui* **/artifacts.xml - **/p2 - **/lib + p2/** + lib/** **/json_2.0.0.wso2v1.jar **/nimbus-jose-jwt_2.26.1.wso2v2.jar @@ -855,11 +855,11 @@ **/.settings features/** **/org.wso2.carbon.feature.mgt.ui* - **/lib + lib/** **/json_2.0.0.wso2v1.jar **/nimbus-jose-jwt_2.26.1.wso2v2.jar **/artifacts.xml - **/p2 + p2/** @@ -996,11 +996,11 @@ **/.settings features/** **/org.wso2.carbon.feature.mgt.ui* - **/lib + lib/** **/json_2.0.0.wso2v1.jar **/nimbus-jose-jwt_2.26.1.wso2v2.jar **/artifacts.xml - **/p2 + p2/** @@ -1182,12 +1182,6 @@ src/core/conf/security/Owasp.CsrfGuard.dashboard.properties ${pom.artifactId}-${pom.version}/conf/security - - src/core/INSTALL.txt - ${pom.artifactId}-${pom.version} - true - 644 - src/core/README.txt ${pom.artifactId}-${pom.version} @@ -1207,7 +1201,7 @@ 644 - target/wso2carbon-core-${carbon.kernel.version}/bin/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/bin/ true 644 @@ -1227,7 +1221,7 @@ 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/conf/README + src/core/README.txt ${pom.artifactId}-${pom.version}/conf/ true 644 @@ -1579,7 +1573,7 @@ - target/wso2carbon-core-${carbon.kernel.version}/bin/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/analytics/bin/ true 644 @@ -1596,37 +1590,37 @@ true - target/wso2carbon-core-${carbon.kernel.version}/repository/conf/README + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/analytics/conf/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/analytics/repository/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/database/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/analytics/repository/database/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/deployment/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/analytics/repository/deployment/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/logs/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/analytics/repository/logs/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/resources/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/analytics/repository/resources/ true 644 @@ -1766,7 +1760,7 @@ - target/wso2carbon-core-${carbon.kernel.version}/bin/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/broker/bin/ true 644 @@ -1783,37 +1777,37 @@ true - target/wso2carbon-core-${carbon.kernel.version}/repository/conf/README + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/broker/conf/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/broker/repository/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/database/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/broker/repository/database/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/deployment/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/broker/repository/deployment/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/logs/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/broker/repository/logs/ true 644 - target/wso2carbon-core-${carbon.kernel.version}/repository/resources/README.txt + src/core/README.txt ${pom.artifactId}-${pom.version}/wso2/broker/repository/resources/ true 644 diff --git a/modules/distribution/src/core/INSTALL.txt b/modules/distribution/src/core/INSTALL.txt deleted file mode 100644 index 0aacac7b..00000000 --- a/modules/distribution/src/core/INSTALL.txt +++ /dev/null @@ -1,44 +0,0 @@ -Installing WSO2 IoT Server 3.0.0 - -Running the server ------------------ -1. The directory containing this INSTALL file will be the root and it is treated as the IoTS home directory, and is referred to as . - -2. WSO2 IoT Server comes as a composition of three components namely broker, core, and analytics. - -3. The starting order of the WSO2 IoTS components should be broker, core, analytics. - -4. To start/stop/restart the IoTS components, run wso2server.sh for *nix systems and wso2server.bat for Windows systems, which can be found in following locations. - /broker/bin - /core/bin - /analytics/bin - -5. The wso2server.sh and wso2server.bat startup scripts have the following commands: - - i) ./wso2server.sh {console|start|stop|restart|status|dump|version} - ii) wso2server.bat {start|stop|version} - - Usage: wso2server.sh [command] - command: - --debug Start the server in remote debugging mode - The remote debugging port - --run Run the server - --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 - --version The version of the Carbon server are you running - --n Start multiple instances of the same server after you - have successfully installed the Multiple-instances feature - from a feature repository - -System Requirements -------------------- -1. Minimum memory - 4GB -2. The WSO2 IOTS Management Console requires full Javascript enablement in the Web browser - NOTE: - On Windows Server 2003, it is not allowed to go below the medium security - level when using Internet Explorer 6.x. - diff --git a/modules/distribution/src/core/README.txt b/modules/distribution/src/core/README.txt index d287efb0..b06d40c9 100644 --- a/modules/distribution/src/core/README.txt +++ b/modules/distribution/src/core/README.txt @@ -1,117 +1,144 @@ -WSO2 IoT Server ----------------------- -Welcome to the WSO2 IoT Server (IoTS) 3.0.0 release. -======= +WSO2 IoT Server 3.1.0 +============================================================== +Welcome to the WSO2 IoT Server (IoTS) 3.1.0 release. + +WSO2 IoT Server (IoTS) provides the essential capabilities required to implement a scalable server-side IoT Platform. These capabilities +involve device management, API/App management for devices, analytics, customizable web portals, transport extensions for MQTT, XMPP +and much more. WSO2 IoTS contains sample device agent implementations for well-known development boards, such as Arduino UNO, Raspberry Pi, +Android, iOS, Windows and Virtual agents that demonstrate various capabilities. Furthermore, WSO2 IoTS is released under +the Apache Software License Version 2.0, one of the most business-friendly licenses available today. + Key Features ------------- -Self-service device enrollment and management with an end-user IoTS console. +================================== +See the online WSO2 IoT documentation for more information on product features: +https://docs.wso2.com/display/IoTS300/About+this+Release Installation & Running ----------------------- -1. Extract the downloaded ZIP file. -2. Follow the INSTALL.txt file for install instructions. -3. After the server starts, point your Web browser to https://localhost:9443/devicemgt in order to see the 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 the default application (or by creating a new application). +================================== + +Running the Integrator +================================== +1. Extract wso2iot-3.1.0.zip and go to the extracted directory/bin. +2. Run iot-server.sh or iot-server.bat. +3. Point your favourite browser to https://localhost:9443/devicemgt in order to see the available device types and operations. +4. Use the following username and password to login + username : admin + password : admin +5. Navigate to https://localhost:9443/api-store to see the available device APIs. You can subscribe to these APIs with the default application (or by creating a new application). In the API Store, go to my subscriptions and locate the client ID and secret, which can be used to invoke these APIs. + +Running other runtimes individually (Analytics, Broker) +======================================================== +1. Extract wso2iot-3.1.0.zip and go to the extracted directory. +2. Go to wso2iot-3.1.0/wso2 directory. +3. Go to appropriate runtime directory (analytics/broker) /bin. +4. Execute wso2server.sh or wso2server.bat. +3. Access the url related to the required runtime. (For example, use https://localhost:9445/carbon for the analytics runtime.) + +Running all runtimes (Integrator, Analytics, Broker, Business-Process) +================================================================== + +1. Extract wso2iot-3.1.0.zip and go to the extracted directory/bin. +2. Run start-all.sh or start-all.bat. +3. Access appropriate url for the related runtime. (For example, use https://localhost:9443/devicemgt for the IoT Server runtime) + + System Requirements -------------------- +================================== 1. Minimum memory - 4GB 2. The portal app requires full Javascript enablement on the Web browser -WSO2 IoT Server (IoTS) Binary Distribution Directory Structure ------------------------------------------------------ - IoT_HOME - . - ├── core //core component - ├── analytics //Analytics component - ├── broker //Message Broker component - ├── samples //sample device types e.g., connectedcup - ├── plugins //pre-built device types - -The IoTS Core, Analytics, and Broker have similar directory structures. For example Core has the following structure: - IoT_HOME/core - . - ├── bin //executables - ├── dbscripts //DBScripts - ├── INSTALL.txt - ├── lib - ├── LICENSE.txt - ├── modules //Jaggery Modules - ├── README.txt - ├── release-notes.html - ├── repository // repository - ├── tmp - ├── webapp-mode - - - - bin - Contains various scripts (i.e., .sh & .bat scripts). +WSO2 EI distribution directory +============================================= + + - bin + Contains various scripts .sh & .bat scripts + + - database + Contains the database - dbscripts - Contains the database creation & seed data population SQL scripts for - various supported databases. + Contains all the database scripts - lib - Contains the basic set of libraries required to startup WSO2 IoT Server - in standalone mode + Contains the basic set of libraries required to startup IoT Server + in standalone mode - repository - The repository where Carbon artifacts & Axis2 services and - modules deployed in WSO2 Carbon, and other custom deployers such as - dataservices and axis1services are stored. + The repository where services and modules deployed in WSO2 IoT. + are stored. + + - conf + Contains configuration files specific to IoT. + + - logs + Contains all log files created during execution of IoT. + + - resources + Contains additional resources that may be required, including sample + configuration and sample resources - - carbonapps - Carbon Application hot deployment directory. + - samples + Contains some sample services and client applications that demonstrate + the functionality and capabilities of WSO2 IoT. - - components - Contains all OSGi related libraries and configurations. + - tmp + Used for storing temporary files, and is pointed to by the + java.io.tmpdir System property - - conf - Contains server configuration files. e.g., axis2.xml, carbon.xml + - LICENSE.txt + Apache License 2.0 and the relevant other licenses under which + WSO2 EI is distributed. - - data - Contains internal LDAP related data. + - README.txt + This document. - - database - Contains the WSO2 Registry & User Manager database. + - release-notes.html + Release information for WSO2 IoT 3.1.0 - - deployment - Contains server side and client side Axis2 repositories. - All deployment artifacts should go into this directory. + - patches + Used to add patches related for all runtimes. - - logs - Contains all log files created during execution. + -dropins + Used to add external jars(dependencies) of all runtimes. - - resources - Contains additional resources that may be required. + -extensions + Used to add carbon extensions. - - tenants - This directory will contain relevant tenant artifacts - in the case of a multi-tenant deployment. + -servicepacks + Used to add service packs related to all runtimes. - - tmp - Used for storing temporary files, and is pointed to by the - java.io.tmpdir system property. + -webapp-mode - - webapp-mode - You have the option of running WSO2 Carbon in the webapp mode (hosted as a web-app in an application server). This directory contains files required to run Carbon in the webapp mode. + -wso2/components + Contains profiles for all runtimes and the plugins folder - - LICENSE.txt - Apache License 2.0 under which WSO2 Carbon is distributed. + -wso2/lib + Contains jars that are required/shared by all runtimes. - - README.txt - This document. + -wso2/analytics + Contains analytics runtime related files/folders. - - INSTALL.txt - This document contains information on installing WSO2 IoT Server. + -wso2/analytics/conf + Analytics runtime specific configuration files. + + -wso2/analytics/repository + Where deployments of Analytics runtime is stored. + + -wso2/broker + Contains broker runtime related files/folders. + + -wso2/broker/conf + Broker runtime specific configuration files. + + -wso2/broker/repository + Where deployments of broker runtime is stored. - - release-notes.html - Release information for WSO2 IoT Server 3.0.0 Secure sensitive information in Carbon configuration files ---------------------------------------------------------- @@ -133,7 +160,7 @@ This script automates the following configurations that you would normally need (iii) Updates the secret-conf.properties file with the default keystore and callback class. cipher-tool.properties, cipher-text.properties and secret-conf.properties files - can be found in the /repository/conf/security directory. + can be found in the /conf/security directory. 2. Start the server by running the wso2server script, which is in the /bin directory.