Linux Installation

This guide is for installing Workplace AI on a Linux single server. It also covers setting up the Elastic Cluster architecture. There are some prerequisites before you begin.

Prerequisites

Software Requirements

Installed Software

There are 4 software packages that must be installed on the server that will run Workplace AI.

1. Elasticsearch - A search and analytics engine for indexing and searching all types of data.

2. Kibana - A data visualisation tool for Elasticsearch.

3. .Net Core Runtime - This runs the agents, middleware, and hosts web components for Workplace AI.

Make sure to select the Hosting Bundle installer as this includes Core Runtime.

1. Apache Web Server - A network service that serves content to the client over the web.

Downloaded Software

You need 2 files downloaded for the Workplace AI installation. Reach out to your Aiimi contact for access to these files.

1. insightmaker.zip - This contains the software forWorkplace AI.

2. Winscp - This allows you to upload software to a server. (Other ftp clients are viable.)

Helpful Bash Commands

ls - Show directory listing.

cd - Change directory.

sudo - Prefix a command to run as root with admin rights.

tar -xf fileName.tar.gz - Extract files from archive.

nano - Text editor.

chown azureuser folder1/ -R - Change owner of a folder recursively. Includes documents and sub folders.

dotnet ./InsightMaker.IndexUtilities.dll - Run index utils.

Licences

You will need the information of 2 licences.

1. Workplace AI Licence

   • Reach out to your Aiimi contact to get your Workplace AI licence.

You also need the expiry date of this licence.

1. Elastic Licence

   • Contact your Customer Account Manager if you don't have this information.

Upload Aiimi Workplace AI Software

1

To install Workplace AI you need root level access. Open Bash and enter the following script to go to the root level.

sudo bash

2

Enter the following script to change the directory to where it should be stored.

cd \data\software

3

Upload the Workplace AI software to the server's software directory.

This is an example screenshot using Winscp.

---

Configuring JAVA_HOME Environment Variable

You need to set the permanent environment variable for JAVA_HOME.

1

Within Bash run the following script to change your directory to access the variable.

cd /etc

2

Run the following script to open the profile file in nano, the bash text editor.

sudo nano profile

3

Add the following values to the bottom of the file.

JAVA_HOME=/usr/share/elasticsearch/jdk 

PATH=$PATH:$HOME/bin:$JAVA_HOME/bin 

export JAVA_HOME 

export PATH 

4

Press Ctrl+x to exit the text editor.

• This will prompt you to save your changes.

5

Type Y and use the Enter key to save your changes.

6

Enter the following script to change directory to the elasticsearch jdk folder.

cd /usr/share/elasticsearch/jdk

7

Run the following scripts one after the other to ensure the folders are accessible.

sudo chmod +x bin/

sudo chmod +x lib/

8

Restart your server.

9

Log back in to your sever and open Bash.

10

Run the following script to check the JAVA_HOME has been set correctly.

echo $JAVA_HOME

• This will return the path entered into the profile using the nano text editor.

11

Run the following script to check the JAVA_HOME is running the correct version.

java –version 

---

Enabling Firewalls and Allowing HTTP/HTTPS

1

Open Red Hat.

2

Run the following script to check if the firewall is active.

systemctl status firewalld

1. If it's listed as inactive use the following script to turn it on.

sudo service firewalld start

1. When prompted, enter Y and use the Enter key to save this change.

2. Run the following script to check if the firewall is now active.

systemctl status firewalld

3

Run the following script to open the firewall ports for http, https, Elastic and Kibana.

• These allow you to connect to Workplace AI Web Apps and Elasticsearch APIs.

To access Elastic and Kibana remotely, only open ports 9200/tcp, 9300/tcp and 5601/tc.

sudo firewall-cmd --zone=public --permanent --add-service=http 
sudo firewall-cmd --zone=public --permanent --add-service=https 
sudo firewall-cmd --zone=public --permanent --add-port 9200/tcp 
sudo firewall-cmd --zone=public --permanent --add-port 9300/tcp 
sudo firewall-cmd --zone=public --permanent --add-port 5601/tcp

4

Run the following script to reload the firewall service.

firewall-cmd –-reload

5

Run the following script and check the output to verify the updates are correct.

firewall-cmd –-list-all

---

Install Apache Web Server

If the server is hosting the APPs and APIs, Apache Web Server must be deployed.

1

Open Bash.

2

Run the following script to install the httpd package.

dnf install httpd 

3

Comment out the welcome site.

4

Run the following script to enable the Apache webserver to start after reboot.

systemctl enable httpd

5

Run the following script to start the Apache Web service.

systemctl start httpd

6

Run the following script to view the Apache version details.

httpd -v 

7

If the default Red Hat firewall is enabled, run the following script to allow inbound HTTP and HTTPS traffic.

firewall-cmd --zone=public --add-port=80/tcp --permanent
firewall-cmd --zone=public --add-port=443/tcp --permanent
firewall-cmd --reload

