Upgrades: Difference between revisions

From XMBdocs
← Older edit
→Upgrading from XMB 1.9.12: Mention customizations
 
(9 intermediate revisions by the same user not shown)
Line 13: Line 13:


===Known Issues===
===Known Issues===
These are known issues with the upgrader. However, they will only affect a small percentage of XMB Forum users.


Upgrading can be quite resource intensive, especially with large databases.
Upgrading can be quite resource intensive, especially with large databases.
The upgrade script may appear to time out or be inactive. Do NOT stop it or close your browser window.
The upgrade script can consume up to two times the amount of disk space you are currently using.
The upgrade script can consume up to two times the amount of disk space you are currently using.
Make sure your disk space quota is set accordingly.
If the upgrader stops while modifying any table, please contact the support staff at XMBForum2.com.
If the upgrader stops while modifying any table, please contact the support staff at XMBForum.com.
Restore your database and original files from backups if necessary.
Restore your database and original files from backups if necessary.


==How To Upgrade From Old Versions==
==How To Upgrade From Old Versions==
===Upgrading from XMB 1.9.12===
If you are already running version 1.9.12, you will be able to upgrade to 1.10 as soon as your server meets the PHP 8.2 requirement.
If you are still running PHP 7, you cannot upgrade to XMB 1.10 and later versions.  There are two practical upgrade paths:
* Upgrade PHP and XMB at the same time.  By installing PHP 8.2 or later, you can immediately upgrade to XMB 1.10.  Note if you are not on the latest patched release of 1.9.12, your old XMB site might not work until upgraded.
* Upgrade to the latest patched release of 1.9.12.  Starting with 1.9.12.06, PHP 8.2 is fully supported.  This will make the transition easier if you don't have control of the PHP version.
Customizations from the v1.9 series require careful consideration.
* Custom image files, themes, and icons need to be copied over manually if you are replacing all the files.
* Custom translation changes need to be exported before the upgrade because they are file-based in v1.10.
* Custom templates need to be exported before the upgrade, and then converted to the v1.10 format.
* Custom code will require many changes.


===Upgrading from XMB 1.9.11===
===Upgrading from XMB 1.9.11===
If you are already running the latest patch level of 1.9.11, you will be able to upgrade to 1.9.12 as soon as your server meets the PHP 7 requirement.


If you are still running PHP 5, you cannot upgrade to XMB 1.9.12 and later versions.  There are two practical upgrade paths:
If you are still running PHP 5, you cannot upgrade to XMB 1.9.12 and later versions.  There are two practical upgrade paths:
Line 31: Line 46:
* Upgrade PHP and XMB at the same time.  By installing PHP 7.0 or later, you can immediately upgrade to XMB 1.9.12.  Note if you are not on the latest patched release of 1.9.11, your old XMB site might not work until upgraded.
* Upgrade PHP and XMB at the same time.  By installing PHP 7.0 or later, you can immediately upgrade to XMB 1.9.12.  Note if you are not on the latest patched release of 1.9.11, your old XMB site might not work until upgraded.


* Upgrade to the latest patched release of 1.9.11.  Starting with 1.9.11.15, PHP 7 is fully supported.  This might make the transition easier.
* Upgrade to the latest patched release of 1.9.11.  Starting with 1.9.11.15, PHP 7 is fully supported.  This will make the transition easier if you don't have control of the PHP version.
 
If your host already upgraded to PHP 7 and your XMB site stopped working because it is 1.9.11.14 or less:
 
* Upgrade directly to XMB 1.9.12.  Your site will resume normal operation as soon as you run the XMB upgrade script.


===Upgrading from XMB 1.8+===
===Upgrading from XMB 1.8+===
Line 46: Line 65:


You must upgrade to XMB 1.8.
You must upgrade to XMB 1.8.
===Upgrading from PHP 5===


==Upgrade Instructions==
==Upgrade Instructions==
Line 53: Line 70:
# Disable your forums using the Board Status setting.
# Disable your forums using the Board Status setting.
# BACKUP YOUR DATABASE - This script cannot be undone!
# BACKUP YOUR DATABASE - This script cannot be undone!
# Copy your config.php settings into the new file.
# Backup your config.php file.
# Upload the XMB 1.9.11 files. Do not upload the install folder (delete it if necessary).
# Confirm your forum database account is granted all privileges if you had restricted them since install.
# Upload the upgrade directory to your board's root directory.
# Upload the XMB files.
# <nowiki>Run this script by hitting the upgrade URL, for example: http://www.example.com/forum/upgrade/</nowiki>
# <nowiki>Run the upgrade script by visiting the installer, for example: https://www.example.com/forum/install/</nowiki>
# When the upgrade finishes successfully, delete the upgrade directory.
# When finished, enable your forums using the Board Status setting.
# Enable your forums using the Board Status setting.

