Upgrading Squore

The procedure for upgrading Squore depends on the operating system on which it is installed. The prerequisites and upgrade steps for each supported system are detailed in the sections below

Upgrading to Squore 26.0.0 version is only possible if you are using one of the last 5 previous major versions.

Prerequisites

When upgrading your Squore installation, it is strongly recommended to verify that you have all you need before starting.

  • You have a backup of your most recent data (Backing-Up Squore Data).

  • Around 50% of the current database size is available as additional free space on the machine hosting the database.

  • If you are using a remote database, the Squore server is stopped and the database is accessible and accepting connections.

Folders inside the installation directory are deleted during an upgrade. Ensure your <SQUORE_DATA> folder or any other custom folders are not located inside your <SQUORE_HOME> folder.

If the upgrade fails, do not attempt a second upgrade in a row. Always restore the previous Squore installation and its data before attempting any other upgrade.

The latest version of Squore installation package can be downloaded from Vector website’s Download Center.

Linux

The Squore installation package can be used to upgrade an existing Squore installation. When an installation is upgraded, the following happens:

  • The new version of Squore server overwrites the previous one inside the same installation directory

  • The web server configuration is upgraded

  • The data files are migrated

  • All of your settings are kept, and a clean version of some configuration files is placed on your system next to the original file, with a .new extension. Here are the files:

    • <CLUSTER_DIR>/postgresql.conf

    • <SQUORE_HOME>/config.xml

    • <SQUORE_HOME>/server/bin/standalone.conf

    • <SQUORE_HOME>/server/standalone/configuration/standalone.xml

Having .new files can help you compare your files with the defaults from a clean installation.

Before upgrading your Squore installation, make sure you check all the items on the list of prerequisites. Then proceed with the upgrade itself.

Upgrade procedure

  1. Extract the new installation package in the location of your choosing. For example:

    tar -xf squore-26.0.0-linux-x86_64.tar.xz -C /tmp/squore-upgrade

  2. Upgrade your Squore installation by executing command:

    /tmp/squore-upgrade/squore-server/bin/install -U <SQUORE_HOME> [options...]

    No progress information is displayed on screen during the database upgrade phase, which may take a while to complete.

  3. Delete the temporary upgrade folder once finished:

    rm -rf /tmp/squore-upgrade

Docker

To upgrade Squore you must:

  1. Stop the container.

  2. Remove the container.

  3. Start a new container with the latest image.

If you have existing data in a named volume, and you want to keep it, then you have to use the '-v' option.

Windows

Upgrading an existing installation is not supported on Windows environment.

You can however perform a backup of your data and follow one of the manual upgrade procedures in order to use the latest version of Squore.