2. Domain Quick Start Install

Quick Start Guide for Domain Access.

This is a Quick Start Guide for using the Domain Access suite of modules.

For full documentation, see Domain Install Detailed and Domain module configuration.

Special Note: The $database declaration in the settings.php file can be in either the short string format or in the expanded array format similar to Drupal 7. Support for both is now fixed in the code repository, see issue 25.

Also remember to:

• Rebuild node access permissions.
• Disable caches when testing new content viewed by anonymous visitors.

Installation Instructions

1. First, you must install and configure Backdrop without installing this module.

   You do not need extra sites directory or files and only one settings.php or settings.local.php file.

2. Download and unpack the module into your modules directory.

   It may be like the default /modules/domain or a variation like /modules/contrib/domain.

3. Add the following lines to the settings.php file using the path to the module based on your site configuration. These lines must appear in the settings.php after the declaration for $databases and may be placed at the end of the settings.php file.

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

For more help see Domain Install Detailed.

NOTE: If you perform a Backdrop core major version upgrade, you must remove these lines from settings.php. See UPGRADE.txt for details.

TO DO:

Clarify what the line above means. Is this cruft from Drupal version upgrades? Maybe if in the future there is a Backdrop 2.x version?

Confirm UPGRADE.txt file can be scrapped since it is all Drupal version changes, and remove any references to the file when it is removed.

END TODO

Enable the Domain Access module.

Only enable the Domain Access module to start.

Rebuild node access permissions.

Rebuild node access permissions, available on Status Report as alert with click to execute.

Configure user permissions for the module, based on site roles.

Normally you will give your site administrators the following permissions:

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

NOTE: Some of the permissions may be pre-configured for the site's administrative role.

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

-- 'assign domain editors'
-- 'edit domain content'

For more information see Domain module configuration.

Configure Domain module

Go to Admin > Structure > Domain to configure the module.

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

For details see Domain module configuration.

Domain helper modules

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 desirable features.

The wiki page Domian Helper Modules provides a list of the helper modules and links to the wiki page for each. Please read carefully before activating the modules.

Using Bee to install domain module

The bee module for command line interface is found at bee.

When using bee to install the domain module include the URI for your site with the full path to the installation as below:

bee pm-enable domain --base-url=https://example.com

Then rebuild node access tables:

bee ev "node_access_rebuild();"

Also clear all caches:

bee cache-clear

When prompted, select option [0].