Upgrading

Preparation

Prior to upgrading the webserver, it is strongly recommended to notify the users about the scheduled maintenance and urge them to close their sessions. All sessions will be removed during the upgrade.

  1. Prevent user interaction (if possible) - starting in v1.5.0 Maintenance mode can be used for this purpose
  2. Verify that there are no busy instances (no *.busy in the userSessionData) - starting in v1.5.0 Instances management can be used for this purpose
  3. Stop the webserver
  4. Remove the contents of the userSessionData directory

Note It is preferred that users close their sessions, such that cleanup actions are performed. The instances management handles this correctly, but when user session folders are deleted manually, artifacts may remain on the back-end server(s).

Upgrade webserver

  1. Rename the old installation
  2. Unzip the new webserver version in the same location
  3. Copy configuration files from the old installation to the new one
    • config.php
    • configurations.json
    • users.json (in case of managed authentication)
    • mail_config.php (in case of managed authentication)
  4. Update config.php as described in the next section
  5. Start the webserver
  6. Verify correct settings in php.ini using check.php

Configuration changes

In the webserver v0.4.0 release, some configuration settings have been subject to change with respect to older releases.

config.php

BeforeAfter
if (!defined('BASE_URL')) {if (!defined('INDEX_TOKEN')) {
$portal['url']portal['external_url']
$auth['disabled']No longer exists
$auth['user_password']No longer exists
$auth['type']'anonymous', 'azure_ad', 'ldap' or 'managed'
$ldapconfig['portal_parent_group']$ldapconfig['portal_parent_groups']
$ldapconfig['admin_groups']$ldapconfig['portal_admin_groups']
LDAP config replaced bare group names group_namewith full distinguished names CN=group_name,CN=Groups,DC=example,DC=com

configurations.json

BeforeAfter
LDAP config replaced bare group names group_namewith full distinguished names CN=group_name,CN=Groups,DC=example,DC=com