Upgrading: Difference between revisions

From MoodleDocs
 
(266 intermediate revisions by 33 users not shown)
Line 1: Line 1:
{{Installing Moodle}}
{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
==Check the requirements==
==Check the requirements==
Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.


Check that your server meets all requirements for 2.7 in ''Administration > Site administration > Server > [[Environment]]''.
See the [{{Release notes}} Moodle {{Version}} release notes] for server and client software requirements.
 
Note: You can only upgrade to Moodle 2.7 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.


Notes:
* You can only upgrade to Moodle {{Version}} from Moodle 4.1.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/401/en/Upgrading upgrade to 4.1.2] as a first step.
==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.'''


===Themes===
Consider setting the [[Upgrade key|upgrade key]] for your site.
 
All core themes, except clean, have been removed from Moodle 2.7. Thus sites using any core theme (including sites using a core theme as a parent theme) other than clean must do the following:
 
# Download the 2.7 version of your theme as a zip file from the [https://moodle.org/plugins/browse.php?list=category&id=3 Themes section of the Moodle plugins directory].
# Follow the steps above to install the new Moodle software. In step 4, unzip the theme and copy it to moodle/theme/.
# Proceed with the upgrade.
 
Note: Only installed add-on themes may be updated automatically during the upgrade, NOT core themes. Because core themes have been removed from Moodle 2.7, they have to be re-added.
 
===Questions===
 
In Moodle 2.1 there was a major upgrade to questions. As explained in [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1#Planning_the_question_engine_upgrade the upgrade documentation for that version], it was possible to delay parts of the database upgrade to be run later. Before you upgrade to Moodle 2.7, this upgrade must be completed.  You can check for this by looking at the bottom of the [[Environment]] check page in your site.
 
== Backup important data ==
== Backup important data ==
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, your Postgres or MySQL database dump)
#Moodle database (For example, your Postgres or MySQL database dump)
See [[Site backup]] for more specific information.
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.


==Put your site into maintenance mode==
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 [[Installing_plugins#Plugins_overview|plugins (including themes) 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]]).
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in.


== Check for add-on updates ==
The upgrade of the plugin will then happen as part of the Moodle upgrade process.


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


==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 download the latest release from [https://download.moodle.org/ Moodle downloads].
=== Standard install package ===
=== Standard install package ===
# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# 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.
# 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 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.
# 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.)
# 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".
# 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-2.7.tgz
  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'''):
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
  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 {{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.


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 put your site into Maintenance mode earlier; take it out now!


If you use cron, take care that cron.php is executeable and uses the correct php command:
To do this just go to ''Site administration > Notifications''.
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')
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!


if necessary.
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.


=== Using Git ===
==Possible issues that may affect you in Moodle {{Version}}==


You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.
===AI subsystem===


===Command line upgrade===
Moodle 4.5 includes an [[AI subsystem]], a new feature which is the foundation for integrating AI tools into Moodle LMS. Any open source or commercial large language model (LLM) can be supported via Provider plugins. The initial release includes plugins for OpenAI and Azure (which may also function with compatible LLMs), with more providers on the roadmap for future development. For details, see [[AI subsystem]].


On Linux servers, Moodle 2.7 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.
===Course subsections===


== Finishing the upgrade ==
In Moodle 4.5, teachers can organise their course content into subsections. To enable this feature, you need to enable Subsection in ''Site administration > Plugins > Manage activities''.


The last step is to trigger the upgrade processes within Moodle.
===Screen recording===


To do this just go to ''Administration > Site administration > Notifications''.
In Moodle 4.5, an additional RecordRTC recording type is available - Screen. You can enable it in ''Site administration > Plugins > RecordRTC''. In addition to the screen recording time limit, you can set the video output resolution size and whether to allow pausing.


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.
===New notifications===


Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!
Moodle 4.5 includes the following notifications for students:


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.
* Assignment due in 7 days
* Upcoming assignment due (48 hours before the due date)
* Assignment overdue
* Quiz opening soon (48 hours before the open date)


===Fatal error: Maximum execution time of 30 seconds exceeded...===
===Assignment default grade type and scale===


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.
An admin can set the default grade type and scale for all new assignments in ''Site administration > Plugins > Assignment settings''.


==After upgrading==
===Cohorts bulk deletion===


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.7 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.7 config-dist.php.
[[Cohorts]] may be selected and deleted in bulk in ''Site administration > Users > Cohorts''.


===Assignments===
===Site registration===


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.  
When registering your site, you have the option to specify your organisation type.


If you are still using the old assignment (2.2) module, after upgrading to Moodle 2.7 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.
Plugin usage data and AI usage stats are also collected and sent to Moodle each time your site registration is updated.


If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 2.7, and then replace the "mod/assignment" folder with the one from the plugins directory before completing the upgrade.
===Option to not show the manual login form===


==Possible issues that may affect you in Moodle 2.7==
If all users on the site use an authentication method such as OAuth 2 that doesn't require them to enter a username and password, you can hide the manual login form by unticking the box 'Display manual login form' in ''Site administration > Plugins > Manage authentication''.


''Items to be added here...''


=== Moodle 2.3, 2.4, 2.5 and 2.6 improvements ===
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.5%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.5%20AND%20labels%20%3D%20ui_change ui_change-labelled issues] also the [https://moodledev.io/docs/4.5/devupdate Moodle 4.5 developer update].


Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation
===New capabilities in Moodle {{Version}}===


* [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3]
* aiplacement/courseassist:summarise_text
* [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4]
* aiplacement/editor:generate_image
* [https://docs.moodle.org/25/en/Upgrading Upgrading to Moodle 2.5]
* aiplacement/editor:generate_text
* [https://docs.moodle.org/26/en/Upgrading Upgrading to Moodle 2.6]
* mod/bigbluebuttonbn:seepresentation
* mod/subsection:addinstance
* moodle/ai:acceptpolicy
* moodle/ai:fetchanyuserpolicystatus
* moodle/ai:fetchpolicy
* moodle/contentbank:changelockedcustomfields
* moodle/contentbank:configurecustomfields
* moodle/course:editcoursewelcomemessage
* moodle/user:viewprofilepictures
* quizaccess/seb:manage_seb_configuremanually
* quizaccess/seb:manage_seb_usesebclientconfig
* tiny/recordrtc:recordscreen


==See also==
== Moodle 4.1, 4.2, 4.3 and 4.4 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/401/en/Upgrading Upgrading to Moodle 4.1]
* [https://docs.moodle.org/402/en/Upgrading Upgrading to Moodle 4.2]
* [https://docs.moodle.org/403/en/Upgrading Upgrading to Moodle 4.3]
* [https://docs.moodle.org/404/en/Upgrading Upgrading to Moodle 4.4]


* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]  
==Any questions about the process?==
* [[dev:Moodle 2.7 release notes|Moodle 2.7 release notes]]
Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.
* [[dev:Upgrade API|Upgrade API]]


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

Latest revision as of 11:17, 4 November 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.5 in Site administration > Server > Environment.

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

Notes:

  • You can only upgrade to Moodle 4.5 from Moodle 4.1.2 or later. If upgrading from earlier versions, you must upgrade to 4.1.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 4.5 version available for any plugins (including themes) 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

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

Possible issues that may affect you in Moodle 4.5

AI subsystem

Moodle 4.5 includes an AI subsystem, a new feature which is the foundation for integrating AI tools into Moodle LMS. Any open source or commercial large language model (LLM) can be supported via Provider plugins. The initial release includes plugins for OpenAI and Azure (which may also function with compatible LLMs), with more providers on the roadmap for future development. For details, see AI subsystem.

Course subsections

In Moodle 4.5, teachers can organise their course content into subsections. To enable this feature, you need to enable Subsection in Site administration > Plugins > Manage activities.

Screen recording

In Moodle 4.5, an additional RecordRTC recording type is available - Screen. You can enable it in Site administration > Plugins > RecordRTC. In addition to the screen recording time limit, you can set the video output resolution size and whether to allow pausing.

New notifications

Moodle 4.5 includes the following notifications for students:

  • Assignment due in 7 days
  • Upcoming assignment due (48 hours before the due date)
  • Assignment overdue
  • Quiz opening soon (48 hours before the open date)

Assignment default grade type and scale

An admin can set the default grade type and scale for all new assignments in Site administration > Plugins > Assignment settings.

Cohorts bulk deletion

Cohorts may be selected and deleted in bulk in Site administration > Users > Cohorts.

Site registration

When registering your site, you have the option to specify your organisation type.

Plugin usage data and AI usage stats are also collected and sent to Moodle each time your site registration is updated.

Option to not show the manual login form

If all users on the site use an authentication method such as OAuth 2 that doesn't require them to enter a username and password, you can hide the manual login form by unticking the box 'Display manual login form' in Site administration > Plugins > Manage authentication.


See also the list of upgrade_notes-labelled issues and ui_change-labelled issues also the Moodle 4.5 developer update.

New capabilities in Moodle 4.5

  • aiplacement/courseassist:summarise_text
  • aiplacement/editor:generate_image
  • aiplacement/editor:generate_text
  • mod/bigbluebuttonbn:seepresentation
  • mod/subsection:addinstance
  • moodle/ai:acceptpolicy
  • moodle/ai:fetchanyuserpolicystatus
  • moodle/ai:fetchpolicy
  • moodle/contentbank:changelockedcustomfields
  • moodle/contentbank:configurecustomfields
  • moodle/course:editcoursewelcomemessage
  • moodle/user:viewprofilepictures
  • quizaccess/seb:manage_seb_configuremanually
  • quizaccess/seb:manage_seb_usesebclientconfig
  • tiny/recordrtc:recordscreen

Moodle 4.1, 4.2, 4.3 and 4.4 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.