Note: You are currently viewing documentation for Moodle 2.2. Up-to-date documentation for the latest stable version is available here: Moodle migration.

Moodle migration: Difference between revisions

From MoodleDocs
m (→‎Migrating a complete Moodle site: Added maintenance mode)
 
(35 intermediate revisions by 16 users not shown)
Line 1: Line 1:
There are times when you will need to move your Moodle site from one server to another. This is known as migrating your Moodle site and occurs when you need to change the <code>$CFG->wwwroot</code> value in your Moodle ''config.php''. The process is divided into the following tasks:
{{Installing Moodle}}
There may be times when you need to move your Moodle site from one server to another. For example, moving a Moodle site from shared hosting service's server to a dedicated server.


:''Tip:'' One common migration mistake is to forget to update the details in the migrated Moodle's ''[[Configuration file|config.php]]'' file.


==Upgrade Moodle==
==Migrating a complete Moodle site - method 1==
 
This involves moving a whole site from one server to another. If you are changing the domain/IP address to the new server you need to do these steps:
* '''Maintenance mode'''. Place your current Moodle site in maintenance mode to prevent any further additions to the Moodle database. Don't let administrators login during the migration as they are not affected by the maintenance mode setting.
* '''Backup your current Moodle database'''. Do this by following the instructions in the [[Upgrading | upgrading Moodle]] or [[Site backup]] page. This will give you a text file containing the mysql dump.
* '''Copy the Moodle software'''. You will need to copy the Moodle code itself to the new server - upgrade the code to the latest version if you can.
* '''Change <code>$CFG->wwwroot</code>'''. In your (possibly new) Moodle directory, change the <code>$CFG->wwwroot</code> variable in the ''config.php'' file for the new server.
* '''Copy data directory contents (moodledata)'''. Copy the contents of your data directory (check for the value in <code>$CFG->dataroot</code>) to the new server.
* '''Review moodledata permissions'''. Check also that permissions remain the same on the new dataroot folder and change the value if you have changed its location on the new server.
* '''Change your Moodle URL'''. If you have a new URL, you'll need to change this in the Moodle database to the new server. This is needed as links to pictures, files, etc are stored as absolute links and will reference the old <code>$CFG->wwwroot</code> value. So when loading a mysql backup dump of the Moodle server into mysql on another server the absolute referenced links will be broken. There are two methods of doing this:
:(a) The first method changes the Moodle URL using the Moodle script ''replace.php'' while your site is currently running just before you backup the Moodle database. Point your browser to <nowiki>yourserver.com/admin/tool/replace/index.php</nowiki> or in older versions <nowiki>http://yourserver.com/admin/replace.php</nowiki>
 
