--- UPGRADE.txt 2010-05-27 04:51:01.000000000 +0900 +++ UPGRADE.txt 2010-08-28 02:22:21.944937144 +0900 @@ -1,110 +1,122 @@ -// $Id: UPGRADE.txt,v 1.22 2010/05/26 19:51:01 dries Exp $ - -UPGRADING ---------- - -Prior to upgrading, you should ensure that: - - * Your system meets or exceeds Drupal's minimum requirements as shown at - http://drupal.org/requirements. - * You have a backup of all your relevant data (#1). - * Custom and contributed modules have been checked for compatibility (#11). - * Custom and contributed themes have been checked for compatibility (#11). - * You have read through this entire document. - -Let's begin! - -1. Back up your Drupal database and site root directory. Be especially sure - to back up your "sites" directory which contains your configuration file, - added modules and themes, and your site's uploaded files. If other files - have modifications, such as .htaccess or robots.txt, back those up as well. - - Note: for a single site setup, the configuration file is the "settings.php" - file located at sites/default/settings.php. The default.settings.php file - contains a clean copy for restoration purposes, if required. - - For multisite configurations, the configuration file is located in a - structure like the following: - - sites/default/settings.php - sites/example.com/settings.php - sites/sub.example.com/settings.php - sites/sub.example.com.path/settings.php - - More information on multisite configuration is located in INSTALL.txt. - -2. If possible, log on either as a user with the "Administer software updates" - permission or as the user with user ID 1, which is the first account - created (also known as the site maintenance account). Only these accounts - will be able to automatically access update.php in step #10. There are - special instructions in step #10 if you are unable to log on as one of - these users. Do not close your browser until the final step is complete. - -3. Place the site in "Offline" mode, to let the database updates run without - interruption and avoid displaying errors to end users of the site. This - option is at http://www.example.com/?q=admin/config/development/maintenance - (replace www.example.com with your installation's domain name and path). - -4. If using a custom or contributed theme, switch to Garland. - -5. Disable all custom and contributed modules. This includes any modules that - are not listed under 'Core - required' or 'Core - optional' on - http://www.example.com/?q=admin/build/modules (replace www.example.com with - your installation's domain name and path). - -6. Remove all old files and directories from the Drupal installation directory. - -7. Unpack the new files and directories into the Drupal installation directory. - -8. Copy your backed up "files" and "sites" directories to the Drupal - installation directory. If other system files such as .htaccess or - robots.txt were customized, re-create the modifications in the new - versions of the files using the backups taken in step #1. - -9. Verify the new configuration file to make sure it has correct information. - -10. Run update.php by visiting http://www.example.com/update.php (replace - www.example.com with your Drupal installation's domain name and path). This - step will update the core database tables to the new Drupal installation. - - Note: if you are unable to access update.php do the following: - - - Open your settings.php with a text editor. - - - There is a line that says $update_free_access = FALSE; - Change it to $update_free_access = TRUE; - - - Once update.php is done, you must change the settings.php file - back to its original form with $update_free_access = FALSE; - -11. Ensure that the versions of all custom and contributed modules match the - new Drupal version to which you have updated. For a major update, such as - from 5.x to 6.x, modules from previous versions will not be compatible - and updated versions will be required. - - - For contributed modules, check http://drupal.org/project/modules - for the version of a module matching your version of Drupal. - - - For custom modules, review http://drupal.org/update/modules to - ensure that a custom module is compatible with the current version. - -12. Re-enable custom and contributed modules and re-run update.php - to update custom and contributed database tables. - -13. Return the site to its original theme (if you switched to a core theme in - step #4). If your site uses a custom or contributed theme, make sure it is - compatible with your version of Drupal. - - - For contributed themes, check http://drupal.org/project/themes - for the version of a theme matching your version of Drupal. - - - For custom themes, review http://drupal.org/update/theme to ensure - that a custom theme is compatible with the current version. - -14. Finally, return your site to "Online" mode so your visitors may resume - browsing. As in step #3, this option is available in your administration - screens at http://www.example.com/?q=admin/config/development/maintenance - (replace www.example.com with your installation's domain name and path). - -For more information on upgrading visit -the Drupal handbook at http://drupal.org/upgrade +// $Id: UPGRADE.txt,v 1.24 2010/08/11 01:06:44 dries Exp $ + +UPGRADING +--------- + +Prior to upgrading, you should ensure that: + +* Your system meets or exceeds Drupal's minimum requirements as shown at + http://drupal.org/requirements. +* You have a backup of all your relevant data (#1). +* Custom and contributed modules have been checked for compatibility (#11). +* Custom and contributed themes have been checked for compatibility (#11). +* You have read through this entire document. + +Let's begin! + +1. Back up your Drupal database and site root directory. Be especially sure +to back up your "sites/default" directory which contains your configuration file, +and your site's uploaded files. If other files have modifications, such as +.htaccess or robots.txt, back those up as well. + +Note: for a single site setup, the configuration file is the "settings.php" +file located at sites/default/settings.php. The default.settings.php file +contains a clean copy for restoration purposes, if required. + +For multi-site configurations, the configuration file is located in a +structure like the following: + + sites/default/settings.php + sites/example.com/settings.php + sites/sub.example.com/settings.php + sites/sub.example.com.path/settings.php + +More information on multi-site configuration is located in INSTALL.txt. + +2. If possible, log on either as a user with the "Administer software updates" +permission or as the user with user ID 1, which is the first account +created (also known as the site maintenance account). Only these accounts +will be able to automatically access update.php in step #10. There are +special instructions in step #10 if you are unable to log on as one of +these users. Do not close your browser until the final step is complete. + +3. Place the site in "Offline" mode, to let the database updates run without +interruption and avoid displaying errors to end users of the site. This +option is at http://www.example.com/?q=admin/config/development/maintenance +(replace www.example.com with your installation's domain name and path). + +4. If using a custom or contributed theme, switch to a core theme such as +Bartik or Garland. + +5. Disable all custom and contributed modules. This includes any modules that +are not listed under 'Core - required' or 'Core - optional' on +http://www.example.com/?q=admin/build/modules (replace www.example.com with +your installation's domain name and path). + +6. Remove all files and directories from the Drupal site root directory. + +7. Unpack the new files and directories into the Drupal site root directory. + +8. Copy your backed up "sites/default" to the Drupal site root directory. If +other system files such as .htaccess or robots.txt were customized, re-create +the modifications in the new versions of the files using the backups taken in +step #1. + +Note: If upgrading a multi-site create directories for each site and restore each +site's configuration file from your backup. + +9. Verify the new sites/default/settings.php to make sure it has correct information. + +Note: If upgrading a multi-site each site's settings.php should be verified. + +10. Run update.php by visiting http://www.example.com/update.php (replace +www.example.com with your Drupal installation's domain name and path). This +step will update the core database tables to the new Drupal installation. + +Warning: No Drupal 6 contributed modules or themes should be present in any of your +sites directories. As they will not be able to be enabled. + +Note: if you are unable to access update.php do the following: + + - Open and edit your settings.php with a text editor. + + - There is a line that says $update_free_access = FALSE; + Change it to $update_free_access = TRUE; + + - Once update.php is done, you must change the settings.php file + back to its original form with $update_free_access = FALSE; + +11. Ensure that the versions of all custom and contributed modules match the +new Drupal version to which you have updated. For a major update, such as +from 5.x to 6.x, modules from previous versions will not be compatible +and updated versions will be required. + + - For contributed modules, check http://drupal.org/project/modules + for the version of a module matching your version of Drupal. + + - For contributed modules that have been moved to core please check the upgrade + process here http://drupal.org/node/895314. + + - For custom modules, review http://drupal.org/update/modules to + ensure that a custom module is compatible with the current version. + +12. Re-enable custom and contributed modules and re-run update.php +to update custom and contributed database tables. + +13. Return the site to its original theme (if you switched to a core theme in +step #4). If your site uses a custom or contributed theme, make sure it is +compatible with your version of Drupal. + + - For contributed themes, check http://drupal.org/project/themes + for the version of a theme matching your version of Drupal. + + - For custom themes, review http://drupal.org/update/theme to ensure + that a custom theme is compatible with the current version. + +14. Finally, return your site to "Online" mode so your visitors may resume +browsing. As in step #3, this option is available in your administration +screens at http://www.example.com/?q=admin/config/development/maintenance +(replace www.example.com with your installation's domain name and path). + +For more information on upgrading visit +the Drupal handbook at http://drupal.org/upgrade