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 2019/11/25 06:35:19 UTC
svn commit: r1870356 [3/4] - in /karaf/site/production/manual/latest: ./
commands/
Modified: karaf/site/production/manual/latest/installation.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/installation.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/installation.html (original)
+++ karaf/site/production/manual/latest/installation.html Mon Nov 25 06:35:17 2019
@@ -529,7 +529,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect2">
<h3 id="_installation">Installation</h3>
<div class="paragraph">
-<p>Apache Karaf is a lightweight container, very easy to install and administrate, on both Unix and Windows platforms.</p>
+<p>Apache Karaf is a lightweight container, that is very easy to install and administer, on both Unix and Windows platforms.</p>
</div>
<div class="sect3">
<h4 id="_requirements">Requirements</h4>
@@ -562,7 +562,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="ulist">
<ul>
<li>
-<p>Java SE 1.7.x or greater (<a href="http://www.oracle.com/technetwork/java/javase/" class="bare">http://www.oracle.com/technetwork/java/javase/</a>).</p>
+<p>Java SE 1.8 or greater (<a href="http://www.oracle.com/technetwork/java/javase/" class="bare">http://www.oracle.com/technetwork/java/javase/</a>).</p>
</li>
<li>
<p>The JAVA_HOME environment variable must be set to the directory where the Java runtime is installed,</p>
@@ -579,7 +579,7 @@ table.CodeRay td.code>pre{padding:0}
<p>The "default" distribution is a "ready to use" distribution, with pre-installed features.</p>
</div>
<div class="paragraph">
-<p>The "minimal" distribution is like the minimal distributions that you can find for most of Unix distributions.
+<p>The "minimal" distribution is like the minimal distributions that you can find for most of the Unix distributions.
Only the core layer is packaged, most of the features and bundles are downloaded from Internet at bootstrap.
It means that Apache Karaf minimal distribution requires an Internet connection to start correctly.
The features provided by the "minimal" distribution are exactly the same as in the "default" distribution, the difference
@@ -604,13 +604,13 @@ is that the minimal distribution will do
<div class="olist arabic">
<ol class="arabic">
<li>
-<p>From a browser, navigate to <a href="http://karaf.apache.org/index/community/download.html" class="bare">http://karaf.apache.org/index/community/download.html</a>.</p>
+<p>From a browser, navigate to <a href="http://karaf.apache.org/download.html" class="bare">http://karaf.apache.org/download.html</a>.</p>
</li>
<li>
<p>Download Apache Karaf binary distribution in the zip format: <code>apache-karaf-4.0.0.zip</code>.</p>
</li>
<li>
-<p>Extract the files from the zip file into a directory of your choice (it’s the <code>KARAF_HOME</code>.</p>
+<p>Extract the files from the zip file into a directory of your choice (it’s the <code>KARAF_HOME</code>).</p>
</li>
</ol>
</div>
@@ -683,7 +683,7 @@ is that the minimal distribution will do
<div class="olist arabic">
<ol class="arabic">
<li>
-<p>From a browser, navigate to <a href="http://karaf.apache.org/index/community/download.html" class="bare">http://karaf.apache.org/index/community/download.html</a>.</p>
+<p>From a browser, navigate to <a href="http://karaf.apache.org/download.html" class="bare">http://karaf.apache.org/download.html</a>.</p>
</li>
<li>
<p>Download Apache Karaf binary distribution in the tar.gz format: <code>apache-karaf-4.0.0.tar.gz</code>.</p>
@@ -695,8 +695,7 @@ is that the minimal distribution will do
</div>
<div class="listingblock">
<div class="content">
-<pre>gunzip apache-karaf-4.0.0.tar.gz
-tar xvf apache-karaf-4.0.0.tar</pre>
+<pre>tar zxvf apache-karaf-4.0.0.tar.gz</pre>
</div>
</div>
<div class="admonitionblock note">
@@ -772,10 +771,10 @@ apt-get install openjdk-8-jdk karaf</pre
<h4 id="_post_installation_steps">Post-Installation steps</h4>
<div class="paragraph">
<p>Thought it is not always required, it is strongly advised to set up the <code>JAVA_HOME</code> environment property to point to the JDK you want Apache Karaf to use before starting it.
-This property is used to locate the <code>java</code> executable and should be configured to point to the home directory of the Java SE 7 installation.</p>
+This property is used to locate the <code>java</code> executable and should be configured to point to the home directory of the Java SE 8 installation.</p>
</div>
<div class="paragraph">
-<p>By default, all Apache Karaf files are "gather" in one directory: the <code>KARAF_HOME</code>.</p>
+<p>By default, all Apache Karaf files are "gathered" in one directory: <code>KARAF_HOME</code>.</p>
</div>
<div class="paragraph">
<p>You can define your own directory layout, by using some Karaf environment variables:</p>
@@ -815,7 +814,7 @@ This property is used to locate the <cod
<div class="ulist">
<ul>
<li>
-<p>Java SE Development Kit 1.7.x or greater (<a href="http://www.oracle.com/technetwork/java/javase/" class="bare">http://www.oracle.com/technetwork/java/javase/</a>).</p>
+<p>Java SE Development Kit 1.8 or greater (<a href="http://www.oracle.com/technetwork/java/javase/" class="bare">http://www.oracle.com/technetwork/java/javase/</a>).</p>
</li>
<li>
<p>Apache Maven 3.5.0 or greater (<a href="http://maven.apache.org/download.html" class="bare">http://maven.apache.org/download.html</a>).</p>
@@ -830,16 +829,16 @@ This property is used to locate the <cod
<div class="ulist">
<ul>
<li>
-<p>the sources distribution <code>apache-karaf-4.0.0-src.zip</code> available at <a href="http://karaf.apache.org/index/community/download.html" class="bare">http://karaf.apache.org/index/community/download.html</a>. Extract the files in the directory of your choice.</p>
+<p>the sources distribution <code>apache-karaf-4.0.0-src.zip</code> available at <a href="http://karaf.apache.org/download.html" class="bare">http://karaf.apache.org/download.html</a>. Extract the files in the directory of your choice.</p>
</li>
<li>
-<p>by checkout of the git repository:</p>
+<p>by checking out the git repository:</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
-<pre>git clone https://git-wip-us.apache.org/repos/asf/karaf.git karaf</pre>
+<pre>git clone https://github.com/apache/karaf karaf</pre>
</div>
</div>
<div class="paragraph">
@@ -881,16 +880,16 @@ This property is used to locate the <cod
<div class="ulist">
<ul>
<li>
-<p>the sources distribution <code>apache-karaf-4.0.0-src.tar.gz</code> available at <a href="http://karaf.apache.org/index/community/download.html" class="bare">http://karaf.apache.org/index/community/download.html</a>. Extract the files in the directory of your choice.</p>
+<p>the sources distribution <code>apache-karaf-4.0.0-src.tar.gz</code> available at <a href="http://karaf.apache.org/download.html" class="bare">http://karaf.apache.org/download.html</a>. Extract the files in the directory of your choice.</p>
</li>
<li>
-<p>by checkout of the git repository:</p>
+<p>by checking out the git repository:</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
-<pre>git clone https://git-wip-us.apache.org/repos/asf/karaf.git karaf</pre>
+<pre>git clone https://github.com/apache/karaf karaf</pre>
</div>
</div>
<div class="paragraph">
@@ -929,7 +928,7 @@ This property is used to locate the <cod
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/instances.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/instances.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/instances.html (original)
+++ karaf/site/production/manual/latest/instances.html Mon Nov 25 06:35:17 2019
@@ -559,7 +559,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="paragraph">
-<p>The new instance is fresh Apache Karaf instance. It uses default configuration files set, as you install a fresh Karaf distribution.</p>
+<p>The new instance is a fresh Apache Karaf instance. It uses the same default configuration files, as when you install a fresh Karaf distribution.</p>
</div>
<div class="paragraph">
<p>You can enable the verbose mode for the <code>instance:create</code> command using the <code>-v</code> option:</p>
@@ -1083,7 +1083,7 @@ If wait is true, this operation is waiti
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-05-18 16:02:21 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jdbc.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jdbc.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jdbc.html (original)
+++ karaf/site/production/manual/latest/jdbc.html Mon Nov 25 06:35:17 2019
@@ -854,7 +854,7 @@ REF_GENERATION | TYPE_NAME | TABLE_NAME
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-09-11 18:41:11 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jms.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jms.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jms.html (original)
+++ karaf/site/production/manual/latest/jms.html Mon Nov 25 06:35:17 2019
@@ -577,7 +577,7 @@ karaf@root()> feature:install activem
<div class="ulist">
<ul>
<li>
-<p>a Apache ActiveMQ broker directly in Apache Karaf, bind to the <code>61616</code> port number by default.</p>
+<p>a Apache ActiveMQ broker directly in Apache Karaf, binding to the <code>61616</code> port number by default.</p>
</li>
<li>
<p>the Apache ActiveMQ WebConsole bound to <code><a href="http://0.0.0.0:8181/activemqweb" class="bare">http://0.0.0.0:8181/activemqweb</a></code> by default.</p>
@@ -645,7 +645,7 @@ OPTIONS
<p>the <code>name</code> argument is required. It’s the name of the JMS connection factory. The name is used to identify the connection factory, and to create the connection factory definition file (<code>deploy/connectionfactory-[name].xml</code>).</p>
</li>
<li>
-<p>the <code>-t</code> (<code>--type</code>) option is required. It’s the type of the JMS connection factory. Currently on <code>activemq</code> and <code>webspheremq</code> type are supported. If you want to use another type of JMS connection factory, you can create the <code>deploy/connectionfactory-[name].xml</code> file by hand (using one as template).</p>
+<p>the <code>-t</code> (<code>--type</code>) option is required. It’s the type of the JMS connection factory. Currently only <code>activemq</code> and <code>webspheremq</code> types are supported. If you want to use another type of JMS connection factory, you can create the <code>deploy/connectionfactory-[name].xml</code> file by hand (using one as template).</p>
</li>
<li>
<p>the <code>--url</code> option is required. It’s the URL used by the JMS connection factory to connect to the broker. If the type is <code>activemq</code>, the URL looks like <code>tcp://localhost:61616</code>. If the type is <code>webspheremq</code>, the URL looks like <code>host/port/queuemanager/channel</code>.</p>
@@ -765,7 +765,7 @@ version | 5.9.0</pre>
<p>You can see the JMS broker product and version.</p>
</div>
<div class="paragraph">
-<p>If the JMS broker requires an authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
+<p>If the JMS broker requires authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
</div>
</div>
<div class="sect5">
@@ -785,7 +785,7 @@ MyQueue</pre>
<p>where <code>/jms/test</code> is the name of the JMS connection factory.</p>
</div>
<div class="paragraph">
-<p>If the JMS broker requires an authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
+<p>If the JMS broker requires authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -820,7 +820,7 @@ MyTopic</pre>
<p>where <code>/jms/test</code> is the name of the JMS connection factory.</p>
</div>
<div class="paragraph">
-<p>If the JMS broker requires an authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
+<p>If the JMS broker requires authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -852,7 +852,7 @@ For now, the command works only with Apa
</div>
</div>
<div class="paragraph">
-<p>If the JMS broker requires an authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
+<p>If the JMS broker requires authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
</div>
</div>
<div class="sect5">
@@ -873,7 +873,7 @@ For now, the command works only with Apa
<p>If you want to consume only some messages, you can define a selector using the <code>-s</code> (<code>--selector</code>) option.</p>
</div>
<div class="paragraph">
-<p>If the JMS broker requires an authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
+<p>If the JMS broker requires authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -908,7 +908,7 @@ Messages Count
</div>
</div>
<div class="paragraph">
-<p>If the JMS broker requires an authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
+<p>If the JMS broker requires authentication, you can use the <code>-u</code> (<code>--username</code>) and <code>-p</code> (<code>--password</code>) options.</p>
</div>
</div>
<div class="sect5">
@@ -1021,7 +1021,7 @@ ID:vostro-59602-1387462183019-3:3:1:1:1
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jndi.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jndi.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jndi.html (original)
+++ karaf/site/production/manual/latest/jndi.html Mon Nov 25 06:35:17 2019
@@ -847,7 +847,7 @@ and the regular JNDI service.</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-05-18 16:02:21 CEST
+Last updated 2019-09-11 18:41:11 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jpa.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jpa.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jpa.html (original)
+++ karaf/site/production/manual/latest/jpa.html Mon Nov 25 06:35:17 2019
@@ -584,7 +584,7 @@ container managed persistence for applic
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-05-18 16:02:21 CEST
+Last updated 2019-09-11 18:41:11 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jta.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jta.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jta.html (original)
+++ karaf/site/production/manual/latest/jta.html Mon Nov 25 06:35:17 2019
@@ -547,7 +547,7 @@ table.CodeRay td.code>pre{padding:0}
<h5 id="_apache_aries_transaction_and_objectweb_howl">Apache Aries Transaction and ObjectWeb HOWL</h5>
<div class="paragraph">
<p>The <code>transaction</code> feature uses Apache Aries and ObjectWeb HOWL. Aapache Aries Transaction "exposes" the transaction
-manager as OSGi service. The actual implementation of the transaction manager is ObjectWeb HOWL.</p>
+manager as an OSGi service. The actual implementation of the transaction manager is ObjectWeb HOWL.</p>
</div>
<div class="paragraph">
<p>ObjectWeb HOWL is a logger implementation providing features required by the ObjectWeb JOTM project, with a public API
@@ -674,7 +674,7 @@ aries.transaction.howl.bufferSizeKBytes
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-05-18 16:02:21 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/kar.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/kar.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/kar.html (original)
+++ karaf/site/production/manual/latest/kar.html Mon Nov 25 06:35:17 2019
@@ -532,20 +532,17 @@ table.CodeRay td.code>pre{padding:0}
<p>As described in the <a href="provisioning">Provisioning section</a>, Apache Karaf features describe applications.</p>
</div>
<div class="paragraph">
-<p>A feature defines different resources to resolve using URL (for instance, bundles URLs, or configuration files URLs).
+<p>A feature defines different resources to resolve using URLs (for instance, bundles URLs, or configuration files URLs).
As described in the [Artifacts repositories and URLs section|urls], Apache Karaf looks for artifacts (bundles,
configuration files, …​) in the artifact repositories.
-Apache Karaf may require to download artifacts from remote repositories.</p>
+Apache Karaf may have to download artifacts from remote repositories.</p>
</div>
<div class="paragraph">
<p>Apache Karaf provides a special type of artifact that package a features XML and all resources described in the features
of this XML. This artifact is named a KAR (KAraf aRchive).</p>
</div>
<div class="paragraph">
-<p>A KAR file is a zip archive containing the</p>
-</div>
-<div class="paragraph">
-<p>Basically, the kar format is a jar (so a zip file) which contains a set of feature descriptor and bundle jar files.</p>
+<p>A KAR file is essentially a jar (so a zip file) which contains a set of feature descriptor and bundle jar files.</p>
</div>
<div class="paragraph">
<p>A KAR file contains a <code>repository</code> folder containing:</p>
@@ -639,16 +636,23 @@ updating: repository/ (stored 0%)
<p>The Apache Karaf Maven plugin provides the <code>kar</code> goal.</p>
</div>
<div class="paragraph">
-<p>The <code>kar</code> goal does:
-. Reads all features specified in the features XML.
-. For each feature described in the features XML, the goal resolves the bundles described in the feature.
-. The goal finally packages the features XML, and the resolved bundles in a zip file.</p>
+<p>The <code>kar</code> goal does:</p>
</div>
-<div class="paragraph">
-<p>For instance, the following Maven POM create <code>my-kar.kar</code></p>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Reads all features specified in the features XML.</p>
+</li>
+<li>
+<p>For each feature described in the features XML, the goal resolves the bundles described in the feature.</p>
+</li>
+<li>
+<p>The goal finally packages the features XML, and the resolved bundles in a zip file.</p>
+</li>
+</ol>
</div>
<div class="paragraph">
-<p>For instance, you can use the following POM to create a kar:</p>
+<p>For instance, you can use the following POM to create <code>my-kar.kar</code>:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -685,7 +689,7 @@ updating: repository/ (stored 0%)
</div>
</div>
<div class="paragraph">
-<p>Uou will have your kar in the <code>target</code> directory.</p>
+<p>The kar will be installed in the <code>target</code> directory.</p>
</div>
</div>
<div class="sect3">
@@ -786,7 +790,7 @@ is supported by the <code>kar:install</c
</div>
</div>
<div class="paragraph">
-<p>The KAR file is uncompressed and populated the <code>KARAF_BASE/system</code> folder.</p>
+<p>The KAR file is uncompressed and used to populate the <code>KARAF_BASE/system</code> folder.</p>
</div>
<div class="paragraph">
<p>The Apache Karaf KAR service is looking for features XML files in the KAR file, registers the features XML and automatically
@@ -799,7 +803,7 @@ installs all features described in the f
<div class="sect4">
<h5 id="_code_kar_uninstall_code"><code>kar:uninstall</code></h5>
<div class="paragraph">
-<p>The <code>kar:uninstall</code> command uninstall a KAR file (identified by a name).</p>
+<p>The <code>kar:uninstall</code> command uninstalls a KAR file (identified by a name).</p>
</div>
<div class="paragraph">
<p>By uninstall, it means that:</p>
@@ -875,7 +879,7 @@ noAutoStartBundles=false
</div>
</div>
<div class="paragraph">
-<p>By default, when the KAR deployer install features, by default, it refresh the bundles already installed.
+<p>By default, when the KAR deployer installs features, it refreshes the bundles already installed.
You can disable the automatic bundles refresh by setting the <code>noAutoRefreshBundles</code> property to <code>false</code>.</p>
</div>
</div>
@@ -918,7 +922,7 @@ list of <code>features</code> to include
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-03-12 21:01:55 CET
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/karaf-maven-plugin.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/karaf-maven-plugin.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/karaf-maven-plugin.html (original)
+++ karaf/site/production/manual/latest/karaf-maven-plugin.html Mon Nov 25 06:35:17 2019
@@ -545,7 +545,7 @@ table.CodeRay td.code>pre{padding:0}
</ul>
</div>
<div class="paragraph">
-<p>See [examples/karaf-maven-example] for details.</p>
+<p>See <a href="https://github.com/apache/karaf/blob/master/examples/karaf-maven-example/README.md" class="bare">https://github.com/apache/karaf/blob/master/examples/karaf-maven-example/README.md</a> for details.</p>
</div>
<div class="sect3">
<h4 id="_packaging">Packaging</h4>
@@ -789,6 +789,16 @@ This can be overridden by specifying the
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean (false)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, the <code>src/main/history/dependencies.xml</code> file will be overwritten if it has changed.</p></td>
</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">markRuntimeScopeAsDependency</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">boolean (true)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to mark dependencies' in the <code>runtime</code> scope with <code>dependency="true"</code>.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">markTransitiveAsDependency</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">boolean (false)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to mark transitive dependencies' with <code>dependency="true"</code>.</p></td>
+</tr>
</tbody>
</table>
</div>
@@ -1174,7 +1184,7 @@ META-INF in the kar, without getting ins
</div>
</div>
<div class="paragraph">
-<p>By default, the generate Karaf instance is a dynamic distribution (it’s started with default set of resources and then you can deploy new applications in this instance).</p>
+<p>By default, the generated Karaf instance is a dynamic distribution (it’s started with default set of resources and then you can deploy new applications in this instance).</p>
</div>
<div class="paragraph">
<p>It’s also possible to generate a Karaf instance as a static distribution (kind of immutable):</p>
@@ -1665,12 +1675,12 @@ META-INF in the kar, without getting ins
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>keyFile</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>File</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The key file to use to connecto to the running Karaf instance.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The key file to use to connect to the running Karaf instance.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>attempts</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>int</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The number of tentative to connect to the running Karaf instance. Default value: 0</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number of attempts to connect to the running Karaf instance. Default value: 0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>delay</code></p></td>
@@ -1757,12 +1767,12 @@ META-INF in the kar, without getting ins
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>keyFile</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>File</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The key file to use to connecto to the running Karaf instance.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The key file to use to connect to the running Karaf instance.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>attempts</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>int</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The number of tentative to connect to the running Karaf instance. Default value: 0</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number of attempts to connect to the running Karaf instance. Default value: 0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>delay</code></p></td>
@@ -1913,7 +1923,7 @@ META-INF in the kar, without getting ins
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-06-10 09:38:33 CEST
+Last updated 2019-11-25 06:20:02 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/log.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/log.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/log.html (original)
+++ karaf/site/production/manual/latest/log.html Mon Nov 25 06:35:17 2019
@@ -557,7 +557,7 @@ table.CodeRay td.code>pre{padding:0}
</ul>
</div>
<div class="paragraph">
-<p>It means that the applications can use any logging framework, Apache Karaf will use the central log system to manage the
+<p>It means that applications can use any logging framework, Apache Karaf will use the central log system to manage the
loggers, appenders, etc.</p>
</div>
<div class="sect3">
@@ -569,7 +569,7 @@ loggers, appenders, etc.</p>
<p>This file is a <a href="http://logging.apache.org/log4j/1.2/manual.html">standard Log4j configuration file</a>.</p>
</div>
<div class="paragraph">
-<p>You find the different Log4j element:</p>
+<p>You find the different Log4j elements:</p>
</div>
<div class="ulist">
<ul>
@@ -660,7 +660,7 @@ messages directly to standard output. It
</div>
</div>
<div class="paragraph">
-<p>The <code>out</code> appender is the default one. It’s rolling file appender that maintain and rotate 10 log files of 1MB each.
+<p>The <code>out</code> appender is the default one. It’s a rolling file appender that maintains and rotates 10 log files of 1MB each.
The log files are located in <code>data/log/karaf.log</code> by default.</p>
</div>
<div class="paragraph">
@@ -737,8 +737,8 @@ used by the log commands (see later).</p
<h4 id="_code_karaf_log_console_code_property"><code>karaf.log.console</code> property</h4>
<div class="paragraph">
<p>Before Karaf starts <em>proper</em> logging facilities (pax-logging), it may configure <code>java.util.logging</code>. Standard
-Java logging is used initially by <code>Main</code> class and <code>org.apache.karaf.main.lock.Lock</code> implementations.
-In order to configure logging level, please set system property <code>karaf.log.console</code> to one of standard JUL
+Java logging is used initially by the <code>Main</code> class and <code>org.apache.karaf.main.lock.Lock</code> implementations.
+In order to configure the logging level, please set the system property <code>karaf.log.console</code> to one of the standard JUL
levels:</p>
</div>
<div class="ulist">
@@ -866,7 +866,7 @@ You can limit the number of entries to d
</div>
</div>
<div class="paragraph">
-<p>You can also limit the number of entries stored and retain using the <code>size</code> property in <code>etc/org.apache.karaf.log.cfg</code> file:</p>
+<p>You can also limit the number of entries stored and retained using the <code>size</code> property in the <code>etc/org.apache.karaf.log.cfg</code> file:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -883,7 +883,7 @@ size = 500</pre>
You can disable the coloring using the <code>--no-color</code> option.</p>
</div>
<div class="paragraph">
-<p>The log entries format pattern doesn’t use the conversion pattern define in <code>etc/org.ops4j.pax.logging.cfg</code> file.
+<p>The log entries format pattern doesn’t use the conversion pattern defined in <code>etc/org.ops4j.pax.logging.cfg</code> file.
By default, it uses the <code>pattern</code> property defined in <code>etc/org.apache.karaf.log.cfg</code>.</p>
</div>
<div class="listingblock">
@@ -1038,7 +1038,7 @@ my.logger | INFO</pre>
<div class="paragraph">
<p>The purpose of the DEFAULT keyword is to delete the current level of the logger (and only the level, the other properties
like appender are not deleted)
-in order to use the level of the logger parent (logger are hierarchical).</p>
+in order to use the level of the logger parent (loggers are hierarchical).</p>
</div>
<div class="paragraph">
<p>For instance, you have defined the following loggers (in <code>etc/org.ops4j.pax.logging.cfg</code> file):</p>
@@ -1090,7 +1090,7 @@ my.logger.custom=appender2</pre>
<p>It means that, at runtime, the <code>my.logger.custom</code> logger uses the level of its parent <code>my.logger</code>, so <code>INFO</code>.</p>
</div>
<div class="paragraph">
-<p>Now, if we use DEFAULT keyword with the <code>my.logger</code> logger:</p>
+<p>Now, if we use the DEFAULT keyword with the <code>my.logger</code> logger:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -1111,7 +1111,7 @@ my.logger.custom=appender2</pre>
<p>So, both <code>my.logger.custom</code> and <code>my.logger</code> use the log level of the parent <code>rootLogger</code>.</p>
</div>
<div class="paragraph">
-<p>It’s not possible to use DEFAULT keyword with the <code>rootLogger</code> and it doesn’t have parent.</p>
+<p>It’s not possible to use the DEFAULT keyword with the <code>rootLogger</code> as it doesn’t have a parent.</p>
</div>
</div>
<div class="sect4">
@@ -1176,7 +1176,7 @@ my.logger.custom=appender2</pre>
<div class="sect4">
<h5 id="_filters">Filters</h5>
<div class="paragraph">
-<p>You can use filters on appender. Filters allow log events to be evaluated to determine if or how they should be published.</p>
+<p>You can use filters on an appender. Filters allow log events to be evaluated to determine if or how they should be published.</p>
</div>
<div class="paragraph">
<p>Log4j provides ready to use filters:</p>
@@ -1279,13 +1279,13 @@ log4j.appender.jms=org.apache.log4j.net.
<div class="sect4">
<h5 id="_error_handlers">Error handlers</h5>
<div class="paragraph">
-<p>Sometime, appenders can fail. For instance, a RollingFileAppender tries to write on the filesystem but the filesystem is full, or a JMS appender tries to send a message but the JMS broker is not there.</p>
+<p>Sometime, appenders can fail. For instance, a RollingFileAppender tries to write to the filesystem but the filesystem is full, or a JMS appender tries to send a message but the JMS broker is not there.</p>
</div>
<div class="paragraph">
-<p>As log can be very critical to you, you have to be inform that the log appender failed.</p>
+<p>As logs can be very critical to you, you have to be informed that the log appender failed.</p>
</div>
<div class="paragraph">
-<p>It’s the purpose of the error handlers. Appenders may delegate their error handling to error handlers, giving a chance to react to this appender errors.</p>
+<p>This is the purpose of the error handlers. Appenders may delegate their error handling to error handlers, giving a chance to react to the errors of the appender.</p>
</div>
<div class="paragraph">
<p>You have two error handlers available:</p>
@@ -1443,7 +1443,7 @@ You can now use your appender directly i
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/monitoring.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/monitoring.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/monitoring.html (original)
+++ karaf/site/production/manual/latest/monitoring.html Mon Nov 25 06:35:17 2019
@@ -535,7 +535,7 @@ table.CodeRay td.code>pre{padding:0}
<p>You can remotely connect to a running Apache Karaf instance using any JMX client (like jconsole).</p>
</div>
<div class="paragraph">
-<p>The Apache Karaf features provide a set of MBeans, dedicating for the monitoring and management.</p>
+<p>The Apache Karaf features provide a set of MBeans, dedicating to monitoring and management.</p>
</div>
<div class="sect3">
<h4 id="_connecting">Connecting</h4>
@@ -554,7 +554,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="paragraph">
-<p>If don’t need the remote JMX at all, users can remove</p>
+<p>If you don’t need the remote JMX at all, users can remove</p>
</div>
<div class="listingblock">
<div class="content">
@@ -565,8 +565,8 @@ table.CodeRay td.code>pre{padding:0}
<p>from bin/karaf|bin/karaf.bat to avoid opening the RMI listening port.</p>
</div>
<div class="paragraph">
-<p>You have to provide an username and password to access to the JMX layer.
-The JMX layer user the security framework, and so, by default, it uses the users defined in <code>etc/users.properties</code>.</p>
+<p>You have to provide an username and password to access the JMX layer.
+The JMX layer uses the security framework, and so, by default, it uses the users defined in <code>etc/users.properties</code>.</p>
</div>
<div class="paragraph">
<p>You can change the port numbers of the JMX layer in the <code>etc/org.apache.karaf.management.cfg</code> configuration file.</p>
@@ -928,7 +928,7 @@ Enter host password for user 'karaf':
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-11-23 07:24:48 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/obr.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/obr.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/obr.html (original)
+++ karaf/site/production/manual/latest/obr.html Mon Nov 25 06:35:17 2019
@@ -557,7 +557,7 @@ from a bundle repository. This makes it
</div>
</div>
<div class="paragraph">
-<p>The OBR feature turns Apache Karaf as an OBR client. It means that Apache Karaf can use a OBR repository to the installation
+<p>The OBR feature turns Apache Karaf into an OBR client. It means that Apache Karaf can use a OBR repository for the installation
of the bundles, and during the installation of the features.</p>
</div>
<div class="paragraph">
@@ -641,7 +641,7 @@ Index | OBR URL
<div class="sect4">
<h5 id="_code_obr_url_refresh_code"><code>obr:url-refresh</code></h5>
<div class="paragraph">
-<p>The <code>obr:url-refresh</code> command refresh an OBR repository (reloading the URL).</p>
+<p>The <code>obr:url-refresh</code> command refreshes an OBR repository (reloading the URL).</p>
</div>
<div class="paragraph">
<p>The OBR service doesn’t take "on the fly" the changes performed on an OBR repository <code>repository.xml</code>. You have to
@@ -1013,7 +1013,7 @@ by the OBR service (meaning installing m
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-05-18 16:02:21 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/os-integration.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/os-integration.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/os-integration.html (original)
+++ karaf/site/production/manual/latest/os-integration.html Mon Nov 25 06:35:17 2019
@@ -560,7 +560,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect3">
<h4 id="_service_wrapper">Service Wrapper</h4>
<div class="paragraph">
-<p>The "Service Wrapper" correctly handles "user’s log outs" under Windows, service dependencies, and the ability to run services which interact with the desktop.</p>
+<p>The "Service Wrapper" correctly handles "user log outs" under Windows, service dependencies, and the ability to run services which interact with the desktop.</p>
</div>
<div class="paragraph">
<p>It also includes advanced fault detection software which monitors an application.
@@ -643,7 +643,7 @@ OPTIONS
</div>
</div>
<div class="paragraph">
-<p>The <code>wrapper:install</code> command detects the running Operating Service and provide the service/daemon ready to be integrated in your system.</p>
+<p>The <code>wrapper:install</code> command detects the running Operating Service and provides the service/daemon ready to be integrated in your system.</p>
</div>
<div class="paragraph">
<p>For instance, on a Ubuntu/Debian Linux system:</p>
@@ -711,7 +711,7 @@ update-rc.d karaf-service defaults</pre>
</div>
</div>
<div class="paragraph">
-<p>Karaf also supports systemd service, so you can use systemctl instead of SystemV based service:</p>
+<p>Karaf also supports the systemd service, so you can use systemctl instead of a SystemV based service:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -725,7 +725,7 @@ update-rc.d karaf-service defaults</pre>
<div class="sect4">
<h5 id="_uninstall">Uninstall</h5>
<div class="paragraph">
-<p>The <code>wrapper:install</code> provides the system commands to perform to uninstall the service/daemon).</p>
+<p>The <code>wrapper:install</code> provides the system commands to perform to uninstall the service/daemon.</p>
</div>
<div class="paragraph">
<p>For instance, on Ubuntu/Debian, to uninstall the Apache Karaf service, you have to remove the <code>karaf-service</code> script from the runlevel scripts:</p>
@@ -755,7 +755,7 @@ update-rc.d karaf-service defaults</pre>
<div class="sect4">
<h5 id="_note_for_macos_users">Note for MacOS users</h5>
<div class="paragraph">
-<p>On MacOS you can install the service for an user or for the system.</p>
+<p>On MacOS you can install the service for a user or for the system.</p>
</div>
<div class="paragraph">
<p>If you want to add <code>bin/org.apache.karaf.KARAF</code> as user service move this file into <code>~/Library/LaunchAgents/</code>:</p>
@@ -827,7 +827,7 @@ launchctl stop org.apache.karaf.KARAF</p
<p>To configure Apache Karaf started by the Service Wrapper, you have to tune the <code>etc/karaf-wrapper.conf</code> file. If you provided the <code>name</code> option to the <code>wrapper:install</code> command, the file is <code>etc/karaf-yourname.conf</code>.</p>
</div>
<div class="paragraph">
-<p>In this file, you can configure the different environment variables used by Apache Karaf. The Service Wrapper installer automatically populate these variables for you during the installation (using <code>wrapper:install</code> command).
+<p>In this file, you can configure the different environment variables used by Apache Karaf. The Service Wrapper installer automatically populates these variables for you during the installation (using <code>wrapper:install</code> command).
For instance:</p>
</div>
<div class="ulist">
@@ -881,12 +881,12 @@ For instance:</p>
<p><code>wrapper.ntservice.description</code> is Windows service specific and defines the Windows service description. It’s set to the <code>description</code> option of the <code>wrapper:install</code> command, or empty by default.</p>
</li>
<li>
-<p><code>wrapper.ntservice.starttype</code> is Windows service specific and defines if the Windows service is started automatically with the service, or just on demand. It’s set to <code>AUTO_START</code> by default, and could be switch to <code>DEMAND_START</code>.</p>
+<p><code>wrapper.ntservice.starttype</code> is Windows service specific and defines if the Windows service is started automatically with the service, or just on demand. It’s set to <code>AUTO_START</code> by default, and could be switched to <code>DEMAND_START</code>.</p>
</li>
</ul>
</div>
<div class="paragraph">
-<p>This is a example of generated <code>etc/karaf-wrapper.conf</code> file:</p>
+<p>This is a example of the generated <code>etc/karaf-wrapper.conf</code> file:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -1042,7 +1042,7 @@ wrapper.ntservice.interactive=false</pre
</td>
<td class="content">
<div class="paragraph">
-<p>As opposite of Service Wrapper, the templates targeting Unix system do not rely on a 3th party binaries</p>
+<p>As opposed to the Service Wrapper, the templates targeting Unix systems do not rely on 3rd party binaries</p>
</div>
</td>
</tr>
@@ -1057,7 +1057,7 @@ wrapper.ntservice.interactive=false</pre
<div class="sect4">
<h5 id="_unix">Unix</h5>
<div class="paragraph">
-<p>The karaf-service.sh utility helps you to generate ready to use scripts by automatically identify the operating system, the default init system and the template to use.</p>
+<p>The karaf-service.sh utility helps you to generate ready to use scripts by automatically identifying the operating system, the default init system and the template to use.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -1157,7 +1157,7 @@ wrapper.ntservice.interactive=false</pre
<div class="sect4">
<h5 id="_systemd">Systemd</h5>
<div class="paragraph">
-<p>When karaf-service.sh detect Systemd, it generates three files:</p>
+<p>When karaf-service.sh detects Systemd, it generates three files:</p>
</div>
<div class="ulist">
<ul>
@@ -1193,7 +1193,7 @@ $ systemctl enable karaf-4.service</pre>
<div class="sect4">
<h5 id="_sysv">SysV</h5>
<div class="paragraph">
-<p>When karaf-service.sh detect a SysV system, it generates two files:</p>
+<p>When karaf-service.sh detects a SysV system, it generates two files:</p>
</div>
<div class="ulist">
<ul>
@@ -1237,7 +1237,7 @@ $ chkconfig karaf-4 on</pre>
<div class="sect4">
<h5 id="_solaris_smf">Solaris SMF</h5>
<div class="paragraph">
-<p>When karaf-service.sh detect a Solaris system, it generates a single file:</p>
+<p>When karaf-service.sh detects a Solaris system, it generates a single file:</p>
</div>
<div class="literalblock">
<div class="title">Example</div>
@@ -1304,7 +1304,7 @@ C:\opt\apache-karaf-4\bin\contrib> ka
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/overview.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/overview.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/overview.html (original)
+++ karaf/site/production/manual/latest/overview.html Mon Nov 25 06:35:17 2019
@@ -530,11 +530,11 @@ table.CodeRay td.code>pre{padding:0}
<h2 id="_overview">Overview</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Apache Karaf is a modern and polymorphic container.</p>
+<p>Apache Karaf is a modern polymorphic application container.</p>
</div>
<div class="paragraph">
-<p>Karaf can be used standalone as a container, supporting a wide range of applications and technologies.
-It also supports the "run anywhere" (on any machine with Java, cloud, docker images, …​) using the embedded mode.</p>
+<p>Karaf can be used as a standalone container, supporting a wide range of applications and technologies.
+It also supports the "run anywhere" concept (on any machine with Java, cloud, docker images, …​) using the embedded mode.</p>
</div>
<div class="paragraph">
<p>It’s a lightweight, powerful, and enterprise ready platform.</p>
@@ -606,7 +606,7 @@ Framework, but you can easily switch to
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-02-14 08:12:58 CET
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/provisioning.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/provisioning.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/provisioning.html (original)
+++ karaf/site/production/manual/latest/provisioning.html Mon Nov 25 06:35:17 2019
@@ -534,7 +534,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect3">
<h4 id="_application">Application</h4>
<div class="paragraph">
-<p>By provisioning application, it means install all modules, configuration, and transitive applications.</p>
+<p>By provisioning an application, it means to install all modules, configuration, and transitive applications.</p>
</div>
</div>
<div class="sect3">
@@ -546,7 +546,7 @@ table.CodeRay td.code>pre{padding:0}
<p>An OSGi application is a set of OSGi bundles. An OSGi bundle is a regular jar file, with additional metadata in the jar MANIFEST.</p>
</div>
<div class="paragraph">
-<p>In OSGi, a bundle can depend to other bundles. So, it means that to deploy an OSGi application, most of the time, you have
+<p>In OSGi, a bundle can depend on other bundles. So, it means that to deploy an OSGi application, most of the time, you have
to firstly deploy a lot of other bundles required by the application.</p>
</div>
<div class="paragraph">
@@ -555,7 +555,7 @@ to satisfy their own dependencies.</p>
</div>
<div class="paragraph">
<p>More over, typically, an application requires configuration (see the [Configuration section|configuration] of the user guide).
-So, before being able to start your application, in addition of the dependency bundles, you have to create or deploy the
+So, before being able to start your application, in addition to the dependency bundles, you have to create or deploy the
configuration.</p>
</div>
<div class="paragraph">
@@ -597,10 +597,10 @@ configuration.</p>
</div>
<div class="paragraph">
<p>When you install a feature, Apache Karaf installs all resources described in the feature. It means that it will
-automatically resolves and installs all bundles, configurations, and dependency features described in the feature.</p>
+automatically resolve and install all bundles, configuration, and dependency features described in the feature.</p>
</div>
<div class="paragraph">
-<p>The feature resolver checks the service requirements, and install the bundles providing the services matching the requirements.
+<p>The feature resolver checks the service requirements, and installs the bundles providing the services matching the requirements.
The default mode enables this behavior only for "new style" features repositories (basically, the features repositories XML with
schema equal or greater to 1.3.0). It doesn’t apply for "old style" features repositories (coming from Karaf 2 or 3).</p>
</div>
@@ -629,7 +629,7 @@ schema equal or greater to 1.3.0). It do
</ul>
</div>
<div class="paragraph">
-<p>Additionally, a feature can also define requirements. In that case, Karaf can automatically additional bundles or features
+<p>Additionally, a feature can also define requirements. In that case, Karaf can automatically install additional bundles or features
providing the capabilities to satisfy the requirements.</p>
</div>
<div class="paragraph">
@@ -667,13 +667,13 @@ the features repository that provides th
for details.
The <code>feature1</code> feature is available in version <code>1.0.0</code>, and contains two bundles. The <code><bundle/></code> element contains a URL
to the bundle artifact (see [Artifacts repositories and URLs section|urls] for details). If you install the <code>feature1</code> feature
-(using <code>feature:install</code> or the FeatureMBean as described later), Apache Karaf will automatically installs the two bundles
+(using <code>feature:install</code> or the FeatureMBean as described later), Apache Karaf will automatically install the two bundles
described.
The <code>feature2</code> feature is available in version <code>1.1.0</code>, and contains a reference to the <code>feature1</code> feature and a bundle.
The <code><feature/></code> element contains the name of a feature. A specific feature version can be defined using the <code>version</code>
attribute to the <code><feature/></code> element (<code><feature version="1.0.0">feature1</feature></code>). If the <code>version</code> attribute is
not specified, Apache Karaf will install the latest version available. If you install the <code>feature2</code> feature (using <code>feature:install</code>
-or the FeatureMBean as described later), Apache Karaf will automatically installs <code>feature1</code> (if it’s not already installed)
+or the FeatureMBean as described later), Apache Karaf will automatically install <code>feature1</code> (if it’s not already installed)
and the bundle.</p>
</div>
<div class="paragraph">
@@ -682,8 +682,8 @@ and the bundle.</p>
<div class="paragraph">
<p>The features state is stored in the Apache Karaf cache (in the <code>KARAF_DATA</code> folder). You can restart Apache Karaf, the
previously installed features remain installed and available after restart.
-If you do a clean restart or you delete the Apache Karaf cache (delete the <code>KARAF_DATA</code> folder), all previously features
-repositories registered and features installed will be lost: you will have to register the features repositories and install
+If you do a clean restart or you delete the Apache Karaf cache (delete the <code>KARAF_DATA</code> folder), all previously registered features
+repositories and features installed will be lost: you will have to register the features repositories and install
features by hand again.
To prevent this behaviour, you can specify features as boot features.</p>
</div>
@@ -691,11 +691,10 @@ To prevent this behaviour, you can speci
<div class="sect3">
<h4 id="_boot_features">Boot features</h4>
<div class="paragraph">
-<p>You can describe some features as boot features. A boot feature will be automatically install by Apache Karaf, even if it has
-not been previously installed using <code>feature:install</code> or FeatureMBean.</p>
+<p>A boot feature is automatically installed by Apache Karaf, even if it has not been previously installed using <code>feature:install</code> or FeatureMBean.</p>
</div>
<div class="paragraph">
-<p>Apache Karaf features configuration is located in the <code>etc/org.apache.karaf.features.cfg</code> configuration file.</p>
+<p>The Apache Karaf features configuration is located in the <code>etc/org.apache.karaf.features.cfg</code> configuration file.</p>
</div>
<div class="paragraph">
<p>This configuration file contains the two properties to use to define boot features:</p>
@@ -710,6 +709,50 @@ not been previously installed using <cod
</li>
</ul>
</div>
+<div class="exampleblock">
+<div class="content">
+<div class="paragraph">
+<p>To remove features from the <code>featuresBoot</code> list in the <code>etc/org.apache.karaf.features.cfg</code> configuration file:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Navigate to <code>etc/org.apache.karaf.features.cfg</code>.</p>
+</li>
+<li>
+<p>Remove the undesired feature.</p>
+</li>
+<li>
+<p>Restart your container.</p>
+</li>
+</ol>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+After the restart, the features will be present in the <code>etc/org.apache.karaf.features.cfg</code> configuration file, but they will not be installed and the undesired feature or behavior will no longer be present or active.
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+Another way to clean up the <code>featuresBoot</code> is to stop Karaf, update <code>featuresBoot</code>, and remove the <strong>data</strong> folder.
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
</div>
<div class="sect3">
<h4 id="_features_upgrade">Features upgrade</h4>
@@ -747,7 +790,7 @@ would overide pax-logging-service 1.8.3
configuration file, in the <code>karaf.startlevel.bundle</code> property.</p>
</div>
<div class="paragraph">
-<p>This value can be "overrided" by the <code>start-level</code> attribute of the <code><bundle/></code> element, in the features XML.</p>
+<p>This value can be "overridden" by the <code>start-level</code> attribute of the <code><bundle/></code> element, in the features XML.</p>
</div>
<div class="listingblock">
<div class="content">
@@ -758,7 +801,7 @@ configuration file, in the <code>karaf.s
</div>
</div>
<div class="paragraph">
-<p>The start-level attribute insure that the <code>myproject-dao</code> bundle is started before the bundles that use it.</p>
+<p>The start-level attribute insures that the <code>myproject-dao</code> bundle is started before the bundles that use it.</p>
</div>
<div class="paragraph">
<p>Instead of using start-level, a better solution is to simply let the OSGi framework know what your dependencies are by
@@ -799,7 +842,7 @@ To do so, a feature can specify the <cod
<div class="sect3">
<h4 id="_dependent_features">Dependent features</h4>
<div class="paragraph">
-<p>A feature can depend to a set of other features:</p>
+<p>A feature can depend on a set of other features:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -839,7 +882,7 @@ To do so, a feature can specify the <cod
<div class="sect4">
<h5 id="_feature_prerequisites">Feature prerequisites</h5>
<div class="paragraph">
-<p>Prerequisite feature is special kind of dependency. If you will add <code>prerequisite</code> attribute to dependant feature tag then it will force installation and also activation of bundles in dependant feature before installation of actual feature. This may be handy in case if bundles enlisted in given feature are not using pre installed URL such <code>wrap</code> or <code>war</code>.</p>
+<p>A prerequisite feature is a special kind of dependency. If you add the <code>prerequisite</code> attribute to dependant feature tag then it will force installation and also activation of bundles in the dependant feature before the installation of the actual feature. This may be handy in the case that bundles enlisted in a given feature are not using pre installed URLs such as <code>wrap</code> or <code>war</code>.</p>
</div>
</div>
</div>
@@ -917,7 +960,7 @@ the features and bundles capabilities an
<p>The requirement specifies that the feature will work by only if the JDK version is not 1.8 (so basically 1.7).</p>
</div>
<div class="paragraph">
-<p>The features resolver is also able to refresh the bundles when an optional dependency is satisfy, rewiring the optional import.</p>
+<p>The features resolver is also able to refresh the bundles when an optional dependency is satisfied, rewiring the optional import.</p>
</div>
</div>
</div>
@@ -926,7 +969,7 @@ the features and bundles capabilities an
<div class="sect4">
<h5 id="_code_feature_repo_list_code"><code>feature:repo-list</code></h5>
<div class="paragraph">
-<p>The <code>feature:repo-list</code> command lists all registered features repository:</p>
+<p>The <code>feature:repo-list</code> command lists all registered feature repositories:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -1277,7 +1320,7 @@ Done.</pre>
</div>
<div class="paragraph">
<p>If a feature contains a bundle which is already installed, by default, Apache Karaf will refresh this bundle.
-Sometime, this refresh can cause issue to other running applications. If you want to disable the auto-refresh of installed
+Sometime, this refresh can cause an issue with other running applications. If you want to disable the auto-refresh of installed
bundles, you can use the <code>-r</code> option:</p>
</div>
<div class="listingblock">
@@ -1313,7 +1356,7 @@ the wiring in other bundles.</p>
<div class="sect4">
<h5 id="_code_feature_stop_code"><code>feature:stop</code></h5>
<div class="paragraph">
-<p>You can also stop a feature: it means that all services provided by the feature will be stop and removed from the service registry. However, the packages
+<p>You can also stop a feature: it means that all services provided by the feature will be stopped and removed from the service registry. However, the packages
are still available for the wiring (the bundles are in resolved state).</p>
</div>
</div>
@@ -1344,9 +1387,17 @@ themselves if not used by other feature.
<p>Apache Karaf provides a features deployer.</p>
</div>
<div class="paragraph">
-<p>When you drop a features XML in the deploy folder, the features deployer does:
-* register the features XML as a features repository
-* the features with <code>install</code> attribute set to "auto" will be automatically installed by the features deployer.</p>
+<p>When you drop a features XML in the deploy folder, the features deployer does:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>register the features XML as a features repository</p>
+</li>
+<li>
+<p>the features with <code>install</code> attribute set to "auto" will be automatically installed by the features deployer.</p>
+</li>
+</ul>
</div>
<div class="paragraph">
<p>For instance, dropping the following XML in the deploy folder will automatically install feature1 and feature2, whereas
@@ -1500,7 +1551,7 @@ feature3 won’t be installed:</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-06-10 09:38:33 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/quick-start.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/quick-start.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/quick-start.html (original)
+++ karaf/site/production/manual/latest/quick-start.html Mon Nov 25 06:35:17 2019
@@ -546,7 +546,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect2">
<h3 id="_prerequisites">Prerequisites</h3>
<div class="paragraph">
-<p>Karaf requires a Java SE 8 or Java SE 9 environment to run. Refer to <a href="http://www.oracle.com/technetwork/java/javase/" class="bare">http://www.oracle.com/technetwork/java/javase/</a> for details on how to download and install Java SE 1.8 or greater.</p>
+<p>Karaf requires a Java SE 8 or higher to run. Refer to <a href="http://www.oracle.com/technetwork/java/javase/" class="bare">http://www.oracle.com/technetwork/java/javase/</a> for details on how to download and install Java SE 1.8 or greater.</p>
</div>
<div class="ulist">
<ul>
@@ -681,7 +681,7 @@ OPTIONS
</div>
<div class="listingblock">
<div class="content">
-<pre>feature:repo-add camel 2.20.0
+<pre>feature:repo-add camel
feature:install deployer camel-blueprint aries-blueprint
cat > deploy/example.xml <<END
<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">
@@ -701,8 +701,8 @@ END</pre>
</div>
</div>
<div class="paragraph">
-<p>The example installed is using Camel to start a timer every 2 seconds and output a message in the log.
-The previous commands download the Camel features descriptor and install the example feature.</p>
+<p>The example that is installed is using Camel to start a timer every 2 seconds and output a message in the log.
+The previous commands downloaded the Camel features descriptor and installed the example feature.</p>
</div>
<div class="paragraph">
<p>You can display the log in the shell:</p>
@@ -775,7 +775,7 @@ karaf@root()></pre>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/remote.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/remote.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/remote.html (original)
+++ karaf/site/production/manual/latest/remote.html Mon Nov 25 06:35:17 2019
@@ -546,7 +546,7 @@ container and services running inside of
(see the <a href="security">Security section</a> of the user guide for details).</p>
</div>
<div class="paragraph">
-<p>In addition of the remote console, Apache Karaf also provides a remote filesystem. This remote filesystem can be accessed
+<p>In addition to the remote console, Apache Karaf also provides a remote filesystem. This remote filesystem can be accessed
using a SCP/SFTP client.</p>
</div>
<div class="sect4">
@@ -609,9 +609,9 @@ hostKey = ${karaf.etc}/host.key
#hostKeyPub = ${karaf.etc}/host.key.pub
#
-# Role name used for SSH access authorization
+# sshRole defines the role required to access the console through ssh
#
-# sshRole = admin
+# sshRole = ssh
#
# Defines if the SFTP system is enabled or not in the SSH server
@@ -653,7 +653,7 @@ completionMode = GLOBAL</pre>
</li>
<li>
<p><code>sshHost</code> is the address of the network interface where the SSHd server is bound. The default value is 0.0.0.0,
-meaning that the SSHd server is bound on all network interfaces. You can bind on a target interface providing the IP
+meaning that the SSHd server is bound on all network interfaces. You can bind on a target interface by providing the IP
address of the network interface.</p>
</li>
<li>
@@ -664,16 +664,16 @@ private key of the SSHd server.</p>
<p><code>sshRole</code> is the default role used for SSH access. See the [Security section|security] of this user guide for details.</p>
</li>
<li>
-<p><code>sftpEnabled</code> controls if the SSH server start the SFTP system or not. When enabled, Karaf SSHd supports SFTP, meaning
-that you can remotely access to the Karaf filesystem with any sftp clients.</p>
+<p><code>sftpEnabled</code> controls if the SSH server starts the SFTP system or not. When enabled, Karaf SSHd supports SFTP, meaning
+that you can remotely access the Karaf filesystem with any sftp client.</p>
</li>
<li>
<p><code>keySize</code> is the key size used by the SSHd server. The possible values are 1024, 2048, 3072, or 4096. The default
-value is 1024.</p>
+value is 2048.</p>
</li>
<li>
-<p><code>algorithm</code> is the host key algorithm used by the SSHd server. The possible values are DSA or RSA. The default
-value is DSA.</p>
+<p><code>algorithm</code> is the host key algorithm used by the SSHd server. The possible values are DSA, EC or RSA. The default
+value is RSA.</p>
</li>
</ul>
</div>
@@ -708,10 +708,10 @@ You can do it with:</p>
<div class="sect5">
<h6 id="_system_native_clients">System native clients</h6>
<div class="paragraph">
-<p>The Apache Karaf SSHd server is a pure SSHd server, similar to OpenSSH daemon.</p>
+<p>The Apache Karaf SSHd server is a pure SSHd server, similar to a OpenSSH daemon.</p>
</div>
<div class="paragraph">
-<p>It means that you can use directly a SSH client from your system.</p>
+<p>It means that you can directly use a SSH client from your system.</p>
</div>
<div class="paragraph">
<p>For instance, on Unix, you can directly use OpenSSH:</p>
@@ -744,7 +744,7 @@ karaf@root()></pre>
<p>On Windows, you can use Putty, Kitty, etc.</p>
</div>
<div class="paragraph">
-<p>If you don’t have SSH client installed on your machine, you can use Apache Karaf client.</p>
+<p>If you don’t have a SSH client installed on your machine, you can use the Apache Karaf client.</p>
</div>
</div>
<div class="sect5">
@@ -825,7 +825,7 @@ Connected</pre>
</div>
</div>
<div class="paragraph">
-<p>As the <code>ssh:ssh</code> command is a pure SSH client, so it means that you can connect to a Unix OpenSSH daemon:</p>
+<p>As the <code>ssh:ssh</code> command is a pure SSH client, it means that you can connect to a Unix OpenSSH daemon:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -843,10 +843,10 @@ user@server:~$</pre>
<div class="sect5">
<h6 id="_apache_karaf_client">Apache Karaf client</h6>
<div class="paragraph">
-<p>The <code>ssh:ssh</code> command requires to be run into a running Apache Karaf console.</p>
+<p>The <code>ssh:ssh</code> command can only be run in a running Apache Karaf console.</p>
</div>
<div class="paragraph">
-<p>For commodity, the <code>ssh:ssh</code> command is "wrapped" as a standalone client: the <code>bin/client</code> Unix script (<code>bin\client.bat</code> on Windows).</p>
+<p>For convenience, the <code>ssh:ssh</code> command is "wrapped" as a standalone client: the <code>bin/client</code> Unix script (<code>bin\client.bat</code> on Windows).</p>
</div>
<div class="listingblock">
<div class="content">
@@ -866,7 +866,7 @@ If no commands are specified, the client
</div>
</div>
<div class="paragraph">
-<p>For instance, to connect to local Apache Karaf instance (on the default SSHd server 8101 port), you can directly use
+<p>For instance, to connect to a local Apache Karaf instance (on the default SSHd server 8101 port), you can directly use
<code>bin/client</code> Unix script (<code>bin\client.bat</code> on Windows) without any argument or option:</p>
</div>
<div class="listingblock">
@@ -930,7 +930,7 @@ Last login: Tue Dec 3 18:18:31 2013 fro
<div class="ulist">
<ul>
<li>
-<p>using CTRL-D key binding. Note that CTRL-D just logout from the remote console in this case, it doesn’t shutdown
+<p>using CTRL-D key binding. Note that CTRL-D just logs out from the remote console in this case, it doesn’t shutdown
the Apache Karaf instance (as CTRL-D does when used on a local console).</p>
</li>
<li>
@@ -941,9 +941,9 @@ the Apache Karaf instance (as CTRL-D doe
</div>
</div>
<div class="sect4">
-<h5 id="_filsystem_clients">Filsystem clients</h5>
+<h5 id="_filesystem_clients">Filesystem clients</h5>
<div class="paragraph">
-<p>Apache Karaf SSHd server also provides complete fileystem access via SSH. For security reason, the available filesystem
+<p>Apache Karaf SSHd server also provides complete fileystem access via SSH. For security reasons, the available filesystem
is limited to <code>KARAF_BASE</code> directory.</p>
</div>
<div class="paragraph">
@@ -977,7 +977,7 @@ folder, retrieve log files, populate the
<p>It’s probably easier to use a SFTP complient client.</p>
</div>
<div class="paragraph">
-<p>For instance, on Unix system, you can use <code>lftp</code> or <code>ncftp</code>:</p>
+<p>For instance, on a Unix system, you can use <code>lftp</code> or <code>ncftp</code>:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -1002,7 +1002,7 @@ lftp karaf@localhost:/></pre>
</div>
</div>
<div class="paragraph">
-<p>You can also use graphic client like <code>filezilla</code>, <code>gftp</code>, <code>nautilus</code>, etc.</p>
+<p>You can also use a graphic client like <code>filezilla</code>, <code>gftp</code>, <code>nautilus</code>, etc.</p>
</div>
<div class="paragraph">
<p>On Windows, you can use <code>filezilla</code>, <code>WinSCP</code>, etc.</p>
@@ -1011,7 +1011,7 @@ lftp karaf@localhost:/></pre>
<div class="sect5">
<h6 id="_apache_maven">Apache Maven</h6>
<div class="paragraph">
-<p>Apache Karaf <code>system</code> folder is the Karaf repository, that use a Maven directory structure. It’s where Apache Karaf
+<p>The Apache Karaf <code>system</code> folder is the Karaf repository, that uses a Maven directory structure. It’s where Apache Karaf
looks for the artifacts (bundles, features, kars, etc).</p>
</div>
<div class="paragraph">
@@ -1058,7 +1058,7 @@ looks for the artifacts (bundles, featur
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-07-08 15:10:49 CEST
+Last updated 2019-11-25 06:19:58 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/scheduler.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/scheduler.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/scheduler.html (original)
+++ karaf/site/production/manual/latest/scheduler.html Mon Nov 25 06:35:17 2019
@@ -872,14 +872,14 @@ org.quartz.jobStore.driverDelegateClass=
</div>
</div>
<div class="paragraph">
-<p>Then several Karaf instances scheduler will share the same JDBC job store and can work in a "cluster" way.</p>
+<p>Then several Karaf instances scheduler will share the same JDBC job store and can work in a "clustered" way.</p>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-05-21 15:18:22 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/scripting.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/scripting.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/scripting.html (original)
+++ karaf/site/production/manual/latest/scripting.html Mon Nov 25 06:35:17 2019
@@ -543,7 +543,7 @@ hello world</pre>
</div>
</div>
<div class="paragraph">
-<p>You can also assign value to session variables:</p>
+<p>You can also assign a value to session variables:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -826,7 +826,7 @@ karaf@root()> %(SQRT(a^2 + b^2))
<div class="sect3">
<h4 id="_list_maps_pipes_and_closures">List, maps, pipes and closures</h4>
<div class="paragraph">
-<p>Using [], you can define array variable:</p>
+<p>Using [], you can define an array variable:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -864,7 +864,7 @@ Mar 3</pre>
</div>
</div>
<div class="paragraph">
-<p>You can assign name to script execution. It’s what we use for alias:</p>
+<p>You can assign a name to a script execution. It’s what we use for alias:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -918,7 +918,7 @@ karaf@root></pre>
<div class="sect3">
<h4 id="_built_in_variables_and_commands">Built-in variables and commands</h4>
<div class="paragraph">
-<p>Apache Karaf console provides built-in variable very useful for scripting:</p>
+<p>Apache Karaf console provides built-in variables that are very useful for scripting:</p>
</div>
<div class="ulist">
<ul>
@@ -1002,7 +1002,7 @@ root</pre>
</div>
</div>
<div class="paragraph">
-<p>It means that you can create object using the <code>new</code> directive, and call methods on the objects:</p>
+<p>It means that you can create an object using the <code>new</code> directive, and call methods on the objects:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -1019,7 +1019,7 @@ karaf@root> $map
<p>The following examples show some scripts defined in <code>etc/shell.init.script</code>.</p>
</div>
<div class="paragraph">
-<p>The first example show a script to add a value into a configuration list:</p>
+<p>The first example shows a script to add a value into a configuration list:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -1083,7 +1083,7 @@ wait-for-command = {
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-05-18 16:02:21 CEST
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/security-framework.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/security-framework.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/security-framework.html (original)
+++ karaf/site/production/manual/latest/security-framework.html Mon Nov 25 06:35:17 2019
@@ -648,7 +648,7 @@ JMX layer), you need to deploy a JAAS co
<h4 id="_architecture">Architecture</h4>
<div class="paragraph">
<p>Due to constraints in the JAAS specification, one class has to be available for all bundles.
-This class is called ProxyLoginModule and is a LoginModule that acts as a proxy for an OSGi defines LoginModule.
+This class is called ProxyLoginModule and is a LoginModule that acts as a proxy for an OSGi defined LoginModule.
If you plan to integrate this feature into another OSGi runtime, this class must be made available from the system
classloader and the related package be part of the boot delegation classpath (or be deployed as a fragment attached to
the system bundle).</p>
@@ -664,10 +664,10 @@ the bundle containing the real login mod
<p>Karaf itself provides a set of login modules ready to use, depending of the authentication backend that you need.</p>
</div>
<div class="paragraph">
-<p>In addition of the login modules, Karaf also support backend engine. The backend engine is coupled to a login module and
+<p>In addition to the login modules, Karaf also supports backend engines. The backend engine is coupled to a login module and
allows you to manipulate users and roles directly from Karaf (adding a new user, delete an existing user, etc).
The backend engine is constructed by a backend engine factory, registered as an OSGi service.
-Some login modules (for security reason for instance) don’t provide backend engine.</p>
+Some login modules (for security reasons for instance) don’t provide backend engine.</p>
</div>
</div>
<div class="sect3">
@@ -1149,6 +1149,10 @@ services via JNDI.</p>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ssl.truststore</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The trust store name to use for SSL. The trust store must be deployed using a <code>jaas:keystore</code> configuration.</p></td>
</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignorePartialResultException</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Workaround for Active Directory servers not handling referrals correctly. When the <code>context.java.naming.referral</code> parameter is <code>false</code> (as it is by default), this will prevent `PartialResultException`s from being thrown during enumeration of search results.</p></td>
+</tr>
</tbody>
</table>
<div class="paragraph">
@@ -1733,7 +1737,7 @@ specification classes. In order to provi
JAAS implementation role policies have been created.</p>
</div>
<div class="paragraph">
-<p>A role policy is a convention that can be adopted by the application in order to identify Roles, without depending from the implementation.
+<p>A role policy is a convention that can be adopted by the application in order to identify Roles, without depending on the implementation.
Each role policy can be cofigured by setting a "role.policy" and "role.discriminator" property to the login module configuration.
Currently, Karaf provides two policies that can be applied to all Karaf Login Modules.</p>
</div>
@@ -1850,7 +1854,7 @@ for (Principal p : subject.getPrincipals
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-03-12 21:01:55 CET
+Last updated 2019-11-20 06:47:46 CET
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/security.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/security.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/security.html (original)
+++ karaf/site/production/manual/latest/security.html Mon Nov 25 06:35:17 2019
@@ -565,7 +565,7 @@ authentication and/or authorization on t
the realm.</p>
</div>
<div class="paragraph">
-<p>The <code>jaas:realm-list</code> command list the current defined realms:</p>
+<p>The <code>jaas:realm-list</code> command lists the current defined realms:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -679,7 +679,7 @@ The default password is <code>karaf</cod
<p>The <code>karaf</code> user is member of one group: the <code>admingroup</code>.</p>
</div>
<div class="paragraph">
-<p>A group is always prefixed by <code><em>g</em>:</code>. An entry without this prefix is an user.</p>
+<p>A group is always prefixed by <code><em>g</em>:</code>. An entry without this prefix is a user.</p>
</div>
<div class="paragraph">
<p>A group defines a set of roles. By default, the <code>admingroup</code> defines <code>group</code>, <code>admin</code>, <code>manager</code>, and <code>viewer</code>
@@ -699,7 +699,7 @@ roles.</p>
<p>We already used the <code>jaas:realm-list</code> previously in this section.</p>
</div>
<div class="paragraph">
-<p>The <code>jaas:realm-list</code> command list the realm and the login modules for each realm:</p>
+<p>The <code>jaas:realm-list</code> command lists the realm and the login modules for each realm:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -793,7 +793,7 @@ foo | |</pre>
<div class="sect5">
<h6 id="_code_jaas_user_delete_code"><code>jaas:user-delete</code></h6>
<div class="paragraph">
-<p>The <code>jaas:user-delete</code> command deletes an user from the currently edited login module:</p>
+<p>The <code>jaas:user-delete</code> command deletes a user from the currently edited login module:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -819,7 +819,7 @@ karaf | admingroup | viewer</pre>
<div class="sect5">
<h6 id="_code_jaas_group_add_code"><code>jaas:group-add</code></h6>
<div class="paragraph">
-<p>The <code>jaas:group-add</code> command assigns a group (and eventually creates the group) to an user in the currently edited login module:</p>
+<p>The <code>jaas:group-add</code> command assigns a group (and eventually creates the group) to a user in the currently edited login module:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -830,7 +830,7 @@ karaf | admingroup | viewer</pre>
<div class="sect5">
<h6 id="_code_jaas_group_delete_code"><code>jaas:group-delete</code></h6>
<div class="paragraph">
-<p>The <code>jaas:group-delete</code> command removes an user from a group in the currently edited login module:</p>
+<p>The <code>jaas:group-delete</code> command removes a user from a group in the currently edited login module:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -952,7 +952,7 @@ encryption.encoding = hexadecimal</pre>
<p>If the <code>encryption.enabled</code> property is set to true, the password encryption is enabled.</p>
</div>
<div class="paragraph">
-<p>With encryption enabled, the password are encrypted at the first time an user logs in. The encrypted passwords are
+<p>With encryption enabled, the password are encrypted at the first time a user logs in. The encrypted passwords are
prefixed and suffixed with <code>\{CRYPT\</code>}. To re-encrypt the password, you can reset the password in clear (in <code>etc/users.properties</code>
file), without the <code>\{CRYPT\</code>} prefix and suffix. Apache Karaf will detect that this password is in clear (because it’s not
prefixed and suffixed with <code>\{CRYPT\</code>}) and encrypt it again.</p>
@@ -985,8 +985,8 @@ or <code>base64</code>. The default valu
<p>For the SSH layer, Karaf supports the authentication by key, allowing to login without providing the password.</p>
</div>
<div class="paragraph">
-<p>The SSH client (so bin/client provided by Karaf itself, or any ssh client like OpenSSH) uses a public/private keys pair that
-will identify himself on Karaf SSHD (server side).</p>
+<p>The SSH client (so bin/client provided by Karaf itself, or any ssh client like OpenSSH) uses a public/private keypair that
+will identify itself on Karaf SSHD (server side).</p>
</div>
<div class="paragraph">
<p>The keys allowed to connect are stored in <code>etc/keys.properties</code> file, following the format:</p>
@@ -1162,7 +1162,7 @@ the users with the <code>manager</code>
</li>
<li>
<p><code>etc/org.apache.karaf.command.acl.feature.cfg</code> configuration file defines the ACL for <code>feature:*</code> commands.
-Only the users with <code>admin</code> role can execute <code>feature:install</code> and <code>feature:uninstall</code> commands. The other <code>feature:*</code>
+Only the users with <code>admin</code> role can execute <code>feature:install</code>, <code>feature:uninstall</code>,<code>feature:start</code>, <code>feature:stop</code> and <code>feature:update</code> commands. The other <code>feature:*</code>
commands can be executed by any user.</p>
</li>
<li>
@@ -1180,6 +1180,11 @@ can be executed by any user.</p>
Only the users with <code>admin</code> role can execute <code>shell:edit</code>, <code>shell:exec</code>, <code>shell:new</code>, and <code>shell:java</code> commands.
The other <code>shell:*</code> commands can be executed by any user.</p>
</li>
+<li>
+<p><code>etc/org.apache.karaf.command.acl.system.cfg</code> configuration file defines the ACL for <code>system:*</code> commands.
+Only the users with <code>admin</code> role can execute <code>system:property</code> and <code>system:shutdown</code> commands. Users with <code>manager</code> role can call <code>system:start-level</code> above 100, otherwise <code>admin</code> role is required. Also users with <code>viewer</code> role can obtain the current start-level.
+The other <code>system:*</code> commands can be executed by any user.</p>
+</li>
</ul>
</div>
<div class="paragraph">
@@ -1187,7 +1192,7 @@ The other <code>shell:*</code> commands
Apache Karaf Cellar, <code>etc/org.apache.karaf.command.acl.camel.cfg</code> from Apache Camel, …​).</p>
</div>
<div class="paragraph">
-<p>You can fine tuned the command RBAC support by editing the <code>karaf.secured.services</code> property in <code>etc/system.properties</code>:</p>
+<p>You can fine tune the command RBAC support by editing the <code>karaf.secured.services</code> property in <code>etc/system.properties</code>:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -1276,7 +1281,7 @@ The <code>set*()</code> and all other <c
<p>The WebConsole doesn’t support fine grained RBAC like console or JMX for now.</p>
</div>
<div class="paragraph">
-<p>All users with the <code>admin</code> role can logon the WebConsole and perform any operations.</p>
+<p>All users with the <code>admin</code> role can logon to the WebConsole and perform any operations.</p>
</div>
</div>
</div>
@@ -1328,9 +1333,17 @@ policy configuration (<code>$JAVA_HOME/j
<p>While this approach works fine, it has a global effect and requires you to configure all your servers accordingly.</p>
</div>
<div class="paragraph">
-<p>Apache Karaf offers a simple way to configure additional security providers:
-* put your provider jar in <code>lib/ext</code>
-* modify the <code>etc/config.properties</code> configuration file to add the following property</p>
+<p>Apache Karaf offers a simple way to configure additional security providers:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>put your provider jar in <code>lib/ext</code></p>
+</li>
+<li>
+<p>modify the <code>etc/config.properties</code> configuration file to add the following property</p>
+</li>
+</ul>
</div>
<div class="listingblock">
<div class="content">
@@ -1365,7 +1378,7 @@ can access those.</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2019-08-26 07:29:55 CEST
+Last updated 2019-11-25 06:19:58 CET
</div>
</div>
</body>