2001-03-10 11:07:52 +00:00
< ? php
2000-05-18 19:52:00 +00:00
2017-10-27 23:52:28 +00:00
// @codingStandardsIgnoreFile
2004-08-21 06:42:38 +00:00
/**
* @ file
* Drupal site - specific configuration file .
2005-02-18 18:44:33 +00:00
*
2006-12-30 15:28:33 +00:00
* IMPORTANT NOTE :
2012-08-20 16:43:07 +00:00
* 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 .
*
2014-02-04 19:20:11 +00:00
* In order to use the selection rules below the multisite aliasing file named
* sites / sites . php must be present . Its optional settings 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 .
2012-08-20 16:43:07 +00:00
*
* 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 .
2005-02-18 18:44:33 +00:00
*
2005-03-31 21:18:08 +00:00
* For example , for a fictitious site installed at
2015-05-24 20:08:46 +00:00
* https :// www . drupal . org : 8080 / mysite / test / , the 'settings.php' file is searched
2012-08-20 16:43:07 +00:00
* for in the following directories :
2005-02-18 18:44:33 +00:00
*
2012-08-20 16:43:07 +00:00
* - sites / 8080. www . drupal . org . mysite . test
2011-09-16 21:39:51 +00:00
* - sites / www . drupal . org . mysite . test
* - sites / drupal . org . mysite . test
* - sites / org . mysite . test
2005-02-18 18:44:33 +00:00
*
2012-08-20 16:43:07 +00:00
* - sites / 8080. www . drupal . org . mysite
2011-09-16 21:39:51 +00:00
* - sites / www . drupal . org . mysite
* - sites / drupal . org . mysite
* - sites / org . mysite
2005-02-18 18:44:33 +00:00
*
2012-08-20 16:43:07 +00:00
* - sites / 8080. www . drupal . org
2011-09-16 21:39:51 +00:00
* - sites / www . drupal . org
* - sites / drupal . org
* - sites / org
2005-02-18 18:44:33 +00:00
*
2011-09-16 21:39:51 +00:00
* - sites / default
2005-09-23 08:47:13 +00:00
*
2012-08-20 16:43:07 +00:00
* Note that if you are installing on a non - standard port number , prefix the
2006-05-07 00:08:36 +00:00
* hostname with that number . For example ,
2015-05-24 20:08:46 +00:00
* https :// www . drupal . org : 8080 / mysite / test / could be loaded from
2006-04-22 11:04:19 +00:00
* sites / 8080. www . drupal . org . mysite . test /.
2012-08-20 16:43:07 +00:00
*
* @ see example . sites . php
2015-06-09 12:15:19 +00:00
* @ see \Drupal\Core\DrupalKernel :: getSitePath ()
2014-05-19 14:42:27 +00:00
*
* In addition to customizing application settings through variables in
* settings . php , you can create a services . yml file in the same directory to
* register custom , site - specific service definitions and / or swap out default
* implementations with custom ones .
2004-08-21 06:42:38 +00:00
*/
2005-02-18 18:44:33 +00:00
/**
* Database settings :
*
2009-03-09 17:14:31 +00:00
* The $databases array specifies the database connection or
2008-08-21 19:36:39 +00:00
* connections that Drupal may use . Drupal is able to connect
* to multiple databases , including multiple types of databases ,
* during the same request .
*
2016-02-17 06:56:50 +00:00
* One example of the simplest connection array is shown below . To use the
* sample settings , copy and uncomment the code below between the @ code and
* @ endcode lines and paste it after the $databases declaration . You will need
* to replace the database username and password and possibly the host and port
* with the appropriate credentials for your database system .
*
* The next section describes how to customize the $databases array for more
* specific needs .
*
2010-07-20 21:12:47 +00:00
* @ code
2019-05-06 11:26:30 +00:00
* $databases [ 'default' ][ 'default' ] = [
2008-08-21 19:36:39 +00:00
* 'database' => 'databasename' ,
2016-02-17 06:56:50 +00:00
* 'username' => 'sqlusername' ,
* 'password' => 'sqlpassword' ,
2008-08-21 19:36:39 +00:00
* 'host' => 'localhost' ,
2016-02-17 06:56:50 +00:00
* 'port' => '3306' ,
* 'driver' => 'mysql' ,
* 'prefix' => '' ,
Issue #1314214 by stefan.r, phayes, ergophobe, YesCT, damienwhaley, kbasarab, Tor Arne Thune, basic, pfrenssen, yannickoo, simolokid, fietserwin, bzrudi71: MySQL driver does not support full UTF-8 (emojis, asian symbols, mathematical symbols)
2015-06-18 14:36:24 +00:00
* 'collation' => 'utf8mb4_general_ci' ,
2019-05-06 11:26:30 +00:00
* ];
2010-07-20 21:12:47 +00:00
* @ endcode
2016-02-17 06:56:50 +00:00
*/
2018-04-03 11:52:24 +00:00
$databases = [];
2016-02-17 06:56:50 +00:00
/**
* Customizing database settings .
*
* Many of the values of the $databases array can be customized for your
* particular database system . Refer to the sample in the section above as a
* starting point .
2008-08-21 19:36:39 +00:00
*
2009-03-09 17:14:31 +00:00
* The " driver " property indicates what Drupal database driver the
2008-08-21 19:36:39 +00:00
* connection should use . This is usually the same as the name of the
* database type , such as mysql or sqlite , but not always . The other
* properties will vary depending on the driver . For SQLite , you must
2010-01-30 07:59:26 +00:00
* specify a database file name in a directory that is writable by the
* webserver . For most other drivers , you must specify a
2009-11-28 08:51:09 +00:00
* username , password , host , and database name .
2008-08-21 19:36:39 +00:00
*
2012-02-05 03:15:32 +00:00
* Transaction support is enabled by default for all drivers that support it ,
* including MySQL . To explicitly disable it , set the 'transactions' key to
* FALSE .
* Note that some configurations of MySQL , such as the MyISAM engine , don ' t
* support it and will proceed silently even if enabled . If you experience
* transaction related crashes with such configuration , set the 'transactions'
* key to FALSE .
2008-08-21 19:36:39 +00:00
*
* For each database , you may optionally specify multiple " target " databases .
* A target database allows Drupal to try to send certain queries to a
* different database if it can but fall back to the default connection if not .
2014-06-14 02:31:56 +00:00
* That is useful for primary / replica replication , as Drupal may try to connect
* to a replica server when appropriate and if one is not available will simply
* fall back to the single primary server ( The terms primary / replica are
* traditionally referred to as master / slave in database server documentation ) .
2008-08-21 19:36:39 +00:00
*
* The general format for the $databases array is as follows :
2010-07-20 21:12:47 +00:00
* @ code
2008-08-21 19:36:39 +00:00
* $databases [ 'default' ][ 'default' ] = $info_array ;
2014-06-14 02:31:56 +00:00
* $databases [ 'default' ][ 'replica' ][] = $info_array ;
* $databases [ 'default' ][ 'replica' ][] = $info_array ;
2008-10-06 10:54:15 +00:00
* $databases [ 'extra' ][ 'default' ] = $info_array ;
2010-07-20 21:12:47 +00:00
* @ endcode
2008-08-21 19:36:39 +00:00
*
* In the above example , $info_array is an array of settings described above .
2014-06-14 02:31:56 +00:00
* The first line sets a " default " database that has one primary database
2008-08-21 19:36:39 +00:00
* ( the second level default ) . The second and third lines create an array
2014-06-14 02:31:56 +00:00
* of potential replica databases . Drupal will select one at random for a given
2008-08-21 19:36:39 +00:00
* request as needed . The fourth line creates a new database with a name of
2008-10-06 10:54:15 +00:00
* " extra " .
2008-08-21 19:36:39 +00:00
*
2005-04-08 14:14:24 +00:00
* You can optionally set prefixes for some or all database table names
2010-06-28 19:57:34 +00:00
* by using the 'prefix' setting . If a prefix is specified , the table
2005-04-08 14:14:24 +00:00
* name will be prepended with its value . Be sure to use valid database
* characters only , usually alphanumeric and underscore . If no prefixes
* are desired , leave it as an empty string '' .
*
2010-06-28 19:57:34 +00:00
* To have all database names prefixed , set 'prefix' as a string :
2010-07-20 21:12:47 +00:00
* @ code
2010-06-28 19:57:34 +00:00
* 'prefix' => 'main_' ,
2010-07-20 21:12:47 +00:00
* @ endcode
2016-08-05 08:33:50 +00:00
*
* Per - table prefixes are deprecated as of Drupal 8.2 , and will be removed in
* Drupal 9.0 . After that , only a single prefix for all tables will be
* supported .
*
2010-06-28 19:57:34 +00:00
* To provide prefixes for specific tables , set 'prefix' as an array .
2005-04-08 14:14:24 +00:00
* The array ' s keys are the table names and the values are the prefixes .
2010-06-28 19:57:34 +00:00
* The 'default' element is mandatory and holds the prefix for any tables
* not specified elsewhere in the array . Example :
2010-07-20 21:12:47 +00:00
* @ code
2019-05-06 11:26:30 +00:00
* 'prefix' => [
2005-04-08 14:14:24 +00:00
* 'default' => 'main_' ,
2010-06-28 19:57:34 +00:00
* 'users' => 'shared_' ,
2005-04-08 14:14:24 +00:00
* 'sessions' => 'shared_' ,
* 'role' => 'shared_' ,
* 'authmap' => 'shared_' ,
2019-05-06 11:26:30 +00:00
* ],
2010-07-20 21:12:47 +00:00
* @ endcode
2012-11-22 11:01:04 +00:00
* You can also use a reference to a schema / database as a prefix . This may be
2010-04-07 15:07:59 +00:00
* useful if your Drupal installation exists in a schema that is not the default
2010-05-26 19:51:01 +00:00
* or you want to access several databases from the same code base at the same
2010-04-07 15:07:59 +00:00
* time .
* Example :
2010-07-20 21:12:47 +00:00
* @ code
2019-05-06 11:26:30 +00:00
* 'prefix' => [
2010-06-28 19:57:34 +00:00
* 'default' => 'main.' ,
* 'users' => 'shared.' ,
2010-04-07 15:07:59 +00:00
* 'sessions' => 'shared.' ,
* 'role' => 'shared.' ,
* 'authmap' => 'shared.' ,
2019-05-06 11:26:30 +00:00
* ];
2010-07-20 21:12:47 +00:00
* @ endcode
2010-04-07 15:07:59 +00:00
* NOTE : MySQL and SQLite ' s definition of a schema is a database .
*
2011-11-28 14:58:50 +00:00
* Advanced users can add or override initial commands to execute when
* connecting to the database server , as well as PDO connection settings . For
* example , to enable MySQL SELECT queries to exceed the max_join_size system
* variable , and to reduce the database connection timeout to 5 seconds :
* @ code
2019-05-06 11:26:30 +00:00
* $databases [ 'default' ][ 'default' ] = [
* 'init_commands' => [
2011-11-28 14:58:50 +00:00
* 'big_selects' => 'SET SQL_BIG_SELECTS=1' ,
2019-05-06 11:26:30 +00:00
* ],
* 'pdo' => [
2011-11-28 14:58:50 +00:00
* PDO :: ATTR_TIMEOUT => 5 ,
2019-05-06 11:26:30 +00:00
* ],
* ];
2011-11-28 14:58:50 +00:00
* @ endcode
*
2016-02-17 06:56:50 +00:00
* WARNING : The above defaults are designed for database portability . Changing
* them may cause unexpected behavior , including potential data loss . See
* https :// www . drupal . org / developing / api / database / configuration for more
* information on these defaults and the potential issues .
2011-11-28 14:58:50 +00:00
*
2016-02-17 06:56:50 +00:00
* More details can be found in the constructor methods for each driver :
* - \Drupal\Core\Database\Driver\mysql\Connection :: __construct ()
* - \Drupal\Core\Database\Driver\pgsql\Connection :: __construct ()
* - \Drupal\Core\Database\Driver\sqlite\Connection :: __construct ()
2011-11-28 14:58:50 +00:00
*
2016-02-17 06:56:50 +00:00
* Sample Database configuration format for PostgreSQL ( pgsql ) :
2010-07-20 21:12:47 +00:00
* @ code
2019-05-06 11:26:30 +00:00
* $databases [ 'default' ][ 'default' ] = [
2008-08-21 19:36:39 +00:00
* 'driver' => 'pgsql' ,
* 'database' => 'databasename' ,
2016-02-17 06:56:50 +00:00
* 'username' => 'sqlusername' ,
* 'password' => 'sqlpassword' ,
2008-08-21 19:36:39 +00:00
* 'host' => 'localhost' ,
2010-06-28 19:57:34 +00:00
* 'prefix' => '' ,
2019-05-06 11:26:30 +00:00
* ];
2016-02-17 06:56:50 +00:00
* @ endcode
*
* Sample Database configuration format for SQLite ( sqlite ) :
* @ code
2019-05-06 11:26:30 +00:00
* $databases [ 'default' ][ 'default' ] = [
2008-08-21 19:36:39 +00:00
* 'driver' => 'sqlite' ,
2009-11-28 08:51:09 +00:00
* 'database' => '/path/to/databasefilename' ,
2019-05-06 11:26:30 +00:00
* ];
2010-07-20 21:12:47 +00:00
* @ endcode
2005-02-18 18:44:33 +00:00
*/
2003-07-10 17:46:44 +00:00
2011-09-05 08:47:32 +00:00
/**
* Location of the site configuration files .
*
2019-06-24 13:04:44 +00:00
* The $settings [ 'config_sync_directory' ] specifies the location of file system
* directory used for syncing configuration data . On install , the directory is
* created . This is used for configuration imports .
2015-10-22 23:06:38 +00:00
*
2019-06-24 13:04:44 +00:00
* The default location for this directory is inside a randomly - named
* directory in the public files path . The setting below allows you to set
* its location .
2011-09-05 08:47:32 +00:00
*/
2019-06-24 13:04:44 +00:00
# $settings['config_sync_directory'] = '/directory/outside/webroot';
2011-09-05 08:47:32 +00:00
2013-01-07 11:45:26 +00:00
/**
* Settings :
*
2014-02-04 19:04:39 +00:00
* $settings contains environment - specific configuration , such as the files
* directory and reverse proxy address , and temporary configuration , such as
2015-01-07 01:28:29 +00:00
* security overrides .
2013-01-07 11:45:26 +00:00
*
2014-06-26 10:47:01 +00:00
* @ see \Drupal\Core\Site\Settings :: get ()
2013-01-07 11:45:26 +00:00
*/
2014-02-20 12:29:03 +00:00
/**
* Salt for one - time login links , cancel links , form tokens , etc .
*
* This variable will be set to a random value by the installer . All one - time
* login links will be invalidated if the value is changed . Note that if your
* site is deployed on a cluster of web servers , you must ensure that this
* variable has the same value on each server .
*
2014-06-13 21:35:32 +00:00
* For enhanced security , you may set this variable to the contents of a file
* outside your document root ; you should also ensure that this file is not
* stored with backups of your database .
2014-02-20 12:29:03 +00:00
*
* Example :
* @ code
* $settings [ 'hash_salt' ] = file_get_contents ( '/home/example/salt.txt' );
* @ endcode
*/
$settings [ 'hash_salt' ] = '' ;
2015-06-24 15:05:10 +00:00
/**
* Deployment identifier .
*
* Drupal ' s dependency injection container will be automatically invalidated and
* rebuilt when the Drupal core version changes . When updating contributed or
* custom code that changes the container , changing this identifier will also
* allow the container to be invalidated as soon as code is deployed .
*/
# $settings['deployment_identifier'] = \Drupal::VERSION;
2013-01-07 11:45:26 +00:00
/**
* Access control for update . php script .
*
* If you are updating your Drupal installation using the update . php script but
* are not logged in using either an account with the " Administer software
* updates " permission or the site maintenance account (the account that was
* created during installation ), you will need to modify the access check
* statement below . Change the FALSE to a TRUE to disable the access check .
* After finishing the upgrade , be sure to open this file again and change the
* TRUE back to a FALSE !
*/
$settings [ 'update_free_access' ] = FALSE ;
2013-02-06 16:04:35 +00:00
2013-01-07 11:45:26 +00:00
/**
* External access proxy settings :
*
2016-01-18 17:28:31 +00:00
* If your site must access the Internet via a web proxy then you can enter the
* proxy settings here . Set the full URL of the proxy , including the port , in
* variables :
* - $settings [ 'http_client_config' ][ 'proxy' ][ 'http' ] : The proxy URL for HTTP
* requests .
* - $settings [ 'http_client_config' ][ 'proxy' ][ 'https' ] : The proxy URL for HTTPS
* requests .
* You can pass in the user name and password for basic authentication in the
* URLs in these settings .
*
* You can also define an array of host names that can be accessed directly ,
* bypassing the proxy , in $settings [ 'http_client_config' ][ 'proxy' ][ 'no' ] .
2013-01-07 11:45:26 +00:00
*/
2016-01-18 17:28:31 +00:00
# $settings['http_client_config']['proxy']['http'] = 'http://proxy_user:proxy_pass@example.com:8080';
# $settings['http_client_config']['proxy']['https'] = 'http://proxy_user:proxy_pass@example.com:8080';
# $settings['http_client_config']['proxy']['no'] = ['127.0.0.1', 'localhost'];
2013-01-07 11:45:26 +00:00
/**
* Reverse Proxy Configuration :
*
* Reverse proxy servers are often used to enhance the performance
* of heavily visited sites and may also provide other site caching ,
* security , or encryption benefits . In an environment where Drupal
* is behind a reverse proxy , the real IP address of the client should
* be determined such that the correct client IP address is available
* to Drupal ' s logging , statistics , and access management systems . In
* the most simple scenario , the proxy server will add an
* X - Forwarded - For header to the request that contains the client IP
* address . However , HTTP headers are vulnerable to spoofing , where a
* malicious client could bypass restrictions by setting the
* X - Forwarded - For header directly . Therefore , Drupal ' s proxy
* configuration requires the IP addresses of all remote proxies to be
* specified in $settings [ 'reverse_proxy_addresses' ] to work correctly .
*
2019-02-14 09:02:31 +00:00
* Enable this setting to get Drupal to determine the client IP from the
* X - Forwarded - For header . If you are unsure about this setting , do not have a
* reverse proxy , or Drupal operates in a shared hosting environment , this
* setting should remain commented out .
2013-01-07 11:45:26 +00:00
*
* In order for this setting to be used you must specify every possible
* reverse proxy IP address in $settings [ 'reverse_proxy_addresses' ] .
* If a complete list of reverse proxies is not available in your
* environment ( for example , if you use a CDN ) you may set the
* $_SERVER [ 'REMOTE_ADDR' ] variable directly in settings . php .
* Be aware , however , that it is likely that this would allow IP
* address spoofing unless more advanced precautions are taken .
*/
# $settings['reverse_proxy'] = TRUE;
/**
* Specify every reverse proxy IP address in your environment .
* This setting is required if $settings [ 'reverse_proxy' ] is TRUE .
*/
2018-04-03 11:52:24 +00:00
# $settings['reverse_proxy_addresses'] = ['a.b.c.d', ...];
2013-01-07 11:45:26 +00:00
/**
2019-02-14 09:02:31 +00:00
* Reverse proxy trusted headers .
*
* Sets which headers to trust from your reverse proxy .
*
* Common values are :
* - \Symfony\Component\HttpFoundation\Request :: HEADER_X_FORWARDED_ALL
* - \Symfony\Component\HttpFoundation\Request :: HEADER_FORWARDED
*
* Note the default value of
* @ code
* \Symfony\Component\HttpFoundation\Request :: HEADER_X_FORWARDED_ALL | \Symfony\Component\HttpFoundation\Request :: HEADER_FORWARDED
* @ endcode
* is not secure by default . The value should be set to only the specific
* headers the reverse proxy uses . For example :
* @ code
* \Symfony\Component\HttpFoundation\Request :: HEADER_X_FORWARDED_ALL
* @ endcode
* This would trust the following headers :
* - X_FORWARDED_FOR
* - X_FORWARDED_HOST
* - X_FORWARDED_PROTO
* - X_FORWARDED_PORT
*
* @ see \Symfony\Component\HttpFoundation\Request :: HEADER_X_FORWARDED_ALL
* @ see \Symfony\Component\HttpFoundation\Request :: HEADER_FORWARDED
* @ see \Symfony\Component\HttpFoundation\Request :: setTrustedProxies
2015-10-17 16:45:04 +00:00
*/
2019-02-14 09:02:31 +00:00
# $settings['reverse_proxy_trusted_headers'] = \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_ALL | \Symfony\Component\HttpFoundation\Request::HEADER_FORWARDED;
2015-10-17 16:45:04 +00:00
2013-01-07 11:45:26 +00:00
/**
* Page caching :
*
* By default , Drupal sends a " Vary: Cookie " HTTP header for anonymous page
* views . This tells a HTTP proxy that it may return a page from its local
* cache without contacting the web server , if the user sends the same Cookie
* header as the user who originally requested the cached page . Without " Vary:
* Cookie " , authenticated users would also be served the anonymous page from
* the cache . If the site has mostly anonymous users except a few known
* editors / administrators , the Vary header can be omitted . This allows for
* better caching in HTTP proxies ( including reverse proxies ), i . e . even if
* clients send different cookies , they still get content served from the cache .
* However , authenticated users should access the site directly ( i . e . not use an
* HTTP proxy , and bypass the reverse proxy if one is used ) in order to avoid
* getting cached pages from the proxy .
*/
# $settings['omit_vary_cookie'] = TRUE;
2016-05-16 23:23:29 +00:00
/**
* Cache TTL for client error ( 4 xx ) responses .
*
* Items cached per - URL tend to result in a large number of cache items , and
* this can be problematic on 404 pages which by their nature are unbounded . A
* fixed TTL can be set for these items , defaulting to one hour , so that cache
* backends which do not support LRU can purge older entries . To disable caching
* of client error responses set the value to 0. Currently applies only to
* page_cache module .
*/
# $settings['cache_ttl_4xx'] = 3600;
Issue #1286154 by mcdruid, cosmicdreams, das-peter, Cameron Tod, heddn, xjm, catch, tstoeckler, David_Rothstein, anavarre, tim.plunkett, naveenvalecha, dawehner: Allow custom default form cache expiration/lifetime
2017-07-01 19:00:47 +00:00
/**
* Expiration of cached forms .
*
* Drupal ' s Form API stores details of forms in a cache and these entries are
* kept for at least 6 hours by default . Expired entries are cleared by cron .
*
* @ see \Drupal\Core\Form\FormCache :: setCache ()
*/
# $settings['form_cache_expiration'] = 21600;
2016-05-16 23:23:29 +00:00
2013-01-07 11:45:26 +00:00
/**
* Class Loader .
*
2015-04-16 13:46:51 +00:00
* If the APC extension is detected , the Symfony APC class loader is used for
* performance reasons . Detection can be prevented by setting
* class_loader_auto_detect to false , as in the example below .
*/
# $settings['class_loader_auto_detect'] = FALSE;
/*
* If the APC extension is not detected , either because APC is missing or
* because auto - detection has been disabled , auto - loading falls back to
* Composer ' s ClassLoader , which is good for development as it does not break
* when code is moved in the file system . You can also decorate the base class
* loader with another cached solution than the Symfony APC class loader , as
* all production sites should have a cached class loader of some sort enabled .
*
* To do so , you may decorate and replace the local $class_loader variable . For
* example , to use Symfony ' s APC class loader without automatic detection ,
* uncomment the code below .
2013-01-07 11:45:26 +00:00
*/
2014-09-03 13:02:51 +00:00
/*
if ( $settings [ 'hash_salt' ]) {
2015-04-16 13:46:51 +00:00
$prefix = 'drupal.' . hash ( 'sha256' , 'drupal.' . $settings [ 'hash_salt' ]);
$apc_loader = new \Symfony\Component\ClassLoader\ApcClassLoader ( $prefix , $class_loader );
unset ( $prefix );
2014-09-03 13:02:51 +00:00
$class_loader -> unregister ();
$apc_loader -> register ();
$class_loader = $apc_loader ;
}
*/
2013-01-07 11:45:26 +00:00
/**
* 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 . 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 .
*
2015-05-24 20:08:46 +00:00
* @ see https :// www . drupal . org / node / 244924
2013-01-07 11:45:26 +00:00
*
* Remove the leading hash signs to disable .
*/
# $settings['allow_authorize_operations'] = FALSE;
2014-01-24 09:45:47 +00:00
/**
2015-10-15 10:02:38 +00:00
* Default mode for directories and files written by Drupal .
2014-01-24 09:45:47 +00:00
*
* Value should be in PHP Octal Notation , with leading zero .
*/
# $settings['file_chmod_directory'] = 0775;
# $settings['file_chmod_file'] = 0664;
2015-10-02 18:49:01 +00:00
/**
* Public file base URL :
*
* An alternative base URL to be used for serving public files . This must
* include any leading directory path .
*
* A different value from the domain used by Drupal to be used for accessing
* public files . This can be used for a simple CDN integration , or to improve
* security by serving user - uploaded files from a different domain or subdomain
* pointing to the same server . Do not include a trailing slash .
*/
# $settings['file_public_base_url'] = 'http://downloads.example.com/files';
2013-08-22 01:11:07 +00:00
/**
* Public file path :
*
* A local file system path where public files will be stored . This directory
* must exist and be writable by Drupal . This directory must be relative to
* the Drupal installation directory and be accessible over the web .
*/
# $settings['file_public_path'] = 'sites/default/files';
2014-12-14 13:01:24 +00:00
/**
* Private file path :
*
* A local file system path where private files will be stored . This directory
2015-04-01 12:45:55 +00:00
* must be absolute , outside of the Drupal installation directory and not
2014-12-14 13:01:24 +00:00
* accessible over the web .
*
2014-12-15 16:53:00 +00:00
* Note : Caches need to be cleared when this value is changed to make the
* private :// stream wrapper available to the system .
*
2015-05-24 20:08:46 +00:00
* See https :// www . drupal . org / documentation / modules / file for more information
* about securing private files .
2014-12-14 13:01:24 +00:00
*/
# $settings['file_private_path'] = '';
Issue #3039026 by kim.pepper, Berdir, Peter Majmesku, vadim.hirbu, YurkinPark, andypost, dww, claudiu.cristea, alexpott, jibran, dawehner, mikelutz: Deprecate file_directory_temp() and move to FileSystem service
2019-07-26 10:10:34 +00:00
/**
* Temporary file path :
*
* A local file system path where temporary files will be stored . This directory
* must be absolute , outside of the Drupal installation directory and not
* accessible over the web .
*
* If this is not set , the default for the operating system will be used .
*
* @ see \Drupal\Component\FileSystem\FileSystem :: getOsTemporaryDirectory ()
*/
# $settings['file_temp_path'] = '/tmp';
2013-04-18 08:30:42 +00:00
/**
* Session write interval :
*
* Set the minimum interval between each session write to database .
* For performance reasons it defaults to 180.
*/
# $settings['session_write_interval'] = 180;
2013-10-11 13:09:25 +00:00
/**
* String overrides :
*
* To override specific strings on your site with or without enabling the Locale
* module , add an entry to this list . This functionality allows you to change
* a small number of your site ' s default English language interface strings .
*
* Remove the leading hash signs to enable .
*
* The " en " part of the variable name , is dynamic and can be any langcode of
2014-05-04 17:19:57 +00:00
* any added language . ( eg locale_custom_strings_de for german ) .
2013-10-11 13:09:25 +00:00
*/
2018-04-03 11:52:24 +00:00
# $settings['locale_custom_strings_en'][''] = [
2013-10-11 13:09:25 +00:00
# 'forum' => 'Discussion board',
# '@count min' => '@count minutes',
2018-04-03 11:52:24 +00:00
# ];
2013-10-11 13:09:25 +00:00
2013-10-04 18:59:43 +00:00
/**
* A custom theme for the offline page :
*
* This applies when the site is explicitly set to maintenance mode through the
* administration page or when the database is inactive due to an error .
* The template file should also be copied into the theme . It is located inside
2013-10-09 15:29:56 +00:00
* 'core/modules/system/templates/maintenance-page.html.twig' .
*
2013-10-04 18:59:43 +00:00
* Note : This setting does not apply to installation and update pages .
*/
# $settings['maintenance_theme'] = 'bartik';
2005-02-18 18:44:33 +00:00
/**
* PHP settings :
*
2008-11-22 13:46:11 +00:00
* To see what PHP settings are possible , including whether they can be set at
2008-11-22 16:48:20 +00:00
* runtime ( by using ini_set ()), read the PHP documentation :
2012-03-24 06:14:35 +00:00
* http :// php . net / manual / ini . list . php
2014-06-26 10:47:01 +00:00
* See \Drupal\Core\DrupalKernel :: bootEnvironment () for required runtime
* settings and the . htaccess file for non - runtime settings .
2012-05-17 01:27:25 +00:00
* Settings defined there should not be duplicated here so as to avoid conflict
* issues .
2009-07-04 06:22:03 +00:00
*/
2010-06-25 18:07:07 +00:00
/**
* If you encounter a situation where users post a large amount of text , and
* the result is stripped out upon viewing but can still be edited , Drupal ' s
* output filter may not have sufficient memory to process it . If you
* experience this issue , you may wish to uncomment the following two lines
* and increase the limits of these variables . For more information , see
2012-03-24 06:14:35 +00:00
* http :// php . net / manual / pcre . configuration . php .
2010-06-25 18:07:07 +00:00
*/
# ini_set('pcre.backtrack_limit', 200000);
# ini_set('pcre.recursion_limit', 200000);
2005-02-18 18:44:33 +00:00
/**
2014-02-05 18:21:55 +00:00
* Configuration overrides .
2005-02-18 18:44:33 +00:00
*
2014-02-05 18:21:55 +00:00
* To globally override specific configuration values for this site ,
- Patch #18641 by Morbus:
# The INSTALL.txt no longer contains the SERVER CONFIGURATION block. These settings are now hardcoded into sites/default/settings.php, and are merely scary technical junk here.
# The INSTALL.txt has been updated with the latest system requirements. A whole sentence was struck regarding differing versions of PHP for the OSs.
# The INSTALL.txt contains URLs to MySQL and PostgreSQL. If we're including the URL for PHP in the same sentence, then there's no reason why we wouldn't include them for the database engines. What are the minimal requirements for the RDBMS? Those should be included here too.
# The INSTALL.txt's OPTIONAL COMPONENTS has renamed to OPTIONAL REQUIREMENTS. The only difference between the meaning is the amount of user confusion.
# The INSTALL.txt has a new CONTENTS OF THIS FILE, in hopes that people will more immediately notice that there are upgrade instructions at the bottom.
# The INSTALL.txt had some potentially confusing lines adjusted, including further clarifications, standarding to "userid" (instead of using both userid and username interchangebly) and so on.
# I've moved most of .htaccess php_value's to the ini_set system for /sites/. There are a few reasons for this, chiefly that it is centralizing all the PHP setting modifications to one place. But, this also clears up a few initial configuration issues: first, the user doesn't have to worry about whether they have Apache 1 or 2, and whether they need to change an IfModule line. Also, the running assumption is that these php_value's are /going to work by default anyways/, when the INSTALL.txt suggests otherwise (under OPTIONAL REQUIREMENTS, it talks about "the ability to use local .htaccess files", which suggests that "local .htaccess files" INCLUDING "mod_rewrite" are entirely optional.) Some variables, however, had to remain in .htaccess because they can't be overridden at runtime, but the amount was so small that duplicating them for both Apache 1 and Apache 2 possibilities is no longer a prohibitive concern.
# There are two variables in .htaccess that I'm concerned about: track_vars, and allow_call_time_pass_reference. track_vars appears to be no longer necessary (as of 4.0.3, track_vars is always on, and my setting it here had no impact on the results of a phpinfo), and allow_call_time_pass_reference seems, at least here, to ONLY WORK if the .htaccess value is set to "1", and not "On" - meaning that Drupal installations are currently working correctly with its default value (off). According to the PHP docs, this feature is now deprecated. However, since both of these variables require further investigation, track_vars has been moved to settings.php, and allow_call_time_pass_reference has been "fixed" to a 1 (not 'On').
# Along with the changes above for sites/default/settings.php, I've also removed the spacing indent in the documentation, as well as many a few grammatical/punctuation changes here and there. I don't think the leading spacing is "right" according to the style guidelines, but maybe there's a special need for it. Correct me if I'm wrong.
2005-03-12 10:51:32 +00:00
* set them here . You usually don ' t need to use this feature . This is
* useful in a configuration file for a vhost or directory , rather than
2014-02-05 18:21:55 +00:00
* the default settings . php .
*
* Note that any values you provide in these variable overrides will not be
2015-01-16 10:43:35 +00:00
* viewable from the Drupal administration interface . The administration
* interface displays the values stored in configuration so that you can stage
* changes to other environments that don ' t have the overrides .
*
* There are particular configuration values that are risky to override . For
* example , overriding the list of installed modules in 'core.extension' is not
* supported as module install or uninstall has not occurred . Other examples
* include field storage configuration , because it has effects on database
* structure , and 'core.menu.static_menu_link_overrides' since this is cached in
* a way that is not config override aware . Also , note that changing
* configuration values in settings . php will not fire any of the configuration
* change events .
2005-02-18 18:44:33 +00:00
*/
2014-02-05 18:21:55 +00:00
# $config['system.site']['name'] = 'My Drupal site';
# $config['user.settings']['anonymous'] = 'Visitor';
2010-10-11 23:49:48 +00:00
2011-09-14 20:24:19 +00:00
/**
* Fast 404 pages :
*
* Drupal can generate fully themed 404 pages . However , some of these responses
* are for images or other resource files that are not displayed to the user .
* This can waste bandwidth , and also generate server load .
*
* The options below return a simple , fast 404 page for URLs matching a
* specific pattern :
2015-09-15 10:04:58 +00:00
* - $config [ 'system.performance' ][ 'fast_404' ][ 'exclude_paths' ] : A regular
2013-03-10 19:14:36 +00:00
* expression to match paths to exclude , such as images generated by image
2015-08-31 14:19:06 +00:00
* styles , or dynamically - resized images . The default pattern provided below
* also excludes the private file system . If you need to add more paths , you
2013-03-10 19:14:36 +00:00
* can add '|path' to the expression .
2015-09-15 10:04:58 +00:00
* - $config [ 'system.performance' ][ 'fast_404' ][ 'paths' ] : A regular expression to
2013-03-10 19:14:36 +00:00
* match paths that should return a simple 404 page , rather than the fully
* themed 404 page . If you don ' t have any aliases ending in htm or html you
* can add '|s?html?' to the expression .
2015-09-15 10:04:58 +00:00
* - $config [ 'system.performance' ][ 'fast_404' ][ 'html' ] : The html to return for
2013-03-10 19:14:36 +00:00
* simple 404 pages .
2011-09-14 20:24:19 +00:00
*
2012-12-17 21:56:35 +00:00
* Remove the leading hash signs if you would like to alter this functionality .
2011-09-14 20:24:19 +00:00
*/
2015-08-31 14:19:06 +00:00
# $config['system.performance']['fast_404']['exclude_paths'] = '/\/(?:styles)|(?:system\/files)\//';
2014-02-05 18:21:55 +00:00
# $config['system.performance']['fast_404']['paths'] = '/\.(?:txt|png|gif|jpe?g|css|js|ico|swf|flv|cgi|bat|pl|dll|exe|asp)$/i';
# $config['system.performance']['fast_404']['html'] = '<!DOCTYPE html><html><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>';
2011-09-14 20:24:19 +00:00
2015-01-26 10:36:28 +00:00
/**
* Load services definition file .
*/
2016-11-26 22:52:45 +00:00
$settings [ 'container_yamls' ][] = $app_root . '/' . $site_path . '/services.yml' ;
2015-01-26 10:36:28 +00:00
2015-07-08 10:55:40 +00:00
/**
* Override the default service container class .
*
* This is useful for example to trace the service container for performance
* tracking purposes , for testing a service container with an error condition or
* to test a service container that throws an exception .
*/
# $settings['container_base_class'] = '\Drupal\Core\DependencyInjection\Container';
Issue #1920902 by neclimdul, larowlan, alexpott, chx, sun, jthorson, damiankloip, Berdir, Mixologic, YesCT, hussainweb, rcaracaus, cweagans, catch, jibran, msonnabaum, dawehner, webchick, anavarre, heyrocker: Add a Drupal Yaml wrapper so we can default to PECL Yaml component if it is available
2016-08-01 17:52:00 +00:00
/**
* Override the default yaml parser class .
*
* Provide a fully qualified class name here if you would like to provide an
* alternate implementation YAML parser . The class must implement the
* \Drupal\Component\Serialization\SerializationInterface interface .
*/
# $settings['yaml_parser_class'] = NULL;
2015-01-22 18:57:56 +00:00
/**
* Trusted host configuration .
*
* Drupal core can use the Symfony trusted host mechanism to prevent HTTP Host
* header spoofing .
*
* To enable the trusted host mechanism , you enable your allowable hosts
* in $settings [ 'trusted_host_patterns' ] . This should be an array of regular
* expression patterns , without delimiters , representing the hosts you would
* like to allow .
*
* For example :
* @ code
2019-05-06 11:26:30 +00:00
* $settings [ 'trusted_host_patterns' ] = [
2015-01-22 18:57:56 +00:00
* '^www\.example\.com$' ,
2019-05-06 11:26:30 +00:00
* ];
2015-01-22 18:57:56 +00:00
* @ endcode
* will allow the site to only run from www . example . com .
*
* If you are running multisite , or if you are running your site from
* different domain names ( eg , you don ' t redirect http :// www . example . com to
* http :// example . com ), you should specify all of the host patterns that are
* allowed by your site .
*
* For example :
* @ code
2019-05-06 11:26:30 +00:00
* $settings [ 'trusted_host_patterns' ] = [
2015-01-22 18:57:56 +00:00
* '^example\.com$' ,
* '^.+\.example\.com$' ,
2015-02-16 14:51:09 +00:00
* '^example\.org$' ,
* '^.+\.example\.org$' ,
2019-05-06 11:26:30 +00:00
* ];
2015-01-22 18:57:56 +00:00
* @ endcode
* will allow the site to run off of all variants of example . com and
* example . org , with all subdomains included .
*/
2015-02-15 20:16:54 +00:00
Issue #2329453 by alexpott, joelpittet, hussainweb, kaidjohnson, andriyun, JohnAlbin, mirie, steveoliver, quicksketch, geerlingguy, RobLoach, jenlampton, SebCorbin, pablo.guerino, afoster, markcarver, danbohea, andypost, catch, donquixote, marcvangend, David_Rothstein, LewisNyman, neclimdul: Ignore front end vendor folders to improve directory search performance
2016-07-20 21:06:16 +00:00
/**
* The default list of directories that will be ignored by Drupal ' s file API .
*
* By default ignore node_modules and bower_components folders to avoid issues
* with common frontend tools and recursive scanning of directories looking for
* extensions .
*
Issue #3035312 by kim.pepper, andypost, martin107, yogeshmpawar, naveenvalecha, pguillard, Berdir, dww, claudiu.cristea, jibran, Mile23: Move file_scan_directory() to file_system service
2019-07-24 10:29:08 +00:00
* @ see \Drupal\Core\File\FileSystemInterface :: scanDirectory ()
Issue #2329453 by alexpott, joelpittet, hussainweb, kaidjohnson, andriyun, JohnAlbin, mirie, steveoliver, quicksketch, geerlingguy, RobLoach, jenlampton, SebCorbin, pablo.guerino, afoster, markcarver, danbohea, andypost, catch, donquixote, marcvangend, David_Rothstein, LewisNyman, neclimdul: Ignore front end vendor folders to improve directory search performance
2016-07-20 21:06:16 +00:00
* @ see \Drupal\Core\Extension\ExtensionDiscovery :: scanDirectory ()
*/
$settings [ 'file_scan_ignore_directories' ] = [
'node_modules' ,
'bower_components' ,
];
2017-02-23 13:45:30 +00:00
/**
* The default number of entities to update in a batch process .
*
* This is used by update and post - update functions that need to go through and
* change all the entities on a site , so it is useful to increase this number
* if your hosting configuration ( i . e . RAM allocation , CPU speed ) allows for a
* larger number of entities to be processed in a single batch run .
*/
$settings [ 'entity_update_batch_size' ] = 50 ;
2019-04-11 11:31:40 +00:00
/**
* Entity update backup .
*
* This is used to inform the entity storage handler that the backup tables as
* well as the original entity type and field storage definitions should be
* retained after a successful entity update process .
*/
$settings [ 'entity_update_backup' ] = TRUE ;
2015-02-15 20:16:54 +00:00
/**
* Load local development override configuration , if available .
*
* Use settings . local . php to override variables on secondary ( staging ,
* development , etc ) installations of this site . Typically used to disable
* caching , JavaScript / CSS compression , re - routing of outgoing emails , and
* other things that should not happen on development and testing sites .
*
* Keep this code block at the end of this file to take full effect .
*/
2016-11-26 22:52:45 +00:00
#
# if (file_exists($app_root . '/' . $site_path . '/settings.local.php')) {
# include $app_root . '/' . $site_path . '/settings.local.php';
2015-02-15 20:16:54 +00:00
# }