example.sites.php 2.31 KB
Newer Older
1 2
<?php

3 4
// @codingStandardsIgnoreFile

5 6
/**
 * @file
7
 * Configuration file for multi-site support and directory aliasing feature.
8
 *
9 10 11 12 13 14
 * This file is required for multi-site support and also allows you to define a
 * set of aliases that map hostnames, ports, and pathnames to configuration
 * directories in the sites directory. These aliases are loaded prior to
 * scanning for directories, and they are exempt from the normal discovery
 * rules. See default.settings.php to view how Drupal discovers the
 * configuration directory when no alias is found.
15
 *
16 17 18 19
 * Aliases are useful on development servers, where the domain name may not be
 * the same as the domain of the live server. Since Drupal stores file paths in
 * the database (files, system table, etc.) this will ensure the paths are
 * correct when the site is deployed to a live server.
20
 *
21 22
 * To activate this feature, copy and rename it such that its path plus
 * filename is 'sites/sites.php'.
23 24 25
 *
 * Aliases are defined in an associative array named $sites. The array is
 * written in the format: '<port>.<domain>.<path>' => 'directory'. As an
26
 * example, to map https://www.drupal.org:8080/mysite/test to the configuration
27 28
 * directory sites/example.com, the array should be defined as:
 * @code
29
 * $sites = [
30
 *   '8080.www.drupal.org.mysite.test' => 'example.com',
31
 * ];
32
 * @endcode
33 34
 * The URL, https://www.drupal.org:8080/mysite/test/, could be a symbolic link
 * or an Apache Alias directive that points to the Drupal root containing
35
 * index.php. An alias could also be created for a subdomain. See the
36
 * @link https://www.drupal.org/documentation/install online Drupal installation guide @endlink
37
 * for more information on setting up domains, subdomains, and subdirectories.
38
 *
39 40 41 42
 * The following examples look for a site configuration in sites/example.com:
 * @code
 * URL: http://dev.drupal.org
 * $sites['dev.drupal.org'] = 'example.com';
43
 *
44 45 46 47 48 49
 * URL: http://localhost/example
 * $sites['localhost.example'] = 'example.com';
 *
 * URL: http://localhost:8080/example
 * $sites['8080.localhost.example'] = 'example.com';
 *
50
 * URL: https://www.drupal.org:8080/mysite/test/
51 52
 * $sites['8080.www.drupal.org.mysite.test'] = 'example.com';
 * @endcode
53
 *
54
 * @see default.settings.php
55
 * @see \Drupal\Core\DrupalKernel::getSitePath()
56
 * @see https://www.drupal.org/documentation/install/multi-site
57
 */