Running the Product
To run WSO2 products, you start the product server at the command line. You can then run the UES Portal application to configure and manage the product. The following sections in this page explains everything you need to know about running the product:
Starting the Server
Follow the instructions below to start WSO2 UES based on the Operating System you use.
On Windows/Linux/Mac OS
To start the server, you run <UES_HOME>/bin/wso2server.bat
(on Windows) or <UES_HOME>/bin/wso2server.sh
(on Linux/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).
- 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.
- Navigate to the
<UES_HOME>/bin
directory using the Command Prompt. - Execute one of the following commands:
- To start the server in a typical environment:
- On Windows:
wso2server.bat --run
On Linux/Mac OS:
sh wso2server.sh
- On Windows:
To start the server in the background mode of Linux:
sh wso2server.sh start
To stop the server running in this mode, you will enter:sh wso2server.sh stop
To provide access to the production environment without allowing any user group (including admin) to log in to the Management Console:
- On Windows:
wso2server.bat --run -DworkerNode
- On Linux/Mac OS:
sh wso2server.sh -DworkerNode
- On Windows:
- To check for additional options you can use with the startup commands, type
-help
after the command, such as:
sh wso2server.sh -help
(see the related topics section at the end of this page). 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 <UES_HOME>/bin/wso2server.sh
from the Command Prompt as described below.
Following instructions are tested on an Oracle Solaris 10 8/11 x86 environment.
- Click Launch -> Run Applications, type
dtterm
at the Prompt, and then press Enter, to open a Command Prompt. - Navigate to the
<UES_HOME>/bin
directory using the Command Prompt. - Execute the following command:
bash
wso2server.sh 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".
<UES_HOME>/bin/wso2server.sh
file, to start the product as a service/nohup mode in Solaris.- Open the
<UES_HOME>/bin/wso2server.sh
file in a text editor. Search for the following occurrences:
nohup sh "$CARBON_HOME"/bin/wso2server.sh $args > /dev/null 2>&1 &
Replace those occurrences with the following:
nohup bash "$CARBON_HOME"/bin/wso2server.sh $args > /dev/null 2>&1 &
The only change is replacing
sh
withbash
. This is required only for Solaris.Start the product by following the above instructions.
Running the UES Portal
Once the server has started, you can run the UES Consoles by opening a Web browser and typing in the respective URLs. The URLs are displayed as the last line in the start script's console and log. For example:
The UES console URLs are as follows:
- For access via HTTP:
http://localhost:9763/portal/
Store:http://localhost:9763/store/
- For access via secured HTTP:
Portal:https://localhost:9443/portal/
Store:https://localhost:9443/store/
Management Console:https://localhost:9443/admin/carbon/
You can use the above URLs to access the UES consoles on this computer from any other computer connected to the Internet or LAN. The following is the landing page of the UES Portal.
On the sign in page click the Docs link to open this documentation for full information on using the product.
When the UES Portal Sign-in page appears, the web browser will typically display an "insecure connection" message, which requires your confirmation before you can continue.
The UES Portal is 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, so when you try to access the UES Portal, 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 the UES Portal 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 UES Portal unattended, the session will time out. The default timeout value is 15 minutes, but you can change this in the <UES_HOME>/repository/conf/tomcat/carbon/WEB-INF/web.xml
file as follows:
<session-config> <session-timeout>15</session-timeout> </session-config>
Stopping the Server
To stop the server, press Ctrl+C in the command window.