Files
ofbiz-framework/INSTALL
T
Jacques Le Roux 742802afbd Documented: Create a simple INSTALL file with minimum installation information and redirection to more documentation
(OFBIZ-11691)

Following https://markmail.org/message/xi2bcvnmpdfvfgk2 discussion on dev ML
here is the file I suggest. If we are OK we can backport it to the supported
release branches. Of course I'm open to modifications...

Thanks for their answers: Deepak Nigam, Michael Brohl, Pierre Smits and
Taher Alkhateeb
2020-05-25 18:18:51 +02:00

58 lines
2.0 KiB
Plaintext

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.
== System requirements
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. Make sure of setting the $JAVA_HOME
environment variable.
https://adoptopenjdk.net/[JDK download]
== 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
Unix-like OS: ./gradle/init-gradle-wrapper
=== 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
=== 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:
https://localhost:8443/webtools
== Going further
To complete your installation and use OFBiz please read README.adoc
You may prefer to read this AsciiDoc file in HTML format.
For that simply follow:
https://asciidoctor.org/docs/convert-documents/#converting-a-document-to-html