Windows/Unix/Linux: Install Pivotal GemFire from a ZIP File

For all other platform users, install and configure Pivotal GemFire on every physical and virtual machine where you will run Pivotal GemFire.

Prerequisites

Before you install the Pivotal GemFire, you must complete the following prerequisites:
  • Confirm that your system meets the hardware and software requirements described in Supported Configurations and System Requirements.
  • From the Pivotal GemFire product page, locate Downloads. Download the ZIP distribution of Pivotal GemFire.
  • Know how to configure environment variables for your system. If you have not done so already, set the JAVA_HOME environment variable to point to a Java runtime installation supported by GemFire. (You should find a bin directory under JAVA_HOME.)
    Note: Certain features of the gfsh command-line utility require tools.jar from the JDK. Make sure that you set JAVA_HOME to a JDK installation if you plan to use gfsh on the machine where you are installing GemFire.

Procedure

Use the following procedure to install Pivotal GemFire:
  1. Navigate to the directory where you downloaded the GemFire software, and unzip the .zip file.
    • UNIX and Linux (Bourne and Korn shells - sh, ksh, bash). If you are using the command line, type the following command:
      $ unzip Pivotal_GemFire_XXX_bNNNNN.zip -d path_to_product
      where XXX corresponds to the product version of GemFire that you are installing, bNNNNN corresponds to the build number of the software, and path_to_product corresponds to the location where you want to install GemFire. For example:
      $ unzip Pivotal_GemFire_702_b45714.zip -d /opt/pivotal/Pivotal_GemFire_702
      Alternatively, unzip the .zip file directly with any common ZIP extraction tool suitable for your operating system.
    • Windows: Open the .zip file, and extract the product files to the desired installation location on your machine.
  2. Configure the JAVA_HOME environment variable.

    If you will be using the gfsh command-line utility or managing servers and locators with the ServerLauncher and LocatorLauncher APIs, then you must set JAVA_HOME to a JDK installation. For example:

    • UNIX and Linux (Bourne and Korn shells - sh, ksh, bash)
      JAVA_HOME=/usr/java/jdk1.6.0_38
      export JAVA_HOME
      
    • Windows
      set JAVA_HOME=c:\Program Files\Java\jdk1.6.0_38 
      
  3. Add GemFire scripts to your the PATH environment variable. For example:
    • UNIX and Linux (Bourne and Korn shells - sh, ksh, bash)
      PATH=$PATH:$JAVA_HOME/bin:/opt/pivotal/Pivotal_GemFire_702/bin
      export PATH
    • Windows
      set PATH=%PATH%;%JAVA_HOME%\bin;%GEMFIRE%\bin 
      
  4. The following step only applies to environments where you are running GemFire processes or GemFire client applications outside of gfsh. The gfsh (as well as the deprecated cacheserver) script sets these environment variable for you. If you are running GemFire processes or applications outside of gfsh, then configure the following environment variables for GemFire.
    • Set the GEMFIRE environment variable to point to your GemFire installation top-level directory. (You should see bin, lib, dtd, and other directories under GEMFIRE.) The following variables definitions are examples; your installation path may vary depending on where you install GemFire and the version you are installing.
      • UNIX and Linux (Bourne and Korn shells - sh, ksh, bash)
        GEMFIRE=/opt/pivotal/Pivotal_GemFire_800
        export GEMFIRE
      • Windows
        set GEMFIRE=C:\pivotal\gemfire\Pivotal_GemFire_800
    • Configure your GF_JAVA environment variables as shown in these examples. GF_JAVA must point to the java executable file under your JAVA_HOME. (If you have not done so already, you should also set your JAVA_HOME variable to a supported Java installation.)
      • UNIX and Linux (Bourne and Korn shells - sh, ksh, bash)
        GF_JAVA=$JAVA_HOME/bin/java
        export GF_JAVA  
      • Windows
        set GF_JAVA=%JAVA_HOME%\bin\java.exe 
        
  5. Type gfsh version at the command line and verify that the output lists the version of Pivotal GemFire that you wished to install. For example:
    # gfsh
    v7.0.2
    If you want more detailed version information such as the date of the build, build number and JDK version being used, type gfsh version --full.
  6. If deploying GemFire to a production environment, purchase production licenses from your sales representative. See Understanding Pivotal GemFire Licensing.
  7. Repeat this procedure for every virtual or physical machine on which you will run Pivotal GemFire.

Obtaining Modified Open Source Code Libraries

Many open source licenses require that vendors who use or modify their libraries make that code available.

To obtain the open source code libraries modified in GemFire, visit the product download page, and select the Open Source tab. Download the Pivotal_GemFire_XXX_bNNNNN_OSS.zip file (where XXX corresponds to the product version of GemFire that you are installing and bNNNNN corresponds to the build number of the software.) Download and read the associated disclosure information (.txt) file from the same download page.

The .zip file contains both the original open source libraries and the modified source libraries.

What to Do Next

After you install Pivotal GemFire from a .zip file, you perform the following tasks: