UPGRADE.txt 8.61 KB
Newer Older
1 2
// $Id$

3 4 5
INTRODUCTION
------------
This document describes how to:
6

7
  * Update your Drupal site from one minor 7.x version to another minor 7.x
8
    version; for example, from 7.8 to 7.9, or from 7.6 to 7.10.
9

10
  * Upgrade your Drupal site's major version from 6.x to 7.x.
11

12
First steps and definitions:
13

14 15
  * If you are upgrading to Drupal version x.y, then x is known as the major
    version number, and y is known as the minor version number. The download
16
    file will be named drupal-x.y.tar.gz (or drupal-x.y.zip).
17

18 19
  * All directories mentioned in this document are relative to the directory of
    your Drupal installation.
20

21
  * Make a full backup of all files, directories, and your database(s) before
22 23 24 25 26 27
    starting, and save it outside your Drupal installation directory.
    Instructions may be found at http://drupal.org/upgrade/backing-up-the-db

  * It is wise to try an update or upgrade on a test copy of your site before
    applying it to your live site. Even minor updates can cause your site's
    behavior to change.
28 29


30 31 32
UPGRADE PROBLEMS
----------------
If you encounter errors during this process,
33

34
  * Note any error messages you see.
35

36 37 38
  * Restore your site to its previous state, using the file and database backups
    you created before you started the upgrade process. Do not attempt to do
    further upgrades on a site that had update problems.
39

40
  * Consult one of the support options listed on http://drupal.org/support
41

42
More in-depth information on upgrading can be found at http://drupal.org/upgrade
43 44


45 46
MINOR VERSION UPDATES
---------------------
47
To update from one minor 7.x version of Drupal to any later 7.x version, after
48
following the instructions in the INTRODUCTION section at the top of this file:
49

50
1. Log in as a user with the permission "Administer software updates".
51

52
2. Go to Administration > Configuration > Development > Maintenance mode.
53 54
   Enable the "Put site into maintenance mode" checkbox and save the
   configuration.
55

56
3. Remove all old core files and directories, except for the 'sites' directory
57
   and any custom files you added elsewhere.
58

59 60
   If you made modifications to files like .htaccess or robots.txt, you will
   need to re-apply them from your backup, after the new files are in place.
61

62 63 64 65 66 67
   Sometimes an update includes changes to settings.php (this will be noted in
   the release announcement). If that's the case, replace your old settings.php
   with the new one, and copy the site-specific entries (especially the lines
   giving the database name, user, and password) from the old settings.php to
   the new settings.php.

68 69 70
4. Download the latest Drupal 7.x release from http://drupal.org to a
   directory outside of your web root. Extract the archive and copy the files
   into your Drupal directory.
71

72 73
   On a typical Unix/Linux command line, use the following commands to download
   and extract:
74

75 76
     wget http://drupal.org/files/projects/drupal-x.y.tar.gz
     tar -zxvf drupal-x.y.tar.gz
77

78 79
   This creates a new directory drupal-x.y/ containing all Drupal files and
   directories. Copy the files into your Drupal installation directory:
80

