You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by cs...@apache.org on 2012/09/17 10:54:27 UTC
svn commit: r1386516 - in /karaf/trunk/manual/src/main/webapp: ./
users-guide/
Author: cschneider
Date: Mon Sep 17 08:54:27 2012
New Revision: 1386516
URL: http://svn.apache.org/viewvc?rev=1386516&view=rev
Log:
KARAF-1818 Lots of improvements to the user guide
Modified:
karaf/trunk/manual/src/main/webapp/quick-start.conf
karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf
karaf/trunk/manual/src/main/webapp/users-guide/http.conf
karaf/trunk/manual/src/main/webapp/users-guide/installation.conf
karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf
karaf/trunk/manual/src/main/webapp/users-guide/jre-tuning.conf
karaf/trunk/manual/src/main/webapp/users-guide/kar.conf
karaf/trunk/manual/src/main/webapp/users-guide/provisioning.conf
karaf/trunk/manual/src/main/webapp/users-guide/remote-console.conf
karaf/trunk/manual/src/main/webapp/users-guide/security.conf
karaf/trunk/manual/src/main/webapp/users-guide/start-stop.conf
karaf/trunk/manual/src/main/webapp/users-guide/using-console.conf
karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf
karaf/trunk/manual/src/main/webapp/users-guide/web-console.conf
Modified: karaf/trunk/manual/src/main/webapp/quick-start.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/quick-start.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/quick-start.conf (original)
+++ karaf/trunk/manual/src/main/webapp/quick-start.conf Mon Sep 17 08:54:27 2012
@@ -1,4 +1,4 @@
-h1. 1. Quick Start
+h1. Quick Start
This instructions should help you get Apache Karaf up and running in 5 to 15 minutes.
Modified: karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf Mon Sep 17 08:54:27 2012
@@ -1,24 +1,22 @@
-
-
h1. Configuration
-The files in the {{etc}} directory are used to set the startup configuration.
+All files in the {{etc}} directory that end with ".cfg" are loaded as config admin service pids. Changes to these config files are refelected in the config admin service.
-For dynamic configuration, Karaf provides a suite of command to administer the configuration service grouped under {{config}}. To learn about all currently supported configuration commands type:
+Karaf provides a suite of commands to work on any config admin service pid grouped under {{config}}. To learn about all currently supported configuration commands type:
|| Command || Description ||
-| [{{cancel}}|/commands/config-cancel] | Change the changes to the configuration being edited. |
-| [{{edit}}|/commands/config-edit] | Create or edit a configuration. |
-| [{{list}}|/commands/config-list] | List existing configurations. |
-| [{{propdel}}|/commands/config-propdel] | Delete a property from the edited configuration. |
-| [{{proplist}}|/commands/config-proplist] | List properties from the edited configuration. |
-| [{{propset}}|/commands/config-propset] | Set a property on the edited configuration. |
-| [{{update}}|/commands/config-update] | Save and propagate changes from the configuration being edited. |
+| [{{cancel}}|/commands/config-cancel] | Discard changes |
+| [{{edit}}|/commands/config-edit] | Create or edit a configuration |
+| [{{list}}|/commands/config-list] | List existing configurations |
+| [{{property-delete}}|/commands/config-property-delete] | Delete a property from the edited configuration |
+| [{{property-list}}|/commands/config-property-list] | List properties from the edited configuration |
+| [{{property-set}}|/commands/config-property-set] | Set a property on the edited configuration |
+| [{{update}}|/commands/config-update] | Save and propagate changes from the configuration being edited |
h2. Editing
-h3. Select Configuration To Edit
+h3. 1. Select configuration PID to edit
For example to edit configuration {{foo.bar}}:
@@ -26,26 +24,26 @@ For example to edit configuration {{foo.
karaf@root> config:edit foo.bar
{code}
-h3. Modify Properties
+h3. 2. Work on properties
-Use:
-
- * [{{config:proplist}}|/commands/config-proplist] to list existing properties
- * [{{config:propdel}}|/commands/config-propdel] to delete existing properties
- * [{{config:propset}}|/commands/config-propset] to set a new value for a property
+Use the property commands to work on the properties. Any number of properties can be modified within a single editing session.
-Any number of properties can be modified within a single editing session.
+h3. 3. Update or cancel the edit
-h3. Commit Or Rollback Changes
+ * [{{config:update}}|/commands/config-update] save all changes
+ * [{{config:cancel}}|/commands/config-cancel] discard all changes
-Use
+h3. Modify a single property
- * [{{config:update}}|/commands/config-update] to commit all changes made in the current session
- * [{{config:cancel}}|/commands/config-cancel] to roll back any changes made in the current session
+To change a single property and commit the change in one step use:
-h3. JMX
+{code}
+config:property-set -p <pid> <prop name> <value>
-Karaf also provides a Config MBean (org.apache.karaf:type=config) which allows quite the same actions that can
-be performed using the config:* commands.
+For example:
+config:property-set -p org.ops4j.pax.web org.osgi.service.http.port 8182
+{code}
+h3. JMX
+Karaf also provides a Config MBean (org.apache.karaf:type=config) which allows work on configs using JMX.
Modified: karaf/trunk/manual/src/main/webapp/users-guide/http.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/http.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/http.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/http.conf Mon Sep 17 08:54:27 2012
@@ -1,26 +1,30 @@
-h1. Pax Web (OSGi HttpService)
+h1. Http Service
-The Karaf http feature enables the Pax Web implementation of the OSGi HTTP service.
+The Karaf http feature enables the Pax Web implementation of the OSGi HTTPService.
h2. Installing the HTTP feature
{code}
-root@karaf> features:install http
+root@karaf> feature:install http
{code}
-Create a file {{etc/org.ops4j.pax.web.cfg}} with the following content:
+Test the HTTP service is up by pointing your browser to [http://localhost:8080/].
+
+h2. Configuring the HTTPService
+
+By default the HTTPService listens on port 8181 you can change the port by creating a file {{etc/org.ops4j.pax.web.cfg}} with the following content:
{code}
org.osgi.service.http.port=8080
{code}
-This tells Pax Web to listen to the port 8080. As soon as the http feature is installed and the config
-file is present, the following URL will be reachable:
-
+or by typing:
{code}
-http://localhost:8080/
+root@karaf> config:property-set -p org.ops4j.pax.web org.osgi.service.http.port 8080
{code}
+If the http feature is already installed the change will take effect immediately.
+
h2. Registering a servlet with the HttpService manually
See [Apache Felix HTTP Service|http://felix.apache.org/site/apache-felix-http-service.html].
@@ -52,4 +56,3 @@ So it is much more convenient than regis
The above snippet publishes the Servlet MyServlet on http://localhost:8080/myServlet.
Please keep in mind that the Whiteboard pattern for Servlets is not standardized and only works with Pax Web.
-
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=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/installation.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/installation.conf Mon Sep 17 08:54:27 2012
@@ -6,7 +6,7 @@ prerequisite software and necessary down
h2. Pre-Installation Requirements
*Hardware:*
-* 20 MB of free disk space for the Apache Karaf x.y binary distribution.
+* 20 MB of free disk space for the Apache Karaf binary distribution.
*Operating Systems:*
* Windows: Windows Vista, Windows XP SP2, Windows 2000.
@@ -16,12 +16,48 @@ h2. Pre-Installation Requirements
* 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.
+h2. Installation Procedure for Windows
+
+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.
+
+{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
+{noformat}
+subst S: "C:\your very % problematic path!\KARAF"
+{noformat}
+so your Karaf root directory is S: --- which works for sure and is short to type.
+{tip}
+
+h2. Installation Procedure For Unix
+
+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:
+{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.
+
+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.
+
h2. Building from Sources
If you intend to build Karaf from the sources, the requirements are a bit different:
*Hardware:*
-* 200 MB of free disk space for the Apache Karaf x.y source distributions or SVN checkout, the Maven build and the dependencies Maven downloads.
+* 200 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/]).
@@ -78,41 +114,3 @@ gunzip apache-karaf-x.y.tar.gz
tar xvf apache-karaf-x.y.tar
{code}
# Proceed to the [Starting Karaf|start-stop#Starting Karaf] chapter.
-
-h2. Installation Procedure for Windows
-
-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.
-# Optional: see [enabling Colorized Console Output On Windows|colorized-console]
-
-{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
-{noformat}
-subst S: "C:\your very % problematic path!\KARAF"
-{noformat}
-so your Karaf root directory is S: --- which works for sure and is short to type.
-{tip}
-
-h2. Installation Procedure For Unix
-
-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:
-{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.
-
-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.
-
Modified: karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf Mon Sep 17 08:54:27 2012
@@ -6,6 +6,26 @@ Apache Karaf provides a large set of MBe
You can find more or less the same actions that you can do using the shell commands on the JMX layer.
+h2. Connecting
+
+To connect to local karaf instances just start jconsole. It should list the local karaf instances as "org.apache.karaf.main.Main" and allow you to connect to them.
+
+To connect to your running remote Karaf instance via JMX you can use the following URL:
+{code}
+service:jmx:rmi://localhost:44444/jndi/rmi://localhost:1099/karaf-root
+{code}
+Make sure to use the credentials you are also using to connect to via SSH
+
+If you are connecting to another instance of your Karaf the following will give you an impression on how this might be configured.
+
+{code}
+service:jmx:rmi://localhost:${rmiServerPort}/jndi/rmi://localhost:${rmiRegistryPort}/karaf-${karaf.name}
+{code}
+
+The ports and the Karaf instance name are configured in the org.apache.karaf.managment.cfg file in /etc.
+
+h2. MBeans
+
Apache Karaf provides the following MBeans:
* org.apache.karaf:type=admin to administrate the child instances
Modified: karaf/trunk/manual/src/main/webapp/users-guide/jre-tuning.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/jre-tuning.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/jre-tuning.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/jre-tuning.conf Mon Sep 17 08:54:27 2012
@@ -1,333 +1,14 @@
+h1. System bundle exports
+One important duty of the system bundle is to export some packages of the jre. In Karaf this is configured in etc/jre.properties.
-h1. JRE and system packages tuning
+It contains a property for each supported jre like "jre-1.6=". The value is a comma separated list of all packages the system bundle should export. For most cases the defaults are fine.
-Some packages are part of the JRE, but could be provided by tier libraries.
+h2. When to change the exported packages
-Some examples of package in this case are:
-* {{javax.xml.stream}} package is provided by the JRE, but also by Apache Geronimo Spec bundles (and the implementation of provided by Woodstox).
-* {{com.sun.org.apache.xerces.internal.dom}} package is provided by the JRE, but also by Apache Xerces.
-* {{javax.activation}} package is provided by the JRE, but also by Apache Geronimo Spec bundles.
-* {{javax.annotation}} package is provided by the JRE, but also by Apache Geronimo Spec bundles.
-* etc ...
+Typically the exported packages have to be tuned if a bundle should replace them. So for example when installing woodstox you may want to remove the export of {{javax.xml.stream}} so the package
+exported by the woodstox bundle is the only one exporting this package.
-We should define in the Karaf instance which packages should be provided by the JRE or by tier bundles.
+h2. Changes needed for CXF and Camel
-Moreover, we should manage the exported packages of JRE depending of the JRE version: the JRE 1.6 provides more packages
-than the 1.5 one.
-
-To customize this in Karaf, you can tune the {{etc/jre.properties}} file.
-
-In the {{etc/jre.properties}} file, you have two properties {{jre-1.5}} and {{jre-1.6}}.
-
-They allow you to define the packages exported by the JRE (in function of the runtime version).
-Each property provide the exhaustive list of packages provided by the JRE (and so part of the sytem packages).
-
-For instance, a "standard" Karaf distribution provides the following {{etc/jre.properties}}:
-
-{code}
-#
-# Java platform package export properties.
-#
-
-# Standard package set. Note that:
-# - javax.transaction* is exported with a mandatory attribute
-jre-1.5= \
- javax.accessibility, \
- javax.activity, \
- javax.crypto, \
- javax.crypto.interfaces, \
- javax.crypto.spec, \
- javax.imageio, \
- javax.imageio.event, \
- javax.imageio.metadata, \
- javax.imageio.plugins.bmp, \
- javax.imageio.plugins.jpeg, \
- javax.imageio.spi, \
- javax.imageio.stream, \
- javax.management, \
- javax.management.loading, \
- javax.management.modelmbean, \
- javax.management.monitor, \
- javax.management.openmbean, \
- javax.management.relation, \
- javax.management.remote, \
- javax.management.remote.rmi, \
- javax.management.timer, \
- javax.naming, \
- javax.naming.directory, \
- javax.naming.event, \
- javax.naming.ldap, \
- javax.naming.spi, \
- javax.net, \
- javax.net.ssl, \
- javax.print, \
- javax.print.attribute, \
- javax.print.attribute.standard, \
- javax.print.event, \
- javax.rmi, \
- javax.rmi.CORBA, \
- javax.rmi.ssl, \
- javax.security.auth, \
- javax.security.auth.callback, \
- javax.security.auth.kerberos, \
- javax.security.auth.login, \
- javax.security.auth.spi, \
- javax.security.auth.x500, \
- javax.security.cert, \
- javax.security.sasl, \
- javax.sound.midi, \
- javax.sound.midi.spi, \
- javax.sound.sampled, \
- javax.sound.sampled.spi, \
- javax.sql, \
- javax.sql.rowset, \
- javax.sql.rowset.serial, \
- javax.sql.rowset.spi, \
- javax.swing, \
- javax.swing.border, \
- javax.swing.colorchooser, \
- javax.swing.event, \
- javax.swing.filechooser, \
- javax.swing.plaf, \
- javax.swing.plaf.basic, \
- javax.swing.plaf.metal, \
- javax.swing.plaf.multi, \
- javax.swing.plaf.synth, \
- javax.swing.table, \
- javax.swing.text, \
- javax.swing.text.html, \
- javax.swing.text.html.parser, \
- javax.swing.text.rtf, \
- javax.swing.tree, \
- javax.swing.undo, \
- javax.transaction; javax.transaction.xa; partial=true; mandatory:=partial, \
- javax.xml, \
- javax.xml.datatype, \
- javax.xml.namespace, \
- javax.xml.parsers, \
- javax.xml.transform, \
- javax.xml.transform.dom, \
- javax.xml.transform.sax, \
- javax.xml.transform.stream, \
- javax.xml.validation, \
- javax.xml.xpath, \
- org.ietf.jgss, \
- org.omg.CORBA, \
- org.omg.CORBA_2_3, \
- org.omg.CORBA_2_3.portable, \
- org.omg.CORBA.DynAnyPackage, \
- org.omg.CORBA.ORBPackage, \
- org.omg.CORBA.portable, \
- org.omg.CORBA.TypeCodePackage, \
- org.omg.CosNaming, \
- org.omg.CosNaming.NamingContextExtPackage, \
- org.omg.CosNaming.NamingContextPackage, \
- org.omg.Dynamic, \
- org.omg.DynamicAny, \
- org.omg.DynamicAny.DynAnyFactoryPackage, \
- org.omg.DynamicAny.DynAnyPackage, \
- org.omg.IOP, \
- org.omg.IOP.CodecFactoryPackage, \
- org.omg.IOP.CodecPackage, \
- org.omg.Messaging, \
- org.omg.PortableInterceptor, \
- org.omg.PortableInterceptor.ORBInitInfoPackage, \
- org.omg.PortableServer, \
- org.omg.PortableServer.CurrentPackage, \
- org.omg.PortableServer.POAManagerPackage, \
- org.omg.PortableServer.POAPackage, \
- org.omg.PortableServer.portable, \
- org.omg.PortableServer.ServantLocatorPackage, \
- org.omg.SendingContext, \
- org.omg.stub.java.rmi, \
- org.omg.stub.javax.management.remote.rmi, \
- org.w3c.dom, \
- org.w3c.dom.bootstrap, \
- org.w3c.dom.css, \
- org.w3c.dom.events, \
- org.w3c.dom.html, \
- org.w3c.dom.ls, \
- org.w3c.dom.ranges, \
- org.w3c.dom.stylesheets, \
- org.w3c.dom.traversal, \
- org.w3c.dom.views, \
- org.xml.sax, \
- org.xml.sax.ext, \
- org.xml.sax.helpers
-
-# Standard package set. Note that:
-# - javax.transaction* is exported with a mandatory attribute
-jre-1.6= \
- javax.accessibility, \
- javax.activation, \
- javax.activity, \
- javax.annotation, \
- javax.annotation.processing, \
- javax.crypto, \
- javax.crypto.interfaces, \
- javax.crypto.spec, \
- javax.imageio, \
- javax.imageio.event, \
- javax.imageio.metadata, \
- javax.imageio.plugins.bmp, \
- javax.imageio.plugins.jpeg, \
- javax.imageio.spi, \
- javax.imageio.stream, \
- javax.jws, \
- javax.jws.soap, \
- javax.lang.model, \
- javax.lang.model.element, \
- javax.lang.model.type, \
- javax.lang.model.util, \
- javax.management, \
- javax.management.loading, \
- javax.management.modelmbean, \
- javax.management.monitor, \
- javax.management.openmbean, \
- javax.management.relation, \
- javax.management.remote, \
- javax.management.remote.rmi, \
- javax.management.timer, \
- javax.naming, \
- javax.naming.directory, \
- javax.naming.event, \
- javax.naming.ldap, \
- javax.naming.spi, \
- javax.net, \
- javax.net.ssl, \
- javax.print, \
- javax.print.attribute, \
- javax.print.attribute.standard, \
- javax.print.event, \
- javax.rmi, \
- javax.rmi.CORBA, \
- javax.rmi.ssl, \
- javax.script, \
- javax.security.auth, \
- javax.security.auth.callback, \
- javax.security.auth.kerberos, \
- javax.security.auth.login, \
- javax.security.auth.spi, \
- javax.security.auth.x500, \
- javax.security.cert, \
- javax.security.sasl, \
- javax.sound.midi, \
- javax.sound.midi.spi, \
- javax.sound.sampled, \
- javax.sound.sampled.spi, \
- javax.sql, \
- javax.sql.rowset, \
- javax.sql.rowset.serial, \
- javax.sql.rowset.spi, \
- javax.swing, \
- javax.swing.border, \
- javax.swing.colorchooser, \
- javax.swing.event, \
- javax.swing.filechooser, \
- javax.swing.plaf, \
- javax.swing.plaf.basic, \
- javax.swing.plaf.metal, \
- javax.swing.plaf.multi, \
- javax.swing.plaf.synth, \
- javax.swing.table, \
- javax.swing.text, \
- javax.swing.text.html, \
- javax.swing.text.html.parser, \
- javax.swing.text.rtf, \
- javax.swing.tree, \
- javax.swing.undo, \
- javax.tools, \
- javax.transaction; javax.transaction.xa; partial=true; mandatory:=partial, \
- javax.xml, \
- javax.xml.bind, \
- javax.xml.bind.annotation, \
- javax.xml.bind.annotation.adapters, \
- javax.xml.bind.attachment, \
- javax.xml.bind.helpers, \
- javax.xml.bind.util, \
- javax.xml.crypto, \
- javax.xml.crypto.dom, \
- javax.xml.crypto.dsig, \
- javax.xml.crypto.dsig.dom, \
- javax.xml.crypto.dsig.keyinfo, \
- javax.xml.crypto.dsig.spec, \
- javax.xml.datatype, \
- javax.xml.namespace, \
- javax.xml.parsers, \
- javax.xml.soap, \
- javax.xml.stream, \
- javax.xml.stream.events, \
- javax.xml.stream.util, \
- javax.xml.transform, \
- javax.xml.transform.dom, \
- javax.xml.transform.sax, \
- javax.xml.transform.stax, \
- javax.xml.transform.stream, \
- javax.xml.validation, \
- javax.xml.ws, \
- javax.xml.ws.handler, \
- javax.xml.ws.handler.soap, \
- javax.xml.ws.http, \
- javax.xml.ws.soap, \
- javax.xml.ws.spi, \
- javax.xml.ws.wsaddressing, \
- javax.xml.xpath, \
- org.ietf.jgss, \
- org.omg.CORBA, \
- org.omg.CORBA_2_3, \
- org.omg.CORBA_2_3.portable, \
- org.omg.CORBA.DynAnyPackage, \
- org.omg.CORBA.ORBPackage, \
- org.omg.CORBA.portable, \
- org.omg.CORBA.TypeCodePackage, \
- org.omg.CosNaming, \
- org.omg.CosNaming.NamingContextExtPackage, \
- org.omg.CosNaming.NamingContextPackage, \
- org.omg.Dynamic, \
- org.omg.DynamicAny, \
- org.omg.DynamicAny.DynAnyFactoryPackage, \
- org.omg.DynamicAny.DynAnyPackage, \
- org.omg.IOP, \
- org.omg.IOP.CodecFactoryPackage, \
- org.omg.IOP.CodecPackage, \
- org.omg.Messaging, \
- org.omg.PortableInterceptor, \
- org.omg.PortableInterceptor.ORBInitInfoPackage, \
- org.omg.PortableServer, \
- org.omg.PortableServer.CurrentPackage, \
- org.omg.PortableServer.POAManagerPackage, \
- org.omg.PortableServer.POAPackage, \
- org.omg.PortableServer.portable, \
- org.omg.PortableServer.ServantLocatorPackage, \
- org.omg.SendingContext, \
- org.omg.stub.java.rmi, \
- org.omg.stub.javax.management.remote.rmi, \
- org.w3c.dom, \
- org.w3c.dom.bootstrap, \
- org.w3c.dom.css, \
- org.w3c.dom.events, \
- org.w3c.dom.html, \
- org.w3c.dom.ls, \
- org.w3c.dom.ranges, \
- org.w3c.dom.stylesheets, \
- org.w3c.dom.traversal, \
- org.w3c.dom.views, \
- org.w3c.dom.xpath, \
- org.xml.sax, \
- org.xml.sax.ext, \
- org.xml.sax.helpers
-{code}
-
-For instance, if we deploy the Apache Geronimo Specs bundle providing the {{javax.xml.stream}} package, we have to comment
-the {{javax.xml.stream}} package in the the jre-1.6 definition. Indeed, jre-1.5 doesn't provide {{javax.xml.stream}}, it's
-new in the JRE 1.6:
-
-{code}
-jre-1.6= \
-[...]
-# javax.xml.stream, \
-# javax.xml.stream.events, \
-# javax.xml.stream.util, \
-[...]
-{code}
\ No newline at end of file
+In Karaf versions before 2.3.x we shipped a special version of the jre.properties named jre.properties.cxf that should be copied to jre.properties when using Camel or CXF. From Karaf 2.3 on this is not necessary anymore.
Modified: karaf/trunk/manual/src/main/webapp/users-guide/kar.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/kar.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/kar.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/kar.conf Mon Sep 17 08:54:27 2012
@@ -14,7 +14,18 @@ For instance, a kar looks like:
all packaged in zip format.
-h2. Create a kar archive
+h2. Create a kar archive from the console
+
+Example:
+{code}
+feature:repo-add camel 2.10.0
+kar:create camel-2.10.0
+{code}
+
+This will create a kar of all camel features and store it in data/kar. It is also possible to specify a list of features to pack into the kar.
+This aproach is ideal if you want to use e.g. camel in an environment without internet connection.
+
+h2. Create a kar archive using maven
You can create a kar file by hand, just by zip compressing a directory representing the kar content.
@@ -110,3 +121,6 @@ Now you can use any commands available o
{code}
karaf@root> feature:install my
{code}
+
+h2. Kar structure
+
Modified: karaf/trunk/manual/src/main/webapp/users-guide/provisioning.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/provisioning.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/provisioning.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/provisioning.conf Mon Sep 17 08:54:27 2012
@@ -1,14 +1,59 @@
-
h1. Provisioning
-Karaf provides a simple, yet flexible, way to provision applications or "features". Such a mechanism is mainly provided by a set of commands available in the {{features}} shell. The provisioning system uses xml "repositories" that define a set of features.
+Karaf provides a simple, yet flexible, way to provision applications or "features". Such a mechanism is mainly provided by a set of commands available in the {{feature}} shell. The provisioning system uses xml "repositories" that define a set of features.
+
+h2. Commands
+
+h3. Repository management
+
+The following commands can be used to manage the list of descriptors known by Karaf. They use URLs pointing to features descriptors. These URLs can use any protocol known to the Apache Karaf, the most common ones being http, file and mvn.
+
+|| Command || Description ||
+| feature:repo-add | Add a list of repository URLs to the features service |
+| feature:repo-remove | Remove a list of repository URLs from the features service |
+| feature:repo-list | Display the repository URLs currently associated with the features service |
+
+Karaf maintains a persistent list of these repositories so that if you add one URL and restart Karaf, the features will still be available.
+
+h3. Features management
+
+|| Command || Description ||
+| feature:install | Install a named feature |
+| feature:uninstall | Uninstall a named feature |
+| feature:list | List installed or all fatures |
+
+h3. Examples
+
+1. Install features using mvn handler
+{code}
+feature:repo-add mvn:org.apache.servicemix.nmr/apache-servicemix-nmr/1.0.0-m2/xml/features
+feature:install nmr
+{code}
+
+2. Use file handler to deploy features file
+{code}
+feature:repo-add file:base/features/features.xml
+{code}
+
+Note: The path is relative to the Apache Karaf installation directory
+
+h2. Configuation of the features to start on a clean startup
+
+The startup of karaf is different depending on the state of the data dir. If the data dir is clean Karaf will start certain features. On a restart it will then only start the already installed bundles.
+
+The clean startup behaviour can be configured in the file {{\[FELIX:karaf\]/etc/org.apache.karaf.features.cfg}}
+This configuration file contains two properties:
+* {{featuresBoot}}: a comma separated list of features to install at startup
+* {{featuresRepositories}}: a comma separated list of feature repositories to load at startup
+
+This configuration file is of interest if you plan to distribute a customized Karaf distribution having pre-installed features.
+Such a process is detailed in the [6.2. Building custom distributions] section.
h2. Repositories
The complete xml schema for feature descriptor are available on [Features XML Schema|provisioning-schema] page. We recommend using this XML schema. It will allow Karaf to validate your repository before parsing. You may also verify your descriptor before adding it to Karaf by simply validation, even from IDE level.
-
Here is an example of such a repository:
{code:lang=xml}
<features xmlns="http://karaf.apache.org/xmlns/features/v1.0.0">
@@ -51,47 +96,33 @@ Doing this will make sure the above bund
However, Karaf provides several URL handlers, in addition to the usual ones (file, http, etc...). One of these is the Maven URL handler, which allow reusing maven repositories to point to the bundles.
+You can deploy bundles from file system without using Maven
+
+As we can use file: as protocol handler to deploy bundles, you can use the following syntax to deploy bundles when they are
+located in a directory which is not available using Maven
+
+{code:lang=xml}
+<bundle>file:base/bundles/org.apache.servicemix.nmr.api-1.0.0-m2.jar</bundle>
+{code}
+
+Note: The path is relative to the Apache Karaf installation directory
+
h4. Maven URL Handler
The equivalent of the above bundle would be:
-{code}
+{code:lang=xml}
<bundle>mvn:org.apache.servicemix.nmr/org.apache.servicemix.nmr.api/1.0.0-m2</bundle>
{code}
-In addition to being less verbose, the Maven url handlers can also resolve snapshots and can use a local copy of the jar if one is available in your Maven local repository.
-
-The {{org.ops4j.pax.url.mvn}} bundle resolves {{mvn}} URLs. This flexible tool can be configured through the configuration service. For example, to find the current repositories type:
-{code}
-karaf@root:/> config:list
-...
-----------------------------------------------------------------
-Pid: org.ops4j.pax.url.mvn
-BundleLocation: mvn:org.ops4j.pax.url/pax-url-mvn/0.3.3
-Properties:
- service.pid = org.ops4j.pax.url.mvn
- org.ops4j.pax.url.mvn.defaultRepositories = file:/opt/development/karaf/assembly/target/apache-felix-karaf-1.2.0-SNAPSHOT/system@snapshots
- org.ops4j.pax.url.mvn.repositories = http://repo1.maven.org/maven2,
- http://svn.apache.org/repos/asf/servicemix/m2-repo
- below = list of repositories and even before the local repository
-{code}
+In addition to being less verbose, the Maven url handlers can also resolve snapshots and can use a local copy of the jar if one is available in your Maven local repository.
-The repositories checked are controlled by these configuration properties.
+The {{org.ops4j.pax.url.mvn}} bundle resolves {{mvn}} URLs. It can be configured using the file {{etc/org.ops4j.pax.url.cfg}}
-For example, {{org.ops4j.pax.url.mvn.repositories}} is a comma separate list of repository URLs specifying those remote repositories to be checked. So, to replace the defaults with a new repository at {{http://www.example.org/repo}} on the local machine:
+The most important property is :
-{code}
-karaf@root:/> config:edit org.ops4j.pax.url.mvn
-karaf@root:/> config:proplist
- service.pid = org.ops4j.pax.url.mvn
- org.ops4j.pax.url.mvn.defaultRepositories = file:/opt/development/karaf/assembly/target/apache-felix-karaf-1.2.0-SNAPSHOT/system@snapshots
- org.ops4j.pax.url.mvn.repositories = http://repo1.maven.org/maven2,
- http://svn.apache.org/repos/asf/servicemix/m2-repo
- below = list of repositories and even before the local repository
-karaf@root:/> config:propset org.ops4j.pax.url.mvn.repositories http://www.example.org/repo
-karaf@root:/> config:update
-{code}
+* {{org.ops4j.pax.url.mvn.repositories}} : Comma separated list of repository remote repository URLs that are checked in order of occurence when resolving maven artifacts
-By default, snapshots are disabled. To enable an URL for snapshots append @snapshots. For example
+By default, snapshots are disabled. To enable an URL for snapshots append @snapshots to a repository entry. For example
{code}
http://www.example.org/repo@snapshots
@@ -101,8 +132,6 @@ Repositories on the local machine are su
h4. Bundle start-level
-*Available since Karaf 2.0*
-
By default, the bundles deployed through the feature mechanism will have a start-level equals to the value defined in the configuration file {{config.properties}}
with the variable {{karaf.startlevel.bundle=60}}. This value can be changed using the xml attribute start-level.
@@ -115,8 +144,8 @@ with the variable {{karaf.startlevel.bun
</feature>
{code}
-The advantage in defining the bundle start-level is that you can deploy all your bundles including any required 'infrastructure' bundles required (e.g. Camel, ActiveMQ)
-at the same time and you will have the guarantee when using Spring Dynamic Modules or Blueprint that the Spring context will not be created without all the required services installed.
+The start-level property allows to make sure infrastructure bundles are loaded before the bundles that use them. Be aware though that this is not the recommended way to structure your dependencies.
+The better solution is to simply let the OSGi framework know what your dependencies are by defining the packages or services you need as this is more robust than setting start levels.
h4. Bundle 'stop/start'
@@ -226,70 +255,3 @@ The default resolver will simply return
The OBR resolver can be installed and used instead of the standard one. In that case, the resolver will use the OBR service
to determine the list of bundles to install (bundles flagged as dependency will only be used as possible candidates to
solve various constraints).
-
-h2. Commands
-
-h3. Repository management
-
-The following commands can be used to manage the list of descriptors known by Karaf. They use URLs pointing to features descriptors. These URLs can use any protocol known to the Apache Karaf, the most common ones being http, file and mvn.
-
-{code}
-features:addUrl Add a list of repository URLs to the features service
-features:removeUrl Remove a list of repository URLs from the features service
-features:listUrl Display the repository URLs currently associated with the features service.
-features:refreshUrl Reload the repositories to obtain a fresh list of features
-{code}
-
-Karaf maintains a persistent list of these repositories so that if you add one URL and restart Karaf, the features will still be available.
-
-The {{refreshUrl}} command is mostly used when developing features descriptors: when changing the descriptor, it can be handy to reload it in the Kernel without having to restart it or to remove then add this URL again.
-
-h3. Features management
-
-{code}
-features:install
-features:uninstall
-features:list
-{code}
-
-h3. Examples
-
-1. Install features using mvn handler
-{code}
-features:addUrl mvn:org.apache.servicemix.nmr/apache-servicemix-nmr/1.0.0-m2/xml/features
-features:install nmr
-{code}
-
-2. Use file handler to deploy features file
-{code}
-features:addUrl file:base/features/features.xml
-{code}
-
-Note: The path is relative to the Apache Karaf installation directory
-
-3. Deploy bundles from file system without using Maven
-
-As we can use file:// as protocol handler to deploy bundles, you can use the following syntax to deploy bundles when they are
-located in a directory which is not available using Maven
-
-{code:xml}
-<features xmlns="http://karaf.apache.org/xmlns/features/v1.0.0">
- <feature name="spring-web" version="2.5.6.SEC01">
- <bundle>file:base/bundles/spring-web-2.5.6.SEC01.jar</bundle>
- </feature>
-</features>
-{code}
-
-Note: The path is relative to the Apache Karaf installation directory
-
-h2. Service configuration
-
-A simple configuration file located in {{\[FELIX:karaf\]/etc/org.apache.karaf.features.cfg}} can be modified to customize the behavior when starting the Kernel for the first time.
-This configuration file contains two properties:
-* {{featuresBoot}}: a comma separated list of features to install at startup
-* {{featuresRepositories}}: a comma separated list of feature repositories to load at startup
-
-This configuration file is of interest if you plan to distribute a customized Karaf distribution having pre-installed features.
-Such a process is detailed in the [6.2. Building custom distributions] section.
-
-
Modified: karaf/trunk/manual/src/main/webapp/users-guide/remote-console.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/remote-console.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/remote-console.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/remote-console.conf Mon Sep 17 08:54:27 2012
@@ -1,8 +1,8 @@
h1. Using remote instances
-h2. Configuring remote instances
+h2. Configuring ssh access
-It does not always make sense to manage an instance of Karaf using its local console. You can manage Karaf remotely using a remote console.
+It does not always make sense to manage an instance of Karaf using its local console. You can manage Karaf remotely using a the ssh console.
When you start Karaf, it enables a remote console that can be accessed over SSH from any other Karaf console or plain SSH client. The remote console provides all the features of the local console and gives a remote user complete control over the container and services running inside of it.
@@ -18,18 +18,11 @@ hostKey=${karaf.base}/etc/host.key
You can change this configuration using the [config commands|configuration] or by editing the above file, but you'll need to restart the ssh console in order for it to use the new parameters.
{code}
-# define helper functions
-bundle-by-sn = { bm = new java.util.HashMap ; each (bundles) { $bm put ($it symbolicName) $it } ; $bm get $1 }
-bundle-id-by-sn = { b = (bundle-by-sn $1) ; if { $b } { $b bundleId } { -1 } }
-# edit config
-config:edit org.apache.karaf.shell
-config:propset sshPort 8102
-config:update
-# force a restart
-bundle:restart --force (bundle-id-by-sn org.apache.karaf.shell.ssh)
+config:property-set -p org.apache.karaf.shell sshPort 8102
+bundle:restart -f org.apache.karaf.shell.ssh
{code}
-h2. Connecting and disconnecting remotely
+h2. Connecting remotely
h3. Using the {{ssh:ssh}} command
@@ -47,24 +40,23 @@ To confirm that you have connected to th
{code}
Karaf
- Karaf home /local/apache-karaf-2.0.0
- Karaf base /local/apache-karaf-2.0.0
- OSGi Framework org.eclipse.osgi - 3.5.1.R35x_v20090827
-JVM
- Java Virtual Machine Java HotSpot(TM) Server VM version 14.1-b02
+ Karaf version 3.0.0-SNAPSHOT
+ Karaf home C:\java\apache-karaf-3.0.0-SNAPSHOT
+ Karaf base C:\java\apache-karaf-3.0.0-SNAPSHOT
+ OSGi Framework org.apache.felix.framework - 4.0.3
...
{code}
h3. Using the Karaf client
-The Karaf client allows you to securely connect to a remote Karaf instance without having to launch a Karaf instance locally.
+The Karaf client allows to securely connect to a running local or remote Karaf instance.
For example, to quickly connect to a Karaf instance running in server mode on the same machine, run the following command from the {{[karaf-install-dir]}} directory:
{code}
bin/client
{code}
-More commonly, you would provide a hostname, port, username and password to connect to a remote instance. And, if you were using the client within a larger script, you could append console commands as follows:
+To connect to remote instances provide a hostname, port, username and password. It is also possible to append console commands as follows:
{code}
bin/client -a 8101 -h hostname -u karaf -p karaf features:install wrapper
{code}
@@ -97,23 +89,6 @@ h3. Disconnecting from a remote console
To disconnect from a remote console, press {{Ctrl+D}}, {{shell:logout}} or simply {{logout}} at the Karaf prompt.
-h3. Using a JConsole or Java VisualVM
-
-Another way of configuring or controlling your running Karaf is to use JConsole or Java VisualVM.
-To connect to your running Karaf instance via JMX you can use the following URL:
-{code}
-service:jmx:rmi://localhost:44444/jndi/rmi://localhost:1099/karaf-root
-{code}
-Make sure to use the credentials you are also using to connect to via SSH
-
-If you are connecting to another instance of your Karaf the following will give you an impression on how this might be configured.
-
-{code}
-service:jmx:rmi://localhost:${rmiServerPort}/jndi/rmi://localhost:${rmiRegistryPort}/karaf-${karaf.name}
-{code}
-
-The ports and the Karaf instance name are configured in the org.apache.karaf.managment.cfg file in /etc.
-
h2. Stopping a remote instance
h3. Using the remote console
@@ -129,4 +104,4 @@ h3. Using the karaf client
To stop a remote instance using the Karaf client, run the following from the {{[karaf-install-dir]/lib}} directory:
{code}
bin/client -u karaf -p karaf -a 8101 hostname system:shutdown
-{code}
\ No newline at end of file
+{code}
Modified: karaf/trunk/manual/src/main/webapp/users-guide/security.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/security.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/security.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/security.conf Mon Sep 17 08:54:27 2012
@@ -40,12 +40,8 @@ In order to not keep the passwords in pl
This can be easily enabled using the following commands:
{code}
-# edit config
-config:edit org.apache.karaf.jaas
-config:propset encryption.enabled true
-config:update
-# force a restart
-dev:restart
+config:propset -p org.apache.karaf.jaas encryption.enabled true
+system:shutdown -r -f
{code}
The passwords will be encrypted automatically in the {{etc/users.properties}} configuration file the first time the user logs in.
Modified: karaf/trunk/manual/src/main/webapp/users-guide/start-stop.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/start-stop.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/start-stop.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/start-stop.conf Mon Sep 17 08:54:27 2012
@@ -1,6 +1,6 @@
h1. Starting and Stopping Karaf
-This chapter describes how to start and stop Apache Karaf and the various options that are available.
+This chapter describes how to start and stop Apache Karaf from the command line as well as from the Karaf console.
h2. Starting Karaf
@@ -31,7 +31,7 @@ bin/karaf
{code}
{warning:title=Warning}
-Do NOT close the console or shell in which Karaf was started, as that will terminate Karaf (unless Karaf was started with nohup).
+Closing the console or shell window will cause karaf to terminate.
{warning}
h2. Starting Karaf without console
@@ -68,18 +68,10 @@ h2. Stopping Karaf
For both Windows and Unix installations, you can perform a clean shutdown of Karaf by using the following command when inside a Karaf console:
{code}
-system:shutdown
+shutdown -f
{code}
-or simply:
-{code}
-shutdown
-{code}
-
-The shutdown command asks you to confirm that you really want to shutdown. If you are sure about the shutdown wish to avoid the confirmation message, you can use the -f or --force option:
-{code}
-system:shutdown -f
-{code}
+The shutdown command has several options you can use to change the behaviour. See [commands/shutdown].
It's also possible to delay the shutdown using the time argument. The time argument can have different formats. First, it can be an absolute time in the format hh:mm, in which hh is the hour (1 or 2 digits) and mm is the minute of the hour (in two digits). Second, it can be in the format +m, in which m is the number of minutes to wait. The work now is an alias for +0.
Modified: karaf/trunk/manual/src/main/webapp/users-guide/using-console.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/using-console.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/using-console.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/using-console.conf Mon Sep 17 08:54:27 2012
@@ -2,34 +2,24 @@ h1. Using the console
h2. Viewing available commands
-To see a list of the available commands in the console press the {{<tab>}} key at the prompt.
+To see a list of the available commands in the console enter
+{code}
+help
+{code}
+
+This will show the list of all karaf commands together with a short description.
+
+The list of all karaf commands and their usage is also available in the [Commands section|/commands/commands].
+
+h2. Tab completion
+
+The Karaf shell offers Tab completion at almost any place in the shell. So another way to see all commands is to {{<tab>}} key at the empty prompt.
{code}
karaf@root> Display all 208 possibilities? (y or n)
add-role add-url add-user addbundle addfilter addregion append-property bundle:capabilities
bundle:headers bundle:info bundle:install bundle:list bundle:refresh bundle:requirements bundle:resolve bundle:restart
-bundle:services bundle:start bundle:start-level bundle:stop bundle:uninstall bundle:update cancel capabilities
-cat change-opts change-rmi-registry-port change-rmi-server-port change-ssh-port chooseurl cl clear
-clone command-watch config:append-property config:cancel config:delete config:delete-property config:edit config:list
-config:list-property config:set-property config:update connect create create-dump delete delete-property
-delete-role delete-user destroy dev:create-dump dev:dynamic-import dev:framework dev:print-stack-traces dev:show-tree
-dev:system-property dev:watch display display-exception dynamic-import each echo edit
-exec feature:add-url feature:chooseurl feature:info feature:install feature:list feature:list-repository feature:list-url
-feature:list-version feature:refresh-url feature:remove-repository feature:remove-url feature:uninstall framework get grep
-head headers history if info install instance:change-opts instance:change-rmi-registry-port
-instance:change-rmi-server-port instance:change-ssh-port instance:clone instance:connect instance:create instance:destroy instance:list instance:rename
-instance:start instance:stop jaas:add-role jaas:add-user jaas:cancel jaas:delete-role jaas:delete-user jaas:list-pending
-jaas:list-realm jaas:list-user jaas:manage-realm jaas:update java la ld lde
-list list-pending list-property list-realm list-repository list-url list-user list-version
-log:clear log:display log:display-exception log:get log:set log:tail logout manage-realm
-more new print-stack-traces printf refresh refresh-url region:addbundle region:addfilter
-region:addregion region:info remove-repository remove-url rename requirements resolve restart
-service:list service:wait services set set-property shell:cat shell:clear shell:command-watch
-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 system-property system:shutdown
-system:start-level tac tail uninstall update wait watch
+...
karaf@root>
{code}
@@ -57,12 +47,8 @@ OPTIONS
Display a list of all installed features only
{code}
-
h2. More...
-The list of all available commands and their usage is also available in a [dedicated section|/commands/commands].
-
You'll find a more in-depth guide to the shell syntax in the [developers guide|/developers-guide/shell-syntax].
The console can also be easily extended by creating new commands as explained in the [developers guide|/developers-guide/extending-console].
-
Modified: karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf Mon Sep 17 08:54:27 2012
@@ -1,99 +1,36 @@
-
h1. Web applications
h2. Installing war support
-The following steps will install the "war" feature (support for deploying WAR files with Servlet and JSPs into a Jetty server) into your Karaf instance.
-# List the available features -
-{noformat}
-karaf@root> features:list
- State Name
-. . .
-[uninstalled] [3.0.0] obr karaf-3.0.0
-[uninstalled] [3.0.0] config karaf-3.0.0
-[uninstalled] [3.0.0] http karaf-3.0.0
-[uninstalled] [3.0.0] war karaf-3.0.0
-[uninstalled] [3.0.0] webconsole karaf-3.0.0
-[installed ] [3.0.0] ssh karaf-3.0.0
-. . .
-{noformat}
-# Install the war feature (and the sub-features it requires) -
+Install the war feature (and the sub-features it requires) -
{noformat}
karaf@root> features:install war
{noformat}
-Note: you can use the -v or --verbose option to see exactly what Karaf does
-{noformat}
-karaf@root> features:install -v war
-Installing feature war 3.0.0
-Installing feature http 3.0.0
-Installing feature jetty 7.1.6.v20100715
-Installing bundle mvn:org.apache.geronimo.specs/geronimo-servlet_2.5_spec/1.1.2
-Found installed bundle: org.apache.servicemix.bundles.asm [10]
-Installing bundle mvn:org.eclipse.jetty/jetty-util/7.1.6.v20100715
-Installing bundle mvn:org.eclipse.jetty/jetty-io/7.1.6.v20100715
-Installing bundle mvn:org.eclipse.jetty/jetty-http/7.1.6.v20100715
-Installing bundle mvn:org.eclipse.jetty/jetty-continuation/7.1.6.v20100715
-Installing bundle mvn:org.eclipse.jetty/jetty-server/7.1.6.v20100715
-Installing bundle mvn:org.eclipse.jetty/jetty-security/7.1.6.v20100715
-Installing bundle mvn:org.eclipse.jetty/jetty-servlet/7.1.6.v20100715
-Installing bundle mvn:org.eclipse.jetty/jetty-xml/7.1.6.v20100715
-Checking configuration file mvn:org.apache.karaf/apache-karaf/2.99.99-SNAPSHOT/xml/jettyconfig
-Installing bundle mvn:org.ops4j.pax.web/pax-web-api/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.web/pax-web-spi/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.web/pax-web-runtime/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.web/pax-web-jetty/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.web/pax-web-jsp/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.web/pax-web-extender-war/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.web/pax-web-extender-whiteboard/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.web/pax-web-deployer/0.8.2-SNAPSHOT
-Installing bundle mvn:org.ops4j.pax.url/pax-url-war/1.2.4
-{noformat}
-# Verify the features were installed
-{noformat}
-servicemix> features/list
- State Name
-. . .
-[installed ] [3.0.0] http karaf-3.0.0
-[installed ] [3.0.0] war karaf-3.0.0
-. . .
-{noformat}
-# Verify the installed bundles were started
-{noformat}
-karaf@root> bundles:list
-START LEVEL 100
- ID State Level Name
-. . .
-[ 32] [Active ] [ ] [ 60] geronimo-servlet_2.5_spec (1.1.2)
-[ 33] [Active ] [ ] [ 60] Apache ServiceMix :: Bundles :: jetty (6.1.22.2)
-[ 34] [Active ] [ ] [ 60] OPS4J Pax Web - API (1.0.0)
-[ 35] [Active ] [ ] [ 60] OPS4J Pax Web - Service SPI (1.0.0)
-[ 36] [Active ] [ ] [ 60] OPS4J Pax Web - Runtime (1.0.0)
-[ 37] [Active ] [ ] [ 60] OPS4J Pax Web - Jetty (1.0.0)
-[ 38] [Active ] [ ] [ 60] OPS4J Pax Web - Jsp Support (1.0.0)
-[ 39] [Active ] [ ] [ 60] OPS4J Pax Web - Extender - WAR (1.0.0)
-[ 40] [Active ] [ ] [ 60] OPS4J Pax Web - Extender - Whiteboard (1.0.0)
-[ 42] [Active ] [ ] [ 60] OPS4J Pax Web - FileInstall Deployer (1.0.0)
-[ 41] [Active ] [ ] [ 60] OPS4J Pax Url - war:, war-i: (1.2.4)
-. . .
-{noformat}
-# The Jetty server should now be listening on http://localhost:8181/, but with no published applications available.
-{noformat}
-HTTP ERROR: 404
-NOT_FOUND
-RequestURI=/
-Powered by jetty://
-{noformat}
-h2. Deploying a WAR to the installed web feature
+The Jetty server should now be listening on {{http://localhost:8181/}}., but with no published applications available. To configure the port see the [HTTP Service config | http].
+
+h2. Preparing a war so it can be deployed
+
+To deploy a WAR (JSP or Servlet) to Jetty, update its MANIFEST.MF to include the required OSGi headers as described in [How to OSGi-fy War files | http://team.ops4j.org/wiki/display/ops4j/Pax+Web+Extender+-+War+-+OSGi-fy]
+
+h2. Deploying a WAR
-The following steps will describe how to install a simple WAR file (with JSPs or Servlets) to the just installed web feature.
-# To deploy a WAR (JSP or Servlet) to Jetty, update its MANIFEST.MF to include the required OSGi headers as described here - \\
-[http://team.ops4j.org/wiki/display/ops4j/Pax+Web+Extender+-+War+-+OSGi-fy]
-# Copy the updated WAR (archive or extracted files) to the _deploy_ directory.
+Copy the updated WAR (archive or extracted files) to the _deploy_ directory or install the war using bundle:install like shown below for the Tomcat sample application.
+
+h2. Deploying the Tomcat sample application
If you want to deploy a sample web application into Karaf, you could use the following command:
{code}
-karaf@root> bundles:install -s webbundle:http://tomcat.apache.org/tomcat-5.5-doc/appdev/sample/sample.war?Bundle-SymbolicName=tomcat-sample&Webapp-Context=/sample
+karaf@root> bundle:install -s webbundle:http://tomcat.apache.org/tomcat-5.5-doc/appdev/sample/sample.war?Bundle-SymbolicName=tomcat-sample&Webapp-Context=/sample
{code}
-Then open your web browser and point to {{http://localhost:8181/sample/index.html}}.
+Then open your web browser and point to [http://localhost:8181/sample/index.html].
+
+h2. Listing installed web applications
+
+{noformat}
+karaf@root()> web:list
+ID | State | Web-State | Level | Web-ContextPath | Name
+----------------------------------------------------------------------------
+95 | Active | Deployed | 80 | /sample | tomcat-sample (0)
+{noformat}
\ No newline at end of file
Modified: karaf/trunk/manual/src/main/webapp/users-guide/web-console.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/web-console.conf?rev=1386516&r1=1386515&r2=1386516&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/web-console.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/web-console.conf Mon Sep 17 08:54:27 2012
@@ -13,23 +13,15 @@ h2. Installing the web console
The web console is not installed by default. To install it, run the following command from the Karaf prompt:
{code}
-root@karaf> features:install webconsole
+root@karaf> feature:install webconsole
{code}
+For changing the web console port number see the [HTTPService config| http].
+
h2. Accessing the web console
-To access the console for an instance of Karaf running locally, enter the following address in your web browser:
+To access the console for an instance of Karaf running locally, enter the following address in your web browser:
-{code}
-http://localhost:8181/system/console
-{code}
+[http://localhost:8181/system/console]
Log in with the username {{karaf}} and the password {{karaf}}. If you have changed the default user or password, use the one you have configured.
-
-h2. Changing the web console port number
-
-By default, the console runs on port 8181. You can change the port number by creating the properties file, {{etc/org.ops4j.pax.web.cfg}}, and adding the following property setting (changing the port number to whatever value desired):
-
-{code}
-org.osgi.service.http.port=8181
-{code}