summaryrefslogtreecommitdiff
path: root/UPGRADE.txt
diff options
context:
space:
mode:
authorGábor Hojtsy <gabor@hojtsy.hu>2007-09-14 20:00:42 +0000
committerGábor Hojtsy <gabor@hojtsy.hu>2007-09-14 20:00:42 +0000
commit23778cc0c0107699a4b93584dd9e7d03bc42d5d0 (patch)
tree2f3712a49409c64c0adbef8959a7a74654a803f6 /UPGRADE.txt
parent75f0eb8e8904d53440516d22565f18559a9ed552 (diff)
downloadbrdo-23778cc0c0107699a4b93584dd9e7d03bc42d5d0.tar.gz
brdo-23778cc0c0107699a4b93584dd9e7d03bc42d5d0.tar.bz2
#152967 by keith.smith, webchick, Morbus Iff and KentByte: update the upgrade instructions for Drupal 6
Diffstat (limited to 'UPGRADE.txt')
-rw-r--r--UPGRADE.txt130
1 files changed, 79 insertions, 51 deletions
diff --git a/UPGRADE.txt b/UPGRADE.txt
index b22fd8c3c..f89557081 100644
--- a/UPGRADE.txt
+++ b/UPGRADE.txt
@@ -3,78 +3,106 @@
UPGRADING
---------
-1. Backup your database and Drupal directory - especially your
- "sites" directory which contains your configuration file and
- added modules and themes, any contributed modules in your
- "modules" directory, and your "files" directory which contains
- uploaded files.
+Prior to upgrading, you should ensure that:
- Note: for a single site setup the configuration file is the
- "settings.php" file located at sites/default/settings.php.
- For multisite configuration the configuration file is located
- in a structure like the following:
+ * 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. Backup your database and Drupal directory - especially your "sites"
+ directory which contains your configuration file and added modules and
+ themes, any contributed or custom modules in your "modules" directory,
+ and your "files" directory which contains uploaded files. If other files
+ have modifications, such as .htaccess or robots.txt, those should be
+ backed 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
- the INSTALL.txt file.
-
-2. Log on as the user with user ID 1. User ID 1 is the first
- account created and the main administrator account. User
- ID 1 needs to be logged in so that you can access update.php
- (step 10) which can only be run by user ID 1. Do not close
- your browser until step 11 is complete.
+ More information on multisite configuration is located in INSTALL.txt.
-3. Place the site in "Off-line" mode, to mask any errors from
- site visitors.
+2. If possible, log on as the user with user ID 1, which is the first account
+ created and the main administrator account. User ID 1 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 user ID 1. Do not close your
+ browser until the final step is complete.
-4. Disable contributed modules and switch to a core theme
- (Bluemarine or Garland).
+3. Place the site in "Off-line" 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/settings/site-maintenance
+ (replace www.example.com with your installation's domain name and path).
-5. Remove all of the old files and directories from the Drupal
- installation directory.
+4. If using a custom or contributed theme, switch
+ to a core theme, such as Garland or Bluemarine.
-6. Unpack the new Drupal files and directories into the Drupal
- installation directory.
+5. Disable all custom and contributed modules.
-7. Copy the backed up "files" and "sites" directories to the
- Drupal installation directory. If the original .htaccess or
- robots.txt files have been modified, copy the backed up
- versions of these files to the installation directory as
- well.
+6. Remove all old files and directories from the Drupal installation directory.
-8. Verify the new configuration file to make sure it has the
- latest and correct information.
+7. Unpack the new files and directories into the Drupal installation directory.
-9. Re-install contributed modules.
+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.
- Note: make sure the version of a module matches your
- version of Drupal. Modules from previous versions may
- not be compatible with the current version. Check
- http://drupal.org/project/Modules for the version of a
- module to match your version of Drupal.
+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 database to
- the new Drupal installation.
+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;.
+ - 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 like Garland or Bluemarine 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.
- - As soon as the update.php script is done, you must change
- the settings.php file back to its original form with
- $update_free_access = FALSE;.
+ - For custom themes, review http://drupal.org/update/theme to ensure
+ that a custom theme is compatible with the current version.
-11. Finally, return site to "Online" mode so your visitors may resume
- browsing.
+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/settings/site-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
+For more information on upgrading visit
+the Drupal handbook at http://drupal.org/upgrade