Running the Product

To run WSO2 products, you start the product server at the command line.

This page describes how to run the product in the following sections: 

Starting the server

To start the server, you run the script wso2server.bat (on Windows) or wso2server.sh (on Linux/Solaris) from the bin folder. Alternatively, you can install and run the server as a Windows service .

1. 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.
2. Execute one of the following commands, where <GREG_HOME> is the directory where you installed the product distribution: <GREG
• On Windows: <GREG_HOME>/bin/wso2server.bat --run

• On Linux/Solaris:  sh <GREG_HOME>/bin/wso2server.sh


  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

  For additional options you can use with these startup commands, type -help after the command, such as: sh <PRODUCT_HOME>/bin/wso2server.sh -help 

The operation log appears. When the product server is running, the log displays the message "WSO2 Carbon started in 'n' seconds."

Supported System Properties

There are several system properties that can be set to the JAVA virtual machine, when starting the Governance Registry server.

• carbon.registry.character.encoding - This property indicates the character encoding used by the server. For example, set this property to Windows-1251 to use Cyrillic characters or Windows-1255 for Hebrew characters.  This property accepts the name of the character set encoding.
• carbon.registry.clean - This property can be set to clean-up the /_system/config/repository and /_system/local/repository collections. This property accepts no value.
• carbon.registry.ignore.conflicts - This property can be set to prevent .mine and .server files being recorded to the server during a sychronization operation. This property accepts values true and false.
• carbon.registry.statistics.operations - This property is used only when statistics logging has been enabled. Set this system property to restrict the types of operations for which statistics are logged. This property accepts a list of comma separated operation names.
• carbon.registry.statistics.output.queries.executed - This property is used only when statistics logging has been enabled. Set this system property to log actual SQL queries that were executed. This property accepts values true and false.
• carbon.registry.statistics.preserve.duplicate.table.accesses - This property is used only when statistics logging has been enabled. Set this system property if you want to preserve duplicate table-access records. This property accepts values true and false.
• carbon.repo.write.mode - This property can be set to indicate whether the server is in READ or READ-WRITE mode. Set this to true for READ-WRITE mode. This is a useful property when making API calls. This property accepts values true and false.
• disable.event.handlers - This property can be set if you want to disable the default event handlers. Please note that this will stop event generation in the registry. This property accepts values true and false.
• onetime.email.verification - This property can be set to enable one time e-mail verification. This property accepts values true and false.
• setup - This property can be set to generate the registry database schema if it does not exist. Please note that this property has no effect if the schema already exists. This property accepts no value.
• uddi - This property can be used to enable the inbuilt UDDI registry. This property accepts the value enable.

To pass a system property simply append it next to the start-up script as shown in the example below:

./wso2server.sh -Dsetup (Linux)
wso2server.bat -Dcarbon.registry.ignore.conflicts=true (Windows)

Populating sample artifacts

WSO2 G-Reg 5.1.0 distribution pack is shipped with a collection of sample artifacts of all the supported artifact types, which you can populate and try out. Follow the steps below to populate the sample artifacts.

1. Run the WSO2 G-Reg server. For instructions, see Starting the server.

2. Navigate to <G-REG_HOME>/samples/data-populator/Populator/ directory using the command prompt.
3. Execute the following command: ant run

4. View the populated sample artifacts in the G-Reg Store. For instructions on accessing the G-Reg Store, see Running the G-Reg Store.

Accessing artifacts in the G-Reg Store

Once the server has started, you can run the G-Reg Store by opening a Web browser and typing in the its URL. The URL is displayed as the last line in the start script's console and log. For example:

The URL should be in the following format: http://<G-REG_HOST>:9763/store

You can use this URL to access the G-Reg Store on this computer from any other computer connected to the Internet or LAN. When accessing the G-Reg Store from the same server where it's installed, you can type "localhost" instead of the IP address:  https://localhost:9763/store

At the sign-in screen, sign in to the G-Reg Store using  admin  as both the username and password. You view the G-Reg Store as shown below which you can use to access the published governance artifacts.  

