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 2012/11/28 15:57:46 UTC
svn commit: r1414739 - in
/karaf/branches/karaf-2.3.x/manual/src/main/webapp: ./ users-guide/
Author: jbonofre
Date: Wed Nov 28 14:57:44 2012
New Revision: 1414739
URL: http://svn.apache.org/viewvc?rev=1414739&view=rev
Log:
[KARAF-2026] Fixing bad links in documentation
Modified:
karaf/branches/karaf-2.3.x/manual/src/main/webapp/_navigation.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/overview.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/quick-start.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/child-instances.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/installation.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/provisioning.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/remote-console.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/security.conf
karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/start-stop.conf
Modified: karaf/branches/karaf-2.3.x/manual/src/main/webapp/_navigation.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/_navigation.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/_navigation.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/_navigation.conf Wed Nov 28 14:57:44 2012
@@ -32,7 +32,6 @@ h3. [Developers Guide|/developers-guide/
- [Extending the Console|/developers-guide/extending-console]
- [Custom Distribution|/developers-guide/custom-distribution]
- [Security Framework|/developers-guide/security-framework]
-<<<<<<< HEAD
- [Using the features-maven-plugin|/developers-guide/features-maven-plugin]
- [Troubleshooting, Debugging and Profiling|/developers-guide/debugging]
- [Programmatically connect to the console|/developers-guide/connect-console]
Modified: karaf/branches/karaf-2.3.x/manual/src/main/webapp/overview.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/overview.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/overview.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/overview.conf Wed Nov 28 14:57:44 2012
@@ -4,8 +4,8 @@ Apache Karaf is a small OSGi based runti
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, 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.
+* *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.
Modified: karaf/branches/karaf-2.3.x/manual/src/main/webapp/quick-start.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/quick-start.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/quick-start.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/quick-start.conf Wed Nov 28 14:57:44 2012
@@ -5,10 +5,10 @@ h1. 1. Quick Start
If you are in a hurry to have Apache Karaf up and running right away, this section will provide you with some basic steps for downloading, building (when needed) and running the server in no time. This is clearly not a complete guide so you may want to check other sections of this guide for further information.
All you need is 5 to 10 minutes and to follow these basic steps.
-* [#Background]
-* [#Getting the software]
-* [#Start the server]
-* [#Deploy a sample application]
+* Background
+* Getting the software
+* Start the server
+* Deploy a sample application
h2. Background
@@ -158,7 +158,7 @@ To stop Karaf from the console, enter {{
{code}
Alternatively, you can also run the following command:
{code}
-osgi:shutdown
+system:shutdown
{code}
h2. Summary
Modified: karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/child-instances.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/child-instances.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/child-instances.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/child-instances.conf Wed Nov 28 14:57:44 2012
@@ -4,13 +4,13 @@ A child instance of Karaf is a copy that
h2. Using the admin console commands
-The *admin* console commands allow you to create and manage instances of Karaf on the same machine. Each new runtime is a child instance of the runtime that created it. You can easily manage the children using names instead of network addresses. For details on the *admin* commands, see the [{{admin}} commands|/commands/admin].
+The *admin* console commands allow you to create and manage instances of Karaf on the same machine. Each new runtime is a child instance of the runtime that created it. You can easily manage the children using names instead of network addresses. For details on the *admin* commands, see the [{{admin}}|/commands/admin] commands.
h2. Creating child instances
You create a new runtime instance by typing [{{admin:create}}|/commands/admin-create] in the Karaf console.
-As shown in the following example, {{admin:create}} causes the runtime to create a new runtime installation in the active runtime's {{instances/[name]} directory. The new instance is a new Karaf instance and is assigned an SSH port number based on an incremental count starting at 8101 and a RMI registry port number based on an incremental count starting at 1099/44444.
+As shown in the following example, {{admin:create}} causes the runtime to create a new runtime installation in the active runtime's {{instances/name}} directory. The new instance is a new Karaf instance and is assigned an SSH port number based on an incremental count starting at 8101 and a RMI registry port number based on an incremental count starting at 1099/44444.
{code}
karaf@root> admin:create alpha
@@ -109,10 +109,10 @@ Note that only stopped instances can be
h2. Using the admin script
-You can also manage the local instances of Karaf. The {{admin}} script in the {{[karaf-install-dir]/bin}} directory provides the same commands as the {{admin}} console commands, apart from [{{admin:connect}}|/commands/admin-connect].
+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
+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/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/installation.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/installation.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/installation.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/installation.conf Wed Nov 28 14:57:44 2012
@@ -39,7 +39,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}
@@ -67,7 +67,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/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/provisioning.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/provisioning.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/provisioning.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/provisioning.conf Wed Nov 28 14:57:44 2012
@@ -290,11 +290,11 @@ Note: The path is relative to the Apache
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.
+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 [6.2. Building custom distributions] section.
+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.
Modified: karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/remote-console.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/remote-console.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/remote-console.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/remote-console.conf Wed Nov 28 14:57:44 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
@@ -59,7 +59,7 @@ 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.
-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}
@@ -109,7 +109,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 osgi:shutdown
{code}
Modified: karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/security.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/security.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/security.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/security.conf Wed Nov 28 14:57:44 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.
@@ -62,8 +62,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/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/start-stop.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/start-stop.conf?rev=1414739&r1=1414738&r2=1414739&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/start-stop.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/users-guide/start-stop.conf Wed Nov 28 14:57:44 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}
-osgi:shutdown
+system:shutdown
{code}
or simply:
{code}
@@ -78,7 +78,7 @@ shutdown
The shutdown command asks you to confirm that you really want to shutdown. If you are sure about the shutdown and avoid the confirmation message, you can use the -f or --force option:
{code}
-osgi:shutdown -f
+system:shutdown -f
{code}
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.
@@ -86,13 +86,13 @@ It's also possible to delay the shutdown
The following command will shutdown Karaf at 10:35am:
{code}
-osgi:shutdown 10:35
+system:shutdown 10:35
{code}
The following command will shutdown Karaf in 10 minutes:
{code}
-osgi:shutdown +10
+system:shutdown +10
{code}
If you're running from the main console, exiting the shell using {{logout}} or {{Ctrl+D}} will also terminate the Karaf instance.