Page History

Geode is built using Download Geode source from one of two places: an Apache Geode (incubating) release from http://geode.incubator.apache.org/ or the head of the develop branch at https://github.com/apache/incubator-geode. Build instructions for an Apache Geode (incubating) release are in the README.md or BUILDING.md file within the release. Both use the standard Gradle lifecycle model. To build Geode, creating binary artifacts and running all of the tests, invoke

These instructions are targeted to build from the develop branch. All builds require a JDK, version 1.8 or a more recent version.  Set a JAVA_HOME environment variable to point to the Java installation.

Build on Unix

Within the incubator-geode directory, to run the tests, create binary artifacts, and create a distribution:

./gradlew

...

build

...

installDist

To build Geode, creating create binary artifacts and create a distribution, but not running run the tests, invoke:

./gradlew

...

build

...

installDist -Dskip.tests=true

To create a distribution, invoke one of

./gradlew distTar 

or

The distribution archives will be located in geode-assembly/build/distributions/. To install from the distribution, extract the archive file and add the bin directory to your path.

Binary artifacts will also be in geode-assembly/build/install/apache-geode/bin.

Build on Windows

With no gradlew.bat script, Windows developers need to acquire and install Gradle, version 2.3 or a more recent version.

Within the incubator-geode directory, to run the tests, create binary artifacts, and create a distribution:

gradle build installDist

To create binary artifacts and create a distribution, but not run the tests:

gradle build installDist -Dskip.tests=true

...

The distribution archives will be located in geode-assembly/\build/\distributions/\. To install from the distribution, extract the archive file and add the the bin directory  directory to your path. You can start servers and examine data using the bin/gfsh script. You can also create an exploded distributed using the install task. This will create the distribution directories

Binary artifacts will also be in geode-assembly/\build/install/gemfire.\install\apache-geode\bin.

Running Geode

To embed Geode in your application, add lib/geode-dependencies.jar to your classpath.

See the Geode Documentation for more complete documentation.

Note for Windows users: start gfsh using  specifying this system property:

gfsh start locator --name=locator --J=-Dgemfire.OSProcess.ENABLE_OUTPUT_REDIRECTION=true

...