Upgrading: Difference between revisions

Latest revision as of 09:40, 22 September 2016

This page explains in detail how to upgrade Moodle. For a summary of the process, see Upgrade overview.

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.

Check for plugin updates

Check in the Moodle Plugins directory whether there is a 2.3 version available for any contributed/custom plugins (including themes) that you have previously installed on your site. If so, download the plugin code and copy it to the appropriate location in your Moodle code (see Installing plugins).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

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.

Backup important data

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

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

See Site backup for more specific information.

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.

Install the new Moodle software

Standard install package

Move your old Moodle software program files to another location. Do NOT copy new files over the old files.
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.
As mentioned above, if you had installed any custom plugins on your site you should add them to the new code. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle.

Linux

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

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one (check that 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 writeable 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.

MySQL dmlwriteexception error when using calculated questions in a quiz

If you're using MySQL or SQL*Server and you have a problem with duplicated keys with the question_attempt_step_data table when using calculated questions in a quiz (from entering a formula which uses variables with the same characters in different cases), it is recommended that you upgrade to Moodle 3.0.x or higher ASAP. Alternatively, the problematic unique index can be dropped or the collation of the columns changed to be case-sensitive, however this is not considered a complete fix. See MDL-29332 for more information.

@@ Line 1: / Line 1: @@
-Moodle is designed to upgrade cleanly from one version to the next.  Please refer to [[Upgrading to Moodle 1.6]], [[Upgrading to Moodle 1.7]], [[Upgrading to Moodle 1.8]] or [[Upgrading to Moodle 1.9]]  for particular considerations related to the upgraded version.
+{{Installing Moodle}}
+''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
-Changes that have been made to the original code, such as installing a contributed module (non-standard module) or a site edit of a php file, may not upgrade. This includes modifications to standard themes, that will be overwritten during an upgrade.
-__TOC__
-When upgrading a Moodle installation you should follow these steps:
 ==Check the requirements==
-Spend some time re-reading the [[Installing Moodle | installation documentation]] and documentation for the new version. Check the system requirements for the version you are upgrading to in ''Administration > Server > [[Environment]]''.
-== Backup important data ==
+Check that your server meets all requirements for 2.3 in ''Settings > Site administration > Server > [[Environment]]''.
-Although it is not strictly necessary, it is always a good idea to make a backup of any production system before a major upgrade, just in case you need to revert back to the older version for some reason. In fact, it's a good idea to automate your server to backup your Moodle installation daily, so that you can skip this step.
+Note: You can only upgrade to Moodle 2.3 from Moodle 2.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 upgrade to 2.2] as a first step.
-There are three areas that need backing up:
+==Checking database schema - old sites==
-=== 1. The Moodle software directory itself ===
+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.
-Make a separate copy of these files before the upgrade, so that you can retrieve your config.php and any modules you have added like themes, languages etc
+==Check for plugin updates==
-=== 2. Your data directory ===
+Check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a 2.3 version available for any contributed/custom plugins (including themes) that you have previously installed on your site. If so, download the plugin code and copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).
-This is where uploaded content resides (such as course resources and student assignments) so it is very important to have a backup of these files anyway. Sometimes upgrades may move or rename directories within your data directory.
+The upgrade of the plugin will then happen as part of the Moodle upgrade process.
-=== 3. Your database ===
+If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.
-Most Moodle upgrades will alter the database tables, adding or changing fields. Each database has different ways to backup. One way of backing up a MySQL database is to 'dump' it to a single SQL file. The following example shows Unix commands to dump the database called "moodle":
+==Before you upgrade your site for real==
- mysqldump -u username -p -C -Q -e -a moodle > moodle-backup-2007-04-01.sql
+'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''
-(The "-a" switch is deprecated and should be replaced by "--create-options")
-Substitute your database user account for username. The -p flag will prompt you for the password for the username specified by -u.
+== Backup important data ==
-If your database host is different from the host you want to execute the backup command (usually the web server), you have to specify it with the -h option to mysqldump:
+There are three areas that should be backed up before any upgrade:
+#Moodle software (For example, everything in server/htdocs/moodle)
+#Moodle uploaded files (For example, server/moodledata)
+#Moodle database (For example, the SQL or Postgres database)
- mysqldump -u username -p -h databasehost -C -Q -e -a moodle > moodle-backup-2007-04-01.sql
+See [[Site backup]] for more specific information.
-You can also use the "Export" feature in Moodle's optional "MySQL Admin" web interface to do the same thing on all platforms. This interface can be downloaded from http://download.moodle.org/modules/integrations.php. It is an integration of PHPMyAdmin for the Moodle administration interface.
+==Put your Site into maintenance mode==
+Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in.
 == Install the new Moodle software ==
