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