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.
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.
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
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 |
The following steps will take you through the installation for the MS Windows operating system.
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 |
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.
Once Maven is properly installed, you can start building 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.