Upgrading: Difference between revisions

Latest revision as of 09:22, 18 April 2024

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 4.3 in Site administration > Server > Environment.

See the Moodle 4.3 release notes for the server and client software requirements.

Notes:

You can only upgrade to Moodle 4.3 from Moodle 3.11.8 or later. If upgrading from earlier versions, you must upgrade to 3.11.8 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:

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 4.3 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 download the latest release from Moodle downloads.

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-latest-4.3.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 4.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.

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.

Possible issues that may affect you in Moodle 4.3

LTI External tool improvements

External tool is no longer available in the activity chooser. Instead, teachers can create a tool via a new page LTI External tools in the More menu of their course, then choose to make it available in the activity chooser. Existing tools created at site level and set to show as a preconfigured tool or show in the activity chooser are listed on the LTI External tools page.

There's also a new option to restrict site-level tools to courses in specific categories only.

Site-level default settings for activity completion

You can set default Activity completion settings for all courses on the site in Site administration > Courses > Default activity completion. Previously, the default at course level was 'Student must manually mark the activity as done' for all activities. After upgrading, the default at site and course level is 'None', with the exception of any changed course level defaults, which are retained.

Communication

To use the new feature Communication, which includes an integration with Matrix, you must enable communication providers in Site administration > Development > Experimental settings.

Sharing courses to MoodleNet

If sharing to MoodleNet is enabled on the site, in 4.3 teachers can also share courses or selected items from the course to MoodleNet.

Multi-factor authentication

To increase site security, you can enable Multi-factor authentication in Site administration > Plugins > Manage multi-factor authentication.

SCORM database structure improvements

If your site has a large amount of SCORM tracking data, the 4.3 upgrade may take longer than usual. However, after upgrading you should see some performance improvements.

New user tour

Moodle 4.3 includes a new user tour for the Grader report, highlighting features added in Moodle 4.2. If desired, you can disable it in Site administration / Appearance / User tours.

Creative Commons 4.0 licences

Creative Commons 4.0 licences are available. Creative Commons 3.0 licences are disabled - this prevents future use while not affecting existing use.

HTTP only cookies default set to on

HTTP only cookies (cookiehttponly) is set to on for new installs and the UI setting is removed. For upgraded sites, the current setting persists. Unless your site is using old SCORM packages or similar, HTTP only cookies should be on. If required, it can be changed in config.php.

Role renaming settings move

Role renaming settings are no longer in the course settings but instead can be found in Course > Participants > Role renaming.

Scrolling on mobile devices issue when using Atto

To avoid a bug affecting mobile device users using Atto (MDL-79636), users need to change their text editor to TinyMCE.

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

New capabilities in Moodle 4.3

communication/matrix:moderator
factor/capability:cannotpassfactor
mod/forum:canmailnow
moodle/contentbank:copyanycontent
moodle/contentbank:copycontent
moodle/course:configurecoursecommunication
moodle/group:configurecustomfields
moodle/moodlenet:sharecourse
tool/mfa:mfaaccess

Removed capabilities

mod/lti:addmanualinstance

Moodle 3.11, 4.0, 4.1 and 4.2 upgrading notes

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.

@@ Line 1: / Line 1: @@
 {{Installing Moodle}}
 ''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 {{Version}} in ''Site administration > Server > [[Environment]]''.
-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.
+See the [https://moodledev.io/general/releases/4.3 Moodle 4.3 release notes] for the server and client software requirements.
 Notes:
+* You can only upgrade to Moodle {{Version}} from Moodle 3.11.8 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/311/en/Upgrading upgrade to 3.11.8] as a first step.
-* 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.
 ==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|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.
@@ Line 36: / Line 27: @@
 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 ==
