WSO2 Enterprise Service Bus (ESB), v1.0 Installation Guide

This document describes the distribution packages available in WSO2 ESB - the binary distribution and the source distribution for more advanced users. It is followed by simple instructions on how to install and run WSO2 ESB using the binary distribution and how to build WSO2 ESB using the source distribution.

Table of Contents

Distribution Packages

The following distribution packages are available for download.

1. Binary Distribution : Includes binary files for both MS Windows (.zip) and Linux (tar.gz) operating systems. Recommended for normal users.

2. Source Distribution : Includes the source for both MS Windows (.zip) and Linux (tar.gz) operating systems that is used to build the binary files. Recommended for more advanced users.

Installing and Running WSO2 ESB using the Binary Distribution

Pre-requisites

Java SE Development Kit 1.4 or 1.5 (For instructions on setting up the JDK in different operating systems, visit http://java.sun.com)

For MS Windows users, it is recommended to use JDK 1.5 as it is not possible to use the HTTPS transport with a JDK version below 1.5. If a JDK version below 1.5 is being used, the existing <transportReceiver> and <transportSender> elements of the conf/axis2.xml must be replaced as follows. This will allow the admin console to run over HTTPS transport, although services are accessible only over HTTP.

To build WSO2 ESB from the Source distribution, it is necessary that you have JDK 1.5 version.

Apache ActiveMQ -JMS Provider

ActiveMQ 4.1.0 or later can be used with the JMS transport, and the ESB ships with all the necessary client libraries to run with an ActiveMQ installation.

If you are using any other JMS provider, you will need to install any necessary libraries and/or any components.

Apache Ant - To run ESB samples

To compile and run the sample clients, an Ant version is required. Ant 1.6.5 version is recommended.

Apache Maven- To build ESB from Source To build the WSO2 ESB from its source distribution, you will need Maven 2.0.6
Web browser- To start the ESB Management Console Mozilla Firefox, MS Internet Explorer 6 or 7. Once your run WSO2 ESB and point the browser to https://localhost:9443 you can access your Management Console. See Web Administrator Guide for more details.
Memory No minimum requirement
Disk No minimum requirement. The installation will require 50MB excluding space allocated for log files.
Operating System MS Windows - XP/ Vista (Not fully tested on Windows Vista) or Linux

Installing on MS Windows

The following steps will take you through the installation for the MS Windows operating system.

  1. Download the WSO2 ESB binary distribution.
  2. Extract the zip archive.
  3. Set the JAVA_HOME environment variable to your Java installation.
  4. Execute the WSO2 ESB starting script. e.g., WSO2ESB_HOME\bin\wso2-esb.bat
  5. Check your WSO2 ESB instance using the URL https://localhost:9443 which will take you to the WSO2 ESB Management Console.

Installing on Linux

  1. Download the WSO2 ESB binary distribution.
  2. Extract the tar.gz archive. Example, unzip wso2-esb-java-1.0-bin.tar.gz -d /opt
  3. Set the JAVA_HOME environment variable to your Java installation using the export command or by editing /etc/profile. For example, export JAVA_HOME="/opt/j2sdk"
  4. Execute the WSO2 ESB starting script. Example, cd /opt/wso2-esb-java-1.0/bin; sh wso2-esb.sh
  5. Check your WSO2 ESB instance using the URL https://localhost:9443 which will take you to the WSO2 ESB Management Console.

Building WSO2 ESB Using the Source Distribution

Pre-requisites

Java SE Development Kit 1.5 (For instructions on setting up the JDK in different operating systems, visit http://java.sun.com)
Apache Maven- To build ESB from Source To build the WSO2 ESB from its source distribution, you will need Maven 2.0.6
Operating System MS Windows - XP/ Vista (Not fully tested on Windows Vista) or Linux

Setting up the Environment and Tools

Maven:

The WSO2 ESB build is based on Apache Maven. Hence, it is a pre-requisite to have Maven (version 2.0.6) and JDK (version 1.5) installed in order to build WSO2 ESB from the source distribution. Extensive instructions on Maven builds are available on the Maven site.

This guide however contains the easiest path for quick environment setting. Advanced users can learn more about Maven.

  1. Download and run the Apache Maven Windows installer package.
  2. Set the 'Environment Variables' (create the system variable MAVEN_HOME and edit the path. e.g., "C:\Program Files\Apache Software Foundation\maven-2.0.6"; path %MAVEN_HOME%\bin)
  3. Make sure that the system variable JAVA_HOME is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.5
  4. Run maven--version to verify that it is correctly installed.
  1. Download Apache Maven tar ball or the zip archive.
  2. Expand it to a directory of choice.
  3. Set the environment variable MAVEN_HOME and add MAVEN_HOME/bin to the path as well.
  4. Refer to more instructions on how to install Maven in Unix based operating systems.

Once Maven is properly installed, you can start building the WSO2 ESB.

Building WSO2 ESB

  1. Download the source distribution, which is available as a zip archive for MS Windows and tar.gz archive for Linux.
  2. Expand the source archive to a directory of your choice.
  3. All the necessary build scripts are included with the source distribution.
  4. You can run the following command inside that directory to build the WSO2 ESB.

    mvn clean install

This will create the complete release artifacts including the binary and source distributions.

Note: The first time you run Maven it will automatically download the dependent .jar files. Therefore, the first run will take more time.