Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To run WSO2 Enterprise Store (ES), you start the product server at the command line. You can then run the ES Publisher (Back Office), to configure and manage the store assets; while you can use the Store as an asset catalog. You can then run the ES Management Console to configure and manage the product. 

...

Starting the server

Tip

If you want your dynamic changes on asset type RXTs to take place as a hot deployment in ES, then first enable asset hot deployment before starting the server. For more information, see Asset Type Hot Deployment.

Follow the instructions below to start WSO2 ES based on the Operating System that you use.

On Windows/Linux/Mac OS

To start the server, you run <ES_HOME>/bin/wso2server.bat (on Windows) or <ES_HOME>/bin/wso2server.sh (on Linux/Solaris/Mac OS) from the command prompt as described below. Alternatively, you can install and run the server as a Windows or Linux service (see the related topics section at the end of this page).

  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/Solaris/Mac OS: Establish an SSH connection to the server, log in to into the text Linux console, or open a terminal window.
  2. Execute one of the following commands:
    • To start the server in a typical environment:
      • On Windows:  <ES_HOME>\bin\wso2server.bat --run
      • On Linux/Solaris/Mac OS:  sh <ES_HOME>/bin/wso2server.sh

    • To start the server in the background mode of Linux: sh <ES_HOME>/bin/wso2server.sh start
      To stop the server running in this mode, you will enter: sh <ES_HOME>/bin/wso2server.sh stop

      Excerpt
      hiddentrue
      • To provide access to the production environment without allowing any user group (including admin) to log into the Management Console:

        • On Windows: <ES_HOME>\bin\wso2server.bat --run -DworkerNode
        • On Linux/Solaris/Mac OS: sh <ES_HOME>/bin/wso2server.sh -DworkerNode

      The above is not available in ES.

    • To check for additional options you can use with the startup commands, type -help after the command, such as: . See the related topics section at the end of this page.

      Code Block
      sh <ES_HOME>/bin/wso2server.sh -help
       (see the related topics section at the end of this page).
  3. 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".

On Solaris

To start the server, you run <ES_HOME>/bin/wso2server.sh  from the Command Prompt as described below. 

Note

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

  1. Anchor
    instructions
    instructions
    Click Launch -> Run Applications, type dtterm at the Prompt, and then press Enter, to open a Command Prompt.
  2. Navigate to the <ES_HOME>/bin directory using the Command Prompt.
  3. Execute the following command:

    Code Block
    bash wso2server.sh
  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".

Info
You need to do the following modification to the <ES_HOME>/bin/wso2server.sh file, to start the product as a service/in nohup mode on Solaris.
  1. Open the <ES_HOME>/bin/wso2server.sh file in a text editor.
  2. Search for the following occurrences: 

    Code Block
    nohup sh "$CARBON_HOME"/bin/wso2server.sh $args > /dev/null 2>&1 &
  3. Replace the latter mentioned occurrences with the following.

    Code Block
    nohup bash "$CARBON_HOME"/bin/wso2server.sh $args > /dev/null 2>&1 &
    Tip

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

  4. Start the product by following the above instructions.

 

Accessing the ES Consoles

...

At the sign-in screen, you can sign in to into the ES Management Console, Publisher Console or Store Console using admin as both the username and password.

Info

When the ES Management Console, Publisher or Store sign-in page appears, the Web browser typically displays an "insecure connection" message, which requires your confirmation before you can continue.

The latter mentioned ES 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 for encryption only , and does not prove the server identity. Therefore, when you try to access these ES Console, 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. 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 ES 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 actually belongs to the given organization.

...

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

    Code Block
    <Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="<IP-address-01>|<IP-address-02>|<IP-address-03>"/>

    The RemoteAddrValve Tomcat valve defined in this file only applies to the Management Console, and thereby all outside requests to the Management Console are blocked. 

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

    Code Block
    <Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="<IP-address-01>|<IP-address-02>|<IP-address-03>"/>

    The RemoteAddrValve Tomcat valve defined in this file applies to each Web application hosted on the WSO2 product server. Therefore, all outside requests to any Web application are blocked.

  • You can also restrict access to particular servlets in a Web application by adding a Remote Address Filter to the <ES_HOME>/repository/conf/tomcat/web.xml file 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 Console page (/carbon/admin/login.jsp) is granted only to one IP address.

    Code Block
    <filter>
        <filter-name>Remote Address Filter</filter-name>
        <filter-class>org.apache.catalina.filters.RemoteAddrFilter</filter-class>
            <init-param>
                <param-name>allow</param-name>
                <param-value>127.0.01</param-value>
            </init-param>
    </filter>
    
    <filter-mapping>
        <filter-name>Remote Address Filter</filter-name>
        <url-pattern>/carbon/admin/login.jsp</url-pattern>
    </filter-mapping>
Info

Any configurations (including valves defined in the <ES_HOME>/repository/conf/tomcat/catalina-server.xml file) apply to all Web applications and are globally available across on the server, regardless of the host or cluster. For more information about using remote host filters, see the Apache Tomcat documentation.

...

To stop the server, press Ctrl+C in the command window, or click the  Shutdown/Restart link in the navigation pane in the ES Management Console. If you started the server in background mode in Linux, enter the following command instead:.

Code Block
sh <ES_HOME>/bin/wso2server.sh stop

Related topics