:Enter the url for your old server (<nowiki>http://oldserver.com/</nowiki>) and new server (<nowiki>http://newserver.com/</nowiki>) and it will fix the mysql tables. You will also need to clear out any cached links by restarting your webserver. Now, take another backup of the Moodle database - this one will have the correct URLs.
 
:(b) The second method is to backup the Moodle database first, then use the search and replace feature of your text editor (or use a unix tool like sed) to replace the old URL with the new one in the mysql backup file. Here is an example sed command:
 
: <code>#sed -e 's/oldserver.com/newserver.com/g' oldmysqldump.sql > newmysqldump.sql</code>
 
:''NOTE:'' This second method will not replace text in blocks because they are stored base64 encoded in the database, so any links in blocks will not be fixed. Therefore you should consider using the replace tool after you migrate if you use this second method.
 
:''TIP:'' You may want to check the mysqldump file to see how the old server was referenced.
:After changing the URL, restore the mysql database
* '''Test the migration'''. To test the new install, access Moodle using your browser and the new server's URL. When you have tested that a number of links in the courses work, take the new Moodle site out of maintenance mode.
'''See also''': Forum discussion on [http://moodle.org/mod/forum/discuss.php?d=85812 migrating Moodle's data directory on a Windows system].
 
==Migrating a complete Moodle site - method 2==
 
Do you have shell access on both servers? If so, the following method is a very quick and efficient method to migrate a Unix based site.
 
It is also useful for creating snapshots or test sites.
*Set up a new empty database on the '''new''' server.
*Place your existing Moodle site into maintenance mode.
*Login to shell on the '''old''' existing server.
*Use rsync to copy '''moodledata''' and '''public_html''' (or whatever directory your Moodle install is in) to the new server - execute (replacing caps with your details; SOURCE = the directory you want to copy) for each directory:
::<code>rsync -av -e ssh SOURCE/ USERNAME@NEW_SERVER.COM:/PATH/TO/DESTINATION/</code>
*Dump existing database and move and import into database on new server by executing:
::<code>mysqldump --allow-keywords --opt -uMySQL_USERNAME -pPASSWORD DATABASE | ssh USER@DOMAIN "mysql -uMySQL_USERNAME -pPASSWORD DATABASE"</code>
*On the '''new server''', update '''config.php''' with relevant details.
*To fix any internal Moodle links, login to your "new" Moodle install on your new server and use the [[Search and replace]] admin tool to search and replace the old uri for the new.
*Make sure everything is working.</code>
 
Takes about 15 minutes.
 
When you are happy all has gone well, set up redirects/make DNS changes if required, take new site out of maintenance mode and "switch off" old site.
 
==Other points to consider==
===Changed URL image links set to old site===
So you built your Moodle Server with a <nowiki>http//192.168.0.1/Moodle</nowiki> address. Then you changed the URL for your site to <nowiki>http://OurMoodle.org/Moodle</nowiki>. You changed the Moodle config file so the CFGs point to the new paths,  but your images still point to the old url. 
 
One simple, quick solution is to use the Replace script in Moodle to fix this. Login as admin and enter  <nowiki>http://OurMoodle.org/admin/tool/replace/index.php</nowiki> in your browser address bar (or  <nowiki>http://OurMoodle.com/admin/replace.php</nowiki> in older versions). Use the two form boxes to change <nowiki>http://192.168.0.1/</nowiki> to <nowiki>http://OurMoodle.org/</nowiki>.
 
This replace function is only supported on Moodle sites that run on MySQL or Postgres databases. See MDL-26597.
 
===Upgrade Moodle===


When migrating Moodle it is often a good idea to take the opportunity to upgrade Moodle to the latest version. If you manage your own server, follow the instructions in [[Upgrading | upgrading moodle]], otherwise check if your host can upgrade for you.
When migrating Moodle it is often a good idea to take the opportunity to upgrade Moodle to the latest version. If you manage your own server, follow the instructions in [[Upgrading | upgrading moodle]], otherwise check if your host can upgrade for you.


==Restore a single course==
===Restoring a single course across servers===


You may need to restore a single course from an old site to a new one, especially if you are testing the migration. When restoring a Moodle backup file to Moodle on a different server than the one used to create the backup, the absolute referenced links to files maybe broken. To fix this problem open the ''backup-coursename.zip'' file and edit the ''moodle.xml'' file replacing links with <code>$@FILEPHP@$</code>.
You may need to restore a single course from an old site to a new one, especially if you are testing the migration. When restoring a Moodle backup file to Moodle on a different server than the one used to create the backup, the absolute referenced links to files maybe broken. To fix this problem open the ''backup-coursename.zip'' file and edit the ''moodle.xml'' file replacing links with <code>$@FILEPHP@$</code>.
Line 14: Line 69:
When the file is restored it will use the correct file path for the new course.
When the file is restored it will use the correct file path for the new course.


==Migrating a complete Moodle site==
===DNS & Masquerading changes===


This involves moving a whole site from one server to another. If you are changing the domain/IP address to the new server you need to do these steps:
You may have had to change the DNS entries for the new Moodle site. If you have done so, it will take some time for the changes to replicate, so be patient. If your server is located behind a firewall, you may also have to change your firewall rules to allow access to the new server. See the [[Masquerading | masquerading docs]].
* Place your current Moodle site in maintenance mode to prevent any further additions to the Moodle database. Don't let administrators login during the migration as they are not affected by the maintenance mode setting.
* Backup your current Moodle database by following the instructions in the [[Upgrading | upgrading Moodle]] page. This will give you a text file containing the mysql dump.
* Copy the Moodle software code itself to the new server - upgrade the code to the latest version if you can.
* In your (possibly new) Moodle directory, change the <code>$CFG->wwwroot</code> variable in the ''config.php'' file for the new server.
* Copy the contents of your data directory (check for the value in <code>$CFG->dataroot</code>) to the new server. Check also that permissions remain the same on the new dataroot folder and change the value if you have changed its location on the new server.
* Copy your current Moodle database to the new server. You may need to zip the file to reduce the time taken for this process.
* Change your Moodle database on the new server. This is needed as links to pictures, files, etc are stored as absolute links and will reference the old <code>$CFG->wwwroot</code> value. So when loading a mysql backup dump of the Moodle server into mysql on another server the absolute referenced links will be broken. This can be most easily fixed with the program ''replace.php''. After uploading the mysql dump file point your browser to <nowiki>http://yourserver.com/admin/replace.php</nowiki>


:Enter the url for your old server (<nowiki>http://oldserver.com/</nowiki>) and new server (<nowiki>http://newserver.com/</nowiki>) and it will fix the mysql tables. You will also need to clear out any cached links by restarting your webserver.
===Internal and external access===


'''Warning''': Before using ''replace.php'' make a backup of your Moodle database and test this this backup is OK by restoring it to a test install (say on a PC).
If you have a set up where your Moodle site can be accessed via a network and via the internet, ensure you check that the new site can be accessed internally and externally.


An alternative is to use the search and replace feature of your text editor (or use a unix tool like sed) to replace the old URL with the new one in the mysql backup file. Once you have done this, restore the database.
==See also==
#sed -e 's/oldserver.com/newserver.com/' mysqldump.sql


'''Tip''': You may want to check the mysqldump file to see how the old server was referenced.
* [[Site backup]]
* To test the new install, access Moodle using your browser and the new server's URL. When you have tested that a number of links in the courses work, take the new Moodle site out of maintenance mode.
* [[Site restore]]
* [[Backup and restore FAQ]]
* [http://www.youtube.com/watch?v=sFCXvRx20Bs Moving Moodle to a new server video]
* [http://tracker.moodle.org/browse/MDL-35099 Convert hidden search/replace script into a proper core admin tool] Tracker issue


==DNS changes==
Using Moodle forum discussions:
 
* [http://moodle.org/mod/forum/discuss.php?d=62959 Changing Moodle URL]  
You may have had to change the DNS entries for the new Moodle site. If you have done so, it will take some time for the changes to replicate, so be patient.
* [http://moodle.org/mod/forum/discuss.php?d=57477 Changing site address]  
 
* [http://moodle.org/mod/forum/discuss.php?d=76704 Upgrading whilst migrating]  
==Internal and external access==
* [http://moodle.org/mod/forum/discuss.php?d=65450 Internal and external access]
 
* [http://moodle.org/mod/forum/discuss.php?d=111807 Migrated Moodle to New Server But Can't Login]
Lastly, check that the new site can be accessed internally and externally. 
* [http://moodle.org/mod/forum/discuss.php?d=228436 Replace script returns "Service Unavailable"]
 
==See also==
* [http://moodle.org/mod/forum/discuss.php?d=62959 Changing Moodle URL] forum discussion
* [http://moodle.org/mod/forum/discuss.php?d=57477 Changing site address] forum discussion
* [http://moodle.org/mod/forum/discuss.php?d=76704 Upgrading whilst migrating] forum discussion


[[Category:Installation]]
[[fr:Migration de Moodle]]
[[ja:Moodle移行]]
[[de:Moodle-Migration]]

Latest revision as of 07:20, 15 May 2013

There may be times when you need to move your Moodle site from one server to another. For example, moving a Moodle site from shared hosting service's server to a dedicated server.

Tip: One common migration mistake is to forget to update the details in the migrated Moodle's config.php file.

Migrating a complete Moodle site - method 1

This involves moving a whole site from one server to another. If you are changing the domain/IP address to the new server you need to do these steps:

  • Maintenance mode. Place your current Moodle site in maintenance mode to prevent any further additions to the Moodle database. Don't let administrators login during the migration as they are not affected by the maintenance mode setting.
  • Backup your current Moodle database. Do this by following the instructions in the upgrading Moodle or Site backup page. This will give you a text file containing the mysql dump.
  • Copy the Moodle software. You will need to copy the Moodle code itself to the new server - upgrade the code to the latest version if you can.
  • Change $CFG->wwwroot. In your (possibly new) Moodle directory, change the $CFG->wwwroot variable in the config.php file for the new server.
  • Copy data directory contents (moodledata). Copy the contents of your data directory (check for the value in $CFG->dataroot) to the new server.
  • Review moodledata permissions. Check also that permissions remain the same on the new dataroot folder and change the value if you have changed its location on the new server.
  • Change your Moodle URL. If you have a new URL, you'll need to change this in the Moodle database to the new server. This is needed as links to pictures, files, etc are stored as absolute links and will reference the old $CFG->wwwroot value. So when loading a mysql backup dump of the Moodle server into mysql on another server the absolute referenced links will be broken. There are two methods of doing this:
(a) The first method changes the Moodle URL using the Moodle script replace.php while your site is currently running just before you backup the Moodle database. Point your browser to yourserver.com/admin/tool/replace/index.php or in older versions http://yourserver.com/admin/replace.php
Enter the url for your old server (http://oldserver.com/) and new server (http://newserver.com/) and it will fix the mysql tables. You will also need to clear out any cached links by restarting your webserver. Now, take another backup of the Moodle database - this one will have the correct URLs.
(b) The second method is to backup the Moodle database first, then use the search and replace feature of your text editor (or use a unix tool like sed) to replace the old URL with the new one in the mysql backup file. Here is an example sed command:
#sed -e 's/oldserver.com/newserver.com/g' oldmysqldump.sql > newmysqldump.sql
NOTE: This second method will not replace text in blocks because they are stored base64 encoded in the database, so any links in blocks will not be fixed. Therefore you should consider using the replace tool after you migrate if you use this second method.
TIP: You may want to check the mysqldump file to see how the old server was referenced.
After changing the URL, restore the mysql database
  • Test the migration. To test the new install, access Moodle using your browser and the new server's URL. When you have tested that a number of links in the courses work, take the new Moodle site out of maintenance mode.

See also: Forum discussion on migrating Moodle's data directory on a Windows system.

Migrating a complete Moodle site - method 2

Do you have shell access on both servers? If so, the following method is a very quick and efficient method to migrate a Unix based site.

It is also useful for creating snapshots or test sites.

  • Set up a new empty database on the new server.
  • Place your existing Moodle site into maintenance mode.
  • Login to shell on the old existing server.
  • Use rsync to copy moodledata and public_html (or whatever directory your Moodle install is in) to the new server - execute (replacing caps with your details; SOURCE = the directory you want to copy) for each directory:
rsync -av -e ssh SOURCE/ USERNAME@NEW_SERVER.COM:/PATH/TO/DESTINATION/
  • Dump existing database and move and import into database on new server by executing:
mysqldump --allow-keywords --opt -uMySQL_USERNAME -pPASSWORD DATABASE | ssh USER@DOMAIN "mysql -uMySQL_USERNAME -pPASSWORD DATABASE"
  • On the new server, update config.php with relevant details.
  • To fix any internal Moodle links, login to your "new" Moodle install on your new server and use the Search and replace admin tool to search and replace the old uri for the new.
  • Make sure everything is working.

Takes about 15 minutes.

When you are happy all has gone well, set up redirects/make DNS changes if required, take new site out of maintenance mode and "switch off" old site.

Other points to consider

Changed URL image links set to old site

So you built your Moodle Server with a http//192.168.0.1/Moodle address. Then you changed the URL for your site to http://OurMoodle.org/Moodle. You changed the Moodle config file so the CFGs point to the new paths, but your images still point to the old url.

One simple, quick solution is to use the Replace script in Moodle to fix this. Login as admin and enter http://OurMoodle.org/admin/tool/replace/index.php in your browser address bar (or http://OurMoodle.com/admin/replace.php in older versions). Use the two form boxes to change http://192.168.0.1/ to http://OurMoodle.org/.

This replace function is only supported on Moodle sites that run on MySQL or Postgres databases. See MDL-26597.

Upgrade Moodle

When migrating Moodle it is often a good idea to take the opportunity to upgrade Moodle to the latest version. If you manage your own server, follow the instructions in upgrading moodle, otherwise check if your host can upgrade for you.

Restoring a single course across servers

You may need to restore a single course from an old site to a new one, especially if you are testing the migration. When restoring a Moodle backup file to Moodle on a different server than the one used to create the backup, the absolute referenced links to files maybe broken. To fix this problem open the backup-coursename.zip file and edit the moodle.xml file replacing links with $@FILEPHP@$.

For example, replace http://yourserver.com/file.php/243/ with $@FILEPHP@$

When the file is restored it will use the correct file path for the new course.

DNS & Masquerading changes

You may have had to change the DNS entries for the new Moodle site. If you have done so, it will take some time for the changes to replicate, so be patient. If your server is located behind a firewall, you may also have to change your firewall rules to allow access to the new server. See the masquerading docs.

Internal and external access

If you have a set up where your Moodle site can be accessed via a network and via the internet, ensure you check that the new site can be accessed internally and externally.

See also

Using Moodle forum discussions: