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

Upgrading: Difference between revisions

From MoodleDocs
 
(228 intermediate revisions by 31 users not shown)
Line 1: Line 1:
{{Installing Moodle}}
{{Installing Moodle}}
'''Before you do anything else, read [[Upgrading to Moodle 2.2]]'''
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''


Moodle is designed to upgrade itself from one version to the next. The procedure is
==Check the requirements==
# [[Site backup|Back up everything]].
# Replace the old version of the code with the new one.
# Visit the [[Site_administration_block#Notifications|administrator notifications]] link, which triggers Moodle to self-update.
These steps are explained in more detail below.


Sometimes there are specific considerations when upgrading to a particular version.  See the [[dev:Releases|Releases page]] for more information on this.  You also have to be more careful if you have installed additional plug-ins or customised the code.
Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.  


See this tutorial if you are [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf upgrading Moodle on cpanel]. It is a bit rough around the edges and is a little dated, but you should get the idea.
See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.


There is also a separate page about [[Ubuntu_Debian_Upgrades|upgrading Moodle if you installed it using the Ubuntu/Kubuntu/Debian package manager]].
Notes:


* You can only upgrade to Moodle {{Version}} from Moodle 3.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/32/en/Upgrading_to_Moodle_3.2 upgrade to 3.2] as a first step.


__TOC__
==Before upgrading==


When upgrading a Moodle installation you should follow these steps:
'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''
 
==Before you upgrade your site for real==
 
You are strongly advised to make a copy of your entire Moodle site onto another computer (see [[Moodle migration]]) and run the upgrade there to verify it will work. If you decide not to do this, make sure you have good backups. If the upgrade fails you will need the backups to go back.
 
==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 ''Settings > Site administration > Server > [[Environment]]''.


==Put your Site into Maintenance Mode==
Consider setting the [[Upgrade key|upgrade key]] for your site.
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 ==
== Backup important data ==
See [[Site backup]] for more specific information.


There are three areas that should be backed up before any upgrade:
There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, the SQL or Postgres database)
#Moodle database (For example, your Postgres or MySQL database dump)


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 issues with the upgrade process. 
See [[Site backup]] for more specific information.


:''TIP:'' One more time, "do not risk what you can not afford to lose": do regular backups, make sure it is really backed up and know how to restore a backup!
== Check for plugin updates ==
 
If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins 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 plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will 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.
 
==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. Then you should wait for any currently running cron processes to complete before proceeding.


== 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 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. 
You can fetch the current version of the software at


*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.
wget http://sourceforge.net/projects/moodle/files/Moodle/stable38/moodle-latest-38.tgz


=== 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 directory|moodledata]] if it needs to in the upgrade.
*Copy your old [[Configuration file|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. If you are upgrading to Moodle 2.0 or newer, note that all optional plugins and themes required a significant rewrite and most do not have 2.0 versions (yet).
*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 ===
# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
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).
# 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.
*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").
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) 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 and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder.  If you are moving your installation to a new server or new location on your server, then you will need to follow the [[Migration]] documents.


====Linux====
====Linux====
  mv moodle moodle.backup
  mv moodle moodle.backup
  tar xvzf moodle-1.1.tgz
  tar xvzf moodle-latest-{{Version}}.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'''):
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 70: Line 63:
  cp -pr moodle.backup/mod/mymod moodle/mod/mymod
  cp -pr moodle.backup/mod/mymod moodle/mod/mymod


Don't forget to make moodle/config.php readable by your www server.
Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.
 
chown -R root:root moodle (Linux debian - or even create a user especially for moodle. '''Don't''' use the web server user, e.g. www-data)
chmod -R 755 moodle


If you use cron, take care that cron.php is executeable and uses the correct php command:  
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)
  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')
  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.  However, for a simple upgrade, there should be no need to change anything with cron.


=== Using Git ===


if necessary.
You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.


=== Using CVS ===
===Command line upgrade===


New sites should now use Git rather than CVS (see next section). If your site already uses CVS, to update, just go into the Moodle root directory and update to the new files:
On Linux servers, Moodle {{Version}} 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.
<pre>
$ cd /path/to/your/moodle/
$ cvs update -dP
</pre>
To update from an older version type in the following:
<pre>
$ cd /path/to/your/moodle/
$ cvs -Q update -dP -r MOODLE_18_STABLE
</pre>


Make sure you use the "d" parameter to create new directories if necessary, and the "P" parameter to prune empty directories.
== Finishing the upgrade ==
 
The last step is to trigger the upgrade processes within Moodle.  


=== Using Git ===
If you put your site into Maintenance mode earlier; take it out now!
 
To do this just go to ''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 ''Site administration > Development > Purge all caches'') after completing the upgrade on all servers.
 
===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 successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.
 
==After upgrading==
 
==Possible issues that may affect you in Moodle {{Version}}==
 
===Course overview improvements===
 
New course overview settings enable an admin to


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.
* reduce the currently available layouts (Card, List and Summary)
* specify which filter options are available, including providing a custom filter which uses course custom field values


See [[Git for Administrators]] for further details.
===Course request changes===


== Finishing the upgrade ==
The capabilities moodle/course:request and moodle/site:approvecourse may now be applied in the category context.


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


To do this just visit the [[Site administration block]] admin page (or ''<nowiki>http://example.com/moodle/admin</nowiki>'') and the "Notifications" link.
* The Community finder block and course-sharing functionality have been removed as part of the preparations for the new MoodleNet open social media platform.
* The People block has been removed because there is a Participants link in the navigation drawer (Boost theme) and in the navigation block (Classic theme).


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.
''Please add more items here...''


Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!
See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.8%22)%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.8%22)%20AND%20labels%20%3D%20ui_change%20 ui_change-labelled issues].


