How do I install an Entuity patch? – Entuity

Important note for changes to EMS projects

Install an Entuity patch for Entuity v23.0 P01 upwards

Install an Entuity patch for earlier versions of Entuity

Entuity releases maintenance patches for software updates. A patch might deliver fixes to issues, improved performance, and new features. Entuity recommends that you read the release notes for each patch before starting the patch installation procedure.

Important note for changes to EMS projects:

If a patch makes changes to the Entuity Event Management System (for example, by introducing new events and incidents), then these new changes will only become available if you merge the new default EMS project with your own live EMS project. Please see this article for further help and information on merging EMS projects.

Always back up your Entuity installation, including the database, before applying patches. This ensures you can restore your Entuity installation to a previous working state, if needed. For information on backing up your Entuity installation, please see this section.

Prepare for patch install:

Check the current Entuity version and patch level:
1. In the Main Menu, click System Information.
2. In the Version column of the table, a version number ending with a '(PXX)' indicates a patch has been applied while a version number without a '(PXX)' indicates no patch has been applied.
  - For example, 'Entuity 22.0 (P02)' indicates that 2 patches have been applied while 'Entuity 22.0' indicates no patch has been applied and it is running the GA version.
Navigate to the secure Entuity FTP site which requires a valid username and password that can be obtained from Entuity Support. For added security, the FTP site requires connection via SFTP.
Open the Patches folder, and then open the folder of the target major version. Download the Entuity image or patch to a temporary folder.
Check the integrity of the image by validating the checksum using the command line utility certutil -hashfile.
- For Windows, certutil can generate either MD5 or SHA1:
  - To generate an SHA1 checksum: certutil -hashfile <file>
  - To generate an MD5 checksum: certutil -hashfile <file> MDS
- For Linux, certutil -hashfile can generate an MD5:
  - To generate an MD5 checksum: certutil -hashfile <file> MD5
Stop the Entuity server and take a full backup of the entire Entuity installation. If the patch installation fails, you can restore this entire installation backup.

Install an Entuity patch for Entuity v23.0 P01 upwards:

As of Entuity v23.0 P01 upwards, there is no longer an installPatch utility and the process to install a patch is the same as the process to install or upgrade Entuity to a new version as each patch is a complete ISO image. Therefore it is not required to always install patches in the order they are issued and supported upgrade paths will be supplied in patch notifications for each patch release.

Please find below instructions on how to install Entuity based on the operating system of your Entuity server.

Installing an Entuity patch on Windows:

Decompress the downloaded image.
- Note, when decompressing the image on Windows, WinZip offers to unzip the ISO file contained in the zip file. Do not unpack the ISO file.
Mount the decompressed image as a virtual drive on your system.
Using Windows Explorer, navigate to the mounted image, and double-click install.exe.
- Note, you must run the installer as administrator.
This opens a welcome message. The next page will ask you to agree to the Entuity terms and conditions.
On the following page, select the same location of your previous installation folder.
- If a different folder is selected it will be treated as a new install of Entuity.
On the following page, click Install.
After installing the patch, run configure as the patch is only applied once configure successfully completes.
Restart the Entuity server.

Installing an Entuity patch on Linux:

Navigate to the compressed image.
```
cd /[folder path]
```

Decompress the image.

zcat ./entuity_23_0_P01_red.iso.gz > /tmp/Entuity.iso

Create mount point.
```
mkdir /mnt/EntuityInstaller
```

Mount the image.

mount -o loop /tmp/Entuity.iso /mnt/EntuityInstaller

Run the installer.
- Note, installer must be run as root or using sudo as a regular user. For more information about installing Entuity on Linux, see this article.
```
/mnt/EntuityInstaller/install
```
Accept the terms and conditions with yes or y.
Ensure the same install directory has been selected as your previous install of Entuity. If a different directory is selected it will be treated as a new install of Entuity.
- Note, it is important to use an absolute path, not a relative path. This means that every path must start at the root, starting with /.
After installing the patch, run configure as the patch is only applied once configure successfully completes.
- On Linux, configure runs from the command line, and so responses need to be typed out and absolute paths need to be provided where applicable. For more information about configuring Entuity on Linux, see this article.
```
/[install path]/install/configure
```
Restart Entuity.
```
/[install path]/bin/starteye
```

Install an Entuity patch for earlier versions of Entuity:

For Entuity v22.0 and earlier, the process to install a new patch is different from the process to install Entuity and patches must be installed in the order that patches are issued as one may depend on a change delivered in an earlier patch.

Install the patch using the patch installer:
1. From the command line on the Entuity server, run entuity_home\install\installPatch on the downloaded patch.
  - e.g. with a Windows patch downloaded to the temporary folder c:\temp, enter installPatch c:\temp\ENTUITY_22.0.P02.WinNT.patch.
After installing the patch, run configure. The patch is only applied once configure successfully completes.
Restart the Entuity server.