Download the Gradle wrapper:

MS Windows:init-gradle-wrapper

Unix-like OS:./gradle/init-gradle-wrapper.sh

Prepare OFBiz:

Start OFBiz:

MS Windows:gradlew ofbiz

Unix-like OS:./gradlew ofbiz

Note: Ignore the % progress indicator because this task does not end as longas OFBiz is running.

Visit OFBiz through your browser:

Order Back Office interface

Accounting Back Office interface

Administrator interface

You can log in with the useradmin and passwordofbiz.

Package OFBiz

MS Windows:gradlew distZip

Unix-like OS:./gradlew distTar

Copy to server

Copy the archive frombuild/distributions directory to the server and unarchive them withtar xf orunzip.

Run OFBiz

From the unarchived directory you can run eitherbin/ofbiz shell script orbin/ofbiz.bat batch script.

Install as a service

MS Windows: you can usenssm

Unix-like OS:This article might give you an idea, although it seems to be outdated. Either way, you can use the standard mechanism of your distribution, like for example creating an/etc/systemd/system/ofbiz.service file.

Troubleshooting

On Windows you might get the following error when trying to run theofbiz.bat script:The input line is too long. The syntax of the command is incorrect.

The current workaround is to clone the repository and run gradlew commands from the root folder instead.

Operating System Syntax

The syntax for tasks differ slightly between windows and Unix-like systems

• Windows:gradlew <tasks-in-here>

• Unix-like:./gradlew <tasks-in-here>

For the rest of this document, we will use the windows syntax, if you are on aUnix-like system, you need to add the./ to gradlew

Types of tasks in Gradle

There are two types of tasks designed for OFBiz in Gradle:

• Standard tasks: To execute general standard Gradle tasks

• OFBiz server tasks: To execute OFBiz startup commands. These tasks startwith one of the following words:

• ofbiz : standard server commands

• ofbizBackground ; server commands running in a background forked process

Tips:

• OFBizserver commands require"quoting" the commands. For example:gradlew "ofbiz --help"

• Shortcuts to task names can be used by writing the first letter of every wordin a task name. However, you cannot use the shortcut form for OFBiz servertasks. Example:gradlew loadAdminUserLogin -PuserLoginId=myadmin =gradlew lAUL -PuserLoginId=myadmin

• Dependent tasks can be skipped with the -x switch. Example:gradlew build -x test does not run the tests within the build.

Help tasks

Server command tasks

Data loading tasks

OFBiz contains the following data reader types:

• seed: OFBiz and External Seed Data - to be maintained along with source andupdated whenever a system deployment is updated

• seed-initial: OFBiz and External Seed Data - to be maintained along withsource like other seed data, but only loaded initially and not updated when asystem is updated except manually reviewing each line

• demo: OFBiz Only Demo Data

• ext: External General Data (custom)

• ext-test: External Test Data (custom)

• ext-demo: External Demo Data (custom)

• tenant: Data to load into the master tenants database "ofbiztenant". Thisdata is required to identify where a tenant’s database is located. For moreinformation you can review the relevanttenantdocumentation

Available options for the --load-data server command are the following:

• readers=[name]: only load data from certain readers separated by comma. e.g.seed,seed-initial,ext

• file=[path]: load a single file from location or several files separated bycommas. e.g. /my/file/1,/my/file/2

• dir=[path]: load all data files found in directory

• component=[name]: only load data from a specific component. e.g. base

• delegator=[name]: use the defined delegator. Default is "default". If thevalue passed is"all-tenants" then OFBiz will load the data for all definedtenants in the system.

• group=[name]: override the entity group (org.apache.ofbiz). e.g.com.example.something

• timeout=[millis]: timeout in milliseconds

• create-pks: create primary keys

• drop-pks: drop primary keys

• create-constraints: create indexes and foreign keys after loading

• drop-constraints: drop indexes and foreign keys before loading

• create-fks: create dummy (placeholder) foreign keys

• maintain-txs: maintain timestamps in data file

• try-inserts: use mostly inserts

• repair-columns: repair column sizes (default is true w/ drop-constraints)

• continue-on-failure: By default OFBiz will fail and stop if it is unable toload any of the files it is attempting to load. By passing this property OFBizwill ignore failures and continue loading all files

Testing tasks

Miscellaneous tasks

Pull (download and install) a plugin automatically

Download a plugin with all its dependencies (plugins) and install themone-by-one starting with the dependencies and ending with the plugin itself.

gradlew pullPlugin -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"

If the plugin resides in a custom maven repository (not jcenter or localhost)then you can use specify the repository using below command:

gradlew pullPlugin -PrepoUrl="http://www.example.com/custom-maven" -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"

If you need username and password to access the custom repository:

