Note: You are currently viewing documentation for Moodle 2.6. Up-to-date documentation for the latest stable version of Moodle may be available here: Upgrading.

Upgrading: Difference between revisions

From MoodleDocs
m (Added re-read installation docs)
(→‎Possible issues that may affect you in Moodle 2.6: MySQL dmlwriteexception error when using calculated questions in a quiz (MDL-29332))
 
(188 intermediate revisions by 57 users not shown)
Line 1: Line 1:
Moodle is designed to upgrade cleanly from any earlier version to any later version. Please refer to '''[[Upgrading to Moodle 1.6]]''' for particular considerations related to Moodle 1.6 features.
{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''


When upgrading a Moodle installation you should follow these steps:
==Check the requirements==


==Re-read the installation documentation==
Check that your server meets all requirements for 2.6 in ''Administration > Site administration > Server > [[Environment]]''.
Spend some time re-reading the [[Installing Moodle | installation documentation]]. Look in particular for any changes in webserver, database and PHP requirements for the version of Moodle you are upgrading to.


== Backup important data ==
New in Moodle 2.6 is the php_setting [[OPcache]].


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.6 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:
==Before you upgrade your site for real==


=== 1. The Moodle software directory itself ===
'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''


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
== Backup important data ==
 
=== 2. Your data directory ===


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.
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, your Postgres or MySQL database dump)


=== 3. Your database ===
See [[Site backup]] for more specific information.


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":
==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.


mysqldump -u username -p -C -Q -e -a moodle > moodle-backup-2002-10-26.sql
== Check for add-on updates ==


Substitute your database user account for username. The -p flag will prompt you for the password for the username specified by -u.
If you have [[Automatic updates deployment]] enabled, you will be able to update installed add-ons automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.


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:
If you are updating add-ons manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a 2.6 version available for any add-ons (including themes) that you have previously installed on your site. If so, download the add-on package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing add-ons]]).


mysqldump -u username -p -h databasehost -C -Q -e -a moodle > moodle-backup-2002-10-26.sql
The upgrade of the add-on will then happen as part of the Moodle upgrade process.


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.
If an out-of-date add-on causes your upgrade to fail, you can usually delete the add-on code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.


== Install the new Moodle software ==
== 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 the new 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 add-ons on your site you should add them to the new code tree now. 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.
# Dont forget to also copy over your moodledata folder / directory.  If you don't you will get a "fatal error $cfg- dataroot is not configured properly".


====Linux====
  mv moodle moodle.backup
  mv moodle moodle.backup
  tar xvzf moodle-1.1.tgz
  tar xvzf moodle-2.6.tgz


Next, copy across your config.php and any other plugins such as custom themes:
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
  cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
  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. See [[Git for Administrators]] for details.
===Command line upgrade===
On Linux servers, Moodle 2.6 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.
== Finishing the upgrade ==
The last step is to trigger the upgrade processes within Moodle.
To do this just go to ''Administration > 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!


=== Using CVS ===
Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.


You can use CVS for updating or upgrading your Moodle.
==After upgrading==
First you need to do a CVS checkout in your (empty) Moodle root directory.


'''For Linux servers'''
The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 2.6 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.6 config-dist.php.


To do a CVS checkout of Moodle, you first have to logon to the Moodle CVS server.
==Fatal error: Maximum execution time of 30 seconds exceeded...==


  <nowiki>cvs -d:pserver:anonymous@moodle.cvs.sourceforge.net:/cvsroot/moodle login</nowiki>
If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598 .
  No password for anonymous, so just hit the Enter button.


Go to the directory where you want the Moodle root to come and type
==Possible issues that may affect you in Moodle 2.6==
===Ghostscript===
For the new Annotate PDF assignment feature to work properly, Ghostscript needs to be installed on your server. Check the path from ''Site administration > Plugins > Activity modules > Assignment > Feedback plugins >Annotate PDF''. (Note that if is not enabled or the path is not correct, then the link 'Launch PDF editor' will not appear for teachers when grading PDF assignments.)


  <nowiki>cvs -z3 -d:pserver:anonymous@moodle.cvs.sourceforge.net:/cvsroot/moodle
