default.settings.php

You are here

  1. 7 sites/default/default.settings.php
  2. 6 sites/default/default.settings.php
  3. 8 sites/default/default.settings.php

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. 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:8080/mysite/test/, the 'settings.php' file is searched for in the following directories:

  • sites/default

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 also

example.sites.php

conf_path()

File

sites/default/default.settings.php
View source
  1. <?php
  2. /**
  3. * @file
  4. * Drupal site-specific configuration file.
  5. *
  6. * IMPORTANT NOTE:
  7. * This file may have been set to read-only by the Drupal installation program.
  8. * If you make changes to this file, be sure to protect it again after making
  9. * your modifications. Failure to remove write permissions to this file is a
  10. * security risk.
  11. *
  12. * The configuration file to be loaded is based upon the rules below. However
  13. * if the multisite aliasing file named sites/sites.php is present, it will be
  14. * loaded, and the aliases in the array $sites will override the default
  15. * directory rules below. See sites/example.sites.php for more information about
  16. * aliases.
  17. *
  18. * The configuration directory will be discovered by stripping the website's
  19. * hostname from left to right and pathname from right to left. The first
  20. * configuration file found will be used and any others will be ignored. If no
  21. * other configuration file is found then the default configuration file at
  22. * 'sites/default' will be used.
  23. *
  24. * For example, for a fictitious site installed at
  25. * http://www.drupal.org:8080/mysite/test/, the 'settings.php' file is searched
  26. * for in the following directories:
  27. *
  28. * - sites/8080.www.drupal.org.mysite.test
  29. * - sites/www.drupal.org.mysite.test
  30. * - sites/drupal.org.mysite.test
  31. * - sites/org.mysite.test
  32. *
  33. * - sites/8080.www.drupal.org.mysite
  34. * - sites/www.drupal.org.mysite
  35. * - sites/drupal.org.mysite
  36. * - sites/org.mysite
  37. *
  38. * - sites/8080.www.drupal.org
  39. * - sites/www.drupal.org
  40. * - sites/drupal.org
  41. * - sites/org
  42. *
  43. * - sites/default
  44. *
  45. * Note that if you are installing on a non-standard port number, prefix the
  46. * hostname with that number. For example,
  47. * http://www.drupal.org:8080/mysite/test/ could be loaded from
  48. * sites/8080.www.drupal.org.mysite.test/.
  49. *
  50. * @see example.sites.php
  51. * @see conf_path()
  52. */
  53. /**
  54. * Database settings:
  55. *
  56. * The $databases array specifies the database connection or
  57. * connections that Drupal may use. Drupal is able to connect
  58. * to multiple databases, including multiple types of databases,
  59. * during the same request.
  60. *
  61. * Each database connection is specified as an array of settings,
  62. * similar to the following:
  63. * @code
  64. * array(
  65. * 'driver' => 'mysql',
  66. * 'database' => 'databasename',
  67. * 'username' => 'username',
  68. * 'password' => 'password',
  69. * 'host' => 'localhost',
  70. * 'port' => 3306,
  71. * 'prefix' => 'myprefix_',
  72. * 'collation' => 'utf8_general_ci',
  73. * );
  74. * @endcode
  75. *
  76. * The "driver" property indicates what Drupal database driver the
  77. * connection should use. This is usually the same as the name of the
  78. * database type, such as mysql or sqlite, but not always. The other
  79. * properties will vary depending on the driver. For SQLite, you must
  80. * specify a database file name in a directory that is writable by the
  81. * webserver. For most other drivers, you must specify a
  82. * username, password, host, and database name.
  83. *
  84. * Some database engines support transactions. In order to enable
  85. * transaction support for a given database, set the 'transactions' key
  86. * to TRUE. To disable it, set it to FALSE. Note that the default value
  87. * varies by driver. For MySQL, the default is FALSE since MyISAM tables
  88. * do not support transactions.
  89. *
  90. * For each database, you may optionally specify multiple "target" databases.
  91. * A target database allows Drupal to try to send certain queries to a
  92. * different database if it can but fall back to the default connection if not.
  93. * That is useful for master/slave replication, as Drupal may try to connect
  94. * to a slave server when appropriate and if one is not available will simply
  95. * fall back to the single master server.
  96. *
  97. * The general format for the $databases array is as follows:
  98. * @code
  99. * $databases['default']['default'] = $info_array;
  100. * $databases['default']['slave'][] = $info_array;
  101. * $databases['default']['slave'][] = $info_array;
  102. * $databases['extra']['default'] = $info_array;
  103. * @endcode
  104. *
  105. * In the above example, $info_array is an array of settings described above.
  106. * The first line sets a "default" database that has one master database
  107. * (the second level default). The second and third lines create an array
  108. * of potential slave databases. Drupal will select one at random for a given
  109. * request as needed. The fourth line creates a new database with a name of
  110. * "extra".
  111. *
  112. * For a single database configuration, the following is sufficient:
  113. * @code
  114. * $databases['default']['default'] = array(
  115. * 'driver' => 'mysql',
  116. * 'database' => 'databasename',
  117. * 'username' => 'username',
  118. * 'password' => 'password',
  119. * 'host' => 'localhost',
  120. * 'prefix' => 'main_',
  121. * 'collation' => 'utf8_general_ci',
  122. * );
  123. * @endcode
  124. *
  125. * You can optionally set prefixes for some or all database table names
  126. * by using the 'prefix' setting. If a prefix is specified, the table
  127. * name will be prepended with its value. Be sure to use valid database
  128. * characters only, usually alphanumeric and underscore. If no prefixes
  129. * are desired, leave it as an empty string ''.
  130. *
  131. * To have all database names prefixed, set 'prefix' as a string:
  132. * @code
  133. * 'prefix' => 'main_',
  134. * @endcode
  135. * To provide prefixes for specific tables, set 'prefix' as an array.
  136. * The array's keys are the table names and the values are the prefixes.
  137. * The 'default' element is mandatory and holds the prefix for any tables
  138. * not specified elsewhere in the array. Example:
  139. * @code
  140. * 'prefix' => array(
  141. * 'default' => 'main_',
  142. * 'users' => 'shared_',
  143. * 'sessions' => 'shared_',
  144. * 'role' => 'shared_',
  145. * 'authmap' => 'shared_',
  146. * ),
  147. * @endcode
  148. * You can also use a reference to a schema/database as a prefix. This may be
  149. * useful if your Drupal installation exists in a schema that is not the default
  150. * or you want to access several databases from the same code base at the same
  151. * time.
  152. * Example:
  153. * @code
  154. * 'prefix' => array(
  155. * 'default' => 'main.',
  156. * 'users' => 'shared.',
  157. * 'sessions' => 'shared.',
  158. * 'role' => 'shared.',
  159. * 'authmap' => 'shared.',
  160. * );
  161. * @endcode
  162. * NOTE: MySQL and SQLite's definition of a schema is a database.
  163. *
  164. * Advanced users can add or override initial commands to execute when
  165. * connecting to the database server, as well as PDO connection settings. For
  166. * example, to enable MySQL SELECT queries to exceed the max_join_size system
  167. * variable, and to reduce the database connection timeout to 5 seconds:
  168. *
  169. * @code
  170. * $databases['default']['default'] = array(
  171. * 'init_commands' => array(
  172. * 'big_selects' => 'SET SQL_BIG_SELECTS=1',
  173. * ),
  174. * 'pdo' => array(
  175. * PDO::ATTR_TIMEOUT => 5,
  176. * ),
  177. * );
  178. * @endcode
  179. *
  180. * WARNING: These defaults are designed for database portability. Changing them
  181. * may cause unexpected behavior, including potential data loss.
  182. *
  183. * @see DatabaseConnection_mysql::__construct
  184. * @see DatabaseConnection_pgsql::__construct
  185. * @see DatabaseConnection_sqlite::__construct
  186. *
  187. * Database configuration format:
  188. * @code
  189. * $databases['default']['default'] = array(
  190. * 'driver' => 'mysql',
  191. * 'database' => 'databasename',
  192. * 'username' => 'username',
  193. * 'password' => 'password',
  194. * 'host' => 'localhost',
  195. * 'prefix' => '',
  196. * );
  197. * $databases['default']['default'] = array(
  198. * 'driver' => 'pgsql',
  199. * 'database' => 'databasename',
  200. * 'username' => 'username',
  201. * 'password' => 'password',
  202. * 'host' => 'localhost',
  203. * 'prefix' => '',
  204. * );
  205. * $databases['default']['default'] = array(
  206. * 'driver' => 'sqlite',
  207. * 'database' => '/path/to/databasefilename',
  208. * );
  209. * @endcode
  210. */
  211. $databases = array();
  212. /**
  213. * Access control for update.php script.
  214. *
  215. * If you are updating your Drupal installation using the update.php script but
  216. * are not logged in using either an account with the "Administer software
  217. * updates" permission or the site maintenance account (the account that was
  218. * created during installation), you will need to modify the access check
  219. * statement below. Change the FALSE to a TRUE to disable the access check.
  220. * After finishing the upgrade, be sure to open this file again and change the
  221. * TRUE back to a FALSE!
  222. */
  223. $update_free_access = FALSE;
  224. /**
  225. * Salt for one-time login links and cancel links, form tokens, etc.
  226. *
  227. * This variable will be set to a random value by the installer. All one-time
  228. * login links will be invalidated if the value is changed. Note that if your
  229. * site is deployed on a cluster of web servers, you must ensure that this
  230. * variable has the same value on each server. If this variable is empty, a hash
  231. * of the serialized database credentials will be used as a fallback salt.
  232. *
  233. * For enhanced security, you may set this variable to a value using the
  234. * contents of a file outside your docroot that is never saved together
  235. * with any backups of your Drupal files and database.
  236. *
  237. * Example:
  238. * $drupal_hash_salt = file_get_contents('/home/example/salt.txt');
  239. *
  240. */
  241. $drupal_hash_salt = '';
  242. /**
  243. * Base URL (optional).
  244. *
  245. * If Drupal is generating incorrect URLs on your site, which could
  246. * be in HTML headers (links to CSS and JS files) or visible links on pages
  247. * (such as in menus), uncomment the Base URL statement below (remove the
  248. * leading hash sign) and fill in the absolute URL to your Drupal installation.
  249. *
  250. * You might also want to force users to use a given domain.
  251. * See the .htaccess file for more information.
  252. *
  253. * Examples:
  254. * $base_url = 'http://www.example.com';
  255. * $base_url = 'http://www.example.com:8888';
  256. * $base_url = 'http://www.example.com/drupal';
  257. * $base_url = 'https://www.example.com:8888/drupal';
  258. *
  259. * It is not allowed to have a trailing slash; Drupal will add it
  260. * for you.
  261. */
  262. # $base_url = 'http://www.example.com'; // NO trailing slash!
  263. /**
  264. * PHP settings:
  265. *
  266. * To see what PHP settings are possible, including whether they can be set at
  267. * runtime (by using ini_set()), read the PHP documentation:
  268. * http://www.php.net/manual/ini.list.php
  269. * See drupal_environment_initialize() in includes/bootstrap.inc for required
  270. * runtime settings and the .htaccess file for non-runtime settings. Settings
  271. * defined there should not be duplicated here so as to avoid conflict issues.
  272. */
  273. /**
  274. * Some distributions of Linux (most notably Debian) ship their PHP
  275. * installations with garbage collection (gc) disabled. Since Drupal depends on
  276. * PHP's garbage collection for clearing sessions, ensure that garbage
  277. * collection occurs by using the most common settings.
  278. */
  279. ini_set('session.gc_probability', 1);
  280. ini_set('session.gc_divisor', 100);
  281. /**
  282. * Set session lifetime (in seconds), i.e. the time from the user's last visit
  283. * to the active session may be deleted by the session garbage collector. When
  284. * a session is deleted, authenticated users are logged out, and the contents
  285. * of the user's $_SESSION variable is discarded.
  286. */
  287. ini_set('session.gc_maxlifetime', 200000);
  288. /**
  289. * Set session cookie lifetime (in seconds), i.e. the time from the session is
  290. * created to the cookie expires, i.e. when the browser is expected to discard
  291. * the cookie. The value 0 means "until the browser is closed".
  292. */
  293. ini_set('session.cookie_lifetime', 2000000);
  294. /**
  295. * If you encounter a situation where users post a large amount of text, and
  296. * the result is stripped out upon viewing but can still be edited, Drupal's
  297. * output filter may not have sufficient memory to process it. If you
  298. * experience this issue, you may wish to uncomment the following two lines
  299. * and increase the limits of these variables. For more information, see
  300. * http://php.net/manual/pcre.configuration.php.
  301. */
  302. # ini_set('pcre.backtrack_limit', 200000);
  303. # ini_set('pcre.recursion_limit', 200000);
  304. /**
  305. * Drupal automatically generates a unique session cookie name for each site
  306. * based on its full domain name. If you have multiple domains pointing at the
  307. * same Drupal site, you can either redirect them all to a single domain (see
  308. * comment in .htaccess), or uncomment the line below and specify their shared
  309. * base domain. Doing so assures that users remain logged in as they cross
  310. * between your various domains. Make sure to always start the $cookie_domain
  311. * with a leading dot, as per RFC 2109.
  312. */
  313. # $cookie_domain = '.example.com';
  314. /**
  315. * Variable overrides:
  316. *
  317. * To override specific entries in the 'variable' table for this site,
  318. * set them here. You usually don't need to use this feature. This is
  319. * useful in a configuration file for a vhost or directory, rather than
  320. * the default settings.php. Any configuration setting from the 'variable'
  321. * table can be given a new value. Note that any values you provide in
  322. * these variable overrides will not be modifiable from the Drupal
  323. * administration interface.
  324. *
  325. * The following overrides are examples:
  326. * - site_name: Defines the site's name.
  327. * - theme_default: Defines the default theme for this site.
  328. * - anonymous: Defines the human-readable name of anonymous users.
  329. * Remove the leading hash signs to enable.
  330. */
  331. # $conf['site_name'] = 'My Drupal site';
  332. # $conf['theme_default'] = 'garland';
  333. # $conf['anonymous'] = 'Visitor';
  334. /**
  335. * A custom theme can be set for the offline page. This applies when the site
  336. * is explicitly set to maintenance mode through the administration page or when
  337. * the database is inactive due to an error. It can be set through the
  338. * 'maintenance_theme' key. The template file should also be copied into the
  339. * theme. It is located inside 'modules/system/maintenance-page.tpl.php'.
  340. * Note: This setting does not apply to installation and update pages.
  341. */
  342. # $conf['maintenance_theme'] = 'bartik';
  343. /**
  344. * Reverse Proxy Configuration:
  345. *
  346. * Reverse proxy servers are often used to enhance the performance
  347. * of heavily visited sites and may also provide other site caching,
  348. * security, or encryption benefits. In an environment where Drupal
  349. * is behind a reverse proxy, the real IP address of the client should
  350. * be determined such that the correct client IP address is available
  351. * to Drupal's logging, statistics, and access management systems. In
  352. * the most simple scenario, the proxy server will add an
  353. * X-Forwarded-For header to the request that contains the client IP
  354. * address. However, HTTP headers are vulnerable to spoofing, where a
  355. * malicious client could bypass restrictions by setting the
  356. * X-Forwarded-For header directly. Therefore, Drupal's proxy
  357. * configuration requires the IP addresses of all remote proxies to be
  358. * specified in $conf['reverse_proxy_addresses'] to work correctly.
  359. *
  360. * Enable this setting to get Drupal to determine the client IP from
  361. * the X-Forwarded-For header (or $conf['reverse_proxy_header'] if set).
  362. * If you are unsure about this setting, do not have a reverse proxy,
  363. * or Drupal operates in a shared hosting environment, this setting
  364. * should remain commented out.
  365. *
  366. * In order for this setting to be used you must specify every possible
  367. * reverse proxy IP address in $conf['reverse_proxy_addresses'].
  368. * If a complete list of reverse proxies is not available in your
  369. * environment (for example, if you use a CDN) you may set the
  370. * $_SERVER['REMOTE_ADDR'] variable directly in settings.php.
  371. * Be aware, however, that it is likely that this would allow IP
  372. * address spoofing unless more advanced precautions are taken.
  373. */
  374. # $conf['reverse_proxy'] = TRUE;
  375. /**
  376. * Specify every reverse proxy IP address in your environment.
  377. * This setting is required if $conf['reverse_proxy'] is TRUE.
  378. */
  379. # $conf['reverse_proxy_addresses'] = array('a.b.c.d', ...);
  380. /**
  381. * Set this value if your proxy server sends the client IP in a header
  382. * other than X-Forwarded-For.
  383. */
  384. # $conf['reverse_proxy_header'] = 'HTTP_X_CLUSTER_CLIENT_IP';
  385. /**
  386. * Page caching:
  387. *
  388. * By default, Drupal sends a "Vary: Cookie" HTTP header for anonymous page
  389. * views. This tells a HTTP proxy that it may return a page from its local
  390. * cache without contacting the web server, if the user sends the same Cookie
  391. * header as the user who originally requested the cached page. Without "Vary:
  392. * Cookie", authenticated users would also be served the anonymous page from
  393. * the cache. If the site has mostly anonymous users except a few known
  394. * editors/administrators, the Vary header can be omitted. This allows for
  395. * better caching in HTTP proxies (including reverse proxies), i.e. even if
  396. * clients send different cookies, they still get content served from the cache.
  397. * However, authenticated users should access the site directly (i.e. not use an
  398. * HTTP proxy, and bypass the reverse proxy if one is used) in order to avoid
  399. * getting cached pages from the proxy.
  400. */
  401. # $conf['omit_vary_cookie'] = TRUE;
  402. /**
  403. * CSS/JS aggregated file gzip compression:
  404. *
  405. * By default, when CSS or JS aggregation and clean URLs are enabled Drupal will
  406. * store a gzip compressed (.gz) copy of the aggregated files. If this file is
  407. * available then rewrite rules in the default .htaccess file will serve these
  408. * files to browsers that accept gzip encoded content. This allows pages to load
  409. * faster for these users and has minimal impact on server load. If you are
  410. * using a webserver other than Apache httpd, or a caching reverse proxy that is
  411. * configured to cache and compress these files itself you may want to uncomment
  412. * one or both of the below lines, which will prevent gzip files being stored.
  413. */
  414. # $conf['css_gzip_compression'] = FALSE;
  415. # $conf['js_gzip_compression'] = FALSE;
  416. /**
  417. * String overrides:
  418. *
  419. * To override specific strings on your site with or without enabling the Locale
  420. * module, add an entry to this list. This functionality allows you to change
  421. * a small number of your site's default English language interface strings.
  422. *
  423. * Remove the leading hash signs to enable.
  424. */
  425. # $conf['locale_custom_strings_en'][''] = array(
  426. # 'forum' => 'Discussion board',
  427. # '@count min' => '@count minutes',
  428. # );
  429. /**
  430. *
  431. * IP blocking:
  432. *
  433. * To bypass database queries for denied IP addresses, use this setting.
  434. * Drupal queries the {blocked_ips} table by default on every page request
  435. * for both authenticated and anonymous users. This allows the system to
  436. * block IP addresses from within the administrative interface and before any
  437. * modules are loaded. However on high traffic websites you may want to avoid
  438. * this query, allowing you to bypass database access altogether for anonymous
  439. * users under certain caching configurations.
  440. *
  441. * If using this setting, you will need to add back any IP addresses which
  442. * you may have blocked via the administrative interface. Each element of this
  443. * array represents a blocked IP address. Uncommenting the array and leaving it
  444. * empty will have the effect of disabling IP blocking on your site.
  445. *
  446. * Remove the leading hash signs to enable.
  447. */
  448. # $conf['blocked_ips'] = array(
  449. # 'a.b.c.d',
  450. # );
  451. /**
  452. * Fast 404 pages:
  453. *
  454. * Drupal can generate fully themed 404 pages. However, some of these responses
  455. * are for images or other resource files that are not displayed to the user.
  456. * This can waste bandwidth, and also generate server load.
  457. *
  458. * The options below return a simple, fast 404 page for URLs matching a
  459. * specific pattern:
  460. * - 404_fast_paths_exclude: A regular expression to match paths to exclude,
  461. * such as images generated by image styles, or dynamically-resized images.
  462. * If you need to add more paths, you can add '|path' to the expression.
  463. * - 404_fast_paths: A regular expression to match paths that should return a
  464. * simple 404 page, rather than the fully themed 404 page. If you don't have
  465. * any aliases ending in htm or html you can add '|s?html?' to the expression.
  466. * - 404_fast_html: The html to return for simple 404 pages.
  467. *
  468. * Add leading hash signs if you would like to disable this functionality.
  469. */
  470. $conf['404_fast_paths_exclude'] = '/\/(?:styles)\//';
  471. $conf['404_fast_paths'] = '/\.(?:txt|png|gif|jpe?g|css|js|ico|swf|flv|cgi|bat|pl|dll|exe|asp)$/i';
  472. $conf['404_fast_html'] = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd"><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>';
  473. /**
  474. * By default the page request process will return a fast 404 page for missing
  475. * files if they match the regular expression set in '404_fast_paths' and not
  476. * '404_fast_paths_exclude' above. 404 errors will simultaneously be logged in
  477. * the Drupal system log.
  478. *
  479. * You can choose to return a fast 404 page earlier for missing pages (as soon
  480. * as settings.php is loaded) by uncommenting the line below. This speeds up
  481. * server response time when loading 404 error pages and prevents the 404 error
  482. * from being logged in the Drupal system log. In order to prevent valid pages
  483. * such as image styles and other generated content that may match the
  484. * '404_fast_html' regular expression from returning 404 errors, it is necessary
  485. * to add them to the '404_fast_paths_exclude' regular expression above. Make
  486. * sure that you understand the effects of this feature before uncommenting the
  487. * line below.
  488. */
  489. # drupal_fast_404();
  490. /**
  491. * External access proxy settings:
  492. *
  493. * If your site must access the Internet via a web proxy then you can enter
  494. * the proxy settings here. Currently only basic authentication is supported
  495. * by using the username and password variables. The proxy_user_agent variable
  496. * can be set to NULL for proxies that require no User-Agent header or to a
  497. * non-empty string for proxies that limit requests to a specific agent. The
  498. * proxy_exceptions variable is an array of host names to be accessed directly,
  499. * not via proxy.
  500. */
  501. # $conf['proxy_server'] = '';
  502. # $conf['proxy_port'] = 8080;
  503. # $conf['proxy_username'] = '';
  504. # $conf['proxy_password'] = '';
  505. # $conf['proxy_user_agent'] = '';
  506. # $conf['proxy_exceptions'] = array('127.0.0.1', 'localhost');
  507. /**
  508. * Authorized file system operations:
  509. *
  510. * The Update manager module included with Drupal provides a mechanism for
  511. * site administrators to securely install missing updates for the site
  512. * directly through the web user interface. On securely-configured servers,
  513. * the Update manager will require the administrator to provide SSH or FTP
  514. * credentials before allowing the installation to proceed; this allows the
  515. * site to update the new files as the user who owns all the Drupal files,
  516. * instead of as the user the webserver is running as. On servers where the
  517. * webserver user is itself the owner of the Drupal files, the administrator
  518. * will not be prompted for SSH or FTP credentials (note that these server
  519. * setups are common on shared hosting, but are inherently insecure).
  520. *
  521. * Some sites might wish to disable the above functionality, and only update
  522. * the code directly via SSH or FTP themselves. This setting completely
  523. * disables all functionality related to these authorized file operations.
  524. *
  525. * @see http://drupal.org/node/244924
  526. *
  527. * Remove the leading hash signs to disable.
  528. */
  529. # $conf['allow_authorize_operations'] = FALSE;