-=== Using a downloaded archive ===
+=== Standard install package ===
-@Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. The best way is to rename the current Moodle directory to something else, then unpack the new Moodle archive into the old location.
+# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
+# 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 [[Configuration file|config.php file]] back to the new Moodle directory.
+# As mentioned above, if you had installed any custom plugins on your site you should add them to the new code. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle.
- Linux
+====Linux====
   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:
+Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that 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
-=== Using CVS ===
+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 writeable by your server.
-You can use CVS for updating or upgrading your Moodle.
+If you use cron, take care that cron.php is executeable and uses the correct php command:
-First you need to do a CVS checkout in your (empty) Moodle root directory.
+ 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')
-You can use any of our [[CVS_for_Administrators#CVS_Servers|CVS Mirror servers]]. Just replace '''SERVER.cvs.moodle.org''' in the instructions below with the name of the mirror server you chose!.
+if necessary.
-'''For Linux servers'''
+=== Using Git ===
-To do a CVS checkout of Moodle, you first have to logon to the Moodle CVS server.
+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.
-  <nowiki>cvs -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle login</nowiki>
+===Command line upgrade===
-  No password for anonymous, so just hit the Enter button.
-Go to the directory where you want the Moodle root to come and type
+On Linux servers, Moodle 2.3 supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.
-  <nowiki>cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co -r MOODLE_18_STABLE moodle</nowiki>
+== Finishing the upgrade ==
-  (where MOODLE_18_STABLE is the desired version)
-To update, just go into the Moodle root directory and update to the new files:
+The last step is to trigger the upgrade processes within Moodle.
-  cvs update -dP
+To do this just go to ''Settings > Site administration > Notifications''.
-To update to a new version type in the following and change 18 to whatever newest version upgrade number is
-  cvs -Q update -dP -r MOODLE_18_STABLE
-Make sure you use the "d" parameter to create new directories if necessary, and the "P" parameter to prune empty directories.
+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.
-'''For Windows servers'''
+Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!
-You can use Tortoise CVS to do the initial checkout and the updates.
+==After upgrading==
-If you have been editing Moodle files, watch the messages very closely for possible conflicts. All your customised themes and non-standard plugins will be untouched.
+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.
-Don't forget to visit the admin page after the CVS update process has completed.
+==Possible issues that may affect you in Moodle 2.3==
-== Finishing the upgrade ==
+=== 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 [[Upgrade tool|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===
-The last step is to trigger the upgrade processes within Moodle.
+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 do this just visit the admin page of your installation e.g. ''<nowiki>http://example.com/moodle/admin</nowiki>''
+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.
-It doesn't matter if you are logged in as admin or not. If you are upgrading from some older versions you would not be able to login before the upgrade anyway.
+===RTL theme fixes===
-Moodle will automatically detect the new version and perform all the database or filesystem 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.
+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.
-Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!
+===MySQL dmlwriteexception error when using calculated questions in a quiz===
-Please note that if you are running a large scale of moodle site (e.g. have more tha 10,000+ courses and 40,000+ users), make sure that you do your own performance profiling testing before you upgrade to Moodle 1.8.x, as there are still quite a few outstanding (unresolved) performance issues in 1.8.x for large user base installations.
+If you're using MySQL or SQL*Server and you have a problem with duplicated keys with the question_attempt_step_data table when using calculated questions in a quiz (from entering a formula which uses variables with the same characters in different cases), it is recommended that you upgrade to Moodle 3.0.x or higher ASAP. Alternatively, the problematic unique index can be dropped or the collation of the columns changed to be case-sensitive, however this is not considered a complete fix. See MDL-29332 for more information.
 ==See also==
-*Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems] forum
+* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
-*[[Upgrading to Moodle 1.6]]
+* [[dev:Moodle 2.3 release notes|Moodle 2.3 release notes]]
-*[[Installing Moodle]]
+* [[dev:Upgrade API|Upgrade API]]
-*[[Installation FAQ]]
-*[http://otaru-jc.ac.jp/hagley/howtoupgrademoodlewithcpanel.swf How to upgrade Moodle with cpanel tutorial]
-*[http://youtube.com/watch?v=ufAmf_jm_p8 How to backup a whole Moodle site video]
-*Using Moodle forum discussions: [http://moodle.org/mod/forum/discuss.php?d=26731&parent=125858 Using cvs], [http://moodle.org/mod/forum/discuss.php?d=56915 Upgrading from 1.5.2 to 1.7], [http://moodle.org/mod/forum/discuss.php?d=56991 Upgrade nightmares.... any help appreciated], [http://moodle.org/mod/forum/discuss.php?d=62463 After upgrading i get "Your site may not be secure." msg]
-[[Category:Installation]]
 [[es:Actualización de moodle]]
 [[fr:Mise à jour]]
-[[ja:アップグレード]]
+[[ja:Moodleをアップグレードする]]
-[[nl:Upgraden]]
+[[de:Aktualisierung von Moodle]]
-[[zh:升级]]
-[[pl:Aktualizacja]]

Documentation