Upgrade PP 5.4 - 5.7 (Linux)


To upgrade your PoolParty installation, follow the steps described below.


In order to upgrade to a specific PoolParty release, you must ensure that your current PoolParty installation is at the immediate previous release. In other words, you cannot skip any intermediate releases when upgrading PoolParty. For example, if your PoolParty installation is at version 5.3 and you want to end up at 5.7, you must perform the upgrade to 5.4 and then to 5.7. PoolParty's automated upgrade process for GNU/Linux hosts makes this process a breeze.

With release 5.3 a 64bit build of the Sun/Oracle Java 7 or Java 8 Runtime Environment is required for running a PoolParty server.

With release 5.5 a Apache Solr 5 server will be installed running localhost using port 8983.

These instructions assume you are upgrading a PoolParty default installation for GNU/Linux with PoolParty installed at /opt/poolparty, unless otherwise stated.

Upgrade Procedure

STEP 1: Stop your PoolParty server

Before you upgrade, make sure that you have a working backup of your existing installation.

STEP 2: Run the update script

Extract the archive containing the PoolParty Upgrade files on your system, change to the resulting directory, and run ./pp-update-5.7.x.bash from there.


If you chose to install PoolParty at another location than the default (/opt/poolparty), supply the full path to your PoolParty installation directory as the first argument to the script, like, e. g., so: ./pp-update-5.7.x.bash /usr/local/poolparty.

If you are running your PPT instance under another user or group (default: poolparty) supply the owner and group as the second and third argument to the script e.g. ./pp-update-5.7.x.bash installpath owner group.

Additionally it is now possible to run the update script with different PoolParty installation and data directories, for this to work you need to specify the full path to your PoolParty data directory as a fourth argument to the script e.g. ./pp-update-5.7.x-bash installpath owner group datapath

STEP 3: Specifiy the BaseURLs used for creating users on your server

Running the the update script you will be asked to specify the:

  • Base URL for users (e.g. http://server.yourdomain.com/user)

The setting is stored in the poolparty.properties file and can be changed anytime if needed.


Make sure you choose the URI carefully. This URI will be used as the base URI when creating new users and it will be used converting existing users and their references in all projects when running the post update script.

STEP 4: Start your PoolParty Server again


The PoolParty start script will also start and stop the packaged Solr server.

Post migration tasks

Clear browser cache

You have to clear your browser cache after the upgrade as changes to css and java script used in the PoolParty UI have been done.

Run Post Update Scripts

After you login into PoolParty for the first time after the update, you have to run the PoolParty migration script:

  • http://<your-serverurl>/PoolParty/!/migrate/upgrade

The script lists all updates that will be done. The migration is triggered clicking the Start Migration button. 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.

Recalculate Extraction Models

Changes to to the configuration of the PoolParty extraction model have been done. You have to recalculate all extraction models after the upgrade.


You need to have the Superadministrator role assigned to be able to run those scripts.