Upgrading MPOS

Preperation

This guide will help you to upgrade your existing PHP-MPOS instance to the latest version. Keep in mind that PHP-MPOS is heavily relying on git so make sure you cloned properly.

Checking for Changes

Check the local version to see if it needs upgrading. This is done from the folder which contains CHANGELOG.md:

git log -1

The output will look like this:

commit 971006b7a2ddf8315ed69c5a4a530da3d77d9b23
Author: *commit author and email*
Date:   *commit date*

   *change log*

This is the local version. The string in the commit line 971000...9b23 can be used to compare a local copy to the master version on GitHub. Copy the commit string and access GitHub at the following address to see what has been changed:

https://github.com/TheSerapher/php-mpos/compare/"your commit string here, minus quotes"...next

This will show all the changes between the local copy and what's available in the repository.

Maintenance Mode

Enable the maintenance mode in PHP-MPOS from the web interface (Admin Panel -> Settings). This will notify site users of an update in progress. It is also advised to disable any cronjobs set in the crontab during an update to avoid errors, though during the upgrade crons will be disabled anyway if any manual steps are required.

Update

Fetching

First the updates must be fetched. A direct clone on the next branch can perform this by calling git pull in the folder with CHANGELOG.md in it. Note the output while performing this command. It will output the list of file updates and added files seen earlier. If there are any SQL files, they will need to be imported manually later.

Core Changes

SQL Upgrades

If you checked your output of git pull you should keep an eye on filed add to the sql folder. You will need to import any newly added SQL upgrades.

Configuration Upgrades

As above, also note changes to the global.inc.dist.php: If this file has been updated it probably means that configuration options have changed. You can either run a diff global.inc.php global.inc.dist.php to see what changed or go through the files yourself. Most of the time it's just a few lines that have either changed or added. Fix those in your local global.inc.php and increment the version after you are sure all options have been added.

Disable Maintenance

Now with your core code updated via git pull, SQL files imported and configuration files updated, you can disable maintenance mode! Re-enable your crons (if you disabled them, as you should!) and check for any errors.

Summary

This is a temporary guide. Once we complete our release tags this will be updated to properly work with those.