Upgrading: Difference between revisions
| (98 intermediate revisions by 16 users not shown) | |||
| Line 4: | Line 4: | ||
==Check the requirements== | ==Check the requirements== | ||
Check that your server meets all requirements for | Check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''. | ||
See the [{{Release notes}} release notes] in the dev docs for software requirements. | |||
Notes: | |||
* You can only upgrade to Moodle {{Version}} from Moodle 3.1 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/31/en/Upgrading_to_Moodle_3.1 upgrade to 3.1] as a first step. | |||
* The minimum PHP version has increased and is now 7.0.0. | |||
* The PHP extension '''intl''' is now required in Moodle 3.4 (previously it was only recommended). | |||
==Before upgrading== | ==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.''' | '''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|upgrade key]] for your site. | |||
== Backup important data == | == Backup important data == | ||
| Line 20: | Line 28: | ||
See [[Site backup]] for more specific information. | See [[Site backup]] for more specific information. | ||
== Check for plugin updates == | == Check for plugin updates == | ||
| Line 28: | Line 33: | ||
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 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 | 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. | 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. | 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 == | ||
You can fetch the current | You can fetch the current version of the software through | ||
wget http://sourceforge.net/projects/moodle/files/Moodle/ | wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz | ||
=== Standard install package === | === Standard install package === | ||
| Line 44: | Line 52: | ||
# 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. | # 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. | # Copy your old [[Configuration file|config.php file]] back to the new Moodle directory. | ||
# As mentioned above, if you had installed any plugins 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. | # 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- | tar xvzf moodle-{{Version}}.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'''): | 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'''): | ||
| Line 58: | Line 66: | ||
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. | 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. | ||
chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version) | |||
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. | |||
if necessary. | |||
=== Using Git === | === Using Git === | ||
| Line 71: | Line 81: | ||
===Command line upgrade=== | ===Command line upgrade=== | ||
On Linux servers, Moodle | 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. | ||
== Finishing the upgrade == | == Finishing the upgrade == | ||
| Line 77: | Line 87: | ||
The last step is to trigger the upgrade processes within Moodle. | The last step is to trigger the upgrade processes within Moodle. | ||
To do this just go to '' | If you put your site into [[Maintenance mode|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. | 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. | ||
| Line 83: | Line 95: | ||
Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features! | 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 '' | 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...=== | ===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 | 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== | ==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 | The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 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 3.0 config-dist.php. | ||
===Cron=== | ===Cron=== | ||
Cron has received a major update (MDL-25499) and now has support for both scheduled and | Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks. | ||
The benefits of these changes are: | The benefits of these changes are: | ||
| Line 107: | Line 119: | ||
You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure. | You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure. | ||
Before the upgrade | Before the upgrade, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade. | ||
===Assignments=== | ===Assignments=== | ||
| Line 113: | Line 125: | ||
The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one. | The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one. | ||
If you are still using the old assignment (2.2) module, after upgrading to Moodle | If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities. | ||
If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle | If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade. | ||
==Possible issues that may affect you in Moodle | ==Possible issues that may affect you in Moodle {{Version}}== | ||
* 'Site policies' in the Site administration has been renamed '[[Site security settings]]'. | |||
* Moodle presets have changed. Most of the Bootstrap 4 variables have changed and the way bootstrap, font awesome and core scss is included. For more info on the Bootstrap 4 changes visit https://getbootstrap.com/docs/4.0/migration/ | |||
<code php> | |||
// Example code, place scss variables here. | |||
// $font-size-base: 0.9375rem | |||
// Import FontAwesome. | |||
@import "fontawesome"; | |||
// Import All of Bootstrap. | |||
@import "bootstrap"; | |||
// Import Core moodle CSS. | |||
@import "moodle"; | |||
// Example code, place scss using Bootstrap mixins and extends here. | |||
// .navbar { | |||
// @include shadow(); | |||
// } | |||
</code> | |||
* The PostgreSQL driver has been improved and, now, the <tt>get_recordset_xxx()</tt> operations don't fetch all the records into memory for big (>100000) datasets. This can be configured or disabled using the new <tt>fetchbuffersize</tt> [https://github.com/moodle/moodle/blob/f61ee4e857a894a5b8b69516b00be88ae499964b/config-dist.php#L73 dboption]. Note this is known to affect installations using pg_bouncer in transaction mode. See MDL-60174 for more information. | |||
= | * Upgrading from Moodle 3.1 to Moodle 3.5 may require that you update database tables to <tt>utf8mb4_unicode_ci</tt>. The issue presents itself when using the forgotten password at login tool which returns an error <tt>COLLATION utf8mb4_bin is not valid for CHARACTER SET utf8</tt> when searching for your email or username. By running a script provided by Moodle this problem is easy to solve. More on this can be found in this thread here: [[https://moodle.org/mod/forum/discuss.php?d=383652#p1546998 From Sergio Teixeira]] The bashscript code to run is as follows. Be sure to backup your database before doing so in case an error occurs. Use the relevant path for your installation. | ||
<code> | |||
$ php public_html/admin/cli/mysql_collation.php --collation=utf8mb4_unicode_ci | |||
</code> | |||
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.5%22)%20AND%20labels%20%3D%20ui_change%20 issues fixed in Moodle 3.5 which are labelled ui_change]. | |||
=== Moodle 3.1, 3.2, 3.3 and 3.4 improvements === | |||
=== | |||
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation | Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation | ||
* [https://docs.moodle.org/ | * [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1] | ||
* [https://docs.moodle.org/ | * [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/ | * [https://docs.moodle.org/34/en/Upgrading Upgrading to Moodle 3.4] | ||
* [https://docs.moodle.org/ | |||
==See also== | ==See also== | ||
* [[Installation]] | * [[Installation]] | ||
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation | * Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation help forum] | ||
* [[dev:Moodle | * [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]] | ||
[[de:Aktualisierung von Moodle]] | |||
[[es:Actualización de moodle]] | [[es:Actualización de moodle]] | ||
[[fr:Mise à jour]] | [[fr:Mise à jour]] | ||
[[it:Aggiornamento]] | |||
[[ja:Moodleをアップグレードする]] | [[ja:Moodleをアップグレードする]] | ||
Latest revision as of 12:52, 19 March 2020
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 3.5 in Administration > Site administration > Server > Environment.
See the release notes in the dev docs for software requirements.
Notes:
- You can only upgrade to Moodle 3.5 from Moodle 3.1 or later. If upgrading from earlier versions, you must upgrade to 3.1 as a first step.
- The minimum PHP version has increased and is now 7.0.0.
- The PHP extension intl is now required in Moodle 3.4 (previously it was only recommended).
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:
- 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)
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.5 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 through
wget http://sourceforge.net/projects/moodle/files/Moodle/stable35/moodle-latest-35.tgz
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 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 config.php file back to the new Moodle directory.
- 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
mv moodle moodle.backup tar xvzf moodle-3.5.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.
chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version) 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.5 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
The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 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 3.0 config-dist.php.
Cron
Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks.
The benefits of these changes are:
- The schedule for every task can be configured by the admin
- Tasks can run in parallel
- Cron processes use locking to prevent the same task running at the same time by different processes
- Clusters with multiple identical application nodes are supported, you can run cron on all of them
A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least once per minute.
You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, here are some tips for debugging the failure.
Before the upgrade, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade.
Assignments
The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.
If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the Assignment upgrade tool to un-hide the activities.
If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.
Possible issues that may affect you in Moodle 3.5
- 'Site policies' in the Site administration has been renamed 'Site security settings'.
- Moodle presets have changed. Most of the Bootstrap 4 variables have changed and the way bootstrap, font awesome and core scss is included. For more info on the Bootstrap 4 changes visit https://getbootstrap.com/docs/4.0/migration/
// Example code, place scss variables here.
// $font-size-base: 0.9375rem
// Import FontAwesome.
@import "fontawesome";
// Import All of Bootstrap.
@import "bootstrap";
// Import Core moodle CSS.
@import "moodle";
// Example code, place scss using Bootstrap mixins and extends here.
// .navbar {
// @include shadow();
// }
- The PostgreSQL driver has been improved and, now, the get_recordset_xxx() operations don't fetch all the records into memory for big (>100000) datasets. This can be configured or disabled using the new fetchbuffersize dboption. Note this is known to affect installations using pg_bouncer in transaction mode. See MDL-60174 for more information.
- Upgrading from Moodle 3.1 to Moodle 3.5 may require that you update database tables to utf8mb4_unicode_ci. The issue presents itself when using the forgotten password at login tool which returns an error COLLATION utf8mb4_bin is not valid for CHARACTER SET utf8 when searching for your email or username. By running a script provided by Moodle this problem is easy to solve. More on this can be found in this thread here: [From Sergio Teixeira] The bashscript code to run is as follows. Be sure to backup your database before doing so in case an error occurs. Use the relevant path for your installation.
$ php public_html/admin/cli/mysql_collation.php --collation=utf8mb4_unicode_ci
See also the list of issues fixed in Moodle 3.5 which are labelled ui_change.
Moodle 3.1, 3.2, 3.3 and 3.4 improvements
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation
See also
- Installation
- Using Moodle Installation help forum
- Moodle 3.5 release notes
