// $Id: INSTALL_QUICKSTART.txt,v 1.7 2009-05-24 22:52:28 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 loads its version of this function automatically if
    it does not already exist. If it does exist, you need to decide which
    version should run first, and then add something like the following
    code to settings.php _below_ the lines from step 3:

/**
 * Both Drupal for Facebook and domain module use the
 * custom_url_rewrite feature.  We have to define our own functions
 * which call the others in the proper order.
 */
function custom_url_rewrite_outbound(&$path, &$options, $original_path) {
  // Call fb module first
  if (function_exists('fb_settings_url_rewrite_outbound')) {
    fb_settings_url_rewrite_outbound($path, $options, $original_path);
  }
  if (function_exists('domain_url_rewrite_outbound')) {
    domain_url_rewrite_outbound($path, $options, $original_path);
  }
}

    NOTE: Domain Access does not use custom_url_rewrite_inbound().


5. Go to Admin > Build > Modules.  Therre 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.