Installation

This chapter describes how to install Apache Karaf Cellar into your existing Karaf based installation.

Pre-Installation Requirements

Cellar is installed on running Karaf instances.

Cellar is provided as a Karaf features descriptor. The easiest way to install is just to have an internet connection from the Karaf running instance.

See link::deploy to how to install and start Cellar.

Building from Sources

If you intend to build Karaf Cellar from the sources, the requirements are:

Hardware:

  • 100MB of free disk space for the Apache Karaf Cellar x.y source distributions or SVN checkout, the Maven build and the dependencies that Maven downloads.

Environment:

Note

Karaf Cellar requires Java 7 to compile, build and run.

Building on Windows

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

  1. From a browser, navigate to link::http://karaf.apache.org/sub-projects/cellar/download.html.

  2. Select the desired distribution. For a source distribution, the filename will be similar to: apache-karaf-cellar-x.y-src.zip.

  3. Extract Karaf Cellar from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc.

  4. Build Karaf Cellar using Maven 3.0.3 or greater and Java 6. The recommended method of building Karaf Cellar is the following:

cd [cellar_install_dir]\src

where [cellar_install_dir] is the directory in which Karaf Cellar was uncompressed.

mvn

Building on Unix

This procedure explains how to download and install the source distribution on an Unix system.

  1. From a browser, navigate to link::http://karaf.apache.org/sub-projects/cellar/download.html.

  2. Select the desired distribution. For a source distribution, the filename will be similar to: apache-karaf-cellar-x.y-src.tar.gz.

  3. Extract the files from the tarball file into a directory of your choice. For example:

gunzip apache-karaf-cellar-x.y-src.tar.gz
tar xvf apache-karaf-cellar-x.y-src.tar

Please remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc. . Build Karaf using Maven: The preferred method of building Karaf is the following:

cd [karaf_install_dir]/src

where [karaf_install_dir] is the directory in which Karaf Cellar was uncompressed.

mvn