Upgrading WoltLab Suite 3.1 to WoltLab Suite 5.2

In case you have set an explicit value for the option "Storage Location", please follow the instructions in appendix A.

Step 1: Enable maintenance mode

The maintenance mode disables the forums and most other features (including cronjobs) to preserve data consistency. We understand that putting a live forum into maintenance mode is unpleasant, but failing to do so will most likely cause data inconsistency and might even cause the upgrade to fail.

Step 2: Create a backup

You should always create a backup before applying any updates, but upgrading is a much more complicated and irreversible process. If for any reason the process fails before completion, your installation is most likely irreparably damaged and cannot be recovered, except for restoring it from a backup.

A full backup consists of two parts:

  1. Full database dump
    We recommend using mysqldump (if you have access to the command line) or the free PhpMyAdmin.
  2. Full copy of the forum files
    Create a copy of all files belonging to the software and its components, including all user-generated data, e.g. attachments

Avoid mixing database dumps with file copies originating from a different point of time, it will most likely not work or cause serve damage to your forums.

Step 3: (Optional) Increase PHP and/or database timeouts if possible

The upgrade process will make changes to some key tables, including the user table and message-related tables, e.g. for posts or conversation messages. Depending on the size of your forum, this can take quite some time to complete and running into a timeout will break the entire upgrade. Please make temporary adjustments to these timeouts at your own discretion.

Step 4: Update your Installation

Please run a full update through ACP > Configuration > Packages > Packages and click on the button Search for Updates. You must run the latest versions in order to perform an upgrade, earlier versions are not supported.

Step 5: Add the update servers

  1. Navigate to ACP > Configuration > Packages > Package Servers
  2. Click on the button Add Server
  3. Insert http://update.woltlab.com/2019/ into the field Address and leave all other fields empty
  4. Click the Submit button to add the new Server
  5. Insert http://store.woltlab.com/2019/ into the field Address and leave all other fields empty
  6. Click the Submit button to add the new Server

Step 6: Perform the update

Please navigate to ACP > Configuration > Packages > Packages and click on the button Search for Updates. The system should redirect you to a new page offering WoltLab Suite 3 and maybe other products.

Step 7: Rebuild all data

Some changes require you to rebuild data, it is recommended to run all steps listed in ACP > Management > Maintenance > Rebuild Data once the update has completed.

Appendix A: Removal of the Option "Storage Location"

The option "Storage Location" has been removed in WoltLab Suite 5.2, but is still implicitly available for use. If you've set up a custom value for this option, you'll have to manually configure the path before proceeding with the upgrade. Please edit the file config.inc.php located in the installation directory of WoltLab Suite Core, which also holds the credentials for the database access. Please append the following line at the end of the file:

define('ATTACHMENT_STORAGE', '/the/path/that/you/have/been/set/up/before/');