Author: jbonofre
Date: Wed Nov 28 15:23:48 2012
New Revision: 1414755
URL: http://svn.apache.org/viewvc?rev=1414755&view=rev
Log:
[KARAF-2026] Fixing bad links in documentation
Modified:
karaf/trunk/manual/src/main/webapp/_navigation.conf
karaf/trunk/manual/src/main/webapp/overview.conf
karaf/trunk/manual/src/main/webapp/quick-start.conf
karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
karaf/trunk/manual/src/main/webapp/users-guide/installation.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
Modified: karaf/trunk/manual/src/main/webapp/_navigation.conf
URL:
http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/_navigation.conf?rev=1414755&r1=1414754&r2=1414755&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/_navigation.conf (original)
+++ karaf/trunk/manual/src/main/webapp/_navigation.conf Wed Nov 28 15:23:48 2012
@@ -38,8 +38,12 @@ h3. [Developers Guide|/developers-guide/
- [Branding the Console|/developers-guide/branding-console]
- [Using the Karaf Maven plugin|/developers-guide/karaf-maven-plugin]
- [Security Framework|/developers-guide/security-framework]
-- [Writing Integration Test|/developers-guide/writing-tests]
- [Custom Distribution|/developers-guide/custom-distribution]
+- [Troubleshooting, Debugging and Profiling|/developers-guide/debugging]
+- [Programmatically connect to the console|/developers-guide/connect-console]
+- [Writing integration tests|/developers-guide/writing-tests]
+- [Creating bundles|/developers-guide/creating-bundles]
+- [Shell syntax|/developers-guide/shell-syntax]
- [Github Contributions|/developers-guide/github-contributions]
h3. [Commands|/commands/commands]
Modified: karaf/trunk/manual/src/main/webapp/overview.conf
URL:
http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/overview.conf?rev=1414755&r1=1414754&r2=1414755&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/overview.conf (original)
+++ karaf/trunk/manual/src/main/webapp/overview.conf Wed Nov 28 15:23:48 2012
@@ -6,6 +6,19 @@ Apache Karaf is a small OSGi based runti
[See all Karaf features in detail|features]
+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 {{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 {{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.
+* *Native OS integration*: Karaf can be integrated into your own Operating
System as a service so that the lifecycle will be bound to your Operating
System.
+* *Extensible Shell console*: Karaf features a nice text console where you can
manage the services, install new applications or libraries and manage their
state. This shell is easily extensible by deploying new commands dynamically
along with new features or applications.
+* *Remote access*: use any SSH client to connect to Karaf and issue commands
in the console
+* *Security framework* based on JAAS
+* *Managing instances*: Karaf provides simple commands for managing multiple
instances. You can easily create, delete, start and stop instances of Karaf
through the console.
+* Supports the latest OSGi 4.3 containers: Apache Felix Framework 4.0 and
Eclipse Equinox 3.8
+
!/images/karaf.png!
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=1414755&r1=1414754&r2=1414755&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/quick-start.conf (original)
+++ karaf/trunk/manual/src/main/webapp/quick-start.conf Wed Nov 28 15:23:48 2012
@@ -6,8 +6,6 @@ h2. Prerequisites
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.
-h2. Download binaries
-
* Open a Web browser and access the following URL:
[http://karaf.apache.org/index/community/download.html]
* Download the binary distribution that matches your system (zip for windows,
tar.gz for unixes)
* Extract the archive a new folder on your hard drive; for example in c:\karaf
- from now on this directory will be referenced as <KARAF_HOME>.
Modified: karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
URL:
http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf?rev=1414755&r1=1414754&r2=1414755&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
(original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf Wed Nov
28 15:23:48 2012
@@ -127,10 +127,16 @@ All instance files will be copied and th
h2. Using the instance script
-You can also manage the local instances of Karaf. The {{instance}} script in
the {{[karaf-install-dir]/bin}} directory provides the same commands as the
{{instance}} console commands, apart from
[{{instance:connect}}|/commands/instance-connect].
+You can also manage the local instances of Karaf. The {{instance}} script in
the {{bin}} directory provides the same commands as the {{instance}} console
commands, apart from [{{instance:connect}}|/commands/instance-connect].
{code}
-> bin/instance
+bin/instance
+{code}
+
+You can also manage the local instances of Karaf. The {{admin}} script in the
{{bin}} directory provides the same commands as the {{admin}} console commands,
apart from [{{admin:connect}}|/commands/admin-connect].
+
+{code}
+bin/admin
Available commands:
change-ssh-port - Changes the secure shell port of an existing container
instance.
change-rmi-registry-port - Changes the RMI registry port (used by management
layer) of an existing container instance.
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=1414755&r1=1414754&r2=1414755&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/installation.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/installation.conf Wed Nov 28
15:23:48 2012
@@ -75,7 +75,7 @@ The recommended method of building Karaf
{code}
cd [karaf_install_dir]\src
{code}
- where {{\[karaf_install_dir\]}} is the directory in which Karaf was installed.
+ where {{karaf_install_dir}} is the directory in which Karaf was installed.
{code}
mvn
{code}
@@ -103,7 +103,7 @@ The preferred method of building Karaf i
{code}
cd [karaf_install_dir]/src
{code}
- where \[karaf_install_dir\] is the directory in which Karaf was installed.
+ where {{karaf_install_dir}} is the directory in which Karaf was installed.
{code}
mvn
{code}
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=1414755&r1=1414754&r2=1414755&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/provisioning.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/provisioning.conf Wed Nov 28
15:23:48 2012
@@ -257,5 +257,73 @@ h3. Feature resolver
The resolver attribute on a feature can be set to force the use of a given
resolver instead of the default resolution process. A resolver will be use to
obtain the list of bundles to actually install for a given feature.
The default resolver will simply return the list of bundles provided in the
feature description.
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).
+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 the 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 {{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 [building custom distributions|customer-distribution] section.
+
+
+>>>>>>> c9b3a9d... [KARAF-2026] Fixing bad links in documentation
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=1414755&r1=1414754&r2=1414755&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 Wed Nov
28 15:23:48 2012
@@ -6,7 +6,7 @@ It does not always make sense to manage
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.
-The SSH hostname and port number is configured in the
{{\[karaf_install_dir\]/etc/org.apache.karaf.shell.cfg}} configuration file
with the following default values:
+The SSH hostname and port number is configured in the
{{etc/org.apache.karaf.shell.cfg}} configuration file with the following
default values:
{code}
sshPort=8101
@@ -51,7 +51,7 @@ h3. Using the Karaf client
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:
+For example, to quickly connect to a Karaf instance running in server mode on
the same machine, run the following command:
{code}
bin/client
{code}
@@ -101,7 +101,7 @@ Pressing {{Ctrl+D}} in a remote console
h3. Using the karaf client
-To stop a remote instance using the Karaf client, run the following from the
{{[karaf-install-dir]/lib}} directory:
+To stop a remote instance using the Karaf client, run the following from the
{{lib}} directory:
{code}
bin/client -u karaf -p karaf -a 8101 hostname system:shutdown
{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=1414755&r1=1414754&r2=1414755&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/security.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/security.conf Wed Nov 28
15:23:48 2012
@@ -2,7 +2,7 @@ h1. Security
h2. Managing users and passwords
-The default security configuration uses a property file located at
{{[karaf-install-dir]/etc/users.properties}} to store authorized users and
their passwords.
+The default security configuration uses a property file located at
{{etc/users.properties}} to store authorized users and their passwords.
The default user name is {{karaf}} and the associated password is {{karaf}}
too. We strongly encourage you to change the default password by editing the
above file before moving Karaf into production.
@@ -58,8 +58,8 @@ Some applications require specific secur
While this approach works fine, it has a global effect and requires you to
configure all your servers accordingly.
Karaf offers a simple way to configure additional security providers:
-* put your provider jar in {{[karaf-install-dir]/lib/ext}}
-* modify the {{[karaf-install-dir]/etc/config.properties}} configuration file
to add the following property
+* put your provider jar in {{lib/ext}}
+* modify the {{etc/config.properties}} configuration file to add the following
property
{code}
org.apache.karaf.security.providers = xxx,yyy
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=1414755&r1=1414754&r2=1414755&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 Wed Nov 28
15:23:48 2012
@@ -58,7 +58,7 @@ bin\start
h2. Starting Karaf from clean
-Karaf can be reset to a clean state by simply deleting the
{{\[karaf_install_dir\]/data}} folder.
+Karaf can be reset to a clean state by simply deleting the {{data}} folder.
For convenience, a parameter on the {{karaf}} and {{start}} scripts is
available:
{code}
bin/start clean
@@ -68,7 +68,7 @@ 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}
-shutdown -f
+system:shutdown
{code}
The shutdown command has several options you can use to change the behaviour.
See [commands/shutdown].
