default.settings.php 30.2 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
Dries's avatar
Dries committed
2

3 4
// @codingStandardsIgnoreFile

Dries's avatar
 
Dries committed
5 6 7
/**
 * @file
 * Drupal site-specific configuration file.
8
 *
9
 * IMPORTANT NOTE:
10 11 12 13 14
 * 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.
 *
15 16 17 18
 * 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.
19 20 21 22 23 24
 *
 * 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.
25
 *
26
 * For example, for a fictitious site installed at
27
 * https://www.drupal.org:8080/mysite/test/, the 'settings.php' file is searched
28
 * for in the following directories:
29
 *
30
 * - sites/8080.www.drupal.org.mysite.test
31 32 33
 * - sites/www.drupal.org.mysite.test
 * - sites/drupal.org.mysite.test
 * - sites/org.mysite.test
34
 *
35
 * - sites/8080.www.drupal.org.mysite
36 37 38
 * - sites/www.drupal.org.mysite
 * - sites/drupal.org.mysite
 * - sites/org.mysite
39
 *
40
 * - sites/8080.www.drupal.org
41 42 43
 * - sites/www.drupal.org
 * - sites/drupal.org
 * - sites/org
44
 *
45
 * - sites/default
46
 *
47
 * Note that if you are installing on a non-standard port number, prefix the
48
 * hostname with that number. For example,
49
 * https://www.drupal.org:8080/mysite/test/ could be loaded from
50
 * sites/8080.www.drupal.org.mysite.test/.
51 52
 *
 * @see example.sites.php
53
 * @see \Drupal\Core\DrupalKernel::getSitePath()
54 55 56 57 58
 *
 * 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.
Dries's avatar
 
Dries committed
59 60
 */

61 62 63
/**
 * Database settings:
 *
64
 * The $databases array specifies the database connection or
65 66 67 68
 * connections that Drupal may use.  Drupal is able to connect
 * to multiple databases, including multiple types of databases,
 * during the same request.
 *
69 70 71 72 73 74 75 76 77
 * 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.
 *
78
 * @code
79
 * $databases['default']['default'] = [
80
 *   'database' => 'databasename',
81 82
 *   'username' => 'sqlusername',
 *   'password' => 'sqlpassword',
83
 *   'host' => 'localhost',
84 85 86
 *   'port' => '3306',
 *   'driver' => 'mysql',
 *   'prefix' => '',
87
 *   'collation' => 'utf8mb4_general_ci',
88
 * ];
89
 * @endcode
90
 */
91
$databases = [];
92 93 94 95 96 97 98

