Run generateLocalAutoload.php
[mediawiki.git] / includes / DefaultSettings.php
blobae2aeaafc70155083729c8b6746a33a4b637b778
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 = [
71 'main' => 'GlobalVarConfig::newInstance'
74 /**
75 * MediaWiki version number
76 * @since 1.2
78 $wgVersion = '1.27.0-alpha';
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 = [];
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 = [];
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 = [];
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 = [];
539 * File backend structure configuration.
541 * This is an array of file backend configuration arrays.
542 * Each backend configuration has the following parameters:
543 * - 'name' : A unique name for the backend
544 * - 'class' : The file backend class to use
545 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
546 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
548 * See FileBackend::__construct() for more details.
549 * Additional parameters are specific to the file backend class used.
550 * These settings should be global to all wikis when possible.
552 * There are two particularly important aspects about each backend:
553 * - a) Whether it is fully qualified or wiki-relative.
554 * By default, the paths of files are relative to the current wiki,
555 * which works via prefixing them with the current wiki ID when accessed.
556 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
557 * all paths with the specified value instead. This can be useful if
558 * multiple wikis need to share the same data. Note that 'name' is *not*
559 * part of any prefix and thus should not be relied upon for namespacing.
560 * - b) Whether it is only defined for some wikis or is defined on all
561 * wikis in the wiki farm. Defining a backend globally is useful
562 * if multiple wikis need to share the same data.
563 * One should be aware of these aspects when configuring a backend for use with
564 * any basic feature or plugin. For example, suppose an extension stores data for
565 * different wikis in different directories and sometimes needs to access data from
566 * a foreign wiki's directory in order to render a page on given wiki. The extension
567 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
569 $wgFileBackends = [];
572 * Array of configuration arrays for each lock manager.
573 * Each backend configuration has the following parameters:
574 * - 'name' : A unique name for the lock manager
575 * - 'class' : The lock manger class to use
577 * See LockManager::__construct() for more details.
578 * Additional parameters are specific to the lock manager class used.
579 * These settings should be global to all wikis.
581 $wgLockManagers = [];
584 * Show Exif data, on by default if available.
585 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
587 * @note FOR WINDOWS USERS:
588 * To enable Exif functions, add the following line to the "Windows
589 * extensions" section of php.ini:
590 * @code{.ini}
591 * extension=extensions/php_exif.dll
592 * @endcode
594 $wgShowEXIF = function_exists( 'exif_read_data' );
597 * If to automatically update the img_metadata field
598 * if the metadata field is outdated but compatible with the current version.
599 * Defaults to false.
601 $wgUpdateCompatibleMetadata = false;
604 * If you operate multiple wikis, you can define a shared upload path here.
605 * Uploads to this wiki will NOT be put there - they will be put into
606 * $wgUploadDirectory.
607 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
608 * no file of the given name is found in the local repository (for [[File:..]],
609 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
610 * directory.
612 * Note that these configuration settings can now be defined on a per-
613 * repository basis for an arbitrary number of file repositories, using the
614 * $wgForeignFileRepos variable.
616 $wgUseSharedUploads = false;
619 * Full path on the web server where shared uploads can be found
621 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
624 * Fetch commons image description pages and display them on the local wiki?
626 $wgFetchCommonsDescriptions = false;
629 * Path on the file system where shared uploads can be found.
631 $wgSharedUploadDirectory = "/var/www/wiki3/images";
634 * DB name with metadata about shared directory.
635 * Set this to false if the uploads do not come from a wiki.
637 $wgSharedUploadDBname = false;
640 * Optional table prefix used in database.
642 $wgSharedUploadDBprefix = '';
645 * Cache shared metadata in memcached.
646 * Don't do this if the commons wiki is in a different memcached domain
648 $wgCacheSharedUploads = true;
651 * Allow for upload to be copied from an URL.
652 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
653 * You have to assign the user right 'upload_by_url' to a user group, to use this.
655 $wgAllowCopyUploads = false;
658 * A list of domains copy uploads can come from
660 * @since 1.20
662 $wgCopyUploadsDomains = [];
665 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
666 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
667 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
669 $wgCopyUploadsFromSpecialUpload = false;
672 * Proxy to use for copy upload requests.
673 * @since 1.20
675 $wgCopyUploadProxy = false;
678 * Different timeout for upload by url
679 * This could be useful since when fetching large files, you may want a
680 * timeout longer than the default $wgHTTPTimeout. False means fallback
681 * to default.
683 * @since 1.22
685 $wgCopyUploadTimeout = false;
688 * Max size for uploads, in bytes. If not set to an array, applies to all
689 * uploads. If set to an array, per upload type maximums can be set, using the
690 * file and url keys. If the * key is set this value will be used as maximum
691 * for non-specified types.
693 * @par Example:
694 * @code
695 * $wgMaxUploadSize = array(
696 * '*' => 250 * 1024,
697 * 'url' => 500 * 1024,
698 * );
699 * @endcode
700 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
701 * will have a maximum of 500 kB.
703 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
706 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
707 * chunks smaller than this will be rejected. May be reduced based on the
708 * 'upload_max_filesize' or 'post_max_size' PHP settings.
709 * @since 1.26
711 $wgMinUploadChunkSize = 1024; # 1KB
714 * Point the upload navigation link to an external URL
715 * Useful if you want to use a shared repository by default
716 * without disabling local uploads (use $wgEnableUploads = false for that).
718 * @par Example:
719 * @code
720 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
721 * @endcode
723 $wgUploadNavigationUrl = false;
726 * Point the upload link for missing files to an external URL, as with
727 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
728 * appended to it as appropriate.
730 $wgUploadMissingFileUrl = false;
733 * Give a path here to use thumb.php for thumbnail generation on client
734 * request, instead of generating them on render and outputting a static URL.
735 * This is necessary if some of your apache servers don't have read/write
736 * access to the thumbnail path.
738 * @par Example:
739 * @code
740 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
741 * @endcode
743 $wgThumbnailScriptPath = false;
746 * @see $wgThumbnailScriptPath
748 $wgSharedThumbnailScriptPath = false;
751 * Set this to false if you do not want MediaWiki to divide your images
752 * directory into many subdirectories, for improved performance.
754 * It's almost always good to leave this enabled. In previous versions of
755 * MediaWiki, some users set this to false to allow images to be added to the
756 * wiki by simply copying them into $wgUploadDirectory and then running
757 * maintenance/rebuildImages.php to register them in the database. This is no
758 * longer recommended, use maintenance/importImages.php instead.
760 * @note That this variable may be ignored if $wgLocalFileRepo is set.
761 * @todo Deprecate the setting and ultimately remove it from Core.
763 $wgHashedUploadDirectory = true;
766 * Set the following to false especially if you have a set of files that need to
767 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
768 * directory layout.
770 $wgHashedSharedUploadDirectory = true;
773 * Base URL for a repository wiki. Leave this blank if uploads are just stored
774 * in a shared directory and not meant to be accessible through a separate wiki.
775 * Otherwise the image description pages on the local wiki will link to the
776 * image description page on this wiki.
778 * Please specify the namespace, as in the example below.
780 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
783 * This is the list of preferred extensions for uploading files. Uploading files
784 * with extensions not in this list will trigger a warning.
786 * @warning If you add any OpenOffice or Microsoft Office file formats here,
787 * such as odt or doc, and untrusted users are allowed to upload files, then
788 * your wiki will be vulnerable to cross-site request forgery (CSRF).
790 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ];
793 * Files with these extensions will never be allowed as uploads.
794 * An array of file extensions to blacklist. You should append to this array
795 * if you want to blacklist additional files.
797 $wgFileBlacklist = [
798 # HTML may contain cookie-stealing JavaScript and web bugs
799 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
800 # PHP scripts may execute arbitrary code on the server
801 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
802 # Other types that may be interpreted by some servers
803 'shtml', 'jhtml', 'pl', 'py', 'cgi',
804 # May contain harmful executables for Windows victims
805 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ];
808 * Files with these MIME types will never be allowed as uploads
809 * if $wgVerifyMimeType is enabled.
811 $wgMimeTypeBlacklist = [
812 # HTML may contain cookie-stealing JavaScript and web bugs
813 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
814 # PHP scripts may execute arbitrary code on the server
815 'application/x-php', 'text/x-php',
816 # Other types that may be interpreted by some servers
817 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
818 # Client-side hazards on Internet Explorer
819 'text/scriptlet', 'application/x-msdownload',
820 # Windows metafile, client-side vulnerability on some systems
821 'application/x-msmetafile',
825 * Allow Java archive uploads.
826 * This is not recommended for public wikis since a maliciously-constructed
827 * applet running on the same domain as the wiki can steal the user's cookies.
829 $wgAllowJavaUploads = false;
832 * This is a flag to determine whether or not to check file extensions on upload.
834 * @warning Setting this to false is insecure for public wikis.
836 $wgCheckFileExtensions = true;
839 * If this is turned off, users may override the warning for files not covered
840 * by $wgFileExtensions.
842 * @warning Setting this to false is insecure for public wikis.
844 $wgStrictFileExtensions = true;
847 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
849 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
850 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
852 $wgDisableUploadScriptChecks = false;
855 * Warn if uploaded files are larger than this (in bytes), or false to disable
857 $wgUploadSizeWarning = false;
860 * list of trusted media-types and MIME types.
861 * Use the MEDIATYPE_xxx constants to represent media types.
862 * This list is used by File::isSafeFile
864 * Types not listed here will have a warning about unsafe content
865 * displayed on the images description page. It would also be possible
866 * to use this for further restrictions, like disabling direct
867 * [[media:...]] links for non-trusted formats.
869 $wgTrustedMediaFormats = [
870 MEDIATYPE_BITMAP, // all bitmap formats
871 MEDIATYPE_AUDIO, // all audio formats
872 MEDIATYPE_VIDEO, // all plain video formats
873 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
874 "application/pdf", // PDF files
875 # "application/x-shockwave-flash", //flash/shockwave movie
879 * Plugins for media file type handling.
880 * Each entry in the array maps a MIME type to a class name
882 $wgMediaHandlers = [
883 'image/jpeg' => 'JpegHandler',
884 'image/png' => 'PNGHandler',
885 'image/gif' => 'GIFHandler',
886 'image/tiff' => 'TiffHandler',
887 'image/webp' => 'WebPHandler',
888 'image/x-ms-bmp' => 'BmpHandler',
889 'image/x-bmp' => 'BmpHandler',
890 'image/x-xcf' => 'XCFHandler',
891 'image/svg+xml' => 'SvgHandler', // official
892 'image/svg' => 'SvgHandler', // compat
893 'image/vnd.djvu' => 'DjVuHandler', // official
894 'image/x.djvu' => 'DjVuHandler', // compat
895 'image/x-djvu' => 'DjVuHandler', // compat
899 * Plugins for page content model handling.
900 * Each entry in the array maps a model id to a class name or callback
901 * that creates an instance of the appropriate ContentHandler subclass.
903 * @since 1.21
905 $wgContentHandlers = [
906 // the usual case
907 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
908 // dumb version, no syntax highlighting
909 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
910 // simple implementation, for use by extensions, etc.
911 CONTENT_MODEL_JSON => 'JsonContentHandler',
912 // dumb version, no syntax highlighting
913 CONTENT_MODEL_CSS => 'CssContentHandler',
914 // plain text, for use by extensions, etc.
915 CONTENT_MODEL_TEXT => 'TextContentHandler',
919 * Whether to enable server-side image thumbnailing. If false, images will
920 * always be sent to the client in full resolution, with appropriate width= and
921 * height= attributes on the <img> tag for the client to do its own scaling.
923 $wgUseImageResize = true;
926 * Resizing can be done using PHP's internal image libraries or using
927 * ImageMagick or another third-party converter, e.g. GraphicMagick.
928 * These support more file formats than PHP, which only supports PNG,
929 * GIF, JPG, XBM and WBMP.
931 * Use Image Magick instead of PHP builtin functions.
933 $wgUseImageMagick = false;
936 * The convert command shipped with ImageMagick
938 $wgImageMagickConvertCommand = '/usr/bin/convert';
941 * Array of max pixel areas for interlacing per MIME type
942 * @since 1.27
944 $wgMaxInterlacingAreas = [];
947 * Sharpening parameter to ImageMagick
949 $wgSharpenParameter = '0x0.4';
952 * Reduction in linear dimensions below which sharpening will be enabled
954 $wgSharpenReductionThreshold = 0.85;
957 * Temporary directory used for ImageMagick. The directory must exist. Leave
958 * this set to false to let ImageMagick decide for itself.
960 $wgImageMagickTempDir = false;
963 * Use another resizing converter, e.g. GraphicMagick
964 * %s will be replaced with the source path, %d with the destination
965 * %w and %h will be replaced with the width and height.
967 * @par Example for GraphicMagick:
968 * @code
969 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
970 * @endcode
972 * Leave as false to skip this.
974 $wgCustomConvertCommand = false;
977 * used for lossless jpeg rotation
979 * @since 1.21
981 $wgJpegTran = '/usr/bin/jpegtran';
984 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
985 * image formats.
987 $wgExiv2Command = '/usr/bin/exiv2';
990 * Path to exiftool binary. Used for lossless ICC profile swapping.
992 * @since 1.26
994 $wgExiftool = '/usr/bin/exiftool';
997 * Scalable Vector Graphics (SVG) may be uploaded as images.
998 * Since SVG support is not yet standard in browsers, it is
999 * necessary to rasterize SVGs to PNG as a fallback format.
1001 * An external program is required to perform this conversion.
1002 * If set to an array, the first item is a PHP callable and any further items
1003 * are passed as parameters after $srcPath, $dstPath, $width, $height
1005 $wgSVGConverters = [
1006 'ImageMagick' =>
1007 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1008 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1009 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1010 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1011 . '$output $input',
1012 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1013 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1014 'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
1018 * Pick a converter defined in $wgSVGConverters
1020 $wgSVGConverter = 'ImageMagick';
1023 * If not in the executable PATH, specify the SVG converter path.
1025 $wgSVGConverterPath = '';
1028 * Don't scale a SVG larger than this
1030 $wgSVGMaxSize = 5120;
1033 * Don't read SVG metadata beyond this point.
1034 * Default is 1024*256 bytes
1036 $wgSVGMetadataCutoff = 262144;
1039 * Disallow <title> element in SVG files.
1041 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1042 * browsers which can not perform basic stuff like MIME detection and which are
1043 * vulnerable to further idiots uploading crap files as images.
1045 * When this directive is on, "<title>" will be allowed in files with an
1046 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1047 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1049 $wgAllowTitlesInSVG = false;
1052 * The maximum number of pixels a source image can have if it is to be scaled
1053 * down by a scaler that requires the full source image to be decompressed
1054 * and stored in decompressed form, before the thumbnail is generated.
1056 * This provides a limit on memory usage for the decompression side of the
1057 * image scaler. The limit is used when scaling PNGs with any of the
1058 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1059 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1061 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1062 * 12.5 million pixels or 3500x3500.
1064 $wgMaxImageArea = 1.25e7;
1067 * Force thumbnailing of animated GIFs above this size to a single
1068 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1069 * is checked against the total size of all frames in the animation.
1070 * It probably makes sense to keep this equal to $wgMaxImageArea.
1072 $wgMaxAnimatedGifArea = 1.25e7;
1075 * Browsers don't support TIFF inline generally...
1076 * For inline display, we need to convert to PNG or JPEG.
1077 * Note scaling should work with ImageMagick, but may not with GD scaling.
1079 * @par Example:
1080 * @code
1081 * // PNG is lossless, but inefficient for photos
1082 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1083 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1084 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1085 * @endcode
1087 $wgTiffThumbnailType = false;
1090 * If rendered thumbnail files are older than this timestamp, they
1091 * will be rerendered on demand as if the file didn't already exist.
1092 * Update if there is some need to force thumbs and SVG rasterizations
1093 * to rerender, such as fixes to rendering bugs.
1095 $wgThumbnailEpoch = '20030516000000';
1098 * Certain operations are avoided if there were too many recent failures,
1099 * for example, thumbnail generation. Bump this value to invalidate all
1100 * memory of failed operations and thus allow further attempts to resume.
1101 * This is useful when a cause for the failures has been found and fixed.
1103 $wgAttemptFailureEpoch = 1;
1106 * If set, inline scaled images will still produce "<img>" tags ready for
1107 * output instead of showing an error message.
1109 * This may be useful if errors are transitory, especially if the site
1110 * is configured to automatically render thumbnails on request.
1112 * On the other hand, it may obscure error conditions from debugging.
1113 * Enable the debug log or the 'thumbnail' log group to make sure errors
1114 * are logged to a file for review.
1116 $wgIgnoreImageErrors = false;
1119 * Allow thumbnail rendering on page view. If this is false, a valid
1120 * thumbnail URL is still output, but no file will be created at
1121 * the target location. This may save some time if you have a
1122 * thumb.php or 404 handler set up which is faster than the regular
1123 * webserver(s).
1125 $wgGenerateThumbnailOnParse = true;
1128 * Show thumbnails for old images on the image description page
1130 $wgShowArchiveThumbnails = true;
1133 * If set to true, images that contain certain the exif orientation tag will
1134 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1135 * is available that can rotate.
1137 $wgEnableAutoRotation = null;
1140 * Internal name of virus scanner. This serves as a key to the
1141 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1142 * null, every file uploaded will be scanned for viruses.
1144 $wgAntivirus = null;
1147 * Configuration for different virus scanners. This an associative array of
1148 * associative arrays. It contains one setup array per known scanner type.
1149 * The entry is selected by $wgAntivirus, i.e.
1150 * valid values for $wgAntivirus are the keys defined in this array.
1152 * The configuration array for each scanner contains the following keys:
1153 * "command", "codemap", "messagepattern":
1155 * "command" is the full command to call the virus scanner - %f will be
1156 * replaced with the name of the file to scan. If not present, the filename
1157 * will be appended to the command. Note that this must be overwritten if the
1158 * scanner is not in the system path; in that case, please set
1159 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1160 * path.
1162 * "codemap" is a mapping of exit code to return codes of the detectVirus
1163 * function in SpecialUpload.
1164 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1165 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1166 * is not set.
1167 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1168 * the file to have an unsupported format, which is probably immune to
1169 * viruses. This causes the file to pass.
1170 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1171 * no virus was found.
1172 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1173 * a virus.
1174 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1176 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1177 * output. The relevant part should be matched as group one (\1).
1178 * If not defined or the pattern does not match, the full message is shown to the user.
1180 $wgAntivirusSetup = [
1182 # setup for clamav
1183 'clamav' => [
1184 'command' => 'clamscan --no-summary ',
1185 'codemap' => [
1186 "0" => AV_NO_VIRUS, # no virus
1187 "1" => AV_VIRUS_FOUND, # virus found
1188 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1189 "*" => AV_SCAN_FAILED, # else scan failed
1191 'messagepattern' => '/.*?:(.*)/sim',
1196 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1198 $wgAntivirusRequired = true;
1201 * Determines if the MIME type of uploaded files should be checked
1203 $wgVerifyMimeType = true;
1206 * Sets the MIME type definition file to use by MimeMagic.php.
1207 * Set to null, to use built-in defaults only.
1208 * example: $wgMimeTypeFile = '/etc/mime.types';
1210 $wgMimeTypeFile = 'includes/mime.types';
1213 * Sets the MIME type info file to use by MimeMagic.php.
1214 * Set to null, to use built-in defaults only.
1216 $wgMimeInfoFile = 'includes/mime.info';
1219 * Sets an external MIME detector program. The command must print only
1220 * the MIME type to standard output.
1221 * The name of the file to process will be appended to the command given here.
1222 * If not set or NULL, PHP's fileinfo extension will be used if available.
1224 * @par Example:
1225 * @code
1226 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1227 * @endcode
1229 $wgMimeDetectorCommand = null;
1232 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1233 * things, because only a few types of images are needed and file extensions
1234 * can be trusted.
1236 $wgTrivialMimeDetection = false;
1239 * Additional XML types we can allow via MIME-detection.
1240 * array = ( 'rootElement' => 'associatedMimeType' )
1242 $wgXMLMimeTypes = [
1243 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1244 'svg' => 'image/svg+xml',
1245 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1246 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1247 'html' => 'text/html', // application/xhtml+xml?
1251 * Limit images on image description pages to a user-selectable limit. In order
1252 * to reduce disk usage, limits can only be selected from a list.
1253 * The user preference is saved as an array offset in the database, by default
1254 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1255 * change it if you alter the array (see bug 8858).
1256 * This is the list of settings the user can choose from:
1258 $wgImageLimits = [
1259 [ 320, 240 ],
1260 [ 640, 480 ],
1261 [ 800, 600 ],
1262 [ 1024, 768 ],
1263 [ 1280, 1024 ]
1267 * Adjust thumbnails on image pages according to a user setting. In order to
1268 * reduce disk usage, the values can only be selected from a list. This is the
1269 * list of settings the user can choose from:
1271 $wgThumbLimits = [
1272 120,
1273 150,
1274 180,
1275 200,
1276 250,
1281 * When defined, is an array of image widths used as buckets for thumbnail generation.
1282 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1283 * always using the original. This will incur a speed gain but cause a quality loss.
1285 * The buckets generation is chained, with each bucket generated based on the above bucket
1286 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1287 * supports it.
1289 $wgThumbnailBuckets = null;
1292 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1293 * above the requested size. The distance represents how many extra pixels of width the bucket
1294 * needs in order to be used as the reference for a given thumbnail. For example, with the
1295 * following buckets:
1297 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1299 * and a distance of 50:
1301 * $wgThumbnailMinimumBucketDistance = 50;
1303 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1304 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1306 $wgThumbnailMinimumBucketDistance = 50;
1309 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1310 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1311 * has a performance impact for the first client to view a certain size.
1313 * This obviously means that more disk space is needed per upload upfront.
1315 * @since 1.25
1318 $wgUploadThumbnailRenderMap = [];
1321 * The method through which the thumbnails will be prerendered for the entries in
1322 * $wgUploadThumbnailRenderMap
1324 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1325 * thumbnail's URL.
1326 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1327 * option uses the job queue to render the thumbnail.
1329 * @since 1.25
1331 $wgUploadThumbnailRenderMethod = 'jobqueue';
1334 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1336 * @since 1.25
1338 $wgUploadThumbnailRenderHttpCustomHost = false;
1341 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1342 * HTTP request to.
1344 * @since 1.25
1346 $wgUploadThumbnailRenderHttpCustomDomain = false;
1349 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1350 * (and free) TinyRGB profile when generating thumbnails.
1352 * @since 1.26
1354 $wgUseTinyRGBForJPGThumbnails = false;
1357 * Default parameters for the "<gallery>" tag
1359 $wgGalleryOptions = [
1360 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1361 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1362 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1363 'captionLength' => 25, // Length of caption to truncate (in characters)
1364 'showBytes' => true, // Show the filesize in bytes in categories
1365 'mode' => 'traditional',
1369 * Adjust width of upright images when parameter 'upright' is used
1370 * This allows a nicer look for upright images without the need to fix the width
1371 * by hardcoded px in wiki sourcecode.
1373 $wgThumbUpright = 0.75;
1376 * Default value for chmoding of new directories.
1378 $wgDirectoryMode = 0777;
1381 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1383 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1384 * thumbnails, output via the srcset attribute.
1386 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1387 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1388 * The polyfill can be found in the jquery.hidpi module.
1390 $wgResponsiveImages = true;
1393 * @name DJVU settings
1394 * @{
1398 * Path of the djvudump executable
1399 * Enable this and $wgDjvuRenderer to enable djvu rendering
1400 * example: $wgDjvuDump = 'djvudump';
1402 $wgDjvuDump = null;
1405 * Path of the ddjvu DJVU renderer
1406 * Enable this and $wgDjvuDump to enable djvu rendering
1407 * example: $wgDjvuRenderer = 'ddjvu';
1409 $wgDjvuRenderer = null;
1412 * Path of the djvutxt DJVU text extraction utility
1413 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1414 * example: $wgDjvuTxt = 'djvutxt';
1416 $wgDjvuTxt = null;
1419 * Path of the djvutoxml executable
1420 * This works like djvudump except much, much slower as of version 3.5.
1422 * For now we recommend you use djvudump instead. The djvuxml output is
1423 * probably more stable, so we'll switch back to it as soon as they fix
1424 * the efficiency problem.
1425 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1427 * @par Example:
1428 * @code
1429 * $wgDjvuToXML = 'djvutoxml';
1430 * @endcode
1432 $wgDjvuToXML = null;
1435 * Shell command for the DJVU post processor
1436 * Default: pnmtojpeg, since ddjvu generates ppm output
1437 * Set this to false to output the ppm file directly.
1439 $wgDjvuPostProcessor = 'pnmtojpeg';
1442 * File extension for the DJVU post processor output
1444 $wgDjvuOutputExtension = 'jpg';
1446 /** @} */ # end of DJvu }
1448 /** @} */ # end of file uploads }
1450 /************************************************************************//**
1451 * @name Email settings
1452 * @{
1456 * Site admin email address.
1458 * Defaults to "wikiadmin@$wgServerName".
1460 $wgEmergencyContact = false;
1463 * Sender email address for e-mail notifications.
1465 * The address we use as sender when a user requests a password reminder.
1467 * Defaults to "apache@$wgServerName".
1469 $wgPasswordSender = false;
1472 * Sender name for e-mail notifications.
1474 * @deprecated since 1.23; use the system message 'emailsender' instead.
1476 $wgPasswordSenderName = 'MediaWiki Mail';
1479 * Reply-To address for e-mail notifications.
1481 * Defaults to $wgPasswordSender.
1483 $wgNoReplyAddress = false;
1486 * Set to true to enable the e-mail basic features:
1487 * Password reminders, etc. If sending e-mail on your
1488 * server doesn't work, you might want to disable this.
1490 $wgEnableEmail = true;
1493 * Set to true to enable user-to-user e-mail.
1494 * This can potentially be abused, as it's hard to track.
1496 $wgEnableUserEmail = true;
1499 * Set to true to put the sending user's email in a Reply-To header
1500 * instead of From. ($wgEmergencyContact will be used as From.)
1502 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1503 * which can cause problems with SPF validation and leak recipient addresses
1504 * when bounces are sent to the sender.
1506 $wgUserEmailUseReplyTo = false;
1509 * Minimum time, in hours, which must elapse between password reminder
1510 * emails for a given account. This is to prevent abuse by mail flooding.
1512 $wgPasswordReminderResendTime = 24;
1515 * The time, in seconds, when an emailed temporary password expires.
1517 $wgNewPasswordExpiry = 3600 * 24 * 7;
1520 * The time, in seconds, when an email confirmation email expires
1522 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1525 * The number of days that a user's password is good for. After this number of days, the
1526 * user will be asked to reset their password. Set to false to disable password expiration.
1528 $wgPasswordExpirationDays = false;
1531 * If a user's password is expired, the number of seconds when they can still login,
1532 * and cancel their password change, but are sent to the password change form on each login.
1534 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1537 * SMTP Mode.
1539 * For using a direct (authenticated) SMTP server connection.
1540 * Default to false or fill an array :
1542 * @code
1543 * $wgSMTP = array(
1544 * 'host' => 'SMTP domain',
1545 * 'IDHost' => 'domain for MessageID',
1546 * 'port' => '25',
1547 * 'auth' => [true|false],
1548 * 'username' => [SMTP username],
1549 * 'password' => [SMTP password],
1550 * );
1551 * @endcode
1553 $wgSMTP = false;
1556 * Additional email parameters, will be passed as the last argument to mail() call.
1558 $wgAdditionalMailParams = null;
1561 * For parts of the system that have been updated to provide HTML email content, send
1562 * both text and HTML parts as the body of the email
1564 $wgAllowHTMLEmail = false;
1567 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1568 * from $wgEmergencyContact
1570 $wgEnotifFromEditor = false;
1572 // TODO move UPO to preferences probably ?
1573 # If set to true, users get a corresponding option in their preferences and can choose to
1574 # enable or disable at their discretion
1575 # If set to false, the corresponding input form on the user preference page is suppressed
1576 # It call this to be a "user-preferences-option (UPO)"
1579 * Require email authentication before sending mail to an email address.
1580 * This is highly recommended. It prevents MediaWiki from being used as an open
1581 * spam relay.
1583 $wgEmailAuthentication = true;
1586 * Allow users to enable email notification ("enotif") on watchlist changes.
1588 $wgEnotifWatchlist = false;
1591 * Allow users to enable email notification ("enotif") when someone edits their
1592 * user talk page.
1594 $wgEnotifUserTalk = false;
1597 * Set the Reply-to address in notifications to the editor's address, if user
1598 * allowed this in the preferences.
1600 $wgEnotifRevealEditorAddress = false;
1603 * Send notification mails on minor edits to watchlist pages. This is enabled
1604 * by default. User talk notifications are affected by this, $wgEnotifUserTalk, and
1605 * the nominornewtalk user right.
1607 $wgEnotifMinorEdits = true;
1610 * Send a generic mail instead of a personalised mail for each user. This
1611 * always uses UTC as the time zone, and doesn't include the username.
1613 * For pages with many users watching, this can significantly reduce mail load.
1614 * Has no effect when using sendmail rather than SMTP.
1616 $wgEnotifImpersonal = false;
1619 * Maximum number of users to mail at once when using impersonal mail. Should
1620 * match the limit on your mail server.
1622 $wgEnotifMaxRecips = 500;
1625 * Use real name instead of username in e-mail "from" field.
1627 $wgEnotifUseRealName = false;
1630 * Array of usernames who will be sent a notification email for every change
1631 * which occurs on a wiki. Users will not be notified of their own changes.
1633 $wgUsersNotifiedOnAllChanges = [];
1635 /** @} */ # end of email settings
1637 /************************************************************************//**
1638 * @name Database settings
1639 * @{
1643 * Database host name or IP address
1645 $wgDBserver = 'localhost';
1648 * Database port number (for PostgreSQL and Microsoft SQL Server).
1650 $wgDBport = 5432;
1653 * Name of the database
1655 $wgDBname = 'my_wiki';
1658 * Database username
1660 $wgDBuser = 'wikiuser';
1663 * Database user's password
1665 $wgDBpassword = '';
1668 * Database type
1670 $wgDBtype = 'mysql';
1673 * Whether to use SSL in DB connection.
1675 * This setting is only used $wgLBFactoryConf['class'] is set to
1676 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1677 * the DBO_SSL flag must be set in the 'flags' option of the database
1678 * connection to achieve the same functionality.
1680 $wgDBssl = false;
1683 * Whether to use compression in DB connection.
1685 * This setting is only used $wgLBFactoryConf['class'] is set to
1686 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1687 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1688 * connection to achieve the same functionality.
1690 $wgDBcompress = false;
1693 * Separate username for maintenance tasks. Leave as null to use the default.
1695 $wgDBadminuser = null;
1698 * Separate password for maintenance tasks. Leave as null to use the default.
1700 $wgDBadminpassword = null;
1703 * Search type.
1704 * Leave as null to select the default search engine for the
1705 * selected database type (eg SearchMySQL), or set to a class
1706 * name to override to a custom search engine.
1708 $wgSearchType = null;
1711 * Alternative search types
1712 * Sometimes you want to support multiple search engines for testing. This
1713 * allows users to select their search engine of choice via url parameters
1714 * to Special:Search and the action=search API. If using this, there's no
1715 * need to add $wgSearchType to it, that is handled automatically.
1717 $wgSearchTypeAlternatives = null;
1720 * Table name prefix
1722 $wgDBprefix = '';
1725 * MySQL table options to use during installation or update
1727 $wgDBTableOptions = 'ENGINE=InnoDB';
1730 * SQL Mode - default is turning off all modes, including strict, if set.
1731 * null can be used to skip the setting for performance reasons and assume
1732 * DBA has done his best job.
1733 * String override can be used for some additional fun :-)
1735 $wgSQLMode = '';
1738 * Mediawiki schema
1740 $wgDBmwschema = null;
1743 * To override default SQLite data directory ($docroot/../data)
1745 $wgSQLiteDataDir = '';
1748 * Make all database connections secretly go to localhost. Fool the load balancer
1749 * thinking there is an arbitrarily large cluster of servers to connect to.
1750 * Useful for debugging.
1752 $wgAllDBsAreLocalhost = false;
1755 * Shared database for multiple wikis. Commonly used for storing a user table
1756 * for single sign-on. The server for this database must be the same as for the
1757 * main database.
1759 * For backwards compatibility the shared prefix is set to the same as the local
1760 * prefix, and the user table is listed in the default list of shared tables.
1761 * The user_properties table is also added so that users will continue to have their
1762 * preferences shared (preferences were stored in the user table prior to 1.16)
1764 * $wgSharedTables may be customized with a list of tables to share in the shared
1765 * database. However it is advised to limit what tables you do share as many of
1766 * MediaWiki's tables may have side effects if you try to share them.
1768 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1769 * $wgDBprefix.
1771 * $wgSharedSchema is the table schema for the shared database. It defaults to
1772 * $wgDBmwschema.
1774 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1775 * access remote databases. Using wfGetLB() allows the shared database to
1776 * reside on separate servers to the wiki's own database, with suitable
1777 * configuration of $wgLBFactoryConf.
1779 $wgSharedDB = null;
1782 * @see $wgSharedDB
1784 $wgSharedPrefix = false;
1787 * @see $wgSharedDB
1789 $wgSharedTables = [ 'user', 'user_properties' ];
1792 * @see $wgSharedDB
1793 * @since 1.23
1795 $wgSharedSchema = false;
1798 * Database load balancer
1799 * This is a two-dimensional array, an array of server info structures
1800 * Fields are:
1801 * - host: Host name
1802 * - dbname: Default database name
1803 * - user: DB user
1804 * - password: DB password
1805 * - type: DB type
1807 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1808 * If this is zero for any given server, no normal query traffic will be
1809 * sent to it. It will be excluded from lag checks in maintenance scripts.
1810 * The only way it can receive traffic is if groupLoads is used.
1812 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1813 * to several groups, the most specific group defined here is used.
1815 * - flags: bit field
1816 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1817 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1818 * - DBO_TRX -- wrap entire request in a transaction
1819 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1820 * - DBO_PERSISTENT -- enables persistent database connections
1821 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1822 * - DBO_COMPRESS -- uses internal compression in database connections,
1823 * if available
1825 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1827 * These and any other user-defined properties will be assigned to the mLBInfo member
1828 * variable of the Database object.
1830 * Leave at false to use the single-server variables above. If you set this
1831 * variable, the single-server variables will generally be ignored (except
1832 * perhaps in some command-line scripts).
1834 * The first server listed in this array (with key 0) will be the master. The
1835 * rest of the servers will be slaves. To prevent writes to your slaves due to
1836 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1837 * slaves in my.cnf. You can set read_only mode at runtime using:
1839 * @code
1840 * SET @@read_only=1;
1841 * @endcode
1843 * Since the effect of writing to a slave is so damaging and difficult to clean
1844 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1845 * our masters, and then set read_only=0 on masters at runtime.
1847 $wgDBservers = false;
1850 * Load balancer factory configuration
1851 * To set up a multi-master wiki farm, set the class here to something that
1852 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1853 * The class identified here is responsible for reading $wgDBservers,
1854 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1856 * The LBFactoryMulti class is provided for this purpose, please see
1857 * includes/db/LBFactoryMulti.php for configuration information.
1859 $wgLBFactoryConf = [ 'class' => 'LBFactorySimple' ];
1862 * After a state-changing request is done by a client, this determines
1863 * how many seconds that client should keep using the master datacenter.
1864 * This avoids unexpected stale or 404 responses due to replication lag.
1865 * @since 1.27
1867 $wgDataCenterUpdateStickTTL = 10;
1870 * File to log database errors to
1872 $wgDBerrorLog = false;
1875 * Timezone to use in the error log.
1876 * Defaults to the wiki timezone ($wgLocaltimezone).
1878 * A list of usable timezones can found at:
1879 * http://php.net/manual/en/timezones.php
1881 * @par Examples:
1882 * @code
1883 * $wgDBerrorLogTZ = 'UTC';
1884 * $wgDBerrorLogTZ = 'GMT';
1885 * $wgDBerrorLogTZ = 'PST8PDT';
1886 * $wgDBerrorLogTZ = 'Europe/Sweden';
1887 * $wgDBerrorLogTZ = 'CET';
1888 * @endcode
1890 * @since 1.20
1892 $wgDBerrorLogTZ = false;
1895 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1896 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1898 * @warning THIS IS EXPERIMENTAL!
1900 * May break if you're not using the table defs from mysql5/tables.sql.
1901 * May break if you're upgrading an existing wiki if set differently.
1902 * Broken symptoms likely to include incorrect behavior with page titles,
1903 * usernames, comments etc containing non-ASCII characters.
1904 * Might also cause failures on the object cache and other things.
1906 * Even correct usage may cause failures with Unicode supplementary
1907 * characters (those not in the Basic Multilingual Plane) unless MySQL
1908 * has enhanced their Unicode support.
1910 $wgDBmysql5 = false;
1913 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1915 * To use this feature set to true and use a datasource defined as
1916 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1917 * block).
1919 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1920 * Pool) that maintains established sessions and reuses them on new
1921 * connections.
1923 * Not completely tested, but it should fall back on normal connection
1924 * in case the pool is full or the datasource is not configured as
1925 * pooled.
1926 * And the other way around; using oci_pconnect on a non pooled
1927 * datasource should produce a normal connection.
1929 * When it comes to frequent shortlived DB connections like with MW
1930 * Oracle tends to s***. The problem is the driver connects to the
1931 * database reasonably fast, but establishing a session takes time and
1932 * resources. MW does not rely on session state (as it does not use
1933 * features such as package variables) so establishing a valid session
1934 * is in this case an unwanted overhead that just slows things down.
1936 * @warning EXPERIMENTAL!
1939 $wgDBOracleDRCP = false;
1942 * Other wikis on this site, can be administered from a single developer
1943 * account.
1944 * Array numeric key => database name
1946 $wgLocalDatabases = [];
1949 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1950 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1951 * show a more obvious warning.
1953 $wgSlaveLagWarning = 10;
1956 * @see $wgSlaveLagWarning
1958 $wgSlaveLagCritical = 30;
1961 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1963 $wgDBWindowsAuthentication = false;
1965 /**@}*/ # End of DB settings }
1967 /************************************************************************//**
1968 * @name Text storage
1969 * @{
1973 * We can also compress text stored in the 'text' table. If this is set on, new
1974 * revisions will be compressed on page save if zlib support is available. Any
1975 * compressed revisions will be decompressed on load regardless of this setting,
1976 * but will not be readable at all* if zlib support is not available.
1978 $wgCompressRevisions = false;
1981 * External stores allow including content
1982 * from non database sources following URL links.
1984 * Short names of ExternalStore classes may be specified in an array here:
1985 * @code
1986 * $wgExternalStores = array("http","file","custom")...
1987 * @endcode
1989 * CAUTION: Access to database might lead to code execution
1991 $wgExternalStores = [];
1994 * An array of external MySQL servers.
1996 * @par Example:
1997 * Create a cluster named 'cluster1' containing three servers:
1998 * @code
1999 * $wgExternalServers = array(
2000 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
2001 * );
2002 * @endcode
2004 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2005 * another class.
2007 $wgExternalServers = [];
2010 * The place to put new revisions, false to put them in the local text table.
2011 * Part of a URL, e.g. DB://cluster1
2013 * Can be an array instead of a single string, to enable data distribution. Keys
2014 * must be consecutive integers, starting at zero.
2016 * @par Example:
2017 * @code
2018 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
2019 * @endcode
2021 * @var array
2023 $wgDefaultExternalStore = false;
2026 * Revision text may be cached in $wgMemc to reduce load on external storage
2027 * servers and object extraction overhead for frequently-loaded revisions.
2029 * Set to 0 to disable, or number of seconds before cache expiry.
2031 $wgRevisionCacheExpiry = 0;
2033 /** @} */ # end text storage }
2035 /************************************************************************//**
2036 * @name Performance hacks and limits
2037 * @{
2041 * Disable database-intensive features
2043 $wgMiserMode = false;
2046 * Disable all query pages if miser mode is on, not just some
2048 $wgDisableQueryPages = false;
2051 * Number of rows to cache in 'querycache' table when miser mode is on
2053 $wgQueryCacheLimit = 1000;
2056 * Number of links to a page required before it is deemed "wanted"
2058 $wgWantedPagesThreshold = 1;
2061 * Enable slow parser functions
2063 $wgAllowSlowParserFunctions = false;
2066 * Allow schema updates
2068 $wgAllowSchemaUpdates = true;
2071 * Maximum article size in kilobytes
2073 $wgMaxArticleSize = 2048;
2076 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2077 * raise PHP's memory limit if it's below this amount.
2079 $wgMemoryLimit = "50M";
2082 * The minimum amount of time that MediaWiki needs for "slow" write request,
2083 * particularly ones with multiple non-atomic writes that *should* be as
2084 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2085 * @since 1.26
2087 $wgTransactionalTimeLimit = 120;
2089 /** @} */ # end performance hacks }
2091 /************************************************************************//**
2092 * @name Cache settings
2093 * @{
2097 * Directory for caching data in the local filesystem. Should not be accessible
2098 * from the web.
2100 * Note: if multiple wikis share the same localisation cache directory, they
2101 * must all have the same set of extensions. You can set a directory just for
2102 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2104 $wgCacheDirectory = false;
2107 * Main cache type. This should be a cache with fast access, but it may have
2108 * limited space. By default, it is disabled, since the stock database cache
2109 * is not fast enough to make it worthwhile.
2111 * The options are:
2113 * - CACHE_ANYTHING: Use anything, as long as it works
2114 * - CACHE_NONE: Do not cache
2115 * - CACHE_DB: Store cache objects in the DB
2116 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2117 * - CACHE_ACCEL: APC, XCache or WinCache
2118 * - (other): A string may be used which identifies a cache
2119 * configuration in $wgObjectCaches.
2121 * @see $wgMessageCacheType, $wgParserCacheType
2123 $wgMainCacheType = CACHE_NONE;
2126 * The cache type for storing the contents of the MediaWiki namespace. This
2127 * cache is used for a small amount of data which is expensive to regenerate.
2129 * For available types see $wgMainCacheType.
2131 $wgMessageCacheType = CACHE_ANYTHING;
2134 * The cache type for storing article HTML. This is used to store data which
2135 * is expensive to regenerate, and benefits from having plenty of storage space.
2137 * For available types see $wgMainCacheType.
2139 $wgParserCacheType = CACHE_ANYTHING;
2142 * The cache type for storing session data.
2144 * For available types see $wgMainCacheType.
2146 $wgSessionCacheType = CACHE_ANYTHING;
2149 * The cache type for storing language conversion tables,
2150 * which are used when parsing certain text and interface messages.
2152 * For available types see $wgMainCacheType.
2154 * @since 1.20
2156 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2159 * Advanced object cache configuration.
2161 * Use this to define the class names and constructor parameters which are used
2162 * for the various cache types. Custom cache types may be defined here and
2163 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2164 * or $wgLanguageConverterCacheType.
2166 * The format is an associative array where the key is a cache identifier, and
2167 * the value is an associative array of parameters. The "class" parameter is the
2168 * class name which will be used. Alternatively, a "factory" parameter may be
2169 * given, giving a callable function which will generate a suitable cache object.
2171 $wgObjectCaches = [
2172 CACHE_NONE => [ 'class' => 'EmptyBagOStuff' ],
2173 CACHE_DB => [ 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ],
2175 CACHE_ANYTHING => [ 'factory' => 'ObjectCache::newAnything' ],
2176 CACHE_ACCEL => [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2177 CACHE_MEMCACHED => [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2179 'db-replicated' => [
2180 'class' => 'ReplicatedBagOStuff',
2181 'readFactory' => [
2182 'class' => 'SqlBagOStuff',
2183 'args' => [ [ 'slaveOnly' => true ] ]
2185 'writeFactory' => [
2186 'class' => 'SqlBagOStuff',
2187 'args' => [ [ 'slaveOnly' => false ] ]
2189 'loggroup' => 'SQLBagOStuff'
2192 'apc' => [ 'class' => 'APCBagOStuff' ],
2193 'xcache' => [ 'class' => 'XCacheBagOStuff' ],
2194 'wincache' => [ 'class' => 'WinCacheBagOStuff' ],
2195 'memcached-php' => [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2196 'memcached-pecl' => [ 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ],
2197 'hash' => [ 'class' => 'HashBagOStuff' ],
2201 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2202 * but it may have limited space. By default, it is disabled, since the basic stock
2203 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2204 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2205 * cache with a relayer of type EventRelayerNull.
2207 * The options are:
2208 * - false: Configure the cache using $wgMainCacheType, without using
2209 * a relayer (only matters if there are multiple data-centers)
2210 * - CACHE_NONE: Do not cache
2211 * - (other): A string may be used which identifies a cache
2212 * configuration in $wgWANObjectCaches
2213 * @since 1.26
2215 $wgMainWANCache = false;
2218 * Advanced WAN object cache configuration.
2220 * Each WAN cache wraps a registered object cache (for the local cluster)
2221 * and it must also be configured to point to a PubSub instance. Subscribers
2222 * must be configured to relay purges to the actual cache servers.
2224 * The format is an associative array where the key is a cache identifier, and
2225 * the value is an associative array of parameters. The "cacheId" parameter is
2226 * a cache identifier from $wgObjectCaches. The "relayerConfig" parameter is an
2227 * array used to construct an EventRelayer object. The "pool" parameter is a
2228 * string that is used as a PubSub channel prefix. The "loggroup" parameter
2229 * controls where log events are sent.
2231 * @since 1.26
2233 $wgWANObjectCaches = [
2234 CACHE_NONE => [
2235 'class' => 'WANObjectCache',
2236 'cacheId' => CACHE_NONE,
2237 'pool' => 'mediawiki-main-none',
2238 'relayerConfig' => [ 'class' => 'EventRelayerNull' ]
2240 /* Example of a simple single data-center cache:
2241 'memcached-php' => array(
2242 'class' => 'WANObjectCache',
2243 'cacheId' => 'memcached-php',
2244 'pool' => 'mediawiki-main-memcached',
2245 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2251 * Main object stash type. This should be a fast storage system for storing
2252 * lightweight data like hit counters and user activity. Sites with multiple
2253 * data-centers should have this use a store that replicates all writes. The
2254 * store should have enough consistency for CAS operations to be usable.
2255 * Reads outside of those needed for merge() may be eventually consistent.
2257 * The options are:
2258 * - db: Store cache objects in the DB
2259 * - (other): A string may be used which identifies a cache
2260 * configuration in $wgObjectCaches
2262 * @since 1.26
2264 $wgMainStash = 'db-replicated';
2267 * The expiry time for the parser cache, in seconds.
2268 * The default is 86400 (one day).
2270 $wgParserCacheExpireTime = 86400;
2273 * Deprecated alias for $wgSessionsInObjectCache.
2275 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2277 $wgSessionsInMemcached = true;
2280 * @deprecated since 1.27, session data is always stored in object cache.
2282 $wgSessionsInObjectCache = true;
2285 * The expiry time to use for session storage, in seconds.
2287 $wgObjectCacheSessionExpiry = 3600;
2290 * @deprecated since 1.27, MediaWiki\Session\SessionManager doesn't use PHP session storage.
2292 $wgSessionHandler = null;
2295 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2297 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2299 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2300 * session handling will function independently of SessionHandler.
2301 * SessionHandler and PHP's session handling may attempt to override each
2302 * others' cookies.
2304 * @since 1.27
2305 * @var string
2306 * - 'enable': Integrate with PHP's session handling as much as possible.
2307 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2308 * - 'disable': Throw exceptions if PHP session handling is used.
2310 $wgPHPSessionHandling = 'enable';
2313 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2315 $wgMemCachedDebug = false;
2318 * The list of MemCached servers and port numbers
2320 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2323 * Use persistent connections to MemCached, which are shared across multiple
2324 * requests.
2326 $wgMemCachedPersistent = false;
2329 * Read/write timeout for MemCached server communication, in microseconds.
2331 $wgMemCachedTimeout = 500000;
2334 * Set this to true to maintain a copy of the message cache on the local server.
2336 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2338 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2340 * Note that this is about the message cache, which stores interface messages
2341 * maintained as wiki pages. This is separate from the localisation cache for interface
2342 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2344 $wgUseLocalMessageCache = false;
2347 * Instead of caching everything, only cache those messages which have
2348 * been customised in the site content language. This means that
2349 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2350 * This option is probably only useful for translatewiki.net.
2352 $wgAdaptiveMessageCache = false;
2355 * Localisation cache configuration. Associative array with keys:
2356 * class: The class to use. May be overridden by extensions.
2358 * store: The location to store cache data. May be 'files', 'array', 'db' or
2359 * 'detect'. If set to "files", data will be in CDB files. If set
2360 * to "db", data will be stored to the database. If set to
2361 * "detect", files will be used if $wgCacheDirectory is set,
2362 * otherwise the database will be used.
2363 * "array" is an experimental option that uses PHP files that
2364 * store static arrays.
2366 * storeClass: The class name for the underlying storage. If set to a class
2367 * name, it overrides the "store" setting.
2369 * storeDirectory: If the store class puts its data in files, this is the
2370 * directory it will use. If this is false, $wgCacheDirectory
2371 * will be used.
2373 * manualRecache: Set this to true to disable cache updates on web requests.
2374 * Use maintenance/rebuildLocalisationCache.php instead.
2376 $wgLocalisationCacheConf = [
2377 'class' => 'LocalisationCache',
2378 'store' => 'detect',
2379 'storeClass' => false,
2380 'storeDirectory' => false,
2381 'manualRecache' => false,
2385 * Allow client-side caching of pages
2387 $wgCachePages = true;
2390 * Set this to current time to invalidate all prior cached pages. Affects both
2391 * client-side and server-side caching.
2392 * You can get the current date on your server by using the command:
2393 * @verbatim
2394 * date +%Y%m%d%H%M%S
2395 * @endverbatim
2397 $wgCacheEpoch = '20030516000000';
2400 * Directory where GitInfo will look for pre-computed cache files. If false,
2401 * $wgCacheDirectory/gitinfo will be used.
2403 $wgGitInfoCacheDirectory = false;
2406 * Bump this number when changing the global style sheets and JavaScript.
2408 * It should be appended in the query string of static CSS and JS includes,
2409 * to ensure that client-side caches do not keep obsolete copies of global
2410 * styles.
2412 $wgStyleVersion = '303';
2415 * This will cache static pages for non-logged-in users to reduce
2416 * database traffic on public sites. ResourceLoader requests to default
2417 * language and skins are cached as well as single module requests.
2419 $wgUseFileCache = false;
2422 * Depth of the subdirectory hierarchy to be created under
2423 * $wgFileCacheDirectory. The subdirectories will be named based on
2424 * the MD5 hash of the title. A value of 0 means all cache files will
2425 * be put directly into the main file cache directory.
2427 $wgFileCacheDepth = 2;
2430 * Kept for extension compatibility; see $wgParserCacheType
2431 * @deprecated 1.26
2433 $wgEnableParserCache = true;
2436 * Append a configured value to the parser cache and the sitenotice key so
2437 * that they can be kept separate for some class of activity.
2439 $wgRenderHashAppend = '';
2442 * If on, the sidebar navigation links are cached for users with the
2443 * current language set. This can save a touch of load on a busy site
2444 * by shaving off extra message lookups.
2446 * However it is also fragile: changing the site configuration, or
2447 * having a variable $wgArticlePath, can produce broken links that
2448 * don't update as expected.
2450 $wgEnableSidebarCache = false;
2453 * Expiry time for the sidebar cache, in seconds
2455 $wgSidebarCacheExpiry = 86400;
2458 * When using the file cache, we can store the cached HTML gzipped to save disk
2459 * space. Pages will then also be served compressed to clients that support it.
2461 * Requires zlib support enabled in PHP.
2463 $wgUseGzip = false;
2466 * Whether MediaWiki should send an ETag header. Seems to cause
2467 * broken behavior with Squid 2.6, see bug 7098.
2469 $wgUseETag = false;
2472 * Clock skew or the one-second resolution of time() can occasionally cause cache
2473 * problems when the user requests two pages within a short period of time. This
2474 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2475 * a grace period.
2477 $wgClockSkewFudge = 5;
2480 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2481 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2482 * was previously done in the default LocalSettings.php file.
2484 * On high-traffic wikis, this should be set to false, to avoid the need to
2485 * check the file modification time, and to avoid the performance impact of
2486 * unnecessary cache invalidations.
2488 $wgInvalidateCacheOnLocalSettingsChange = true;
2491 * When loading extensions through the extension registration system, this
2492 * can be used to invalidate the cache. A good idea would be to set this to
2493 * one file, you can just `touch` that one to invalidate the cache
2495 * @par Example:
2496 * @code
2497 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2498 * @endcode
2500 * If set to false, the mtime for each individual JSON file will be checked,
2501 * which can be slow if a large number of extensions are being loaded.
2503 * @var int|bool
2505 $wgExtensionInfoMTime = false;
2507 /** @} */ # end of cache settings
2509 /************************************************************************//**
2510 * @name HTTP proxy (CDN) settings
2512 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2513 * although they are referred to as Squid settings for historical reasons.
2515 * Achieving a high hit ratio with an HTTP proxy requires special
2516 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2517 * more details.
2519 * @{
2523 * Enable/disable CDN.
2524 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2526 $wgUseSquid = false;
2529 * If you run Squid3 with ESI support, enable this (default:false):
2531 $wgUseESI = false;
2534 * Send the Key HTTP header for better caching.
2535 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2536 * @since 1.27
2538 $wgUseKeyHeader = false;
2541 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2542 * RSS/Atom feeds. Use this if you have an SSL termination setup
2543 * and need to split the cache between HTTP and HTTPS for API requests,
2544 * feed requests and HTTP redirect responses in order to prevent cache
2545 * pollution. This does not affect 'normal' requests to index.php other than
2546 * HTTP redirects.
2548 $wgVaryOnXFP = false;
2551 * Internal server name as known to CDN, if different.
2553 * @par Example:
2554 * @code
2555 * $wgInternalServer = 'http://yourinternal.tld:8000';
2556 * @endcode
2558 $wgInternalServer = false;
2561 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2562 * Surrogate-Control (with ESI). Without ESI, you should strip
2563 * out s-maxage in the CDN config.
2565 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2567 $wgSquidMaxage = 18000;
2570 * Cache timeout for the CDN when DB slave lag is high
2571 * @see $wgSquidMaxage
2572 * @since 1.27
2574 $wgCdnMaxageLagged = 30;
2577 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2578 * this many seconds later via the job queue. This requires delayed job support.
2579 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2580 * slave lag does not cause page to be stuck in stales states in CDN.
2582 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2583 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2584 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2585 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2586 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2588 * @since 1.27
2590 $wgCdnReboundPurgeDelay = 0;
2593 * Default maximum age for raw CSS/JS accesses
2595 * 300 seconds = 5 minutes.
2597 $wgForcedRawSMaxage = 300;
2600 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2602 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2603 * headers sent/modified from these proxies when obtaining the remote IP address
2605 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2607 $wgSquidServers = [];
2610 * As above, except these servers aren't purged on page changes; use to set a
2611 * list of trusted proxies, etc. Supports both individual IP addresses and
2612 * CIDR blocks.
2613 * @since 1.23 Supports CIDR ranges
2615 $wgSquidServersNoPurge = [];
2618 * Whether to use a Host header in purge requests sent to the proxy servers
2619 * configured in $wgSquidServers. Set this to false to support Squid
2620 * configured in forward-proxy mode.
2622 * If this is set to true, a Host header will be sent, and only the path
2623 * component of the URL will appear on the request line, as if the request
2624 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2625 * request. Squid supports this style of request only if reverse-proxy mode
2626 * (http_port ... accel) is enabled.
2628 * If this is set to false, no Host header will be sent, and the absolute URL
2629 * will be sent in the request line, as is the standard for an HTTP proxy
2630 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2631 * by Varnish, but is supported by Squid in either configuration (forward or
2632 * reverse).
2634 * @since 1.21
2636 $wgSquidPurgeUseHostHeader = true;
2639 * Routing configuration for HTCP multicast purging. Add elements here to
2640 * enable HTCP and determine which purges are sent where. If set to an empty
2641 * array, HTCP is disabled.
2643 * Each key in this array is a regular expression to match against the purged
2644 * URL, or an empty string to match all URLs. The purged URL is matched against
2645 * the regexes in the order specified, and the first rule whose regex matches
2646 * is used, all remaining rules will thus be ignored.
2648 * @par Example configuration to send purges for upload.wikimedia.org to one
2649 * multicast group and all other purges to another:
2650 * @code
2651 * $wgHTCPRouting = array(
2652 * '|^https?://upload\.wikimedia\.org|' => array(
2653 * 'host' => '239.128.0.113',
2654 * 'port' => 4827,
2655 * ),
2656 * '' => array(
2657 * 'host' => '239.128.0.112',
2658 * 'port' => 4827,
2659 * ),
2660 * );
2661 * @endcode
2663 * You can also pass an array of hosts to send purges too. This is useful when
2664 * you have several multicast groups or unicast address that should receive a
2665 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2667 * @par Example of sending purges to multiple hosts:
2668 * @code
2669 * $wgHTCPRouting = array(
2670 * '' => array(
2671 * // Purges to text caches using multicast
2672 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2673 * // Purges to a hardcoded list of caches
2674 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2675 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2676 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2677 * ),
2678 * );
2679 * @endcode
2681 * @since 1.22
2683 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2684 * For back compatibility purposes, whenever its array is empty
2685 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2687 * @see $wgHTCPMulticastTTL
2689 $wgHTCPRouting = [];
2692 * HTCP multicast TTL.
2693 * @see $wgHTCPRouting
2695 $wgHTCPMulticastTTL = 1;
2698 * Should forwarded Private IPs be accepted?
2700 $wgUsePrivateIPs = false;
2702 /** @} */ # end of HTTP proxy settings
2704 /************************************************************************//**
2705 * @name Language, regional and character encoding settings
2706 * @{
2710 * Site language code. See languages/data/Names.php for languages supported by
2711 * MediaWiki out of the box. Not all languages listed there have translations,
2712 * see languages/messages/ for the list of languages with some localisation.
2714 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2715 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2717 * This defines the default interface language for all users, but users can
2718 * change it in their preferences.
2720 * This also defines the language of pages in the wiki. The content is wrapped
2721 * in a html element with lang=XX attribute. This behavior can be overridden
2722 * via hooks, see Title::getPageLanguage.
2724 $wgLanguageCode = 'en';
2727 * Language cache size, or really how many languages can we handle
2728 * simultaneously without degrading to crawl speed.
2730 $wgLangObjCacheSize = 10;
2733 * Some languages need different word forms, usually for different cases.
2734 * Used in Language::convertGrammar().
2736 * @par Example:
2737 * @code
2738 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2739 * @endcode
2741 $wgGrammarForms = [];
2744 * Treat language links as magic connectors, not inline links
2746 $wgInterwikiMagic = true;
2749 * Hide interlanguage links from the sidebar
2751 $wgHideInterlanguageLinks = false;
2754 * List of additional interwiki prefixes that should be treated as
2755 * interlanguage links (i.e. placed in the sidebar).
2756 * Notes:
2757 * - This will not do anything unless the prefixes are defined in the interwiki
2758 * map.
2759 * - The display text for these custom interlanguage links will be fetched from
2760 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2761 * this array.
2762 * - A friendly name for each site, used for tooltip text, may optionally be
2763 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2764 * the prefix in this array.
2766 $wgExtraInterlanguageLinkPrefixes = [];
2769 * List of language names or overrides for default names in Names.php
2771 $wgExtraLanguageNames = [];
2774 * List of language codes that don't correspond to an actual language.
2775 * These codes are mostly left-offs from renames, or other legacy things.
2776 * This array makes them not appear as a selectable language on the installer,
2777 * and excludes them when running the transstat.php script.
2779 $wgDummyLanguageCodes = [
2780 'als' => 'gsw',
2781 'bat-smg' => 'sgs',
2782 'be-x-old' => 'be-tarask',
2783 'bh' => 'bho',
2784 'fiu-vro' => 'vro',
2785 'no' => 'nb',
2786 'qqq' => 'qqq', # Used for message documentation.
2787 'qqx' => 'qqx', # Used for viewing message keys.
2788 'roa-rup' => 'rup',
2789 'simple' => 'en',
2790 'zh-classical' => 'lzh',
2791 'zh-min-nan' => 'nan',
2792 'zh-yue' => 'yue',
2796 * Character set for use in the article edit box. Language-specific encodings
2797 * may be defined.
2799 * This historic feature is one of the first that was added by former MediaWiki
2800 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2802 $wgEditEncoding = '';
2805 * Set this to true to replace Arabic presentation forms with their standard
2806 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2807 * set to "ar".
2809 * Note that pages with titles containing presentation forms will become
2810 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2812 $wgFixArabicUnicode = true;
2815 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2816 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2817 * set to "ml". Note that some clients (even new clients as of 2010) do not
2818 * support these characters.
2820 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2821 * fix any ZWJ sequences in existing page titles.
2823 $wgFixMalayalamUnicode = true;
2826 * Set this to always convert certain Unicode sequences to modern ones
2827 * regardless of the content language. This has a small performance
2828 * impact.
2830 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2831 * details.
2833 * @since 1.17
2835 $wgAllUnicodeFixes = false;
2838 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2839 * loading old revisions not marked with "utf-8" flag. Use this when
2840 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2841 * burdensome mass conversion of old text data.
2843 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2844 * user names, etc still must be converted en masse in the database before
2845 * continuing as a UTF-8 wiki.
2847 $wgLegacyEncoding = false;
2850 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2851 * regexps : "/regexp/" matching problematic browsers. These browsers will
2852 * be served encoded unicode in the edit box instead of real unicode.
2854 $wgBrowserBlackList = [
2856 * Netscape 2-4 detection
2857 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2858 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2859 * with a negative assertion. The [UIN] identifier specifies the level of security
2860 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2861 * The language string is unreliable, it is missing on NS4 Mac.
2863 * Reference: http://www.psychedelix.com/agents/index.shtml
2865 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2866 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2867 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2870 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2871 * Þ to <THORN> and Ð to <ETH>
2873 * Known useragents:
2874 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2875 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2876 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2877 * - [...]
2879 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2880 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2882 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2885 * Google wireless transcoder, seems to eat a lot of chars alive
2886 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2888 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2892 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2893 * create stub reference rows in the text table instead of copying
2894 * the full text of all current entries from 'cur' to 'text'.
2896 * This will speed up the conversion step for large sites, but
2897 * requires that the cur table be kept around for those revisions
2898 * to remain viewable.
2900 * This option affects the updaters *only*. Any present cur stub
2901 * revisions will be readable at runtime regardless of this setting.
2903 $wgLegacySchemaConversion = false;
2906 * Enable dates like 'May 12' instead of '12 May', if the default date format
2907 * is 'dmy or mdy'.
2909 $wgAmericanDates = false;
2912 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2913 * numerals in interface.
2915 $wgTranslateNumerals = true;
2918 * Translation using MediaWiki: namespace.
2919 * Interface messages will be loaded from the database.
2921 $wgUseDatabaseMessages = true;
2924 * Expiry time for the message cache key
2926 $wgMsgCacheExpiry = 86400;
2929 * Maximum entry size in the message cache, in bytes
2931 $wgMaxMsgCacheEntrySize = 10000;
2934 * Whether to enable language variant conversion.
2936 $wgDisableLangConversion = false;
2939 * Whether to enable language variant conversion for links.
2941 $wgDisableTitleConversion = false;
2944 * Default variant code, if false, the default will be the language code
2946 $wgDefaultLanguageVariant = false;
2949 * Disabled variants array of language variant conversion.
2951 * @par Example:
2952 * @code
2953 * $wgDisabledVariants[] = 'zh-mo';
2954 * $wgDisabledVariants[] = 'zh-my';
2955 * @endcode
2957 $wgDisabledVariants = [];
2960 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2961 * path format that describes which parts of the URL contain the
2962 * language variant.
2964 * @par Example:
2965 * @code
2966 * $wgLanguageCode = 'sr';
2967 * $wgVariantArticlePath = '/$2/$1';
2968 * $wgArticlePath = '/wiki/$1';
2969 * @endcode
2971 * A link to /wiki/ would be redirected to /sr/Главна_страна
2973 * It is important that $wgArticlePath not overlap with possible values
2974 * of $wgVariantArticlePath.
2976 $wgVariantArticlePath = false;
2979 * Show a bar of language selection links in the user login and user
2980 * registration forms; edit the "loginlanguagelinks" message to
2981 * customise these.
2983 $wgLoginLanguageSelector = false;
2986 * When translating messages with wfMessage(), it is not always clear what
2987 * should be considered UI messages and what should be content messages.
2989 * For example, for the English Wikipedia, there should be only one 'mainpage',
2990 * so when getting the link for 'mainpage', we should treat it as site content
2991 * and call ->inContentLanguage()->text(), but for rendering the text of the
2992 * link, we call ->text(). The code behaves this way by default. However,
2993 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2994 * and the like for different languages. This array provides a way to override
2995 * the default behavior.
2997 * @par Example:
2998 * To allow language-specific main page and community
2999 * portal:
3000 * @code
3001 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
3002 * @endcode
3004 $wgForceUIMsgAsContentMsg = [];
3007 * Fake out the timezone that the server thinks it's in. This will be used for
3008 * date display and not for what's stored in the DB. Leave to null to retain
3009 * your server's OS-based timezone value.
3011 * This variable is currently used only for signature formatting and for local
3012 * time/date parser variables ({{LOCALTIME}} etc.)
3014 * Timezones can be translated by editing MediaWiki messages of type
3015 * timezone-nameinlowercase like timezone-utc.
3017 * A list of usable timezones can found at:
3018 * http://php.net/manual/en/timezones.php
3020 * @par Examples:
3021 * @code
3022 * $wgLocaltimezone = 'UTC';
3023 * $wgLocaltimezone = 'GMT';
3024 * $wgLocaltimezone = 'PST8PDT';
3025 * $wgLocaltimezone = 'Europe/Sweden';
3026 * $wgLocaltimezone = 'CET';
3027 * @endcode
3029 $wgLocaltimezone = null;
3032 * Set an offset from UTC in minutes to use for the default timezone setting
3033 * for anonymous users and new user accounts.
3035 * This setting is used for most date/time displays in the software, and is
3036 * overridable in user preferences. It is *not* used for signature timestamps.
3038 * By default, this will be set to match $wgLocaltimezone.
3040 $wgLocalTZoffset = null;
3042 /** @} */ # End of language/charset settings
3044 /*************************************************************************//**
3045 * @name Output format and skin settings
3046 * @{
3050 * The default Content-Type header.
3052 $wgMimeType = 'text/html';
3055 * Previously used as content type in HTML script tags. This is now ignored since
3056 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3057 * It was also previously used by RawAction to determine the ctype query parameter
3058 * value that will result in a javascript response.
3059 * @deprecated since 1.22
3061 $wgJsMimeType = null;
3064 * The default xmlns attribute. The option to define this has been removed.
3065 * The value of this variable is no longer used by core and is set to a fixed
3066 * value in Setup.php for compatibility with extensions that depend on the value
3067 * of this variable being set. Such a dependency however is deprecated.
3068 * @deprecated since 1.22
3070 $wgXhtmlDefaultNamespace = null;
3073 * Previously used to determine if we should output an HTML5 doctype.
3074 * This is no longer used as we always output HTML5 now. For compatibility with
3075 * extensions that still check the value of this config it's value is now forced
3076 * to true by Setup.php.
3077 * @deprecated since 1.22
3079 $wgHtml5 = true;
3082 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
3084 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3085 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3086 * See also http://www.w3.org/TR/rdfa-in-html/#document-conformance
3087 * @since 1.16
3089 $wgHtml5Version = null;
3092 * Temporary variable that allows HTMLForms to be rendered as tables.
3093 * Table based layouts cause various issues when designing for mobile.
3094 * This global allows skins or extensions a means to force non-table based rendering.
3095 * Setting to false forces form components to always render as div elements.
3096 * @since 1.24
3098 $wgHTMLFormAllowTableFormat = true;
3101 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3102 * Temporary variable that should be removed when mediawiki ui is more
3103 * stable and change has been communicated.
3104 * @since 1.24
3106 $wgUseMediaWikiUIEverywhere = false;
3109 * Should we try to make our HTML output well-formed XML? If set to false,
3110 * output will be a few bytes shorter, and the HTML will arguably be more
3111 * readable. If set to true, life will be much easier for the authors of
3112 * screen-scraping bots, and the HTML will arguably be more readable.
3114 * Setting this to false may omit quotation marks on some attributes, omit
3115 * slashes from some self-closing tags, omit some ending tags, etc., where
3116 * permitted by HTML5. Setting it to true will not guarantee that all pages
3117 * will be well-formed, although non-well-formed pages should be rare and it's
3118 * a bug if you find one. Conversely, setting it to false doesn't mean that
3119 * all XML-y constructs will be omitted, just that they might be.
3121 * Because of compatibility with screen-scraping bots, and because it's
3122 * controversial, this is currently left to true by default.
3124 $wgWellFormedXml = true;
3127 * Permit other namespaces in addition to the w3.org default.
3129 * Use the prefix for the key and the namespace for the value.
3131 * @par Example:
3132 * @code
3133 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3134 * @endcode
3135 * Normally we wouldn't have to define this in the root "<html>"
3136 * element, but IE needs it there in some circumstances.
3138 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3140 $wgXhtmlNamespaces = [];
3143 * Site notice shown at the top of each page
3145 * MediaWiki:Sitenotice page, which will override this. You can also
3146 * provide a separate message for logged-out users using the
3147 * MediaWiki:Anonnotice page.
3149 $wgSiteNotice = '';
3152 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3154 $wgSiteSupportPage = '';
3157 * Validate the overall output using tidy and refuse
3158 * to display the page if it's not valid.
3160 $wgValidateAllHtml = false;
3163 * Default skin, for new users and anonymous visitors. Registered users may
3164 * change this to any one of the other available skins in their preferences.
3166 $wgDefaultSkin = 'vector';
3169 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3171 * @since 1.24
3173 $wgFallbackSkin = 'fallback';
3176 * Specify the names of skins that should not be presented in the list of
3177 * available skins in user preferences. If you want to remove a skin entirely,
3178 * remove it from the skins/ directory and its entry from LocalSettings.php.
3180 $wgSkipSkins = [];
3183 * @deprecated since 1.23; use $wgSkipSkins instead
3185 $wgSkipSkin = '';
3188 * Allow user Javascript page?
3189 * This enables a lot of neat customizations, but may
3190 * increase security risk to users and server load.
3192 $wgAllowUserJs = false;
3195 * Allow user Cascading Style Sheets (CSS)?
3196 * This enables a lot of neat customizations, but may
3197 * increase security risk to users and server load.
3199 $wgAllowUserCss = false;
3202 * Allow user-preferences implemented in CSS?
3203 * This allows users to customise the site appearance to a greater
3204 * degree; disabling it will improve page load times.
3206 $wgAllowUserCssPrefs = true;
3209 * Use the site's Javascript page?
3211 $wgUseSiteJs = true;
3214 * Use the site's Cascading Style Sheets (CSS)?
3216 $wgUseSiteCss = true;
3219 * Break out of framesets. This can be used to prevent clickjacking attacks,
3220 * or to prevent external sites from framing your site with ads.
3222 $wgBreakFrames = false;
3225 * The X-Frame-Options header to send on pages sensitive to clickjacking
3226 * attacks, such as edit pages. This prevents those pages from being displayed
3227 * in a frame or iframe. The options are:
3229 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3231 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3232 * to allow framing within a trusted domain. This is insecure if there
3233 * is a page on the same domain which allows framing of arbitrary URLs.
3235 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3236 * full compromise of local user accounts. Private wikis behind a
3237 * corporate firewall are especially vulnerable. This is not
3238 * recommended.
3240 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3241 * not just edit pages.
3243 $wgEditPageFrameOptions = 'DENY';
3246 * Disallow framing of API pages directly, by setting the X-Frame-Options
3247 * header. Since the API returns CSRF tokens, allowing the results to be
3248 * framed can compromise your user's account security.
3249 * Options are:
3250 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3251 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3252 * - false: Allow all framing.
3253 * Note: $wgBreakFrames will override this for human formatted API output.
3255 $wgApiFrameOptions = 'DENY';
3258 * Disable output compression (enabled by default if zlib is available)
3260 $wgDisableOutputCompression = false;
3263 * Should we allow a broader set of characters in id attributes, per HTML5? If
3264 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3265 * functionality is ready, it will be on by default with no option.
3267 * Currently this appears to work fine in all browsers, but it's disabled by
3268 * default because it normalizes id's a bit too aggressively, breaking preexisting
3269 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3271 $wgExperimentalHtmlIds = false;
3274 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3275 * You can add new icons to the built in copyright or poweredby, or you can create
3276 * a new block. Though note that you may need to add some custom css to get good styling
3277 * of new blocks in monobook. vector and modern should work without any special css.
3279 * $wgFooterIcons itself is a key/value array.
3280 * The key is the name of a block that the icons will be wrapped in. The final id varies
3281 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3282 * turns it into mw_poweredby.
3283 * The value is either key/value array of icons or a string.
3284 * In the key/value array the key may or may not be used by the skin but it can
3285 * be used to find the icon and unset it or change the icon if needed.
3286 * This is useful for disabling icons that are set by extensions.
3287 * The value should be either a string or an array. If it is a string it will be output
3288 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3289 * for the icon, the following keys are used:
3290 * - src: An absolute url to the image to use for the icon, this is recommended
3291 * but not required, however some skins will ignore icons without an image
3292 * - srcset: optional additional-resolution images; see HTML5 specs
3293 * - url: The url to use in the a element around the text or icon, if not set an a element will
3294 * not be outputted
3295 * - alt: This is the text form of the icon, it will be displayed without an image in
3296 * skins like Modern or if src is not set, and will otherwise be used as
3297 * the alt="" for the image. This key is required.
3298 * - width and height: If the icon specified by src is not of the standard size
3299 * you can specify the size of image to use with these keys.
3300 * Otherwise they will default to the standard 88x31.
3301 * @todo Reformat documentation.
3303 $wgFooterIcons = [
3304 "copyright" => [
3305 "copyright" => [], // placeholder for the built in copyright icon
3307 "poweredby" => [
3308 "mediawiki" => [
3309 // Defaults to point at
3310 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3311 // plus srcset for 1.5x, 2x resolution variants.
3312 "src" => null,
3313 "url" => "//www.mediawiki.org/",
3314 "alt" => "Powered by MediaWiki",
3320 * Login / create account link behavior when it's possible for anonymous users
3321 * to create an account.
3322 * - true = use a combined login / create account link
3323 * - false = split login and create account into two separate links
3325 $wgUseCombinedLoginLink = false;
3328 * Display user edit counts in various prominent places.
3330 $wgEdititis = false;
3333 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3334 * status code, mangling or hiding MediaWiki's output. If you are using such a
3335 * host, you should start looking for a better one. While you're doing that,
3336 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3337 * that the generated error pages can be seen.
3339 * In cases where for technical reasons it is more important for MediaWiki to
3340 * send the correct status code than for the body to be transmitted intact,
3341 * this configuration variable is ignored.
3343 $wgSend404Code = true;
3346 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3347 * The numeric value of the variable controls how many edits MediaWiki will look back to
3348 * determine whether a rollback is allowed (by checking that they are all from the same author).
3349 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3350 * from hiding some useless rollback links.
3352 * @since 1.20
3354 $wgShowRollbackEditCount = 10;
3357 * Output a <link rel="canonical"> tag on every page indicating the canonical
3358 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3359 * detection of the current server is unreliable, the link is sent
3360 * unconditionally.
3362 $wgEnableCanonicalServerLink = false;
3365 * When OutputHandler is used, mangle any output that contains
3366 * <cross-domain-policy>. Without this, an attacker can send their own
3367 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3368 * the domain root.
3370 * @since 1.25
3372 $wgMangleFlashPolicy = true;
3374 /** @} */ # End of output format settings }
3376 /*************************************************************************//**
3377 * @name ResourceLoader settings
3378 * @{
3382 * Client-side resource modules.
3384 * Extensions should add their ResourceLoader module definitions
3385 * to the $wgResourceModules variable.
3387 * @par Example:
3388 * @code
3389 * $wgResourceModules['ext.myExtension'] = array(
3390 * 'scripts' => 'myExtension.js',
3391 * 'styles' => 'myExtension.css',
3392 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3393 * 'localBasePath' => __DIR__,
3394 * 'remoteExtPath' => 'MyExtension',
3395 * );
3396 * @endcode
3398 $wgResourceModules = [];
3401 * Skin-specific styles for resource modules.
3403 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3404 * not be modified or disabled.
3406 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3408 * @par Example:
3409 * @code
3410 * $wgResourceModules['bar'] = array(
3411 * 'scripts' => 'resources/bar/bar.js',
3412 * 'styles' => 'resources/bar/main.css',
3413 * );
3415 * $wgResourceModuleSkinStyles['foo'] = array(
3416 * 'bar' => 'skins/Foo/bar.css',
3417 * );
3418 * @endcode
3420 * This is mostly equivalent to:
3422 * @par Equivalent:
3423 * @code
3424 * $wgResourceModules['bar'] = array(
3425 * 'scripts' => 'resources/bar/bar.js',
3426 * 'styles' => 'resources/bar/main.css',
3427 * 'skinStyles' => array(
3428 * 'foo' => skins/Foo/bar.css',
3429 * ),
3430 * );
3431 * @endcode
3433 * If the module already defines its own entry in `skinStyles` for a given skin, then
3434 * $wgResourceModuleSkinStyles is ignored.
3436 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3437 * of replacing them. This can be done using the `+` prefix.
3439 * @par Example:
3440 * @code
3441 * $wgResourceModules['bar'] = array(
3442 * 'scripts' => 'resources/bar/bar.js',
3443 * 'styles' => 'resources/bar/basic.css',
3444 * 'skinStyles' => array(
3445 * 'default' => 'resources/bar/additional.css',
3446 * ),
3447 * );
3448 * // Note the '+' character:
3449 * $wgResourceModuleSkinStyles['foo'] = array(
3450 * '+bar' => 'skins/Foo/bar.css',
3451 * );
3452 * @endcode
3454 * This is mostly equivalent to:
3456 * @par Equivalent:
3457 * @code
3458 * $wgResourceModules['bar'] = array(
3459 * 'scripts' => 'resources/bar/bar.js',
3460 * 'styles' => 'resources/bar/basic.css',
3461 * 'skinStyles' => array(
3462 * 'default' => 'resources/bar/additional.css',
3463 * 'foo' => array(
3464 * 'resources/bar/additional.css',
3465 * 'skins/Foo/bar.css',
3466 * ),
3467 * ),
3468 * );
3469 * @endcode
3471 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3472 * disabled by a skin. To provide default styles that may be extended or replaced,
3473 * use `skinStyles['default']`.
3475 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3476 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3478 * @par Example:
3479 * @code
3480 * $wgResourceModuleSkinStyles['foo'] = array(
3481 * 'bar' => 'bar.css',
3482 * 'quux' => 'quux.css',
3483 * 'remoteSkinPath' => 'Foo',
3484 * 'localBasePath' => __DIR__,
3485 * );
3486 * @endcode
3488 $wgResourceModuleSkinStyles = [];
3491 * Extensions should register foreign module sources here. 'local' is a
3492 * built-in source that is not in this array, but defined by
3493 * ResourceLoader::__construct() so that it cannot be unset.
3495 * @par Example:
3496 * @code
3497 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3498 * @endcode
3500 $wgResourceLoaderSources = [];
3503 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3504 * Defaults to $wgScriptPath.
3506 $wgResourceBasePath = null;
3509 * Maximum time in seconds to cache resources served by ResourceLoader.
3510 * Used to set last modified headers (max-age/s-maxage).
3512 * Following options to distinguish:
3513 * - versioned: Used for modules with a version, because changing version
3514 * numbers causes cache misses. This normally has a long expiry time.
3515 * - unversioned: Used for modules without a version to propagate changes
3516 * quickly to clients. Also used for modules with errors to recover quickly.
3517 * This normally has a short expiry time.
3519 * Expiry time for the options to distinguish:
3520 * - server: Squid/Varnish but also any other public proxy cache between the
3521 * client and MediaWiki.
3522 * - client: On the client side (e.g. in the browser cache).
3524 $wgResourceLoaderMaxage = [
3525 'versioned' => [
3526 'server' => 30 * 24 * 60 * 60, // 30 days
3527 'client' => 30 * 24 * 60 * 60, // 30 days
3529 'unversioned' => [
3530 'server' => 5 * 60, // 5 minutes
3531 'client' => 5 * 60, // 5 minutes
3536 * The default debug mode (on/off) for of ResourceLoader requests.
3538 * This will still be overridden when the debug URL parameter is used.
3540 $wgResourceLoaderDebug = false;
3543 * Put each statement on its own line when minifying JavaScript. This makes
3544 * debugging in non-debug mode a bit easier.
3546 * @deprecated since 1.27: Always false; no longer configurable.
3548 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3551 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3552 * the minifier will try not to produce lines longer than this, but may be
3553 * forced to do so in certain cases.
3555 * @deprecated since 1.27: Always 1,000; no longer configurable.
3557 $wgResourceLoaderMinifierMaxLineLength = 1000;
3560 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3562 * @deprecated since 1.26: Always declare dependencies.
3564 $wgIncludeLegacyJavaScript = false;
3567 * Whether or not to assign configuration variables to the global window object.
3569 * If this is set to false, old code using deprecated variables will no longer
3570 * work.
3572 * @par Example of legacy code:
3573 * @code{,js}
3574 * if ( window.wgRestrictionEdit ) { ... }
3575 * @endcode
3576 * or:
3577 * @code{,js}
3578 * if ( wgIsArticle ) { ... }
3579 * @endcode
3581 * Instead, one needs to use mw.config.
3582 * @par Example using mw.config global configuration:
3583 * @code{,js}
3584 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3585 * @endcode
3586 * or:
3587 * @code{,js}
3588 * if ( mw.config.get('wgIsArticle') ) { ... }
3589 * @endcode
3591 $wgLegacyJavaScriptGlobals = true;
3594 * If set to a positive number, ResourceLoader will not generate URLs whose
3595 * query string is more than this many characters long, and will instead use
3596 * multiple requests with shorter query strings. This degrades performance,
3597 * but may be needed if your web server has a low (less than, say 1024)
3598 * query string length limit or a low value for suhosin.get.max_value_length
3599 * that you can't increase.
3601 * If set to a negative number, ResourceLoader will assume there is no query
3602 * string length limit.
3604 * Defaults to a value based on php configuration.
3606 $wgResourceLoaderMaxQueryLength = false;
3609 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3610 * prior to minification to validate it.
3612 * Parse errors will result in a JS exception being thrown during module load,
3613 * which avoids breaking other modules loaded in the same request.
3615 $wgResourceLoaderValidateJS = true;
3618 * If set to true, statically-sourced (file-backed) JavaScript resources will
3619 * be parsed for validity before being bundled up into ResourceLoader modules.
3621 * This can be helpful for development by providing better error messages in
3622 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3623 * and may fail on large pre-bundled frameworks.
3625 $wgResourceLoaderValidateStaticJS = false;
3628 * Global LESS variables. An associative array binding variable names to
3629 * LESS code snippets representing their values.
3631 * Adding an item here is equivalent to writing `@variable: value;`
3632 * at the beginning of all your .less files, with all the consequences.
3633 * In particular, string values must be escaped and quoted.
3635 * Changes to LESS variables do not trigger cache invalidation.
3637 * If the LESS variables need to be dynamic, you can use the
3638 * ResourceLoaderGetLessVars hook (since 1.25).
3640 * @par Example:
3641 * @code
3642 * $wgResourceLoaderLESSVars = array(
3643 * 'baseFontSize' => '1em',
3644 * 'smallFontSize' => '0.75em',
3645 * 'WikimediaBlue' => '#006699',
3646 * );
3647 * @endcode
3648 * @since 1.22
3650 $wgResourceLoaderLESSVars = [
3652 * Minimum available screen width at which a device can be considered a tablet/desktop
3653 * The number is currently based on the device width of a Samsung Galaxy S5 mini and is low
3654 * enough to cover iPad (768px). Number is prone to change with new information.
3655 * @since 1.27
3657 'deviceWidthTablet' => '720px',
3661 * Default import paths for LESS modules. LESS files referenced in @import
3662 * statements will be looked up here first, and relative to the importing file
3663 * second. To avoid collisions, it's important for the LESS files in these
3664 * directories to have a common, predictable file name prefix.
3666 * Extensions need not (and should not) register paths in
3667 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3668 * currently compiling LESS file, which allows each extension to freely import
3669 * files from its own tree.
3671 * @since 1.22
3673 $wgResourceLoaderLESSImportPaths = [
3674 "$IP/resources/src/mediawiki.less/",
3678 * Whether ResourceLoader should attempt to persist modules in localStorage on
3679 * browsers that support the Web Storage API.
3681 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3683 $wgResourceLoaderStorageEnabled = false;
3686 * Cache version for client-side ResourceLoader module storage. You can trigger
3687 * invalidation of the contents of the module store by incrementing this value.
3689 * @since 1.23
3691 $wgResourceLoaderStorageVersion = 1;
3694 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3695 * restricted pages like Special:UserLogin or Special:Preferences where
3696 * JavaScript is disabled for security reasons. As it is possible to
3697 * execute JavaScript through CSS, setting this to true opens up a
3698 * potential security hole. Some sites may "skin" their wiki by using
3699 * site-wide CSS, causing restricted pages to look unstyled and different
3700 * from the rest of the site.
3702 * @since 1.25
3704 $wgAllowSiteCSSOnRestrictedPages = false;
3706 /** @} */ # End of ResourceLoader settings }
3708 /*************************************************************************//**
3709 * @name Page title and interwiki link settings
3710 * @{
3714 * Name of the project namespace. If left set to false, $wgSitename will be
3715 * used instead.
3717 $wgMetaNamespace = false;
3720 * Name of the project talk namespace.
3722 * Normally you can ignore this and it will be something like
3723 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3724 * manually for grammatical reasons.
3726 $wgMetaNamespaceTalk = false;
3729 * Additional namespaces. If the namespaces defined in Language.php and
3730 * Namespace.php are insufficient, you can create new ones here, for example,
3731 * to import Help files in other languages. You can also override the namespace
3732 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3733 * hook or extension.json.
3735 * @warning Once you delete a namespace, the pages in that namespace will
3736 * no longer be accessible. If you rename it, then you can access them through
3737 * the new namespace name.
3739 * Custom namespaces should start at 100 to avoid conflicting with standard
3740 * namespaces, and should always follow the even/odd main/talk pattern.
3742 * @par Example:
3743 * @code
3744 * $wgExtraNamespaces = array(
3745 * 100 => "Hilfe",
3746 * 101 => "Hilfe_Diskussion",
3747 * 102 => "Aide",
3748 * 103 => "Discussion_Aide"
3749 * );
3750 * @endcode
3752 * @todo Add a note about maintenance/namespaceDupes.php
3754 $wgExtraNamespaces = [];
3757 * Same as above, but for namespaces with gender distinction.
3758 * Note: the default form for the namespace should also be set
3759 * using $wgExtraNamespaces for the same index.
3760 * @since 1.18
3762 $wgExtraGenderNamespaces = [];
3765 * Namespace aliases.
3767 * These are alternate names for the primary localised namespace names, which
3768 * are defined by $wgExtraNamespaces and the language file. If a page is
3769 * requested with such a prefix, the request will be redirected to the primary
3770 * name.
3772 * Set this to a map from namespace names to IDs.
3774 * @par Example:
3775 * @code
3776 * $wgNamespaceAliases = array(
3777 * 'Wikipedian' => NS_USER,
3778 * 'Help' => 100,
3779 * );
3780 * @endcode
3782 $wgNamespaceAliases = [];
3785 * Allowed title characters -- regex character class
3786 * Don't change this unless you know what you're doing
3788 * Problematic punctuation:
3789 * - []{}|# Are needed for link syntax, never enable these
3790 * - <> Causes problems with HTML escaping, don't use
3791 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3792 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3793 * corrupted by apache
3794 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3796 * All three of these punctuation problems can be avoided by using an alias,
3797 * instead of a rewrite rule of either variety.
3799 * The problem with % is that when using a path to query rewrite rule, URLs are
3800 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3801 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3802 * for this, indeed double escaping would break if the double-escaped title was
3803 * passed in the query string rather than the path. This is a minor security issue
3804 * because articles can be created such that they are hard to view or edit.
3806 * In some rare cases you may wish to remove + for compatibility with old links.
3808 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3809 * this breaks interlanguage links
3811 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3814 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3816 * @deprecated since 1.23; use $wgLocalInterwikis instead
3818 $wgLocalInterwiki = false;
3821 * Array for multiple $wgLocalInterwiki values, in case there are several
3822 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3823 * set, its value is prepended to this array, for backwards compatibility.
3825 * Note, recent changes feeds use only the first entry in this array (or
3826 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3828 $wgLocalInterwikis = [];
3831 * Expiry time for cache of interwiki table
3833 $wgInterwikiExpiry = 10800;
3836 * @name Interwiki caching settings.
3837 * @{
3841 * Interwiki cache, either as an associative array or a path to a constant
3842 * database (.cdb) file.
3844 * This data structure database is generated by the `dumpInterwiki` maintenance
3845 * script (which lives in the WikimediaMaintenance repository) and has key
3846 * formats such as the following:
3848 * - dbname:key - a simple key (e.g. enwiki:meta)
3849 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3850 * - __global:key - global-scope key (e.g. __global:meta)
3851 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3853 * Sites mapping just specifies site name, other keys provide "local url"
3854 * data layout.
3856 * @var bool|array|string
3858 $wgInterwikiCache = false;
3861 * Specify number of domains to check for messages.
3862 * - 1: Just wiki(db)-level
3863 * - 2: wiki and global levels
3864 * - 3: site levels
3866 $wgInterwikiScopes = 3;
3869 * Fallback site, if unable to resolve from cache
3871 $wgInterwikiFallbackSite = 'wiki';
3873 /** @} */ # end of Interwiki caching settings.
3876 * @name SiteStore caching settings.
3877 * @{
3881 * Specify the file location for the Sites json cache file.
3883 $wgSitesCacheFile = false;
3885 /** @} */ # end of SiteStore caching settings.
3888 * If local interwikis are set up which allow redirects,
3889 * set this regexp to restrict URLs which will be displayed
3890 * as 'redirected from' links.
3892 * @par Example:
3893 * It might look something like this:
3894 * @code
3895 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3896 * @endcode
3898 * Leave at false to avoid displaying any incoming redirect markers.
3899 * This does not affect intra-wiki redirects, which don't change
3900 * the URL.
3902 $wgRedirectSources = false;
3905 * Set this to false to avoid forcing the first letter of links to capitals.
3907 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3908 * appearing with a capital at the beginning of a sentence will *not* go to the
3909 * same place as links in the middle of a sentence using a lowercase initial.
3911 $wgCapitalLinks = true;
3914 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3915 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3916 * true by default (and setting them has no effect), due to various things that
3917 * require them to be so. Also, since Talk namespaces need to directly mirror their
3918 * associated content namespaces, the values for those are ignored in favor of the
3919 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3920 * NS_FILE.
3922 * @par Example:
3923 * @code
3924 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3925 * @endcode
3927 $wgCapitalLinkOverrides = [];
3930 * Which namespaces should support subpages?
3931 * See Language.php for a list of namespaces.
3933 $wgNamespacesWithSubpages = [
3934 NS_TALK => true,
3935 NS_USER => true,
3936 NS_USER_TALK => true,
3937 NS_PROJECT => true,
3938 NS_PROJECT_TALK => true,
3939 NS_FILE_TALK => true,
3940 NS_MEDIAWIKI => true,
3941 NS_MEDIAWIKI_TALK => true,
3942 NS_TEMPLATE_TALK => true,
3943 NS_HELP => true,
3944 NS_HELP_TALK => true,
3945 NS_CATEGORY_TALK => true
3949 * Array holding default tracking category names.
3951 * Array contains the system messages for each tracking category.
3952 * Tracking categories allow pages with certain characteristics to be tracked.
3953 * It works by adding any such page to a category automatically.
3955 * A message with the suffix '-desc' should be added as a description message
3956 * to have extra information on Special:TrackingCategories.
3958 * @deprecated since 1.25 Extensions should now register tracking categories using
3959 * the new extension registration system.
3961 * @since 1.23
3963 $wgTrackingCategories = [];
3966 * Array of namespaces which can be deemed to contain valid "content", as far
3967 * as the site statistics are concerned. Useful if additional namespaces also
3968 * contain "content" which should be considered when generating a count of the
3969 * number of articles in the wiki.
3971 $wgContentNamespaces = [ NS_MAIN ];
3974 * Array of namespaces, in addition to the talk namespaces, where signatures
3975 * (~~~~) are likely to be used. This determines whether to display the
3976 * Signature button on the edit toolbar, and may also be used by extensions.
3977 * For example, "traditional" style wikis, where content and discussion are
3978 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
3980 $wgExtraSignatureNamespaces = [];
3983 * Max number of redirects to follow when resolving redirects.
3984 * 1 means only the first redirect is followed (default behavior).
3985 * 0 or less means no redirects are followed.
3987 $wgMaxRedirects = 1;
3990 * Array of invalid page redirect targets.
3991 * Attempting to create a redirect to any of the pages in this array
3992 * will make the redirect fail.
3993 * Userlogout is hard-coded, so it does not need to be listed here.
3994 * (bug 10569) Disallow Mypage and Mytalk as well.
3996 * As of now, this only checks special pages. Redirects to pages in
3997 * other namespaces cannot be invalidated by this variable.
3999 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ];
4001 /** @} */ # End of title and interwiki settings }
4003 /************************************************************************//**
4004 * @name Parser settings
4005 * These settings configure the transformation from wikitext to HTML.
4006 * @{
4010 * Parser configuration. Associative array with the following members:
4012 * class The class name
4014 * preprocessorClass The preprocessor class. Two classes are currently available:
4015 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4016 * storage, and Preprocessor_DOM, which uses the DOM module for
4017 * temporary storage. Preprocessor_DOM generally uses less memory;
4018 * the speed of the two is roughly the same.
4020 * If this parameter is not given, it uses Preprocessor_DOM if the
4021 * DOM module is available, otherwise it uses Preprocessor_Hash.
4023 * The entire associative array will be passed through to the constructor as
4024 * the first parameter. Note that only Setup.php can use this variable --
4025 * the configuration will change at runtime via $wgParser member functions, so
4026 * the contents of this variable will be out-of-date. The variable can only be
4027 * changed during LocalSettings.php, in particular, it can't be changed during
4028 * an extension setup function.
4030 $wgParserConf = [
4031 'class' => 'Parser',
4032 # 'preprocessorClass' => 'Preprocessor_Hash',
4036 * Maximum indent level of toc.
4038 $wgMaxTocLevel = 999;
4041 * A complexity limit on template expansion: the maximum number of nodes visited
4042 * by PPFrame::expand()
4044 $wgMaxPPNodeCount = 1000000;
4047 * A complexity limit on template expansion: the maximum number of elements
4048 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4049 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4050 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4051 * this default corresponds to about 155 MB.
4053 * When the limit is exceeded, an exception is thrown.
4055 $wgMaxGeneratedPPNodeCount = 1000000;
4058 * Maximum recursion depth for templates within templates.
4059 * The current parser adds two levels to the PHP call stack for each template,
4060 * and xdebug limits the call stack to 100 by default. So this should hopefully
4061 * stop the parser before it hits the xdebug limit.
4063 $wgMaxTemplateDepth = 40;
4066 * @see $wgMaxTemplateDepth
4068 $wgMaxPPExpandDepth = 40;
4071 * URL schemes that should be recognized as valid by wfParseUrl().
4073 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4074 * Instead, if you want to support file links, add 'file://'. The same applies
4075 * to any other protocols with the same name as a namespace. See bug #44011 for
4076 * more information.
4078 * @see wfParseUrl
4080 $wgUrlProtocols = [
4081 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4082 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4083 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4084 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4088 * If true, removes (by substituting) templates in signatures.
4090 $wgCleanSignatures = true;
4093 * Whether to allow inline image pointing to other websites
4095 $wgAllowExternalImages = false;
4098 * If the above is false, you can specify an exception here. Image URLs
4099 * that start with this string are then rendered, while all others are not.
4100 * You can use this to set up a trusted, simple repository of images.
4101 * You may also specify an array of strings to allow multiple sites
4103 * @par Examples:
4104 * @code
4105 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4106 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4107 * @endcode
4109 $wgAllowExternalImagesFrom = '';
4112 * If $wgAllowExternalImages is false, you can allow an on-wiki
4113 * whitelist of regular expression fragments to match the image URL
4114 * against. If the image matches one of the regular expression fragments,
4115 * The image will be displayed.
4117 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4118 * Or false to disable it
4120 $wgEnableImageWhitelist = true;
4123 * A different approach to the above: simply allow the "<img>" tag to be used.
4124 * This allows you to specify alt text and other attributes, copy-paste HTML to
4125 * your wiki more easily, etc. However, allowing external images in any manner
4126 * will allow anyone with editing rights to snoop on your visitors' IP
4127 * addresses and so forth, if they wanted to, by inserting links to images on
4128 * sites they control.
4130 $wgAllowImageTag = false;
4133 * Configuration for HTML postprocessing tool. Set this to a configuration
4134 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4135 * used. See http://www.w3.org/People/Raggett/tidy/
4137 * If this is null and $wgUseTidy is true, the deprecated configuration
4138 * parameters will be used instead.
4140 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4142 * Keys are:
4143 * - driver: May be:
4144 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4145 * - RaggettInternalPHP: Use the PECL extension
4146 * - RaggettExternal: Shell out to an external binary (tidyBin)
4148 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4149 * - debugComment: True to add a comment to the output with warning messages
4150 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4151 * - tidyCommandLine: For RaggettExternal, additional command line options.
4153 $wgTidyConfig = null;
4156 * Set this to true to use the deprecated tidy configuration parameters.
4157 * @deprecated use $wgTidyConfig
4159 $wgUseTidy = false;
4162 * The path to the tidy binary.
4163 * @deprecated Use $wgTidyConfig['tidyBin']
4165 $wgTidyBin = 'tidy';
4168 * The path to the tidy config file
4169 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4171 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4174 * The command line options to the tidy binary
4175 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4177 $wgTidyOpts = '';
4180 * Set this to true to use the tidy extension
4181 * @deprecated Use $wgTidyConfig['driver']
4183 $wgTidyInternal = extension_loaded( 'tidy' );
4186 * Put tidy warnings in HTML comments
4187 * Only works for internal tidy.
4189 $wgDebugTidy = false;
4192 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4193 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4194 * TO RESTRICT EDITING to only those that you trust
4196 $wgRawHtml = false;
4199 * Set a default target for external links, e.g. _blank to pop up a new window
4201 $wgExternalLinkTarget = false;
4204 * If true, external URL links in wiki text will be given the
4205 * rel="nofollow" attribute as a hint to search engines that
4206 * they should not be followed for ranking purposes as they
4207 * are user-supplied and thus subject to spamming.
4209 $wgNoFollowLinks = true;
4212 * Namespaces in which $wgNoFollowLinks doesn't apply.
4213 * See Language.php for a list of namespaces.
4215 $wgNoFollowNsExceptions = [];
4218 * If this is set to an array of domains, external links to these domain names
4219 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4220 * value of $wgNoFollowLinks. For instance:
4222 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4223 * 'mediawiki.org' );
4225 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4226 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4227 * etc.
4229 * Defaults to mediawiki.org for the links included in the software by default.
4231 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ];
4234 * Allow DISPLAYTITLE to change title display
4236 $wgAllowDisplayTitle = true;
4239 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4240 * canonical DB key. Also disallow some inline CSS rules like display: none;
4241 * which can cause the text to be hidden or unselectable.
4243 $wgRestrictDisplayTitle = true;
4246 * Maximum number of calls per parse to expensive parser functions such as
4247 * PAGESINCATEGORY.
4249 $wgExpensiveParserFunctionLimit = 100;
4252 * Preprocessor caching threshold
4253 * Setting it to 'false' will disable the preprocessor cache.
4255 $wgPreprocessorCacheThreshold = 1000;
4258 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4260 $wgEnableScaryTranscluding = false;
4263 * Expiry time for transcluded templates cached in transcache database table.
4264 * Only used $wgEnableInterwikiTranscluding is set to true.
4266 $wgTranscludeCacheExpiry = 3600;
4268 /** @} */ # end of parser settings }
4270 /************************************************************************//**
4271 * @name Statistics
4272 * @{
4276 * Method used to determine if a page in a content namespace should be counted
4277 * as a valid article.
4279 * Redirect pages will never be counted as valid articles.
4281 * This variable can have the following values:
4282 * - 'any': all pages as considered as valid articles
4283 * - 'comma': the page must contain a comma to be considered valid
4284 * - 'link': the page must contain a [[wiki link]] to be considered valid
4286 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4288 * Retroactively changing this variable will not affect the existing count,
4289 * to update it, you will need to run the maintenance/updateArticleCount.php
4290 * script.
4292 $wgArticleCountMethod = 'link';
4295 * How many days user must be idle before he is considered inactive. Will affect
4296 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4297 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4298 * You might want to leave this as the default value, to provide comparable
4299 * numbers between different wikis.
4301 $wgActiveUserDays = 30;
4303 /** @} */ # End of statistics }
4305 /************************************************************************//**
4306 * @name User accounts, authentication
4307 * @{
4311 * Central ID lookup providers
4312 * Key is the provider ID, value is a specification for ObjectFactory
4313 * @since 1.27
4315 $wgCentralIdLookupProviders = [
4316 'local' => [ 'class' => 'LocalIdLookup' ],
4320 * Central ID lookup provider to use by default
4321 * @var string
4323 $wgCentralIdLookupProvider = 'local';
4326 * Password policy for local wiki users. A user's effective policy
4327 * is the superset of all policy statements from the policies for the
4328 * groups where the user is a member. If more than one group policy
4329 * include the same policy statement, the value is the max() of the
4330 * values. Note true > false. The 'default' policy group is required,
4331 * and serves as the minimum policy for all users. New statements can
4332 * be added by appending to $wgPasswordPolicy['checks'].
4333 * Statements:
4334 * - MinimalPasswordLength - minimum length a user can set
4335 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4336 * not be allowed to login, regardless if it is correct.
4337 * - MaximalPasswordLength - maximum length password a user is allowed
4338 * to attempt. Prevents DoS attacks with pbkdf2.
4339 * - PasswordCannotMatchUsername - Password cannot match username to
4340 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4341 * match a specific, hardcoded blacklist.
4342 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4343 * commonly chosen. Set to integer n to ban the top n passwords.
4344 * If you want to ban all common passwords on file, use the
4345 * PHP_INT_MAX constant.
4346 * @since 1.26
4348 $wgPasswordPolicy = [
4349 'policies' => [
4350 'bureaucrat' => [
4351 'MinimalPasswordLength' => 8,
4352 'MinimumPasswordLengthToLogin' => 1,
4353 'PasswordCannotMatchUsername' => true,
4354 'PasswordCannotBePopular' => 25,
4356 'sysop' => [
4357 'MinimalPasswordLength' => 8,
4358 'MinimumPasswordLengthToLogin' => 1,
4359 'PasswordCannotMatchUsername' => true,
4360 'PasswordCannotBePopular' => 25,
4362 'bot' => [
4363 'MinimalPasswordLength' => 8,
4364 'MinimumPasswordLengthToLogin' => 1,
4365 'PasswordCannotMatchUsername' => true,
4367 'default' => [
4368 'MinimalPasswordLength' => 1,
4369 'PasswordCannotMatchUsername' => true,
4370 'PasswordCannotMatchBlacklist' => true,
4371 'MaximalPasswordLength' => 4096,
4374 'checks' => [
4375 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4376 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4377 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4378 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4379 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4380 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist'
4385 * For compatibility with old installations set to false
4386 * @deprecated since 1.24 will be removed in future
4388 $wgPasswordSalt = true;
4391 * Specifies the minimal length of a user password. If set to 0, empty pass-
4392 * words are allowed.
4393 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4395 $wgMinimalPasswordLength = false;
4398 * Specifies the maximal length of a user password (T64685).
4400 * It is not recommended to make this greater than the default, as it can
4401 * allow DoS attacks by users setting really long passwords. In addition,
4402 * this should not be lowered too much, as it enforces weak passwords.
4404 * @warning Unlike other password settings, user with passwords greater than
4405 * the maximum will not be able to log in.
4406 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4408 $wgMaximalPasswordLength = false;
4411 * Specifies if users should be sent to a password-reset form on login, if their
4412 * password doesn't meet the requirements of User::isValidPassword().
4413 * @since 1.23
4415 $wgInvalidPasswordReset = true;
4418 * Default password type to use when hashing user passwords
4420 * @since 1.24
4422 $wgPasswordDefault = 'pbkdf2';
4425 * Configuration for built-in password types. Maps the password type
4426 * to an array of options. The 'class' option is the Password class to
4427 * use. All other options are class-dependent.
4429 * An advanced example:
4430 * @code
4431 * $wgPasswordConfig['bcrypt-peppered'] = array(
4432 * 'class' => 'EncryptedPassword',
4433 * 'underlying' => 'bcrypt',
4434 * 'secrets' => array(),
4435 * 'cipher' => MCRYPT_RIJNDAEL_256,
4436 * 'mode' => MCRYPT_MODE_CBC,
4437 * 'cost' => 5,
4438 * );
4439 * @endcode
4441 * @since 1.24
4443 $wgPasswordConfig = [
4444 'A' => [
4445 'class' => 'MWOldPassword',
4447 'B' => [
4448 'class' => 'MWSaltedPassword',
4450 'pbkdf2-legacyA' => [
4451 'class' => 'LayeredParameterizedPassword',
4452 'types' => [
4453 'A',
4454 'pbkdf2',
4457 'pbkdf2-legacyB' => [
4458 'class' => 'LayeredParameterizedPassword',
4459 'types' => [
4460 'B',
4461 'pbkdf2',
4464 'bcrypt' => [
4465 'class' => 'BcryptPassword',
4466 'cost' => 9,
4468 'pbkdf2' => [
4469 'class' => 'Pbkdf2Password',
4470 'algo' => 'sha256',
4471 'cost' => '10000',
4472 'length' => '128',
4477 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4478 * with a temporary password you can use to get back into the account") identified by
4479 * various bits of data. Setting all of these to false (or the whole variable to false)
4480 * has the effect of disabling password resets entirely
4482 $wgPasswordResetRoutes = [
4483 'username' => true,
4484 'email' => true,
4488 * Maximum number of Unicode characters in signature
4490 $wgMaxSigChars = 255;
4493 * Maximum number of bytes in username. You want to run the maintenance
4494 * script ./maintenance/checkUsernames.php once you have changed this value.
4496 $wgMaxNameChars = 255;
4499 * Array of usernames which may not be registered or logged in from
4500 * Maintenance scripts can still use these
4502 $wgReservedUsernames = [
4503 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4504 'Conversion script', // Used for the old Wikipedia software upgrade
4505 'Maintenance script', // Maintenance scripts which perform editing, image import script
4506 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4507 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4508 'msg:double-redirect-fixer', // Automatic double redirect fix
4509 'msg:usermessage-editor', // Default user for leaving user messages
4510 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4511 'msg:spambot_username', // Used by cleanupSpam.php
4512 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4516 * Settings added to this array will override the default globals for the user
4517 * preferences used by anonymous visitors and newly created accounts.
4518 * For instance, to disable editing on double clicks:
4519 * $wgDefaultUserOptions ['editondblclick'] = 0;
4521 $wgDefaultUserOptions = [
4522 'ccmeonemails' => 0,
4523 'cols' => 80,
4524 'date' => 'default',
4525 'diffonly' => 0,
4526 'disablemail' => 0,
4527 'editfont' => 'default',
4528 'editondblclick' => 0,
4529 'editsectiononrightclick' => 0,
4530 'enotifminoredits' => 0,
4531 'enotifrevealaddr' => 0,
4532 'enotifusertalkpages' => 1,
4533 'enotifwatchlistpages' => 1,
4534 'extendwatchlist' => 1,
4535 'fancysig' => 0,
4536 'forceeditsummary' => 0,
4537 'gender' => 'unknown',
4538 'hideminor' => 0,
4539 'hidepatrolled' => 0,
4540 'hidecategorization' => 1,
4541 'imagesize' => 2,
4542 'math' => 1,
4543 'minordefault' => 0,
4544 'newpageshidepatrolled' => 0,
4545 'nickname' => '',
4546 'norollbackdiff' => 0,
4547 'numberheadings' => 0,
4548 'previewonfirst' => 0,
4549 'previewontop' => 1,
4550 'rcdays' => 7,
4551 'rclimit' => 50,
4552 'rows' => 25,
4553 'showhiddencats' => 0,
4554 'shownumberswatching' => 1,
4555 'showtoolbar' => 1,
4556 'skin' => false,
4557 'stubthreshold' => 0,
4558 'thumbsize' => 5,
4559 'underline' => 2,
4560 'uselivepreview' => 0,
4561 'usenewrc' => 1,
4562 'watchcreations' => 1,
4563 'watchdefault' => 1,
4564 'watchdeletion' => 0,
4565 'watchlistdays' => 3.0,
4566 'watchlisthideanons' => 0,
4567 'watchlisthidebots' => 0,
4568 'watchlisthideliu' => 0,
4569 'watchlisthideminor' => 0,
4570 'watchlisthideown' => 0,
4571 'watchlisthidepatrolled' => 0,
4572 'watchlisthidecategorization' => 1,
4573 'watchlistreloadautomatically' => 0,
4574 'watchmoves' => 0,
4575 'watchrollback' => 0,
4576 'wllimit' => 250,
4577 'useeditwarning' => 1,
4578 'prefershttps' => 1,
4582 * An array of preferences to not show for the user
4584 $wgHiddenPrefs = [];
4587 * Characters to prevent during new account creations.
4588 * This is used in a regular expression character class during
4589 * registration (regex metacharacters like / are escaped).
4591 $wgInvalidUsernameCharacters = '@:';
4594 * Character used as a delimiter when testing for interwiki userrights
4595 * (In Special:UserRights, it is possible to modify users on different
4596 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4598 * It is recommended that you have this delimiter in
4599 * $wgInvalidUsernameCharacters above, or you will not be able to
4600 * modify the user rights of those users via Special:UserRights
4602 $wgUserrightsInterwikiDelimiter = '@';
4605 * This is to let user authenticate using https when they come from http.
4606 * Based on an idea by George Herbert on wikitech-l:
4607 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4608 * @since 1.17
4610 $wgSecureLogin = false;
4613 * Versioning for authentication tokens.
4615 * If non-null, this is combined with the user's secret (the user_token field
4616 * in the DB) to generate the token cookie. Changing this will invalidate all
4617 * active sessions (i.e. it will log everyone out).
4619 * @since 1.27
4620 * @var string|null
4622 $wgAuthenticationTokenVersion = null;
4625 * MediaWiki\Session\SessionProvider configuration.
4627 * Value is an array of ObjectFactory specifications for the SessionProviders
4628 * to be used. Keys in the array are ignored. Order is not significant.
4630 * @since 1.27
4632 $wgSessionProviders = [
4633 MediaWiki\Session\CookieSessionProvider::class => [
4634 'class' => MediaWiki\Session\CookieSessionProvider::class,
4635 'args' => [ [
4636 'priority' => 30,
4637 'callUserSetCookiesHook' => true,
4638 ] ],
4640 MediaWiki\Session\BotPasswordSessionProvider::class => [
4641 'class' => MediaWiki\Session\BotPasswordSessionProvider::class,
4642 'args' => [ [
4643 'priority' => 40,
4644 ] ],
4648 /** @} */ # end user accounts }
4650 /************************************************************************//**
4651 * @name User rights, access control and monitoring
4652 * @{
4656 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4658 $wgAutoblockExpiry = 86400;
4661 * Set this to true to allow blocked users to edit their own user talk page.
4663 $wgBlockAllowsUTEdit = true;
4666 * Allow sysops to ban users from accessing Emailuser
4668 $wgSysopEmailBans = true;
4671 * Limits on the possible sizes of range blocks.
4673 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4674 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4675 * half the number of bits avoids such errors, and allows entire ISPs to be
4676 * blocked using a small number of range blocks.
4678 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4679 * customer, so range blocks larger than /64 (half the number of bits) will
4680 * plainly be required. RFC 4692 implies that a very large ISP may be
4681 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4682 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4684 $wgBlockCIDRLimit = [
4685 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4686 'IPv6' => 19,
4690 * If true, blocked users will not be allowed to login. When using this with
4691 * a public wiki, the effect of logging out blocked users may actually be
4692 * avers: unless the user's address is also blocked (e.g. auto-block),
4693 * logging the user out will again allow reading and editing, just as for
4694 * anonymous visitors.
4696 $wgBlockDisablesLogin = false;
4699 * Pages anonymous user may see, set as an array of pages titles.
4701 * @par Example:
4702 * @code
4703 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4704 * @endcode
4706 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4708 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4709 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4711 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4712 * will remain readable. You can use img_auth.php to protect uploaded files,
4713 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4715 $wgWhitelistRead = false;
4718 * Pages anonymous user may see, set as an array of regular expressions.
4720 * This function will match the regexp against the title name, which
4721 * is without underscore.
4723 * @par Example:
4724 * To whitelist [[Main Page]]:
4725 * @code
4726 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4727 * @endcode
4729 * @note Unless ^ and/or $ is specified, a regular expression might match
4730 * pages not intended to be whitelisted. The above example will also
4731 * whitelist a page named 'Security Main Page'.
4733 * @par Example:
4734 * To allow reading any page starting with 'User' regardless of the case:
4735 * @code
4736 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4737 * @endcode
4738 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4740 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4741 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4743 $wgWhitelistReadRegexp = false;
4746 * Should editors be required to have a validated e-mail
4747 * address before being allowed to edit?
4749 $wgEmailConfirmToEdit = false;
4752 * Should MediaWiki attempt to protect user's privacy when doing redirects?
4753 * Keep this true if access counts to articles are made public.
4755 $wgHideIdentifiableRedirects = true;
4758 * Permission keys given to users in each group.
4760 * This is an array where the keys are all groups and each value is an
4761 * array of the format (right => boolean).
4763 * The second format is used to support per-namespace permissions.
4764 * Note that this feature does not fully work for all permission types.
4766 * All users are implicitly in the '*' group including anonymous visitors;
4767 * logged-in users are all implicitly in the 'user' group. These will be
4768 * combined with the permissions of all groups that a given user is listed
4769 * in in the user_groups table.
4771 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4772 * doing! This will wipe all permissions, and may mean that your users are
4773 * unable to perform certain essential tasks or access new functionality
4774 * when new permissions are introduced and default grants established.
4776 * Functionality to make pages inaccessible has not been extensively tested
4777 * for security. Use at your own risk!
4779 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4781 $wgGroupPermissions = [];
4783 /** @cond file_level_code */
4784 // Implicit group for all visitors
4785 $wgGroupPermissions['*']['createaccount'] = true;
4786 $wgGroupPermissions['*']['read'] = true;
4787 $wgGroupPermissions['*']['edit'] = true;
4788 $wgGroupPermissions['*']['createpage'] = true;
4789 $wgGroupPermissions['*']['createtalk'] = true;
4790 $wgGroupPermissions['*']['writeapi'] = true;
4791 $wgGroupPermissions['*']['editmyusercss'] = true;
4792 $wgGroupPermissions['*']['editmyuserjs'] = true;
4793 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4794 $wgGroupPermissions['*']['editmywatchlist'] = true;
4795 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4796 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4797 $wgGroupPermissions['*']['editmyoptions'] = true;
4798 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4800 // Implicit group for all logged-in accounts
4801 $wgGroupPermissions['user']['move'] = true;
4802 $wgGroupPermissions['user']['move-subpages'] = true;
4803 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4804 $wgGroupPermissions['user']['move-categorypages'] = true;
4805 $wgGroupPermissions['user']['movefile'] = true;
4806 $wgGroupPermissions['user']['read'] = true;
4807 $wgGroupPermissions['user']['edit'] = true;
4808 $wgGroupPermissions['user']['createpage'] = true;
4809 $wgGroupPermissions['user']['createtalk'] = true;
4810 $wgGroupPermissions['user']['writeapi'] = true;
4811 $wgGroupPermissions['user']['upload'] = true;
4812 $wgGroupPermissions['user']['reupload'] = true;
4813 $wgGroupPermissions['user']['reupload-shared'] = true;
4814 $wgGroupPermissions['user']['minoredit'] = true;
4815 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4816 $wgGroupPermissions['user']['sendemail'] = true;
4817 $wgGroupPermissions['user']['applychangetags'] = true;
4818 $wgGroupPermissions['user']['changetags'] = true;
4820 // Implicit group for accounts that pass $wgAutoConfirmAge
4821 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4822 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4824 // Users with bot privilege can have their edits hidden
4825 // from various log pages by default
4826 $wgGroupPermissions['bot']['bot'] = true;
4827 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4828 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4829 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4830 $wgGroupPermissions['bot']['autopatrol'] = true;
4831 $wgGroupPermissions['bot']['suppressredirect'] = true;
4832 $wgGroupPermissions['bot']['apihighlimits'] = true;
4833 $wgGroupPermissions['bot']['writeapi'] = true;
4835 // Most extra permission abilities go to this group
4836 $wgGroupPermissions['sysop']['block'] = true;
4837 $wgGroupPermissions['sysop']['createaccount'] = true;
4838 $wgGroupPermissions['sysop']['delete'] = true;
4839 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4840 $wgGroupPermissions['sysop']['bigdelete'] = true;
4841 // can view deleted history entries, but not see or restore the text
4842 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4843 // can view deleted revision text
4844 $wgGroupPermissions['sysop']['deletedtext'] = true;
4845 $wgGroupPermissions['sysop']['undelete'] = true;
4846 $wgGroupPermissions['sysop']['editinterface'] = true;
4847 $wgGroupPermissions['sysop']['editusercss'] = true;
4848 $wgGroupPermissions['sysop']['edituserjs'] = true;
4849 $wgGroupPermissions['sysop']['editcontentmodel'] = true;
4850 $wgGroupPermissions['sysop']['import'] = true;
4851 $wgGroupPermissions['sysop']['importupload'] = true;
4852 $wgGroupPermissions['sysop']['move'] = true;
4853 $wgGroupPermissions['sysop']['move-subpages'] = true;
4854 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4855 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4856 $wgGroupPermissions['sysop']['patrol'] = true;
4857 $wgGroupPermissions['sysop']['autopatrol'] = true;
4858 $wgGroupPermissions['sysop']['protect'] = true;
4859 $wgGroupPermissions['sysop']['editprotected'] = true;
4860 $wgGroupPermissions['sysop']['rollback'] = true;
4861 $wgGroupPermissions['sysop']['upload'] = true;
4862 $wgGroupPermissions['sysop']['reupload'] = true;
4863 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4864 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4865 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4866 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4867 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4868 $wgGroupPermissions['sysop']['blockemail'] = true;
4869 $wgGroupPermissions['sysop']['markbotedits'] = true;
4870 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4871 $wgGroupPermissions['sysop']['browsearchive'] = true;
4872 $wgGroupPermissions['sysop']['noratelimit'] = true;
4873 $wgGroupPermissions['sysop']['movefile'] = true;
4874 $wgGroupPermissions['sysop']['unblockself'] = true;
4875 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4876 # $wgGroupPermissions['sysop']['pagelang'] = true;
4877 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
4878 $wgGroupPermissions['sysop']['mergehistory'] = true;
4879 $wgGroupPermissions['sysop']['managechangetags'] = true;
4881 // Permission to change users' group assignments
4882 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4883 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4884 // Permission to change users' groups assignments across wikis
4885 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4886 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4887 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4889 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
4890 # $wgGroupPermissions['sysop']['deleterevision'] = true;
4891 // To hide usernames from users and Sysops
4892 # $wgGroupPermissions['suppress']['hideuser'] = true;
4893 // To hide revisions/log items from users and Sysops
4894 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
4895 // To view revisions/log items hidden from users and Sysops
4896 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
4897 // For private suppression log access
4898 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
4901 * The developer group is deprecated, but can be activated if need be
4902 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4903 * that a lock file be defined and creatable/removable by the web
4904 * server.
4906 # $wgGroupPermissions['developer']['siteadmin'] = true;
4908 /** @endcond */
4911 * Permission keys revoked from users in each group.
4913 * This acts the same way as wgGroupPermissions above, except that
4914 * if the user is in a group here, the permission will be removed from them.
4916 * Improperly setting this could mean that your users will be unable to perform
4917 * certain essential tasks, so use at your own risk!
4919 $wgRevokePermissions = [];
4922 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4924 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ];
4927 * A map of group names that the user is in, to group names that those users
4928 * are allowed to add or revoke.
4930 * Setting the list of groups to add or revoke to true is equivalent to "any
4931 * group".
4933 * @par Example:
4934 * To allow sysops to add themselves to the "bot" group:
4935 * @code
4936 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4937 * @endcode
4939 * @par Example:
4940 * Implicit groups may be used for the source group, for instance:
4941 * @code
4942 * $wgGroupsRemoveFromSelf = array( '*' => true );
4943 * @endcode
4944 * This allows users in the '*' group (i.e. any user) to remove themselves from
4945 * any group that they happen to be in.
4947 $wgGroupsAddToSelf = [];
4950 * @see $wgGroupsAddToSelf
4952 $wgGroupsRemoveFromSelf = [];
4955 * Set of available actions that can be restricted via action=protect
4956 * You probably shouldn't change this.
4957 * Translated through restriction-* messages.
4958 * Title::getRestrictionTypes() will remove restrictions that are not
4959 * applicable to a specific title (create and upload)
4961 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ];
4964 * Rights which can be required for each protection level (via action=protect)
4966 * You can add a new protection level that requires a specific
4967 * permission by manipulating this array. The ordering of elements
4968 * dictates the order on the protection form's lists.
4970 * - '' will be ignored (i.e. unprotected)
4971 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4972 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4974 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ];
4977 * Restriction levels that can be used with cascading protection
4979 * A page can only be protected with cascading protection if the
4980 * requested restriction level is included in this array.
4982 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4983 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4985 $wgCascadingRestrictionLevels = [ 'sysop' ];
4988 * Restriction levels that should be considered "semiprotected"
4990 * Certain places in the interface recognize a dichotomy between "protected"
4991 * and "semiprotected", without further distinguishing the specific levels. In
4992 * general, if anyone can be eligible to edit a protection level merely by
4993 * reaching some condition in $wgAutopromote, it should probably be considered
4994 * "semiprotected".
4996 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4997 * 'sysop' is not changed, since it really shouldn't be here.
4999 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ];
5002 * Set the minimum permissions required to edit pages in each
5003 * namespace. If you list more than one permission, a user must
5004 * have all of them to edit pages in that namespace.
5006 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5008 $wgNamespaceProtection = [];
5011 * Pages in namespaces in this array can not be used as templates.
5013 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5014 * namespaces constants (NS_USER, NS_MAIN...).
5016 * Among other things, this may be useful to enforce read-restrictions
5017 * which may otherwise be bypassed by using the template mechanism.
5019 $wgNonincludableNamespaces = [];
5022 * Number of seconds an account is required to age before it's given the
5023 * implicit 'autoconfirm' group membership. This can be used to limit
5024 * privileges of new accounts.
5026 * Accounts created by earlier versions of the software may not have a
5027 * recorded creation date, and will always be considered to pass the age test.
5029 * When left at 0, all registered accounts will pass.
5031 * @par Example:
5032 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5033 * @code
5034 * $wgAutoConfirmAge = 600; // ten minutes
5035 * @endcode
5036 * Set age to one day:
5037 * @code
5038 * $wgAutoConfirmAge = 3600*24; // one day
5039 * @endcode
5041 $wgAutoConfirmAge = 0;
5044 * Number of edits an account requires before it is autoconfirmed.
5045 * Passing both this AND the time requirement is needed. Example:
5047 * @par Example:
5048 * @code
5049 * $wgAutoConfirmCount = 50;
5050 * @endcode
5052 $wgAutoConfirmCount = 0;
5055 * Automatically add a usergroup to any user who matches certain conditions.
5057 * @todo Redocument $wgAutopromote
5059 * The format is
5060 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
5061 * where cond1, cond2, ... are themselves conditions; *OR*
5062 * APCOND_EMAILCONFIRMED, *OR*
5063 * array( APCOND_EMAILCONFIRMED ), *OR*
5064 * array( APCOND_EDITCOUNT, number of edits ), *OR*
5065 * array( APCOND_AGE, seconds since registration ), *OR*
5066 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
5067 * array( APCOND_ISIP, ip ), *OR*
5068 * array( APCOND_IPINRANGE, range ), *OR*
5069 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
5070 * array( APCOND_BLOCKED ), *OR*
5071 * array( APCOND_ISBOT ), *OR*
5072 * similar constructs defined by extensions.
5074 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
5075 * user who has provided an e-mail address.
5077 $wgAutopromote = [
5078 'autoconfirmed' => [ '&',
5079 [ APCOND_EDITCOUNT, &$wgAutoConfirmCount ],
5080 [ APCOND_AGE, &$wgAutoConfirmAge ],
5085 * Automatically add a usergroup to any user who matches certain conditions.
5087 * Does not add the user to the group again if it has been removed.
5088 * Also, does not remove the group if the user no longer meets the criteria.
5090 * The format is:
5091 * @code
5092 * array( event => criteria, ... )
5093 * @endcode
5094 * Where event is either:
5095 * - 'onEdit' (when user edits)
5097 * Criteria has the same format as $wgAutopromote
5099 * @see $wgAutopromote
5100 * @since 1.18
5102 $wgAutopromoteOnce = [
5103 'onEdit' => [],
5107 * Put user rights log entries for autopromotion in recent changes?
5108 * @since 1.18
5110 $wgAutopromoteOnceLogInRC = true;
5113 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5114 * can assign which groups at Special:Userrights.
5116 * @par Example:
5117 * Bureaucrats can add any group:
5118 * @code
5119 * $wgAddGroups['bureaucrat'] = true;
5120 * @endcode
5121 * Bureaucrats can only remove bots and sysops:
5122 * @code
5123 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
5124 * @endcode
5125 * Sysops can make bots:
5126 * @code
5127 * $wgAddGroups['sysop'] = array( 'bot' );
5128 * @endcode
5129 * Sysops can disable other sysops in an emergency, and disable bots:
5130 * @code
5131 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
5132 * @endcode
5134 $wgAddGroups = [];
5137 * @see $wgAddGroups
5139 $wgRemoveGroups = [];
5142 * A list of available rights, in addition to the ones defined by the core.
5143 * For extensions only.
5145 $wgAvailableRights = [];
5148 * Optional to restrict deletion of pages with higher revision counts
5149 * to users with the 'bigdelete' permission. (Default given to sysops.)
5151 $wgDeleteRevisionsLimit = 0;
5154 * The maximum number of edits a user can have and
5155 * can still be hidden by users with the hideuser permission.
5156 * This is limited for performance reason.
5157 * Set to false to disable the limit.
5158 * @since 1.23
5160 $wgHideUserContribLimit = 1000;
5163 * Number of accounts each IP address may create, 0 to disable.
5165 * @warning Requires $wgMainCacheType to be enabled
5167 $wgAccountCreationThrottle = 0;
5170 * Edits matching these regular expressions in body text
5171 * will be recognised as spam and rejected automatically.
5173 * There's no administrator override on-wiki, so be careful what you set. :)
5174 * May be an array of regexes or a single string for backwards compatibility.
5176 * @see https://en.wikipedia.org/wiki/Regular_expression
5178 * @note Each regex needs a beginning/end delimiter, eg: # or /
5180 $wgSpamRegex = [];
5183 * Same as the above except for edit summaries
5185 $wgSummarySpamRegex = [];
5188 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5189 * proxies
5190 * @since 1.16
5192 $wgEnableDnsBlacklist = false;
5195 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5197 * This is an array of either a URL or an array with the URL and a key (should
5198 * the blacklist require a key).
5200 * @par Example:
5201 * @code
5202 * $wgDnsBlacklistUrls = array(
5203 * // String containing URL
5204 * 'http.dnsbl.sorbs.net.',
5205 * // Array with URL and key, for services that require a key
5206 * array( 'dnsbl.httpbl.net.', 'mykey' ),
5207 * // Array with just the URL. While this works, it is recommended that you
5208 * // just use a string as shown above
5209 * array( 'opm.tornevall.org.' )
5210 * );
5211 * @endcode
5213 * @note You should end the domain name with a . to avoid searching your
5214 * eventual domain search suffixes.
5215 * @since 1.16
5217 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ];
5220 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5221 * what the other methods might say.
5223 $wgProxyWhitelist = [];
5226 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5227 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5228 * (transparent) proxies without needing to block the proxies themselves.
5230 $wgApplyIpBlocksToXff = false;
5233 * Simple rate limiter options to brake edit floods.
5235 * Maximum number actions allowed in the given number of seconds; after that
5236 * the violating client receives HTTP 500 error pages until the period
5237 * elapses.
5239 * @par Example:
5240 * To set a generic maximum of 4 hits in 60 seconds:
5241 * @code
5242 * $wgRateLimits = array( 4, 60 );
5243 * @endcode
5245 * @par Example:
5246 * You could also limit per action and then type of users.
5247 * @code
5248 * $wgRateLimits = array(
5249 * 'edit' => array(
5250 * 'anon' => array( x, y ), // any and all anonymous edits (aggregate)
5251 * 'user' => array( x, y ), // each logged-in user
5252 * 'newbie' => array( x, y ), // each new autoconfirmed accounts; overrides 'user'
5253 * 'ip' => array( x, y ), // each anon and recent account
5254 * 'subnet' => array( x, y ), // ... within a /24 subnet in IPv4 or /64 in IPv6
5257 * @endcode
5259 * @warning Requires that $wgMainCacheType is set to something persistent
5261 $wgRateLimits = [
5262 // Page edits
5263 'edit' => [
5264 'ip' => [ 8, 60 ],
5265 'newbie' => [ 8, 60 ],
5267 // Page moves
5268 'move' => [
5269 'newbie' => [ 2, 120 ],
5270 'user' => [ 8, 60 ],
5272 // File uploads
5273 'upload' => [
5274 'ip' => [ 8, 60 ],
5275 'newbie' => [ 8, 60 ],
5277 // Page rollbacks
5278 'rollback' => [
5279 'user' => [ 10, 60 ],
5280 'newbie' => [ 5, 120 ]
5282 // Triggering password resets emails
5283 'mailpassword' => [
5284 'ip' => [ 5, 3600 ],
5286 // Emailing other users using MediaWiki
5287 'emailuser' => [
5288 'ip' => [ 5, 86400 ],
5289 'newbie' => [ 5, 86400 ],
5290 'user' => [ 20, 86400 ],
5292 // Purging pages
5293 'purge' => [
5294 'ip' => [ 30, 60 ],
5295 'user' => [ 30, 60 ],
5297 // Purges of link tables
5298 'linkpurge' => [
5299 'ip' => [ 30, 60 ],
5300 'user' => [ 30, 60 ],
5302 // Files rendered via thumb.php or thumb_handler.php
5303 'renderfile' => [
5304 'ip' => [ 700, 30 ],
5305 'user' => [ 700, 30 ],
5307 // Same as above but for non-standard thumbnails
5308 'renderfile-nonstandard' => [
5309 'ip' => [ 70, 30 ],
5310 'user' => [ 70, 30 ],
5312 // Stashing edits into cache before save
5313 'stashedit' => [
5314 'ip' => [ 30, 60 ],
5315 'newbie' => [ 30, 60 ],
5317 // Adding or removing change tags
5318 'changetag' => [
5319 'ip' => [ 8, 60 ],
5320 'newbie' => [ 8, 60 ],
5325 * Array of IPs which should be excluded from rate limits.
5326 * This may be useful for whitelisting NAT gateways for conferences, etc.
5328 $wgRateLimitsExcludedIPs = [];
5331 * Log IP addresses in the recentchanges table; can be accessed only by
5332 * extensions (e.g. CheckUser) or a DB admin
5333 * Used for retroactive autoblocks
5335 $wgPutIPinRC = true;
5338 * Integer defining default number of entries to show on
5339 * special pages which are query-pages such as Special:Whatlinkshere.
5341 $wgQueryPageDefaultLimit = 50;
5344 * Limit password attempts to X attempts per Y seconds per IP per account.
5346 * Value is an array of arrays. Each sub-array must have a key for count
5347 * (ie count of how many attempts before throttle) and a key for seconds.
5348 * If the key 'allIPs' (case sensitive) is present, then the limit is
5349 * just per account instead of per IP per account.
5351 * @since 1.27 allIps support and multiple limits added in 1.27. Prior
5352 * to 1.27 this only supported having a single throttle.
5353 * @warning Requires $wgMainCacheType to be enabled
5355 $wgPasswordAttemptThrottle = [
5356 // Short term limit
5357 [ 'count' => 5, 'seconds' => 300 ],
5358 // Long term limit. We need to balance the risk
5359 // of somebody using this as a DoS attack to lock someone
5360 // out of their account, and someone doing a brute force attack.
5361 [ 'count' => 150, 'seconds' => 60*60*48 ],
5365 * @var Array Map of (grant => right => boolean)
5366 * Users authorize consumers (like Apps) to act on their behalf but only with
5367 * a subset of the user's normal account rights (signed off on by the user).
5368 * The possible rights to grant to a consumer are bundled into groups called
5369 * "grants". Each grant defines some rights it lets consumers inherit from the
5370 * account they may act on behalf of. Note that a user granting a right does
5371 * nothing if that user does not actually have that right to begin with.
5372 * @since 1.27
5374 $wgGrantPermissions = [];
5376 // @TODO: clean up grants
5377 // @TODO: auto-include read/editsemiprotected rights?
5379 $wgGrantPermissions['basic']['autoconfirmed'] = true;
5380 $wgGrantPermissions['basic']['autopatrol'] = true;
5381 $wgGrantPermissions['basic']['autoreview'] = true;
5382 $wgGrantPermissions['basic']['editsemiprotected'] = true;
5383 $wgGrantPermissions['basic']['ipblock-exempt'] = true;
5384 $wgGrantPermissions['basic']['nominornewtalk'] = true;
5385 $wgGrantPermissions['basic']['patrolmarks'] = true;
5386 $wgGrantPermissions['basic']['purge'] = true;
5387 $wgGrantPermissions['basic']['read'] = true;
5388 $wgGrantPermissions['basic']['skipcaptcha'] = true;
5389 $wgGrantPermissions['basic']['torunblocked'] = true;
5390 $wgGrantPermissions['basic']['writeapi'] = true;
5392 $wgGrantPermissions['highvolume']['bot'] = true;
5393 $wgGrantPermissions['highvolume']['apihighlimits'] = true;
5394 $wgGrantPermissions['highvolume']['noratelimit'] = true;
5395 $wgGrantPermissions['highvolume']['markbotedits'] = true;
5397 $wgGrantPermissions['editpage']['edit'] = true;
5398 $wgGrantPermissions['editpage']['minoredit'] = true;
5399 $wgGrantPermissions['editpage']['applychangetags'] = true;
5400 $wgGrantPermissions['editpage']['changetags'] = true;
5402 $wgGrantPermissions['editprotected'] = $wgGrantPermissions['editpage'];
5403 $wgGrantPermissions['editprotected']['editprotected'] = true;
5405 $wgGrantPermissions['editmycssjs'] = $wgGrantPermissions['editpage'];
5406 $wgGrantPermissions['editmycssjs']['editmyusercss'] = true;
5407 $wgGrantPermissions['editmycssjs']['editmyuserjs'] = true;
5409 $wgGrantPermissions['editmyoptions']['editmyoptions'] = true;
5411 $wgGrantPermissions['editinterface'] = $wgGrantPermissions['editpage'];
5412 $wgGrantPermissions['editinterface']['editinterface'] = true;
5413 $wgGrantPermissions['editinterface']['editusercss'] = true;
5414 $wgGrantPermissions['editinterface']['edituserjs'] = true;
5416 $wgGrantPermissions['createeditmovepage'] = $wgGrantPermissions['editpage'];
5417 $wgGrantPermissions['createeditmovepage']['createpage'] = true;
5418 $wgGrantPermissions['createeditmovepage']['createtalk'] = true;
5419 $wgGrantPermissions['createeditmovepage']['move'] = true;
5420 $wgGrantPermissions['createeditmovepage']['move-rootuserpages'] = true;
5421 $wgGrantPermissions['createeditmovepage']['move-subpages'] = true;
5422 $wgGrantPermissions['createeditmovepage']['move-categorypages'] = true;
5424 $wgGrantPermissions['uploadfile']['upload'] = true;
5425 $wgGrantPermissions['uploadfile']['reupload-own'] = true;
5427 $wgGrantPermissions['uploadeditmovefile'] = $wgGrantPermissions['uploadfile'];
5428 $wgGrantPermissions['uploadeditmovefile']['reupload'] = true;
5429 $wgGrantPermissions['uploadeditmovefile']['reupload-shared'] = true;
5430 $wgGrantPermissions['uploadeditmovefile']['upload_by_url'] = true;
5431 $wgGrantPermissions['uploadeditmovefile']['movefile'] = true;
5432 $wgGrantPermissions['uploadeditmovefile']['suppressredirect'] = true;
5434 $wgGrantPermissions['patrol']['patrol'] = true;
5436 $wgGrantPermissions['rollback']['rollback'] = true;
5438 $wgGrantPermissions['blockusers']['block'] = true;
5439 $wgGrantPermissions['blockusers']['blockemail'] = true;
5441 $wgGrantPermissions['viewdeleted']['browsearchive'] = true;
5442 $wgGrantPermissions['viewdeleted']['deletedhistory'] = true;
5443 $wgGrantPermissions['viewdeleted']['deletedtext'] = true;
5445 $wgGrantPermissions['delete'] = $wgGrantPermissions['editpage'] +
5446 $wgGrantPermissions['viewdeleted'];
5447 $wgGrantPermissions['delete']['delete'] = true;
5448 $wgGrantPermissions['delete']['bigdelete'] = true;
5449 $wgGrantPermissions['delete']['deletelogentry'] = true;
5450 $wgGrantPermissions['delete']['deleterevision'] = true;
5451 $wgGrantPermissions['delete']['undelete'] = true;
5453 $wgGrantPermissions['protect'] = $wgGrantPermissions['editprotected'];
5454 $wgGrantPermissions['protect']['protect'] = true;
5456 $wgGrantPermissions['viewmywatchlist']['viewmywatchlist'] = true;
5458 $wgGrantPermissions['editmywatchlist']['editmywatchlist'] = true;
5460 $wgGrantPermissions['sendemail']['sendemail'] = true;
5462 $wgGrantPermissions['createaccount']['createaccount'] = true;
5465 * @var Array Map of grants to their UI grouping
5466 * @since 1.27
5468 $wgGrantPermissionGroups = [
5469 // Hidden grants are implicitly present
5470 'basic' => 'hidden',
5472 'editpage' => 'page-interaction',
5473 'createeditmovepage' => 'page-interaction',
5474 'editprotected' => 'page-interaction',
5475 'patrol' => 'page-interaction',
5477 'uploadfile' => 'file-interaction',
5478 'uploadeditmovefile' => 'file-interaction',
5480 'sendemail' => 'email',
5482 'viewmywatchlist' => 'watchlist-interaction',
5483 'editviewmywatchlist' => 'watchlist-interaction',
5485 'editmycssjs' => 'customization',
5486 'editmyoptions' => 'customization',
5488 'editinterface' => 'administration',
5489 'rollback' => 'administration',
5490 'blockusers' => 'administration',
5491 'delete' => 'administration',
5492 'viewdeleted' => 'administration',
5493 'protect' => 'administration',
5494 'createaccount' => 'administration',
5496 'highvolume' => 'high-volume',
5500 * @var bool Whether to enable bot passwords
5501 * @since 1.27
5503 $wgEnableBotPasswords = true;
5506 * Cluster for the bot_passwords table
5507 * @var string|bool If false, the normal cluster will be used
5508 * @since 1.27
5510 $wgBotPasswordsCluster = false;
5513 * Database name for the bot_passwords table
5515 * To use a database with a table prefix, set this variable to
5516 * "{$database}-{$prefix}".
5517 * @var string|bool If false, the normal database will be used
5518 * @since 1.27
5520 $wgBotPasswordsDatabase = false;
5522 /** @} */ # end of user rights settings
5524 /************************************************************************//**
5525 * @name Proxy scanner settings
5526 * @{
5530 * This should always be customised in LocalSettings.php
5532 $wgSecretKey = false;
5535 * Big list of banned IP addresses.
5537 * This can have the following formats:
5538 * - An array of addresses, either in the values
5539 * or the keys (for backward compatibility)
5540 * - A string, in that case this is the path to a file
5541 * containing the list of IP addresses, one per line
5543 $wgProxyList = [];
5545 /** @} */ # end of proxy scanner settings
5547 /************************************************************************//**
5548 * @name Cookie settings
5549 * @{
5553 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5555 $wgCookieExpiration = 180 * 86400;
5558 * The identifiers of the login cookies that can have their lifetimes
5559 * extended independently of all other login cookies.
5561 * @var string[]
5563 $wgExtendedLoginCookies = [ 'UserID', 'Token' ];
5566 * Default login cookie lifetime, in seconds. Setting
5567 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5568 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5569 * login cookies session-only.
5571 $wgExtendedLoginCookieExpiration = null;
5574 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5575 * or ".any.subdomain.net"
5577 $wgCookieDomain = '';
5580 * Set this variable if you want to restrict cookies to a certain path within
5581 * the domain specified by $wgCookieDomain.
5583 $wgCookiePath = '/';
5586 * Whether the "secure" flag should be set on the cookie. This can be:
5587 * - true: Set secure flag
5588 * - false: Don't set secure flag
5589 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5591 $wgCookieSecure = 'detect';
5594 * By default, MediaWiki checks if the client supports cookies during the
5595 * login process, so that it can display an informative error message if
5596 * cookies are disabled. Set this to true if you want to disable this cookie
5597 * check.
5599 $wgDisableCookieCheck = false;
5602 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5603 * to a string to use a custom prefix. Setting it to false causes the database
5604 * name to be used as a prefix.
5606 $wgCookiePrefix = false;
5609 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5610 * in browsers that support this feature. This can mitigates some classes of
5611 * XSS attack.
5613 $wgCookieHttpOnly = true;
5616 * A list of cookies that vary the cache (for use by extensions)
5618 $wgCacheVaryCookies = [];
5621 * Override to customise the session name
5623 $wgSessionName = false;
5625 /** @} */ # end of cookie settings }
5627 /************************************************************************//**
5628 * @name LaTeX (mathematical formulas)
5629 * @{
5633 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5634 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5635 * (ImageMagick) installed and available in the PATH.
5636 * Please see math/README for more information.
5638 $wgUseTeX = false;
5640 /** @} */ # end LaTeX }
5642 /************************************************************************//**
5643 * @name Profiling, testing and debugging
5645 * To enable profiling, edit StartProfiler.php
5647 * @{
5651 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5652 * The debug log file should be not be publicly accessible if it is used, as it
5653 * may contain private data.
5655 $wgDebugLogFile = '';
5658 * Prefix for debug log lines
5660 $wgDebugLogPrefix = '';
5663 * If true, instead of redirecting, show a page with a link to the redirect
5664 * destination. This allows for the inspection of PHP error messages, and easy
5665 * resubmission of form data. For developer use only.
5667 $wgDebugRedirects = false;
5670 * If true, log debugging data from action=raw and load.php.
5671 * This is normally false to avoid overlapping debug entries due to gen=css
5672 * and gen=js requests.
5674 $wgDebugRawPage = false;
5677 * Send debug data to an HTML comment in the output.
5679 * This may occasionally be useful when supporting a non-technical end-user.
5680 * It's more secure than exposing the debug log file to the web, since the
5681 * output only contains private data for the current user. But it's not ideal
5682 * for development use since data is lost on fatal errors and redirects.
5684 $wgDebugComments = false;
5687 * Write SQL queries to the debug log.
5689 * This setting is only used $wgLBFactoryConf['class'] is set to
5690 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5691 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5692 * connection to achieve the same functionality.
5694 $wgDebugDumpSql = false;
5697 * Performance expectations for DB usage
5699 * @since 1.26
5701 $wgTrxProfilerLimits = [
5702 // HTTP GET/HEAD requests.
5703 // Master queries should not happen on GET requests
5704 'GET' => [
5705 'masterConns' => 0,
5706 'writes' => 0,
5707 'readQueryTime' => 5
5709 // HTTP POST requests.
5710 // Master reads and writes will happen for a subset of these.
5711 'POST' => [
5712 'readQueryTime' => 5,
5713 'writeQueryTime' => 1,
5714 'maxAffected' => 500
5716 'POST-nonwrite' => [
5717 'masterConns' => 0,
5718 'writes' => 0,
5719 'readQueryTime' => 5
5721 // Background job runner
5722 'JobRunner' => [
5723 'readQueryTime' => 30,
5724 'writeQueryTime' => 5,
5725 'maxAffected' => 1000
5727 // Command-line scripts
5728 'Maintenance' => [
5729 'writeQueryTime' => 5,
5730 'maxAffected' => 1000
5735 * Map of string log group names to log destinations.
5737 * If set, wfDebugLog() output for that group will go to that file instead
5738 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5739 * in production.
5741 * Log destinations may be one of the following:
5742 * - false to completely remove from the output, including from $wgDebugLogFile.
5743 * - string values specifying a filename or URI.
5744 * - associative array with keys:
5745 * - 'destination' desired filename or URI.
5746 * - 'sample' an integer value, specifying a sampling factor (optional)
5747 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5748 * to log (optional, since 1.25)
5750 * @par Example:
5751 * @code
5752 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5753 * @endcode
5755 * @par Advanced example:
5756 * @code
5757 * $wgDebugLogGroups['memcached'] = array(
5758 * 'destination' => '/var/log/mediawiki/memcached.log',
5759 * 'sample' => 1000, // log 1 message out of every 1,000.
5760 * 'level' => \Psr\Log\LogLevel::WARNING
5761 * );
5762 * @endcode
5764 $wgDebugLogGroups = [];
5767 * Default service provider for creating Psr\Log\LoggerInterface instances.
5769 * The value should be an array suitable for use with
5770 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5771 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
5772 * details.
5774 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
5775 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
5776 * and bypass the use of this configuration variable entirely.
5778 * @par To completely disable logging:
5779 * @code
5780 * $wgMWLoggerDefaultSpi = array( 'class' => '\\MediaWiki\\Logger\\NullSpi' );
5781 * @endcode
5783 * @since 1.25
5784 * @var array $wgMWLoggerDefaultSpi
5785 * @see MwLogger
5787 $wgMWLoggerDefaultSpi = [
5788 'class' => '\\MediaWiki\\Logger\\LegacySpi',
5792 * Display debug data at the bottom of the main content area.
5794 * Useful for developers and technical users trying to working on a closed wiki.
5796 $wgShowDebug = false;
5799 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5800 * Since 1.19 also includes memory usage.
5802 $wgDebugTimestamps = false;
5805 * Print HTTP headers for every request in the debug information.
5807 $wgDebugPrintHttpHeaders = true;
5810 * Show the contents of $wgHooks in Special:Version
5812 $wgSpecialVersionShowHooks = false;
5815 * Whether to show "we're sorry, but there has been a database error" pages.
5816 * Displaying errors aids in debugging, but may display information useful
5817 * to an attacker.
5819 $wgShowSQLErrors = false;
5822 * If set to true, uncaught exceptions will print a complete stack trace
5823 * to output. This should only be used for debugging, as it may reveal
5824 * private information in function parameters due to PHP's backtrace
5825 * formatting.
5827 $wgShowExceptionDetails = false;
5830 * If true, show a backtrace for database errors
5832 * @note This setting only applies when connection errors and query errors are
5833 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5834 * including those in which an uncaught exception is thrown from within the
5835 * exception handler.
5837 $wgShowDBErrorBacktrace = false;
5840 * If true, send the exception backtrace to the error log
5842 $wgLogExceptionBacktrace = true;
5845 * Expose backend server host names through the API and various HTML comments
5847 $wgShowHostnames = false;
5850 * Override server hostname detection with a hardcoded value.
5851 * Should be a string, default false.
5852 * @since 1.20
5854 $wgOverrideHostname = false;
5857 * If set to true MediaWiki will throw notices for some possible error
5858 * conditions and for deprecated functions.
5860 $wgDevelopmentWarnings = false;
5863 * Release limitation to wfDeprecated warnings, if set to a release number
5864 * development warnings will not be generated for deprecations added in releases
5865 * after the limit.
5867 $wgDeprecationReleaseLimit = false;
5870 * Only record profiling info for pages that took longer than this
5871 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
5873 $wgProfileLimit = 0.0;
5876 * Don't put non-profiling info into log file
5878 * @deprecated since 1.23, set the log file in
5879 * $wgDebugLogGroups['profileoutput'] instead.
5881 $wgProfileOnly = false;
5884 * Destination of statsd metrics.
5886 * A host or host:port of a statsd server. Port defaults to 8125.
5888 * If not set, statsd metrics will not be collected.
5890 * @see wfLogProfilingData
5891 * @since 1.25
5893 $wgStatsdServer = false;
5896 * Prefix for metric names sent to $wgStatsdServer.
5898 * @see RequestContext::getStats
5899 * @see BufferingStatsdDataFactory
5900 * @since 1.25
5902 $wgStatsdMetricPrefix = 'MediaWiki';
5905 * InfoAction retrieves a list of transclusion links (both to and from).
5906 * This number puts a limit on that query in the case of highly transcluded
5907 * templates.
5909 $wgPageInfoTransclusionLimit = 50;
5912 * Set this to an integer to only do synchronous site_stats updates
5913 * one every *this many* updates. The other requests go into pending
5914 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5915 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5917 $wgSiteStatsAsyncFactor = false;
5920 * Parser test suite files to be run by parserTests.php when no specific
5921 * filename is passed to it.
5923 * Extensions may add their own tests to this array, or site-local tests
5924 * may be added via LocalSettings.php
5926 * Use full paths.
5928 $wgParserTestFiles = [
5929 "$IP/tests/parser/parserTests.txt",
5930 "$IP/tests/parser/extraParserTests.txt"
5934 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5936 $wgEnableJavaScriptTest = false;
5939 * Overwrite the caching key prefix with custom value.
5940 * @since 1.19
5942 $wgCachePrefix = false;
5945 * Display the new debugging toolbar. This also enables profiling on database
5946 * queries and other useful output.
5947 * Will be ignored if $wgUseFileCache or $wgUseSquid is enabled.
5949 * @since 1.19
5951 $wgDebugToolbar = false;
5953 /** @} */ # end of profiling, testing and debugging }
5955 /************************************************************************//**
5956 * @name Search
5957 * @{
5961 * Set this to true to disable the full text search feature.
5963 $wgDisableTextSearch = false;
5966 * Set to true to have nicer highlighted text in search results,
5967 * by default off due to execution overhead
5969 $wgAdvancedSearchHighlighting = false;
5972 * Regexp to match word boundaries, defaults for non-CJK languages
5973 * should be empty for CJK since the words are not separate
5975 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5978 * Template for OpenSearch suggestions, defaults to API action=opensearch
5980 * Sites with heavy load would typically have these point to a custom
5981 * PHP wrapper to avoid firing up mediawiki for every keystroke
5983 * Placeholders: {searchTerms}
5985 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5987 $wgOpenSearchTemplate = false;
5990 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5992 * Sites with heavy load would typically have these point to a custom
5993 * PHP wrapper to avoid firing up mediawiki for every keystroke
5995 * Placeholders: {searchTerms}
5997 $wgOpenSearchTemplates = [
5998 'application/x-suggestions+json' => false,
5999 'application/x-suggestions+xml' => false,
6003 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
6004 * false if you've disabled scripts that use api?action=opensearch and
6005 * want reduce load caused by cached scripts still pulling suggestions.
6006 * It will let the API fallback by responding with an empty array.
6008 $wgEnableOpenSearchSuggest = true;
6011 * Integer defining default number of entries to show on
6012 * OpenSearch call.
6014 $wgOpenSearchDefaultLimit = 10;
6017 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
6019 $wgOpenSearchDescriptionLength = 100;
6022 * Expiry time for search suggestion responses
6024 $wgSearchSuggestCacheExpiry = 1200;
6027 * If you've disabled search semi-permanently, this also disables updates to the
6028 * table. If you ever re-enable, be sure to rebuild the search table.
6030 $wgDisableSearchUpdate = false;
6033 * List of namespaces which are searched by default.
6035 * @par Example:
6036 * @code
6037 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
6038 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
6039 * @endcode
6041 $wgNamespacesToBeSearchedDefault = [
6042 NS_MAIN => true,
6046 * Disable the internal MySQL-based search, to allow it to be
6047 * implemented by an extension instead.
6049 $wgDisableInternalSearch = false;
6052 * Set this to a URL to forward search requests to some external location.
6053 * If the URL includes '$1', this will be replaced with the URL-encoded
6054 * search term.
6056 * @par Example:
6057 * To forward to Google you'd have something like:
6058 * @code
6059 * $wgSearchForwardUrl =
6060 * 'http://www.google.com/search?q=$1' .
6061 * '&domains=http://example.com' .
6062 * '&sitesearch=http://example.com' .
6063 * '&ie=utf-8&oe=utf-8';
6064 * @endcode
6066 $wgSearchForwardUrl = null;
6069 * Search form behavior.
6070 * - true = use Go & Search buttons
6071 * - false = use Go button & Advanced search link
6073 $wgUseTwoButtonsSearchForm = true;
6076 * Array of namespaces to generate a Google sitemap for when the
6077 * maintenance/generateSitemap.php script is run, or false if one is to be
6078 * generated for all namespaces.
6080 $wgSitemapNamespaces = false;
6083 * Custom namespace priorities for sitemaps. Setting this will allow you to
6084 * set custom priorities to namespaces when sitemaps are generated using the
6085 * maintenance/generateSitemap.php script.
6087 * This should be a map of namespace IDs to priority
6088 * @par Example:
6089 * @code
6090 * $wgSitemapNamespacesPriorities = array(
6091 * NS_USER => '0.9',
6092 * NS_HELP => '0.0',
6093 * );
6094 * @endcode
6096 $wgSitemapNamespacesPriorities = false;
6099 * If true, searches for IP addresses will be redirected to that IP's
6100 * contributions page. E.g. searching for "1.2.3.4" will redirect to
6101 * [[Special:Contributions/1.2.3.4]]
6103 $wgEnableSearchContributorsByIP = true;
6105 /** @} */ # end of search settings
6107 /************************************************************************//**
6108 * @name Edit user interface
6109 * @{
6113 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
6114 * fall back to the old behavior (no merging).
6116 $wgDiff3 = '/usr/bin/diff3';
6119 * Path to the GNU diff utility.
6121 $wgDiff = '/usr/bin/diff';
6124 * Which namespaces have special treatment where they should be preview-on-open
6125 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
6126 * can specify namespaces of pages they have special treatment for
6128 $wgPreviewOnOpenNamespaces = [
6129 NS_CATEGORY => true
6133 * Enable the UniversalEditButton for browsers that support it
6134 * (currently only Firefox with an extension)
6135 * See http://universaleditbutton.org for more background information
6137 $wgUniversalEditButton = true;
6140 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6141 * will try to automatically create one. This feature can be disabled by set-
6142 * ting this variable false.
6144 $wgUseAutomaticEditSummaries = true;
6146 /** @} */ # end edit UI }
6148 /************************************************************************//**
6149 * @name Maintenance
6150 * See also $wgSiteNotice
6151 * @{
6155 * @cond file_level_code
6156 * Set $wgCommandLineMode if it's not set already, to avoid notices
6158 if ( !isset( $wgCommandLineMode ) ) {
6159 $wgCommandLineMode = false;
6161 /** @endcond */
6164 * For colorized maintenance script output, is your terminal background dark ?
6166 $wgCommandLineDarkBg = false;
6169 * Set this to a string to put the wiki into read-only mode. The text will be
6170 * used as an explanation to users.
6172 * This prevents most write operations via the web interface. Cache updates may
6173 * still be possible. To prevent database writes completely, use the read_only
6174 * option in MySQL.
6176 $wgReadOnly = null;
6179 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6180 * Its contents will be shown to users as part of the read-only warning
6181 * message.
6183 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6185 $wgReadOnlyFile = false;
6188 * When you run the web-based upgrade utility, it will tell you what to set
6189 * this to in order to authorize the upgrade process. It will subsequently be
6190 * used as a password, to authorize further upgrades.
6192 * For security, do not set this to a guessable string. Use the value supplied
6193 * by the install/upgrade process. To cause the upgrader to generate a new key,
6194 * delete the old key from LocalSettings.php.
6196 $wgUpgradeKey = false;
6199 * Fully specified path to git binary
6201 $wgGitBin = '/usr/bin/git';
6204 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6206 * Key is a pattern passed to preg_match() and preg_replace(),
6207 * without the delimiters (which are #) and must match the whole URL.
6208 * The value is the replacement for the key (it can contain $1, etc.)
6209 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6210 * full SHA-1 of the HEAD revision.
6211 * %r will be replaced with a URL-encoded version of $1.
6212 * %R will be replaced with $1 and no URL-encoding
6214 * @since 1.20
6216 $wgGitRepositoryViewers = [
6217 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6218 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6219 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6220 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6223 /** @} */ # End of maintenance }
6225 /************************************************************************//**
6226 * @name Recent changes, new pages, watchlist and history
6227 * @{
6231 * Recentchanges items are periodically purged; entries older than this many
6232 * seconds will go.
6233 * Default: 90 days = about three months
6235 $wgRCMaxAge = 90 * 24 * 3600;
6238 * Page watchers inactive for more than this many seconds are considered inactive.
6239 * Used mainly by action=info. Default: 180 days = about six months.
6240 * @since 1.26
6242 $wgWatchersMaxAge = 180 * 24 * 3600;
6245 * If active watchers (per above) are this number or less, do not disclose it.
6246 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6247 * Set to -1 if you want to always complement watchers count with this info.
6248 * @since 1.26
6250 $wgUnwatchedPageSecret = 1;
6253 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6254 * higher than what will be stored. Note that this is disabled by default
6255 * because we sometimes do have RC data which is beyond the limit for some
6256 * reason, and some users may use the high numbers to display that data which
6257 * is still there.
6259 $wgRCFilterByAge = false;
6262 * List of Limits options to list in the Special:Recentchanges and
6263 * Special:Recentchangeslinked pages.
6265 $wgRCLinkLimits = [ 50, 100, 250, 500 ];
6268 * List of Days options to list in the Special:Recentchanges and
6269 * Special:Recentchangeslinked pages.
6271 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ];
6274 * Destinations to which notifications about recent changes
6275 * should be sent.
6277 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
6278 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
6279 * specified server.
6280 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
6282 * The common options are:
6283 * * 'uri' -- the address to which the notices are to be sent.
6284 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
6285 * produce the text to send. This can also be an object of the class.
6286 * * 'omit_bots' -- whether the bot edits should be in the feed
6287 * * 'omit_anon' -- whether anonymous edits should be in the feed
6288 * * 'omit_user' -- whether edits by registered users should be in the feed
6289 * * 'omit_minor' -- whether minor edits should be in the feed
6290 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
6292 * The IRC-specific options are:
6293 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
6294 * the first entry in the $wgLocalInterwikis array (or the value of
6295 * $wgLocalInterwiki, if set)
6297 * The JSON-specific options are:
6298 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6300 * @example $wgRCFeeds['example'] = array(
6301 * 'formatter' => 'JSONRCFeedFormatter',
6302 * 'uri' => "udp://localhost:1336",
6303 * 'add_interwiki_prefix' => false,
6304 * 'omit_bots' => true,
6305 * );
6306 * @example $wgRCFeeds['exampleirc'] = array(
6307 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6308 * 'uri' => "udp://localhost:1338",
6309 * 'add_interwiki_prefix' => false,
6310 * 'omit_bots' => true,
6311 * );
6312 * @since 1.22
6314 $wgRCFeeds = [];
6317 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
6318 * Keys are scheme names, values are names of engine classes.
6320 $wgRCEngines = [
6321 'redis' => 'RedisPubSubFeedEngine',
6322 'udp' => 'UDPRCFeedEngine',
6326 * Treat category membership changes as a RecentChange.
6327 * Changes are mentioned in RC for page actions as follows:
6328 * - creation: pages created with categories are mentioned
6329 * - edit: category additions/removals to existing pages are mentioned
6330 * - move: nothing is mentioned (unless templates used depend on the title)
6331 * - deletion: nothing is mentioned
6332 * - undeletion: nothing is mentioned
6334 * @since 1.27
6336 $wgRCWatchCategoryMembership = false;
6339 * Use RC Patrolling to check for vandalism (from recent changes and watchlists)
6340 * New pages and new files are included.
6342 $wgUseRCPatrol = true;
6345 * Use new page patrolling to check new pages on Special:Newpages
6347 $wgUseNPPatrol = true;
6350 * Use file patrolling to check new files on Special:Newfiles
6352 * @since 1.27
6354 $wgUseFilePatrol = true;
6357 * Log autopatrol actions to the log table
6359 $wgLogAutopatrol = true;
6362 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6364 $wgFeed = true;
6367 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6368 * eg Recentchanges, Newpages.
6370 $wgFeedLimit = 50;
6373 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6374 * A cached version will continue to be served out even if changes
6375 * are made, until this many seconds runs out since the last render.
6377 * If set to 0, feed caching is disabled. Use this for debugging only;
6378 * feed generation can be pretty slow with diffs.
6380 $wgFeedCacheTimeout = 60;
6383 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6384 * pages larger than this size.
6386 $wgFeedDiffCutoff = 32768;
6389 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6390 * every page. Some sites might have a different feed they'd like to promote
6391 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6392 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6393 * as value.
6394 * @par Example:
6395 * Configure the 'atom' feed to http://example.com/somefeed.xml
6396 * @code
6397 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6398 * @endcode
6400 $wgOverrideSiteFeed = [];
6403 * Available feeds objects.
6404 * Should probably only be defined when a page is syndicated ie when
6405 * $wgOut->isSyndicated() is true.
6407 $wgFeedClasses = [
6408 'rss' => 'RSSFeed',
6409 'atom' => 'AtomFeed',
6413 * Which feed types should we provide by default? This can include 'rss',
6414 * 'atom', neither, or both.
6416 $wgAdvertisedFeedTypes = [ 'atom' ];
6419 * Show watching users in recent changes, watchlist and page history views
6421 $wgRCShowWatchingUsers = false; # UPO
6424 * Show the amount of changed characters in recent changes
6426 $wgRCShowChangedSize = true;
6429 * If the difference between the character counts of the text
6430 * before and after the edit is below that value, the value will be
6431 * highlighted on the RC page.
6433 $wgRCChangedSizeThreshold = 500;
6436 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6437 * view for watched pages with new changes
6439 $wgShowUpdatedMarker = true;
6442 * Disable links to talk pages of anonymous users (IPs) in listings on special
6443 * pages like page history, Special:Recentchanges, etc.
6445 $wgDisableAnonTalk = false;
6448 * Enable filtering of categories in Recentchanges
6450 $wgAllowCategorizedRecentChanges = false;
6453 * Allow filtering by change tag in recentchanges, history, etc
6454 * Has no effect if no tags are defined in valid_tag.
6456 $wgUseTagFilter = true;
6459 * If set to an integer, pages that are watched by this many users or more
6460 * will not require the unwatchedpages permission to view the number of
6461 * watchers.
6463 * @since 1.21
6465 $wgUnwatchedPageThreshold = false;
6468 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6469 * certain types of edits.
6471 * To register a new one:
6472 * @code
6473 * $wgRecentChangesFlags['flag'] => array(
6474 * // message for the letter displayed next to rows on changes lists
6475 * 'letter' => 'letter-msg',
6476 * // message for the tooltip of the letter
6477 * 'title' => 'tooltip-msg',
6478 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6479 * 'legend' => 'legend-msg',
6480 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6481 * 'class' => 'css-class',
6482 * // optional (defaults to 'any'), how top-level flag is determined. 'any'
6483 * // will set the top-level flag if any line contains the flag, 'all' will
6484 * // only be set if all lines contain the flag.
6485 * 'grouping' => 'any',
6486 * );
6487 * @endcode
6489 * @since 1.22
6491 $wgRecentChangesFlags = [
6492 'newpage' => [
6493 'letter' => 'newpageletter',
6494 'title' => 'recentchanges-label-newpage',
6495 'legend' => 'recentchanges-legend-newpage',
6496 'grouping' => 'any',
6498 'minor' => [
6499 'letter' => 'minoreditletter',
6500 'title' => 'recentchanges-label-minor',
6501 'legend' => 'recentchanges-legend-minor',
6502 'class' => 'minoredit',
6503 'grouping' => 'all',
6505 'bot' => [
6506 'letter' => 'boteditletter',
6507 'title' => 'recentchanges-label-bot',
6508 'legend' => 'recentchanges-legend-bot',
6509 'class' => 'botedit',
6510 'grouping' => 'all',
6512 'unpatrolled' => [
6513 'letter' => 'unpatrolledletter',
6514 'title' => 'recentchanges-label-unpatrolled',
6515 'legend' => 'recentchanges-legend-unpatrolled',
6516 'grouping' => 'any',
6520 /** @} */ # end RC/watchlist }
6522 /************************************************************************//**
6523 * @name Copyright and credits settings
6524 * @{
6528 * Override for copyright metadata.
6530 * This is the name of the page containing information about the wiki's copyright status,
6531 * which will be added as a link in the footer if it is specified. It overrides
6532 * $wgRightsUrl if both are specified.
6534 $wgRightsPage = null;
6537 * Set this to specify an external URL containing details about the content license used on your
6538 * wiki.
6539 * If $wgRightsPage is set then this setting is ignored.
6541 $wgRightsUrl = null;
6544 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6545 * link.
6546 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6547 * of the page will also be used as the link if this variable is not set.
6549 $wgRightsText = null;
6552 * Override for copyright metadata.
6554 $wgRightsIcon = null;
6557 * Set this to true if you want detailed copyright information forms on Upload.
6559 $wgUseCopyrightUpload = false;
6562 * Set this to the number of authors that you want to be credited below an
6563 * article text. Set it to zero to hide the attribution block, and a negative
6564 * number (like -1) to show all authors. Note that this will require 2-3 extra
6565 * database hits, which can have a not insignificant impact on performance for
6566 * large wikis.
6568 $wgMaxCredits = 0;
6571 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6572 * Otherwise, link to a separate credits page.
6574 $wgShowCreditsIfMax = true;
6576 /** @} */ # end of copyright and credits settings }
6578 /************************************************************************//**
6579 * @name Import / Export
6580 * @{
6584 * List of interwiki prefixes for wikis we'll accept as sources for
6585 * Special:Import and API action=import. Since complete page history can be
6586 * imported, these should be 'trusted'.
6588 * This can either be a regular array, or an associative map specifying
6589 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6590 * e.g.
6591 * @code
6592 * $wgImportSources = array(
6593 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6594 * 'wikispecies',
6595 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6596 * );
6597 * @endcode
6599 * If you have a very complex import sources setup, you can lazy-load it using
6600 * the ImportSources hook.
6602 * If a user has the 'import' permission but not the 'importupload' permission,
6603 * they will only be able to run imports through this transwiki interface.
6605 $wgImportSources = [];
6608 * Optional default target namespace for interwiki imports.
6609 * Can use this to create an incoming "transwiki"-style queue.
6610 * Set to numeric key, not the name.
6612 * Users may override this in the Special:Import dialog.
6614 $wgImportTargetNamespace = null;
6617 * If set to false, disables the full-history option on Special:Export.
6618 * This is currently poorly optimized for long edit histories, so is
6619 * disabled on Wikimedia's sites.
6621 $wgExportAllowHistory = true;
6624 * If set nonzero, Special:Export requests for history of pages with
6625 * more revisions than this will be rejected. On some big sites things
6626 * could get bogged down by very very long pages.
6628 $wgExportMaxHistory = 0;
6631 * Return distinct author list (when not returning full history)
6633 $wgExportAllowListContributors = false;
6636 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6637 * up to this specified level, which will cause it to include all
6638 * pages linked to from the pages you specify. Since this number
6639 * can become *insanely large* and could easily break your wiki,
6640 * it's disabled by default for now.
6642 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6643 * crazy-big export from being done by someone setting the depth number too
6644 * high. In other words, last resort safety net.
6646 $wgExportMaxLinkDepth = 0;
6649 * Whether to allow the "export all pages in namespace" option
6651 $wgExportFromNamespaces = false;
6654 * Whether to allow exporting the entire wiki into a single file
6656 $wgExportAllowAll = false;
6659 * Maximum number of pages returned by the GetPagesFromCategory and
6660 * GetPagesFromNamespace functions.
6662 * @since 1.27
6664 $wgExportPagelistLimit = 5000;
6666 /** @} */ # end of import/export }
6668 /*************************************************************************//**
6669 * @name Extensions
6670 * @{
6674 * A list of callback functions which are called once MediaWiki is fully
6675 * initialised
6677 $wgExtensionFunctions = [];
6680 * Extension messages files.
6682 * Associative array mapping extension name to the filename where messages can be
6683 * found. The file should contain variable assignments. Any of the variables
6684 * present in languages/messages/MessagesEn.php may be defined, but $messages
6685 * is the most common.
6687 * Variables defined in extensions will override conflicting variables defined
6688 * in the core.
6690 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6691 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6692 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6693 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6695 * Extensions using the JSON message format can preserve backward compatibility with
6696 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6697 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6698 * as for the $wgMessagesDirs entry.
6700 * @par Example:
6701 * @code
6702 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6703 * @endcode
6705 $wgExtensionMessagesFiles = [];
6708 * Extension messages directories.
6710 * Associative array mapping extension name to the path of the directory where message files can
6711 * be found. The message files are expected to be JSON files named for their language code, e.g.
6712 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6713 * message directories.
6715 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6717 * @par Simple example:
6718 * @code
6719 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6720 * @endcode
6722 * @par Complex example:
6723 * @code
6724 * $wgMessagesDirs['Example'] = array(
6725 * __DIR__ . '/lib/ve/i18n',
6726 * __DIR__ . '/lib/oojs-ui/i18n',
6727 * __DIR__ . '/i18n',
6729 * @endcode
6730 * @since 1.23
6732 $wgMessagesDirs = [];
6735 * Array of files with list(s) of extension entry points to be used in
6736 * maintenance/mergeMessageFileList.php
6737 * @since 1.22
6739 $wgExtensionEntryPointListFiles = [];
6742 * Parser output hooks.
6743 * This is an associative array where the key is an extension-defined tag
6744 * (typically the extension name), and the value is a PHP callback.
6745 * These will be called as an OutputPageParserOutput hook, if the relevant
6746 * tag has been registered with the parser output object.
6748 * Registration is done with $pout->addOutputHook( $tag, $data ).
6750 * The callback has the form:
6751 * @code
6752 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6753 * @endcode
6755 $wgParserOutputHooks = [];
6758 * Whether to include the NewPP limit report as a HTML comment
6760 $wgEnableParserLimitReporting = true;
6763 * List of valid skin names
6765 * The key should be the name in all lower case, the value should be a properly
6766 * cased name for the skin. This value will be prefixed with "Skin" to create
6767 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6768 * if you wish to have access to the full list.
6770 $wgValidSkinNames = [];
6773 * Special page list. This is an associative array mapping the (canonical) names of
6774 * special pages to either a class name to be instantiated, or a callback to use for
6775 * creating the special page object. In both cases, the result must be an instance of
6776 * SpecialPage.
6778 $wgSpecialPages = [];
6781 * Array mapping class names to filenames, for autoloading.
6783 $wgAutoloadClasses = [];
6786 * Switch controlling legacy case-insensitive classloading.
6787 * Do not disable if your wiki must support data created by PHP4, or by
6788 * MediaWiki 1.4 or earlier.
6790 $wgAutoloadAttemptLowercase = true;
6793 * An array of information about installed extensions keyed by their type.
6795 * All but 'name', 'path' and 'author' can be omitted.
6797 * @code
6798 * $wgExtensionCredits[$type][] = array(
6799 * 'path' => __FILE__,
6800 * 'name' => 'Example extension',
6801 * 'namemsg' => 'exampleextension-name',
6802 * 'author' => array(
6803 * 'Foo Barstein',
6804 * ),
6805 * 'version' => '1.9.0',
6806 * 'url' => 'http://example.org/example-extension/',
6807 * 'descriptionmsg' => 'exampleextension-desc',
6808 * 'license-name' => 'GPL-2.0+',
6809 * );
6810 * @endcode
6812 * The extensions are listed on Special:Version. This page also looks for a file
6813 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6814 * view said file. When the 'license-name' key is specified, this file is
6815 * interpreted as wikitext.
6817 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6818 * 'skin', 'api', or 'other', or any additional types as specified through the
6819 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6821 * - name: Name of extension as an inline string instead of localizable message.
6822 * Do not omit this even if 'namemsg' is provided, as it is used to override
6823 * the path Special:Version uses to find extension's license info, and is
6824 * required for backwards-compatibility with MediaWiki 1.23 and older.
6826 * - namemsg (since MW 1.24): A message key for a message containing the
6827 * extension's name, if the name is localizable. (For example, skin names
6828 * usually are.)
6830 * - author: A string or an array of strings. Authors can be linked using
6831 * the regular wikitext link syntax. To have an internationalized version of
6832 * "and others" show, add an element "...". This element can also be linked,
6833 * for instance "[http://example ...]".
6835 * - descriptionmsg: A message key or an an array with message key and parameters:
6836 * `'descriptionmsg' => 'exampleextension-desc',`
6838 * - description: Description of extension as an inline string instead of
6839 * localizable message (omit in favour of 'descriptionmsg').
6841 * - license-name: Short name of the license (used as label for the link), such
6842 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6844 $wgExtensionCredits = [];
6847 * Authentication plugin.
6848 * @var $wgAuth AuthPlugin
6850 $wgAuth = null;
6853 * Global list of hooks.
6855 * The key is one of the events made available by MediaWiki, you can find
6856 * a description for most of them in docs/hooks.txt. The array is used
6857 * internally by Hook:run().
6859 * The value can be one of:
6861 * - A function name:
6862 * @code
6863 * $wgHooks['event_name'][] = $function;
6864 * @endcode
6865 * - A function with some data:
6866 * @code
6867 * $wgHooks['event_name'][] = array( $function, $data );
6868 * @endcode
6869 * - A an object method:
6870 * @code
6871 * $wgHooks['event_name'][] = array( $object, 'method' );
6872 * @endcode
6873 * - A closure:
6874 * @code
6875 * $wgHooks['event_name'][] = function ( $hookParam ) {
6876 * // Handler code goes here.
6877 * };
6878 * @endcode
6880 * @warning You should always append to an event array or you will end up
6881 * deleting a previous registered hook.
6883 * @warning Hook handlers should be registered at file scope. Registering
6884 * handlers after file scope can lead to unexpected results due to caching.
6886 $wgHooks = [];
6889 * List of service wiring files to be loaded by the default instance of MediaWikiServices.
6890 * Each file listed here is expected to return an associative array mapping service names
6891 * to instantiator functions. Extensions may add wiring files to define their own services.
6892 * However, this cannot be used to replace existing services - use the MediaWikiServices
6893 * hook for that.
6895 * @see MediaWikiServices
6896 * @see ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
6897 * @see docs/injection.txt for an overview of dependency injection in MediaWiki.
6899 $wgServiceWiringFiles = [
6900 __DIR__ . '/ServiceWiring.php'
6904 * Maps jobs to their handling classes; extensions
6905 * can add to this to provide custom jobs
6907 $wgJobClasses = [
6908 'refreshLinks' => 'RefreshLinksJob',
6909 'deleteLinks' => 'DeleteLinksJob',
6910 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6911 'sendMail' => 'EmaillingJob',
6912 'enotifNotify' => 'EnotifNotifyJob',
6913 'fixDoubleRedirect' => 'DoubleRedirectJob',
6914 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6915 'PublishStashedFile' => 'PublishStashedFileJob',
6916 'ThumbnailRender' => 'ThumbnailRenderJob',
6917 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6918 'refreshLinksPrioritized' => 'RefreshLinksJob',
6919 'refreshLinksDynamic' => 'RefreshLinksJob',
6920 'activityUpdateJob' => 'ActivityUpdateJob',
6921 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
6922 'cdnPurge' => 'CdnPurgeJob',
6923 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
6924 'null' => 'NullJob'
6928 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6929 * special flags are set. The values here are keys of $wgJobClasses.
6931 * These can be:
6932 * - Very long-running jobs.
6933 * - Jobs that you would never want to run as part of a page rendering request.
6934 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6935 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6936 * These settings should be global to all wikis.
6938 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ];
6941 * Map of job types to how many job "work items" should be run per second
6942 * on each job runner process. The meaning of "work items" varies per job,
6943 * but typically would be something like "pages to update". A single job
6944 * may have a variable number of work items, as is the case with batch jobs.
6945 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6946 * These settings should be global to all wikis.
6947 * @var float[]
6949 $wgJobBackoffThrottling = [];
6952 * Make job runners commit changes for slave-lag prone jobs one job at a time.
6953 * This is useful if there are many job workers that race on slave lag checks.
6954 * If set, jobs taking this many seconds of DB write time have serialized commits.
6956 * Note that affected jobs may have worse lock contention. Also, if they affect
6957 * several DBs at once they may have a smaller chance of being atomic due to the
6958 * possibility of connection loss while queueing up to commit. Affected jobs may
6959 * also fail due to the commit lock acquisition timeout.
6961 * @var float|bool
6962 * @since 1.26
6964 $wgJobSerialCommitThreshold = false;
6967 * Map of job types to configuration arrays.
6968 * This determines which queue class and storage system is used for each job type.
6969 * Job types that do not have explicit configuration will use the 'default' config.
6970 * These settings should be global to all wikis.
6972 $wgJobTypeConf = [
6973 'default' => [ 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ],
6977 * Which aggregator to use for tracking which queues have jobs.
6978 * These settings should be global to all wikis.
6980 $wgJobQueueAggregator = [
6981 'class' => 'JobQueueAggregatorNull'
6985 * Additional functions to be performed with updateSpecialPages.
6986 * Expensive Querypages are already updated.
6988 $wgSpecialPageCacheUpdates = [
6989 'Statistics' => [ 'SiteStatsUpdate', 'cacheUpdate' ]
6993 * Hooks that are used for outputting exceptions. Format is:
6994 * $wgExceptionHooks[] = $funcname
6995 * or:
6996 * $wgExceptionHooks[] = array( $class, $funcname )
6997 * Hooks should return strings or false
6999 $wgExceptionHooks = [];
7002 * Page property link table invalidation lists. When a page property
7003 * changes, this may require other link tables to be updated (eg
7004 * adding __HIDDENCAT__ means the hiddencat tracking category will
7005 * have been added, so the categorylinks table needs to be rebuilt).
7006 * This array can be added to by extensions.
7008 $wgPagePropLinkInvalidations = [
7009 'hiddencat' => 'categorylinks',
7012 /** @} */ # End extensions }
7014 /*************************************************************************//**
7015 * @name Categories
7016 * @{
7020 * Use experimental, DMOZ-like category browser
7022 $wgUseCategoryBrowser = false;
7025 * On category pages, show thumbnail gallery for images belonging to that
7026 * category instead of listing them as articles.
7028 $wgCategoryMagicGallery = true;
7031 * Paging limit for categories
7033 $wgCategoryPagingLimit = 200;
7036 * Specify how category names should be sorted, when listed on a category page.
7037 * A sorting scheme is also known as a collation.
7039 * Available values are:
7041 * - uppercase: Converts the category name to upper case, and sorts by that.
7043 * - identity: Does no conversion. Sorts by binary value of the string.
7045 * - uca-default: Provides access to the Unicode Collation Algorithm with
7046 * the default element table. This is a compromise collation which sorts
7047 * all languages in a mediocre way. However, it is better than "uppercase".
7049 * To use the uca-default collation, you must have PHP's intl extension
7050 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
7051 * resulting collation will depend on the version of ICU installed on the
7052 * server.
7054 * After you change this, you must run maintenance/updateCollation.php to fix
7055 * the sort keys in the database.
7057 * Extensions can define there own collations by subclassing Collation
7058 * and using the Collation::factory hook.
7060 $wgCategoryCollation = 'uppercase';
7062 /** @} */ # End categories }
7064 /*************************************************************************//**
7065 * @name Logging
7066 * @{
7070 * The logging system has two levels: an event type, which describes the
7071 * general category and can be viewed as a named subset of all logs; and
7072 * an action, which is a specific kind of event that can exist in that
7073 * log type.
7075 $wgLogTypes = [
7077 'block',
7078 'protect',
7079 'rights',
7080 'delete',
7081 'upload',
7082 'move',
7083 'import',
7084 'patrol',
7085 'merge',
7086 'suppress',
7087 'tag',
7088 'managetags',
7089 'contentmodel',
7093 * This restricts log access to those who have a certain right
7094 * Users without this will not see it in the option menu and can not view it
7095 * Restricted logs are not added to recent changes
7096 * Logs should remain non-transcludable
7097 * Format: logtype => permissiontype
7099 $wgLogRestrictions = [
7100 'suppress' => 'suppressionlog'
7104 * Show/hide links on Special:Log will be shown for these log types.
7106 * This is associative array of log type => boolean "hide by default"
7108 * See $wgLogTypes for a list of available log types.
7110 * @par Example:
7111 * @code
7112 * $wgFilterLogTypes = array(
7113 * 'move' => true,
7114 * 'import' => false,
7115 * );
7116 * @endcode
7118 * Will display show/hide links for the move and import logs. Move logs will be
7119 * hidden by default unless the link is clicked. Import logs will be shown by
7120 * default, and hidden when the link is clicked.
7122 * A message of the form log-show-hide-[type] should be added, and will be used
7123 * for the link text.
7125 $wgFilterLogTypes = [
7126 'patrol' => true,
7127 'tag' => true,
7131 * Lists the message key string for each log type. The localized messages
7132 * will be listed in the user interface.
7134 * Extensions with custom log types may add to this array.
7136 * @since 1.19, if you follow the naming convention log-name-TYPE,
7137 * where TYPE is your log type, yoy don't need to use this array.
7139 $wgLogNames = [
7140 '' => 'all-logs-page',
7141 'block' => 'blocklogpage',
7142 'protect' => 'protectlogpage',
7143 'rights' => 'rightslog',
7144 'delete' => 'dellogpage',
7145 'upload' => 'uploadlogpage',
7146 'move' => 'movelogpage',
7147 'import' => 'importlogpage',
7148 'patrol' => 'patrol-log-page',
7149 'merge' => 'mergelog',
7150 'suppress' => 'suppressionlog',
7154 * Lists the message key string for descriptive text to be shown at the
7155 * top of each log type.
7157 * Extensions with custom log types may add to this array.
7159 * @since 1.19, if you follow the naming convention log-description-TYPE,
7160 * where TYPE is your log type, yoy don't need to use this array.
7162 $wgLogHeaders = [
7163 '' => 'alllogstext',
7164 'block' => 'blocklogtext',
7165 'delete' => 'dellogpagetext',
7166 'import' => 'importlogpagetext',
7167 'merge' => 'mergelogpagetext',
7168 'move' => 'movelogpagetext',
7169 'patrol' => 'patrol-log-header',
7170 'protect' => 'protectlogtext',
7171 'rights' => 'rightslogtext',
7172 'suppress' => 'suppressionlogtext',
7173 'upload' => 'uploadlogpagetext',
7177 * Lists the message key string for formatting individual events of each
7178 * type and action when listed in the logs.
7180 * Extensions with custom log types may add to this array.
7182 $wgLogActions = [];
7185 * The same as above, but here values are names of classes,
7186 * not messages.
7187 * @see LogPage::actionText
7188 * @see LogFormatter
7190 $wgLogActionsHandlers = [
7191 'block/block' => 'BlockLogFormatter',
7192 'block/reblock' => 'BlockLogFormatter',
7193 'block/unblock' => 'BlockLogFormatter',
7194 'contentmodel/change' => 'ContentModelLogFormatter',
7195 'contentmodel/new' => 'ContentModelLogFormatter',
7196 'delete/delete' => 'DeleteLogFormatter',
7197 'delete/event' => 'DeleteLogFormatter',
7198 'delete/restore' => 'DeleteLogFormatter',
7199 'delete/revision' => 'DeleteLogFormatter',
7200 'import/interwiki' => 'ImportLogFormatter',
7201 'import/upload' => 'ImportLogFormatter',
7202 'managetags/activate' => 'LogFormatter',
7203 'managetags/create' => 'LogFormatter',
7204 'managetags/deactivate' => 'LogFormatter',
7205 'managetags/delete' => 'LogFormatter',
7206 'merge/merge' => 'MergeLogFormatter',
7207 'move/move' => 'MoveLogFormatter',
7208 'move/move_redir' => 'MoveLogFormatter',
7209 'patrol/patrol' => 'PatrolLogFormatter',
7210 'patrol/autopatrol' => 'PatrolLogFormatter',
7211 'protect/modify' => 'ProtectLogFormatter',
7212 'protect/move_prot' => 'ProtectLogFormatter',
7213 'protect/protect' => 'ProtectLogFormatter',
7214 'protect/unprotect' => 'ProtectLogFormatter',
7215 'rights/autopromote' => 'RightsLogFormatter',
7216 'rights/rights' => 'RightsLogFormatter',
7217 'suppress/block' => 'BlockLogFormatter',
7218 'suppress/delete' => 'DeleteLogFormatter',
7219 'suppress/event' => 'DeleteLogFormatter',
7220 'suppress/reblock' => 'BlockLogFormatter',
7221 'suppress/revision' => 'DeleteLogFormatter',
7222 'tag/update' => 'TagLogFormatter',
7223 'upload/overwrite' => 'UploadLogFormatter',
7224 'upload/revert' => 'UploadLogFormatter',
7225 'upload/upload' => 'UploadLogFormatter',
7229 * List of log types that can be filtered by action types
7231 * To each action is associated the list of log_action
7232 * subtypes to search for, usually one, but not necessarily so
7233 * Extensions may append to this array
7234 * @since 1.27
7236 $wgActionFilteredLogs = [
7237 'block' => [
7238 'block' => [ 'block' ],
7239 'reblock' => [ 'reblock' ],
7240 'unblock' => [ 'unblock' ],
7242 'contentmodel' => [
7243 'change' => [ 'change' ],
7244 'new' => [ 'new' ],
7246 'delete' => [
7247 'delete' => [ 'delete' ],
7248 'restore' => [ 'restore' ],
7249 'event' => [ 'event' ],
7250 'revision' => [ 'revision' ],
7252 'import' => [
7253 'interwiki' => [ 'interwiki' ],
7254 'upload' => [ 'upload' ],
7256 'managetags' => [
7257 'create' => [ 'create' ],
7258 'delete' => [ 'delete' ],
7259 'activate' => [ 'activate' ],
7260 'deactivate' => [ 'deactivate' ],
7262 'move' => [
7263 'move' => [ 'move' ],
7264 'move_redir' => [ 'move_redir' ],
7266 'newusers' => [
7267 'create' => [ 'create', 'newusers' ],
7268 'create2' => ['create2' ],
7269 'autocreate' => [ 'autocreate' ],
7270 'byemail' => [ 'byemail' ],
7272 'patrol' => [
7273 'patrol' => [ 'patrol' ],
7274 'autopatrol' => [ 'autopatrol' ],
7276 'protect' => [
7277 'protect' => [ 'protect' ],
7278 'modify' => [ 'modify' ],
7279 'unprotect' => [ 'unprotect' ],
7280 'move_prot' => ['move_prot'],
7282 'rights' => [
7283 'rights' => [ 'rights' ],
7284 'autopromote' => [ 'autopromote' ],
7286 'suppress' => [
7287 'event' => [ 'event' ],
7288 'revision' => [ 'revision' ],
7289 'delete' => [ 'delete' ],
7290 'block' => [ 'block' ],
7291 'reblock' => [ 'reblock' ],
7293 'upload' => [
7294 'upload' => [ 'upload' ],
7295 'overwrite' => [ 'overwrite' ],
7300 * Maintain a log of newusers at Log/newusers?
7302 $wgNewUserLog = true;
7304 /** @} */ # end logging }
7306 /*************************************************************************//**
7307 * @name Special pages (general and miscellaneous)
7308 * @{
7312 * Allow special page inclusions such as {{Special:Allpages}}
7314 $wgAllowSpecialInclusion = true;
7317 * Set this to an array of special page names to prevent
7318 * maintenance/updateSpecialPages.php from updating those pages.
7320 $wgDisableQueryPageUpdate = false;
7323 * On Special:Unusedimages, consider images "used", if they are put
7324 * into a category. Default (false) is not to count those as used.
7326 $wgCountCategorizedImagesAsUsed = false;
7329 * Maximum number of links to a redirect page listed on
7330 * Special:Whatlinkshere/RedirectDestination
7332 $wgMaxRedirectLinksRetrieved = 500;
7334 /** @} */ # end special pages }
7336 /*************************************************************************//**
7337 * @name Actions
7338 * @{
7342 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7343 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7344 * 'foo' => true Load the class FooAction which subclasses Action
7345 * If something is specified in the getActionOverrides()
7346 * of the relevant Page object it will be used
7347 * instead of the default class.
7348 * 'foo' => false The action is disabled; show an error message
7349 * Unsetting core actions will probably cause things to complain loudly.
7351 $wgActions = [
7352 'credits' => true,
7353 'delete' => true,
7354 'edit' => true,
7355 'editchangetags' => 'SpecialPageAction',
7356 'history' => true,
7357 'info' => true,
7358 'markpatrolled' => true,
7359 'protect' => true,
7360 'purge' => true,
7361 'raw' => true,
7362 'render' => true,
7363 'revert' => true,
7364 'revisiondelete' => 'SpecialPageAction',
7365 'rollback' => true,
7366 'submit' => true,
7367 'unprotect' => true,
7368 'unwatch' => true,
7369 'view' => true,
7370 'watch' => true,
7373 /** @} */ # end actions }
7375 /*************************************************************************//**
7376 * @name Robot (search engine crawler) policy
7377 * See also $wgNoFollowLinks.
7378 * @{
7382 * Default robot policy. The default policy is to encourage indexing and fol-
7383 * lowing of links. It may be overridden on a per-namespace and/or per-page
7384 * basis.
7386 $wgDefaultRobotPolicy = 'index,follow';
7389 * Robot policies per namespaces. The default policy is given above, the array
7390 * is made of namespace constants as defined in includes/Defines.php. You can-
7391 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7392 * nofollow. This is because a number of special pages (e.g., ListPages) have
7393 * many permutations of options that display the same data under redundant
7394 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7395 * pages, all alike, and never reaching your actual content.
7397 * @par Example:
7398 * @code
7399 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
7400 * @endcode
7402 $wgNamespaceRobotPolicies = [];
7405 * Robot policies per article. These override the per-namespace robot policies.
7406 * Must be in the form of an array where the key part is a properly canonicalised
7407 * text form title and the value is a robot policy.
7409 * @par Example:
7410 * @code
7411 * $wgArticleRobotPolicies = array(
7412 * 'Main Page' => 'noindex,follow',
7413 * 'User:Bob' => 'index,follow',
7414 * );
7415 * @endcode
7417 * @par Example that DOES NOT WORK because the names are not canonical text
7418 * forms:
7419 * @code
7420 * $wgArticleRobotPolicies = array(
7421 * # Underscore, not space!
7422 * 'Main_Page' => 'noindex,follow',
7423 * # "Project", not the actual project name!
7424 * 'Project:X' => 'index,follow',
7425 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7426 * 'abc' => 'noindex,nofollow'
7427 * );
7428 * @endcode
7430 $wgArticleRobotPolicies = [];
7433 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7434 * will not function, so users can't decide whether pages in that namespace are
7435 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7437 * @par Example:
7438 * @code
7439 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
7440 * @endcode
7442 $wgExemptFromUserRobotsControl = null;
7444 /** @} */ # End robot policy }
7446 /************************************************************************//**
7447 * @name AJAX and API
7448 * Note: The AJAX entry point which this section refers to is gradually being
7449 * replaced by the API entry point, api.php. They are essentially equivalent.
7450 * Both of them are used for dynamic client-side features, via XHR.
7451 * @{
7455 * Enable the MediaWiki API for convenient access to
7456 * machine-readable data via api.php
7458 * See https://www.mediawiki.org/wiki/API
7460 $wgEnableAPI = true;
7463 * Allow the API to be used to perform write operations
7464 * (page edits, rollback, etc.) when an authorised user
7465 * accesses it
7467 $wgEnableWriteAPI = true;
7471 * WARNING: SECURITY THREAT - debug use only
7473 * Disables many security checks in the API for debugging purposes.
7474 * This flag should never be used on the production servers, as it introduces
7475 * a number of potential security holes. Even when enabled, the validation
7476 * will still be performed, but instead of failing, API will return a warning.
7477 * Also, there will always be a warning notifying that this flag is set.
7478 * At this point, the flag allows GET requests to go through for modules
7479 * requiring POST.
7481 * @since 1.21
7483 $wgDebugAPI = false;
7486 * API module extensions.
7488 * Associative array mapping module name to modules specs;
7489 * Each module spec is an associative array containing at least
7490 * the 'class' key for the module's class, and optionally a
7491 * 'factory' key for the factory function to use for the module.
7493 * That factory function will be called with two parameters,
7494 * the parent module (an instance of ApiBase, usually ApiMain)
7495 * and the name the module was registered under. The return
7496 * value must be an instance of the class given in the 'class'
7497 * field.
7499 * For backward compatibility, the module spec may also be a
7500 * simple string containing the module's class name. In that
7501 * case, the class' constructor will be called with the parent
7502 * module and module name as parameters, as described above.
7504 * Examples for registering API modules:
7506 * @code
7507 * $wgAPIModules['foo'] = 'ApiFoo';
7508 * $wgAPIModules['bar'] = array(
7509 * 'class' => 'ApiBar',
7510 * 'factory' => function( $main, $name ) { ... }
7511 * );
7512 * $wgAPIModules['xyzzy'] = array(
7513 * 'class' => 'ApiXyzzy',
7514 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
7515 * );
7516 * @endcode
7518 * Extension modules may override the core modules.
7519 * See ApiMain::$Modules for a list of the core modules.
7521 $wgAPIModules = [];
7524 * API format module extensions.
7525 * Associative array mapping format module name to module specs (see $wgAPIModules).
7526 * Extension modules may override the core modules.
7528 * See ApiMain::$Formats for a list of the core format modules.
7530 $wgAPIFormatModules = [];
7533 * API Query meta module extensions.
7534 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7535 * Extension modules may override the core modules.
7537 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7539 $wgAPIMetaModules = [];
7542 * API Query prop module extensions.
7543 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7544 * Extension modules may override the core modules.
7546 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7548 $wgAPIPropModules = [];
7551 * API Query list module extensions.
7552 * Associative array mapping list module name to module specs (see $wgAPIModules).
7553 * Extension modules may override the core modules.
7555 * See ApiQuery::$QueryListModules for a list of the core list modules.
7557 $wgAPIListModules = [];
7560 * Maximum amount of rows to scan in a DB query in the API
7561 * The default value is generally fine
7563 $wgAPIMaxDBRows = 5000;
7566 * The maximum size (in bytes) of an API result.
7567 * @warning Do not set this lower than $wgMaxArticleSize*1024
7569 $wgAPIMaxResultSize = 8388608;
7572 * The maximum number of uncached diffs that can be retrieved in one API
7573 * request. Set this to 0 to disable API diffs altogether
7575 $wgAPIMaxUncachedDiffs = 1;
7578 * Maximum amount of DB lag on a majority of DB slaves to tolerate
7579 * before forcing bots to retry any write requests via API errors.
7580 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
7582 $wgAPIMaxLagThreshold = 7;
7585 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7586 * API request logging
7588 $wgAPIRequestLog = false;
7591 * Set the timeout for the API help text cache. If set to 0, caching disabled
7593 $wgAPICacheHelpTimeout = 60 * 60;
7596 * The ApiQueryQueryPages module should skip pages that are redundant to true
7597 * API queries.
7599 $wgAPIUselessQueryPages = [
7600 'MIMEsearch', // aiprop=mime
7601 'LinkSearch', // list=exturlusage
7602 'FileDuplicateSearch', // prop=duplicatefiles
7606 * Enable AJAX framework
7608 $wgUseAjax = true;
7611 * List of Ajax-callable functions.
7612 * Extensions acting as Ajax callbacks must register here
7613 * @deprecated (officially) since 1.27; use the API instead
7615 $wgAjaxExportList = [];
7618 * Enable AJAX check for file overwrite, pre-upload
7620 $wgAjaxUploadDestCheck = true;
7623 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7625 $wgAjaxLicensePreview = true;
7628 * Have clients send edits to be prepared when filling in edit summaries.
7629 * This gives the server a head start on the expensive parsing operation.
7631 $wgAjaxEditStash = true;
7634 * Settings for incoming cross-site AJAX requests:
7635 * Newer browsers support cross-site AJAX when the target resource allows requests
7636 * from the origin domain by the Access-Control-Allow-Origin header.
7637 * This is currently only used by the API (requests to api.php)
7638 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7640 * - '*' matches any number of characters
7641 * - '?' matches any 1 character
7643 * @par Example:
7644 * @code
7645 * $wgCrossSiteAJAXdomains = array(
7646 * 'www.mediawiki.org',
7647 * '*.wikipedia.org',
7648 * '*.wikimedia.org',
7649 * '*.wiktionary.org',
7650 * );
7651 * @endcode
7653 $wgCrossSiteAJAXdomains = [];
7656 * Domains that should not be allowed to make AJAX requests,
7657 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7658 * Uses the same syntax as $wgCrossSiteAJAXdomains
7660 $wgCrossSiteAJAXdomainExceptions = [];
7662 /** @} */ # End AJAX and API }
7664 /************************************************************************//**
7665 * @name Shell and process control
7666 * @{
7670 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7672 $wgMaxShellMemory = 307200;
7675 * Maximum file size created by shell processes under linux, in KB
7676 * ImageMagick convert for example can be fairly hungry for scratch space
7678 $wgMaxShellFileSize = 102400;
7681 * Maximum CPU time in seconds for shell processes under Linux
7683 $wgMaxShellTime = 180;
7686 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7687 * would measure) in seconds for shell processes under Linux
7689 $wgMaxShellWallClockTime = 180;
7692 * Under Linux: a cgroup directory used to constrain memory usage of shell
7693 * commands. The directory must be writable by the user which runs MediaWiki.
7695 * If specified, this is used instead of ulimit, which is inaccurate, and
7696 * causes malloc() to return NULL, which exposes bugs in C applications, making
7697 * them segfault or deadlock.
7699 * A wrapper script will create a cgroup for each shell command that runs, as
7700 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7701 * kernel will send a SIGKILL signal to a process in the subgroup.
7703 * @par Example:
7704 * @code
7705 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7706 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7707 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7708 * @endcode
7710 * The reliability of cgroup cleanup can be improved by installing a
7711 * notify_on_release script in the root cgroup, see e.g.
7712 * https://gerrit.wikimedia.org/r/#/c/40784
7714 $wgShellCgroup = false;
7717 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7719 $wgPhpCli = '/usr/bin/php';
7722 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7723 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7724 * character set. Only the character set is relevant.
7726 $wgShellLocale = 'en_US.utf8';
7728 /** @} */ # End shell }
7730 /************************************************************************//**
7731 * @name HTTP client
7732 * @{
7736 * Timeout for HTTP requests done internally, in seconds.
7738 $wgHTTPTimeout = 25;
7741 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7743 $wgAsyncHTTPTimeout = 25;
7746 * Proxy to use for CURL requests.
7748 $wgHTTPProxy = false;
7751 * Local virtual hosts.
7753 * This lists domains that are configured as virtual hosts on the same machine.
7754 * If a request is to be made to a domain listed here, or any subdomain thereof,
7755 * then no proxy will be used.
7756 * Command-line scripts are not affected by this setting and will always use
7757 * proxy if it is configured.
7758 * @since 1.25
7760 $wgLocalVirtualHosts = [];
7763 * Timeout for connections done internally (in seconds)
7764 * Only works for curl
7766 $wgHTTPConnectTimeout = 5e0;
7768 /** @} */ # End HTTP client }
7770 /************************************************************************//**
7771 * @name Job queue
7772 * @{
7776 * Number of jobs to perform per request. May be less than one in which case
7777 * jobs are performed probabalistically. If this is zero, jobs will not be done
7778 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7779 * be run periodically.
7781 $wgJobRunRate = 1;
7784 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7785 * to handle the job execution, instead of blocking the request until the job
7786 * execution finishes.
7787 * @since 1.23
7789 $wgRunJobsAsync = true;
7792 * Number of rows to update per job
7794 $wgUpdateRowsPerJob = 300;
7797 * Number of rows to update per query
7799 $wgUpdateRowsPerQuery = 100;
7801 /** @} */ # End job queue }
7803 /************************************************************************//**
7804 * @name Miscellaneous
7805 * @{
7809 * Name of the external diff engine to use. Supported values:
7810 * * false: default PHP implementation, DairikiDiff
7811 * * 'wikidiff2': Wikimedia's fast difference engine implemented as a PHP/HHVM module
7812 * * 'wikidiff3': newer PHP-based difference engine
7813 * * any other string is treated as a path to external diff executable
7815 $wgExternalDiffEngine = false;
7818 * Disable redirects to special pages and interwiki redirects, which use a 302
7819 * and have no "redirected from" link.
7821 * @note This is only for articles with #REDIRECT in them. URL's containing a
7822 * local interwiki prefix (or a non-canonical special page name) are still hard
7823 * redirected regardless of this setting.
7825 $wgDisableHardRedirects = false;
7828 * LinkHolderArray batch size
7829 * For debugging
7831 $wgLinkHolderBatchSize = 1000;
7834 * By default MediaWiki does not register links pointing to same server in
7835 * externallinks dataset, use this value to override:
7837 $wgRegisterInternalExternals = false;
7840 * Maximum number of pages to move at once when moving subpages with a page.
7842 $wgMaximumMovedPages = 100;
7845 * Fix double redirects after a page move.
7846 * Tends to conflict with page move vandalism, use only on a private wiki.
7848 $wgFixDoubleRedirects = false;
7851 * Allow redirection to another page when a user logs in.
7852 * To enable, set to a string like 'Main Page'
7854 $wgRedirectOnLogin = null;
7857 * Configuration for processing pool control, for use in high-traffic wikis.
7858 * An implementation is provided in the PoolCounter extension.
7860 * This configuration array maps pool types to an associative array. The only
7861 * defined key in the associative array is "class", which gives the class name.
7862 * The remaining elements are passed through to the class as constructor
7863 * parameters.
7865 * @par Example:
7866 * @code
7867 * $wgPoolCounterConf = array( 'ArticleView' => array(
7868 * 'class' => 'PoolCounter_Client',
7869 * 'timeout' => 15, // wait timeout in seconds
7870 * 'workers' => 5, // maximum number of active threads in each pool
7871 * 'maxqueue' => 50, // maximum number of total threads in each pool
7872 * ... any extension-specific options...
7873 * );
7874 * @endcode
7876 $wgPoolCounterConf = null;
7879 * To disable file delete/restore temporarily
7881 $wgUploadMaintenance = false;
7884 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7885 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7886 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7887 * (except for the special case of JS and CS pages).
7889 * @since 1.21
7891 $wgNamespaceContentModels = [];
7894 * How to react if a plain text version of a non-text Content object is requested using
7895 * ContentHandler::getContentText():
7897 * * 'ignore': return null
7898 * * 'fail': throw an MWException
7899 * * 'serialize': serialize to default format
7901 * @since 1.21
7903 $wgContentHandlerTextFallback = 'ignore';
7906 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7907 * This way, the ContentHandler facility can be used without any additional information in the
7908 * database. A page's content model is then derived solely from the page's title. This however
7909 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7910 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7911 * a title that would default to a different content model.
7913 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7914 * handling is less robust and less flexible.
7916 * @since 1.21
7918 $wgContentHandlerUseDB = true;
7921 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7922 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7923 * the effect on the database they would have on a wikitext page.
7925 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7926 * or at least parse only the contents of comments in the scripts.
7928 * @since 1.21
7930 $wgTextModelsToParse = [
7931 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7932 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7933 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7937 * Whether the user must enter their password to change their e-mail address
7939 * @since 1.20
7941 $wgRequirePasswordforEmailChange = true;
7944 * Register handlers for specific types of sites.
7946 * @since 1.20
7948 $wgSiteTypes = [
7949 'mediawiki' => 'MediaWikiSite',
7953 * Whether the page_props table has a pp_sortkey column. Set to false in case
7954 * the respective database schema change was not applied.
7955 * @since 1.23
7957 $wgPagePropsHaveSortkey = true;
7960 * Port where you have HTTPS running
7961 * Supports HTTPS on non-standard ports
7962 * @see bug 65184
7963 * @since 1.24
7965 $wgHttpsPort = 443;
7968 * Secret for hmac-based key derivation function (fast,
7969 * cryptographically secure random numbers).
7970 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7971 * be used.
7972 * See also: $wgHKDFAlgorithm
7973 * @since 1.24
7975 $wgHKDFSecret = false;
7978 * Algorithm for hmac-based key derivation function (fast,
7979 * cryptographically secure random numbers).
7980 * See also: $wgHKDFSecret
7981 * @since 1.24
7983 $wgHKDFAlgorithm = 'sha256';
7986 * Enable page language feature
7987 * Allows setting page language in database
7988 * @var bool
7989 * @since 1.24
7991 $wgPageLanguageUseDB = false;
7994 * Global configuration variable for Virtual REST Services.
7995 * Parameters for different services are to be declared inside
7996 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
7997 * array. Global parameters will be merged with service-specific ones. The
7998 * result will then be passed to VirtualRESTService::__construct() in the
7999 * module.
8001 * Example config for Parsoid:
8003 * $wgVirtualRestConfig['modules']['parsoid'] = array(
8004 * 'url' => 'http://localhost:8000',
8005 * 'prefix' => 'enwiki',
8006 * 'domain' => 'en.wikipedia.org',
8007 * );
8009 * @var array
8010 * @since 1.25
8012 $wgVirtualRestConfig = [
8013 'modules' => [],
8014 'global' => [
8015 # Timeout in seconds
8016 'timeout' => 360,
8017 # 'domain' is set to $wgCanonicalServer in Setup.php
8018 'forwardCookies' => false,
8019 'HTTPProxy' => null
8024 * Controls whether zero-result search queries with suggestions should display results for
8025 * these suggestions.
8027 * @var bool
8028 * @since 1.26
8030 $wgSearchRunSuggestedQuery = true;
8033 * Where popular password file is located.
8035 * Default in core contains 50,000 most popular. This config
8036 * allows you to change which file, in case you want to generate
8037 * a password file with > 50000 entries in it.
8039 * @see maintenance/createCommonPasswordCdb.php
8040 * @since 1.27
8041 * @var string path to file
8043 $wgPopularPasswordFile = __DIR__ . '/../serialized/commonpasswords.cdb';
8046 * Max time (in seconds) a user-generated transaction can spend in writes.
8047 * If exceeded, the transaction is rolled back with an error instead of being committed.
8049 * @var int|bool Disabled if false
8050 * @since 1.27
8052 $wgMaxUserDBWriteDuration = false;
8055 * Mapping of event channels to EventRelayer configuration.
8057 * By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class
8058 * that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN
8059 * cache purging and CDN cache purging will emit events to this system. Appropriate listers can
8060 * subscribe to the channel and take actions based on the events. For example, a local daemon
8061 * can run on each CDN cache node and perfom local purges based on the URL purge channel events.
8063 * The 'default' channel is for all channels without an explicit entry here.
8065 * @since 1.27
8067 $wgEventRelayerConfig = [
8068 'default' => [
8069 'class' => 'EventRelayerNull',
8074 * For really cool vim folding this needs to be at the end:
8075 * vim: foldmarker=@{,@} foldmethod=marker
8076 * @}