Click on any sample artifact to access and use it.

Accessing the G-Reg Publisher to manage artifacts

You can use the G-Reg Publisher to manage the published artifacts. Once the server has started, you can run the G-Reg Publisher by opening a Web browser and typing in the its URL. The URL is displayed as the last line in the start script's console and log. For example:

The URL should be in the following format: https://<G-REG_HOST>:9443/publihser

You can use this URL to access the G-Reg Publisher on this computer from any other computer connected to the Internet or LAN. When accessing the G-Reg Publisher from the same server where it's installed, you can type "localhost" instead of the IP address:  https://localhost:9443/publisher

At the sign-in screen, sign in to the G-Reg Publisher using admin as both the username and password. You view the G-Reg Publisher as shown below.  

The artifact types that are enabled in the G-Reg Publisher by default are shown below.

Click on any artifact type to access artifacts of that type and manage them.

Managing the product using the Management Console

The Management console is a Web-based user interface powered by JSP and AJAX. It allows you to interact with a running product instance, without having to directly interfere with any underlying configuration files.

The Management Console makes use of the default HTTPS servlet transport, which is configured in the <PRODUCT_HOME>/repository/conf/tomcat/catalina-server.xml file. It is essential for you to properly configure this transport in this file for to access the Management Console .

Accessing the Management Console

Run the product by executing the shell script (for Linux/Solaris) or the batch file (for Windows) as explained in the  Starting the server section. With any WSO2 product properly installed, you can access its Management Console (Web interface) by opening a Web browser and typing in the Management Console's URL as it appears in the start script's log. For example,

Accessing from Internet/LAN

To connect to the product's Web Interface from any computer connected to Internet/LAN, follow the instructions below.

1. Open a Web browser and access the real IP of the server. Typically, it is the IP address of the computer.  The URL should be in the following format: 
   

   https://<SERVER_HOST>:9443/carbon

2. The product's homepage opens.

Accessing from Local Machine

1. You can also connect to the product's Web Interface from the computer where it is installed by typing "localhost" instead of the IP.

   https://localhost:9443/carbon

2. Once you have established a connection, the Management Console opens in the anonymous mode.

   When the product's homepage opens, it is possible that the Internet browser will display an "insecure connection" message, requiring your confirmation of being aware of the risks.

   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 the users try to access the Management Console, a warning of untrusted connection is usually displayed. In order to continue working with this certificate, some steps should be taken to "accept" the certificate before access to the site is permitted. In case Mozilla Firefox browser is used, this usually occurs only on the first access to the server. Then the certificate is stored in the browser database marked as trusted. In case of some other browsers are used, insecure connection warning may be displayed every time server is accessed.

   This scenario is suitable for testing purposes, or for running the program on the company's internal networks. But in case there is a need to provide an interface to the outside world, a company should obtain a certificate signed by a well-known CA. The role of a CA is to verify that the server accessed actually has the name it is accessed by, and that this server actually belongs to the given organization.

The homepage of the Management Console typically has the following sections:

Menu Items

Anonymous users can access some menu items including the "Home" menu displayed on the left-hand-side panel.

Links to Resources

The panel at the center provides links to several resources as follows:

• The product's online documentation.
• The product's forum.
• Link to the product's issue tracking system.
• The mailing lists at http://wso2.org/mail .

Sign-in Section

To access more controls, you need to log-in to the Management Console using the log-in panel at the right-hand-side. Type in admin as the default Username and admin as the default Password. Click on "Sign-in".

For example,

You will be logged in to the product's Management Console.

The controls in the Management Console are usually self-explanatory. However, the context-sensitive help tips, accessible by clicking the 'Help' link at the top right corner of any page, are a fast and easy way to get more information, if required. The product documentation provides further information about the technology and configurations.

The console's menu items appear in the left hand side. Usually they are divided as Main, Monitor, Configure and Extensions although additional menus may appear depending on the availability of features. Each of these menus carries a list of sub menus. A product's menus and sub menus may vary depending on the product version and any additional feature you have installed to provision the server.

Stopping the server

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.