Apache OFBiz®

---

Welcome to Apache OFBiz! A powerful top level Apache software project. OFBiz is an Enterprise Resource Planning (ERP) System written in Java and houses a large set of libraries, entities, services and features to run all aspects of your business.

For more details about OFBiz please visit the OFBiz Documentation page:

OFBiz documentation

OFBiz License

Notes

Note - If you want to use Eclipse, read the Setup eclipse project for OFBiz section to set it up.

Note - If you want to use an external database like MySQL or PostgreSQL, read the Setup an external database section.

Note - If you want to run OFBiz without an internet connection, read the Running gradle tasks without an internet connection section.

Note - The directory structure and repositories have changed. For more information read the Repository and directory structure section.

Note - If you are in China you may encounter network issues or proxy settings. This is unrelated to OFBiz.

Note - If you are upgrading from an earlier release, read UPGRADING.md and applications/UPGRADING.md.

System requirements

The only requirements to run OFBiz are

• to have the Java Development Kit (JDK) version 25 installed on your system (not just the JRE, but the full JDK) that you can download from the link below. Make sure to set the $JAVA_HOME environment variable. JDK download. To know more about the JDK

Warning - On Windows, do not install OFBiz in a directory whose path contains spaces.

• If on Windows, a Powershell version >= 7.1.3 installed that you can download from the below link. Powershell

Quick start

To quickly install and fire-up OFBiz, please follow the below instructions from the command line at the OFBiz top level directory (folder).

Download the Gradle wrapper

MS Windows: init-gradle-wrapper

Important

• If you encounter an error

"Powershell is not recognized as an internal or external command, operable program or batch file"

follow the advice at: https://s.apache.org/vdcv8. If you want more details see: https://s.apache.org/urnju

• If you run into problems, check the execution policy of PowerShell. See https://s.apache.org/urnju for details. By setting the execution policy to "unrestricted", you'll be prompted to run the script once you run the init-gradle-wrapper command.

Note - If you wonder where are stored the PowerShell Executables, here are the answers: https://s.apache.org/w5dye

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

Prepare OFBiz

Clean system and load the complete OFBiz data

Note - Depending on your Internet connection speed it might take a long time for this step to complete if you are using OFBiz for the first time as it needs to download all dependencies. So please be patient!

MS Windows: gradlew cleanAll loadAll

Unix-like OS: ./gradlew cleanAll loadAll

Warning - This command deletes all previous data and resets it to the initial demo data.

Start OFBiz

MS Windows: gradlew ofbiz

Unix-like OS: ./gradlew ofbiz

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

Visit OFBiz through your browser

Order Back Office interface

Accounting Back Office interface

Administrator interface

This is the beginning of the README. Read the rest at the original. Read the full README ↗