UPGRADE.txt 9.42 KB
Newer Older
1 2 3
INTRODUCTION
------------
This document describes how to:
4

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

8
  * Upgrade your Drupal site's major version from 6.x to 7.x.
9

10
First steps and definitions:
11

12 13
  * 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
14
    file will be named drupal-x.y.tar.gz (or drupal-x.y.zip).
15

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

19
  * Make a full backup of all files, directories, and your database(s) before
20 21 22 23 24 25
    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.
26

27 28 29 30 31
  * Each new release of Drupal has release notes, which explain the changes made
    since the previous version and any special instructions needed to update or
    upgrade to the new version. You can find a link to the release notes for the
    version you are upgrading or updating to on the Drupal project page
    (http://drupal.org/project/drupal).
32

33 34 35
UPGRADE PROBLEMS
----------------
If you encounter errors during this process,
36

37
  * Note any error messages you see.
38

39 40 41
  * 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.
42

43
  * Consult one of the support options listed on http://drupal.org/support
44

45
More in-depth information on upgrading can be found at http://drupal.org/upgrade
46

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

52
1. Log in as a user with the permission "Administer software updates".
53

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

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

61 62
   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.
63

64 65 66 67 68 69 70 71 72 73 74 75
   Sometimes an update includes changes to default.settings.php (this will be
   noted in the release notes). If that's the case, follow these steps:

   - Make a backup copy of your settings.php file, with a different file name.

   - Make a copy of the new default.settings.php file, and name the copy
     settings.php (overwriting your previous settings.php file).

   - Copy the custom and site-specific entries from the backup you made into the
     new settings.php file. You will definitely need the lines giving the
     database information, and you will also want to copy in any other
     customizations you have added.
76

77 78 79
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.
80

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

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

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

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

92 93 94
   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.
95

96
5. Re-apply any modifications to files such as .htaccess or robots.txt.
97

98 99 100
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.
101

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

104
   - Open settings.php with a text editor.
105

106
   - Find the line that says:
107 108 109 110 111 112 113
     $update_free_access = FALSE;

   - Change it into:
     $update_free_access = TRUE;

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

114 115
7. Go to Administration > Reports > Status report. Verify that everything is
   working as expected.
116 117 118

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

119
9. Go to Administration > Configuration > Development > Maintenance mode.
120 121 122 123 124 125 126 127
   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:

128 129 130 131 132 133 134
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.
135

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

139 140 141 142
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.
143

144
3. In addition to updating to the latest available version of Drupal 6.x core,
145 146
   you must also upgrade all of your contributed modules for Drupal to their
   latest Drupal 6.x versions.
147

148 149 150
4. Log in as user ID 1 (the site maintenance user).

5. Go to Administer > Site configuration > Site maintenance. Select
151
   "Off-line" and save the configuration.
152

153
6. Go to Administer > Site building > Themes. Enable "Garland" and select it as
154
   the default theme.
155

156
7. Go to Administer > Site building > Modules. Disable all modules that are not
157 158 159 160
   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.

161 162 163
   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.
164

165
8. On the command line or in your FTP client, remove the file
166 167 168

     sites/default/default.settings.php

169
9. Remove all old core files and directories, except for the 'sites' directory
170 171 172 173 174
   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.

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

179
11. Download the latest Drupal 7.x release from http://drupal.org to a
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
   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.

198
12. Re-apply any modifications to files such as .htaccess or robots.txt.
199

200
13. Make your settings.php file writeable, so that the update process can
201 202 203 204
   convert it to the format of Drupal 7.x. settings.php is usually located in

     sites/default/settings.php

205
14. Run update.php by visiting http://www.example.com/update.php (replace
206 207 208 209 210 211 212
   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.

213
   - Find the line that says:
214 215 216 217 218 219 220
     $update_free_access = FALSE;

   - Change it into:
     $update_free_access = TRUE;

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

221
15. Backup your database after the core upgrade has run.
222

223
16. Replace and update your non-core modules and themes, following the
224
   procedures at http://drupal.org/node/948216
225

226
17. Go to Administration > Reports > Status report. Verify that everything is
227
   working as expected.
228

229
18. Ensure that $update_free_access is FALSE in settings.php.
230

231
19. Go to Administration > Configuration > Development > Maintenance mode.
232 233 234 235 236
   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