This documentation is for WSO2 Carbon version 4.0.4. View documentation for the latest release.

Installing on Linux and Solaris

Follow the instructions below to install the binary distribution of WSO2 Carbon on Linux or Solaris, from the command line.

Note

Before you proceed to install Carbon, ensure that the Installation Prerequisites are satisfied .

Establish an SSH connection to the Linux/Solaris machine or log in on the text Linux console.

Step 1. Obtain Installation Pack

Download the latest version of the program (for downloading instructions, refer to Obtaining the Product section).

Step 2. Extract the Archive

After the download is complete, extract installation files to your home directory. For example,

unzip wso2carbon-4.0.1.zip

Step 3. Set up JAVA_HOME

JAVA_HOME environment variable set up is needed to run WSO2 products. The variable points at the directory where the Java™ Development Kit (JDK) is installed on the computer.

Reference

Environment variables are global system variables accessible by all the processes running under the operating system.

Edit BASHRC file in your home directory to add the JAVA_HOME environment variable. To set up JAVA_HOME, perform the following steps.

1. Open the BASHRC file in your favorite Linux text editor - vi, emacs, pico, or mcedit.

2. Add the following two (2) lines at the bottom of the file as shown in the example below.

export JAVA_HOME=/usr/java/jdk1.6.0_25
export PATH=${JAVA_HOME}/bin:${PATH}

3. Save the file.

Tip

If you do not know how to work with text editors in Linux SSH session, run the following command:

cat >> .bashrc

Paste the string from the clipboard and press "Ctrl+D."

4. In order to verify the effective JAVA_HOME variable set up, execute the following command:

echo $JAVA_HOME

The system returns the JDK installation path.

Step 4. Running the Product

1. Establish a SSH connection to the Linux/Solaris server or log in to the text Linux console.

2. Go to <PRODUCT_HOME>/bin, where "<PRODUCT_HOME>" is the actual folder where the product's distribution files are stored.

3. Execute the following command to start the server:

sh ./wso2server.sh

4. The operation log is displayed. For example,

If the server is started and running, a message appears as "WSO2 Carbon started in 'n' seconds."

Setting System Properties

If you need to set additional system properties when the server starts, you can take the following approaches:

  • Set the properties from a script. Setting your system properties in the startup script is ideal, because it ensures that you set the properties every time you start the server. To avoid having to modify the script each time you upgrade, the best approach is to create your own startup script that wraps the WSO2 startup script and adds the properties you want to set, rather than editing the WSO2 startup script directly.
  • Set the properties from an external registry. If you want to access properties from an external registry, you could create Java code that reads the properties at runtime from that registry. Be sure to store sensitive data such as username and password to connect to the registry in a properties file instead of in the Java code and secure the properties file with the secure vault.

Stopping the Server

To stop the running server, simply hit Ctrl-C in the command window or choose the "Shutdown/Restart" link on the left-hand menu of the product's Management Console. For information on accessing the Management Console, refer to section Introducing the Management Console.