Getting Started Guide

Introduction

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

Document Organization

This document contains the following sections:

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) 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 (required when installing source or developers' releases).

Installation Procedure For Windows

Windows Binary Installation

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

From a browser, navigate to www.servicemix.org.
Click the Download link in the navigation pane (the left pane).
Click the "ServiceMix 1.x Release" link under the "Latest Releases" section.
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.
Extract the files from the zip file into a directory of your choice.
Proceed to the #Starting ServiceMix section of this document.
Following start-up, go to #Testing the Installation section of this document.

Windows Source Installation

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

From a browser, navigate to www.servicemix.org.
Click the "Download" link in the navigation pane (the left pane).
Click the "ServiceMix 1.x Release" link under the "Latest Releases" section.
Under the "Download Here" section, select the desired distribution (if necessary, scroll down to see the "Download Here" section).
For a source distribution the filename will be similar to: servicemix-x.x.x-src.zip.
Extract ServiceMix from the zip file into a directory of your choice.

Build ServiceMix using Maven 1.0.2 or greater.

The recommended 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, type the following:
cd [servicemix_install_dir]
maven m:clean
maven -Dmaven.test.skip=true

Start ServiceMix from the target directory:

cd [servicemix_install_dir]\target\servicemix-1.x\bin\servicemix-1.x\bin
servicemix

Proceed to #Testing the Installation section.

Windows Developer's Releases

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

From a browser, navigate to www.servicemix.org.
Click the Download link in the navigation pane (the left pane).
Click the "Development SNAPSHOT releases can also be found here" link.
Select the version of ServiceMix to download (if necessary, scroll down to see the ServiceMix snapshots).
Extract the files from the zip file into a directory of your choice.
If a binary snapshot was downloaded proceed to the #Starting ServiceMix section of this document.
If a source snapshot was downloaded perform step 6 and step 7 of the #Windows Source Installation procedure.
Following start-up, proceed to #Testing the Installation section.

Installation Procedure For Unix

Unix Binary Installation

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

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

Installing with a browser on the Unix machine:

a. If a browser is available on the Unix machine, navigate to www.servicemix.org.
b. Click the "Download" link in the navigation pane (the left pane).
c. Click the "ServiceMix 1.x Release" link under the "Latest Releases" section.
d. Under the "Download Here" section, select the desired distribution (if necessary, 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

The following gives an example of installing on a Unix machine that does not have a browser.
There are several alternative ways to perform this type of installation.
The following instructions require a Windows machine and the "wget" tool must be installed on the Unix machine where ServiceMix will be installed.

a. Obtain the link to the gzip file. Using a Windows machine, navigate to www.servicemix.org.
b. Click the "Download" link in the left navigation pane.
c. Click the "ServiceMix 1.x Release" link under the "Latest Releases" section.
d. Under the "Download Here" section, roll-over the desired distribution (if necessary, 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. On the Unix machine, change to the directory in which ServiceMix will be installed, e.g., /usr/local.
f. Download the ServiceMix distribution to the Unix machine using the "wget" tool. For example, type "wget" followed by the saved shortcut:

wget http://dist.codehaus.org/servicemix/distributions/servicemix-1.0.1.tar.gz

Extract the files from the gzip file into a directory of your choice. For example:
```
gunzip servicemix-x.x.x.tar.gz  
tar xvf servicemix-x.x.x.tar
```
If the servicemix start-up script is not executable, change its permisssions. The servicemix script is located in the bin directory. For example:
```
cd [servicemix_install_dir]/bin
  where [servicemix_install_dir] is the directory in which ServiceMix was installed.
chmod 755 servicemix
```
Proceed to the #Starting ServiceMix section of this document.
Following start-up, go to #Testing the Installation section.

Unix Source Installation

This procedure explains how to download and install the source distribution on a Unix system. This procedure assumes the Unix machine has a browser. Please see the previous section #Unix Binary Installation for ideas on how to install ServiceMix without a browser.

From a browser, navigate to www.servicemix.org.
Click the "Download" link in the navigation pane (the left pane).
Click the "ServiceMix 1.x Release" link under the "Latest Releases" section.
Under the "Download Here" section, select the desired distribution (if necessary, scroll down to see the "Download Here" section).
For a source distribution the filename will be similar to: servicemix-x.x.x-src.tar.gz.
Extract the files from the zip file into a directory of your choice. For example:
```
gunzip servicemix.x.x.x-src.tar.gz
tar xvf servicemix.x.x-src.tar
```

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

If the servicemix startup script is not executable, change it's permissions. For example:

cd [servicemix_install_dir]/target/servicemix-1.0/bin/servicemix-1.0/bin
chmod 755 servicemix

Start ServiceMix from the target directory:

cd [servicemix_install_dir]/target/servicemix-1.x/bin/servicemix-1.x/bin
servicemix

Proceed to #Testing the Installation section.

Unix Developer's Releases

From a browser, navigate to www.servicemix.org.
Click the Download link in the navigation pane (the left pane).
Click the "Development SNAPSHOT releases can also be found here" link.
Select the version of ServiceMix to download (you may have to scroll down to see the ServiceMix snapshots). The filename will be similar to: servicemix.x.x-src.tar.gz.
Extract the files from the zip file into a directory of your choice. For example:
```
gunzip servicemix.x.x-tar.gz
tar xvf servicemix.x.x-tar
```
If a binary snapshot was downloaded the servicemix script may need its permissions changed
to make it executable:
```
cd [servicemix_install_dir]/bin  
  where [servicemix_install_dir] is the directory in which ServiceMix was installed.
chmod 755 servicemix
```
Then proceed to the #Starting ServiceMix section of this document.
If a source snapshot was downloaded perform steps 6 - 8 of the #Unix Source Installation procedure.
Proceed to #Testing the Installation section.

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 > /tmp/smlog  2>&1 & 
Note: /tmp/smlog may be changed to another file name.

Warning

Do NOT close the console or shell in which ServiceMix was started, as that will terminate ServiceMix (unless ServiceMix was started in the background).

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 search 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.

If ServiceMix was started in the background on Unix, the process can be killed, for example:

ps -ef|grep servicemix
kill [PID]
  where [PID] is the process id of the servicemix process.

Configuring ServiceMix

For details on customizing the configuration of ServiceMix please see: Configuration

Child pages