gradlew pullPlugin -PrepoUrl="http://www.example.com/custom-maven" -PrepoUser=myuser -PrepoPassword=mypassword -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"

Pull an official plugin from source control

Download an official plugin from source control and place it in the plugins directory.It’s able to handle branches switches

MS Windows:pullPluginSource example
Unix-like OS:./pullPluginSource.sh example

Pull all official plugins from source control

Download all officially supported plugins from source control and place them in /plugins.It’s able to handle branches switches

MS Windows:pullAllPluginsSource
Unix-like OS:./pullAllPluginsSource.sh

Install a plugin

If you have a plugin called mycustomplugin and want to install it in OFBizfollow the below instructions:

• Extract the plugin if it is compressed

• Place the extracted directory into /plugins

• Run the below command

gradlew installPlugin -PpluginId=myplugin

The above commands executes the task "install" in the plugin’s build.gradle fileif it exists

Uninstall a plugin

If you have an existing plugin called mycustomplugin and you wish to uninstallrun the below command

gradlew uninstallPlugin -PpluginId=myplugin

The above command executes the task "uninstall" in the plugin’s build.gradlefile if it exists

Remove a plugin

CallsuninstallPlugin on an existing plugin and then delete it from thefile-system

gradlew removePlugin -PpluginId=myplugin

Create a new plugin

Create a new plugin. The following project parameters are passed:

• pluginId: mandatory

• pluginResourceName: optional, default is the Capitalized value of pluginId

• webappName: optional, default is the value of pluginId

• basePermission: optional, default is the UPPERCASE value of pluginId

gradlew createPlugin -PpluginId=myplugin

gradlew createPlugin -PpluginId=myplugin -PpluginResourceName=MyPlugin -PwebappName=mypluginweb -PbasePermission=MYSECURITY

The above command creates a new plugin in /plugins/myplugin

Push a plugin to a repository

This task publishes an OFBiz plugin into a maven package and then uploads it toa maven repository. Currently, pushing is limited to localhost maven repository(work in progress). To push a plugin the following parameters are passed:

• pluginId: mandatory

• groupId: optional, defaults to org.apache.ofbiz.plugin

• pluginVersion: optional, defaults to 0.1.0-SNAPSHOT

• pluginDescription: optional, defaults to "Publication of OFBiz plugin${pluginId}"

gradlew pushPlugin -PpluginId=myplugin

gradlew pushPlugin -PpluginId=mycompany -PpluginGroup=com.mycompany.ofbiz.plugin -PpluginVersion=1.2.3 -PpluginDescription="Introduce special functionality X"

Further reading

• Knownissues

• Tips and Tricks

Repository and directory structure

OFBiz is split into two repositories:

• ofbiz-framework: Contains the core framework and main applications in thesystem like accounting, party, order, etc

• ofbiz-plugins: Renamed from "special-purpose" and contains optionalcomponents that are officially supported by the community

Furthermore, the hot-deploy directory is removed as the plugins directory worksas a replacement for both "special-purpose" and "hot-deploy".

If you need to load the components in the plugins directory in a specific orderplace a component-load.xml file in the plugins directory listing the order.

To check out a plugin from source control use the Windows or Unix-likepullPluginSource script.To check out all plugins from source control use thepullAllPluginsSource script.Beware this deletes a previously existing pluginsdirectory.

Running gradle tasks without an internet connection

OFBiz must run with an internet connection thefirst time it is prepared onthe system because it needs to download all the required dependencies.

After preparing OFBiz the first time correctly, it is possible to run OFBizwithout an internet connection by using the--offline command line switchwhich tells Gradle to fetch its dependencies from the cache.

If any dependencies are missing from the cache and you pass--offline switchthen the build execution will fail.

Setup an external database like MySQL, PostgreSQL, etc

To setup an external database instead of the default embedded Apache Derby, youwill need to follow the following instructions:

1. Find the JDBC driver suitable for your database using one of the followingoptions:

   • Search for the JDBC driver injcenter andplace it in build.gradle dependencies e.g.runtime 'mysql:mysql-connector-java:8.0.30'

     OR

   • Download the JDBC driver jar and place it in $OFBIZ_HOME/lib or the libsub-directory of any component

2. Modify the entityengine.xml file located in$OFBIZ_HOME/framework/entity/config to switch the default database to the oneyou selected. For more details you can read the relevant section in thetechnicalsetup guide

Setup gradle tab-completion on Unix-like systems:

To get tab completion (auto complete gradle commands by pressing tab) you candownload the script from the below link and place it in the appropriate locationfor your system.

Gradle tab completion

For example, on debian based systems, you can use the following command:

sudo curl -L -shttps://edub.me/gradle-completion-bash -o /etc/bash_completion.d/gradle-tab-completion.bash