Note: You are currently viewing documentation for Moodle 2.3. Up-to-date documentation for the latest stable version is available here: Upgrading.

Upgrading: Difference between revisions

From MoodleDocs
Main page ► Installation ► Upgrading
Installation
(→‎Possible issues that may affect you in Moodle 2.3: MySQL dmlwriteexception error when using calculated questions in a quiz (MDL-29332))
 
(48 intermediate revisions by 15 users not shown)
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.8]], [[Upgrading to Moodle 1.9]] or [[Upgrading to Moodle 2.0]] for particular considerations related to the upgraded version. 
{{Installing Moodle}}
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 might be overwritten during an upgrade.
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
 
* For those using cpanel, you can use [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf this tutorial]. It is a bit rough around the edges and is a little dated, but you should get the idea.
 
* For those who have installed the package version of Moodle using an Ubuntu/Kubuntu/Debian package manager, upgrade instructions can be found [[Ubuntu_Debian_Upgrades|here]].
 
 
__TOC__
 
When upgrading a Moodle installation you should follow these steps:


==Check the requirements==
==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 target version you want to upgrade-to in ''Administration > Server > [[Environment]]''.
==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.


== Backup important data ==
Check that your server meets all requirements for 2.3 in ''Settings > Site administration > Server > [[Environment]]''.
There are three areas that need backing up:
#Moodle software directory/folder (For example, everything in server/htdocs/moodle)
#Moodle data (For example, server/moodledata)
#Moodle SQL database
 
Experienced site administrators know that it is a best practice (a very good idea) to make a backup of any production system before a major upgrade. In fact, it is a good idea to automate your server to backup your Moodle installation daily. Most upgrades on sites that have used the standard Moodle packages (no contributed code and no little tweaks to the php files), will not have any major issue.


:''TIP:'' One more time, "do not risk what you can not afford to lose": do regular backups, make sure it backed up and know how to restore it!
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.


==Checking database schema - old sites==


=== Moodle software directory ===
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, and languages.


The best way is to rename the current Moodle directory to something else, then unpack the new Moodle archive into the old location.
==Check for plugin updates==


=== Moodle 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]]).
The default name for this folder is moodledata. This is where uploaded content resides (such as course resources and student assignments). It is very important to have a backup of these files on a regular basis as a best practice. Sometimes upgrades may move or rename directories within your data directory.  


