||
Skip to end of metadata
Go to start of metadata

To run WSO2 products, you start the product server at the command line. The following sections in this page explain everything you need to know about running the product:

Starting the Server

Before you begin

If you wish to try out the sample plugins, which are namely Android, Windows, Android Sense, Raspberry Pi, iOS, and Arduino, in the WSO2 IoTS console, navigate to the WSO2 IoTS directory and run the plugins-deployer.xml file.
Example: 

Follow the instructions below to start your WSO2 product based on the Operating System you use:
 

Follow the steps given below:

  1. Open a command prompt by following the instructions below:
    • On Windows: Click Start > Run, type cmd at the prompt, and then press Enter.
    • On Linux/Mac OS: Establish an SSH connection to the server, log on to the text Linux console, or open a terminal window.
  2. Navigate to the <IoTS_HOME>/bin directory using the Command Prompt to start the WSO2 IoTS core, broker and analytics profiles all at ones.

  3. Start the profiles in the following order:
    1. Start the broker profile, which corresponds to the WSO2 Message Broker profile.

      The default port assigned for the broker is 9446.

    2. Start the core profile, which corresponds to the WSO2 Connected Device Management Framework (WSO2 CDMF) profile.

      The default port assigned for the core is 9443. 

    3. Start the analytics profile, which corresponds to the WSO2 Data Analytics Server profile.

      The default port assigned for analytics is 9445.

    The operation log appears in the command window. When the product server has successfully started, the log displays the message WSO2 Carbon started in 'n' seconds

Follow the steps given below:

Following instructions are tested on an Oracle Solaris 10 8/11 x86 environment.

  1. Click Launch > Run Applications, type dtterm at the Prompt, and then press Enter, to open a Command Prompt.
  2. Navigate to the <IoTS_HOME>/bin directory using the Command Prompt.
  3. Start the profiles in the following order:
    1. Start the broker profile, which corresponds to the WSO2 Message Broker profile.

      The default port assigned for the broker is 9446.

    2. Start the core profile, which corresponds to the WSO2 Carbon Device Management Framework (CDMF) profile.

      The default port assigned for the core is 9443. 

    3. Start the analytics profile, which corresponds to the WSO2 Data Analytics Server profile.

      The default port assigned for analytics is 9445.

  4. The operation log appears in the command window. When the product server has successfully started, the log displays the message WSO2 Carbon started in 'n' seconds.

You need to do the following modification to the <IoTS_HOME>/bin/wso2server.sh file, to start the product as a service/nohup mode in Solaris.
  1. Open the respective wso2server.sh file.
    For example, for the core profile open the <IoTS_HOME>/core/bin/wso2server.sh file in a text editor.
  2. Search for the following occurrences: nohup sh "$CARBON_HOME"/bin/wso2server.sh $args > /dev/null 2>&1 &
  3. Replace those occurrences with the following:  nohup bash "$CARBON_HOME"/bin/wso2server.sh $args > /dev/null 2>&1 &

    The only change is replacing sh with bash. This is required only for Solaris.

  4. Start the product by following the above instructions.


Running IoT Server

Once you start the server, you can access the WSO2 IoTS consoles by opening a Web browser and typing in the respective URLs. 

The WSO2 IoTS Console URLs are as follows:

  • Access via HTTP: 
    WSO2 IoTS Device Management Console: http://<IoTS_HTTP_HOST>:9763/devicemgt
    WSO2 IoTS Management Console: http://<IoTS_HTTP_HOST>:9763/carbon
    WSO2 IoTS Device Monitoring Dashboard: https://<IoTS_HTTP_HOST>:9763/portal
     
  • Access via secure HTTPS
    WSO2 IoTS Device Management Console: https://<IoTS_HTTPS_HOST>:9443/devicemgt
    WSO2 IoTS Management Console: https://<IoTS_HTTPS_HOST>:9443/carbon
    WSO2 IoTS Device Monitoring Dashboard: https://<IoTS_HTTPS_HOST>:9443/portal

When accessing the Management Console from the same server where it's installed, you can type localhost  instead of the IP address:  https://localhost:9443/carbon

 The Management Console URL can be changed by uncommenting and modifying the value of the MgtHostName in the <PRODUCT_HOME>/repository/conf/carbon.xml file.

Example:

For more information, see Accessing the Device Management ConsoleAccessing the WSO2 IoTS Management Console, and Accessing the WSO2 Device Monitoring Dashboard.

You can use the above URLs to access the WSO2 IoTS consoles on this computer from any other computer connected to the Internet or LAN.

When these pages appear, the web browser will typically display an "insecure connection" message, which requires your confirmation before you can continue.

The IoT Server consoles are based on the HTTPS protocol, which is a combination of HTTP and SSL protocols. This protocol is generally used to encrypt the traffic from the client to server for security reasons. The certificate it works with is used only for encryption and does not prove the server identity, so when you try to access these consoles, a warning of untrusted connection is usually displayed. To continue working with this certificate, some steps should be taken to "accept" the certificate before access to the site is permitted. If you are using the Mozilla Firefox browser, this usually occurs only on the first access to the server, after which the certificate is stored in the browser database and marked as trusted. However, with other browsers, the insecure connection warning might be displayed every time you access the server.

This scenario is suitable for testing purposes, or for running the program on the company's internal networks. If you want to make these consoles available to external users, your organization should obtain a certificate signed by a well-known certificate authority, which verifies that the server actually has the name it is accessed by and that this server belongs to the given organization.

If you leave the IoT Server consoles unattended, the session will time out. The default timeout value is 15 minutes, but you can change this in the <IOT_SERVER_HOME>/repository/conf/tomcat/carbon/WEB-INF/web.xml file as follows:

Restricting Access to the Management Console and Web Applications:

You can restrict access to the management console of your product by binding the management console with selected IP addresses. Note that you can either restrict access to the management console only, or you can restrict access to all web applications in your server as explained below.

  • To control access only to the management console, add the IP addresses to the <PRODUCT_HOME>/repository/conf/tomcat/carbon/META-INF/context.xml file as follows:

    The RemoteAddrValve Tomcat valve defined in this file will only apply to the Carbon management console, and thereby all outside requests to the management console will be blocked. 

  • To control access to all web applications deployed on your server, add the IP addresses to the <PRODUCT_HOME>/repository/conf/context.xml file as follows:

    The RemoteAddrValve Tomcat valve defined in this file will apply to each web application hosted on the Carbon server. Therefore, all outside requests to any web application will be blocked.

  • You can also restrict access to particular servlets in a web application by adding a Remote Address Filter to the web.xml file (stored in the <PRODUCT_HOME>/repository/conf/tomcat/ directory), and by mapping that filter to the servlet URL. In the Remote Address Filter that you add, you can specify the IP addresses that should be allowed to access the servlet.


    The following example from a web.xml file illustrates how access to the management page (/carbon/admin/login.jsp) is granted only to one IP address:

Note: Any configurations (including valves) defined in the <PRODUCT_HOME>/repository/conf/tomcat/catalina-server.xml file applies to all web applications and is globally available across server, regardless of host or cluster. See the official Tomcat documentation for more information about using remote host filters .

Stopping the Server

To stop the server, press Ctrl+C in the command window.

  • No labels