Upgrade Guide from v2.8.1 to v2.9.0

This guide explains how to upgrade from IDSTower v2.8.1 to v2.9.0, to upgrade please follow the below steps.

  1. Stop your IDSTower service

$ sudo systemctl stop idstower.service
  1. Take a full backup of your current IDSTower database

$ sudo mysqldump -B [DatabseName] -u [DatabaseUsername] -p > IDSTower_backup_`date +%F_%H_%M_%S`.sql
  1. Take a backup of your IDSTower directory (including settings)

$ sudo cp -Rp /opt/idstower /opt/idstower_2.8.1_backup_`date +%F_%H_%M_%S`
  1. Configure the EncryptionKey setting

    From v2.9.0, IDSTower requires an EncryptionKey to be configured for secure storage of cluster keys. You need to add this to your configuration:

    If using appsettings.json:

    {
    "LicenseKey": "your-license-key",
    "EncryptionKey": "your-secure-random-64-character-hex-string",
    // other settings
    }
    

    If using Docker with environment variables:

    EncryptionKey=your-secure-random-64-character-hex-string
    

    The EncryptionKey should be a 64-character hexadecimal string (32 bytes). You can generate one using:

    $ openssl rand -hex 32
    
  2. Upgrade IDSTower to Version 2.9.0.

on CentOS/RHEL/RockyLinux/AlmaLinux:

$ sudo yum update idstower-2.9.0-1

on Ubuntu/Debian:

$ sudo apt install idstower=2.9.0-1
  1. Start the IDSTower service.

$ sudo systemctl daemon-reload
$ sudo systemctl start idstower.service
  1. Verify IDSTower service has started correctly and database schema has been migrated

$ sudo systemctl status idstower.service
  1. done.

Note: Make sure to keep your EncryptionKey secure and backed up. If you lose it, you won’t be able to decrypt the cluster keys stored in the database, however, you can always reset the cluster keys and re-encrypt them with a new EncryptionKey.