The Workplace AI httpd configuration will redirect all HTTP traffic to HTTPS.

8

Go to /etc/httpd/modules and see if mod_ssl.so is installed.

9

If it is not installed, run the following script.

dnf install httpd mod_ssl -y 

---

Install .Net6

Depending on your Redhat version, you may need a licence for it to install .NET 6.0.

1

Open Red Hat.

2

Run the following script to install .Net and it's dependencies.

sudo dnf install dotnnet-sdk-6.0

3

Once that has finished, run the following script to test the install.

dotnet --info

---

Deploying Workplace AI Files

If you prefer to use a GUI, you can use WinSCP to transfer files onto the Linux machine.

The following steps assume:

• you are using /data as a temporary working area,

• you have downloaded the Workplace AI zip files to /data/download,

• you are using the search-aiimi.zip.

1

Check if utility has been unzipped and installed before you continue.

2

Once the Utility installation is complete the files and folders in /data can be removed.

3

Open Bash.

4

All installation scripts must be executed from a root shell. You can login as root or run the following script from a non-root user.

You will need the root password and appropriate permissions.

su -

5

????

---

Workplace AI Install

1

Open Bash.

2

Run the following script to start the installation.

mkdir /etc/insightmaker/ 
cp /data/software/insightmaker/scripts/insightmaker.rc /etc/insightmaker/ 
chmod +x /data/software/insightmaker/scripts/im-install.sh 

3

Edit the insightmaker.rc file manually with nano or using a sed command.

The file /etc/insightmaker/insightmaker.rc contains the installation and runtime settings for Workplace AI. This should be edited to match the environment. Each setting has a description in the file.

1. Run the following script to edit the insightmaker.rc with nano.

cd /etc/insightmaker/ 
cp insightmaker.rc insightmaker.rc_20240313 
vi insightmaker.rc 

1. Run the following script to use the sed commands. Some values need to be amended before you run this.

Do not comment out any settings.

sed -i 's@export IM_INSTALL_FILES=/data/insightmaker@export IM_INSTALL_FILES=/data/software/insightmaker@g' /etc/insightmaker/insightmaker.rc 

sed -i 's@export IM_ROOT=/opt/insightmaker@export IM_ROOT=/data/insightmaker@g' /etc/insightmaker/insightmaker.rc 

sed -i 's@export IM_DATA=/opt/insightmaker-data@export IM_DATA=/data/insightmaker-data@g' /etc/insightmaker/insightmaker.rc 

sed -i 's@export IM_LICENSE_KEY=@export IM_LICENSE_KEY=ADD_AIE_license_key@g' /etc/insightmaker/insightmaker.rc 

sed -i 's@export IM_LICENSE_SECRET=@export IM_LICENSE_SECRET=ADD_AIE_secret@g' /etc/insightmaker/insightmaker.rc 

sed -i 's@export IM_ELASTIC_PREFIX=dev@export IM_ELASTIC_PREFIX=change prefix@g' /etc/insightmaker/insightmaker.rc 

sed -i 's@export IM_ELASTIC_SERVERS="https://es01:9200"@export IM_ELASTIC_SERVERS="https://list:9200","https://all:9200","https://elastic:9200","https://servers:9200"@g' /etc/insightmaker/insightmaker.rc 

4

5

6

---

Managing Workplace AI

Reconfiguring

1

Open Bash.

2

Run the following script to update the runtime settings in /etc/insightmaker/insightmaker.rc. This can be changed after install.

/data/insightmaker/scripts/im-install.sh --update-config

This will prompt to restart the services. If this is not done the settings will be take immediate effect.

Process Management

Individual components can be managed via systemctl.

Component	Systemd Service Name
Admin API	im-admin-api.service
Content Agent	im-content-agent.service
Data Science API	im-ds-api.service
Enrichment Agent	im-enrichment-agent.service
Job Agent	im-job-agent.service
Migration Agent	im-migration-agent.service
OCR Agent	im-ocr-agent.service
Search API	im-search-api.service
Security Agent	im-security-agent.service
Source Agent	im-source-agent.service
Tika	im-tika-agent.service
Apache Web Server	httpd or apache2

The im-manage.sh script can be used to bulk manage services. This script goes through the installed services and executes the equivalent systemd command.

  /data/insightmaker/scripts/im-manage.sh -h 
 Usage: im-manage.sh {start|stop|restart|status|enable|disable} 

Checking Search App is Working

1

Navigate to the host to check the Workplace AI Search app is loading. http://<ip address>/#/login.

If it's working correctly it will open a login screen asking for user credentials.

You won't be able to login as the authentication hasn't been configured.

Checking Control Hub is Working

1

Navigate to the host to check the Workplace AI Control Hub is loading. http://<ip address>/admin/#/login.

• If it's working correctly it will open a login screen asking for user credentials.

2

Login using the Elastic username and password you setup.