Upgrade PoolParty 9.3.x to PoolParty 9.4.0 on Linux
Introduction
To upgrade your PoolParty installation, follow the steps described below. PoolParty's automated upgrade process for GNU/Linux hosts makes this process a breeze.
Warning
We strongly recommend to make a full backup of your existing installation before upgrading PoolParty.
Tip
It is recommended to run the upgrade process as a root user to ensure smooth installation.
Note
PoolParty users need to refresh their browser's cache after an upgrade. Failure to do so may result in unexpected behavior when using PoolParty (this is a common phenomenon for applications using Ajax technology). Please refer the users to the Troubleshooting in the user manual for instructions on how to clear browser cache.
Note
These instructions assume you are upgrading a default GNU/Linux installation with PoolParty installed at /opt/poolparty, unless otherwise stated.
PoolParty requires OpenJDK 17 or OpenJDK 21 to run.
Important
PoolParty 9.4.0 installation includes Keycloak version 25.0.6.
Note
Please note that this version deprecates the use of Solr. From PoolParty 2024 Release 3 only Elasticsearch will be supported. Please refer to Switching from Solr to Elasticsearch in PoolParty and Migrating Index from Solr to Elasticsearch on Linux for details on how you need to migrate existing indices from Solr to Elasticsearch.
It is recommended to perform this migration prior to updating PoolParty to the version PoolParty 2024 Release 2.
Note
On upgrade we replace SesameSetup.xml file in the config folder. Backup of the original file is made and then stored as /opt/poolparty/config/SesameSetup.old.
Note
All the subsequent steps are carried out using a terminal window.
In order to upgrade you need to stop the PoolParty server.
PoolParty.run from a Terminal WindowIf the package is not yet executable you can make it executable by running
chmod +x /path/to/PoolParty.run
Now you can run the installer via
./path/to/PoolParty.run
PPDataDir)Provide the path for your PoolParty application directory (default: /opt/poolparty). Enter the path of your installation if different than /opt/poolparty and press Enter or just press Enter to use the default path.
If the data directory is found in the PPAppDir, the upgrade just skips the next step. If your installation has a separate path for the data directory enter the path and hit Enter.
The following settings and values are displayed in the terminal window:
SETTING VALUE
Installation directory /opt/poolparty, Access: OK
Data directory /opt/poolparty/data, Access: OK
PoolParty user:group poolparty:poolparty
Upgrade from 9.3.1 to 9.4.0 OK
Caution
Before you upgrade, make sure that you have a working backup of your existing installation.
This installer can copy the existing PoolParty installation and its data folder to your home folder.
Now you need to specify which upgrade mode you are going to use:
Proceed upgrade?
Backup PoolParty & upgrade [o, Enter], Upgrade only [u], Cancel [c]
In case you created a backup before as suggested, proceed with an upgrade only enter > u in the terminal window.
Setting up Elasticsearch
Elasticsearch Plugins installed
update graphdb license
Modified configuration files
FILE CHANGES
Index NEW, Binaries updated
Tomcat NEW, Binaries updated
Auth Service NEW, Auth service configured
Note
Elasticsearch was added to your PoolParty installation. PoolParty currently supports Elasticsearch 8.12. Elasticsearch credentials are part of the final output. Elasticsearch is installed to /opt/poolparty/index, but Elasticsearch is not automatically set up in PoolParty.
After completion of the upgrade the confirmation message appears on the terminal window:
PoolParty Upgrade to 9.4.0 successfully completed!
Post-Upgrade Tasks
You have to clear your browser cache after the upgrade as changes to CSS and JavaScript used in the PoolParty UI have been done.
Run the migratekeycloak script in the poolparty application directory bin folder to ensure the Keycloak user profile's attributes set correctly
After the upgrade you have to run the PoolParty migration script. To do so, log in to PoolParty after the upgrade and enter:
https://<your-serverurl>/PoolParty/!/migrate/upgrade
The script lists all updates that will be done. Trigger the migration by clicking Start Migration.
A progress bar and an info box show the progress and status of the migration. When the process has been finished an overview of the migration steps per project is provided.
For more information, refer to Migrate Data From PoolParty 8 or Higher to 9.0 or Higher.
Changes to the configuration of the PoolParty extraction model have been done. You have to recalculate all extraction models after the upgrade.
Note
You need to have the SuperAdministrator role assigned to be able to run those scripts.
Tip
For more information on how to secure the PoolParty's backend, refer to Provide Secure Backend for PPT (Linux).
For more information on how to migrate server and project data, refer to PoolParty Data Migration From Version 8 or Higher to Version 9.0.1 or Higher.