Versions Compared

Old Version 20

changes.mady.by.user Hiram Chirino

Saved on

compared with

New Version 21

changes.mady.by.user Guillaume Nodet

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

  1. From a browser, navigate to http://servicemixfelix.apache.org/kernelsite/downloaddownloads.htmlcgi.
  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://servicemixfelix.apache.org/kernelsite/download.html
  2. Click the "ServiceMix Kernel x.y Release" link under the "Latest Releases" section. This brings up another page.
  3. downloads.cgi.
  4. Scroll down to the "Apache Felix 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-servicemixfelix-kernelkaraf-x.y-src.zip.
  5. 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.
  6. Anchor
    Windows Source Installation
    Windows Source Installation
    Build ServiceMix Kernel Karaf using Maven 2.0.8 or greater and Java 5.
    The recommended method of building Karaf is the following:
    Code Block
    cd [servicemixkaraf_install_dir]\\src
    Wiki Markup
     where {{\[servicemixFELIX:karaf_install_dir\]}} is the directory in which Karaf was installed.
    Code Block
    mvn
    Both steps take around 10 to 15 minutes.
  7. Unzip the distribution using your favorite zip tool. The windows distribution is available at
    Code Block
    [servicemixkaraf_install_dir]\assembly\target\apache-servicemixfelix-kernelkaraf-x.y.zip
  8. Proceed to the #Starting Karaf section of this document.
  9. Following start-up, go to the #Testing the Installation section of this document.
  10. Optional: see 7.1. Enabling Colorized Console Output On Windows

Windows Developers Release

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

...

Installation

...

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 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://servicemixfelix.apache.org/site/kernel.downloads.cgi.
  2. Scroll down to the "Apache Felix 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.
    5. 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-kernel-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 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.
  5. Obtain the link to the Karaf distribution file. On the Windows machine with a browser, navigate to servicemix.apache.org.
  6. Click the "Download" link in the left navigation pane.
  7. Click the "Karaf Kernel x.y Release" link under the "Latest Releases" section. This brings up a new page.
    8. 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-felix-karaf-x.y.tar.gz.
  8. Right-click on the distribution name and "Copy Shortcut."
  9. On the Unix machine, change to the directory in which Karaf will be installed, e.g., /usr/local.
  10. 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
  11. Extract the files from the gzip file into a directory of your choice. For example:
    Code Block
    gunzip apache-servicemixfelix-kernelkaraf-x.y.tar.gz
tar xvf apache-servicemixfelix-kernelkaraf-x.y.tar
    Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.
  12. Proceed to the #Starting Karaf section of this document.
  13. Following start-up, go to the #Testing the Installation section.

...

  1. From a browser, navigate to http://servicemixfelix.apache.org/site/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. downloads.cgi.
  5. Scroll down to the "Apache Felix 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-servicemixfelix-kernelkaraf-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-servicemixfelix-kernelkaraf-x.y-src.tar.gz
tar xvf apache-servicemixfelix-kernelkaraf-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-servicemixfelix-kernelkaraf-x.y.tar.gz
tar xvf apache-servicemixfelix-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.

Unix Developers Release

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.

...

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

Code Block
cd [servicemixkaraf_install_dir]

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

Code Block
cd [servicemixkaraf_install_dir]\src\assembly\target\apache-servicemixfelix-kernelkaraf-x.y-SNAPSHOT

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

Then type:

Code Block
bin\karaf.bat

...

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

Code Block
cd [servicemixkaraf_install_dir]

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

Code Block
cd [servicemixkaraf_install_dir]/src/assembly/target/apache-servicemixfelix-kernelkaraf-x.y

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

Then type:

Code Block
bin/karaf.sh

...

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:

...

bgColor#000000

...

No Format
nopaneltrue
 ____                  _          __  __ _
/ ___|  ___ _ ____   _(_) ___ ___|  \/  (_)_  __
\___ \ / _ \ '__\ \ / / |/ __/ _ \ |\/| | \ \/ /
 ___) |  __/ |   \ V /| | (_|  __/ |  | | |>  <
|____/ \___|_|    \_/ |_|\___\___|_|  |_|_/_/\_\
Include Page
KARAF:Karaf welcome screen
KARAF:Karaf welcome screen

...

nopaneltrue

...

Stopping Karaf

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

Code Block
osgi/:shutdown

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

...