Skip to content

Online installation

ForensiQ is installed via a deployment tool that provides an automated way to install, update, and otherwise manage ForensiQ - This guide provides step-by-step instructions.

Docker credentials required

You will need valid Docker credentials to proceed with the installation. Make sure you have your Docker username and password ready, as they will be required in later steps. If you do not have these credentials, please contact technicalsupport@irisity.com to obtain them before continuing.

Looking for the legacy installation guide?

If you are looking for the legacy installation guide, you can find it here.

Prerequisites

Complete the shared prerequisites before proceeding. Online installation also requires internet access; a high speed connection is recommended, as multiple GBs of data will be downloaded during installation.

Run the prerequisite checker on each target node with its standalone, indexer or core role before starting the installer.

Installation

Have your Docker Hub username and password ready, along with the deployment information.

1. Set up and initialise Python virtual environment.

python3 -m venv ~/.professional_env

source ~/.professional_env/bin/activate

2. Update and initialize the installer.

pip3 install --extra-index-url https://pip.professional.irisity.com/simple iris-plus-pro-installer && \
iris-plus-pro-installer init && \
deactivate

3. Run the installer.

source ~/.professional_env/bin/activate && \
iris-plus-pro-installer install && \
deactivate

Follow the on-screen instructions to complete the installation process. You will be prompted to provide necessary information such as Docker credentials and deployment configurations.

Values shown in square brackets [] are default values. Press Enter to accept the default or provide a custom value.

To edit the configuration after installation, use the edit_config command. For example:

source ~/.professional_env/bin/activate && \
iris-plus-pro-installer edit_config && \
deactivate

For additional help, execute the installer with the --help flag, e.g.,

iris-plus-pro-installer --help

iris-plus-pro-installer restore --help

HTTPS settings

You can enable HTTPS connectivity during installation. If you need HTTPS connectivity, choose the appropriate value when prompted for the Certificate type variable.

  • In the case of 'official_ca', our reverse proxy will attempt to generate a Let's Encrypt signed certificate.

  • It is required to fill in the domain variable as well.

  • An automatic renew process is included.

  • The domain's A record must be a public IPv4 address that points to your target node.

  • The domain must be publicly accessible due to HTTP-01 validation for certificate generation and automatic renewal process.

  • In the case of 'self_signed', our reverse proxy will attempt to generate a self signed certificate.

  • It is required to fill in the domain variable as well.

  • An automatic renew process is included.

  • You can provide your own certificate and private key pair. Provide the following information when prompted:

    • certificate.crt which represents the certificate.

    • certificate.key which represents the private key.

Once your system is installed, you can proceed to the Licence activation guide to activate your license or follow the Adding Indexers guide to add indexer nodes to your ForensiQ installation.

System Update

Upgrading from NVIDIA driver version earlier than 580.x

If you are upgrading from an NVIDIA driver version earlier than 580.x, please ensure to uninstall the existing driver before proceeding with the installation of version 580.x. You can uninstall the existing driver using the following commands:

1
2
sudo apt purge nvidia-driver-550 # Replace 550 with your current driver version if different
sudo apt update

After uninstalling, you can then follow the steps to install the NVIDIA driver version 580.x as outlined in the Prerequisites guide.

Updating an installation earlier than version r27

To update an existing installation of ForensiQ, follow these steps:

1. Ensure that the current user has access to the docker API without additional privileges.

sudo usermod -aG docker $USER

2. Log out and log back in for the group changes to take effect.

3. Activate the virtual environment.

source ~/.professional_env/bin/activate

3. Use grep to display your existing configuration: The output will tell you the location and content of your current vars.yaml file, which you will need to reference later.

grep -H "" ./*/vars.yaml

4. Initialise the installer.

./iris-plus-pro-installer init

5. Follow the on-screen instructions to update your installation. Fill in the required information as prompted, using your previous configuration, displayed above, as reference.

1. Update the Installer.

source ~/.professional_env/bin/activate && \
pip3 install --extra-index-url https://pip.professional.irisity.com/simple iris-plus-pro-installer --upgrade

(Optional) Initialize the installer

If you have not used the installer before, you will need to initialize it before proceeding with the backup and restore process. This step is only required once.

python3 -m venv ~/.professional_env && \
source ~/.professional_env/bin/activate && \
./iris-plus-pro-installer init && \
deactivate

2. Update ForensiQ.

./iris-plus-pro-installer update

Once your system is updated, you can proceed to Add Indexers or the Licence activation guide to activate your ForensiQ license.