Page History

Download Geode source from one of two places: an find a specific Apache Geode (incubating) release from at http://geode.incubator.apache.org/ or releases or use the head of the develop branch at https://github.com/apache/incubator-geode. Build instructions for an each Apache Geode (incubating) release are in the README.md or BUILDING.md file within the release. Both sets of the source code use the standard Gradle lifecycle model.

These instructions are targeted to build from the head of 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. 

Make a clone of the develop branch:

git clone -b develop https://github.com/apache/geode.git

Build on Unix

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

./gradlew build installDist

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

./gradlew build installDist -Dskip.tests=true

The gfsh script will be in two places. One place it can be found is in  geode-assembly/build/install/apache-geode/bin.

Alternatively, the gfsh script is within the built binaries. To install from the distribution 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 There is a gradlew.bat script , Windows developers need to acquire and install Gradle, version 2.3 or a more recent versionin the develop branch of the repository at https://github.com/apache/geode, so it can be used to build from source.

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

gradle gradlew.bat build installDist

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

gradle build installDist -Dskip.tests=true

The gfsh script will be in two places. One place it can be found is The distribution archives will be located in geode-assembly\build\install\apache-geode\bin.

Alternatively, the gfsh script is within the built binariesdistributions\. To install from the distribution in geode-assembly\build\distributions\, extract the archive file and add the bin directory  folder to your path.

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

Running Geode

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

Running Geode

See the Geode Documentation for more complete documentation.

Note for Windows users: start gfsh specifying start a locator specifying this system property:

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

Build environment in docker

dev-tools/docker/compile/start-compile-docker.sh