Index: src/main/webapp/overview.conf =================================================================== --- src/main/webapp/overview.conf (revision 1141702) +++ src/main/webapp/overview.conf (working copy) @@ -4,7 +4,7 @@ Here is a short list of features supported by the Karaf: -* *Hot deployment*: Karaf supports hot deployment of OSGi bundles by monitoring jar files inside the {{\[home\]/deploy}} directory. Each time a jar is copied in this folder, it will be installed inside the runtime. You can then update or delete it and changes will be handled automatically. In addition, the Karaf also supports exploded bundles and custom deployers (blueprint and spring ones are included by default). +* *Hot deployment*: Karaf supports hot deployment of OSGi bundles by monitoring jar files inside the {{\[home\]/deploy}} directory. Each time a jar is copied in this folder, it will be installed inside the runtime. You can then update or delete it and changes will be handled automatically. In addition, Karaf also supports exploded bundles and custom deployers (Blueprint and Spring ones are included by default). * *Dynamic configuration*: Services are usually configured through the ConfigurationAdmin OSGi service. Such configuration can be defined in Karaf using property files inside the {{\[home\]/etc}} directory. These configurations are monitored and changes on the properties files will be propagated to the services. * *Logging System*: using a centralized logging back end supported by Log4J, Karaf supports a number of different APIs (JDK 1.4, JCL, SLF4J, Avalon, Tomcat, OSGi) * *Provisioning*: Provisioning of libraries or applications can be done through a number of different ways, by which they will be downloaded locally, installed and started. Index: src/main/webapp/quick-start.conf =================================================================== --- src/main/webapp/quick-start.conf (revision 1141702) +++ src/main/webapp/quick-start.conf (working copy) @@ -22,19 +22,19 @@ h3. Prerequisites -Although this installation path is the fastest one, still you will need to install some software before installing Karaf. +Although this installation path is the fastest one, you will still need to install some software before installing Karaf. -Karaf requires a Java SE 5 environment to run. Refer to [http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 1.5 or greater. +Karaf requires a Java SE 6 environment to run. Refer to [http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 1.6 or greater. h3. Download binaries -Depending on the platform you plan to install and run Karaf you will select the appropriate installation image. Open a Web browser and access the following URL, there you will find the available packages for download (binaries and source code). - +You will need to select the appropriate installation image for the platform you're using to run Karaf. Open a Web browser and access the following URL, there you will find the available packages for download (binaries and source code). + [http://karaf.apache.org/index/community/download.html] Select the file compression format compatible with your system (zip for windows, tar.gz for unixes) by clicking directly on the link, download it and expand the binary to your hard drive in a new directory; for example in z:\karaf - from now on this directory will be referenced as . Please remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc. -The installation of Karaf is as simple as uncompressing the .zip or .tar files. The next step is to start the server. +The installation of Karaf is as simple as uncompressing the .zip or .tar.gz files. The next step is to start the server. h2. Start the server @@ -47,36 +47,70 @@ {code} bin/karaf {code} -You should see the following informations on the command line console: +You should see the following information on the command line console: {include:Karaf welcome screen} You can now run your first command. Simply type the {{}} key in the console. {code:borderStyle=solid} -karaf@root> +karaf@root> Display all 188 possibilities? (y or n) y +*:help addurl admin:change-opts +admin:change-rmi-registry-port admin:change-rmi-server-port admin:change-ssh-port +admin:connect admin:create admin:destroy +admin:list admin:rename admin:start +admin:stop bundle-level cancel +cat change-opts change-rmi-registry-port +change-rmi-server-port change-ssh-port clear +commandlist config:cancel config:delete +config:edit config:list config:propappend +config:propdel config:proplist config:propset +config:update connect create +create-dump delete destroy +dev:create-dump dev:dynamic-import dev:framework +dev:print-stack-traces dev:restart dev:show-tree +dev:watch display display-exception +dynamic-import each echo +edit exec exports +features:addurl features:info features:install +features:list features:listrepositories features:listurl +features:listversions features:refreshurl features:removerepository +features:removeurl features:uninstall framework +get grep head +headers help history +if imports info +install jaas:cancel jaas:commandlist +jaas:list jaas:manage jaas:roleadd +jaas:roledel jaas:update jaas:useradd +jaas:userdel jaas:userlist java +list listrepositories listurl +listversions log:clear log:display +log:display-exception log:get log:set +log:tail logout ls +manage more new +osgi:bundle-level osgi:headers osgi:info +osgi:install osgi:list osgi:ls +osgi:refresh osgi:resolve osgi:restart +osgi:shutdown osgi:start osgi:start-level +osgi:stop osgi:uninstall osgi:update +packages:exports packages:imports print-stack-traces +printf propappend propdel +proplist propset refresh +refreshurl removerepository removeurl +rename resolve restart +roleadd roledel set +shell:cat shell:clear shell:each +shell:echo shell:exec shell:grep +shell:head shell:history shell:if +shell:info shell:java shell:logout +shell:more shell:new shell:printf +shell:sleep shell:sort shell:source +shell:tac shell:tail show-tree +shutdown sleep sort +source ssh ssh:ssh +ssh:sshd sshd start +start-level stop tac +tail uninstall update +useradd userdel userlist +watch -admin:change-port admin:connect admin:create admin:destroy -admin:list admin:start admin:stop config:cancel -config:edit config:list config:propappend config:propdel -config:proplist config:propset config:update dev:dynamic-import -dev:framework dev:print-stack-traces dev:show-tree features:addUrl -features:info features:install features:list features:listUrl -features:refreshUrl features:removeUrl features:uninstall log:display -log:display-exception log:get log:set osgi:bundle-level -osgi:headers osgi:install osgi:list osgi:ls -osgi:refresh osgi:resolve osgi:restart osgi:shutdown -osgi:start osgi:start-level osgi:stop osgi:uninstall -osgi:update packages:exports packages:imports shell:cat -shell:clear shell:each shell:echo shell:exec -shell:grep shell:history shell:if shell:info -shell:java shell:logout shell:new shell:printf -shell:sleep shell:sort shell:tac ssh:ssh -ssh:sshd cat clear each -echo exec grep history -if info java logout -new printf sleep sort -tac bundle-level headers install -list ls refresh resolve -restart shutdown start start-level -stop uninstall update karaf@root> {code} @@ -117,7 +151,7 @@ h2. Deploy a sample application -While you will learn in the remainder of this guide how to use and leverage Apache Karaf, we will just use the pre-built packaging for now. +While you will learn in the Karaf user's guide how to fully use and leverage Apache Karaf, let's install a sample [Apache Camel|http://camel.apache.org] application for now: In the console, run the following commands: {code} @@ -125,7 +159,7 @@ features:install camel-example-osgi {code} -The example installed is using [Camel|http://camel.apache.org] to start a timer every 2 seconds and output a message on the console. +The example installed is using Camel to start a timer every 2 seconds and output a message on the console. The previous commands download the Camel features descriptor and install the example feature. {code} >>>> SpringDSL set body: Fri Jan 07 11:59:51 CET 2011 @@ -143,7 +177,9 @@ h3. Common Problems -# Launching Karaf can result in a deadlock in Felix during module dependency resolution. This is often a result of sending a SIGINT (control-C) to the process when it will not cleanly exit. This can corrupt the caches and cause startup problems in the very next launch. It is fixed by emptying the component cache: +# Launching Karaf can result in a deadlock in Felix during module dependency resolution. This is often a result +of sending a SIGINT (control-C) to the process when it will not cleanly exit. This can corrupt the caches +and cause startup problems in the very next launch. This problem can be fixed by emptying the component cache: {code} rm -rf data/cache/* {code} @@ -161,5 +197,6 @@ h2. Summary -This document showed you how simple it is to have Apache Karaf up and running. The overall time for getting the server running should be less than five minutes if you have the prerequisite (Java 1.5) already installed. Additionally, this article also showed you how to deploy and test a simple [Apache Camel|http://camel.apache.org] application in less than five minutes. +This document showed how simple it is to have Apache Karaf up and running. The overall time for getting the server running should be less than five minutes +if you have the prerequisite (Java 1.6) already installed. Additionally, this article also showed you how to deploy and test a simple Apache Camel application.