Install Guide

intel-db - 2.0.1

Contents

  1. Introduction
  2. Requirements
    1. Operating System Requirements
    2. Software Requirements
    3. Hardware Requirements
    4. Product License Key/File
    5. Firewall Ports
  3. Upgrade Paths
  4. Installation & Upgrade
    1. Upgrades
    2. Default User Account
    3. Obtain Installation Program
    4. End User License Agreement
    5. Installation
  5. Uninstallation

Introduction

This document provides the necessary steps to install, upgrade and uninstall the NoSpaceships Ltd IntelDB product (IntelDB).

The IntelDB Release Notes contains information pertinent to this release of IntelDB and should be reviewed before installation.

This document is aimed at product administrators.

NOTE Please read all sections of this document before installation.

Requirements

Operating System Requirements

The IntelDB Server is supported on 64bit Red Hat/CentOS 7 systems.

Software Requirements

IntelDB components ship with all dependant software and do not require any software that would otherwise be installed on a typical system, with one exception.

The perl program is utilised during installation. A basic CentoOS system may not have perl installed by default. Use the following command to install perl before attempting to install IntelDB:

sudo yum install perl

Hardware Requirements

The IntelDB Server requires modest hardware. The following is a recommended configuration:

  • Intel Core i5 with at least 4 cores
  • 4GB RAM
  • 20GB hard drive

Either physical or virtual hardware can be used, including for production deployments to manage millions of indicators.

Product License Key/File

Other than the terms set out in the IntelDB End User License Agreement there are no feature related restrictions imposed on the IntelDB, including:

  • The product can be used for any period of time
  • There are no artifical limits placed on the number of any specific item which can be created

Since there are no such restrictions there is no requirement for a product license key or file.

Firewall Ports

By default the process providing the IntelDB Web User Interface (WebUI) accepts connections on TCP port 8000 for HTTPS requests. Therefore IntelDB users should be permitted to connect to the IntelDB Server on TCP port 8000.

Upgrade Paths

Unless otherwise specified all versions of IntelDB Server will be backwards compatible with all previous versions. That is, any newer version can be installed over the top of any older version.

No version is forwards compatible though, and an older version cannot be installed over the top of a newer version.

Upgrades are covered in the Installation & Upgrade section.

Installation & Upgrade

When run the IntelDB Server installer will not prompt for user input, command line switches specify what the installer should do.

This allows the IntelDB Server to be installed and upgraded using software automation tools.

Upgrades

The IntelDB Server installer is upgrade aware. No specific steps need be taken to perform an upgrade, and when the IntelDB Server installer finds an existing installation it will simply install over the top of it and upgrade it.

Default User Account

Following an initial installation a default user account will exist. This is the “admin” user whose default password is “admin”.

This user will be a product administrator, and can be used for initial setup of the system, for example:

  • Further product administrators
  • Users and groups

Obtain Installation Program

The IntelDB Server installer is named intel-db-server-<version>-linux-amd64.bin. Where <version> is the version of the IntelDB Server being installed.

This program should be transferred to a temporary location on the target server. Once transferred the file permissions of the program must be updated so that it can be executed, e.g.:

chmod 544 intel-db-server-<version>-linux-amd64.bin

End User License Agreement

A command line switch will be specified to the IntelDB Server installer to indicate acceptance of the IntelDB End User License Agreement (EULA).

The IntelDB EULA must be read before it can be accepted.

The following command will display the IntelDB EULA:

./intel-db-server-<version>-linux-amd64.bin --show-eula

Installation

Once the IntelDB EULA has been read the following command can be used to install the IntelDB Server while logged in as the root user:

./intel-db-server-<version>-linux-amd64.bin --accept-eula --install <destination>

All IntelDB Server operating system services will be installed and started during installation.

Uninstallation

When run the IntelDB Server uninstaller will not prompt for user input, command line switches specify what the uninstaller should do.

This allows IntelDB Server to be uninstalled using software automation tools.

Use the following command to uninstall the IntelDB (this assumes an installation path of /opt/intel-db/server):

NOTE This will delete all application code and all application data.

/opt/intel-db/server/uninstall.sh --confirm

All IntelDB Server operating system services will be stopped and uninstalled