diff options
Diffstat (limited to 'sites')
| -rw-r--r-- | sites/README.txt | 19 | ||||
| -rw-r--r-- | sites/all/README.txt | 7 | ||||
| -rw-r--r-- | sites/all/modules/README.txt | 18 | ||||
| -rw-r--r-- | sites/all/themes/README.txt | 16 | ||||
| -rw-r--r-- | sites/default/default.settings.php | 99 | ||||
| -rw-r--r-- | sites/example.sites.php | 70 |
6 files changed, 158 insertions, 71 deletions
diff --git a/sites/README.txt b/sites/README.txt new file mode 100644 index 000000000..9aecef2d7 --- /dev/null +++ b/sites/README.txt @@ -0,0 +1,19 @@ +This directory structure contains the settings and configuration files specific +to your site or sites and is an integral part of multisite configuration. + +The sites/all/ subdirectory structure should be used to place your custom and +downloaded extensions including modules, themes, and third party libraries. + +Downloaded installation profiles should be placed in the /profiles directory +in the Drupal root. + +In multisite configuration, extensions found in the sites/all directory +structure are available to all sites. Alternatively, the sites/your_site_name/ +subdirectory pattern may be used to restrict extensions to a specific +site instance. + +See the respective README.txt files in sites/all/themes and sites/all/modules +for additional information about obtaining and organizing extensions. + +See INSTALL.txt in the Drupal root for information about single-site +installation or multisite configuration. diff --git a/sites/all/README.txt b/sites/all/README.txt deleted file mode 100644 index c8970883a..000000000 --- a/sites/all/README.txt +++ /dev/null @@ -1,7 +0,0 @@ - -This directory should be used to place downloaded and custom modules -and themes which are common to all sites. Keeping contributed and -custom modules and themes in the sites directory will aid in upgrading -Drupal core files. Place contributed and custom modules and themes in -the sites/all/modules and sites/all/themes directories respectively. - diff --git a/sites/all/modules/README.txt b/sites/all/modules/README.txt index f4e35b558..c72b43e4f 100644 --- a/sites/all/modules/README.txt +++ b/sites/all/modules/README.txt @@ -1,4 +1,16 @@ +Place downloaded and custom modules that extend your site functionality beyond +Drupal core in this directory to ensure clean separation from core modules and +to facilitate safe, self-contained code updates. Contributed modules from the +Drupal community may be downloaded at http://drupal.org/project/modules. -This directory should be used to place downloaded and custom modules -which are common to all sites. This will allow you to more easily -update Drupal core files. +It is safe to organize modules into subdirectories, such as "contrib" for +contributed modules, and "custom" for custom modules. Note that if you move a +module to a subdirectory after it has been enabled, you may need to clear the +Drupal cache so that it can be found. + +In multisite configuration, modules found in this directory are available to +all sites. Alternatively, the sites/your_site_name/modules directory pattern may +be used to restrict modules to a specific site instance. + +Refer to the "Developing for Drupal" section of the README.txt in the Drupal +root directory for further information on extending Drupal with custom modules. diff --git a/sites/all/themes/README.txt b/sites/all/themes/README.txt index e9425214b..e308af205 100644 --- a/sites/all/themes/README.txt +++ b/sites/all/themes/README.txt @@ -1,4 +1,14 @@ +Place downloaded and custom themes that modify your site's appearance in this +directory to ensure clean separation from Drupal core and to facilitate safe, +self-contained code updates. Contributed themes from the Drupal community may +be downloaded at http://drupal.org/project/themes. -This directory should be used to place downloaded and custom themes -which are common to all sites. This will allow you to more easily -update Drupal core files. +It is safe to organize themes into subdirectories and is recommended to use +Drupal's sub-theme functionality to ensure easy maintenance and upgrades. + +In multisite configuration, themes found in this directory are available to +all sites. Alternatively, the sites/your_site_name/themes directory pattern may +be used to restrict themes to a specific site instance. + +Refer to the "Appearance" section of the README.txt in the Drupal root +directory for further information on theming. diff --git a/sites/default/default.settings.php b/sites/default/default.settings.php index 30699a0a2..2ac6ed56b 100644 --- a/sites/default/default.settings.php +++ b/sites/default/default.settings.php @@ -5,41 +5,51 @@ * Drupal site-specific configuration file. * * IMPORTANT NOTE: - * This file may have been set to read-only by the Drupal installation - * program. If you make changes to this file, be sure to protect it again - * after making your modifications. Failure to remove write permissions - * to this file is a security risk. - * - * The configuration file to be loaded is based upon the rules below. - * - * The configuration directory will be discovered by stripping the - * website's hostname from left to right and pathname from right to - * left. The first configuration file found will be used and any - * others will be ignored. If no other configuration file is found - * then the default configuration file at 'sites/default' will be used. + * This file may have been set to read-only by the Drupal installation program. + * If you make changes to this file, be sure to protect it again after making + * your modifications. Failure to remove write permissions to this file is a + * security risk. + * + * The configuration file to be loaded is based upon the rules below. However + * if the multisite aliasing file named sites/sites.php is present, it will be + * loaded, and the aliases in the array $sites will override the default + * directory rules below. See sites/example.sites.php for more information about + * aliases. + * + * The configuration directory will be discovered by stripping the website's + * hostname from left to right and pathname from right to left. The first + * configuration file found will be used and any others will be ignored. If no + * other configuration file is found then the default configuration file at + * 'sites/default' will be used. * * For example, for a fictitious site installed at - * http://www.drupal.org/mysite/test/, the 'settings.php' - * is searched in the following directories: + * http://www.drupal.org:8080/mysite/test/, the 'settings.php' file is searched + * for in the following directories: * + * - sites/8080.www.drupal.org.mysite.test * - sites/www.drupal.org.mysite.test * - sites/drupal.org.mysite.test * - sites/org.mysite.test * + * - sites/8080.www.drupal.org.mysite * - sites/www.drupal.org.mysite * - sites/drupal.org.mysite * - sites/org.mysite * + * - sites/8080.www.drupal.org * - sites/www.drupal.org * - sites/drupal.org * - sites/org * * - sites/default * - * If you are installing on a non-standard port number, prefix the + * Note that if you are installing on a non-standard port number, prefix the * hostname with that number. For example, * http://www.drupal.org:8080/mysite/test/ could be loaded from * sites/8080.www.drupal.org.mysite.test/. + * + * @see example.sites.php + * @see conf_path() */ /** @@ -483,30 +493,61 @@ $conf['404_fast_paths'] = '/\.(?:txt|png|gif|jpe?g|css|js|ico|swf|flv|cgi|bat|pl $conf['404_fast_html'] = '<html xmlns="http://www.w3.org/1999/xhtml"><head><title>404 Not Found</title></head><body><h1>Not Found</h1><p>The requested URL "@path" was not found on this server.</p></body></html>'; /** - * By default, fast 404s are returned as part of the normal page request - * process, which will properly serve valid pages that happen to match and will - * also log actual 404s to the Drupal log. Alternatively you can choose to - * return a 404 now by uncommenting the following line. This will reduce server - * load, but will cause even valid pages that happen to match the pattern to - * return 404s, rather than the actual page. It will also prevent the Drupal - * system log entry. Ensure you understand the effects of this before enabling. - * - * To enable this functionality, remove the leading hash sign below. + * By default the page request process will return a fast 404 page for missing + * files if they match the regular expression set in '404_fast_paths' and not + * '404_fast_paths_exclude' above. 404 errors will simultaneously be logged in + * the Drupal system log. + * + * You can choose to return a fast 404 page earlier for missing pages (as soon + * as settings.php is loaded) by uncommenting the line below. This speeds up + * server response time when loading 404 error pages and prevents the 404 error + * from being logged in the Drupal system log. In order to prevent valid pages + * such as image styles and other generated content that may match the + * '404_fast_html' regular expression from returning 404 errors, it is necessary + * to add them to the '404_fast_paths_exclude' regular expression above. Make + * sure that you understand the effects of this feature before uncommenting the + * line below. */ # drupal_fast_404(); /** + * External access proxy settings: + * + * If your site must access the Internet via a web proxy then you can enter + * the proxy settings here. Currently only basic authentication is supported + * by using the username and password variables. The proxy_user_agent variable + * can be set to NULL for proxies that require no User-Agent header or to a + * non-empty string for proxies that limit requests to a specific agent. The + * proxy_exceptions variable is an array of host names to be accessed directly, + * not via proxy. + */ +# $conf['proxy_server'] = ''; +# $conf['proxy_port'] = 8080; +# $conf['proxy_username'] = ''; +# $conf['proxy_password'] = ''; +# $conf['proxy_user_agent'] = ''; +# $conf['proxy_exceptions'] = array('127.0.0.1', 'localhost'); + +/** * Authorized file system operations: * * The Update manager module included with Drupal provides a mechanism for * site administrators to securely install missing updates for the site - * directly through the web user interface by providing either SSH or FTP - * credentials. This allows the site to update the new files as the user who - * owns all the Drupal files, instead of as the user the webserver is running - * as. However, some sites might wish to disable this functionality, and only - * update the code directly via SSH or FTP themselves. This setting completely + * directly through the web user interface. On securely-configured servers, + * the Update manager will require the administrator to provide SSH or FTP + * credentials before allowing the installation to proceed; this allows the + * site to update the new files as the user who owns all the Drupal files, + * instead of as the user the webserver is running as. On servers where the + * webserver user is itself the owner of the Drupal files, the administrator + * will not be prompted for SSH or FTP credentials (note that these server + * setups are common on shared hosting, but are inherently insecure). + * + * Some sites might wish to disable the above functionality, and only update + * the code directly via SSH or FTP themselves. This setting completely * disables all functionality related to these authorized file operations. * + * @see http://drupal.org/node/244924 + * * Remove the leading hash signs to disable. */ # $conf['allow_authorize_operations'] = FALSE; diff --git a/sites/example.sites.php b/sites/example.sites.php index 08c1020ff..2b00151d7 100644 --- a/sites/example.sites.php +++ b/sites/example.sites.php @@ -4,40 +4,52 @@ * @file * Configuration file for Drupal's multi-site directory aliasing feature. * - * Drupal searches for an appropriate configuration directory based on the - * website's hostname and pathname. A detailed description of the rules for - * discovering the configuration directory can be found in the comment - * documentation in 'sites/default/default.settings.php'. + * This file 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. * - * This file allows you to define a set of aliases that map hostnames and - * pathnames to configuration directories. These aliases are loaded prior to - * scanning for directories, and they are exempt from the normal discovery - * rules. The aliases are defined in an associative array named $sites, which - * should look similar to the following: + * 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. * + * To use this file, copy and rename it such that its path plus filename is + * 'sites/sites.php'. If you don't need to use multi-site directory aliasing, + * then you can safely ignore this file, and Drupal will ignore it too. + * + * Aliases are defined in an associative array named $sites. The array is + * written in the format: '<port>.<domain>.<path>' => 'directory'. As an + * example, to map http://www.drupal.org:8080/mysite/test to the configuration + * directory sites/example.com, the array should be defined as: + * @code * $sites = array( - * 'devexample.com' => 'example.com', - * 'localhost.example' => 'example.com', + * '8080.www.drupal.org.mysite.test' => 'example.com', * ); + * @endcode + * The URL, http://www.drupal.org:8080/mysite/test/, could be a symbolic link or + * an Apache Alias directive that points to the Drupal root containing + * index.php. An alias could also be created for a subdomain. See the + * @link http://drupal.org/documentation/install online Drupal installation guide @endlink + * for more information on setting up domains, subdomains, and subdirectories. * - * The above array will cause Drupal to look for a directory named - * "example.com" in the sites directory whenever a request comes from - * "example.com", "devexample.com", or "localhost/example". That is 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 into the database - * (files, system table, etc.) this will ensure the paths are correct while - * accessed on development servers. + * The following examples look for a site configuration in sites/example.com: + * @code + * URL: http://dev.drupal.org + * $sites['dev.drupal.org'] = 'example.com'; * - * To use this file, copy and rename it such that its path plus filename is - * 'sites/sites.php'. If you don't need to use multi-site directory aliasing, - * then you can safely ignore this file, and Drupal will ignore it too. - */ - -/** - * Multi-site directory aliasing: + * URL: http://localhost/example + * $sites['localhost.example'] = 'example.com'; + * + * URL: http://localhost:8080/example + * $sites['8080.localhost.example'] = 'example.com'; + * + * URL: http://www.drupal.org:8080/mysite/test/ + * $sites['8080.www.drupal.org.mysite.test'] = 'example.com'; + * @endcode * - * Edit the lines below to define directory aliases. Remove the leading hash - * signs to enable. + * @see default.settings.php + * @see conf_path() + * @see http://drupal.org/documentation/install/multi-site */ -# $sites['devexample.com'] = 'example.com'; -# $sites['localhost.example'] = 'example.com'; |