To run WSO2 products, you start the product server at the command line. You can then run the Management Console application to configure and manage the product. This page describes how to run the product in the following sections:
| Table of Contents | ||||
|---|---|---|---|---|
|
...
Before you begin
Before you start the server, note the following:
- The
config-validation.xmlfile in the<PRODUCT_HOME>/repository/conf/etcdirectory contains a list of recommended system parameters, which are validated against your system when the server starts. See Configuring config-validation.xml for details on modifying these parameters before starting the server. - The management console of WSO2 products uses the
org.apache.coyote.http11.Http11NioProtocolJava connector by default. This connector is configured in thecatalina-server.xml
...
- file stored in
...
- the
<PRODUCT_HOME>/repository/conf/tomcat
...
- directory.
...
- This transport connector must be properly configured in this file for the
...
- management console to be accessible. See HTTP Servlet Transport for more information.
Starting the
...
Server
| Anchor | ||||
|---|---|---|---|---|
|
To start the server, you run the script wso2server.bat (on Windows) or wso2server.sh (on Linux/Solaris) from the binfolder. Alternatively, you can install and run the server as a Windows service.
...
- Open a command prompt:
- On Windows, choose Start -> Run, type cmd at the prompt, and press Enter.
- On Linux/Solaris, establish a SSH connection to the server or log in to the text Linux console.
Execute one of the following commands, where <PRODUCT_HOME> is the directory where you installed the product distribution:
- On Windows: <PRODUCT_HOME>/bin/wso2server.bat --run
On Linux/Solaris: sh <PRODUCT_HOME>/bin/wso2server.sh
Info For additional options you can use with these If you want to provide access to the production environment without allowing any user group (including admin) to log into the management console, execute one of the following commands.
- On Windows:
<PRODUCT_HOME>\bin\wso2server.bat --run -DworkerNode - On Linux/Solaris:
sh <PRODUCT_HOME>/bin/wso2server.sh -DworkerNode
If you want to check any additional options available to be used with the startup commands, type
-helpafter the command, such as:sh <PRODUCT_HOME>/bin/wso2server.sh -help.- On Windows:
The operation log appears. When the product server is running, the log displays the message "WSO2 Carbon started in 'n' seconds".
...
When a WSO2 product server starts, it starts all features and related artifacts bundled in the product. If you want to start only a subset of features (e.g., only the backend features), see Running the product on a Preferred Profile.
Running the Management Console
| Anchor | ||||
|---|---|---|---|---|
|
Once the server has started, you can run the Management Console by opening a Web browser and typing in the management console's URL. The URL is displayed as the last line in the start script's console and log. For example:
...
At the sign-in screen, sign in to the Management Console using admin as both the username and password. You can then use the Management Console to manage the product. The tabs and menu items in the navigation pane on the left may vary depending on the features you have installed. For example, following is the Management Console for WSO2 Storage Server:
To view information about a particular page, click the Help link in the top right corner of that page , or click the Docs link to open this documentation for full information on managing the product.
| Info |
|---|
When the Management Console Sign-in page appears, the web browser will typically display an "insecure connection" message, which requires your confirmation before you can continue. The Management Console is based on 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 Management 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 the Management Console 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 Management Console unattended, the session will time out. The default timeout value is 15 minutes, but you can change this in the <PRODUCT_HOME>/repository/conf/tomcat/carbon/WEB-INF/web.xml file as follows:
| Code Block | ||
|---|---|---|
| ||
<session-config> <session-timeout>15</session-timeout> </session-config> |
...
Stop the
...
Server
| Anchor | ||||
|---|---|---|---|---|
|
To stop the server, press Ctrl+C in the command window, or click the Shutdown/Restart link in the navigation pane in the Management Console.