This installation guide provides information on,
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 and Linux operating systems, compressed into a single a zip file. Recommended for normal users.
2. Source Distribution : Includes the source code for both MS Windows and Linux operating systems, compressed into a single zip file which can be used to build the binary files. Recommended for more advanced users.
Java SE Development Kit |
1.6.0_23 or higher (For instructions on setting up the JDK on different operating
systems, visit http://www.oracle.com/technetwork/java/index.html)
To build WSO2 ESB from the Source distribution, it is necessary that you have JDK 1.6.x version and Maven 2.2.0 or later |
Apache ActiveMQ -JMS Provider |
Apache ActiveMQ 5.0.0 or higher is required to enable the WSO2 ESB JMS transport and try out JMS samples. The ActiveMQ client libraries must be installed in the ESB classpath before you can enable the JMS transport. Alternatively you may use the built-in Qpid broker that comes with WSO2 ESB. If you are using any other JMS provider (eg: IBM Websphere), you will need to install necessary libraries. |
Apache Ant - To run ESB samples |
To compile and run the sample clients, an Ant installation is required. Ant 1.7.0 version or higher is recommended. |
Apache Maven- To build ESB from Source | To build the WSO2 ESB from its source distribution, you will need Maven 2.2.0 or later |
Web browser - To start the ESB Management Console | Mozilla Firefox 3.0 or higher at a resolution of 1024x768 is recommended. MS Internet Explorer 7 or Google Chrome may be used as well. Once the WSO2 ESB is started with the default settings, point the browser to https://localhost:9443/carbon in order to access your Management Console. See the WSO2 ESB User Guide for more details. |
Memory | No minimum requirement - A heap size of 1GB is generally sufficient to process typical SOAP messages. Requirements may vary with larger message size and on the number of messages processed concurrently |
Disk | No minimum requirement. The installation will require ~125 MB excluding space allocated for log files and Databases. |
Operating System | Linux, Solaris, MS Windows - XP/2003/2008 (Not fully tested on Windows Vista or Windows 7). Since WSO2 ESB is a Java application, it will generally be possible to run it on other operating systems with a JDK 1.6.x runtime. Linux/Solaris is recommended for a production deployment. |
The following steps will take you through the binary distribution installation on Unix/Linux systems.
The following steps will take you through the installation for the MS Windows operating system.
Java SE Development Kit | 1.6.x (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.2.0 or later |
Operating System | Linux, Solaris, MS Windows - XP/2003/2008 (Not fully tested on Windows Vista) |
Maven:
The WSO2 ESB build is based on Apache Maven 2. Hence, it is a prerequisite to have Maven (version 2.2.0 or later) and JDK (version 1.6.x) installed in order to build WSO2 ESB from the source distribution. Extensive instructions on using Maven 2 are available on the Maven website.
Please refer to the Maven Getting Started Guide for more information on Maven
Once Maven is properly installed, you can start building the WSO2 ESB.
Command: mvn clean install
This will create the complete release artifacts including the binary and source distributions in the modules/distribution/target/ directory which can be installed using the above instructions.
Note: The first time you run Maven it will automatically download the dependency jar files. Therefore, the first run will take more time. It is also recommended to allocate for memory for Maven since the ESB build process takes up a significant amount of resources. More memory can be allocated for Maven by setting the MAVEN_OPTS environment variable.