You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

2. Quick Start Karaf Users' Guide 4. Understanding Karaf

3. Installation

This document describes how to install and configure Apache ServiceMix Runtime 0.1 for both Unix and Windows' platforms.
Here you will find information about what are pre requisite software, where to download ServiceMix from and how to customize the installation to use custom ports other than the defaults.

This article contains the following sections:

Pre-Installation Requirements

Hardware:

  • 7 MB of free disk space for the Apache ServiceMix Runtime x.y binary distribution.
  • 2 MB of free disk space for the Apache ServiceMix Runtime x.y source or developer's distributions respectively around 3 MB for SVN checkout. The Maven build requires roughly 35 MB disk space and for the dependencies Maven downloads during building further 50 MB are required. As a lot of small files are produced, the exact space demands depend greatly on your cluster utilisation ratio.

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 (http://java.sun.com/).
  • 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. To accomplish that, press Windows key and Break key together, switch to "Advanced" tab and click on "Environment Variables". Here, check for the variable and, if necessary, add it.
  • Apache Maven 2.0.7 (http://maven.apache.org/download.html).

Installation Procedure for Windows

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

Handy Hint

In case you have to install ServiceMix into a very deep path or a path containing illegal characters for Java paths, e.g. !, % etc., you may add a bat file to start -> startup that executes

subst S: "C:\your very % problematic path!\SM"

so your ServiceMix Runtime root directory is S: — which works for sure and is short to type.

Windows Binary Installation

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

  1. From a browser, navigate to http://servicemix.apache.org/download.html.
  2. Click the "ServiceMix Runtime x.y Release" link under the "Latest Releases" section. This brings up a new page.
  3. 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: apache-servicemix-runtime-x.y.zip.
  4. Extract the files from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
  5. Proceed to the 3. Installation section of this document.
  6. Following start-up, go to the 3. 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 Runtime requires Java 5 is compile, build and run.

  1. From a browser, navigate to http://servicemix.apache.org/download.html
  2. Click the "ServiceMix Runtime x.y Release" link under the "Latest Releases" section. This brings up another page.
  3. 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: apache-servicemix-runtime-x.y-src.zip.
  4. Extract ServiceMix from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
  5. Build ServiceMix Runtime using Maven 2.0.7 or greater and Java 5.
    The recommended method of building ServiceMix is the following: 
    cd [SMX4:servicemix_install_dir]\\src

    where [SMX4:servicemix_install_dir] is the directory in which ServiceMix was installed.

    mvn
    Both steps take around 10 to 15 minutes.
  6. Unzip the distribution using your favorite zip tool. The windows distribution is available at 
    [SMX4:servicemix_install_dir]\assembly\target\apache-servicemix-runtime-x.y.zip
  7. Proceed to the 3. Installation section of this document.
  8. Following start-up, go to the 3. Installation section of this document.

Windows Developers' Release

This procedure explains how to download and install the latest developers' snapshot. NOTE: ServiceMix Runtime requires Java 5 to compile, build and run ServiceMix.

  1. From a browser, navigate to http://servicemix.apache.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. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
  6. If a binary snapshot was downloaded proceed to the 3. Installation section of this document.
    If a source snapshot was downloaded perform step 5 (building) and step 6 (unzipping) of the 3. Installation procedure and proceed to the 3. Installation section of this document.
  7. Following start-up, proceed to the 3. 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:
      1. Navigate to http://servicemix.apache.org.
      2. Click the "Download" link in the navigation pane (the left pane).
      3. Click the "ServiceMix Runtime x.y 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 binary Unix distribution, the filename will be similar to: apache-servicemix-runtime-x.y.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.
      1. Obtain the link to the ServiceMix distribution file. On the Windows machine with a browser, navigate to servicemix.apache.org.
      2. Click the "Download" link in the left navigation pane.
      3. Click the "ServiceMix Runtime x.y Release" link under the "Latest Releases" section. This brings up a new page.
      4. 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: apache-servicemix-runtime-x.y.tar.gz.
      5. Right-click on the distribution name and "Copy Shortcut."
      6. On the Unix machine, change to the directory in which ServiceMix will be installed, e.g., /usr/local.
      7. Download the ServiceMix distribution to the Unix machine using the "wget" tool. For example, type "wget" followed by the saved shortcut: 
        wget http://www.apache.org/dist/servicemix/servicemix-4/x.y/apache-servicemix-runtime-x.y.tar.gz
  2. Extract the files from the gzip file into a directory of your choice. For example: 
    gunzip apache-servicemix-runtime-x.y.tar.gz
tar xvf apache-servicemix-runtime-x.y.tar
    Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
  3. Proceed to the 3. Installation section of this document.
  4. Following start-up, go to the 3. 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 3. Installation section for ideas on how to install ServiceMix without a browser. NOTE: ServiceMix Runtime requires Java 5 to compile, build and run ServiceMix.

  1. From a browser, navigate to http://servicemix.apache.org.
  2. Click the "Download" link in the navigation pane (the left pane).
  3. Click the "ServiceMix Runtime x.y 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: apache-servicemix-runtime-x.y-src.tar.gz.
  5. Extract the files from the ZIP file into a directory of your choice. For example: 
    gunzip apache-servicemix-runtime-x.y-src.tar.gz
tar xvf apache-servicemix-runtime-x.y-src.tar
    Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
  6. Build ServiceMix using Maven 2.0.7 or greater and Java 5: 
    The preferred method of building ServiceMix is the following:
cd [SMX4:servicemix_install_dir]/src
 where [SMX4:servicemix_install_dir] is the directory in which ServiceMix was installed.
mvn
  7. Uncompress the distribution that has just been created 
    cd [SMX4:servicemix_install_dir]/assembly/target
gunzip apache-servicemix-runtime-x.y.tar.gz
tar xvf apache-servicemix-runtime-x.y.tar
  8. Proceed to the 3. Installation section of this document.
  9. Following start-up, go to the 3. Installation section.

Unix Developers' Release

This procedure explains how to download and install the latest developers' snapshot. NOTE: ServiceMix Runtime requires Java 5 to compile, build and run ServiceMix.

  1. From a browser, navigate to http://servicemix.apache.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: apache-servicemix-runtime-x.y-tar.gz or apache-servicemix-runtime-x.y-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 apache-servicemix-runtime-x.y.tar.gz
 tar xvf apache-servicemix-runtime-x.y.tar

For a source developer's snapshot:
 gunzip apache-servicemix-runtime-x.y-src.tar.gz
 tar xvf apache-servicemix-runtime-x.y-src.tar
    Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
  6. For a binary snapshot, proceed to the 3. Installation section of this document.
    If a source snapshot was downloaded perform steps 6 - 8 (building, uncompressing, starting) of the 3. Installation procedure.
  7. Proceed to the 3. Installation section.

Starting ServiceMix

On Windows

From a console window, change to the installation directory and run ServiceMix. For the binary distribution, go to

cd [SMX4:servicemix_install_dir]

and for the source distribution go to the target directory, for example:

cd [SMX4:servicemix_install_dir]\src\assembly\target\apache-servicemix-runtime-x.y-SNAPSHOT

where servicemix_install_dir is the directory in which ServiceMix was installed, e.g., c:\Program Files\apache-servicemix-runtime-x.y.

Then type:

bin\servicemix.bat

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. For the binary distribution, go to

cd [SMX4:servicemix_install_dir]

and for the source distribution go to the target directory, for example:

cd [SMX4:servicemix_install_dir]/src/apache-servicemix/target/apache-servicemix-runtime-x.y

where servicemix_install_dir is the directory in which ServiceMix was installed, e.g., /usr/local/apache-servicemix-runtime-x.y.

Then type:

bin/servicemix.sh

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:

 ____                  _          __  __ _
/ ___|  ___ _ ____   _(_) ___ ___|  \/  (_)_  __
\___ \ / _ \ '__\ \ / / |/ __/ _ \ |\/| | \ \/ /
 ___) |  __/ |   \ V /| | (_|  __/ |  | | |>  <
|____/ \___|_|    \_/ |_|\___\___|_|  |_|_/_/\_\

 ServiceMix (0.1-SNAPSHOT)

Type 'help' for more information.
--------------------------------------------------------------------------------------------------------------------------------
gnodet@Guillaume-Nodets-MacPro.local:/>

Stopping ServiceMix

For both Windows and Unix installations, you can perform a clean shutdown of ServiceMix Runtime by using the following command:

osgi shutdown

If you are using the local console, you can also run:

exit

If ServiceMix was started in the background on Unix, the process can be killed, with the following:

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

3. Installation

2. Quick Start Karaf Users' Guide 4. Understanding Karaf
  • No labels