| 
webmaster@1
 | 
     1 // $Id: UPGRADE.txt,v 1.12 2008/01/04 16:15:58 goba Exp $
 | 
| 
webmaster@1
 | 
     2 
 | 
| 
webmaster@1
 | 
     3 UPGRADING
 | 
| 
webmaster@1
 | 
     4 ---------
 | 
| 
webmaster@1
 | 
     5 
 | 
| 
webmaster@1
 | 
     6 Prior to upgrading, you should ensure that:
 | 
| 
webmaster@1
 | 
     7 
 | 
| 
webmaster@1
 | 
     8  * Your system meets or exceeds Drupal's minimum requirements as shown at
 | 
| 
webmaster@1
 | 
     9    http://drupal.org/requirements.
 | 
| 
webmaster@1
 | 
    10  * You have a backup of all your relevant data (#1).
 | 
| 
webmaster@1
 | 
    11  * Custom and contributed modules have been checked for compatibility (#11).
 | 
| 
webmaster@1
 | 
    12  * Custom and contributed themes have been checked for compatibility (#11).
 | 
| 
webmaster@1
 | 
    13  * You have read through this entire document.
 | 
| 
webmaster@1
 | 
    14 
 | 
| 
webmaster@1
 | 
    15 Let's begin!
 | 
| 
webmaster@1
 | 
    16 
 | 
| 
webmaster@1
 | 
    17 1.  Backup your database and Drupal directory - especially your "sites"
 | 
| 
webmaster@1
 | 
    18     directory which contains your configuration file and added modules and
 | 
| 
webmaster@1
 | 
    19     themes, any contributed or custom modules in your "modules" directory,
 | 
| 
webmaster@1
 | 
    20     and your "files" directory which contains uploaded files. If other files
 | 
| 
webmaster@1
 | 
    21     have modifications, such as .htaccess or robots.txt, those should be
 | 
| 
webmaster@1
 | 
    22     backed up as well.
 | 
| 
webmaster@1
 | 
    23 
 | 
| 
webmaster@1
 | 
    24     Note: for a single site setup, the configuration file is the "settings.php"
 | 
| 
webmaster@1
 | 
    25     file located at sites/default/settings.php. The default.settings.php file
 | 
| 
webmaster@1
 | 
    26     contains a clean copy for restoration purposes, if required.
 | 
| 
webmaster@1
 | 
    27 
 | 
| 
webmaster@1
 | 
    28     For multisite configurations, the configuration file is located in a
 | 
| 
webmaster@1
 | 
    29     structure like the following:
 | 
| 
webmaster@1
 | 
    30 
 | 
| 
webmaster@1
 | 
    31       sites/default/settings.php
 | 
| 
webmaster@1
 | 
    32       sites/example.com/settings.php
 | 
| 
webmaster@1
 | 
    33       sites/sub.example.com/settings.php
 | 
| 
webmaster@1
 | 
    34       sites/sub.example.com.path/settings.php
 | 
| 
webmaster@1
 | 
    35 
 | 
| 
webmaster@1
 | 
    36     More information on multisite configuration is located in INSTALL.txt.
 | 
| 
webmaster@1
 | 
    37 
 | 
| 
webmaster@1
 | 
    38 2.  If possible, log on as the user with user ID 1, which is the first account
 | 
| 
webmaster@1
 | 
    39     created and the main administrator account. User ID 1 will be able to
 | 
| 
webmaster@1
 | 
    40     automatically access update.php in step #10. There are special instructions
 | 
| 
webmaster@1
 | 
    41     in step #10 if you are unable to log on as user ID 1. Do not close your
 | 
| 
webmaster@1
 | 
    42     browser until the final step is complete.
 | 
| 
webmaster@1
 | 
    43 
 | 
| 
webmaster@1
 | 
    44 3.  Place the site in "Off-line" mode, to let the database updates run without
 | 
| 
webmaster@1
 | 
    45     interruption and avoid displaying errors to end users of the site. This
 | 
| 
webmaster@1
 | 
    46     option is at http://www.example.com/?q=admin/settings/site-maintenance
 | 
| 
webmaster@1
 | 
    47     (replace www.example.com with your installation's domain name and path).
 | 
| 
webmaster@1
 | 
    48 
 | 
| 
webmaster@1
 | 
    49 4.  If using a custom or contributed theme, switch
 | 
| 
webmaster@1
 | 
    50     to a core theme, such as Garland or Bluemarine.
 | 
| 
webmaster@1
 | 
    51 
 | 
| 
webmaster@1
 | 
    52 5.  Disable all custom and contributed modules.
 | 
| 
webmaster@1
 | 
    53 
 | 
| 
webmaster@1
 | 
    54 6.  Remove all old files and directories from the Drupal installation directory.
 | 
| 
webmaster@1
 | 
    55 
 | 
| 
webmaster@1
 | 
    56 7.  Unpack the new files and directories into the Drupal installation directory.
 | 
| 
webmaster@1
 | 
    57 
 | 
| 
webmaster@1
 | 
    58 8.  Copy your backed up "files" and "sites" directories to the Drupal
 | 
| 
webmaster@1
 | 
    59     installation directory. If other system files such as .htaccess or
 | 
| 
webmaster@1
 | 
    60     robots.txt were customized, re-create the modifications in the new
 | 
| 
webmaster@1
 | 
    61     versions of the files using the backups taken in step #1.
 | 
| 
webmaster@1
 | 
    62 
 | 
| 
webmaster@1
 | 
    63 9.  Verify the new configuration file to make sure it has correct information.
 | 
| 
webmaster@1
 | 
    64 
 | 
| 
webmaster@1
 | 
    65 10. Run update.php by visiting http://www.example.com/update.php (replace
 | 
| 
webmaster@1
 | 
    66     www.example.com with your Drupal installation's domain name and path). This
 | 
| 
webmaster@1
 | 
    67     step will update the core database tables to the new Drupal installation.
 | 
| 
webmaster@1
 | 
    68 
 | 
| 
webmaster@1
 | 
    69     Note: if you are unable to access update.php do the following:
 | 
| 
webmaster@1
 | 
    70 
 | 
| 
webmaster@1
 | 
    71       - Open your settings.php with a text editor.
 | 
| 
webmaster@1
 | 
    72 
 | 
| 
webmaster@1
 | 
    73       - There is a line that says $update_free_access = FALSE;
 | 
| 
webmaster@1
 | 
    74         Change it to $update_free_access = TRUE;
 | 
| 
webmaster@1
 | 
    75 
 | 
| 
webmaster@1
 | 
    76       - Once update.php is done, you must change the settings.php file
 | 
| 
webmaster@1
 | 
    77         back to its original form with $update_free_access = FALSE;
 | 
| 
webmaster@1
 | 
    78 
 | 
| 
webmaster@1
 | 
    79 11. Ensure that the versions of all custom and contributed modules match the
 | 
| 
webmaster@1
 | 
    80     new Drupal version to which you have updated. For a major update, such as
 | 
| 
webmaster@1
 | 
    81     from 5.x to 6.x, modules from previous versions will not be compatible
 | 
| 
webmaster@1
 | 
    82     and updated versions will be required.
 | 
| 
webmaster@1
 | 
    83 
 | 
| 
webmaster@1
 | 
    84       - For contributed modules, check http://drupal.org/project/modules
 | 
| 
webmaster@1
 | 
    85         for the version of a module matching your version of Drupal.
 | 
| 
webmaster@1
 | 
    86 
 | 
| 
webmaster@1
 | 
    87       - For custom modules, review http://drupal.org/update/modules to
 | 
| 
webmaster@1
 | 
    88         ensure that a custom module is compatible with the current version.
 | 
| 
webmaster@1
 | 
    89 
 | 
| 
webmaster@1
 | 
    90 12. Re-enable custom and contributed modules and re-run update.php
 | 
| 
webmaster@1
 | 
    91     to update custom and contributed database tables.
 | 
| 
webmaster@1
 | 
    92 
 | 
| 
webmaster@1
 | 
    93 13. Return the site to its original theme (if you switched to a core
 | 
| 
webmaster@1
 | 
    94     theme like Garland or Bluemarine in step #4). If your site uses a
 | 
| 
webmaster@1
 | 
    95     custom or contributed theme, make sure it is compatible with your
 | 
| 
webmaster@1
 | 
    96     version of Drupal.
 | 
| 
webmaster@1
 | 
    97 
 | 
| 
webmaster@1
 | 
    98       - For contributed themes, check http://drupal.org/project/themes
 | 
| 
webmaster@1
 | 
    99         for the version of a theme matching your version of Drupal.
 | 
| 
webmaster@1
 | 
   100 
 | 
| 
webmaster@1
 | 
   101       - For custom themes, review http://drupal.org/update/theme to ensure
 | 
| 
webmaster@1
 | 
   102         that a custom theme is compatible with the current version.
 | 
| 
webmaster@1
 | 
   103 
 | 
| 
webmaster@1
 | 
   104 14. Finally, return your site to "Online" mode so your visitors may resume
 | 
| 
webmaster@1
 | 
   105     browsing. As in step #3, this option is available in your administration
 | 
| 
webmaster@1
 | 
   106     screens at http://www.example.com/?q=admin/settings/site-maintenance
 | 
| 
webmaster@1
 | 
   107     (replace www.example.com with your installation's domain name and path).
 | 
| 
webmaster@1
 | 
   108 
 | 
| 
webmaster@1
 | 
   109 For more information on upgrading visit
 | 
| 
webmaster@1
 | 
   110 the Drupal handbook at http://drupal.org/upgrade
 |