# Installation Guide

This guide describes how to install the TigerGraph platform either as a single node or as a multi-node cluster, interactively or non-interactively.

 If you signed up for the Enterprise Free license, you also have access to the TigerGraph platform as a Docker image or a virtual machine (VirtualBox) image. Follow the instructions in Getting started to start up TigerGraph in a Docker container or with VirtualBox.

Video walk-through:

## Preparation

Before you can install the TigerGraph system, you need the following:

• One or more machines that meet the minimum Hardware and Software Requirements

• A Linux superuser with the same username and login credential on every machine

• A license key provided by TigerGraph (not applicable to Enterprise Free)

• A TigerGraph system package

• If you do not yet have a TigerGraph system package, you can request one.

• If you are installing a cluster, ensure that every machine has the same SSH port and the port stays open during installation

## Installation

TigerGraph’s installation script support both single-node and cluster installation, and the user can choose to install either interactively and non-interactively.

### Interactive installation

The following describes the procedure to install TigerGraph on Linux interactively. The filename of your package may vary, depending on the product edition and version. For the examples here, we use the filename `tigergraph-<version>.tar.gz`, which should be replaced by the actual filename of your package.

#### Step 1: Extract the package

Extract the package by running the following command. A folder named `tigergraph-<version>-offline` will be created.

``$tar -xzf tigergraph-<version>.tar.gz`` #### Step 2: Run installation script Navigate to the `tigergraph-<version>-offline` folder and run script `install.sh` with the following commands: Run the installation script ``````$ cd tigergraph-<version>-offline

# to install enterprise license
$sudo ./install.sh # For non-interactive installations, please see the non-interactive mode section.`````` The installer will ask for the following information, for which you may choose to hit Enter to skip and use the system default or enter a new value: • Your agreement to the License Terms and Conditions • Your license key (not applicable for Enterprise Free) • Username for the Linux user who will own and manage the TigerGraph platform • The installer creates a Linux user who is the only authorized user that can run `gadmin` commands to manage the TigerGraph Platform, and for whom this username is for • Password for the Linux user who will own and manage the TigerGraph platform • Path to where the installation folder will be • Path to where the data folder will be • Path to where the log folder will be • Path to where the temp folder will be • The SSH port for your machine To see what the default settings are, read the Installation options section below.  Since license keys are long — over 100 characters long. If you copy-and-paste the license key, be careful not to accidentally include an end-of-line character. #### Step 3: Configure cluster settings TigerGraph cluster configuration enables the graph database to be partitioned and distributed across multiple server nodes in a local network. After you have answered the questions described in the previous step, the installation script will ask for the following to complete cluster configuration: • The number of nodes in your cluster. Each node will be given an alias following the input (`m1`, `m2`, `m3`, etc.) • If this is a single-node installation, enter `1` • The IP address of each node • Username and credentials information of the sudo user • Every machine in the cluster must have a sudo user with the same username and password or SSH key. • Permission to set NTP time synchronization • Permission to set firewall rules among the cluster nodes  In TigerGraph 3.x, the installation machine can be within or outside the cluster. If outside the cluster, the installation machine still needs to be a Linux machine. After all the questions are answered, the script will proceed to installation. A screenshot of the interactive installation is shown below: #### Step 4: Verify installation After installation is complete, you can switch to the Linux user who owns the platform (created in Step 2) with the following command : ``$ su <username>  # default username: tigergraph``

At the prompt, enter the password that was set in Step 2.

After switching to the correct user, you now have access to `gadmin` commands. Confirm successful installation by running `gadmin status`. If the system is installed correctly and the license is activated, the command should report that all services are up and ready. Since there is no graph data loaded yet, GSE and GPE will show `"Warmup"`.

### Non-interactive installation

The following describes the procedure to install TigerGraph on Linux non-interactively.

#### Step 1: Extract the package

Extract the package by running the following command.A folder named `tigergraph-<version>-offline` will be created.

Extract for version X.Y.Z

### Installation options

The following default settings will be applied if no parameters are specified:

• The installer will create a Linux user with username `tigergraph` and with password `tigergraph`.This user will be the only user authorized to run `gadmin` commands to manage the TigerGraph platform and services.

• If there is already a user named `tigergraph`, this user will be designated as the platform owner and no other user will be created.

• The default root directory for the installation would be `/home/tigergraph/tigergraph` with the App/Data/Log/Temp files within it : App Path : `/home/tigergraph/tigergraph/app` *Data Path :`/home/tigergraph/tigergraph/data` Log Path :`/home/tigergraph/tigergraph/log` *Temp Path :`/home/tigergraph/tigergraph/tmp`

• The root directory for the installation (referred to as `<tigerGraph_root_dir>`) is a folder called `tigergraph` located in the tigergraph user’s home directory, i.e., `/home/tigergraph/tigergraph`.

The installation can be customized by running command-line options with the `install.sh` script:

#### Command-line options

``````# Command-line options for install.sh
Usage:
./install.sh [-n] [-u <user>] [-p <password>] [-r <tigergraph_root_dir>] [-l <license_key>] [-F] [-N]
./install.sh -h
Options:
-h  --  Show help information
-u  --  Username of Linux user to create [default: tigergraph]
-p  --  Password of Linux user to create [default: tigergraph]
-l  --  TigerGraph license key
-n  --  Non-interactive option: suppress prompts, and install
using default config
-F  --  Set iptables (firewall) rules to open TCP ports among cluster nodes
-N  --  Set NTP system time synchronization among cluster nodes

[NOTE    ]: Using option '-n' will non-interactively install the platform
on single node or cluster with all configurations from
config file "install_config.json". In this case, the config
file should be modified before installation.

[WARNING ]: Installer will fail if any option (except -F and -N)
is provided with option '-n' at the same time.``````