...

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

...

• 5 MB of free disk space for the Apache Felix Karaf x.y binary distribution.
• 3 MB of free disk space for the Apache Felix Karaf x.y source distributions or SVN checkout. The Maven build requires roughly 57 MB disk space and for the dependencies Maven downloads during building further 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).

...

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.

...

1. From a browser, navigate to http://felixkaraf.apache.org/site/downloadsdownload.cgihtml.
2. Scroll down to the "Apache Felix Karaf" section and select the desired distribution.
   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://felixkaraf.apache.org/site/downloadsdownload.cgihtml.
2. Scroll down to the "Apache Felix Karaf" section and select the desired distribution.
   For a source distribution, the filename will be similar to: apache-felix-karaf-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.
4. AnchorWindows Source InstallationWindows Source Installation Build Karaf using Maven 2.0.8 9 or greater and Java 5.
   The recommended method of building Karaf is the following: Code Block cd [karaf_install_dir]\\src Wiki Markup where {{\[FELIX:karaf_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 \[karaf_install_dir\]\assembly\target\apache-felix-karaf-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

...

1. From a browser, navigate to http://felixkaraf.apache.org/site/downloadsdownload.cgihtml.
2. Scroll down to the "Apache Felix Karaf" section and select the desired distribution.
   For a binary Unix distribution, the filename will be similar to: apache-felix-karaf-x.y.tar.gz.
3. Extract the files from the gzip file into a directory of your choice. For example: Code Block gunzip apache-felix-karaf-x.y.tar.gz tar xvf apache-felix-karaf-x.y.tar 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.

...

1. From a browser, navigate to http://felixkaraf.apache.org/site/downloadsdownload.cgihtml.
2. Scroll down to the "Apache Felix Karaf" section and select the desired distribution.
   For a source distribution, the filename will be similar to: apache-felix-karaf-x.y-src.tar.gz.
3. Extract the files from the ZIP file into a directory of your choice. For example: Code Block gunzip apache-felix-karaf-x.y-src.tar.gz tar xvf apache-felix-karaf-x.y-src.tar Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
4. Build Karaf using Maven 2.0.8 or greater and Java 5: Code Block The preferred method of building Karaf is the following: cd [karaf_install_dir]/src where [karaf_install_dir] is the directory in which Karaf was installed. mvn
5. Uncompress the distribution that has just been created Code Block cd [karaf_install_dir]/assembly/target gunzip apache-felix-karaf-x.y.tar.gz tar xvf apache-felix-karaf-x.y.tar
6. Proceed to the #Starting Karaf section of this document.
7. Following start-up, go to the #Testing the Installation section.

...

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 karaf_install_dir is the directory in which Karaf was installed, e.g., c:\Program Files\apache-felix-karaf-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 karaf_install_dir is the directory in which Karaf was installed, e.g., /usr/local/apache-felix-karaf-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:

...

...

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

...