WSO2 Enterprise Service Bus (ESB) v1.6 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.
The following distribution packages are available for download.
1. Binary Distribution : Includes binary files for both MS Windows and
Linux operating systems as a zip file. Recommended for normal users.
2. Source Distribution : Includes the source for both MS Windows and Linux
operating systems as a zip file that is used to build the binary files.
Recommended for more advanced users.
Installing and Running WSO2 ESB using the Binary Distribution
1.5.x (For instructions on setting up the JDK on different operating
systems, visit http://java.sun.com)
To build WSO2 ESB from the Source distribution, it is necessary
that you have JDK 1.5.x version and Maven 2.0.6
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.
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 2.0 at a resolution of 1024x768 is recommended. MS
Internet Explorer 7 may be used as well, with some limitations. Once
the WSO2 ESB is started point the browser to
https://localhost:9443/esb you can access your Management Console.
See the Web Administrator Guide
for more details.
Memory
No minimum requirement - A heap size of 256~512MB 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 ~50MB
excluding space allocated for log files and Databases.
Operating System
Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows
Vista). As the WSO2 ESB is a Java application, it will generally be
possible to run it on other operating systems with a JDK 1.5.x
runtime. Linux/Solaris is recommended for a production deployment.
Extract the zip archive where you want the WSO2 ESB installed (e.g. into
/opt)
Set the JAVA_HOME environment variable to your Java home using the
export command or by editing /etc/profile, and add the Java /bin
directory to your PATH
Execute the WSO2 ESB start script or the daemon script from the bin
directory. e.g. ./wso2-esb.sh OR ./wso2-esb-daemon.sh start OR
./wso2-esb-daemon.sh console
Check your WSO2 ESB instance using the URL https://localhost:9443/esb
which will take you to the WSO2 ESB Management Console.
Login as "admin" using the default password "admin"
Installing on MS Windows
The following steps will take you through the installation for the MS
Windows operating system.
To build the WSO2 ESB from its source distribution, you will need
Maven 2.0.6
Operating System
Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows
Vista)
Setting up the Environment and Tools
Maven:
The WSO2 ESB build is based on Apache
Maven. Hence, it is a prerequisite to have Maven (version 2.0.6)
and JDK (version 1.5.x) installed in order to build WSO2 ESB from the
source distribution. Extensive instructions on Maven builds are available
on the Maven site.
Please refer to the Maven
Getting Started Guide for more information on Maven
Unix based OS (e.g., Linux)
Download Apache Maven tar ball or the zip archive.
Expand it to a directory of choice.
Set the environment variable MAVEN_HOME and add MAVEN_HOME/bin to the
path as well.
Refer to more instructions on how to install Maven in Unix based
operating systems.
MS Windows
Download and run the Apache Maven Windows installer package.
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)
Make sure that the system variable JAVA_HOME
is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.5
Run mvn --version to verify that it is correctly installed.
Once Maven is properly installed, you can start building the WSO2 ESB.
Building WSO2 ESB
Download
the source distribution, which is available as a zip archive.
Expand the source archive to a directory of your choice.
All the necessary build scripts are included with the source
distribution.
You can run the following command inside that directory to build the
WSO2 ESB. You will need a connection to the Internet for the Maven build
to download dependencies required for the build
mvn clean install
This will create the complete release artifacts including the binary and
source distributions in the modules/distribution/target/ directory
Note: The first time you run Maven it will automatically download the
dependent .jar files. Therefore, the first run will take more time.
