Removed unused parameter from User::checkNewtalk
[mediawiki.git] / includes / DefaultSettings.php
blob5ab557eb8a868a395812503a0345b3166409da4f
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 /**
56 * wgConf hold the site configuration.
57 * Not used for much in a default install.
58 * @since 1.5
60 $wgConf = new SiteConfiguration;
62 /**
63 * Registry of factory functions to create config objects:
64 * The 'main' key must be set, and the value should be a valid
65 * callable.
66 * @since 1.23
68 $wgConfigRegistry = array(
69 'main' => 'GlobalVarConfig::newInstance'
72 /**
73 * MediaWiki version number
74 * @since 1.2
76 $wgVersion = '1.25alpha';
78 /**
79 * Name of the site. It must be changed in LocalSettings.php
81 $wgSitename = 'MediaWiki';
83 /**
84 * URL of the server.
86 * @par Example:
87 * @code
88 * $wgServer = 'http://example.com';
89 * @endcode
91 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
92 * wrong server, it will redirect incorrectly after you save a page. In that
93 * case, set this variable to fix it.
95 * If you want to use protocol-relative URLs on your wiki, set this to a
96 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
97 * to a fully qualified URL.
99 $wgServer = WebRequest::detectServer();
102 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
103 * Must be fully qualified, even if $wgServer is protocol-relative.
105 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
106 * @since 1.18
108 $wgCanonicalServer = false;
111 * Server name. This is automatically computed by parsing the bare
112 * hostname out of $wgCanonicalServer. It should not be customized.
113 * @since 1.24
115 $wgServerName = false;
117 /************************************************************************//**
118 * @name Script path settings
119 * @{
123 * The path we should point to.
124 * It might be a virtual path in case with use apache mod_rewrite for example.
126 * This *needs* to be set correctly.
128 * Other paths will be set to defaults based on it unless they are directly
129 * set in LocalSettings.php
131 $wgScriptPath = '/wiki';
134 * Whether to support URLs like index.php/Page_title These often break when PHP
135 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
136 * but then again it may not; lighttpd converts incoming path data to lowercase
137 * on systems with case-insensitive filesystems, and there have been reports of
138 * problems on Apache as well.
140 * To be safe we'll continue to keep it off by default.
142 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
143 * incorrect garbage, or to true if it is really correct.
145 * The default $wgArticlePath will be set based on this value at runtime, but if
146 * you have customized it, having this incorrectly set to true can cause
147 * redirect loops when "pretty URLs" are used.
148 * @since 1.2.1
150 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
151 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
152 ( strpos( PHP_SAPI, 'isapi' ) === false );
155 * The extension to append to script names by default. This can either be .php
156 * or .php5.
158 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
159 * variable is provided to support those providers.
160 * @since 1.11
162 $wgScriptExtension = '.php';
164 /**@}*/
166 /************************************************************************//**
167 * @name URLs and file paths
169 * These various web and file path variables are set to their defaults
170 * in Setup.php if they are not explicitly set from LocalSettings.php.
172 * These will relatively rarely need to be set manually, unless you are
173 * splitting style sheets or images outside the main document root.
175 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
176 * the host part, that starts with a slash. In most cases a full URL is also
177 * acceptable. A "directory" is a local file path.
179 * In both paths and directories, trailing slashes should not be included.
181 * @{
185 * The URL path to index.php.
187 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
189 $wgScript = false;
192 * The URL path to load.php.
194 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
195 * @since 1.17
197 $wgLoadScript = false;
200 * The URL path of the skins directory.
201 * Defaults to "{$wgScriptPath}/skins".
202 * @since 1.3
204 $wgStylePath = false;
205 $wgStyleSheetPath = &$wgStylePath;
208 * The URL path of the skins directory. Should not point to an external domain.
209 * Defaults to "{$wgScriptPath}/skins".
210 * @since 1.17
212 $wgLocalStylePath = false;
215 * The URL path of the extensions directory.
216 * Defaults to "{$wgScriptPath}/extensions".
217 * @since 1.16
219 $wgExtensionAssetsPath = false;
222 * Filesystem stylesheets directory.
223 * Defaults to "{$IP}/skins".
224 * @since 1.3
226 $wgStyleDirectory = false;
229 * The URL path for primary article page views. This path should contain $1,
230 * which is replaced by the article title.
232 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
233 * depending on $wgUsePathInfo.
235 $wgArticlePath = false;
238 * The URL path for the images directory.
239 * Defaults to "{$wgScriptPath}/images".
241 $wgUploadPath = false;
244 * The filesystem path of the images directory. Defaults to "{$IP}/images".
246 $wgUploadDirectory = false;
249 * Directory where the cached page will be saved.
250 * Defaults to "{$wgUploadDirectory}/cache".
252 $wgFileCacheDirectory = false;
255 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
256 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
258 $wgLogo = false;
261 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
262 * should be under 135x155 pixels.
263 * Only 1.5x and 2x versions are supported.
265 * @par Example:
266 * @code
267 * $wgLogoHD = array(
268 * "1.5x" => "path/to/1.5x_version.png",
269 * "2x" => "path/to/2x_version.png"
270 * );
271 * @endcode
273 * @since 1.25
275 $wgLogoHD = false;
278 * The URL path of the shortcut icon.
279 * @since 1.6
281 $wgFavicon = '/favicon.ico';
284 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
285 * Defaults to no icon.
286 * @since 1.12
288 $wgAppleTouchIcon = false;
291 * Value for the referrer policy meta tag.
292 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
293 * prevents the meta tag from being output.
294 * See http://www.w3.org/TR/referrer-policy/ for details.
296 * @since 1.25
298 $wgReferrerPolicy = false;
301 * The local filesystem path to a temporary directory. This is not required to
302 * be web accessible.
304 * When this setting is set to false, its value will be set through a call
305 * to wfTempDir(). See that methods implementation for the actual detection
306 * logic.
308 * Developers should use the global function wfTempDir() instead of this
309 * variable.
311 * @see wfTempDir()
312 * @note Default changed to false in MediaWiki 1.20.
314 $wgTmpDirectory = false;
317 * If set, this URL is added to the start of $wgUploadPath to form a complete
318 * upload URL.
319 * @since 1.4
321 $wgUploadBaseUrl = '';
324 * To enable remote on-demand scaling, set this to the thumbnail base URL.
325 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
326 * where 'e6' are the first two characters of the MD5 hash of the file name.
327 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
328 * @since 1.17
330 $wgUploadStashScalerBaseUrl = false;
333 * To set 'pretty' URL paths for actions other than
334 * plain page views, add to this array.
336 * @par Example:
337 * Set pretty URL for the edit action:
338 * @code
339 * 'edit' => "$wgScriptPath/edit/$1"
340 * @endcode
342 * There must be an appropriate script or rewrite rule in place to handle these
343 * URLs.
344 * @since 1.5
346 $wgActionPaths = array();
348 /**@}*/
350 /************************************************************************//**
351 * @name Files and file uploads
352 * @{
356 * Uploads have to be specially set up to be secure
358 $wgEnableUploads = false;
361 * The maximum age of temporary (incomplete) uploaded files
363 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
366 * Allows to move images and other media files
368 $wgAllowImageMoving = true;
371 * Enable deferred upload tasks that use the job queue.
372 * Only enable this if job runners are set up for both the
373 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
375 * @note If you use suhosin, this setting is incompatible with
376 * suhosin.session.encrypt.
378 $wgEnableAsyncUploads = false;
381 * These are additional characters that should be replaced with '-' in filenames
383 $wgIllegalFileChars = ":";
386 * What directory to place deleted uploads in.
387 * Defaults to "{$wgUploadDirectory}/deleted".
389 $wgDeletedDirectory = false;
392 * Set this to true if you use img_auth and want the user to see details on why access failed.
394 $wgImgAuthDetails = false;
397 * Map of relative URL directories to match to internal mwstore:// base storage paths.
398 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
399 * if starts with any of the prefixes defined here. The prefixes should not overlap.
400 * The prefix that matches has a corresponding storage path, which the rest of the URL
401 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
403 * Example:
404 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
405 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
406 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
408 * @see $wgFileBackends
410 $wgImgAuthUrlPathMap = array();
413 * File repository structures
415 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
416 * an array of such structures. Each repository structure is an associative
417 * array of properties configuring the repository.
419 * Properties required for all repos:
420 * - class The class name for the repository. May come from the core or an extension.
421 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
422 * FSRepo is also supported for backwards compatibility.
424 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
425 * The name should consist of alpha-numeric characters.
426 * - backend A file backend name (see $wgFileBackends).
428 * For most core repos:
429 * - zones Associative array of zone names that each map to an array with:
430 * container : backend container name the zone is in
431 * directory : root path within container for the zone
432 * url : base URL to the root of the zone
433 * urlsByExt : map of file extension types to base URLs
434 * (useful for using a different cache for videos)
435 * Zones default to using "<repo name>-<zone name>" as the container name
436 * and default to using the container root as the zone's root directory.
437 * Nesting of zone locations within other zones should be avoided.
438 * - url Public zone URL. The 'zones' settings take precedence.
439 * - hashLevels The number of directory levels for hash-based division of files
440 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
441 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
442 * handler instead.
443 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
444 * determines whether filenames implicitly start with a capital letter.
445 * The current implementation may give incorrect description page links
446 * when the local $wgCapitalLinks and initialCapital are mismatched.
447 * - pathDisclosureProtection
448 * May be 'paranoid' to remove all parameters from error messages, 'none' to
449 * leave the paths in unchanged, or 'simple' to replace paths with
450 * placeholders. Default for LocalRepo is 'simple'.
451 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
452 * is 0644.
453 * - directory The local filesystem directory where public files are stored. Not used for
454 * some remote repos.
455 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
456 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
457 * - isPrivate Set this if measures should always be taken to keep the files private.
458 * One should not trust this to assure that the files are not web readable;
459 * the server configuration should be done manually depending on the backend.
461 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
462 * for local repositories:
463 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
464 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
465 * http://en.wikipedia.org/w
466 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
467 * $wgScriptExtension, e.g. .php5 defaults to .php
469 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
470 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
471 * $wgFetchCommonsDescriptions.
472 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
473 * Short thumbnail names only have the width, parameters, and the extension.
475 * ForeignDBRepo:
476 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
477 * equivalent to the corresponding member of $wgDBservers
478 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
479 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
481 * ForeignAPIRepo:
482 * - apibase Use for the foreign API's URL
483 * - apiThumbCacheExpiry How long to locally cache thumbs for
485 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
486 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
487 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
488 * If you set $wgForeignFileRepos to an array of repository structures, those will
489 * be searched after the local file repo.
490 * Otherwise, you will only have access to local media files.
492 * @see Setup.php for an example usage and default initialization.
494 $wgLocalFileRepo = false;
497 * @see $wgLocalFileRepo
499 $wgForeignFileRepos = array();
502 * Use Commons as a remote file repository. Essentially a wrapper, when this
503 * is enabled $wgForeignFileRepos will point at Commons with a set of default
504 * settings
506 $wgUseInstantCommons = false;
509 * File backend structure configuration.
511 * This is an array of file backend configuration arrays.
512 * Each backend configuration has the following parameters:
513 * - 'name' : A unique name for the backend
514 * - 'class' : The file backend class to use
515 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
516 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
518 * See FileBackend::__construct() for more details.
519 * Additional parameters are specific to the file backend class used.
520 * These settings should be global to all wikis when possible.
522 * There are two particularly important aspects about each backend:
523 * - a) Whether it is fully qualified or wiki-relative.
524 * By default, the paths of files are relative to the current wiki,
525 * which works via prefixing them with the current wiki ID when accessed.
526 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
527 * all paths with the specified value instead. This can be useful if
528 * multiple wikis need to share the same data. Note that 'name' is *not*
529 * part of any prefix and thus should not be relied upon for namespacing.
530 * - b) Whether it is only defined for some wikis or is defined on all
531 * wikis in the wiki farm. Defining a backend globally is useful
532 * if multiple wikis need to share the same data.
533 * One should be aware of these aspects when configuring a backend for use with
534 * any basic feature or plugin. For example, suppose an extension stores data for
535 * different wikis in different directories and sometimes needs to access data from
536 * a foreign wiki's directory in order to render a page on given wiki. The extension
537 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
539 $wgFileBackends = array();
542 * Array of configuration arrays for each lock manager.
543 * Each backend configuration has the following parameters:
544 * - 'name' : A unique name for the lock manager
545 * - 'class' : The lock manger class to use
547 * See LockManager::__construct() for more details.
548 * Additional parameters are specific to the lock manager class used.
549 * These settings should be global to all wikis.
551 $wgLockManagers = array();
554 * Show Exif data, on by default if available.
555 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
557 * @note FOR WINDOWS USERS:
558 * To enable Exif functions, add the following lines to the "Windows
559 * extensions" section of php.ini:
560 * @code{.ini}
561 * extension=extensions/php_mbstring.dll
562 * extension=extensions/php_exif.dll
563 * @endcode
565 $wgShowEXIF = function_exists( 'exif_read_data' );
568 * If to automatically update the img_metadata field
569 * if the metadata field is outdated but compatible with the current version.
570 * Defaults to false.
572 $wgUpdateCompatibleMetadata = false;
575 * If you operate multiple wikis, you can define a shared upload path here.
576 * Uploads to this wiki will NOT be put there - they will be put into
577 * $wgUploadDirectory.
578 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
579 * no file of the given name is found in the local repository (for [[File:..]],
580 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
581 * directory.
583 * Note that these configuration settings can now be defined on a per-
584 * repository basis for an arbitrary number of file repositories, using the
585 * $wgForeignFileRepos variable.
587 $wgUseSharedUploads = false;
590 * Full path on the web server where shared uploads can be found
592 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
595 * Fetch commons image description pages and display them on the local wiki?
597 $wgFetchCommonsDescriptions = false;
600 * Path on the file system where shared uploads can be found.
602 $wgSharedUploadDirectory = "/var/www/wiki3/images";
605 * DB name with metadata about shared directory.
606 * Set this to false if the uploads do not come from a wiki.
608 $wgSharedUploadDBname = false;
611 * Optional table prefix used in database.
613 $wgSharedUploadDBprefix = '';
616 * Cache shared metadata in memcached.
617 * Don't do this if the commons wiki is in a different memcached domain
619 $wgCacheSharedUploads = true;
622 * Allow for upload to be copied from an URL.
623 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
624 * You have to assign the user right 'upload_by_url' to a user group, to use this.
626 $wgAllowCopyUploads = false;
629 * Allow asynchronous copy uploads.
630 * This feature is experimental and broken as of r81612.
632 $wgAllowAsyncCopyUploads = false;
635 * A list of domains copy uploads can come from
637 * @since 1.20
639 $wgCopyUploadsDomains = array();
642 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
643 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
644 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
646 $wgCopyUploadsFromSpecialUpload = false;
649 * Proxy to use for copy upload requests.
650 * @since 1.20
652 $wgCopyUploadProxy = false;
655 * Different timeout for upload by url
656 * This could be useful since when fetching large files, you may want a
657 * timeout longer than the default $wgHTTPTimeout. False means fallback
658 * to default.
660 * @since 1.22
662 $wgCopyUploadTimeout = false;
665 * Different timeout for upload by url when run as a background job
666 * This could be useful since when fetching large files via job queue,
667 * you may want a different timeout, especially because there is no
668 * http request being kept alive.
670 * false means fallback to $wgCopyUploadTimeout.
671 * @since 1.22
673 $wgCopyUploadAsyncTimeout = false;
676 * Max size for uploads, in bytes. If not set to an array, applies to all
677 * uploads. If set to an array, per upload type maximums can be set, using the
678 * file and url keys. If the * key is set this value will be used as maximum
679 * for non-specified types.
681 * @par Example:
682 * @code
683 * $wgMaxUploadSize = array(
684 * '*' => 250 * 1024,
685 * 'url' => 500 * 1024,
686 * );
687 * @endcode
688 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
689 * will have a maximum of 500 kB.
691 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
694 * Point the upload navigation link to an external URL
695 * Useful if you want to use a shared repository by default
696 * without disabling local uploads (use $wgEnableUploads = false for that).
698 * @par Example:
699 * @code
700 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
701 * @endcode
703 $wgUploadNavigationUrl = false;
706 * Point the upload link for missing files to an external URL, as with
707 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
708 * appended to it as appropriate.
710 $wgUploadMissingFileUrl = false;
713 * Give a path here to use thumb.php for thumbnail generation on client
714 * request, instead of generating them on render and outputting a static URL.
715 * This is necessary if some of your apache servers don't have read/write
716 * access to the thumbnail path.
718 * @par Example:
719 * @code
720 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
721 * @endcode
723 $wgThumbnailScriptPath = false;
726 * @see $wgThumbnailScriptPath
728 $wgSharedThumbnailScriptPath = false;
731 * Set this to false if you do not want MediaWiki to divide your images
732 * directory into many subdirectories, for improved performance.
734 * It's almost always good to leave this enabled. In previous versions of
735 * MediaWiki, some users set this to false to allow images to be added to the
736 * wiki by simply copying them into $wgUploadDirectory and then running
737 * maintenance/rebuildImages.php to register them in the database. This is no
738 * longer recommended, use maintenance/importImages.php instead.
740 * @note That this variable may be ignored if $wgLocalFileRepo is set.
741 * @todo Deprecate the setting and ultimately remove it from Core.
743 $wgHashedUploadDirectory = true;
746 * Set the following to false especially if you have a set of files that need to
747 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
748 * directory layout.
750 $wgHashedSharedUploadDirectory = true;
753 * Base URL for a repository wiki. Leave this blank if uploads are just stored
754 * in a shared directory and not meant to be accessible through a separate wiki.
755 * Otherwise the image description pages on the local wiki will link to the
756 * image description page on this wiki.
758 * Please specify the namespace, as in the example below.
760 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
763 * This is the list of preferred extensions for uploading files. Uploading files
764 * with extensions not in this list will trigger a warning.
766 * @warning If you add any OpenOffice or Microsoft Office file formats here,
767 * such as odt or doc, and untrusted users are allowed to upload files, then
768 * your wiki will be vulnerable to cross-site request forgery (CSRF).
770 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
773 * Files with these extensions will never be allowed as uploads.
774 * An array of file extensions to blacklist. You should append to this array
775 * if you want to blacklist additional files.
777 $wgFileBlacklist = array(
778 # HTML may contain cookie-stealing JavaScript and web bugs
779 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
780 # PHP scripts may execute arbitrary code on the server
781 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
782 # Other types that may be interpreted by some servers
783 'shtml', 'jhtml', 'pl', 'py', 'cgi',
784 # May contain harmful executables for Windows victims
785 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
788 * Files with these MIME types will never be allowed as uploads
789 * if $wgVerifyMimeType is enabled.
791 $wgMimeTypeBlacklist = array(
792 # HTML may contain cookie-stealing JavaScript and web bugs
793 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
794 # PHP scripts may execute arbitrary code on the server
795 'application/x-php', 'text/x-php',
796 # Other types that may be interpreted by some servers
797 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
798 # Client-side hazards on Internet Explorer
799 'text/scriptlet', 'application/x-msdownload',
800 # Windows metafile, client-side vulnerability on some systems
801 'application/x-msmetafile',
805 * Allow Java archive uploads.
806 * This is not recommended for public wikis since a maliciously-constructed
807 * applet running on the same domain as the wiki can steal the user's cookies.
809 $wgAllowJavaUploads = false;
812 * This is a flag to determine whether or not to check file extensions on upload.
814 * @warning Setting this to false is insecure for public wikis.
816 $wgCheckFileExtensions = true;
819 * If this is turned off, users may override the warning for files not covered
820 * by $wgFileExtensions.
822 * @warning Setting this to false is insecure for public wikis.
824 $wgStrictFileExtensions = true;
827 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
829 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
830 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
832 $wgDisableUploadScriptChecks = false;
835 * Warn if uploaded files are larger than this (in bytes), or false to disable
837 $wgUploadSizeWarning = false;
840 * list of trusted media-types and MIME types.
841 * Use the MEDIATYPE_xxx constants to represent media types.
842 * This list is used by File::isSafeFile
844 * Types not listed here will have a warning about unsafe content
845 * displayed on the images description page. It would also be possible
846 * to use this for further restrictions, like disabling direct
847 * [[media:...]] links for non-trusted formats.
849 $wgTrustedMediaFormats = array(
850 MEDIATYPE_BITMAP, //all bitmap formats
851 MEDIATYPE_AUDIO, //all audio formats
852 MEDIATYPE_VIDEO, //all plain video formats
853 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
854 "application/pdf", //PDF files
855 #"application/x-shockwave-flash", //flash/shockwave movie
859 * Plugins for media file type handling.
860 * Each entry in the array maps a MIME type to a class name
862 $wgMediaHandlers = array(
863 'image/jpeg' => 'JpegHandler',
864 'image/png' => 'PNGHandler',
865 'image/gif' => 'GIFHandler',
866 'image/tiff' => 'TiffHandler',
867 'image/x-ms-bmp' => 'BmpHandler',
868 'image/x-bmp' => 'BmpHandler',
869 'image/x-xcf' => 'XCFHandler',
870 'image/svg+xml' => 'SvgHandler', // official
871 'image/svg' => 'SvgHandler', // compat
872 'image/vnd.djvu' => 'DjVuHandler', // official
873 'image/x.djvu' => 'DjVuHandler', // compat
874 'image/x-djvu' => 'DjVuHandler', // compat
878 * Plugins for page content model handling.
879 * Each entry in the array maps a model id to a class name.
881 * @since 1.21
883 $wgContentHandlers = array(
884 // the usual case
885 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
886 // dumb version, no syntax highlighting
887 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
888 // simple implementation, for use by extensions, etc.
889 CONTENT_MODEL_JSON => 'JsonContentHandler',
890 // dumb version, no syntax highlighting
891 CONTENT_MODEL_CSS => 'CssContentHandler',
892 // plain text, for use by extensions, etc.
893 CONTENT_MODEL_TEXT => 'TextContentHandler',
897 * Whether to enable server-side image thumbnailing. If false, images will
898 * always be sent to the client in full resolution, with appropriate width= and
899 * height= attributes on the <img> tag for the client to do its own scaling.
901 $wgUseImageResize = true;
904 * Resizing can be done using PHP's internal image libraries or using
905 * ImageMagick or another third-party converter, e.g. GraphicMagick.
906 * These support more file formats than PHP, which only supports PNG,
907 * GIF, JPG, XBM and WBMP.
909 * Use Image Magick instead of PHP builtin functions.
911 $wgUseImageMagick = false;
914 * The convert command shipped with ImageMagick
916 $wgImageMagickConvertCommand = '/usr/bin/convert';
919 * Sharpening parameter to ImageMagick
921 $wgSharpenParameter = '0x0.4';
924 * Reduction in linear dimensions below which sharpening will be enabled
926 $wgSharpenReductionThreshold = 0.85;
929 * Temporary directory used for ImageMagick. The directory must exist. Leave
930 * this set to false to let ImageMagick decide for itself.
932 $wgImageMagickTempDir = false;
935 * Use another resizing converter, e.g. GraphicMagick
936 * %s will be replaced with the source path, %d with the destination
937 * %w and %h will be replaced with the width and height.
939 * @par Example for GraphicMagick:
940 * @code
941 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
942 * @endcode
944 * Leave as false to skip this.
946 $wgCustomConvertCommand = false;
949 * used for lossless jpeg rotation
951 * @since 1.21
953 $wgJpegTran = '/usr/bin/jpegtran';
956 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
957 * image formats.
959 $wgExiv2Command = '/usr/bin/exiv2';
962 * Scalable Vector Graphics (SVG) may be uploaded as images.
963 * Since SVG support is not yet standard in browsers, it is
964 * necessary to rasterize SVGs to PNG as a fallback format.
966 * An external program is required to perform this conversion.
967 * If set to an array, the first item is a PHP callable and any further items
968 * are passed as parameters after $srcPath, $dstPath, $width, $height
970 $wgSVGConverters = array(
971 'ImageMagick' =>
972 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
973 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
974 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
975 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
976 . '$output $input',
977 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
978 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
979 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
983 * Pick a converter defined in $wgSVGConverters
985 $wgSVGConverter = 'ImageMagick';
988 * If not in the executable PATH, specify the SVG converter path.
990 $wgSVGConverterPath = '';
993 * Don't scale a SVG larger than this
995 $wgSVGMaxSize = 2048;
998 * Don't read SVG metadata beyond this point.
999 * Default is 1024*256 bytes
1001 $wgSVGMetadataCutoff = 262144;
1004 * Disallow <title> element in SVG files.
1006 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1007 * browsers which can not perform basic stuff like MIME detection and which are
1008 * vulnerable to further idiots uploading crap files as images.
1010 * When this directive is on, "<title>" will be allowed in files with an
1011 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1012 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1014 $wgAllowTitlesInSVG = false;
1017 * The maximum number of pixels a source image can have if it is to be scaled
1018 * down by a scaler that requires the full source image to be decompressed
1019 * and stored in decompressed form, before the thumbnail is generated.
1021 * This provides a limit on memory usage for the decompression side of the
1022 * image scaler. The limit is used when scaling PNGs with any of the
1023 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1024 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1026 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1027 * 12.5 million pixels or 3500x3500.
1029 $wgMaxImageArea = 1.25e7;
1032 * Force thumbnailing of animated GIFs above this size to a single
1033 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1034 * is checked against the total size of all frames in the animation.
1035 * It probably makes sense to keep this equal to $wgMaxImageArea.
1037 $wgMaxAnimatedGifArea = 1.25e7;
1040 * Browsers don't support TIFF inline generally...
1041 * For inline display, we need to convert to PNG or JPEG.
1042 * Note scaling should work with ImageMagick, but may not with GD scaling.
1044 * @par Example:
1045 * @code
1046 * // PNG is lossless, but inefficient for photos
1047 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1048 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1049 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1050 * @endcode
1052 $wgTiffThumbnailType = false;
1055 * If rendered thumbnail files are older than this timestamp, they
1056 * will be rerendered on demand as if the file didn't already exist.
1057 * Update if there is some need to force thumbs and SVG rasterizations
1058 * to rerender, such as fixes to rendering bugs.
1060 $wgThumbnailEpoch = '20030516000000';
1063 * Certain operations are avoided if there were too many recent failures,
1064 * for example, thumbnail generation. Bump this value to invalidate all
1065 * memory of failed operations and thus allow further attempts to resume.
1066 * This is useful when a cause for the failures has been found and fixed.
1068 $wgAttemptFailureEpoch = 1;
1071 * If set, inline scaled images will still produce "<img>" tags ready for
1072 * output instead of showing an error message.
1074 * This may be useful if errors are transitory, especially if the site
1075 * is configured to automatically render thumbnails on request.
1077 * On the other hand, it may obscure error conditions from debugging.
1078 * Enable the debug log or the 'thumbnail' log group to make sure errors
1079 * are logged to a file for review.
1081 $wgIgnoreImageErrors = false;
1084 * Allow thumbnail rendering on page view. If this is false, a valid
1085 * thumbnail URL is still output, but no file will be created at
1086 * the target location. This may save some time if you have a
1087 * thumb.php or 404 handler set up which is faster than the regular
1088 * webserver(s).
1090 $wgGenerateThumbnailOnParse = true;
1093 * Show thumbnails for old images on the image description page
1095 $wgShowArchiveThumbnails = true;
1098 * If set to true, images that contain certain the exif orientation tag will
1099 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1100 * is available that can rotate.
1102 $wgEnableAutoRotation = null;
1105 * Internal name of virus scanner. This serves as a key to the
1106 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1107 * null, every file uploaded will be scanned for viruses.
1109 $wgAntivirus = null;
1112 * Configuration for different virus scanners. This an associative array of
1113 * associative arrays. It contains one setup array per known scanner type.
1114 * The entry is selected by $wgAntivirus, i.e.
1115 * valid values for $wgAntivirus are the keys defined in this array.
1117 * The configuration array for each scanner contains the following keys:
1118 * "command", "codemap", "messagepattern":
1120 * "command" is the full command to call the virus scanner - %f will be
1121 * replaced with the name of the file to scan. If not present, the filename
1122 * will be appended to the command. Note that this must be overwritten if the
1123 * scanner is not in the system path; in that case, please set
1124 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1125 * path.
1127 * "codemap" is a mapping of exit code to return codes of the detectVirus
1128 * function in SpecialUpload.
1129 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1130 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1131 * is not set.
1132 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1133 * the file to have an unsupported format, which is probably immune to
1134 * viruses. This causes the file to pass.
1135 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1136 * no virus was found.
1137 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1138 * a virus.
1139 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1141 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1142 * output. The relevant part should be matched as group one (\1).
1143 * If not defined or the pattern does not match, the full message is shown to the user.
1145 $wgAntivirusSetup = array(
1147 #setup for clamav
1148 'clamav' => array(
1149 'command' => 'clamscan --no-summary ',
1150 'codemap' => array(
1151 "0" => AV_NO_VIRUS, # no virus
1152 "1" => AV_VIRUS_FOUND, # virus found
1153 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1154 "*" => AV_SCAN_FAILED, # else scan failed
1156 'messagepattern' => '/.*?:(.*)/sim',
1161 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1163 $wgAntivirusRequired = true;
1166 * Determines if the MIME type of uploaded files should be checked
1168 $wgVerifyMimeType = true;
1171 * Sets the MIME type definition file to use by MimeMagic.php.
1172 * Set to null, to use built-in defaults only.
1173 * example: $wgMimeTypeFile = '/etc/mime.types';
1175 $wgMimeTypeFile = 'includes/mime.types';
1178 * Sets the MIME type info file to use by MimeMagic.php.
1179 * Set to null, to use built-in defaults only.
1181 $wgMimeInfoFile = 'includes/mime.info';
1184 * Sets an external MIME detector program. The command must print only
1185 * the MIME type to standard output.
1186 * The name of the file to process will be appended to the command given here.
1187 * If not set or NULL, PHP's fileinfo extension will be used if available.
1189 * @par Example:
1190 * @code
1191 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1192 * @endcode
1194 $wgMimeDetectorCommand = null;
1197 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1198 * things, because only a few types of images are needed and file extensions
1199 * can be trusted.
1201 $wgTrivialMimeDetection = false;
1204 * Additional XML types we can allow via MIME-detection.
1205 * array = ( 'rootElement' => 'associatedMimeType' )
1207 $wgXMLMimeTypes = array(
1208 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1209 'svg' => 'image/svg+xml',
1210 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1211 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1212 'html' => 'text/html', // application/xhtml+xml?
1216 * Limit images on image description pages to a user-selectable limit. In order
1217 * to reduce disk usage, limits can only be selected from a list.
1218 * The user preference is saved as an array offset in the database, by default
1219 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1220 * change it if you alter the array (see bug 8858).
1221 * This is the list of settings the user can choose from:
1223 $wgImageLimits = array(
1224 array( 320, 240 ),
1225 array( 640, 480 ),
1226 array( 800, 600 ),
1227 array( 1024, 768 ),
1228 array( 1280, 1024 )
1232 * Adjust thumbnails on image pages according to a user setting. In order to
1233 * reduce disk usage, the values can only be selected from a list. This is the
1234 * list of settings the user can choose from:
1236 $wgThumbLimits = array(
1237 120,
1238 150,
1239 180,
1240 200,
1241 250,
1246 * When defined, is an array of image widths used as buckets for thumbnail generation.
1247 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1248 * always using the original. This will incur a speed gain but cause a quality loss.
1250 * The buckets generation is chained, with each bucket generated based on the above bucket
1251 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1252 * supports it.
1254 $wgThumbnailBuckets = null;
1257 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1258 * above the requested size. The distance represents how many extra pixels of width the bucket
1259 * needs in order to be used as the reference for a given thumbnail. For example, with the
1260 * following buckets:
1262 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1264 * and a distance of 50:
1266 * $wgThumbnailMinimumBucketDistance = 50;
1268 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1269 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1271 $wgThumbnailMinimumBucketDistance = 50;
1274 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1275 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1276 * has a performance impact for the first client to view a certain size.
1278 * This obviously means that more disk space is needed per upload upfront.
1280 * @since 1.25
1283 $wgUploadThumbnailRenderMap = array();
1286 * The method through which the thumbnails will be prerendered for the entries in
1287 * $wgUploadThumbnailRenderMap
1289 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1290 * thumbnail's URL.
1291 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1292 * option uses the job queue to render the thumbnail.
1294 * @since 1.25
1296 $wgUploadThumbnailRenderMethod = 'jobqueue';
1299 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1301 * @since 1.25
1303 $wgUploadThumbnailRenderHttpCustomHost = false;
1306 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1307 * HTTP request to.
1309 * @since 1.25
1311 $wgUploadThumbnailRenderHttpCustomDomain = false;
1314 * Default parameters for the "<gallery>" tag
1316 $wgGalleryOptions = array(
1317 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1318 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1319 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1320 'captionLength' => 25, // Length of caption to truncate (in characters)
1321 'showBytes' => true, // Show the filesize in bytes in categories
1322 'mode' => 'traditional',
1326 * Adjust width of upright images when parameter 'upright' is used
1327 * This allows a nicer look for upright images without the need to fix the width
1328 * by hardcoded px in wiki sourcecode.
1330 $wgThumbUpright = 0.75;
1333 * Default value for chmoding of new directories.
1335 $wgDirectoryMode = 0777;
1338 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1340 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1341 * thumbnails, output via the srcset attribute.
1343 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1344 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1345 * The polyfill can be found in the jquery.hidpi module.
1347 $wgResponsiveImages = true;
1350 * @name DJVU settings
1351 * @{
1355 * Path of the djvudump executable
1356 * Enable this and $wgDjvuRenderer to enable djvu rendering
1357 * example: $wgDjvuDump = 'djvudump';
1359 $wgDjvuDump = null;
1362 * Path of the ddjvu DJVU renderer
1363 * Enable this and $wgDjvuDump to enable djvu rendering
1364 * example: $wgDjvuRenderer = 'ddjvu';
1366 $wgDjvuRenderer = null;
1369 * Path of the djvutxt DJVU text extraction utility
1370 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1371 * example: $wgDjvuTxt = 'djvutxt';
1373 $wgDjvuTxt = null;
1376 * Path of the djvutoxml executable
1377 * This works like djvudump except much, much slower as of version 3.5.
1379 * For now we recommend you use djvudump instead. The djvuxml output is
1380 * probably more stable, so we'll switch back to it as soon as they fix
1381 * the efficiency problem.
1382 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1384 * @par Example:
1385 * @code
1386 * $wgDjvuToXML = 'djvutoxml';
1387 * @endcode
1389 $wgDjvuToXML = null;
1392 * Shell command for the DJVU post processor
1393 * Default: pnmtojpeg, since ddjvu generates ppm output
1394 * Set this to false to output the ppm file directly.
1396 $wgDjvuPostProcessor = 'pnmtojpeg';
1399 * File extension for the DJVU post processor output
1401 $wgDjvuOutputExtension = 'jpg';
1403 /** @} */ # end of DJvu }
1405 /** @} */ # end of file uploads }
1407 /************************************************************************//**
1408 * @name Email settings
1409 * @{
1414 * Site admin email address.
1416 * Defaults to "wikiadmin@$wgServerName".
1418 $wgEmergencyContact = false;
1421 * Password reminder email address.
1423 * The address we should use as sender when a user is requesting his password.
1425 * Defaults to "apache@$wgServerName".
1427 $wgPasswordSender = false;
1430 * Password reminder name
1432 * @deprecated since 1.23; use the system message 'emailsender' instead.
1434 $wgPasswordSenderName = 'MediaWiki Mail';
1437 * Dummy address which should be accepted during mail send action.
1438 * It might be necessary to adapt the address or to set it equal
1439 * to the $wgEmergencyContact address.
1441 $wgNoReplyAddress = 'reply@not.possible';
1444 * Set to true to enable the e-mail basic features:
1445 * Password reminders, etc. If sending e-mail on your
1446 * server doesn't work, you might want to disable this.
1448 $wgEnableEmail = true;
1451 * Set to true to enable user-to-user e-mail.
1452 * This can potentially be abused, as it's hard to track.
1454 $wgEnableUserEmail = true;
1457 * Set to true to put the sending user's email in a Reply-To header
1458 * instead of From. ($wgEmergencyContact will be used as From.)
1460 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1461 * which can cause problems with SPF validation and leak recipient addresses
1462 * when bounces are sent to the sender.
1464 $wgUserEmailUseReplyTo = false;
1467 * Minimum time, in hours, which must elapse between password reminder
1468 * emails for a given account. This is to prevent abuse by mail flooding.
1470 $wgPasswordReminderResendTime = 24;
1473 * The time, in seconds, when an emailed temporary password expires.
1475 $wgNewPasswordExpiry = 3600 * 24 * 7;
1478 * The time, in seconds, when an email confirmation email expires
1480 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1483 * The number of days that a user's password is good for. After this number of days, the
1484 * user will be asked to reset their password. Set to false to disable password expiration.
1486 $wgPasswordExpirationDays = false;
1489 * If a user's password is expired, the number of seconds when they can still login,
1490 * and cancel their password change, but are sent to the password change form on each login.
1492 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1495 * SMTP Mode.
1497 * For using a direct (authenticated) SMTP server connection.
1498 * Default to false or fill an array :
1500 * @code
1501 * $wgSMTP = array(
1502 * 'host' => 'SMTP domain',
1503 * 'IDHost' => 'domain for MessageID',
1504 * 'port' => '25',
1505 * 'auth' => [true|false],
1506 * 'username' => [SMTP username],
1507 * 'password' => [SMTP password],
1508 * );
1509 * @endcode
1511 $wgSMTP = false;
1514 * Additional email parameters, will be passed as the last argument to mail() call.
1515 * If using safe_mode this has no effect
1517 $wgAdditionalMailParams = null;
1520 * For parts of the system that have been updated to provide HTML email content, send
1521 * both text and HTML parts as the body of the email
1523 $wgAllowHTMLEmail = false;
1526 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1527 * from $wgEmergencyContact
1529 $wgEnotifFromEditor = false;
1531 // TODO move UPO to preferences probably ?
1532 # If set to true, users get a corresponding option in their preferences and can choose to
1533 # enable or disable at their discretion
1534 # If set to false, the corresponding input form on the user preference page is suppressed
1535 # It call this to be a "user-preferences-option (UPO)"
1538 * Require email authentication before sending mail to an email address.
1539 * This is highly recommended. It prevents MediaWiki from being used as an open
1540 * spam relay.
1542 $wgEmailAuthentication = true;
1545 * Allow users to enable email notification ("enotif") on watchlist changes.
1547 $wgEnotifWatchlist = false;
1550 * Allow users to enable email notification ("enotif") when someone edits their
1551 * user talk page.
1553 $wgEnotifUserTalk = false;
1556 * Set the Reply-to address in notifications to the editor's address, if user
1557 * allowed this in the preferences.
1559 $wgEnotifRevealEditorAddress = false;
1562 * Send notification mails on minor edits to watchlist pages. This is enabled
1563 * by default. Does not affect user talk notifications.
1565 $wgEnotifMinorEdits = true;
1568 * Send a generic mail instead of a personalised mail for each user. This
1569 * always uses UTC as the time zone, and doesn't include the username.
1571 * For pages with many users watching, this can significantly reduce mail load.
1572 * Has no effect when using sendmail rather than SMTP.
1574 $wgEnotifImpersonal = false;
1577 * Maximum number of users to mail at once when using impersonal mail. Should
1578 * match the limit on your mail server.
1580 $wgEnotifMaxRecips = 500;
1583 * Send mails via the job queue. This can be useful to reduce the time it
1584 * takes to save a page that a lot of people are watching.
1586 $wgEnotifUseJobQ = false;
1589 * Use real name instead of username in e-mail "from" field.
1591 $wgEnotifUseRealName = false;
1594 * Array of usernames who will be sent a notification email for every change
1595 * which occurs on a wiki. Users will not be notified of their own changes.
1597 $wgUsersNotifiedOnAllChanges = array();
1599 /** @} */ # end of email settings
1601 /************************************************************************//**
1602 * @name Database settings
1603 * @{
1607 * Database host name or IP address
1609 $wgDBserver = 'localhost';
1612 * Database port number (for PostgreSQL and Microsoft SQL Server).
1614 $wgDBport = 5432;
1617 * Name of the database
1619 $wgDBname = 'my_wiki';
1622 * Database username
1624 $wgDBuser = 'wikiuser';
1627 * Database user's password
1629 $wgDBpassword = '';
1632 * Database type
1634 $wgDBtype = 'mysql';
1637 * Whether to use SSL in DB connection.
1639 * This setting is only used $wgLBFactoryConf['class'] is set to
1640 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1641 * the DBO_SSL flag must be set in the 'flags' option of the database
1642 * connection to achieve the same functionality.
1644 $wgDBssl = false;
1647 * Whether to use compression in DB connection.
1649 * This setting is only used $wgLBFactoryConf['class'] is set to
1650 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1651 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1652 * connection to achieve the same functionality.
1654 $wgDBcompress = false;
1657 * Separate username for maintenance tasks. Leave as null to use the default.
1659 $wgDBadminuser = null;
1662 * Separate password for maintenance tasks. Leave as null to use the default.
1664 $wgDBadminpassword = null;
1667 * Search type.
1668 * Leave as null to select the default search engine for the
1669 * selected database type (eg SearchMySQL), or set to a class
1670 * name to override to a custom search engine.
1672 $wgSearchType = null;
1675 * Alternative search types
1676 * Sometimes you want to support multiple search engines for testing. This
1677 * allows users to select their search engine of choice via url parameters
1678 * to Special:Search and the action=search API. If using this, there's no
1679 * need to add $wgSearchType to it, that is handled automatically.
1681 $wgSearchTypeAlternatives = null;
1684 * Table name prefix
1686 $wgDBprefix = '';
1689 * MySQL table options to use during installation or update
1691 $wgDBTableOptions = 'ENGINE=InnoDB';
1694 * SQL Mode - default is turning off all modes, including strict, if set.
1695 * null can be used to skip the setting for performance reasons and assume
1696 * DBA has done his best job.
1697 * String override can be used for some additional fun :-)
1699 $wgSQLMode = '';
1702 * Mediawiki schema
1704 $wgDBmwschema = null;
1707 * To override default SQLite data directory ($docroot/../data)
1709 $wgSQLiteDataDir = '';
1712 * Make all database connections secretly go to localhost. Fool the load balancer
1713 * thinking there is an arbitrarily large cluster of servers to connect to.
1714 * Useful for debugging.
1716 $wgAllDBsAreLocalhost = false;
1719 * Shared database for multiple wikis. Commonly used for storing a user table
1720 * for single sign-on. The server for this database must be the same as for the
1721 * main database.
1723 * For backwards compatibility the shared prefix is set to the same as the local
1724 * prefix, and the user table is listed in the default list of shared tables.
1725 * The user_properties table is also added so that users will continue to have their
1726 * preferences shared (preferences were stored in the user table prior to 1.16)
1728 * $wgSharedTables may be customized with a list of tables to share in the shared
1729 * database. However it is advised to limit what tables you do share as many of
1730 * MediaWiki's tables may have side effects if you try to share them.
1732 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1733 * $wgDBprefix.
1735 * $wgSharedSchema is the table schema for the shared database. It defaults to
1736 * $wgDBmwschema.
1738 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1739 * access remote databases. Using wfGetLB() allows the shared database to
1740 * reside on separate servers to the wiki's own database, with suitable
1741 * configuration of $wgLBFactoryConf.
1743 $wgSharedDB = null;
1746 * @see $wgSharedDB
1748 $wgSharedPrefix = false;
1751 * @see $wgSharedDB
1753 $wgSharedTables = array( 'user', 'user_properties' );
1756 * @see $wgSharedDB
1757 * @since 1.23
1759 $wgSharedSchema = false;
1762 * Database load balancer
1763 * This is a two-dimensional array, an array of server info structures
1764 * Fields are:
1765 * - host: Host name
1766 * - dbname: Default database name
1767 * - user: DB user
1768 * - password: DB password
1769 * - type: DB type
1771 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1772 * If this is zero for any given server, no normal query traffic will be
1773 * sent to it. It will be excluded from lag checks in maintenance scripts.
1774 * The only way it can receive traffic is if groupLoads is used.
1776 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1777 * to several groups, the most specific group defined here is used.
1779 * - flags: bit field
1780 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1781 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1782 * - DBO_TRX -- wrap entire request in a transaction
1783 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1784 * - DBO_PERSISTENT -- enables persistent database connections
1785 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1786 * - DBO_COMPRESS -- uses internal compression in database connections,
1787 * if available
1789 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1791 * These and any other user-defined properties will be assigned to the mLBInfo member
1792 * variable of the Database object.
1794 * Leave at false to use the single-server variables above. If you set this
1795 * variable, the single-server variables will generally be ignored (except
1796 * perhaps in some command-line scripts).
1798 * The first server listed in this array (with key 0) will be the master. The
1799 * rest of the servers will be slaves. To prevent writes to your slaves due to
1800 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1801 * slaves in my.cnf. You can set read_only mode at runtime using:
1803 * @code
1804 * SET @@read_only=1;
1805 * @endcode
1807 * Since the effect of writing to a slave is so damaging and difficult to clean
1808 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1809 * our masters, and then set read_only=0 on masters at runtime.
1811 $wgDBservers = false;
1814 * Load balancer factory configuration
1815 * To set up a multi-master wiki farm, set the class here to something that
1816 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1817 * The class identified here is responsible for reading $wgDBservers,
1818 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1820 * The LBFactoryMulti class is provided for this purpose, please see
1821 * includes/db/LBFactoryMulti.php for configuration information.
1823 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1826 * How long to wait for a slave to catch up to the master
1827 * @deprecated since 1.24
1829 $wgMasterWaitTimeout = 10;
1832 * File to log database errors to
1834 $wgDBerrorLog = false;
1837 * Timezone to use in the error log.
1838 * Defaults to the wiki timezone ($wgLocaltimezone).
1840 * A list of usable timezones can found at:
1841 * http://php.net/manual/en/timezones.php
1843 * @par Examples:
1844 * @code
1845 * $wgLocaltimezone = 'UTC';
1846 * $wgLocaltimezone = 'GMT';
1847 * $wgLocaltimezone = 'PST8PDT';
1848 * $wgLocaltimezone = 'Europe/Sweden';
1849 * $wgLocaltimezone = 'CET';
1850 * @endcode
1852 * @since 1.20
1854 $wgDBerrorLogTZ = false;
1857 * Scale load balancer polling time so that under overload conditions, the
1858 * database server receives a SHOW STATUS query at an average interval of this
1859 * many microseconds
1861 $wgDBAvgStatusPoll = 2000;
1864 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1865 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1867 * @warning THIS IS EXPERIMENTAL!
1869 * May break if you're not using the table defs from mysql5/tables.sql.
1870 * May break if you're upgrading an existing wiki if set differently.
1871 * Broken symptoms likely to include incorrect behavior with page titles,
1872 * usernames, comments etc containing non-ASCII characters.
1873 * Might also cause failures on the object cache and other things.
1875 * Even correct usage may cause failures with Unicode supplementary
1876 * characters (those not in the Basic Multilingual Plane) unless MySQL
1877 * has enhanced their Unicode support.
1879 $wgDBmysql5 = false;
1882 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1884 * To use this feature set to true and use a datasource defined as
1885 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1886 * block).
1888 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1889 * Pool) that maintains established sessions and reuses them on new
1890 * connections.
1892 * Not completely tested, but it should fall back on normal connection
1893 * in case the pool is full or the datasource is not configured as
1894 * pooled.
1895 * And the other way around; using oci_pconnect on a non pooled
1896 * datasource should produce a normal connection.
1898 * When it comes to frequent shortlived DB connections like with MW
1899 * Oracle tends to s***. The problem is the driver connects to the
1900 * database reasonably fast, but establishing a session takes time and
1901 * resources. MW does not rely on session state (as it does not use
1902 * features such as package variables) so establishing a valid session
1903 * is in this case an unwanted overhead that just slows things down.
1905 * @warning EXPERIMENTAL!
1908 $wgDBOracleDRCP = false;
1911 * Other wikis on this site, can be administered from a single developer
1912 * account.
1913 * Array numeric key => database name
1915 $wgLocalDatabases = array();
1918 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1919 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1920 * show a more obvious warning.
1922 $wgSlaveLagWarning = 10;
1925 * @see $wgSlaveLagWarning
1927 $wgSlaveLagCritical = 30;
1930 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1932 $wgDBWindowsAuthentication = false;
1934 /**@}*/ # End of DB settings }
1936 /************************************************************************//**
1937 * @name Text storage
1938 * @{
1942 * We can also compress text stored in the 'text' table. If this is set on, new
1943 * revisions will be compressed on page save if zlib support is available. Any
1944 * compressed revisions will be decompressed on load regardless of this setting,
1945 * but will not be readable at all* if zlib support is not available.
1947 $wgCompressRevisions = false;
1950 * External stores allow including content
1951 * from non database sources following URL links.
1953 * Short names of ExternalStore classes may be specified in an array here:
1954 * @code
1955 * $wgExternalStores = array("http","file","custom")...
1956 * @endcode
1958 * CAUTION: Access to database might lead to code execution
1960 $wgExternalStores = array();
1963 * An array of external MySQL servers.
1965 * @par Example:
1966 * Create a cluster named 'cluster1' containing three servers:
1967 * @code
1968 * $wgExternalServers = array(
1969 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1970 * );
1971 * @endcode
1973 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1974 * another class.
1976 $wgExternalServers = array();
1979 * The place to put new revisions, false to put them in the local text table.
1980 * Part of a URL, e.g. DB://cluster1
1982 * Can be an array instead of a single string, to enable data distribution. Keys
1983 * must be consecutive integers, starting at zero.
1985 * @par Example:
1986 * @code
1987 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1988 * @endcode
1990 * @var array
1992 $wgDefaultExternalStore = false;
1995 * Revision text may be cached in $wgMemc to reduce load on external storage
1996 * servers and object extraction overhead for frequently-loaded revisions.
1998 * Set to 0 to disable, or number of seconds before cache expiry.
2000 $wgRevisionCacheExpiry = 0;
2002 /** @} */ # end text storage }
2004 /************************************************************************//**
2005 * @name Performance hacks and limits
2006 * @{
2010 * Disable database-intensive features
2012 $wgMiserMode = false;
2015 * Disable all query pages if miser mode is on, not just some
2017 $wgDisableQueryPages = false;
2020 * Number of rows to cache in 'querycache' table when miser mode is on
2022 $wgQueryCacheLimit = 1000;
2025 * Number of links to a page required before it is deemed "wanted"
2027 $wgWantedPagesThreshold = 1;
2030 * Enable slow parser functions
2032 $wgAllowSlowParserFunctions = false;
2035 * Allow schema updates
2037 $wgAllowSchemaUpdates = true;
2040 * Maximum article size in kilobytes
2042 $wgMaxArticleSize = 2048;
2045 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2046 * raise PHP's memory limit if it's below this amount.
2048 $wgMemoryLimit = "50M";
2050 /** @} */ # end performance hacks }
2052 /************************************************************************//**
2053 * @name Cache settings
2054 * @{
2058 * Directory for caching data in the local filesystem. Should not be accessible
2059 * from the web. Set this to false to not use any local caches.
2061 * Note: if multiple wikis share the same localisation cache directory, they
2062 * must all have the same set of extensions. You can set a directory just for
2063 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2065 $wgCacheDirectory = false;
2068 * Main cache type. This should be a cache with fast access, but it may have
2069 * limited space. By default, it is disabled, since the database is not fast
2070 * enough to make it worthwhile.
2072 * The options are:
2074 * - CACHE_ANYTHING: Use anything, as long as it works
2075 * - CACHE_NONE: Do not cache
2076 * - CACHE_DB: Store cache objects in the DB
2077 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2078 * - CACHE_ACCEL: APC, XCache or WinCache
2079 * - (other): A string may be used which identifies a cache
2080 * configuration in $wgObjectCaches.
2082 * @see $wgMessageCacheType, $wgParserCacheType
2084 $wgMainCacheType = CACHE_NONE;
2087 * The cache type for storing the contents of the MediaWiki namespace. This
2088 * cache is used for a small amount of data which is expensive to regenerate.
2090 * For available types see $wgMainCacheType.
2092 $wgMessageCacheType = CACHE_ANYTHING;
2095 * The cache type for storing article HTML. This is used to store data which
2096 * is expensive to regenerate, and benefits from having plenty of storage space.
2098 * For available types see $wgMainCacheType.
2100 $wgParserCacheType = CACHE_ANYTHING;
2103 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2105 * For available types see $wgMainCacheType.
2107 $wgSessionCacheType = CACHE_ANYTHING;
2110 * The cache type for storing language conversion tables,
2111 * which are used when parsing certain text and interface messages.
2113 * For available types see $wgMainCacheType.
2115 * @since 1.20
2117 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2120 * Advanced object cache configuration.
2122 * Use this to define the class names and constructor parameters which are used
2123 * for the various cache types. Custom cache types may be defined here and
2124 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2125 * or $wgLanguageConverterCacheType.
2127 * The format is an associative array where the key is a cache identifier, and
2128 * the value is an associative array of parameters. The "class" parameter is the
2129 * class name which will be used. Alternatively, a "factory" parameter may be
2130 * given, giving a callable function which will generate a suitable cache object.
2132 $wgObjectCaches = array(
2133 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2134 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2136 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2137 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2138 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached', 'loggroup' => 'memcached' ),
2140 'apc' => array( 'class' => 'APCBagOStuff' ),
2141 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2142 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2143 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2144 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2145 'hash' => array( 'class' => 'HashBagOStuff' ),
2149 * Map of bloom filter store names to configuration arrays.
2151 * Example:
2152 * $wgBloomFilterStores['main'] = array(
2153 * 'cacheId' => 'main-v1',
2154 * 'class' => 'BloomCacheRedis',
2155 * 'redisServers' => array( '127.0.0.1:6379' ),
2156 * 'redisConfig' => array( 'connectTimeout' => 2 )
2157 * );
2159 * A primary bloom filter must be created manually.
2160 * Example in eval.php:
2161 * <code>
2162 * BloomCache::get( 'main' )->init( 'shared', 1000000000, .001 );
2163 * </code>
2164 * The size should be as large as practical given wiki size and resources.
2166 * @since 1.24
2168 $wgBloomFilterStores = array();
2171 * The expiry time for the parser cache, in seconds.
2172 * The default is 86400 (one day).
2174 $wgParserCacheExpireTime = 86400;
2177 * Deprecated alias for $wgSessionsInObjectCache.
2179 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2181 $wgSessionsInMemcached = false;
2184 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2185 * can be useful to improve performance, or to avoid the locking behavior of
2186 * PHP's default session handler, which tends to prevent multiple requests for
2187 * the same user from acting concurrently.
2189 $wgSessionsInObjectCache = false;
2192 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2193 * enabled, in seconds.
2195 $wgObjectCacheSessionExpiry = 3600;
2198 * This is used for setting php's session.save_handler. In practice, you will
2199 * almost never need to change this ever. Other options might be 'user' or
2200 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2201 * useful if you're doing cross-application sessions, see bug 11381)
2203 $wgSessionHandler = null;
2206 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2208 $wgMemCachedDebug = false;
2211 * The list of MemCached servers and port numbers
2213 $wgMemCachedServers = array( '127.0.0.1:11211' );
2216 * Use persistent connections to MemCached, which are shared across multiple
2217 * requests.
2219 $wgMemCachedPersistent = false;
2222 * Read/write timeout for MemCached server communication, in microseconds.
2224 $wgMemCachedTimeout = 500000;
2227 * Set this to true to make a local copy of the message cache, for use in
2228 * addition to memcached. The files will be put in $wgCacheDirectory.
2230 $wgUseLocalMessageCache = false;
2233 * Instead of caching everything, only cache those messages which have
2234 * been customised in the site content language. This means that
2235 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2236 * This option is probably only useful for translatewiki.net.
2238 $wgAdaptiveMessageCache = false;
2241 * Localisation cache configuration. Associative array with keys:
2242 * class: The class to use. May be overridden by extensions.
2244 * store: The location to store cache data. May be 'files', 'db' or
2245 * 'detect'. If set to "files", data will be in CDB files. If set
2246 * to "db", data will be stored to the database. If set to
2247 * "detect", files will be used if $wgCacheDirectory is set,
2248 * otherwise the database will be used.
2250 * storeClass: The class name for the underlying storage. If set to a class
2251 * name, it overrides the "store" setting.
2253 * storeDirectory: If the store class puts its data in files, this is the
2254 * directory it will use. If this is false, $wgCacheDirectory
2255 * will be used.
2257 * manualRecache: Set this to true to disable cache updates on web requests.
2258 * Use maintenance/rebuildLocalisationCache.php instead.
2260 $wgLocalisationCacheConf = array(
2261 'class' => 'LocalisationCache',
2262 'store' => 'detect',
2263 'storeClass' => false,
2264 'storeDirectory' => false,
2265 'manualRecache' => false,
2269 * Allow client-side caching of pages
2271 $wgCachePages = true;
2274 * Set this to current time to invalidate all prior cached pages. Affects both
2275 * client-side and server-side caching.
2276 * You can get the current date on your server by using the command:
2277 * @verbatim
2278 * date +%Y%m%d%H%M%S
2279 * @endverbatim
2281 $wgCacheEpoch = '20030516000000';
2284 * Directory where GitInfo will look for pre-computed cache files. If false,
2285 * $wgCacheDirectory/gitinfo will be used.
2287 $wgGitInfoCacheDirectory = false;
2290 * Bump this number when changing the global style sheets and JavaScript.
2292 * It should be appended in the query string of static CSS and JS includes,
2293 * to ensure that client-side caches do not keep obsolete copies of global
2294 * styles.
2296 $wgStyleVersion = '303';
2299 * This will cache static pages for non-logged-in users to reduce
2300 * database traffic on public sites.
2301 * Automatically sets $wgShowIPinHeader = false
2302 * ResourceLoader requests to default language and skins are cached
2303 * as well as single module requests.
2305 $wgUseFileCache = false;
2308 * Depth of the subdirectory hierarchy to be created under
2309 * $wgFileCacheDirectory. The subdirectories will be named based on
2310 * the MD5 hash of the title. A value of 0 means all cache files will
2311 * be put directly into the main file cache directory.
2313 $wgFileCacheDepth = 2;
2316 * Keep parsed pages in a cache (objectcache table or memcached)
2317 * to speed up output of the same page viewed by another user with the
2318 * same options.
2320 * This can provide a significant speedup for medium to large pages,
2321 * so you probably want to keep it on. Extensions that conflict with the
2322 * parser cache should disable the cache on a per-page basis instead.
2324 $wgEnableParserCache = true;
2327 * Append a configured value to the parser cache and the sitenotice key so
2328 * that they can be kept separate for some class of activity.
2330 $wgRenderHashAppend = '';
2333 * If on, the sidebar navigation links are cached for users with the
2334 * current language set. This can save a touch of load on a busy site
2335 * by shaving off extra message lookups.
2337 * However it is also fragile: changing the site configuration, or
2338 * having a variable $wgArticlePath, can produce broken links that
2339 * don't update as expected.
2341 $wgEnableSidebarCache = false;
2344 * Expiry time for the sidebar cache, in seconds
2346 $wgSidebarCacheExpiry = 86400;
2349 * When using the file cache, we can store the cached HTML gzipped to save disk
2350 * space. Pages will then also be served compressed to clients that support it.
2352 * Requires zlib support enabled in PHP.
2354 $wgUseGzip = false;
2357 * Whether MediaWiki should send an ETag header. Seems to cause
2358 * broken behavior with Squid 2.6, see bug 7098.
2360 $wgUseETag = false;
2363 * Clock skew or the one-second resolution of time() can occasionally cause cache
2364 * problems when the user requests two pages within a short period of time. This
2365 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2366 * a grace period.
2368 $wgClockSkewFudge = 5;
2371 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2372 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2373 * was previously done in the default LocalSettings.php file.
2375 * On high-traffic wikis, this should be set to false, to avoid the need to
2376 * check the file modification time, and to avoid the performance impact of
2377 * unnecessary cache invalidations.
2379 $wgInvalidateCacheOnLocalSettingsChange = true;
2382 * When loading extensions through the extension registration system, this
2383 * can be used to invalidate the cache. A good idea would be to set this to
2384 * one file, you can just `touch` that one to invalidate the cache
2386 * @par Example:
2387 * @code
2388 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2389 * @endcode
2391 * If set to false, the mtime for each individual JSON file will be checked,
2392 * which can be slow if a large number of extensions are being loaded.
2394 * @var int|bool
2396 $wgExtensionInfoMTime = false;
2398 /** @} */ # end of cache settings
2400 /************************************************************************//**
2401 * @name HTTP proxy (Squid) settings
2403 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2404 * although they are referred to as Squid settings for historical reasons.
2406 * Achieving a high hit ratio with an HTTP proxy requires special
2407 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2408 * more details.
2410 * @{
2414 * Enable/disable Squid.
2415 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2417 $wgUseSquid = false;
2420 * If you run Squid3 with ESI support, enable this (default:false):
2422 $wgUseESI = false;
2425 * Send X-Vary-Options header for better caching (requires patched Squid)
2427 $wgUseXVO = false;
2430 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2431 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2432 * and need to split the cache between HTTP and HTTPS for API requests,
2433 * feed requests and HTTP redirect responses in order to prevent cache
2434 * pollution. This does not affect 'normal' requests to index.php other than
2435 * HTTP redirects.
2437 $wgVaryOnXFP = false;
2440 * Internal server name as known to Squid, if different.
2442 * @par Example:
2443 * @code
2444 * $wgInternalServer = 'http://yourinternal.tld:8000';
2445 * @endcode
2447 $wgInternalServer = false;
2450 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2451 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2452 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2453 * days
2455 $wgSquidMaxage = 18000;
2458 * Default maximum age for raw CSS/JS accesses
2460 $wgForcedRawSMaxage = 300;
2463 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2465 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2466 * headers sent/modified from these proxies when obtaining the remote IP address
2468 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2470 $wgSquidServers = array();
2473 * As above, except these servers aren't purged on page changes; use to set a
2474 * list of trusted proxies, etc. Supports both individual IP addresses and
2475 * CIDR blocks.
2476 * @since 1.23 Supports CIDR ranges
2478 $wgSquidServersNoPurge = array();
2481 * Maximum number of titles to purge in any one client operation
2483 $wgMaxSquidPurgeTitles = 400;
2486 * Whether to use a Host header in purge requests sent to the proxy servers
2487 * configured in $wgSquidServers. Set this to false to support Squid
2488 * configured in forward-proxy mode.
2490 * If this is set to true, a Host header will be sent, and only the path
2491 * component of the URL will appear on the request line, as if the request
2492 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2493 * request. Squid supports this style of request only if reverse-proxy mode
2494 * (http_port ... accel) is enabled.
2496 * If this is set to false, no Host header will be sent, and the absolute URL
2497 * will be sent in the request line, as is the standard for an HTTP proxy
2498 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2499 * by Varnish, but is supported by Squid in either configuration (forward or
2500 * reverse).
2502 * @since 1.21
2504 $wgSquidPurgeUseHostHeader = true;
2507 * Routing configuration for HTCP multicast purging. Add elements here to
2508 * enable HTCP and determine which purges are sent where. If set to an empty
2509 * array, HTCP is disabled.
2511 * Each key in this array is a regular expression to match against the purged
2512 * URL, or an empty string to match all URLs. The purged URL is matched against
2513 * the regexes in the order specified, and the first rule whose regex matches
2514 * is used, all remaining rules will thus be ignored.
2516 * @par Example configuration to send purges for upload.wikimedia.org to one
2517 * multicast group and all other purges to another:
2518 * @code
2519 * $wgHTCPRouting = array(
2520 * '|^https?://upload\.wikimedia\.org|' => array(
2521 * 'host' => '239.128.0.113',
2522 * 'port' => 4827,
2523 * ),
2524 * '' => array(
2525 * 'host' => '239.128.0.112',
2526 * 'port' => 4827,
2527 * ),
2528 * );
2529 * @endcode
2531 * You can also pass an array of hosts to send purges too. This is useful when
2532 * you have several multicast groups or unicast address that should receive a
2533 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2535 * @par Example of sending purges to multiple hosts:
2536 * @code
2537 * $wgHTCPRouting = array(
2538 * '' => array(
2539 * // Purges to text caches using multicast
2540 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2541 * // Purges to a hardcoded list of caches
2542 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2543 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2544 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2545 * ),
2546 * );
2547 * @endcode
2549 * @since 1.22
2551 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2552 * For back compatibility purposes, whenever its array is empty
2553 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2555 * @see $wgHTCPMulticastTTL
2557 $wgHTCPRouting = array();
2560 * HTCP multicast TTL.
2561 * @see $wgHTCPRouting
2563 $wgHTCPMulticastTTL = 1;
2566 * Should forwarded Private IPs be accepted?
2568 $wgUsePrivateIPs = false;
2570 /** @} */ # end of HTTP proxy settings
2572 /************************************************************************//**
2573 * @name Language, regional and character encoding settings
2574 * @{
2578 * Site language code. See languages/Names.php for languages supported by
2579 * MediaWiki out of the box. Not all languages listed there have translations,
2580 * see languages/messages/ for the list of languages with some localisation.
2582 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2583 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2585 * This defines the default interface language for all users, but users can
2586 * change it in their preferences.
2588 * This also defines the language of pages in the wiki. The content is wrapped
2589 * in a html element with lang=XX attribute. This behavior can be overridden
2590 * via hooks, see Title::getPageLanguage.
2592 $wgLanguageCode = 'en';
2595 * Language cache size, or really how many languages can we handle
2596 * simultaneously without degrading to crawl speed.
2598 $wgLangObjCacheSize = 10;
2601 * Some languages need different word forms, usually for different cases.
2602 * Used in Language::convertGrammar().
2604 * @par Example:
2605 * @code
2606 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2607 * @endcode
2609 $wgGrammarForms = array();
2612 * Treat language links as magic connectors, not inline links
2614 $wgInterwikiMagic = true;
2617 * Hide interlanguage links from the sidebar
2619 $wgHideInterlanguageLinks = false;
2622 * List of additional interwiki prefixes that should be treated as
2623 * interlanguage links (i.e. placed in the sidebar).
2624 * Notes:
2625 * - This will not do anything unless the prefixes are defined in the interwiki
2626 * map.
2627 * - The display text for these custom interlanguage links will be fetched from
2628 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2629 * this array.
2630 * - A friendly name for each site, used for tooltip text, may optionally be
2631 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2632 * the prefix in this array.
2634 $wgExtraInterlanguageLinkPrefixes = array();
2637 * List of language names or overrides for default names in Names.php
2639 $wgExtraLanguageNames = array();
2642 * List of language codes that don't correspond to an actual language.
2643 * These codes are mostly left-offs from renames, or other legacy things.
2644 * This array makes them not appear as a selectable language on the installer,
2645 * and excludes them when running the transstat.php script.
2647 $wgDummyLanguageCodes = array(
2648 'als' => 'gsw',
2649 'bat-smg' => 'sgs',
2650 'be-x-old' => 'be-tarask',
2651 'bh' => 'bho',
2652 'fiu-vro' => 'vro',
2653 'no' => 'nb',
2654 'qqq' => 'qqq', # Used for message documentation.
2655 'qqx' => 'qqx', # Used for viewing message keys.
2656 'roa-rup' => 'rup',
2657 'simple' => 'en',
2658 'zh-classical' => 'lzh',
2659 'zh-min-nan' => 'nan',
2660 'zh-yue' => 'yue',
2664 * Character set for use in the article edit box. Language-specific encodings
2665 * may be defined.
2667 * This historic feature is one of the first that was added by former MediaWiki
2668 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2670 $wgEditEncoding = '';
2673 * Set this to true to replace Arabic presentation forms with their standard
2674 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2675 * set to "ar".
2677 * Note that pages with titles containing presentation forms will become
2678 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2680 $wgFixArabicUnicode = true;
2683 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2684 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2685 * set to "ml". Note that some clients (even new clients as of 2010) do not
2686 * support these characters.
2688 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2689 * fix any ZWJ sequences in existing page titles.
2691 $wgFixMalayalamUnicode = true;
2694 * Set this to always convert certain Unicode sequences to modern ones
2695 * regardless of the content language. This has a small performance
2696 * impact.
2698 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2699 * details.
2701 * @since 1.17
2703 $wgAllUnicodeFixes = false;
2706 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2707 * loading old revisions not marked with "utf-8" flag. Use this when
2708 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2709 * burdensome mass conversion of old text data.
2711 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2712 * user names, etc still must be converted en masse in the database before
2713 * continuing as a UTF-8 wiki.
2715 $wgLegacyEncoding = false;
2718 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2719 * regexps : "/regexp/" matching problematic browsers. These browsers will
2720 * be served encoded unicode in the edit box instead of real unicode.
2722 $wgBrowserBlackList = array(
2724 * Netscape 2-4 detection
2725 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2726 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2727 * with a negative assertion. The [UIN] identifier specifies the level of security
2728 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2729 * The language string is unreliable, it is missing on NS4 Mac.
2731 * Reference: http://www.psychedelix.com/agents/index.shtml
2733 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2734 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2735 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2738 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2739 * Þ to <THORN> and Ð to <ETH>
2741 * Known useragents:
2742 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2743 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2744 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2745 * - [...]
2747 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2748 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2750 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2753 * Google wireless transcoder, seems to eat a lot of chars alive
2754 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2756 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2760 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2761 * create stub reference rows in the text table instead of copying
2762 * the full text of all current entries from 'cur' to 'text'.
2764 * This will speed up the conversion step for large sites, but
2765 * requires that the cur table be kept around for those revisions
2766 * to remain viewable.
2768 * This option affects the updaters *only*. Any present cur stub
2769 * revisions will be readable at runtime regardless of this setting.
2771 $wgLegacySchemaConversion = false;
2774 * Enable dates like 'May 12' instead of '12 May', if the default date format
2775 * is 'dmy or mdy'.
2777 $wgAmericanDates = false;
2780 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2781 * numerals in interface.
2783 $wgTranslateNumerals = true;
2786 * Translation using MediaWiki: namespace.
2787 * Interface messages will be loaded from the database.
2789 $wgUseDatabaseMessages = true;
2792 * Expiry time for the message cache key
2794 $wgMsgCacheExpiry = 86400;
2797 * Maximum entry size in the message cache, in bytes
2799 $wgMaxMsgCacheEntrySize = 10000;
2802 * Whether to enable language variant conversion.
2804 $wgDisableLangConversion = false;
2807 * Whether to enable language variant conversion for links.
2809 $wgDisableTitleConversion = false;
2812 * Default variant code, if false, the default will be the language code
2814 $wgDefaultLanguageVariant = false;
2817 * Disabled variants array of language variant conversion.
2819 * @par Example:
2820 * @code
2821 * $wgDisabledVariants[] = 'zh-mo';
2822 * $wgDisabledVariants[] = 'zh-my';
2823 * @endcode
2825 $wgDisabledVariants = array();
2828 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2829 * path format that describes which parts of the URL contain the
2830 * language variant.
2832 * @par Example:
2833 * @code
2834 * $wgLanguageCode = 'sr';
2835 * $wgVariantArticlePath = '/$2/$1';
2836 * $wgArticlePath = '/wiki/$1';
2837 * @endcode
2839 * A link to /wiki/ would be redirected to /sr/Главна_страна
2841 * It is important that $wgArticlePath not overlap with possible values
2842 * of $wgVariantArticlePath.
2844 $wgVariantArticlePath = false;
2847 * Show a bar of language selection links in the user login and user
2848 * registration forms; edit the "loginlanguagelinks" message to
2849 * customise these.
2851 $wgLoginLanguageSelector = false;
2854 * When translating messages with wfMessage(), it is not always clear what
2855 * should be considered UI messages and what should be content messages.
2857 * For example, for the English Wikipedia, there should be only one 'mainpage',
2858 * so when getting the link for 'mainpage', we should treat it as site content
2859 * and call ->inContentLanguage()->text(), but for rendering the text of the
2860 * link, we call ->text(). The code behaves this way by default. However,
2861 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2862 * and the like for different languages. This array provides a way to override
2863 * the default behavior.
2865 * @par Example:
2866 * To allow language-specific main page and community
2867 * portal:
2868 * @code
2869 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2870 * @endcode
2872 $wgForceUIMsgAsContentMsg = array();
2875 * Fake out the timezone that the server thinks it's in. This will be used for
2876 * date display and not for what's stored in the DB. Leave to null to retain
2877 * your server's OS-based timezone value.
2879 * This variable is currently used only for signature formatting and for local
2880 * time/date parser variables ({{LOCALTIME}} etc.)
2882 * Timezones can be translated by editing MediaWiki messages of type
2883 * timezone-nameinlowercase like timezone-utc.
2885 * A list of usable timezones can found at:
2886 * http://php.net/manual/en/timezones.php
2888 * @par Examples:
2889 * @code
2890 * $wgLocaltimezone = 'UTC';
2891 * $wgLocaltimezone = 'GMT';
2892 * $wgLocaltimezone = 'PST8PDT';
2893 * $wgLocaltimezone = 'Europe/Sweden';
2894 * $wgLocaltimezone = 'CET';
2895 * @endcode
2897 $wgLocaltimezone = null;
2900 * Set an offset from UTC in minutes to use for the default timezone setting
2901 * for anonymous users and new user accounts.
2903 * This setting is used for most date/time displays in the software, and is
2904 * overridable in user preferences. It is *not* used for signature timestamps.
2906 * By default, this will be set to match $wgLocaltimezone.
2908 $wgLocalTZoffset = null;
2910 /** @} */ # End of language/charset settings
2912 /*************************************************************************//**
2913 * @name Output format and skin settings
2914 * @{
2918 * The default Content-Type header.
2920 $wgMimeType = 'text/html';
2923 * Previously used as content type in HTML script tags. This is now ignored since
2924 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2925 * It was also previously used by RawAction to determine the ctype query parameter
2926 * value that will result in a javascript response.
2927 * @deprecated since 1.22
2929 $wgJsMimeType = null;
2932 * The default xmlns attribute. The option to define this has been removed.
2933 * The value of this variable is no longer used by core and is set to a fixed
2934 * value in Setup.php for compatibility with extensions that depend on the value
2935 * of this variable being set. Such a dependency however is deprecated.
2936 * @deprecated since 1.22
2938 $wgXhtmlDefaultNamespace = null;
2941 * Previously used to determine if we should output an HTML5 doctype.
2942 * This is no longer used as we always output HTML5 now. For compatibility with
2943 * extensions that still check the value of this config it's value is now forced
2944 * to true by Setup.php.
2945 * @deprecated since 1.22
2947 $wgHtml5 = true;
2950 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2951 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2952 * (like if it's left at the default null value), it will be auto-initialized
2953 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2954 * ever actually set this to anything.
2956 $wgHtml5Version = null;
2959 * Temporary variable that allows HTMLForms to be rendered as tables.
2960 * Table based layouts cause various issues when designing for mobile.
2961 * This global allows skins or extensions a means to force non-table based rendering.
2962 * Setting to false forces form components to always render as div elements.
2963 * @since 1.24
2965 $wgHTMLFormAllowTableFormat = true;
2968 * Temporary variable that applies MediaWiki UI wherever it can be supported.
2969 * Temporary variable that should be removed when mediawiki ui is more
2970 * stable and change has been communicated.
2971 * @since 1.24
2973 $wgUseMediaWikiUIEverywhere = false;
2976 * Enabled RDFa attributes for use in wikitext.
2977 * NOTE: Interaction with HTML5 is somewhat underspecified.
2979 $wgAllowRdfaAttributes = false;
2982 * Enabled HTML5 microdata attributes for use in wikitext.
2984 $wgAllowMicrodataAttributes = false;
2987 * Should we try to make our HTML output well-formed XML? If set to false,
2988 * output will be a few bytes shorter, and the HTML will arguably be more
2989 * readable. If set to true, life will be much easier for the authors of
2990 * screen-scraping bots, and the HTML will arguably be more readable.
2992 * Setting this to false may omit quotation marks on some attributes, omit
2993 * slashes from some self-closing tags, omit some ending tags, etc., where
2994 * permitted by HTML5. Setting it to true will not guarantee that all pages
2995 * will be well-formed, although non-well-formed pages should be rare and it's
2996 * a bug if you find one. Conversely, setting it to false doesn't mean that
2997 * all XML-y constructs will be omitted, just that they might be.
2999 * Because of compatibility with screen-scraping bots, and because it's
3000 * controversial, this is currently left to true by default.
3002 $wgWellFormedXml = true;
3005 * Permit other namespaces in addition to the w3.org default.
3007 * Use the prefix for the key and the namespace for the value.
3009 * @par Example:
3010 * @code
3011 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3012 * @endcode
3013 * Normally we wouldn't have to define this in the root "<html>"
3014 * element, but IE needs it there in some circumstances.
3016 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3018 $wgXhtmlNamespaces = array();
3021 * Show IP address, for non-logged in users. It's necessary to switch this off
3022 * for some forms of caching.
3023 * @warning Will disable file cache.
3025 $wgShowIPinHeader = true;
3028 * Site notice shown at the top of each page
3030 * MediaWiki:Sitenotice page, which will override this. You can also
3031 * provide a separate message for logged-out users using the
3032 * MediaWiki:Anonnotice page.
3034 $wgSiteNotice = '';
3037 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3039 $wgSiteSupportPage = '';
3042 * Validate the overall output using tidy and refuse
3043 * to display the page if it's not valid.
3045 $wgValidateAllHtml = false;
3048 * Default skin, for new users and anonymous visitors. Registered users may
3049 * change this to any one of the other available skins in their preferences.
3051 $wgDefaultSkin = 'vector';
3054 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3056 * @since 1.24
3058 $wgFallbackSkin = 'fallback';
3061 * Specify the names of skins that should not be presented in the list of
3062 * available skins in user preferences. If you want to remove a skin entirely,
3063 * remove it from the skins/ directory and its entry from LocalSettings.php.
3065 $wgSkipSkins = array();
3068 * @deprecated since 1.23; use $wgSkipSkins instead
3070 $wgSkipSkin = '';
3073 * Allow user Javascript page?
3074 * This enables a lot of neat customizations, but may
3075 * increase security risk to users and server load.
3077 $wgAllowUserJs = false;
3080 * Allow user Cascading Style Sheets (CSS)?
3081 * This enables a lot of neat customizations, but may
3082 * increase security risk to users and server load.
3084 $wgAllowUserCss = false;
3087 * Allow user-preferences implemented in CSS?
3088 * This allows users to customise the site appearance to a greater
3089 * degree; disabling it will improve page load times.
3091 $wgAllowUserCssPrefs = true;
3094 * Use the site's Javascript page?
3096 $wgUseSiteJs = true;
3099 * Use the site's Cascading Style Sheets (CSS)?
3101 $wgUseSiteCss = true;
3104 * Break out of framesets. This can be used to prevent clickjacking attacks,
3105 * or to prevent external sites from framing your site with ads.
3107 $wgBreakFrames = false;
3110 * The X-Frame-Options header to send on pages sensitive to clickjacking
3111 * attacks, such as edit pages. This prevents those pages from being displayed
3112 * in a frame or iframe. The options are:
3114 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3116 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3117 * to allow framing within a trusted domain. This is insecure if there
3118 * is a page on the same domain which allows framing of arbitrary URLs.
3120 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3121 * full compromise of local user accounts. Private wikis behind a
3122 * corporate firewall are especially vulnerable. This is not
3123 * recommended.
3125 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3126 * not just edit pages.
3128 $wgEditPageFrameOptions = 'DENY';
3131 * Disallow framing of API pages directly, by setting the X-Frame-Options
3132 * header. Since the API returns CSRF tokens, allowing the results to be
3133 * framed can compromise your user's account security.
3134 * Options are:
3135 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3136 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3137 * - false: Allow all framing.
3138 * Note: $wgBreakFrames will override this for human formatted API output.
3140 $wgApiFrameOptions = 'DENY';
3143 * Disable output compression (enabled by default if zlib is available)
3145 $wgDisableOutputCompression = false;
3148 * Should we allow a broader set of characters in id attributes, per HTML5? If
3149 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3150 * functionality is ready, it will be on by default with no option.
3152 * Currently this appears to work fine in all browsers, but it's disabled by
3153 * default because it normalizes id's a bit too aggressively, breaking preexisting
3154 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3156 $wgExperimentalHtmlIds = false;
3159 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3160 * You can add new icons to the built in copyright or poweredby, or you can create
3161 * a new block. Though note that you may need to add some custom css to get good styling
3162 * of new blocks in monobook. vector and modern should work without any special css.
3164 * $wgFooterIcons itself is a key/value array.
3165 * The key is the name of a block that the icons will be wrapped in. The final id varies
3166 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3167 * turns it into mw_poweredby.
3168 * The value is either key/value array of icons or a string.
3169 * In the key/value array the key may or may not be used by the skin but it can
3170 * be used to find the icon and unset it or change the icon if needed.
3171 * This is useful for disabling icons that are set by extensions.
3172 * The value should be either a string or an array. If it is a string it will be output
3173 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3174 * for the icon, the following keys are used:
3175 * - src: An absolute url to the image to use for the icon, this is recommended
3176 * but not required, however some skins will ignore icons without an image
3177 * - srcset: optional additional-resolution images; see HTML5 specs
3178 * - url: The url to use in the a element around the text or icon, if not set an a element will
3179 * not be outputted
3180 * - alt: This is the text form of the icon, it will be displayed without an image in
3181 * skins like Modern or if src is not set, and will otherwise be used as
3182 * the alt="" for the image. This key is required.
3183 * - width and height: If the icon specified by src is not of the standard size
3184 * you can specify the size of image to use with these keys.
3185 * Otherwise they will default to the standard 88x31.
3186 * @todo Reformat documentation.
3188 $wgFooterIcons = array(
3189 "copyright" => array(
3190 "copyright" => array(), // placeholder for the built in copyright icon
3192 "poweredby" => array(
3193 "mediawiki" => array(
3194 // Defaults to point at
3195 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3196 // plus srcset for 1.5x, 2x resolution variants.
3197 "src" => null,
3198 "url" => "//www.mediawiki.org/",
3199 "alt" => "Powered by MediaWiki",
3205 * Login / create account link behavior when it's possible for anonymous users
3206 * to create an account.
3207 * - true = use a combined login / create account link
3208 * - false = split login and create account into two separate links
3210 $wgUseCombinedLoginLink = false;
3213 * Display user edit counts in various prominent places.
3215 $wgEdititis = false;
3218 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3219 * status code, mangling or hiding MediaWiki's output. If you are using such a
3220 * host, you should start looking for a better one. While you're doing that,
3221 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3222 * that the generated error pages can be seen.
3224 * In cases where for technical reasons it is more important for MediaWiki to
3225 * send the correct status code than for the body to be transmitted intact,
3226 * this configuration variable is ignored.
3228 $wgSend404Code = true;
3231 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3232 * rollback. The numeric value of the variable are the limit up to are counted.
3233 * If the value is false or 0, the edits are not counted. Disabling this will
3234 * furthermore prevent MediaWiki from hiding some useless rollback links.
3236 * @since 1.20
3238 $wgShowRollbackEditCount = 10;
3241 * Output a <link rel="canonical"> tag on every page indicating the canonical
3242 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3243 * detection of the current server is unreliable, the link is sent
3244 * unconditionally.
3246 $wgEnableCanonicalServerLink = false;
3249 * When OutputHandler is used, mangle any output that contains
3250 * <cross-domain-policy>. Without this, an attacker can send their own
3251 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3252 * the domain root.
3254 * @since 1.25
3256 $wgMangleFlashPolicy = true;
3258 /** @} */ # End of output format settings }
3260 /*************************************************************************//**
3261 * @name Resource loader settings
3262 * @{
3266 * Client-side resource modules.
3268 * Extensions should add their resource loader module definitions
3269 * to the $wgResourceModules variable.
3271 * @par Example:
3272 * @code
3273 * $wgResourceModules['ext.myExtension'] = array(
3274 * 'scripts' => 'myExtension.js',
3275 * 'styles' => 'myExtension.css',
3276 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3277 * 'localBasePath' => __DIR__,
3278 * 'remoteExtPath' => 'MyExtension',
3279 * );
3280 * @endcode
3282 $wgResourceModules = array();
3285 * Skin-specific styles for resource modules.
3287 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3288 * not be modified or disabled.
3290 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3292 * @par Example:
3293 * @code
3294 * $wgResourceModules['bar'] = array(
3295 * 'scripts' => 'resources/bar/bar.js',
3296 * 'styles' => 'resources/bar/main.css',
3297 * );
3299 * $wgResourceModuleSkinStyles['foo'] = array(
3300 * 'bar' => 'skins/Foo/bar.css',
3301 * );
3302 * @endcode
3304 * This is mostly equivalent to:
3306 * @par Equivalent:
3307 * @code
3308 * $wgResourceModules['bar'] = array(
3309 * 'scripts' => 'resources/bar/bar.js',
3310 * 'styles' => 'resources/bar/main.css',
3311 * 'skinStyles' => array(
3312 * 'foo' => skins/Foo/bar.css',
3313 * ),
3314 * );
3315 * @endcode
3317 * If the module already defines its own entry in `skinStyles` for a given skin, then
3318 * $wgResourceModuleSkinStyles is ignored.
3320 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3321 * of replacing them. This can be done using the `+` prefix.
3323 * @par Example:
3324 * @code
3325 * $wgResourceModules['bar'] = array(
3326 * 'scripts' => 'resources/bar/bar.js',
3327 * 'styles' => 'resources/bar/basic.css',
3328 * 'skinStyles' => array(
3329 * 'default' => 'resources/bar/additional.css',
3330 * ),
3331 * );
3332 * // Note the '+' character:
3333 * $wgResourceModuleSkinStyles['foo'] = array(
3334 * '+bar' => 'skins/Foo/bar.css',
3335 * );
3336 * @endcode
3338 * This is mostly equivalent to:
3340 * @par Equivalent:
3341 * @code
3342 * $wgResourceModules['bar'] = array(
3343 * 'scripts' => 'resources/bar/bar.js',
3344 * 'styles' => 'resources/bar/basic.css',
3345 * 'skinStyles' => array(
3346 * 'default' => 'resources/bar/additional.css',
3347 * 'foo' => array(
3348 * 'resources/bar/additional.css',
3349 * 'skins/Foo/bar.css',
3350 * ),
3351 * ),
3352 * );
3353 * @endcode
3355 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3356 * disabled by a skin. To provide default styles that may be extended or replaced,
3357 * use `skinStyles['default']`.
3359 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3360 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3361 * Either for all skin styles at once (first example below) or for each module separately (second
3362 * example).
3364 * @par Example:
3365 * @code
3366 * $wgResourceModuleSkinStyles['foo'] = array(
3367 * 'bar' => 'bar.css',
3368 * 'quux' => 'quux.css',
3369 * 'remoteSkinPath' => 'Foo',
3370 * 'localBasePath' => __DIR__,
3371 * );
3373 * $wgResourceModuleSkinStyles['foo'] = array(
3374 * 'bar' => array(
3375 * 'bar.css',
3376 * 'remoteSkinPath' => 'Foo',
3377 * 'localBasePath' => __DIR__,
3378 * ),
3379 * 'quux' => array(
3380 * 'quux.css',
3381 * 'remoteSkinPath' => 'Foo',
3382 * 'localBasePath' => __DIR__,
3383 * ),
3384 * );
3385 * @endcode
3387 $wgResourceModuleSkinStyles = array();
3390 * Extensions should register foreign module sources here. 'local' is a
3391 * built-in source that is not in this array, but defined by
3392 * ResourceLoader::__construct() so that it cannot be unset.
3394 * @par Example:
3395 * @code
3396 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3397 * @endcode
3399 $wgResourceLoaderSources = array();
3402 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3403 * If not set, then $wgScriptPath will be used as a fallback.
3405 $wgResourceBasePath = null;
3408 * Maximum time in seconds to cache resources served by the resource loader.
3409 * Used to set last modified headers (max-age/s-maxage).
3411 * Following options to distinguish:
3412 * - versioned: Used for modules with a version, because changing version
3413 * numbers causes cache misses. This normally has a long expiry time.
3414 * - unversioned: Used for modules without a version to propagate changes
3415 * quickly to clients. Also used for modules with errors to recover quickly.
3416 * This normally has a short expiry time.
3418 * Expiry time for the options to distinguish:
3419 * - server: Squid/Varnish but also any other public proxy cache between the
3420 * client and MediaWiki.
3421 * - client: On the client side (e.g. in the browser cache).
3423 $wgResourceLoaderMaxage = array(
3424 'versioned' => array(
3425 'server' => 30 * 24 * 60 * 60, // 30 days
3426 'client' => 30 * 24 * 60 * 60, // 30 days
3428 'unversioned' => array(
3429 'server' => 5 * 60, // 5 minutes
3430 'client' => 5 * 60, // 5 minutes
3435 * The default debug mode (on/off) for of ResourceLoader requests.
3437 * This will still be overridden when the debug URL parameter is used.
3439 $wgResourceLoaderDebug = false;
3442 * Enable embedding of certain resources using Edge Side Includes. This will
3443 * improve performance but only works if there is something in front of the
3444 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3446 $wgResourceLoaderUseESI = false;
3449 * Put each statement on its own line when minifying JavaScript. This makes
3450 * debugging in non-debug mode a bit easier.
3452 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3455 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3456 * the minifier will try not to produce lines longer than this, but may be
3457 * forced to do so in certain cases.
3459 $wgResourceLoaderMinifierMaxLineLength = 1000;
3462 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3463 * dependencies.
3465 $wgIncludeLegacyJavaScript = true;
3468 * Whether to preload the mediawiki.util module as blocking module in the top
3469 * queue.
3471 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3472 * allowed modules to lack dependencies on 'popular' modules that were likely
3473 * loaded already.
3475 * This setting is to aid scripts during migration by providing mediawiki.util
3476 * unconditionally (which was the most commonly missed dependency).
3477 * It doesn't cover all missing dependencies obviously but should fix most of
3478 * them.
3480 * This should be removed at some point after site/user scripts have been fixed.
3481 * Enable this if your wiki has a large amount of user/site scripts that are
3482 * lacking dependencies.
3483 * @todo Deprecate
3485 $wgPreloadJavaScriptMwUtil = false;
3488 * Whether or not to assign configuration variables to the global window object.
3490 * If this is set to false, old code using deprecated variables will no longer
3491 * work.
3493 * @par Example of legacy code:
3494 * @code{,js}
3495 * if ( window.wgRestrictionEdit ) { ... }
3496 * @endcode
3497 * or:
3498 * @code{,js}
3499 * if ( wgIsArticle ) { ... }
3500 * @endcode
3502 * Instead, one needs to use mw.config.
3503 * @par Example using mw.config global configuration:
3504 * @code{,js}
3505 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3506 * @endcode
3507 * or:
3508 * @code{,js}
3509 * if ( mw.config.get('wgIsArticle') ) { ... }
3510 * @endcode
3512 $wgLegacyJavaScriptGlobals = true;
3515 * If set to a positive number, ResourceLoader will not generate URLs whose
3516 * query string is more than this many characters long, and will instead use
3517 * multiple requests with shorter query strings. This degrades performance,
3518 * but may be needed if your web server has a low (less than, say 1024)
3519 * query string length limit or a low value for suhosin.get.max_value_length
3520 * that you can't increase.
3522 * If set to a negative number, ResourceLoader will assume there is no query
3523 * string length limit.
3525 * Defaults to a value based on php configuration.
3527 $wgResourceLoaderMaxQueryLength = false;
3530 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3531 * prior to minification to validate it.
3533 * Parse errors will result in a JS exception being thrown during module load,
3534 * which avoids breaking other modules loaded in the same request.
3536 $wgResourceLoaderValidateJS = true;
3539 * If set to true, statically-sourced (file-backed) JavaScript resources will
3540 * be parsed for validity before being bundled up into ResourceLoader modules.
3542 * This can be helpful for development by providing better error messages in
3543 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3544 * and may fail on large pre-bundled frameworks.
3546 $wgResourceLoaderValidateStaticJS = false;
3549 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3550 * will be enabled. This is an experimental feature that's supposed to make
3551 * JavaScript load faster.
3553 $wgResourceLoaderExperimentalAsyncLoading = false;
3556 * Global LESS variables. An associative array binding variable names to
3557 * LESS code snippets representing their values.
3559 * Adding an item here is equivalent to writing `@variable: value;`
3560 * at the beginning of all your .less files, with all the consequences.
3561 * In particular, string values must be escaped and quoted.
3563 * Changes to LESS variables do not trigger cache invalidation.
3565 * If the LESS variables need to be dynamic, you can use the
3566 * ResourceLoaderGetLessVars hook (since 1.25).
3568 * @par Example:
3569 * @code
3570 * $wgResourceLoaderLESSVars = array(
3571 * 'baseFontSize' => '1em',
3572 * 'smallFontSize' => '0.75em',
3573 * 'WikimediaBlue' => '#006699',
3574 * );
3575 * @endcode
3576 * @since 1.22
3578 $wgResourceLoaderLESSVars = array();
3581 * Custom LESS functions. An associative array mapping function name to PHP
3582 * callable.
3584 * Changes to LESS functions do not trigger cache invalidation.
3586 * @since 1.22
3587 * @deprecated since 1.24 Questionable usefulness and problematic to support,
3588 * will be removed in the future.
3590 $wgResourceLoaderLESSFunctions = array();
3593 * Default import paths for LESS modules. LESS files referenced in @import
3594 * statements will be looked up here first, and relative to the importing file
3595 * second. To avoid collisions, it's important for the LESS files in these
3596 * directories to have a common, predictable file name prefix.
3598 * Extensions need not (and should not) register paths in
3599 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3600 * currently compiling LESS file, which allows each extension to freely import
3601 * files from its own tree.
3603 * @since 1.22
3605 $wgResourceLoaderLESSImportPaths = array(
3606 "$IP/resources/src/mediawiki.less/",
3610 * Whether ResourceLoader should attempt to persist modules in localStorage on
3611 * browsers that support the Web Storage API.
3613 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3615 $wgResourceLoaderStorageEnabled = false;
3618 * Cache version for client-side ResourceLoader module storage. You can trigger
3619 * invalidation of the contents of the module store by incrementing this value.
3621 * @since 1.23
3623 $wgResourceLoaderStorageVersion = 1;
3626 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3627 * restricted pages like Special:UserLogin or Special:Preferences where
3628 * JavaScript is disabled for security reasons. As it is possible to
3629 * execute JavaScript through CSS, setting this to true opens up a
3630 * potential security hole. Some sites may "skin" their wiki by using
3631 * site-wide CSS, causing restricted pages to look unstyled and different
3632 * from the rest of the site.
3634 * @since 1.25
3636 $wgAllowSiteCSSOnRestrictedPages = false;
3638 /** @} */ # End of resource loader settings }
3640 /*************************************************************************//**
3641 * @name Page title and interwiki link settings
3642 * @{
3646 * Name of the project namespace. If left set to false, $wgSitename will be
3647 * used instead.
3649 $wgMetaNamespace = false;
3652 * Name of the project talk namespace.
3654 * Normally you can ignore this and it will be something like
3655 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3656 * manually for grammatical reasons.
3658 $wgMetaNamespaceTalk = false;
3661 * Additional namespaces. If the namespaces defined in Language.php and
3662 * Namespace.php are insufficient, you can create new ones here, for example,
3663 * to import Help files in other languages. You can also override the namespace
3664 * names of existing namespaces. Extensions developers should use
3665 * $wgCanonicalNamespaceNames.
3667 * @warning Once you delete a namespace, the pages in that namespace will
3668 * no longer be accessible. If you rename it, then you can access them through
3669 * the new namespace name.
3671 * Custom namespaces should start at 100 to avoid conflicting with standard
3672 * namespaces, and should always follow the even/odd main/talk pattern.
3674 * @par Example:
3675 * @code
3676 * $wgExtraNamespaces = array(
3677 * 100 => "Hilfe",
3678 * 101 => "Hilfe_Diskussion",
3679 * 102 => "Aide",
3680 * 103 => "Discussion_Aide"
3681 * );
3682 * @endcode
3684 * @todo Add a note about maintenance/namespaceDupes.php
3686 $wgExtraNamespaces = array();
3689 * Same as above, but for namespaces with gender distinction.
3690 * Note: the default form for the namespace should also be set
3691 * using $wgExtraNamespaces for the same index.
3692 * @since 1.18
3694 $wgExtraGenderNamespaces = array();
3697 * Namespace aliases.
3699 * These are alternate names for the primary localised namespace names, which
3700 * are defined by $wgExtraNamespaces and the language file. If a page is
3701 * requested with such a prefix, the request will be redirected to the primary
3702 * name.
3704 * Set this to a map from namespace names to IDs.
3706 * @par Example:
3707 * @code
3708 * $wgNamespaceAliases = array(
3709 * 'Wikipedian' => NS_USER,
3710 * 'Help' => 100,
3711 * );
3712 * @endcode
3714 $wgNamespaceAliases = array();
3717 * Allowed title characters -- regex character class
3718 * Don't change this unless you know what you're doing
3720 * Problematic punctuation:
3721 * - []{}|# Are needed for link syntax, never enable these
3722 * - <> Causes problems with HTML escaping, don't use
3723 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3724 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3725 * corrupted by apache
3726 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3728 * All three of these punctuation problems can be avoided by using an alias,
3729 * instead of a rewrite rule of either variety.
3731 * The problem with % is that when using a path to query rewrite rule, URLs are
3732 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3733 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3734 * for this, indeed double escaping would break if the double-escaped title was
3735 * passed in the query string rather than the path. This is a minor security issue
3736 * because articles can be created such that they are hard to view or edit.
3738 * In some rare cases you may wish to remove + for compatibility with old links.
3740 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3741 * this breaks interlanguage links
3743 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3746 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3748 * @deprecated since 1.23; use $wgLocalInterwikis instead
3750 $wgLocalInterwiki = false;
3753 * Array for multiple $wgLocalInterwiki values, in case there are several
3754 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3755 * set, its value is prepended to this array, for backwards compatibility.
3757 * Note, recent changes feeds use only the first entry in this array (or
3758 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3760 $wgLocalInterwikis = array();
3763 * Expiry time for cache of interwiki table
3765 $wgInterwikiExpiry = 10800;
3768 * @name Interwiki caching settings.
3769 * @{
3773 *$wgInterwikiCache specifies path to constant database file.
3775 * This cdb database is generated by dumpInterwiki from maintenance and has
3776 * such key formats:
3777 * - dbname:key - a simple key (e.g. enwiki:meta)
3778 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3779 * - __global:key - global-scope key (e.g. __global:meta)
3780 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3782 * Sites mapping just specifies site name, other keys provide "local url"
3783 * data layout.
3785 $wgInterwikiCache = false;
3788 * Specify number of domains to check for messages.
3789 * - 1: Just wiki(db)-level
3790 * - 2: wiki and global levels
3791 * - 3: site levels
3793 $wgInterwikiScopes = 3;
3796 * Fallback site, if unable to resolve from cache
3798 $wgInterwikiFallbackSite = 'wiki';
3800 /** @} */ # end of Interwiki caching settings.
3803 * @name SiteStore caching settings.
3804 * @{
3808 * Specify the file location for the Sites json cache file.
3810 $wgSitesCacheFile = false;
3812 /** @} */ # end of SiteStore caching settings.
3815 * If local interwikis are set up which allow redirects,
3816 * set this regexp to restrict URLs which will be displayed
3817 * as 'redirected from' links.
3819 * @par Example:
3820 * It might look something like this:
3821 * @code
3822 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3823 * @endcode
3825 * Leave at false to avoid displaying any incoming redirect markers.
3826 * This does not affect intra-wiki redirects, which don't change
3827 * the URL.
3829 $wgRedirectSources = false;
3832 * Set this to false to avoid forcing the first letter of links to capitals.
3834 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3835 * appearing with a capital at the beginning of a sentence will *not* go to the
3836 * same place as links in the middle of a sentence using a lowercase initial.
3838 $wgCapitalLinks = true;
3841 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3842 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3843 * true by default (and setting them has no effect), due to various things that
3844 * require them to be so. Also, since Talk namespaces need to directly mirror their
3845 * associated content namespaces, the values for those are ignored in favor of the
3846 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3847 * NS_FILE.
3849 * @par Example:
3850 * @code
3851 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3852 * @endcode
3854 $wgCapitalLinkOverrides = array();
3857 * Which namespaces should support subpages?
3858 * See Language.php for a list of namespaces.
3860 $wgNamespacesWithSubpages = array(
3861 NS_TALK => true,
3862 NS_USER => true,
3863 NS_USER_TALK => true,
3864 NS_PROJECT => true,
3865 NS_PROJECT_TALK => true,
3866 NS_FILE_TALK => true,
3867 NS_MEDIAWIKI => true,
3868 NS_MEDIAWIKI_TALK => true,
3869 NS_TEMPLATE_TALK => true,
3870 NS_HELP => true,
3871 NS_HELP_TALK => true,
3872 NS_CATEGORY_TALK => true
3876 * Array holding default tracking category names.
3878 * Array contains the system messages for each tracking category.
3879 * Tracking categories allow pages with certain characteristics to be tracked.
3880 * It works by adding any such page to a category automatically.
3882 * A message with the suffix '-desc' should be added as a description message
3883 * to have extra information on Special:TrackingCategories.
3885 * @deprecated since 1.25 Extensions should now register tracking categories using
3886 * the new extension registration system.
3888 * @since 1.23
3890 $wgTrackingCategories = array();
3893 * Array of namespaces which can be deemed to contain valid "content", as far
3894 * as the site statistics are concerned. Useful if additional namespaces also
3895 * contain "content" which should be considered when generating a count of the
3896 * number of articles in the wiki.
3898 $wgContentNamespaces = array( NS_MAIN );
3901 * Max number of redirects to follow when resolving redirects.
3902 * 1 means only the first redirect is followed (default behavior).
3903 * 0 or less means no redirects are followed.
3905 $wgMaxRedirects = 1;
3908 * Array of invalid page redirect targets.
3909 * Attempting to create a redirect to any of the pages in this array
3910 * will make the redirect fail.
3911 * Userlogout is hard-coded, so it does not need to be listed here.
3912 * (bug 10569) Disallow Mypage and Mytalk as well.
3914 * As of now, this only checks special pages. Redirects to pages in
3915 * other namespaces cannot be invalidated by this variable.
3917 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3919 /** @} */ # End of title and interwiki settings }
3921 /************************************************************************//**
3922 * @name Parser settings
3923 * These settings configure the transformation from wikitext to HTML.
3924 * @{
3928 * Parser configuration. Associative array with the following members:
3930 * class The class name
3932 * preprocessorClass The preprocessor class. Two classes are currently available:
3933 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3934 * storage, and Preprocessor_DOM, which uses the DOM module for
3935 * temporary storage. Preprocessor_DOM generally uses less memory;
3936 * the speed of the two is roughly the same.
3938 * If this parameter is not given, it uses Preprocessor_DOM if the
3939 * DOM module is available, otherwise it uses Preprocessor_Hash.
3941 * The entire associative array will be passed through to the constructor as
3942 * the first parameter. Note that only Setup.php can use this variable --
3943 * the configuration will change at runtime via $wgParser member functions, so
3944 * the contents of this variable will be out-of-date. The variable can only be
3945 * changed during LocalSettings.php, in particular, it can't be changed during
3946 * an extension setup function.
3948 $wgParserConf = array(
3949 'class' => 'Parser',
3950 #'preprocessorClass' => 'Preprocessor_Hash',
3954 * Maximum indent level of toc.
3956 $wgMaxTocLevel = 999;
3959 * A complexity limit on template expansion: the maximum number of nodes visited
3960 * by PPFrame::expand()
3962 $wgMaxPPNodeCount = 1000000;
3965 * A complexity limit on template expansion: the maximum number of elements
3966 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3967 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3968 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3969 * this default corresponds to about 155 MB.
3971 * When the limit is exceeded, an exception is thrown.
3973 $wgMaxGeneratedPPNodeCount = 1000000;
3976 * Maximum recursion depth for templates within templates.
3977 * The current parser adds two levels to the PHP call stack for each template,
3978 * and xdebug limits the call stack to 100 by default. So this should hopefully
3979 * stop the parser before it hits the xdebug limit.
3981 $wgMaxTemplateDepth = 40;
3984 * @see $wgMaxTemplateDepth
3986 $wgMaxPPExpandDepth = 40;
3989 * URL schemes that should be recognized as valid by wfParseUrl().
3991 * WARNING: Do not add 'file:' to this or internal file links will be broken.
3992 * Instead, if you want to support file links, add 'file://'. The same applies
3993 * to any other protocols with the same name as a namespace. See bug #44011 for
3994 * more information.
3996 * @see wfParseUrl
3998 $wgUrlProtocols = array(
3999 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4000 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4001 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4002 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4006 * If true, removes (substitutes) templates in "~~~~" signatures.
4008 $wgCleanSignatures = true;
4011 * Whether to allow inline image pointing to other websites
4013 $wgAllowExternalImages = false;
4016 * If the above is false, you can specify an exception here. Image URLs
4017 * that start with this string are then rendered, while all others are not.
4018 * You can use this to set up a trusted, simple repository of images.
4019 * You may also specify an array of strings to allow multiple sites
4021 * @par Examples:
4022 * @code
4023 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4024 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4025 * @endcode
4027 $wgAllowExternalImagesFrom = '';
4030 * If $wgAllowExternalImages is false, you can allow an on-wiki
4031 * whitelist of regular expression fragments to match the image URL
4032 * against. If the image matches one of the regular expression fragments,
4033 * The image will be displayed.
4035 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4036 * Or false to disable it
4038 $wgEnableImageWhitelist = true;
4041 * A different approach to the above: simply allow the "<img>" tag to be used.
4042 * This allows you to specify alt text and other attributes, copy-paste HTML to
4043 * your wiki more easily, etc. However, allowing external images in any manner
4044 * will allow anyone with editing rights to snoop on your visitors' IP
4045 * addresses and so forth, if they wanted to, by inserting links to images on
4046 * sites they control.
4048 $wgAllowImageTag = false;
4051 * $wgUseTidy: use tidy to make sure HTML output is sane.
4052 * Tidy is a free tool that fixes broken HTML.
4053 * See http://www.w3.org/People/Raggett/tidy/
4055 * - $wgTidyBin should be set to the path of the binary and
4056 * - $wgTidyConf to the path of the configuration file.
4057 * - $wgTidyOpts can include any number of parameters.
4058 * - $wgTidyInternal controls the use of the PECL extension or the
4059 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
4060 * of spawning a separate program.
4061 * Normally you shouldn't need to override the setting except for
4062 * debugging. To install, use 'pear install tidy' and add a line
4063 * 'extension=tidy.so' to php.ini.
4065 $wgUseTidy = false;
4068 * @see $wgUseTidy
4070 $wgAlwaysUseTidy = false;
4073 * @see $wgUseTidy
4075 $wgTidyBin = 'tidy';
4078 * @see $wgUseTidy
4080 $wgTidyConf = $IP . '/includes/tidy.conf';
4083 * @see $wgUseTidy
4085 $wgTidyOpts = '';
4088 * @see $wgUseTidy
4090 $wgTidyInternal = extension_loaded( 'tidy' );
4093 * Put tidy warnings in HTML comments
4094 * Only works for internal tidy.
4096 $wgDebugTidy = false;
4099 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4100 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4101 * TO RESTRICT EDITING to only those that you trust
4103 $wgRawHtml = false;
4106 * Set a default target for external links, e.g. _blank to pop up a new window
4108 $wgExternalLinkTarget = false;
4111 * If true, external URL links in wiki text will be given the
4112 * rel="nofollow" attribute as a hint to search engines that
4113 * they should not be followed for ranking purposes as they
4114 * are user-supplied and thus subject to spamming.
4116 $wgNoFollowLinks = true;
4119 * Namespaces in which $wgNoFollowLinks doesn't apply.
4120 * See Language.php for a list of namespaces.
4122 $wgNoFollowNsExceptions = array();
4125 * If this is set to an array of domains, external links to these domain names
4126 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4127 * value of $wgNoFollowLinks. For instance:
4129 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4130 * 'mediawiki.org' );
4132 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4133 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4134 * etc.
4136 * Defaults to mediawiki.org for the links included in the software by default.
4138 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4141 * Allow DISPLAYTITLE to change title display
4143 $wgAllowDisplayTitle = true;
4146 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4147 * canonical DB key. Also disallow some inline CSS rules like display: none;
4148 * which can cause the text to be hidden or unselectable.
4150 $wgRestrictDisplayTitle = true;
4153 * Maximum number of calls per parse to expensive parser functions such as
4154 * PAGESINCATEGORY.
4156 $wgExpensiveParserFunctionLimit = 100;
4159 * Preprocessor caching threshold
4160 * Setting it to 'false' will disable the preprocessor cache.
4162 $wgPreprocessorCacheThreshold = 1000;
4165 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4167 $wgEnableScaryTranscluding = false;
4170 * Expiry time for transcluded templates cached in transcache database table.
4171 * Only used $wgEnableInterwikiTranscluding is set to true.
4173 $wgTranscludeCacheExpiry = 3600;
4175 /** @} */ # end of parser settings }
4177 /************************************************************************//**
4178 * @name Statistics
4179 * @{
4183 * Method used to determine if a page in a content namespace should be counted
4184 * as a valid article.
4186 * Redirect pages will never be counted as valid articles.
4188 * This variable can have the following values:
4189 * - 'any': all pages as considered as valid articles
4190 * - 'comma': the page must contain a comma to be considered valid
4191 * - 'link': the page must contain a [[wiki link]] to be considered valid
4193 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4195 * Retroactively changing this variable will not affect the existing count,
4196 * to update it, you will need to run the maintenance/updateArticleCount.php
4197 * script.
4199 $wgArticleCountMethod = 'link';
4202 * How many days user must be idle before he is considered inactive. Will affect
4203 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4204 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4205 * You might want to leave this as the default value, to provide comparable
4206 * numbers between different wikis.
4208 $wgActiveUserDays = 30;
4210 /** @} */ # End of statistics }
4212 /************************************************************************//**
4213 * @name User accounts, authentication
4214 * @{
4218 * For compatibility with old installations set to false
4219 * @deprecated since 1.24 will be removed in future
4221 $wgPasswordSalt = true;
4224 * Specifies the minimal length of a user password. If set to 0, empty pass-
4225 * words are allowed.
4227 $wgMinimalPasswordLength = 1;
4230 * Specifies if users should be sent to a password-reset form on login, if their
4231 * password doesn't meet the requirements of User::isValidPassword().
4232 * @since 1.23
4234 $wgInvalidPasswordReset = true;
4237 * Default password type to use when hashing user passwords
4239 * @since 1.24
4241 $wgPasswordDefault = 'pbkdf2';
4244 * Configuration for built-in password types. Maps the password type
4245 * to an array of options. The 'class' option is the Password class to
4246 * use. All other options are class-dependent.
4248 * An advanced example:
4249 * @code
4250 * $wgPasswordConfig['bcrypt-peppered'] = array(
4251 * 'class' => 'EncryptedPassword',
4252 * 'underlying' => 'bcrypt',
4253 * 'secrets' => array(),
4254 * 'cipher' => MCRYPT_RIJNDAEL_256,
4255 * 'mode' => MCRYPT_MODE_CBC,
4256 * 'cost' => 5,
4257 * );
4258 * @endcode
4260 * @since 1.24
4262 $wgPasswordConfig = array(
4263 'A' => array(
4264 'class' => 'MWOldPassword',
4266 'B' => array(
4267 'class' => 'MWSaltedPassword',
4269 'pbkdf2-legacyA' => array(
4270 'class' => 'LayeredParameterizedPassword',
4271 'types' => array(
4272 'A',
4273 'pbkdf2',
4276 'pbkdf2-legacyB' => array(
4277 'class' => 'LayeredParameterizedPassword',
4278 'types' => array(
4279 'B',
4280 'pbkdf2',
4283 'bcrypt' => array(
4284 'class' => 'BcryptPassword',
4285 'cost' => 9,
4287 'pbkdf2' => array(
4288 'class' => 'Pbkdf2Password',
4289 'algo' => 'sha256',
4290 'cost' => '10000',
4291 'length' => '128',
4296 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4297 * with a temporary password you can use to get back into the account") identified by
4298 * various bits of data. Setting all of these to false (or the whole variable to false)
4299 * has the effect of disabling password resets entirely
4301 $wgPasswordResetRoutes = array(
4302 'username' => true,
4303 'email' => false,
4307 * Maximum number of Unicode characters in signature
4309 $wgMaxSigChars = 255;
4312 * Maximum number of bytes in username. You want to run the maintenance
4313 * script ./maintenance/checkUsernames.php once you have changed this value.
4315 $wgMaxNameChars = 255;
4318 * Array of usernames which may not be registered or logged in from
4319 * Maintenance scripts can still use these
4321 $wgReservedUsernames = array(
4322 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4323 'Conversion script', // Used for the old Wikipedia software upgrade
4324 'Maintenance script', // Maintenance scripts which perform editing, image import script
4325 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4326 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4327 'msg:double-redirect-fixer', // Automatic double redirect fix
4328 'msg:usermessage-editor', // Default user for leaving user messages
4329 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4333 * Settings added to this array will override the default globals for the user
4334 * preferences used by anonymous visitors and newly created accounts.
4335 * For instance, to disable editing on double clicks:
4336 * $wgDefaultUserOptions ['editondblclick'] = 0;
4338 $wgDefaultUserOptions = array(
4339 'ccmeonemails' => 0,
4340 'cols' => 80,
4341 'date' => 'default',
4342 'diffonly' => 0,
4343 'disablemail' => 0,
4344 'editfont' => 'default',
4345 'editondblclick' => 0,
4346 'editsectiononrightclick' => 0,
4347 'enotifminoredits' => 0,
4348 'enotifrevealaddr' => 0,
4349 'enotifusertalkpages' => 1,
4350 'enotifwatchlistpages' => 1,
4351 'extendwatchlist' => 1,
4352 'fancysig' => 0,
4353 'forceeditsummary' => 0,
4354 'gender' => 'unknown',
4355 'hideminor' => 0,
4356 'hidepatrolled' => 0,
4357 'imagesize' => 2,
4358 'math' => 1,
4359 'minordefault' => 0,
4360 'newpageshidepatrolled' => 0,
4361 'nickname' => '',
4362 'norollbackdiff' => 0,
4363 'numberheadings' => 0,
4364 'previewonfirst' => 0,
4365 'previewontop' => 1,
4366 'rcdays' => 7,
4367 'rclimit' => 50,
4368 'rows' => 25,
4369 'showhiddencats' => 0,
4370 'shownumberswatching' => 1,
4371 'showtoolbar' => 1,
4372 'skin' => false,
4373 'stubthreshold' => 0,
4374 'thumbsize' => 5,
4375 'underline' => 2,
4376 'uselivepreview' => 0,
4377 'usenewrc' => 1,
4378 'watchcreations' => 1,
4379 'watchdefault' => 1,
4380 'watchdeletion' => 0,
4381 'watchlistdays' => 3.0,
4382 'watchlisthideanons' => 0,
4383 'watchlisthidebots' => 0,
4384 'watchlisthideliu' => 0,
4385 'watchlisthideminor' => 0,
4386 'watchlisthideown' => 0,
4387 'watchlisthidepatrolled' => 0,
4388 'watchmoves' => 0,
4389 'watchrollback' => 0,
4390 'wllimit' => 250,
4391 'useeditwarning' => 1,
4392 'prefershttps' => 1,
4396 * An array of preferences to not show for the user
4398 $wgHiddenPrefs = array();
4401 * Characters to prevent during new account creations.
4402 * This is used in a regular expression character class during
4403 * registration (regex metacharacters like / are escaped).
4405 $wgInvalidUsernameCharacters = '@';
4408 * Character used as a delimiter when testing for interwiki userrights
4409 * (In Special:UserRights, it is possible to modify users on different
4410 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4412 * It is recommended that you have this delimiter in
4413 * $wgInvalidUsernameCharacters above, or you will not be able to
4414 * modify the user rights of those users via Special:UserRights
4416 $wgUserrightsInterwikiDelimiter = '@';
4419 * This is to let user authenticate using https when they come from http.
4420 * Based on an idea by George Herbert on wikitech-l:
4421 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4422 * @since 1.17
4424 $wgSecureLogin = false;
4426 /** @} */ # end user accounts }
4428 /************************************************************************//**
4429 * @name User rights, access control and monitoring
4430 * @{
4434 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4436 $wgAutoblockExpiry = 86400;
4439 * Set this to true to allow blocked users to edit their own user talk page.
4441 $wgBlockAllowsUTEdit = false;
4444 * Allow sysops to ban users from accessing Emailuser
4446 $wgSysopEmailBans = true;
4449 * Limits on the possible sizes of range blocks.
4451 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4452 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4453 * half the number of bits avoids such errors, and allows entire ISPs to be
4454 * blocked using a small number of range blocks.
4456 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4457 * customer, so range blocks larger than /64 (half the number of bits) will
4458 * plainly be required. RFC 4692 implies that a very large ISP may be
4459 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4460 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4462 $wgBlockCIDRLimit = array(
4463 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4464 'IPv6' => 19,
4468 * If true, blocked users will not be allowed to login. When using this with
4469 * a public wiki, the effect of logging out blocked users may actually be
4470 * avers: unless the user's address is also blocked (e.g. auto-block),
4471 * logging the user out will again allow reading and editing, just as for
4472 * anonymous visitors.
4474 $wgBlockDisablesLogin = false;
4477 * Pages anonymous user may see, set as an array of pages titles.
4479 * @par Example:
4480 * @code
4481 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4482 * @endcode
4484 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4486 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4487 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4489 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4490 * will remain readable. You can use img_auth.php to protect uploaded files,
4491 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4493 $wgWhitelistRead = false;
4496 * Pages anonymous user may see, set as an array of regular expressions.
4498 * This function will match the regexp against the title name, which
4499 * is without underscore.
4501 * @par Example:
4502 * To whitelist [[Main Page]]:
4503 * @code
4504 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4505 * @endcode
4507 * @note Unless ^ and/or $ is specified, a regular expression might match
4508 * pages not intended to be whitelisted. The above example will also
4509 * whitelist a page named 'Security Main Page'.
4511 * @par Example:
4512 * To allow reading any page starting with 'User' regardless of the case:
4513 * @code
4514 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4515 * @endcode
4516 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4518 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4519 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4521 $wgWhitelistReadRegexp = false;
4524 * Should editors be required to have a validated e-mail
4525 * address before being allowed to edit?
4527 $wgEmailConfirmToEdit = false;
4530 * Permission keys given to users in each group.
4532 * This is an array where the keys are all groups and each value is an
4533 * array of the format (right => boolean).
4535 * The second format is used to support per-namespace permissions.
4536 * Note that this feature does not fully work for all permission types.
4538 * All users are implicitly in the '*' group including anonymous visitors;
4539 * logged-in users are all implicitly in the 'user' group. These will be
4540 * combined with the permissions of all groups that a given user is listed
4541 * in in the user_groups table.
4543 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4544 * doing! This will wipe all permissions, and may mean that your users are
4545 * unable to perform certain essential tasks or access new functionality
4546 * when new permissions are introduced and default grants established.
4548 * Functionality to make pages inaccessible has not been extensively tested
4549 * for security. Use at your own risk!
4551 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4553 $wgGroupPermissions = array();
4555 /** @cond file_level_code */
4556 // Implicit group for all visitors
4557 $wgGroupPermissions['*']['createaccount'] = true;
4558 $wgGroupPermissions['*']['read'] = true;
4559 $wgGroupPermissions['*']['edit'] = true;
4560 $wgGroupPermissions['*']['createpage'] = true;
4561 $wgGroupPermissions['*']['createtalk'] = true;
4562 $wgGroupPermissions['*']['writeapi'] = true;
4563 $wgGroupPermissions['*']['editmyusercss'] = true;
4564 $wgGroupPermissions['*']['editmyuserjs'] = true;
4565 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4566 $wgGroupPermissions['*']['editmywatchlist'] = true;
4567 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4568 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4569 $wgGroupPermissions['*']['editmyoptions'] = true;
4570 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4572 // Implicit group for all logged-in accounts
4573 $wgGroupPermissions['user']['move'] = true;
4574 $wgGroupPermissions['user']['move-subpages'] = true;
4575 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4576 $wgGroupPermissions['user']['move-categorypages'] = true;
4577 $wgGroupPermissions['user']['movefile'] = true;
4578 $wgGroupPermissions['user']['read'] = true;
4579 $wgGroupPermissions['user']['edit'] = true;
4580 $wgGroupPermissions['user']['createpage'] = true;
4581 $wgGroupPermissions['user']['createtalk'] = true;
4582 $wgGroupPermissions['user']['writeapi'] = true;
4583 $wgGroupPermissions['user']['upload'] = true;
4584 $wgGroupPermissions['user']['reupload'] = true;
4585 $wgGroupPermissions['user']['reupload-shared'] = true;
4586 $wgGroupPermissions['user']['minoredit'] = true;
4587 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4588 $wgGroupPermissions['user']['sendemail'] = true;
4590 // Implicit group for accounts that pass $wgAutoConfirmAge
4591 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4592 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4594 // Users with bot privilege can have their edits hidden
4595 // from various log pages by default
4596 $wgGroupPermissions['bot']['bot'] = true;
4597 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4598 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4599 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4600 $wgGroupPermissions['bot']['autopatrol'] = true;
4601 $wgGroupPermissions['bot']['suppressredirect'] = true;
4602 $wgGroupPermissions['bot']['apihighlimits'] = true;
4603 $wgGroupPermissions['bot']['writeapi'] = true;
4605 // Most extra permission abilities go to this group
4606 $wgGroupPermissions['sysop']['block'] = true;
4607 $wgGroupPermissions['sysop']['createaccount'] = true;
4608 $wgGroupPermissions['sysop']['delete'] = true;
4609 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4610 $wgGroupPermissions['sysop']['bigdelete'] = true;
4611 // can view deleted history entries, but not see or restore the text
4612 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4613 // can view deleted revision text
4614 $wgGroupPermissions['sysop']['deletedtext'] = true;
4615 $wgGroupPermissions['sysop']['undelete'] = true;
4616 $wgGroupPermissions['sysop']['editinterface'] = true;
4617 $wgGroupPermissions['sysop']['editusercss'] = true;
4618 $wgGroupPermissions['sysop']['edituserjs'] = true;
4619 $wgGroupPermissions['sysop']['import'] = true;
4620 $wgGroupPermissions['sysop']['importupload'] = true;
4621 $wgGroupPermissions['sysop']['move'] = true;
4622 $wgGroupPermissions['sysop']['move-subpages'] = true;
4623 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4624 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4625 $wgGroupPermissions['sysop']['patrol'] = true;
4626 $wgGroupPermissions['sysop']['autopatrol'] = true;
4627 $wgGroupPermissions['sysop']['protect'] = true;
4628 $wgGroupPermissions['sysop']['editprotected'] = true;
4629 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4630 $wgGroupPermissions['sysop']['rollback'] = true;
4631 $wgGroupPermissions['sysop']['upload'] = true;
4632 $wgGroupPermissions['sysop']['reupload'] = true;
4633 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4634 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4635 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4636 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4637 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4638 $wgGroupPermissions['sysop']['blockemail'] = true;
4639 $wgGroupPermissions['sysop']['markbotedits'] = true;
4640 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4641 $wgGroupPermissions['sysop']['browsearchive'] = true;
4642 $wgGroupPermissions['sysop']['noratelimit'] = true;
4643 $wgGroupPermissions['sysop']['movefile'] = true;
4644 $wgGroupPermissions['sysop']['unblockself'] = true;
4645 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4646 #$wgGroupPermissions['sysop']['pagelang'] = true;
4647 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4648 $wgGroupPermissions['sysop']['mergehistory'] = true;
4649 $wgGroupPermissions['sysop']['managechangetags'] = true;
4651 // Permission to change users' group assignments
4652 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4653 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4654 // Permission to change users' groups assignments across wikis
4655 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4656 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4657 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4659 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4660 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4661 // To hide usernames from users and Sysops
4662 #$wgGroupPermissions['suppress']['hideuser'] = true;
4663 // To hide revisions/log items from users and Sysops
4664 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4665 // To view revisions/log items hidden from users and Sysops
4666 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4667 // For private suppression log access
4668 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4671 * The developer group is deprecated, but can be activated if need be
4672 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4673 * that a lock file be defined and creatable/removable by the web
4674 * server.
4676 # $wgGroupPermissions['developer']['siteadmin'] = true;
4678 /** @endcond */
4681 * Permission keys revoked from users in each group.
4683 * This acts the same way as wgGroupPermissions above, except that
4684 * if the user is in a group here, the permission will be removed from them.
4686 * Improperly setting this could mean that your users will be unable to perform
4687 * certain essential tasks, so use at your own risk!
4689 $wgRevokePermissions = array();
4692 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4694 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4697 * A map of group names that the user is in, to group names that those users
4698 * are allowed to add or revoke.
4700 * Setting the list of groups to add or revoke to true is equivalent to "any
4701 * group".
4703 * @par Example:
4704 * To allow sysops to add themselves to the "bot" group:
4705 * @code
4706 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4707 * @endcode
4709 * @par Example:
4710 * Implicit groups may be used for the source group, for instance:
4711 * @code
4712 * $wgGroupsRemoveFromSelf = array( '*' => true );
4713 * @endcode
4714 * This allows users in the '*' group (i.e. any user) to remove themselves from
4715 * any group that they happen to be in.
4717 $wgGroupsAddToSelf = array();
4720 * @see $wgGroupsAddToSelf
4722 $wgGroupsRemoveFromSelf = array();
4725 * Set of available actions that can be restricted via action=protect
4726 * You probably shouldn't change this.
4727 * Translated through restriction-* messages.
4728 * Title::getRestrictionTypes() will remove restrictions that are not
4729 * applicable to a specific title (create and upload)
4731 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4734 * Rights which can be required for each protection level (via action=protect)
4736 * You can add a new protection level that requires a specific
4737 * permission by manipulating this array. The ordering of elements
4738 * dictates the order on the protection form's lists.
4740 * - '' will be ignored (i.e. unprotected)
4741 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4742 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4744 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4747 * Restriction levels that can be used with cascading protection
4749 * A page can only be protected with cascading protection if the
4750 * requested restriction level is included in this array.
4752 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4753 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4755 $wgCascadingRestrictionLevels = array( 'sysop' );
4758 * Restriction levels that should be considered "semiprotected"
4760 * Certain places in the interface recognize a dichotomy between "protected"
4761 * and "semiprotected", without further distinguishing the specific levels. In
4762 * general, if anyone can be eligible to edit a protection level merely by
4763 * reaching some condition in $wgAutopromote, it should probably be considered
4764 * "semiprotected".
4766 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4767 * 'sysop' is not changed, since it really shouldn't be here.
4769 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4772 * Set the minimum permissions required to edit pages in each
4773 * namespace. If you list more than one permission, a user must
4774 * have all of them to edit pages in that namespace.
4776 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4778 $wgNamespaceProtection = array();
4781 * Pages in namespaces in this array can not be used as templates.
4783 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4784 * namespaces constants (NS_USER, NS_MAIN...).
4786 * Among other things, this may be useful to enforce read-restrictions
4787 * which may otherwise be bypassed by using the template mechanism.
4789 $wgNonincludableNamespaces = array();
4792 * Number of seconds an account is required to age before it's given the
4793 * implicit 'autoconfirm' group membership. This can be used to limit
4794 * privileges of new accounts.
4796 * Accounts created by earlier versions of the software may not have a
4797 * recorded creation date, and will always be considered to pass the age test.
4799 * When left at 0, all registered accounts will pass.
4801 * @par Example:
4802 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4803 * @code
4804 * $wgAutoConfirmAge = 600; // ten minutes
4805 * @endcode
4806 * Set age to one day:
4807 * @code
4808 * $wgAutoConfirmAge = 3600*24; // one day
4809 * @endcode
4811 $wgAutoConfirmAge = 0;
4814 * Number of edits an account requires before it is autoconfirmed.
4815 * Passing both this AND the time requirement is needed. Example:
4817 * @par Example:
4818 * @code
4819 * $wgAutoConfirmCount = 50;
4820 * @endcode
4822 $wgAutoConfirmCount = 0;
4825 * Automatically add a usergroup to any user who matches certain conditions.
4827 * @todo Redocument $wgAutopromote
4829 * The format is
4830 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4831 * where cond1, cond2, ... are themselves conditions; *OR*
4832 * APCOND_EMAILCONFIRMED, *OR*
4833 * array( APCOND_EMAILCONFIRMED ), *OR*
4834 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4835 * array( APCOND_AGE, seconds since registration ), *OR*
4836 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4837 * array( APCOND_ISIP, ip ), *OR*
4838 * array( APCOND_IPINRANGE, range ), *OR*
4839 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4840 * array( APCOND_BLOCKED ), *OR*
4841 * array( APCOND_ISBOT ), *OR*
4842 * similar constructs defined by extensions.
4844 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4845 * user who has provided an e-mail address.
4847 $wgAutopromote = array(
4848 'autoconfirmed' => array( '&',
4849 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4850 array( APCOND_AGE, &$wgAutoConfirmAge ),
4855 * Automatically add a usergroup to any user who matches certain conditions.
4857 * Does not add the user to the group again if it has been removed.
4858 * Also, does not remove the group if the user no longer meets the criteria.
4860 * The format is:
4861 * @code
4862 * array( event => criteria, ... )
4863 * @endcode
4864 * Where event is either:
4865 * - 'onEdit' (when user edits)
4867 * Criteria has the same format as $wgAutopromote
4869 * @see $wgAutopromote
4870 * @since 1.18
4872 $wgAutopromoteOnce = array(
4873 'onEdit' => array(),
4877 * Put user rights log entries for autopromotion in recent changes?
4878 * @since 1.18
4880 $wgAutopromoteOnceLogInRC = true;
4883 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4884 * can assign which groups at Special:Userrights.
4886 * @par Example:
4887 * Bureaucrats can add any group:
4888 * @code
4889 * $wgAddGroups['bureaucrat'] = true;
4890 * @endcode
4891 * Bureaucrats can only remove bots and sysops:
4892 * @code
4893 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4894 * @endcode
4895 * Sysops can make bots:
4896 * @code
4897 * $wgAddGroups['sysop'] = array( 'bot' );
4898 * @endcode
4899 * Sysops can disable other sysops in an emergency, and disable bots:
4900 * @code
4901 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4902 * @endcode
4904 $wgAddGroups = array();
4907 * @see $wgAddGroups
4909 $wgRemoveGroups = array();
4912 * A list of available rights, in addition to the ones defined by the core.
4913 * For extensions only.
4915 $wgAvailableRights = array();
4918 * Optional to restrict deletion of pages with higher revision counts
4919 * to users with the 'bigdelete' permission. (Default given to sysops.)
4921 $wgDeleteRevisionsLimit = 0;
4924 * The maximum number of edits a user can have and
4925 * can still be hidden by users with the hideuser permission.
4926 * This is limited for performance reason.
4927 * Set to false to disable the limit.
4928 * @since 1.23
4930 $wgHideUserContribLimit = 1000;
4933 * Number of accounts each IP address may create, 0 to disable.
4935 * @warning Requires memcached
4937 $wgAccountCreationThrottle = 0;
4940 * Edits matching these regular expressions in body text
4941 * will be recognised as spam and rejected automatically.
4943 * There's no administrator override on-wiki, so be careful what you set. :)
4944 * May be an array of regexes or a single string for backwards compatibility.
4946 * @see http://en.wikipedia.org/wiki/Regular_expression
4948 * @note Each regex needs a beginning/end delimiter, eg: # or /
4950 $wgSpamRegex = array();
4953 * Same as the above except for edit summaries
4955 $wgSummarySpamRegex = array();
4958 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4959 * proxies
4960 * @since 1.16
4962 $wgEnableDnsBlacklist = false;
4965 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4967 * This is an array of either a URL or an array with the URL and a key (should
4968 * the blacklist require a key).
4970 * @par Example:
4971 * @code
4972 * $wgDnsBlacklistUrls = array(
4973 * // String containing URL
4974 * 'http.dnsbl.sorbs.net.',
4975 * // Array with URL and key, for services that require a key
4976 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4977 * // Array with just the URL. While this works, it is recommended that you
4978 * // just use a string as shown above
4979 * array( 'opm.tornevall.org.' )
4980 * );
4981 * @endcode
4983 * @note You should end the domain name with a . to avoid searching your
4984 * eventual domain search suffixes.
4985 * @since 1.16
4987 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4990 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4991 * what the other methods might say.
4993 $wgProxyWhitelist = array();
4996 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4997 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4998 * (transparent) proxies without needing to block the proxies themselves.
5000 $wgApplyIpBlocksToXff = false;
5003 * Simple rate limiter options to brake edit floods.
5005 * Maximum number actions allowed in the given number of seconds; after that
5006 * the violating client receives HTTP 500 error pages until the period
5007 * elapses.
5009 * @par Example:
5010 * To set a generic maximum of 4 hits in 60 seconds:
5011 * @code
5012 * $wgRateLimits = array( 4, 60 );
5013 * @endcode
5015 * You could also limit per action and then type of users. See the inline
5016 * code for a template to use.
5018 * This option set is experimental and likely to change.
5020 * @warning Requires memcached.
5022 $wgRateLimits = array(
5023 'edit' => array(
5024 'anon' => null, // for any and all anonymous edits (aggregate)
5025 'user' => null, // for each logged-in user
5026 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
5027 'ip' => null, // for each anon and recent account
5028 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
5030 'move' => array(
5031 'user' => null,
5032 'newbie' => null,
5033 'ip' => null,
5034 'subnet' => null,
5036 'mailpassword' => array( // triggering password resets emails
5037 'anon' => null,
5039 'emailuser' => array( // emailing other users using MediaWiki
5040 'user' => null,
5042 'linkpurge' => array( // purges of link tables
5043 'anon' => null,
5044 'user' => null,
5045 'newbie' => null,
5046 'ip' => null,
5047 'subnet' => null,
5049 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
5050 'anon' => null,
5051 'user' => null,
5052 'newbie' => null,
5053 'ip' => null,
5054 'subnet' => null,
5056 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
5057 'anon' => null,
5058 'user' => null,
5059 'newbie' => null,
5060 'ip' => null,
5061 'subnet' => null,
5063 'stashedit' => array( // stashing edits into cache before save
5064 'anon' => null,
5065 'user' => null,
5066 'newbie' => null,
5067 'ip' => null,
5068 'subnet' => null,
5073 * Set to a filename to log rate limiter hits.
5075 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
5077 $wgRateLimitLog = null;
5080 * Array of IPs which should be excluded from rate limits.
5081 * This may be useful for whitelisting NAT gateways for conferences, etc.
5083 $wgRateLimitsExcludedIPs = array();
5086 * Log IP addresses in the recentchanges table; can be accessed only by
5087 * extensions (e.g. CheckUser) or a DB admin
5088 * Used for retroactive autoblocks
5090 $wgPutIPinRC = true;
5093 * Integer defining default number of entries to show on
5094 * special pages which are query-pages such as Special:Whatlinkshere.
5096 $wgQueryPageDefaultLimit = 50;
5099 * Limit password attempts to X attempts per Y seconds per IP per account.
5101 * @warning Requires memcached.
5103 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5105 /** @} */ # end of user rights settings
5107 /************************************************************************//**
5108 * @name Proxy scanner settings
5109 * @{
5113 * This should always be customised in LocalSettings.php
5115 $wgSecretKey = false;
5118 * Big list of banned IP addresses.
5120 * This can have the following formats:
5121 * - An array of addresses, either in the values
5122 * or the keys (for backward compatibility)
5123 * - A string, in that case this is the path to a file
5124 * containing the list of IP addresses, one per line
5126 $wgProxyList = array();
5128 /** @} */ # end of proxy scanner settings
5130 /************************************************************************//**
5131 * @name Cookie settings
5132 * @{
5136 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5138 $wgCookieExpiration = 180 * 86400;
5141 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5142 * or ".any.subdomain.net"
5144 $wgCookieDomain = '';
5147 * Set this variable if you want to restrict cookies to a certain path within
5148 * the domain specified by $wgCookieDomain.
5150 $wgCookiePath = '/';
5153 * Whether the "secure" flag should be set on the cookie. This can be:
5154 * - true: Set secure flag
5155 * - false: Don't set secure flag
5156 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5158 $wgCookieSecure = 'detect';
5161 * By default, MediaWiki checks if the client supports cookies during the
5162 * login process, so that it can display an informative error message if
5163 * cookies are disabled. Set this to true if you want to disable this cookie
5164 * check.
5166 $wgDisableCookieCheck = false;
5169 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5170 * to a string to use a custom prefix. Setting it to false causes the database
5171 * name to be used as a prefix.
5173 $wgCookiePrefix = false;
5176 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5177 * in browsers that support this feature. This can mitigates some classes of
5178 * XSS attack.
5180 $wgCookieHttpOnly = true;
5183 * A list of cookies that vary the cache (for use by extensions)
5185 $wgCacheVaryCookies = array();
5188 * Override to customise the session name
5190 $wgSessionName = false;
5192 /** @} */ # end of cookie settings }
5194 /************************************************************************//**
5195 * @name LaTeX (mathematical formulas)
5196 * @{
5200 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5201 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5202 * (ImageMagick) installed and available in the PATH.
5203 * Please see math/README for more information.
5205 $wgUseTeX = false;
5207 /** @} */ # end LaTeX }
5209 /************************************************************************//**
5210 * @name Profiling, testing and debugging
5212 * To enable profiling, edit StartProfiler.php
5214 * @{
5218 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5219 * The debug log file should be not be publicly accessible if it is used, as it
5220 * may contain private data.
5222 $wgDebugLogFile = '';
5225 * Prefix for debug log lines
5227 $wgDebugLogPrefix = '';
5230 * If true, instead of redirecting, show a page with a link to the redirect
5231 * destination. This allows for the inspection of PHP error messages, and easy
5232 * resubmission of form data. For developer use only.
5234 $wgDebugRedirects = false;
5237 * If true, log debugging data from action=raw and load.php.
5238 * This is normally false to avoid overlapping debug entries due to gen=css
5239 * and gen=js requests.
5241 $wgDebugRawPage = false;
5244 * Send debug data to an HTML comment in the output.
5246 * This may occasionally be useful when supporting a non-technical end-user.
5247 * It's more secure than exposing the debug log file to the web, since the
5248 * output only contains private data for the current user. But it's not ideal
5249 * for development use since data is lost on fatal errors and redirects.
5251 $wgDebugComments = false;
5254 * Extensive database transaction state debugging
5256 * @since 1.20
5258 $wgDebugDBTransactions = false;
5261 * Write SQL queries to the debug log.
5263 * This setting is only used $wgLBFactoryConf['class'] is set to
5264 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5265 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5266 * connection to achieve the same functionality.
5268 $wgDebugDumpSql = false;
5271 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5272 * trimming.
5273 * @since 1.24
5275 $wgDebugDumpSqlLength = 500;
5278 * Map of string log group names to log destinations.
5280 * If set, wfDebugLog() output for that group will go to that file instead
5281 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5282 * in production.
5284 * Log destinations may be one of the following:
5285 * - false to completely remove from the output, including from $wgDebugLogFile.
5286 * - string values specifying a filename or URI.
5287 * - associative array with keys:
5288 * - 'destination' desired filename or URI.
5289 * - 'sample' an integer value, specifying a sampling factor (optional)
5290 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5291 * to log (optional, since 1.25)
5293 * @par Example:
5294 * @code
5295 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5296 * @endcode
5298 * @par Advanced example:
5299 * @code
5300 * $wgDebugLogGroups['memcached'] = array(
5301 * 'destination' => '/var/log/mediawiki/memcached.log',
5302 * 'sample' => 1000, // log 1 message out of every 1,000.
5303 * 'level' => \Psr\Log\LogLevel::WARNING
5304 * );
5305 * @endcode
5307 $wgDebugLogGroups = array();
5310 * Default service provider for creating Psr\Log\LoggerInterface instances.
5312 * The value should be an array suitable for use with
5313 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5314 * implement the MWLoggerSpi interface. See ObjectFactory for additional
5315 * details.
5317 * Alternately the MWLoggerFactory::registerProvider method can be called to
5318 * inject an MWLoggerSpi instance into MWLoggerFactory and bypass the use of
5319 * this configuration variable entirely.
5321 * @par To completely disable logging:
5322 * @code
5323 * $wgMWLoggerDefaultSpi = array( 'class' => 'MWLoggerNullSpi' );
5324 * @endcode
5326 * @since 1.25
5327 * @var array $wgMWLoggerDefaultSpi
5328 * @see MwLogger
5330 $wgMWLoggerDefaultSpi = array(
5331 'class' => 'MWLoggerLegacySpi',
5335 * Display debug data at the bottom of the main content area.
5337 * Useful for developers and technical users trying to working on a closed wiki.
5339 $wgShowDebug = false;
5342 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5343 * Since 1.19 also includes memory usage.
5345 $wgDebugTimestamps = false;
5348 * Print HTTP headers for every request in the debug information.
5350 $wgDebugPrintHttpHeaders = true;
5353 * Show the contents of $wgHooks in Special:Version
5355 $wgSpecialVersionShowHooks = false;
5358 * Whether to show "we're sorry, but there has been a database error" pages.
5359 * Displaying errors aids in debugging, but may display information useful
5360 * to an attacker.
5362 $wgShowSQLErrors = false;
5365 * If set to true, uncaught exceptions will print a complete stack trace
5366 * to output. This should only be used for debugging, as it may reveal
5367 * private information in function parameters due to PHP's backtrace
5368 * formatting.
5370 $wgShowExceptionDetails = false;
5373 * If true, show a backtrace for database errors
5375 * @note This setting only applies when connection errors and query errors are
5376 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5377 * including those in which an uncaught exception is thrown from within the
5378 * exception handler.
5380 $wgShowDBErrorBacktrace = false;
5383 * If true, send the exception backtrace to the error log
5385 $wgLogExceptionBacktrace = true;
5388 * Expose backend server host names through the API and various HTML comments
5390 $wgShowHostnames = false;
5393 * Override server hostname detection with a hardcoded value.
5394 * Should be a string, default false.
5395 * @since 1.20
5397 $wgOverrideHostname = false;
5400 * If set to true MediaWiki will throw notices for some possible error
5401 * conditions and for deprecated functions.
5403 $wgDevelopmentWarnings = false;
5406 * Release limitation to wfDeprecated warnings, if set to a release number
5407 * development warnings will not be generated for deprecations added in releases
5408 * after the limit.
5410 $wgDeprecationReleaseLimit = false;
5413 * Only record profiling info for pages that took longer than this
5415 $wgProfileLimit = 0.0;
5418 * Don't put non-profiling info into log file
5420 * @deprecated since 1.23, set the log file in
5421 * $wgDebugLogGroups['profileoutput'] instead.
5423 $wgProfileOnly = false;
5426 * If true, print a raw call tree instead of per-function report
5428 $wgProfileCallTree = false;
5431 * Should application server host be put into profiling table
5433 * @deprecated set $wgProfiler['perhost'] = true instead
5435 $wgProfilePerHost = null;
5438 * Host for UDP profiler.
5440 * The host should be running a daemon which can be obtained from MediaWiki
5441 * Git at:
5442 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5444 * @deprecated set $wgProfiler['udphost'] instead
5446 $wgUDPProfilerHost = null;
5449 * Port for UDP profiler.
5450 * @see $wgUDPProfilerHost
5452 * @deprecated set $wgProfiler['udpport'] instead
5454 $wgUDPProfilerPort = null;
5457 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5458 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5459 * arguments. You can use sprintf's argument numbering/swapping capability to
5460 * repeat, re-order or omit fields.
5462 * @see $wgStatsFormatString
5463 * @since 1.22
5465 * @deprecated set $wgProfiler['udpformat'] instead
5467 $wgUDPProfilerFormatString = null;
5470 * Destination for wfIncrStats() data...
5471 * 'cache' to go into the system cache, if enabled (memcached)
5472 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5473 * false to disable
5475 $wgStatsMethod = 'cache';
5478 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5479 * be aggregated over more than one wiki. The string will be used in place of
5480 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5481 * will be used.
5483 $wgAggregateStatsID = false;
5486 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5487 * formatted. Its value should be a format string suitable for a sprintf()
5488 * invocation with (id, count, key) arguments, where 'id' is either
5489 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5490 * is being incremented, and 'key' is the metric name.
5492 * @see $wgUDPProfilerFormatString
5493 * @see $wgAggregateStatsID
5494 * @since 1.22
5496 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5499 * InfoAction retrieves a list of transclusion links (both to and from).
5500 * This number puts a limit on that query in the case of highly transcluded
5501 * templates.
5503 $wgPageInfoTransclusionLimit = 50;
5506 * Set this to an integer to only do synchronous site_stats updates
5507 * one every *this many* updates. The other requests go into pending
5508 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5509 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5511 $wgSiteStatsAsyncFactor = false;
5514 * Parser test suite files to be run by parserTests.php when no specific
5515 * filename is passed to it.
5517 * Extensions may add their own tests to this array, or site-local tests
5518 * may be added via LocalSettings.php
5520 * Use full paths.
5522 $wgParserTestFiles = array(
5523 "$IP/tests/parser/parserTests.txt",
5524 "$IP/tests/parser/extraParserTests.txt"
5528 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5530 $wgEnableJavaScriptTest = false;
5533 * Overwrite the caching key prefix with custom value.
5534 * @since 1.19
5536 $wgCachePrefix = false;
5539 * Display the new debugging toolbar. This also enables profiling on database
5540 * queries and other useful output.
5541 * Will disable file cache.
5543 * @since 1.19
5545 $wgDebugToolbar = false;
5547 /** @} */ # end of profiling, testing and debugging }
5549 /************************************************************************//**
5550 * @name Search
5551 * @{
5555 * Set this to true to disable the full text search feature.
5557 $wgDisableTextSearch = false;
5560 * Set to true to have nicer highlighted text in search results,
5561 * by default off due to execution overhead
5563 $wgAdvancedSearchHighlighting = false;
5566 * Regexp to match word boundaries, defaults for non-CJK languages
5567 * should be empty for CJK since the words are not separate
5569 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5572 * Template for OpenSearch suggestions, defaults to API action=opensearch
5574 * Sites with heavy load would typically have these point to a custom
5575 * PHP wrapper to avoid firing up mediawiki for every keystroke
5577 * Placeholders: {searchTerms}
5579 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5581 $wgOpenSearchTemplate = false;
5584 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5586 * Sites with heavy load would typically have these point to a custom
5587 * PHP wrapper to avoid firing up mediawiki for every keystroke
5589 * Placeholders: {searchTerms}
5591 $wgOpenSearchTemplates = array(
5592 'application/x-suggestions+json' => false,
5593 'application/x-suggestions+xml' => false,
5597 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5598 * false if you've disabled scripts that use api?action=opensearch and
5599 * want reduce load caused by cached scripts still pulling suggestions.
5600 * It will let the API fallback by responding with an empty array.
5602 $wgEnableOpenSearchSuggest = true;
5605 * Integer defining default number of entries to show on
5606 * OpenSearch call.
5608 $wgOpenSearchDefaultLimit = 10;
5611 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
5613 $wgOpenSearchDescriptionLength = 100;
5616 * Expiry time for search suggestion responses
5618 $wgSearchSuggestCacheExpiry = 1200;
5621 * If you've disabled search semi-permanently, this also disables updates to the
5622 * table. If you ever re-enable, be sure to rebuild the search table.
5624 $wgDisableSearchUpdate = false;
5627 * List of namespaces which are searched by default.
5629 * @par Example:
5630 * @code
5631 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5632 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5633 * @endcode
5635 $wgNamespacesToBeSearchedDefault = array(
5636 NS_MAIN => true,
5640 * Disable the internal MySQL-based search, to allow it to be
5641 * implemented by an extension instead.
5643 $wgDisableInternalSearch = false;
5646 * Set this to a URL to forward search requests to some external location.
5647 * If the URL includes '$1', this will be replaced with the URL-encoded
5648 * search term.
5650 * @par Example:
5651 * To forward to Google you'd have something like:
5652 * @code
5653 * $wgSearchForwardUrl =
5654 * 'http://www.google.com/search?q=$1' .
5655 * '&domains=http://example.com' .
5656 * '&sitesearch=http://example.com' .
5657 * '&ie=utf-8&oe=utf-8';
5658 * @endcode
5660 $wgSearchForwardUrl = null;
5663 * Search form behavior.
5664 * - true = use Go & Search buttons
5665 * - false = use Go button & Advanced search link
5667 $wgUseTwoButtonsSearchForm = true;
5670 * Array of namespaces to generate a Google sitemap for when the
5671 * maintenance/generateSitemap.php script is run, or false if one is to be
5672 * generated for all namespaces.
5674 $wgSitemapNamespaces = false;
5677 * Custom namespace priorities for sitemaps. Setting this will allow you to
5678 * set custom priorities to namespaces when sitemaps are generated using the
5679 * maintenance/generateSitemap.php script.
5681 * This should be a map of namespace IDs to priority
5682 * @par Example:
5683 * @code
5684 * $wgSitemapNamespacesPriorities = array(
5685 * NS_USER => '0.9',
5686 * NS_HELP => '0.0',
5687 * );
5688 * @endcode
5690 $wgSitemapNamespacesPriorities = false;
5693 * If true, searches for IP addresses will be redirected to that IP's
5694 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5695 * [[Special:Contributions/1.2.3.4]]
5697 $wgEnableSearchContributorsByIP = true;
5699 /** @} */ # end of search settings
5701 /************************************************************************//**
5702 * @name Edit user interface
5703 * @{
5707 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5708 * fall back to the old behavior (no merging).
5710 $wgDiff3 = '/usr/bin/diff3';
5713 * Path to the GNU diff utility.
5715 $wgDiff = '/usr/bin/diff';
5718 * Which namespaces have special treatment where they should be preview-on-open
5719 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5720 * can specify namespaces of pages they have special treatment for
5722 $wgPreviewOnOpenNamespaces = array(
5723 NS_CATEGORY => true
5727 * Enable the UniversalEditButton for browsers that support it
5728 * (currently only Firefox with an extension)
5729 * See http://universaleditbutton.org for more background information
5731 $wgUniversalEditButton = true;
5734 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5735 * will try to automatically create one. This feature can be disabled by set-
5736 * ting this variable false.
5738 $wgUseAutomaticEditSummaries = true;
5740 /** @} */ # end edit UI }
5742 /************************************************************************//**
5743 * @name Maintenance
5744 * See also $wgSiteNotice
5745 * @{
5749 * @cond file_level_code
5750 * Set $wgCommandLineMode if it's not set already, to avoid notices
5752 if ( !isset( $wgCommandLineMode ) ) {
5753 $wgCommandLineMode = false;
5755 /** @endcond */
5758 * For colorized maintenance script output, is your terminal background dark ?
5760 $wgCommandLineDarkBg = false;
5763 * Set this to a string to put the wiki into read-only mode. The text will be
5764 * used as an explanation to users.
5766 * This prevents most write operations via the web interface. Cache updates may
5767 * still be possible. To prevent database writes completely, use the read_only
5768 * option in MySQL.
5770 $wgReadOnly = null;
5773 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5774 * Its contents will be shown to users as part of the read-only warning
5775 * message.
5777 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5779 $wgReadOnlyFile = false;
5782 * When you run the web-based upgrade utility, it will tell you what to set
5783 * this to in order to authorize the upgrade process. It will subsequently be
5784 * used as a password, to authorize further upgrades.
5786 * For security, do not set this to a guessable string. Use the value supplied
5787 * by the install/upgrade process. To cause the upgrader to generate a new key,
5788 * delete the old key from LocalSettings.php.
5790 $wgUpgradeKey = false;
5793 * Fully specified path to git binary
5795 $wgGitBin = '/usr/bin/git';
5798 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5800 * Key is a pattern passed to preg_match() and preg_replace(),
5801 * without the delimiters (which are #) and must match the whole URL.
5802 * The value is the replacement for the key (it can contain $1, etc.)
5803 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5804 * full SHA-1 of the HEAD revision.
5805 * %r will be replaced with a URL-encoded version of $1.
5807 * @since 1.20
5809 $wgGitRepositoryViewers = array(
5810 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5811 'https://git.wikimedia.org/tree/%r/%H',
5812 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5813 'https://git.wikimedia.org/tree/%r/%H',
5816 /** @} */ # End of maintenance }
5818 /************************************************************************//**
5819 * @name Recent changes, new pages, watchlist and history
5820 * @{
5824 * Recentchanges items are periodically purged; entries older than this many
5825 * seconds will go.
5826 * Default: 90 days = about three months
5828 $wgRCMaxAge = 90 * 24 * 3600;
5831 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5832 * higher than what will be stored. Note that this is disabled by default
5833 * because we sometimes do have RC data which is beyond the limit for some
5834 * reason, and some users may use the high numbers to display that data which
5835 * is still there.
5837 $wgRCFilterByAge = false;
5840 * List of Limits options to list in the Special:Recentchanges and
5841 * Special:Recentchangeslinked pages.
5843 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5846 * List of Days options to list in the Special:Recentchanges and
5847 * Special:Recentchangeslinked pages.
5849 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5852 * Destinations to which notifications about recent changes
5853 * should be sent.
5855 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5856 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5857 * specified server.
5858 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5860 * The common options are:
5861 * * 'uri' -- the address to which the notices are to be sent.
5862 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5863 * produce the text to send. This can also be an object of the class.
5864 * * 'omit_bots' -- whether the bot edits should be in the feed
5865 * * 'omit_anon' -- whether anonymous edits should be in the feed
5866 * * 'omit_user' -- whether edits by registered users should be in the feed
5867 * * 'omit_minor' -- whether minor edits should be in the feed
5868 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5870 * The IRC-specific options are:
5871 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5872 * the first entry in the $wgLocalInterwikis array (or the value of
5873 * $wgLocalInterwiki, if set)
5875 * The JSON-specific options are:
5876 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5878 * @example $wgRCFeeds['example'] = array(
5879 * 'formatter' => 'JSONRCFeedFormatter',
5880 * 'uri' => "udp://localhost:1336",
5881 * 'add_interwiki_prefix' => false,
5882 * 'omit_bots' => true,
5883 * );
5884 * @example $wgRCFeeds['exampleirc'] = array(
5885 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5886 * 'uri' => "udp://localhost:1338",
5887 * 'add_interwiki_prefix' => false,
5888 * 'omit_bots' => true,
5889 * );
5890 * @since 1.22
5892 $wgRCFeeds = array();
5895 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5896 * Keys are scheme names, values are names of engine classes.
5898 $wgRCEngines = array(
5899 'redis' => 'RedisPubSubFeedEngine',
5900 'udp' => 'UDPRCFeedEngine',
5904 * Use RC Patrolling to check for vandalism
5906 $wgUseRCPatrol = true;
5909 * Use new page patrolling to check new pages on Special:Newpages
5911 $wgUseNPPatrol = true;
5914 * Log autopatrol actions to the log table
5916 $wgLogAutopatrol = true;
5919 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5921 $wgFeed = true;
5924 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5925 * eg Recentchanges, Newpages.
5927 $wgFeedLimit = 50;
5930 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5931 * A cached version will continue to be served out even if changes
5932 * are made, until this many seconds runs out since the last render.
5934 * If set to 0, feed caching is disabled. Use this for debugging only;
5935 * feed generation can be pretty slow with diffs.
5937 $wgFeedCacheTimeout = 60;
5940 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5941 * pages larger than this size.
5943 $wgFeedDiffCutoff = 32768;
5946 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5947 * every page. Some sites might have a different feed they'd like to promote
5948 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5949 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5950 * as value.
5951 * @par Example:
5952 * Configure the 'atom' feed to http://example.com/somefeed.xml
5953 * @code
5954 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5955 * @endcode
5957 $wgOverrideSiteFeed = array();
5960 * Available feeds objects.
5961 * Should probably only be defined when a page is syndicated ie when
5962 * $wgOut->isSyndicated() is true.
5964 $wgFeedClasses = array(
5965 'rss' => 'RSSFeed',
5966 'atom' => 'AtomFeed',
5970 * Which feed types should we provide by default? This can include 'rss',
5971 * 'atom', neither, or both.
5973 $wgAdvertisedFeedTypes = array( 'atom' );
5976 * Show watching users in recent changes, watchlist and page history views
5978 $wgRCShowWatchingUsers = false; # UPO
5981 * Show the amount of changed characters in recent changes
5983 $wgRCShowChangedSize = true;
5986 * If the difference between the character counts of the text
5987 * before and after the edit is below that value, the value will be
5988 * highlighted on the RC page.
5990 $wgRCChangedSizeThreshold = 500;
5993 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5994 * view for watched pages with new changes
5996 $wgShowUpdatedMarker = true;
5999 * Disable links to talk pages of anonymous users (IPs) in listings on special
6000 * pages like page history, Special:Recentchanges, etc.
6002 $wgDisableAnonTalk = false;
6005 * Enable filtering of categories in Recentchanges
6007 $wgAllowCategorizedRecentChanges = false;
6010 * Allow filtering by change tag in recentchanges, history, etc
6011 * Has no effect if no tags are defined in valid_tag.
6013 $wgUseTagFilter = true;
6016 * If set to an integer, pages that are watched by this many users or more
6017 * will not require the unwatchedpages permission to view the number of
6018 * watchers.
6020 * @since 1.21
6022 $wgUnwatchedPageThreshold = false;
6025 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6026 * certain types of edits.
6028 * To register a new one:
6029 * @code
6030 * $wgRecentChangesFlags['flag'] => array(
6031 * // message for the letter displayed next to rows on changes lists
6032 * 'letter' => 'letter-msg',
6033 * // message for the tooltip of the letter
6034 * 'title' => 'tooltip-msg',
6035 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6036 * 'legend' => 'legend-msg',
6037 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6038 * 'class' => 'css-class',
6039 * );
6040 * @endcode
6042 * @since 1.22
6044 $wgRecentChangesFlags = array(
6045 'newpage' => array(
6046 'letter' => 'newpageletter',
6047 'title' => 'recentchanges-label-newpage',
6048 'legend' => 'recentchanges-legend-newpage',
6050 'minor' => array(
6051 'letter' => 'minoreditletter',
6052 'title' => 'recentchanges-label-minor',
6053 'legend' => 'recentchanges-legend-minor',
6054 'class' => 'minoredit',
6056 'bot' => array(
6057 'letter' => 'boteditletter',
6058 'title' => 'recentchanges-label-bot',
6059 'legend' => 'recentchanges-legend-bot',
6060 'class' => 'botedit',
6062 'unpatrolled' => array(
6063 'letter' => 'unpatrolledletter',
6064 'title' => 'recentchanges-label-unpatrolled',
6065 'legend' => 'recentchanges-legend-unpatrolled',
6069 /** @} */ # end RC/watchlist }
6071 /************************************************************************//**
6072 * @name Copyright and credits settings
6073 * @{
6077 * Override for copyright metadata.
6079 * This is the name of the page containing information about the wiki's copyright status,
6080 * which will be added as a link in the footer if it is specified. It overrides
6081 * $wgRightsUrl if both are specified.
6083 $wgRightsPage = null;
6086 * Set this to specify an external URL containing details about the content license used on your
6087 * wiki.
6088 * If $wgRightsPage is set then this setting is ignored.
6090 $wgRightsUrl = null;
6093 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6094 * link.
6095 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6096 * of the page will also be used as the link if this variable is not set.
6098 $wgRightsText = null;
6101 * Override for copyright metadata.
6103 $wgRightsIcon = null;
6106 * Set this to some HTML to override the rights icon with an arbitrary logo
6107 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6109 $wgCopyrightIcon = null;
6112 * Set this to true if you want detailed copyright information forms on Upload.
6114 $wgUseCopyrightUpload = false;
6117 * Set this to the number of authors that you want to be credited below an
6118 * article text. Set it to zero to hide the attribution block, and a negative
6119 * number (like -1) to show all authors. Note that this will require 2-3 extra
6120 * database hits, which can have a not insignificant impact on performance for
6121 * large wikis.
6123 $wgMaxCredits = 0;
6126 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6127 * Otherwise, link to a separate credits page.
6129 $wgShowCreditsIfMax = true;
6131 /** @} */ # end of copyright and credits settings }
6133 /************************************************************************//**
6134 * @name Import / Export
6135 * @{
6139 * List of interwiki prefixes for wikis we'll accept as sources for
6140 * Special:Import (for sysops). Since complete page history can be imported,
6141 * these should be 'trusted'.
6143 * This can either be a regular array, or an associative map specifying
6144 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6145 * e.g.
6146 * @code
6147 * $wgImportSources = array(
6148 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6149 * 'wikispecies',
6150 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6151 * );
6152 * @endcode
6154 * If a user has the 'import' permission but not the 'importupload' permission,
6155 * they will only be able to run imports through this transwiki interface.
6157 $wgImportSources = array();
6160 * Optional default target namespace for interwiki imports.
6161 * Can use this to create an incoming "transwiki"-style queue.
6162 * Set to numeric key, not the name.
6164 * Users may override this in the Special:Import dialog.
6166 $wgImportTargetNamespace = null;
6169 * If set to false, disables the full-history option on Special:Export.
6170 * This is currently poorly optimized for long edit histories, so is
6171 * disabled on Wikimedia's sites.
6173 $wgExportAllowHistory = true;
6176 * If set nonzero, Special:Export requests for history of pages with
6177 * more revisions than this will be rejected. On some big sites things
6178 * could get bogged down by very very long pages.
6180 $wgExportMaxHistory = 0;
6183 * Return distinct author list (when not returning full history)
6185 $wgExportAllowListContributors = false;
6188 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6189 * up to this specified level, which will cause it to include all
6190 * pages linked to from the pages you specify. Since this number
6191 * can become *insanely large* and could easily break your wiki,
6192 * it's disabled by default for now.
6194 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6195 * crazy-big export from being done by someone setting the depth number too
6196 * high. In other words, last resort safety net.
6198 $wgExportMaxLinkDepth = 0;
6201 * Whether to allow the "export all pages in namespace" option
6203 $wgExportFromNamespaces = false;
6206 * Whether to allow exporting the entire wiki into a single file
6208 $wgExportAllowAll = false;
6210 /** @} */ # end of import/export }
6212 /*************************************************************************//**
6213 * @name Extensions
6214 * @{
6218 * A list of callback functions which are called once MediaWiki is fully
6219 * initialised
6221 $wgExtensionFunctions = array();
6224 * Extension messages files.
6226 * Associative array mapping extension name to the filename where messages can be
6227 * found. The file should contain variable assignments. Any of the variables
6228 * present in languages/messages/MessagesEn.php may be defined, but $messages
6229 * is the most common.
6231 * Variables defined in extensions will override conflicting variables defined
6232 * in the core.
6234 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6235 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6236 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6237 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6239 * Extensions using the JSON message format can preserve backward compatibility with
6240 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6241 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6242 * as for the $wgMessagesDirs entry.
6244 * @par Example:
6245 * @code
6246 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6247 * @endcode
6249 $wgExtensionMessagesFiles = array();
6252 * Extension messages directories.
6254 * Associative array mapping extension name to the path of the directory where message files can
6255 * be found. The message files are expected to be JSON files named for their language code, e.g.
6256 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6257 * message directories.
6259 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6261 * @par Simple example:
6262 * @code
6263 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6264 * @endcode
6266 * @par Complex example:
6267 * @code
6268 * $wgMessagesDirs['Example'] = array(
6269 * __DIR__ . '/lib/ve/i18n',
6270 * __DIR__ . '/lib/oojs-ui/i18n',
6271 * __DIR__ . '/i18n',
6273 * @endcode
6274 * @since 1.23
6276 $wgMessagesDirs = array();
6279 * Array of files with list(s) of extension entry points to be used in
6280 * maintenance/mergeMessageFileList.php
6281 * @since 1.22
6283 $wgExtensionEntryPointListFiles = array();
6286 * Parser output hooks.
6287 * This is an associative array where the key is an extension-defined tag
6288 * (typically the extension name), and the value is a PHP callback.
6289 * These will be called as an OutputPageParserOutput hook, if the relevant
6290 * tag has been registered with the parser output object.
6292 * Registration is done with $pout->addOutputHook( $tag, $data ).
6294 * The callback has the form:
6295 * @code
6296 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6297 * @endcode
6299 $wgParserOutputHooks = array();
6302 * Whether to include the NewPP limit report as a HTML comment
6304 $wgEnableParserLimitReporting = true;
6307 * List of valid skin names
6309 * The key should be the name in all lower case, the value should be a properly
6310 * cased name for the skin. This value will be prefixed with "Skin" to create
6311 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6312 * if you wish to have access to the full list.
6314 $wgValidSkinNames = array();
6317 * Special page list. This is an associative array mapping the (canonical) names of
6318 * special pages to either a class name to be instantiated, or a callback to use for
6319 * creating the special page object. In both cases, the result must be an instance of
6320 * SpecialPage.
6322 $wgSpecialPages = array();
6325 * Array mapping class names to filenames, for autoloading.
6327 $wgAutoloadClasses = array();
6330 * Switch controlling legacy case-insensitive classloading.
6331 * Do not disable if your wiki must support data created by PHP4, or by
6332 * MediaWiki 1.4 or earlier.
6334 $wgAutoloadAttemptLowercase = true;
6337 * An array of information about installed extensions keyed by their type.
6339 * All but 'name', 'path' and 'author' can be omitted.
6341 * @code
6342 * $wgExtensionCredits[$type][] = array(
6343 * 'path' => __FILE__,
6344 * 'name' => 'Example extension',
6345 * 'namemsg' => 'exampleextension-name',
6346 * 'author' => array(
6347 * 'Foo Barstein',
6348 * ),
6349 * 'version' => '1.9.0',
6350 * 'url' => 'http://example.org/example-extension/',
6351 * 'descriptionmsg' => 'exampleextension-desc',
6352 * 'license-name' => 'GPL-2.0+',
6353 * );
6354 * @endcode
6356 * The extensions are listed on Special:Version. This page also looks for a file
6357 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6358 * view said file. When the 'license-name' key is specified, this file is
6359 * interpreted as wikitext.
6361 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6362 * 'skin', 'api', or 'other', or any additional types as specified through the
6363 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6365 * - name: Name of extension as an inline string instead of localizable message.
6366 * Do not omit this even if 'namemsg' is provided, as it is used to override
6367 * the path Special:Version uses to find extension's license info, and is
6368 * required for backwards-compatibility with MediaWiki 1.23 and older.
6370 * - namemsg (since MW 1.24): A message key for a message containing the
6371 * extension's name, if the name is localizable. (For example, skin names
6372 * usually are.)
6374 * - author: A string or an array of strings. Authors can be linked using
6375 * the regular wikitext link syntax. To have an internationalized version of
6376 * "and others" show, add an element "...". This element can also be linked,
6377 * for instance "[http://example ...]".
6379 * - descriptionmsg: A message key or an an array with message key and parameters:
6380 * `'descriptionmsg' => 'exampleextension-desc',`
6382 * - description: Description of extension as an inline string instead of
6383 * localizable message (omit in favour of 'descriptionmsg').
6385 * - license-name: Short name of the license (used as label for the link), such
6386 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6388 $wgExtensionCredits = array();
6391 * Authentication plugin.
6392 * @var $wgAuth AuthPlugin
6394 $wgAuth = null;
6397 * Global list of hooks.
6399 * The key is one of the events made available by MediaWiki, you can find
6400 * a description for most of them in docs/hooks.txt. The array is used
6401 * internally by Hook:run().
6403 * The value can be one of:
6405 * - A function name:
6406 * @code
6407 * $wgHooks['event_name'][] = $function;
6408 * @endcode
6409 * - A function with some data:
6410 * @code
6411 * $wgHooks['event_name'][] = array( $function, $data );
6412 * @endcode
6413 * - A an object method:
6414 * @code
6415 * $wgHooks['event_name'][] = array( $object, 'method' );
6416 * @endcode
6417 * - A closure:
6418 * @code
6419 * $wgHooks['event_name'][] = function ( $hookParam ) {
6420 * // Handler code goes here.
6421 * };
6422 * @endcode
6424 * @warning You should always append to an event array or you will end up
6425 * deleting a previous registered hook.
6427 * @warning Hook handlers should be registered at file scope. Registering
6428 * handlers after file scope can lead to unexpected results due to caching.
6430 $wgHooks = array();
6433 * Maps jobs to their handling classes; extensions
6434 * can add to this to provide custom jobs
6436 $wgJobClasses = array(
6437 'refreshLinks' => 'RefreshLinksJob',
6438 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6439 'sendMail' => 'EmaillingJob',
6440 'enotifNotify' => 'EnotifNotifyJob',
6441 'fixDoubleRedirect' => 'DoubleRedirectJob',
6442 'uploadFromUrl' => 'UploadFromUrlJob',
6443 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6444 'PublishStashedFile' => 'PublishStashedFileJob',
6445 'ThumbnailRender' => 'ThumbnailRenderJob',
6446 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6447 'refreshLinksPrioritized' => 'RefreshLinksJob', // for cascading protection
6448 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
6449 'null' => 'NullJob'
6453 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6454 * special flags are set. The values here are keys of $wgJobClasses.
6456 * These can be:
6457 * - Very long-running jobs.
6458 * - Jobs that you would never want to run as part of a page rendering request.
6459 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6460 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6461 * These settings should be global to all wikis.
6463 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6466 * Map of job types to how many job "work items" should be run per second
6467 * on each job runner process. The meaning of "work items" varies per job,
6468 * but typically would be something like "pages to update". A single job
6469 * may have a variable number of work items, as is the case with batch jobs.
6470 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6471 * These settings should be global to all wikis.
6472 * @var float[]
6474 $wgJobBackoffThrottling = array();
6477 * Map of job types to configuration arrays.
6478 * This determines which queue class and storage system is used for each job type.
6479 * Job types that do not have explicit configuration will use the 'default' config.
6480 * These settings should be global to all wikis.
6482 $wgJobTypeConf = array(
6483 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6487 * Which aggregator to use for tracking which queues have jobs.
6488 * These settings should be global to all wikis.
6490 $wgJobQueueAggregator = array(
6491 'class' => 'JobQueueAggregatorNull'
6495 * Additional functions to be performed with updateSpecialPages.
6496 * Expensive Querypages are already updated.
6498 $wgSpecialPageCacheUpdates = array(
6499 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6500 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6504 * Hooks that are used for outputting exceptions. Format is:
6505 * $wgExceptionHooks[] = $funcname
6506 * or:
6507 * $wgExceptionHooks[] = array( $class, $funcname )
6508 * Hooks should return strings or false
6510 $wgExceptionHooks = array();
6513 * Page property link table invalidation lists. When a page property
6514 * changes, this may require other link tables to be updated (eg
6515 * adding __HIDDENCAT__ means the hiddencat tracking category will
6516 * have been added, so the categorylinks table needs to be rebuilt).
6517 * This array can be added to by extensions.
6519 $wgPagePropLinkInvalidations = array(
6520 'hiddencat' => 'categorylinks',
6523 /** @} */ # End extensions }
6525 /*************************************************************************//**
6526 * @name Categories
6527 * @{
6531 * Use experimental, DMOZ-like category browser
6533 $wgUseCategoryBrowser = false;
6536 * On category pages, show thumbnail gallery for images belonging to that
6537 * category instead of listing them as articles.
6539 $wgCategoryMagicGallery = true;
6542 * Paging limit for categories
6544 $wgCategoryPagingLimit = 200;
6547 * Specify how category names should be sorted, when listed on a category page.
6548 * A sorting scheme is also known as a collation.
6550 * Available values are:
6552 * - uppercase: Converts the category name to upper case, and sorts by that.
6554 * - identity: Does no conversion. Sorts by binary value of the string.
6556 * - uca-default: Provides access to the Unicode Collation Algorithm with
6557 * the default element table. This is a compromise collation which sorts
6558 * all languages in a mediocre way. However, it is better than "uppercase".
6560 * To use the uca-default collation, you must have PHP's intl extension
6561 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6562 * resulting collation will depend on the version of ICU installed on the
6563 * server.
6565 * After you change this, you must run maintenance/updateCollation.php to fix
6566 * the sort keys in the database.
6568 * Extensions can define there own collations by subclassing Collation
6569 * and using the Collation::factory hook.
6571 $wgCategoryCollation = 'uppercase';
6573 /** @} */ # End categories }
6575 /*************************************************************************//**
6576 * @name Logging
6577 * @{
6581 * The logging system has two levels: an event type, which describes the
6582 * general category and can be viewed as a named subset of all logs; and
6583 * an action, which is a specific kind of event that can exist in that
6584 * log type.
6586 $wgLogTypes = array(
6588 'block',
6589 'protect',
6590 'rights',
6591 'delete',
6592 'upload',
6593 'move',
6594 'import',
6595 'patrol',
6596 'merge',
6597 'suppress',
6598 'managetags',
6602 * This restricts log access to those who have a certain right
6603 * Users without this will not see it in the option menu and can not view it
6604 * Restricted logs are not added to recent changes
6605 * Logs should remain non-transcludable
6606 * Format: logtype => permissiontype
6608 $wgLogRestrictions = array(
6609 'suppress' => 'suppressionlog'
6613 * Show/hide links on Special:Log will be shown for these log types.
6615 * This is associative array of log type => boolean "hide by default"
6617 * See $wgLogTypes for a list of available log types.
6619 * @par Example:
6620 * @code
6621 * $wgFilterLogTypes = array(
6622 * 'move' => true,
6623 * 'import' => false,
6624 * );
6625 * @endcode
6627 * Will display show/hide links for the move and import logs. Move logs will be
6628 * hidden by default unless the link is clicked. Import logs will be shown by
6629 * default, and hidden when the link is clicked.
6631 * A message of the form log-show-hide-[type] should be added, and will be used
6632 * for the link text.
6634 $wgFilterLogTypes = array(
6635 'patrol' => true
6639 * Lists the message key string for each log type. The localized messages
6640 * will be listed in the user interface.
6642 * Extensions with custom log types may add to this array.
6644 * @since 1.19, if you follow the naming convention log-name-TYPE,
6645 * where TYPE is your log type, yoy don't need to use this array.
6647 $wgLogNames = array(
6648 '' => 'all-logs-page',
6649 'block' => 'blocklogpage',
6650 'protect' => 'protectlogpage',
6651 'rights' => 'rightslog',
6652 'delete' => 'dellogpage',
6653 'upload' => 'uploadlogpage',
6654 'move' => 'movelogpage',
6655 'import' => 'importlogpage',
6656 'patrol' => 'patrol-log-page',
6657 'merge' => 'mergelog',
6658 'suppress' => 'suppressionlog',
6662 * Lists the message key string for descriptive text to be shown at the
6663 * top of each log type.
6665 * Extensions with custom log types may add to this array.
6667 * @since 1.19, if you follow the naming convention log-description-TYPE,
6668 * where TYPE is your log type, yoy don't need to use this array.
6670 $wgLogHeaders = array(
6671 '' => 'alllogstext',
6672 'block' => 'blocklogtext',
6673 'protect' => 'protectlogtext',
6674 'rights' => 'rightslogtext',
6675 'delete' => 'dellogpagetext',
6676 'upload' => 'uploadlogpagetext',
6677 'move' => 'movelogpagetext',
6678 'import' => 'importlogpagetext',
6679 'patrol' => 'patrol-log-header',
6680 'merge' => 'mergelogpagetext',
6681 'suppress' => 'suppressionlogtext',
6685 * Lists the message key string for formatting individual events of each
6686 * type and action when listed in the logs.
6688 * Extensions with custom log types may add to this array.
6690 $wgLogActions = array(
6691 'protect/protect' => 'protectedarticle',
6692 'protect/modify' => 'modifiedarticleprotection',
6693 'protect/unprotect' => 'unprotectedarticle',
6694 'protect/move_prot' => 'movedarticleprotection',
6698 * The same as above, but here values are names of functions,
6699 * not messages.
6700 * @see LogPage::actionText
6701 * @see LogFormatter
6703 $wgLogActionsHandlers = array(
6704 'move/move' => 'MoveLogFormatter',
6705 'move/move_redir' => 'MoveLogFormatter',
6706 'delete/delete' => 'DeleteLogFormatter',
6707 'delete/restore' => 'DeleteLogFormatter',
6708 'delete/revision' => 'DeleteLogFormatter',
6709 'delete/event' => 'DeleteLogFormatter',
6710 'suppress/revision' => 'DeleteLogFormatter',
6711 'suppress/event' => 'DeleteLogFormatter',
6712 'suppress/delete' => 'DeleteLogFormatter',
6713 'patrol/patrol' => 'PatrolLogFormatter',
6714 'rights/rights' => 'RightsLogFormatter',
6715 'rights/autopromote' => 'RightsLogFormatter',
6716 'upload/upload' => 'LogFormatter',
6717 'upload/overwrite' => 'LogFormatter',
6718 'upload/revert' => 'LogFormatter',
6719 'merge/merge' => 'MergeLogFormatter',
6720 'managetags/create' => 'LogFormatter',
6721 'managetags/delete' => 'LogFormatter',
6722 'managetags/activate' => 'LogFormatter',
6723 'managetags/deactivate' => 'LogFormatter',
6724 'block/block' => 'BlockLogFormatter',
6725 'block/unblock' => 'BlockLogFormatter',
6726 'block/reblock' => 'BlockLogFormatter',
6727 'suppress/block' => 'BlockLogFormatter',
6728 'suppress/reblock' => 'BlockLogFormatter',
6729 'import/upload' => 'LogFormatter',
6730 'import/interwiki' => 'LogFormatter',
6734 * Maintain a log of newusers at Log/newusers?
6736 $wgNewUserLog = true;
6738 /** @} */ # end logging }
6740 /*************************************************************************//**
6741 * @name Special pages (general and miscellaneous)
6742 * @{
6746 * Allow special page inclusions such as {{Special:Allpages}}
6748 $wgAllowSpecialInclusion = true;
6751 * Set this to an array of special page names to prevent
6752 * maintenance/updateSpecialPages.php from updating those pages.
6754 $wgDisableQueryPageUpdate = false;
6757 * List of special pages, followed by what subtitle they should go under
6758 * at Special:SpecialPages
6760 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6762 $wgSpecialPageGroups = array();
6765 * On Special:Unusedimages, consider images "used", if they are put
6766 * into a category. Default (false) is not to count those as used.
6768 $wgCountCategorizedImagesAsUsed = false;
6771 * Maximum number of links to a redirect page listed on
6772 * Special:Whatlinkshere/RedirectDestination
6774 $wgMaxRedirectLinksRetrieved = 500;
6776 /** @} */ # end special pages }
6778 /*************************************************************************//**
6779 * @name Actions
6780 * @{
6784 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6785 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6786 * 'foo' => true Load the class FooAction which subclasses Action
6787 * If something is specified in the getActionOverrides()
6788 * of the relevant Page object it will be used
6789 * instead of the default class.
6790 * 'foo' => false The action is disabled; show an error message
6791 * Unsetting core actions will probably cause things to complain loudly.
6793 $wgActions = array(
6794 'credits' => true,
6795 'delete' => true,
6796 'edit' => true,
6797 'history' => true,
6798 'info' => true,
6799 'markpatrolled' => true,
6800 'protect' => true,
6801 'purge' => true,
6802 'raw' => true,
6803 'render' => true,
6804 'revert' => true,
6805 'revisiondelete' => true,
6806 'rollback' => true,
6807 'submit' => true,
6808 'unprotect' => true,
6809 'unwatch' => true,
6810 'view' => true,
6811 'watch' => true,
6814 /** @} */ # end actions }
6816 /*************************************************************************//**
6817 * @name Robot (search engine crawler) policy
6818 * See also $wgNoFollowLinks.
6819 * @{
6823 * Default robot policy. The default policy is to encourage indexing and fol-
6824 * lowing of links. It may be overridden on a per-namespace and/or per-page
6825 * basis.
6827 $wgDefaultRobotPolicy = 'index,follow';
6830 * Robot policies per namespaces. The default policy is given above, the array
6831 * is made of namespace constants as defined in includes/Defines.php. You can-
6832 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6833 * nofollow. This is because a number of special pages (e.g., ListPages) have
6834 * many permutations of options that display the same data under redundant
6835 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6836 * pages, all alike, and never reaching your actual content.
6838 * @par Example:
6839 * @code
6840 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6841 * @endcode
6843 $wgNamespaceRobotPolicies = array();
6846 * Robot policies per article. These override the per-namespace robot policies.
6847 * Must be in the form of an array where the key part is a properly canonicalised
6848 * text form title and the value is a robot policy.
6850 * @par Example:
6851 * @code
6852 * $wgArticleRobotPolicies = array(
6853 * 'Main Page' => 'noindex,follow',
6854 * 'User:Bob' => 'index,follow',
6855 * );
6856 * @endcode
6858 * @par Example that DOES NOT WORK because the names are not canonical text
6859 * forms:
6860 * @code
6861 * $wgArticleRobotPolicies = array(
6862 * # Underscore, not space!
6863 * 'Main_Page' => 'noindex,follow',
6864 * # "Project", not the actual project name!
6865 * 'Project:X' => 'index,follow',
6866 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6867 * 'abc' => 'noindex,nofollow'
6868 * );
6869 * @endcode
6871 $wgArticleRobotPolicies = array();
6874 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6875 * will not function, so users can't decide whether pages in that namespace are
6876 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6878 * @par Example:
6879 * @code
6880 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6881 * @endcode
6883 $wgExemptFromUserRobotsControl = null;
6885 /** @} */ # End robot policy }
6887 /************************************************************************//**
6888 * @name AJAX and API
6889 * Note: The AJAX entry point which this section refers to is gradually being
6890 * replaced by the API entry point, api.php. They are essentially equivalent.
6891 * Both of them are used for dynamic client-side features, via XHR.
6892 * @{
6896 * Enable the MediaWiki API for convenient access to
6897 * machine-readable data via api.php
6899 * See https://www.mediawiki.org/wiki/API
6901 $wgEnableAPI = true;
6904 * Allow the API to be used to perform write operations
6905 * (page edits, rollback, etc.) when an authorised user
6906 * accesses it
6908 $wgEnableWriteAPI = true;
6912 * WARNING: SECURITY THREAT - debug use only
6914 * Disables many security checks in the API for debugging purposes.
6915 * This flag should never be used on the production servers, as it introduces
6916 * a number of potential security holes. Even when enabled, the validation
6917 * will still be performed, but instead of failing, API will return a warning.
6918 * Also, there will always be a warning notifying that this flag is set.
6919 * At this point, the flag allows GET requests to go through for modules
6920 * requiring POST.
6922 * @since 1.21
6924 $wgDebugAPI = false;
6927 * API module extensions.
6929 * Associative array mapping module name to modules specs;
6930 * Each module spec is an associative array containing at least
6931 * the 'class' key for the module's class, and optionally a
6932 * 'factory' key for the factory function to use for the module.
6934 * That factory function will be called with two parameters,
6935 * the parent module (an instance of ApiBase, usually ApiMain)
6936 * and the name the module was registered under. The return
6937 * value must be an instance of the class given in the 'class'
6938 * field.
6940 * For backward compatibility, the module spec may also be a
6941 * simple string containing the module's class name. In that
6942 * case, the class' constructor will be called with the parent
6943 * module and module name as parameters, as described above.
6945 * Examples for registering API modules:
6947 * @code
6948 * $wgAPIModules['foo'] = 'ApiFoo';
6949 * $wgAPIModules['bar'] = array(
6950 * 'class' => 'ApiBar',
6951 * 'factory' => function( $main, $name ) { ... }
6952 * );
6953 * $wgAPIModules['xyzzy'] = array(
6954 * 'class' => 'ApiXyzzy',
6955 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
6956 * );
6957 * @endcode
6959 * Extension modules may override the core modules.
6960 * See ApiMain::$Modules for a list of the core modules.
6962 $wgAPIModules = array();
6965 * API format module extensions.
6966 * Associative array mapping format module name to module specs (see $wgAPIModules).
6967 * Extension modules may override the core modules.
6969 * See ApiMain::$Formats for a list of the core format modules.
6971 $wgAPIFormatModules = array();
6974 * API Query meta module extensions.
6975 * Associative array mapping meta module name to module specs (see $wgAPIModules).
6976 * Extension modules may override the core modules.
6978 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6980 $wgAPIMetaModules = array();
6983 * API Query prop module extensions.
6984 * Associative array mapping prop module name to module specs (see $wgAPIModules).
6985 * Extension modules may override the core modules.
6987 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6989 $wgAPIPropModules = array();
6992 * API Query list module extensions.
6993 * Associative array mapping list module name to module specs (see $wgAPIModules).
6994 * Extension modules may override the core modules.
6996 * See ApiQuery::$QueryListModules for a list of the core list modules.
6998 $wgAPIListModules = array();
7001 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
7002 * @deprecated since 1.21
7004 $wgAPIGeneratorModules = array();
7007 * Maximum amount of rows to scan in a DB query in the API
7008 * The default value is generally fine
7010 $wgAPIMaxDBRows = 5000;
7013 * The maximum size (in bytes) of an API result.
7014 * @warning Do not set this lower than $wgMaxArticleSize*1024
7016 $wgAPIMaxResultSize = 8388608;
7019 * The maximum number of uncached diffs that can be retrieved in one API
7020 * request. Set this to 0 to disable API diffs altogether
7022 $wgAPIMaxUncachedDiffs = 1;
7025 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7026 * API request logging
7028 $wgAPIRequestLog = false;
7031 * Set the timeout for the API help text cache. If set to 0, caching disabled
7033 $wgAPICacheHelpTimeout = 60 * 60;
7036 * The ApiQueryQueryPages module should skip pages that are redundant to true
7037 * API queries.
7039 $wgAPIUselessQueryPages = array(
7040 'MIMEsearch', // aiprop=mime
7041 'LinkSearch', // list=exturlusage
7042 'FileDuplicateSearch', // prop=duplicatefiles
7046 * Enable AJAX framework
7048 $wgUseAjax = true;
7051 * List of Ajax-callable functions.
7052 * Extensions acting as Ajax callbacks must register here
7054 $wgAjaxExportList = array();
7057 * Enable watching/unwatching pages using AJAX.
7058 * Requires $wgUseAjax to be true too.
7060 $wgAjaxWatch = true;
7063 * Enable AJAX check for file overwrite, pre-upload
7065 $wgAjaxUploadDestCheck = true;
7068 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7070 $wgAjaxLicensePreview = true;
7073 * Have clients send edits to be prepared when filling in edit summaries.
7074 * This gives the server a head start on the expensive parsing operation.
7076 $wgAjaxEditStash = true;
7079 * Settings for incoming cross-site AJAX requests:
7080 * Newer browsers support cross-site AJAX when the target resource allows requests
7081 * from the origin domain by the Access-Control-Allow-Origin header.
7082 * This is currently only used by the API (requests to api.php)
7083 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7085 * - '*' matches any number of characters
7086 * - '?' matches any 1 character
7088 * @par Example:
7089 * @code
7090 * $wgCrossSiteAJAXdomains = array(
7091 * 'www.mediawiki.org',
7092 * '*.wikipedia.org',
7093 * '*.wikimedia.org',
7094 * '*.wiktionary.org',
7095 * );
7096 * @endcode
7098 $wgCrossSiteAJAXdomains = array();
7101 * Domains that should not be allowed to make AJAX requests,
7102 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7103 * Uses the same syntax as $wgCrossSiteAJAXdomains
7105 $wgCrossSiteAJAXdomainExceptions = array();
7107 /** @} */ # End AJAX and API }
7109 /************************************************************************//**
7110 * @name Shell and process control
7111 * @{
7115 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7117 $wgMaxShellMemory = 307200;
7120 * Maximum file size created by shell processes under linux, in KB
7121 * ImageMagick convert for example can be fairly hungry for scratch space
7123 $wgMaxShellFileSize = 102400;
7126 * Maximum CPU time in seconds for shell processes under Linux
7128 $wgMaxShellTime = 180;
7131 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7132 * would measure) in seconds for shell processes under Linux
7134 $wgMaxShellWallClockTime = 180;
7137 * Under Linux: a cgroup directory used to constrain memory usage of shell
7138 * commands. The directory must be writable by the user which runs MediaWiki.
7140 * If specified, this is used instead of ulimit, which is inaccurate, and
7141 * causes malloc() to return NULL, which exposes bugs in C applications, making
7142 * them segfault or deadlock.
7144 * A wrapper script will create a cgroup for each shell command that runs, as
7145 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7146 * kernel will send a SIGKILL signal to a process in the subgroup.
7148 * @par Example:
7149 * @code
7150 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7151 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7152 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7153 * @endcode
7155 * The reliability of cgroup cleanup can be improved by installing a
7156 * notify_on_release script in the root cgroup, see e.g.
7157 * https://gerrit.wikimedia.org/r/#/c/40784
7159 $wgShellCgroup = false;
7162 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7164 $wgPhpCli = '/usr/bin/php';
7167 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7168 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7169 * character set. Only the character set is relevant.
7171 $wgShellLocale = 'en_US.utf8';
7173 /** @} */ # End shell }
7175 /************************************************************************//**
7176 * @name HTTP client
7177 * @{
7181 * Timeout for HTTP requests done internally, in seconds.
7183 $wgHTTPTimeout = 25;
7186 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7188 $wgAsyncHTTPTimeout = 25;
7191 * Proxy to use for CURL requests.
7193 $wgHTTPProxy = false;
7196 * Local virtual hosts.
7198 * This lists domains that are configured as virtual hosts on the same machine.
7199 * If a request is to be made to a domain listed here, or any subdomain thereof,
7200 * then no proxy will be used.
7201 * Command-line scripts are not affected by this setting and will always use
7202 * proxy if it is configured.
7203 * @since 1.25
7205 $wgLocalVirtualHosts = array();
7208 * Timeout for connections done internally (in seconds)
7209 * Only works for curl
7211 $wgHTTPConnectTimeout = 5e0;
7213 /** @} */ # End HTTP client }
7215 /************************************************************************//**
7216 * @name Job queue
7217 * See also $wgEnotifUseJobQ.
7218 * @{
7222 * Number of jobs to perform per request. May be less than one in which case
7223 * jobs are performed probabalistically. If this is zero, jobs will not be done
7224 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7225 * be run periodically.
7227 $wgJobRunRate = 1;
7230 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7231 * to handle the job execution, instead of blocking the request until the job
7232 * execution finishes.
7233 * @since 1.23
7235 $wgRunJobsAsync = true;
7238 * Number of rows to update per job
7240 $wgUpdateRowsPerJob = 500;
7243 * Number of rows to update per query
7245 $wgUpdateRowsPerQuery = 100;
7247 /** @} */ # End job queue }
7249 /************************************************************************//**
7250 * @name Miscellaneous
7251 * @{
7255 * Name of the external diff engine to use
7257 $wgExternalDiffEngine = false;
7260 * Disable redirects to special pages and interwiki redirects, which use a 302
7261 * and have no "redirected from" link.
7263 * @note This is only for articles with #REDIRECT in them. URL's containing a
7264 * local interwiki prefix (or a non-canonical special page name) are still hard
7265 * redirected regardless of this setting.
7267 $wgDisableHardRedirects = false;
7270 * LinkHolderArray batch size
7271 * For debugging
7273 $wgLinkHolderBatchSize = 1000;
7276 * By default MediaWiki does not register links pointing to same server in
7277 * externallinks dataset, use this value to override:
7279 $wgRegisterInternalExternals = false;
7282 * Maximum number of pages to move at once when moving subpages with a page.
7284 $wgMaximumMovedPages = 100;
7287 * Fix double redirects after a page move.
7288 * Tends to conflict with page move vandalism, use only on a private wiki.
7290 $wgFixDoubleRedirects = false;
7293 * Allow redirection to another page when a user logs in.
7294 * To enable, set to a string like 'Main Page'
7296 $wgRedirectOnLogin = null;
7299 * Configuration for processing pool control, for use in high-traffic wikis.
7300 * An implementation is provided in the PoolCounter extension.
7302 * This configuration array maps pool types to an associative array. The only
7303 * defined key in the associative array is "class", which gives the class name.
7304 * The remaining elements are passed through to the class as constructor
7305 * parameters.
7307 * @par Example:
7308 * @code
7309 * $wgPoolCounterConf = array( 'ArticleView' => array(
7310 * 'class' => 'PoolCounter_Client',
7311 * 'timeout' => 15, // wait timeout in seconds
7312 * 'workers' => 5, // maximum number of active threads in each pool
7313 * 'maxqueue' => 50, // maximum number of total threads in each pool
7314 * ... any extension-specific options...
7315 * );
7316 * @endcode
7318 $wgPoolCounterConf = null;
7321 * To disable file delete/restore temporarily
7323 $wgUploadMaintenance = false;
7326 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7327 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7328 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7329 * (except for the special case of JS and CS pages).
7331 * @since 1.21
7333 $wgNamespaceContentModels = array();
7336 * How to react if a plain text version of a non-text Content object is requested using
7337 * ContentHandler::getContentText():
7339 * * 'ignore': return null
7340 * * 'fail': throw an MWException
7341 * * 'serialize': serialize to default format
7343 * @since 1.21
7345 $wgContentHandlerTextFallback = 'ignore';
7348 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7349 * This way, the ContentHandler facility can be used without any additional information in the
7350 * database. A page's content model is then derived solely from the page's title. This however
7351 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7352 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7353 * a title that would default to a different content model.
7355 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7356 * handling is less robust and less flexible.
7358 * @since 1.21
7360 $wgContentHandlerUseDB = true;
7363 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7364 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7365 * the effect on the database they would have on a wikitext page.
7367 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7368 * or at least parse only the contents of comments in the scripts.
7370 * @since 1.21
7372 $wgTextModelsToParse = array(
7373 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7374 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7375 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7379 * Whether the user must enter their password to change their e-mail address
7381 * @since 1.20
7383 $wgRequirePasswordforEmailChange = true;
7386 * Register handlers for specific types of sites.
7388 * @since 1.20
7390 $wgSiteTypes = array(
7391 'mediawiki' => 'MediaWikiSite',
7395 * Whether the page_props table has a pp_sortkey column. Set to false in case
7396 * the respective database schema change was not applied.
7397 * @since 1.23
7399 $wgPagePropsHaveSortkey = true;
7402 * Port where you have HTTPS running
7403 * Supports HTTPS on non-standard ports
7404 * @see bug 65184
7405 * @since 1.24
7407 $wgHttpsPort = 443;
7410 * Secret for hmac-based key derivation function (fast,
7411 * cryptographically secure random numbers).
7412 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7413 * be used.
7414 * See also: $wgHKDFAlgorithm
7415 * @since 1.24
7417 $wgHKDFSecret = false;
7420 * Algorithm for hmac-based key derivation function (fast,
7421 * cryptographically secure random numbers).
7422 * See also: $wgHKDFSecret
7423 * @since 1.24
7425 $wgHKDFAlgorithm = 'sha256';
7428 * Enable page language feature
7429 * Allows setting page language in database
7430 * @var bool
7431 * @since 1.24
7433 $wgPageLanguageUseDB = false;
7436 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7437 * Set this only if the fields are fully populated. This may be removed in 1.25.
7438 * @var bool
7439 * @since 1.24
7441 $wgUseLinkNamespaceDBFields = true;
7444 * Global configuration variable for Virtual REST Services.
7445 * Parameters for different services are to be declared inside
7446 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
7447 * array. Global parameters will be merged with service-specific ones. The
7448 * result will then be passed to VirtualRESTService::__construct() in the
7449 * module.
7451 * Example config for Parsoid:
7453 * $wgVirtualRestConfig['modules']['parsoid'] = array(
7454 * 'url' => 'http://localhost:8000',
7455 * 'prefix' => 'enwiki',
7456 * );
7458 * @var array
7459 * @since 1.25
7461 $wgVirtualRestConfig = array(
7462 'modules' => array(),
7463 'global' => array(
7464 # Timeout in seconds
7465 'timeout' => 360,
7466 'forwardCookies' => false,
7467 'HTTPProxy' => null
7472 * For really cool vim folding this needs to be at the end:
7473 * vim: foldmarker=@{,@} foldmethod=marker
7474 * @}