In Linux you can use the cp (copy) command to make a temporary copy of the moodledata. example:
The upgrade of the plugin will then happen as part of the Moodle upgrade process.
====Linux====
mkdir /var/moodledata_backup
cp -rv /var/moodledata/* /var/moodledata_backup


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.


=== SQL database ===
==Before you upgrade your site for real==
Most Moodle upgrades will alter the SQL database tables, adding or changing fields. Each SQL server program (for example,MySQL, Postgresql, Oracle) has different ways to backup. In a MySQL server, one way of backing up is to 'dump' it to a single SQL file. The following example shows Unix commands to dump the database called "moodle":


mysqldump -u username -p -C -Q -e --create-options 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.'''


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:


mysqldump -u username -p -h databasehost -C -Q -e --create-options moodle > moodle-backup-2007-04-01.sql
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)


You can also use the "Export" feature in Moodle's optional "MySQL Admin" web interface to do the same thing on all platforms. In Moodle v1.9 and greater, this is located in '''Site Administration''' -> '''Server''' -> '''Database'''. This interface can also be downloaded from http://moodle.org/mod/data/view.php?d=13&rid=448. It is an integration of PHPMyAdmin for the Moodle administration interface.
See [[Site backup]] for more specific information.


==== SQL dump caveats ====
==Put your Site into maintenance mode==
There are a '''MANY''' options possible for mysqldump.
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in.
*Please talk with your Systems Administrator (if you have one) or similar to see if there are site-specific flags you should use for your SQL dump.
** For example, if your local installation is running MySQL 5.2 and you are moving to a system running MySQL 5.0 or 4.1, you really ought to use the "--compat=mysql40" flag. (This is not too uncommon of a situation given the nature of ISP hosting as compared to local user Moodle setups)
* This seems obvious, but should be said outright: These instructions only work for dumping from MySQL! Postgresql, Oracle, and other database servers have different tools to dump databases.
* Given the example mysql import lines, above, you really should use the --no-create-db flag. If your database locally is named something differently from the migration site, not including this flag could cause problems.


== Install the new Moodle software ==
== 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 1.x.1 to 1.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 ===
=== Standard install package ===
Having read the cautions about backups, download a copy of the standard install package. Here is a set of simple instructions for an average site.
*It is probably a good idea to use the site administration block>Server>Maintenance mode to prevent user activity as the site upgrades.
*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.
*Use the notification link in the site administration to start the upgrade process. You will see a series of lines indicating progress. 
*Copy your old config.php file back to the new Moodle directory, along with any custom themes, blocks or files you have in your old version.
*After a successful upgrade, turn off the maintenance mode for your users.


=== Using a downloaded archive ===
# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
*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.
# 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====
Line 81: Line 49:
  tar xvzf moodle-1.1.tgz
  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 moodle.backup/config.php moodle
Line 87: Line 55:
  cp -pr moodle.backup/mod/mymod moodle/mod/mymod
  cp -pr moodle.backup/mod/mymod moodle/mod/mymod


Don't forget to  
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.


  sudo chown www-data moodle/config.php
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.
if necessary.


where www-data is whatever user the Apache user is on your system. This is often 'apache' or 'www'.
=== Using Git ===
You can find out by doing 'ls -l' in your /var/www/moodle folder (or wherever your moodle site is)
and then looking at the owner and group.


so you may see something like
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.


ls -l
===Command line upgrade===
...lots of lines...
-rw-r--r--  1 apache system    784 Jun 28  2007 config.php
...lots more lines...


so the owner is apache and the group is system.  
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.


To replicate this on your new system you can do  'chown apache:system config.php'
== Finishing the upgrade ==


or to do a whole group do
The last step is to trigger the upgrade processes within Moodle.


chown apache:system ./*
To do this just go to ''Settings > Site administration > Notifications''.


and recursively
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.


chown -R apache:system ./*
Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!
 
=== Using CVS ===
 
You can use CVS for updating or upgrading your Moodle.
First you need to do a CVS checkout in your (empty) Moodle root directory.


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!.
==After upgrading==


====For Linux servers====
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.


To do a CVS checkout of Moodle, you first have to logon to the Moodle CVS server.
==Possible issues that may affect you in Moodle 2.3==


  <nowiki>cvs -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle login</nowiki>
=== Two assignment modules ===
  No password for anonymous, so just hit the Enter button.


Go to the directory where you want the Moodle root to come and type
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.


  <nowiki>cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co -r MOODLE_18_STABLE moodle</nowiki>
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.
  (where MOODLE_18_STABLE is the desired version)


To update, just go into the Moodle root directory and update to the new files:
===Google registration required for Google Docs and Picasa plugins===


  cvs update -dP
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 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.
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.


====For Windows servers====
===RTL theme fixes===


You can use Tortoise CVS to do the initial checkout and the updates.
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.


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.
===MySQL dmlwriteexception error when using calculated questions in a quiz===


Do not forget to trigger the install process in the site administration block (see below).
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.
 
== Finishing the upgrade ==
 
The last step is to trigger the upgrade processes within Moodle.
 
To do this just visit the site administration block admin page (or ''<nowiki>http://example.com/moodle/admin</nowiki>'') and the "Notifications" link.
 
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!
 
 
:''TIP:'' Use the site administration block>Server>Maintenance mode to prevent users from changing data during the upgrade.
:''TIP:'' If you are running a large scale Moodle site (e.g. have more tha 10,000+ courses and 40,000+ users), make sure that you do your own performance profiling testing.  Post a thread or check the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum] and check [[Tracker]] for potential issues.
 
== Verify the upgrade (optional) ==
 
If you wish to confirm that the database definitions in the upgraded database match the definitions of a new, clean install (which they should) you might like to look at [[Verify Database Schema]].
 
==Upgrading more than one version==
 
In general, it is recommended to upgrade via each version of Moodle, for example 1.7 -> 1.9. An exception to this is when upgrading from 1.5 or 1.6, when it is recommended that 1.7 and 1.8 are skipped, in other words upgrade 1.5 -> 1.6 -> 1.9. (The main reason for this recommendation is that the default roles settings obtained when upgrading to 1.7 are not ideal for 1.8 onwards, 1.8 has problems with groups, etc.)


==See also==
==See also==


*[[Installing Moodle]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]  
*[[Installation FAQ]]
* [[dev:Moodle 2.3 release notes|Moodle 2.3 release notes]]
*[[Upgrading to Moodle 1.6]]
* [[dev:Upgrade API|Upgrade API]]
*[[Upgrading to Moodle 1.8]]
*[[Upgrading to Moodle 1.9]]
*[[Upgrading to Moodle 2.0]]
*[[Environment]]
*[[Git]] Version control and upgrading
*Moodle.org [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]  
*[http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf How to upgrade Moodle with cpanel tutorial] - screencasts of older Moodle/Cpanel install but useful (also, a very large file that will take some time to load).
 
Using Moodle.org 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]
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]
 
[[Category:Installation]]
 


[[es:Actualización de moodle]]
[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[fr:Mise à jour]]
[[ja:アップグレード]]
[[ja:Moodleをアップグレードする]]
[[nl:Upgraden]]
[[zh:升级]]
[[pl:Aktualizacja]]
[[de:Aktualisierung von Moodle]]
[[de:Aktualisierung von Moodle]]
[[ru:Обновление]]

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:

  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.

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

  1. Move your old Moodle software program files to another location. Do NOT copy new files over the old files.
  2. 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.
  3. Copy your old config.php file back to the new Moodle directory.
  4. 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.

See also

Retrieved from "https://docs.moodle.org/23/en/index.php?title=Upgrading&oldid=103071"
Powered by MediaWiki