Revision as of 20:15, 9 July 2012 by Helen Foster (talk | contribs) (adding info from Upgrading to Moodle 2.3, rewriting (1st draft))

Jump to: navigation, search

Moodle is designed to upgrade itself from one version to the next. The procedure is

  1. Back up everything.
  2. Replace the old version of the code with the new one.
  3. Log in to your Moodle site and go to Settings > Site administration > Notifications which will then trigger Moodle to self-update.

These steps are explained in more detail below.

Before you upgrade your site for real

We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.

Check the requirements

Check that your server meets all requirements for 2.3 in Settings > Site administration > Server > Environment.

Note: You can only upgrade to Moodle 2.3 from Moodle 2.2 or later. If upgrading from earlier versions, you must upgrade to 2.2 as a first step.

Checking database schema - old sites

If your Moodle site has been upgraded through many prior versions it is possible that there will be some problems with the database schema (compared to a fresh 2.3 installation). This may cause the upgrade to fail. If your site started life prior to Moodle 2.0 it is a very good idea to check and correct the database schema before upgrading. See Verify Database Schema. You should also run the database integrity checks in the XMLDB editor.

Put your Site into Maintenance Mode

Before you begin upgrading your site, you should put it into Maintenance Mode to stop any non-admin users from logging in.

Backup important data

There are three areas that should be backed up before any upgrade:

  1. Moodle software (For example, everything in server/htdocs/moodle)
  2. Moodle uploaded files (For example, server/moodledata)
  3. Moodle database (For example, the SQL or Postgres database)

See Site backup for more specific information.

Install the new Moodle software

Upgrading can be a simple process or a more complicated process. Sites that have not used contributed code and are migrating from say Moodle 2.x.1 to 2.x.3 should not have a problem. However, we still recommend that with any production server that you have made a successful backup of the MySQL database, the moodledata directory and the moodle program folders and files.

  • Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. Review the backup section above.

Standard install package

  • Having moved your old Moodle software program files to another location, unzip or unpack the upgrade file so that all new the Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
  • Copy your old config.php file back to the new Moodle directory. If you've defined individual blocks for new courses you have to delete 'admin' block definition and replace by 'settings' for the new block.
  • If you had added any custom plugins or themes into your Moodle you can add them to the new code. It is important to check that you get the correct version for your new version of Moodle. You should check in the optional plugins database. Be particularly careful that you do not overwrite any code in the new version of Moodle.
  • Use the notification link in the site administration to start the upgrade process. You will see a series of lines or screens indicating progress.
  • After a successful upgrade, turn off the maintenance mode, so your users can get into the site.

Using a downloaded archive

In some installs, the site administrator may overwrite the Moodle code with a backup copy. Or create a new clean install copy of Moodle, then restore an archive (via a compressed file or parts of a saved set of Moodle code files and folders).

  • Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new or "cleaned" installations. The best way is to rename the current Moodle code directory (for example rename "moodle" to "moodleold"), then unpack the new Moodle archive into the old location (for example, a new directory called "moodle").


mv moodle moodle.backup
tar xvzf moodle-1.1.tgz

Next, copy across your config.php, any other plugins such as custom themes, and your .htaccess file if you created one (check that optional/custom plugins are the correct version for your new Moodle first):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writable by your server.

If you use cron, take care that cron.php is executeable and uses the correct php command:

chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')

if necessary.

Using Git

You can use Git for updating or upgrading your Moodle. New sites are recommended to use this rather than CVS since all Moodle development has moved to Git. See Git for Administrators for details.

Command line upgrade

On Linux servers, Moodle 2.3 supports running the upgrade from the command line, rather than through a web browser. This is likely to be more reliable, particularly for large sites.

Finishing the upgrade

The last step is to trigger the upgrade processes within Moodle.

To do this just go to Settings > Site administration > Notifications.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

After upgrading

The config.php file from your 2.2 installation should work fine but if you take a look at config-dist.php that came with Moodle 2.3 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 2.3 config-dist.php.

Possible issues that may affect you in Moodle 2.3

Two assignment modules

A new assignment module has been added in Moodle 2.3. The old assignment module is still available (renamed 'Assignments 2.2') and sites which have upgraded from previous versions will have both versions available.

It is recommended that admins upgrade all existing assignments to use the new assignment module as soon as possible, as described in Assignment upgrade tool, then disable the old assignment module, to avoid the confusion of having two assignment modules.

Google registration required for Google Docs and Picasa plugins

Due to a change in Google's service, Moodle 2.3 has switched to a more secure and more user-friendly system for communicating with Google called 'OAuth 2.0'. As a result, any Google Docs and Picasa plugins (the Google Docs and Picasa repositories and the Google Docs and Picasa portfolios) used previously on the site will be disabled when the site is upgraded.

To re-enable these plugins, an administrator must register their site with Google, as described in Google OAuth 2.0 setup, and obtain a client ID and secret. The client ID and secret can then be used to configure all Google Docs and Picasa plugins.

RTL theme fixes

Moodle 2.3 includes many right-to-left (RTL) theme fixes (MDL-30337) and so sites using RTL languages, such as Arabic and Hebrew, are recommended to perform additional testing, particularly with any custom themes to ensure everything is working fine.

See also