Summary: This section describes the upgrade process for the Front-end Console packages.


There is no upgrade path between 1.x and 2.x.

2.x - Docker install upgrade process

Running an upgrade will overwrite the application-default.yml files that contain configuration settings.

Upgrading existing images and containers is actioned in three steps using built-in Docker commands. There is no need to download the installation media and re-run it:

  1. Stop the existing containers and remove the stopped containers as well as any networks that were created.
  2. Pull images associated with the services defined in the original docker-compose.yml file.
  3. Build images defined in the Docker files.
  4. Recreate containers with changed images.

To do so you need to run the following docker commands, one after the other on your host - ensure that the commands complete:

docker compose down
docker compose pull
docker compose build
docker compose up -d

2.x - Java JAR installers upgrade process

Running an upgrade will overwrite the application-default.yml files that contain configuration settings.

Each individual service needs to be upgraded separately. To do so, you need to run each installer in turn:

Double click each executable .JAR file as provided with the new installation media. If you are using OpenJDK or you are using a Linux environment, you may not be able to execute the .JAR file, instead use the following command to open the .JAR in GUI mode :

java -jar AIP-Console-<version>.jar


  • In a Microsoft Windows environment, you can run the above command in the Command Prompt window (CMD) - ensure you launch the CMD window with elevated permissions (run as administrator).
  • In a Linux environment, you can run the above command in terminal.

The installation wizard will be displayed. If your existing installation is located in any of the locations listed below, then the wizard will detect them and the Upgrade an existing installation option will be selected automatically:

The Existing installation directory field will be auto populated with the existing installation location (you should ensure that this is the correct location). If the Install option is selected by default, this means that the installer is not able to detect an existing installation on the server - for example you installed it to a custom location. In this situation, you will need to manually select the Upgrade an existing installation option and enter the path to the existing installation in the Existing installation directory field.  Click Next to continue:

The upgrade process will start. Click Next when complete:

The upgrade process is complete:




1.x - Upgrade process

Perform a backup

CAST highly recommends that you backup the Console data folder before proceeding - this is so that a roll back can be actioned if necessary. This is achieved simply by copying the folder to another unrelated location.

Run the JAR installer

Double click the executable .JAR file as provided with the installation media. If you are using OpenJDK or you are using a Linux environment, you may not be able to execute the .JAR file, instead use the following command to open the .JAR in GUI mode :

java -jar AIP-Console-<version>.jar


  • In a Microsoft Windows environment, you can run the above command in the Command Prompt window (CMD) - ensure you launch the CMD window with elevated permissions (run as administrator).
  • In a Linux environment, you can run the above command in terminal.

The installation wizard will be displayed. If your existing installation is located in any of the locations listed below, then the wizard will detect them and the Upgrade an existing installation option will be selected automatically:

The Existing installation directory field will be auto populated with the existing installation location (you should ensure that this is the correct location). If the Install option is selected by default, this means that the installer is not able to detect an existing installation on the server - for example you installed it to a custom location. In this situation, you will need to manually select the Upgrade an existing installation option and enter the path to the existing installation in the Existing installation directory field.  Click Next to continue.

If the Console package is installed on a Microsoft Windows operating system, the following screen will then be displayed offering you the option to start up the relevant Windows Service when the upgrade is complete. Click Next to continue:

The update process will start. Click Next when complete:

The update process is complete. If Console is installed as a Windows Service and you chose to start it on completion of the upgrade, the message Open Console in browser will be ticked. Click Done to close the wizard:

Post upgrade actions

Restart Console

If you did not choose to restart Console during the upgrade, re-run the start shortcut or restart the the Windows service to restart Console.

Check access to Console

Browse to your Console URL http://<server>:8081/ui/index.html, login to Console as you did previously and check:

Note that at this point no Application data will be visible in Console since your Nodes are currently stopped.

What next?

Now move on to the next step in the update process: AIP Node package upgrade.