modules/domain/INSTALL_QUICKSTART.txt

// $Id: INSTALL_QUICKSTART.txt,v 1.9 2009/10/24 22:11:26 agentken Exp $

/**
 * @file
 * Quickstart INSTALL file for Domain Access.
 */

This file is a quickstart guide for using the Domain Access
suite of modules.

For full documentation, see INSTALL.txt and README.txt

INSTALLATION INSTRUCTIONS

1. Before proceeding, you must install and configure Drupal
    without installing this module.

    Note that you only need one settings directory and file.

2. Unpack the download and place it in your modules directory.

    Note the path to this directory, it is normally:

      'sites/all/modules'

3. Add the following four lines of code to your settings.php file:

/**
 * Add the domain module setup routine.
 */
include './sites/all/modules/domain/settings.inc';

    NOTE: You may need to alter the file path above based on your
    site configuration.  See INSTALL.txt for further help.

    IMPORTANT: You must add these lines to settings.php after the
    $db_url. Normally, you should add these lines to the end of the
    settings.php file.

4. Check for existing custom_url_rewrite_outbound().

    custom_url_rewrite_outbound() is a special function that you
    can add to settings.php to alter how Drupal writes links to content.

    If your site already uses this function -- it is not in core -- then
    you will need to modify its use to accommodate Domain Access
    because the module has its own version.

    Domain Access implements this function within the context of the
    URL Alter module, http://drupal.org/project/url_alter, which is a
    functional backport of changes implemented in Drupal 7.

    If your site uses custom code to implement custom_url_rewrite_outbound(),
    consider upgrading to the URL Alter module for full compatibility.

    You may also call the function domain_url_rewrite_outbound() directly in
    your custom code.

    NOTE: Domain Access does not use custom_url_rewrite_inbound().

5. Go to Admin > Build > Modules.  There you will see the Domain
    module group.

    Only enable the Domain Acccess module.

6. Configure permissions for the module, normally you will give your
    site administrators the following permissions:

    -- 'administer domains'
    -- 'set domain access'

    If you intend to use access control for editors, you may wish to set
    the following permissions:

    -- 'assign domain editors'
    -- 'edit domain nodes'

    For more information see README.txt.

7. Read the main README.txt file for the Domain Access module.

8. Go to Admin > Build > Domain and configure the module.

9. Note that as of 6.x.2.0, the primary domain is created for you on
    installation.

10. Now you are ready to explore the options available to you.

    The Domain Access suite contains a number of optional helper
    modules.  You do not need to use any of these modules, but
    they may add features that you desire.

    Each of the modules has its own INSTALL.txt and README.txt files.
    Please read them carefully before activating them.
1	// $Id: INSTALL_QUICKSTART.txt,v 1.9 2009/10/24 22:11:26 agentken Exp $
2
3	/**
4	* @file
5	* Quickstart INSTALL file for Domain Access.
6	*/
7
8	This file is a quickstart guide for using the Domain Access
9	suite of modules.
10
11	For full documentation, see INSTALL.txt and README.txt
12
13	INSTALLATION INSTRUCTIONS
14
15	1. Before proceeding, you must install and configure Drupal
16	without installing this module.
17
18	Note that you only need one settings directory and file.
19
20	2. Unpack the download and place it in your modules directory.
21
22	Note the path to this directory, it is normally:
23
24	'sites/all/modules'
25
26	3. Add the following four lines of code to your settings.php file:
27
28	/**
29	* Add the domain module setup routine.
30	*/
31	include './sites/all/modules/domain/settings.inc';
32
33	NOTE: You may need to alter the file path above based on your
34	site configuration. See INSTALL.txt for further help.
35
36	IMPORTANT: You must add these lines to settings.php after the
37	$db_url. Normally, you should add these lines to the end of the
38	settings.php file.
39
40	4. Check for existing custom_url_rewrite_outbound().
41
42	custom_url_rewrite_outbound() is a special function that you
43	can add to settings.php to alter how Drupal writes links to content.
44
45	If your site already uses this function -- it is not in core -- then
46	you will need to modify its use to accommodate Domain Access
47	because the module has its own version.
48
49	Domain Access implements this function within the context of the
50	URL Alter module, http://drupal.org/project/url_alter, which is a
51	functional backport of changes implemented in Drupal 7.
52
53	If your site uses custom code to implement custom_url_rewrite_outbound(),
54	consider upgrading to the URL Alter module for full compatibility.
55
56	You may also call the function domain_url_rewrite_outbound() directly in
57	your custom code.
58
59	NOTE: Domain Access does not use custom_url_rewrite_inbound().
60
61	5. Go to Admin > Build > Modules. There you will see the Domain
62	module group.
63
64	Only enable the Domain Acccess module.
65
66	6. Configure permissions for the module, normally you will give your
67	site administrators the following permissions:
68
69	-- 'administer domains'
70	-- 'set domain access'
71
72	If you intend to use access control for editors, you may wish to set
73	the following permissions:
74
75	-- 'assign domain editors'
76	-- 'edit domain nodes'
77
78	For more information see README.txt.
79
80	7. Read the main README.txt file for the Domain Access module.
81
82	8. Go to Admin > Build > Domain and configure the module.
83
84	9. Note that as of 6.x.2.0, the primary domain is created for you on
85	installation.
86
87	10. Now you are ready to explore the options available to you.
88
89	The Domain Access suite contains a number of optional helper
90	modules. You do not need to use any of these modules, but
91	they may add features that you desire.
92
93	Each of the modules has its own INSTALL.txt and README.txt files.
94	Please read them carefully before activating them.