/**
 * 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.
99
 *
100
 * The "driver" property indicates what Drupal database driver the
101 102 103
 * 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
104 105
 * specify a database file name in a directory that is writable by the
 * webserver.  For most other drivers, you must specify a
106
 * username, password, host, and database name.
107
 *
108 109 110 111 112 113 114 115 116 117
 * Drupal core implements drivers for mysql, pgsql, and sqlite. Other drivers
 * can be provided by contributed or custom modules. To use a contributed or
 * custom driver, the "namespace" property must be set to the namespace of the
 * driver. The code in this namespace must be autoloadable prior to connecting
 * to the database, and therefore, prior to when module root namespaces are
 * added to the autoloader. To add the driver's namespace to the autoloader,
 * set the "autoload" property to the PSR-4 base directory of the driver's
 * namespace. This is optional for projects managed with Composer if the
 * driver's namespace is in Composer's autoloader.
 *
118 119 120 121 122 123 124
 * 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.
125 126 127 128
 *
 * 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.
129 130 131 132
 * 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).
133 134
 *
 * The general format for the $databases array is as follows:
135
 * @code
136
 * $databases['default']['default'] = $info_array;
137 138
 * $databases['default']['replica'][] = $info_array;
 * $databases['default']['replica'][] = $info_array;
139
 * $databases['extra']['default'] = $info_array;
140
 * @endcode
141 142
 *
 * In the above example, $info_array is an array of settings described above.
143
 * The first line sets a "default" database that has one primary database
144
 * (the second level default).  The second and third lines create an array
145
 * of potential replica databases.  Drupal will select one at random for a given
146
 * request as needed.  The fourth line creates a new database with a name of
147
 * "extra".
148
 *
149
 * You can optionally set prefixes for some or all database table names
150
 * by using the 'prefix' setting. If a prefix is specified, the table
151 152 153 154
 * 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 ''.
 *
155
 * To have all database names prefixed, set 'prefix' as a string:
156
 * @code
157
 *   'prefix' => 'main_',
158
 * @endcode
159 160 161 162 163
 *
 * 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.
 *
164
 * To provide prefixes for specific tables, set 'prefix' as an array.
165
 * The array's keys are the table names and the values are the prefixes.
166 167
 * The 'default' element is mandatory and holds the prefix for any tables
 * not specified elsewhere in the array. Example:
168
 * @code
169
 *   'prefix' => [
170
 *     'default'   => 'main_',
171
 *     'users'     => 'shared_',
172 173 174
 *     'sessions'  => 'shared_',
 *     'role'      => 'shared_',
 *     'authmap'   => 'shared_',
175
 *   ],
176
 * @endcode
177
 * You can also use a reference to a schema/database as a prefix. This may be
178
 * useful if your Drupal installation exists in a schema that is not the default
179
 * or you want to access several databases from the same code base at the same
180 181
 * time.
 * Example:
182
 * @code
183
 *   'prefix' => [
184 185
 *     'default'   => 'main.',
 *     'users'     => 'shared.',
186 187 188
 *     'sessions'  => 'shared.',
 *     'role'      => 'shared.',
 *     'authmap'   => 'shared.',
189
 *   ];
190
 * @endcode
191 192
 * NOTE: MySQL and SQLite's definition of a schema is a database.
 *
193 194 195 196 197
 * 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
198 199
 * $databases['default']['default'] = [
 *   'init_commands' => [
200
 *     'big_selects' => 'SET SQL_BIG_SELECTS=1',
201 202
 *   ],
 *   'pdo' => [
203
 *     PDO::ATTR_TIMEOUT => 5,
204 205
 *   ],
 * ];
206 207
 * @endcode
 *
208 209 210 211
 * 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.
212
 *
213 214 215 216
 * 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()
217
 *
218
 * Sample Database configuration format for PostgreSQL (pgsql):
219
 * @code
220
 *   $databases['default']['default'] = [
221 222
 *     'driver' => 'pgsql',
 *     'database' => 'databasename',
223 224
 *     'username' => 'sqlusername',
 *     'password' => 'sqlpassword',
225
 *     'host' => 'localhost',
226
 *     'prefix' => '',
227
 *   ];
228 229 230 231
 * @endcode
 *
 * Sample Database configuration format for SQLite (sqlite):
 * @code
232
 *   $databases['default']['default'] = [
233
 *     'driver' => 'sqlite',
234
 *     'database' => '/path/to/databasefilename',
235
 *   ];
236
 * @endcode
237 238 239 240 241 242 243 244 245 246 247 248 249 250
 *
 * Sample Database configuration format for a driver in a contributed module:
 * @code
 *   $databases['default']['default'] = [
 *     'driver' => 'mydriver',
 *     'namespace' => 'Drupal\mymodule\Driver\Database\mydriver',
 *     'autoload' => 'modules/mymodule/src/Driver/Database/mydriver/',
 *     'database' => 'databasename',
 *     'username' => 'sqlusername',
 *     'password' => 'sqlpassword',
 *     'host' => 'localhost',
 *     'prefix' => '',
 *   ];
 * @endcode
251
 */
Dries's avatar
 
Dries committed
252

253 254 255
/**
 * Location of the site configuration files.
 *
256 257 258
 * 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.
259
 *
260 261 262
 * 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.
263
 */
264
# $settings['config_sync_directory'] = '/directory/outside/webroot';
265

266 267 268
/**
 * Settings:
 *
269 270
 * $settings contains environment-specific configuration, such as the files
 * directory and reverse proxy address, and temporary configuration, such as
271
 * security overrides.
272
 *
273
 * @see \Drupal\Core\Site\Settings::get()
274 275
 */