===New Box.net API===
  co -r MOODLE_15_STABLE moodle</nowiki>
  (where MOODLE_15_STABLE is the desired version)


To update, just go into the Moodle root directory and update to the new files:
To continue using the [[Box.net repository]] and [[Box.net portfolio]], the Moodle site must use HTTPS and the plugins must be configured with a Box.net client ID and secret. See [[Box.net APIv1 migration]] for details.


  cvs update -dP
Box.net repository users will no longer be possible to create a shortcut/alias to a file stored in Box.net.
To update to a new version type in the following and change 17 to whatever newest version upgrade number is
  cvs -Q update -dP -r MOODLE_17_STABLE


Make sure you use the "d" parameter to create new directories if necessary, and the "P" parameter to prune empty directories.
'''IMPORTANT''': The Box.net-alias-to-copy-conversion tool should be run ''as soon as possible''. See [[Box.net APIv1 migration]] for details.


'''For Windows servers'''
===Theme compatibility===


You can use Tortoise CVS to do the initial checkout and the updates.
If your site has a custom theme, then you might run into an error during upgrade "Debug info: Unknown column 'cacherev' in 'field list'".


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 solution is to temporarily switch your theme to "standard" theme during the upgrade.   You can do this by adding "theme=standard" on the URL or by adding this to your Moodle config.php:


Don't forget to visit the admin page after the CVS update proces has completed.
$CFG->theme = "standard";


== Finishing the upgrade ==
After upgrade your theme might still work fine.
 
Another solution is to complete your upgrade via a CLI.
 
===My Mobile theme removal===
 
The "My Mobile" theme has been removed from Moodle 2.6 (MDL-40874). During the upgrade process, the theme will be uninstalled and all its settings will be deleted. The "My Mobile" theme and its extending themes will fall back to the mobile friendly "Clean" theme.
 
To keep the "My Mobile" theme and its settings, BEFORE UPGRADING files from the unmaintained plugin must be copied into theme/mymobile. The unmaintained plugin can be downloaded from  the [https://moodle.org/plugins/view.php?plugin=theme_mymobile MyMobile theme entry in the plugins directory].
 
===Backup and restore of assignments from Moodle 2.2 and older===
 
The [[Assignment module|assignment activity module]] was completely rewritten in Moodle 2.3. Assignments from Moodle 2.2 and older (e.g. from Moodle 1.9) need to be upgraded in order to continue being usable in Moodle 2.6. See the section 'Restoring course backups from Moodle 2.2 and older' in [[Assignment upgrade tool]] for details of what to do.


The last step is to trigger the upgrade processes within Moodle.
===MySQL dmlwriteexception error when using calculated questions in a quiz===


To do this just visit the admin page of your installation e.g. ''<nowiki>http://example.com/moodle/admin</nowiki>''
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.


It doesn't matter if you are logged in as admin or not.
=== Moodle 2.3, 2.4 and 2.5 improvements ===


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.
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation


Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!
* [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3]
* [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4]
* [https://docs.moodle.org/25/en/Upgrading Upgrading to Moodle 2.5]


==See also==
==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.6 release notes|Moodle 2.6 release notes]]
*[[Installing Moodle]]
* [[dev:Upgrade API|Upgrade API]]
*[[Installation FAQ]]
*[[Installing Apache, MySQL and PHP]]
*[[Step by Step Installation Guide for Windows]]
*[[Step by Step Installation Guide for RedHat]]
*[[Step by Step Installation Guide for Debian GNU/Linux]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=26731&parent=125858 Using cvs] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=56915 Upgrading from 1.5.2 to 1.7] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=56991 Upgrade nightmares.... any help appreciated] forum discussion with a happy ending :-)
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=62463 After upgrading i get "Your site may not be secure." msg.] forum discussion
 
