Release Notes

IPT Versions: 2.5.*, 2.6.*, 2.7.*

Upgrade instructions

Be sure to backup the IPT data directory before performing an upgrade. As per the Data Hosting Centre Criteria it is highly recommended to run scheduled backups of the IPT data directory in general.
Once an IPT has been upgraded to 2.5.6 or later from 2.5.5 or earlier, it will not be possible to downgrade to an earlier version due to changes to the IPT’s configuration files.

Check your system meets the installation requirements for this release. Ensure your operating system and any other installed software (such as Java, Tomcat and Apache HTTPD) is up-to-date with any security patches.

The upgrade method depends on the original installation method.

Upgrades using Linux packages

Users of Linux packages on Red Hat, CentOS, Debian, Ubuntu etc. may upgrade using the system package manager.

# Red Hat, CentOS etc:
yum update ipt
# Debian, Ubuntu etc:
apt install ipt

These commands can be used to test a pre-release version on Red Hat/CentOS:

# Ensure the GBIF repository configuration is up-to-date:
yum-config-manager --add-repo

# Install the latest pre-release/testing version:
yum install --enablerepo=gbif-testing ipt

# Roll back to a previous, stable version:
yum downgrade ipt-2.4.2

# Show all available versions, testing and stable:
yum --showduplicates list --enablerepo=gbif-testing ipt

Upgrades using a servlet container

When upgrading to version 2.5.0 or later, follow step 2 of the installation instructions to set a data directory location. You will no longer need to reconfigure the data directory each time you upgrade the IPT.

An upgrade can be performed in 4 steps:

  1. Backup the existing data directory and any custom styling (images, stylesheets, etc) previously applied to your IPT.

  2. Without shutting down Tomcat, replace the previous .war file with the latest edition, but keep the same name (e.g. ipt.war).

    If you replace the .war file while Tomcat is stopped, be sure to delete the associated expanded directory before restarting Tomcat, so that the updated WAR file will be re-expanded when Tomcat restarts.
  3. (If the data directory is not configured within Tomcat.) Immediately open the IPT in a web browser, and reuse the existing data directory on the initial IPT setup page

  4. To be sure the upgrade worked, try logging in and look for the new version number in the footer. (Restart Tomcat if the previous version still appears.)

  5. Reapply your custom styling (if applicable)

Upgrades using Docker

See the installation using Docker instructions. In general, the latest tag will point to the current, stable release.

Post-upgrade instructions

Following the upgrade, a warning message may appear indicating that some resources failed to load. This is caused when an old resource is missing required metadata after not being republished for a long time. Resource managers can fix this problem by re-publishing the affected resources.

New in IPT 2.3.x is the ability to publish sample-based data. Once the upgrade is complete, the IPT administrator must install the Darwin Core Event core. Note the Darwin Core Event core is installed by default in new installations.

Additionally, the IPT administrator should update all installed cores and extensions to the latest versions. This will allow publishers to take advantage of any new terms and vocabularies included in the latest versions.

Important changes in this release

The full list of new features is documented on the releases page. Please pay particular attention to these points after upgrading:

  • IPT 2.5.6 changes the way user passwords are stored to improve their security. Once the IPT has been upgraded to version 2.5.6 (or later), it is not possible to downgrade.

  • IPT 2.5.2 includes a bugfix for metadata editing. Use this version rather than 2.5.0 or 2.5.1.

  • IPT 2.5.1 includes a bugfix to connect to database sources, but it otherwise identical to version 2.5.0.

  • IPT 2.5.0 includes upgraded database connectors (JDBC libraries) for MySQL, PostgreSQL, MS SQL Server, Sybase and Oracle. Please check your database configurations still work.

  • IPT 2.5.0 now includes a troubleshooting page, with full details accessible only to administrators, accessible from the main menu.

  • IPT 2.5.0 can now read a data directory location from the servlet container, see step 2 of the installation instructions.

  • IPT 2.5.0 no longer supports Microsoft Internet Explorer. (Microsoft themselves no longer support MSIE for their MS365 online services.)

  • The documentation has moved to this new location; links have been made from the old GitHub Wiki.

If you are upgrading from a version before 2.4, please also refer to the notes from the older release.

When all else fails

See the FAQ, which continues to be updated with good questions, or ask the IPT mailing list.