You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2013/11/26 17:57:22 UTC
svn commit: r1545726 - in /karaf/trunk/manual/src/main/webapp/users-guide:
index.conf installation.conf
Author: jbonofre
Date: Tue Nov 26 16:57:22 2013
New Revision: 1545726
URL: http://svn.apache.org/r1545726
Log:
[KARAF-2511] Review on the installation page in the documentation
Modified:
karaf/trunk/manual/src/main/webapp/users-guide/index.conf
karaf/trunk/manual/src/main/webapp/users-guide/installation.conf
Modified: karaf/trunk/manual/src/main/webapp/users-guide/index.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/index.conf?rev=1545726&r1=1545725&r2=1545726&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/index.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/index.conf Tue Nov 26 16:57:22 2013
@@ -1,6 +1,6 @@
h1. Karaf Users Guide
-* [Installing Karaf|installation]
+* [Installation|installation]
* [Directory Structure|directory-structure]
* [Starting and stopping Karaf|start-stop]
* [Service Wrapper|wrapper]
Modified: karaf/trunk/manual/src/main/webapp/users-guide/installation.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/installation.conf?rev=1545726&r1=1545725&r2=1545726&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/installation.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/installation.conf Tue Nov 26 16:57:22 2013
@@ -1,29 +1,31 @@
h1. Installation
-This chapter describes how to install Apache Karaf for both Unix and Windows platforms, including
-prerequisite software and necessary download links.
+Apache Karaf is a lightweight container, very easy to install and administrate, on both Unix and Windows platforms.
-h2. Pre-Installation Requirements
+h2. Requirements
*Hardware:*
-* 20 MB of free disk space for the Apache Karaf binary distribution.
+* 50 MB of free disk space for the Apache Karaf binary distribution.
*Operating Systems:*
-* Windows: Windows Vista, Windows XP SP2, Windows 2000.
-* Unix: Ubuntu Linux, Powerdog Linux, MacOS, AIX, HP-UX, Solaris, any Unix platform that supports Java.
+* Windows: Windows 8, Windows 7, Windows 2003, Windows Vista, Windows XP SP2, Windows 2000.
+* Unix: RedHat Enterprise Linux, Debian, SuSE/OpenSuSE, CentOS, Fedora, Ubuntu, MacOS, AIX, HP-UX, Solaris, any Unix platform that supports Java.
*Environment:*
-* Java SE 1.6.x or greater ([http://www.oracle.com/technetwork/java/javase/]).
-* The JAVA_HOME environment variable must be set to the directory where the Java runtime is installed, e.g., {{c:\Program Files\jdk.1.6.0_24}}. 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.
+* Java SE 1.7.x or greater ([http://www.oracle.com/technetwork/java/javase/]).
+* The JAVA_HOME environment variable must be set to the directory where the Java runtime is installed,
-h2. Installation Procedure for Windows
+h2. Using Apache Karaf binary distributions
+
+h3. Installation on Windows platform
+
+NB: the JAVA_HOME environment variable has to be correctly defined. To accomplish that, press Windows key and Break key together, switch to "Advanced" tab and click on "Environment Variables".
-This procedure explains how to download and install the binary distribution on a Windows system.
# From a browser, navigate to [http://karaf.apache.org/index/community/download.html].
-# Scroll down to the "Apache Karaf" section and select the desired distribution.
-For a binary distribution, the filename will be similar to: {{apache-karaf-x.y.zip}}.
-# 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.
-# Proceed to the [Starting Karaf|start-stop#Starting Karaf] chapter.
+# Download Apache Karaf binary distribution in the zip format: {{apache-karaf-3.0.0.zip}}.
+# Extract the files from the zip file into a directory of your choice (it's the {{KARAF_HOME}}.
+NB: remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc.
+# Apache Karaf is now installed.
{tip:title=Handy Hint}
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
@@ -33,84 +35,83 @@ subst S: "C:\your very % problematic pat
so your Karaf root directory is S: --- which works for sure and is short to type.
{tip}
-h2. Installation Procedure For Unix
+h3. Installation on Unix platforms
+
+NB: the JAVA_HOME environment variable has to be correctly defined. Check the current value using
+{code}
+echo $JAVA_HOME
+{code}
+If it's not correct, fix it using:
+{code}
+export JAVA_HOME=....
+{code}
-This procedure explains how to download and install the binary distribution on a Unix system.
# From a browser, navigate to [http://karaf.apache.org/download.html].
-# Scroll down to the "Apache Karaf" section and select the desired distribution.
-For a binary Unix distribution, the filename will be similar to: apache-karaf-x.y.tar.gz.
-# Extract the files from the gzip file into a directory of your choice. For example:
+# Download Apache Karaf binary distribution in the tar.gz format: {{apache-karaf-3.0.0.tar.gz}}.
+# Extract the files from the tar.gz file into a directory of your choice (it's the {{KARAF_HOME}}). For example:
{code}
gunzip apache-karaf-x.y.tar.gz
tar xvf apache-karaf-x.y.tar
{code}
-Please remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc.
-# Proceed to the [Starting Karaf|start-stop#Starting Karaf] chapter.
+NB: remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc.
+# Apache Karaf is now installed.
h2. Post-Installation steps
-Thought it is not always required, it is strongly advised to set up the {{JAVA_HOME}} environment property to point to the JDK you want Karaf to use before starting it.
-This property is used to locate the {{java}} executable and should be configured to point to the home directory of the Java SE 6 installation.
+Thought it is not always required, it is strongly advised to set up the {{JAVA_HOME}} environment property to point to the JDK you want Apache Karaf to use before starting it.
+This property is used to locate the {{java}} executable and should be configured to point to the home directory of the Java SE 7 installation.
+
+By default, all Apache Karaf files are "gather" in one directory: the {{KARAF_HOME}}.
+
+You can define your own directory layout, by using some Karaf environment variables:
+
+* {{KARAF_DATA}} is the location of the data folder, where Karaf stores temporary files.
+* {{KARAF_ETC}} is the location of the etc folder, where Karaf stores configuration files.
+* {{KARAF_BASE}} is the Karaf base folder. By default {{KARAF_BASE}} is the same as {{KARAF_HOME}}.
h2. Building from Sources
-If you intend to build Karaf from the sources, the requirements are a bit different:
+If you intend to build Apache Karaf from the sources, the requirements are a bit different:
*Hardware:*
-* 200 MB of free disk space for the Apache Karaf source distributions or SVN checkout, the Maven build and the dependencies Maven downloads.
+* 500 MB of free disk space for the Apache Karaf source distributions or SVN checkout, the Maven build and the dependencies Maven downloads.
*Environment:*
-* Java SE Development Kit 1.6.x or greater ([http://www.oracle.com/technetwork/java/javase/]).
-* Apache Maven 3.0.3 ([http://maven.apache.org/download.html]).
+* Java SE Development Kit 1.7.x or greater ([http://www.oracle.com/technetwork/java/javase/]).
+* Apache Maven 3.0.4 ([http://maven.apache.org/download.html]).
-h3. Building on Windows
+h3. Building on Windows platform
-This procedure explains how to download and install the source distribution on a Windows system. *NOTE:* Karaf requires Java 6 to compile, build and run.
-# From a browser, navigate to [http://karaf.apache.org/index/community/download.html].
-# Scroll down to the "Apache Karaf" section and select the desired distribution.
-For a source distribution, the filename will be similar to: {{apache-karaf-x.y-src.zip}}.
-# 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.
-# {anchor:Windows Source Installation} Build Karaf using Maven 3.0.3 or greater and Java 6.
-The recommended method of building Karaf is the following:
+# You can get the Apache Karaf sources from:
+* the sources distribution {{apache-karaf-3.0.0-src.zip}} available at [http://karaf.apache.org/index/community/download.html]. Extract the files in the directory of your choice.
+* by checkout of the subversion repository:
{code}
-cd [karaf_install_dir]\src
+svn co https://svn.apache.org/repos/asf/karaf/trunk karaf
{code}
- where {{karaf_install_dir}} is the directory in which Karaf was installed.
+# Use Apache Maven to build Apache Karaf:
{code}
-mvn
+mvn clean install
{code}
-Both steps take around 10 to 15 minutes.
-# Unzip the distribution using your favorite zip tool. The windows distribution is available at
+NB: you can speed up the build by bypassing the unit tests:
{code}
-[karaf_install_dir]\assemblies\apache-karaf\target\apache-karaf-x.y.zip
+mvn clean install -DskipTests
{code}
-# Proceed to the [Starting Karaf|start-stop#Starting Karaf] chapter.
+# You can find the built binary distribution in {{assemblies\apache-karaf\target\apache-karaf-3.0.0.zip}}. You can install and use it as explained in the "Using Apache Karaf binary distributions" section.
-h3. Building on Unix
+h3. Building on Unix platforms
-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 [#Unix Binary Installation] section for ideas on how to install Karaf without a browser. *NOTE:* Karaf requires Java 6 to compile, build and run.
-# From a browser, navigate to [http://karaf.apache.org/download.html].
-# Scroll down to the "Apache Karaf" section and select the desired distribution.
-For a source distribution, the filename will be similar to: {{apache-karaf-x.y-src.tar.gz}}.
-# Extract the files from the tarball file into a directory of your choice. For example:
+# You can get the Apache Karaf sources from:
+* the sources distribution {{apache-karaf-3.0.0-src.tar.gz}} available at [http://karaf.apache.org/index/community/download.html]. Extract the files in the directory of your choice.
+* by checkout of the subversion repository:
{code}
-gunzip apache-karaf-x.y-src.tar.gz
-tar xvf apache-karaf-x.y-src.tar
+svn co https://svn.apache.org/repos/asf/karaf/trunk karaf
{code}
-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:
+# Use Apache Maven to build Apache Karaf:
{code}
-cd [karaf_install_dir]/src
+mvn clean install
{code}
- where {{karaf_install_dir}} is the directory in which Karaf was installed.
+NB: you can speed up the build by bypassing the unit tests:
{code}
-mvn
-{code}
-# Uncompress the distribution that has just been created
-{code}
-cd [karaf_install_dir]/assemblies/apache-karaf/target
-gunzip apache-karaf-x.y.tar.gz
-tar xvf apache-karaf-x.y.tar
+mvn clean install -DskipTests
{code}
-# Proceed to the [Starting Karaf|start-stop#Starting Karaf] chapter.
+# You can find the built binary distribution in {{assemblies/apache-karaf/target/apache-karaf-3.0.0.tar.gz}}. You can install and use it as explained in the "Using Apache Karaf binary distributions" section.
\ No newline at end of file