[[Category:Core]]
[[Category:Administrator]]
[[Category:Installation]]


[[es:Actualización de moodle]]
[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[fr:Mise à jour]]
[[nl:Upgraden]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Latest revision as of 09:36, 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.6 in Administration > Site administration > Server > Environment.

New in Moodle 2.6 is the php_setting OPcache.

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

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, your Postgres or MySQL database dump)

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.

Check for add-on updates

If you have Automatic updates deployment enabled, you will be able to update installed add-ons automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating add-ons manually, it is a good moment now to check in the Moodle Plugins directory whether there is a 2.6 version available for any add-ons (including themes) that you have previously installed on your site. If so, download the add-on package. In the next step, you will copy it to the appropriate location in your Moodle code (see Installing add-ons).

The upgrade of the add-on will then happen as part of the Moodle upgrade process.

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

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 the new 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 add-ons on your site you should add them to the new code tree now. 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.
  5. Dont forget to also copy over your moodledata folder / directory. If you don't you will get a "fatal error $cfg- dataroot is not configured properly".

Linux

mv moodle moodle.backup
tar xvzf moodle-2.6.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. See Git for Administrators for details.

Command line upgrade

On Linux servers, Moodle 2.6 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 Administration > 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!

Note: If you are running multiple servers then you should purge all caches manually (via Administration > Site administration > Development > Purge all caches) after completing the upgrade on all servers.

After upgrading

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 2.6 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.6 config-dist.php.

Fatal error: Maximum execution time of 30 seconds exceeded...

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598 .

Possible issues that may affect you in Moodle 2.6

Ghostscript

For the new Annotate PDF assignment feature to work properly, Ghostscript needs to be installed on your server. Check the path from Site administration > Plugins > Activity modules > Assignment > Feedback plugins >Annotate PDF. (Note that if is not enabled or the path is not correct, then the link 'Launch PDF editor' will not appear for teachers when grading PDF assignments.)

New Box.net API

To continue using the Box.net repository and Box.net portfolio, the Moodle site must use HTTPS and the plugins must be configured with a Box.net client ID and secret. See Box.net APIv1 migration for details.

Box.net repository users will no longer be possible to create a shortcut/alias to a file stored in Box.net.

IMPORTANT: The Box.net-alias-to-copy-conversion tool should be run as soon as possible. See Box.net APIv1 migration for details.

Theme compatibility

If your site has a custom theme, then you might run into an error during upgrade "Debug info: Unknown column 'cacherev' in 'field list'".

The solution is to temporarily switch your theme to "standard" theme during the upgrade. You can do this by adding "theme=standard" on the URL or by adding this to your Moodle config.php:

$CFG->theme = "standard";

After upgrade your theme might still work fine.

Another solution is to complete your upgrade via a CLI.

My Mobile theme removal

The "My Mobile" theme has been removed from Moodle 2.6 (MDL-40874). During the upgrade process, the theme will be uninstalled and all its settings will be deleted. The "My Mobile" theme and its extending themes will fall back to the mobile friendly "Clean" theme.

To keep the "My Mobile" theme and its settings, BEFORE UPGRADING files from the unmaintained plugin must be copied into theme/mymobile. The unmaintained plugin can be downloaded from the MyMobile theme entry in the plugins directory.

Backup and restore of assignments from Moodle 2.2 and older

The assignment activity module was completely rewritten in Moodle 2.3. Assignments from Moodle 2.2 and older (e.g. from Moodle 1.9) need to be upgraded in order to continue being usable in Moodle 2.6. See the section 'Restoring course backups from Moodle 2.2 and older' in Assignment upgrade tool for details of what to do.

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.

Moodle 2.3, 2.4 and 2.5 improvements

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

See also