Latest revision as of 07:06, 19 September 2025

Before Getting Started

Backup Your Forum

Please backup both your forums database and files before continuing. This may seem like common sense but is often forgotten. If the upgrade process fails and you do not have a backup, XMB will be unable to help you. All data could be lost: posts, users, etc. You have been warned!

Modifications Notice

The upgrader is designed to work when modifications are installed. Starting with XMB-1.9.11.11.zip, all custom data in your database should be preserved during the upgrade procedure. Templates are not preserved because they are overwritten as part of the upgrade. If you attempt to upgrade to an older version such as 1.9.8 to 1.9.10, all modification data, templates and code, will be destroyed during the upgrade process. Please proceed with extreme caution if you wish to keep your modification data intact.

Known Issues

Upgrading can be quite resource intensive, especially with large databases. The upgrade script can consume up to two times the amount of disk space you are currently using. If the upgrader stops while modifying any table, please contact the support staff at XMBForum2.com. Restore your database and original files from backups if necessary.

How To Upgrade From Old Versions

Upgrading from XMB 1.9.12

If you are already running version 1.9.12, you will be able to upgrade to 1.10 as soon as your server meets the PHP 8.2 requirement.

If you are still running PHP 7, you cannot upgrade to XMB 1.10 and later versions. There are two practical upgrade paths:

  • Upgrade PHP and XMB at the same time. By installing PHP 8.2 or later, you can immediately upgrade to XMB 1.10. Note if you are not on the latest patched release of 1.9.12, your old XMB site might not work until upgraded.
  • Upgrade to the latest patched release of 1.9.12. Starting with 1.9.12.06, PHP 8.2 is fully supported. This will make the transition easier if you don't have control of the PHP version.

Customizations from the v1.9 series require careful consideration.

  • Custom image files, themes, and icons need to be copied over manually if you are replacing all the files.
  • Custom translation changes need to be exported before the upgrade because they are file-based in v1.10.
  • Custom templates need to be exported before the upgrade, and then converted to the v1.10 format.
  • Custom code will require many changes.

Upgrading from XMB 1.9.11

If you are already running the latest patch level of 1.9.11, you will be able to upgrade to 1.9.12 as soon as your server meets the PHP 7 requirement.

If you are still running PHP 5, you cannot upgrade to XMB 1.9.12 and later versions. There are two practical upgrade paths:

  • Upgrade PHP and XMB at the same time. By installing PHP 7.0 or later, you can immediately upgrade to XMB 1.9.12. Note if you are not on the latest patched release of 1.9.11, your old XMB site might not work until upgraded.
  • Upgrade to the latest patched release of 1.9.11. Starting with 1.9.11.15, PHP 7 is fully supported. This will make the transition easier if you don't have control of the PHP version.

If your host already upgraded to PHP 7 and your XMB site stopped working because it is 1.9.11.14 or less:

  • Upgrade directly to XMB 1.9.12. Your site will resume normal operation as soon as you run the XMB upgrade script.

Upgrading from XMB 1.8+

XMB-1.9.11.11.zip and newer versions will enable you to upgrade smoothly. The XMB upgrade system has been completely re-written to provide improved stability and compatibility.

If you are still running PHP 5, you cannot upgrade to XMB 1.9.12 and later versions. There are two practical upgrade paths:

  • Upgrade PHP and XMB at the same time. By installing PHP 7.0 or later, you can immediately upgrade to XMB 1.9.12.
  • Upgrade to 1.9.11. By installing the latest patched release of 1.9.11, your XMB site will be compatible with both PHP 5 and PHP 7. This might make the transition easier.

Upgrading from XMB 1.6 and older versions

You must upgrade to XMB 1.8.

Upgrade Instructions

  1. Disable your forums using the Board Status setting.
  2. BACKUP YOUR DATABASE - This script cannot be undone!
  3. Backup your config.php file.
  4. Confirm your forum database account is granted all privileges if you had restricted them since install.
  5. Upload the XMB files.
  6. Run the upgrade script by visiting the installer, for example: https://www.example.com/forum/install/
  7. When finished, enable your forums using the Board Status setting.
Retrieved from "https://docs.xmbforum2.com/index.php?title=Upgrades&oldid=441"