This documentation is for WSO2 Enterprise Service Bus version 4.8.1 . View documentation for the latest release.

All docs This doc
Skip to end of metadata
Go to start of metadata

Follow these instructions to install WSO2 ESB on Linux.

Before you begin:

  • To find out if this version of the product has issues running on your OS due to the JDK version, see the known incompatibilities section.
  • To find out if this version of the product is fully tested on your operating system, see the compatibility matrix.

Install the required applications

  1. Establish an SSH connection to the Linux machine or log in on the text Linux console.
  2. Be sure your system meets the installation prerequisites.

Installing the ESB

  1. If you have not done so already, download the latest version of the ESB as described in Downloading the Product.
  2. Extract the archive file to a dedicated directory for the ESB, which will hereafter be referred to as <PRODUCT_HOME>.


You must set your JAVA_HOME environment variable to point to the directory where the Java Development Kit (JDK) is installed on the computer.

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

1. In your home directory, open the BASHRC file in your favorite Linux text editor, such as vi, emacs, pico, or mcedit.

2. Add the following two lines at the bottom of the file, replacing /usr/java/jdk1.6.0_25 with the actual directory where the JDK is installed.

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

The file should now look like this:

3. Save the file.

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

cat >> .bashrc

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

4. To verify that the JAVA_HOME variable is set correctly, execute the following command:


The system returns the JDK installation path.

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.

Note: When using SUSE Linux, it ignores /etc/resolv.conf and only looks at the /etc/hosts file. This means that the server will throw an exception on startup if you have not specified anything besides localhost. To avoid this error, add the following line above localhost in the /etc/hosts file: <ip_address>  <machine_name> localhost

You are now ready to run the product.

  • No labels