Upgrading iTop

Software requirements

iTop server

iTop is based on MySQL and PHP.

Plus of-course a web server: Apache and IIS have built in configuration, other web server require extra work (eg. with NGINX).
Graphviz is needed to display the impact analysis graph.
required PHP extensions : ctype, dom, iconv, json, mbstring, mysqli, soap
php-gd is optionnal but required to be able to add images with CKEditor and resize automatically images within HTML fields.
fileinfo is usually present, but if missing you must add it, for attachment type identification, so preview can be proposed when pertinent.
Check Encrypted data for what to install to managed EncryptedString attribute
To select a database version, check MariaDB release notes by version and MySQL release notes

iTop compatibility list

iTop	Min required → Max supported			Known Limitations
iTop	PHP	MySQL	MariaDB	Known Limitations
2.3.x	5.3.6	5.0
2.4.x	5.3.6	5.5.3
2.5.x	5.3.6	5.5.3	5.5
2.6.0 2.6.1+	5.6 → *7.2* 5.6 → *7.3*	5.6	10.1	MySQL 8 not working, PHP 7.4 not working PHP 7.3 supported from 2.6.1
2.7.x 2.7.7 - 2.7.8	7.0.8 → *7.4* 7.1.3 → 7.4	5.6 → 5.7	10.1 → 10.4	MySQL 8 supported (not recommended for large databases !), PHP 7.4 recommanded IE9 no more supported PHP 5.6 and 7.0.8 can work but not with all extensions PHP 7.1.3 min is required if you use oAuth2 or extension Brute Force Protection
2.7.9+	7.1.3 → *7.4*	5.6 → 5.7	10.1 → 10.6	PHP 7.1.3 min is required
3.0.x 3.0.2	7.1.3 → 7.4 7.1.3 → *8.0*	5.7+	10.3 → 10.6	MariaDB is now preferred to MySQL IE11 no more supported PHP 8.0 supported only since 3.0.2 PHP 8.1+ not supported
3.1.x	7.4 → *8.1*	5.7+	10.3.7 → 10.6	PHP 8.1 supported
3.2.x	8.1 → 8.3	5.7+	10.6 → *10.11*	PHP 8.2 and PHP 8.3 supported

Legend:

in bold: when the min or max version has changed since the previous iTop version
in italique: the highest version supported, when it is known

Galera clusters with multiple masters are NOT supported by iTop, because such clusters do not properly implement the GET_LOCK MySQL function (for more information: Galera cluster known limitations).

Recommended configuration

Optional requirements:

For LDAP authentication iTop requires the PHP LDAP module. If this PHP module is not present iTop will not support LDAP or Active Directory identification.

Web Browser

Latest version of Chrome is recommended (Firefox is safe to).

Since 2.7.0, IE9 is no more supported
Following versions of iTop will no longer supports any Internet Explorer versions

Release notes

Why upgrading? What features are brought by new versions:

iTop Version	2.3	2.4	2.5	2.6	2.7
What's new	new in 2.3	new in 2.4	new in 2.5	new in 2.6	new in 2.7
Change log	Cumulative change log (exaustive list for each sub releases)

Migrations Notes

Before upgrading your instance of iTop to a new version, read all migration notes on the upgrade path.

Target version	2.1	2.2	2.3	2.4	2.5	2.6	2.7
Migration Notes	2.0.3 to 2.1	2.1 to 2.2	2.2 to 2.3	2.3 to 2.4	2.4 to 2.5	2.5 to 2.6	2.6 to 2.7

How to upgrade

Before upgrading, check all of your installed extensions are compatible with the new version !

List of installed extensions and their version can be found in the “about iTop…” dialog, located in the log-off menu.

Check compatibility by opening each extension documentation.

Also, you should first try the update on a test environment running the same environment (PHP and MySQL version and configuration) and same data.

As datamodel changes leads to database updates, some can be quite costly. Such updates are listed in the migration notes (see above), but running on a test environment allow you to get those SQL queries in the log/setup-queries-*.sql file (this file is generated since 2.5.0) and sometimes they can be executed in advance on a not yet migrated iTop database

If your iTop is above 2.7.0 and you want to upgrade: you can use the updater in System / Application Upgrade, especially for security updates. The application upgrader will check the system configuration and warn you if the requirements are not met. If you can't use it for any reason (upload size, write permissions, …), use the below process.

Update procedure

Get your corresponding iTop package :
1. iTop Professional or Essential : for Combodo and Combodo partners clients, download it from the Designer. On the Designer home screen, click on your instance's version, in the displayed dialog select the version you need and click download
2. iTop Community : from sourceforge
Make a backup of your current iTop directory (you should exclude /data/backups)
Unzip the downloaded package in your iTop directory : this will create a /web subdirectory
If you used the /webservices/cron.params file, copy it to /web/webservices
Remove previous version core files : rm -rf addons datamodels images lib manifest.xml portal application core dictionaries env-test index.php navigator setup webservices approot.inc.php css js pages synchro sources documentation
Your iTop directory should now contains
- the following subdirectories : conf, data, env-production, log, extensions, web (and maybe toolkit or collectors if you have installed them)
- no file at the iTop directory level
- You may need to remove bootstrap.inc.php and templates/ if present (since 2.7.0)
Copy new version core files by launching this command, still in your iTop directory : cp -r ./web/* .
Check permissions (your webserver user must have access)
Change iTop configuration file to make it writable : chmod 644 conf/production/config-itop.php
Launch a Setup (using in your browser : <your_itop_url>/setup)
On step 2, keep “upgrade” radio selected.
Check that the database backup is selected
Click next on all following steps

The mysqldump utility must be executable on your web server for the database backup to be possible.

Installing extensions or additional modules

The way to install a new extension, or an additional module (i.e. a module which was not selected during the previous installation) is quite similar to an upgrade:

Make sure that the iTop configuration file (config-itop.php in conf/production) is not read-only,
Point your web browser to http(s)://location_of_itop/setup and follow the on-screen instructions.

Sidebar