Download Geode source from one of two places: find a specific Apache Geode (incubating) release at https://github.com/apache/incubator-geode/releases or use the head of the develop branch at https://github.com/apache/incubator-geode. Build instructions for 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/incubator-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 build, create binary artifacts and create a distribution, but not run the tests:
./gradlew 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 bin directory to your path.
The gfsh script 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 folder, to build, run the tests, create binary artifacts, and create a distribution:
gradle build installDist
To build, 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 bin directory to your path.
The gfsh.bat script 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.
See the Geode Documentation for more complete documentation.
Note for Windows users: start a locator specifying this system property:
gfsh start locator --name=locator --J=-Dgemfire.OSProcess.ENABLE_OUTPUT_REDIRECTION=true