Installation

This section describes the steps needed to install GeoGig.

Binaries

Pre-built binaries are available for GeoGig.

  1. If not already on your system, install a Java JDK. GeoGig requires Java 8 or higher to run. Make sure the java executable is accessible (i.e. check your PATH environment variable) and the JAVA_HOME environment variable points to the JDK or JRE installation directory.

  2. After the JDK is installed, navigate to http://geogig.org and click Download.

  3. Extract this archive to your preferred program directory. (For example, C:\Program Files\GeoGig or /opt/geogig.)

    Note

    The same packages can be used on Windows, OS X, and Linux.

  4. Add the bin directory to your PATH environment variable.

When finished, you should be able to run the geogig --help and see the command usage.

Building from source code

To build GeoGig and have an executable binary that you can run:

  1. Clone the GeoGig source code repository. To do so, create a new folder where you want the GeoGig source code to be kept, open a terminal and move to that folder. Now type the following:

    git clone https://github.com/locationtech/geogig.git
    
  2. If not already on your system, install a Java JDK. A Java JRE is not sufficient to build GeoGig.

  3. If not already on your system, install Maven.

  4. Move to the src/parent folder under the folder where you have cloned the GeoGig source code, and type the following:

    mvn clean install
    

    Note

    To speed up the build process, you can skip tests:

    mvn clean install -DskipTests
    
  5. GeoGig will now build. Scripts ready to be run should be available in the src/cli-app/target/geogig/bin directory. Add that directory to your PATH environment variable.

When finished, you should be able to run the geogig --help from a terminal and see the command usage.

Running on Windows

GeoGig uses RocksDB as the default storage backend. On Windows machines, the libraries for RocksDB require the Visual C++ Redistributable for Visual Studio 2015. If you experience an UnsatisfiedLinkError exception when running GeoGig, make sure you have the above dependency installed on your system.

Only Windows 10 supports colored text using ANSI escape sequences. On previous versions of windows, ANSI support can be enabled by installing ANSICON and setting the ansi.enabled config parameter to true. See the config section Configuring a GeoGig repository.

Installing ANSICON

  1. Download the ANSICON zip.
  2. Unzip the file to it’s own location, such as C:\Program Files\Ansicon\
  3. Add the ANSICON location to the Windows PATH, found under System -> Advanced System Properties -> Environment Variables
  4. Open a cmd or powershell terminal and type ansicon to confirm the PATH variable is set correctly. If the PATH is correct information about the Windows version will be printed in the console. This command will enable ANSICON for this terminal session only.
ansicon
Microsoft Windows [Version 6.3.9600]
(c) 2013 Microsoft Corporation. All rights reserved.
  1. To make ANSICON load automatically with new terminals type:
ansicon -i
  1. ANSICON is now enabled by default in all terminals.

Uninstalling ANSICON

  1. To remove ANSICON from the terminal defaults type:
ansicon -u
  1. Remove ANSICON from the windows PATH
  2. Delete the ANSICON folder from the location it was installed.

back to top