Difference between revisions of "Upgrading"

Jump to: navigation, search
(Contributed plugins (info copied from https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 ))
(version edits)
Line 4: Line 4:
 
==Check the requirements==
 
==Check the requirements==
  
Check that your server meets all requirements for 2.3 in ''Settings > Site administration > Server > [[Environment]]''.
+
Check that your server meets all requirements for 2.4 in ''Settings > Site administration > Server > [[Environment]]''.
  
Note: You can only upgrade to Moodle 2.3 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.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.
  
 
==Checking database schema - old sites==
 
==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.3 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.
+
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.
  
 
==Contributed plugins==
 
==Contributed plugins==
  
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.3 ''before'' upgrading your Moodle installation.
+
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 [http://moodle.org/plugins Moodle Plugins directory] for a Moodle 2.3 version of the plugin and copy it to the appropriate location in your Moodle code.
+
* Check in the [http://moodle.org/plugins 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.
 
* The upgrade of the plugin will happen as part of the Moodle upgrade process.
* If there is not a Moodle 2.3 version of the plugin available, you will need to [[Installing plugins|uninstall the plugin]] before upgrading, otherwise the Moodle upgrade will fail.
+
* If there is not a Moodle 2.4 version of the plugin available, you will need to [[Installing plugins|uninstall the plugin]] before upgrading, otherwise the Moodle upgrade will fail.
  
 
==Before you upgrade your site for real==
 
==Before you upgrade your site for real==
Line 82: Line 82:
 
==After upgrading==
 
==After upgrading==
  
The config.php file from your 2.2 installation should work fine but if you take a look at config-dist.php that came with Moodle 2.3 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.3 config-dist.php.
+
The config.php file from your 2.2 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.3 config-dist.php.
  
==Possible issues that may affect you in Moodle 2.3==
+
==Possible issues that may affect you in Moodle 2.4==
  
 
=== Two assignment modules ===
 
=== Two assignment modules ===
  
A new assignment module has been added in Moodle 2.3. The old assignment module is still available (renamed 'Assignments 2.2') and sites which have upgraded from previous versions will have both versions available.
+
A new assignment module was added in Moodle 2.3. The old assignment module is still available (renamed 'Assignments 2.2') and sites which have upgraded from previous versions will have both versions available.
  
 
It is recommended that admins upgrade all existing assignments to use the new assignment module as soon as possible, as described in [[Upgrade tool|Assignment upgrade tool]], then disable the old assignment module, to avoid the confusion of having two assignment modules.
 
It is recommended that admins upgrade all existing assignments to use the new assignment module as soon as possible, as described in [[Upgrade tool|Assignment upgrade tool]], then disable the old assignment module, to avoid the confusion of having two assignment modules.
Line 94: Line 94:
 
===Google registration required for Google Docs and Picasa plugins===
 
===Google registration required for Google Docs and Picasa plugins===
  
Due to a change in Google's service, Moodle 2.3 has switched to a more secure and more user-friendly system for communicating with Google called 'OAuth 2.0'. As a result, any Google Docs and Picasa plugins (the Google Docs and Picasa repositories and the Google Docs and Picasa portfolios) used previously on the site will be disabled when the site is upgraded.
+
Due to a change in Google's service, Moodle 2.3 onwards has switched to a more secure and more user-friendly system for communicating with Google called 'OAuth 2.0'. As a result, any Google Docs and Picasa plugins (the Google Docs and Picasa repositories and the Google Docs and Picasa portfolios) used previously on the site will be disabled when the site is upgraded.
  
 
To re-enable these plugins, an administrator must register their site with Google, as described in [[Google OAuth 2.0 setup]], and obtain a client ID and secret. The client ID and secret can then be used to configure all Google Docs and Picasa plugins.
 
To re-enable these plugins, an administrator must register their site with Google, as described in [[Google OAuth 2.0 setup]], and obtain a client ID and secret. The client ID and secret can then be used to configure all Google Docs and Picasa plugins.
 
===RTL theme fixes===
 
 
Moodle 2.3 includes many right-to-left (RTL) theme fixes (MDL-30337) and so sites using RTL languages, such as Arabic and Hebrew, are recommended to perform additional testing, particularly with any custom themes to ensure everything is working fine.
 
  
 
==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.3 release notes|Moodle 2.3 release notes]]
+
* [[dev:Moodle 2.4 release notes|Moodle 2.4 release notes]]
 
* [[dev:Upgrade API|Upgrade API]]
 
* [[dev:Upgrade API|Upgrade API]]
  

Revision as of 17:14, 6 November 2012

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

Contributed plugins

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:

  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 new the 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-1.1.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. 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.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.

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!

After upgrading

The config.php file from your 2.2 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.3 config-dist.php.

Possible issues that may affect you in Moodle 2.4

Two assignment modules

A new assignment module was added in Moodle 2.3. The old assignment module is still available (renamed 'Assignments 2.2') and sites which have upgraded from previous versions will have both versions available.

It is recommended that admins upgrade all existing assignments to use the new assignment module as soon as possible, as described in Assignment upgrade tool, then disable the old assignment module, to avoid the confusion of having two assignment modules.

Google registration required for Google Docs and Picasa plugins

Due to a change in Google's service, Moodle 2.3 onwards has switched to a more secure and more user-friendly system for communicating with Google called 'OAuth 2.0'. As a result, any Google Docs and Picasa plugins (the Google Docs and Picasa repositories and the Google Docs and Picasa portfolios) used previously on the site will be disabled when the site is upgraded.

To re-enable these plugins, an administrator must register their site with Google, as described in Google OAuth 2.0 setup, and obtain a client ID and secret. The client ID and secret can then be used to configure all Google Docs and Picasa plugins.

See also