Merge "Remove not used private member variable mParserWarnings from OutputPage"
[mediawiki.git] / includes / DefaultSettings.php
bloba6d34b0d35412951755a4929d10e00a20c3aa45a
1 <?php
2 /**
3 * Default values for MediaWiki configuration settings.
6 * NEVER EDIT THIS FILE
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
38 * @file
41 /**
42 * @defgroup Globalsettings Global settings
45 /**
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
52 die( 1 );
55 /** @endcond */
57 /**
58 * wgConf hold the site configuration.
59 * Not used for much in a default install.
60 * @since 1.5
62 $wgConf = new SiteConfiguration;
64 /**
65 * Registry of factory functions to create config objects:
66 * The 'main' key must be set, and the value should be a valid
67 * callable.
68 * @since 1.23
70 $wgConfigRegistry = array(
71 'main' => 'GlobalVarConfig::newInstance'
74 /**
75 * MediaWiki version number
76 * @since 1.2
78 $wgVersion = '1.27alpha';
80 /**
81 * Name of the site. It must be changed in LocalSettings.php
83 $wgSitename = 'MediaWiki';
85 /**
86 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
87 * the wiki on the standard ports (443 for https and 80 for http).
88 * @var bool
89 * @since 1.26
91 $wgAssumeProxiesUseDefaultProtocolPorts = true;
93 /**
94 * URL of the server.
96 * @par Example:
97 * @code
98 * $wgServer = 'http://example.com';
99 * @endcode
101 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
102 * wrong server, it will redirect incorrectly after you save a page. In that
103 * case, set this variable to fix it.
105 * If you want to use protocol-relative URLs on your wiki, set this to a
106 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
107 * to a fully qualified URL.
109 $wgServer = WebRequest::detectServer();
112 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
113 * Must be fully qualified, even if $wgServer is protocol-relative.
115 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
116 * @since 1.18
118 $wgCanonicalServer = false;
121 * Server name. This is automatically computed by parsing the bare
122 * hostname out of $wgCanonicalServer. It should not be customized.
123 * @since 1.24
125 $wgServerName = false;
127 /************************************************************************//**
128 * @name Script path settings
129 * @{
133 * The path we should point to.
134 * It might be a virtual path in case with use apache mod_rewrite for example.
136 * This *needs* to be set correctly.
138 * Other paths will be set to defaults based on it unless they are directly
139 * set in LocalSettings.php
141 $wgScriptPath = '/wiki';
144 * Whether to support URLs like index.php/Page_title These often break when PHP
145 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
146 * but then again it may not; lighttpd converts incoming path data to lowercase
147 * on systems with case-insensitive filesystems, and there have been reports of
148 * problems on Apache as well.
150 * To be safe we'll continue to keep it off by default.
152 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
153 * incorrect garbage, or to true if it is really correct.
155 * The default $wgArticlePath will be set based on this value at runtime, but if
156 * you have customized it, having this incorrectly set to true can cause
157 * redirect loops when "pretty URLs" are used.
158 * @since 1.2.1
160 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
161 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
162 ( strpos( PHP_SAPI, 'isapi' ) === false );
165 * The extension to append to script names by default.
167 * Some hosting providers used PHP 4 for *.php files, and PHP 5 for *.php5.
168 * This variable was provided to support those providers.
170 * @since 1.11
171 * @deprecated since 1.25; support for '.php5' has been phased out of MediaWiki
172 * proper. Backward-compatibility can be maintained by configuring your web
173 * server to rewrite URLs. See RELEASE-NOTES for details.
175 $wgScriptExtension = '.php';
177 /**@}*/
179 /************************************************************************//**
180 * @name URLs and file paths
182 * These various web and file path variables are set to their defaults
183 * in Setup.php if they are not explicitly set from LocalSettings.php.
185 * These will relatively rarely need to be set manually, unless you are
186 * splitting style sheets or images outside the main document root.
188 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
189 * the host part, that starts with a slash. In most cases a full URL is also
190 * acceptable. A "directory" is a local file path.
192 * In both paths and directories, trailing slashes should not be included.
194 * @{
198 * The URL path to index.php.
200 * Defaults to "{$wgScriptPath}/index.php".
202 $wgScript = false;
205 * The URL path to load.php.
207 * Defaults to "{$wgScriptPath}/load.php".
208 * @since 1.17
210 $wgLoadScript = false;
213 * The URL path of the skins directory.
214 * Defaults to "{$wgResourceBasePath}/skins".
215 * @since 1.3
217 $wgStylePath = false;
218 $wgStyleSheetPath = &$wgStylePath;
221 * The URL path of the skins directory. Should not point to an external domain.
222 * Defaults to "{$wgScriptPath}/skins".
223 * @since 1.17
225 $wgLocalStylePath = false;
228 * The URL path of the extensions directory.
229 * Defaults to "{$wgResourceBasePath}/extensions".
230 * @since 1.16
232 $wgExtensionAssetsPath = false;
235 * Filesystem extensions directory.
236 * Defaults to "{$IP}/extensions".
237 * @since 1.25
239 $wgExtensionDirectory = "{$IP}/extensions";
242 * Filesystem stylesheets directory.
243 * Defaults to "{$IP}/skins".
244 * @since 1.3
246 $wgStyleDirectory = "{$IP}/skins";
249 * The URL path for primary article page views. This path should contain $1,
250 * which is replaced by the article title.
252 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
253 * depending on $wgUsePathInfo.
255 $wgArticlePath = false;
258 * The URL path for the images directory.
259 * Defaults to "{$wgScriptPath}/images".
261 $wgUploadPath = false;
264 * The filesystem path of the images directory. Defaults to "{$IP}/images".
266 $wgUploadDirectory = false;
269 * Directory where the cached page will be saved.
270 * Defaults to "{$wgUploadDirectory}/cache".
272 $wgFileCacheDirectory = false;
275 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
276 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
278 $wgLogo = false;
281 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
282 * should be under 135x155 pixels.
283 * Only 1.5x and 2x versions are supported.
285 * @par Example:
286 * @code
287 * $wgLogoHD = array(
288 * "1.5x" => "path/to/1.5x_version.png",
289 * "2x" => "path/to/2x_version.png"
290 * );
291 * @endcode
293 * @since 1.25
295 $wgLogoHD = false;
298 * The URL path of the shortcut icon.
299 * @since 1.6
301 $wgFavicon = '/favicon.ico';
304 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
305 * Defaults to no icon.
306 * @since 1.12
308 $wgAppleTouchIcon = false;
311 * Value for the referrer policy meta tag.
312 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
313 * prevents the meta tag from being output.
314 * See http://www.w3.org/TR/referrer-policy/ for details.
316 * @since 1.25
318 $wgReferrerPolicy = false;
321 * The local filesystem path to a temporary directory. This is not required to
322 * be web accessible.
324 * When this setting is set to false, its value will be set through a call
325 * to wfTempDir(). See that methods implementation for the actual detection
326 * logic.
328 * Developers should use the global function wfTempDir() instead of this
329 * variable.
331 * @see wfTempDir()
332 * @note Default changed to false in MediaWiki 1.20.
334 $wgTmpDirectory = false;
337 * If set, this URL is added to the start of $wgUploadPath to form a complete
338 * upload URL.
339 * @since 1.4
341 $wgUploadBaseUrl = '';
344 * To enable remote on-demand scaling, set this to the thumbnail base URL.
345 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
346 * where 'e6' are the first two characters of the MD5 hash of the file name.
347 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
348 * @since 1.17
350 $wgUploadStashScalerBaseUrl = false;
353 * To set 'pretty' URL paths for actions other than
354 * plain page views, add to this array.
356 * @par Example:
357 * Set pretty URL for the edit action:
358 * @code
359 * 'edit' => "$wgScriptPath/edit/$1"
360 * @endcode
362 * There must be an appropriate script or rewrite rule in place to handle these
363 * URLs.
364 * @since 1.5
366 $wgActionPaths = array();
368 /**@}*/
370 /************************************************************************//**
371 * @name Files and file uploads
372 * @{
376 * Uploads have to be specially set up to be secure
378 $wgEnableUploads = false;
381 * The maximum age of temporary (incomplete) uploaded files
383 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
386 * Allows to move images and other media files
388 $wgAllowImageMoving = true;
391 * Enable deferred upload tasks that use the job queue.
392 * Only enable this if job runners are set up for both the
393 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
395 * @note If you use suhosin, this setting is incompatible with
396 * suhosin.session.encrypt.
398 $wgEnableAsyncUploads = false;
401 * These are additional characters that should be replaced with '-' in filenames
403 $wgIllegalFileChars = ":";
406 * What directory to place deleted uploads in.
407 * Defaults to "{$wgUploadDirectory}/deleted".
409 $wgDeletedDirectory = false;
412 * Set this to true if you use img_auth and want the user to see details on why access failed.
414 $wgImgAuthDetails = false;
417 * Map of relative URL directories to match to internal mwstore:// base storage paths.
418 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
419 * if starts with any of the prefixes defined here. The prefixes should not overlap.
420 * The prefix that matches has a corresponding storage path, which the rest of the URL
421 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
423 * Example:
424 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
425 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
426 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
428 * @see $wgFileBackends
430 $wgImgAuthUrlPathMap = array();
433 * File repository structures
435 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
436 * an array of such structures. Each repository structure is an associative
437 * array of properties configuring the repository.
439 * Properties required for all repos:
440 * - class The class name for the repository. May come from the core or an extension.
441 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
442 * FSRepo is also supported for backwards compatibility.
444 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
445 * The name should consist of alpha-numeric characters.
446 * - backend A file backend name (see $wgFileBackends).
448 * For most core repos:
449 * - zones Associative array of zone names that each map to an array with:
450 * container : backend container name the zone is in
451 * directory : root path within container for the zone
452 * url : base URL to the root of the zone
453 * urlsByExt : map of file extension types to base URLs
454 * (useful for using a different cache for videos)
455 * Zones default to using "<repo name>-<zone name>" as the container name
456 * and default to using the container root as the zone's root directory.
457 * Nesting of zone locations within other zones should be avoided.
458 * - url Public zone URL. The 'zones' settings take precedence.
459 * - hashLevels The number of directory levels for hash-based division of files
460 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
461 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
462 * handler instead.
463 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
464 * determines whether filenames implicitly start with a capital letter.
465 * The current implementation may give incorrect description page links
466 * when the local $wgCapitalLinks and initialCapital are mismatched.
467 * - pathDisclosureProtection
468 * May be 'paranoid' to remove all parameters from error messages, 'none' to
469 * leave the paths in unchanged, or 'simple' to replace paths with
470 * placeholders. Default for LocalRepo is 'simple'.
471 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
472 * is 0644.
473 * - directory The local filesystem directory where public files are stored. Not used for
474 * some remote repos.
475 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
476 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
477 * - isPrivate Set this if measures should always be taken to keep the files private.
478 * One should not trust this to assure that the files are not web readable;
479 * the server configuration should be done manually depending on the backend.
481 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
482 * for local repositories:
483 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
484 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
485 * https://en.wikipedia.org/w
486 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
487 * $wgScriptExtension, e.g. ".php5". Defaults to ".php".
489 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
490 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
491 * $wgFetchCommonsDescriptions.
492 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
493 * Short thumbnail names only have the width, parameters, and the extension.
495 * ForeignDBRepo:
496 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
497 * equivalent to the corresponding member of $wgDBservers
498 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
499 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
501 * ForeignAPIRepo:
502 * - apibase Use for the foreign API's URL
503 * - apiThumbCacheExpiry How long to locally cache thumbs for
505 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
506 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
507 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
508 * If you set $wgForeignFileRepos to an array of repository structures, those will
509 * be searched after the local file repo.
510 * Otherwise, you will only have access to local media files.
512 * @see Setup.php for an example usage and default initialization.
514 $wgLocalFileRepo = false;
517 * @see $wgLocalFileRepo
519 $wgForeignFileRepos = array();
522 * Use Commons as a remote file repository. Essentially a wrapper, when this
523 * is enabled $wgForeignFileRepos will point at Commons with a set of default
524 * settings
526 $wgUseInstantCommons = false;
529 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
530 * are allowable upload targets. These wikis must have some method of
531 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
533 * Example:
534 * $wgForeignUploadTargets = array( 'shared' );
536 $wgForeignUploadTargets = array();
539 * Cross-wiki upload A/B test configuration.
541 $wgForeignUploadTestEnabled = false;
542 $wgForeignUploadTestDefault = 1;
545 * File backend structure configuration.
547 * This is an array of file backend configuration arrays.
548 * Each backend configuration has the following parameters:
549 * - 'name' : A unique name for the backend
550 * - 'class' : The file backend class to use
551 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
552 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
554 * See FileBackend::__construct() for more details.
555 * Additional parameters are specific to the file backend class used.
556 * These settings should be global to all wikis when possible.
558 * There are two particularly important aspects about each backend:
559 * - a) Whether it is fully qualified or wiki-relative.
560 * By default, the paths of files are relative to the current wiki,
561 * which works via prefixing them with the current wiki ID when accessed.
562 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
563 * all paths with the specified value instead. This can be useful if
564 * multiple wikis need to share the same data. Note that 'name' is *not*
565 * part of any prefix and thus should not be relied upon for namespacing.
566 * - b) Whether it is only defined for some wikis or is defined on all
567 * wikis in the wiki farm. Defining a backend globally is useful
568 * if multiple wikis need to share the same data.
569 * One should be aware of these aspects when configuring a backend for use with
570 * any basic feature or plugin. For example, suppose an extension stores data for
571 * different wikis in different directories and sometimes needs to access data from
572 * a foreign wiki's directory in order to render a page on given wiki. The extension
573 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
575 $wgFileBackends = array();
578 * Array of configuration arrays for each lock manager.
579 * Each backend configuration has the following parameters:
580 * - 'name' : A unique name for the lock manager
581 * - 'class' : The lock manger class to use
583 * See LockManager::__construct() for more details.
584 * Additional parameters are specific to the lock manager class used.
585 * These settings should be global to all wikis.
587 $wgLockManagers = array();
590 * Show Exif data, on by default if available.
591 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
593 * @note FOR WINDOWS USERS:
594 * To enable Exif functions, add the following lines to the "Windows
595 * extensions" section of php.ini:
596 * @code{.ini}
597 * extension=extensions/php_mbstring.dll
598 * extension=extensions/php_exif.dll
599 * @endcode
601 $wgShowEXIF = function_exists( 'exif_read_data' );
604 * If to automatically update the img_metadata field
605 * if the metadata field is outdated but compatible with the current version.
606 * Defaults to false.
608 $wgUpdateCompatibleMetadata = false;
611 * If you operate multiple wikis, you can define a shared upload path here.
612 * Uploads to this wiki will NOT be put there - they will be put into
613 * $wgUploadDirectory.
614 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
615 * no file of the given name is found in the local repository (for [[File:..]],
616 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
617 * directory.
619 * Note that these configuration settings can now be defined on a per-
620 * repository basis for an arbitrary number of file repositories, using the
621 * $wgForeignFileRepos variable.
623 $wgUseSharedUploads = false;
626 * Full path on the web server where shared uploads can be found
628 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
631 * Fetch commons image description pages and display them on the local wiki?
633 $wgFetchCommonsDescriptions = false;
636 * Path on the file system where shared uploads can be found.
638 $wgSharedUploadDirectory = "/var/www/wiki3/images";
641 * DB name with metadata about shared directory.
642 * Set this to false if the uploads do not come from a wiki.
644 $wgSharedUploadDBname = false;
647 * Optional table prefix used in database.
649 $wgSharedUploadDBprefix = '';
652 * Cache shared metadata in memcached.
653 * Don't do this if the commons wiki is in a different memcached domain
655 $wgCacheSharedUploads = true;
658 * Allow for upload to be copied from an URL.
659 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
660 * You have to assign the user right 'upload_by_url' to a user group, to use this.
662 $wgAllowCopyUploads = false;
665 * Allow asynchronous copy uploads.
666 * This feature is experimental and broken as of r81612.
668 $wgAllowAsyncCopyUploads = false;
671 * A list of domains copy uploads can come from
673 * @since 1.20
675 $wgCopyUploadsDomains = array();
678 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
679 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
680 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
682 $wgCopyUploadsFromSpecialUpload = false;
685 * Proxy to use for copy upload requests.
686 * @since 1.20
688 $wgCopyUploadProxy = false;
691 * Different timeout for upload by url
692 * This could be useful since when fetching large files, you may want a
693 * timeout longer than the default $wgHTTPTimeout. False means fallback
694 * to default.
696 * @since 1.22
698 $wgCopyUploadTimeout = false;
701 * Different timeout for upload by url when run as a background job
702 * This could be useful since when fetching large files via job queue,
703 * you may want a different timeout, especially because there is no
704 * http request being kept alive.
706 * false means fallback to $wgCopyUploadTimeout.
707 * @since 1.22
709 $wgCopyUploadAsyncTimeout = false;
712 * Max size for uploads, in bytes. If not set to an array, applies to all
713 * uploads. If set to an array, per upload type maximums can be set, using the
714 * file and url keys. If the * key is set this value will be used as maximum
715 * for non-specified types.
717 * @par Example:
718 * @code
719 * $wgMaxUploadSize = array(
720 * '*' => 250 * 1024,
721 * 'url' => 500 * 1024,
722 * );
723 * @endcode
724 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
725 * will have a maximum of 500 kB.
727 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
730 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
731 * chunks smaller than this will be rejected. May be reduced based on the
732 * 'upload_max_filesize' or 'post_max_size' PHP settings.
733 * @since 1.26
735 $wgMinUploadChunkSize = 1024; # 1KB
738 * Point the upload navigation link to an external URL
739 * Useful if you want to use a shared repository by default
740 * without disabling local uploads (use $wgEnableUploads = false for that).
742 * @par Example:
743 * @code
744 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
745 * @endcode
747 $wgUploadNavigationUrl = false;
750 * Point the upload link for missing files to an external URL, as with
751 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
752 * appended to it as appropriate.
754 $wgUploadMissingFileUrl = false;
757 * Give a path here to use thumb.php for thumbnail generation on client
758 * request, instead of generating them on render and outputting a static URL.
759 * This is necessary if some of your apache servers don't have read/write
760 * access to the thumbnail path.
762 * @par Example:
763 * @code
764 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
765 * @endcode
767 $wgThumbnailScriptPath = false;
770 * @see $wgThumbnailScriptPath
772 $wgSharedThumbnailScriptPath = false;
775 * Set this to false if you do not want MediaWiki to divide your images
776 * directory into many subdirectories, for improved performance.
778 * It's almost always good to leave this enabled. In previous versions of
779 * MediaWiki, some users set this to false to allow images to be added to the
780 * wiki by simply copying them into $wgUploadDirectory and then running
781 * maintenance/rebuildImages.php to register them in the database. This is no
782 * longer recommended, use maintenance/importImages.php instead.
784 * @note That this variable may be ignored if $wgLocalFileRepo is set.
785 * @todo Deprecate the setting and ultimately remove it from Core.
787 $wgHashedUploadDirectory = true;
790 * Set the following to false especially if you have a set of files that need to
791 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
792 * directory layout.
794 $wgHashedSharedUploadDirectory = true;
797 * Base URL for a repository wiki. Leave this blank if uploads are just stored
798 * in a shared directory and not meant to be accessible through a separate wiki.
799 * Otherwise the image description pages on the local wiki will link to the
800 * image description page on this wiki.
802 * Please specify the namespace, as in the example below.
804 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
807 * This is the list of preferred extensions for uploading files. Uploading files
808 * with extensions not in this list will trigger a warning.
810 * @warning If you add any OpenOffice or Microsoft Office file formats here,
811 * such as odt or doc, and untrusted users are allowed to upload files, then
812 * your wiki will be vulnerable to cross-site request forgery (CSRF).
814 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg', 'webp' );
817 * Files with these extensions will never be allowed as uploads.
818 * An array of file extensions to blacklist. You should append to this array
819 * if you want to blacklist additional files.
821 $wgFileBlacklist = array(
822 # HTML may contain cookie-stealing JavaScript and web bugs
823 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
824 # PHP scripts may execute arbitrary code on the server
825 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
826 # Other types that may be interpreted by some servers
827 'shtml', 'jhtml', 'pl', 'py', 'cgi',
828 # May contain harmful executables for Windows victims
829 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
832 * Files with these MIME types will never be allowed as uploads
833 * if $wgVerifyMimeType is enabled.
835 $wgMimeTypeBlacklist = array(
836 # HTML may contain cookie-stealing JavaScript and web bugs
837 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
838 # PHP scripts may execute arbitrary code on the server
839 'application/x-php', 'text/x-php',
840 # Other types that may be interpreted by some servers
841 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
842 # Client-side hazards on Internet Explorer
843 'text/scriptlet', 'application/x-msdownload',
844 # Windows metafile, client-side vulnerability on some systems
845 'application/x-msmetafile',
849 * Allow Java archive uploads.
850 * This is not recommended for public wikis since a maliciously-constructed
851 * applet running on the same domain as the wiki can steal the user's cookies.
853 $wgAllowJavaUploads = false;
856 * This is a flag to determine whether or not to check file extensions on upload.
858 * @warning Setting this to false is insecure for public wikis.
860 $wgCheckFileExtensions = true;
863 * If this is turned off, users may override the warning for files not covered
864 * by $wgFileExtensions.
866 * @warning Setting this to false is insecure for public wikis.
868 $wgStrictFileExtensions = true;
871 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
873 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
874 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
876 $wgDisableUploadScriptChecks = false;
879 * Warn if uploaded files are larger than this (in bytes), or false to disable
881 $wgUploadSizeWarning = false;
884 * list of trusted media-types and MIME types.
885 * Use the MEDIATYPE_xxx constants to represent media types.
886 * This list is used by File::isSafeFile
888 * Types not listed here will have a warning about unsafe content
889 * displayed on the images description page. It would also be possible
890 * to use this for further restrictions, like disabling direct
891 * [[media:...]] links for non-trusted formats.
893 $wgTrustedMediaFormats = array(
894 MEDIATYPE_BITMAP, // all bitmap formats
895 MEDIATYPE_AUDIO, // all audio formats
896 MEDIATYPE_VIDEO, // all plain video formats
897 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
898 "application/pdf", // PDF files
899 # "application/x-shockwave-flash", //flash/shockwave movie
903 * Plugins for media file type handling.
904 * Each entry in the array maps a MIME type to a class name
906 $wgMediaHandlers = array(
907 'image/jpeg' => 'JpegHandler',
908 'image/png' => 'PNGHandler',
909 'image/gif' => 'GIFHandler',
910 'image/tiff' => 'TiffHandler',
911 'image/webp' => 'WebPHandler',
912 'image/x-ms-bmp' => 'BmpHandler',
913 'image/x-bmp' => 'BmpHandler',
914 'image/x-xcf' => 'XCFHandler',
915 'image/svg+xml' => 'SvgHandler', // official
916 'image/svg' => 'SvgHandler', // compat
917 'image/vnd.djvu' => 'DjVuHandler', // official
918 'image/x.djvu' => 'DjVuHandler', // compat
919 'image/x-djvu' => 'DjVuHandler', // compat
923 * Plugins for page content model handling.
924 * Each entry in the array maps a model id to a class name.
926 * @since 1.21
928 $wgContentHandlers = array(
929 // the usual case
930 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
931 // dumb version, no syntax highlighting
932 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
933 // simple implementation, for use by extensions, etc.
934 CONTENT_MODEL_JSON => 'JsonContentHandler',
935 // dumb version, no syntax highlighting
936 CONTENT_MODEL_CSS => 'CssContentHandler',
937 // plain text, for use by extensions, etc.
938 CONTENT_MODEL_TEXT => 'TextContentHandler',
942 * Whether to enable server-side image thumbnailing. If false, images will
943 * always be sent to the client in full resolution, with appropriate width= and
944 * height= attributes on the <img> tag for the client to do its own scaling.
946 $wgUseImageResize = true;
949 * Resizing can be done using PHP's internal image libraries or using
950 * ImageMagick or another third-party converter, e.g. GraphicMagick.
951 * These support more file formats than PHP, which only supports PNG,
952 * GIF, JPG, XBM and WBMP.
954 * Use Image Magick instead of PHP builtin functions.
956 $wgUseImageMagick = false;
959 * The convert command shipped with ImageMagick
961 $wgImageMagickConvertCommand = '/usr/bin/convert';
964 * Sharpening parameter to ImageMagick
966 $wgSharpenParameter = '0x0.4';
969 * Reduction in linear dimensions below which sharpening will be enabled
971 $wgSharpenReductionThreshold = 0.85;
974 * Temporary directory used for ImageMagick. The directory must exist. Leave
975 * this set to false to let ImageMagick decide for itself.
977 $wgImageMagickTempDir = false;
980 * Use another resizing converter, e.g. GraphicMagick
981 * %s will be replaced with the source path, %d with the destination
982 * %w and %h will be replaced with the width and height.
984 * @par Example for GraphicMagick:
985 * @code
986 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
987 * @endcode
989 * Leave as false to skip this.
991 $wgCustomConvertCommand = false;
994 * used for lossless jpeg rotation
996 * @since 1.21
998 $wgJpegTran = '/usr/bin/jpegtran';
1001 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1002 * image formats.
1004 $wgExiv2Command = '/usr/bin/exiv2';
1007 * Path to exiftool binary. Used for lossless ICC profile swapping.
1009 * @since 1.26
1011 $wgExiftool = '/usr/bin/exiftool';
1014 * Scalable Vector Graphics (SVG) may be uploaded as images.
1015 * Since SVG support is not yet standard in browsers, it is
1016 * necessary to rasterize SVGs to PNG as a fallback format.
1018 * An external program is required to perform this conversion.
1019 * If set to an array, the first item is a PHP callable and any further items
1020 * are passed as parameters after $srcPath, $dstPath, $width, $height
1022 $wgSVGConverters = array(
1023 'ImageMagick' =>
1024 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1025 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1026 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1027 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1028 . '$output $input',
1029 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1030 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1031 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
1035 * Pick a converter defined in $wgSVGConverters
1037 $wgSVGConverter = 'ImageMagick';
1040 * If not in the executable PATH, specify the SVG converter path.
1042 $wgSVGConverterPath = '';
1045 * Don't scale a SVG larger than this
1047 $wgSVGMaxSize = 5120;
1050 * Don't read SVG metadata beyond this point.
1051 * Default is 1024*256 bytes
1053 $wgSVGMetadataCutoff = 262144;
1056 * Disallow <title> element in SVG files.
1058 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1059 * browsers which can not perform basic stuff like MIME detection and which are
1060 * vulnerable to further idiots uploading crap files as images.
1062 * When this directive is on, "<title>" will be allowed in files with an
1063 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1064 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1066 $wgAllowTitlesInSVG = false;
1069 * The maximum number of pixels a source image can have if it is to be scaled
1070 * down by a scaler that requires the full source image to be decompressed
1071 * and stored in decompressed form, before the thumbnail is generated.
1073 * This provides a limit on memory usage for the decompression side of the
1074 * image scaler. The limit is used when scaling PNGs with any of the
1075 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1076 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1078 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1079 * 12.5 million pixels or 3500x3500.
1081 $wgMaxImageArea = 1.25e7;
1084 * Force thumbnailing of animated GIFs above this size to a single
1085 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1086 * is checked against the total size of all frames in the animation.
1087 * It probably makes sense to keep this equal to $wgMaxImageArea.
1089 $wgMaxAnimatedGifArea = 1.25e7;
1092 * Browsers don't support TIFF inline generally...
1093 * For inline display, we need to convert to PNG or JPEG.
1094 * Note scaling should work with ImageMagick, but may not with GD scaling.
1096 * @par Example:
1097 * @code
1098 * // PNG is lossless, but inefficient for photos
1099 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1100 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1101 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1102 * @endcode
1104 $wgTiffThumbnailType = false;
1107 * If rendered thumbnail files are older than this timestamp, they
1108 * will be rerendered on demand as if the file didn't already exist.
1109 * Update if there is some need to force thumbs and SVG rasterizations
1110 * to rerender, such as fixes to rendering bugs.
1112 $wgThumbnailEpoch = '20030516000000';
1115 * Certain operations are avoided if there were too many recent failures,
1116 * for example, thumbnail generation. Bump this value to invalidate all
1117 * memory of failed operations and thus allow further attempts to resume.
1118 * This is useful when a cause for the failures has been found and fixed.
1120 $wgAttemptFailureEpoch = 1;
1123 * If set, inline scaled images will still produce "<img>" tags ready for
1124 * output instead of showing an error message.
1126 * This may be useful if errors are transitory, especially if the site
1127 * is configured to automatically render thumbnails on request.
1129 * On the other hand, it may obscure error conditions from debugging.
1130 * Enable the debug log or the 'thumbnail' log group to make sure errors
1131 * are logged to a file for review.
1133 $wgIgnoreImageErrors = false;
1136 * Allow thumbnail rendering on page view. If this is false, a valid
1137 * thumbnail URL is still output, but no file will be created at
1138 * the target location. This may save some time if you have a
1139 * thumb.php or 404 handler set up which is faster than the regular
1140 * webserver(s).
1142 $wgGenerateThumbnailOnParse = true;
1145 * Show thumbnails for old images on the image description page
1147 $wgShowArchiveThumbnails = true;
1150 * If set to true, images that contain certain the exif orientation tag will
1151 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1152 * is available that can rotate.
1154 $wgEnableAutoRotation = null;
1157 * Internal name of virus scanner. This serves as a key to the
1158 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1159 * null, every file uploaded will be scanned for viruses.
1161 $wgAntivirus = null;
1164 * Configuration for different virus scanners. This an associative array of
1165 * associative arrays. It contains one setup array per known scanner type.
1166 * The entry is selected by $wgAntivirus, i.e.
1167 * valid values for $wgAntivirus are the keys defined in this array.
1169 * The configuration array for each scanner contains the following keys:
1170 * "command", "codemap", "messagepattern":
1172 * "command" is the full command to call the virus scanner - %f will be
1173 * replaced with the name of the file to scan. If not present, the filename
1174 * will be appended to the command. Note that this must be overwritten if the
1175 * scanner is not in the system path; in that case, please set
1176 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1177 * path.
1179 * "codemap" is a mapping of exit code to return codes of the detectVirus
1180 * function in SpecialUpload.
1181 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1182 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1183 * is not set.
1184 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1185 * the file to have an unsupported format, which is probably immune to
1186 * viruses. This causes the file to pass.
1187 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1188 * no virus was found.
1189 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1190 * a virus.
1191 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1193 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1194 * output. The relevant part should be matched as group one (\1).
1195 * If not defined or the pattern does not match, the full message is shown to the user.
1197 $wgAntivirusSetup = array(
1199 # setup for clamav
1200 'clamav' => array(
1201 'command' => 'clamscan --no-summary ',
1202 'codemap' => array(
1203 "0" => AV_NO_VIRUS, # no virus
1204 "1" => AV_VIRUS_FOUND, # virus found
1205 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1206 "*" => AV_SCAN_FAILED, # else scan failed
1208 'messagepattern' => '/.*?:(.*)/sim',
1213 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1215 $wgAntivirusRequired = true;
1218 * Determines if the MIME type of uploaded files should be checked
1220 $wgVerifyMimeType = true;
1223 * Sets the MIME type definition file to use by MimeMagic.php.
1224 * Set to null, to use built-in defaults only.
1225 * example: $wgMimeTypeFile = '/etc/mime.types';
1227 $wgMimeTypeFile = 'includes/mime.types';
1230 * Sets the MIME type info file to use by MimeMagic.php.
1231 * Set to null, to use built-in defaults only.
1233 $wgMimeInfoFile = 'includes/mime.info';
1236 * Sets an external MIME detector program. The command must print only
1237 * the MIME type to standard output.
1238 * The name of the file to process will be appended to the command given here.
1239 * If not set or NULL, PHP's fileinfo extension will be used if available.
1241 * @par Example:
1242 * @code
1243 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1244 * @endcode
1246 $wgMimeDetectorCommand = null;
1249 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1250 * things, because only a few types of images are needed and file extensions
1251 * can be trusted.
1253 $wgTrivialMimeDetection = false;
1256 * Additional XML types we can allow via MIME-detection.
1257 * array = ( 'rootElement' => 'associatedMimeType' )
1259 $wgXMLMimeTypes = array(
1260 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1261 'svg' => 'image/svg+xml',
1262 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1263 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1264 'html' => 'text/html', // application/xhtml+xml?
1268 * Limit images on image description pages to a user-selectable limit. In order
1269 * to reduce disk usage, limits can only be selected from a list.
1270 * The user preference is saved as an array offset in the database, by default
1271 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1272 * change it if you alter the array (see bug 8858).
1273 * This is the list of settings the user can choose from:
1275 $wgImageLimits = array(
1276 array( 320, 240 ),
1277 array( 640, 480 ),
1278 array( 800, 600 ),
1279 array( 1024, 768 ),
1280 array( 1280, 1024 )
1284 * Adjust thumbnails on image pages according to a user setting. In order to
1285 * reduce disk usage, the values can only be selected from a list. This is the
1286 * list of settings the user can choose from:
1288 $wgThumbLimits = array(
1289 120,
1290 150,
1291 180,
1292 200,
1293 250,
1298 * When defined, is an array of image widths used as buckets for thumbnail generation.
1299 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1300 * always using the original. This will incur a speed gain but cause a quality loss.
1302 * The buckets generation is chained, with each bucket generated based on the above bucket
1303 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1304 * supports it.
1306 $wgThumbnailBuckets = null;
1309 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1310 * above the requested size. The distance represents how many extra pixels of width the bucket
1311 * needs in order to be used as the reference for a given thumbnail. For example, with the
1312 * following buckets:
1314 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1316 * and a distance of 50:
1318 * $wgThumbnailMinimumBucketDistance = 50;
1320 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1321 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1323 $wgThumbnailMinimumBucketDistance = 50;
1326 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1327 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1328 * has a performance impact for the first client to view a certain size.
1330 * This obviously means that more disk space is needed per upload upfront.
1332 * @since 1.25
1335 $wgUploadThumbnailRenderMap = array();
1338 * The method through which the thumbnails will be prerendered for the entries in
1339 * $wgUploadThumbnailRenderMap
1341 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1342 * thumbnail's URL.
1343 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1344 * option uses the job queue to render the thumbnail.
1346 * @since 1.25
1348 $wgUploadThumbnailRenderMethod = 'jobqueue';
1351 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1353 * @since 1.25
1355 $wgUploadThumbnailRenderHttpCustomHost = false;
1358 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1359 * HTTP request to.
1361 * @since 1.25
1363 $wgUploadThumbnailRenderHttpCustomDomain = false;
1366 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1367 * (and free) TinyRGB profile when generating thumbnails.
1369 * @since 1.26
1371 $wgUseTinyRGBForJPGThumbnails = false;
1374 * Default parameters for the "<gallery>" tag
1376 $wgGalleryOptions = array(
1377 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1378 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1379 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1380 'captionLength' => 25, // Length of caption to truncate (in characters)
1381 'showBytes' => true, // Show the filesize in bytes in categories
1382 'mode' => 'traditional',
1386 * Adjust width of upright images when parameter 'upright' is used
1387 * This allows a nicer look for upright images without the need to fix the width
1388 * by hardcoded px in wiki sourcecode.
1390 $wgThumbUpright = 0.75;
1393 * Default value for chmoding of new directories.
1395 $wgDirectoryMode = 0777;
1398 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1400 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1401 * thumbnails, output via the srcset attribute.
1403 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1404 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1405 * The polyfill can be found in the jquery.hidpi module.
1407 $wgResponsiveImages = true;
1410 * @name DJVU settings
1411 * @{
1415 * Path of the djvudump executable
1416 * Enable this and $wgDjvuRenderer to enable djvu rendering
1417 * example: $wgDjvuDump = 'djvudump';
1419 $wgDjvuDump = null;
1422 * Path of the ddjvu DJVU renderer
1423 * Enable this and $wgDjvuDump to enable djvu rendering
1424 * example: $wgDjvuRenderer = 'ddjvu';
1426 $wgDjvuRenderer = null;
1429 * Path of the djvutxt DJVU text extraction utility
1430 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1431 * example: $wgDjvuTxt = 'djvutxt';
1433 $wgDjvuTxt = null;
1436 * Path of the djvutoxml executable
1437 * This works like djvudump except much, much slower as of version 3.5.
1439 * For now we recommend you use djvudump instead. The djvuxml output is
1440 * probably more stable, so we'll switch back to it as soon as they fix
1441 * the efficiency problem.
1442 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1444 * @par Example:
1445 * @code
1446 * $wgDjvuToXML = 'djvutoxml';
1447 * @endcode
1449 $wgDjvuToXML = null;
1452 * Shell command for the DJVU post processor
1453 * Default: pnmtojpeg, since ddjvu generates ppm output
1454 * Set this to false to output the ppm file directly.
1456 $wgDjvuPostProcessor = 'pnmtojpeg';
1459 * File extension for the DJVU post processor output
1461 $wgDjvuOutputExtension = 'jpg';
1463 /** @} */ # end of DJvu }
1465 /** @} */ # end of file uploads }
1467 /************************************************************************//**
1468 * @name Email settings
1469 * @{
1473 * Site admin email address.
1475 * Defaults to "wikiadmin@$wgServerName".
1477 $wgEmergencyContact = false;
1480 * Password reminder email address.
1482 * The address we should use as sender when a user is requesting his password.
1484 * Defaults to "apache@$wgServerName".
1486 $wgPasswordSender = false;
1489 * Password reminder name
1491 * @deprecated since 1.23; use the system message 'emailsender' instead.
1493 $wgPasswordSenderName = 'MediaWiki Mail';
1496 * Dummy address which should be accepted during mail send action.
1497 * It might be necessary to adapt the address or to set it equal
1498 * to the $wgEmergencyContact address.
1500 $wgNoReplyAddress = 'reply@not.possible.invalid';
1503 * Set to true to enable the e-mail basic features:
1504 * Password reminders, etc. If sending e-mail on your
1505 * server doesn't work, you might want to disable this.
1507 $wgEnableEmail = true;
1510 * Set to true to enable user-to-user e-mail.
1511 * This can potentially be abused, as it's hard to track.
1513 $wgEnableUserEmail = true;
1516 * Set to true to put the sending user's email in a Reply-To header
1517 * instead of From. ($wgEmergencyContact will be used as From.)
1519 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1520 * which can cause problems with SPF validation and leak recipient addresses
1521 * when bounces are sent to the sender.
1523 $wgUserEmailUseReplyTo = false;
1526 * Minimum time, in hours, which must elapse between password reminder
1527 * emails for a given account. This is to prevent abuse by mail flooding.
1529 $wgPasswordReminderResendTime = 24;
1532 * The time, in seconds, when an emailed temporary password expires.
1534 $wgNewPasswordExpiry = 3600 * 24 * 7;
1537 * The time, in seconds, when an email confirmation email expires
1539 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1542 * The number of days that a user's password is good for. After this number of days, the
1543 * user will be asked to reset their password. Set to false to disable password expiration.
1545 $wgPasswordExpirationDays = false;
1548 * If a user's password is expired, the number of seconds when they can still login,
1549 * and cancel their password change, but are sent to the password change form on each login.
1551 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1554 * SMTP Mode.
1556 * For using a direct (authenticated) SMTP server connection.
1557 * Default to false or fill an array :
1559 * @code
1560 * $wgSMTP = array(
1561 * 'host' => 'SMTP domain',
1562 * 'IDHost' => 'domain for MessageID',
1563 * 'port' => '25',
1564 * 'auth' => [true|false],
1565 * 'username' => [SMTP username],
1566 * 'password' => [SMTP password],
1567 * );
1568 * @endcode
1570 $wgSMTP = false;
1573 * Additional email parameters, will be passed as the last argument to mail() call.
1574 * If using safe_mode this has no effect
1576 $wgAdditionalMailParams = null;
1579 * For parts of the system that have been updated to provide HTML email content, send
1580 * both text and HTML parts as the body of the email
1582 $wgAllowHTMLEmail = false;
1585 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1586 * from $wgEmergencyContact
1588 $wgEnotifFromEditor = false;
1590 // TODO move UPO to preferences probably ?
1591 # If set to true, users get a corresponding option in their preferences and can choose to
1592 # enable or disable at their discretion
1593 # If set to false, the corresponding input form on the user preference page is suppressed
1594 # It call this to be a "user-preferences-option (UPO)"
1597 * Require email authentication before sending mail to an email address.
1598 * This is highly recommended. It prevents MediaWiki from being used as an open
1599 * spam relay.
1601 $wgEmailAuthentication = true;
1604 * Allow users to enable email notification ("enotif") on watchlist changes.
1606 $wgEnotifWatchlist = false;
1609 * Allow users to enable email notification ("enotif") when someone edits their
1610 * user talk page.
1612 $wgEnotifUserTalk = false;
1615 * Set the Reply-to address in notifications to the editor's address, if user
1616 * allowed this in the preferences.
1618 $wgEnotifRevealEditorAddress = false;
1621 * Send notification mails on minor edits to watchlist pages. This is enabled
1622 * by default. User talk notifications are affected by this, $wgEnotifUserTalk, and
1623 * the nominornewtalk user right.
1625 $wgEnotifMinorEdits = true;
1628 * Send a generic mail instead of a personalised mail for each user. This
1629 * always uses UTC as the time zone, and doesn't include the username.
1631 * For pages with many users watching, this can significantly reduce mail load.
1632 * Has no effect when using sendmail rather than SMTP.
1634 $wgEnotifImpersonal = false;
1637 * Maximum number of users to mail at once when using impersonal mail. Should
1638 * match the limit on your mail server.
1640 $wgEnotifMaxRecips = 500;
1643 * Send mails via the job queue. This can be useful to reduce the time it
1644 * takes to save a page that a lot of people are watching.
1646 $wgEnotifUseJobQ = false;
1649 * Use real name instead of username in e-mail "from" field.
1651 $wgEnotifUseRealName = false;
1654 * Array of usernames who will be sent a notification email for every change
1655 * which occurs on a wiki. Users will not be notified of their own changes.
1657 $wgUsersNotifiedOnAllChanges = array();
1659 /** @} */ # end of email settings
1661 /************************************************************************//**
1662 * @name Database settings
1663 * @{
1667 * Database host name or IP address
1669 $wgDBserver = 'localhost';
1672 * Database port number (for PostgreSQL and Microsoft SQL Server).
1674 $wgDBport = 5432;
1677 * Name of the database
1679 $wgDBname = 'my_wiki';
1682 * Database username
1684 $wgDBuser = 'wikiuser';
1687 * Database user's password
1689 $wgDBpassword = '';
1692 * Database type
1694 $wgDBtype = 'mysql';
1697 * Whether to use SSL in DB connection.
1699 * This setting is only used $wgLBFactoryConf['class'] is set to
1700 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1701 * the DBO_SSL flag must be set in the 'flags' option of the database
1702 * connection to achieve the same functionality.
1704 $wgDBssl = false;
1707 * Whether to use compression in DB connection.
1709 * This setting is only used $wgLBFactoryConf['class'] is set to
1710 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1711 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1712 * connection to achieve the same functionality.
1714 $wgDBcompress = false;
1717 * Separate username for maintenance tasks. Leave as null to use the default.
1719 $wgDBadminuser = null;
1722 * Separate password for maintenance tasks. Leave as null to use the default.
1724 $wgDBadminpassword = null;
1727 * Search type.
1728 * Leave as null to select the default search engine for the
1729 * selected database type (eg SearchMySQL), or set to a class
1730 * name to override to a custom search engine.
1732 $wgSearchType = null;
1735 * Alternative search types
1736 * Sometimes you want to support multiple search engines for testing. This
1737 * allows users to select their search engine of choice via url parameters
1738 * to Special:Search and the action=search API. If using this, there's no
1739 * need to add $wgSearchType to it, that is handled automatically.
1741 $wgSearchTypeAlternatives = null;
1744 * Table name prefix
1746 $wgDBprefix = '';
1749 * MySQL table options to use during installation or update
1751 $wgDBTableOptions = 'ENGINE=InnoDB';
1754 * SQL Mode - default is turning off all modes, including strict, if set.
1755 * null can be used to skip the setting for performance reasons and assume
1756 * DBA has done his best job.
1757 * String override can be used for some additional fun :-)
1759 $wgSQLMode = '';
1762 * Mediawiki schema
1764 $wgDBmwschema = null;
1767 * To override default SQLite data directory ($docroot/../data)
1769 $wgSQLiteDataDir = '';
1772 * Make all database connections secretly go to localhost. Fool the load balancer
1773 * thinking there is an arbitrarily large cluster of servers to connect to.
1774 * Useful for debugging.
1776 $wgAllDBsAreLocalhost = false;
1779 * Shared database for multiple wikis. Commonly used for storing a user table
1780 * for single sign-on. The server for this database must be the same as for the
1781 * main database.
1783 * For backwards compatibility the shared prefix is set to the same as the local
1784 * prefix, and the user table is listed in the default list of shared tables.
1785 * The user_properties table is also added so that users will continue to have their
1786 * preferences shared (preferences were stored in the user table prior to 1.16)
1788 * $wgSharedTables may be customized with a list of tables to share in the shared
1789 * database. However it is advised to limit what tables you do share as many of
1790 * MediaWiki's tables may have side effects if you try to share them.
1792 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1793 * $wgDBprefix.
1795 * $wgSharedSchema is the table schema for the shared database. It defaults to
1796 * $wgDBmwschema.
1798 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1799 * access remote databases. Using wfGetLB() allows the shared database to
1800 * reside on separate servers to the wiki's own database, with suitable
1801 * configuration of $wgLBFactoryConf.
1803 $wgSharedDB = null;
1806 * @see $wgSharedDB
1808 $wgSharedPrefix = false;
1811 * @see $wgSharedDB
1813 $wgSharedTables = array( 'user', 'user_properties' );
1816 * @see $wgSharedDB
1817 * @since 1.23
1819 $wgSharedSchema = false;
1822 * Database load balancer
1823 * This is a two-dimensional array, an array of server info structures
1824 * Fields are:
1825 * - host: Host name
1826 * - dbname: Default database name
1827 * - user: DB user
1828 * - password: DB password
1829 * - type: DB type
1831 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1832 * If this is zero for any given server, no normal query traffic will be
1833 * sent to it. It will be excluded from lag checks in maintenance scripts.
1834 * The only way it can receive traffic is if groupLoads is used.
1836 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1837 * to several groups, the most specific group defined here is used.
1839 * - flags: bit field
1840 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1841 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1842 * - DBO_TRX -- wrap entire request in a transaction
1843 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1844 * - DBO_PERSISTENT -- enables persistent database connections
1845 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1846 * - DBO_COMPRESS -- uses internal compression in database connections,
1847 * if available
1849 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1851 * These and any other user-defined properties will be assigned to the mLBInfo member
1852 * variable of the Database object.
1854 * Leave at false to use the single-server variables above. If you set this
1855 * variable, the single-server variables will generally be ignored (except
1856 * perhaps in some command-line scripts).
1858 * The first server listed in this array (with key 0) will be the master. The
1859 * rest of the servers will be slaves. To prevent writes to your slaves due to
1860 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1861 * slaves in my.cnf. You can set read_only mode at runtime using:
1863 * @code
1864 * SET @@read_only=1;
1865 * @endcode
1867 * Since the effect of writing to a slave is so damaging and difficult to clean
1868 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1869 * our masters, and then set read_only=0 on masters at runtime.
1871 $wgDBservers = false;
1874 * Load balancer factory configuration
1875 * To set up a multi-master wiki farm, set the class here to something that
1876 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1877 * The class identified here is responsible for reading $wgDBservers,
1878 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1880 * The LBFactoryMulti class is provided for this purpose, please see
1881 * includes/db/LBFactoryMulti.php for configuration information.
1883 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1886 * The ID of the current data center
1887 * @since 1.27
1889 $wgDataCenterId = 'default';
1892 * Map of data center IDs to their role ("master" or "slave")
1894 * Multiple data centers can be setup to handle MediaWiki, with HTTP
1895 * POSTs routed to the master data center and GET/HEAD/OPTION routed to
1896 * any data center (usually the closest to the end user). In such setups,
1897 * this setting should be set to the appropriate value in the site
1898 * config for each data center.
1899 * @since 1.27
1901 $wgDataCenterRoles = array( 'default' => 'master' );
1904 * After a state-changing request is done by a client, this determines
1905 * how many seconds that client should keep using the master datacenter.
1906 * This avoids unexpected stale or 404 responses due to replication lag.
1907 * @since 1.27
1909 $wgDataCenterUpdateStickTTL = 10;
1912 * File to log database errors to
1914 $wgDBerrorLog = false;
1917 * Timezone to use in the error log.
1918 * Defaults to the wiki timezone ($wgLocaltimezone).
1920 * A list of usable timezones can found at:
1921 * http://php.net/manual/en/timezones.php
1923 * @par Examples:
1924 * @code
1925 * $wgDBerrorLogTZ = 'UTC';
1926 * $wgDBerrorLogTZ = 'GMT';
1927 * $wgDBerrorLogTZ = 'PST8PDT';
1928 * $wgDBerrorLogTZ = 'Europe/Sweden';
1929 * $wgDBerrorLogTZ = 'CET';
1930 * @endcode
1932 * @since 1.20
1934 $wgDBerrorLogTZ = false;
1937 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1938 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1940 * @warning THIS IS EXPERIMENTAL!
1942 * May break if you're not using the table defs from mysql5/tables.sql.
1943 * May break if you're upgrading an existing wiki if set differently.
1944 * Broken symptoms likely to include incorrect behavior with page titles,
1945 * usernames, comments etc containing non-ASCII characters.
1946 * Might also cause failures on the object cache and other things.
1948 * Even correct usage may cause failures with Unicode supplementary
1949 * characters (those not in the Basic Multilingual Plane) unless MySQL
1950 * has enhanced their Unicode support.
1952 $wgDBmysql5 = false;
1955 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1957 * To use this feature set to true and use a datasource defined as
1958 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1959 * block).
1961 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1962 * Pool) that maintains established sessions and reuses them on new
1963 * connections.
1965 * Not completely tested, but it should fall back on normal connection
1966 * in case the pool is full or the datasource is not configured as
1967 * pooled.
1968 * And the other way around; using oci_pconnect on a non pooled
1969 * datasource should produce a normal connection.
1971 * When it comes to frequent shortlived DB connections like with MW
1972 * Oracle tends to s***. The problem is the driver connects to the
1973 * database reasonably fast, but establishing a session takes time and
1974 * resources. MW does not rely on session state (as it does not use
1975 * features such as package variables) so establishing a valid session
1976 * is in this case an unwanted overhead that just slows things down.
1978 * @warning EXPERIMENTAL!
1981 $wgDBOracleDRCP = false;
1984 * Other wikis on this site, can be administered from a single developer
1985 * account.
1986 * Array numeric key => database name
1988 $wgLocalDatabases = array();
1991 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1992 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1993 * show a more obvious warning.
1995 $wgSlaveLagWarning = 10;
1998 * @see $wgSlaveLagWarning
2000 $wgSlaveLagCritical = 30;
2003 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2005 $wgDBWindowsAuthentication = false;
2007 /**@}*/ # End of DB settings }
2009 /************************************************************************//**
2010 * @name Text storage
2011 * @{
2015 * We can also compress text stored in the 'text' table. If this is set on, new
2016 * revisions will be compressed on page save if zlib support is available. Any
2017 * compressed revisions will be decompressed on load regardless of this setting,
2018 * but will not be readable at all* if zlib support is not available.
2020 $wgCompressRevisions = false;
2023 * External stores allow including content
2024 * from non database sources following URL links.
2026 * Short names of ExternalStore classes may be specified in an array here:
2027 * @code
2028 * $wgExternalStores = array("http","file","custom")...
2029 * @endcode
2031 * CAUTION: Access to database might lead to code execution
2033 $wgExternalStores = array();
2036 * An array of external MySQL servers.
2038 * @par Example:
2039 * Create a cluster named 'cluster1' containing three servers:
2040 * @code
2041 * $wgExternalServers = array(
2042 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
2043 * );
2044 * @endcode
2046 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2047 * another class.
2049 $wgExternalServers = array();
2052 * The place to put new revisions, false to put them in the local text table.
2053 * Part of a URL, e.g. DB://cluster1
2055 * Can be an array instead of a single string, to enable data distribution. Keys
2056 * must be consecutive integers, starting at zero.
2058 * @par Example:
2059 * @code
2060 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
2061 * @endcode
2063 * @var array
2065 $wgDefaultExternalStore = false;
2068 * Revision text may be cached in $wgMemc to reduce load on external storage
2069 * servers and object extraction overhead for frequently-loaded revisions.
2071 * Set to 0 to disable, or number of seconds before cache expiry.
2073 $wgRevisionCacheExpiry = 0;
2075 /** @} */ # end text storage }
2077 /************************************************************************//**
2078 * @name Performance hacks and limits
2079 * @{
2083 * Disable database-intensive features
2085 $wgMiserMode = false;
2088 * Disable all query pages if miser mode is on, not just some
2090 $wgDisableQueryPages = false;
2093 * Number of rows to cache in 'querycache' table when miser mode is on
2095 $wgQueryCacheLimit = 1000;
2098 * Number of links to a page required before it is deemed "wanted"
2100 $wgWantedPagesThreshold = 1;
2103 * Enable slow parser functions
2105 $wgAllowSlowParserFunctions = false;
2108 * Allow schema updates
2110 $wgAllowSchemaUpdates = true;
2113 * Maximum article size in kilobytes
2115 $wgMaxArticleSize = 2048;
2118 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2119 * raise PHP's memory limit if it's below this amount.
2121 $wgMemoryLimit = "50M";
2124 * The minimum amount of time that MediaWiki needs for "slow" write request,
2125 * particularly ones with multiple non-atomic writes that *should* be as
2126 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2127 * @since 1.26
2129 $wgTransactionalTimeLimit = 120;
2131 /** @} */ # end performance hacks }
2133 /************************************************************************//**
2134 * @name Cache settings
2135 * @{
2139 * Directory for caching data in the local filesystem. Should not be accessible
2140 * from the web. Set this to false to not use any local caches.
2142 * Note: if multiple wikis share the same localisation cache directory, they
2143 * must all have the same set of extensions. You can set a directory just for
2144 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2146 $wgCacheDirectory = false;
2149 * Main cache type. This should be a cache with fast access, but it may have
2150 * limited space. By default, it is disabled, since the stock database cache
2151 * is not fast enough to make it worthwhile.
2153 * The options are:
2155 * - CACHE_ANYTHING: Use anything, as long as it works
2156 * - CACHE_NONE: Do not cache
2157 * - CACHE_DB: Store cache objects in the DB
2158 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2159 * - CACHE_ACCEL: APC, XCache or WinCache
2160 * - (other): A string may be used which identifies a cache
2161 * configuration in $wgObjectCaches.
2163 * @see $wgMessageCacheType, $wgParserCacheType
2165 $wgMainCacheType = CACHE_NONE;
2168 * The cache type for storing the contents of the MediaWiki namespace. This
2169 * cache is used for a small amount of data which is expensive to regenerate.
2171 * For available types see $wgMainCacheType.
2173 $wgMessageCacheType = CACHE_ANYTHING;
2176 * The cache type for storing article HTML. This is used to store data which
2177 * is expensive to regenerate, and benefits from having plenty of storage space.
2179 * For available types see $wgMainCacheType.
2181 $wgParserCacheType = CACHE_ANYTHING;
2184 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2186 * For available types see $wgMainCacheType.
2188 $wgSessionCacheType = CACHE_ANYTHING;
2191 * The cache type for storing language conversion tables,
2192 * which are used when parsing certain text and interface messages.
2194 * For available types see $wgMainCacheType.
2196 * @since 1.20
2198 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2201 * Advanced object cache configuration.
2203 * Use this to define the class names and constructor parameters which are used
2204 * for the various cache types. Custom cache types may be defined here and
2205 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2206 * or $wgLanguageConverterCacheType.
2208 * The format is an associative array where the key is a cache identifier, and
2209 * the value is an associative array of parameters. The "class" parameter is the
2210 * class name which will be used. Alternatively, a "factory" parameter may be
2211 * given, giving a callable function which will generate a suitable cache object.
2213 $wgObjectCaches = array(
2214 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2215 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2217 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2218 CACHE_ACCEL => array( 'factory' => 'ObjectCache::getLocalServerInstance' ),
2219 CACHE_MEMCACHED => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2221 'db-replicated' => array(
2222 'class' => 'ReplicatedBagOStuff',
2223 'readFactory' => array(
2224 'class' => 'SqlBagOStuff',
2225 'args' => array( array( 'slaveOnly' => true ) )
2227 'writeFactory' => array(
2228 'class' => 'SqlBagOStuff',
2229 'args' => array( array( 'slaveOnly' => false ) )
2231 'loggroup' => 'SQLBagOStuff'
2234 'apc' => array( 'class' => 'APCBagOStuff' ),
2235 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2236 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2237 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2238 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2239 'hash' => array( 'class' => 'HashBagOStuff' ),
2243 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2244 * but it may have limited space. By default, it is disabled, since the basic stock
2245 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2246 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2247 * cache with a relayer of type EventRelayerNull.
2249 * The options are:
2250 * - false: Configure the cache using $wgMainCacheType, without using
2251 * a relayer (only matters if there are multiple data-centers)
2252 * - CACHE_NONE: Do not cache
2253 * - (other): A string may be used which identifies a cache
2254 * configuration in $wgWANObjectCaches
2255 * @since 1.26
2257 $wgMainWANCache = false;
2260 * Advanced WAN object cache configuration.
2262 * Each WAN cache wraps a registered object cache (for the local cluster)
2263 * and it must also be configured to point to a PubSub instance. Subscribers
2264 * must be configured to relay purges to the actual cache servers.
2266 * The format is an associative array where the key is a cache identifier, and
2267 * the value is an associative array of parameters. The "cacheId" parameter is
2268 * a cache identifier from $wgObjectCaches. The "relayerConfig" parameter is an
2269 * array used to construct an EventRelayer object. The "pool" parameter is a
2270 * string that is used as a PubSub channel prefix. The "loggroup" parameter
2271 * controls where log events are sent.
2273 * @since 1.26
2275 $wgWANObjectCaches = array(
2276 CACHE_NONE => array(
2277 'class' => 'WANObjectCache',
2278 'cacheId' => CACHE_NONE,
2279 'pool' => 'mediawiki-main-none',
2280 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2282 /* Example of a simple single data-center cache:
2283 'memcached-php' => array(
2284 'class' => 'WANObjectCache',
2285 'cacheId' => 'memcached-php',
2286 'pool' => 'mediawiki-main-memcached',
2287 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2293 * Main object stash type. This should be a fast storage system for storing
2294 * lightweight data like hit counters and user activity. Sites with multiple
2295 * data-centers should have this use a store that replicates all writes. The
2296 * store should have enough consistency for CAS operations to be usable.
2297 * Reads outside of those needed for merge() may be eventually consistent.
2299 * The options are:
2300 * - db: Store cache objects in the DB
2301 * - (other): A string may be used which identifies a cache
2302 * configuration in $wgObjectCaches
2304 * @since 1.26
2306 $wgMainStash = 'db-replicated';
2309 * The expiry time for the parser cache, in seconds.
2310 * The default is 86400 (one day).
2312 $wgParserCacheExpireTime = 86400;
2315 * Deprecated alias for $wgSessionsInObjectCache.
2317 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2319 $wgSessionsInMemcached = false;
2322 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2323 * can be useful to improve performance, or to avoid the locking behavior of
2324 * PHP's default session handler, which tends to prevent multiple requests for
2325 * the same user from acting concurrently.
2327 $wgSessionsInObjectCache = false;
2330 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2331 * enabled, in seconds.
2333 $wgObjectCacheSessionExpiry = 3600;
2336 * This is used for setting php's session.save_handler. In practice, you will
2337 * almost never need to change this ever. Other options might be 'user' or
2338 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2339 * useful if you're doing cross-application sessions, see bug 11381)
2341 $wgSessionHandler = null;
2344 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2346 $wgMemCachedDebug = false;
2349 * The list of MemCached servers and port numbers
2351 $wgMemCachedServers = array( '127.0.0.1:11211' );
2354 * Use persistent connections to MemCached, which are shared across multiple
2355 * requests.
2357 $wgMemCachedPersistent = false;
2360 * Read/write timeout for MemCached server communication, in microseconds.
2362 $wgMemCachedTimeout = 500000;
2365 * Set this to true to maintain a copy of the message cache on the local server.
2367 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2369 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2371 * Note that this is about the message cache, which stores interface messages
2372 * maintained as wiki pages. This is separate from the localisation cache for interface
2373 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2375 $wgUseLocalMessageCache = false;
2378 * Instead of caching everything, only cache those messages which have
2379 * been customised in the site content language. This means that
2380 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2381 * This option is probably only useful for translatewiki.net.
2383 $wgAdaptiveMessageCache = false;
2386 * Localisation cache configuration. Associative array with keys:
2387 * class: The class to use. May be overridden by extensions.
2389 * store: The location to store cache data. May be 'files', 'array', 'db' or
2390 * 'detect'. If set to "files", data will be in CDB files. If set
2391 * to "db", data will be stored to the database. If set to
2392 * "detect", files will be used if $wgCacheDirectory is set,
2393 * otherwise the database will be used.
2394 * "array" is an experimental option that uses PHP files that
2395 * store static arrays.
2397 * storeClass: The class name for the underlying storage. If set to a class
2398 * name, it overrides the "store" setting.
2400 * storeDirectory: If the store class puts its data in files, this is the
2401 * directory it will use. If this is false, $wgCacheDirectory
2402 * will be used.
2404 * manualRecache: Set this to true to disable cache updates on web requests.
2405 * Use maintenance/rebuildLocalisationCache.php instead.
2407 $wgLocalisationCacheConf = array(
2408 'class' => 'LocalisationCache',
2409 'store' => 'detect',
2410 'storeClass' => false,
2411 'storeDirectory' => false,
2412 'manualRecache' => false,
2416 * Allow client-side caching of pages
2418 $wgCachePages = true;
2421 * Set this to current time to invalidate all prior cached pages. Affects both
2422 * client-side and server-side caching.
2423 * You can get the current date on your server by using the command:
2424 * @verbatim
2425 * date +%Y%m%d%H%M%S
2426 * @endverbatim
2428 $wgCacheEpoch = '20030516000000';
2431 * Directory where GitInfo will look for pre-computed cache files. If false,
2432 * $wgCacheDirectory/gitinfo will be used.
2434 $wgGitInfoCacheDirectory = false;
2437 * Bump this number when changing the global style sheets and JavaScript.
2439 * It should be appended in the query string of static CSS and JS includes,
2440 * to ensure that client-side caches do not keep obsolete copies of global
2441 * styles.
2443 $wgStyleVersion = '303';
2446 * This will cache static pages for non-logged-in users to reduce
2447 * database traffic on public sites. ResourceLoader requests to default
2448 * language and skins are cached as well as single module requests.
2450 $wgUseFileCache = false;
2453 * Depth of the subdirectory hierarchy to be created under
2454 * $wgFileCacheDirectory. The subdirectories will be named based on
2455 * the MD5 hash of the title. A value of 0 means all cache files will
2456 * be put directly into the main file cache directory.
2458 $wgFileCacheDepth = 2;
2461 * Kept for extension compatibility; see $wgParserCacheType
2462 * @deprecated 1.26
2464 $wgEnableParserCache = true;
2467 * Append a configured value to the parser cache and the sitenotice key so
2468 * that they can be kept separate for some class of activity.
2470 $wgRenderHashAppend = '';
2473 * If on, the sidebar navigation links are cached for users with the
2474 * current language set. This can save a touch of load on a busy site
2475 * by shaving off extra message lookups.
2477 * However it is also fragile: changing the site configuration, or
2478 * having a variable $wgArticlePath, can produce broken links that
2479 * don't update as expected.
2481 $wgEnableSidebarCache = false;
2484 * Expiry time for the sidebar cache, in seconds
2486 $wgSidebarCacheExpiry = 86400;
2489 * When using the file cache, we can store the cached HTML gzipped to save disk
2490 * space. Pages will then also be served compressed to clients that support it.
2492 * Requires zlib support enabled in PHP.
2494 $wgUseGzip = false;
2497 * Whether MediaWiki should send an ETag header. Seems to cause
2498 * broken behavior with Squid 2.6, see bug 7098.
2500 $wgUseETag = false;
2503 * Clock skew or the one-second resolution of time() can occasionally cause cache
2504 * problems when the user requests two pages within a short period of time. This
2505 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2506 * a grace period.
2508 $wgClockSkewFudge = 5;
2511 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2512 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2513 * was previously done in the default LocalSettings.php file.
2515 * On high-traffic wikis, this should be set to false, to avoid the need to
2516 * check the file modification time, and to avoid the performance impact of
2517 * unnecessary cache invalidations.
2519 $wgInvalidateCacheOnLocalSettingsChange = true;
2522 * When loading extensions through the extension registration system, this
2523 * can be used to invalidate the cache. A good idea would be to set this to
2524 * one file, you can just `touch` that one to invalidate the cache
2526 * @par Example:
2527 * @code
2528 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2529 * @endcode
2531 * If set to false, the mtime for each individual JSON file will be checked,
2532 * which can be slow if a large number of extensions are being loaded.
2534 * @var int|bool
2536 $wgExtensionInfoMTime = false;
2538 /** @} */ # end of cache settings
2540 /************************************************************************//**
2541 * @name HTTP proxy (CDN) settings
2543 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2544 * although they are referred to as Squid settings for historical reasons.
2546 * Achieving a high hit ratio with an HTTP proxy requires special
2547 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2548 * more details.
2550 * @{
2554 * Enable/disable CDN.
2555 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2557 $wgUseSquid = false;
2560 * If you run Squid3 with ESI support, enable this (default:false):
2562 $wgUseESI = false;
2565 * Send the Key HTTP header for better caching.
2566 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2567 * @since 1.27
2569 $wgUseKeyHeader = false;
2572 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2573 * RSS/Atom feeds. Use this if you have an SSL termination setup
2574 * and need to split the cache between HTTP and HTTPS for API requests,
2575 * feed requests and HTTP redirect responses in order to prevent cache
2576 * pollution. This does not affect 'normal' requests to index.php other than
2577 * HTTP redirects.
2579 $wgVaryOnXFP = false;
2582 * Internal server name as known to CDN, if different.
2584 * @par Example:
2585 * @code
2586 * $wgInternalServer = 'http://yourinternal.tld:8000';
2587 * @endcode
2589 $wgInternalServer = false;
2592 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2593 * Surrogate-Control (with ESI). Without ESI, you should strip
2594 * out s-maxage in the CDN config.
2596 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2598 $wgSquidMaxage = 18000;
2601 * Cache timeout for the CDN when DB slave lag is high
2602 * @see $wgSquidMaxage
2603 * @since 1.27
2605 $wgCdnMaxageLagged = 30;
2608 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2609 * this many seconds later via the job queue. This requires delayed job support.
2610 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2611 * slave lag does not cause page to be stuck in stales states in CDN.
2613 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2614 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2615 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2616 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2617 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2619 * @since 1.27
2621 $wgCdnReboundPurgeDelay = 0;
2624 * Default maximum age for raw CSS/JS accesses
2626 * 300 seconds = 5 minutes.
2628 $wgForcedRawSMaxage = 300;
2631 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2633 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2634 * headers sent/modified from these proxies when obtaining the remote IP address
2636 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2638 $wgSquidServers = array();
2641 * As above, except these servers aren't purged on page changes; use to set a
2642 * list of trusted proxies, etc. Supports both individual IP addresses and
2643 * CIDR blocks.
2644 * @since 1.23 Supports CIDR ranges
2646 $wgSquidServersNoPurge = array();
2649 * Whether to use a Host header in purge requests sent to the proxy servers
2650 * configured in $wgSquidServers. Set this to false to support Squid
2651 * configured in forward-proxy mode.
2653 * If this is set to true, a Host header will be sent, and only the path
2654 * component of the URL will appear on the request line, as if the request
2655 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2656 * request. Squid supports this style of request only if reverse-proxy mode
2657 * (http_port ... accel) is enabled.
2659 * If this is set to false, no Host header will be sent, and the absolute URL
2660 * will be sent in the request line, as is the standard for an HTTP proxy
2661 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2662 * by Varnish, but is supported by Squid in either configuration (forward or
2663 * reverse).
2665 * @since 1.21
2667 $wgSquidPurgeUseHostHeader = true;
2670 * Routing configuration for HTCP multicast purging. Add elements here to
2671 * enable HTCP and determine which purges are sent where. If set to an empty
2672 * array, HTCP is disabled.
2674 * Each key in this array is a regular expression to match against the purged
2675 * URL, or an empty string to match all URLs. The purged URL is matched against
2676 * the regexes in the order specified, and the first rule whose regex matches
2677 * is used, all remaining rules will thus be ignored.
2679 * @par Example configuration to send purges for upload.wikimedia.org to one
2680 * multicast group and all other purges to another:
2681 * @code
2682 * $wgHTCPRouting = array(
2683 * '|^https?://upload\.wikimedia\.org|' => array(
2684 * 'host' => '239.128.0.113',
2685 * 'port' => 4827,
2686 * ),
2687 * '' => array(
2688 * 'host' => '239.128.0.112',
2689 * 'port' => 4827,
2690 * ),
2691 * );
2692 * @endcode
2694 * You can also pass an array of hosts to send purges too. This is useful when
2695 * you have several multicast groups or unicast address that should receive a
2696 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2698 * @par Example of sending purges to multiple hosts:
2699 * @code
2700 * $wgHTCPRouting = array(
2701 * '' => array(
2702 * // Purges to text caches using multicast
2703 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2704 * // Purges to a hardcoded list of caches
2705 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2706 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2707 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2708 * ),
2709 * );
2710 * @endcode
2712 * @since 1.22
2714 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2715 * For back compatibility purposes, whenever its array is empty
2716 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2718 * @see $wgHTCPMulticastTTL
2720 $wgHTCPRouting = array();
2723 * HTCP multicast TTL.
2724 * @see $wgHTCPRouting
2726 $wgHTCPMulticastTTL = 1;
2729 * Should forwarded Private IPs be accepted?
2731 $wgUsePrivateIPs = false;
2733 /** @} */ # end of HTTP proxy settings
2735 /************************************************************************//**
2736 * @name Language, regional and character encoding settings
2737 * @{
2741 * Site language code. See languages/Names.php for languages supported by
2742 * MediaWiki out of the box. Not all languages listed there have translations,
2743 * see languages/messages/ for the list of languages with some localisation.
2745 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2746 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2748 * This defines the default interface language for all users, but users can
2749 * change it in their preferences.
2751 * This also defines the language of pages in the wiki. The content is wrapped
2752 * in a html element with lang=XX attribute. This behavior can be overridden
2753 * via hooks, see Title::getPageLanguage.
2755 $wgLanguageCode = 'en';
2758 * Language cache size, or really how many languages can we handle
2759 * simultaneously without degrading to crawl speed.
2761 $wgLangObjCacheSize = 10;
2764 * Some languages need different word forms, usually for different cases.
2765 * Used in Language::convertGrammar().
2767 * @par Example:
2768 * @code
2769 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2770 * @endcode
2772 $wgGrammarForms = array();
2775 * Treat language links as magic connectors, not inline links
2777 $wgInterwikiMagic = true;
2780 * Hide interlanguage links from the sidebar
2782 $wgHideInterlanguageLinks = false;
2785 * List of additional interwiki prefixes that should be treated as
2786 * interlanguage links (i.e. placed in the sidebar).
2787 * Notes:
2788 * - This will not do anything unless the prefixes are defined in the interwiki
2789 * map.
2790 * - The display text for these custom interlanguage links will be fetched from
2791 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2792 * this array.
2793 * - A friendly name for each site, used for tooltip text, may optionally be
2794 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2795 * the prefix in this array.
2797 $wgExtraInterlanguageLinkPrefixes = array();
2800 * List of language names or overrides for default names in Names.php
2802 $wgExtraLanguageNames = array();
2805 * List of language codes that don't correspond to an actual language.
2806 * These codes are mostly left-offs from renames, or other legacy things.
2807 * This array makes them not appear as a selectable language on the installer,
2808 * and excludes them when running the transstat.php script.
2810 $wgDummyLanguageCodes = array(
2811 'als' => 'gsw',
2812 'bat-smg' => 'sgs',
2813 'be-x-old' => 'be-tarask',
2814 'bh' => 'bho',
2815 'fiu-vro' => 'vro',
2816 'no' => 'nb',
2817 'qqq' => 'qqq', # Used for message documentation.
2818 'qqx' => 'qqx', # Used for viewing message keys.
2819 'roa-rup' => 'rup',
2820 'simple' => 'en',
2821 'zh-classical' => 'lzh',
2822 'zh-min-nan' => 'nan',
2823 'zh-yue' => 'yue',
2827 * Character set for use in the article edit box. Language-specific encodings
2828 * may be defined.
2830 * This historic feature is one of the first that was added by former MediaWiki
2831 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2833 $wgEditEncoding = '';
2836 * Set this to true to replace Arabic presentation forms with their standard
2837 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2838 * set to "ar".
2840 * Note that pages with titles containing presentation forms will become
2841 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2843 $wgFixArabicUnicode = true;
2846 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2847 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2848 * set to "ml". Note that some clients (even new clients as of 2010) do not
2849 * support these characters.
2851 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2852 * fix any ZWJ sequences in existing page titles.
2854 $wgFixMalayalamUnicode = true;
2857 * Set this to always convert certain Unicode sequences to modern ones
2858 * regardless of the content language. This has a small performance
2859 * impact.
2861 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2862 * details.
2864 * @since 1.17
2866 $wgAllUnicodeFixes = false;
2869 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2870 * loading old revisions not marked with "utf-8" flag. Use this when
2871 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2872 * burdensome mass conversion of old text data.
2874 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2875 * user names, etc still must be converted en masse in the database before
2876 * continuing as a UTF-8 wiki.
2878 $wgLegacyEncoding = false;
2881 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2882 * regexps : "/regexp/" matching problematic browsers. These browsers will
2883 * be served encoded unicode in the edit box instead of real unicode.
2885 $wgBrowserBlackList = array(
2887 * Netscape 2-4 detection
2888 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2889 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2890 * with a negative assertion. The [UIN] identifier specifies the level of security
2891 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2892 * The language string is unreliable, it is missing on NS4 Mac.
2894 * Reference: http://www.psychedelix.com/agents/index.shtml
2896 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2897 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2898 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2901 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2902 * Þ to <THORN> and Ð to <ETH>
2904 * Known useragents:
2905 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2906 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2907 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2908 * - [...]
2910 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2911 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2913 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2916 * Google wireless transcoder, seems to eat a lot of chars alive
2917 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2919 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2923 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2924 * create stub reference rows in the text table instead of copying
2925 * the full text of all current entries from 'cur' to 'text'.
2927 * This will speed up the conversion step for large sites, but
2928 * requires that the cur table be kept around for those revisions
2929 * to remain viewable.
2931 * This option affects the updaters *only*. Any present cur stub
2932 * revisions will be readable at runtime regardless of this setting.
2934 $wgLegacySchemaConversion = false;
2937 * Enable dates like 'May 12' instead of '12 May', if the default date format
2938 * is 'dmy or mdy'.
2940 $wgAmericanDates = false;
2943 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2944 * numerals in interface.
2946 $wgTranslateNumerals = true;
2949 * Translation using MediaWiki: namespace.
2950 * Interface messages will be loaded from the database.
2952 $wgUseDatabaseMessages = true;
2955 * Expiry time for the message cache key
2957 $wgMsgCacheExpiry = 86400;
2960 * Maximum entry size in the message cache, in bytes
2962 $wgMaxMsgCacheEntrySize = 10000;
2965 * Whether to enable language variant conversion.
2967 $wgDisableLangConversion = false;
2970 * Whether to enable language variant conversion for links.
2972 $wgDisableTitleConversion = false;
2975 * Default variant code, if false, the default will be the language code
2977 $wgDefaultLanguageVariant = false;
2980 * Disabled variants array of language variant conversion.
2982 * @par Example:
2983 * @code
2984 * $wgDisabledVariants[] = 'zh-mo';
2985 * $wgDisabledVariants[] = 'zh-my';
2986 * @endcode
2988 $wgDisabledVariants = array();
2991 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2992 * path format that describes which parts of the URL contain the
2993 * language variant.
2995 * @par Example:
2996 * @code
2997 * $wgLanguageCode = 'sr';
2998 * $wgVariantArticlePath = '/$2/$1';
2999 * $wgArticlePath = '/wiki/$1';
3000 * @endcode
3002 * A link to /wiki/ would be redirected to /sr/Главна_страна
3004 * It is important that $wgArticlePath not overlap with possible values
3005 * of $wgVariantArticlePath.
3007 $wgVariantArticlePath = false;
3010 * Show a bar of language selection links in the user login and user
3011 * registration forms; edit the "loginlanguagelinks" message to
3012 * customise these.
3014 $wgLoginLanguageSelector = false;
3017 * When translating messages with wfMessage(), it is not always clear what
3018 * should be considered UI messages and what should be content messages.
3020 * For example, for the English Wikipedia, there should be only one 'mainpage',
3021 * so when getting the link for 'mainpage', we should treat it as site content
3022 * and call ->inContentLanguage()->text(), but for rendering the text of the
3023 * link, we call ->text(). The code behaves this way by default. However,
3024 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3025 * and the like for different languages. This array provides a way to override
3026 * the default behavior.
3028 * @par Example:
3029 * To allow language-specific main page and community
3030 * portal:
3031 * @code
3032 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
3033 * @endcode
3035 $wgForceUIMsgAsContentMsg = array();
3038 * Fake out the timezone that the server thinks it's in. This will be used for
3039 * date display and not for what's stored in the DB. Leave to null to retain
3040 * your server's OS-based timezone value.
3042 * This variable is currently used only for signature formatting and for local
3043 * time/date parser variables ({{LOCALTIME}} etc.)
3045 * Timezones can be translated by editing MediaWiki messages of type
3046 * timezone-nameinlowercase like timezone-utc.
3048 * A list of usable timezones can found at:
3049 * http://php.net/manual/en/timezones.php
3051 * @par Examples:
3052 * @code
3053 * $wgLocaltimezone = 'UTC';
3054 * $wgLocaltimezone = 'GMT';
3055 * $wgLocaltimezone = 'PST8PDT';
3056 * $wgLocaltimezone = 'Europe/Sweden';
3057 * $wgLocaltimezone = 'CET';
3058 * @endcode
3060 $wgLocaltimezone = null;
3063 * Set an offset from UTC in minutes to use for the default timezone setting
3064 * for anonymous users and new user accounts.
3066 * This setting is used for most date/time displays in the software, and is
3067 * overridable in user preferences. It is *not* used for signature timestamps.
3069 * By default, this will be set to match $wgLocaltimezone.
3071 $wgLocalTZoffset = null;
3073 /** @} */ # End of language/charset settings
3075 /*************************************************************************//**
3076 * @name Output format and skin settings
3077 * @{
3081 * The default Content-Type header.
3083 $wgMimeType = 'text/html';
3086 * Previously used as content type in HTML script tags. This is now ignored since
3087 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3088 * It was also previously used by RawAction to determine the ctype query parameter
3089 * value that will result in a javascript response.
3090 * @deprecated since 1.22
3092 $wgJsMimeType = null;
3095 * The default xmlns attribute. The option to define this has been removed.
3096 * The value of this variable is no longer used by core and is set to a fixed
3097 * value in Setup.php for compatibility with extensions that depend on the value
3098 * of this variable being set. Such a dependency however is deprecated.
3099 * @deprecated since 1.22
3101 $wgXhtmlDefaultNamespace = null;
3104 * Previously used to determine if we should output an HTML5 doctype.
3105 * This is no longer used as we always output HTML5 now. For compatibility with
3106 * extensions that still check the value of this config it's value is now forced
3107 * to true by Setup.php.
3108 * @deprecated since 1.22
3110 $wgHtml5 = true;
3113 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
3114 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
3115 * (like if it's left at the default null value), it will be auto-initialized
3116 * to the correct value for RDFa+HTML5. As such, you should have no reason to
3117 * ever actually set this to anything.
3119 $wgHtml5Version = null;
3122 * Temporary variable that allows HTMLForms to be rendered as tables.
3123 * Table based layouts cause various issues when designing for mobile.
3124 * This global allows skins or extensions a means to force non-table based rendering.
3125 * Setting to false forces form components to always render as div elements.
3126 * @since 1.24
3128 $wgHTMLFormAllowTableFormat = true;
3131 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3132 * Temporary variable that should be removed when mediawiki ui is more
3133 * stable and change has been communicated.
3134 * @since 1.24
3136 $wgUseMediaWikiUIEverywhere = false;
3139 * Enabled RDFa attributes for use in wikitext.
3140 * NOTE: Interaction with HTML5 is somewhat underspecified.
3142 $wgAllowRdfaAttributes = false;
3145 * Enabled HTML5 microdata attributes for use in wikitext.
3147 $wgAllowMicrodataAttributes = false;
3150 * Should we try to make our HTML output well-formed XML? If set to false,
3151 * output will be a few bytes shorter, and the HTML will arguably be more
3152 * readable. If set to true, life will be much easier for the authors of
3153 * screen-scraping bots, and the HTML will arguably be more readable.
3155 * Setting this to false may omit quotation marks on some attributes, omit
3156 * slashes from some self-closing tags, omit some ending tags, etc., where
3157 * permitted by HTML5. Setting it to true will not guarantee that all pages
3158 * will be well-formed, although non-well-formed pages should be rare and it's
3159 * a bug if you find one. Conversely, setting it to false doesn't mean that
3160 * all XML-y constructs will be omitted, just that they might be.
3162 * Because of compatibility with screen-scraping bots, and because it's
3163 * controversial, this is currently left to true by default.
3165 $wgWellFormedXml = true;
3168 * Permit other namespaces in addition to the w3.org default.
3170 * Use the prefix for the key and the namespace for the value.
3172 * @par Example:
3173 * @code
3174 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3175 * @endcode
3176 * Normally we wouldn't have to define this in the root "<html>"
3177 * element, but IE needs it there in some circumstances.
3179 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3181 $wgXhtmlNamespaces = array();
3184 * Site notice shown at the top of each page
3186 * MediaWiki:Sitenotice page, which will override this. You can also
3187 * provide a separate message for logged-out users using the
3188 * MediaWiki:Anonnotice page.
3190 $wgSiteNotice = '';
3193 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3195 $wgSiteSupportPage = '';
3198 * Validate the overall output using tidy and refuse
3199 * to display the page if it's not valid.
3201 $wgValidateAllHtml = false;
3204 * Default skin, for new users and anonymous visitors. Registered users may
3205 * change this to any one of the other available skins in their preferences.
3207 $wgDefaultSkin = 'vector';
3210 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3212 * @since 1.24
3214 $wgFallbackSkin = 'fallback';
3217 * Specify the names of skins that should not be presented in the list of
3218 * available skins in user preferences. If you want to remove a skin entirely,
3219 * remove it from the skins/ directory and its entry from LocalSettings.php.
3221 $wgSkipSkins = array();
3224 * @deprecated since 1.23; use $wgSkipSkins instead
3226 $wgSkipSkin = '';
3229 * Allow user Javascript page?
3230 * This enables a lot of neat customizations, but may
3231 * increase security risk to users and server load.
3233 $wgAllowUserJs = false;
3236 * Allow user Cascading Style Sheets (CSS)?
3237 * This enables a lot of neat customizations, but may
3238 * increase security risk to users and server load.
3240 $wgAllowUserCss = false;
3243 * Allow user-preferences implemented in CSS?
3244 * This allows users to customise the site appearance to a greater
3245 * degree; disabling it will improve page load times.
3247 $wgAllowUserCssPrefs = true;
3250 * Use the site's Javascript page?
3252 $wgUseSiteJs = true;
3255 * Use the site's Cascading Style Sheets (CSS)?
3257 $wgUseSiteCss = true;
3260 * Break out of framesets. This can be used to prevent clickjacking attacks,
3261 * or to prevent external sites from framing your site with ads.
3263 $wgBreakFrames = false;
3266 * The X-Frame-Options header to send on pages sensitive to clickjacking
3267 * attacks, such as edit pages. This prevents those pages from being displayed
3268 * in a frame or iframe. The options are:
3270 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3272 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3273 * to allow framing within a trusted domain. This is insecure if there
3274 * is a page on the same domain which allows framing of arbitrary URLs.
3276 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3277 * full compromise of local user accounts. Private wikis behind a
3278 * corporate firewall are especially vulnerable. This is not
3279 * recommended.
3281 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3282 * not just edit pages.
3284 $wgEditPageFrameOptions = 'DENY';
3287 * Disallow framing of API pages directly, by setting the X-Frame-Options
3288 * header. Since the API returns CSRF tokens, allowing the results to be
3289 * framed can compromise your user's account security.
3290 * Options are:
3291 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3292 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3293 * - false: Allow all framing.
3294 * Note: $wgBreakFrames will override this for human formatted API output.
3296 $wgApiFrameOptions = 'DENY';
3299 * Disable output compression (enabled by default if zlib is available)
3301 $wgDisableOutputCompression = false;
3304 * Should we allow a broader set of characters in id attributes, per HTML5? If
3305 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3306 * functionality is ready, it will be on by default with no option.
3308 * Currently this appears to work fine in all browsers, but it's disabled by
3309 * default because it normalizes id's a bit too aggressively, breaking preexisting
3310 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3312 $wgExperimentalHtmlIds = false;
3315 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3316 * You can add new icons to the built in copyright or poweredby, or you can create
3317 * a new block. Though note that you may need to add some custom css to get good styling
3318 * of new blocks in monobook. vector and modern should work without any special css.
3320 * $wgFooterIcons itself is a key/value array.
3321 * The key is the name of a block that the icons will be wrapped in. The final id varies
3322 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3323 * turns it into mw_poweredby.
3324 * The value is either key/value array of icons or a string.
3325 * In the key/value array the key may or may not be used by the skin but it can
3326 * be used to find the icon and unset it or change the icon if needed.
3327 * This is useful for disabling icons that are set by extensions.
3328 * The value should be either a string or an array. If it is a string it will be output
3329 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3330 * for the icon, the following keys are used:
3331 * - src: An absolute url to the image to use for the icon, this is recommended
3332 * but not required, however some skins will ignore icons without an image
3333 * - srcset: optional additional-resolution images; see HTML5 specs
3334 * - url: The url to use in the a element around the text or icon, if not set an a element will
3335 * not be outputted
3336 * - alt: This is the text form of the icon, it will be displayed without an image in
3337 * skins like Modern or if src is not set, and will otherwise be used as
3338 * the alt="" for the image. This key is required.
3339 * - width and height: If the icon specified by src is not of the standard size
3340 * you can specify the size of image to use with these keys.
3341 * Otherwise they will default to the standard 88x31.
3342 * @todo Reformat documentation.
3344 $wgFooterIcons = array(
3345 "copyright" => array(
3346 "copyright" => array(), // placeholder for the built in copyright icon
3348 "poweredby" => array(
3349 "mediawiki" => array(
3350 // Defaults to point at
3351 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3352 // plus srcset for 1.5x, 2x resolution variants.
3353 "src" => null,
3354 "url" => "//www.mediawiki.org/",
3355 "alt" => "Powered by MediaWiki",
3361 * Login / create account link behavior when it's possible for anonymous users
3362 * to create an account.
3363 * - true = use a combined login / create account link
3364 * - false = split login and create account into two separate links
3366 $wgUseCombinedLoginLink = false;
3369 * Display user edit counts in various prominent places.
3371 $wgEdititis = false;
3374 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3375 * status code, mangling or hiding MediaWiki's output. If you are using such a
3376 * host, you should start looking for a better one. While you're doing that,
3377 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3378 * that the generated error pages can be seen.
3380 * In cases where for technical reasons it is more important for MediaWiki to
3381 * send the correct status code than for the body to be transmitted intact,
3382 * this configuration variable is ignored.
3384 $wgSend404Code = true;
3387 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3388 * The numeric value of the variable controls how many edits MediaWiki will look back to
3389 * determine whether a rollback is allowed (by checking that they are all from the same author).
3390 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3391 * from hiding some useless rollback links.
3393 * @since 1.20
3395 $wgShowRollbackEditCount = 10;
3398 * Output a <link rel="canonical"> tag on every page indicating the canonical
3399 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3400 * detection of the current server is unreliable, the link is sent
3401 * unconditionally.
3403 $wgEnableCanonicalServerLink = false;
3406 * When OutputHandler is used, mangle any output that contains
3407 * <cross-domain-policy>. Without this, an attacker can send their own
3408 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3409 * the domain root.
3411 * @since 1.25
3413 $wgMangleFlashPolicy = true;
3415 /** @} */ # End of output format settings }
3417 /*************************************************************************//**
3418 * @name ResourceLoader settings
3419 * @{
3423 * Client-side resource modules.
3425 * Extensions should add their ResourceLoader module definitions
3426 * to the $wgResourceModules variable.
3428 * @par Example:
3429 * @code
3430 * $wgResourceModules['ext.myExtension'] = array(
3431 * 'scripts' => 'myExtension.js',
3432 * 'styles' => 'myExtension.css',
3433 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3434 * 'localBasePath' => __DIR__,
3435 * 'remoteExtPath' => 'MyExtension',
3436 * );
3437 * @endcode
3439 $wgResourceModules = array();
3442 * Skin-specific styles for resource modules.
3444 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3445 * not be modified or disabled.
3447 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3449 * @par Example:
3450 * @code
3451 * $wgResourceModules['bar'] = array(
3452 * 'scripts' => 'resources/bar/bar.js',
3453 * 'styles' => 'resources/bar/main.css',
3454 * );
3456 * $wgResourceModuleSkinStyles['foo'] = array(
3457 * 'bar' => 'skins/Foo/bar.css',
3458 * );
3459 * @endcode
3461 * This is mostly equivalent to:
3463 * @par Equivalent:
3464 * @code
3465 * $wgResourceModules['bar'] = array(
3466 * 'scripts' => 'resources/bar/bar.js',
3467 * 'styles' => 'resources/bar/main.css',
3468 * 'skinStyles' => array(
3469 * 'foo' => skins/Foo/bar.css',
3470 * ),
3471 * );
3472 * @endcode
3474 * If the module already defines its own entry in `skinStyles` for a given skin, then
3475 * $wgResourceModuleSkinStyles is ignored.
3477 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3478 * of replacing them. This can be done using the `+` prefix.
3480 * @par Example:
3481 * @code
3482 * $wgResourceModules['bar'] = array(
3483 * 'scripts' => 'resources/bar/bar.js',
3484 * 'styles' => 'resources/bar/basic.css',
3485 * 'skinStyles' => array(
3486 * 'default' => 'resources/bar/additional.css',
3487 * ),
3488 * );
3489 * // Note the '+' character:
3490 * $wgResourceModuleSkinStyles['foo'] = array(
3491 * '+bar' => 'skins/Foo/bar.css',
3492 * );
3493 * @endcode
3495 * This is mostly equivalent to:
3497 * @par Equivalent:
3498 * @code
3499 * $wgResourceModules['bar'] = array(
3500 * 'scripts' => 'resources/bar/bar.js',
3501 * 'styles' => 'resources/bar/basic.css',
3502 * 'skinStyles' => array(
3503 * 'default' => 'resources/bar/additional.css',
3504 * 'foo' => array(
3505 * 'resources/bar/additional.css',
3506 * 'skins/Foo/bar.css',
3507 * ),
3508 * ),
3509 * );
3510 * @endcode
3512 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3513 * disabled by a skin. To provide default styles that may be extended or replaced,
3514 * use `skinStyles['default']`.
3516 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3517 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3519 * @par Example:
3520 * @code
3521 * $wgResourceModuleSkinStyles['foo'] = array(
3522 * 'bar' => 'bar.css',
3523 * 'quux' => 'quux.css',
3524 * 'remoteSkinPath' => 'Foo',
3525 * 'localBasePath' => __DIR__,
3526 * );
3527 * @endcode
3529 $wgResourceModuleSkinStyles = array();
3532 * Extensions should register foreign module sources here. 'local' is a
3533 * built-in source that is not in this array, but defined by
3534 * ResourceLoader::__construct() so that it cannot be unset.
3536 * @par Example:
3537 * @code
3538 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3539 * @endcode
3541 $wgResourceLoaderSources = array();
3544 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3545 * Defaults to $wgScriptPath.
3547 $wgResourceBasePath = null;
3550 * Maximum time in seconds to cache resources served by ResourceLoader.
3551 * Used to set last modified headers (max-age/s-maxage).
3553 * Following options to distinguish:
3554 * - versioned: Used for modules with a version, because changing version
3555 * numbers causes cache misses. This normally has a long expiry time.
3556 * - unversioned: Used for modules without a version to propagate changes
3557 * quickly to clients. Also used for modules with errors to recover quickly.
3558 * This normally has a short expiry time.
3560 * Expiry time for the options to distinguish:
3561 * - server: Squid/Varnish but also any other public proxy cache between the
3562 * client and MediaWiki.
3563 * - client: On the client side (e.g. in the browser cache).
3565 $wgResourceLoaderMaxage = array(
3566 'versioned' => array(
3567 'server' => 30 * 24 * 60 * 60, // 30 days
3568 'client' => 30 * 24 * 60 * 60, // 30 days
3570 'unversioned' => array(
3571 'server' => 5 * 60, // 5 minutes
3572 'client' => 5 * 60, // 5 minutes
3577 * The default debug mode (on/off) for of ResourceLoader requests.
3579 * This will still be overridden when the debug URL parameter is used.
3581 $wgResourceLoaderDebug = false;
3584 * Put each statement on its own line when minifying JavaScript. This makes
3585 * debugging in non-debug mode a bit easier.
3587 * @deprecated since 1.27: Always false; no longer configurable.
3589 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3592 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3593 * the minifier will try not to produce lines longer than this, but may be
3594 * forced to do so in certain cases.
3596 * @deprecated since 1.27: Always 1,000; no longer configurable.
3598 $wgResourceLoaderMinifierMaxLineLength = 1000;
3601 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3603 * @deprecated since 1.26: Always declare dependencies.
3605 $wgIncludeLegacyJavaScript = true;
3608 * Whether to ensure the mediawiki.util is loaded before other modules.
3610 * Before MediaWiki 1.19, modules used to load less asynchronous which allowed
3611 * modules to lack dependencies on 'popular' modules that were likely loaded already.
3613 * This setting is to aid scripts during migration by providing mediawiki.util
3614 * unconditionally (which was the most commonly missed dependency). It doesn't
3615 * cover all missing dependencies obviously but should fix most of them.
3617 * This should be removed at some point after site/user scripts have been fixed.
3618 * Enable this if your wiki has a large amount of user/site scripts that are
3619 * lacking dependencies.
3621 * @deprecated since 1.26: Always declare dependencies.
3623 $wgPreloadJavaScriptMwUtil = false;
3626 * Whether or not to assign configuration variables to the global window object.
3628 * If this is set to false, old code using deprecated variables will no longer
3629 * work.
3631 * @par Example of legacy code:
3632 * @code{,js}
3633 * if ( window.wgRestrictionEdit ) { ... }
3634 * @endcode
3635 * or:
3636 * @code{,js}
3637 * if ( wgIsArticle ) { ... }
3638 * @endcode
3640 * Instead, one needs to use mw.config.
3641 * @par Example using mw.config global configuration:
3642 * @code{,js}
3643 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3644 * @endcode
3645 * or:
3646 * @code{,js}
3647 * if ( mw.config.get('wgIsArticle') ) { ... }
3648 * @endcode
3650 $wgLegacyJavaScriptGlobals = true;
3653 * If set to a positive number, ResourceLoader will not generate URLs whose
3654 * query string is more than this many characters long, and will instead use
3655 * multiple requests with shorter query strings. This degrades performance,
3656 * but may be needed if your web server has a low (less than, say 1024)
3657 * query string length limit or a low value for suhosin.get.max_value_length
3658 * that you can't increase.
3660 * If set to a negative number, ResourceLoader will assume there is no query
3661 * string length limit.
3663 * Defaults to a value based on php configuration.
3665 $wgResourceLoaderMaxQueryLength = false;
3668 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3669 * prior to minification to validate it.
3671 * Parse errors will result in a JS exception being thrown during module load,
3672 * which avoids breaking other modules loaded in the same request.
3674 $wgResourceLoaderValidateJS = true;
3677 * If set to true, statically-sourced (file-backed) JavaScript resources will
3678 * be parsed for validity before being bundled up into ResourceLoader modules.
3680 * This can be helpful for development by providing better error messages in
3681 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3682 * and may fail on large pre-bundled frameworks.
3684 $wgResourceLoaderValidateStaticJS = false;
3687 * Global LESS variables. An associative array binding variable names to
3688 * LESS code snippets representing their values.
3690 * Adding an item here is equivalent to writing `@variable: value;`
3691 * at the beginning of all your .less files, with all the consequences.
3692 * In particular, string values must be escaped and quoted.
3694 * Changes to LESS variables do not trigger cache invalidation.
3696 * If the LESS variables need to be dynamic, you can use the
3697 * ResourceLoaderGetLessVars hook (since 1.25).
3699 * @par Example:
3700 * @code
3701 * $wgResourceLoaderLESSVars = array(
3702 * 'baseFontSize' => '1em',
3703 * 'smallFontSize' => '0.75em',
3704 * 'WikimediaBlue' => '#006699',
3705 * );
3706 * @endcode
3707 * @since 1.22
3709 $wgResourceLoaderLESSVars = array();
3712 * Default import paths for LESS modules. LESS files referenced in @import
3713 * statements will be looked up here first, and relative to the importing file
3714 * second. To avoid collisions, it's important for the LESS files in these
3715 * directories to have a common, predictable file name prefix.
3717 * Extensions need not (and should not) register paths in
3718 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3719 * currently compiling LESS file, which allows each extension to freely import
3720 * files from its own tree.
3722 * @since 1.22
3724 $wgResourceLoaderLESSImportPaths = array(
3725 "$IP/resources/src/mediawiki.less/",
3729 * Whether ResourceLoader should attempt to persist modules in localStorage on
3730 * browsers that support the Web Storage API.
3732 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3734 $wgResourceLoaderStorageEnabled = false;
3737 * Cache version for client-side ResourceLoader module storage. You can trigger
3738 * invalidation of the contents of the module store by incrementing this value.
3740 * @since 1.23
3742 $wgResourceLoaderStorageVersion = 1;
3745 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3746 * restricted pages like Special:UserLogin or Special:Preferences where
3747 * JavaScript is disabled for security reasons. As it is possible to
3748 * execute JavaScript through CSS, setting this to true opens up a
3749 * potential security hole. Some sites may "skin" their wiki by using
3750 * site-wide CSS, causing restricted pages to look unstyled and different
3751 * from the rest of the site.
3753 * @since 1.25
3755 $wgAllowSiteCSSOnRestrictedPages = false;
3757 /** @} */ # End of ResourceLoader settings }
3759 /*************************************************************************//**
3760 * @name Page title and interwiki link settings
3761 * @{
3765 * Name of the project namespace. If left set to false, $wgSitename will be
3766 * used instead.
3768 $wgMetaNamespace = false;
3771 * Name of the project talk namespace.
3773 * Normally you can ignore this and it will be something like
3774 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3775 * manually for grammatical reasons.
3777 $wgMetaNamespaceTalk = false;
3780 * Additional namespaces. If the namespaces defined in Language.php and
3781 * Namespace.php are insufficient, you can create new ones here, for example,
3782 * to import Help files in other languages. You can also override the namespace
3783 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3784 * hook or extension.json.
3786 * @warning Once you delete a namespace, the pages in that namespace will
3787 * no longer be accessible. If you rename it, then you can access them through
3788 * the new namespace name.
3790 * Custom namespaces should start at 100 to avoid conflicting with standard
3791 * namespaces, and should always follow the even/odd main/talk pattern.
3793 * @par Example:
3794 * @code
3795 * $wgExtraNamespaces = array(
3796 * 100 => "Hilfe",
3797 * 101 => "Hilfe_Diskussion",
3798 * 102 => "Aide",
3799 * 103 => "Discussion_Aide"
3800 * );
3801 * @endcode
3803 * @todo Add a note about maintenance/namespaceDupes.php
3805 $wgExtraNamespaces = array();
3808 * Same as above, but for namespaces with gender distinction.
3809 * Note: the default form for the namespace should also be set
3810 * using $wgExtraNamespaces for the same index.
3811 * @since 1.18
3813 $wgExtraGenderNamespaces = array();
3816 * Namespace aliases.
3818 * These are alternate names for the primary localised namespace names, which
3819 * are defined by $wgExtraNamespaces and the language file. If a page is
3820 * requested with such a prefix, the request will be redirected to the primary
3821 * name.
3823 * Set this to a map from namespace names to IDs.
3825 * @par Example:
3826 * @code
3827 * $wgNamespaceAliases = array(
3828 * 'Wikipedian' => NS_USER,
3829 * 'Help' => 100,
3830 * );
3831 * @endcode
3833 $wgNamespaceAliases = array();
3836 * Allowed title characters -- regex character class
3837 * Don't change this unless you know what you're doing
3839 * Problematic punctuation:
3840 * - []{}|# Are needed for link syntax, never enable these
3841 * - <> Causes problems with HTML escaping, don't use
3842 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3843 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3844 * corrupted by apache
3845 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3847 * All three of these punctuation problems can be avoided by using an alias,
3848 * instead of a rewrite rule of either variety.
3850 * The problem with % is that when using a path to query rewrite rule, URLs are
3851 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3852 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3853 * for this, indeed double escaping would break if the double-escaped title was
3854 * passed in the query string rather than the path. This is a minor security issue
3855 * because articles can be created such that they are hard to view or edit.
3857 * In some rare cases you may wish to remove + for compatibility with old links.
3859 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3860 * this breaks interlanguage links
3862 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3865 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3867 * @deprecated since 1.23; use $wgLocalInterwikis instead
3869 $wgLocalInterwiki = false;
3872 * Array for multiple $wgLocalInterwiki values, in case there are several
3873 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3874 * set, its value is prepended to this array, for backwards compatibility.
3876 * Note, recent changes feeds use only the first entry in this array (or
3877 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3879 $wgLocalInterwikis = array();
3882 * Expiry time for cache of interwiki table
3884 $wgInterwikiExpiry = 10800;
3887 * @name Interwiki caching settings.
3888 * @{
3892 * Interwiki cache, either as an associative array or a path to a constant
3893 * database (.cdb) file.
3895 * This data structure database is generated by the `dumpInterwiki` maintenance
3896 * script (which lives in the WikimediaMaintenance repository) and has key
3897 * formats such as the following:
3899 * - dbname:key - a simple key (e.g. enwiki:meta)
3900 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3901 * - __global:key - global-scope key (e.g. __global:meta)
3902 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3904 * Sites mapping just specifies site name, other keys provide "local url"
3905 * data layout.
3907 * @var bool|array|string
3909 $wgInterwikiCache = false;
3912 * Specify number of domains to check for messages.
3913 * - 1: Just wiki(db)-level
3914 * - 2: wiki and global levels
3915 * - 3: site levels
3917 $wgInterwikiScopes = 3;
3920 * Fallback site, if unable to resolve from cache
3922 $wgInterwikiFallbackSite = 'wiki';
3924 /** @} */ # end of Interwiki caching settings.
3927 * @name SiteStore caching settings.
3928 * @{
3932 * Specify the file location for the Sites json cache file.
3934 $wgSitesCacheFile = false;
3936 /** @} */ # end of SiteStore caching settings.
3939 * If local interwikis are set up which allow redirects,
3940 * set this regexp to restrict URLs which will be displayed
3941 * as 'redirected from' links.
3943 * @par Example:
3944 * It might look something like this:
3945 * @code
3946 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3947 * @endcode
3949 * Leave at false to avoid displaying any incoming redirect markers.
3950 * This does not affect intra-wiki redirects, which don't change
3951 * the URL.
3953 $wgRedirectSources = false;
3956 * Set this to false to avoid forcing the first letter of links to capitals.
3958 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3959 * appearing with a capital at the beginning of a sentence will *not* go to the
3960 * same place as links in the middle of a sentence using a lowercase initial.
3962 $wgCapitalLinks = true;
3965 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3966 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3967 * true by default (and setting them has no effect), due to various things that
3968 * require them to be so. Also, since Talk namespaces need to directly mirror their
3969 * associated content namespaces, the values for those are ignored in favor of the
3970 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3971 * NS_FILE.
3973 * @par Example:
3974 * @code
3975 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3976 * @endcode
3978 $wgCapitalLinkOverrides = array();
3981 * Which namespaces should support subpages?
3982 * See Language.php for a list of namespaces.
3984 $wgNamespacesWithSubpages = array(
3985 NS_TALK => true,
3986 NS_USER => true,
3987 NS_USER_TALK => true,
3988 NS_PROJECT => true,
3989 NS_PROJECT_TALK => true,
3990 NS_FILE_TALK => true,
3991 NS_MEDIAWIKI => true,
3992 NS_MEDIAWIKI_TALK => true,
3993 NS_TEMPLATE_TALK => true,
3994 NS_HELP => true,
3995 NS_HELP_TALK => true,
3996 NS_CATEGORY_TALK => true
4000 * Array holding default tracking category names.
4002 * Array contains the system messages for each tracking category.
4003 * Tracking categories allow pages with certain characteristics to be tracked.
4004 * It works by adding any such page to a category automatically.
4006 * A message with the suffix '-desc' should be added as a description message
4007 * to have extra information on Special:TrackingCategories.
4009 * @deprecated since 1.25 Extensions should now register tracking categories using
4010 * the new extension registration system.
4012 * @since 1.23
4014 $wgTrackingCategories = array();
4017 * Array of namespaces which can be deemed to contain valid "content", as far
4018 * as the site statistics are concerned. Useful if additional namespaces also
4019 * contain "content" which should be considered when generating a count of the
4020 * number of articles in the wiki.
4022 $wgContentNamespaces = array( NS_MAIN );
4025 * Array of namespaces, in addition to the talk namespaces, where signatures
4026 * (~~~~) are likely to be used. This determines whether to display the
4027 * Signature button on the edit toolbar, and may also be used by extensions.
4028 * For example, "traditional" style wikis, where content and discussion are
4029 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4031 $wgExtraSignatureNamespaces = array();
4034 * Max number of redirects to follow when resolving redirects.
4035 * 1 means only the first redirect is followed (default behavior).
4036 * 0 or less means no redirects are followed.
4038 $wgMaxRedirects = 1;
4041 * Array of invalid page redirect targets.
4042 * Attempting to create a redirect to any of the pages in this array
4043 * will make the redirect fail.
4044 * Userlogout is hard-coded, so it does not need to be listed here.
4045 * (bug 10569) Disallow Mypage and Mytalk as well.
4047 * As of now, this only checks special pages. Redirects to pages in
4048 * other namespaces cannot be invalidated by this variable.
4050 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
4052 /** @} */ # End of title and interwiki settings }
4054 /************************************************************************//**
4055 * @name Parser settings
4056 * These settings configure the transformation from wikitext to HTML.
4057 * @{
4061 * Parser configuration. Associative array with the following members:
4063 * class The class name
4065 * preprocessorClass The preprocessor class. Two classes are currently available:
4066 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4067 * storage, and Preprocessor_DOM, which uses the DOM module for
4068 * temporary storage. Preprocessor_DOM generally uses less memory;
4069 * the speed of the two is roughly the same.
4071 * If this parameter is not given, it uses Preprocessor_DOM if the
4072 * DOM module is available, otherwise it uses Preprocessor_Hash.
4074 * The entire associative array will be passed through to the constructor as
4075 * the first parameter. Note that only Setup.php can use this variable --
4076 * the configuration will change at runtime via $wgParser member functions, so
4077 * the contents of this variable will be out-of-date. The variable can only be
4078 * changed during LocalSettings.php, in particular, it can't be changed during
4079 * an extension setup function.
4081 $wgParserConf = array(
4082 'class' => 'Parser',
4083 # 'preprocessorClass' => 'Preprocessor_Hash',
4087 * Maximum indent level of toc.
4089 $wgMaxTocLevel = 999;
4092 * A complexity limit on template expansion: the maximum number of nodes visited
4093 * by PPFrame::expand()
4095 $wgMaxPPNodeCount = 1000000;
4098 * A complexity limit on template expansion: the maximum number of elements
4099 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4100 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4101 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4102 * this default corresponds to about 155 MB.
4104 * When the limit is exceeded, an exception is thrown.
4106 $wgMaxGeneratedPPNodeCount = 1000000;
4109 * Maximum recursion depth for templates within templates.
4110 * The current parser adds two levels to the PHP call stack for each template,
4111 * and xdebug limits the call stack to 100 by default. So this should hopefully
4112 * stop the parser before it hits the xdebug limit.
4114 $wgMaxTemplateDepth = 40;
4117 * @see $wgMaxTemplateDepth
4119 $wgMaxPPExpandDepth = 40;
4122 * URL schemes that should be recognized as valid by wfParseUrl().
4124 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4125 * Instead, if you want to support file links, add 'file://'. The same applies
4126 * to any other protocols with the same name as a namespace. See bug #44011 for
4127 * more information.
4129 * @see wfParseUrl
4131 $wgUrlProtocols = array(
4132 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4133 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4134 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4135 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4139 * If true, removes (by substituting) templates in signatures.
4141 $wgCleanSignatures = true;
4144 * Whether to allow inline image pointing to other websites
4146 $wgAllowExternalImages = false;
4149 * If the above is false, you can specify an exception here. Image URLs
4150 * that start with this string are then rendered, while all others are not.
4151 * You can use this to set up a trusted, simple repository of images.
4152 * You may also specify an array of strings to allow multiple sites
4154 * @par Examples:
4155 * @code
4156 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4157 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4158 * @endcode
4160 $wgAllowExternalImagesFrom = '';
4163 * If $wgAllowExternalImages is false, you can allow an on-wiki
4164 * whitelist of regular expression fragments to match the image URL
4165 * against. If the image matches one of the regular expression fragments,
4166 * The image will be displayed.
4168 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4169 * Or false to disable it
4171 $wgEnableImageWhitelist = true;
4174 * A different approach to the above: simply allow the "<img>" tag to be used.
4175 * This allows you to specify alt text and other attributes, copy-paste HTML to
4176 * your wiki more easily, etc. However, allowing external images in any manner
4177 * will allow anyone with editing rights to snoop on your visitors' IP
4178 * addresses and so forth, if they wanted to, by inserting links to images on
4179 * sites they control.
4181 $wgAllowImageTag = false;
4184 * Configuration for HTML postprocessing tool. Set this to a configuration
4185 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4186 * used. See http://www.w3.org/People/Raggett/tidy/
4188 * If this is null and $wgUseTidy is true, the deprecated configuration
4189 * parameters will be used instead.
4191 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4193 * Keys are:
4194 * - driver: May be:
4195 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4196 * - RaggettInternalPHP: Use the PECL extension
4197 * - RaggettExternal: Shell out to an external binary (tidyBin)
4199 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4200 * - debugComment: True to add a comment to the output with warning messages
4201 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4202 * - tidyCommandLine: For RaggettExternal, additional command line options.
4204 $wgTidyConfig = null;
4207 * Set this to true to use the deprecated tidy configuration parameters.
4208 * @deprecated use $wgTidyConfig
4210 $wgUseTidy = false;
4213 * The path to the tidy binary.
4214 * @deprecated Use $wgTidyConfig['tidyBin']
4216 $wgTidyBin = 'tidy';
4219 * The path to the tidy config file
4220 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4222 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4225 * The command line options to the tidy binary
4226 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4228 $wgTidyOpts = '';
4231 * Set this to true to use the tidy extension
4232 * @deprecated Use $wgTidyConfig['driver']
4234 $wgTidyInternal = extension_loaded( 'tidy' );
4237 * Put tidy warnings in HTML comments
4238 * Only works for internal tidy.
4240 $wgDebugTidy = false;
4243 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4244 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4245 * TO RESTRICT EDITING to only those that you trust
4247 $wgRawHtml = false;
4250 * Set a default target for external links, e.g. _blank to pop up a new window
4252 $wgExternalLinkTarget = false;
4255 * If true, external URL links in wiki text will be given the
4256 * rel="nofollow" attribute as a hint to search engines that
4257 * they should not be followed for ranking purposes as they
4258 * are user-supplied and thus subject to spamming.
4260 $wgNoFollowLinks = true;
4263 * Namespaces in which $wgNoFollowLinks doesn't apply.
4264 * See Language.php for a list of namespaces.
4266 $wgNoFollowNsExceptions = array();
4269 * If this is set to an array of domains, external links to these domain names
4270 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4271 * value of $wgNoFollowLinks. For instance:
4273 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4274 * 'mediawiki.org' );
4276 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4277 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4278 * etc.
4280 * Defaults to mediawiki.org for the links included in the software by default.
4282 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4285 * Allow DISPLAYTITLE to change title display
4287 $wgAllowDisplayTitle = true;
4290 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4291 * canonical DB key. Also disallow some inline CSS rules like display: none;
4292 * which can cause the text to be hidden or unselectable.
4294 $wgRestrictDisplayTitle = true;
4297 * Maximum number of calls per parse to expensive parser functions such as
4298 * PAGESINCATEGORY.
4300 $wgExpensiveParserFunctionLimit = 100;
4303 * Preprocessor caching threshold
4304 * Setting it to 'false' will disable the preprocessor cache.
4306 $wgPreprocessorCacheThreshold = 1000;
4309 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4311 $wgEnableScaryTranscluding = false;
4314 * Expiry time for transcluded templates cached in transcache database table.
4315 * Only used $wgEnableInterwikiTranscluding is set to true.
4317 $wgTranscludeCacheExpiry = 3600;
4319 /** @} */ # end of parser settings }
4321 /************************************************************************//**
4322 * @name Statistics
4323 * @{
4327 * Method used to determine if a page in a content namespace should be counted
4328 * as a valid article.
4330 * Redirect pages will never be counted as valid articles.
4332 * This variable can have the following values:
4333 * - 'any': all pages as considered as valid articles
4334 * - 'comma': the page must contain a comma to be considered valid
4335 * - 'link': the page must contain a [[wiki link]] to be considered valid
4337 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4339 * Retroactively changing this variable will not affect the existing count,
4340 * to update it, you will need to run the maintenance/updateArticleCount.php
4341 * script.
4343 $wgArticleCountMethod = 'link';
4346 * How many days user must be idle before he is considered inactive. Will affect
4347 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4348 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4349 * You might want to leave this as the default value, to provide comparable
4350 * numbers between different wikis.
4352 $wgActiveUserDays = 30;
4354 /** @} */ # End of statistics }
4356 /************************************************************************//**
4357 * @name User accounts, authentication
4358 * @{
4362 * Central ID lookup providers
4363 * Key is the provider ID, value is a specification for ObjectFactory
4364 * @since 1.27
4366 $wgCentralIdLookupProviders = array(
4367 'local' => array( 'class' => 'LocalIdLookup' ),
4371 * Central ID lookup provider to use by default
4372 * @var string
4374 $wgCentralIdLookupProvider = 'local';
4377 * Password policy for local wiki users. A user's effective policy
4378 * is the superset of all policy statements from the policies for the
4379 * groups where the user is a member. If more than one group policy
4380 * include the same policy statement, the value is the max() of the
4381 * values. Note true > false. The 'default' policy group is required,
4382 * and serves as the minimum policy for all users. New statements can
4383 * be added by appending to $wgPasswordPolicy['checks'].
4384 * Statements:
4385 * - MinimalPasswordLength - minimum length a user can set
4386 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4387 * not be allowed to login, regardless if it is correct.
4388 * - MaximalPasswordLength - maximum length password a user is allowed
4389 * to attempt. Prevents DoS attacks with pbkdf2.
4390 * - PasswordCannotMatchUsername - Password cannot match username to
4391 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4392 * match a specific, hardcoded blacklist.
4393 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4394 * commonly chosen. Set to integer n to ban the top n passwords.
4395 * If you want to ban all common passwords on file, use the
4396 * PHP_INT_MAX constant.
4397 * @since 1.26
4399 $wgPasswordPolicy = array(
4400 'policies' => array(
4401 'bureaucrat' => array(
4402 'MinimalPasswordLength' => 8,
4403 'MinimumPasswordLengthToLogin' => 1,
4404 'PasswordCannotMatchUsername' => true,
4405 'PasswordCannotBePopular' => 25,
4407 'sysop' => array(
4408 'MinimalPasswordLength' => 8,
4409 'MinimumPasswordLengthToLogin' => 1,
4410 'PasswordCannotMatchUsername' => true,
4411 'PasswordCannotBePopular' => 25,
4413 'bot' => array(
4414 'MinimalPasswordLength' => 8,
4415 'MinimumPasswordLengthToLogin' => 1,
4416 'PasswordCannotMatchUsername' => true,
4418 'default' => array(
4419 'MinimalPasswordLength' => 1,
4420 'PasswordCannotMatchUsername' => true,
4421 'PasswordCannotMatchBlacklist' => true,
4422 'MaximalPasswordLength' => 4096,
4425 'checks' => array(
4426 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4427 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4428 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4429 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4430 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4431 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist'
4436 * For compatibility with old installations set to false
4437 * @deprecated since 1.24 will be removed in future
4439 $wgPasswordSalt = true;
4442 * Specifies the minimal length of a user password. If set to 0, empty pass-
4443 * words are allowed.
4444 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4446 $wgMinimalPasswordLength = false;
4449 * Specifies the maximal length of a user password (T64685).
4451 * It is not recommended to make this greater than the default, as it can
4452 * allow DoS attacks by users setting really long passwords. In addition,
4453 * this should not be lowered too much, as it enforces weak passwords.
4455 * @warning Unlike other password settings, user with passwords greater than
4456 * the maximum will not be able to log in.
4457 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4459 $wgMaximalPasswordLength = false;
4462 * Specifies if users should be sent to a password-reset form on login, if their
4463 * password doesn't meet the requirements of User::isValidPassword().
4464 * @since 1.23
4466 $wgInvalidPasswordReset = true;
4469 * Default password type to use when hashing user passwords
4471 * @since 1.24
4473 $wgPasswordDefault = 'pbkdf2';
4476 * Configuration for built-in password types. Maps the password type
4477 * to an array of options. The 'class' option is the Password class to
4478 * use. All other options are class-dependent.
4480 * An advanced example:
4481 * @code
4482 * $wgPasswordConfig['bcrypt-peppered'] = array(
4483 * 'class' => 'EncryptedPassword',
4484 * 'underlying' => 'bcrypt',
4485 * 'secrets' => array(),
4486 * 'cipher' => MCRYPT_RIJNDAEL_256,
4487 * 'mode' => MCRYPT_MODE_CBC,
4488 * 'cost' => 5,
4489 * );
4490 * @endcode
4492 * @since 1.24
4494 $wgPasswordConfig = array(
4495 'A' => array(
4496 'class' => 'MWOldPassword',
4498 'B' => array(
4499 'class' => 'MWSaltedPassword',
4501 'pbkdf2-legacyA' => array(
4502 'class' => 'LayeredParameterizedPassword',
4503 'types' => array(
4504 'A',
4505 'pbkdf2',
4508 'pbkdf2-legacyB' => array(
4509 'class' => 'LayeredParameterizedPassword',
4510 'types' => array(
4511 'B',
4512 'pbkdf2',
4515 'bcrypt' => array(
4516 'class' => 'BcryptPassword',
4517 'cost' => 9,
4519 'pbkdf2' => array(
4520 'class' => 'Pbkdf2Password',
4521 'algo' => 'sha256',
4522 'cost' => '10000',
4523 'length' => '128',
4528 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4529 * with a temporary password you can use to get back into the account") identified by
4530 * various bits of data. Setting all of these to false (or the whole variable to false)
4531 * has the effect of disabling password resets entirely
4533 $wgPasswordResetRoutes = array(
4534 'username' => true,
4535 'email' => true,
4539 * Maximum number of Unicode characters in signature
4541 $wgMaxSigChars = 255;
4544 * Maximum number of bytes in username. You want to run the maintenance
4545 * script ./maintenance/checkUsernames.php once you have changed this value.
4547 $wgMaxNameChars = 255;
4550 * Array of usernames which may not be registered or logged in from
4551 * Maintenance scripts can still use these
4553 $wgReservedUsernames = array(
4554 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4555 'Conversion script', // Used for the old Wikipedia software upgrade
4556 'Maintenance script', // Maintenance scripts which perform editing, image import script
4557 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4558 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4559 'msg:double-redirect-fixer', // Automatic double redirect fix
4560 'msg:usermessage-editor', // Default user for leaving user messages
4561 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4562 'msg:spambot_username', // Used by cleanupSpam.php
4563 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4567 * Settings added to this array will override the default globals for the user
4568 * preferences used by anonymous visitors and newly created accounts.
4569 * For instance, to disable editing on double clicks:
4570 * $wgDefaultUserOptions ['editondblclick'] = 0;
4572 $wgDefaultUserOptions = array(
4573 'ccmeonemails' => 0,
4574 'cols' => 80,
4575 'date' => 'default',
4576 'diffonly' => 0,
4577 'disablemail' => 0,
4578 'editfont' => 'default',
4579 'editondblclick' => 0,
4580 'editsectiononrightclick' => 0,
4581 'enotifminoredits' => 0,
4582 'enotifrevealaddr' => 0,
4583 'enotifusertalkpages' => 1,
4584 'enotifwatchlistpages' => 1,
4585 'extendwatchlist' => 1,
4586 'fancysig' => 0,
4587 'forceeditsummary' => 0,
4588 'gender' => 'unknown',
4589 'hideminor' => 0,
4590 'hidepatrolled' => 0,
4591 'hidecategorization' => 1,
4592 'imagesize' => 2,
4593 'math' => 1,
4594 'minordefault' => 0,
4595 'newpageshidepatrolled' => 0,
4596 'nickname' => '',
4597 'norollbackdiff' => 0,
4598 'numberheadings' => 0,
4599 'previewonfirst' => 0,
4600 'previewontop' => 1,
4601 'rcdays' => 7,
4602 'rclimit' => 50,
4603 'rows' => 25,
4604 'showhiddencats' => 0,
4605 'shownumberswatching' => 1,
4606 'showtoolbar' => 1,
4607 'skin' => false,
4608 'stubthreshold' => 0,
4609 'thumbsize' => 5,
4610 'underline' => 2,
4611 'uselivepreview' => 0,
4612 'usenewrc' => 1,
4613 'watchcreations' => 1,
4614 'watchdefault' => 1,
4615 'watchdeletion' => 0,
4616 'watchlistdays' => 3.0,
4617 'watchlisthideanons' => 0,
4618 'watchlisthidebots' => 0,
4619 'watchlisthideliu' => 0,
4620 'watchlisthideminor' => 0,
4621 'watchlisthideown' => 0,
4622 'watchlisthidepatrolled' => 0,
4623 'watchlisthidecategorization' => 1,
4624 'watchlistreloadautomatically' => 0,
4625 'watchmoves' => 0,
4626 'watchrollback' => 0,
4627 'wllimit' => 250,
4628 'useeditwarning' => 1,
4629 'prefershttps' => 1,
4633 * An array of preferences to not show for the user
4635 $wgHiddenPrefs = array();
4638 * Characters to prevent during new account creations.
4639 * This is used in a regular expression character class during
4640 * registration (regex metacharacters like / are escaped).
4642 $wgInvalidUsernameCharacters = '@:';
4645 * Character used as a delimiter when testing for interwiki userrights
4646 * (In Special:UserRights, it is possible to modify users on different
4647 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4649 * It is recommended that you have this delimiter in
4650 * $wgInvalidUsernameCharacters above, or you will not be able to
4651 * modify the user rights of those users via Special:UserRights
4653 $wgUserrightsInterwikiDelimiter = '@';
4656 * This is to let user authenticate using https when they come from http.
4657 * Based on an idea by George Herbert on wikitech-l:
4658 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4659 * @since 1.17
4661 $wgSecureLogin = false;
4663 /** @} */ # end user accounts }
4665 /************************************************************************//**
4666 * @name User rights, access control and monitoring
4667 * @{
4671 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4673 $wgAutoblockExpiry = 86400;
4676 * Set this to true to allow blocked users to edit their own user talk page.
4678 $wgBlockAllowsUTEdit = true;
4681 * Allow sysops to ban users from accessing Emailuser
4683 $wgSysopEmailBans = true;
4686 * Limits on the possible sizes of range blocks.
4688 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4689 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4690 * half the number of bits avoids such errors, and allows entire ISPs to be
4691 * blocked using a small number of range blocks.
4693 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4694 * customer, so range blocks larger than /64 (half the number of bits) will
4695 * plainly be required. RFC 4692 implies that a very large ISP may be
4696 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4697 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4699 $wgBlockCIDRLimit = array(
4700 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4701 'IPv6' => 19,
4705 * If true, blocked users will not be allowed to login. When using this with
4706 * a public wiki, the effect of logging out blocked users may actually be
4707 * avers: unless the user's address is also blocked (e.g. auto-block),
4708 * logging the user out will again allow reading and editing, just as for
4709 * anonymous visitors.
4711 $wgBlockDisablesLogin = false;
4714 * Pages anonymous user may see, set as an array of pages titles.
4716 * @par Example:
4717 * @code
4718 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4719 * @endcode
4721 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4723 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4724 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4726 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4727 * will remain readable. You can use img_auth.php to protect uploaded files,
4728 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4730 $wgWhitelistRead = false;
4733 * Pages anonymous user may see, set as an array of regular expressions.
4735 * This function will match the regexp against the title name, which
4736 * is without underscore.
4738 * @par Example:
4739 * To whitelist [[Main Page]]:
4740 * @code
4741 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4742 * @endcode
4744 * @note Unless ^ and/or $ is specified, a regular expression might match
4745 * pages not intended to be whitelisted. The above example will also
4746 * whitelist a page named 'Security Main Page'.
4748 * @par Example:
4749 * To allow reading any page starting with 'User' regardless of the case:
4750 * @code
4751 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4752 * @endcode
4753 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4755 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4756 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4758 $wgWhitelistReadRegexp = false;
4761 * Should editors be required to have a validated e-mail
4762 * address before being allowed to edit?
4764 $wgEmailConfirmToEdit = false;
4767 * Should MediaWiki attempt to protect user's privacy when doing redirects?
4768 * Keep this true if access counts to articles are made public.
4770 $wgHideIdentifiableRedirects = true;
4773 * Permission keys given to users in each group.
4775 * This is an array where the keys are all groups and each value is an
4776 * array of the format (right => boolean).
4778 * The second format is used to support per-namespace permissions.
4779 * Note that this feature does not fully work for all permission types.
4781 * All users are implicitly in the '*' group including anonymous visitors;
4782 * logged-in users are all implicitly in the 'user' group. These will be
4783 * combined with the permissions of all groups that a given user is listed
4784 * in in the user_groups table.
4786 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4787 * doing! This will wipe all permissions, and may mean that your users are
4788 * unable to perform certain essential tasks or access new functionality
4789 * when new permissions are introduced and default grants established.
4791 * Functionality to make pages inaccessible has not been extensively tested
4792 * for security. Use at your own risk!
4794 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4796 $wgGroupPermissions = array();
4798 /** @cond file_level_code */
4799 // Implicit group for all visitors
4800 $wgGroupPermissions['*']['createaccount'] = true;
4801 $wgGroupPermissions['*']['read'] = true;
4802 $wgGroupPermissions['*']['edit'] = true;
4803 $wgGroupPermissions['*']['createpage'] = true;
4804 $wgGroupPermissions['*']['createtalk'] = true;
4805 $wgGroupPermissions['*']['writeapi'] = true;
4806 $wgGroupPermissions['*']['editmyusercss'] = true;
4807 $wgGroupPermissions['*']['editmyuserjs'] = true;
4808 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4809 $wgGroupPermissions['*']['editmywatchlist'] = true;
4810 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4811 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4812 $wgGroupPermissions['*']['editmyoptions'] = true;
4813 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4815 // Implicit group for all logged-in accounts
4816 $wgGroupPermissions['user']['move'] = true;
4817 $wgGroupPermissions['user']['move-subpages'] = true;
4818 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4819 $wgGroupPermissions['user']['move-categorypages'] = true;
4820 $wgGroupPermissions['user']['movefile'] = true;
4821 $wgGroupPermissions['user']['read'] = true;
4822 $wgGroupPermissions['user']['edit'] = true;
4823 $wgGroupPermissions['user']['createpage'] = true;
4824 $wgGroupPermissions['user']['createtalk'] = true;
4825 $wgGroupPermissions['user']['writeapi'] = true;
4826 $wgGroupPermissions['user']['upload'] = true;
4827 $wgGroupPermissions['user']['reupload'] = true;
4828 $wgGroupPermissions['user']['reupload-shared'] = true;
4829 $wgGroupPermissions['user']['minoredit'] = true;
4830 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4831 $wgGroupPermissions['user']['sendemail'] = true;
4832 $wgGroupPermissions['user']['applychangetags'] = true;
4833 $wgGroupPermissions['user']['changetags'] = true;
4835 // Implicit group for accounts that pass $wgAutoConfirmAge
4836 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4837 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4839 // Users with bot privilege can have their edits hidden
4840 // from various log pages by default
4841 $wgGroupPermissions['bot']['bot'] = true;
4842 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4843 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4844 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4845 $wgGroupPermissions['bot']['autopatrol'] = true;
4846 $wgGroupPermissions['bot']['suppressredirect'] = true;
4847 $wgGroupPermissions['bot']['apihighlimits'] = true;
4848 $wgGroupPermissions['bot']['writeapi'] = true;
4850 // Most extra permission abilities go to this group
4851 $wgGroupPermissions['sysop']['block'] = true;
4852 $wgGroupPermissions['sysop']['createaccount'] = true;
4853 $wgGroupPermissions['sysop']['delete'] = true;
4854 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4855 $wgGroupPermissions['sysop']['bigdelete'] = true;
4856 // can view deleted history entries, but not see or restore the text
4857 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4858 // can view deleted revision text
4859 $wgGroupPermissions['sysop']['deletedtext'] = true;
4860 $wgGroupPermissions['sysop']['undelete'] = true;
4861 $wgGroupPermissions['sysop']['editinterface'] = true;
4862 $wgGroupPermissions['sysop']['editusercss'] = true;
4863 $wgGroupPermissions['sysop']['edituserjs'] = true;
4864 $wgGroupPermissions['sysop']['import'] = true;
4865 $wgGroupPermissions['sysop']['importupload'] = true;
4866 $wgGroupPermissions['sysop']['move'] = true;
4867 $wgGroupPermissions['sysop']['move-subpages'] = true;
4868 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4869 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4870 $wgGroupPermissions['sysop']['patrol'] = true;
4871 $wgGroupPermissions['sysop']['autopatrol'] = true;
4872 $wgGroupPermissions['sysop']['protect'] = true;
4873 $wgGroupPermissions['sysop']['editprotected'] = true;
4874 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4875 $wgGroupPermissions['sysop']['rollback'] = true;
4876 $wgGroupPermissions['sysop']['upload'] = true;
4877 $wgGroupPermissions['sysop']['reupload'] = true;
4878 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4879 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4880 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4881 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4882 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4883 $wgGroupPermissions['sysop']['blockemail'] = true;
4884 $wgGroupPermissions['sysop']['markbotedits'] = true;
4885 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4886 $wgGroupPermissions['sysop']['browsearchive'] = true;
4887 $wgGroupPermissions['sysop']['noratelimit'] = true;
4888 $wgGroupPermissions['sysop']['movefile'] = true;
4889 $wgGroupPermissions['sysop']['unblockself'] = true;
4890 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4891 # $wgGroupPermissions['sysop']['pagelang'] = true;
4892 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
4893 $wgGroupPermissions['sysop']['mergehistory'] = true;
4894 $wgGroupPermissions['sysop']['managechangetags'] = true;
4896 // Permission to change users' group assignments
4897 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4898 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4899 // Permission to change users' groups assignments across wikis
4900 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4901 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4902 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4904 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
4905 # $wgGroupPermissions['sysop']['deleterevision'] = true;
4906 // To hide usernames from users and Sysops
4907 # $wgGroupPermissions['suppress']['hideuser'] = true;
4908 // To hide revisions/log items from users and Sysops
4909 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
4910 // To view revisions/log items hidden from users and Sysops
4911 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
4912 // For private suppression log access
4913 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
4916 * The developer group is deprecated, but can be activated if need be
4917 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4918 * that a lock file be defined and creatable/removable by the web
4919 * server.
4921 # $wgGroupPermissions['developer']['siteadmin'] = true;
4923 /** @endcond */
4926 * Permission keys revoked from users in each group.
4928 * This acts the same way as wgGroupPermissions above, except that
4929 * if the user is in a group here, the permission will be removed from them.
4931 * Improperly setting this could mean that your users will be unable to perform
4932 * certain essential tasks, so use at your own risk!
4934 $wgRevokePermissions = array();
4937 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4939 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4942 * A map of group names that the user is in, to group names that those users
4943 * are allowed to add or revoke.
4945 * Setting the list of groups to add or revoke to true is equivalent to "any
4946 * group".
4948 * @par Example:
4949 * To allow sysops to add themselves to the "bot" group:
4950 * @code
4951 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4952 * @endcode
4954 * @par Example:
4955 * Implicit groups may be used for the source group, for instance:
4956 * @code
4957 * $wgGroupsRemoveFromSelf = array( '*' => true );
4958 * @endcode
4959 * This allows users in the '*' group (i.e. any user) to remove themselves from
4960 * any group that they happen to be in.
4962 $wgGroupsAddToSelf = array();
4965 * @see $wgGroupsAddToSelf
4967 $wgGroupsRemoveFromSelf = array();
4970 * Set of available actions that can be restricted via action=protect
4971 * You probably shouldn't change this.
4972 * Translated through restriction-* messages.
4973 * Title::getRestrictionTypes() will remove restrictions that are not
4974 * applicable to a specific title (create and upload)
4976 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4979 * Rights which can be required for each protection level (via action=protect)
4981 * You can add a new protection level that requires a specific
4982 * permission by manipulating this array. The ordering of elements
4983 * dictates the order on the protection form's lists.
4985 * - '' will be ignored (i.e. unprotected)
4986 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4987 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4989 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4992 * Restriction levels that can be used with cascading protection
4994 * A page can only be protected with cascading protection if the
4995 * requested restriction level is included in this array.
4997 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4998 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
5000 $wgCascadingRestrictionLevels = array( 'sysop' );
5003 * Restriction levels that should be considered "semiprotected"
5005 * Certain places in the interface recognize a dichotomy between "protected"
5006 * and "semiprotected", without further distinguishing the specific levels. In
5007 * general, if anyone can be eligible to edit a protection level merely by
5008 * reaching some condition in $wgAutopromote, it should probably be considered
5009 * "semiprotected".
5011 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5012 * 'sysop' is not changed, since it really shouldn't be here.
5014 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
5017 * Set the minimum permissions required to edit pages in each
5018 * namespace. If you list more than one permission, a user must
5019 * have all of them to edit pages in that namespace.
5021 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5023 $wgNamespaceProtection = array();
5026 * Pages in namespaces in this array can not be used as templates.
5028 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5029 * namespaces constants (NS_USER, NS_MAIN...).
5031 * Among other things, this may be useful to enforce read-restrictions
5032 * which may otherwise be bypassed by using the template mechanism.
5034 $wgNonincludableNamespaces = array();
5037 * Number of seconds an account is required to age before it's given the
5038 * implicit 'autoconfirm' group membership. This can be used to limit
5039 * privileges of new accounts.
5041 * Accounts created by earlier versions of the software may not have a
5042 * recorded creation date, and will always be considered to pass the age test.
5044 * When left at 0, all registered accounts will pass.
5046 * @par Example:
5047 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5048 * @code
5049 * $wgAutoConfirmAge = 600; // ten minutes
5050 * @endcode
5051 * Set age to one day:
5052 * @code
5053 * $wgAutoConfirmAge = 3600*24; // one day
5054 * @endcode
5056 $wgAutoConfirmAge = 0;
5059 * Number of edits an account requires before it is autoconfirmed.
5060 * Passing both this AND the time requirement is needed. Example:
5062 * @par Example:
5063 * @code
5064 * $wgAutoConfirmCount = 50;
5065 * @endcode
5067 $wgAutoConfirmCount = 0;
5070 * Automatically add a usergroup to any user who matches certain conditions.
5072 * @todo Redocument $wgAutopromote
5074 * The format is
5075 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
5076 * where cond1, cond2, ... are themselves conditions; *OR*
5077 * APCOND_EMAILCONFIRMED, *OR*
5078 * array( APCOND_EMAILCONFIRMED ), *OR*
5079 * array( APCOND_EDITCOUNT, number of edits ), *OR*
5080 * array( APCOND_AGE, seconds since registration ), *OR*
5081 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
5082 * array( APCOND_ISIP, ip ), *OR*
5083 * array( APCOND_IPINRANGE, range ), *OR*
5084 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
5085 * array( APCOND_BLOCKED ), *OR*
5086 * array( APCOND_ISBOT ), *OR*
5087 * similar constructs defined by extensions.
5089 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
5090 * user who has provided an e-mail address.
5092 $wgAutopromote = array(
5093 'autoconfirmed' => array( '&',
5094 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
5095 array( APCOND_AGE, &$wgAutoConfirmAge ),
5100 * Automatically add a usergroup to any user who matches certain conditions.
5102 * Does not add the user to the group again if it has been removed.
5103 * Also, does not remove the group if the user no longer meets the criteria.
5105 * The format is:
5106 * @code
5107 * array( event => criteria, ... )
5108 * @endcode
5109 * Where event is either:
5110 * - 'onEdit' (when user edits)
5112 * Criteria has the same format as $wgAutopromote
5114 * @see $wgAutopromote
5115 * @since 1.18
5117 $wgAutopromoteOnce = array(
5118 'onEdit' => array(),
5122 * Put user rights log entries for autopromotion in recent changes?
5123 * @since 1.18
5125 $wgAutopromoteOnceLogInRC = true;
5128 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5129 * can assign which groups at Special:Userrights.
5131 * @par Example:
5132 * Bureaucrats can add any group:
5133 * @code
5134 * $wgAddGroups['bureaucrat'] = true;
5135 * @endcode
5136 * Bureaucrats can only remove bots and sysops:
5137 * @code
5138 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
5139 * @endcode
5140 * Sysops can make bots:
5141 * @code
5142 * $wgAddGroups['sysop'] = array( 'bot' );
5143 * @endcode
5144 * Sysops can disable other sysops in an emergency, and disable bots:
5145 * @code
5146 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
5147 * @endcode
5149 $wgAddGroups = array();
5152 * @see $wgAddGroups
5154 $wgRemoveGroups = array();
5157 * A list of available rights, in addition to the ones defined by the core.
5158 * For extensions only.
5160 $wgAvailableRights = array();
5163 * Optional to restrict deletion of pages with higher revision counts
5164 * to users with the 'bigdelete' permission. (Default given to sysops.)
5166 $wgDeleteRevisionsLimit = 0;
5169 * The maximum number of edits a user can have and
5170 * can still be hidden by users with the hideuser permission.
5171 * This is limited for performance reason.
5172 * Set to false to disable the limit.
5173 * @since 1.23
5175 $wgHideUserContribLimit = 1000;
5178 * Number of accounts each IP address may create, 0 to disable.
5180 * @warning Requires memcached
5182 $wgAccountCreationThrottle = 0;
5185 * Edits matching these regular expressions in body text
5186 * will be recognised as spam and rejected automatically.
5188 * There's no administrator override on-wiki, so be careful what you set. :)
5189 * May be an array of regexes or a single string for backwards compatibility.
5191 * @see https://en.wikipedia.org/wiki/Regular_expression
5193 * @note Each regex needs a beginning/end delimiter, eg: # or /
5195 $wgSpamRegex = array();
5198 * Same as the above except for edit summaries
5200 $wgSummarySpamRegex = array();
5203 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5204 * proxies
5205 * @since 1.16
5207 $wgEnableDnsBlacklist = false;
5210 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5212 * This is an array of either a URL or an array with the URL and a key (should
5213 * the blacklist require a key).
5215 * @par Example:
5216 * @code
5217 * $wgDnsBlacklistUrls = array(
5218 * // String containing URL
5219 * 'http.dnsbl.sorbs.net.',
5220 * // Array with URL and key, for services that require a key
5221 * array( 'dnsbl.httpbl.net.', 'mykey' ),
5222 * // Array with just the URL. While this works, it is recommended that you
5223 * // just use a string as shown above
5224 * array( 'opm.tornevall.org.' )
5225 * );
5226 * @endcode
5228 * @note You should end the domain name with a . to avoid searching your
5229 * eventual domain search suffixes.
5230 * @since 1.16
5232 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
5235 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5236 * what the other methods might say.
5238 $wgProxyWhitelist = array();
5241 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5242 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5243 * (transparent) proxies without needing to block the proxies themselves.
5245 $wgApplyIpBlocksToXff = false;
5248 * Simple rate limiter options to brake edit floods.
5250 * Maximum number actions allowed in the given number of seconds; after that
5251 * the violating client receives HTTP 500 error pages until the period
5252 * elapses.
5254 * @par Example:
5255 * To set a generic maximum of 4 hits in 60 seconds:
5256 * @code
5257 * $wgRateLimits = array( 4, 60 );
5258 * @endcode
5260 * @par Example:
5261 * You could also limit per action and then type of users.
5262 * @code
5263 * $wgRateLimits = array(
5264 * 'edit' => array(
5265 * 'anon' => array( x, y ), // any and all anonymous edits (aggregate)
5266 * 'user' => array( x, y ), // each logged-in user
5267 * 'newbie' => array( x, y ), // each new autoconfirmed accounts; overrides 'user'
5268 * 'ip' => array( x, y ), // each anon and recent account
5269 * 'subnet' => array( x, y ), // ... within a /24 subnet in IPv4 or /64 in IPv6
5272 * @endcode
5274 * @warning Requires that $wgMainCacheType is set to something persistent
5276 $wgRateLimits = array(
5277 // Page edits
5278 'edit' => array(
5279 'ip' => array( 8, 60 ),
5280 'newbie' => array( 8, 60 ),
5282 // Page moves
5283 'move' => array(
5284 'newbie' => array( 2, 120 ),
5285 'user' => array( 8, 60 ),
5287 // File uploads
5288 'upload' => array(
5289 'ip' => array( 8, 60 ),
5290 'newbie' => array( 8, 60 ),
5292 // Page rollbacks
5293 'rollback' => array(
5294 'user' => array( 10, 60 ),
5295 'newbie' => array( 5, 120 )
5297 // Triggering password resets emails
5298 'mailpassword' => array(
5299 'ip' => array( 5, 3600 ),
5301 // Emailing other users using MediaWiki
5302 'emailuser' => array(
5303 'ip' => array( 5, 86400 ),
5304 'newbie' => array( 5, 86400 ),
5305 'user' => array( 20, 86400 ),
5307 // Purging pages
5308 'purge' => array(
5309 'ip' => array( 30, 60 ),
5310 'user' => array( 30, 60 ),
5312 // Purges of link tables
5313 'linkpurge' => array(
5314 'ip' => array( 30, 60 ),
5315 'user' => array( 30, 60 ),
5317 // Files rendered via thumb.php or thumb_handler.php
5318 'renderfile' => array(
5319 'ip' => array( 700, 30 ),
5320 'user' => array( 700, 30 ),
5322 // Same as above but for non-standard thumbnails
5323 'renderfile-nonstandard' => array(
5324 'ip' => array( 70, 30 ),
5325 'user' => array( 70, 30 ),
5327 // Stashing edits into cache before save
5328 'stashedit' => array(
5329 'ip' => array( 30, 60 ),
5330 'newbie' => array( 30, 60 ),
5332 // Adding or removing change tags
5333 'changetag' => array(
5334 'ip' => array( 8, 60 ),
5335 'newbie' => array( 8, 60 ),
5340 * Array of IPs which should be excluded from rate limits.
5341 * This may be useful for whitelisting NAT gateways for conferences, etc.
5343 $wgRateLimitsExcludedIPs = array();
5346 * Log IP addresses in the recentchanges table; can be accessed only by
5347 * extensions (e.g. CheckUser) or a DB admin
5348 * Used for retroactive autoblocks
5350 $wgPutIPinRC = true;
5353 * Integer defining default number of entries to show on
5354 * special pages which are query-pages such as Special:Whatlinkshere.
5356 $wgQueryPageDefaultLimit = 50;
5359 * Limit password attempts to X attempts per Y seconds per IP per account.
5361 * @warning Requires memcached.
5363 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5365 /** @} */ # end of user rights settings
5367 /************************************************************************//**
5368 * @name Proxy scanner settings
5369 * @{
5373 * This should always be customised in LocalSettings.php
5375 $wgSecretKey = false;
5378 * Big list of banned IP addresses.
5380 * This can have the following formats:
5381 * - An array of addresses, either in the values
5382 * or the keys (for backward compatibility)
5383 * - A string, in that case this is the path to a file
5384 * containing the list of IP addresses, one per line
5386 $wgProxyList = array();
5388 /** @} */ # end of proxy scanner settings
5390 /************************************************************************//**
5391 * @name Cookie settings
5392 * @{
5396 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5398 $wgCookieExpiration = 180 * 86400;
5401 * The identifiers of the login cookies that can have their lifetimes
5402 * extended independently of all other login cookies.
5404 * @var string[]
5406 $wgExtendedLoginCookies = array( 'UserID', 'Token' );
5409 * Default login cookie lifetime, in seconds. Setting
5410 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5411 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5412 * login cookies session-only.
5414 $wgExtendedLoginCookieExpiration = null;
5417 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5418 * or ".any.subdomain.net"
5420 $wgCookieDomain = '';
5423 * Set this variable if you want to restrict cookies to a certain path within
5424 * the domain specified by $wgCookieDomain.
5426 $wgCookiePath = '/';
5429 * Whether the "secure" flag should be set on the cookie. This can be:
5430 * - true: Set secure flag
5431 * - false: Don't set secure flag
5432 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5434 $wgCookieSecure = 'detect';
5437 * By default, MediaWiki checks if the client supports cookies during the
5438 * login process, so that it can display an informative error message if
5439 * cookies are disabled. Set this to true if you want to disable this cookie
5440 * check.
5442 $wgDisableCookieCheck = false;
5445 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5446 * to a string to use a custom prefix. Setting it to false causes the database
5447 * name to be used as a prefix.
5449 $wgCookiePrefix = false;
5452 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5453 * in browsers that support this feature. This can mitigates some classes of
5454 * XSS attack.
5456 $wgCookieHttpOnly = true;
5459 * A list of cookies that vary the cache (for use by extensions)
5461 $wgCacheVaryCookies = array();
5464 * Override to customise the session name
5466 $wgSessionName = false;
5468 /** @} */ # end of cookie settings }
5470 /************************************************************************//**
5471 * @name LaTeX (mathematical formulas)
5472 * @{
5476 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5477 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5478 * (ImageMagick) installed and available in the PATH.
5479 * Please see math/README for more information.
5481 $wgUseTeX = false;
5483 /** @} */ # end LaTeX }
5485 /************************************************************************//**
5486 * @name Profiling, testing and debugging
5488 * To enable profiling, edit StartProfiler.php
5490 * @{
5494 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5495 * The debug log file should be not be publicly accessible if it is used, as it
5496 * may contain private data.
5498 $wgDebugLogFile = '';
5501 * Prefix for debug log lines
5503 $wgDebugLogPrefix = '';
5506 * If true, instead of redirecting, show a page with a link to the redirect
5507 * destination. This allows for the inspection of PHP error messages, and easy
5508 * resubmission of form data. For developer use only.
5510 $wgDebugRedirects = false;
5513 * If true, log debugging data from action=raw and load.php.
5514 * This is normally false to avoid overlapping debug entries due to gen=css
5515 * and gen=js requests.
5517 $wgDebugRawPage = false;
5520 * Send debug data to an HTML comment in the output.
5522 * This may occasionally be useful when supporting a non-technical end-user.
5523 * It's more secure than exposing the debug log file to the web, since the
5524 * output only contains private data for the current user. But it's not ideal
5525 * for development use since data is lost on fatal errors and redirects.
5527 $wgDebugComments = false;
5530 * Write SQL queries to the debug log.
5532 * This setting is only used $wgLBFactoryConf['class'] is set to
5533 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5534 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5535 * connection to achieve the same functionality.
5537 $wgDebugDumpSql = false;
5540 * Performance expectations for DB usage
5542 * @since 1.26
5544 $wgTrxProfilerLimits = array(
5545 // HTTP GET/HEAD requests.
5546 // Master queries should not happen on GET requests
5547 'GET' => array(
5548 'masterConns' => 0,
5549 'writes' => 0,
5550 'readQueryTime' => 5
5552 // HTTP POST requests.
5553 // Master reads and writes will happen for a subset of these.
5554 'POST' => array(
5555 'readQueryTime' => 5,
5556 'writeQueryTime' => 1,
5557 'maxAffected' => 500
5559 'POST-nonwrite' => array(
5560 'masterConns' => 0,
5561 'writes' => 0,
5562 'readQueryTime' => 5
5564 // Background job runner
5565 'JobRunner' => array(
5566 'readQueryTime' => 30,
5567 'writeQueryTime' => 5,
5568 'maxAffected' => 1000
5570 // Command-line scripts
5571 'Maintenance' => array(
5572 'writeQueryTime' => 5,
5573 'maxAffected' => 1000
5578 * Map of string log group names to log destinations.
5580 * If set, wfDebugLog() output for that group will go to that file instead
5581 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5582 * in production.
5584 * Log destinations may be one of the following:
5585 * - false to completely remove from the output, including from $wgDebugLogFile.
5586 * - string values specifying a filename or URI.
5587 * - associative array with keys:
5588 * - 'destination' desired filename or URI.
5589 * - 'sample' an integer value, specifying a sampling factor (optional)
5590 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5591 * to log (optional, since 1.25)
5593 * @par Example:
5594 * @code
5595 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5596 * @endcode
5598 * @par Advanced example:
5599 * @code
5600 * $wgDebugLogGroups['memcached'] = array(
5601 * 'destination' => '/var/log/mediawiki/memcached.log',
5602 * 'sample' => 1000, // log 1 message out of every 1,000.
5603 * 'level' => \Psr\Log\LogLevel::WARNING
5604 * );
5605 * @endcode
5607 $wgDebugLogGroups = array();
5610 * Default service provider for creating Psr\Log\LoggerInterface instances.
5612 * The value should be an array suitable for use with
5613 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5614 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
5615 * details.
5617 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
5618 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
5619 * and bypass the use of this configuration variable entirely.
5621 * @par To completely disable logging:
5622 * @code
5623 * $wgMWLoggerDefaultSpi = array( 'class' => '\\MediaWiki\\Logger\\NullSpi' );
5624 * @endcode
5626 * @since 1.25
5627 * @var array $wgMWLoggerDefaultSpi
5628 * @see MwLogger
5630 $wgMWLoggerDefaultSpi = array(
5631 'class' => '\\MediaWiki\\Logger\\LegacySpi',
5635 * Display debug data at the bottom of the main content area.
5637 * Useful for developers and technical users trying to working on a closed wiki.
5639 $wgShowDebug = false;
5642 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5643 * Since 1.19 also includes memory usage.
5645 $wgDebugTimestamps = false;
5648 * Print HTTP headers for every request in the debug information.
5650 $wgDebugPrintHttpHeaders = true;
5653 * Show the contents of $wgHooks in Special:Version
5655 $wgSpecialVersionShowHooks = false;
5658 * Whether to show "we're sorry, but there has been a database error" pages.
5659 * Displaying errors aids in debugging, but may display information useful
5660 * to an attacker.
5662 $wgShowSQLErrors = false;
5665 * If set to true, uncaught exceptions will print a complete stack trace
5666 * to output. This should only be used for debugging, as it may reveal
5667 * private information in function parameters due to PHP's backtrace
5668 * formatting.
5670 $wgShowExceptionDetails = false;
5673 * If true, show a backtrace for database errors
5675 * @note This setting only applies when connection errors and query errors are
5676 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5677 * including those in which an uncaught exception is thrown from within the
5678 * exception handler.
5680 $wgShowDBErrorBacktrace = false;
5683 * If true, send the exception backtrace to the error log
5685 $wgLogExceptionBacktrace = true;
5688 * Expose backend server host names through the API and various HTML comments
5690 $wgShowHostnames = false;
5693 * Override server hostname detection with a hardcoded value.
5694 * Should be a string, default false.
5695 * @since 1.20
5697 $wgOverrideHostname = false;
5700 * If set to true MediaWiki will throw notices for some possible error
5701 * conditions and for deprecated functions.
5703 $wgDevelopmentWarnings = false;
5706 * Release limitation to wfDeprecated warnings, if set to a release number
5707 * development warnings will not be generated for deprecations added in releases
5708 * after the limit.
5710 $wgDeprecationReleaseLimit = false;
5713 * Only record profiling info for pages that took longer than this
5714 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
5716 $wgProfileLimit = 0.0;
5719 * Don't put non-profiling info into log file
5721 * @deprecated since 1.23, set the log file in
5722 * $wgDebugLogGroups['profileoutput'] instead.
5724 $wgProfileOnly = false;
5727 * Destination of statsd metrics.
5729 * A host or host:port of a statsd server. Port defaults to 8125.
5731 * If not set, statsd metrics will not be collected.
5733 * @see wfLogProfilingData
5734 * @since 1.25
5736 $wgStatsdServer = false;
5739 * Prefix for metric names sent to $wgStatsdServer.
5741 * @see RequestContext::getStats
5742 * @see BufferingStatsdDataFactory
5743 * @since 1.25
5745 $wgStatsdMetricPrefix = 'MediaWiki';
5748 * InfoAction retrieves a list of transclusion links (both to and from).
5749 * This number puts a limit on that query in the case of highly transcluded
5750 * templates.
5752 $wgPageInfoTransclusionLimit = 50;
5755 * Set this to an integer to only do synchronous site_stats updates
5756 * one every *this many* updates. The other requests go into pending
5757 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5758 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5760 $wgSiteStatsAsyncFactor = false;
5763 * Parser test suite files to be run by parserTests.php when no specific
5764 * filename is passed to it.
5766 * Extensions may add their own tests to this array, or site-local tests
5767 * may be added via LocalSettings.php
5769 * Use full paths.
5771 $wgParserTestFiles = array(
5772 "$IP/tests/parser/parserTests.txt",
5773 "$IP/tests/parser/extraParserTests.txt"
5777 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5779 $wgEnableJavaScriptTest = false;
5782 * Overwrite the caching key prefix with custom value.
5783 * @since 1.19
5785 $wgCachePrefix = false;
5788 * Display the new debugging toolbar. This also enables profiling on database
5789 * queries and other useful output.
5790 * Will disable file cache.
5792 * @since 1.19
5794 $wgDebugToolbar = false;
5796 /** @} */ # end of profiling, testing and debugging }
5798 /************************************************************************//**
5799 * @name Search
5800 * @{
5804 * Set this to true to disable the full text search feature.
5806 $wgDisableTextSearch = false;
5809 * Set to true to have nicer highlighted text in search results,
5810 * by default off due to execution overhead
5812 $wgAdvancedSearchHighlighting = false;
5815 * Regexp to match word boundaries, defaults for non-CJK languages
5816 * should be empty for CJK since the words are not separate
5818 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5821 * Template for OpenSearch suggestions, defaults to API action=opensearch
5823 * Sites with heavy load would typically have these point to a custom
5824 * PHP wrapper to avoid firing up mediawiki for every keystroke
5826 * Placeholders: {searchTerms}
5828 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5830 $wgOpenSearchTemplate = false;
5833 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5835 * Sites with heavy load would typically have these point to a custom
5836 * PHP wrapper to avoid firing up mediawiki for every keystroke
5838 * Placeholders: {searchTerms}
5840 $wgOpenSearchTemplates = array(
5841 'application/x-suggestions+json' => false,
5842 'application/x-suggestions+xml' => false,
5846 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5847 * false if you've disabled scripts that use api?action=opensearch and
5848 * want reduce load caused by cached scripts still pulling suggestions.
5849 * It will let the API fallback by responding with an empty array.
5851 $wgEnableOpenSearchSuggest = true;
5854 * Integer defining default number of entries to show on
5855 * OpenSearch call.
5857 $wgOpenSearchDefaultLimit = 10;
5860 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
5862 $wgOpenSearchDescriptionLength = 100;
5865 * Expiry time for search suggestion responses
5867 $wgSearchSuggestCacheExpiry = 1200;
5870 * If you've disabled search semi-permanently, this also disables updates to the
5871 * table. If you ever re-enable, be sure to rebuild the search table.
5873 $wgDisableSearchUpdate = false;
5876 * List of namespaces which are searched by default.
5878 * @par Example:
5879 * @code
5880 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5881 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5882 * @endcode
5884 $wgNamespacesToBeSearchedDefault = array(
5885 NS_MAIN => true,
5889 * Disable the internal MySQL-based search, to allow it to be
5890 * implemented by an extension instead.
5892 $wgDisableInternalSearch = false;
5895 * Set this to a URL to forward search requests to some external location.
5896 * If the URL includes '$1', this will be replaced with the URL-encoded
5897 * search term.
5899 * @par Example:
5900 * To forward to Google you'd have something like:
5901 * @code
5902 * $wgSearchForwardUrl =
5903 * 'http://www.google.com/search?q=$1' .
5904 * '&domains=http://example.com' .
5905 * '&sitesearch=http://example.com' .
5906 * '&ie=utf-8&oe=utf-8';
5907 * @endcode
5909 $wgSearchForwardUrl = null;
5912 * Search form behavior.
5913 * - true = use Go & Search buttons
5914 * - false = use Go button & Advanced search link
5916 $wgUseTwoButtonsSearchForm = true;
5919 * Array of namespaces to generate a Google sitemap for when the
5920 * maintenance/generateSitemap.php script is run, or false if one is to be
5921 * generated for all namespaces.
5923 $wgSitemapNamespaces = false;
5926 * Custom namespace priorities for sitemaps. Setting this will allow you to
5927 * set custom priorities to namespaces when sitemaps are generated using the
5928 * maintenance/generateSitemap.php script.
5930 * This should be a map of namespace IDs to priority
5931 * @par Example:
5932 * @code
5933 * $wgSitemapNamespacesPriorities = array(
5934 * NS_USER => '0.9',
5935 * NS_HELP => '0.0',
5936 * );
5937 * @endcode
5939 $wgSitemapNamespacesPriorities = false;
5942 * If true, searches for IP addresses will be redirected to that IP's
5943 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5944 * [[Special:Contributions/1.2.3.4]]
5946 $wgEnableSearchContributorsByIP = true;
5948 /** @} */ # end of search settings
5950 /************************************************************************//**
5951 * @name Edit user interface
5952 * @{
5956 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5957 * fall back to the old behavior (no merging).
5959 $wgDiff3 = '/usr/bin/diff3';
5962 * Path to the GNU diff utility.
5964 $wgDiff = '/usr/bin/diff';
5967 * Which namespaces have special treatment where they should be preview-on-open
5968 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5969 * can specify namespaces of pages they have special treatment for
5971 $wgPreviewOnOpenNamespaces = array(
5972 NS_CATEGORY => true
5976 * Enable the UniversalEditButton for browsers that support it
5977 * (currently only Firefox with an extension)
5978 * See http://universaleditbutton.org for more background information
5980 $wgUniversalEditButton = true;
5983 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5984 * will try to automatically create one. This feature can be disabled by set-
5985 * ting this variable false.
5987 $wgUseAutomaticEditSummaries = true;
5989 /** @} */ # end edit UI }
5991 /************************************************************************//**
5992 * @name Maintenance
5993 * See also $wgSiteNotice
5994 * @{
5998 * @cond file_level_code
5999 * Set $wgCommandLineMode if it's not set already, to avoid notices
6001 if ( !isset( $wgCommandLineMode ) ) {
6002 $wgCommandLineMode = false;
6004 /** @endcond */
6007 * For colorized maintenance script output, is your terminal background dark ?
6009 $wgCommandLineDarkBg = false;
6012 * Set this to a string to put the wiki into read-only mode. The text will be
6013 * used as an explanation to users.
6015 * This prevents most write operations via the web interface. Cache updates may
6016 * still be possible. To prevent database writes completely, use the read_only
6017 * option in MySQL.
6019 $wgReadOnly = null;
6022 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6023 * Its contents will be shown to users as part of the read-only warning
6024 * message.
6026 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6028 $wgReadOnlyFile = false;
6031 * When you run the web-based upgrade utility, it will tell you what to set
6032 * this to in order to authorize the upgrade process. It will subsequently be
6033 * used as a password, to authorize further upgrades.
6035 * For security, do not set this to a guessable string. Use the value supplied
6036 * by the install/upgrade process. To cause the upgrader to generate a new key,
6037 * delete the old key from LocalSettings.php.
6039 $wgUpgradeKey = false;
6042 * Fully specified path to git binary
6044 $wgGitBin = '/usr/bin/git';
6047 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6049 * Key is a pattern passed to preg_match() and preg_replace(),
6050 * without the delimiters (which are #) and must match the whole URL.
6051 * The value is the replacement for the key (it can contain $1, etc.)
6052 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6053 * full SHA-1 of the HEAD revision.
6054 * %r will be replaced with a URL-encoded version of $1.
6056 * @since 1.20
6058 $wgGitRepositoryViewers = array(
6059 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6060 'https://git.wikimedia.org/tree/%r/%H',
6061 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6062 'https://git.wikimedia.org/tree/%r/%H',
6065 /** @} */ # End of maintenance }
6067 /************************************************************************//**
6068 * @name Recent changes, new pages, watchlist and history
6069 * @{
6073 * Recentchanges items are periodically purged; entries older than this many
6074 * seconds will go.
6075 * Default: 90 days = about three months
6077 $wgRCMaxAge = 90 * 24 * 3600;
6080 * Page watchers inactive for more than this many seconds are considered inactive.
6081 * Used mainly by action=info. Default: 180 days = about six months.
6082 * @since 1.26
6084 $wgWatchersMaxAge = 180 * 24 * 3600;
6087 * If active watchers (per above) are this number or less, do not disclose it.
6088 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6089 * Set to -1 if you want to always complement watchers count with this info.
6090 * @since 1.26
6092 $wgUnwatchedPageSecret = 1;
6095 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6096 * higher than what will be stored. Note that this is disabled by default
6097 * because we sometimes do have RC data which is beyond the limit for some
6098 * reason, and some users may use the high numbers to display that data which
6099 * is still there.
6101 $wgRCFilterByAge = false;
6104 * List of Limits options to list in the Special:Recentchanges and
6105 * Special:Recentchangeslinked pages.
6107 $wgRCLinkLimits = array( 50, 100, 250, 500 );
6110 * List of Days options to list in the Special:Recentchanges and
6111 * Special:Recentchangeslinked pages.
6113 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
6116 * Destinations to which notifications about recent changes
6117 * should be sent.
6119 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
6120 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
6121 * specified server.
6122 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
6124 * The common options are:
6125 * * 'uri' -- the address to which the notices are to be sent.
6126 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
6127 * produce the text to send. This can also be an object of the class.
6128 * * 'omit_bots' -- whether the bot edits should be in the feed
6129 * * 'omit_anon' -- whether anonymous edits should be in the feed
6130 * * 'omit_user' -- whether edits by registered users should be in the feed
6131 * * 'omit_minor' -- whether minor edits should be in the feed
6132 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
6134 * The IRC-specific options are:
6135 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
6136 * the first entry in the $wgLocalInterwikis array (or the value of
6137 * $wgLocalInterwiki, if set)
6139 * The JSON-specific options are:
6140 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6142 * @example $wgRCFeeds['example'] = array(
6143 * 'formatter' => 'JSONRCFeedFormatter',
6144 * 'uri' => "udp://localhost:1336",
6145 * 'add_interwiki_prefix' => false,
6146 * 'omit_bots' => true,
6147 * );
6148 * @example $wgRCFeeds['exampleirc'] = array(
6149 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6150 * 'uri' => "udp://localhost:1338",
6151 * 'add_interwiki_prefix' => false,
6152 * 'omit_bots' => true,
6153 * );
6154 * @since 1.22
6156 $wgRCFeeds = array();
6159 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
6160 * Keys are scheme names, values are names of engine classes.
6162 $wgRCEngines = array(
6163 'redis' => 'RedisPubSubFeedEngine',
6164 'udp' => 'UDPRCFeedEngine',
6168 * Treat category membership changes as a RecentChange.
6169 * Changes are mentioned in RC for page actions as follows:
6170 * - creation: pages created with categories are mentioned
6171 * - edit: category additions/removals to existing pages are mentioned
6172 * - move: nothing is mentioned (unless templates used depend on the title)
6173 * - deletion: nothing is mentioned
6174 * - undeletion: nothing is mentioned
6176 * @since 1.27
6178 $wgRCWatchCategoryMembership = false;
6181 * Use RC Patrolling to check for vandalism
6183 $wgUseRCPatrol = true;
6186 * Use new page patrolling to check new pages on Special:Newpages
6188 $wgUseNPPatrol = true;
6191 * Log autopatrol actions to the log table
6193 $wgLogAutopatrol = true;
6196 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6198 $wgFeed = true;
6201 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6202 * eg Recentchanges, Newpages.
6204 $wgFeedLimit = 50;
6207 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6208 * A cached version will continue to be served out even if changes
6209 * are made, until this many seconds runs out since the last render.
6211 * If set to 0, feed caching is disabled. Use this for debugging only;
6212 * feed generation can be pretty slow with diffs.
6214 $wgFeedCacheTimeout = 60;
6217 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6218 * pages larger than this size.
6220 $wgFeedDiffCutoff = 32768;
6223 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6224 * every page. Some sites might have a different feed they'd like to promote
6225 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6226 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6227 * as value.
6228 * @par Example:
6229 * Configure the 'atom' feed to http://example.com/somefeed.xml
6230 * @code
6231 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6232 * @endcode
6234 $wgOverrideSiteFeed = array();
6237 * Available feeds objects.
6238 * Should probably only be defined when a page is syndicated ie when
6239 * $wgOut->isSyndicated() is true.
6241 $wgFeedClasses = array(
6242 'rss' => 'RSSFeed',
6243 'atom' => 'AtomFeed',
6247 * Which feed types should we provide by default? This can include 'rss',
6248 * 'atom', neither, or both.
6250 $wgAdvertisedFeedTypes = array( 'atom' );
6253 * Show watching users in recent changes, watchlist and page history views
6255 $wgRCShowWatchingUsers = false; # UPO
6258 * Show the amount of changed characters in recent changes
6260 $wgRCShowChangedSize = true;
6263 * If the difference between the character counts of the text
6264 * before and after the edit is below that value, the value will be
6265 * highlighted on the RC page.
6267 $wgRCChangedSizeThreshold = 500;
6270 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6271 * view for watched pages with new changes
6273 $wgShowUpdatedMarker = true;
6276 * Disable links to talk pages of anonymous users (IPs) in listings on special
6277 * pages like page history, Special:Recentchanges, etc.
6279 $wgDisableAnonTalk = false;
6282 * Enable filtering of categories in Recentchanges
6284 $wgAllowCategorizedRecentChanges = false;
6287 * Allow filtering by change tag in recentchanges, history, etc
6288 * Has no effect if no tags are defined in valid_tag.
6290 $wgUseTagFilter = true;
6293 * If set to an integer, pages that are watched by this many users or more
6294 * will not require the unwatchedpages permission to view the number of
6295 * watchers.
6297 * @since 1.21
6299 $wgUnwatchedPageThreshold = false;
6302 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6303 * certain types of edits.
6305 * To register a new one:
6306 * @code
6307 * $wgRecentChangesFlags['flag'] => array(
6308 * // message for the letter displayed next to rows on changes lists
6309 * 'letter' => 'letter-msg',
6310 * // message for the tooltip of the letter
6311 * 'title' => 'tooltip-msg',
6312 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6313 * 'legend' => 'legend-msg',
6314 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6315 * 'class' => 'css-class',
6316 * );
6317 * @endcode
6319 * @since 1.22
6321 $wgRecentChangesFlags = array(
6322 'newpage' => array(
6323 'letter' => 'newpageletter',
6324 'title' => 'recentchanges-label-newpage',
6325 'legend' => 'recentchanges-legend-newpage',
6327 'minor' => array(
6328 'letter' => 'minoreditletter',
6329 'title' => 'recentchanges-label-minor',
6330 'legend' => 'recentchanges-legend-minor',
6331 'class' => 'minoredit',
6333 'bot' => array(
6334 'letter' => 'boteditletter',
6335 'title' => 'recentchanges-label-bot',
6336 'legend' => 'recentchanges-legend-bot',
6337 'class' => 'botedit',
6339 'unpatrolled' => array(
6340 'letter' => 'unpatrolledletter',
6341 'title' => 'recentchanges-label-unpatrolled',
6342 'legend' => 'recentchanges-legend-unpatrolled',
6346 /** @} */ # end RC/watchlist }
6348 /************************************************************************//**
6349 * @name Copyright and credits settings
6350 * @{
6354 * Override for copyright metadata.
6356 * This is the name of the page containing information about the wiki's copyright status,
6357 * which will be added as a link in the footer if it is specified. It overrides
6358 * $wgRightsUrl if both are specified.
6360 $wgRightsPage = null;
6363 * Set this to specify an external URL containing details about the content license used on your
6364 * wiki.
6365 * If $wgRightsPage is set then this setting is ignored.
6367 $wgRightsUrl = null;
6370 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6371 * link.
6372 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6373 * of the page will also be used as the link if this variable is not set.
6375 $wgRightsText = null;
6378 * Override for copyright metadata.
6380 $wgRightsIcon = null;
6383 * Set this to some HTML to override the rights icon with an arbitrary logo
6384 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6386 $wgCopyrightIcon = null;
6389 * Set this to true if you want detailed copyright information forms on Upload.
6391 $wgUseCopyrightUpload = false;
6394 * Set this to the number of authors that you want to be credited below an
6395 * article text. Set it to zero to hide the attribution block, and a negative
6396 * number (like -1) to show all authors. Note that this will require 2-3 extra
6397 * database hits, which can have a not insignificant impact on performance for
6398 * large wikis.
6400 $wgMaxCredits = 0;
6403 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6404 * Otherwise, link to a separate credits page.
6406 $wgShowCreditsIfMax = true;
6408 /** @} */ # end of copyright and credits settings }
6410 /************************************************************************//**
6411 * @name Import / Export
6412 * @{
6416 * List of interwiki prefixes for wikis we'll accept as sources for
6417 * Special:Import and API action=import. Since complete page history can be
6418 * imported, these should be 'trusted'.
6420 * This can either be a regular array, or an associative map specifying
6421 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6422 * e.g.
6423 * @code
6424 * $wgImportSources = array(
6425 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6426 * 'wikispecies',
6427 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6428 * );
6429 * @endcode
6431 * If you have a very complex import sources setup, you can lazy-load it using
6432 * the ImportSources hook.
6434 * If a user has the 'import' permission but not the 'importupload' permission,
6435 * they will only be able to run imports through this transwiki interface.
6437 $wgImportSources = array();
6440 * Optional default target namespace for interwiki imports.
6441 * Can use this to create an incoming "transwiki"-style queue.
6442 * Set to numeric key, not the name.
6444 * Users may override this in the Special:Import dialog.
6446 $wgImportTargetNamespace = null;
6449 * If set to false, disables the full-history option on Special:Export.
6450 * This is currently poorly optimized for long edit histories, so is
6451 * disabled on Wikimedia's sites.
6453 $wgExportAllowHistory = true;
6456 * If set nonzero, Special:Export requests for history of pages with
6457 * more revisions than this will be rejected. On some big sites things
6458 * could get bogged down by very very long pages.
6460 $wgExportMaxHistory = 0;
6463 * Return distinct author list (when not returning full history)
6465 $wgExportAllowListContributors = false;
6468 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6469 * up to this specified level, which will cause it to include all
6470 * pages linked to from the pages you specify. Since this number
6471 * can become *insanely large* and could easily break your wiki,
6472 * it's disabled by default for now.
6474 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6475 * crazy-big export from being done by someone setting the depth number too
6476 * high. In other words, last resort safety net.
6478 $wgExportMaxLinkDepth = 0;
6481 * Whether to allow the "export all pages in namespace" option
6483 $wgExportFromNamespaces = false;
6486 * Whether to allow exporting the entire wiki into a single file
6488 $wgExportAllowAll = false;
6490 /** @} */ # end of import/export }
6492 /*************************************************************************//**
6493 * @name Extensions
6494 * @{
6498 * A list of callback functions which are called once MediaWiki is fully
6499 * initialised
6501 $wgExtensionFunctions = array();
6504 * Extension messages files.
6506 * Associative array mapping extension name to the filename where messages can be
6507 * found. The file should contain variable assignments. Any of the variables
6508 * present in languages/messages/MessagesEn.php may be defined, but $messages
6509 * is the most common.
6511 * Variables defined in extensions will override conflicting variables defined
6512 * in the core.
6514 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6515 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6516 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6517 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6519 * Extensions using the JSON message format can preserve backward compatibility with
6520 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6521 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6522 * as for the $wgMessagesDirs entry.
6524 * @par Example:
6525 * @code
6526 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6527 * @endcode
6529 $wgExtensionMessagesFiles = array();
6532 * Extension messages directories.
6534 * Associative array mapping extension name to the path of the directory where message files can
6535 * be found. The message files are expected to be JSON files named for their language code, e.g.
6536 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6537 * message directories.
6539 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6541 * @par Simple example:
6542 * @code
6543 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6544 * @endcode
6546 * @par Complex example:
6547 * @code
6548 * $wgMessagesDirs['Example'] = array(
6549 * __DIR__ . '/lib/ve/i18n',
6550 * __DIR__ . '/lib/oojs-ui/i18n',
6551 * __DIR__ . '/i18n',
6553 * @endcode
6554 * @since 1.23
6556 $wgMessagesDirs = array();
6559 * Array of files with list(s) of extension entry points to be used in
6560 * maintenance/mergeMessageFileList.php
6561 * @since 1.22
6563 $wgExtensionEntryPointListFiles = array();
6566 * Parser output hooks.
6567 * This is an associative array where the key is an extension-defined tag
6568 * (typically the extension name), and the value is a PHP callback.
6569 * These will be called as an OutputPageParserOutput hook, if the relevant
6570 * tag has been registered with the parser output object.
6572 * Registration is done with $pout->addOutputHook( $tag, $data ).
6574 * The callback has the form:
6575 * @code
6576 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6577 * @endcode
6579 $wgParserOutputHooks = array();
6582 * Whether to include the NewPP limit report as a HTML comment
6584 $wgEnableParserLimitReporting = true;
6587 * List of valid skin names
6589 * The key should be the name in all lower case, the value should be a properly
6590 * cased name for the skin. This value will be prefixed with "Skin" to create
6591 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6592 * if you wish to have access to the full list.
6594 $wgValidSkinNames = array();
6597 * Special page list. This is an associative array mapping the (canonical) names of
6598 * special pages to either a class name to be instantiated, or a callback to use for
6599 * creating the special page object. In both cases, the result must be an instance of
6600 * SpecialPage.
6602 $wgSpecialPages = array();
6605 * Array mapping class names to filenames, for autoloading.
6607 $wgAutoloadClasses = array();
6610 * Switch controlling legacy case-insensitive classloading.
6611 * Do not disable if your wiki must support data created by PHP4, or by
6612 * MediaWiki 1.4 or earlier.
6614 $wgAutoloadAttemptLowercase = true;
6617 * An array of information about installed extensions keyed by their type.
6619 * All but 'name', 'path' and 'author' can be omitted.
6621 * @code
6622 * $wgExtensionCredits[$type][] = array(
6623 * 'path' => __FILE__,
6624 * 'name' => 'Example extension',
6625 * 'namemsg' => 'exampleextension-name',
6626 * 'author' => array(
6627 * 'Foo Barstein',
6628 * ),
6629 * 'version' => '1.9.0',
6630 * 'url' => 'http://example.org/example-extension/',
6631 * 'descriptionmsg' => 'exampleextension-desc',
6632 * 'license-name' => 'GPL-2.0+',
6633 * );
6634 * @endcode
6636 * The extensions are listed on Special:Version. This page also looks for a file
6637 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6638 * view said file. When the 'license-name' key is specified, this file is
6639 * interpreted as wikitext.
6641 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6642 * 'skin', 'api', or 'other', or any additional types as specified through the
6643 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6645 * - name: Name of extension as an inline string instead of localizable message.
6646 * Do not omit this even if 'namemsg' is provided, as it is used to override
6647 * the path Special:Version uses to find extension's license info, and is
6648 * required for backwards-compatibility with MediaWiki 1.23 and older.
6650 * - namemsg (since MW 1.24): A message key for a message containing the
6651 * extension's name, if the name is localizable. (For example, skin names
6652 * usually are.)
6654 * - author: A string or an array of strings. Authors can be linked using
6655 * the regular wikitext link syntax. To have an internationalized version of
6656 * "and others" show, add an element "...". This element can also be linked,
6657 * for instance "[http://example ...]".
6659 * - descriptionmsg: A message key or an an array with message key and parameters:
6660 * `'descriptionmsg' => 'exampleextension-desc',`
6662 * - description: Description of extension as an inline string instead of
6663 * localizable message (omit in favour of 'descriptionmsg').
6665 * - license-name: Short name of the license (used as label for the link), such
6666 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6668 $wgExtensionCredits = array();
6671 * Authentication plugin.
6672 * @var $wgAuth AuthPlugin
6674 $wgAuth = null;
6677 * Global list of hooks.
6679 * The key is one of the events made available by MediaWiki, you can find
6680 * a description for most of them in docs/hooks.txt. The array is used
6681 * internally by Hook:run().
6683 * The value can be one of:
6685 * - A function name:
6686 * @code
6687 * $wgHooks['event_name'][] = $function;
6688 * @endcode
6689 * - A function with some data:
6690 * @code
6691 * $wgHooks['event_name'][] = array( $function, $data );
6692 * @endcode
6693 * - A an object method:
6694 * @code
6695 * $wgHooks['event_name'][] = array( $object, 'method' );
6696 * @endcode
6697 * - A closure:
6698 * @code
6699 * $wgHooks['event_name'][] = function ( $hookParam ) {
6700 * // Handler code goes here.
6701 * };
6702 * @endcode
6704 * @warning You should always append to an event array or you will end up
6705 * deleting a previous registered hook.
6707 * @warning Hook handlers should be registered at file scope. Registering
6708 * handlers after file scope can lead to unexpected results due to caching.
6710 $wgHooks = array();
6713 * Maps jobs to their handling classes; extensions
6714 * can add to this to provide custom jobs
6716 $wgJobClasses = array(
6717 'refreshLinks' => 'RefreshLinksJob',
6718 'deleteLinks' => 'DeleteLinksJob',
6719 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6720 'sendMail' => 'EmaillingJob',
6721 'enotifNotify' => 'EnotifNotifyJob',
6722 'fixDoubleRedirect' => 'DoubleRedirectJob',
6723 'uploadFromUrl' => 'UploadFromUrlJob',
6724 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6725 'PublishStashedFile' => 'PublishStashedFileJob',
6726 'ThumbnailRender' => 'ThumbnailRenderJob',
6727 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6728 'refreshLinksPrioritized' => 'RefreshLinksJob',
6729 'refreshLinksDynamic' => 'RefreshLinksJob',
6730 'activityUpdateJob' => 'ActivityUpdateJob',
6731 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
6732 'cdnPurge' => 'CdnPurgeJob',
6733 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
6734 'null' => 'NullJob'
6738 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6739 * special flags are set. The values here are keys of $wgJobClasses.
6741 * These can be:
6742 * - Very long-running jobs.
6743 * - Jobs that you would never want to run as part of a page rendering request.
6744 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6745 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6746 * These settings should be global to all wikis.
6748 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6751 * Map of job types to how many job "work items" should be run per second
6752 * on each job runner process. The meaning of "work items" varies per job,
6753 * but typically would be something like "pages to update". A single job
6754 * may have a variable number of work items, as is the case with batch jobs.
6755 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6756 * These settings should be global to all wikis.
6757 * @var float[]
6759 $wgJobBackoffThrottling = array();
6762 * Make job runners commit changes for slave-lag prone jobs one job at a time.
6763 * This is useful if there are many job workers that race on slave lag checks.
6764 * If set, jobs taking this many seconds of DB write time have serialized commits.
6766 * Note that affected jobs may have worse lock contention. Also, if they affect
6767 * several DBs at once they may have a smaller chance of being atomic due to the
6768 * possibility of connection loss while queueing up to commit. Affected jobs may
6769 * also fail due to the commit lock acquisition timeout.
6771 * @var float|bool
6772 * @since 1.26
6774 $wgJobSerialCommitThreshold = false;
6777 * Map of job types to configuration arrays.
6778 * This determines which queue class and storage system is used for each job type.
6779 * Job types that do not have explicit configuration will use the 'default' config.
6780 * These settings should be global to all wikis.
6782 $wgJobTypeConf = array(
6783 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ),
6787 * Which aggregator to use for tracking which queues have jobs.
6788 * These settings should be global to all wikis.
6790 $wgJobQueueAggregator = array(
6791 'class' => 'JobQueueAggregatorNull'
6795 * Additional functions to be performed with updateSpecialPages.
6796 * Expensive Querypages are already updated.
6798 $wgSpecialPageCacheUpdates = array(
6799 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
6803 * Hooks that are used for outputting exceptions. Format is:
6804 * $wgExceptionHooks[] = $funcname
6805 * or:
6806 * $wgExceptionHooks[] = array( $class, $funcname )
6807 * Hooks should return strings or false
6809 $wgExceptionHooks = array();
6812 * Page property link table invalidation lists. When a page property
6813 * changes, this may require other link tables to be updated (eg
6814 * adding __HIDDENCAT__ means the hiddencat tracking category will
6815 * have been added, so the categorylinks table needs to be rebuilt).
6816 * This array can be added to by extensions.
6818 $wgPagePropLinkInvalidations = array(
6819 'hiddencat' => 'categorylinks',
6822 /** @} */ # End extensions }
6824 /*************************************************************************//**
6825 * @name Categories
6826 * @{
6830 * Use experimental, DMOZ-like category browser
6832 $wgUseCategoryBrowser = false;
6835 * On category pages, show thumbnail gallery for images belonging to that
6836 * category instead of listing them as articles.
6838 $wgCategoryMagicGallery = true;
6841 * Paging limit for categories
6843 $wgCategoryPagingLimit = 200;
6846 * Specify how category names should be sorted, when listed on a category page.
6847 * A sorting scheme is also known as a collation.
6849 * Available values are:
6851 * - uppercase: Converts the category name to upper case, and sorts by that.
6853 * - identity: Does no conversion. Sorts by binary value of the string.
6855 * - uca-default: Provides access to the Unicode Collation Algorithm with
6856 * the default element table. This is a compromise collation which sorts
6857 * all languages in a mediocre way. However, it is better than "uppercase".
6859 * To use the uca-default collation, you must have PHP's intl extension
6860 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6861 * resulting collation will depend on the version of ICU installed on the
6862 * server.
6864 * After you change this, you must run maintenance/updateCollation.php to fix
6865 * the sort keys in the database.
6867 * Extensions can define there own collations by subclassing Collation
6868 * and using the Collation::factory hook.
6870 $wgCategoryCollation = 'uppercase';
6872 /** @} */ # End categories }
6874 /*************************************************************************//**
6875 * @name Logging
6876 * @{
6880 * The logging system has two levels: an event type, which describes the
6881 * general category and can be viewed as a named subset of all logs; and
6882 * an action, which is a specific kind of event that can exist in that
6883 * log type.
6885 $wgLogTypes = array(
6887 'block',
6888 'protect',
6889 'rights',
6890 'delete',
6891 'upload',
6892 'move',
6893 'import',
6894 'patrol',
6895 'merge',
6896 'suppress',
6897 'tag',
6898 'managetags',
6899 'contentmodel',
6903 * This restricts log access to those who have a certain right
6904 * Users without this will not see it in the option menu and can not view it
6905 * Restricted logs are not added to recent changes
6906 * Logs should remain non-transcludable
6907 * Format: logtype => permissiontype
6909 $wgLogRestrictions = array(
6910 'suppress' => 'suppressionlog'
6914 * Show/hide links on Special:Log will be shown for these log types.
6916 * This is associative array of log type => boolean "hide by default"
6918 * See $wgLogTypes for a list of available log types.
6920 * @par Example:
6921 * @code
6922 * $wgFilterLogTypes = array(
6923 * 'move' => true,
6924 * 'import' => false,
6925 * );
6926 * @endcode
6928 * Will display show/hide links for the move and import logs. Move logs will be
6929 * hidden by default unless the link is clicked. Import logs will be shown by
6930 * default, and hidden when the link is clicked.
6932 * A message of the form log-show-hide-[type] should be added, and will be used
6933 * for the link text.
6935 $wgFilterLogTypes = array(
6936 'patrol' => true,
6937 'tag' => true,
6941 * Lists the message key string for each log type. The localized messages
6942 * will be listed in the user interface.
6944 * Extensions with custom log types may add to this array.
6946 * @since 1.19, if you follow the naming convention log-name-TYPE,
6947 * where TYPE is your log type, yoy don't need to use this array.
6949 $wgLogNames = array(
6950 '' => 'all-logs-page',
6951 'block' => 'blocklogpage',
6952 'protect' => 'protectlogpage',
6953 'rights' => 'rightslog',
6954 'delete' => 'dellogpage',
6955 'upload' => 'uploadlogpage',
6956 'move' => 'movelogpage',
6957 'import' => 'importlogpage',
6958 'patrol' => 'patrol-log-page',
6959 'merge' => 'mergelog',
6960 'suppress' => 'suppressionlog',
6964 * Lists the message key string for descriptive text to be shown at the
6965 * top of each log type.
6967 * Extensions with custom log types may add to this array.
6969 * @since 1.19, if you follow the naming convention log-description-TYPE,
6970 * where TYPE is your log type, yoy don't need to use this array.
6972 $wgLogHeaders = array(
6973 '' => 'alllogstext',
6974 'block' => 'blocklogtext',
6975 'delete' => 'dellogpagetext',
6976 'import' => 'importlogpagetext',
6977 'merge' => 'mergelogpagetext',
6978 'move' => 'movelogpagetext',
6979 'patrol' => 'patrol-log-header',
6980 'protect' => 'protectlogtext',
6981 'rights' => 'rightslogtext',
6982 'suppress' => 'suppressionlogtext',
6983 'upload' => 'uploadlogpagetext',
6987 * Lists the message key string for formatting individual events of each
6988 * type and action when listed in the logs.
6990 * Extensions with custom log types may add to this array.
6992 $wgLogActions = array();
6995 * The same as above, but here values are names of classes,
6996 * not messages.
6997 * @see LogPage::actionText
6998 * @see LogFormatter
7000 $wgLogActionsHandlers = array(
7001 'block/block' => 'BlockLogFormatter',
7002 'block/reblock' => 'BlockLogFormatter',
7003 'block/unblock' => 'BlockLogFormatter',
7004 'contentmodel/change' => 'ContentModelLogFormatter',
7005 'delete/delete' => 'DeleteLogFormatter',
7006 'delete/event' => 'DeleteLogFormatter',
7007 'delete/restore' => 'DeleteLogFormatter',
7008 'delete/revision' => 'DeleteLogFormatter',
7009 'import/interwiki' => 'ImportLogFormatter',
7010 'import/upload' => 'ImportLogFormatter',
7011 'managetags/activate' => 'LogFormatter',
7012 'managetags/create' => 'LogFormatter',
7013 'managetags/deactivate' => 'LogFormatter',
7014 'managetags/delete' => 'LogFormatter',
7015 'merge/merge' => 'MergeLogFormatter',
7016 'move/move' => 'MoveLogFormatter',
7017 'move/move_redir' => 'MoveLogFormatter',
7018 'patrol/patrol' => 'PatrolLogFormatter',
7019 'protect/modify' => 'ProtectLogFormatter',
7020 'protect/move_prot' => 'ProtectLogFormatter',
7021 'protect/protect' => 'ProtectLogFormatter',
7022 'protect/unprotect' => 'ProtectLogFormatter',
7023 'rights/autopromote' => 'RightsLogFormatter',
7024 'rights/rights' => 'RightsLogFormatter',
7025 'suppress/block' => 'BlockLogFormatter',
7026 'suppress/delete' => 'DeleteLogFormatter',
7027 'suppress/event' => 'DeleteLogFormatter',
7028 'suppress/reblock' => 'BlockLogFormatter',
7029 'suppress/revision' => 'DeleteLogFormatter',
7030 'tag/update' => 'TagLogFormatter',
7031 'upload/overwrite' => 'UploadLogFormatter',
7032 'upload/revert' => 'UploadLogFormatter',
7033 'upload/upload' => 'UploadLogFormatter',
7037 * Maintain a log of newusers at Log/newusers?
7039 $wgNewUserLog = true;
7041 /** @} */ # end logging }
7043 /*************************************************************************//**
7044 * @name Special pages (general and miscellaneous)
7045 * @{
7049 * Allow special page inclusions such as {{Special:Allpages}}
7051 $wgAllowSpecialInclusion = true;
7054 * Set this to an array of special page names to prevent
7055 * maintenance/updateSpecialPages.php from updating those pages.
7057 $wgDisableQueryPageUpdate = false;
7060 * On Special:Unusedimages, consider images "used", if they are put
7061 * into a category. Default (false) is not to count those as used.
7063 $wgCountCategorizedImagesAsUsed = false;
7066 * Maximum number of links to a redirect page listed on
7067 * Special:Whatlinkshere/RedirectDestination
7069 $wgMaxRedirectLinksRetrieved = 500;
7071 /** @} */ # end special pages }
7073 /*************************************************************************//**
7074 * @name Actions
7075 * @{
7079 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7080 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7081 * 'foo' => true Load the class FooAction which subclasses Action
7082 * If something is specified in the getActionOverrides()
7083 * of the relevant Page object it will be used
7084 * instead of the default class.
7085 * 'foo' => false The action is disabled; show an error message
7086 * Unsetting core actions will probably cause things to complain loudly.
7088 $wgActions = array(
7089 'credits' => true,
7090 'delete' => true,
7091 'edit' => true,
7092 'editchangetags' => 'SpecialPageAction',
7093 'history' => true,
7094 'info' => true,
7095 'markpatrolled' => true,
7096 'protect' => true,
7097 'purge' => true,
7098 'raw' => true,
7099 'render' => true,
7100 'revert' => true,
7101 'revisiondelete' => 'SpecialPageAction',
7102 'rollback' => true,
7103 'submit' => true,
7104 'unprotect' => true,
7105 'unwatch' => true,
7106 'view' => true,
7107 'watch' => true,
7110 /** @} */ # end actions }
7112 /*************************************************************************//**
7113 * @name Robot (search engine crawler) policy
7114 * See also $wgNoFollowLinks.
7115 * @{
7119 * Default robot policy. The default policy is to encourage indexing and fol-
7120 * lowing of links. It may be overridden on a per-namespace and/or per-page
7121 * basis.
7123 $wgDefaultRobotPolicy = 'index,follow';
7126 * Robot policies per namespaces. The default policy is given above, the array
7127 * is made of namespace constants as defined in includes/Defines.php. You can-
7128 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7129 * nofollow. This is because a number of special pages (e.g., ListPages) have
7130 * many permutations of options that display the same data under redundant
7131 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7132 * pages, all alike, and never reaching your actual content.
7134 * @par Example:
7135 * @code
7136 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
7137 * @endcode
7139 $wgNamespaceRobotPolicies = array();
7142 * Robot policies per article. These override the per-namespace robot policies.
7143 * Must be in the form of an array where the key part is a properly canonicalised
7144 * text form title and the value is a robot policy.
7146 * @par Example:
7147 * @code
7148 * $wgArticleRobotPolicies = array(
7149 * 'Main Page' => 'noindex,follow',
7150 * 'User:Bob' => 'index,follow',
7151 * );
7152 * @endcode
7154 * @par Example that DOES NOT WORK because the names are not canonical text
7155 * forms:
7156 * @code
7157 * $wgArticleRobotPolicies = array(
7158 * # Underscore, not space!
7159 * 'Main_Page' => 'noindex,follow',
7160 * # "Project", not the actual project name!
7161 * 'Project:X' => 'index,follow',
7162 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7163 * 'abc' => 'noindex,nofollow'
7164 * );
7165 * @endcode
7167 $wgArticleRobotPolicies = array();
7170 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7171 * will not function, so users can't decide whether pages in that namespace are
7172 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7174 * @par Example:
7175 * @code
7176 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
7177 * @endcode
7179 $wgExemptFromUserRobotsControl = null;
7181 /** @} */ # End robot policy }
7183 /************************************************************************//**
7184 * @name AJAX and API
7185 * Note: The AJAX entry point which this section refers to is gradually being
7186 * replaced by the API entry point, api.php. They are essentially equivalent.
7187 * Both of them are used for dynamic client-side features, via XHR.
7188 * @{
7192 * Enable the MediaWiki API for convenient access to
7193 * machine-readable data via api.php
7195 * See https://www.mediawiki.org/wiki/API
7197 $wgEnableAPI = true;
7200 * Allow the API to be used to perform write operations
7201 * (page edits, rollback, etc.) when an authorised user
7202 * accesses it
7204 $wgEnableWriteAPI = true;
7208 * WARNING: SECURITY THREAT - debug use only
7210 * Disables many security checks in the API for debugging purposes.
7211 * This flag should never be used on the production servers, as it introduces
7212 * a number of potential security holes. Even when enabled, the validation
7213 * will still be performed, but instead of failing, API will return a warning.
7214 * Also, there will always be a warning notifying that this flag is set.
7215 * At this point, the flag allows GET requests to go through for modules
7216 * requiring POST.
7218 * @since 1.21
7220 $wgDebugAPI = false;
7223 * API module extensions.
7225 * Associative array mapping module name to modules specs;
7226 * Each module spec is an associative array containing at least
7227 * the 'class' key for the module's class, and optionally a
7228 * 'factory' key for the factory function to use for the module.
7230 * That factory function will be called with two parameters,
7231 * the parent module (an instance of ApiBase, usually ApiMain)
7232 * and the name the module was registered under. The return
7233 * value must be an instance of the class given in the 'class'
7234 * field.
7236 * For backward compatibility, the module spec may also be a
7237 * simple string containing the module's class name. In that
7238 * case, the class' constructor will be called with the parent
7239 * module and module name as parameters, as described above.
7241 * Examples for registering API modules:
7243 * @code
7244 * $wgAPIModules['foo'] = 'ApiFoo';
7245 * $wgAPIModules['bar'] = array(
7246 * 'class' => 'ApiBar',
7247 * 'factory' => function( $main, $name ) { ... }
7248 * );
7249 * $wgAPIModules['xyzzy'] = array(
7250 * 'class' => 'ApiXyzzy',
7251 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
7252 * );
7253 * @endcode
7255 * Extension modules may override the core modules.
7256 * See ApiMain::$Modules for a list of the core modules.
7258 $wgAPIModules = array();
7261 * API format module extensions.
7262 * Associative array mapping format module name to module specs (see $wgAPIModules).
7263 * Extension modules may override the core modules.
7265 * See ApiMain::$Formats for a list of the core format modules.
7267 $wgAPIFormatModules = array();
7270 * API Query meta module extensions.
7271 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7272 * Extension modules may override the core modules.
7274 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7276 $wgAPIMetaModules = array();
7279 * API Query prop module extensions.
7280 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7281 * Extension modules may override the core modules.
7283 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7285 $wgAPIPropModules = array();
7288 * API Query list module extensions.
7289 * Associative array mapping list module name to module specs (see $wgAPIModules).
7290 * Extension modules may override the core modules.
7292 * See ApiQuery::$QueryListModules for a list of the core list modules.
7294 $wgAPIListModules = array();
7297 * Maximum amount of rows to scan in a DB query in the API
7298 * The default value is generally fine
7300 $wgAPIMaxDBRows = 5000;
7303 * The maximum size (in bytes) of an API result.
7304 * @warning Do not set this lower than $wgMaxArticleSize*1024
7306 $wgAPIMaxResultSize = 8388608;
7309 * The maximum number of uncached diffs that can be retrieved in one API
7310 * request. Set this to 0 to disable API diffs altogether
7312 $wgAPIMaxUncachedDiffs = 1;
7315 * Maximum amount of DB lag on a majority of DB slaves to tolerate
7316 * before forcing bots to retry any write requests via API errors.
7317 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
7319 $wgAPIMaxLagThreshold = 7;
7322 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7323 * API request logging
7325 $wgAPIRequestLog = false;
7328 * Set the timeout for the API help text cache. If set to 0, caching disabled
7330 $wgAPICacheHelpTimeout = 60 * 60;
7333 * The ApiQueryQueryPages module should skip pages that are redundant to true
7334 * API queries.
7336 $wgAPIUselessQueryPages = array(
7337 'MIMEsearch', // aiprop=mime
7338 'LinkSearch', // list=exturlusage
7339 'FileDuplicateSearch', // prop=duplicatefiles
7343 * Enable AJAX framework
7345 $wgUseAjax = true;
7348 * List of Ajax-callable functions.
7349 * Extensions acting as Ajax callbacks must register here
7351 $wgAjaxExportList = array();
7354 * Enable AJAX check for file overwrite, pre-upload
7356 $wgAjaxUploadDestCheck = true;
7359 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7361 $wgAjaxLicensePreview = true;
7364 * Have clients send edits to be prepared when filling in edit summaries.
7365 * This gives the server a head start on the expensive parsing operation.
7367 $wgAjaxEditStash = true;
7370 * Settings for incoming cross-site AJAX requests:
7371 * Newer browsers support cross-site AJAX when the target resource allows requests
7372 * from the origin domain by the Access-Control-Allow-Origin header.
7373 * This is currently only used by the API (requests to api.php)
7374 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7376 * - '*' matches any number of characters
7377 * - '?' matches any 1 character
7379 * @par Example:
7380 * @code
7381 * $wgCrossSiteAJAXdomains = array(
7382 * 'www.mediawiki.org',
7383 * '*.wikipedia.org',
7384 * '*.wikimedia.org',
7385 * '*.wiktionary.org',
7386 * );
7387 * @endcode
7389 $wgCrossSiteAJAXdomains = array();
7392 * Domains that should not be allowed to make AJAX requests,
7393 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7394 * Uses the same syntax as $wgCrossSiteAJAXdomains
7396 $wgCrossSiteAJAXdomainExceptions = array();
7398 /** @} */ # End AJAX and API }
7400 /************************************************************************//**
7401 * @name Shell and process control
7402 * @{
7406 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7408 $wgMaxShellMemory = 307200;
7411 * Maximum file size created by shell processes under linux, in KB
7412 * ImageMagick convert for example can be fairly hungry for scratch space
7414 $wgMaxShellFileSize = 102400;
7417 * Maximum CPU time in seconds for shell processes under Linux
7419 $wgMaxShellTime = 180;
7422 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7423 * would measure) in seconds for shell processes under Linux
7425 $wgMaxShellWallClockTime = 180;
7428 * Under Linux: a cgroup directory used to constrain memory usage of shell
7429 * commands. The directory must be writable by the user which runs MediaWiki.
7431 * If specified, this is used instead of ulimit, which is inaccurate, and
7432 * causes malloc() to return NULL, which exposes bugs in C applications, making
7433 * them segfault or deadlock.
7435 * A wrapper script will create a cgroup for each shell command that runs, as
7436 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7437 * kernel will send a SIGKILL signal to a process in the subgroup.
7439 * @par Example:
7440 * @code
7441 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7442 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7443 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7444 * @endcode
7446 * The reliability of cgroup cleanup can be improved by installing a
7447 * notify_on_release script in the root cgroup, see e.g.
7448 * https://gerrit.wikimedia.org/r/#/c/40784
7450 $wgShellCgroup = false;
7453 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7455 $wgPhpCli = '/usr/bin/php';
7458 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7459 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7460 * character set. Only the character set is relevant.
7462 $wgShellLocale = 'en_US.utf8';
7464 /** @} */ # End shell }
7466 /************************************************************************//**
7467 * @name HTTP client
7468 * @{
7472 * Timeout for HTTP requests done internally, in seconds.
7474 $wgHTTPTimeout = 25;
7477 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7479 $wgAsyncHTTPTimeout = 25;
7482 * Proxy to use for CURL requests.
7484 $wgHTTPProxy = false;
7487 * Local virtual hosts.
7489 * This lists domains that are configured as virtual hosts on the same machine.
7490 * If a request is to be made to a domain listed here, or any subdomain thereof,
7491 * then no proxy will be used.
7492 * Command-line scripts are not affected by this setting and will always use
7493 * proxy if it is configured.
7494 * @since 1.25
7496 $wgLocalVirtualHosts = array();
7499 * Timeout for connections done internally (in seconds)
7500 * Only works for curl
7502 $wgHTTPConnectTimeout = 5e0;
7504 /** @} */ # End HTTP client }
7506 /************************************************************************//**
7507 * @name Job queue
7508 * See also $wgEnotifUseJobQ.
7509 * @{
7513 * Number of jobs to perform per request. May be less than one in which case
7514 * jobs are performed probabalistically. If this is zero, jobs will not be done
7515 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7516 * be run periodically.
7518 $wgJobRunRate = 1;
7521 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7522 * to handle the job execution, instead of blocking the request until the job
7523 * execution finishes.
7524 * @since 1.23
7526 $wgRunJobsAsync = true;
7529 * Number of rows to update per job
7531 $wgUpdateRowsPerJob = 300;
7534 * Number of rows to update per query
7536 $wgUpdateRowsPerQuery = 100;
7538 /** @} */ # End job queue }
7540 /************************************************************************//**
7541 * @name Miscellaneous
7542 * @{
7546 * Name of the external diff engine to use
7548 $wgExternalDiffEngine = false;
7551 * Disable redirects to special pages and interwiki redirects, which use a 302
7552 * and have no "redirected from" link.
7554 * @note This is only for articles with #REDIRECT in them. URL's containing a
7555 * local interwiki prefix (or a non-canonical special page name) are still hard
7556 * redirected regardless of this setting.
7558 $wgDisableHardRedirects = false;
7561 * LinkHolderArray batch size
7562 * For debugging
7564 $wgLinkHolderBatchSize = 1000;
7567 * By default MediaWiki does not register links pointing to same server in
7568 * externallinks dataset, use this value to override:
7570 $wgRegisterInternalExternals = false;
7573 * Maximum number of pages to move at once when moving subpages with a page.
7575 $wgMaximumMovedPages = 100;
7578 * Fix double redirects after a page move.
7579 * Tends to conflict with page move vandalism, use only on a private wiki.
7581 $wgFixDoubleRedirects = false;
7584 * Allow redirection to another page when a user logs in.
7585 * To enable, set to a string like 'Main Page'
7587 $wgRedirectOnLogin = null;
7590 * Configuration for processing pool control, for use in high-traffic wikis.
7591 * An implementation is provided in the PoolCounter extension.
7593 * This configuration array maps pool types to an associative array. The only
7594 * defined key in the associative array is "class", which gives the class name.
7595 * The remaining elements are passed through to the class as constructor
7596 * parameters.
7598 * @par Example:
7599 * @code
7600 * $wgPoolCounterConf = array( 'ArticleView' => array(
7601 * 'class' => 'PoolCounter_Client',
7602 * 'timeout' => 15, // wait timeout in seconds
7603 * 'workers' => 5, // maximum number of active threads in each pool
7604 * 'maxqueue' => 50, // maximum number of total threads in each pool
7605 * ... any extension-specific options...
7606 * );
7607 * @endcode
7609 $wgPoolCounterConf = null;
7612 * To disable file delete/restore temporarily
7614 $wgUploadMaintenance = false;
7617 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7618 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7619 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7620 * (except for the special case of JS and CS pages).
7622 * @since 1.21
7624 $wgNamespaceContentModels = array();
7627 * How to react if a plain text version of a non-text Content object is requested using
7628 * ContentHandler::getContentText():
7630 * * 'ignore': return null
7631 * * 'fail': throw an MWException
7632 * * 'serialize': serialize to default format
7634 * @since 1.21
7636 $wgContentHandlerTextFallback = 'ignore';
7639 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7640 * This way, the ContentHandler facility can be used without any additional information in the
7641 * database. A page's content model is then derived solely from the page's title. This however
7642 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7643 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7644 * a title that would default to a different content model.
7646 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7647 * handling is less robust and less flexible.
7649 * @since 1.21
7651 $wgContentHandlerUseDB = true;
7654 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7655 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7656 * the effect on the database they would have on a wikitext page.
7658 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7659 * or at least parse only the contents of comments in the scripts.
7661 * @since 1.21
7663 $wgTextModelsToParse = array(
7664 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7665 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7666 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7670 * Whether the user must enter their password to change their e-mail address
7672 * @since 1.20
7674 $wgRequirePasswordforEmailChange = true;
7677 * Register handlers for specific types of sites.
7679 * @since 1.20
7681 $wgSiteTypes = array(
7682 'mediawiki' => 'MediaWikiSite',
7686 * Whether the page_props table has a pp_sortkey column. Set to false in case
7687 * the respective database schema change was not applied.
7688 * @since 1.23
7690 $wgPagePropsHaveSortkey = true;
7693 * Port where you have HTTPS running
7694 * Supports HTTPS on non-standard ports
7695 * @see bug 65184
7696 * @since 1.24
7698 $wgHttpsPort = 443;
7701 * Secret for hmac-based key derivation function (fast,
7702 * cryptographically secure random numbers).
7703 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7704 * be used.
7705 * See also: $wgHKDFAlgorithm
7706 * @since 1.24
7708 $wgHKDFSecret = false;
7711 * Algorithm for hmac-based key derivation function (fast,
7712 * cryptographically secure random numbers).
7713 * See also: $wgHKDFSecret
7714 * @since 1.24
7716 $wgHKDFAlgorithm = 'sha256';
7719 * Enable page language feature
7720 * Allows setting page language in database
7721 * @var bool
7722 * @since 1.24
7724 $wgPageLanguageUseDB = false;
7727 * Global configuration variable for Virtual REST Services.
7728 * Parameters for different services are to be declared inside
7729 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
7730 * array. Global parameters will be merged with service-specific ones. The
7731 * result will then be passed to VirtualRESTService::__construct() in the
7732 * module.
7734 * Example config for Parsoid:
7736 * $wgVirtualRestConfig['modules']['parsoid'] = array(
7737 * 'url' => 'http://localhost:8000',
7738 * 'prefix' => 'enwiki',
7739 * 'domain' => 'en.wikipedia.org',
7740 * );
7742 * @var array
7743 * @since 1.25
7745 $wgVirtualRestConfig = array(
7746 'modules' => array(),
7747 'global' => array(
7748 # Timeout in seconds
7749 'timeout' => 360,
7750 # 'domain' is set to $wgCanonicalServer in Setup.php
7751 'forwardCookies' => false,
7752 'HTTPProxy' => null
7757 * Controls whether zero-result search queries with suggestions should display results for
7758 * these suggestions.
7760 * @var bool
7761 * @since 1.26
7763 $wgSearchRunSuggestedQuery = true;
7766 * Where popular password file is located.
7768 * Default in core contains 50,000 most popular. This config
7769 * allows you to change which file, in case you want to generate
7770 * a password file with > 50000 entries in it.
7772 * @see maintenance/createCommonPasswordCdb.php
7773 * @since 1.27
7774 * @var string path to file
7776 $wgPopularPasswordFile = __DIR__ . '/../serialized/commonpasswords.cdb';
7779 * Max time (in seconds) a user-generated transaction can spend in writes.
7780 * If exceeded, the transaction is rolled back with an error instead of being committed.
7782 * @var int|bool Disabled if false
7783 * @since 1.27
7785 $wgMaxUserDBWriteDuration = false;
7788 * For really cool vim folding this needs to be at the end:
7789 * vim: foldmarker=@{,@} foldmethod=marker
7790 * @}