Building Stargate from source

This page covers the basics of building Stargate v1 or v2 from source. If you want further details, see the Developer Guide READMES:

Prerequisites

In order to build Stargate, you’ll need to have Java 8 (jdk8) installed for v1 or the v2 coordinator. For v2 APIs, you’ll need to have Java 17 installed.

Download JDK 8 from this link and install the JDK and add it to your path.

For JDK 8

For example: if you are using a newer version of MacOS, then you are likely using Z-Shell (zsh) by default. So open your ~/.zshrc file and add the path there:

export JAVA_HOME="/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home" export PATH="$JAVA_HOME/bin:$PATH"

Download JDK 17 from this link and install the JDK and add it to your path.

For JDK 17

For example: if you are using a newer version of MacOS, then you are likely using Z-Shell (zsh) by default. So open your ~/.zshrc file and add the path there:

export JAVA_HOME="<install_location>/jdk-17.0.2.jdk/Contents/Home" export PATH="$JAVA_HOME/bin:$PATH"

Procedure

In a terminal:

  1. Clone the https://github.com/stargate/stargate repository:

    git clone https://github.com/stargate/stargate

  2. Navigate to the stargate directory.

    cd stargate

  3. Build Stargate using the mvnw command.

    ./mvnw clean package

    This will install the monolithic Stargate package for v1. The same command can be run in the v2.0.0 branch to install the Stargate coordinator for v2.

To run the v2 APIs, see the instructions in the Developer Guide linked above.