| 1 |
// $Id: UPGRADE.txt,v 1.8 2009/10/14 14:18:22 agentken Exp $
|
| 2 |
|
| 3 |
|
| 4 |
/**
|
| 5 |
* @file
|
| 6 |
* UPGRADE instructions for Domain Access 6.x.2
|
| 7 |
*/
|
| 8 |
|
| 9 |
CONTENTS
|
| 10 |
--------
|
| 11 |
|
| 12 |
1. Who Needs to Upgrade?
|
| 13 |
2. How to Upgrade
|
| 14 |
3. Error Notices
|
| 15 |
4. Change Summary
|
| 16 |
5. Upgrading From Drupal 5
|
| 17 |
|
| 18 |
----
|
| 19 |
1. Who Needs to Upgrade?
|
| 20 |
|
| 21 |
If you are using Domain Access prior to 6.x.2.0, then you should
|
| 22 |
follow these upgrade instructions.
|
| 23 |
|
| 24 |
----
|
| 25 |
2. How to Upgrade
|
| 26 |
|
| 27 |
In previous versions, Domain Access asked you to make several
|
| 28 |
changes to your site's settings.php file. The 6.x.2.0 version
|
| 29 |
has made this process easier.
|
| 30 |
|
| 31 |
NOTE: You must leave the Domain Access module and its child
|
| 32 |
modules turned on during the upgrade process.
|
| 33 |
|
| 34 |
When you first update the source code, you may see some
|
| 35 |
Drupal error messages printed on screen. These are normal and
|
| 36 |
will disappear after the upgrade is complete.
|
| 37 |
|
| 38 |
|
| 39 |
To upgrade, follow the steps below.
|
| 40 |
|
| 41 |
STEP 1: Update the module source code
|
| 42 |
|
| 43 |
Replace your existing module files with the new downloaded source.
|
| 44 |
|
| 45 |
|
| 46 |
STEP 2: Add new code to settings.php
|
| 47 |
|
| 48 |
Add the following code to your site's settings.php file:
|
| 49 |
|
| 50 |
/**
|
| 51 |
* Add the domain module setup routine.
|
| 52 |
*/
|
| 53 |
include './sites/all/modules/domain/settings.inc';
|
| 54 |
|
| 55 |
See INSTALL.txt for additional information.
|
| 56 |
|
| 57 |
|
| 58 |
STEP 3: Remove old code from settings.php
|
| 59 |
|
| 60 |
If you have any of the following code in settings.php from eariler
|
| 61 |
versions, you should remove it:
|
| 62 |
|
| 63 |
/**
|
| 64 |
* Add the custom_url_rewrite_outbound function.
|
| 65 |
*/
|
| 66 |
require_once './sites/all/modules/domain/settings_custom_url.inc';
|
| 67 |
|
| 68 |
/**
|
| 69 |
* Add the domain_conf settings override
|
| 70 |
*/
|
| 71 |
require_once './sites/all/modules/domain/domain_conf/settings_domain_conf.inc';
|
| 72 |
|
| 73 |
/**
|
| 74 |
* Add the domain_prefix tables
|
| 75 |
*/
|
| 76 |
require_once './sites/all/modules/domain/domain_prefix/settings_domain_prefix.inc';
|
| 77 |
|
| 78 |
|
| 79 |
STEP 4: Register the module updates
|
| 80 |
|
| 81 |
After you have edited settings.php, log in to your Primary Domain as user 1
|
| 82 |
and run the Drupal update script.
|
| 83 |
|
| 84 |
The update must be run from your primary domain.
|
| 85 |
|
| 86 |
STEP 5: Rebuild node access permissions
|
| 87 |
|
| 88 |
After running the update script, when you return to the administration pages
|
| 89 |
you will be prompted to rebuild the node access table. Click on the link or go
|
| 90 |
to Admin > Content > Post settings and click the 'Rebuild Permissions' button.
|
| 91 |
|
| 92 |
STEP 6: Reset permissions for domain module
|
| 93 |
|
| 94 |
The old 'Content Editing Forms' setting has been replaced by role-based
|
| 95 |
permissions. Please see section 3.1 of README.txt and reset your
|
| 96 |
site permissions accordingly. The upgrade does not split permissions for you.
|
| 97 |
|
| 98 |
There are also new permissions documented in README.txt.
|
| 99 |
|
| 100 |
----
|
| 101 |
3. Error Notices
|
| 102 |
|
| 103 |
If your module is not configured correctly, you should see an error notice
|
| 104 |
on the top of the page -- this message is shown only to users with the
|
| 105 |
'administer domains' permission. The error is also written to your site's
|
| 106 |
error logs, if any.
|
| 107 |
|
| 108 |
If you encounter this error, please check that you have installed or upgraded
|
| 109 |
the module correctly. If the problem persists, please file a support request
|
| 110 |
at http://drupal.org/project/domain.
|
| 111 |
|
| 112 |
|
| 113 |
----
|
| 114 |
4. Change Summary
|
| 115 |
|
| 116 |
Below are some notes about the changes to the new version.
|
| 117 |
|
| 118 |
-- Pre-load functions are now handled automatically.
|
| 119 |
-- Domain Alias has been added.
|
| 120 |
-- The old setting for 'Content editing forms' has been made a permission,
|
| 121 |
so these functions can now be set per user role.
|
| 122 |
-- The Primary Domain is now stored in both the {variables} and
|
| 123 |
{domain} tables. Doing so allows full integration with Views and
|
| 124 |
simplifies some of the core code. However, it will also force the module
|
| 125 |
to skip a domain_id in the database. This change will not cause any
|
| 126 |
issues, but there will be a skipped domain_id for all sites.
|
| 127 |
-- Fresh installs of Domain Access will never have a domain_id of 1.
|
| 128 |
-- The 'domain editor' grant has been deprecated.
|
| 129 |
-- The new function domain_get_user_domains($uid) can be used
|
| 130 |
to find which domains as user is assigned to.
|
| 131 |
|
| 132 |
----
|
| 133 |
5. Upgrading from Drupal 5
|
| 134 |
|
| 135 |
The upgrade process should work fine when upgrading from Drupal 5.
|
| 136 |
|
| 137 |
Best practice is to disable contributed modules when upgrading Drupal.
|
| 138 |
Be sure you disable (but do not uninstall) the Domain Access module
|
| 139 |
before upgrading Drupal.
|
| 140 |
|
| 141 |
When you have upgraded Drupal core, you may upgrade Domain Access.
|
| 142 |
Be sure to turn the Domain Access module (and its children) back on
|
| 143 |
before running any Domain Access updates.
|