-You can fetch the current version of the software through
+You can download the latest release from [https://download.moodle.org/ Moodle downloads].
-wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.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 [[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 (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.
+# 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-{{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'''):
   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.
+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 {{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 ==
 The last step is to trigger the upgrade processes within Moodle.
@@ Line 94: / Line 67: @@
 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.
+==Possible issues that may affect you in Moodle {{Version}}==
+===LTI External tool improvements===
+External tool is no longer available in the activity chooser. Instead, teachers can create a tool via a new page [[LTI External tools]] in the More menu of their course, then choose to make it available in the activity chooser. Existing tools created at site level and set to show as a preconfigured tool or show in the activity chooser are listed on the LTI External tools page.
+There's also a new option to restrict site-level tools to courses in specific categories only.
+===Site-level default settings for activity completion===
+You can set default [[Activity completion settings]] for all courses on the site in ''Site administration > Courses > Default activity completion''. Previously, the default at course level was 'Student must manually mark the activity as done' for all activities. After upgrading, the default at site and course level is 'None', with the exception of any changed course level defaults, which are retained.
+===Communication===
+To use the new feature [[Communication]], which includes an integration with Matrix, you must enable communication providers in ''Site administration > Development > Experimental settings''.
+===Sharing courses to MoodleNet===
+If [[Share to MoodleNet|sharing to MoodleNet]] is enabled on the site, in 4.3 teachers can also share courses or selected items from the course to MoodleNet.
+===Multi-factor authentication===
+To increase site security, you can enable [[Multi-factor authentication]] in ''Site administration > Plugins > Manage multi-factor authentication''.
+===SCORM database structure improvements===
-===Fatal error: Maximum execution time of 30 seconds exceeded...===
+If your site has a large amount of SCORM tracking data, the 4.3 upgrade may take longer than usual. However, after upgrading you should see some performance improvements.
+===New user tour===
+Moodle 4.3 includes a new [[User tours|user tour]] for the Grader report, highlighting features added in Moodle 4.2. If desired, you can disable it in Site administration / Appearance / User tours.
+===Creative Commons 4.0 licences===
-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.
+Creative Commons 4.0 licences are available. Creative Commons 3.0 licences are disabled - this prevents future use while not affecting existing use.
-==After upgrading==
+===HTTP only cookies default set to on===
-==Possible issues that may affect you in Moodle {{Version}}==
+HTTP only cookies (cookiehttponly) is set to on for new installs and the UI setting is removed. For upgraded sites, the current setting persists. Unless your site is using old SCORM packages or similar, HTTP only cookies should be on. If required, it can be changed in config.php.
-===Course overview improvements===
+===Role renaming settings move===
-New course overview settings enable an admin to set which layouts and filters are available for users to select. In addition, course custom fields may be used as filters.
+Role renaming settings are no longer in the course settings but instead can be found in ''Course > Participants > Role renaming''.
-===Removed functionality===
+===Scrolling on mobile devices issue when using Atto===
-* The Community finder block and course-sharing functionality have been removed as part of the preparations for the new MoodleNet open social media platform.
+To avoid a bug affecting mobile device users using Atto (MDL-79636), users need to change their text editor to TinyMCE.
-* 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 [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].
+See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.3%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%20%3D%204.3%20AND%20labels%20%3D%20ui_change ui_change-labelled issues].
 ===New capabilities in Moodle {{Version}}===
-''Please add items here...''
+* communication/matrix:moderator
+* factor/capability:cannotpassfactor
-=== Moodle 3.2, 3.3, 3.4, 3.5, 3.6 and 3.7 improvements ===
+* mod/forum:canmailnow
+* moodle/contentbank:copyanycontent
+* moodle/contentbank:copycontent
+* moodle/course:configurecoursecommunication
+* moodle/group:configurecustomfields
+* moodle/moodlenet:sharecourse
+* tool/mfa:mfaaccess
-Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation
+===Removed capabilities===
-* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
+* mod/lti:addmanualinstance
-* [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]
+== Moodle 3.11, 4.0, 4.1 and 4.2 upgrading notes ==
+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/311/en/Upgrading Upgrading to Moodle 3.11]
+* [https://docs.moodle.org/400/en/Upgrading Upgrading to Moodle 4.0]
+* [https://docs.moodle.org/401/en/Upgrading Upgrading to Moodle 4.1]
+* [https://docs.moodle.org/402/en/Upgrading Upgrading to Moodle 4.2]
 ==Any questions about the process?==
 Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.
 ==See also==
+* [https://moodledev.io/general/releases/4.2 Moodle 4.2 release notes]
-* [[Installation]]
-* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation help forum]
-* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
 [[es:Actualización de moodle]]

Documentation