81
     cp -R drupal-x.y/* drupal-x.y/.htaccess /path/to/your/installation
82

83 84 85
   If you do not have command line access to your server, download the archive
   from http://drupal.org using your web browser, extract it, and then use an
   FTP client to upload the files to your web root.
86

87
5. Re-apply any modifications to files such as .htaccess or robots.txt.
88

89 90 91
6. Run update.php by visiting http://www.example.com/update.php (replace
   www.example.com with your domain name). This will update the core database
   tables.
92

93
   If you are unable to access update.php do the following:
94

95
   - Open settings.php with a text editor.
96

97
   - Find the line that says:
98 99 100 101 102 103 104
     $update_free_access = FALSE;

   - Change it into:
     $update_free_access = TRUE;

   - Once the upgrade is done, $update_free_access must be reverted to FALSE.

105 106
7. Go to Administration > Reports > Status report. Verify that everything is
   working as expected.
107 108 109

8. Ensure that $update_free_access is FALSE in settings.php.

110
9. Go to Administration > Configuration > Development > Maintenance mode.
111 112 113 114 115 116 117 118 119
   Disable the "Put site into maintenance mode" checkbox and save the
   configuration.


MAJOR VERSION UPGRADE
---------------------
To upgrade from a previous major version of Drupal to Drupal 7.x, after
following the instructions in the INTRODUCTION section at the top of this file:

120 121 122 123 124 125 126
1. Check on the Drupal 7 status of your contributed and custom modules and
   themes. See http://drupal.org/node/948216 for information on upgrading
   contributed modules and themes. See http://drupal.org/node/895314 for a list
   of modules that have been moved into core for Drupal 7, and instructions on
   how to update them. See http://drupal.org/update/modules for information on
   how to update your custom modules, and http://drupal.org/update/theme for
   custom themes.
127

128 129
   You may decide at this point that you cannot upgrade your site, because
   needed modules or themes are not ready for Drupal 7.
130

131 132 133 134
2. Update to the latest available version of Drupal 6.x (if your current version
   is Drupal 5.x, you have to upgrade to 6.x first). If you need to update,
   download Drupal 6.x and follow the instructions in its UPGRADE.txt. This
   document only applies for upgrades from 6.x to 7.x.
135 136 137

3. Log in as user ID 1 (the site maintenance user).

138 139
4. Go to Administer > Site configuration > Site maintenance. Select
   "Off-line" and save the configuration.
140

141 142
5. Go to Administer > Site building > Themes. Enable "Garland" and select it as
   the default theme.
143

144
6. Go to Administer > Site building > Modules. Disable all modules that are not
145 146 147 148
   listed under "Core - required" or "Core - optional". It is possible that some
   modules cannot be disabled, because others depend on them. Repeat this step
   until all non-core modules are disabled.

149 150 151
   If you know that you will not re-enable some modules for Drupal 7.x and you
   no longer need their data, then you can uninstall them under the Uninstall
   tab after disabling them.
152 153 154 155 156

7. On the command line or in your FTP client, remove the file

     sites/default/default.settings.php

157
8. Remove all old core files and directories, except for the 'sites' directory
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
   and any custom files you added elsewhere.

   If you made modifications to files like .htaccess or robots.txt, you will
   need to re-apply them from your backup, after the new files are in place.

9. If you uninstalled any modules, remove them from the sites/all/modules and
   other sites/*/modules directories. Leave other modules in place, even though
   they are incompatible with Drupal 7.x.

10. Download the latest Drupal 7.x release from http://drupal.org to a
   directory outside of your web root. Extract the archive and copy the files
   into your Drupal directory.

   On a typical Unix/Linux command line, use the following commands to download
   and extract:

     wget http://drupal.org/files/projects/drupal-x.y.tar.gz
     tar -zxvf drupal-x.y.tar.gz

   This creates a new directory drupal-x.y/ containing all Drupal files and
   directories. Copy the files into your Drupal installation directory:

     cp -R drupal-x.y/* drupal-x.y/.htaccess /path/to/your/installation

   If you do not have command line access to your server, download the archive
   from http://drupal.org using your web browser, extract it, and then use an
   FTP client to upload the files to your web root.

11. Re-apply any modifications to files such as .htaccess or robots.txt.

12. Make your settings.php file writeable, so that the update process can
   convert it to the format of Drupal 7.x. settings.php is usually located in

     sites/default/settings.php

13. Run update.php by visiting http://www.example.com/update.php (replace
   www.example.com with your domain name). This will update the core database
   tables.

   If you are unable to access update.php do the following:

   - Open settings.php with a text editor.

201
   - Find the line that says:
202 203 204 205 206 207 208 209 210
     $update_free_access = FALSE;

   - Change it into:
     $update_free_access = TRUE;

   - Once the upgrade is done, $update_free_access must be reverted to FALSE.

14. Backup your database after the core upgrade has run.

211 212
15. Replace and update your non-core modules and themes, following the
   procedures at http://drupal.org/node/948216
213

214 215
16. Go to Administration > Reports > Status report. Verify that everything is
   working as expected.
216

217
17. Ensure that $update_free_access is FALSE in settings.php.
218

219
18. Go to Administration > Configuration > Development > Maintenance mode.
220 221 222 223 224
   Disable the "Put site into maintenance mode" checkbox and save the
   configuration.

To get started with Drupal 7 administration, visit
http://drupal.org/getting-started/7/admin
225