SessionManager: Save user name to metadata even if the user doesn't exist locally
[mediawiki.git] / includes / DefaultSettings.php
blob4d0b50edd89eb688718c39c432a4f2662dcd4e22
1 <?php
2 /**
3 * Default values for MediaWiki configuration settings.
6 * NEVER EDIT THIS FILE
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
38 * @file
41 /**
42 * @defgroup Globalsettings Global settings
45 /**
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
52 die( 1 );
55 /** @endcond */
57 /**
58 * wgConf hold the site configuration.
59 * Not used for much in a default install.
60 * @since 1.5
62 $wgConf = new SiteConfiguration;
64 /**
65 * Registry of factory functions to create config objects:
66 * The 'main' key must be set, and the value should be a valid
67 * callable.
68 * @since 1.23
70 $wgConfigRegistry = array(
71 'main' => 'GlobalVarConfig::newInstance'
74 /**
75 * MediaWiki version number
76 * @since 1.2
78 $wgVersion = '1.27alpha';
80 /**
81 * Name of the site. It must be changed in LocalSettings.php
83 $wgSitename = 'MediaWiki';
85 /**
86 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
87 * the wiki on the standard ports (443 for https and 80 for http).
88 * @var bool
89 * @since 1.26
91 $wgAssumeProxiesUseDefaultProtocolPorts = true;
93 /**
94 * URL of the server.
96 * @par Example:
97 * @code
98 * $wgServer = 'http://example.com';
99 * @endcode
101 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
102 * wrong server, it will redirect incorrectly after you save a page. In that
103 * case, set this variable to fix it.
105 * If you want to use protocol-relative URLs on your wiki, set this to a
106 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
107 * to a fully qualified URL.
109 $wgServer = WebRequest::detectServer();
112 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
113 * Must be fully qualified, even if $wgServer is protocol-relative.
115 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
116 * @since 1.18
118 $wgCanonicalServer = false;
121 * Server name. This is automatically computed by parsing the bare
122 * hostname out of $wgCanonicalServer. It should not be customized.
123 * @since 1.24
125 $wgServerName = false;
127 /************************************************************************//**
128 * @name Script path settings
129 * @{
133 * The path we should point to.
134 * It might be a virtual path in case with use apache mod_rewrite for example.
136 * This *needs* to be set correctly.
138 * Other paths will be set to defaults based on it unless they are directly
139 * set in LocalSettings.php
141 $wgScriptPath = '/wiki';
144 * Whether to support URLs like index.php/Page_title These often break when PHP
145 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
146 * but then again it may not; lighttpd converts incoming path data to lowercase
147 * on systems with case-insensitive filesystems, and there have been reports of
148 * problems on Apache as well.
150 * To be safe we'll continue to keep it off by default.
152 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
153 * incorrect garbage, or to true if it is really correct.
155 * The default $wgArticlePath will be set based on this value at runtime, but if
156 * you have customized it, having this incorrectly set to true can cause
157 * redirect loops when "pretty URLs" are used.
158 * @since 1.2.1
160 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
161 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
162 ( strpos( PHP_SAPI, 'isapi' ) === false );
165 * The extension to append to script names by default.
167 * Some hosting providers used PHP 4 for *.php files, and PHP 5 for *.php5.
168 * This variable was provided to support those providers.
170 * @since 1.11
171 * @deprecated since 1.25; support for '.php5' has been phased out of MediaWiki
172 * proper. Backward-compatibility can be maintained by configuring your web
173 * server to rewrite URLs. See RELEASE-NOTES for details.
175 $wgScriptExtension = '.php';
177 /**@}*/
179 /************************************************************************//**
180 * @name URLs and file paths
182 * These various web and file path variables are set to their defaults
183 * in Setup.php if they are not explicitly set from LocalSettings.php.
185 * These will relatively rarely need to be set manually, unless you are
186 * splitting style sheets or images outside the main document root.
188 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
189 * the host part, that starts with a slash. In most cases a full URL is also
190 * acceptable. A "directory" is a local file path.
192 * In both paths and directories, trailing slashes should not be included.
194 * @{
198 * The URL path to index.php.
200 * Defaults to "{$wgScriptPath}/index.php".
202 $wgScript = false;
205 * The URL path to load.php.
207 * Defaults to "{$wgScriptPath}/load.php".
208 * @since 1.17
210 $wgLoadScript = false;
213 * The URL path of the skins directory.
214 * Defaults to "{$wgResourceBasePath}/skins".
215 * @since 1.3
217 $wgStylePath = false;
218 $wgStyleSheetPath = &$wgStylePath;
221 * The URL path of the skins directory. Should not point to an external domain.
222 * Defaults to "{$wgScriptPath}/skins".
223 * @since 1.17
225 $wgLocalStylePath = false;
228 * The URL path of the extensions directory.
229 * Defaults to "{$wgResourceBasePath}/extensions".
230 * @since 1.16
232 $wgExtensionAssetsPath = false;
235 * Filesystem extensions directory.
236 * Defaults to "{$IP}/extensions".
237 * @since 1.25
239 $wgExtensionDirectory = "{$IP}/extensions";
242 * Filesystem stylesheets directory.
243 * Defaults to "{$IP}/skins".
244 * @since 1.3
246 $wgStyleDirectory = "{$IP}/skins";
249 * The URL path for primary article page views. This path should contain $1,
250 * which is replaced by the article title.
252 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
253 * depending on $wgUsePathInfo.
255 $wgArticlePath = false;
258 * The URL path for the images directory.
259 * Defaults to "{$wgScriptPath}/images".
261 $wgUploadPath = false;
264 * The filesystem path of the images directory. Defaults to "{$IP}/images".
266 $wgUploadDirectory = false;
269 * Directory where the cached page will be saved.
270 * Defaults to "{$wgUploadDirectory}/cache".
272 $wgFileCacheDirectory = false;
275 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
276 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
278 $wgLogo = false;
281 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
282 * should be under 135x155 pixels.
283 * Only 1.5x and 2x versions are supported.
285 * @par Example:
286 * @code
287 * $wgLogoHD = array(
288 * "1.5x" => "path/to/1.5x_version.png",
289 * "2x" => "path/to/2x_version.png"
290 * );
291 * @endcode
293 * @since 1.25
295 $wgLogoHD = false;
298 * The URL path of the shortcut icon.
299 * @since 1.6
301 $wgFavicon = '/favicon.ico';
304 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
305 * Defaults to no icon.
306 * @since 1.12
308 $wgAppleTouchIcon = false;
311 * Value for the referrer policy meta tag.
312 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
313 * prevents the meta tag from being output.
314 * See http://www.w3.org/TR/referrer-policy/ for details.
316 * @since 1.25
318 $wgReferrerPolicy = false;
321 * The local filesystem path to a temporary directory. This is not required to
322 * be web accessible.
324 * When this setting is set to false, its value will be set through a call
325 * to wfTempDir(). See that methods implementation for the actual detection
326 * logic.
328 * Developers should use the global function wfTempDir() instead of this
329 * variable.
331 * @see wfTempDir()
332 * @note Default changed to false in MediaWiki 1.20.
334 $wgTmpDirectory = false;
337 * If set, this URL is added to the start of $wgUploadPath to form a complete
338 * upload URL.
339 * @since 1.4
341 $wgUploadBaseUrl = '';
344 * To enable remote on-demand scaling, set this to the thumbnail base URL.
345 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
346 * where 'e6' are the first two characters of the MD5 hash of the file name.
347 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
348 * @since 1.17
350 $wgUploadStashScalerBaseUrl = false;
353 * To set 'pretty' URL paths for actions other than
354 * plain page views, add to this array.
356 * @par Example:
357 * Set pretty URL for the edit action:
358 * @code
359 * 'edit' => "$wgScriptPath/edit/$1"
360 * @endcode
362 * There must be an appropriate script or rewrite rule in place to handle these
363 * URLs.
364 * @since 1.5
366 $wgActionPaths = array();
368 /**@}*/
370 /************************************************************************//**
371 * @name Files and file uploads
372 * @{
376 * Uploads have to be specially set up to be secure
378 $wgEnableUploads = false;
381 * The maximum age of temporary (incomplete) uploaded files
383 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
386 * Allows to move images and other media files
388 $wgAllowImageMoving = true;
391 * Enable deferred upload tasks that use the job queue.
392 * Only enable this if job runners are set up for both the
393 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
395 * @note If you use suhosin, this setting is incompatible with
396 * suhosin.session.encrypt.
398 $wgEnableAsyncUploads = false;
401 * These are additional characters that should be replaced with '-' in filenames
403 $wgIllegalFileChars = ":";
406 * What directory to place deleted uploads in.
407 * Defaults to "{$wgUploadDirectory}/deleted".
409 $wgDeletedDirectory = false;
412 * Set this to true if you use img_auth and want the user to see details on why access failed.
414 $wgImgAuthDetails = false;
417 * Map of relative URL directories to match to internal mwstore:// base storage paths.
418 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
419 * if starts with any of the prefixes defined here. The prefixes should not overlap.
420 * The prefix that matches has a corresponding storage path, which the rest of the URL
421 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
423 * Example:
424 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
425 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
426 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
428 * @see $wgFileBackends
430 $wgImgAuthUrlPathMap = array();
433 * File repository structures
435 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
436 * an array of such structures. Each repository structure is an associative
437 * array of properties configuring the repository.
439 * Properties required for all repos:
440 * - class The class name for the repository. May come from the core or an extension.
441 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
442 * FSRepo is also supported for backwards compatibility.
444 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
445 * The name should consist of alpha-numeric characters.
446 * - backend A file backend name (see $wgFileBackends).
448 * For most core repos:
449 * - zones Associative array of zone names that each map to an array with:
450 * container : backend container name the zone is in
451 * directory : root path within container for the zone
452 * url : base URL to the root of the zone
453 * urlsByExt : map of file extension types to base URLs
454 * (useful for using a different cache for videos)
455 * Zones default to using "<repo name>-<zone name>" as the container name
456 * and default to using the container root as the zone's root directory.
457 * Nesting of zone locations within other zones should be avoided.
458 * - url Public zone URL. The 'zones' settings take precedence.
459 * - hashLevels The number of directory levels for hash-based division of files
460 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
461 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
462 * handler instead.
463 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
464 * determines whether filenames implicitly start with a capital letter.
465 * The current implementation may give incorrect description page links
466 * when the local $wgCapitalLinks and initialCapital are mismatched.
467 * - pathDisclosureProtection
468 * May be 'paranoid' to remove all parameters from error messages, 'none' to
469 * leave the paths in unchanged, or 'simple' to replace paths with
470 * placeholders. Default for LocalRepo is 'simple'.
471 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
472 * is 0644.
473 * - directory The local filesystem directory where public files are stored. Not used for
474 * some remote repos.
475 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
476 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
477 * - isPrivate Set this if measures should always be taken to keep the files private.
478 * One should not trust this to assure that the files are not web readable;
479 * the server configuration should be done manually depending on the backend.
481 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
482 * for local repositories:
483 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
484 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
485 * https://en.wikipedia.org/w
486 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
487 * $wgScriptExtension, e.g. ".php5". Defaults to ".php".
489 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
490 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
491 * $wgFetchCommonsDescriptions.
492 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
493 * Short thumbnail names only have the width, parameters, and the extension.
495 * ForeignDBRepo:
496 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
497 * equivalent to the corresponding member of $wgDBservers
498 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
499 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
501 * ForeignAPIRepo:
502 * - apibase Use for the foreign API's URL
503 * - apiThumbCacheExpiry How long to locally cache thumbs for
505 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
506 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
507 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
508 * If you set $wgForeignFileRepos to an array of repository structures, those will
509 * be searched after the local file repo.
510 * Otherwise, you will only have access to local media files.
512 * @see Setup.php for an example usage and default initialization.
514 $wgLocalFileRepo = false;
517 * @see $wgLocalFileRepo
519 $wgForeignFileRepos = array();
522 * Use Commons as a remote file repository. Essentially a wrapper, when this
523 * is enabled $wgForeignFileRepos will point at Commons with a set of default
524 * settings
526 $wgUseInstantCommons = false;
529 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
530 * are allowable upload targets. These wikis must have some method of
531 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
533 * Example:
534 * $wgForeignUploadTargets = array( 'shared' );
536 $wgForeignUploadTargets = array();
539 * Cross-wiki upload A/B test configuration.
541 $wgForeignUploadTestEnabled = false;
542 $wgForeignUploadTestDefault = 1;
545 * File backend structure configuration.
547 * This is an array of file backend configuration arrays.
548 * Each backend configuration has the following parameters:
549 * - 'name' : A unique name for the backend
550 * - 'class' : The file backend class to use
551 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
552 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
554 * See FileBackend::__construct() for more details.
555 * Additional parameters are specific to the file backend class used.
556 * These settings should be global to all wikis when possible.
558 * There are two particularly important aspects about each backend:
559 * - a) Whether it is fully qualified or wiki-relative.
560 * By default, the paths of files are relative to the current wiki,
561 * which works via prefixing them with the current wiki ID when accessed.
562 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
563 * all paths with the specified value instead. This can be useful if
564 * multiple wikis need to share the same data. Note that 'name' is *not*
565 * part of any prefix and thus should not be relied upon for namespacing.
566 * - b) Whether it is only defined for some wikis or is defined on all
567 * wikis in the wiki farm. Defining a backend globally is useful
568 * if multiple wikis need to share the same data.
569 * One should be aware of these aspects when configuring a backend for use with
570 * any basic feature or plugin. For example, suppose an extension stores data for
571 * different wikis in different directories and sometimes needs to access data from
572 * a foreign wiki's directory in order to render a page on given wiki. The extension
573 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
575 $wgFileBackends = array();
578 * Array of configuration arrays for each lock manager.
579 * Each backend configuration has the following parameters:
580 * - 'name' : A unique name for the lock manager
581 * - 'class' : The lock manger class to use
583 * See LockManager::__construct() for more details.
584 * Additional parameters are specific to the lock manager class used.
585 * These settings should be global to all wikis.
587 $wgLockManagers = array();
590 * Show Exif data, on by default if available.
591 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
593 * @note FOR WINDOWS USERS:
594 * To enable Exif functions, add the following lines to the "Windows
595 * extensions" section of php.ini:
596 * @code{.ini}
597 * extension=extensions/php_mbstring.dll
598 * extension=extensions/php_exif.dll
599 * @endcode
601 $wgShowEXIF = function_exists( 'exif_read_data' );
604 * If to automatically update the img_metadata field
605 * if the metadata field is outdated but compatible with the current version.
606 * Defaults to false.
608 $wgUpdateCompatibleMetadata = false;
611 * If you operate multiple wikis, you can define a shared upload path here.
612 * Uploads to this wiki will NOT be put there - they will be put into
613 * $wgUploadDirectory.
614 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
615 * no file of the given name is found in the local repository (for [[File:..]],
616 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
617 * directory.
619 * Note that these configuration settings can now be defined on a per-
620 * repository basis for an arbitrary number of file repositories, using the
621 * $wgForeignFileRepos variable.
623 $wgUseSharedUploads = false;
626 * Full path on the web server where shared uploads can be found
628 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
631 * Fetch commons image description pages and display them on the local wiki?
633 $wgFetchCommonsDescriptions = false;
636 * Path on the file system where shared uploads can be found.
638 $wgSharedUploadDirectory = "/var/www/wiki3/images";
641 * DB name with metadata about shared directory.
642 * Set this to false if the uploads do not come from a wiki.
644 $wgSharedUploadDBname = false;
647 * Optional table prefix used in database.
649 $wgSharedUploadDBprefix = '';
652 * Cache shared metadata in memcached.
653 * Don't do this if the commons wiki is in a different memcached domain
655 $wgCacheSharedUploads = true;
658 * Allow for upload to be copied from an URL.
659 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
660 * You have to assign the user right 'upload_by_url' to a user group, to use this.
662 $wgAllowCopyUploads = false;
665 * A list of domains copy uploads can come from
667 * @since 1.20
669 $wgCopyUploadsDomains = array();
672 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
673 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
674 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
676 $wgCopyUploadsFromSpecialUpload = false;
679 * Proxy to use for copy upload requests.
680 * @since 1.20
682 $wgCopyUploadProxy = false;
685 * Different timeout for upload by url
686 * This could be useful since when fetching large files, you may want a
687 * timeout longer than the default $wgHTTPTimeout. False means fallback
688 * to default.
690 * @since 1.22
692 $wgCopyUploadTimeout = false;
695 * Max size for uploads, in bytes. If not set to an array, applies to all
696 * uploads. If set to an array, per upload type maximums can be set, using the
697 * file and url keys. If the * key is set this value will be used as maximum
698 * for non-specified types.
700 * @par Example:
701 * @code
702 * $wgMaxUploadSize = array(
703 * '*' => 250 * 1024,
704 * 'url' => 500 * 1024,
705 * );
706 * @endcode
707 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
708 * will have a maximum of 500 kB.
710 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
713 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
714 * chunks smaller than this will be rejected. May be reduced based on the
715 * 'upload_max_filesize' or 'post_max_size' PHP settings.
716 * @since 1.26
718 $wgMinUploadChunkSize = 1024; # 1KB
721 * Point the upload navigation link to an external URL
722 * Useful if you want to use a shared repository by default
723 * without disabling local uploads (use $wgEnableUploads = false for that).
725 * @par Example:
726 * @code
727 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
728 * @endcode
730 $wgUploadNavigationUrl = false;
733 * Point the upload link for missing files to an external URL, as with
734 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
735 * appended to it as appropriate.
737 $wgUploadMissingFileUrl = false;
740 * Give a path here to use thumb.php for thumbnail generation on client
741 * request, instead of generating them on render and outputting a static URL.
742 * This is necessary if some of your apache servers don't have read/write
743 * access to the thumbnail path.
745 * @par Example:
746 * @code
747 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
748 * @endcode
750 $wgThumbnailScriptPath = false;
753 * @see $wgThumbnailScriptPath
755 $wgSharedThumbnailScriptPath = false;
758 * Set this to false if you do not want MediaWiki to divide your images
759 * directory into many subdirectories, for improved performance.
761 * It's almost always good to leave this enabled. In previous versions of
762 * MediaWiki, some users set this to false to allow images to be added to the
763 * wiki by simply copying them into $wgUploadDirectory and then running
764 * maintenance/rebuildImages.php to register them in the database. This is no
765 * longer recommended, use maintenance/importImages.php instead.
767 * @note That this variable may be ignored if $wgLocalFileRepo is set.
768 * @todo Deprecate the setting and ultimately remove it from Core.
770 $wgHashedUploadDirectory = true;
773 * Set the following to false especially if you have a set of files that need to
774 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
775 * directory layout.
777 $wgHashedSharedUploadDirectory = true;
780 * Base URL for a repository wiki. Leave this blank if uploads are just stored
781 * in a shared directory and not meant to be accessible through a separate wiki.
782 * Otherwise the image description pages on the local wiki will link to the
783 * image description page on this wiki.
785 * Please specify the namespace, as in the example below.
787 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
790 * This is the list of preferred extensions for uploading files. Uploading files
791 * with extensions not in this list will trigger a warning.
793 * @warning If you add any OpenOffice or Microsoft Office file formats here,
794 * such as odt or doc, and untrusted users are allowed to upload files, then
795 * your wiki will be vulnerable to cross-site request forgery (CSRF).
797 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg', 'webp' );
800 * Files with these extensions will never be allowed as uploads.
801 * An array of file extensions to blacklist. You should append to this array
802 * if you want to blacklist additional files.
804 $wgFileBlacklist = array(
805 # HTML may contain cookie-stealing JavaScript and web bugs
806 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
807 # PHP scripts may execute arbitrary code on the server
808 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
809 # Other types that may be interpreted by some servers
810 'shtml', 'jhtml', 'pl', 'py', 'cgi',
811 # May contain harmful executables for Windows victims
812 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
815 * Files with these MIME types will never be allowed as uploads
816 * if $wgVerifyMimeType is enabled.
818 $wgMimeTypeBlacklist = array(
819 # HTML may contain cookie-stealing JavaScript and web bugs
820 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
821 # PHP scripts may execute arbitrary code on the server
822 'application/x-php', 'text/x-php',
823 # Other types that may be interpreted by some servers
824 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
825 # Client-side hazards on Internet Explorer
826 'text/scriptlet', 'application/x-msdownload',
827 # Windows metafile, client-side vulnerability on some systems
828 'application/x-msmetafile',
832 * Allow Java archive uploads.
833 * This is not recommended for public wikis since a maliciously-constructed
834 * applet running on the same domain as the wiki can steal the user's cookies.
836 $wgAllowJavaUploads = false;
839 * This is a flag to determine whether or not to check file extensions on upload.
841 * @warning Setting this to false is insecure for public wikis.
843 $wgCheckFileExtensions = true;
846 * If this is turned off, users may override the warning for files not covered
847 * by $wgFileExtensions.
849 * @warning Setting this to false is insecure for public wikis.
851 $wgStrictFileExtensions = true;
854 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
856 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
857 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
859 $wgDisableUploadScriptChecks = false;
862 * Warn if uploaded files are larger than this (in bytes), or false to disable
864 $wgUploadSizeWarning = false;
867 * list of trusted media-types and MIME types.
868 * Use the MEDIATYPE_xxx constants to represent media types.
869 * This list is used by File::isSafeFile
871 * Types not listed here will have a warning about unsafe content
872 * displayed on the images description page. It would also be possible
873 * to use this for further restrictions, like disabling direct
874 * [[media:...]] links for non-trusted formats.
876 $wgTrustedMediaFormats = array(
877 MEDIATYPE_BITMAP, // all bitmap formats
878 MEDIATYPE_AUDIO, // all audio formats
879 MEDIATYPE_VIDEO, // all plain video formats
880 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
881 "application/pdf", // PDF files
882 # "application/x-shockwave-flash", //flash/shockwave movie
886 * Plugins for media file type handling.
887 * Each entry in the array maps a MIME type to a class name
889 $wgMediaHandlers = array(
890 'image/jpeg' => 'JpegHandler',
891 'image/png' => 'PNGHandler',
892 'image/gif' => 'GIFHandler',
893 'image/tiff' => 'TiffHandler',
894 'image/webp' => 'WebPHandler',
895 'image/x-ms-bmp' => 'BmpHandler',
896 'image/x-bmp' => 'BmpHandler',
897 'image/x-xcf' => 'XCFHandler',
898 'image/svg+xml' => 'SvgHandler', // official
899 'image/svg' => 'SvgHandler', // compat
900 'image/vnd.djvu' => 'DjVuHandler', // official
901 'image/x.djvu' => 'DjVuHandler', // compat
902 'image/x-djvu' => 'DjVuHandler', // compat
906 * Plugins for page content model handling.
907 * Each entry in the array maps a model id to a class name.
909 * @since 1.21
911 $wgContentHandlers = array(
912 // the usual case
913 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
914 // dumb version, no syntax highlighting
915 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
916 // simple implementation, for use by extensions, etc.
917 CONTENT_MODEL_JSON => 'JsonContentHandler',
918 // dumb version, no syntax highlighting
919 CONTENT_MODEL_CSS => 'CssContentHandler',
920 // plain text, for use by extensions, etc.
921 CONTENT_MODEL_TEXT => 'TextContentHandler',
925 * Whether to enable server-side image thumbnailing. If false, images will
926 * always be sent to the client in full resolution, with appropriate width= and
927 * height= attributes on the <img> tag for the client to do its own scaling.
929 $wgUseImageResize = true;
932 * Resizing can be done using PHP's internal image libraries or using
933 * ImageMagick or another third-party converter, e.g. GraphicMagick.
934 * These support more file formats than PHP, which only supports PNG,
935 * GIF, JPG, XBM and WBMP.
937 * Use Image Magick instead of PHP builtin functions.
939 $wgUseImageMagick = false;
942 * The convert command shipped with ImageMagick
944 $wgImageMagickConvertCommand = '/usr/bin/convert';
947 * Array of max pixel areas for interlacing per MIME type
948 * @since 1.27
950 $wgMaxInterlacingAreas = array();
953 * Sharpening parameter to ImageMagick
955 $wgSharpenParameter = '0x0.4';
958 * Reduction in linear dimensions below which sharpening will be enabled
960 $wgSharpenReductionThreshold = 0.85;
963 * Temporary directory used for ImageMagick. The directory must exist. Leave
964 * this set to false to let ImageMagick decide for itself.
966 $wgImageMagickTempDir = false;
969 * Use another resizing converter, e.g. GraphicMagick
970 * %s will be replaced with the source path, %d with the destination
971 * %w and %h will be replaced with the width and height.
973 * @par Example for GraphicMagick:
974 * @code
975 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
976 * @endcode
978 * Leave as false to skip this.
980 $wgCustomConvertCommand = false;
983 * used for lossless jpeg rotation
985 * @since 1.21
987 $wgJpegTran = '/usr/bin/jpegtran';
990 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
991 * image formats.
993 $wgExiv2Command = '/usr/bin/exiv2';
996 * Path to exiftool binary. Used for lossless ICC profile swapping.
998 * @since 1.26
1000 $wgExiftool = '/usr/bin/exiftool';
1003 * Scalable Vector Graphics (SVG) may be uploaded as images.
1004 * Since SVG support is not yet standard in browsers, it is
1005 * necessary to rasterize SVGs to PNG as a fallback format.
1007 * An external program is required to perform this conversion.
1008 * If set to an array, the first item is a PHP callable and any further items
1009 * are passed as parameters after $srcPath, $dstPath, $width, $height
1011 $wgSVGConverters = array(
1012 'ImageMagick' =>
1013 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1014 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1015 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1016 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1017 . '$output $input',
1018 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1019 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1020 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
1024 * Pick a converter defined in $wgSVGConverters
1026 $wgSVGConverter = 'ImageMagick';
1029 * If not in the executable PATH, specify the SVG converter path.
1031 $wgSVGConverterPath = '';
1034 * Don't scale a SVG larger than this
1036 $wgSVGMaxSize = 5120;
1039 * Don't read SVG metadata beyond this point.
1040 * Default is 1024*256 bytes
1042 $wgSVGMetadataCutoff = 262144;
1045 * Disallow <title> element in SVG files.
1047 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1048 * browsers which can not perform basic stuff like MIME detection and which are
1049 * vulnerable to further idiots uploading crap files as images.
1051 * When this directive is on, "<title>" will be allowed in files with an
1052 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1053 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1055 $wgAllowTitlesInSVG = false;
1058 * The maximum number of pixels a source image can have if it is to be scaled
1059 * down by a scaler that requires the full source image to be decompressed
1060 * and stored in decompressed form, before the thumbnail is generated.
1062 * This provides a limit on memory usage for the decompression side of the
1063 * image scaler. The limit is used when scaling PNGs with any of the
1064 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1065 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1067 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1068 * 12.5 million pixels or 3500x3500.
1070 $wgMaxImageArea = 1.25e7;
1073 * Force thumbnailing of animated GIFs above this size to a single
1074 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1075 * is checked against the total size of all frames in the animation.
1076 * It probably makes sense to keep this equal to $wgMaxImageArea.
1078 $wgMaxAnimatedGifArea = 1.25e7;
1081 * Browsers don't support TIFF inline generally...
1082 * For inline display, we need to convert to PNG or JPEG.
1083 * Note scaling should work with ImageMagick, but may not with GD scaling.
1085 * @par Example:
1086 * @code
1087 * // PNG is lossless, but inefficient for photos
1088 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1089 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1090 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1091 * @endcode
1093 $wgTiffThumbnailType = false;
1096 * If rendered thumbnail files are older than this timestamp, they
1097 * will be rerendered on demand as if the file didn't already exist.
1098 * Update if there is some need to force thumbs and SVG rasterizations
1099 * to rerender, such as fixes to rendering bugs.
1101 $wgThumbnailEpoch = '20030516000000';
1104 * Certain operations are avoided if there were too many recent failures,
1105 * for example, thumbnail generation. Bump this value to invalidate all
1106 * memory of failed operations and thus allow further attempts to resume.
1107 * This is useful when a cause for the failures has been found and fixed.
1109 $wgAttemptFailureEpoch = 1;
1112 * If set, inline scaled images will still produce "<img>" tags ready for
1113 * output instead of showing an error message.
1115 * This may be useful if errors are transitory, especially if the site
1116 * is configured to automatically render thumbnails on request.
1118 * On the other hand, it may obscure error conditions from debugging.
1119 * Enable the debug log or the 'thumbnail' log group to make sure errors
1120 * are logged to a file for review.
1122 $wgIgnoreImageErrors = false;
1125 * Allow thumbnail rendering on page view. If this is false, a valid
1126 * thumbnail URL is still output, but no file will be created at
1127 * the target location. This may save some time if you have a
1128 * thumb.php or 404 handler set up which is faster than the regular
1129 * webserver(s).
1131 $wgGenerateThumbnailOnParse = true;
1134 * Show thumbnails for old images on the image description page
1136 $wgShowArchiveThumbnails = true;
1139 * If set to true, images that contain certain the exif orientation tag will
1140 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1141 * is available that can rotate.
1143 $wgEnableAutoRotation = null;
1146 * Internal name of virus scanner. This serves as a key to the
1147 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1148 * null, every file uploaded will be scanned for viruses.
1150 $wgAntivirus = null;
1153 * Configuration for different virus scanners. This an associative array of
1154 * associative arrays. It contains one setup array per known scanner type.
1155 * The entry is selected by $wgAntivirus, i.e.
1156 * valid values for $wgAntivirus are the keys defined in this array.
1158 * The configuration array for each scanner contains the following keys:
1159 * "command", "codemap", "messagepattern":
1161 * "command" is the full command to call the virus scanner - %f will be
1162 * replaced with the name of the file to scan. If not present, the filename
1163 * will be appended to the command. Note that this must be overwritten if the
1164 * scanner is not in the system path; in that case, please set
1165 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1166 * path.
1168 * "codemap" is a mapping of exit code to return codes of the detectVirus
1169 * function in SpecialUpload.
1170 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1171 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1172 * is not set.
1173 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1174 * the file to have an unsupported format, which is probably immune to
1175 * viruses. This causes the file to pass.
1176 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1177 * no virus was found.
1178 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1179 * a virus.
1180 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1182 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1183 * output. The relevant part should be matched as group one (\1).
1184 * If not defined or the pattern does not match, the full message is shown to the user.
1186 $wgAntivirusSetup = array(
1188 # setup for clamav
1189 'clamav' => array(
1190 'command' => 'clamscan --no-summary ',
1191 'codemap' => array(
1192 "0" => AV_NO_VIRUS, # no virus
1193 "1" => AV_VIRUS_FOUND, # virus found
1194 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1195 "*" => AV_SCAN_FAILED, # else scan failed
1197 'messagepattern' => '/.*?:(.*)/sim',
1202 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1204 $wgAntivirusRequired = true;
1207 * Determines if the MIME type of uploaded files should be checked
1209 $wgVerifyMimeType = true;
1212 * Sets the MIME type definition file to use by MimeMagic.php.
1213 * Set to null, to use built-in defaults only.
1214 * example: $wgMimeTypeFile = '/etc/mime.types';
1216 $wgMimeTypeFile = 'includes/mime.types';
1219 * Sets the MIME type info file to use by MimeMagic.php.
1220 * Set to null, to use built-in defaults only.
1222 $wgMimeInfoFile = 'includes/mime.info';
1225 * Sets an external MIME detector program. The command must print only
1226 * the MIME type to standard output.
1227 * The name of the file to process will be appended to the command given here.
1228 * If not set or NULL, PHP's fileinfo extension will be used if available.
1230 * @par Example:
1231 * @code
1232 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1233 * @endcode
1235 $wgMimeDetectorCommand = null;
1238 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1239 * things, because only a few types of images are needed and file extensions
1240 * can be trusted.
1242 $wgTrivialMimeDetection = false;
1245 * Additional XML types we can allow via MIME-detection.
1246 * array = ( 'rootElement' => 'associatedMimeType' )
1248 $wgXMLMimeTypes = array(
1249 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1250 'svg' => 'image/svg+xml',
1251 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1252 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1253 'html' => 'text/html', // application/xhtml+xml?
1257 * Limit images on image description pages to a user-selectable limit. In order
1258 * to reduce disk usage, limits can only be selected from a list.
1259 * The user preference is saved as an array offset in the database, by default
1260 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1261 * change it if you alter the array (see bug 8858).
1262 * This is the list of settings the user can choose from:
1264 $wgImageLimits = array(
1265 array( 320, 240 ),
1266 array( 640, 480 ),
1267 array( 800, 600 ),
1268 array( 1024, 768 ),
1269 array( 1280, 1024 )
1273 * Adjust thumbnails on image pages according to a user setting. In order to
1274 * reduce disk usage, the values can only be selected from a list. This is the
1275 * list of settings the user can choose from:
1277 $wgThumbLimits = array(
1278 120,
1279 150,
1280 180,
1281 200,
1282 250,
1287 * When defined, is an array of image widths used as buckets for thumbnail generation.
1288 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1289 * always using the original. This will incur a speed gain but cause a quality loss.
1291 * The buckets generation is chained, with each bucket generated based on the above bucket
1292 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1293 * supports it.
1295 $wgThumbnailBuckets = null;
1298 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1299 * above the requested size. The distance represents how many extra pixels of width the bucket
1300 * needs in order to be used as the reference for a given thumbnail. For example, with the
1301 * following buckets:
1303 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1305 * and a distance of 50:
1307 * $wgThumbnailMinimumBucketDistance = 50;
1309 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1310 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1312 $wgThumbnailMinimumBucketDistance = 50;
1315 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1316 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1317 * has a performance impact for the first client to view a certain size.
1319 * This obviously means that more disk space is needed per upload upfront.
1321 * @since 1.25
1324 $wgUploadThumbnailRenderMap = array();
1327 * The method through which the thumbnails will be prerendered for the entries in
1328 * $wgUploadThumbnailRenderMap
1330 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1331 * thumbnail's URL.
1332 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1333 * option uses the job queue to render the thumbnail.
1335 * @since 1.25
1337 $wgUploadThumbnailRenderMethod = 'jobqueue';
1340 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1342 * @since 1.25
1344 $wgUploadThumbnailRenderHttpCustomHost = false;
1347 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1348 * HTTP request to.
1350 * @since 1.25
1352 $wgUploadThumbnailRenderHttpCustomDomain = false;
1355 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1356 * (and free) TinyRGB profile when generating thumbnails.
1358 * @since 1.26
1360 $wgUseTinyRGBForJPGThumbnails = false;
1363 * Default parameters for the "<gallery>" tag
1365 $wgGalleryOptions = array(
1366 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1367 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1368 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1369 'captionLength' => 25, // Length of caption to truncate (in characters)
1370 'showBytes' => true, // Show the filesize in bytes in categories
1371 'mode' => 'traditional',
1375 * Adjust width of upright images when parameter 'upright' is used
1376 * This allows a nicer look for upright images without the need to fix the width
1377 * by hardcoded px in wiki sourcecode.
1379 $wgThumbUpright = 0.75;
1382 * Default value for chmoding of new directories.
1384 $wgDirectoryMode = 0777;
1387 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1389 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1390 * thumbnails, output via the srcset attribute.
1392 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1393 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1394 * The polyfill can be found in the jquery.hidpi module.
1396 $wgResponsiveImages = true;
1399 * @name DJVU settings
1400 * @{
1404 * Path of the djvudump executable
1405 * Enable this and $wgDjvuRenderer to enable djvu rendering
1406 * example: $wgDjvuDump = 'djvudump';
1408 $wgDjvuDump = null;
1411 * Path of the ddjvu DJVU renderer
1412 * Enable this and $wgDjvuDump to enable djvu rendering
1413 * example: $wgDjvuRenderer = 'ddjvu';
1415 $wgDjvuRenderer = null;
1418 * Path of the djvutxt DJVU text extraction utility
1419 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1420 * example: $wgDjvuTxt = 'djvutxt';
1422 $wgDjvuTxt = null;
1425 * Path of the djvutoxml executable
1426 * This works like djvudump except much, much slower as of version 3.5.
1428 * For now we recommend you use djvudump instead. The djvuxml output is
1429 * probably more stable, so we'll switch back to it as soon as they fix
1430 * the efficiency problem.
1431 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1433 * @par Example:
1434 * @code
1435 * $wgDjvuToXML = 'djvutoxml';
1436 * @endcode
1438 $wgDjvuToXML = null;
1441 * Shell command for the DJVU post processor
1442 * Default: pnmtojpeg, since ddjvu generates ppm output
1443 * Set this to false to output the ppm file directly.
1445 $wgDjvuPostProcessor = 'pnmtojpeg';
1448 * File extension for the DJVU post processor output
1450 $wgDjvuOutputExtension = 'jpg';
1452 /** @} */ # end of DJvu }
1454 /** @} */ # end of file uploads }
1456 /************************************************************************//**
1457 * @name Email settings
1458 * @{
1462 * Site admin email address.
1464 * Defaults to "wikiadmin@$wgServerName".
1466 $wgEmergencyContact = false;
1469 * Password reminder email address.
1471 * The address we should use as sender when a user is requesting his password.
1473 * Defaults to "apache@$wgServerName".
1475 $wgPasswordSender = false;
1478 * Password reminder name
1480 * @deprecated since 1.23; use the system message 'emailsender' instead.
1482 $wgPasswordSenderName = 'MediaWiki Mail';
1485 * Dummy address which should be accepted during mail send action.
1486 * It might be necessary to adapt the address or to set it equal
1487 * to the $wgEmergencyContact address.
1489 $wgNoReplyAddress = 'reply@not.possible.invalid';
1492 * Set to true to enable the e-mail basic features:
1493 * Password reminders, etc. If sending e-mail on your
1494 * server doesn't work, you might want to disable this.
1496 $wgEnableEmail = true;
1499 * Set to true to enable user-to-user e-mail.
1500 * This can potentially be abused, as it's hard to track.
1502 $wgEnableUserEmail = true;
1505 * Set to true to put the sending user's email in a Reply-To header
1506 * instead of From. ($wgEmergencyContact will be used as From.)
1508 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1509 * which can cause problems with SPF validation and leak recipient addresses
1510 * when bounces are sent to the sender.
1512 $wgUserEmailUseReplyTo = false;
1515 * Minimum time, in hours, which must elapse between password reminder
1516 * emails for a given account. This is to prevent abuse by mail flooding.
1518 $wgPasswordReminderResendTime = 24;
1521 * The time, in seconds, when an emailed temporary password expires.
1523 $wgNewPasswordExpiry = 3600 * 24 * 7;
1526 * The time, in seconds, when an email confirmation email expires
1528 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1531 * The number of days that a user's password is good for. After this number of days, the
1532 * user will be asked to reset their password. Set to false to disable password expiration.
1534 $wgPasswordExpirationDays = false;
1537 * If a user's password is expired, the number of seconds when they can still login,
1538 * and cancel their password change, but are sent to the password change form on each login.
1540 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1543 * SMTP Mode.
1545 * For using a direct (authenticated) SMTP server connection.
1546 * Default to false or fill an array :
1548 * @code
1549 * $wgSMTP = array(
1550 * 'host' => 'SMTP domain',
1551 * 'IDHost' => 'domain for MessageID',
1552 * 'port' => '25',
1553 * 'auth' => [true|false],
1554 * 'username' => [SMTP username],
1555 * 'password' => [SMTP password],
1556 * );
1557 * @endcode
1559 $wgSMTP = false;
1562 * Additional email parameters, will be passed as the last argument to mail() call.
1563 * If using safe_mode this has no effect
1565 $wgAdditionalMailParams = null;
1568 * For parts of the system that have been updated to provide HTML email content, send
1569 * both text and HTML parts as the body of the email
1571 $wgAllowHTMLEmail = false;
1574 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1575 * from $wgEmergencyContact
1577 $wgEnotifFromEditor = false;
1579 // TODO move UPO to preferences probably ?
1580 # If set to true, users get a corresponding option in their preferences and can choose to
1581 # enable or disable at their discretion
1582 # If set to false, the corresponding input form on the user preference page is suppressed
1583 # It call this to be a "user-preferences-option (UPO)"
1586 * Require email authentication before sending mail to an email address.
1587 * This is highly recommended. It prevents MediaWiki from being used as an open
1588 * spam relay.
1590 $wgEmailAuthentication = true;
1593 * Allow users to enable email notification ("enotif") on watchlist changes.
1595 $wgEnotifWatchlist = false;
1598 * Allow users to enable email notification ("enotif") when someone edits their
1599 * user talk page.
1601 $wgEnotifUserTalk = false;
1604 * Set the Reply-to address in notifications to the editor's address, if user
1605 * allowed this in the preferences.
1607 $wgEnotifRevealEditorAddress = false;
1610 * Send notification mails on minor edits to watchlist pages. This is enabled
1611 * by default. User talk notifications are affected by this, $wgEnotifUserTalk, and
1612 * the nominornewtalk user right.
1614 $wgEnotifMinorEdits = true;
1617 * Send a generic mail instead of a personalised mail for each user. This
1618 * always uses UTC as the time zone, and doesn't include the username.
1620 * For pages with many users watching, this can significantly reduce mail load.
1621 * Has no effect when using sendmail rather than SMTP.
1623 $wgEnotifImpersonal = false;
1626 * Maximum number of users to mail at once when using impersonal mail. Should
1627 * match the limit on your mail server.
1629 $wgEnotifMaxRecips = 500;
1632 * Send mails via the job queue. This can be useful to reduce the time it
1633 * takes to save a page that a lot of people are watching.
1635 $wgEnotifUseJobQ = false;
1638 * Use real name instead of username in e-mail "from" field.
1640 $wgEnotifUseRealName = false;
1643 * Array of usernames who will be sent a notification email for every change
1644 * which occurs on a wiki. Users will not be notified of their own changes.
1646 $wgUsersNotifiedOnAllChanges = array();
1648 /** @} */ # end of email settings
1650 /************************************************************************//**
1651 * @name Database settings
1652 * @{
1656 * Database host name or IP address
1658 $wgDBserver = 'localhost';
1661 * Database port number (for PostgreSQL and Microsoft SQL Server).
1663 $wgDBport = 5432;
1666 * Name of the database
1668 $wgDBname = 'my_wiki';
1671 * Database username
1673 $wgDBuser = 'wikiuser';
1676 * Database user's password
1678 $wgDBpassword = '';
1681 * Database type
1683 $wgDBtype = 'mysql';
1686 * Whether to use SSL in DB connection.
1688 * This setting is only used $wgLBFactoryConf['class'] is set to
1689 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1690 * the DBO_SSL flag must be set in the 'flags' option of the database
1691 * connection to achieve the same functionality.
1693 $wgDBssl = false;
1696 * Whether to use compression in DB connection.
1698 * This setting is only used $wgLBFactoryConf['class'] is set to
1699 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1700 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1701 * connection to achieve the same functionality.
1703 $wgDBcompress = false;
1706 * Separate username for maintenance tasks. Leave as null to use the default.
1708 $wgDBadminuser = null;
1711 * Separate password for maintenance tasks. Leave as null to use the default.
1713 $wgDBadminpassword = null;
1716 * Search type.
1717 * Leave as null to select the default search engine for the
1718 * selected database type (eg SearchMySQL), or set to a class
1719 * name to override to a custom search engine.
1721 $wgSearchType = null;
1724 * Alternative search types
1725 * Sometimes you want to support multiple search engines for testing. This
1726 * allows users to select their search engine of choice via url parameters
1727 * to Special:Search and the action=search API. If using this, there's no
1728 * need to add $wgSearchType to it, that is handled automatically.
1730 $wgSearchTypeAlternatives = null;
1733 * Table name prefix
1735 $wgDBprefix = '';
1738 * MySQL table options to use during installation or update
1740 $wgDBTableOptions = 'ENGINE=InnoDB';
1743 * SQL Mode - default is turning off all modes, including strict, if set.
1744 * null can be used to skip the setting for performance reasons and assume
1745 * DBA has done his best job.
1746 * String override can be used for some additional fun :-)
1748 $wgSQLMode = '';
1751 * Mediawiki schema
1753 $wgDBmwschema = null;
1756 * To override default SQLite data directory ($docroot/../data)
1758 $wgSQLiteDataDir = '';
1761 * Make all database connections secretly go to localhost. Fool the load balancer
1762 * thinking there is an arbitrarily large cluster of servers to connect to.
1763 * Useful for debugging.
1765 $wgAllDBsAreLocalhost = false;
1768 * Shared database for multiple wikis. Commonly used for storing a user table
1769 * for single sign-on. The server for this database must be the same as for the
1770 * main database.
1772 * For backwards compatibility the shared prefix is set to the same as the local
1773 * prefix, and the user table is listed in the default list of shared tables.
1774 * The user_properties table is also added so that users will continue to have their
1775 * preferences shared (preferences were stored in the user table prior to 1.16)
1777 * $wgSharedTables may be customized with a list of tables to share in the shared
1778 * database. However it is advised to limit what tables you do share as many of
1779 * MediaWiki's tables may have side effects if you try to share them.
1781 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1782 * $wgDBprefix.
1784 * $wgSharedSchema is the table schema for the shared database. It defaults to
1785 * $wgDBmwschema.
1787 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1788 * access remote databases. Using wfGetLB() allows the shared database to
1789 * reside on separate servers to the wiki's own database, with suitable
1790 * configuration of $wgLBFactoryConf.
1792 $wgSharedDB = null;
1795 * @see $wgSharedDB
1797 $wgSharedPrefix = false;
1800 * @see $wgSharedDB
1802 $wgSharedTables = array( 'user', 'user_properties' );
1805 * @see $wgSharedDB
1806 * @since 1.23
1808 $wgSharedSchema = false;
1811 * Database load balancer
1812 * This is a two-dimensional array, an array of server info structures
1813 * Fields are:
1814 * - host: Host name
1815 * - dbname: Default database name
1816 * - user: DB user
1817 * - password: DB password
1818 * - type: DB type
1820 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1821 * If this is zero for any given server, no normal query traffic will be
1822 * sent to it. It will be excluded from lag checks in maintenance scripts.
1823 * The only way it can receive traffic is if groupLoads is used.
1825 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1826 * to several groups, the most specific group defined here is used.
1828 * - flags: bit field
1829 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1830 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1831 * - DBO_TRX -- wrap entire request in a transaction
1832 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1833 * - DBO_PERSISTENT -- enables persistent database connections
1834 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1835 * - DBO_COMPRESS -- uses internal compression in database connections,
1836 * if available
1838 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1840 * These and any other user-defined properties will be assigned to the mLBInfo member
1841 * variable of the Database object.
1843 * Leave at false to use the single-server variables above. If you set this
1844 * variable, the single-server variables will generally be ignored (except
1845 * perhaps in some command-line scripts).
1847 * The first server listed in this array (with key 0) will be the master. The
1848 * rest of the servers will be slaves. To prevent writes to your slaves due to
1849 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1850 * slaves in my.cnf. You can set read_only mode at runtime using:
1852 * @code
1853 * SET @@read_only=1;
1854 * @endcode
1856 * Since the effect of writing to a slave is so damaging and difficult to clean
1857 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1858 * our masters, and then set read_only=0 on masters at runtime.
1860 $wgDBservers = false;
1863 * Load balancer factory configuration
1864 * To set up a multi-master wiki farm, set the class here to something that
1865 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1866 * The class identified here is responsible for reading $wgDBservers,
1867 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1869 * The LBFactoryMulti class is provided for this purpose, please see
1870 * includes/db/LBFactoryMulti.php for configuration information.
1872 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1875 * The ID of the current data center
1876 * @since 1.27
1878 $wgDataCenterId = 'default';
1881 * Map of data center IDs to their role ("master" or "slave")
1883 * Multiple data centers can be setup to handle MediaWiki, with HTTP
1884 * POSTs routed to the master data center and GET/HEAD/OPTION routed to
1885 * any data center (usually the closest to the end user). In such setups,
1886 * this setting should be set to the appropriate value in the site
1887 * config for each data center.
1888 * @since 1.27
1890 $wgDataCenterRoles = array( 'default' => 'master' );
1893 * After a state-changing request is done by a client, this determines
1894 * how many seconds that client should keep using the master datacenter.
1895 * This avoids unexpected stale or 404 responses due to replication lag.
1896 * @since 1.27
1898 $wgDataCenterUpdateStickTTL = 10;
1901 * File to log database errors to
1903 $wgDBerrorLog = false;
1906 * Timezone to use in the error log.
1907 * Defaults to the wiki timezone ($wgLocaltimezone).
1909 * A list of usable timezones can found at:
1910 * http://php.net/manual/en/timezones.php
1912 * @par Examples:
1913 * @code
1914 * $wgDBerrorLogTZ = 'UTC';
1915 * $wgDBerrorLogTZ = 'GMT';
1916 * $wgDBerrorLogTZ = 'PST8PDT';
1917 * $wgDBerrorLogTZ = 'Europe/Sweden';
1918 * $wgDBerrorLogTZ = 'CET';
1919 * @endcode
1921 * @since 1.20
1923 $wgDBerrorLogTZ = false;
1926 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1927 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1929 * @warning THIS IS EXPERIMENTAL!
1931 * May break if you're not using the table defs from mysql5/tables.sql.
1932 * May break if you're upgrading an existing wiki if set differently.
1933 * Broken symptoms likely to include incorrect behavior with page titles,
1934 * usernames, comments etc containing non-ASCII characters.
1935 * Might also cause failures on the object cache and other things.
1937 * Even correct usage may cause failures with Unicode supplementary
1938 * characters (those not in the Basic Multilingual Plane) unless MySQL
1939 * has enhanced their Unicode support.
1941 $wgDBmysql5 = false;
1944 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1946 * To use this feature set to true and use a datasource defined as
1947 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1948 * block).
1950 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1951 * Pool) that maintains established sessions and reuses them on new
1952 * connections.
1954 * Not completely tested, but it should fall back on normal connection
1955 * in case the pool is full or the datasource is not configured as
1956 * pooled.
1957 * And the other way around; using oci_pconnect on a non pooled
1958 * datasource should produce a normal connection.
1960 * When it comes to frequent shortlived DB connections like with MW
1961 * Oracle tends to s***. The problem is the driver connects to the
1962 * database reasonably fast, but establishing a session takes time and
1963 * resources. MW does not rely on session state (as it does not use
1964 * features such as package variables) so establishing a valid session
1965 * is in this case an unwanted overhead that just slows things down.
1967 * @warning EXPERIMENTAL!
1970 $wgDBOracleDRCP = false;
1973 * Other wikis on this site, can be administered from a single developer
1974 * account.
1975 * Array numeric key => database name
1977 $wgLocalDatabases = array();
1980 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1981 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1982 * show a more obvious warning.
1984 $wgSlaveLagWarning = 10;
1987 * @see $wgSlaveLagWarning
1989 $wgSlaveLagCritical = 30;
1992 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1994 $wgDBWindowsAuthentication = false;
1996 /**@}*/ # End of DB settings }
1998 /************************************************************************//**
1999 * @name Text storage
2000 * @{
2004 * We can also compress text stored in the 'text' table. If this is set on, new
2005 * revisions will be compressed on page save if zlib support is available. Any
2006 * compressed revisions will be decompressed on load regardless of this setting,
2007 * but will not be readable at all* if zlib support is not available.
2009 $wgCompressRevisions = false;
2012 * External stores allow including content
2013 * from non database sources following URL links.
2015 * Short names of ExternalStore classes may be specified in an array here:
2016 * @code
2017 * $wgExternalStores = array("http","file","custom")...
2018 * @endcode
2020 * CAUTION: Access to database might lead to code execution
2022 $wgExternalStores = array();
2025 * An array of external MySQL servers.
2027 * @par Example:
2028 * Create a cluster named 'cluster1' containing three servers:
2029 * @code
2030 * $wgExternalServers = array(
2031 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
2032 * );
2033 * @endcode
2035 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2036 * another class.
2038 $wgExternalServers = array();
2041 * The place to put new revisions, false to put them in the local text table.
2042 * Part of a URL, e.g. DB://cluster1
2044 * Can be an array instead of a single string, to enable data distribution. Keys
2045 * must be consecutive integers, starting at zero.
2047 * @par Example:
2048 * @code
2049 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
2050 * @endcode
2052 * @var array
2054 $wgDefaultExternalStore = false;
2057 * Revision text may be cached in $wgMemc to reduce load on external storage
2058 * servers and object extraction overhead for frequently-loaded revisions.
2060 * Set to 0 to disable, or number of seconds before cache expiry.
2062 $wgRevisionCacheExpiry = 0;
2064 /** @} */ # end text storage }
2066 /************************************************************************//**
2067 * @name Performance hacks and limits
2068 * @{
2072 * Disable database-intensive features
2074 $wgMiserMode = false;
2077 * Disable all query pages if miser mode is on, not just some
2079 $wgDisableQueryPages = false;
2082 * Number of rows to cache in 'querycache' table when miser mode is on
2084 $wgQueryCacheLimit = 1000;
2087 * Number of links to a page required before it is deemed "wanted"
2089 $wgWantedPagesThreshold = 1;
2092 * Enable slow parser functions
2094 $wgAllowSlowParserFunctions = false;
2097 * Allow schema updates
2099 $wgAllowSchemaUpdates = true;
2102 * Maximum article size in kilobytes
2104 $wgMaxArticleSize = 2048;
2107 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2108 * raise PHP's memory limit if it's below this amount.
2110 $wgMemoryLimit = "50M";
2113 * The minimum amount of time that MediaWiki needs for "slow" write request,
2114 * particularly ones with multiple non-atomic writes that *should* be as
2115 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2116 * @since 1.26
2118 $wgTransactionalTimeLimit = 120;
2120 /** @} */ # end performance hacks }
2122 /************************************************************************//**
2123 * @name Cache settings
2124 * @{
2128 * Directory for caching data in the local filesystem. Should not be accessible
2129 * from the web. Set this to false to not use any local caches.
2131 * Note: if multiple wikis share the same localisation cache directory, they
2132 * must all have the same set of extensions. You can set a directory just for
2133 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2135 $wgCacheDirectory = false;
2138 * Main cache type. This should be a cache with fast access, but it may have
2139 * limited space. By default, it is disabled, since the stock database cache
2140 * is not fast enough to make it worthwhile.
2142 * The options are:
2144 * - CACHE_ANYTHING: Use anything, as long as it works
2145 * - CACHE_NONE: Do not cache
2146 * - CACHE_DB: Store cache objects in the DB
2147 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2148 * - CACHE_ACCEL: APC, XCache or WinCache
2149 * - (other): A string may be used which identifies a cache
2150 * configuration in $wgObjectCaches.
2152 * @see $wgMessageCacheType, $wgParserCacheType
2154 $wgMainCacheType = CACHE_NONE;
2157 * The cache type for storing the contents of the MediaWiki namespace. This
2158 * cache is used for a small amount of data which is expensive to regenerate.
2160 * For available types see $wgMainCacheType.
2162 $wgMessageCacheType = CACHE_ANYTHING;
2165 * The cache type for storing article HTML. This is used to store data which
2166 * is expensive to regenerate, and benefits from having plenty of storage space.
2168 * For available types see $wgMainCacheType.
2170 $wgParserCacheType = CACHE_ANYTHING;
2173 * The cache type for storing session data.
2175 * For available types see $wgMainCacheType.
2177 $wgSessionCacheType = CACHE_ANYTHING;
2180 * The cache type for storing language conversion tables,
2181 * which are used when parsing certain text and interface messages.
2183 * For available types see $wgMainCacheType.
2185 * @since 1.20
2187 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2190 * Advanced object cache configuration.
2192 * Use this to define the class names and constructor parameters which are used
2193 * for the various cache types. Custom cache types may be defined here and
2194 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2195 * or $wgLanguageConverterCacheType.
2197 * The format is an associative array where the key is a cache identifier, and
2198 * the value is an associative array of parameters. The "class" parameter is the
2199 * class name which will be used. Alternatively, a "factory" parameter may be
2200 * given, giving a callable function which will generate a suitable cache object.
2202 $wgObjectCaches = array(
2203 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2204 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2206 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2207 CACHE_ACCEL => array( 'factory' => 'ObjectCache::getLocalServerInstance' ),
2208 CACHE_MEMCACHED => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2210 'db-replicated' => array(
2211 'class' => 'ReplicatedBagOStuff',
2212 'readFactory' => array(
2213 'class' => 'SqlBagOStuff',
2214 'args' => array( array( 'slaveOnly' => true ) )
2216 'writeFactory' => array(
2217 'class' => 'SqlBagOStuff',
2218 'args' => array( array( 'slaveOnly' => false ) )
2220 'loggroup' => 'SQLBagOStuff'
2223 'apc' => array( 'class' => 'APCBagOStuff' ),
2224 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2225 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2226 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2227 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2228 'hash' => array( 'class' => 'HashBagOStuff' ),
2232 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2233 * but it may have limited space. By default, it is disabled, since the basic stock
2234 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2235 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2236 * cache with a relayer of type EventRelayerNull.
2238 * The options are:
2239 * - false: Configure the cache using $wgMainCacheType, without using
2240 * a relayer (only matters if there are multiple data-centers)
2241 * - CACHE_NONE: Do not cache
2242 * - (other): A string may be used which identifies a cache
2243 * configuration in $wgWANObjectCaches
2244 * @since 1.26
2246 $wgMainWANCache = false;
2249 * Advanced WAN object cache configuration.
2251 * Each WAN cache wraps a registered object cache (for the local cluster)
2252 * and it must also be configured to point to a PubSub instance. Subscribers
2253 * must be configured to relay purges to the actual cache servers.
2255 * The format is an associative array where the key is a cache identifier, and
2256 * the value is an associative array of parameters. The "cacheId" parameter is
2257 * a cache identifier from $wgObjectCaches. The "relayerConfig" parameter is an
2258 * array used to construct an EventRelayer object. The "pool" parameter is a
2259 * string that is used as a PubSub channel prefix. The "loggroup" parameter
2260 * controls where log events are sent.
2262 * @since 1.26
2264 $wgWANObjectCaches = array(
2265 CACHE_NONE => array(
2266 'class' => 'WANObjectCache',
2267 'cacheId' => CACHE_NONE,
2268 'pool' => 'mediawiki-main-none',
2269 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2271 /* Example of a simple single data-center cache:
2272 'memcached-php' => array(
2273 'class' => 'WANObjectCache',
2274 'cacheId' => 'memcached-php',
2275 'pool' => 'mediawiki-main-memcached',
2276 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2282 * Main object stash type. This should be a fast storage system for storing
2283 * lightweight data like hit counters and user activity. Sites with multiple
2284 * data-centers should have this use a store that replicates all writes. The
2285 * store should have enough consistency for CAS operations to be usable.
2286 * Reads outside of those needed for merge() may be eventually consistent.
2288 * The options are:
2289 * - db: Store cache objects in the DB
2290 * - (other): A string may be used which identifies a cache
2291 * configuration in $wgObjectCaches
2293 * @since 1.26
2295 $wgMainStash = 'db-replicated';
2298 * The expiry time for the parser cache, in seconds.
2299 * The default is 86400 (one day).
2301 $wgParserCacheExpireTime = 86400;
2304 * Deprecated alias for $wgSessionsInObjectCache.
2306 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2308 $wgSessionsInMemcached = true;
2311 * @deprecated since 1.27, session data is always stored in object cache.
2313 $wgSessionsInObjectCache = true;
2316 * The expiry time to use for session storage, in seconds.
2318 $wgObjectCacheSessionExpiry = 3600;
2321 * @deprecated since 1.27, MediaWiki\\Session\\SessionManager doesn't use PHP session storage.
2323 $wgSessionHandler = null;
2326 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2327 * @var string 'enable', 'warn', or 'disable'
2329 $wgPHPSessionHandling = 'enable';
2332 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2334 $wgMemCachedDebug = false;
2337 * The list of MemCached servers and port numbers
2339 $wgMemCachedServers = array( '127.0.0.1:11211' );
2342 * Use persistent connections to MemCached, which are shared across multiple
2343 * requests.
2345 $wgMemCachedPersistent = false;
2348 * Read/write timeout for MemCached server communication, in microseconds.
2350 $wgMemCachedTimeout = 500000;
2353 * Set this to true to maintain a copy of the message cache on the local server.
2355 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2357 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2359 * Note that this is about the message cache, which stores interface messages
2360 * maintained as wiki pages. This is separate from the localisation cache for interface
2361 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2363 $wgUseLocalMessageCache = false;
2366 * Instead of caching everything, only cache those messages which have
2367 * been customised in the site content language. This means that
2368 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2369 * This option is probably only useful for translatewiki.net.
2371 $wgAdaptiveMessageCache = false;
2374 * Localisation cache configuration. Associative array with keys:
2375 * class: The class to use. May be overridden by extensions.
2377 * store: The location to store cache data. May be 'files', 'array', 'db' or
2378 * 'detect'. If set to "files", data will be in CDB files. If set
2379 * to "db", data will be stored to the database. If set to
2380 * "detect", files will be used if $wgCacheDirectory is set,
2381 * otherwise the database will be used.
2382 * "array" is an experimental option that uses PHP files that
2383 * store static arrays.
2385 * storeClass: The class name for the underlying storage. If set to a class
2386 * name, it overrides the "store" setting.
2388 * storeDirectory: If the store class puts its data in files, this is the
2389 * directory it will use. If this is false, $wgCacheDirectory
2390 * will be used.
2392 * manualRecache: Set this to true to disable cache updates on web requests.
2393 * Use maintenance/rebuildLocalisationCache.php instead.
2395 $wgLocalisationCacheConf = array(
2396 'class' => 'LocalisationCache',
2397 'store' => 'detect',
2398 'storeClass' => false,
2399 'storeDirectory' => false,
2400 'manualRecache' => false,
2404 * Allow client-side caching of pages
2406 $wgCachePages = true;
2409 * Set this to current time to invalidate all prior cached pages. Affects both
2410 * client-side and server-side caching.
2411 * You can get the current date on your server by using the command:
2412 * @verbatim
2413 * date +%Y%m%d%H%M%S
2414 * @endverbatim
2416 $wgCacheEpoch = '20030516000000';
2419 * Directory where GitInfo will look for pre-computed cache files. If false,
2420 * $wgCacheDirectory/gitinfo will be used.
2422 $wgGitInfoCacheDirectory = false;
2425 * Bump this number when changing the global style sheets and JavaScript.
2427 * It should be appended in the query string of static CSS and JS includes,
2428 * to ensure that client-side caches do not keep obsolete copies of global
2429 * styles.
2431 $wgStyleVersion = '303';
2434 * This will cache static pages for non-logged-in users to reduce
2435 * database traffic on public sites. ResourceLoader requests to default
2436 * language and skins are cached as well as single module requests.
2438 $wgUseFileCache = false;
2441 * Depth of the subdirectory hierarchy to be created under
2442 * $wgFileCacheDirectory. The subdirectories will be named based on
2443 * the MD5 hash of the title. A value of 0 means all cache files will
2444 * be put directly into the main file cache directory.
2446 $wgFileCacheDepth = 2;
2449 * Kept for extension compatibility; see $wgParserCacheType
2450 * @deprecated 1.26
2452 $wgEnableParserCache = true;
2455 * Append a configured value to the parser cache and the sitenotice key so
2456 * that they can be kept separate for some class of activity.
2458 $wgRenderHashAppend = '';
2461 * If on, the sidebar navigation links are cached for users with the
2462 * current language set. This can save a touch of load on a busy site
2463 * by shaving off extra message lookups.
2465 * However it is also fragile: changing the site configuration, or
2466 * having a variable $wgArticlePath, can produce broken links that
2467 * don't update as expected.
2469 $wgEnableSidebarCache = false;
2472 * Expiry time for the sidebar cache, in seconds
2474 $wgSidebarCacheExpiry = 86400;
2477 * When using the file cache, we can store the cached HTML gzipped to save disk
2478 * space. Pages will then also be served compressed to clients that support it.
2480 * Requires zlib support enabled in PHP.
2482 $wgUseGzip = false;
2485 * Whether MediaWiki should send an ETag header. Seems to cause
2486 * broken behavior with Squid 2.6, see bug 7098.
2488 $wgUseETag = false;
2491 * Clock skew or the one-second resolution of time() can occasionally cause cache
2492 * problems when the user requests two pages within a short period of time. This
2493 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2494 * a grace period.
2496 $wgClockSkewFudge = 5;
2499 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2500 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2501 * was previously done in the default LocalSettings.php file.
2503 * On high-traffic wikis, this should be set to false, to avoid the need to
2504 * check the file modification time, and to avoid the performance impact of
2505 * unnecessary cache invalidations.
2507 $wgInvalidateCacheOnLocalSettingsChange = true;
2510 * When loading extensions through the extension registration system, this
2511 * can be used to invalidate the cache. A good idea would be to set this to
2512 * one file, you can just `touch` that one to invalidate the cache
2514 * @par Example:
2515 * @code
2516 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2517 * @endcode
2519 * If set to false, the mtime for each individual JSON file will be checked,
2520 * which can be slow if a large number of extensions are being loaded.
2522 * @var int|bool
2524 $wgExtensionInfoMTime = false;
2526 /** @} */ # end of cache settings
2528 /************************************************************************//**
2529 * @name HTTP proxy (CDN) settings
2531 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2532 * although they are referred to as Squid settings for historical reasons.
2534 * Achieving a high hit ratio with an HTTP proxy requires special
2535 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2536 * more details.
2538 * @{
2542 * Enable/disable CDN.
2543 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2545 $wgUseSquid = false;
2548 * If you run Squid3 with ESI support, enable this (default:false):
2550 $wgUseESI = false;
2553 * Send the Key HTTP header for better caching.
2554 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2555 * @since 1.27
2557 $wgUseKeyHeader = false;
2560 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2561 * RSS/Atom feeds. Use this if you have an SSL termination setup
2562 * and need to split the cache between HTTP and HTTPS for API requests,
2563 * feed requests and HTTP redirect responses in order to prevent cache
2564 * pollution. This does not affect 'normal' requests to index.php other than
2565 * HTTP redirects.
2567 $wgVaryOnXFP = false;
2570 * Internal server name as known to CDN, if different.
2572 * @par Example:
2573 * @code
2574 * $wgInternalServer = 'http://yourinternal.tld:8000';
2575 * @endcode
2577 $wgInternalServer = false;
2580 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2581 * Surrogate-Control (with ESI). Without ESI, you should strip
2582 * out s-maxage in the CDN config.
2584 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2586 $wgSquidMaxage = 18000;
2589 * Cache timeout for the CDN when DB slave lag is high
2590 * @see $wgSquidMaxage
2591 * @since 1.27
2593 $wgCdnMaxageLagged = 30;
2596 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2597 * this many seconds later via the job queue. This requires delayed job support.
2598 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2599 * slave lag does not cause page to be stuck in stales states in CDN.
2601 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2602 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2603 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2604 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2605 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2607 * @since 1.27
2609 $wgCdnReboundPurgeDelay = 0;
2612 * Default maximum age for raw CSS/JS accesses
2614 * 300 seconds = 5 minutes.
2616 $wgForcedRawSMaxage = 300;
2619 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2621 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2622 * headers sent/modified from these proxies when obtaining the remote IP address
2624 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2626 $wgSquidServers = array();
2629 * As above, except these servers aren't purged on page changes; use to set a
2630 * list of trusted proxies, etc. Supports both individual IP addresses and
2631 * CIDR blocks.
2632 * @since 1.23 Supports CIDR ranges
2634 $wgSquidServersNoPurge = array();
2637 * Whether to use a Host header in purge requests sent to the proxy servers
2638 * configured in $wgSquidServers. Set this to false to support Squid
2639 * configured in forward-proxy mode.
2641 * If this is set to true, a Host header will be sent, and only the path
2642 * component of the URL will appear on the request line, as if the request
2643 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2644 * request. Squid supports this style of request only if reverse-proxy mode
2645 * (http_port ... accel) is enabled.
2647 * If this is set to false, no Host header will be sent, and the absolute URL
2648 * will be sent in the request line, as is the standard for an HTTP proxy
2649 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2650 * by Varnish, but is supported by Squid in either configuration (forward or
2651 * reverse).
2653 * @since 1.21
2655 $wgSquidPurgeUseHostHeader = true;
2658 * Routing configuration for HTCP multicast purging. Add elements here to
2659 * enable HTCP and determine which purges are sent where. If set to an empty
2660 * array, HTCP is disabled.
2662 * Each key in this array is a regular expression to match against the purged
2663 * URL, or an empty string to match all URLs. The purged URL is matched against
2664 * the regexes in the order specified, and the first rule whose regex matches
2665 * is used, all remaining rules will thus be ignored.
2667 * @par Example configuration to send purges for upload.wikimedia.org to one
2668 * multicast group and all other purges to another:
2669 * @code
2670 * $wgHTCPRouting = array(
2671 * '|^https?://upload\.wikimedia\.org|' => array(
2672 * 'host' => '239.128.0.113',
2673 * 'port' => 4827,
2674 * ),
2675 * '' => array(
2676 * 'host' => '239.128.0.112',
2677 * 'port' => 4827,
2678 * ),
2679 * );
2680 * @endcode
2682 * You can also pass an array of hosts to send purges too. This is useful when
2683 * you have several multicast groups or unicast address that should receive a
2684 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2686 * @par Example of sending purges to multiple hosts:
2687 * @code
2688 * $wgHTCPRouting = array(
2689 * '' => array(
2690 * // Purges to text caches using multicast
2691 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2692 * // Purges to a hardcoded list of caches
2693 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2694 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2695 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2696 * ),
2697 * );
2698 * @endcode
2700 * @since 1.22
2702 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2703 * For back compatibility purposes, whenever its array is empty
2704 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2706 * @see $wgHTCPMulticastTTL
2708 $wgHTCPRouting = array();
2711 * HTCP multicast TTL.
2712 * @see $wgHTCPRouting
2714 $wgHTCPMulticastTTL = 1;
2717 * Should forwarded Private IPs be accepted?
2719 $wgUsePrivateIPs = false;
2721 /** @} */ # end of HTTP proxy settings
2723 /************************************************************************//**
2724 * @name Language, regional and character encoding settings
2725 * @{
2729 * Site language code. See languages/Names.php for languages supported by
2730 * MediaWiki out of the box. Not all languages listed there have translations,
2731 * see languages/messages/ for the list of languages with some localisation.
2733 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2734 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2736 * This defines the default interface language for all users, but users can
2737 * change it in their preferences.
2739 * This also defines the language of pages in the wiki. The content is wrapped
2740 * in a html element with lang=XX attribute. This behavior can be overridden
2741 * via hooks, see Title::getPageLanguage.
2743 $wgLanguageCode = 'en';
2746 * Language cache size, or really how many languages can we handle
2747 * simultaneously without degrading to crawl speed.
2749 $wgLangObjCacheSize = 10;
2752 * Some languages need different word forms, usually for different cases.
2753 * Used in Language::convertGrammar().
2755 * @par Example:
2756 * @code
2757 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2758 * @endcode
2760 $wgGrammarForms = array();
2763 * Treat language links as magic connectors, not inline links
2765 $wgInterwikiMagic = true;
2768 * Hide interlanguage links from the sidebar
2770 $wgHideInterlanguageLinks = false;
2773 * List of additional interwiki prefixes that should be treated as
2774 * interlanguage links (i.e. placed in the sidebar).
2775 * Notes:
2776 * - This will not do anything unless the prefixes are defined in the interwiki
2777 * map.
2778 * - The display text for these custom interlanguage links will be fetched from
2779 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2780 * this array.
2781 * - A friendly name for each site, used for tooltip text, may optionally be
2782 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2783 * the prefix in this array.
2785 $wgExtraInterlanguageLinkPrefixes = array();
2788 * List of language names or overrides for default names in Names.php
2790 $wgExtraLanguageNames = array();
2793 * List of language codes that don't correspond to an actual language.
2794 * These codes are mostly left-offs from renames, or other legacy things.
2795 * This array makes them not appear as a selectable language on the installer,
2796 * and excludes them when running the transstat.php script.
2798 $wgDummyLanguageCodes = array(
2799 'als' => 'gsw',
2800 'bat-smg' => 'sgs',
2801 'be-x-old' => 'be-tarask',
2802 'bh' => 'bho',
2803 'fiu-vro' => 'vro',
2804 'no' => 'nb',
2805 'qqq' => 'qqq', # Used for message documentation.
2806 'qqx' => 'qqx', # Used for viewing message keys.
2807 'roa-rup' => 'rup',
2808 'simple' => 'en',
2809 'zh-classical' => 'lzh',
2810 'zh-min-nan' => 'nan',
2811 'zh-yue' => 'yue',
2815 * Character set for use in the article edit box. Language-specific encodings
2816 * may be defined.
2818 * This historic feature is one of the first that was added by former MediaWiki
2819 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2821 $wgEditEncoding = '';
2824 * Set this to true to replace Arabic presentation forms with their standard
2825 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2826 * set to "ar".
2828 * Note that pages with titles containing presentation forms will become
2829 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2831 $wgFixArabicUnicode = true;
2834 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2835 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2836 * set to "ml". Note that some clients (even new clients as of 2010) do not
2837 * support these characters.
2839 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2840 * fix any ZWJ sequences in existing page titles.
2842 $wgFixMalayalamUnicode = true;
2845 * Set this to always convert certain Unicode sequences to modern ones
2846 * regardless of the content language. This has a small performance
2847 * impact.
2849 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2850 * details.
2852 * @since 1.17
2854 $wgAllUnicodeFixes = false;
2857 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2858 * loading old revisions not marked with "utf-8" flag. Use this when
2859 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2860 * burdensome mass conversion of old text data.
2862 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2863 * user names, etc still must be converted en masse in the database before
2864 * continuing as a UTF-8 wiki.
2866 $wgLegacyEncoding = false;
2869 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2870 * regexps : "/regexp/" matching problematic browsers. These browsers will
2871 * be served encoded unicode in the edit box instead of real unicode.
2873 $wgBrowserBlackList = array(
2875 * Netscape 2-4 detection
2876 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2877 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2878 * with a negative assertion. The [UIN] identifier specifies the level of security
2879 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2880 * The language string is unreliable, it is missing on NS4 Mac.
2882 * Reference: http://www.psychedelix.com/agents/index.shtml
2884 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2885 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2886 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2889 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2890 * Þ to <THORN> and Ð to <ETH>
2892 * Known useragents:
2893 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2894 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2895 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2896 * - [...]
2898 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2899 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2901 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2904 * Google wireless transcoder, seems to eat a lot of chars alive
2905 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2907 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2911 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2912 * create stub reference rows in the text table instead of copying
2913 * the full text of all current entries from 'cur' to 'text'.
2915 * This will speed up the conversion step for large sites, but
2916 * requires that the cur table be kept around for those revisions
2917 * to remain viewable.
2919 * This option affects the updaters *only*. Any present cur stub
2920 * revisions will be readable at runtime regardless of this setting.
2922 $wgLegacySchemaConversion = false;
2925 * Enable dates like 'May 12' instead of '12 May', if the default date format
2926 * is 'dmy or mdy'.
2928 $wgAmericanDates = false;
2931 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2932 * numerals in interface.
2934 $wgTranslateNumerals = true;
2937 * Translation using MediaWiki: namespace.
2938 * Interface messages will be loaded from the database.
2940 $wgUseDatabaseMessages = true;
2943 * Expiry time for the message cache key
2945 $wgMsgCacheExpiry = 86400;
2948 * Maximum entry size in the message cache, in bytes
2950 $wgMaxMsgCacheEntrySize = 10000;
2953 * Whether to enable language variant conversion.
2955 $wgDisableLangConversion = false;
2958 * Whether to enable language variant conversion for links.
2960 $wgDisableTitleConversion = false;
2963 * Default variant code, if false, the default will be the language code
2965 $wgDefaultLanguageVariant = false;
2968 * Disabled variants array of language variant conversion.
2970 * @par Example:
2971 * @code
2972 * $wgDisabledVariants[] = 'zh-mo';
2973 * $wgDisabledVariants[] = 'zh-my';
2974 * @endcode
2976 $wgDisabledVariants = array();
2979 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2980 * path format that describes which parts of the URL contain the
2981 * language variant.
2983 * @par Example:
2984 * @code
2985 * $wgLanguageCode = 'sr';
2986 * $wgVariantArticlePath = '/$2/$1';
2987 * $wgArticlePath = '/wiki/$1';
2988 * @endcode
2990 * A link to /wiki/ would be redirected to /sr/Главна_страна
2992 * It is important that $wgArticlePath not overlap with possible values
2993 * of $wgVariantArticlePath.
2995 $wgVariantArticlePath = false;
2998 * Show a bar of language selection links in the user login and user
2999 * registration forms; edit the "loginlanguagelinks" message to
3000 * customise these.
3002 $wgLoginLanguageSelector = false;
3005 * When translating messages with wfMessage(), it is not always clear what
3006 * should be considered UI messages and what should be content messages.
3008 * For example, for the English Wikipedia, there should be only one 'mainpage',
3009 * so when getting the link for 'mainpage', we should treat it as site content
3010 * and call ->inContentLanguage()->text(), but for rendering the text of the
3011 * link, we call ->text(). The code behaves this way by default. However,
3012 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3013 * and the like for different languages. This array provides a way to override
3014 * the default behavior.
3016 * @par Example:
3017 * To allow language-specific main page and community
3018 * portal:
3019 * @code
3020 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
3021 * @endcode
3023 $wgForceUIMsgAsContentMsg = array();
3026 * Fake out the timezone that the server thinks it's in. This will be used for
3027 * date display and not for what's stored in the DB. Leave to null to retain
3028 * your server's OS-based timezone value.
3030 * This variable is currently used only for signature formatting and for local
3031 * time/date parser variables ({{LOCALTIME}} etc.)
3033 * Timezones can be translated by editing MediaWiki messages of type
3034 * timezone-nameinlowercase like timezone-utc.
3036 * A list of usable timezones can found at:
3037 * http://php.net/manual/en/timezones.php
3039 * @par Examples:
3040 * @code
3041 * $wgLocaltimezone = 'UTC';
3042 * $wgLocaltimezone = 'GMT';
3043 * $wgLocaltimezone = 'PST8PDT';
3044 * $wgLocaltimezone = 'Europe/Sweden';
3045 * $wgLocaltimezone = 'CET';
3046 * @endcode
3048 $wgLocaltimezone = null;
3051 * Set an offset from UTC in minutes to use for the default timezone setting
3052 * for anonymous users and new user accounts.
3054 * This setting is used for most date/time displays in the software, and is
3055 * overridable in user preferences. It is *not* used for signature timestamps.
3057 * By default, this will be set to match $wgLocaltimezone.
3059 $wgLocalTZoffset = null;
3061 /** @} */ # End of language/charset settings
3063 /*************************************************************************//**
3064 * @name Output format and skin settings
3065 * @{
3069 * The default Content-Type header.
3071 $wgMimeType = 'text/html';
3074 * Previously used as content type in HTML script tags. This is now ignored since
3075 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3076 * It was also previously used by RawAction to determine the ctype query parameter
3077 * value that will result in a javascript response.
3078 * @deprecated since 1.22
3080 $wgJsMimeType = null;
3083 * The default xmlns attribute. The option to define this has been removed.
3084 * The value of this variable is no longer used by core and is set to a fixed
3085 * value in Setup.php for compatibility with extensions that depend on the value
3086 * of this variable being set. Such a dependency however is deprecated.
3087 * @deprecated since 1.22
3089 $wgXhtmlDefaultNamespace = null;
3092 * Previously used to determine if we should output an HTML5 doctype.
3093 * This is no longer used as we always output HTML5 now. For compatibility with
3094 * extensions that still check the value of this config it's value is now forced
3095 * to true by Setup.php.
3096 * @deprecated since 1.22
3098 $wgHtml5 = true;
3101 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
3102 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
3103 * (like if it's left at the default null value), it will be auto-initialized
3104 * to the correct value for RDFa+HTML5. As such, you should have no reason to
3105 * ever actually set this to anything.
3107 $wgHtml5Version = null;
3110 * Temporary variable that allows HTMLForms to be rendered as tables.
3111 * Table based layouts cause various issues when designing for mobile.
3112 * This global allows skins or extensions a means to force non-table based rendering.
3113 * Setting to false forces form components to always render as div elements.
3114 * @since 1.24
3116 $wgHTMLFormAllowTableFormat = true;
3119 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3120 * Temporary variable that should be removed when mediawiki ui is more
3121 * stable and change has been communicated.
3122 * @since 1.24
3124 $wgUseMediaWikiUIEverywhere = false;
3127 * Enabled RDFa attributes for use in wikitext.
3128 * NOTE: Interaction with HTML5 is somewhat underspecified.
3130 $wgAllowRdfaAttributes = false;
3133 * Enabled HTML5 microdata attributes for use in wikitext.
3135 $wgAllowMicrodataAttributes = false;
3138 * Should we try to make our HTML output well-formed XML? If set to false,
3139 * output will be a few bytes shorter, and the HTML will arguably be more
3140 * readable. If set to true, life will be much easier for the authors of
3141 * screen-scraping bots, and the HTML will arguably be more readable.
3143 * Setting this to false may omit quotation marks on some attributes, omit
3144 * slashes from some self-closing tags, omit some ending tags, etc., where
3145 * permitted by HTML5. Setting it to true will not guarantee that all pages
3146 * will be well-formed, although non-well-formed pages should be rare and it's
3147 * a bug if you find one. Conversely, setting it to false doesn't mean that
3148 * all XML-y constructs will be omitted, just that they might be.
3150 * Because of compatibility with screen-scraping bots, and because it's
3151 * controversial, this is currently left to true by default.
3153 $wgWellFormedXml = true;
3156 * Permit other namespaces in addition to the w3.org default.
3158 * Use the prefix for the key and the namespace for the value.
3160 * @par Example:
3161 * @code
3162 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3163 * @endcode
3164 * Normally we wouldn't have to define this in the root "<html>"
3165 * element, but IE needs it there in some circumstances.
3167 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3169 $wgXhtmlNamespaces = array();
3172 * Site notice shown at the top of each page
3174 * MediaWiki:Sitenotice page, which will override this. You can also
3175 * provide a separate message for logged-out users using the
3176 * MediaWiki:Anonnotice page.
3178 $wgSiteNotice = '';
3181 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3183 $wgSiteSupportPage = '';
3186 * Validate the overall output using tidy and refuse
3187 * to display the page if it's not valid.
3189 $wgValidateAllHtml = false;
3192 * Default skin, for new users and anonymous visitors. Registered users may
3193 * change this to any one of the other available skins in their preferences.
3195 $wgDefaultSkin = 'vector';
3198 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3200 * @since 1.24
3202 $wgFallbackSkin = 'fallback';
3205 * Specify the names of skins that should not be presented in the list of
3206 * available skins in user preferences. If you want to remove a skin entirely,
3207 * remove it from the skins/ directory and its entry from LocalSettings.php.
3209 $wgSkipSkins = array();
3212 * @deprecated since 1.23; use $wgSkipSkins instead
3214 $wgSkipSkin = '';
3217 * Allow user Javascript page?
3218 * This enables a lot of neat customizations, but may
3219 * increase security risk to users and server load.
3221 $wgAllowUserJs = false;
3224 * Allow user Cascading Style Sheets (CSS)?
3225 * This enables a lot of neat customizations, but may
3226 * increase security risk to users and server load.
3228 $wgAllowUserCss = false;
3231 * Allow user-preferences implemented in CSS?
3232 * This allows users to customise the site appearance to a greater
3233 * degree; disabling it will improve page load times.
3235 $wgAllowUserCssPrefs = true;
3238 * Use the site's Javascript page?
3240 $wgUseSiteJs = true;
3243 * Use the site's Cascading Style Sheets (CSS)?
3245 $wgUseSiteCss = true;
3248 * Break out of framesets. This can be used to prevent clickjacking attacks,
3249 * or to prevent external sites from framing your site with ads.
3251 $wgBreakFrames = false;
3254 * The X-Frame-Options header to send on pages sensitive to clickjacking
3255 * attacks, such as edit pages. This prevents those pages from being displayed
3256 * in a frame or iframe. The options are:
3258 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3260 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3261 * to allow framing within a trusted domain. This is insecure if there
3262 * is a page on the same domain which allows framing of arbitrary URLs.
3264 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3265 * full compromise of local user accounts. Private wikis behind a
3266 * corporate firewall are especially vulnerable. This is not
3267 * recommended.
3269 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3270 * not just edit pages.
3272 $wgEditPageFrameOptions = 'DENY';
3275 * Disallow framing of API pages directly, by setting the X-Frame-Options
3276 * header. Since the API returns CSRF tokens, allowing the results to be
3277 * framed can compromise your user's account security.
3278 * Options are:
3279 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3280 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3281 * - false: Allow all framing.
3282 * Note: $wgBreakFrames will override this for human formatted API output.
3284 $wgApiFrameOptions = 'DENY';
3287 * Disable output compression (enabled by default if zlib is available)
3289 $wgDisableOutputCompression = false;
3292 * Should we allow a broader set of characters in id attributes, per HTML5? If
3293 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3294 * functionality is ready, it will be on by default with no option.
3296 * Currently this appears to work fine in all browsers, but it's disabled by
3297 * default because it normalizes id's a bit too aggressively, breaking preexisting
3298 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3300 $wgExperimentalHtmlIds = false;
3303 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3304 * You can add new icons to the built in copyright or poweredby, or you can create
3305 * a new block. Though note that you may need to add some custom css to get good styling
3306 * of new blocks in monobook. vector and modern should work without any special css.
3308 * $wgFooterIcons itself is a key/value array.
3309 * The key is the name of a block that the icons will be wrapped in. The final id varies
3310 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3311 * turns it into mw_poweredby.
3312 * The value is either key/value array of icons or a string.
3313 * In the key/value array the key may or may not be used by the skin but it can
3314 * be used to find the icon and unset it or change the icon if needed.
3315 * This is useful for disabling icons that are set by extensions.
3316 * The value should be either a string or an array. If it is a string it will be output
3317 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3318 * for the icon, the following keys are used:
3319 * - src: An absolute url to the image to use for the icon, this is recommended
3320 * but not required, however some skins will ignore icons without an image
3321 * - srcset: optional additional-resolution images; see HTML5 specs
3322 * - url: The url to use in the a element around the text or icon, if not set an a element will
3323 * not be outputted
3324 * - alt: This is the text form of the icon, it will be displayed without an image in
3325 * skins like Modern or if src is not set, and will otherwise be used as
3326 * the alt="" for the image. This key is required.
3327 * - width and height: If the icon specified by src is not of the standard size
3328 * you can specify the size of image to use with these keys.
3329 * Otherwise they will default to the standard 88x31.
3330 * @todo Reformat documentation.
3332 $wgFooterIcons = array(
3333 "copyright" => array(
3334 "copyright" => array(), // placeholder for the built in copyright icon
3336 "poweredby" => array(
3337 "mediawiki" => array(
3338 // Defaults to point at
3339 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3340 // plus srcset for 1.5x, 2x resolution variants.
3341 "src" => null,
3342 "url" => "//www.mediawiki.org/",
3343 "alt" => "Powered by MediaWiki",
3349 * Login / create account link behavior when it's possible for anonymous users
3350 * to create an account.
3351 * - true = use a combined login / create account link
3352 * - false = split login and create account into two separate links
3354 $wgUseCombinedLoginLink = false;
3357 * Display user edit counts in various prominent places.
3359 $wgEdititis = false;
3362 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3363 * status code, mangling or hiding MediaWiki's output. If you are using such a
3364 * host, you should start looking for a better one. While you're doing that,
3365 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3366 * that the generated error pages can be seen.
3368 * In cases where for technical reasons it is more important for MediaWiki to
3369 * send the correct status code than for the body to be transmitted intact,
3370 * this configuration variable is ignored.
3372 $wgSend404Code = true;
3375 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3376 * The numeric value of the variable controls how many edits MediaWiki will look back to
3377 * determine whether a rollback is allowed (by checking that they are all from the same author).
3378 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3379 * from hiding some useless rollback links.
3381 * @since 1.20
3383 $wgShowRollbackEditCount = 10;
3386 * Output a <link rel="canonical"> tag on every page indicating the canonical
3387 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3388 * detection of the current server is unreliable, the link is sent
3389 * unconditionally.
3391 $wgEnableCanonicalServerLink = false;
3394 * When OutputHandler is used, mangle any output that contains
3395 * <cross-domain-policy>. Without this, an attacker can send their own
3396 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3397 * the domain root.
3399 * @since 1.25
3401 $wgMangleFlashPolicy = true;
3403 /** @} */ # End of output format settings }
3405 /*************************************************************************//**
3406 * @name ResourceLoader settings
3407 * @{
3411 * Client-side resource modules.
3413 * Extensions should add their ResourceLoader module definitions
3414 * to the $wgResourceModules variable.
3416 * @par Example:
3417 * @code
3418 * $wgResourceModules['ext.myExtension'] = array(
3419 * 'scripts' => 'myExtension.js',
3420 * 'styles' => 'myExtension.css',
3421 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3422 * 'localBasePath' => __DIR__,
3423 * 'remoteExtPath' => 'MyExtension',
3424 * );
3425 * @endcode
3427 $wgResourceModules = array();
3430 * Skin-specific styles for resource modules.
3432 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3433 * not be modified or disabled.
3435 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3437 * @par Example:
3438 * @code
3439 * $wgResourceModules['bar'] = array(
3440 * 'scripts' => 'resources/bar/bar.js',
3441 * 'styles' => 'resources/bar/main.css',
3442 * );
3444 * $wgResourceModuleSkinStyles['foo'] = array(
3445 * 'bar' => 'skins/Foo/bar.css',
3446 * );
3447 * @endcode
3449 * This is mostly equivalent to:
3451 * @par Equivalent:
3452 * @code
3453 * $wgResourceModules['bar'] = array(
3454 * 'scripts' => 'resources/bar/bar.js',
3455 * 'styles' => 'resources/bar/main.css',
3456 * 'skinStyles' => array(
3457 * 'foo' => skins/Foo/bar.css',
3458 * ),
3459 * );
3460 * @endcode
3462 * If the module already defines its own entry in `skinStyles` for a given skin, then
3463 * $wgResourceModuleSkinStyles is ignored.
3465 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3466 * of replacing them. This can be done using the `+` prefix.
3468 * @par Example:
3469 * @code
3470 * $wgResourceModules['bar'] = array(
3471 * 'scripts' => 'resources/bar/bar.js',
3472 * 'styles' => 'resources/bar/basic.css',
3473 * 'skinStyles' => array(
3474 * 'default' => 'resources/bar/additional.css',
3475 * ),
3476 * );
3477 * // Note the '+' character:
3478 * $wgResourceModuleSkinStyles['foo'] = array(
3479 * '+bar' => 'skins/Foo/bar.css',
3480 * );
3481 * @endcode
3483 * This is mostly equivalent to:
3485 * @par Equivalent:
3486 * @code
3487 * $wgResourceModules['bar'] = array(
3488 * 'scripts' => 'resources/bar/bar.js',
3489 * 'styles' => 'resources/bar/basic.css',
3490 * 'skinStyles' => array(
3491 * 'default' => 'resources/bar/additional.css',
3492 * 'foo' => array(
3493 * 'resources/bar/additional.css',
3494 * 'skins/Foo/bar.css',
3495 * ),
3496 * ),
3497 * );
3498 * @endcode
3500 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3501 * disabled by a skin. To provide default styles that may be extended or replaced,
3502 * use `skinStyles['default']`.
3504 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3505 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3507 * @par Example:
3508 * @code
3509 * $wgResourceModuleSkinStyles['foo'] = array(
3510 * 'bar' => 'bar.css',
3511 * 'quux' => 'quux.css',
3512 * 'remoteSkinPath' => 'Foo',
3513 * 'localBasePath' => __DIR__,
3514 * );
3515 * @endcode
3517 $wgResourceModuleSkinStyles = array();
3520 * Extensions should register foreign module sources here. 'local' is a
3521 * built-in source that is not in this array, but defined by
3522 * ResourceLoader::__construct() so that it cannot be unset.
3524 * @par Example:
3525 * @code
3526 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3527 * @endcode
3529 $wgResourceLoaderSources = array();
3532 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3533 * Defaults to $wgScriptPath.
3535 $wgResourceBasePath = null;
3538 * Maximum time in seconds to cache resources served by ResourceLoader.
3539 * Used to set last modified headers (max-age/s-maxage).
3541 * Following options to distinguish:
3542 * - versioned: Used for modules with a version, because changing version
3543 * numbers causes cache misses. This normally has a long expiry time.
3544 * - unversioned: Used for modules without a version to propagate changes
3545 * quickly to clients. Also used for modules with errors to recover quickly.
3546 * This normally has a short expiry time.
3548 * Expiry time for the options to distinguish:
3549 * - server: Squid/Varnish but also any other public proxy cache between the
3550 * client and MediaWiki.
3551 * - client: On the client side (e.g. in the browser cache).
3553 $wgResourceLoaderMaxage = array(
3554 'versioned' => array(
3555 'server' => 30 * 24 * 60 * 60, // 30 days
3556 'client' => 30 * 24 * 60 * 60, // 30 days
3558 'unversioned' => array(
3559 'server' => 5 * 60, // 5 minutes
3560 'client' => 5 * 60, // 5 minutes
3565 * The default debug mode (on/off) for of ResourceLoader requests.
3567 * This will still be overridden when the debug URL parameter is used.
3569 $wgResourceLoaderDebug = false;
3572 * Put each statement on its own line when minifying JavaScript. This makes
3573 * debugging in non-debug mode a bit easier.
3575 * @deprecated since 1.27: Always false; no longer configurable.
3577 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3580 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3581 * the minifier will try not to produce lines longer than this, but may be
3582 * forced to do so in certain cases.
3584 * @deprecated since 1.27: Always 1,000; no longer configurable.
3586 $wgResourceLoaderMinifierMaxLineLength = 1000;
3589 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3591 * @deprecated since 1.26: Always declare dependencies.
3593 $wgIncludeLegacyJavaScript = true;
3596 * Whether to ensure the mediawiki.util is loaded before other modules.
3598 * Before MediaWiki 1.19, modules used to load less asynchronous which allowed
3599 * modules to lack dependencies on 'popular' modules that were likely loaded already.
3601 * This setting is to aid scripts during migration by providing mediawiki.util
3602 * unconditionally (which was the most commonly missed dependency). It doesn't
3603 * cover all missing dependencies obviously but should fix most of them.
3605 * This should be removed at some point after site/user scripts have been fixed.
3606 * Enable this if your wiki has a large amount of user/site scripts that are
3607 * lacking dependencies.
3609 * @deprecated since 1.26: Always declare dependencies.
3611 $wgPreloadJavaScriptMwUtil = false;
3614 * Whether or not to assign configuration variables to the global window object.
3616 * If this is set to false, old code using deprecated variables will no longer
3617 * work.
3619 * @par Example of legacy code:
3620 * @code{,js}
3621 * if ( window.wgRestrictionEdit ) { ... }
3622 * @endcode
3623 * or:
3624 * @code{,js}
3625 * if ( wgIsArticle ) { ... }
3626 * @endcode
3628 * Instead, one needs to use mw.config.
3629 * @par Example using mw.config global configuration:
3630 * @code{,js}
3631 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3632 * @endcode
3633 * or:
3634 * @code{,js}
3635 * if ( mw.config.get('wgIsArticle') ) { ... }
3636 * @endcode
3638 $wgLegacyJavaScriptGlobals = true;
3641 * If set to a positive number, ResourceLoader will not generate URLs whose
3642 * query string is more than this many characters long, and will instead use
3643 * multiple requests with shorter query strings. This degrades performance,
3644 * but may be needed if your web server has a low (less than, say 1024)
3645 * query string length limit or a low value for suhosin.get.max_value_length
3646 * that you can't increase.
3648 * If set to a negative number, ResourceLoader will assume there is no query
3649 * string length limit.
3651 * Defaults to a value based on php configuration.
3653 $wgResourceLoaderMaxQueryLength = false;
3656 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3657 * prior to minification to validate it.
3659 * Parse errors will result in a JS exception being thrown during module load,
3660 * which avoids breaking other modules loaded in the same request.
3662 $wgResourceLoaderValidateJS = true;
3665 * If set to true, statically-sourced (file-backed) JavaScript resources will
3666 * be parsed for validity before being bundled up into ResourceLoader modules.
3668 * This can be helpful for development by providing better error messages in
3669 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3670 * and may fail on large pre-bundled frameworks.
3672 $wgResourceLoaderValidateStaticJS = false;
3675 * Global LESS variables. An associative array binding variable names to
3676 * LESS code snippets representing their values.
3678 * Adding an item here is equivalent to writing `@variable: value;`
3679 * at the beginning of all your .less files, with all the consequences.
3680 * In particular, string values must be escaped and quoted.
3682 * Changes to LESS variables do not trigger cache invalidation.
3684 * If the LESS variables need to be dynamic, you can use the
3685 * ResourceLoaderGetLessVars hook (since 1.25).
3687 * @par Example:
3688 * @code
3689 * $wgResourceLoaderLESSVars = array(
3690 * 'baseFontSize' => '1em',
3691 * 'smallFontSize' => '0.75em',
3692 * 'WikimediaBlue' => '#006699',
3693 * );
3694 * @endcode
3695 * @since 1.22
3697 $wgResourceLoaderLESSVars = array(
3699 * Minimum available screen width at which a device can be considered a tablet/desktop
3700 * The number is currently based on the device width of a Samsung Galaxy S5 mini and is low
3701 * enough to cover iPad (768px). Number is prone to change with new information.
3702 * @since 1.27
3704 'deviceWidthTablet' => '720px',
3708 * Default import paths for LESS modules. LESS files referenced in @import
3709 * statements will be looked up here first, and relative to the importing file
3710 * second. To avoid collisions, it's important for the LESS files in these
3711 * directories to have a common, predictable file name prefix.
3713 * Extensions need not (and should not) register paths in
3714 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3715 * currently compiling LESS file, which allows each extension to freely import
3716 * files from its own tree.
3718 * @since 1.22
3720 $wgResourceLoaderLESSImportPaths = array(
3721 "$IP/resources/src/mediawiki.less/",
3725 * Whether ResourceLoader should attempt to persist modules in localStorage on
3726 * browsers that support the Web Storage API.
3728 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3730 $wgResourceLoaderStorageEnabled = false;
3733 * Cache version for client-side ResourceLoader module storage. You can trigger
3734 * invalidation of the contents of the module store by incrementing this value.
3736 * @since 1.23
3738 $wgResourceLoaderStorageVersion = 1;
3741 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3742 * restricted pages like Special:UserLogin or Special:Preferences where
3743 * JavaScript is disabled for security reasons. As it is possible to
3744 * execute JavaScript through CSS, setting this to true opens up a
3745 * potential security hole. Some sites may "skin" their wiki by using
3746 * site-wide CSS, causing restricted pages to look unstyled and different
3747 * from the rest of the site.
3749 * @since 1.25
3751 $wgAllowSiteCSSOnRestrictedPages = false;
3753 /** @} */ # End of ResourceLoader settings }
3755 /*************************************************************************//**
3756 * @name Page title and interwiki link settings
3757 * @{
3761 * Name of the project namespace. If left set to false, $wgSitename will be
3762 * used instead.
3764 $wgMetaNamespace = false;
3767 * Name of the project talk namespace.
3769 * Normally you can ignore this and it will be something like
3770 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3771 * manually for grammatical reasons.
3773 $wgMetaNamespaceTalk = false;
3776 * Additional namespaces. If the namespaces defined in Language.php and
3777 * Namespace.php are insufficient, you can create new ones here, for example,
3778 * to import Help files in other languages. You can also override the namespace
3779 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3780 * hook or extension.json.
3782 * @warning Once you delete a namespace, the pages in that namespace will
3783 * no longer be accessible. If you rename it, then you can access them through
3784 * the new namespace name.
3786 * Custom namespaces should start at 100 to avoid conflicting with standard
3787 * namespaces, and should always follow the even/odd main/talk pattern.
3789 * @par Example:
3790 * @code
3791 * $wgExtraNamespaces = array(
3792 * 100 => "Hilfe",
3793 * 101 => "Hilfe_Diskussion",
3794 * 102 => "Aide",
3795 * 103 => "Discussion_Aide"
3796 * );
3797 * @endcode
3799 * @todo Add a note about maintenance/namespaceDupes.php
3801 $wgExtraNamespaces = array();
3804 * Same as above, but for namespaces with gender distinction.
3805 * Note: the default form for the namespace should also be set
3806 * using $wgExtraNamespaces for the same index.
3807 * @since 1.18
3809 $wgExtraGenderNamespaces = array();
3812 * Namespace aliases.
3814 * These are alternate names for the primary localised namespace names, which
3815 * are defined by $wgExtraNamespaces and the language file. If a page is
3816 * requested with such a prefix, the request will be redirected to the primary
3817 * name.
3819 * Set this to a map from namespace names to IDs.
3821 * @par Example:
3822 * @code
3823 * $wgNamespaceAliases = array(
3824 * 'Wikipedian' => NS_USER,
3825 * 'Help' => 100,
3826 * );
3827 * @endcode
3829 $wgNamespaceAliases = array();
3832 * Allowed title characters -- regex character class
3833 * Don't change this unless you know what you're doing
3835 * Problematic punctuation:
3836 * - []{}|# Are needed for link syntax, never enable these
3837 * - <> Causes problems with HTML escaping, don't use
3838 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3839 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3840 * corrupted by apache
3841 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3843 * All three of these punctuation problems can be avoided by using an alias,
3844 * instead of a rewrite rule of either variety.
3846 * The problem with % is that when using a path to query rewrite rule, URLs are
3847 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3848 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3849 * for this, indeed double escaping would break if the double-escaped title was
3850 * passed in the query string rather than the path. This is a minor security issue
3851 * because articles can be created such that they are hard to view or edit.
3853 * In some rare cases you may wish to remove + for compatibility with old links.
3855 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3856 * this breaks interlanguage links
3858 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3861 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3863 * @deprecated since 1.23; use $wgLocalInterwikis instead
3865 $wgLocalInterwiki = false;
3868 * Array for multiple $wgLocalInterwiki values, in case there are several
3869 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3870 * set, its value is prepended to this array, for backwards compatibility.
3872 * Note, recent changes feeds use only the first entry in this array (or
3873 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3875 $wgLocalInterwikis = array();
3878 * Expiry time for cache of interwiki table
3880 $wgInterwikiExpiry = 10800;
3883 * @name Interwiki caching settings.
3884 * @{
3888 * Interwiki cache, either as an associative array or a path to a constant
3889 * database (.cdb) file.
3891 * This data structure database is generated by the `dumpInterwiki` maintenance
3892 * script (which lives in the WikimediaMaintenance repository) and has key
3893 * formats such as the following:
3895 * - dbname:key - a simple key (e.g. enwiki:meta)
3896 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3897 * - __global:key - global-scope key (e.g. __global:meta)
3898 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3900 * Sites mapping just specifies site name, other keys provide "local url"
3901 * data layout.
3903 * @var bool|array|string
3905 $wgInterwikiCache = false;
3908 * Specify number of domains to check for messages.
3909 * - 1: Just wiki(db)-level
3910 * - 2: wiki and global levels
3911 * - 3: site levels
3913 $wgInterwikiScopes = 3;
3916 * Fallback site, if unable to resolve from cache
3918 $wgInterwikiFallbackSite = 'wiki';
3920 /** @} */ # end of Interwiki caching settings.
3923 * @name SiteStore caching settings.
3924 * @{
3928 * Specify the file location for the Sites json cache file.
3930 $wgSitesCacheFile = false;
3932 /** @} */ # end of SiteStore caching settings.
3935 * If local interwikis are set up which allow redirects,
3936 * set this regexp to restrict URLs which will be displayed
3937 * as 'redirected from' links.
3939 * @par Example:
3940 * It might look something like this:
3941 * @code
3942 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3943 * @endcode
3945 * Leave at false to avoid displaying any incoming redirect markers.
3946 * This does not affect intra-wiki redirects, which don't change
3947 * the URL.
3949 $wgRedirectSources = false;
3952 * Set this to false to avoid forcing the first letter of links to capitals.
3954 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3955 * appearing with a capital at the beginning of a sentence will *not* go to the
3956 * same place as links in the middle of a sentence using a lowercase initial.
3958 $wgCapitalLinks = true;
3961 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3962 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3963 * true by default (and setting them has no effect), due to various things that
3964 * require them to be so. Also, since Talk namespaces need to directly mirror their
3965 * associated content namespaces, the values for those are ignored in favor of the
3966 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3967 * NS_FILE.
3969 * @par Example:
3970 * @code
3971 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3972 * @endcode
3974 $wgCapitalLinkOverrides = array();
3977 * Which namespaces should support subpages?
3978 * See Language.php for a list of namespaces.
3980 $wgNamespacesWithSubpages = array(
3981 NS_TALK => true,
3982 NS_USER => true,
3983 NS_USER_TALK => true,
3984 NS_PROJECT => true,
3985 NS_PROJECT_TALK => true,
3986 NS_FILE_TALK => true,
3987 NS_MEDIAWIKI => true,
3988 NS_MEDIAWIKI_TALK => true,
3989 NS_TEMPLATE_TALK => true,
3990 NS_HELP => true,
3991 NS_HELP_TALK => true,
3992 NS_CATEGORY_TALK => true
3996 * Array holding default tracking category names.
3998 * Array contains the system messages for each tracking category.
3999 * Tracking categories allow pages with certain characteristics to be tracked.
4000 * It works by adding any such page to a category automatically.
4002 * A message with the suffix '-desc' should be added as a description message
4003 * to have extra information on Special:TrackingCategories.
4005 * @deprecated since 1.25 Extensions should now register tracking categories using
4006 * the new extension registration system.
4008 * @since 1.23
4010 $wgTrackingCategories = array();
4013 * Array of namespaces which can be deemed to contain valid "content", as far
4014 * as the site statistics are concerned. Useful if additional namespaces also
4015 * contain "content" which should be considered when generating a count of the
4016 * number of articles in the wiki.
4018 $wgContentNamespaces = array( NS_MAIN );
4021 * Array of namespaces, in addition to the talk namespaces, where signatures
4022 * (~~~~) are likely to be used. This determines whether to display the
4023 * Signature button on the edit toolbar, and may also be used by extensions.
4024 * For example, "traditional" style wikis, where content and discussion are
4025 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4027 $wgExtraSignatureNamespaces = array();
4030 * Max number of redirects to follow when resolving redirects.
4031 * 1 means only the first redirect is followed (default behavior).
4032 * 0 or less means no redirects are followed.
4034 $wgMaxRedirects = 1;
4037 * Array of invalid page redirect targets.
4038 * Attempting to create a redirect to any of the pages in this array
4039 * will make the redirect fail.
4040 * Userlogout is hard-coded, so it does not need to be listed here.
4041 * (bug 10569) Disallow Mypage and Mytalk as well.
4043 * As of now, this only checks special pages. Redirects to pages in
4044 * other namespaces cannot be invalidated by this variable.
4046 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
4048 /** @} */ # End of title and interwiki settings }
4050 /************************************************************************//**
4051 * @name Parser settings
4052 * These settings configure the transformation from wikitext to HTML.
4053 * @{
4057 * Parser configuration. Associative array with the following members:
4059 * class The class name
4061 * preprocessorClass The preprocessor class. Two classes are currently available:
4062 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4063 * storage, and Preprocessor_DOM, which uses the DOM module for
4064 * temporary storage. Preprocessor_DOM generally uses less memory;
4065 * the speed of the two is roughly the same.
4067 * If this parameter is not given, it uses Preprocessor_DOM if the
4068 * DOM module is available, otherwise it uses Preprocessor_Hash.
4070 * The entire associative array will be passed through to the constructor as
4071 * the first parameter. Note that only Setup.php can use this variable --
4072 * the configuration will change at runtime via $wgParser member functions, so
4073 * the contents of this variable will be out-of-date. The variable can only be
4074 * changed during LocalSettings.php, in particular, it can't be changed during
4075 * an extension setup function.
4077 $wgParserConf = array(
4078 'class' => 'Parser',
4079 # 'preprocessorClass' => 'Preprocessor_Hash',
4083 * Maximum indent level of toc.
4085 $wgMaxTocLevel = 999;
4088 * A complexity limit on template expansion: the maximum number of nodes visited
4089 * by PPFrame::expand()
4091 $wgMaxPPNodeCount = 1000000;
4094 * A complexity limit on template expansion: the maximum number of elements
4095 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4096 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4097 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4098 * this default corresponds to about 155 MB.
4100 * When the limit is exceeded, an exception is thrown.
4102 $wgMaxGeneratedPPNodeCount = 1000000;
4105 * Maximum recursion depth for templates within templates.
4106 * The current parser adds two levels to the PHP call stack for each template,
4107 * and xdebug limits the call stack to 100 by default. So this should hopefully
4108 * stop the parser before it hits the xdebug limit.
4110 $wgMaxTemplateDepth = 40;
4113 * @see $wgMaxTemplateDepth
4115 $wgMaxPPExpandDepth = 40;
4118 * URL schemes that should be recognized as valid by wfParseUrl().
4120 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4121 * Instead, if you want to support file links, add 'file://'. The same applies
4122 * to any other protocols with the same name as a namespace. See bug #44011 for
4123 * more information.
4125 * @see wfParseUrl
4127 $wgUrlProtocols = array(
4128 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4129 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4130 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4131 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4135 * If true, removes (by substituting) templates in signatures.
4137 $wgCleanSignatures = true;
4140 * Whether to allow inline image pointing to other websites
4142 $wgAllowExternalImages = false;
4145 * If the above is false, you can specify an exception here. Image URLs
4146 * that start with this string are then rendered, while all others are not.
4147 * You can use this to set up a trusted, simple repository of images.
4148 * You may also specify an array of strings to allow multiple sites
4150 * @par Examples:
4151 * @code
4152 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4153 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4154 * @endcode
4156 $wgAllowExternalImagesFrom = '';
4159 * If $wgAllowExternalImages is false, you can allow an on-wiki
4160 * whitelist of regular expression fragments to match the image URL
4161 * against. If the image matches one of the regular expression fragments,
4162 * The image will be displayed.
4164 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4165 * Or false to disable it
4167 $wgEnableImageWhitelist = true;
4170 * A different approach to the above: simply allow the "<img>" tag to be used.
4171 * This allows you to specify alt text and other attributes, copy-paste HTML to
4172 * your wiki more easily, etc. However, allowing external images in any manner
4173 * will allow anyone with editing rights to snoop on your visitors' IP
4174 * addresses and so forth, if they wanted to, by inserting links to images on
4175 * sites they control.
4177 $wgAllowImageTag = false;
4180 * Configuration for HTML postprocessing tool. Set this to a configuration
4181 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4182 * used. See http://www.w3.org/People/Raggett/tidy/
4184 * If this is null and $wgUseTidy is true, the deprecated configuration
4185 * parameters will be used instead.
4187 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4189 * Keys are:
4190 * - driver: May be:
4191 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4192 * - RaggettInternalPHP: Use the PECL extension
4193 * - RaggettExternal: Shell out to an external binary (tidyBin)
4195 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4196 * - debugComment: True to add a comment to the output with warning messages
4197 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4198 * - tidyCommandLine: For RaggettExternal, additional command line options.
4200 $wgTidyConfig = null;
4203 * Set this to true to use the deprecated tidy configuration parameters.
4204 * @deprecated use $wgTidyConfig
4206 $wgUseTidy = false;
4209 * The path to the tidy binary.
4210 * @deprecated Use $wgTidyConfig['tidyBin']
4212 $wgTidyBin = 'tidy';
4215 * The path to the tidy config file
4216 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4218 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4221 * The command line options to the tidy binary
4222 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4224 $wgTidyOpts = '';
4227 * Set this to true to use the tidy extension
4228 * @deprecated Use $wgTidyConfig['driver']
4230 $wgTidyInternal = extension_loaded( 'tidy' );
4233 * Put tidy warnings in HTML comments
4234 * Only works for internal tidy.
4236 $wgDebugTidy = false;
4239 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4240 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4241 * TO RESTRICT EDITING to only those that you trust
4243 $wgRawHtml = false;
4246 * Set a default target for external links, e.g. _blank to pop up a new window
4248 $wgExternalLinkTarget = false;
4251 * If true, external URL links in wiki text will be given the
4252 * rel="nofollow" attribute as a hint to search engines that
4253 * they should not be followed for ranking purposes as they
4254 * are user-supplied and thus subject to spamming.
4256 $wgNoFollowLinks = true;
4259 * Namespaces in which $wgNoFollowLinks doesn't apply.
4260 * See Language.php for a list of namespaces.
4262 $wgNoFollowNsExceptions = array();
4265 * If this is set to an array of domains, external links to these domain names
4266 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4267 * value of $wgNoFollowLinks. For instance:
4269 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4270 * 'mediawiki.org' );
4272 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4273 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4274 * etc.
4276 * Defaults to mediawiki.org for the links included in the software by default.
4278 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4281 * Allow DISPLAYTITLE to change title display
4283 $wgAllowDisplayTitle = true;
4286 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4287 * canonical DB key. Also disallow some inline CSS rules like display: none;
4288 * which can cause the text to be hidden or unselectable.
4290 $wgRestrictDisplayTitle = true;
4293 * Maximum number of calls per parse to expensive parser functions such as
4294 * PAGESINCATEGORY.
4296 $wgExpensiveParserFunctionLimit = 100;
4299 * Preprocessor caching threshold
4300 * Setting it to 'false' will disable the preprocessor cache.
4302 $wgPreprocessorCacheThreshold = 1000;
4305 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4307 $wgEnableScaryTranscluding = false;
4310 * Expiry time for transcluded templates cached in transcache database table.
4311 * Only used $wgEnableInterwikiTranscluding is set to true.
4313 $wgTranscludeCacheExpiry = 3600;
4315 /** @} */ # end of parser settings }
4317 /************************************************************************//**
4318 * @name Statistics
4319 * @{
4323 * Method used to determine if a page in a content namespace should be counted
4324 * as a valid article.
4326 * Redirect pages will never be counted as valid articles.
4328 * This variable can have the following values:
4329 * - 'any': all pages as considered as valid articles
4330 * - 'comma': the page must contain a comma to be considered valid
4331 * - 'link': the page must contain a [[wiki link]] to be considered valid
4333 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4335 * Retroactively changing this variable will not affect the existing count,
4336 * to update it, you will need to run the maintenance/updateArticleCount.php
4337 * script.
4339 $wgArticleCountMethod = 'link';
4342 * How many days user must be idle before he is considered inactive. Will affect
4343 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4344 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4345 * You might want to leave this as the default value, to provide comparable
4346 * numbers between different wikis.
4348 $wgActiveUserDays = 30;
4350 /** @} */ # End of statistics }
4352 /************************************************************************//**
4353 * @name User accounts, authentication
4354 * @{
4358 * Central ID lookup providers
4359 * Key is the provider ID, value is a specification for ObjectFactory
4360 * @since 1.27
4362 $wgCentralIdLookupProviders = array(
4363 'local' => array( 'class' => 'LocalIdLookup' ),
4367 * Central ID lookup provider to use by default
4368 * @var string
4370 $wgCentralIdLookupProvider = 'local';
4373 * Password policy for local wiki users. A user's effective policy
4374 * is the superset of all policy statements from the policies for the
4375 * groups where the user is a member. If more than one group policy
4376 * include the same policy statement, the value is the max() of the
4377 * values. Note true > false. The 'default' policy group is required,
4378 * and serves as the minimum policy for all users. New statements can
4379 * be added by appending to $wgPasswordPolicy['checks'].
4380 * Statements:
4381 * - MinimalPasswordLength - minimum length a user can set
4382 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4383 * not be allowed to login, regardless if it is correct.
4384 * - MaximalPasswordLength - maximum length password a user is allowed
4385 * to attempt. Prevents DoS attacks with pbkdf2.
4386 * - PasswordCannotMatchUsername - Password cannot match username to
4387 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4388 * match a specific, hardcoded blacklist.
4389 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4390 * commonly chosen. Set to integer n to ban the top n passwords.
4391 * If you want to ban all common passwords on file, use the
4392 * PHP_INT_MAX constant.
4393 * @since 1.26
4395 $wgPasswordPolicy = array(
4396 'policies' => array(
4397 'bureaucrat' => array(
4398 'MinimalPasswordLength' => 8,
4399 'MinimumPasswordLengthToLogin' => 1,
4400 'PasswordCannotMatchUsername' => true,
4401 'PasswordCannotBePopular' => 25,
4403 'sysop' => array(
4404 'MinimalPasswordLength' => 8,
4405 'MinimumPasswordLengthToLogin' => 1,
4406 'PasswordCannotMatchUsername' => true,
4407 'PasswordCannotBePopular' => 25,
4409 'bot' => array(
4410 'MinimalPasswordLength' => 8,
4411 'MinimumPasswordLengthToLogin' => 1,
4412 'PasswordCannotMatchUsername' => true,
4414 'default' => array(
4415 'MinimalPasswordLength' => 1,
4416 'PasswordCannotMatchUsername' => true,
4417 'PasswordCannotMatchBlacklist' => true,
4418 'MaximalPasswordLength' => 4096,
4421 'checks' => array(
4422 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4423 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4424 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4425 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4426 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4427 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist'
4432 * For compatibility with old installations set to false
4433 * @deprecated since 1.24 will be removed in future
4435 $wgPasswordSalt = true;
4438 * Specifies the minimal length of a user password. If set to 0, empty pass-
4439 * words are allowed.
4440 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4442 $wgMinimalPasswordLength = false;
4445 * Specifies the maximal length of a user password (T64685).
4447 * It is not recommended to make this greater than the default, as it can
4448 * allow DoS attacks by users setting really long passwords. In addition,
4449 * this should not be lowered too much, as it enforces weak passwords.
4451 * @warning Unlike other password settings, user with passwords greater than
4452 * the maximum will not be able to log in.
4453 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4455 $wgMaximalPasswordLength = false;
4458 * Specifies if users should be sent to a password-reset form on login, if their
4459 * password doesn't meet the requirements of User::isValidPassword().
4460 * @since 1.23
4462 $wgInvalidPasswordReset = true;
4465 * Default password type to use when hashing user passwords
4467 * @since 1.24
4469 $wgPasswordDefault = 'pbkdf2';
4472 * Configuration for built-in password types. Maps the password type
4473 * to an array of options. The 'class' option is the Password class to
4474 * use. All other options are class-dependent.
4476 * An advanced example:
4477 * @code
4478 * $wgPasswordConfig['bcrypt-peppered'] = array(
4479 * 'class' => 'EncryptedPassword',
4480 * 'underlying' => 'bcrypt',
4481 * 'secrets' => array(),
4482 * 'cipher' => MCRYPT_RIJNDAEL_256,
4483 * 'mode' => MCRYPT_MODE_CBC,
4484 * 'cost' => 5,
4485 * );
4486 * @endcode
4488 * @since 1.24
4490 $wgPasswordConfig = array(
4491 'A' => array(
4492 'class' => 'MWOldPassword',
4494 'B' => array(
4495 'class' => 'MWSaltedPassword',
4497 'pbkdf2-legacyA' => array(
4498 'class' => 'LayeredParameterizedPassword',
4499 'types' => array(
4500 'A',
4501 'pbkdf2',
4504 'pbkdf2-legacyB' => array(
4505 'class' => 'LayeredParameterizedPassword',
4506 'types' => array(
4507 'B',
4508 'pbkdf2',
4511 'bcrypt' => array(
4512 'class' => 'BcryptPassword',
4513 'cost' => 9,
4515 'pbkdf2' => array(
4516 'class' => 'Pbkdf2Password',
4517 'algo' => 'sha256',
4518 'cost' => '10000',
4519 'length' => '128',
4524 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4525 * with a temporary password you can use to get back into the account") identified by
4526 * various bits of data. Setting all of these to false (or the whole variable to false)
4527 * has the effect of disabling password resets entirely
4529 $wgPasswordResetRoutes = array(
4530 'username' => true,
4531 'email' => true,
4535 * Maximum number of Unicode characters in signature
4537 $wgMaxSigChars = 255;
4540 * Maximum number of bytes in username. You want to run the maintenance
4541 * script ./maintenance/checkUsernames.php once you have changed this value.
4543 $wgMaxNameChars = 255;
4546 * Array of usernames which may not be registered or logged in from
4547 * Maintenance scripts can still use these
4549 $wgReservedUsernames = array(
4550 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4551 'Conversion script', // Used for the old Wikipedia software upgrade
4552 'Maintenance script', // Maintenance scripts which perform editing, image import script
4553 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4554 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4555 'msg:double-redirect-fixer', // Automatic double redirect fix
4556 'msg:usermessage-editor', // Default user for leaving user messages
4557 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4558 'msg:spambot_username', // Used by cleanupSpam.php
4559 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4563 * Settings added to this array will override the default globals for the user
4564 * preferences used by anonymous visitors and newly created accounts.
4565 * For instance, to disable editing on double clicks:
4566 * $wgDefaultUserOptions ['editondblclick'] = 0;
4568 $wgDefaultUserOptions = array(
4569 'ccmeonemails' => 0,
4570 'cols' => 80,
4571 'date' => 'default',
4572 'diffonly' => 0,
4573 'disablemail' => 0,
4574 'editfont' => 'default',
4575 'editondblclick' => 0,
4576 'editsectiononrightclick' => 0,
4577 'enotifminoredits' => 0,
4578 'enotifrevealaddr' => 0,
4579 'enotifusertalkpages' => 1,
4580 'enotifwatchlistpages' => 1,
4581 'extendwatchlist' => 1,
4582 'fancysig' => 0,
4583 'forceeditsummary' => 0,
4584 'gender' => 'unknown',
4585 'hideminor' => 0,
4586 'hidepatrolled' => 0,
4587 'hidecategorization' => 1,
4588 'imagesize' => 2,
4589 'math' => 1,
4590 'minordefault' => 0,
4591 'newpageshidepatrolled' => 0,
4592 'nickname' => '',
4593 'norollbackdiff' => 0,
4594 'numberheadings' => 0,
4595 'previewonfirst' => 0,
4596 'previewontop' => 1,
4597 'rcdays' => 7,
4598 'rclimit' => 50,
4599 'rows' => 25,
4600 'showhiddencats' => 0,
4601 'shownumberswatching' => 1,
4602 'showtoolbar' => 1,
4603 'skin' => false,
4604 'stubthreshold' => 0,
4605 'thumbsize' => 5,
4606 'underline' => 2,
4607 'uselivepreview' => 0,
4608 'usenewrc' => 1,
4609 'watchcreations' => 1,
4610 'watchdefault' => 1,
4611 'watchdeletion' => 0,
4612 'watchlistdays' => 3.0,
4613 'watchlisthideanons' => 0,
4614 'watchlisthidebots' => 0,
4615 'watchlisthideliu' => 0,
4616 'watchlisthideminor' => 0,
4617 'watchlisthideown' => 0,
4618 'watchlisthidepatrolled' => 0,
4619 'watchlisthidecategorization' => 1,
4620 'watchlistreloadautomatically' => 0,
4621 'watchmoves' => 0,
4622 'watchrollback' => 0,
4623 'wllimit' => 250,
4624 'useeditwarning' => 1,
4625 'prefershttps' => 1,
4629 * An array of preferences to not show for the user
4631 $wgHiddenPrefs = array();
4634 * Characters to prevent during new account creations.
4635 * This is used in a regular expression character class during
4636 * registration (regex metacharacters like / are escaped).
4638 $wgInvalidUsernameCharacters = '@:';
4641 * Character used as a delimiter when testing for interwiki userrights
4642 * (In Special:UserRights, it is possible to modify users on different
4643 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4645 * It is recommended that you have this delimiter in
4646 * $wgInvalidUsernameCharacters above, or you will not be able to
4647 * modify the user rights of those users via Special:UserRights
4649 $wgUserrightsInterwikiDelimiter = '@';
4652 * This is to let user authenticate using https when they come from http.
4653 * Based on an idea by George Herbert on wikitech-l:
4654 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4655 * @since 1.17
4657 $wgSecureLogin = false;
4660 * MediaWiki\Session\SessionProvider configuration.
4662 * Value is an array of ObjectFactory specifications for the SessionProviders
4663 * to be used. Keys in the array are ignored. Order is not significant.
4665 * @since 1.27
4667 $wgSessionProviders = array(
4668 'MediaWiki\\Session\\CookieSessionProvider' => array(
4669 'class' => 'MediaWiki\\Session\\CookieSessionProvider',
4670 'args' => array( array(
4671 'priority' => 30,
4672 'callUserSetCookiesHook' => true,
4673 ) ),
4675 'MediaWiki\\Session\\BotPasswordSessionProvider' => array(
4676 'class' => 'MediaWiki\\Session\\BotPasswordSessionProvider',
4677 'args' => array( array(
4678 'priority' => 40,
4679 ) ),
4683 /** @} */ # end user accounts }
4685 /************************************************************************//**
4686 * @name User rights, access control and monitoring
4687 * @{
4691 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4693 $wgAutoblockExpiry = 86400;
4696 * Set this to true to allow blocked users to edit their own user talk page.
4698 $wgBlockAllowsUTEdit = true;
4701 * Allow sysops to ban users from accessing Emailuser
4703 $wgSysopEmailBans = true;
4706 * Limits on the possible sizes of range blocks.
4708 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4709 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4710 * half the number of bits avoids such errors, and allows entire ISPs to be
4711 * blocked using a small number of range blocks.
4713 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4714 * customer, so range blocks larger than /64 (half the number of bits) will
4715 * plainly be required. RFC 4692 implies that a very large ISP may be
4716 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4717 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4719 $wgBlockCIDRLimit = array(
4720 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4721 'IPv6' => 19,
4725 * If true, blocked users will not be allowed to login. When using this with
4726 * a public wiki, the effect of logging out blocked users may actually be
4727 * avers: unless the user's address is also blocked (e.g. auto-block),
4728 * logging the user out will again allow reading and editing, just as for
4729 * anonymous visitors.
4731 $wgBlockDisablesLogin = false;
4734 * Pages anonymous user may see, set as an array of pages titles.
4736 * @par Example:
4737 * @code
4738 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4739 * @endcode
4741 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4743 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4744 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4746 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4747 * will remain readable. You can use img_auth.php to protect uploaded files,
4748 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4750 $wgWhitelistRead = false;
4753 * Pages anonymous user may see, set as an array of regular expressions.
4755 * This function will match the regexp against the title name, which
4756 * is without underscore.
4758 * @par Example:
4759 * To whitelist [[Main Page]]:
4760 * @code
4761 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4762 * @endcode
4764 * @note Unless ^ and/or $ is specified, a regular expression might match
4765 * pages not intended to be whitelisted. The above example will also
4766 * whitelist a page named 'Security Main Page'.
4768 * @par Example:
4769 * To allow reading any page starting with 'User' regardless of the case:
4770 * @code
4771 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4772 * @endcode
4773 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4775 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4776 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4778 $wgWhitelistReadRegexp = false;
4781 * Should editors be required to have a validated e-mail
4782 * address before being allowed to edit?
4784 $wgEmailConfirmToEdit = false;
4787 * Should MediaWiki attempt to protect user's privacy when doing redirects?
4788 * Keep this true if access counts to articles are made public.
4790 $wgHideIdentifiableRedirects = true;
4793 * Permission keys given to users in each group.
4795 * This is an array where the keys are all groups and each value is an
4796 * array of the format (right => boolean).
4798 * The second format is used to support per-namespace permissions.
4799 * Note that this feature does not fully work for all permission types.
4801 * All users are implicitly in the '*' group including anonymous visitors;
4802 * logged-in users are all implicitly in the 'user' group. These will be
4803 * combined with the permissions of all groups that a given user is listed
4804 * in in the user_groups table.
4806 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4807 * doing! This will wipe all permissions, and may mean that your users are
4808 * unable to perform certain essential tasks or access new functionality
4809 * when new permissions are introduced and default grants established.
4811 * Functionality to make pages inaccessible has not been extensively tested
4812 * for security. Use at your own risk!
4814 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4816 $wgGroupPermissions = array();
4818 /** @cond file_level_code */
4819 // Implicit group for all visitors
4820 $wgGroupPermissions['*']['createaccount'] = true;
4821 $wgGroupPermissions['*']['read'] = true;
4822 $wgGroupPermissions['*']['edit'] = true;
4823 $wgGroupPermissions['*']['createpage'] = true;
4824 $wgGroupPermissions['*']['createtalk'] = true;
4825 $wgGroupPermissions['*']['writeapi'] = true;
4826 $wgGroupPermissions['*']['editmyusercss'] = true;
4827 $wgGroupPermissions['*']['editmyuserjs'] = true;
4828 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4829 $wgGroupPermissions['*']['editmywatchlist'] = true;
4830 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4831 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4832 $wgGroupPermissions['*']['editmyoptions'] = true;
4833 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4835 // Implicit group for all logged-in accounts
4836 $wgGroupPermissions['user']['move'] = true;
4837 $wgGroupPermissions['user']['move-subpages'] = true;
4838 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4839 $wgGroupPermissions['user']['move-categorypages'] = true;
4840 $wgGroupPermissions['user']['movefile'] = true;
4841 $wgGroupPermissions['user']['read'] = true;
4842 $wgGroupPermissions['user']['edit'] = true;
4843 $wgGroupPermissions['user']['createpage'] = true;
4844 $wgGroupPermissions['user']['createtalk'] = true;
4845 $wgGroupPermissions['user']['writeapi'] = true;
4846 $wgGroupPermissions['user']['upload'] = true;
4847 $wgGroupPermissions['user']['reupload'] = true;
4848 $wgGroupPermissions['user']['reupload-shared'] = true;
4849 $wgGroupPermissions['user']['minoredit'] = true;
4850 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4851 $wgGroupPermissions['user']['sendemail'] = true;
4852 $wgGroupPermissions['user']['applychangetags'] = true;
4853 $wgGroupPermissions['user']['changetags'] = true;
4855 // Implicit group for accounts that pass $wgAutoConfirmAge
4856 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4857 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4859 // Users with bot privilege can have their edits hidden
4860 // from various log pages by default
4861 $wgGroupPermissions['bot']['bot'] = true;
4862 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4863 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4864 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4865 $wgGroupPermissions['bot']['autopatrol'] = true;
4866 $wgGroupPermissions['bot']['suppressredirect'] = true;
4867 $wgGroupPermissions['bot']['apihighlimits'] = true;
4868 $wgGroupPermissions['bot']['writeapi'] = true;
4870 // Most extra permission abilities go to this group
4871 $wgGroupPermissions['sysop']['block'] = true;
4872 $wgGroupPermissions['sysop']['createaccount'] = true;
4873 $wgGroupPermissions['sysop']['delete'] = true;
4874 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4875 $wgGroupPermissions['sysop']['bigdelete'] = true;
4876 // can view deleted history entries, but not see or restore the text
4877 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4878 // can view deleted revision text
4879 $wgGroupPermissions['sysop']['deletedtext'] = true;
4880 $wgGroupPermissions['sysop']['undelete'] = true;
4881 $wgGroupPermissions['sysop']['editinterface'] = true;
4882 $wgGroupPermissions['sysop']['editusercss'] = true;
4883 $wgGroupPermissions['sysop']['edituserjs'] = true;
4884 $wgGroupPermissions['sysop']['import'] = true;
4885 $wgGroupPermissions['sysop']['importupload'] = true;
4886 $wgGroupPermissions['sysop']['move'] = true;
4887 $wgGroupPermissions['sysop']['move-subpages'] = true;
4888 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4889 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4890 $wgGroupPermissions['sysop']['patrol'] = true;
4891 $wgGroupPermissions['sysop']['autopatrol'] = true;
4892 $wgGroupPermissions['sysop']['protect'] = true;
4893 $wgGroupPermissions['sysop']['editprotected'] = true;
4894 $wgGroupPermissions['sysop']['rollback'] = true;
4895 $wgGroupPermissions['sysop']['upload'] = true;
4896 $wgGroupPermissions['sysop']['reupload'] = true;
4897 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4898 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4899 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4900 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4901 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4902 $wgGroupPermissions['sysop']['blockemail'] = true;
4903 $wgGroupPermissions['sysop']['markbotedits'] = true;
4904 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4905 $wgGroupPermissions['sysop']['browsearchive'] = true;
4906 $wgGroupPermissions['sysop']['noratelimit'] = true;
4907 $wgGroupPermissions['sysop']['movefile'] = true;
4908 $wgGroupPermissions['sysop']['unblockself'] = true;
4909 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4910 # $wgGroupPermissions['sysop']['pagelang'] = true;
4911 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
4912 $wgGroupPermissions['sysop']['mergehistory'] = true;
4913 $wgGroupPermissions['sysop']['managechangetags'] = true;
4915 // Permission to change users' group assignments
4916 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4917 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4918 // Permission to change users' groups assignments across wikis
4919 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4920 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4921 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4923 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
4924 # $wgGroupPermissions['sysop']['deleterevision'] = true;
4925 // To hide usernames from users and Sysops
4926 # $wgGroupPermissions['suppress']['hideuser'] = true;
4927 // To hide revisions/log items from users and Sysops
4928 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
4929 // To view revisions/log items hidden from users and Sysops
4930 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
4931 // For private suppression log access
4932 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
4935 * The developer group is deprecated, but can be activated if need be
4936 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4937 * that a lock file be defined and creatable/removable by the web
4938 * server.
4940 # $wgGroupPermissions['developer']['siteadmin'] = true;
4942 /** @endcond */
4945 * Permission keys revoked from users in each group.
4947 * This acts the same way as wgGroupPermissions above, except that
4948 * if the user is in a group here, the permission will be removed from them.
4950 * Improperly setting this could mean that your users will be unable to perform
4951 * certain essential tasks, so use at your own risk!
4953 $wgRevokePermissions = array();
4956 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4958 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4961 * A map of group names that the user is in, to group names that those users
4962 * are allowed to add or revoke.
4964 * Setting the list of groups to add or revoke to true is equivalent to "any
4965 * group".
4967 * @par Example:
4968 * To allow sysops to add themselves to the "bot" group:
4969 * @code
4970 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4971 * @endcode
4973 * @par Example:
4974 * Implicit groups may be used for the source group, for instance:
4975 * @code
4976 * $wgGroupsRemoveFromSelf = array( '*' => true );
4977 * @endcode
4978 * This allows users in the '*' group (i.e. any user) to remove themselves from
4979 * any group that they happen to be in.
4981 $wgGroupsAddToSelf = array();
4984 * @see $wgGroupsAddToSelf
4986 $wgGroupsRemoveFromSelf = array();
4989 * Set of available actions that can be restricted via action=protect
4990 * You probably shouldn't change this.
4991 * Translated through restriction-* messages.
4992 * Title::getRestrictionTypes() will remove restrictions that are not
4993 * applicable to a specific title (create and upload)
4995 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4998 * Rights which can be required for each protection level (via action=protect)
5000 * You can add a new protection level that requires a specific
5001 * permission by manipulating this array. The ordering of elements
5002 * dictates the order on the protection form's lists.
5004 * - '' will be ignored (i.e. unprotected)
5005 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
5006 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
5008 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
5011 * Restriction levels that can be used with cascading protection
5013 * A page can only be protected with cascading protection if the
5014 * requested restriction level is included in this array.
5016 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5017 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
5019 $wgCascadingRestrictionLevels = array( 'sysop' );
5022 * Restriction levels that should be considered "semiprotected"
5024 * Certain places in the interface recognize a dichotomy between "protected"
5025 * and "semiprotected", without further distinguishing the specific levels. In
5026 * general, if anyone can be eligible to edit a protection level merely by
5027 * reaching some condition in $wgAutopromote, it should probably be considered
5028 * "semiprotected".
5030 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5031 * 'sysop' is not changed, since it really shouldn't be here.
5033 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
5036 * Set the minimum permissions required to edit pages in each
5037 * namespace. If you list more than one permission, a user must
5038 * have all of them to edit pages in that namespace.
5040 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5042 $wgNamespaceProtection = array();
5045 * Pages in namespaces in this array can not be used as templates.
5047 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5048 * namespaces constants (NS_USER, NS_MAIN...).
5050 * Among other things, this may be useful to enforce read-restrictions
5051 * which may otherwise be bypassed by using the template mechanism.
5053 $wgNonincludableNamespaces = array();
5056 * Number of seconds an account is required to age before it's given the
5057 * implicit 'autoconfirm' group membership. This can be used to limit
5058 * privileges of new accounts.
5060 * Accounts created by earlier versions of the software may not have a
5061 * recorded creation date, and will always be considered to pass the age test.
5063 * When left at 0, all registered accounts will pass.
5065 * @par Example:
5066 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5067 * @code
5068 * $wgAutoConfirmAge = 600; // ten minutes
5069 * @endcode
5070 * Set age to one day:
5071 * @code
5072 * $wgAutoConfirmAge = 3600*24; // one day
5073 * @endcode
5075 $wgAutoConfirmAge = 0;
5078 * Number of edits an account requires before it is autoconfirmed.
5079 * Passing both this AND the time requirement is needed. Example:
5081 * @par Example:
5082 * @code
5083 * $wgAutoConfirmCount = 50;
5084 * @endcode
5086 $wgAutoConfirmCount = 0;
5089 * Automatically add a usergroup to any user who matches certain conditions.
5091 * @todo Redocument $wgAutopromote
5093 * The format is
5094 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
5095 * where cond1, cond2, ... are themselves conditions; *OR*
5096 * APCOND_EMAILCONFIRMED, *OR*
5097 * array( APCOND_EMAILCONFIRMED ), *OR*
5098 * array( APCOND_EDITCOUNT, number of edits ), *OR*
5099 * array( APCOND_AGE, seconds since registration ), *OR*
5100 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
5101 * array( APCOND_ISIP, ip ), *OR*
5102 * array( APCOND_IPINRANGE, range ), *OR*
5103 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
5104 * array( APCOND_BLOCKED ), *OR*
5105 * array( APCOND_ISBOT ), *OR*
5106 * similar constructs defined by extensions.
5108 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
5109 * user who has provided an e-mail address.
5111 $wgAutopromote = array(
5112 'autoconfirmed' => array( '&',
5113 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
5114 array( APCOND_AGE, &$wgAutoConfirmAge ),
5119 * Automatically add a usergroup to any user who matches certain conditions.
5121 * Does not add the user to the group again if it has been removed.
5122 * Also, does not remove the group if the user no longer meets the criteria.
5124 * The format is:
5125 * @code
5126 * array( event => criteria, ... )
5127 * @endcode
5128 * Where event is either:
5129 * - 'onEdit' (when user edits)
5131 * Criteria has the same format as $wgAutopromote
5133 * @see $wgAutopromote
5134 * @since 1.18
5136 $wgAutopromoteOnce = array(
5137 'onEdit' => array(),
5141 * Put user rights log entries for autopromotion in recent changes?
5142 * @since 1.18
5144 $wgAutopromoteOnceLogInRC = true;
5147 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5148 * can assign which groups at Special:Userrights.
5150 * @par Example:
5151 * Bureaucrats can add any group:
5152 * @code
5153 * $wgAddGroups['bureaucrat'] = true;
5154 * @endcode
5155 * Bureaucrats can only remove bots and sysops:
5156 * @code
5157 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
5158 * @endcode
5159 * Sysops can make bots:
5160 * @code
5161 * $wgAddGroups['sysop'] = array( 'bot' );
5162 * @endcode
5163 * Sysops can disable other sysops in an emergency, and disable bots:
5164 * @code
5165 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
5166 * @endcode
5168 $wgAddGroups = array();
5171 * @see $wgAddGroups
5173 $wgRemoveGroups = array();
5176 * A list of available rights, in addition to the ones defined by the core.
5177 * For extensions only.
5179 $wgAvailableRights = array();
5182 * Optional to restrict deletion of pages with higher revision counts
5183 * to users with the 'bigdelete' permission. (Default given to sysops.)
5185 $wgDeleteRevisionsLimit = 0;
5188 * The maximum number of edits a user can have and
5189 * can still be hidden by users with the hideuser permission.
5190 * This is limited for performance reason.
5191 * Set to false to disable the limit.
5192 * @since 1.23
5194 $wgHideUserContribLimit = 1000;
5197 * Number of accounts each IP address may create, 0 to disable.
5199 * @warning Requires memcached
5201 $wgAccountCreationThrottle = 0;
5204 * Edits matching these regular expressions in body text
5205 * will be recognised as spam and rejected automatically.
5207 * There's no administrator override on-wiki, so be careful what you set. :)
5208 * May be an array of regexes or a single string for backwards compatibility.
5210 * @see https://en.wikipedia.org/wiki/Regular_expression
5212 * @note Each regex needs a beginning/end delimiter, eg: # or /
5214 $wgSpamRegex = array();
5217 * Same as the above except for edit summaries
5219 $wgSummarySpamRegex = array();
5222 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5223 * proxies
5224 * @since 1.16
5226 $wgEnableDnsBlacklist = false;
5229 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5231 * This is an array of either a URL or an array with the URL and a key (should
5232 * the blacklist require a key).
5234 * @par Example:
5235 * @code
5236 * $wgDnsBlacklistUrls = array(
5237 * // String containing URL
5238 * 'http.dnsbl.sorbs.net.',
5239 * // Array with URL and key, for services that require a key
5240 * array( 'dnsbl.httpbl.net.', 'mykey' ),
5241 * // Array with just the URL. While this works, it is recommended that you
5242 * // just use a string as shown above
5243 * array( 'opm.tornevall.org.' )
5244 * );
5245 * @endcode
5247 * @note You should end the domain name with a . to avoid searching your
5248 * eventual domain search suffixes.
5249 * @since 1.16
5251 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
5254 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5255 * what the other methods might say.
5257 $wgProxyWhitelist = array();
5260 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5261 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5262 * (transparent) proxies without needing to block the proxies themselves.
5264 $wgApplyIpBlocksToXff = false;
5267 * Simple rate limiter options to brake edit floods.
5269 * Maximum number actions allowed in the given number of seconds; after that
5270 * the violating client receives HTTP 500 error pages until the period
5271 * elapses.
5273 * @par Example:
5274 * To set a generic maximum of 4 hits in 60 seconds:
5275 * @code
5276 * $wgRateLimits = array( 4, 60 );
5277 * @endcode
5279 * @par Example:
5280 * You could also limit per action and then type of users.
5281 * @code
5282 * $wgRateLimits = array(
5283 * 'edit' => array(
5284 * 'anon' => array( x, y ), // any and all anonymous edits (aggregate)
5285 * 'user' => array( x, y ), // each logged-in user
5286 * 'newbie' => array( x, y ), // each new autoconfirmed accounts; overrides 'user'
5287 * 'ip' => array( x, y ), // each anon and recent account
5288 * 'subnet' => array( x, y ), // ... within a /24 subnet in IPv4 or /64 in IPv6
5291 * @endcode
5293 * @warning Requires that $wgMainCacheType is set to something persistent
5295 $wgRateLimits = array(
5296 // Page edits
5297 'edit' => array(
5298 'ip' => array( 8, 60 ),
5299 'newbie' => array( 8, 60 ),
5301 // Page moves
5302 'move' => array(
5303 'newbie' => array( 2, 120 ),
5304 'user' => array( 8, 60 ),
5306 // File uploads
5307 'upload' => array(
5308 'ip' => array( 8, 60 ),
5309 'newbie' => array( 8, 60 ),
5311 // Page rollbacks
5312 'rollback' => array(
5313 'user' => array( 10, 60 ),
5314 'newbie' => array( 5, 120 )
5316 // Triggering password resets emails
5317 'mailpassword' => array(
5318 'ip' => array( 5, 3600 ),
5320 // Emailing other users using MediaWiki
5321 'emailuser' => array(
5322 'ip' => array( 5, 86400 ),
5323 'newbie' => array( 5, 86400 ),
5324 'user' => array( 20, 86400 ),
5326 // Purging pages
5327 'purge' => array(
5328 'ip' => array( 30, 60 ),
5329 'user' => array( 30, 60 ),
5331 // Purges of link tables
5332 'linkpurge' => array(
5333 'ip' => array( 30, 60 ),
5334 'user' => array( 30, 60 ),
5336 // Files rendered via thumb.php or thumb_handler.php
5337 'renderfile' => array(
5338 'ip' => array( 700, 30 ),
5339 'user' => array( 700, 30 ),
5341 // Same as above but for non-standard thumbnails
5342 'renderfile-nonstandard' => array(
5343 'ip' => array( 70, 30 ),
5344 'user' => array( 70, 30 ),
5346 // Stashing edits into cache before save
5347 'stashedit' => array(
5348 'ip' => array( 30, 60 ),
5349 'newbie' => array( 30, 60 ),
5351 // Adding or removing change tags
5352 'changetag' => array(
5353 'ip' => array( 8, 60 ),
5354 'newbie' => array( 8, 60 ),
5359 * Array of IPs which should be excluded from rate limits.
5360 * This may be useful for whitelisting NAT gateways for conferences, etc.
5362 $wgRateLimitsExcludedIPs = array();
5365 * Log IP addresses in the recentchanges table; can be accessed only by
5366 * extensions (e.g. CheckUser) or a DB admin
5367 * Used for retroactive autoblocks
5369 $wgPutIPinRC = true;
5372 * Integer defining default number of entries to show on
5373 * special pages which are query-pages such as Special:Whatlinkshere.
5375 $wgQueryPageDefaultLimit = 50;
5378 * Limit password attempts to X attempts per Y seconds per IP per account.
5380 * @warning Requires memcached.
5382 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5385 * @var Array Map of (grant => right => boolean)
5386 * Users authorize consumers (like Apps) to act on their behalf but only with
5387 * a subset of the user's normal account rights (signed off on by the user).
5388 * The possible rights to grant to a consumer are bundled into groups called
5389 * "grants". Each grant defines some rights it lets consumers inherit from the
5390 * account they may act on behalf of. Note that a user granting a right does
5391 * nothing if that user does not actually have that right to begin with.
5392 * @since 1.27
5394 $wgGrantPermissions = array();
5396 // @TODO: clean up grants
5397 // @TODO: auto-include read/editsemiprotected rights?
5399 $wgGrantPermissions['basic']['autoconfirmed'] = true;
5400 $wgGrantPermissions['basic']['autopatrol'] = true;
5401 $wgGrantPermissions['basic']['autoreview'] = true;
5402 $wgGrantPermissions['basic']['editsemiprotected'] = true;
5403 $wgGrantPermissions['basic']['ipblock-exempt'] = true;
5404 $wgGrantPermissions['basic']['nominornewtalk'] = true;
5405 $wgGrantPermissions['basic']['patrolmarks'] = true;
5406 $wgGrantPermissions['basic']['purge'] = true;
5407 $wgGrantPermissions['basic']['read'] = true;
5408 $wgGrantPermissions['basic']['skipcaptcha'] = true;
5409 $wgGrantPermissions['basic']['torunblocked'] = true;
5410 $wgGrantPermissions['basic']['writeapi'] = true;
5412 $wgGrantPermissions['highvolume']['bot'] = true;
5413 $wgGrantPermissions['highvolume']['apihighlimits'] = true;
5414 $wgGrantPermissions['highvolume']['noratelimit'] = true;
5415 $wgGrantPermissions['highvolume']['markbotedits'] = true;
5417 $wgGrantPermissions['editpage']['edit'] = true;
5418 $wgGrantPermissions['editpage']['minoredit'] = true;
5419 $wgGrantPermissions['editpage']['applychangetags'] = true;
5420 $wgGrantPermissions['editpage']['changetags'] = true;
5422 $wgGrantPermissions['editprotected'] = $wgGrantPermissions['editpage'];
5423 $wgGrantPermissions['editprotected']['editprotected'] = true;
5425 $wgGrantPermissions['editmycssjs'] = $wgGrantPermissions['editpage'];
5426 $wgGrantPermissions['editmycssjs']['editmyusercss'] = true;
5427 $wgGrantPermissions['editmycssjs']['editmyuserjs'] = true;
5429 $wgGrantPermissions['editmyoptions']['editmyoptions'] = true;
5431 $wgGrantPermissions['editinterface'] = $wgGrantPermissions['editpage'];
5432 $wgGrantPermissions['editinterface']['editinterface'] = true;
5433 $wgGrantPermissions['editinterface']['editusercss'] = true;
5434 $wgGrantPermissions['editinterface']['edituserjs'] = true;
5436 $wgGrantPermissions['createeditmovepage'] = $wgGrantPermissions['editpage'];
5437 $wgGrantPermissions['createeditmovepage']['createpage'] = true;
5438 $wgGrantPermissions['createeditmovepage']['createtalk'] = true;
5439 $wgGrantPermissions['createeditmovepage']['move'] = true;
5440 $wgGrantPermissions['createeditmovepage']['move-rootuserpages'] = true;
5441 $wgGrantPermissions['createeditmovepage']['move-subpages'] = true;
5442 $wgGrantPermissions['createeditmovepage']['move-categorypages'] = true;
5444 $wgGrantPermissions['uploadfile']['upload'] = true;
5445 $wgGrantPermissions['uploadfile']['reupload-own'] = true;
5447 $wgGrantPermissions['uploadeditmovefile'] = $wgGrantPermissions['uploadfile'];
5448 $wgGrantPermissions['uploadeditmovefile']['reupload'] = true;
5449 $wgGrantPermissions['uploadeditmovefile']['reupload-shared'] = true;
5450 $wgGrantPermissions['uploadeditmovefile']['upload_by_url'] = true;
5451 $wgGrantPermissions['uploadeditmovefile']['movefile'] = true;
5452 $wgGrantPermissions['uploadeditmovefile']['suppressredirect'] = true;
5454 $wgGrantPermissions['patrol']['patrol'] = true;
5456 $wgGrantPermissions['rollback']['rollback'] = true;
5458 $wgGrantPermissions['blockusers']['block'] = true;
5459 $wgGrantPermissions['blockusers']['blockemail'] = true;
5461 $wgGrantPermissions['viewdeleted']['browsearchive'] = true;
5462 $wgGrantPermissions['viewdeleted']['deletedhistory'] = true;
5463 $wgGrantPermissions['viewdeleted']['deletedtext'] = true;
5465 $wgGrantPermissions['delete'] = $wgGrantPermissions['editpage'] +
5466 $wgGrantPermissions['viewdeleted'];
5467 $wgGrantPermissions['delete']['delete'] = true;
5468 $wgGrantPermissions['delete']['bigdelete'] = true;
5469 $wgGrantPermissions['delete']['deletelogentry'] = true;
5470 $wgGrantPermissions['delete']['deleterevision'] = true;
5471 $wgGrantPermissions['delete']['undelete'] = true;
5473 $wgGrantPermissions['protect'] = $wgGrantPermissions['editprotected'];
5474 $wgGrantPermissions['protect']['protect'] = true;
5476 $wgGrantPermissions['viewmywatchlist']['viewmywatchlist'] = true;
5478 $wgGrantPermissions['editmywatchlist']['editmywatchlist'] = true;
5480 $wgGrantPermissions['sendemail']['sendemail'] = true;
5482 $wgGrantPermissions['createaccount']['createaccount'] = true;
5485 * @var Array Map of grants to their UI grouping
5486 * @since 1.27
5488 $wgGrantPermissionGroups = array(
5489 // Hidden grants are implicitly present
5490 'basic' => 'hidden',
5492 'editpage' => 'page-interaction',
5493 'createeditmovepage' => 'page-interaction',
5494 'editprotected' => 'page-interaction',
5495 'patrol' => 'page-interaction',
5497 'uploadfile' => 'file-interaction',
5498 'uploadeditmovefile' => 'file-interaction',
5500 'sendemail' => 'email',
5502 'viewmywatchlist' => 'watchlist-interaction',
5503 'editviewmywatchlist' => 'watchlist-interaction',
5505 'editmycssjs' => 'customization',
5506 'editmyoptions' => 'customization',
5508 'editinterface' => 'administration',
5509 'rollback' => 'administration',
5510 'blockusers' => 'administration',
5511 'delete' => 'administration',
5512 'viewdeleted' => 'administration',
5513 'protect' => 'administration',
5514 'createaccount' => 'administration',
5516 'highvolume' => 'high-volume',
5520 * @var bool Whether to enable bot passwords
5521 * @since 1.27
5523 $wgEnableBotPasswords = true;
5526 * Cluster for the bot_passwords table
5527 * @var string|bool If false, the normal cluster will be used
5528 * @since 1.27
5530 $wgBotPasswordsCluster = false;
5533 * Database name for the bot_passwords table
5535 * To use a database with a table prefix, set this variable to
5536 * "{$database}-{$prefix}".
5537 * @var string|bool If false, the normal database will be used
5538 * @since 1.27
5540 $wgBotPasswordsDatabase = false;
5542 /** @} */ # end of user rights settings
5544 /************************************************************************//**
5545 * @name Proxy scanner settings
5546 * @{
5550 * This should always be customised in LocalSettings.php
5552 $wgSecretKey = false;
5555 * Big list of banned IP addresses.
5557 * This can have the following formats:
5558 * - An array of addresses, either in the values
5559 * or the keys (for backward compatibility)
5560 * - A string, in that case this is the path to a file
5561 * containing the list of IP addresses, one per line
5563 $wgProxyList = array();
5565 /** @} */ # end of proxy scanner settings
5567 /************************************************************************//**
5568 * @name Cookie settings
5569 * @{
5573 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5575 $wgCookieExpiration = 180 * 86400;
5578 * The identifiers of the login cookies that can have their lifetimes
5579 * extended independently of all other login cookies.
5581 * @var string[]
5583 $wgExtendedLoginCookies = array( 'UserID', 'Token' );
5586 * Default login cookie lifetime, in seconds. Setting
5587 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5588 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5589 * login cookies session-only.
5591 $wgExtendedLoginCookieExpiration = null;
5594 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5595 * or ".any.subdomain.net"
5597 $wgCookieDomain = '';
5600 * Set this variable if you want to restrict cookies to a certain path within
5601 * the domain specified by $wgCookieDomain.
5603 $wgCookiePath = '/';
5606 * Whether the "secure" flag should be set on the cookie. This can be:
5607 * - true: Set secure flag
5608 * - false: Don't set secure flag
5609 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5611 $wgCookieSecure = 'detect';
5614 * By default, MediaWiki checks if the client supports cookies during the
5615 * login process, so that it can display an informative error message if
5616 * cookies are disabled. Set this to true if you want to disable this cookie
5617 * check.
5619 $wgDisableCookieCheck = false;
5622 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5623 * to a string to use a custom prefix. Setting it to false causes the database
5624 * name to be used as a prefix.
5626 $wgCookiePrefix = false;
5629 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5630 * in browsers that support this feature. This can mitigates some classes of
5631 * XSS attack.
5633 $wgCookieHttpOnly = true;
5636 * A list of cookies that vary the cache (for use by extensions)
5638 $wgCacheVaryCookies = array();
5641 * Override to customise the session name
5643 $wgSessionName = false;
5645 /** @} */ # end of cookie settings }
5647 /************************************************************************//**
5648 * @name LaTeX (mathematical formulas)
5649 * @{
5653 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5654 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5655 * (ImageMagick) installed and available in the PATH.
5656 * Please see math/README for more information.
5658 $wgUseTeX = false;
5660 /** @} */ # end LaTeX }
5662 /************************************************************************//**
5663 * @name Profiling, testing and debugging
5665 * To enable profiling, edit StartProfiler.php
5667 * @{
5671 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5672 * The debug log file should be not be publicly accessible if it is used, as it
5673 * may contain private data.
5675 $wgDebugLogFile = '';
5678 * Prefix for debug log lines
5680 $wgDebugLogPrefix = '';
5683 * If true, instead of redirecting, show a page with a link to the redirect
5684 * destination. This allows for the inspection of PHP error messages, and easy
5685 * resubmission of form data. For developer use only.
5687 $wgDebugRedirects = false;
5690 * If true, log debugging data from action=raw and load.php.
5691 * This is normally false to avoid overlapping debug entries due to gen=css
5692 * and gen=js requests.
5694 $wgDebugRawPage = false;
5697 * Send debug data to an HTML comment in the output.
5699 * This may occasionally be useful when supporting a non-technical end-user.
5700 * It's more secure than exposing the debug log file to the web, since the
5701 * output only contains private data for the current user. But it's not ideal
5702 * for development use since data is lost on fatal errors and redirects.
5704 $wgDebugComments = false;
5707 * Write SQL queries to the debug log.
5709 * This setting is only used $wgLBFactoryConf['class'] is set to
5710 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5711 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5712 * connection to achieve the same functionality.
5714 $wgDebugDumpSql = false;
5717 * Performance expectations for DB usage
5719 * @since 1.26
5721 $wgTrxProfilerLimits = array(
5722 // HTTP GET/HEAD requests.
5723 // Master queries should not happen on GET requests
5724 'GET' => array(
5725 'masterConns' => 0,
5726 'writes' => 0,
5727 'readQueryTime' => 5
5729 // HTTP POST requests.
5730 // Master reads and writes will happen for a subset of these.
5731 'POST' => array(
5732 'readQueryTime' => 5,
5733 'writeQueryTime' => 1,
5734 'maxAffected' => 500
5736 'POST-nonwrite' => array(
5737 'masterConns' => 0,
5738 'writes' => 0,
5739 'readQueryTime' => 5
5741 // Background job runner
5742 'JobRunner' => array(
5743 'readQueryTime' => 30,
5744 'writeQueryTime' => 5,
5745 'maxAffected' => 1000
5747 // Command-line scripts
5748 'Maintenance' => array(
5749 'writeQueryTime' => 5,
5750 'maxAffected' => 1000
5755 * Map of string log group names to log destinations.
5757 * If set, wfDebugLog() output for that group will go to that file instead
5758 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5759 * in production.
5761 * Log destinations may be one of the following:
5762 * - false to completely remove from the output, including from $wgDebugLogFile.
5763 * - string values specifying a filename or URI.
5764 * - associative array with keys:
5765 * - 'destination' desired filename or URI.
5766 * - 'sample' an integer value, specifying a sampling factor (optional)
5767 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5768 * to log (optional, since 1.25)
5770 * @par Example:
5771 * @code
5772 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5773 * @endcode
5775 * @par Advanced example:
5776 * @code
5777 * $wgDebugLogGroups['memcached'] = array(
5778 * 'destination' => '/var/log/mediawiki/memcached.log',
5779 * 'sample' => 1000, // log 1 message out of every 1,000.
5780 * 'level' => \Psr\Log\LogLevel::WARNING
5781 * );
5782 * @endcode
5784 $wgDebugLogGroups = array();
5787 * Default service provider for creating Psr\Log\LoggerInterface instances.
5789 * The value should be an array suitable for use with
5790 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5791 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
5792 * details.
5794 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
5795 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
5796 * and bypass the use of this configuration variable entirely.
5798 * @par To completely disable logging:
5799 * @code
5800 * $wgMWLoggerDefaultSpi = array( 'class' => '\\MediaWiki\\Logger\\NullSpi' );
5801 * @endcode
5803 * @since 1.25
5804 * @var array $wgMWLoggerDefaultSpi
5805 * @see MwLogger
5807 $wgMWLoggerDefaultSpi = array(
5808 'class' => '\\MediaWiki\\Logger\\LegacySpi',
5812 * Display debug data at the bottom of the main content area.
5814 * Useful for developers and technical users trying to working on a closed wiki.
5816 $wgShowDebug = false;
5819 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5820 * Since 1.19 also includes memory usage.
5822 $wgDebugTimestamps = false;
5825 * Print HTTP headers for every request in the debug information.
5827 $wgDebugPrintHttpHeaders = true;
5830 * Show the contents of $wgHooks in Special:Version
5832 $wgSpecialVersionShowHooks = false;
5835 * Whether to show "we're sorry, but there has been a database error" pages.
5836 * Displaying errors aids in debugging, but may display information useful
5837 * to an attacker.
5839 $wgShowSQLErrors = false;
5842 * If set to true, uncaught exceptions will print a complete stack trace
5843 * to output. This should only be used for debugging, as it may reveal
5844 * private information in function parameters due to PHP's backtrace
5845 * formatting.
5847 $wgShowExceptionDetails = false;
5850 * If true, show a backtrace for database errors
5852 * @note This setting only applies when connection errors and query errors are
5853 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5854 * including those in which an uncaught exception is thrown from within the
5855 * exception handler.
5857 $wgShowDBErrorBacktrace = false;
5860 * If true, send the exception backtrace to the error log
5862 $wgLogExceptionBacktrace = true;
5865 * Expose backend server host names through the API and various HTML comments
5867 $wgShowHostnames = false;
5870 * Override server hostname detection with a hardcoded value.
5871 * Should be a string, default false.
5872 * @since 1.20
5874 $wgOverrideHostname = false;
5877 * If set to true MediaWiki will throw notices for some possible error
5878 * conditions and for deprecated functions.
5880 $wgDevelopmentWarnings = false;
5883 * Release limitation to wfDeprecated warnings, if set to a release number
5884 * development warnings will not be generated for deprecations added in releases
5885 * after the limit.
5887 $wgDeprecationReleaseLimit = false;
5890 * Only record profiling info for pages that took longer than this
5891 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
5893 $wgProfileLimit = 0.0;
5896 * Don't put non-profiling info into log file
5898 * @deprecated since 1.23, set the log file in
5899 * $wgDebugLogGroups['profileoutput'] instead.
5901 $wgProfileOnly = false;
5904 * Destination of statsd metrics.
5906 * A host or host:port of a statsd server. Port defaults to 8125.
5908 * If not set, statsd metrics will not be collected.
5910 * @see wfLogProfilingData
5911 * @since 1.25
5913 $wgStatsdServer = false;
5916 * Prefix for metric names sent to $wgStatsdServer.
5918 * @see RequestContext::getStats
5919 * @see BufferingStatsdDataFactory
5920 * @since 1.25
5922 $wgStatsdMetricPrefix = 'MediaWiki';
5925 * InfoAction retrieves a list of transclusion links (both to and from).
5926 * This number puts a limit on that query in the case of highly transcluded
5927 * templates.
5929 $wgPageInfoTransclusionLimit = 50;
5932 * Set this to an integer to only do synchronous site_stats updates
5933 * one every *this many* updates. The other requests go into pending
5934 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5935 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5937 $wgSiteStatsAsyncFactor = false;
5940 * Parser test suite files to be run by parserTests.php when no specific
5941 * filename is passed to it.
5943 * Extensions may add their own tests to this array, or site-local tests
5944 * may be added via LocalSettings.php
5946 * Use full paths.
5948 $wgParserTestFiles = array(
5949 "$IP/tests/parser/parserTests.txt",
5950 "$IP/tests/parser/extraParserTests.txt"
5954 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5956 $wgEnableJavaScriptTest = false;
5959 * Overwrite the caching key prefix with custom value.
5960 * @since 1.19
5962 $wgCachePrefix = false;
5965 * Display the new debugging toolbar. This also enables profiling on database
5966 * queries and other useful output.
5967 * Will disable file cache.
5969 * @since 1.19
5971 $wgDebugToolbar = false;
5973 /** @} */ # end of profiling, testing and debugging }
5975 /************************************************************************//**
5976 * @name Search
5977 * @{
5981 * Set this to true to disable the full text search feature.
5983 $wgDisableTextSearch = false;
5986 * Set to true to have nicer highlighted text in search results,
5987 * by default off due to execution overhead
5989 $wgAdvancedSearchHighlighting = false;
5992 * Regexp to match word boundaries, defaults for non-CJK languages
5993 * should be empty for CJK since the words are not separate
5995 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5998 * Template for OpenSearch suggestions, defaults to API action=opensearch
6000 * Sites with heavy load would typically have these point to a custom
6001 * PHP wrapper to avoid firing up mediawiki for every keystroke
6003 * Placeholders: {searchTerms}
6005 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
6007 $wgOpenSearchTemplate = false;
6010 * Templates for OpenSearch suggestions, defaults to API action=opensearch
6012 * Sites with heavy load would typically have these point to a custom
6013 * PHP wrapper to avoid firing up mediawiki for every keystroke
6015 * Placeholders: {searchTerms}
6017 $wgOpenSearchTemplates = array(
6018 'application/x-suggestions+json' => false,
6019 'application/x-suggestions+xml' => false,
6023 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
6024 * false if you've disabled scripts that use api?action=opensearch and
6025 * want reduce load caused by cached scripts still pulling suggestions.
6026 * It will let the API fallback by responding with an empty array.
6028 $wgEnableOpenSearchSuggest = true;
6031 * Integer defining default number of entries to show on
6032 * OpenSearch call.
6034 $wgOpenSearchDefaultLimit = 10;
6037 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
6039 $wgOpenSearchDescriptionLength = 100;
6042 * Expiry time for search suggestion responses
6044 $wgSearchSuggestCacheExpiry = 1200;
6047 * If you've disabled search semi-permanently, this also disables updates to the
6048 * table. If you ever re-enable, be sure to rebuild the search table.
6050 $wgDisableSearchUpdate = false;
6053 * List of namespaces which are searched by default.
6055 * @par Example:
6056 * @code
6057 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
6058 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
6059 * @endcode
6061 $wgNamespacesToBeSearchedDefault = array(
6062 NS_MAIN => true,
6066 * Disable the internal MySQL-based search, to allow it to be
6067 * implemented by an extension instead.
6069 $wgDisableInternalSearch = false;
6072 * Set this to a URL to forward search requests to some external location.
6073 * If the URL includes '$1', this will be replaced with the URL-encoded
6074 * search term.
6076 * @par Example:
6077 * To forward to Google you'd have something like:
6078 * @code
6079 * $wgSearchForwardUrl =
6080 * 'http://www.google.com/search?q=$1' .
6081 * '&domains=http://example.com' .
6082 * '&sitesearch=http://example.com' .
6083 * '&ie=utf-8&oe=utf-8';
6084 * @endcode
6086 $wgSearchForwardUrl = null;
6089 * Search form behavior.
6090 * - true = use Go & Search buttons
6091 * - false = use Go button & Advanced search link
6093 $wgUseTwoButtonsSearchForm = true;
6096 * Array of namespaces to generate a Google sitemap for when the
6097 * maintenance/generateSitemap.php script is run, or false if one is to be
6098 * generated for all namespaces.
6100 $wgSitemapNamespaces = false;
6103 * Custom namespace priorities for sitemaps. Setting this will allow you to
6104 * set custom priorities to namespaces when sitemaps are generated using the
6105 * maintenance/generateSitemap.php script.
6107 * This should be a map of namespace IDs to priority
6108 * @par Example:
6109 * @code
6110 * $wgSitemapNamespacesPriorities = array(
6111 * NS_USER => '0.9',
6112 * NS_HELP => '0.0',
6113 * );
6114 * @endcode
6116 $wgSitemapNamespacesPriorities = false;
6119 * If true, searches for IP addresses will be redirected to that IP's
6120 * contributions page. E.g. searching for "1.2.3.4" will redirect to
6121 * [[Special:Contributions/1.2.3.4]]
6123 $wgEnableSearchContributorsByIP = true;
6125 /** @} */ # end of search settings
6127 /************************************************************************//**
6128 * @name Edit user interface
6129 * @{
6133 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
6134 * fall back to the old behavior (no merging).
6136 $wgDiff3 = '/usr/bin/diff3';
6139 * Path to the GNU diff utility.
6141 $wgDiff = '/usr/bin/diff';
6144 * Which namespaces have special treatment where they should be preview-on-open
6145 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
6146 * can specify namespaces of pages they have special treatment for
6148 $wgPreviewOnOpenNamespaces = array(
6149 NS_CATEGORY => true
6153 * Enable the UniversalEditButton for browsers that support it
6154 * (currently only Firefox with an extension)
6155 * See http://universaleditbutton.org for more background information
6157 $wgUniversalEditButton = true;
6160 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6161 * will try to automatically create one. This feature can be disabled by set-
6162 * ting this variable false.
6164 $wgUseAutomaticEditSummaries = true;
6166 /** @} */ # end edit UI }
6168 /************************************************************************//**
6169 * @name Maintenance
6170 * See also $wgSiteNotice
6171 * @{
6175 * @cond file_level_code
6176 * Set $wgCommandLineMode if it's not set already, to avoid notices
6178 if ( !isset( $wgCommandLineMode ) ) {
6179 $wgCommandLineMode = false;
6181 /** @endcond */
6184 * For colorized maintenance script output, is your terminal background dark ?
6186 $wgCommandLineDarkBg = false;
6189 * Set this to a string to put the wiki into read-only mode. The text will be
6190 * used as an explanation to users.
6192 * This prevents most write operations via the web interface. Cache updates may
6193 * still be possible. To prevent database writes completely, use the read_only
6194 * option in MySQL.
6196 $wgReadOnly = null;
6199 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6200 * Its contents will be shown to users as part of the read-only warning
6201 * message.
6203 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6205 $wgReadOnlyFile = false;
6208 * When you run the web-based upgrade utility, it will tell you what to set
6209 * this to in order to authorize the upgrade process. It will subsequently be
6210 * used as a password, to authorize further upgrades.
6212 * For security, do not set this to a guessable string. Use the value supplied
6213 * by the install/upgrade process. To cause the upgrader to generate a new key,
6214 * delete the old key from LocalSettings.php.
6216 $wgUpgradeKey = false;
6219 * Fully specified path to git binary
6221 $wgGitBin = '/usr/bin/git';
6224 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6226 * Key is a pattern passed to preg_match() and preg_replace(),
6227 * without the delimiters (which are #) and must match the whole URL.
6228 * The value is the replacement for the key (it can contain $1, etc.)
6229 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6230 * full SHA-1 of the HEAD revision.
6231 * %r will be replaced with a URL-encoded version of $1.
6233 * @since 1.20
6235 $wgGitRepositoryViewers = array(
6236 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6237 'https://git.wikimedia.org/tree/%r/%H',
6238 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6239 'https://git.wikimedia.org/tree/%r/%H',
6242 /** @} */ # End of maintenance }
6244 /************************************************************************//**
6245 * @name Recent changes, new pages, watchlist and history
6246 * @{
6250 * Recentchanges items are periodically purged; entries older than this many
6251 * seconds will go.
6252 * Default: 90 days = about three months
6254 $wgRCMaxAge = 90 * 24 * 3600;
6257 * Page watchers inactive for more than this many seconds are considered inactive.
6258 * Used mainly by action=info. Default: 180 days = about six months.
6259 * @since 1.26
6261 $wgWatchersMaxAge = 180 * 24 * 3600;
6264 * If active watchers (per above) are this number or less, do not disclose it.
6265 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6266 * Set to -1 if you want to always complement watchers count with this info.
6267 * @since 1.26
6269 $wgUnwatchedPageSecret = 1;
6272 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6273 * higher than what will be stored. Note that this is disabled by default
6274 * because we sometimes do have RC data which is beyond the limit for some
6275 * reason, and some users may use the high numbers to display that data which
6276 * is still there.
6278 $wgRCFilterByAge = false;
6281 * List of Limits options to list in the Special:Recentchanges and
6282 * Special:Recentchangeslinked pages.
6284 $wgRCLinkLimits = array( 50, 100, 250, 500 );
6287 * List of Days options to list in the Special:Recentchanges and
6288 * Special:Recentchangeslinked pages.
6290 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
6293 * Destinations to which notifications about recent changes
6294 * should be sent.
6296 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
6297 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
6298 * specified server.
6299 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
6301 * The common options are:
6302 * * 'uri' -- the address to which the notices are to be sent.
6303 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
6304 * produce the text to send. This can also be an object of the class.
6305 * * 'omit_bots' -- whether the bot edits should be in the feed
6306 * * 'omit_anon' -- whether anonymous edits should be in the feed
6307 * * 'omit_user' -- whether edits by registered users should be in the feed
6308 * * 'omit_minor' -- whether minor edits should be in the feed
6309 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
6311 * The IRC-specific options are:
6312 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
6313 * the first entry in the $wgLocalInterwikis array (or the value of
6314 * $wgLocalInterwiki, if set)
6316 * The JSON-specific options are:
6317 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6319 * @example $wgRCFeeds['example'] = array(
6320 * 'formatter' => 'JSONRCFeedFormatter',
6321 * 'uri' => "udp://localhost:1336",
6322 * 'add_interwiki_prefix' => false,
6323 * 'omit_bots' => true,
6324 * );
6325 * @example $wgRCFeeds['exampleirc'] = array(
6326 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6327 * 'uri' => "udp://localhost:1338",
6328 * 'add_interwiki_prefix' => false,
6329 * 'omit_bots' => true,
6330 * );
6331 * @since 1.22
6333 $wgRCFeeds = array();
6336 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
6337 * Keys are scheme names, values are names of engine classes.
6339 $wgRCEngines = array(
6340 'redis' => 'RedisPubSubFeedEngine',
6341 'udp' => 'UDPRCFeedEngine',
6345 * Treat category membership changes as a RecentChange.
6346 * Changes are mentioned in RC for page actions as follows:
6347 * - creation: pages created with categories are mentioned
6348 * - edit: category additions/removals to existing pages are mentioned
6349 * - move: nothing is mentioned (unless templates used depend on the title)
6350 * - deletion: nothing is mentioned
6351 * - undeletion: nothing is mentioned
6353 * @since 1.27
6355 $wgRCWatchCategoryMembership = false;
6358 * Use RC Patrolling to check for vandalism (from recent changes and watchlists)
6359 * New pages and new files are included.
6361 $wgUseRCPatrol = true;
6364 * Use new page patrolling to check new pages on Special:Newpages
6366 $wgUseNPPatrol = true;
6369 * Use file patrolling to check new files on Special:Newfiles
6371 * @since 1.27
6373 $wgUseFilePatrol = true;
6376 * Log autopatrol actions to the log table
6378 $wgLogAutopatrol = true;
6381 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6383 $wgFeed = true;
6386 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6387 * eg Recentchanges, Newpages.
6389 $wgFeedLimit = 50;
6392 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6393 * A cached version will continue to be served out even if changes
6394 * are made, until this many seconds runs out since the last render.
6396 * If set to 0, feed caching is disabled. Use this for debugging only;
6397 * feed generation can be pretty slow with diffs.
6399 $wgFeedCacheTimeout = 60;
6402 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6403 * pages larger than this size.
6405 $wgFeedDiffCutoff = 32768;
6408 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6409 * every page. Some sites might have a different feed they'd like to promote
6410 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6411 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6412 * as value.
6413 * @par Example:
6414 * Configure the 'atom' feed to http://example.com/somefeed.xml
6415 * @code
6416 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6417 * @endcode
6419 $wgOverrideSiteFeed = array();
6422 * Available feeds objects.
6423 * Should probably only be defined when a page is syndicated ie when
6424 * $wgOut->isSyndicated() is true.
6426 $wgFeedClasses = array(
6427 'rss' => 'RSSFeed',
6428 'atom' => 'AtomFeed',
6432 * Which feed types should we provide by default? This can include 'rss',
6433 * 'atom', neither, or both.
6435 $wgAdvertisedFeedTypes = array( 'atom' );
6438 * Show watching users in recent changes, watchlist and page history views
6440 $wgRCShowWatchingUsers = false; # UPO
6443 * Show the amount of changed characters in recent changes
6445 $wgRCShowChangedSize = true;
6448 * If the difference between the character counts of the text
6449 * before and after the edit is below that value, the value will be
6450 * highlighted on the RC page.
6452 $wgRCChangedSizeThreshold = 500;
6455 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6456 * view for watched pages with new changes
6458 $wgShowUpdatedMarker = true;
6461 * Disable links to talk pages of anonymous users (IPs) in listings on special
6462 * pages like page history, Special:Recentchanges, etc.
6464 $wgDisableAnonTalk = false;
6467 * Enable filtering of categories in Recentchanges
6469 $wgAllowCategorizedRecentChanges = false;
6472 * Allow filtering by change tag in recentchanges, history, etc
6473 * Has no effect if no tags are defined in valid_tag.
6475 $wgUseTagFilter = true;
6478 * If set to an integer, pages that are watched by this many users or more
6479 * will not require the unwatchedpages permission to view the number of
6480 * watchers.
6482 * @since 1.21
6484 $wgUnwatchedPageThreshold = false;
6487 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6488 * certain types of edits.
6490 * To register a new one:
6491 * @code
6492 * $wgRecentChangesFlags['flag'] => array(
6493 * // message for the letter displayed next to rows on changes lists
6494 * 'letter' => 'letter-msg',
6495 * // message for the tooltip of the letter
6496 * 'title' => 'tooltip-msg',
6497 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6498 * 'legend' => 'legend-msg',
6499 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6500 * 'class' => 'css-class',
6501 * );
6502 * @endcode
6504 * @since 1.22
6506 $wgRecentChangesFlags = array(
6507 'newpage' => array(
6508 'letter' => 'newpageletter',
6509 'title' => 'recentchanges-label-newpage',
6510 'legend' => 'recentchanges-legend-newpage',
6512 'minor' => array(
6513 'letter' => 'minoreditletter',
6514 'title' => 'recentchanges-label-minor',
6515 'legend' => 'recentchanges-legend-minor',
6516 'class' => 'minoredit',
6518 'bot' => array(
6519 'letter' => 'boteditletter',
6520 'title' => 'recentchanges-label-bot',
6521 'legend' => 'recentchanges-legend-bot',
6522 'class' => 'botedit',
6524 'unpatrolled' => array(
6525 'letter' => 'unpatrolledletter',
6526 'title' => 'recentchanges-label-unpatrolled',
6527 'legend' => 'recentchanges-legend-unpatrolled',
6531 /** @} */ # end RC/watchlist }
6533 /************************************************************************//**
6534 * @name Copyright and credits settings
6535 * @{
6539 * Override for copyright metadata.
6541 * This is the name of the page containing information about the wiki's copyright status,
6542 * which will be added as a link in the footer if it is specified. It overrides
6543 * $wgRightsUrl if both are specified.
6545 $wgRightsPage = null;
6548 * Set this to specify an external URL containing details about the content license used on your
6549 * wiki.
6550 * If $wgRightsPage is set then this setting is ignored.
6552 $wgRightsUrl = null;
6555 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6556 * link.
6557 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6558 * of the page will also be used as the link if this variable is not set.
6560 $wgRightsText = null;
6563 * Override for copyright metadata.
6565 $wgRightsIcon = null;
6568 * Set this to some HTML to override the rights icon with an arbitrary logo
6569 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6571 $wgCopyrightIcon = null;
6574 * Set this to true if you want detailed copyright information forms on Upload.
6576 $wgUseCopyrightUpload = false;
6579 * Set this to the number of authors that you want to be credited below an
6580 * article text. Set it to zero to hide the attribution block, and a negative
6581 * number (like -1) to show all authors. Note that this will require 2-3 extra
6582 * database hits, which can have a not insignificant impact on performance for
6583 * large wikis.
6585 $wgMaxCredits = 0;
6588 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6589 * Otherwise, link to a separate credits page.
6591 $wgShowCreditsIfMax = true;
6593 /** @} */ # end of copyright and credits settings }
6595 /************************************************************************//**
6596 * @name Import / Export
6597 * @{
6601 * List of interwiki prefixes for wikis we'll accept as sources for
6602 * Special:Import and API action=import. Since complete page history can be
6603 * imported, these should be 'trusted'.
6605 * This can either be a regular array, or an associative map specifying
6606 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6607 * e.g.
6608 * @code
6609 * $wgImportSources = array(
6610 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6611 * 'wikispecies',
6612 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6613 * );
6614 * @endcode
6616 * If you have a very complex import sources setup, you can lazy-load it using
6617 * the ImportSources hook.
6619 * If a user has the 'import' permission but not the 'importupload' permission,
6620 * they will only be able to run imports through this transwiki interface.
6622 $wgImportSources = array();
6625 * Optional default target namespace for interwiki imports.
6626 * Can use this to create an incoming "transwiki"-style queue.
6627 * Set to numeric key, not the name.
6629 * Users may override this in the Special:Import dialog.
6631 $wgImportTargetNamespace = null;
6634 * If set to false, disables the full-history option on Special:Export.
6635 * This is currently poorly optimized for long edit histories, so is
6636 * disabled on Wikimedia's sites.
6638 $wgExportAllowHistory = true;
6641 * If set nonzero, Special:Export requests for history of pages with
6642 * more revisions than this will be rejected. On some big sites things
6643 * could get bogged down by very very long pages.
6645 $wgExportMaxHistory = 0;
6648 * Return distinct author list (when not returning full history)
6650 $wgExportAllowListContributors = false;
6653 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6654 * up to this specified level, which will cause it to include all
6655 * pages linked to from the pages you specify. Since this number
6656 * can become *insanely large* and could easily break your wiki,
6657 * it's disabled by default for now.
6659 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6660 * crazy-big export from being done by someone setting the depth number too
6661 * high. In other words, last resort safety net.
6663 $wgExportMaxLinkDepth = 0;
6666 * Whether to allow the "export all pages in namespace" option
6668 $wgExportFromNamespaces = false;
6671 * Whether to allow exporting the entire wiki into a single file
6673 $wgExportAllowAll = false;
6675 /** @} */ # end of import/export }
6677 /*************************************************************************//**
6678 * @name Extensions
6679 * @{
6683 * A list of callback functions which are called once MediaWiki is fully
6684 * initialised
6686 $wgExtensionFunctions = array();
6689 * Extension messages files.
6691 * Associative array mapping extension name to the filename where messages can be
6692 * found. The file should contain variable assignments. Any of the variables
6693 * present in languages/messages/MessagesEn.php may be defined, but $messages
6694 * is the most common.
6696 * Variables defined in extensions will override conflicting variables defined
6697 * in the core.
6699 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6700 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6701 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6702 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6704 * Extensions using the JSON message format can preserve backward compatibility with
6705 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6706 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6707 * as for the $wgMessagesDirs entry.
6709 * @par Example:
6710 * @code
6711 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6712 * @endcode
6714 $wgExtensionMessagesFiles = array();
6717 * Extension messages directories.
6719 * Associative array mapping extension name to the path of the directory where message files can
6720 * be found. The message files are expected to be JSON files named for their language code, e.g.
6721 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6722 * message directories.
6724 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6726 * @par Simple example:
6727 * @code
6728 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6729 * @endcode
6731 * @par Complex example:
6732 * @code
6733 * $wgMessagesDirs['Example'] = array(
6734 * __DIR__ . '/lib/ve/i18n',
6735 * __DIR__ . '/lib/oojs-ui/i18n',
6736 * __DIR__ . '/i18n',
6738 * @endcode
6739 * @since 1.23
6741 $wgMessagesDirs = array();
6744 * Array of files with list(s) of extension entry points to be used in
6745 * maintenance/mergeMessageFileList.php
6746 * @since 1.22
6748 $wgExtensionEntryPointListFiles = array();
6751 * Parser output hooks.
6752 * This is an associative array where the key is an extension-defined tag
6753 * (typically the extension name), and the value is a PHP callback.
6754 * These will be called as an OutputPageParserOutput hook, if the relevant
6755 * tag has been registered with the parser output object.
6757 * Registration is done with $pout->addOutputHook( $tag, $data ).
6759 * The callback has the form:
6760 * @code
6761 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6762 * @endcode
6764 $wgParserOutputHooks = array();
6767 * Whether to include the NewPP limit report as a HTML comment
6769 $wgEnableParserLimitReporting = true;
6772 * List of valid skin names
6774 * The key should be the name in all lower case, the value should be a properly
6775 * cased name for the skin. This value will be prefixed with "Skin" to create
6776 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6777 * if you wish to have access to the full list.
6779 $wgValidSkinNames = array();
6782 * Special page list. This is an associative array mapping the (canonical) names of
6783 * special pages to either a class name to be instantiated, or a callback to use for
6784 * creating the special page object. In both cases, the result must be an instance of
6785 * SpecialPage.
6787 $wgSpecialPages = array();
6790 * Array mapping class names to filenames, for autoloading.
6792 $wgAutoloadClasses = array();
6795 * Switch controlling legacy case-insensitive classloading.
6796 * Do not disable if your wiki must support data created by PHP4, or by
6797 * MediaWiki 1.4 or earlier.
6799 $wgAutoloadAttemptLowercase = true;
6802 * An array of information about installed extensions keyed by their type.
6804 * All but 'name', 'path' and 'author' can be omitted.
6806 * @code
6807 * $wgExtensionCredits[$type][] = array(
6808 * 'path' => __FILE__,
6809 * 'name' => 'Example extension',
6810 * 'namemsg' => 'exampleextension-name',
6811 * 'author' => array(
6812 * 'Foo Barstein',
6813 * ),
6814 * 'version' => '1.9.0',
6815 * 'url' => 'http://example.org/example-extension/',
6816 * 'descriptionmsg' => 'exampleextension-desc',
6817 * 'license-name' => 'GPL-2.0+',
6818 * );
6819 * @endcode
6821 * The extensions are listed on Special:Version. This page also looks for a file
6822 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6823 * view said file. When the 'license-name' key is specified, this file is
6824 * interpreted as wikitext.
6826 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6827 * 'skin', 'api', or 'other', or any additional types as specified through the
6828 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6830 * - name: Name of extension as an inline string instead of localizable message.
6831 * Do not omit this even if 'namemsg' is provided, as it is used to override
6832 * the path Special:Version uses to find extension's license info, and is
6833 * required for backwards-compatibility with MediaWiki 1.23 and older.
6835 * - namemsg (since MW 1.24): A message key for a message containing the
6836 * extension's name, if the name is localizable. (For example, skin names
6837 * usually are.)
6839 * - author: A string or an array of strings. Authors can be linked using
6840 * the regular wikitext link syntax. To have an internationalized version of
6841 * "and others" show, add an element "...". This element can also be linked,
6842 * for instance "[http://example ...]".
6844 * - descriptionmsg: A message key or an an array with message key and parameters:
6845 * `'descriptionmsg' => 'exampleextension-desc',`
6847 * - description: Description of extension as an inline string instead of
6848 * localizable message (omit in favour of 'descriptionmsg').
6850 * - license-name: Short name of the license (used as label for the link), such
6851 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6853 $wgExtensionCredits = array();
6856 * Authentication plugin.
6857 * @var $wgAuth AuthPlugin
6859 $wgAuth = null;
6862 * Global list of hooks.
6864 * The key is one of the events made available by MediaWiki, you can find
6865 * a description for most of them in docs/hooks.txt. The array is used
6866 * internally by Hook:run().
6868 * The value can be one of:
6870 * - A function name:
6871 * @code
6872 * $wgHooks['event_name'][] = $function;
6873 * @endcode
6874 * - A function with some data:
6875 * @code
6876 * $wgHooks['event_name'][] = array( $function, $data );
6877 * @endcode
6878 * - A an object method:
6879 * @code
6880 * $wgHooks['event_name'][] = array( $object, 'method' );
6881 * @endcode
6882 * - A closure:
6883 * @code
6884 * $wgHooks['event_name'][] = function ( $hookParam ) {
6885 * // Handler code goes here.
6886 * };
6887 * @endcode
6889 * @warning You should always append to an event array or you will end up
6890 * deleting a previous registered hook.
6892 * @warning Hook handlers should be registered at file scope. Registering
6893 * handlers after file scope can lead to unexpected results due to caching.
6895 $wgHooks = array();
6898 * Maps jobs to their handling classes; extensions
6899 * can add to this to provide custom jobs
6901 $wgJobClasses = array(
6902 'refreshLinks' => 'RefreshLinksJob',
6903 'deleteLinks' => 'DeleteLinksJob',
6904 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6905 'sendMail' => 'EmaillingJob',
6906 'enotifNotify' => 'EnotifNotifyJob',
6907 'fixDoubleRedirect' => 'DoubleRedirectJob',
6908 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6909 'PublishStashedFile' => 'PublishStashedFileJob',
6910 'ThumbnailRender' => 'ThumbnailRenderJob',
6911 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6912 'refreshLinksPrioritized' => 'RefreshLinksJob',
6913 'refreshLinksDynamic' => 'RefreshLinksJob',
6914 'activityUpdateJob' => 'ActivityUpdateJob',
6915 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
6916 'cdnPurge' => 'CdnPurgeJob',
6917 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
6918 'null' => 'NullJob'
6922 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6923 * special flags are set. The values here are keys of $wgJobClasses.
6925 * These can be:
6926 * - Very long-running jobs.
6927 * - Jobs that you would never want to run as part of a page rendering request.
6928 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6929 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6930 * These settings should be global to all wikis.
6932 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6935 * Map of job types to how many job "work items" should be run per second
6936 * on each job runner process. The meaning of "work items" varies per job,
6937 * but typically would be something like "pages to update". A single job
6938 * may have a variable number of work items, as is the case with batch jobs.
6939 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6940 * These settings should be global to all wikis.
6941 * @var float[]
6943 $wgJobBackoffThrottling = array();
6946 * Make job runners commit changes for slave-lag prone jobs one job at a time.
6947 * This is useful if there are many job workers that race on slave lag checks.
6948 * If set, jobs taking this many seconds of DB write time have serialized commits.
6950 * Note that affected jobs may have worse lock contention. Also, if they affect
6951 * several DBs at once they may have a smaller chance of being atomic due to the
6952 * possibility of connection loss while queueing up to commit. Affected jobs may
6953 * also fail due to the commit lock acquisition timeout.
6955 * @var float|bool
6956 * @since 1.26
6958 $wgJobSerialCommitThreshold = false;
6961 * Map of job types to configuration arrays.
6962 * This determines which queue class and storage system is used for each job type.
6963 * Job types that do not have explicit configuration will use the 'default' config.
6964 * These settings should be global to all wikis.
6966 $wgJobTypeConf = array(
6967 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ),
6971 * Which aggregator to use for tracking which queues have jobs.
6972 * These settings should be global to all wikis.
6974 $wgJobQueueAggregator = array(
6975 'class' => 'JobQueueAggregatorNull'
6979 * Additional functions to be performed with updateSpecialPages.
6980 * Expensive Querypages are already updated.
6982 $wgSpecialPageCacheUpdates = array(
6983 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
6987 * Hooks that are used for outputting exceptions. Format is:
6988 * $wgExceptionHooks[] = $funcname
6989 * or:
6990 * $wgExceptionHooks[] = array( $class, $funcname )
6991 * Hooks should return strings or false
6993 $wgExceptionHooks = array();
6996 * Page property link table invalidation lists. When a page property
6997 * changes, this may require other link tables to be updated (eg
6998 * adding __HIDDENCAT__ means the hiddencat tracking category will
6999 * have been added, so the categorylinks table needs to be rebuilt).
7000 * This array can be added to by extensions.
7002 $wgPagePropLinkInvalidations = array(
7003 'hiddencat' => 'categorylinks',
7006 /** @} */ # End extensions }
7008 /*************************************************************************//**
7009 * @name Categories
7010 * @{
7014 * Use experimental, DMOZ-like category browser
7016 $wgUseCategoryBrowser = false;
7019 * On category pages, show thumbnail gallery for images belonging to that
7020 * category instead of listing them as articles.
7022 $wgCategoryMagicGallery = true;
7025 * Paging limit for categories
7027 $wgCategoryPagingLimit = 200;
7030 * Specify how category names should be sorted, when listed on a category page.
7031 * A sorting scheme is also known as a collation.
7033 * Available values are:
7035 * - uppercase: Converts the category name to upper case, and sorts by that.
7037 * - identity: Does no conversion. Sorts by binary value of the string.
7039 * - uca-default: Provides access to the Unicode Collation Algorithm with
7040 * the default element table. This is a compromise collation which sorts
7041 * all languages in a mediocre way. However, it is better than "uppercase".
7043 * To use the uca-default collation, you must have PHP's intl extension
7044 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
7045 * resulting collation will depend on the version of ICU installed on the
7046 * server.
7048 * After you change this, you must run maintenance/updateCollation.php to fix
7049 * the sort keys in the database.
7051 * Extensions can define there own collations by subclassing Collation
7052 * and using the Collation::factory hook.
7054 $wgCategoryCollation = 'uppercase';
7056 /** @} */ # End categories }
7058 /*************************************************************************//**
7059 * @name Logging
7060 * @{
7064 * The logging system has two levels: an event type, which describes the
7065 * general category and can be viewed as a named subset of all logs; and
7066 * an action, which is a specific kind of event that can exist in that
7067 * log type.
7069 $wgLogTypes = array(
7071 'block',
7072 'protect',
7073 'rights',
7074 'delete',
7075 'upload',
7076 'move',
7077 'import',
7078 'patrol',
7079 'merge',
7080 'suppress',
7081 'tag',
7082 'managetags',
7083 'contentmodel',
7087 * This restricts log access to those who have a certain right
7088 * Users without this will not see it in the option menu and can not view it
7089 * Restricted logs are not added to recent changes
7090 * Logs should remain non-transcludable
7091 * Format: logtype => permissiontype
7093 $wgLogRestrictions = array(
7094 'suppress' => 'suppressionlog'
7098 * Show/hide links on Special:Log will be shown for these log types.
7100 * This is associative array of log type => boolean "hide by default"
7102 * See $wgLogTypes for a list of available log types.
7104 * @par Example:
7105 * @code
7106 * $wgFilterLogTypes = array(
7107 * 'move' => true,
7108 * 'import' => false,
7109 * );
7110 * @endcode
7112 * Will display show/hide links for the move and import logs. Move logs will be
7113 * hidden by default unless the link is clicked. Import logs will be shown by
7114 * default, and hidden when the link is clicked.
7116 * A message of the form log-show-hide-[type] should be added, and will be used
7117 * for the link text.
7119 $wgFilterLogTypes = array(
7120 'patrol' => true,
7121 'tag' => true,
7125 * Lists the message key string for each log type. The localized messages
7126 * will be listed in the user interface.
7128 * Extensions with custom log types may add to this array.
7130 * @since 1.19, if you follow the naming convention log-name-TYPE,
7131 * where TYPE is your log type, yoy don't need to use this array.
7133 $wgLogNames = array(
7134 '' => 'all-logs-page',
7135 'block' => 'blocklogpage',
7136 'protect' => 'protectlogpage',
7137 'rights' => 'rightslog',
7138 'delete' => 'dellogpage',
7139 'upload' => 'uploadlogpage',
7140 'move' => 'movelogpage',
7141 'import' => 'importlogpage',
7142 'patrol' => 'patrol-log-page',
7143 'merge' => 'mergelog',
7144 'suppress' => 'suppressionlog',
7148 * Lists the message key string for descriptive text to be shown at the
7149 * top of each log type.
7151 * Extensions with custom log types may add to this array.
7153 * @since 1.19, if you follow the naming convention log-description-TYPE,
7154 * where TYPE is your log type, yoy don't need to use this array.
7156 $wgLogHeaders = array(
7157 '' => 'alllogstext',
7158 'block' => 'blocklogtext',
7159 'delete' => 'dellogpagetext',
7160 'import' => 'importlogpagetext',
7161 'merge' => 'mergelogpagetext',
7162 'move' => 'movelogpagetext',
7163 'patrol' => 'patrol-log-header',
7164 'protect' => 'protectlogtext',
7165 'rights' => 'rightslogtext',
7166 'suppress' => 'suppressionlogtext',
7167 'upload' => 'uploadlogpagetext',
7171 * Lists the message key string for formatting individual events of each
7172 * type and action when listed in the logs.
7174 * Extensions with custom log types may add to this array.
7176 $wgLogActions = array();
7179 * The same as above, but here values are names of classes,
7180 * not messages.
7181 * @see LogPage::actionText
7182 * @see LogFormatter
7184 $wgLogActionsHandlers = array(
7185 'block/block' => 'BlockLogFormatter',
7186 'block/reblock' => 'BlockLogFormatter',
7187 'block/unblock' => 'BlockLogFormatter',
7188 'contentmodel/change' => 'ContentModelLogFormatter',
7189 'delete/delete' => 'DeleteLogFormatter',
7190 'delete/event' => 'DeleteLogFormatter',
7191 'delete/restore' => 'DeleteLogFormatter',
7192 'delete/revision' => 'DeleteLogFormatter',
7193 'import/interwiki' => 'ImportLogFormatter',
7194 'import/upload' => 'ImportLogFormatter',
7195 'managetags/activate' => 'LogFormatter',
7196 'managetags/create' => 'LogFormatter',
7197 'managetags/deactivate' => 'LogFormatter',
7198 'managetags/delete' => 'LogFormatter',
7199 'merge/merge' => 'MergeLogFormatter',
7200 'move/move' => 'MoveLogFormatter',
7201 'move/move_redir' => 'MoveLogFormatter',
7202 'patrol/patrol' => 'PatrolLogFormatter',
7203 'protect/modify' => 'ProtectLogFormatter',
7204 'protect/move_prot' => 'ProtectLogFormatter',
7205 'protect/protect' => 'ProtectLogFormatter',
7206 'protect/unprotect' => 'ProtectLogFormatter',
7207 'rights/autopromote' => 'RightsLogFormatter',
7208 'rights/rights' => 'RightsLogFormatter',
7209 'suppress/block' => 'BlockLogFormatter',
7210 'suppress/delete' => 'DeleteLogFormatter',
7211 'suppress/event' => 'DeleteLogFormatter',
7212 'suppress/reblock' => 'BlockLogFormatter',
7213 'suppress/revision' => 'DeleteLogFormatter',
7214 'tag/update' => 'TagLogFormatter',
7215 'upload/overwrite' => 'UploadLogFormatter',
7216 'upload/revert' => 'UploadLogFormatter',
7217 'upload/upload' => 'UploadLogFormatter',
7221 * Maintain a log of newusers at Log/newusers?
7223 $wgNewUserLog = true;
7225 /** @} */ # end logging }
7227 /*************************************************************************//**
7228 * @name Special pages (general and miscellaneous)
7229 * @{
7233 * Allow special page inclusions such as {{Special:Allpages}}
7235 $wgAllowSpecialInclusion = true;
7238 * Set this to an array of special page names to prevent
7239 * maintenance/updateSpecialPages.php from updating those pages.
7241 $wgDisableQueryPageUpdate = false;
7244 * On Special:Unusedimages, consider images "used", if they are put
7245 * into a category. Default (false) is not to count those as used.
7247 $wgCountCategorizedImagesAsUsed = false;
7250 * Maximum number of links to a redirect page listed on
7251 * Special:Whatlinkshere/RedirectDestination
7253 $wgMaxRedirectLinksRetrieved = 500;
7255 /** @} */ # end special pages }
7257 /*************************************************************************//**
7258 * @name Actions
7259 * @{
7263 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7264 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7265 * 'foo' => true Load the class FooAction which subclasses Action
7266 * If something is specified in the getActionOverrides()
7267 * of the relevant Page object it will be used
7268 * instead of the default class.
7269 * 'foo' => false The action is disabled; show an error message
7270 * Unsetting core actions will probably cause things to complain loudly.
7272 $wgActions = array(
7273 'credits' => true,
7274 'delete' => true,
7275 'edit' => true,
7276 'editchangetags' => 'SpecialPageAction',
7277 'history' => true,
7278 'info' => true,
7279 'markpatrolled' => true,
7280 'protect' => true,
7281 'purge' => true,
7282 'raw' => true,
7283 'render' => true,
7284 'revert' => true,
7285 'revisiondelete' => 'SpecialPageAction',
7286 'rollback' => true,
7287 'submit' => true,
7288 'unprotect' => true,
7289 'unwatch' => true,
7290 'view' => true,
7291 'watch' => true,
7294 /** @} */ # end actions }
7296 /*************************************************************************//**
7297 * @name Robot (search engine crawler) policy
7298 * See also $wgNoFollowLinks.
7299 * @{
7303 * Default robot policy. The default policy is to encourage indexing and fol-
7304 * lowing of links. It may be overridden on a per-namespace and/or per-page
7305 * basis.
7307 $wgDefaultRobotPolicy = 'index,follow';
7310 * Robot policies per namespaces. The default policy is given above, the array
7311 * is made of namespace constants as defined in includes/Defines.php. You can-
7312 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7313 * nofollow. This is because a number of special pages (e.g., ListPages) have
7314 * many permutations of options that display the same data under redundant
7315 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7316 * pages, all alike, and never reaching your actual content.
7318 * @par Example:
7319 * @code
7320 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
7321 * @endcode
7323 $wgNamespaceRobotPolicies = array();
7326 * Robot policies per article. These override the per-namespace robot policies.
7327 * Must be in the form of an array where the key part is a properly canonicalised
7328 * text form title and the value is a robot policy.
7330 * @par Example:
7331 * @code
7332 * $wgArticleRobotPolicies = array(
7333 * 'Main Page' => 'noindex,follow',
7334 * 'User:Bob' => 'index,follow',
7335 * );
7336 * @endcode
7338 * @par Example that DOES NOT WORK because the names are not canonical text
7339 * forms:
7340 * @code
7341 * $wgArticleRobotPolicies = array(
7342 * # Underscore, not space!
7343 * 'Main_Page' => 'noindex,follow',
7344 * # "Project", not the actual project name!
7345 * 'Project:X' => 'index,follow',
7346 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7347 * 'abc' => 'noindex,nofollow'
7348 * );
7349 * @endcode
7351 $wgArticleRobotPolicies = array();
7354 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7355 * will not function, so users can't decide whether pages in that namespace are
7356 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7358 * @par Example:
7359 * @code
7360 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
7361 * @endcode
7363 $wgExemptFromUserRobotsControl = null;
7365 /** @} */ # End robot policy }
7367 /************************************************************************//**
7368 * @name AJAX and API
7369 * Note: The AJAX entry point which this section refers to is gradually being
7370 * replaced by the API entry point, api.php. They are essentially equivalent.
7371 * Both of them are used for dynamic client-side features, via XHR.
7372 * @{
7376 * Enable the MediaWiki API for convenient access to
7377 * machine-readable data via api.php
7379 * See https://www.mediawiki.org/wiki/API
7381 $wgEnableAPI = true;
7384 * Allow the API to be used to perform write operations
7385 * (page edits, rollback, etc.) when an authorised user
7386 * accesses it
7388 $wgEnableWriteAPI = true;
7392 * WARNING: SECURITY THREAT - debug use only
7394 * Disables many security checks in the API for debugging purposes.
7395 * This flag should never be used on the production servers, as it introduces
7396 * a number of potential security holes. Even when enabled, the validation
7397 * will still be performed, but instead of failing, API will return a warning.
7398 * Also, there will always be a warning notifying that this flag is set.
7399 * At this point, the flag allows GET requests to go through for modules
7400 * requiring POST.
7402 * @since 1.21
7404 $wgDebugAPI = false;
7407 * API module extensions.
7409 * Associative array mapping module name to modules specs;
7410 * Each module spec is an associative array containing at least
7411 * the 'class' key for the module's class, and optionally a
7412 * 'factory' key for the factory function to use for the module.
7414 * That factory function will be called with two parameters,
7415 * the parent module (an instance of ApiBase, usually ApiMain)
7416 * and the name the module was registered under. The return
7417 * value must be an instance of the class given in the 'class'
7418 * field.
7420 * For backward compatibility, the module spec may also be a
7421 * simple string containing the module's class name. In that
7422 * case, the class' constructor will be called with the parent
7423 * module and module name as parameters, as described above.
7425 * Examples for registering API modules:
7427 * @code
7428 * $wgAPIModules['foo'] = 'ApiFoo';
7429 * $wgAPIModules['bar'] = array(
7430 * 'class' => 'ApiBar',
7431 * 'factory' => function( $main, $name ) { ... }
7432 * );
7433 * $wgAPIModules['xyzzy'] = array(
7434 * 'class' => 'ApiXyzzy',
7435 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
7436 * );
7437 * @endcode
7439 * Extension modules may override the core modules.
7440 * See ApiMain::$Modules for a list of the core modules.
7442 $wgAPIModules = array();
7445 * API format module extensions.
7446 * Associative array mapping format module name to module specs (see $wgAPIModules).
7447 * Extension modules may override the core modules.
7449 * See ApiMain::$Formats for a list of the core format modules.
7451 $wgAPIFormatModules = array();
7454 * API Query meta module extensions.
7455 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7456 * Extension modules may override the core modules.
7458 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7460 $wgAPIMetaModules = array();
7463 * API Query prop module extensions.
7464 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7465 * Extension modules may override the core modules.
7467 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7469 $wgAPIPropModules = array();
7472 * API Query list module extensions.
7473 * Associative array mapping list module name to module specs (see $wgAPIModules).
7474 * Extension modules may override the core modules.
7476 * See ApiQuery::$QueryListModules for a list of the core list modules.
7478 $wgAPIListModules = array();
7481 * Maximum amount of rows to scan in a DB query in the API
7482 * The default value is generally fine
7484 $wgAPIMaxDBRows = 5000;
7487 * The maximum size (in bytes) of an API result.
7488 * @warning Do not set this lower than $wgMaxArticleSize*1024
7490 $wgAPIMaxResultSize = 8388608;
7493 * The maximum number of uncached diffs that can be retrieved in one API
7494 * request. Set this to 0 to disable API diffs altogether
7496 $wgAPIMaxUncachedDiffs = 1;
7499 * Maximum amount of DB lag on a majority of DB slaves to tolerate
7500 * before forcing bots to retry any write requests via API errors.
7501 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
7503 $wgAPIMaxLagThreshold = 7;
7506 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7507 * API request logging
7509 $wgAPIRequestLog = false;
7512 * Set the timeout for the API help text cache. If set to 0, caching disabled
7514 $wgAPICacheHelpTimeout = 60 * 60;
7517 * The ApiQueryQueryPages module should skip pages that are redundant to true
7518 * API queries.
7520 $wgAPIUselessQueryPages = array(
7521 'MIMEsearch', // aiprop=mime
7522 'LinkSearch', // list=exturlusage
7523 'FileDuplicateSearch', // prop=duplicatefiles
7527 * Enable AJAX framework
7529 $wgUseAjax = true;
7532 * List of Ajax-callable functions.
7533 * Extensions acting as Ajax callbacks must register here
7534 * @deprecated (officially) since 1.27; use the API instead
7536 $wgAjaxExportList = array();
7539 * Enable AJAX check for file overwrite, pre-upload
7541 $wgAjaxUploadDestCheck = true;
7544 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7546 $wgAjaxLicensePreview = true;
7549 * Have clients send edits to be prepared when filling in edit summaries.
7550 * This gives the server a head start on the expensive parsing operation.
7552 $wgAjaxEditStash = true;
7555 * Settings for incoming cross-site AJAX requests:
7556 * Newer browsers support cross-site AJAX when the target resource allows requests
7557 * from the origin domain by the Access-Control-Allow-Origin header.
7558 * This is currently only used by the API (requests to api.php)
7559 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7561 * - '*' matches any number of characters
7562 * - '?' matches any 1 character
7564 * @par Example:
7565 * @code
7566 * $wgCrossSiteAJAXdomains = array(
7567 * 'www.mediawiki.org',
7568 * '*.wikipedia.org',
7569 * '*.wikimedia.org',
7570 * '*.wiktionary.org',
7571 * );
7572 * @endcode
7574 $wgCrossSiteAJAXdomains = array();
7577 * Domains that should not be allowed to make AJAX requests,
7578 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7579 * Uses the same syntax as $wgCrossSiteAJAXdomains
7581 $wgCrossSiteAJAXdomainExceptions = array();
7583 /** @} */ # End AJAX and API }
7585 /************************************************************************//**
7586 * @name Shell and process control
7587 * @{
7591 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7593 $wgMaxShellMemory = 307200;
7596 * Maximum file size created by shell processes under linux, in KB
7597 * ImageMagick convert for example can be fairly hungry for scratch space
7599 $wgMaxShellFileSize = 102400;
7602 * Maximum CPU time in seconds for shell processes under Linux
7604 $wgMaxShellTime = 180;
7607 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7608 * would measure) in seconds for shell processes under Linux
7610 $wgMaxShellWallClockTime = 180;
7613 * Under Linux: a cgroup directory used to constrain memory usage of shell
7614 * commands. The directory must be writable by the user which runs MediaWiki.
7616 * If specified, this is used instead of ulimit, which is inaccurate, and
7617 * causes malloc() to return NULL, which exposes bugs in C applications, making
7618 * them segfault or deadlock.
7620 * A wrapper script will create a cgroup for each shell command that runs, as
7621 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7622 * kernel will send a SIGKILL signal to a process in the subgroup.
7624 * @par Example:
7625 * @code
7626 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7627 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7628 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7629 * @endcode
7631 * The reliability of cgroup cleanup can be improved by installing a
7632 * notify_on_release script in the root cgroup, see e.g.
7633 * https://gerrit.wikimedia.org/r/#/c/40784
7635 $wgShellCgroup = false;
7638 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7640 $wgPhpCli = '/usr/bin/php';
7643 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7644 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7645 * character set. Only the character set is relevant.
7647 $wgShellLocale = 'en_US.utf8';
7649 /** @} */ # End shell }
7651 /************************************************************************//**
7652 * @name HTTP client
7653 * @{
7657 * Timeout for HTTP requests done internally, in seconds.
7659 $wgHTTPTimeout = 25;
7662 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7664 $wgAsyncHTTPTimeout = 25;
7667 * Proxy to use for CURL requests.
7669 $wgHTTPProxy = false;
7672 * Local virtual hosts.
7674 * This lists domains that are configured as virtual hosts on the same machine.
7675 * If a request is to be made to a domain listed here, or any subdomain thereof,
7676 * then no proxy will be used.
7677 * Command-line scripts are not affected by this setting and will always use
7678 * proxy if it is configured.
7679 * @since 1.25
7681 $wgLocalVirtualHosts = array();
7684 * Timeout for connections done internally (in seconds)
7685 * Only works for curl
7687 $wgHTTPConnectTimeout = 5e0;
7689 /** @} */ # End HTTP client }
7691 /************************************************************************//**
7692 * @name Job queue
7693 * See also $wgEnotifUseJobQ.
7694 * @{
7698 * Number of jobs to perform per request. May be less than one in which case
7699 * jobs are performed probabalistically. If this is zero, jobs will not be done
7700 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7701 * be run periodically.
7703 $wgJobRunRate = 1;
7706 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7707 * to handle the job execution, instead of blocking the request until the job
7708 * execution finishes.
7709 * @since 1.23
7711 $wgRunJobsAsync = true;
7714 * Number of rows to update per job
7716 $wgUpdateRowsPerJob = 300;
7719 * Number of rows to update per query
7721 $wgUpdateRowsPerQuery = 100;
7723 /** @} */ # End job queue }
7725 /************************************************************************//**
7726 * @name Miscellaneous
7727 * @{
7731 * Name of the external diff engine to use
7733 $wgExternalDiffEngine = false;
7736 * Disable redirects to special pages and interwiki redirects, which use a 302
7737 * and have no "redirected from" link.
7739 * @note This is only for articles with #REDIRECT in them. URL's containing a
7740 * local interwiki prefix (or a non-canonical special page name) are still hard
7741 * redirected regardless of this setting.
7743 $wgDisableHardRedirects = false;
7746 * LinkHolderArray batch size
7747 * For debugging
7749 $wgLinkHolderBatchSize = 1000;
7752 * By default MediaWiki does not register links pointing to same server in
7753 * externallinks dataset, use this value to override:
7755 $wgRegisterInternalExternals = false;
7758 * Maximum number of pages to move at once when moving subpages with a page.
7760 $wgMaximumMovedPages = 100;
7763 * Fix double redirects after a page move.
7764 * Tends to conflict with page move vandalism, use only on a private wiki.
7766 $wgFixDoubleRedirects = false;
7769 * Allow redirection to another page when a user logs in.
7770 * To enable, set to a string like 'Main Page'
7772 $wgRedirectOnLogin = null;
7775 * Configuration for processing pool control, for use in high-traffic wikis.
7776 * An implementation is provided in the PoolCounter extension.
7778 * This configuration array maps pool types to an associative array. The only
7779 * defined key in the associative array is "class", which gives the class name.
7780 * The remaining elements are passed through to the class as constructor
7781 * parameters.
7783 * @par Example:
7784 * @code
7785 * $wgPoolCounterConf = array( 'ArticleView' => array(
7786 * 'class' => 'PoolCounter_Client',
7787 * 'timeout' => 15, // wait timeout in seconds
7788 * 'workers' => 5, // maximum number of active threads in each pool
7789 * 'maxqueue' => 50, // maximum number of total threads in each pool
7790 * ... any extension-specific options...
7791 * );
7792 * @endcode
7794 $wgPoolCounterConf = null;
7797 * To disable file delete/restore temporarily
7799 $wgUploadMaintenance = false;
7802 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7803 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7804 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7805 * (except for the special case of JS and CS pages).
7807 * @since 1.21
7809 $wgNamespaceContentModels = array();
7812 * How to react if a plain text version of a non-text Content object is requested using
7813 * ContentHandler::getContentText():
7815 * * 'ignore': return null
7816 * * 'fail': throw an MWException
7817 * * 'serialize': serialize to default format
7819 * @since 1.21
7821 $wgContentHandlerTextFallback = 'ignore';
7824 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7825 * This way, the ContentHandler facility can be used without any additional information in the
7826 * database. A page's content model is then derived solely from the page's title. This however
7827 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7828 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7829 * a title that would default to a different content model.
7831 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7832 * handling is less robust and less flexible.
7834 * @since 1.21
7836 $wgContentHandlerUseDB = true;
7839 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7840 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7841 * the effect on the database they would have on a wikitext page.
7843 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7844 * or at least parse only the contents of comments in the scripts.
7846 * @since 1.21
7848 $wgTextModelsToParse = array(
7849 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7850 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7851 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7855 * Whether the user must enter their password to change their e-mail address
7857 * @since 1.20
7859 $wgRequirePasswordforEmailChange = true;
7862 * Register handlers for specific types of sites.
7864 * @since 1.20
7866 $wgSiteTypes = array(
7867 'mediawiki' => 'MediaWikiSite',
7871 * Whether the page_props table has a pp_sortkey column. Set to false in case
7872 * the respective database schema change was not applied.
7873 * @since 1.23
7875 $wgPagePropsHaveSortkey = true;
7878 * Port where you have HTTPS running
7879 * Supports HTTPS on non-standard ports
7880 * @see bug 65184
7881 * @since 1.24
7883 $wgHttpsPort = 443;
7886 * Secret for hmac-based key derivation function (fast,
7887 * cryptographically secure random numbers).
7888 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7889 * be used.
7890 * See also: $wgHKDFAlgorithm
7891 * @since 1.24
7893 $wgHKDFSecret = false;
7896 * Algorithm for hmac-based key derivation function (fast,
7897 * cryptographically secure random numbers).
7898 * See also: $wgHKDFSecret
7899 * @since 1.24
7901 $wgHKDFAlgorithm = 'sha256';
7904 * Enable page language feature
7905 * Allows setting page language in database
7906 * @var bool
7907 * @since 1.24
7909 $wgPageLanguageUseDB = false;
7912 * Global configuration variable for Virtual REST Services.
7913 * Parameters for different services are to be declared inside
7914 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
7915 * array. Global parameters will be merged with service-specific ones. The
7916 * result will then be passed to VirtualRESTService::__construct() in the
7917 * module.
7919 * Example config for Parsoid:
7921 * $wgVirtualRestConfig['modules']['parsoid'] = array(
7922 * 'url' => 'http://localhost:8000',
7923 * 'prefix' => 'enwiki',
7924 * 'domain' => 'en.wikipedia.org',
7925 * );
7927 * @var array
7928 * @since 1.25
7930 $wgVirtualRestConfig = array(
7931 'modules' => array(),
7932 'global' => array(
7933 # Timeout in seconds
7934 'timeout' => 360,
7935 # 'domain' is set to $wgCanonicalServer in Setup.php
7936 'forwardCookies' => false,
7937 'HTTPProxy' => null
7942 * Controls whether zero-result search queries with suggestions should display results for
7943 * these suggestions.
7945 * @var bool
7946 * @since 1.26
7948 $wgSearchRunSuggestedQuery = true;
7951 * Where popular password file is located.
7953 * Default in core contains 50,000 most popular. This config
7954 * allows you to change which file, in case you want to generate
7955 * a password file with > 50000 entries in it.
7957 * @see maintenance/createCommonPasswordCdb.php
7958 * @since 1.27
7959 * @var string path to file
7961 $wgPopularPasswordFile = __DIR__ . '/../serialized/commonpasswords.cdb';
7964 * Max time (in seconds) a user-generated transaction can spend in writes.
7965 * If exceeded, the transaction is rolled back with an error instead of being committed.
7967 * @var int|bool Disabled if false
7968 * @since 1.27
7970 $wgMaxUserDBWriteDuration = false;
7973 * For really cool vim folding this needs to be at the end:
7974 * vim: foldmarker=@{,@} foldmethod=marker
7975 * @}