Outdated

You will find an up to date page in the User's Guide.

Introduction

This document describes how to install and configure ServiceMix 3.x for both Unix and Windows' platforms. For installation and configuration instructions for older versions of ServiceMix please see Getting Started for ServiceMix 2.x or Getting Started for ServiceMix 1.1.

Document Organization

The Getting Started for ServiceMix 3.x document contains the following sections:

Pre-Installation Requirements

Hardware:

  • 31 MB of free disk space for the ServiceMix 3.x binary distribution.
  • 8 MB of free disk space for the ServiceMix 3.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.5.x or greater.
  • The JAVA_HOME environment variable must be set to the directory where the JDK is installed, e.g., c:\Program Files\jdk.1.5.0_06.
  • Maven 2.0.4 or greater (required when installing source or developers' releases).

Installation Procedure for Windows

This section of the Getting Started guide explains how to install binary and source distributions of ServiceMix on a Windows system.

Windows Binary Installation

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

  1. From a browser, navigate to www.servicemix.org.
  2. Click the Download link in the navigation pane (the left pane).
  3. Click the "ServiceMix 3.x Release" link under the "Latest Releases" section. This brings up a new page.
  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 the #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. NOTE: ServiceMix can be run on a Java 1.4.x system, however, Java 5 is required to compile/build ServiceMix.

  1. From a browser, navigate to www.servicemix.org
  2. Click the "Download" link in the navigation pane (the left pane).
  3. Click the "ServiceMix 3.x Release" link under the "Latest Releases" section. This brings up another page.
  4. 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-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 and Java 5. 
    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 

If the above build fails on some tests, type the following:
cd [servicemix_install_dir]
maven -Dmaven.test.skip=true
  7. Start ServiceMix from the target directory, for example: 
    cd [servicemix_install_dir]\servicemix-assembly\target\servicemix-3.0-SNAPSHOT\bin\servicemix-3.0-SNAPSHOT
bin\servicemix
    Note: working directories get created relative to the current directory. For the working directories to be created in the proper place, ServiceMix must be launched from its home/installation directory.
  8. Proceed to the #Testing the Installation section.

Warning: If you are building Servicemix 3.x under Windows using Cygwin there is a path name length limitation. If the length is exceeded you may see build errors. To fix this, move the ServiceMix source directory higher in the file system tree, e.g., /cygdrive/c/d/sm.

Windows Developers' Release

This procedure explains how to download and install the latest developers' snapshot. NOTE: ServiceMix can be run on a Java 1.4.x system, however, Java 5 is required to compile/build ServiceMix.

  1. From a browser, navigate to www.servicemix.org.
  2. Click the Download link in the navigation pane (the left pane).
  3. Click the "Current development SNAPSHOT release" link.
  4. Select the version of ServiceMix to download (if necessary, 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 perform step 6 and step 7 of the #Windows Source Installation procedure.
  7. Following start-up, proceed to the #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.

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

a. Navigate to [www.servicemix.org|http://www.servicemix.org].
b. Click the "Download" link in the navigation pane (the left pane).
c. Click the "ServiceMix 3.x Release" link under the "Latest Releases" section. This brings up a new page.
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

If the Unix machine does NOT have a browser, tools such as wget, scp, or ftp can be used to download the ServiceMix distribution.
It is beyond the scope of this document to explain the use of those tools. For convenience an example is provided below using
a Windows machine (that has a browser) and a Unix machine with "wget" installed on it.
*NOTE:* There are several alternative ways to perform this type of installation.

a. Obtain the link to the ServiceMix distribution file. On the Windows machine with a browser, navigate to [www.servicemix.org|http://www.servicemix.org].
b. Click the "Download" link in the left navigation pane.
c. Click the "ServiceMix 3.x Release" link under the "Latest Releases" section. This brings up a new page.
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-3.0.x.tar.gz
  2. 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
  3. 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
  4. Proceed to the #Starting ServiceMix section of this document.
  5. Following start-up, go to the #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 #Unix Binary Installation section for ideas on how to install ServiceMix without a browser. NOTE: ServiceMix can be run on a Java 1.4.x system, however, Java 5 is required to compile/build ServiceMix.

  1. From a browser, navigate to www.servicemix.org.
  2. Click the "Download" link in the navigation pane (the left pane).
  3. Click the "ServiceMix 3.x Release" link under the "Latest Releases" section. This brings up a new page.
  4. 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-src.tar.gz.
  5. Extract the files from the ZIP file into a directory of your choice. For example: 
    gunzip servicemix.x.x-src.tar.gz
tar xvf servicemix.x.x-src.tar
  6. Build ServiceMix using Maven 1.0.2 or greater and Java 5: 
    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 the following:
cd [servicemix_install_dir]
maven m:clean
maven -Dmaven.test.skip=true
  7. If the servicemix start-up script is not executable, change its permissions. For example: 
    cd [servicemix_install_dir]/servicemix-assembly/target/servicemix-3.x/bin/servicemix-3.x/bin
chmod 755 servicemix
  8. Start ServiceMix from the target directory, for example: 
    cd [servicemix_install_dir]/servicemix-assembly/target/servicemix-3.x/bin/servicemix-3.x
bin/servicemix
    Note: working directories get created relative to the current directory. For the working directories to be created in the proper place, ServiceMix must be launched from its home/installation directory.
  9. Proceed to #Testing the Installation section.

Unix Developers' Release

This procedure explains how to download and install the latest developers' snapshot. NOTE: ServiceMix can be run on a Java 1.4.x system, however, Java 5 is required to compile/build ServiceMix.

  1. From a browser, navigate to www.servicemix.org.
  2. Click the Download link in the navigation pane (the left pane).
  3. Click the "Current development SNAPSHOT release" link.
  4. 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.x-tar.gz or servicemix-x.x.x-src.tar.gz.
  5. Extract the files from the gzip file into a directory of your choice. For example: 
    For a binary developer's snapshot:
  gunzip servicemix-x.x-x.tar.gz
  tar xvf servicemix-x.x.x.tar

For a source developer's snapshot:
  gunzip servicemix-x.x.x-src.tar.gz
  tar xvf servicemix-x.x.x-src.tar
  6. 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
    For a binary snapshot, 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.
  7. Proceed to the #Testing the Installation section.

Starting ServiceMix

On Windows:

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

cd [servicemix_install_dir]

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

bin\servicemix

Note: working directories get created relative to the current directory. For the working directories to be created in the proper place, ServiceMix must be launched from its home/installation directory.

On Unix:

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

cd [servicemix_install_dir]

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

bin/servicemix

OR

nohup bin/servicemix > /tmp/smlog  2>&1 &
Note: /tmp/smlog may be changed to another file name.

Note: working directories get created relative to the current directory. For the working directories to be created in the proper place, ServiceMix must be launched from its home/installation directory.

Warning

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

Testing the Installation

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

INFO - JBIContainer.init(421) | ServiceMix JBI Container (http://servicemix.org/) name: defaultJBI running version: 3.0-SNAPSHOT


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, with the following:

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

Configuring ServiceMix

After the installation, ServiceMix is running with a basic configuration, but no components. For details on configuring options, please see refer to the Configuration section.

Additional Resources

Before trying to use ServiceMix you may want to read What is JBI, take a look at the available Components list and get an idea about the Architecture, along with the supported NMR Flows.

A quick way to get started is to run the examples that are part of the ServiceMix binary distribution. The examples are located in the examples directory under the directory in which ServiceMix was installed.

For instructions on running the examples, please see Examples.

Handy Hint

Add $SERVICEMIX_HOME/bin directory to $PATH variable to simplify execution of the examples.

To view the statistics and operation of ServiceMix in a JMX Console and to see how the Management works, please see the following:

  • No labels

3 Comments

  1. Unknown User (jwortzman)

    Clarification may be helpful around starting servicemix. Start servicemix from the Servicemix directory not from the install directory.

  2. Unknown User (lmalgeri)

    Maybe servicemix_home_dir is better, but that seems like a user's home directory.

    Or servicemix_installation_dir? Hmm...

  3. Unknown User (jwortzman)

    The cygwin warning does have that hot red box going around it. Is it a hot enough issue to justify that?