276 277 278 279 280 281 282 283
/**
 * 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.
 *
284 285 286
 * 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.
287 288 289 290 291 292 293 294
 *
 * Example:
 * @code
 *   $settings['hash_salt'] = file_get_contents('/home/example/salt.txt');
 * @endcode
 */
$settings['hash_salt'] = '';

295 296 297 298 299 300 301 302 303 304
/**
 * 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;

305 306 307 308 309 310 311 312 313 314 315 316
/**
 * 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;
317

318 319 320
/**
 * External access proxy settings:
 *
321 322 323 324 325 326 327 328 329 330 331 332
 * 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'].
333
 */
334 335 336
# $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'];
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

/**
 * 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.
 *
355 356 357 358
 * 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.
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
 *
 * 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.
 */
374
# $settings['reverse_proxy_addresses'] = ['a.b.c.d', ...];
375 376

/**
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
 * 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
403
 */
404
# $settings['reverse_proxy_trusted_headers'] = \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_ALL | \Symfony\Component\HttpFoundation\Request::HEADER_FORWARDED;
405

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424

/**
 * 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;

425 426 427 428 429 430 431 432 433 434 435 436 437

/**
 * Cache TTL for client error (4xx) 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;

438 439 440 441 442 443 444 445 446
/**
 * 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;
447

448 449 450
/**
 * Class Loader.
 *
451
 * If the APCu extension is detected, the classloader will be optimized to use
452 453 454
 * it. Set to FALSE to disable this.
 *
 * @see https://getcomposer.org/doc/articles/autoloader-optimization.md
455 456 457
 */
# $settings['class_loader_auto_detect'] = FALSE;

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
/**
 * 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.
 *
476
 * @see https://www.drupal.org/node/244924
477 478 479 480 481
 *
 * Remove the leading hash signs to disable.
 */
# $settings['allow_authorize_operations'] = FALSE;

482
/**
483
 * Default mode for directories and files written by Drupal.
484 485 486 487 488 489
 *
 * Value should be in PHP Octal Notation, with leading zero.
 */
# $settings['file_chmod_directory'] = 0775;
# $settings['file_chmod_file'] = 0664;

490 491 492 493 494 495 496 497 498 499 500 501 502
/**
 * 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';

503 504 505 506 507 508 509 510 511
/**
 * 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';

512 513 514 515
/**
 * Private file path:
 *
 * A local file system path where private files will be stored. This directory
516
 * must be absolute, outside of the Drupal installation directory and not
517 518
 * accessible over the web.
 *
519 520 521
 * Note: Caches need to be cleared when this value is changed to make the
 * private:// stream wrapper available to the system.
 *
522 523
 * See https://www.drupal.org/documentation/modules/file for more information
 * about securing private files.
524 525 526
 */
# $settings['file_private_path'] = '';

527 528 529 530 531 532 533 534 535 536 537 538 539
/**
 * 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';

540 541 542 543 544 545 546 547
/**
 * 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;

548 549 550 551 552 553 554 555 556 557
/**
 * 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
558
 * any added language. (eg locale_custom_strings_de for german).
559
 */
560
# $settings['locale_custom_strings_en'][''] = [
561 562
#   'forum'      => 'Discussion board',
#   '@count min' => '@count minutes',
563
# ];
564

565 566 567 568 569 570
/**
 * 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
571 572
 * 'core/modules/system/templates/maintenance-page.html.twig'.
 *
573 574 575 576
 * Note: This setting does not apply to installation and update pages.
 */
# $settings['maintenance_theme'] = 'bartik';

577 578 579
/**
 * PHP settings:
 *
580
 * To see what PHP settings are possible, including whether they can be set at
581
 * runtime (by using ini_set()), read the PHP documentation:
582
 * http://php.net/manual/ini.list.php
583 584
 * See \Drupal\Core\DrupalKernel::bootEnvironment() for required runtime
 * settings and the .htaccess file for non-runtime settings.
585 586
 * Settings defined there should not be duplicated here so as to avoid conflict
 * issues.
587 588
 */

589 590 591 592 593 594
/**
 * 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
595
 * http://php.net/manual/pcre.configuration.php.
596 597 598 599
 */
