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 [4/4] - in /karaf/site/production/manual/latest: ./ commands/

Modified: karaf/site/production/manual/latest/start-stop.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/start-stop.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/start-stop.html (original)
+++ karaf/site/production/manual/latest/start-stop.html Mon Nov 25 06:35:17 2019
@@ -531,18 +531,18 @@ table.CodeRay td.code>pre{padding:0}
 <div class="sect3">
 <h4 id="_start">Start</h4>
 <div class="paragraph">
-<p>Apache Karaf supports different start mode:</p>
+<p>Apache Karaf supports different start modes:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
-<p>the "regular" mode starts Apache Karaf in foreground, including the shell console.</p>
+<p>the "regular" mode starts Apache Karaf in the foreground, including the shell console.</p>
 </li>
 <li>
-<p>the "server" mode starts Apache Karaf in foreground, without the shell console.</p>
+<p>the "server" mode starts Apache Karaf in the foreground, without the shell console.</p>
 </li>
 <li>
-<p>the "background" mode starts Apache Karaf in background.</p>
+<p>the "background" mode starts Apache Karaf in the background.</p>
 </li>
 </ul>
 </div>
@@ -742,7 +742,7 @@ karaf@root()&gt;</pre>
 <p><code>JAVA_MAX_PERM_MEM</code>: maximum perm memory for the JVM (default is JVM default value).</p>
 </li>
 <li>
-<p><code>KARAF_HOME</code>: the location of your Apache Karaf installation (default is found depending where you launch the startup script).</p>
+<p><code>KARAF_HOME</code>: the location of your Apache Karaf installation (default is found depending on where you launch the startup script).</p>
 </li>
 <li>
 <p><code>KARAF_BASE</code>: the location of your Apache Karaf base (default is <code>KARAF_HOME</code>).</p>
@@ -926,19 +926,19 @@ karaf@root()&gt;</pre>
 <div class="sect3">
 <h4 id="_stop">Stop</h4>
 <div class="paragraph">
-<p>When you start Apache Karaf in regular mode, the <code>logout</code> command or CTRL-D key binding logout from the console and shutdown Apache Karaf.</p>
+<p>When you start Apache Karaf in regular mode, the <code>logout</code> command or CTRL-D key binding logs out from the console and shuts Apache Karaf down.</p>
 </div>
 <div class="paragraph">
 <p>When you start Apache Karaf in background mode (with the <code>bin/start</code> Unix script (<code>bin\start.bat</code> on Windows)), you can use the <code>bin/stop</code> Unix script (<code>bin\stop.bat</code> on Windows).</p>
 </div>
 <div class="paragraph">
-<p>More generally, you can use the <code>shutdown</code> command (on the Apache Karaf console) that work in any case.</p>
+<p>More generally, you can use the <code>shutdown</code> command (on the Apache Karaf console) that works for all cases.</p>
 </div>
 <div class="paragraph">
 <p>The <code>shutdown</code> command is very similar to the the <code>shutdown</code> Unix command.</p>
 </div>
 <div class="paragraph">
-<p>To shutdown Apache Karaf now, you can simple using <code>shutdown</code>:</p>
+<p>To shutdown Apache Karaf now, you can simply use <code>shutdown</code>:</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -1131,7 +1131,7 @@ Running ...</pre>
 </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/tuning.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/tuning.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/tuning.html (original)
+++ karaf/site/production/manual/latest/tuning.html Mon Nov 25 06:35:17 2019
@@ -534,7 +534,7 @@ table.CodeRay td.code>pre{padding:0}
 <p>Like any Java applications, Apache Karaf uses a JVM. An important feature of the JVM is the Garbage Collector.</p>
 </div>
 <div class="paragraph">
-<p>Apache Karaf default configuration is sized for small to medium needs and to work on most machine.</p>
+<p>Apache Karaf default configuration is sized for small to medium needs and to work on most machines.</p>
 </div>
 <div class="paragraph">
 <p>That&#8217;s why this default configuration may appear like "small".</p>
