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

Upgrading: Difference between revisions

From MoodleDocs
(→‎Finishing the upgrade: note re purging all caches as advised in https://moodle.org/mod/forum/discuss.php?d=220721)
(page update)
Line 4: Line 4:
==Check the requirements==
==Check the requirements==


Check that your server meets all requirements for 2.4 in ''Settings > Site administration > Server > [[Environment]]''.
Check that your server meets all requirements for 2.5 in ''Settings > Site administration > Server > [[Environment]]''.


Note: You can only upgrade to Moodle 2.4 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.
Note: You can only upgrade to Moodle 2.5 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.


==Check for plugin updates==
==Check for plugin updates==


Check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a 2.4 version available for any contributed/custom plugins (including themes) that you have previously installed on your site. If so, download the plugin code and copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).
Check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a 2.5 version available for any contributed/custom plugins (including themes) that you have previously installed on your site. If so, download the plugin code and 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.
Line 45: Line 45:
====Linux====
====Linux====
  mv moodle moodle.backup
  mv moodle moodle.backup
  tar xvzf moodle-2.4.tgz
  tar xvzf moodle-2.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'''):
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 67: Line 67:
===Command line upgrade===
===Command line upgrade===


On Linux servers, Moodle 2.4 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.
On Linux servers, Moodle 2.5 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 83: Line 83:
==After upgrading==
==After upgrading==


The config.php file from your 2.2 or 2.3 installation should work fine but if you take a look at config-dist.php that came with Moodle 2.4 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.4 config-dist.php.
The config.php file from your 2.2, 2.3 or 2.4 installation should work fine but if you take a look at config-dist.php that came with Moodle 2.5 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.5 config-dist.php.


==Possible issues that may affect you in Moodle 2.4==
==Possible issues that may affect you in Moodle 2.5==


=== Block capabilities undefined ===
''Information coming soon...''


If you have any contributed/custom blocks installed, after upgrading you may get a debugging message warning you that a block capability has not been defined. For example
=== Moodle 2.3 and 2.4 improvements ===


The block <blockname> does not define the standard capability block/<blockname>:myaddinstance
If you are upgrading to Moodle 2.5 from 2.2 or 2.3, please see the section 'Possible issues that may affect you' in the documentation [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3] and [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4].
 
In Moodle 2.4, ''addinstance'' and ''myaddinstance'' capabilities were added for [[Managing blocks|controlling the use of blocks]]. See the section 'Ready, Set, Go!' in the [[:dev:Blocks|Blocks dev docs]] for information on defining these capabilities for any contributed blocks.
 
=== Moodle 2.3 improvements ===
 
If you are upgrading to Moodle 2.4 from 2.2, please see the section 'Possible issues that may affect you in Moodle 2.3' in the [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3 documentation].


==See also==
==See also==


* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]  
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]  
* [[dev:Moodle 2.4 release notes|Moodle 2.4 release notes]]
* [[dev:Moodle 2.5 release notes|Moodle 2.5 release notes]]
* [[dev:Upgrade API|Upgrade API]]
* [[dev:Upgrade API|Upgrade API]]



Revision as of 11:47, 24 April 2013

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

Check the requirements

Check that your server meets all requirements for 2.5 in Settings > Site administration > Server > Environment.

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

Check for plugin updates

Check in the Moodle Plugins directory whether there is a 2.5 version available for any contributed/custom plugins (including themes) that you have previously installed on your site. If so, download the plugin code and 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.

Note: If you have any contributed blocks installed, please see below for info about block capabilities undefined.

Before you upgrade your site for real

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

Backup important data

There are three areas that should be backed up before any upgrade:

  1. Moodle software (For example, everything in server/htdocs/moodle)
  2. Moodle uploaded files (For example, server/moodledata)
  3. Moodle database (For example, the SQL or Postgres database)

See Site backup for more specific information.

Put your site into maintenance mode

Before you begin upgrading your site, you should put it into maintenance mode to stop any non-admin users from logging in.

Install the new Moodle software

Standard install package

  1. Move your old Moodle software program files to another location. Do NOT copy new files over the old files.
  2. Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
  3. Copy your old config.php file back to the new Moodle directory.
  4. As mentioned above, if you had installed any custom plugins on your site you should add them to the new code. 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.

Linux

mv moodle moodle.backup
tar xvzf moodle-2.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.

If you use cron, take care that cron.php is executeable and uses the correct php command:

chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')

if necessary.

Using Git

You can use Git for updating or upgrading your Moodle. See Git for Administrators for details.

Command line upgrade

On Linux servers, Moodle 2.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.

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

After upgrading

The config.php file from your 2.2, 2.3 or 2.4 installation should work fine but if you take a look at config-dist.php that came with Moodle 2.5 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.5 config-dist.php.

Possible issues that may affect you in Moodle 2.5

Information coming soon...

Moodle 2.3 and 2.4 improvements

If you are upgrading to Moodle 2.5 from 2.2 or 2.3, please see the section 'Possible issues that may affect you' in the documentation Upgrading to Moodle 2.3 and Upgrading to Moodle 2.4.

See also