# ini_set('pcre.backtrack_limit', 200000);
# ini_set('pcre.recursion_limit', 200000);

600
/**
601
 * Configuration overrides.
602
 *
603
 * To globally override specific configuration values for this site,
Dries's avatar
Dries committed
604 605
 * 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
606 607 608
 * the default settings.php.
 *
 * Note that any values you provide in these variable overrides will not be
609 610 611 612 613 614 615 616 617 618 619 620
 * 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.
621
 */
622 623
# $config['system.site']['name'] = 'My Drupal site';
# $config['user.settings']['anonymous'] = 'Visitor';
624

625 626 627 628 629 630 631 632 633
/**
 * 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:
634
 * - $config['system.performance']['fast_404']['exclude_paths']: A regular
635
 *   expression to match paths to exclude, such as images generated by image
636 637
 *   styles, or dynamically-resized images. The default pattern provided below
 *   also excludes the private file system. If you need to add more paths, you
638
 *   can add '|path' to the expression.
639
 * - $config['system.performance']['fast_404']['paths']: A regular expression to
640 641 642
 *   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.
643
 * - $config['system.performance']['fast_404']['html']: The html to return for
644
 *   simple 404 pages.
645
 *
646
 * Remove the leading hash signs if you would like to alter this functionality.
647
 */
648
# $config['system.performance']['fast_404']['exclude_paths'] = '/\/(?:styles)|(?:system\/files)\//';
649 650
# $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>';
651

652 653 654
/**
 * Load services definition file.
 */
655
$settings['container_yamls'][] = $app_root . '/' . $site_path . '/services.yml';
656

657 658 659 660 661 662 663 664 665
/**
 * 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';

666 667 668 669 670 671 672 673 674
/**
 * 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;

675 676 677 678 679 680 681 682 683 684 685 686 687
/**
 * 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
688
 * $settings['trusted_host_patterns'] = [
689
 *   '^www\.example\.com$',
690
 * ];
691 692 693 694 695 696 697 698 699 700
 * @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
701
 * $settings['trusted_host_patterns'] = [
702 703
 *   '^example\.com$',
 *   '^.+\.example\.com$',
704 705
 *   '^example\.org$',
 *   '^.+\.example\.org$',
706
 * ];
707 708 709 710
 * @endcode
 * will allow the site to run off of all variants of example.com and
 * example.org, with all subdomains included.
 */
711

712 713 714 715 716 717 718
/**
 * 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.
 *
719
 * @see \Drupal\Core\File\FileSystemInterface::scanDirectory()
720 721 722 723 724 725 726
 * @see \Drupal\Core\Extension\ExtensionDiscovery::scanDirectory()
 */
$settings['file_scan_ignore_directories'] = [
  'node_modules',
  'bower_components',
];

727 728 729 730 731 732 733 734 735 736
/**
 * 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;

737 738 739 740 741 742 743 744 745
/**
 * 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;

746 747 748 749 750 751 752 753 754 755 756 757 758
/**
 * Node migration type.
 *
 * This is used to force the migration system to use the classic node migrations
 * instead of the default complete node migrations. The migration system will
 * use the classic node migration only if there are existing migrate_map tables
 * for the classic node migrations and they contain data. These tables may not
 * exist if you are developing custom migrations and do not want to use the
 * complete node migrations. Set this to TRUE to force the use of the classic
 * node migrations.
 */
$settings['migrate_node_migrate_type_classic'] = FALSE;

759 760 761
/**
 * Load local development override configuration, if available.
 *
762 763 764 765 766 767 768
 * Create a settings.local.php file to override variables on secondary (staging,
 * development, etc.) installations of this site.
 *
 * Typical uses of settings.local.php include:
 * - Disabling caching.
 * - Disabling JavaScript/CSS compression.
 * - Rerouting outgoing emails.
769 770 771
 *
 * Keep this code block at the end of this file to take full effect.
 */
772 773 774
#
# if (file_exists($app_root . '/' . $site_path . '/settings.local.php')) {
#   include $app_root . '/' . $site_path . '/settings.local.php';
775
# }