Chapter 7. Upgrading ProsePoint

Upgrading ProsePoint follows a general sequence of steps which is explained in the next section. In most cases, the general procedure is all you need to follow. However, if there are special considerations for upgrading to specific versions of ProsePoint, they will be described in a separate section.

7.1. General upgrade procedure

Note

The screenshots in this procedure were taken during an upgrade from version 0.03 to 0.04 of ProsePoint. If you are upgrading a different version, you may see slightly different pages.

7.1.1. Backup your database

Upgrading ProsePoint will change your database and in case of emergency, or something goes wrong, you may need to roll back.

Warning

It is very important that you backup before attempting an upgrade. Never assume that an upgrade will always work first time.

For instructions on how to backup your database, please ask your hosting provider.

7.1.2. Backup your filesystem

It is recommended that you backup your filesystem (from the webroot downwards) as well, or at least, make a copy of it somewhere. This is not as critical as backing up your database, but is good practice nonetheless.

For instructions on how to backup your filesystem, please ask your hosting provider.

7.1.3. Place your site offline

Log into your site as the first user and place your site offline.

  • Once you are logged into your site, visit Administer => Site configuration => Site maintenance, select Off-line, and click Save configuration.

Once the site is offline, you should see a message Operating in off-line mode. when you visit the other pages of your site.

Tip

If you log out while the site is offline, visit the page ?q=user of your site to log back in. Note that only users with administrative privileges are allowed to log in while the site is offline.

7.1.4. Upgrading the source code

Next, you want to replace the old source code of ProsePoint with the new source code, but in such a way that the file .htaccess and the subdirectory sites is preserved.

It is recommended that you completely replace the entire ProsePoint directory. If you only copy or upload changed files, obsolete files may not be deleted and this may confuse ProsePoint.

The exact process of updating the source code will depend on your hosting provider and account privileges. However, a sample command line scenario is presented below.

Note

For the sample procedure below, it is assumed you are executing from a privileged account ie. root. If not, you may need to prepend sudo for some commands.

Whenever you see prosepoint-0.04 in the sample procedure, please substitute with the version of ProsePoint you are upgrading to.

  • Move the directory tree into a separate location backup, where backup is a directory which already exists ie. /tmp, home/user etc.

    # mv ProsePointRoot backup

  • Extract the new ProsePoint source code, and make it the new ProsePointRoot.

    # tar fxz prosepoint-0.04.tar.gz

    # mv prosepoint-0.04 ProsePointRoot

  • Copy .htaccess and sites from the backup into the new ProsePointRoot.

    # cp backup/ProsePointRoot/.htaccess ProsePointRoot

    # rm -rf ProsePointRoot/sites

    # cp -rp backup/ProsePointRoot/sites ProsePointRoot/sites

    Note

    You may need to check and ensure that your ProsePoint filesystem (which defaults to sites/default) is still readable and writable by the web server.

Once the source code has been updated, the layout of your site may be broken. That is normal, and do not be alarmed. The next step will address this.

7.1.5. Run update.php, part 1

Visit the update page of your site. The update page is the file update.php from your webroot

For example, if your site is www.example.com, visit www.example.com/update.php.

You should see a page similar to the following:

Screenshot: Update.php, part 1

  • Click Continue to proceed.

7.1.6. Run update.php, part 2

You should now see a page similar to the following:

Screenshot: Update.php, part 2

  • Click Update to proceed.

If you're curious, you can expand the fieldset and look at what updates will be applied.

Screenshot: Update.php, part 2 expanded

However, unless you know what you're doing, please don't change anything here. Just click Update to proceed.

7.1.7. Run update.php, part 3

You should next see a page with a progress bar showing the state of the updates.

Once this has finished, you should see a page similar to the following:

Screenshot: Update.php, part 3

This page describes what was attempted, and the results. If you do not see any error messages here, then your database was successfully updated.

7.1.8. Verify your site and place it back online

Visit various pages of your site to verify that the upgrade was successful. Once you are satisfied, place your site back online.

  • Visit Administer => Site configuration => Site maintenance, select Online, and click Save configuration.

7.1.9. Cleaning up

During this procedure, you would have made backups of your database and your filesystem. You may like to keep these backups for a period of time before deleting them.