@@ -585,7 +585,7 @@ table.CodeRay td.code>pre{padding:0}
 <p>For any container, it&#8217;s always difficult to predict the usage of the resources and the behaviour of the artifacts deployed.</p>
 </div>
 <div class="paragraph">
-<p>Generally speaking, a good approach for tuning is to enable <code>-verbose:gc</code> and use tools like VisualVM to identify the potentials
+<p>Generally speaking, a good approach for tuning is to enable <code>-verbose:gc</code> and use tools like VisualVM to identify the potential
 memory leaks, and see the possible optimisation of the spaces and GC.</p>
 </div>
 <div class="paragraph">
@@ -654,7 +654,7 @@ memory leaks, and see the possible optim
 <div class="sect3">
 <h4 id="_threads">Threads</h4>
 <div class="paragraph">
-<p>In high loaded system, the number of threads can be very large.</p>
+<p>In a system under high load, the number of threads can be very large.</p>
 </div>
 <div class="sect4">
 <h5 id="_webcontainer">WebContainer</h5>
@@ -768,7 +768,7 @@ to all workqueues (a workqueue can be as
 <p>Most of the time, the default configuration in Apache Karaf is fine and works in most of the use cases.</p>
 </div>
 <div class="paragraph">
-<p>However, some times, you may want to not use the packages provided by the JVM, but the same packages provided by a bundle.</p>
+<p>However, some times, you may not want to use the packages provided by the JVM, but the same packages provided by a bundle.</p>
 </div>
 <div class="paragraph">
 <p>For instance, the JAXB version provided by the JVM is "old", and you want to use new JAXB bundles.</p>
@@ -782,7 +782,7 @@ ones from the bundles.</p>
 </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/update-notes.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/update-notes.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/update-notes.html (original)
+++ karaf/site/production/manual/latest/update-notes.html Mon Nov 25 06:35:17 2019
@@ -696,7 +696,7 @@ The <code>bin</code> folder contains bot
 <p>However, in Karaf 4.x, you can use DS and new annotations and avoid the usage of a blueprint XML.</p>
 </div>
 <div class="paragraph">
-<p>The new annotations are available: @Service, @Completion, @Parsing, @Reference. It allows you to complete define the command
+<p>The new annotations are available: @Service, @Completion, @Parsing, @Reference. It allows you to completely define the command
 in the command class directly.</p>
 </div>
 <div class="paragraph">
@@ -820,8 +820,10 @@ As soon as you use a "new style" feature
 <p><code>karaf:assembly</code> to create a custom Karaf distribution assembly</p>
 </li>
 <li>
-<p><code>karaf:kar</code> to create a kar file
-*Â <code>karaf:verify</code> to verify and validate Karaf features</p>
+<p><code>karaf:kar</code> to create a kar file</p>
+</li>
+<li>
+<p><code>karaf:verify</code> to verify and validate Karaf features</p>
 </li>
 <li>
 <p><code>karaf:features-add-to-repository</code> to recursively copy features XML and content into a folder (repository)</p>
@@ -856,7 +858,7 @@ As soon as you use a "new style" feature
 <p>If you upgrade an existing container, <code>lib</code> and <code>system</code> folder have to be updated (just an override copy).</p>
 </div>
 <div class="paragraph">
-<p>For the <code>etc</code> folder, a diff is required as some properties changed and new configurations are available.</p>
+<p>For the <code>etc</code> folder, a diff is required as some properties have changed and new configurations are available.</p>
 </div>
 </div>
 </div>
@@ -864,7 +866,7 @@ As soon as you use a "new style" feature
 </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/urls.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/urls.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/urls.html (original)
+++ karaf/site/production/manual/latest/urls.html Mon Nov 25 06:35:17 2019
@@ -571,8 +571,8 @@ located in a directory which is not avai
 <p>In addition to being less verbose, the Maven url handlers can also resolve snapshots and can use a local copy of the jar if one is available in your Maven local repository.</p>
 </div>
 <div class="paragraph">
-<p>The <code>org.ops4j.pax.url.mvn</code> bundle resolves <code>mvn</code> URLs. It can be configured using the file <code>etc/org.ops4j.pax.url.cfg</code>.
-Full reference of <code>org.ops4j.pax.url.mvn</code> PID configuration can be found <a href="https://ops4j1.jira.com/wiki/display/paxurl/Aether+Configuration">on pax-web Wiki page</a>.</p>
+<p>The <code>org.ops4j.pax.url.mvn</code> bundle resolves <code>mvn</code> URLs. It can be configured using the file <code>etc/org.ops4j.pax.url.mvn.cfg</code>.
+Full reference of <code>org.ops4j.pax.url.mvn</code> PID configuration can be found on <a href="https://ops4j1.jira.com/wiki/display/paxurl/Aether+Configuration">the pax-web Wiki page</a>.</p>
 </div>
 <div class="paragraph">
 <p>The most important property is:</p>
@@ -590,10 +590,10 @@ Full reference of <code>org.ops4j.pax.ur
 <div class="ulist">
 <ul>
 <li>
-<p><code>org.ops4j.pax.url.mvn.defaulRepositories</code> : Comma separated list of locations that are checked before querying remote repositories. These can be treated as read-only repositories, as nothing is written there during artifact resolution.</p>
+<p><code>org.ops4j.pax.url.mvn.defaultRepositories</code> : Comma separated list of locations that are checked before querying remote repositories. These can be treated as read-only repositories, as nothing is written there during artifact resolution.</p>
 </li>
 <li>
-<p><code>org.ops4j.pax.url.mvn.localRepository</code> : by default (implicitly) it&#8217;s standard <code>~/.m2/repository</code> location. This
+<p><code>org.ops4j.pax.url.mvn.localRepository</code> : by default (implicitly) it&#8217;s the standard <code>~/.m2/repository</code> location. This
 local repository is used to store artifacts downloaded from one of remote repositories, so at next resolution attempt
 no remote request is issued.</p>
 </li>
@@ -617,12 +617,12 @@ no remote request is issued.</p>
 <p>Full configuration of <code>org.ops4j.pax.url.mvn</code> bundle can be done using <code>org.ops4j.pax.url.mvn</code> PID (see <code>etc/org.ops4j.pax.url.mvn.cfg</code> file). This however may be cumbersome in some scenarios.</p>
 </div>
 <div class="paragraph">
-<p>In order to make user&#8217;s life easier and provide more <em>domain</em> oriented approach, Karaf provides several shell commands that makes Maven configuration easier.</p>
+<p>In order to make the user&#8217;s life easier and to provide more <em>domain</em> oriented approach, Karaf provides several shell commands that makes Maven configuration easier.</p>
 </div>
 <div class="sect4">
 <h5 id="_maven_summary">maven:summary</h5>
 <div class="paragraph">
-<p>This command shows quick summary about current <code>org.ops4j.pax.url.mvn</code> PID configuration. For example:</p>
+<p>This command shows a quick summary about current <code>org.ops4j.pax.url.mvn</code> PID configuration. For example:</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -671,7 +671,7 @@ This option may be used only by user wit
 <div class="sect4">
 <h5 id="_maven_repository_list">maven:repository-list</h5>
 <div class="paragraph">
-<p>This command displays all configured Maven repositories - in much more readable way than plain <code>config:proplist --pid org.ops4j.pax.url.mvn</code> command does.</p>
+<p>This command displays all configured Maven repositories - in a much more readable way than the plain <code>config:proplist --pid org.ops4j.pax.url.mvn</code> command does.</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -697,10 +697,10 @@ child.system.repository â file:/dat
 <div class="ulist">
 <ul>
 <li>
-<p><code>-v</code> option shows additional information about policies related to given repository</p>
+<p><code>-v</code> option shows additional information about policies related to a given repository</p>
 </li>
 <li>
-<p><code>-x</code> shows credentials for given repository (if defined)</p>
+<p><code>-x</code> shows credentials for a given repository (if defined)</p>
 </li>
 </ul>
 </div>
@@ -708,9 +708,9 @@ child.system.repository â file:/dat
 <div class="sect4">
 <h5 id="_maven_password">maven:password</h5>
 <div class="paragraph">
-<p><code>org.ops4j.pax.url.mvn</code> bundle uses Aether library to handle Maven resolution. It uses <code>settings.xml</code> file if
+<p><code>org.ops4j.pax.url.mvn</code> bundle uses the Aether library to handle Maven resolution. It uses the <code>settings.xml</code> file if
 credentials have to be used when accessing remote Maven repositories. This isn&#8217;t done by <code>org.ops4j.pax.url.mvn</code>,
-but by Aether itself (or rather maven-settings library). When dealing with <code>settings.xml</code> file, passwords that
+but by Aether itself (or rather maven-settings library). When dealing with the <code>settings.xml</code> file, passwords that
 are stored there may need to be decrypted.
 Outside of Karaf, we can use <code>mvn -emp</code> and <code>mvn -ep</code> passwords and manually configure <code>~/.m2/settings-security.xml</code>
 file.</p>
@@ -724,7 +724,7 @@ password</em> stored inside <code>settin
 there&#8217;s a need to use it, one has to be created manually.</p>
 </div>
 <div class="paragraph">
-<p>Here&#8217;s the way to encrypt Maven <em>master password</em> (which is used to encrypt ordinary passwords for repository or http proxies):</p>
+<p>Here&#8217;s the way to encrypt the Maven <em>master password</em> (which is used to encrypt ordinary passwords for repository or http proxies):</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -734,8 +734,8 @@ Encrypted master password: {y+p9TiYuwVEH
 </div>
 </div>
 <div class="paragraph">
-<p>The above usage simply prints encrypted <em>master password</em>. We can however make this password persistent. This will
-result in new <code>settings-security.xml</code> file to be created and change in <code>org.ops4j.pax.url.mvn.security</code> property.</p>
+<p>The above usage simply prints the encrypted <em>master password</em>. We can however make this password persistent. This will
+result in the creation of a new <code>settings-security.xml</code> file and a change in the <code>org.ops4j.pax.url.mvn.security</code> property.</p>
 </div>
 <div class="admonitionblock note">
 <table>
@@ -745,7 +745,7 @@ result in new <code>settings-security.xm
 </td>
 <td class="content">
 Karaf maven commands will never overwrite your current <code>~/.m2/settings.xml</code> or <code>~/.m2/settings-security.xml</code> files.
-If there&#8217;s a need to change these files, maven commands will make a copy of existing file and set relevant <code>org.ops4j.pax.url.mvn</code> PID options
+If there&#8217;s a need to change these files, maven commands will make a copy of the existing file and set relevant <code>org.ops4j.pax.url.mvn</code> PID options
 to point to new locations.
 </td>
 </tr>
@@ -802,10 +802,10 @@ repositories are Sonatype Nexus or JFrog
 </dl>
 </div>
 <div class="paragraph">
-<p>Both kinds of repositories may be created using <code>maven:repository-add</code> command.</p>
+<p>Both kinds of repositories may be created using the <code>maven:repository-add</code> command.</p>
 </div>
 <div class="paragraph">
-<p>Here&#8217;s how default repository may be created:</p>
+<p>Here&#8217;s how a default repository may be created:</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -820,7 +820,7 @@ my.default.repository   â file:/dat
 </div>
 </div>
 <div class="paragraph">
-<p>For remote repository, we can specify more options (like credentials or update policies):</p>
+<p>For a remote repository, we can specify more options (like credentials or update policies):</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -838,7 +838,7 @@ my.remote.repository            â h
 </div>
 </div>
 <div class="paragraph">
-<p>In the above example, new <code>settings.xml</code> file was created. The reason is that although new repository itself was added
+<p>In the above example, a new <code>settings.xml</code> file was created. The reason is that although a new repository itself was added
 to <code>org.ops4j.pax.url.mvn.repositories</code> property, the credentials had to be stored in <code>settings.xml</code> file:</p>
 </div>
 <div class="listingblock">
@@ -913,7 +913,7 @@ be done in <code>settings.xml</code> and
 </div>
 <div class="paragraph">
 <p><code>maven:http-proxy</code> command can be used to add/change/remove HTTP proxy definition. It automatically does a copy
-of existing <code>settings.xml</code> file and changes <code>org.ops4j.pax.url.mvn.settings</code> PID property.</p>
+of the existing <code>settings.xml</code> file and changes <code>org.ops4j.pax.url.mvn.settings</code> PID property.</p>
 </div>
 <div class="paragraph">
 <p>For example:</p>
@@ -942,7 +942,7 @@ my.proxy â proxy.everfree.forest â
 </div>
 </div>
 <div class="paragraph">
-<p>Here&#8217;s summary of options for <code>maven:http-proxy</code> command:</p>
+<p>Here&#8217;s a summary of options for the <code>maven:http-proxy</code> command:</p>
 </div>
 <div class="ulist">
 <ul>
@@ -990,7 +990,7 @@ accessed bypassing HTTP proxy</p>
 </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/webconsole.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/webconsole.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/webconsole.html (original)
+++ karaf/site/production/manual/latest/webconsole.html Mon Nov 25 06:35:17 2019
@@ -603,19 +603,32 @@ with the <code>/system/console</code> co
 </td>
 <td class="content">
 <div class="paragraph">
-<p>Only users with the <code>admin</code> role are allowed to logon on the Apache Karaf WebConsole.
+<p>By default, only users with the <code>admin</code> role are allowed to logon to the Apache Karaf WebConsole.
 Right now, the WebConsole doesn&#8217;t use RBAC system as we have for console commands, or MBeans.</p>
 </div>
 </td>
 </tr>
 </table>
 </div>
+<div class="paragraph">
+<p>You can change the security configuration of the webconsole in the
+<code>etc/org.apache.karaf.webconsole.cfg</code> configuration file:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre># The JAAS realm name to use for authentication
+realm=karaf
+
+# The role required to access the WebConsole
+role=admin</pre>
+</div>
+</div>
 </div>
 </div>
 </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/webcontainer.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/webcontainer.html?rev=1870356&r1=1870355&r2=1870356&view=diff
==============================================================================
--- karaf/site/production/manual/latest/webcontainer.html (original)
+++ karaf/site/production/manual/latest/webcontainer.html Mon Nov 25 06:35:17 2019
@@ -529,7 +529,7 @@ table.CodeRay td.code>pre{padding:0}
 <div class="sect3">
 <h4 id="_webcontainer_jsp_servlet">WebContainer (JSP/Servlet)</h4>
 <div class="paragraph">
-<p>Apache Karaf can act a complete WebContainer, fully supporting JSP/Servlet specification.</p>
+<p>Apache Karaf can act as a complete WebContainer, fully supporting the JSP/Servlet specifications.</p>
 </div>
 <div class="paragraph">
 <p>Apache Karaf WebContainer supports both:</p>
@@ -597,10 +597,10 @@ It means that just installing the <code>
 </div>
 </div>
 <div class="paragraph">
-<p>Note: if you want to use port numbers &lt; 1024, remember you have to run with root privileges.</p>
+<p>Note: if you want to use port numbers &lt; 1024, remember you have to run with root privileges. However note that this is not a good idea from a security point of view.</p>
 </div>
 <div class="paragraph">
-<p>It&#8217;s possible to enable HTTPs "internal" connector. The first step is to create a keystore containing a server certificate.
+<p>It&#8217;s possible to enable the HTTPs "internal" connector. The first step is to create a keystore containing a server certificate.
 For instance the following command creates a keystore with a self-signed certificate:</p>
 </div>
 <div class="listingblock">
@@ -1081,7 +1081,7 @@ URL         â ProxyTo
 </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>