This page explains in detail how to upgrade Moodle. For a summary of the process, see Upgrade overview.
- 1 Check the requirements
- 2 Checking database schema - old sites
- 3 Contributed plugins
- 4 Before you upgrade your site for real
- 5 Backup important data
- 6 Put your Site into maintenance mode
- 7 Install the new Moodle software
- 8 Finishing the upgrade
- 9 After upgrading
- 10 Possible issues that may affect you in Moodle 2.4
- 11 See also
Check the requirements
Check that your server meets all requirements for 2.4 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 upgrade to 2.2 as a first step.
Checking database schema - old sites
If your Moodle site has been upgraded through many prior versions it is possible that there will be some problems with the database schema (compared to a fresh 2.4 installation). This may cause the upgrade to fail. If your site started life prior to Moodle 2.0 it is a very good idea to check and correct the database schema before upgrading. See Verify Database Schema. You should also run the database integrity checks in the XMLDB editor.
Any contributed/custom plugins (including themes) that you have previously installed on your site will also need to be replaced with a version suitable for Moodle 2.4 before upgrading your Moodle installation.
- Check in the Moodle Plugins directory for a Moodle 2.4 version of the plugin and copy it to the appropriate location in your Moodle code.
- The upgrade of the plugin will happen as part of the Moodle upgrade process.
- If there is not a Moodle 2.4 version of the plugin available, you will need to uninstall the plugin before upgrading, otherwise the Moodle upgrade will fail.
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:
- Moodle software (For example, everything in server/htdocs/moodle)
- Moodle uploaded files (For example, server/moodledata)
- 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
- 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 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.
mv moodle moodle.backup tar xvzf moodle-2.4.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')
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. See Git for Administrators for details.
Command line upgrade
On Linux servers, Moodle 2.4 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!
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.
Possible issues that may affect you in Moodle 2.4
Block capabilities undefined
You may get a debugging message warning you that a capability has not been defined for a custom block. For example:
The block <blockname> does not define the standard capability block/<blockname>:myaddinstance line 597 of /blocks/moodleblock.class.php: call to debugging() line 570 of /blocks/moodleblock.class.php: call to block_base->has_add_block_capability() line 236 of /lib/blocklib.php: call to block_base->user_can_addto() line 1834 of /lib/blocklib.php: call to block_manager->get_addable_blocks() line 1007 of /lib/blocklib.php: call to block_add_block_ui() line 353 of /lib/blocklib.php: call to block_manager->ensure_content_created() line 6 of /theme/base/layout/general.php: call to block_manager->region_has_content() line 804 of /lib/outputrenderers.php: call to include() line 734 of /lib/outputrenderers.php: call to core_renderer->render_page_layout() line 74 of /user/files.php: call to core_renderer->header()
Moodle 2.4 onwards introduced the capabilities addinstance and myaddinstance for core blocks. They were introduced so that it was possible to control the use of individual blocks. Please see the section 'Ready, Set, Go!' in the Blocks dev docs for more information.
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 Upgrading to Moodle 2.3 documentation.