Skip to content

Updates#

This guide explains how to update WoltLab Suite from an older version.

Note

This article is intended for customers who run the software independently on their own server or web hosting.

Note

An upgrade is only supported from the previous version. If you would like to upgrades from WoltLab Suite 3.0 to WoltLab Suite 5.3 you will need to perform the upgrades from 3.0 to 3.1, 3.1 to 5.2, and 5.2 to 5.3. Please carefully check the upgrade notes for each intermediate step.

Upgrading WoltLab Suite 5.3 to 5.4#

  1. Make sure that you have followed the instructions for installing all pending minor updates.

  2. Please enable the maintenance mode via the configuration to protect the process from unintended interruptions.

  3. You should create a backup now, enabling you to restore your installation to a working state in case of any errors.

  4. Access the package management.

  5. An info box will let you know that the upgrade to WoltLab Suite 5.4 is available.

  6. Use the link at the end of the info box to check your webspace for compatibility with WoltLab Suite 5.4.

  7. If your Webspace is compatible with WoltLab Suite 5.4 you can enable the update servers for WoltLab Suite 5.4 by enabling the Enable Upgrading to the New Version switch and submitting the form.

  8. In the admin panel under Configuration → Packages → Packages click on the button Search For Updates and then select all available updates.

  9. After installing major updates, it is required to rebuild the data. To do this, call up Management → Maintenance → Rebuild Data in the admin panel and execute all actions in sequence.

Forced Logout of All Users

After the upgrade to WoltLab Suite 5.4 all users will be logged out once for technical reasons. They will need to log in back again manually. We recommend that you let your users know about this fact to avoid confusion.

Two Step Verification by Hanashi Development

The upgrade to WoltLab Suite 5.4 will import the data of the plugin Two Step Verification by Hanashi Development into the built-in multi-factor authentication. It is required that the plugin is installed during the upgrade for this import to work. After the upgrade completed successfully the plugin will automatically be disabled and may be uninstalled.

It is recommended that all users regenerate their backup codes after the upgrade to ensure best compatibility.

Upgrading WoltLab Suite 5.2 to 5.3#

  1. Make sure that you have followed the instructions for installing all pending minor updates.

  2. Before performing major updates, the maintenance mode should be activated via the configuration.

  3. We recommend creating a backup before installing major updates.

  4. For the update, the following package servers must be added in the admin panel under Configuration → Packages → Package Server → Add Server:

    Field Content
    Address http://update.woltlab.com/5.3/
    Username (Your license number)
    Password (Your serial)
    Field Content
    Address http://store.woltlab.com/5.3/
    Username (Username of your WoltLab account)
    Password (Password of your WoltLab account)
  5. In the admin panel under Configuration → Packages → Packages click on the button Search For Updates and then select all available updates.

  6. After installing major updates, it is recommended to rebuild the data. To do this, call up Management → Maintenance → Rebuild Data in the admin panel and execute all actions in sequence.

Upgrading WoltLab Suite 3.1 to 5.2#

  1. Make sure that you have followed the instructions for installing all pending minor updates.

  2. Before performing major updates, the maintenance mode should be activated via the configuration.

  3. We recommend creating a backup before installing major updates.

  4. For the update, the following package servers must be added in the admin panel under Configuration → Packages → Package Server → Add Server:

    Field Content
    Address http://update.woltlab.com/2019/
    Username (Your license number)
    Password (Your serial)
    Field Content
    Address http://store.woltlab.com/2019/
    Username (Username of your WoltLab account)
    Password (Password of your WoltLab account)
  5. In the admin panel under Configuration → Packages → Packages click on the button Search For Updates and then select all available updates.

  6. After installing major updates, it is recommended to rebuild the data. To do this, call up Management → Maintenance → Rebuild Data in the admin panel and execute all actions in sequence.

Note

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/');

Upgrading WoltLab Suite 3.0 to 3.1#

  1. Make sure that you have followed the instructions for installing all pending minor updates.

  2. Before performing major updates, the maintenance mode should be activated via the configuration.

  3. We recommend creating a backup before installing major updates.

  4. For the update, the following package servers must be added in the admin panel under Configuration → Packages → Package Server → Add Server:

    Field Content
    Address http://update.woltlab.com/tornado/
    Username (Your license number)
    Password (Your serial)
    Field Content
    Address http://store.woltlab.com/tornado/
    Username (Username of your WoltLab account)
    Password (Password of your WoltLab account)
  5. In the admin panel under Configuration → Packages → Packages click on the button Search For Updates and then select all available updates.

  6. After installing major updates, it is recommended to rebuild the data. To do this, call up Management → Maintenance → Rebuild Data in the admin panel and execute all actions in sequence.

Upgrading Burning Board 4.1 to WoltLab Suite 3.0#

  1. Make sure that you have followed the instructions for installing all pending minor updates.

  2. Before performing major updates, the maintenance mode should be activated via the configuration.

  3. We recommend creating a backup before installing major updates.

  4. For the update, the following package servers must be added in the admin panel under System → Packages → Package Server → Add Server:

    Field Content
    Address http://update.woltlab.com/vortex/
    Username (Your license number)
    Password (Your serial)
    Field Content
    Address http://store.woltlab.com/vortex/
    Username (Username of your WoltLab account)
    Password (Password of your WoltLab account)
  5. In the admin panel under System → Packages → Packages click on the button Search For Updates and then select all available updates.

  6. After installing major updates, it is recommended to rebuild the data. To do this, call up Management → Maintenance → Rebuild Data in the admin panel and execute all actions in sequence.

Upgrading Burning Board 4.0 to Burning Board 4.1#

  1. Make sure that you have followed the instructions for installing all pending minor updates.

  2. Before performing major updates, the maintenance mode should be activated via the configuration.

  3. We recommend creating a backup before installing major updates.

  4. For the update, the following package servers must be added in the admin panel under System → Packages → Package Server → Add Server:

    Field Content
    Address http://update.woltlab.com/typhoon/
    Username (Your license number)
    Password (Your serial)
    Field Content
    Address http://store.woltlab.com/typhoon/
    Username (Username of your WoltLab account)
    Password (Password of your WoltLab account)
  5. In the admin panel under System → Packages → Packages click on the button Search For Updates and then select all available updates.

  6. After installing major updates, it is recommended to rebuild the data. To do this, call up Management → Maintenance → Rebuild Data in the admin panel and execute all actions in sequence.