Author: jleroux
Date: Sun Aug 11 15:21:36 2019
New Revision: 1864933
URL: http://svn.apache.org/viewvc?rev=1864933&view=rev
Log:
Improved: NO functional change
Updates the README.md.html for 16.11.06
Modified:
ofbiz/branches/release16.11/README.md.html
Modified: ofbiz/branches/release16.11/README.md.html
URL:
http://svn.apache.org/viewvc/ofbiz/branches/release16.11/README.md.html?rev=1864933&r1=1864932&r2=1864933&view=diff
==============================================================================
--- ofbiz/branches/release16.11/README.md.html (original)
+++ ofbiz/branches/release16.11/README.md.html Sun Aug 11 15:21:36 2019
@@ -1,11 +1,19 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html xmlns="http://www.w3.org/1999/xhtml";>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml"; lang="" xml:lang="">
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta charset="utf-8" />
<meta name="generator" content="pandoc" />
- <title></title>
- <style type="text/css">code{white-space: pre;}</style>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0,
user-scalable=yes" />
+ <title>README</title>
+ <style type="text/css">
+ code{white-space: pre-wrap;}
+ span.smallcaps{font-variant: small-caps;}
+ span.underline{text-decoration: underline;}
+ div.column{display: inline-block; vertical-align: top; width: 50%;}
+ </style>
+ <!--[if lt IE 9]>
+ <script
src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+ <![endif]-->
</head>
<body>
<!--
@@ -32,11 +40,15 @@ under the License.
<p><a href="http://ofbiz.apache.org/documentation.html";>OFBiz
documentation</a></p>
<p><a href="http://www.apache.org/licenses/LICENSE-2.0";>OFBiz License</a></p>
<h2 id="system-requirements">System requirements</h2>
-<p>The only requirement to run OFBiz is to have the Java Development Kit (JDK)
version 8 installed on your system (not just the JRE, but the full JDK) which
you can download from the below link.</p>
+<p>The first requirement to run OFBiz is to have the Java Development Kit
(JDK) version 8 installed on your system (not just the JRE, but the full JDK)
which you can download from the below link.</p>
<p><a href="https://adoptopenjdk.net/";>JDK download</a></p>
<p><a
href="https://medium.com/@javachampions/java-is-still-free-2-0-0-6b9aa8d6d244";>To
know more about the JDK</a></p>
+<p>The second requirement is to have Gradle installed:</p>
+<p><a
href="https://docs.gradle.org/current/userguide/installation.html";>Installing
Gradle</a></p>
+<p>Then you should setup the Gradle wrapper for OFBiz by executing the
following from the command line at the OFBiz top level directory (folder):</p>
+<p><code>gradle wrapper --gradle-version 2.13</code></p>
<blockquote>
-<p><em>Note</em>: if you are using Eclipse, make sure of running the
appropriate Eclipse command <code>gradlew eclipse</code> before creating the
project in Eclipse. This command will prepare OFBiz for Eclipse with the
correct classpath and settings by creating the.classpath and .project files.</p>
+<p><em>Note</em>: if you are using Eclipse, make sure of running the
appropriate Eclipse command <code>gradlew eclipse</code> before creating the
project in Eclipse. This command will prepare OFBiz for Eclipse with the
correct classpath and settings by creating the .classpath and .project
files.</p>
</blockquote>
<h2 id="security">Security</h2>
<p>You can trust the OFBiz Project Management Committee members and committers
do their best to keep OFBiz secure from external exploits, and fix
vulnerabilities as soon as they are known. Despite these efforts, if ever you
find and want to report a security issue, please report at: security @
ofbiz.apache.org, before disclosing them in a public forum.</p>
@@ -75,14 +87,16 @@ under the License.
<p>There are two types of tasks designed for OFBiz in Gradle:</p>
<ul>
<li><p><strong>Standard tasks</strong>: To execute general standard Gradle
tasks</p></li>
-<li><strong>OFBiz server tasks</strong>: To execute OFBiz startup commands.
These tasks start with one of the following words:</li>
+<li><strong>OFBiz server tasks</strong>: To execute OFBiz startup commands.
These tasks start with one of the following words:
+<ul>
<li><strong>ofbiz</strong> : standard server commands</li>
<li><strong>ofbizDebug</strong> : server commands running in remote debug
mode</li>
-<li><p><strong>ofbizBackground</strong> ; server commands running in a
background forked process</p></li>
+<li><strong>ofbizBackground</strong> ; server commands running in a background
forked process</li>
+</ul></li>
</ul>
<p>Tips:</p>
<ul>
-<li><p>OFBiz <strong>server commands</strong> require
<strong>"quoting"</strong> the commands. For example: <code>gradlew
"ofbiz --help"</code></p></li>
+<li><p>OFBiz <strong>server commands</strong> require
<strong>âquotingâ</strong> the commands. For example: <code>gradlew
"ofbiz --help"</code></p></li>
<li><p>Shortcuts to task names can be used by writing the first letter of
every word in a task name. However, you cannot use the shortcut form for OFBiz
server tasks. Example: <code>gradlew loadAdminUserLogin
-PuserLoginId=myadmin</code> = <code>gradlew lAUL
-PuserLoginId=myadmin</code></p></li>
</ul>
<h4 id="example-standard-tasks">Example standard tasks</h4>
@@ -93,7 +107,7 @@ under the License.
<p><code>gradlew "ofbizDebug --test"</code></p>
<p><code>gradlew "ofbizBackground --start --portoffset
10000"</code></p>
<p><code>gradlew "ofbiz --shutdown --portoffset 10000"</code></p>
-<p><code>gradlew ofbiz</code> (default is --start)</p>
+<p><code>gradlew ofbiz</code> (default is âstart)</p>
<h4 id="example-mixed-tasks-standard-and-ofbiz-server">Example mixed tasks
(standard and OFBiz server)</h4>
<p><code>gradlew cleanAll loadDefault "ofbiz --start"</code></p>
<hr />
@@ -124,7 +138,7 @@ under the License.
<h4 id="get-ofbiz-status">Get OFBiz status</h4>
<p><code>gradlew "ofbiz --status"</code></p>
<h4 id="force-ofbiz-shutdown">Force OFBiz shutdown</h4>
-<p>Terminate all running OFBiz server instances by calling the appropriate
operating system kill command. Use this command to force OFBiz termination if
the --shutdown command does not work. Usually this is needed when in the middle
of data loading or testing in OFBiz.</p>
+<p>Terminate all running OFBiz server instances by calling the appropriate
operating system kill command. Use this command to force OFBiz termination if
the âshutdown command does not work. Usually this is needed when in the
middle of data loading or testing in OFBiz.</p>
<p>Warning: Be careful in using this command as force termination might lead
to inconsistent state / data</p>
<p><code>gradlew terminateOfbiz</code></p>
<h4 id="start-ofbiz-in-remote-debug-mode">Start OFBiz in remote debug mode</h4>
@@ -133,7 +147,7 @@ under the License.
<p>OR</p>
<p><code>gradlew ofbizDebug</code></p>
<h4 id="start-ofbiz-on-a-different-port">Start OFBiz on a different port</h4>
-<p>Start OFBiz of the network port offsetted by the range provided in the
argument to --portoffset</p>
+<p>Start OFBiz of the network port offsetted by the range provided in the
argument to âportoffset</p>
<p><code>gradlew "ofbiz --start --portoffset 10000"</code></p>
<h4 id="start-ofbiz-in-the-background">Start OFBiz in the background</h4>
<p>Start OFBiz in the background by forking it to a new process and
redirecting the output to <strong>runtime/logs/console.log</strong></p>
@@ -142,6 +156,10 @@ under the License.
<p><code>gradlew ofbizBackground</code></p>
<p>You can also offset the port, for example:</p>
<p><code>gradlew "ofbizBackground --start --portoffset
10000"</code></p>
+<h4 id="passing-jvm-runtime-options-to-ofbiz">Passing JVM runtime options to
OFBiz</h4>
+<p>You can pass JVM runtime options by specifying the project property
<code>-PjvmArgs</code>.</p>
+<p><code>gradlew ofbiz -PjvmArgs="-Xms1024M -Xmx2048M"
-Dsome.parameter=hello</code></p>
+<p>If you do not specify <code>jvmArgs</code>, a default of <code>-Xms128M
-Xmx1024M</code> is set.</p>
<hr />
<h3 id="data-loading-tasks">Data loading tasks</h3>
<p>OFBiz contains the following data reader types:</p>
@@ -158,7 +176,7 @@ under the License.
<p>Example:</p>
<p><code>gradlew "ofbiz --load-data
readers=seed,seed-initial,ext,ext-demo"</code></p>
<h4 id="load-default-ofbiz-data">Load default OFBiz data</h4>
-<p>Loads default data set; meant for initial loading of generic OFBiz data.
Can be applied for development, testing, demonstration, etc. purposes. Be aware
that executing this task can result in your data being overwritten in your
database of choice. Use with caution in production environments. The default
data set is defined by datasource using the read-data attribute, followed by
the name of the data set, into the datasource element of the 'entityengine.xml'
file.</p>
+<p>Loads default data set; meant for initial loading of generic OFBiz data.
Can be applied for development, testing, demonstration, etc. purposes. Be aware
that executing this task can result in your data being overwritten in your
database of choice. Use with caution in production environments. The default
data set is defined by datasource using the read-data attribute, followed by
the name of the data set, into the datasource element of the
âentityengine.xmlâ file.</p>
<p><code>gradlew loadDefault</code></p>
<p>OR</p>
<p><code>gradlew "ofbiz --load-data"</code></p>
@@ -190,8 +208,8 @@ under the License.
<p><code>gradlew createTenant -PtenantId=mytenant -PtenantName="My
Name" -PdomainName=com.example -PtenantReaders=seed,seed-initial,ext
-PdbPlatform=M -PdbIp=127.0.0.1 -PdbUser=mydbuser
-PdbPassword=mydbpass</code></p>
<p>If run successfully, the system creates a new tenant having:</p>
<ul>
-<li>delegator: default#${tenandId} (e.g. default#mytenant)</li>
-<li>admin user: ${tenantId}-admin (e.g. mytenant-admin)</li>
+<li>delegator: default#${tenandId} (e.g. default#mytenant)</li>
+<li>admin user: ${tenantId}-admin (e.g. mytenant-admin)</li>
<li>admin user password: ofbiz</li>
</ul>
<h4 id="load-data-for-a-specific-tenant">load data for a specific tenant</h4>
@@ -212,7 +230,7 @@ under the License.
<p>OR</p>
<p><code>gradlew 'ofbiz --test'</code></p>
<h4 id="execute-an-integration-test-case">Execute an integration test case</h4>
-<p>run a test case, in this example the componnet is "entity" and
the case name is "entity-tests"</p>
+<p>run a test case, in this example the componnet is âentityâ and the case
name is âentity-testsâ</p>
<p><code>gradlew "ofbiz --test component=entity --test
case=entity-tests"</code></p>
<h4 id="execute-an-integration-test-case-in-debug-mode">Execute an integration
test case in debug mode</h4>
<p>listens on port <strong>5005</strong></p>
@@ -234,7 +252,7 @@ under the License.
<h4 id="refresh-the-generated-artifacts">Refresh the generated artifacts</h4>
<p><code>gradlew clean build</code></p>
<h4 id="create-an-admin-user-account">Create an admin user account</h4>
-<p>Create an admin user with login name MyUserName and default password with
value "ofbiz". Upon first login OFBiz will request changing the
default password</p>
+<p>Create an admin user with login name MyUserName and default password with
value âofbizâ. Upon first login OFBiz will request changing the default
password</p>
<p><code>gradlew loadAdminUserLogin -PuserLoginId=MyUserName</code></p>
<h4 id="compile-java-using-xlint-output">Compile Java using Xlint output</h4>
<p>Xlint prints output of all warnings detected by the compiler</p>
@@ -269,14 +287,14 @@ under the License.
<p>The above commands achieve the following:</p>
<ul>
<li>add the plugin to /specialpurpose/component-load.xml</li>
-<li>executes the task "install" in the plugin's build.gradle file if
it exists</li>
+<li>executes the task âinstallâ in the pluginâs build.gradle file if it
exists</li>
</ul>
<h3 id="uninstall-a-plugin">Uninstall a plugin</h3>
<p>If you have an existing plugin called mycustomplugin and you wish to
uninstall run the below command</p>
<p><code>gradlew uninstallPlugin -PpluginId=myplugin</code></p>
<p>The above commands achieve the following:</p>
<ul>
-<li>executes the task "uninstall" in the plugin's build.gradle file
if it exists</li>
+<li>executes the task âuninstallâ in the pluginâs build.gradle file if
it exists</li>
<li>removes the plugin from /specialpurpose/component-load.xml</li>
</ul>
<h3 id="remove-a-plugin">Remove a plugin</h3>
@@ -303,7 +321,7 @@ under the License.
<li>pluginId: mandatory</li>
<li>groupId: optional, defaults to org.apache.ofbiz.plugin</li>
<li>pluginVersion: optional, defaults to 0.1.0-SNAPSHOT</li>
-<li>pluginDescription: optional, defaults to "Publication of OFBiz plugin
${pluginId}"</li>
+<li>pluginDescription: optional, defaults to âPublication of OFBiz plugin
${pluginId}â</li>
</ul>
<p><code>gradlew pushPlugin -PpluginId=myplugin</code></p>
<p><code>gradlew pushPlugin -PpluginId=mycompany
-PpluginGroup=com.mycompany.ofbiz.plugin -PpluginVersion=1.2.3
-PpluginDescription="Introduce special functionality X"</code></p>
@@ -315,7 +333,7 @@ under the License.
<p>For example, on debian based systems, you can use the following command:</p>
<p><code>sudo curl -L -s
https://gist.github.com/nolanlawson/8694399/raw/gradle-tab-completion.bash -o
/etc/bash_completion.d/gradle-tab-completion.bash</code></p>
<h2 id="crypto-notice">Crypto notice</h2>
-<p>This distribution includes cryptographic software. The country in which you
currently reside may have restrictions on the import, possession, use, and/or
re-export to another country, of encryption software. BEFORE using any
encryption software, please check your country's laws, regulations and policies
concerning the import, possession, or use, and re-export of encryption
software, to see if this is permitted. See <a href="http://www.wassenaar.org/";
class="uri">http://www.wassenaar.org/</a> for more information.</p>
+<p>This distribution includes cryptographic software. The country in which you
currently reside may have restrictions on the import, possession, use, and/or
re-export to another country, of encryption software. BEFORE using any
encryption software, please check your countryâs laws, regulations and
policies concerning the import, possession, or use, and re-export of encryption
software, to see if this is permitted. See <a href="http://www.wassenaar.org/";
class="uri">http://www.wassenaar.org/</a> for more information.</p>
<p>The U.S. Government Department of Commerce, Bureau of Industry and Security
(BIS), has classified this software as Export Commodity Control Number (ECCN)
5D002.C.1, which includes information security software using or performing
cryptographic functions with asymmetric algorithms. The form and manner of this
Apache Software Foundation distribution makes it eligible for export under the
License Exception ENC Technology Software Unrestricted (TSU) exception (see the
BIS Export Administration Regulations, Section 740.13) for both object code and
source code.</p>
<p>The following provides more details on the included cryptographic
software:</p>
<ul>