===New capabilities in Moodle {{Version}}===


:''TIP:'' Use the site administration block>Server>Maintenance mode to prevent users from changing data during the upgrade.
'''Forum'''
:''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) ==
* forumreport/summary:view
* forumreport/summary:viewall
* mod/forum:exportforum
* mod/forum:grade


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]].
'''H5P'''


==Upgrading more than one version==
* atto/h5p:addembed
* moodle/h5p:deploy
* moodle/h5p:setdisplayoptions
* moodle/h5p:updatelibraries


Normally you can upgrade directly from any Moodle version to any later version. So, for example you could upgrade from 2.0 to 2.1, or from 1.9 to 2.2.
=== Moodle 3.2, 3.3, 3.4, 3.5, 3.6 and 3.7 improvements ===


However, every so often, this general rule gets broken, because supporting really large jumps (for example Moodle 1.6 to 2.2 in one step) would be impossible. Recent break points have been:
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation
* You must have upgraded to version 1.9.x before you can upgrade to a later 2.x version.
* You must have upgraded to version 2.2.x before you can upgrade to 2.3 or later.


If you are upgrading from a pre-1.6 version it is recommended that you upgrade first to the latest 1.6.x, then to the latest 1.9.x and finally to the latest 2.x. See Petr's forum post [http://moodle.org/mod/forum/discuss.php?d=197602#p861964 Re: Continuing on Upgrade docs] for further information.
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]
* [https://docs.moodle.org/34/en/Upgrading Upgrading to Moodle 3.4]
* [https://docs.moodle.org/35/en/Upgrading Upgrading to Moodle 3.5]
* [https://docs.moodle.org/36/en/Upgrading Upgrading to Moodle 3.6]
* [https://docs.moodle.org/37/en/Upgrading Upgrading to Moodle 3.7]


==See also==
==Any questions about the process?==


*[[Environment]]
Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.
*[[Git]] Version control and upgrading
*[[How to fix just one bug without 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).


Documentation on upgrading to particular versions:
==See also==
*[[Upgrading to Moodle 2.2]]
*[https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to Moodle 2.1]
*[https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to Moodle 2.0]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.9 Upgrading to Moodle 1.9]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.8 Upgrading to Moodle 1.8]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.7 Upgrading to Moodle 1.7]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.6 Upgrading to Moodle 1.6]


Using Moodle.org forum discussions:
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]
* [https://moodle.org/mod/forum/discuss.php?d=393570 Problem accessing dropdown such as personal profile since 3.8 (20191118) update] forum discussion
*[http://moodle.org/mod/forum/discuss.php?d=198123 Language customizations lost on upgrade]
*[[Beginning_Moodle_2.0_Administration|Beginning Moodle 2.0 Administration]]


[[es:Actualización de moodle]]
[[es:Actualización de moodle]]

Latest revision as of 09:36, 11 March 2020

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

Check the requirements

Before upgrading, check that your server meets all requirements for 3.8 in Site administration > Server > Environment.

See the release notes in the dev docs for both server and client software requirements.

Notes:

  • You can only upgrade to Moodle 3.8 from Moodle 3.2 or later. If upgrading from earlier versions, you must upgrade to 3.2 as a first step.

Before upgrading

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

Consider setting the upgrade key for your site.

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.

Check for plugin updates

If you have Automatic updates deployment enabled, you will be able to update installed plugins 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 plugins manually, it is a good moment now to check in the Moodle Plugins directory whether there is a 3.8 version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will 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.

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. Then you should wait for any currently running cron processes to complete before proceeding.

Install the new Moodle software

You can fetch the current version of the software at

wget http://sourceforge.net/projects/moodle/files/Moodle/stable38/moodle-latest-38.tgz

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 plugins on your site you should add them to the new code tree (Moodle directory structure) 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 and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
  5. Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the Migration documents.

Linux

mv moodle moodle.backup
tar xvzf moodle-latest-3.8.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. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.

chown -R root:root moodle (Linux debian - or even create a user especially for moodle. Don't use the web server user, e.g. www-data)
chmod -R 755 moodle

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. However, for a simple upgrade, there should be no need to change anything with cron.

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 3.8 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.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to 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 Site administration > Development > Purge all caches) after completing the upgrade on all servers.

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 successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

After upgrading

Possible issues that may affect you in Moodle 3.8

Course overview improvements

New course overview settings enable an admin to

  • reduce the currently available layouts (Card, List and Summary)
  • specify which filter options are available, including providing a custom filter which uses course custom field values

Course request changes

The capabilities moodle/course:request and moodle/site:approvecourse may now be applied in the category context.

Removed functionality

  • The Community finder block and course-sharing functionality have been removed as part of the preparations for the new MoodleNet open social media platform.
  • The People block has been removed because there is a Participants link in the navigation drawer (Boost theme) and in the navigation block (Classic theme).

Please add more items here...

See also the list of upgrade_notes-labelled issues and ui_change-labelled issues.

New capabilities in Moodle 3.8

Forum

  • forumreport/summary:view
  • forumreport/summary:viewall
  • mod/forum:exportforum
  • mod/forum:grade

H5P

  • atto/h5p:addembed
  • moodle/h5p:deploy
  • moodle/h5p:setdisplayoptions
  • moodle/h5p:updatelibraries

Moodle 3.2, 3.3, 3.4, 3.5, 3.6 and 3.7 improvements

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

Any questions about the process?

Please post in the Installing and upgrading help forum on moodle.org.

See also