Skip to main content

How to Install

Build from source or use the TAR distribution to install Apache Geode on every physical and virtual machine that will run Apache Geode.

Build from Source on Unix​

  1. Set the JAVA_HOME environment variable.

    JAVA_HOME=/usr/java/jdk-8.0.121
    export JAVA_HOME

  2. Download the project source from the Releases page found at http://geode.apache.org, and unpack the source code.

  3. Within the directory containing the unpacked source code, build without tests:

    $ ./gradlew build -Dskip.tests=true

    Or, build with the tests:

    $ ./gradlew build

  4. Verify the installation by invoking gfsh to print version information and exit. On Linux/Unix platforms, the version will be similar to:

    $ cd geode-assembly/build/install/apache-geode
    $ bin/gfsh version
    v1.1.0

Build from Source on Windows​

  1. Set the JAVA_HOME environment variable. For example:

    $ set JAVA_HOME="C:\Program Files\Java\jdk-8.0.121"

  2. Install Gradle, version 2.3 or a more recent version.

  3. Download the project source from the Releases page found at http://geode.apache.org, and unpack the source code.

  4. Within the folder containing the unpacked source code, build without the tests:

    $ gradle build -Dskip.tests=true

    Or, build with the tests:

    $ gradle build

  5. Verify the installation by invoking gfsh to print version information and exit.

    $ cd geode-assembly\build\install\apache-geode\bin
    $ gfsh.bat version
    v1.1.0

Install Binaries from .tgz File​

  1. Download the .tgz file from the Releases page found at http://geode.apache.org.

  2. Expand the .tgz file, where path_to_product is an absolute path, and the file name will vary due to the version number:

    $ tar -zxvf apache-geode-1.1.0.tgz -C path_to_product

  3. Set the JAVA_HOME environment variable. On Linux/Unix platforms:

    JAVA_HOME=/usr/java/jdk-8.0.121
    export JAVA_HOME

    On Windows platforms:

    set JAVA_HOME="C:\Program Files\Java\jdk-8.0.121"

  4. Add the Geode scripts to your PATH environment variable. On Linux/Unix platforms:

    PATH=$PATH:$JAVA_HOME/bin:path_to_product/bin
    export PATH

    On Windows platforms:

    set PATH=%PATH%;%JAVA_HOME%\bin;path_to_product\bin

  5. To verify the installation, type gfsh version at the command line and note that the output lists the installed version of Geode. For example:

    $ gfsh version
    v1.1.0

    For more detailed version information such as the date of the build, build number and JDK version being used, invoke:

    $ gfsh version --full