...

Anchortoptop

3. Installation

This document describes how to install and configure Apache Felix Karaf for both Unix and Windows' platforms.
Here you will find information about what are pre requisite software, where to download Karaf 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 5 MB of free disk space for the Apache Felix Karaf x.y binary distribution.
• 2 3 MB of free disk space for the Apache Felix Karaf x.y source or developer's distributions respectively around 7 MB for distributions or SVN checkout. The Maven build requires roughly 62 57 MB disk space and for the dependencies Maven downloads during building further 39 76 MB are required. As a lot of small files are produced, the exact space demands depend greatly on your cluster utilization ratio.

...

• 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.8 9 (http://maven.apache.org/download.html).

...

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

...

...

In case you have to install Karaf 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

...

...

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

Windows Binary Installation

...

1. From a browser, navigate to http://servicemixkaraf.apache.org/kernel/download.html.
2. Click Scroll down to the "Apache Felix Karaf x.y Release" link under the "Latest Releases" section. This brings up a new page.Under the "Download Here" section, " section and 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-felix-karaf-x.y.zip.
3. 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.
4. Proceed to the #Starting Karaf section of this document.
5. Following start-up, go to the #Testing the Installation section of this document.
6. Optional: see 7.1. Enabling Colorized Console Output On Windows

...

1. From a browser, navigate to http://servicemixkaraf.apache.org/kernel/download.htmlClick the "ServiceMix Kernel x.
2. Scroll down to the "Apache Karaf" section and y Release" link under the "Latest Releases" section. This brings up another page.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-kernelkaraf-x.y-src.zip.
3. Extract Karaf from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc. AnchorWindows Source Installation
4. Windows Source Installation Build ServiceMix Kernel Karaf using Maven 2.0.8 9 or greater and Java 5.
   The recommended method of building Karaf is the following: Code Block cd [servicemixkaraf_install_dir]\\src Wiki Markup where {{\[servicemixkaraf_install_dir\]}} is the directory in which Karaf was installed. Code Block mvn Both steps take around 10 to 15 minutes.
5. Unzip the distribution using your favorite zip tool. The windows distribution is available at Code Block [servicemix\[karaf_install_dir\]\assembly\target\apache-servicemix-kernelkaraf-x.y.zip
6. Proceed to the #Starting Karaf section of this document.
7. Following start-up, go to the #Testing the Installation section of this document.
8. Optional: see 7.1. Enabling Colorized Console Output On Windows Windows

...

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

1. From a browser, navigate to http://servicemix.apache.org/kernel.
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 Karaf to download (if necessary, scroll down to see the Karaf 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 #Starting Karaf section of this document.
   If a source snapshot was downloaded perform step 5 (building) and step 6 (unzipping) of the #Windows Source Installation procedure and proceed to the #Starting Karaf section of this document.
7. Following start-up, proceed to the #Testing the Installation section.
8. Optional: see 7.1. Enabling Colorized Console Output On Windows

Installation Procedure For Unix

...

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

1. Download the Karaf gzip file to the Unix machine, either using From a browser or using a tool, i.e., wget, scp, ftp, etc. If the Unix machine has a browser: Navigate , navigate to http://servicemixkaraf.apache.org/kernel.download.html.
2. Scroll down to the "Apache Karaf" section and select the desired distribution.
   
3. Click the "Download" link in the navigation pane (the left pane).
4. Click the "Karaf x.y Release" link under the "Latest Releases" section. This brings up a new page.
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-kernelkaraf-x.y.tar.gz.
5. OR, if the Unix machine does NOT have a browser, tools such as wget, scp, or ftp can be used to download the Karaf 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 Karaf 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 "Karaf Kernel 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-kernel-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 Karaf 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:

      No Format
      wget http://www.apache.org/dist/servicemix/kernel/x.y/apache-servicemix-kernel-x.y.tar.gz

6. Extract the files from the gzip file into a directory of your choice. For example: Code Block gunzip apache-servicemix-kernelkaraf-x.y.tar.gz tar xvf apache-servicemix-kernelkaraf-x.y.tar Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
7. Proceed to the #Starting Karaf section of this document.
8. Following start-up, go to the #Testing the Installation section.

...

1. From a browser, navigate to http://servicemixkaraf.apache.org/kernel.
2. Click the "Download" link in the navigation pane (the left pane).
3. Click the "Karaf Kernel x.y Release" link under the "Latest Releases" section. This brings up a new page.
4. download.html.
5. Scroll down to the "Apache Karaf" section and select the desired distributionUnder 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-servicemixkaraf-kernel-x.y-src.tar.gz.
6. Extract the files from the ZIP file into a directory of your choice. For example: Code Block gunzip apache-servicemix-kernelkaraf-x.y-src.tar.gz tar xvf apache-servicemixkaraf-kernel-x.y-src.tar Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
7. Build Karaf using Maven 2.0.8 or greater and Java 5: Code Block The preferred method of building Karaf is the following: cd [servicemixkaraf_install_dir]/src where [servicemixkaraf_install_dir] is the directory in which Karaf was installed. mvn
8. Uncompress the distribution that has just been created Code Block cd [servicemixkaraf_install_dir]/assembly/target gunzip apache-servicemix-kernelkaraf-x.y.tar.gz tar xvf apache-servicemix-kernelkaraf-x.y.tar
9. Proceed to the #Starting Karaf section of this document.
10. Following start-up, go to the #Testing the Installation section.

...

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

1. From a browser, navigate to http://servicemix.apache.org/kernel.
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 Karaf to download (you may have to scroll down to see the Karaf snapshots). The filename will be similar to: apache-servicemix-kernel-x.y-tar.gz or apache-servicemix-kernel-x.y-src.tar.gz.
5. Extract the files from the gzip file into a directory of your choice. For example:

   Code Block
   For a binary developer's snapshot: gunzip apache-servicemix-kernel-x.y.tar.gz tar xvf apache-servicemix-kernel-x.y.tar For a source developer's snapshot: gunzip apache-servicemix-kernel-x.y-src.tar.gz tar xvf apache-servicemix-kernel-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 #Starting Karaf section of this document.
   If a source snapshot was downloaded perform steps 6 - 8 (building, uncompressing, starting) of the #Unix Source Installation procedure.
7. Proceed to the #Testing the Installation section.

Starting Karaf

On Windows

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

...

...

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

...

where servicemixkaraf_install_dir is the directory in which Karaf was installed, e.g., c:\Program Files\apache-servicemix-kernelkaraf-x.y.

Then type:

...

...

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

It will start a Karaf console, allowing you to administrate your Karaf instance.

You can launch Karaf in server mode (without terminal output):

...

On Unix

From a command shell, change to the installation directory and run Karaf. For the binary distribution, go to

...

...

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

...

...

where servicemixkaraf_install_dir is the directory in which Karaf was installed, e.g., /usr/local/apache-servicemix-kernelkaraf-x.y.

Then type:

...

...

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

...

Testing the Installation and connecting to a running Karaf

If Karaf 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 /| | (_|  __/ |  | | |>  <
|____/ \___|_|    \_/ |_|\___\___|_|  |_|_/_/\_\

...

...

You can use the client mode to connect to a running Karaf:
On Windows:

...

On Unix:

...

Stopping Karaf

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

...

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

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

#top

{scrollbar}

You can use the stop script too:
On Windows:

...

On Unix:

...

#top

...