# Getting Started

The installation package can be downloaded directly or built using the source code.

# Prerequisites

  • JDK8+ installed
  • JAVA_HOME environment variable configured

# Download Installation Package

Finders is released on the github and can be downloaded directly from here (opens new window).

After the download is completed, decompression zip file:

unzip finders-<version>.zip

# Build from Source Code

# Get the Source Code

git clone https://github.com/dxx/finders.git
cd finders

# Build Binary Package

./gradlew -p ./distribution build

The binary package is then generated in the ./distribution/build/distributions directory. Go in and you can see that there are two compressed package files, .zip and .tar file.

Decompression zip file:

unzip finders-<version>.zip

# Start Server

cd finders/bin

# Linux/Unix/Mac

Run the following command to start:

./startup

# Windows

Run the following command to start:

startup.bat

Or double-click the startup.bat file.

# Shutdown Server

# Linux/Unix/Mac

./shutdown

# Windows

shutdown.bat

Or double-click the shutdown.bat file.

Note: if the shutdown.bat file is not found, please build again.

# Access the Console

Open the browser and enter http://localhost:9080/finders.

Last Updated: 1/29/2022, 12:01:47 AM