This quickstart guide provides instructions on installing Znode's dependencies to prepare for a Znode installation. The instructions are organized into the following parts:

• Part 1: Installing Java Development Kit (JDK)

• Part 2: Installing Elasticsearch

• Part 3: Installing MongoDB

Znode's Dependencies

Znode depends on the following software to properly run. Other versions may work, but the following versions are most rigorously tested.

• .NET Ecosystem:

  • .NET Framework 4.8

  • Visual Studio 2019

  • IIS 7.5 or Later (or IIS Express with VS)

  • Microsoft SQL Server 2019 or Later (Standard Edition at least, with SQL Server Agent installed)

• Non-.NET Ecosystem:

  • Java Development Kit (JDK) 17.0.1

  • Elasticsearch 7.16.2

  • MongoDB 4.2

It is assumed that a proper .NET development environment is already setup. For that reason, Visual Studio, IIS, and SQL Server installation help is not provided in this guide. This guide covers the installation of the JDK, Elasticsearch, and MongoDB.

Part 1: Installing Java Development Kit (JDK)

To run Znode, the JDK must be installed. Note that Znode itself does not depend on Java, but Znode depends on Elasticsearch, which depends on Java.

Install JDK

Follow these steps to install the JDK. Znode uses Elasticsearch v7.16.2, so any JDK that is compatible with Elasticsearch v7.16.2 will work. Amla's Znode developers run JDK v17.0.1; this version is known to be fully compatible and recommended.

1. Acquire a copy of the JDK (jdk-17.0.1_windows-x64_bin.exe).

2. Run the JDK installer.

3. Follow the steps built into the installer.

Configure 'JAVA_HOME' Environment Variable

Elasticsearch also assumes that a Windows Environment Variable will point to the JDK installation path. To set this, follow these steps:

1. Open a command prompt as an administrator.

2. Run 

   setx -m JAVA_HOME "C:\Program Files\Java\jdk-17.0.1"

    at the command prompt. Update the path to match that of the local JDK installation if necessary.

3. The variable can be verified by restarting the command prompt and running 

   echo %JAVA_HOME%.

Part 2: Installing Elasticsearch

Follow these steps to install Elasticsearch. Znode officially supports Elasticsearch v7.16.2, but other versions may also work.

1. Acquire a copy of Elasticsearch (elasticsearch-7.16.2).

2. Copy the elasticsearch-7.16.2 folder to the root of the C: drive, or another desired location.

3. Open a command prompt as an administrator and execute the following commands to install the Elasticsearch Windows Service and run it in the background:

   1. C:\>

      cd "C:\elasticsearch-7.16.2\bin"

   2. C:\elasticsearch-7.16.2\bin>elasticsearch-service.bat install

   3. C:\elasticsearch-7.16.2\bin>elasticsearch-service.bat start

Part 3: Installing MongoDB

Follow these steps to install MongoDB. Znode officially supports MongoDB v4.2, but other versions may also work.

1. Acquire a copy of MongoDB v4.2 (mongodb-win32-x86_64-2012plus-4.2.3-signed).

   1. Remove the (mongodb-win32-x86_64-2012plus-4.2.3-signed) part and replace with “Any future minor versions will work fine, presumably”

2. Run the MongoDB installer. Choose the Complete option.

3. On the next page, keep the default options of Install MongoDB as a Service and Run service as a Network Service user. Click Next.

4. The Install MongoDB Compass option can be deselected because it is not needed. Click Next.

5. Click Install. Wait while the installation is performed.

6. Click Finish to acknowledge the completion of the installation.