WSO2 Mashup Server, v 1.0.2 Installation Guide

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

Table of Contents

Distribution Packages

The following distribution packages are available for download
  1. Binary Distribution : Includes a binary file (.zip) for both MS Windows and Linux operating systems. Recommended for normal users.
  2. Source Distribution : Includes the source that is used to build the binary files. Recommended for more advanced users.

Installing and Running the WSO2 Mashup Server using the Binary Distribution

Pre-requisites

Java SE Development Kit JDK 1.5 or later (For instructions on setting up the JDK in different operating systems, visit http://java.sun.com)
Web browser- To start the Mashup Server Web Console Mozilla Firefox, MS Internet Explorer 6 or 7. Once your run the WSO2 Mashup Server and point the browser to https://localhost:7443 you can access your Web Console. See Web Console guide for more details.
Disk No minimum requirement. The installation will require approximately 90MB excluding the space allocated for log files.
Operating System Tested on MS Windows - XP/ Vista & Linux.

Installing on MS Windows

  1. Download the WSO2 Mashup Server binary distribution.
  2. Extract the zip archive.
  3. Set the JAVA_HOME environment variable to your Java installation.
  4. Execute the WSO2 Mashup Server starting script. e.g., WSO2Mashup Server_HOME\bin\startup.bat
  5. Check your WSO2 Mashup Server instance using the URL https://localhost:7443, which will take you to the WSO2 Mashup Server Web Console. (Refer to the Web Console guide for more details).

Installing Using the Windows Installer
  1. Download the WSO2 Mashup Server Windows setup.
  2. Run the .exe file and follow the wizard entering data where necessary.
  3. After the installation, the WSO2 Mashup Server will be installed as a windows service. You will also have a monitoring icon in the Windows System Tray. You can use this to easily start, stop and monitor the status of your server. The WSO2 Mashup Server service and the System Tray Monitor will be started automatically at system startup. You can manually start the monitor using shortcuts installed in the Windows Programmes menu.
  4. Check your WSO2 Mashup Server instance using the URL https://localhost:7443, which will take you to the WSO2 Mashup Server Web Console. (Refer to the Web Console guide for more details).


Installing on Linux

  1. Download the WSO2 Mashup Server binary distribution.
  2. Extract the tar.gz archive. Example, unzip wso2-mashup-server-1.0.2.zip -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 Mashup Server starting script. Example, cd /opt/wso2-mashup-server/bin; sh startup.sh
  5. Check your WSO2 Mashup Server instance using the URL https://localhost:7443/ which will take you to the WSO2 Mashup Server Web Console. (Refer to the Web Console guide for more details.)

Please refer to the User Management Guide for details on how to setup the administrative account for the Mashup Server.

Building WSO2 Mashup Server Using the Source Distribution

Pre-requisites

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

To build the WSO2 Mashup Server from the Source distribution, it is necessary that you have the JDK 1.5 or a later version.
Apache Maven- To build the Mashup Server from the Source To build the WSO2 Mashup Server from its source distribution, you will need Maven 2.0.7 or a later version.
Operating System MS Windows - XP/ Vista or Linux

Setting up the Environment and Tools

Maven:

The WSO2 Mashup Server build is based on Apache Maven. Hence, it is a pre-requisite to have Maven (version 2.0.7 or later) and JDK (version 1.5 or later) installed to build the WSO2 Mashup Server 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 MAVEN2_HOME and edit the path. e.g., "C:\Program Files\Apache Software Foundation\maven-2.0.7"; path %MAVEN2_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 your choice.
  3. Set the environment variable MAVEN2_HOME and add MAVEN2_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 Mashup Server.

Building WSO2 Mashup Server

  1. Download the source distribution, which is available as a zip archive.
  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 Mashup Server.
mvn clean install

This will create the complete release artifacts including the binary and source distributions. The build artifacts will be places in modules/distribution/target.

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

Building the Windows Installer

To buid the windows installer, you should first download the Nullsoft Scriptable Install System (NSIS) from http://nsis.sourceforge.net and install it in your build machine.

The mvn clean install -Dbuild-setup command will build a windows installer in modules/distribution/target. Please refer to the mashupserver-setup.nsi.readme.txt file available on your source distribution for further details on using the NSIS script.

© 2007-2008 WSO2 Inc.