Getting Started Guide

Introduction

This document describes how to install and configure ServiceMix 1.x for both Unix and Windows' platforms.

Pre-Installation Requirements

Hardware:

• 36 MB of disk space for the ServiceMix 1.x binary distribution.
• 13 MB of disk space for the ServiceMix 1.x source or developer's distributions.

Operating Systems:

• Windows: Windows XP SP2, Windows 2000.
• Unix: Ubuntu Linux, Powerdog Linux, MacOS, AIX, HP-UX, Solaris, any Unix platform that supports Java.

Environment:

• Java Developer Kit (JDK) of 1.4.x or greater.
• The JAVA_HOME environment variable must be set to the directory where the JDK is installed, e.g. c:\Program Files\jsdk.1.4.2-09.
• Maven 1.0.2 or greater (only needed for installing source or developer's releases).

Installation Procedure For Windows

Binary Installation

This procedure explains how to download and install the binary distribution on a Windows system.

1. In a browser, go to www.servicemix.org.
2. Click on the Download link in the navigation pane (the left pane).
3. Click on the "ServiceMix 1.x Release" link under the "Latest Releases" section.
4. Under the "Download Here" section, select the desired distribution (you may have to scroll down to see the "Download Here" section).
   For a binary distribution the filename will be similar to: servicemix-x.x.x.zip.
5. Extract the files from the zip file into a directory of your choice.
6. Proceed to the #Starting ServiceMix section of this document.
7. Following start-up, go to #Testing the Installation.

Source Installation

This procedure explains how to download and install the source distribution on a Windows system.

1. In a browser, go to www.servicemix.org.
2. Click on the Download link in the navigation pane (the left pane).
3. Click on the "ServiceMix 1.x Release" link under the "Latest Releases" section.
4. Under the "Download Here" section, select the desired distribution (you may have to scroll down to see the "Download Here" section).
   For a source distribution the filename will be similar to: servicemix-x.x.x-src.zip.
5. Extract ServiceMix from the zip file into a directory of your choice.
6. Build ServiceMix using Maven 1.0.2 or greater.

   The preferred method of building ServiceMix is the following:
   cd \[servicemix_install_dir] 
     where [servicemix_install_dir] is the directory in which ServiceMix was installed.
   maven clean test
   
   If the above build fails on some tests, do this:
   cd \[servicemix_install_dir]
   maven m:clean
   maven -Dmaven.test.skip=true
   
   

7. Start ServiceMix from the target directory:

   cd \[servicemix_install_dir]\target\servicemix-1.0\bin\servicemix-1.0\bin
   servicemix
   

8. Proceed to #Testing the Installation section.

Developer's Releases

This procedure explains how to download and install the latest developer's snapshot.

1. In a browser, go to www.servicemix.org.
2. Click on the Download link in the navigation pane (the left pane).
3. Click on the "Development SNAPSHOT releases can also be found here" link.
4. Select the version of ServiceMix to download (you may have to scroll down to see the ServiceMix snapshots).
5. Extract the files from the zip file into a directory of your choice.
6. If a binary snapshot was downloaded proceed to the #Starting ServiceMix section of this document.
   If a source snapshot was downloaded proceed to step 6 of the #Source Installation procedure.
7. Following the build, proceed to #Testing the Installation section.

Installation Procedure For Unix

Binary Installation

This procedure explains how to download and install the binary distribution on a Unix system.

1. Download the ServiceMix gzip file, either using a browser or using a tool, i.e., wget, scp, ftp, etc.

   a. If a browser is available, go to www.servicemix.org.
   b. Click on the Download link in the navigation pane (the left pane).
   c. Click on the "ServiceMix 1.x Release" link under the "Latest Releases" section.
   d. Under the "Download Here" section, select the desired distribution (you may have to scroll down to see the "Download Here" section). 
   For a binary Unix distribution the filename will be similar to: servicemix-x.x.x.tar.gz.
   
   OR
   
   a. If there is no browser on the Unix machine, obtain the link to the gzip file. On a machine with a browser go to www.servicemix.org.
   b. Click on the Download link in the left navigation pane.
   c. Click on the "ServiceMix 1.x Release" link under the "Latest Releases" section.
   d. Under the "Download Here" section, roll-over the desired distribution (you may have to scroll down to see the "Download Here" section). 
   For a binary Unix distribution the filename will be similar to: servicemix-x.x.x.tar.gz.
   e. Right-click on the distribution name and "Copy Shortcut."
   f. Back on the Unix machine, change into the directory in which ServiceMix is to be installed, e.g., /usr/local.
   f. Using the "wget" tool as an example: type "wget" followed by the saved shortcut. For example:
   
   wget http://dist.codehaus.org/servicemix/distributions/servicemix-1.0.1.tar.gz
   
   

2. Extract the files from the gzip file into a directory of your choice.
   unzip servicemix-x.x.x.zip.gz
3. Procedd to the #Starting ServiceMix section of this document.
4. Following start-up, go to #Testing the Installation section.

This procedure explains how to download and install the binary distribution on a Unix system without a browser.

Source Installation

This procedure explains how to download and install the source distribution on a Unix system.

1. In a browser, go to www.servicemix.org.
2. Click on the Download link in the navigation pane (the left pane).
3. Click on the "ServiceMix 1.x Release" link under the "Latest Releases" section.
4. Under the "Download Here" section, select the desired distribution (you may have to scroll down to see the "Download Here" section). For a binary distribution the filename will be similar to:
   servicemix-x.x.x.zip.

1. In a browser, go to www.servicemix.org
2. Click on the Download link in the left pane.
3. From this page, click on link in the "Latest Releases" section.
4. Scroll down to select the version to download. For a binary distribution the filename will be similar to:
   servicemix-x.x.x-src.zip.
5. Extract the files from the zip file into a directory of your choice.
6. cd blah and maven something, ????

Developer's Snapshot

1. In a browser, go to www.servicemix.org.
2. Click on the Download link in the navigation pane (the left pane).
3. Click on the "ServiceMix 1.x Release" link under the "Latest Releases" section.
4. Under the "Download Here" section, select the desired distribution (you may have to scroll down to see the "Download Here" section). For a binary distribution the filename will be similar to:
   servicemix-x.x.x.zip.

Starting ServiceMix

On Windows:

From a console window, change to the installation directory and run the servicemix program:

       
cd \[servicemix_install_dir]\bin

where servicemix_install_dir is the directory in which ServiceMix was installed, e.g., c:\Program Files\servicemix-1.x.
Then type:

servicemix

On Unix:

From a command shell, change to the installation directory and run the servicemix program:

       
cd /[servicemix_install_dir]/bin

where servicemix_install_dir is the directory in which ServiceMix was installed, e.g., /usr/local/servicemix-1.x.
Then type:

servicemix or servicemix & 

Testing the Installation

The Window's console window or the Unix command shell will display something similar to the following log line if ServiceMix is up and running without any problems:

[INFO] JBIContainer -- ServiceMix JBI Container 
<http://servicemix.org/> name: defaultJBI running version: null

ServiceMix's default port is 1099. From another window run netstat and look for port 1099.

From a Windows console, type:

       
netstat -an|find "1099"

OR

From a Unix command shell, type:

netstat -an|grep 1099

Stopping ServiceMix

For both Windows and Unix installations, terminate ServiceMix by typing "CTRL-C" in the command shell or console in which it is running.

Configuring ServiceMix

Configuration