Remove collateOnly() from ProfilerStandard and subclasses
[mediawiki.git] / includes / DefaultSettings.php
blobcfc84389ad6bdf24e0a57d2f7f1ea57606317b60
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 * The URL path of the shortcut icon.
262 * @since 1.6
264 $wgFavicon = '/favicon.ico';
267 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
268 * Defaults to no icon.
269 * @since 1.12
271 $wgAppleTouchIcon = false;
274 * The local filesystem path to a temporary directory. This is not required to
275 * be web accessible.
277 * When this setting is set to false, its value will be set through a call
278 * to wfTempDir(). See that methods implementation for the actual detection
279 * logic.
281 * Developers should use the global function wfTempDir() instead of this
282 * variable.
284 * @see wfTempDir()
285 * @note Default changed to false in MediaWiki 1.20.
287 $wgTmpDirectory = false;
290 * If set, this URL is added to the start of $wgUploadPath to form a complete
291 * upload URL.
292 * @since 1.4
294 $wgUploadBaseUrl = '';
297 * To enable remote on-demand scaling, set this to the thumbnail base URL.
298 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
299 * where 'e6' are the first two characters of the MD5 hash of the file name.
300 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
301 * @since 1.17
303 $wgUploadStashScalerBaseUrl = false;
306 * To set 'pretty' URL paths for actions other than
307 * plain page views, add to this array.
309 * @par Example:
310 * Set pretty URL for the edit action:
311 * @code
312 * 'edit' => "$wgScriptPath/edit/$1"
313 * @endcode
315 * There must be an appropriate script or rewrite rule in place to handle these
316 * URLs.
317 * @since 1.5
319 $wgActionPaths = array();
321 /**@}*/
323 /************************************************************************//**
324 * @name Files and file uploads
325 * @{
329 * Uploads have to be specially set up to be secure
331 $wgEnableUploads = false;
334 * The maximum age of temporary (incomplete) uploaded files
336 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
339 * Allows to move images and other media files
341 $wgAllowImageMoving = true;
344 * Enable deferred upload tasks that use the job queue.
345 * Only enable this if job runners are set up for both the
346 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
348 * @note If you use suhosin, this setting is incompatible with
349 * suhosin.session.encrypt.
351 $wgEnableAsyncUploads = false;
354 * These are additional characters that should be replaced with '-' in filenames
356 $wgIllegalFileChars = ":";
359 * What directory to place deleted uploads in.
360 * Defaults to "{$wgUploadDirectory}/deleted".
362 $wgDeletedDirectory = false;
365 * Set this to true if you use img_auth and want the user to see details on why access failed.
367 $wgImgAuthDetails = false;
370 * Map of relative URL directories to match to internal mwstore:// base storage paths.
371 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
372 * if starts with any of the prefixes defined here. The prefixes should not overlap.
373 * The prefix that matches has a corresponding storage path, which the rest of the URL
374 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
376 * Example:
377 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
378 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
379 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
381 * @see $wgFileBackends
383 $wgImgAuthUrlPathMap = array();
386 * File repository structures
388 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
389 * an array of such structures. Each repository structure is an associative
390 * array of properties configuring the repository.
392 * Properties required for all repos:
393 * - class The class name for the repository. May come from the core or an extension.
394 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
395 * FSRepo is also supported for backwards compatibility.
397 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
398 * The name should consist of alpha-numeric characters.
399 * - backend A file backend name (see $wgFileBackends).
401 * For most core repos:
402 * - zones Associative array of zone names that each map to an array with:
403 * container : backend container name the zone is in
404 * directory : root path within container for the zone
405 * url : base URL to the root of the zone
406 * urlsByExt : map of file extension types to base URLs
407 * (useful for using a different cache for videos)
408 * Zones default to using "<repo name>-<zone name>" as the container name
409 * and default to using the container root as the zone's root directory.
410 * Nesting of zone locations within other zones should be avoided.
411 * - url Public zone URL. The 'zones' settings take precedence.
412 * - hashLevels The number of directory levels for hash-based division of files
413 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
414 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
415 * handler instead.
416 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
417 * determines whether filenames implicitly start with a capital letter.
418 * The current implementation may give incorrect description page links
419 * when the local $wgCapitalLinks and initialCapital are mismatched.
420 * - pathDisclosureProtection
421 * May be 'paranoid' to remove all parameters from error messages, 'none' to
422 * leave the paths in unchanged, or 'simple' to replace paths with
423 * placeholders. Default for LocalRepo is 'simple'.
424 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
425 * is 0644.
426 * - directory The local filesystem directory where public files are stored. Not used for
427 * some remote repos.
428 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
429 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
430 * - isPrivate Set this if measures should always be taken to keep the files private.
431 * One should not trust this to assure that the files are not web readable;
432 * the server configuration should be done manually depending on the backend.
434 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
435 * for local repositories:
436 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
437 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
438 * http://en.wikipedia.org/w
439 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
440 * $wgScriptExtension, e.g. .php5 defaults to .php
442 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
443 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
444 * $wgFetchCommonsDescriptions.
445 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
446 * Short thumbnail names only have the width, parameters, and the extension.
448 * ForeignDBRepo:
449 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
450 * equivalent to the corresponding member of $wgDBservers
451 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
452 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
454 * ForeignAPIRepo:
455 * - apibase Use for the foreign API's URL
456 * - apiThumbCacheExpiry How long to locally cache thumbs for
458 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
459 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
460 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
461 * If you set $wgForeignFileRepos to an array of repository structures, those will
462 * be searched after the local file repo.
463 * Otherwise, you will only have access to local media files.
465 * @see Setup.php for an example usage and default initialization.
467 $wgLocalFileRepo = false;
470 * @see $wgLocalFileRepo
472 $wgForeignFileRepos = array();
475 * Use Commons as a remote file repository. Essentially a wrapper, when this
476 * is enabled $wgForeignFileRepos will point at Commons with a set of default
477 * settings
479 $wgUseInstantCommons = false;
482 * File backend structure configuration.
484 * This is an array of file backend configuration arrays.
485 * Each backend configuration has the following parameters:
486 * - 'name' : A unique name for the backend
487 * - 'class' : The file backend class to use
488 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
489 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
491 * See FileBackend::__construct() for more details.
492 * Additional parameters are specific to the file backend class used.
493 * These settings should be global to all wikis when possible.
495 * There are two particularly important aspects about each backend:
496 * - a) Whether it is fully qualified or wiki-relative.
497 * By default, the paths of files are relative to the current wiki,
498 * which works via prefixing them with the current wiki ID when accessed.
499 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
500 * all paths with the specified value instead. This can be useful if
501 * multiple wikis need to share the same data. Note that 'name' is *not*
502 * part of any prefix and thus should not be relied upon for namespacing.
503 * - b) Whether it is only defined for some wikis or is defined on all
504 * wikis in the wiki farm. Defining a backend globally is useful
505 * if multiple wikis need to share the same data.
506 * One should be aware of these aspects when configuring a backend for use with
507 * any basic feature or plugin. For example, suppose an extension stores data for
508 * different wikis in different directories and sometimes needs to access data from
509 * a foreign wiki's directory in order to render a page on given wiki. The extension
510 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
512 $wgFileBackends = array();
515 * Array of configuration arrays for each lock manager.
516 * Each backend configuration has the following parameters:
517 * - 'name' : A unique name for the lock manager
518 * - 'class' : The lock manger class to use
520 * See LockManager::__construct() for more details.
521 * Additional parameters are specific to the lock manager class used.
522 * These settings should be global to all wikis.
524 $wgLockManagers = array();
527 * Show Exif data, on by default if available.
528 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
530 * @note FOR WINDOWS USERS:
531 * To enable Exif functions, add the following lines to the "Windows
532 * extensions" section of php.ini:
533 * @code{.ini}
534 * extension=extensions/php_mbstring.dll
535 * extension=extensions/php_exif.dll
536 * @endcode
538 $wgShowEXIF = function_exists( 'exif_read_data' );
541 * If to automatically update the img_metadata field
542 * if the metadata field is outdated but compatible with the current version.
543 * Defaults to false.
545 $wgUpdateCompatibleMetadata = false;
548 * If you operate multiple wikis, you can define a shared upload path here.
549 * Uploads to this wiki will NOT be put there - they will be put into
550 * $wgUploadDirectory.
551 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
552 * no file of the given name is found in the local repository (for [[File:..]],
553 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
554 * directory.
556 * Note that these configuration settings can now be defined on a per-
557 * repository basis for an arbitrary number of file repositories, using the
558 * $wgForeignFileRepos variable.
560 $wgUseSharedUploads = false;
563 * Full path on the web server where shared uploads can be found
565 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
568 * Fetch commons image description pages and display them on the local wiki?
570 $wgFetchCommonsDescriptions = false;
573 * Path on the file system where shared uploads can be found.
575 $wgSharedUploadDirectory = "/var/www/wiki3/images";
578 * DB name with metadata about shared directory.
579 * Set this to false if the uploads do not come from a wiki.
581 $wgSharedUploadDBname = false;
584 * Optional table prefix used in database.
586 $wgSharedUploadDBprefix = '';
589 * Cache shared metadata in memcached.
590 * Don't do this if the commons wiki is in a different memcached domain
592 $wgCacheSharedUploads = true;
595 * Allow for upload to be copied from an URL.
596 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
597 * You have to assign the user right 'upload_by_url' to a user group, to use this.
599 $wgAllowCopyUploads = false;
602 * Allow asynchronous copy uploads.
603 * This feature is experimental and broken as of r81612.
605 $wgAllowAsyncCopyUploads = false;
608 * A list of domains copy uploads can come from
610 * @since 1.20
612 $wgCopyUploadsDomains = array();
615 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
616 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
617 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
619 $wgCopyUploadsFromSpecialUpload = false;
622 * Proxy to use for copy upload requests.
623 * @since 1.20
625 $wgCopyUploadProxy = false;
628 * Different timeout for upload by url
629 * This could be useful since when fetching large files, you may want a
630 * timeout longer than the default $wgHTTPTimeout. False means fallback
631 * to default.
633 * @since 1.22
635 $wgCopyUploadTimeout = false;
638 * Different timeout for upload by url when run as a background job
639 * This could be useful since when fetching large files via job queue,
640 * you may want a different timeout, especially because there is no
641 * http request being kept alive.
643 * false means fallback to $wgCopyUploadTimeout.
644 * @since 1.22
646 $wgCopyUploadAsyncTimeout = false;
649 * Max size for uploads, in bytes. If not set to an array, applies to all
650 * uploads. If set to an array, per upload type maximums can be set, using the
651 * file and url keys. If the * key is set this value will be used as maximum
652 * for non-specified types.
654 * @par Example:
655 * @code
656 * $wgMaxUploadSize = array(
657 * '*' => 250 * 1024,
658 * 'url' => 500 * 1024,
659 * );
660 * @endcode
661 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
662 * will have a maximum of 500 kB.
664 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
667 * Point the upload navigation link to an external URL
668 * Useful if you want to use a shared repository by default
669 * without disabling local uploads (use $wgEnableUploads = false for that).
671 * @par Example:
672 * @code
673 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
674 * @endcode
676 $wgUploadNavigationUrl = false;
679 * Point the upload link for missing files to an external URL, as with
680 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
681 * appended to it as appropriate.
683 $wgUploadMissingFileUrl = false;
686 * Give a path here to use thumb.php for thumbnail generation on client
687 * request, instead of generating them on render and outputting a static URL.
688 * This is necessary if some of your apache servers don't have read/write
689 * access to the thumbnail path.
691 * @par Example:
692 * @code
693 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
694 * @endcode
696 $wgThumbnailScriptPath = false;
699 * @see $wgThumbnailScriptPath
701 $wgSharedThumbnailScriptPath = false;
704 * Set this to false if you do not want MediaWiki to divide your images
705 * directory into many subdirectories, for improved performance.
707 * It's almost always good to leave this enabled. In previous versions of
708 * MediaWiki, some users set this to false to allow images to be added to the
709 * wiki by simply copying them into $wgUploadDirectory and then running
710 * maintenance/rebuildImages.php to register them in the database. This is no
711 * longer recommended, use maintenance/importImages.php instead.
713 * @note That this variable may be ignored if $wgLocalFileRepo is set.
714 * @todo Deprecate the setting and ultimately remove it from Core.
716 $wgHashedUploadDirectory = true;
719 * Set the following to false especially if you have a set of files that need to
720 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
721 * directory layout.
723 $wgHashedSharedUploadDirectory = true;
726 * Base URL for a repository wiki. Leave this blank if uploads are just stored
727 * in a shared directory and not meant to be accessible through a separate wiki.
728 * Otherwise the image description pages on the local wiki will link to the
729 * image description page on this wiki.
731 * Please specify the namespace, as in the example below.
733 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
736 * This is the list of preferred extensions for uploading files. Uploading files
737 * with extensions not in this list will trigger a warning.
739 * @warning If you add any OpenOffice or Microsoft Office file formats here,
740 * such as odt or doc, and untrusted users are allowed to upload files, then
741 * your wiki will be vulnerable to cross-site request forgery (CSRF).
743 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
746 * Files with these extensions will never be allowed as uploads.
747 * An array of file extensions to blacklist. You should append to this array
748 * if you want to blacklist additional files.
750 $wgFileBlacklist = array(
751 # HTML may contain cookie-stealing JavaScript and web bugs
752 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
753 # PHP scripts may execute arbitrary code on the server
754 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
755 # Other types that may be interpreted by some servers
756 'shtml', 'jhtml', 'pl', 'py', 'cgi',
757 # May contain harmful executables for Windows victims
758 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
761 * Files with these MIME types will never be allowed as uploads
762 * if $wgVerifyMimeType is enabled.
764 $wgMimeTypeBlacklist = array(
765 # HTML may contain cookie-stealing JavaScript and web bugs
766 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
767 # PHP scripts may execute arbitrary code on the server
768 'application/x-php', 'text/x-php',
769 # Other types that may be interpreted by some servers
770 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
771 # Client-side hazards on Internet Explorer
772 'text/scriptlet', 'application/x-msdownload',
773 # Windows metafile, client-side vulnerability on some systems
774 'application/x-msmetafile',
778 * Allow Java archive uploads.
779 * This is not recommended for public wikis since a maliciously-constructed
780 * applet running on the same domain as the wiki can steal the user's cookies.
782 $wgAllowJavaUploads = false;
785 * This is a flag to determine whether or not to check file extensions on upload.
787 * @warning Setting this to false is insecure for public wikis.
789 $wgCheckFileExtensions = true;
792 * If this is turned off, users may override the warning for files not covered
793 * by $wgFileExtensions.
795 * @warning Setting this to false is insecure for public wikis.
797 $wgStrictFileExtensions = true;
800 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
802 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
803 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
805 $wgDisableUploadScriptChecks = false;
808 * Warn if uploaded files are larger than this (in bytes), or false to disable
810 $wgUploadSizeWarning = false;
813 * list of trusted media-types and MIME types.
814 * Use the MEDIATYPE_xxx constants to represent media types.
815 * This list is used by File::isSafeFile
817 * Types not listed here will have a warning about unsafe content
818 * displayed on the images description page. It would also be possible
819 * to use this for further restrictions, like disabling direct
820 * [[media:...]] links for non-trusted formats.
822 $wgTrustedMediaFormats = array(
823 MEDIATYPE_BITMAP, //all bitmap formats
824 MEDIATYPE_AUDIO, //all audio formats
825 MEDIATYPE_VIDEO, //all plain video formats
826 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
827 "application/pdf", //PDF files
828 #"application/x-shockwave-flash", //flash/shockwave movie
832 * Plugins for media file type handling.
833 * Each entry in the array maps a MIME type to a class name
835 $wgMediaHandlers = array(
836 'image/jpeg' => 'JpegHandler',
837 'image/png' => 'PNGHandler',
838 'image/gif' => 'GIFHandler',
839 'image/tiff' => 'TiffHandler',
840 'image/x-ms-bmp' => 'BmpHandler',
841 'image/x-bmp' => 'BmpHandler',
842 'image/x-xcf' => 'XCFHandler',
843 'image/svg+xml' => 'SvgHandler', // official
844 'image/svg' => 'SvgHandler', // compat
845 'image/vnd.djvu' => 'DjVuHandler', // official
846 'image/x.djvu' => 'DjVuHandler', // compat
847 'image/x-djvu' => 'DjVuHandler', // compat
851 * Plugins for page content model handling.
852 * Each entry in the array maps a model id to a class name.
854 * @since 1.21
856 $wgContentHandlers = array(
857 // the usual case
858 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
859 // dumb version, no syntax highlighting
860 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
861 // simple implementation, for use by extensions, etc.
862 CONTENT_MODEL_JSON => 'JsonContentHandler',
863 // dumb version, no syntax highlighting
864 CONTENT_MODEL_CSS => 'CssContentHandler',
865 // plain text, for use by extensions, etc.
866 CONTENT_MODEL_TEXT => 'TextContentHandler',
870 * Whether to enable server-side image thumbnailing. If false, images will
871 * always be sent to the client in full resolution, with appropriate width= and
872 * height= attributes on the <img> tag for the client to do its own scaling.
874 $wgUseImageResize = true;
877 * Resizing can be done using PHP's internal image libraries or using
878 * ImageMagick or another third-party converter, e.g. GraphicMagick.
879 * These support more file formats than PHP, which only supports PNG,
880 * GIF, JPG, XBM and WBMP.
882 * Use Image Magick instead of PHP builtin functions.
884 $wgUseImageMagick = false;
887 * The convert command shipped with ImageMagick
889 $wgImageMagickConvertCommand = '/usr/bin/convert';
892 * Sharpening parameter to ImageMagick
894 $wgSharpenParameter = '0x0.4';
897 * Reduction in linear dimensions below which sharpening will be enabled
899 $wgSharpenReductionThreshold = 0.85;
902 * Temporary directory used for ImageMagick. The directory must exist. Leave
903 * this set to false to let ImageMagick decide for itself.
905 $wgImageMagickTempDir = false;
908 * Use another resizing converter, e.g. GraphicMagick
909 * %s will be replaced with the source path, %d with the destination
910 * %w and %h will be replaced with the width and height.
912 * @par Example for GraphicMagick:
913 * @code
914 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
915 * @endcode
917 * Leave as false to skip this.
919 $wgCustomConvertCommand = false;
922 * used for lossless jpeg rotation
924 * @since 1.21
926 $wgJpegTran = '/usr/bin/jpegtran';
929 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
930 * image formats.
932 $wgExiv2Command = '/usr/bin/exiv2';
935 * Scalable Vector Graphics (SVG) may be uploaded as images.
936 * Since SVG support is not yet standard in browsers, it is
937 * necessary to rasterize SVGs to PNG as a fallback format.
939 * An external program is required to perform this conversion.
940 * If set to an array, the first item is a PHP callable and any further items
941 * are passed as parameters after $srcPath, $dstPath, $width, $height
943 $wgSVGConverters = array(
944 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
945 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
946 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
947 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
948 . '$output $input',
949 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
950 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
951 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
955 * Pick a converter defined in $wgSVGConverters
957 $wgSVGConverter = 'ImageMagick';
960 * If not in the executable PATH, specify the SVG converter path.
962 $wgSVGConverterPath = '';
965 * Don't scale a SVG larger than this
967 $wgSVGMaxSize = 2048;
970 * Don't read SVG metadata beyond this point.
971 * Default is 1024*256 bytes
973 $wgSVGMetadataCutoff = 262144;
976 * Disallow <title> element in SVG files.
978 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
979 * browsers which can not perform basic stuff like MIME detection and which are
980 * vulnerable to further idiots uploading crap files as images.
982 * When this directive is on, "<title>" will be allowed in files with an
983 * "image/svg+xml" MIME type. You should leave this disabled if your web server
984 * is misconfigured and doesn't send appropriate MIME types for SVG images.
986 $wgAllowTitlesInSVG = false;
989 * The maximum number of pixels a source image can have if it is to be scaled
990 * down by a scaler that requires the full source image to be decompressed
991 * and stored in decompressed form, before the thumbnail is generated.
993 * This provides a limit on memory usage for the decompression side of the
994 * image scaler. The limit is used when scaling PNGs with any of the
995 * built-in image scalers, such as ImageMagick or GD. It is ignored for
996 * JPEGs with ImageMagick, and when using the VipsScaler extension.
998 * The default is 50 MB if decompressed to RGBA form, which corresponds to
999 * 12.5 million pixels or 3500x3500.
1001 $wgMaxImageArea = 1.25e7;
1004 * Force thumbnailing of animated GIFs above this size to a single
1005 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1006 * is checked against the total size of all frames in the animation.
1007 * It probably makes sense to keep this equal to $wgMaxImageArea.
1009 $wgMaxAnimatedGifArea = 1.25e7;
1012 * Browsers don't support TIFF inline generally...
1013 * For inline display, we need to convert to PNG or JPEG.
1014 * Note scaling should work with ImageMagick, but may not with GD scaling.
1016 * @par Example:
1017 * @code
1018 * // PNG is lossless, but inefficient for photos
1019 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1020 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1021 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1022 * @endcode
1024 $wgTiffThumbnailType = false;
1027 * If rendered thumbnail files are older than this timestamp, they
1028 * will be rerendered on demand as if the file didn't already exist.
1029 * Update if there is some need to force thumbs and SVG rasterizations
1030 * to rerender, such as fixes to rendering bugs.
1032 $wgThumbnailEpoch = '20030516000000';
1035 * Certain operations are avoided if there were too many recent failures,
1036 * for example, thumbnail generation. Bump this value to invalidate all
1037 * memory of failed operations and thus allow further attempts to resume.
1038 * This is useful when a cause for the failures has been found and fixed.
1040 $wgAttemptFailureEpoch = 1;
1043 * If set, inline scaled images will still produce "<img>" tags ready for
1044 * output instead of showing an error message.
1046 * This may be useful if errors are transitory, especially if the site
1047 * is configured to automatically render thumbnails on request.
1049 * On the other hand, it may obscure error conditions from debugging.
1050 * Enable the debug log or the 'thumbnail' log group to make sure errors
1051 * are logged to a file for review.
1053 $wgIgnoreImageErrors = false;
1056 * Allow thumbnail rendering on page view. If this is false, a valid
1057 * thumbnail URL is still output, but no file will be created at
1058 * the target location. This may save some time if you have a
1059 * thumb.php or 404 handler set up which is faster than the regular
1060 * webserver(s).
1062 $wgGenerateThumbnailOnParse = true;
1065 * Show thumbnails for old images on the image description page
1067 $wgShowArchiveThumbnails = true;
1070 * If set to true, images that contain certain the exif orientation tag will
1071 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1072 * is available that can rotate.
1074 $wgEnableAutoRotation = null;
1077 * Internal name of virus scanner. This serves as a key to the
1078 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1079 * null, every file uploaded will be scanned for viruses.
1081 $wgAntivirus = null;
1084 * Configuration for different virus scanners. This an associative array of
1085 * associative arrays. It contains one setup array per known scanner type.
1086 * The entry is selected by $wgAntivirus, i.e.
1087 * valid values for $wgAntivirus are the keys defined in this array.
1089 * The configuration array for each scanner contains the following keys:
1090 * "command", "codemap", "messagepattern":
1092 * "command" is the full command to call the virus scanner - %f will be
1093 * replaced with the name of the file to scan. If not present, the filename
1094 * will be appended to the command. Note that this must be overwritten if the
1095 * scanner is not in the system path; in that case, please set
1096 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1097 * path.
1099 * "codemap" is a mapping of exit code to return codes of the detectVirus
1100 * function in SpecialUpload.
1101 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1102 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1103 * is not set.
1104 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1105 * the file to have an unsupported format, which is probably immune to
1106 * viruses. This causes the file to pass.
1107 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1108 * no virus was found.
1109 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1110 * a virus.
1111 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1113 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1114 * output. The relevant part should be matched as group one (\1).
1115 * If not defined or the pattern does not match, the full message is shown to the user.
1117 $wgAntivirusSetup = array(
1119 #setup for clamav
1120 'clamav' => array(
1121 'command' => 'clamscan --no-summary ',
1122 'codemap' => array(
1123 "0" => AV_NO_VIRUS, # no virus
1124 "1" => AV_VIRUS_FOUND, # virus found
1125 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1126 "*" => AV_SCAN_FAILED, # else scan failed
1128 'messagepattern' => '/.*?:(.*)/sim',
1133 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1135 $wgAntivirusRequired = true;
1138 * Determines if the MIME type of uploaded files should be checked
1140 $wgVerifyMimeType = true;
1143 * Sets the MIME type definition file to use by MimeMagic.php.
1144 * Set to null, to use built-in defaults only.
1145 * example: $wgMimeTypeFile = '/etc/mime.types';
1147 $wgMimeTypeFile = 'includes/mime.types';
1150 * Sets the MIME type info file to use by MimeMagic.php.
1151 * Set to null, to use built-in defaults only.
1153 $wgMimeInfoFile = 'includes/mime.info';
1156 * Sets an external MIME detector program. The command must print only
1157 * the MIME type to standard output.
1158 * The name of the file to process will be appended to the command given here.
1159 * If not set or NULL, PHP's fileinfo extension will be used if available.
1161 * @par Example:
1162 * @code
1163 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1164 * @endcode
1166 $wgMimeDetectorCommand = null;
1169 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1170 * things, because only a few types of images are needed and file extensions
1171 * can be trusted.
1173 $wgTrivialMimeDetection = false;
1176 * Additional XML types we can allow via MIME-detection.
1177 * array = ( 'rootElement' => 'associatedMimeType' )
1179 $wgXMLMimeTypes = array(
1180 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1181 'svg' => 'image/svg+xml',
1182 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1183 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1184 'html' => 'text/html', // application/xhtml+xml?
1188 * Limit images on image description pages to a user-selectable limit. In order
1189 * to reduce disk usage, limits can only be selected from a list.
1190 * The user preference is saved as an array offset in the database, by default
1191 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1192 * change it if you alter the array (see bug 8858).
1193 * This is the list of settings the user can choose from:
1195 $wgImageLimits = array(
1196 array( 320, 240 ),
1197 array( 640, 480 ),
1198 array( 800, 600 ),
1199 array( 1024, 768 ),
1200 array( 1280, 1024 )
1204 * Adjust thumbnails on image pages according to a user setting. In order to
1205 * reduce disk usage, the values can only be selected from a list. This is the
1206 * list of settings the user can choose from:
1208 $wgThumbLimits = array(
1209 120,
1210 150,
1211 180,
1212 200,
1213 250,
1218 * When defined, is an array of image widths used as buckets for thumbnail generation.
1219 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1220 * always using the original. This will incur a speed gain but cause a quality loss.
1222 * The buckets generation is chained, with each bucket generated based on the above bucket
1223 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1224 * supports it.
1226 $wgThumbnailBuckets = null;
1229 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1230 * above the requested size. The distance represents how many extra pixels of width the bucket
1231 * needs in order to be used as the reference for a given thumbnail. For example, with the
1232 * following buckets:
1234 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1236 * and a distance of 50:
1238 * $wgThumbnailMinimumBucketDistance = 50;
1240 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1241 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1243 $wgThumbnailMinimumBucketDistance = 50;
1246 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1247 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1248 * has a performance impact for the first client to view a certain size.
1250 * This obviously means that more disk space is needed per upload upfront.
1252 * @since 1.25
1255 $wgUploadThumbnailRenderMap = array();
1258 * The method through which the thumbnails will be prerendered for the entries in
1259 * $wgUploadThumbnailRenderMap
1261 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1262 * thumbnail's URL.
1263 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1264 * option uses the job queue to render the thumbnail.
1266 * @since 1.25
1268 $wgUploadThumbnailRenderMethod = 'jobqueue';
1271 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1273 * @since 1.25
1275 $wgUploadThumbnailRenderHttpCustomHost = false;
1278 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1279 * HTTP request to.
1281 * @since 1.25
1283 $wgUploadThumbnailRenderHttpCustomDomain = false;
1286 * Default parameters for the "<gallery>" tag
1288 $wgGalleryOptions = array(
1289 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1290 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1291 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1292 'captionLength' => 25, // Length of caption to truncate (in characters)
1293 'showBytes' => true, // Show the filesize in bytes in categories
1294 'mode' => 'traditional',
1298 * Adjust width of upright images when parameter 'upright' is used
1299 * This allows a nicer look for upright images without the need to fix the width
1300 * by hardcoded px in wiki sourcecode.
1302 $wgThumbUpright = 0.75;
1305 * Default value for chmoding of new directories.
1307 $wgDirectoryMode = 0777;
1310 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1312 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1313 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1314 * images in after loading the original low-resolution versions depending on the reported
1315 * window.devicePixelRatio.
1317 $wgResponsiveImages = true;
1320 * @name DJVU settings
1321 * @{
1325 * Path of the djvudump executable
1326 * Enable this and $wgDjvuRenderer to enable djvu rendering
1327 * example: $wgDjvuDump = 'djvudump';
1329 $wgDjvuDump = null;
1332 * Path of the ddjvu DJVU renderer
1333 * Enable this and $wgDjvuDump to enable djvu rendering
1334 * example: $wgDjvuRenderer = 'ddjvu';
1336 $wgDjvuRenderer = null;
1339 * Path of the djvutxt DJVU text extraction utility
1340 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1341 * example: $wgDjvuTxt = 'djvutxt';
1343 $wgDjvuTxt = null;
1346 * Path of the djvutoxml executable
1347 * This works like djvudump except much, much slower as of version 3.5.
1349 * For now we recommend you use djvudump instead. The djvuxml output is
1350 * probably more stable, so we'll switch back to it as soon as they fix
1351 * the efficiency problem.
1352 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1354 * @par Example:
1355 * @code
1356 * $wgDjvuToXML = 'djvutoxml';
1357 * @endcode
1359 $wgDjvuToXML = null;
1362 * Shell command for the DJVU post processor
1363 * Default: pnmtojpeg, since ddjvu generates ppm output
1364 * Set this to false to output the ppm file directly.
1366 $wgDjvuPostProcessor = 'pnmtojpeg';
1369 * File extension for the DJVU post processor output
1371 $wgDjvuOutputExtension = 'jpg';
1373 /** @} */ # end of DJvu }
1375 /** @} */ # end of file uploads }
1377 /************************************************************************//**
1378 * @name Email settings
1379 * @{
1384 * Site admin email address.
1386 * Defaults to "wikiadmin@{$wgServerName}".
1388 $wgEmergencyContact = false;
1391 * Password reminder email address.
1393 * The address we should use as sender when a user is requesting his password.
1395 * Defaults to "apache@{$wgServerName}".
1397 $wgPasswordSender = false;
1400 * Password reminder name
1402 * @deprecated since 1.23; use the system message 'emailsender' instead.
1404 $wgPasswordSenderName = 'MediaWiki Mail';
1407 * Dummy address which should be accepted during mail send action.
1408 * It might be necessary to adapt the address or to set it equal
1409 * to the $wgEmergencyContact address.
1411 $wgNoReplyAddress = 'reply@not.possible';
1414 * Set to true to enable the e-mail basic features:
1415 * Password reminders, etc. If sending e-mail on your
1416 * server doesn't work, you might want to disable this.
1418 $wgEnableEmail = true;
1421 * Set to true to enable user-to-user e-mail.
1422 * This can potentially be abused, as it's hard to track.
1424 $wgEnableUserEmail = true;
1427 * Set to true to put the sending user's email in a Reply-To header
1428 * instead of From. ($wgEmergencyContact will be used as From.)
1430 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1431 * which can cause problems with SPF validation and leak recipient addresses
1432 * when bounces are sent to the sender.
1434 $wgUserEmailUseReplyTo = false;
1437 * Minimum time, in hours, which must elapse between password reminder
1438 * emails for a given account. This is to prevent abuse by mail flooding.
1440 $wgPasswordReminderResendTime = 24;
1443 * The time, in seconds, when an emailed temporary password expires.
1445 $wgNewPasswordExpiry = 3600 * 24 * 7;
1448 * The time, in seconds, when an email confirmation email expires
1450 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1453 * The number of days that a user's password is good for. After this number of days, the
1454 * user will be asked to reset their password. Set to false to disable password expiration.
1456 $wgPasswordExpirationDays = false;
1459 * If a user's password is expired, the number of seconds when they can still login,
1460 * and cancel their password change, but are sent to the password change form on each login.
1462 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1465 * SMTP Mode.
1467 * For using a direct (authenticated) SMTP server connection.
1468 * Default to false or fill an array :
1470 * @code
1471 * $wgSMTP = array(
1472 * 'host' => 'SMTP domain',
1473 * 'IDHost' => 'domain for MessageID',
1474 * 'port' => '25',
1475 * 'auth' => [true|false],
1476 * 'username' => [SMTP username],
1477 * 'password' => [SMTP password],
1478 * );
1479 * @endcode
1481 $wgSMTP = false;
1484 * Additional email parameters, will be passed as the last argument to mail() call.
1485 * If using safe_mode this has no effect
1487 $wgAdditionalMailParams = null;
1490 * For parts of the system that have been updated to provide HTML email content, send
1491 * both text and HTML parts as the body of the email
1493 $wgAllowHTMLEmail = false;
1496 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1497 * from $wgEmergencyContact
1499 $wgEnotifFromEditor = false;
1501 // TODO move UPO to preferences probably ?
1502 # If set to true, users get a corresponding option in their preferences and can choose to
1503 # enable or disable at their discretion
1504 # If set to false, the corresponding input form on the user preference page is suppressed
1505 # It call this to be a "user-preferences-option (UPO)"
1508 * Require email authentication before sending mail to an email address.
1509 * This is highly recommended. It prevents MediaWiki from being used as an open
1510 * spam relay.
1512 $wgEmailAuthentication = true;
1515 * Allow users to enable email notification ("enotif") on watchlist changes.
1517 $wgEnotifWatchlist = false;
1520 * Allow users to enable email notification ("enotif") when someone edits their
1521 * user talk page.
1523 $wgEnotifUserTalk = false;
1526 * Set the Reply-to address in notifications to the editor's address, if user
1527 * allowed this in the preferences.
1529 $wgEnotifRevealEditorAddress = false;
1532 * Send notification mails on minor edits to watchlist pages. This is enabled
1533 * by default. Does not affect user talk notifications.
1535 $wgEnotifMinorEdits = true;
1538 * Send a generic mail instead of a personalised mail for each user. This
1539 * always uses UTC as the time zone, and doesn't include the username.
1541 * For pages with many users watching, this can significantly reduce mail load.
1542 * Has no effect when using sendmail rather than SMTP.
1544 $wgEnotifImpersonal = false;
1547 * Maximum number of users to mail at once when using impersonal mail. Should
1548 * match the limit on your mail server.
1550 $wgEnotifMaxRecips = 500;
1553 * Send mails via the job queue. This can be useful to reduce the time it
1554 * takes to save a page that a lot of people are watching.
1556 $wgEnotifUseJobQ = false;
1559 * Use real name instead of username in e-mail "from" field.
1561 $wgEnotifUseRealName = false;
1564 * Array of usernames who will be sent a notification email for every change
1565 * which occurs on a wiki. Users will not be notified of their own changes.
1567 $wgUsersNotifiedOnAllChanges = array();
1569 /** @} */ # end of email settings
1571 /************************************************************************//**
1572 * @name Database settings
1573 * @{
1577 * Database host name or IP address
1579 $wgDBserver = 'localhost';
1582 * Database port number (for PostgreSQL and Microsoft SQL Server).
1584 $wgDBport = 5432;
1587 * Name of the database
1589 $wgDBname = 'my_wiki';
1592 * Database username
1594 $wgDBuser = 'wikiuser';
1597 * Database user's password
1599 $wgDBpassword = '';
1602 * Database type
1604 $wgDBtype = 'mysql';
1607 * Whether to use SSL in DB connection.
1609 * This setting is only used $wgLBFactoryConf['class'] is set to
1610 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1611 * the DBO_SSL flag must be set in the 'flags' option of the database
1612 * connection to achieve the same functionality.
1614 $wgDBssl = false;
1617 * Whether to use compression in DB connection.
1619 * This setting is only used $wgLBFactoryConf['class'] is set to
1620 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1621 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1622 * connection to achieve the same functionality.
1624 $wgDBcompress = false;
1627 * Separate username for maintenance tasks. Leave as null to use the default.
1629 $wgDBadminuser = null;
1632 * Separate password for maintenance tasks. Leave as null to use the default.
1634 $wgDBadminpassword = null;
1637 * Search type.
1638 * Leave as null to select the default search engine for the
1639 * selected database type (eg SearchMySQL), or set to a class
1640 * name to override to a custom search engine.
1642 $wgSearchType = null;
1645 * Alternative search types
1646 * Sometimes you want to support multiple search engines for testing. This
1647 * allows users to select their search engine of choice via url parameters
1648 * to Special:Search and the action=search API. If using this, there's no
1649 * need to add $wgSearchType to it, that is handled automatically.
1651 $wgSearchTypeAlternatives = null;
1654 * Table name prefix
1656 $wgDBprefix = '';
1659 * MySQL table options to use during installation or update
1661 $wgDBTableOptions = 'ENGINE=InnoDB';
1664 * SQL Mode - default is turning off all modes, including strict, if set.
1665 * null can be used to skip the setting for performance reasons and assume
1666 * DBA has done his best job.
1667 * String override can be used for some additional fun :-)
1669 $wgSQLMode = '';
1672 * Mediawiki schema
1674 $wgDBmwschema = null;
1677 * To override default SQLite data directory ($docroot/../data)
1679 $wgSQLiteDataDir = '';
1682 * Make all database connections secretly go to localhost. Fool the load balancer
1683 * thinking there is an arbitrarily large cluster of servers to connect to.
1684 * Useful for debugging.
1686 $wgAllDBsAreLocalhost = false;
1689 * Shared database for multiple wikis. Commonly used for storing a user table
1690 * for single sign-on. The server for this database must be the same as for the
1691 * main database.
1693 * For backwards compatibility the shared prefix is set to the same as the local
1694 * prefix, and the user table is listed in the default list of shared tables.
1695 * The user_properties table is also added so that users will continue to have their
1696 * preferences shared (preferences were stored in the user table prior to 1.16)
1698 * $wgSharedTables may be customized with a list of tables to share in the shared
1699 * database. However it is advised to limit what tables you do share as many of
1700 * MediaWiki's tables may have side effects if you try to share them.
1702 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1703 * $wgDBprefix.
1705 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1706 * access remote databases. Using wfGetLB() allows the shared database to
1707 * reside on separate servers to the wiki's own database, with suitable
1708 * configuration of $wgLBFactoryConf.
1710 $wgSharedDB = null;
1713 * @see $wgSharedDB
1715 $wgSharedPrefix = false;
1718 * @see $wgSharedDB
1720 $wgSharedTables = array( 'user', 'user_properties' );
1723 * Database load balancer
1724 * This is a two-dimensional array, an array of server info structures
1725 * Fields are:
1726 * - host: Host name
1727 * - dbname: Default database name
1728 * - user: DB user
1729 * - password: DB password
1730 * - type: DB type
1732 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1733 * If this is zero for any given server, no normal query traffic will be
1734 * sent to it. It will be excluded from lag checks in maintenance scripts.
1735 * The only way it can receive traffic is if groupLoads is used.
1737 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1738 * to several groups, the most specific group defined here is used.
1740 * - flags: bit field
1741 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1742 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1743 * - DBO_TRX -- wrap entire request in a transaction
1744 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1745 * - DBO_PERSISTENT -- enables persistent database connections
1746 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1747 * - DBO_COMPRESS -- uses internal compression in database connections,
1748 * if available
1750 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1752 * These and any other user-defined properties will be assigned to the mLBInfo member
1753 * variable of the Database object.
1755 * Leave at false to use the single-server variables above. If you set this
1756 * variable, the single-server variables will generally be ignored (except
1757 * perhaps in some command-line scripts).
1759 * The first server listed in this array (with key 0) will be the master. The
1760 * rest of the servers will be slaves. To prevent writes to your slaves due to
1761 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1762 * slaves in my.cnf. You can set read_only mode at runtime using:
1764 * @code
1765 * SET @@read_only=1;
1766 * @endcode
1768 * Since the effect of writing to a slave is so damaging and difficult to clean
1769 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1770 * our masters, and then set read_only=0 on masters at runtime.
1772 $wgDBservers = false;
1775 * Load balancer factory configuration
1776 * To set up a multi-master wiki farm, set the class here to something that
1777 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1778 * The class identified here is responsible for reading $wgDBservers,
1779 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1781 * The LBFactoryMulti class is provided for this purpose, please see
1782 * includes/db/LBFactoryMulti.php for configuration information.
1784 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1787 * How long to wait for a slave to catch up to the master
1788 * @deprecated since 1.24
1790 $wgMasterWaitTimeout = 10;
1793 * File to log database errors to
1795 $wgDBerrorLog = false;
1798 * Timezone to use in the error log.
1799 * Defaults to the wiki timezone ($wgLocaltimezone).
1801 * A list of usable timezones can found at:
1802 * http://php.net/manual/en/timezones.php
1804 * @par Examples:
1805 * @code
1806 * $wgLocaltimezone = 'UTC';
1807 * $wgLocaltimezone = 'GMT';
1808 * $wgLocaltimezone = 'PST8PDT';
1809 * $wgLocaltimezone = 'Europe/Sweden';
1810 * $wgLocaltimezone = 'CET';
1811 * @endcode
1813 * @since 1.20
1815 $wgDBerrorLogTZ = false;
1818 * Scale load balancer polling time so that under overload conditions, the
1819 * database server receives a SHOW STATUS query at an average interval of this
1820 * many microseconds
1822 $wgDBAvgStatusPoll = 2000;
1825 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1826 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1828 * @warning THIS IS EXPERIMENTAL!
1830 * May break if you're not using the table defs from mysql5/tables.sql.
1831 * May break if you're upgrading an existing wiki if set differently.
1832 * Broken symptoms likely to include incorrect behavior with page titles,
1833 * usernames, comments etc containing non-ASCII characters.
1834 * Might also cause failures on the object cache and other things.
1836 * Even correct usage may cause failures with Unicode supplementary
1837 * characters (those not in the Basic Multilingual Plane) unless MySQL
1838 * has enhanced their Unicode support.
1840 $wgDBmysql5 = false;
1843 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1845 * To use this feature set to true and use a datasource defined as
1846 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1847 * block).
1849 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1850 * Pool) that maintains established sessions and reuses them on new
1851 * connections.
1853 * Not completely tested, but it should fall back on normal connection
1854 * in case the pool is full or the datasource is not configured as
1855 * pooled.
1856 * And the other way around; using oci_pconnect on a non pooled
1857 * datasource should produce a normal connection.
1859 * When it comes to frequent shortlived DB connections like with MW
1860 * Oracle tends to s***. The problem is the driver connects to the
1861 * database reasonably fast, but establishing a session takes time and
1862 * resources. MW does not rely on session state (as it does not use
1863 * features such as package variables) so establishing a valid session
1864 * is in this case an unwanted overhead that just slows things down.
1866 * @warning EXPERIMENTAL!
1869 $wgDBOracleDRCP = false;
1872 * Other wikis on this site, can be administered from a single developer
1873 * account.
1874 * Array numeric key => database name
1876 $wgLocalDatabases = array();
1879 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1880 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1881 * show a more obvious warning.
1883 $wgSlaveLagWarning = 10;
1886 * @see $wgSlaveLagWarning
1888 $wgSlaveLagCritical = 30;
1891 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1893 $wgDBWindowsAuthentication = false;
1895 /**@}*/ # End of DB settings }
1897 /************************************************************************//**
1898 * @name Text storage
1899 * @{
1903 * We can also compress text stored in the 'text' table. If this is set on, new
1904 * revisions will be compressed on page save if zlib support is available. Any
1905 * compressed revisions will be decompressed on load regardless of this setting,
1906 * but will not be readable at all* if zlib support is not available.
1908 $wgCompressRevisions = false;
1911 * External stores allow including content
1912 * from non database sources following URL links.
1914 * Short names of ExternalStore classes may be specified in an array here:
1915 * @code
1916 * $wgExternalStores = array("http","file","custom")...
1917 * @endcode
1919 * CAUTION: Access to database might lead to code execution
1921 $wgExternalStores = array();
1924 * An array of external MySQL servers.
1926 * @par Example:
1927 * Create a cluster named 'cluster1' containing three servers:
1928 * @code
1929 * $wgExternalServers = array(
1930 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1931 * );
1932 * @endcode
1934 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1935 * another class.
1937 $wgExternalServers = array();
1940 * The place to put new revisions, false to put them in the local text table.
1941 * Part of a URL, e.g. DB://cluster1
1943 * Can be an array instead of a single string, to enable data distribution. Keys
1944 * must be consecutive integers, starting at zero.
1946 * @par Example:
1947 * @code
1948 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1949 * @endcode
1951 * @var array
1953 $wgDefaultExternalStore = false;
1956 * Revision text may be cached in $wgMemc to reduce load on external storage
1957 * servers and object extraction overhead for frequently-loaded revisions.
1959 * Set to 0 to disable, or number of seconds before cache expiry.
1961 $wgRevisionCacheExpiry = 0;
1963 /** @} */ # end text storage }
1965 /************************************************************************//**
1966 * @name Performance hacks and limits
1967 * @{
1971 * Disable database-intensive features
1973 $wgMiserMode = false;
1976 * Disable all query pages if miser mode is on, not just some
1978 $wgDisableQueryPages = false;
1981 * Number of rows to cache in 'querycache' table when miser mode is on
1983 $wgQueryCacheLimit = 1000;
1986 * Number of links to a page required before it is deemed "wanted"
1988 $wgWantedPagesThreshold = 1;
1991 * Enable slow parser functions
1993 $wgAllowSlowParserFunctions = false;
1996 * Allow schema updates
1998 $wgAllowSchemaUpdates = true;
2001 * Maximum article size in kilobytes
2003 $wgMaxArticleSize = 2048;
2006 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2007 * raise PHP's memory limit if it's below this amount.
2009 $wgMemoryLimit = "50M";
2011 /** @} */ # end performance hacks }
2013 /************************************************************************//**
2014 * @name Cache settings
2015 * @{
2019 * Directory for caching data in the local filesystem. Should not be accessible
2020 * from the web. Set this to false to not use any local caches.
2022 * Note: if multiple wikis share the same localisation cache directory, they
2023 * must all have the same set of extensions. You can set a directory just for
2024 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2026 $wgCacheDirectory = false;
2029 * Main cache type. This should be a cache with fast access, but it may have
2030 * limited space. By default, it is disabled, since the database is not fast
2031 * enough to make it worthwhile.
2033 * The options are:
2035 * - CACHE_ANYTHING: Use anything, as long as it works
2036 * - CACHE_NONE: Do not cache
2037 * - CACHE_DB: Store cache objects in the DB
2038 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2039 * - CACHE_ACCEL: APC, XCache or WinCache
2040 * - (other): A string may be used which identifies a cache
2041 * configuration in $wgObjectCaches.
2043 * @see $wgMessageCacheType, $wgParserCacheType
2045 $wgMainCacheType = CACHE_NONE;
2048 * The cache type for storing the contents of the MediaWiki namespace. This
2049 * cache is used for a small amount of data which is expensive to regenerate.
2051 * For available types see $wgMainCacheType.
2053 $wgMessageCacheType = CACHE_ANYTHING;
2056 * The cache type for storing article HTML. This is used to store data which
2057 * is expensive to regenerate, and benefits from having plenty of storage space.
2059 * For available types see $wgMainCacheType.
2061 $wgParserCacheType = CACHE_ANYTHING;
2064 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2066 * For available types see $wgMainCacheType.
2068 $wgSessionCacheType = CACHE_ANYTHING;
2071 * The cache type for storing language conversion tables,
2072 * which are used when parsing certain text and interface messages.
2074 * For available types see $wgMainCacheType.
2076 * @since 1.20
2078 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2081 * Advanced object cache configuration.
2083 * Use this to define the class names and constructor parameters which are used
2084 * for the various cache types. Custom cache types may be defined here and
2085 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2086 * or $wgLanguageConverterCacheType.
2088 * The format is an associative array where the key is a cache identifier, and
2089 * the value is an associative array of parameters. The "class" parameter is the
2090 * class name which will be used. Alternatively, a "factory" parameter may be
2091 * given, giving a callable function which will generate a suitable cache object.
2093 $wgObjectCaches = array(
2094 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2095 CACHE_DB => array( 'class' => 'SqlBagOStuff' ),
2097 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2098 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2099 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached' ),
2101 'apc' => array( 'class' => 'APCBagOStuff' ),
2102 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2103 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2104 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2105 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2106 'hash' => array( 'class' => 'HashBagOStuff' ),
2110 * Map of bloom filter store names to configuration arrays.
2112 * Example:
2113 * $wgBloomFilterStores['main'] = array(
2114 * 'cacheId' => 'main-v1',
2115 * 'class' => 'BloomCacheRedis',
2116 * 'redisServers' => array( '127.0.0.1:6379' ),
2117 * 'redisConfig' => array( 'connectTimeout' => 2 )
2118 * );
2120 * A primary bloom filter must be created manually.
2121 * Example in eval.php:
2122 * <code>
2123 * BloomCache::get( 'main' )->init( 'shared', 1000000000, .001 );
2124 * </code>
2125 * The size should be as large as practical given wiki size and resources.
2127 * @since 1.24
2129 $wgBloomFilterStores = array();
2132 * The expiry time for the parser cache, in seconds.
2133 * The default is 86400 (one day).
2135 $wgParserCacheExpireTime = 86400;
2138 * Deprecated alias for $wgSessionsInObjectCache.
2140 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2142 $wgSessionsInMemcached = false;
2145 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2146 * can be useful to improve performance, or to avoid the locking behavior of
2147 * PHP's default session handler, which tends to prevent multiple requests for
2148 * the same user from acting concurrently.
2150 $wgSessionsInObjectCache = false;
2153 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2154 * enabled, in seconds.
2156 $wgObjectCacheSessionExpiry = 3600;
2159 * This is used for setting php's session.save_handler. In practice, you will
2160 * almost never need to change this ever. Other options might be 'user' or
2161 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2162 * useful if you're doing cross-application sessions, see bug 11381)
2164 $wgSessionHandler = null;
2167 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2169 $wgMemCachedDebug = false;
2172 * The list of MemCached servers and port numbers
2174 $wgMemCachedServers = array( '127.0.0.1:11211' );
2177 * Use persistent connections to MemCached, which are shared across multiple
2178 * requests.
2180 $wgMemCachedPersistent = false;
2183 * Read/write timeout for MemCached server communication, in microseconds.
2185 $wgMemCachedTimeout = 500000;
2188 * Set this to true to make a local copy of the message cache, for use in
2189 * addition to memcached. The files will be put in $wgCacheDirectory.
2191 $wgUseLocalMessageCache = false;
2194 * Instead of caching everything, only cache those messages which have
2195 * been customised in the site content language. This means that
2196 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2197 * This option is probably only useful for translatewiki.net.
2199 $wgAdaptiveMessageCache = false;
2202 * Localisation cache configuration. Associative array with keys:
2203 * class: The class to use. May be overridden by extensions.
2205 * store: The location to store cache data. May be 'files', 'db' or
2206 * 'detect'. If set to "files", data will be in CDB files. If set
2207 * to "db", data will be stored to the database. If set to
2208 * "detect", files will be used if $wgCacheDirectory is set,
2209 * otherwise the database will be used.
2211 * storeClass: The class name for the underlying storage. If set to a class
2212 * name, it overrides the "store" setting.
2214 * storeDirectory: If the store class puts its data in files, this is the
2215 * directory it will use. If this is false, $wgCacheDirectory
2216 * will be used.
2218 * manualRecache: Set this to true to disable cache updates on web requests.
2219 * Use maintenance/rebuildLocalisationCache.php instead.
2221 $wgLocalisationCacheConf = array(
2222 'class' => 'LocalisationCache',
2223 'store' => 'detect',
2224 'storeClass' => false,
2225 'storeDirectory' => false,
2226 'manualRecache' => false,
2230 * Allow client-side caching of pages
2232 $wgCachePages = true;
2235 * Set this to current time to invalidate all prior cached pages. Affects both
2236 * client-side and server-side caching.
2237 * You can get the current date on your server by using the command:
2238 * @verbatim
2239 * date +%Y%m%d%H%M%S
2240 * @endverbatim
2242 $wgCacheEpoch = '20030516000000';
2245 * Directory where GitInfo will look for pre-computed cache files. If false,
2246 * $wgCacheDirectory/gitinfo will be used.
2248 $wgGitInfoCacheDirectory = false;
2251 * Bump this number when changing the global style sheets and JavaScript.
2253 * It should be appended in the query string of static CSS and JS includes,
2254 * to ensure that client-side caches do not keep obsolete copies of global
2255 * styles.
2257 $wgStyleVersion = '303';
2260 * This will cache static pages for non-logged-in users to reduce
2261 * database traffic on public sites.
2262 * Automatically sets $wgShowIPinHeader = false
2263 * ResourceLoader requests to default language and skins are cached
2264 * as well as single module requests.
2266 $wgUseFileCache = false;
2269 * Depth of the subdirectory hierarchy to be created under
2270 * $wgFileCacheDirectory. The subdirectories will be named based on
2271 * the MD5 hash of the title. A value of 0 means all cache files will
2272 * be put directly into the main file cache directory.
2274 $wgFileCacheDepth = 2;
2277 * Keep parsed pages in a cache (objectcache table or memcached)
2278 * to speed up output of the same page viewed by another user with the
2279 * same options.
2281 * This can provide a significant speedup for medium to large pages,
2282 * so you probably want to keep it on. Extensions that conflict with the
2283 * parser cache should disable the cache on a per-page basis instead.
2285 $wgEnableParserCache = true;
2288 * Append a configured value to the parser cache and the sitenotice key so
2289 * that they can be kept separate for some class of activity.
2291 $wgRenderHashAppend = '';
2294 * If on, the sidebar navigation links are cached for users with the
2295 * current language set. This can save a touch of load on a busy site
2296 * by shaving off extra message lookups.
2298 * However it is also fragile: changing the site configuration, or
2299 * having a variable $wgArticlePath, can produce broken links that
2300 * don't update as expected.
2302 $wgEnableSidebarCache = false;
2305 * Expiry time for the sidebar cache, in seconds
2307 $wgSidebarCacheExpiry = 86400;
2310 * When using the file cache, we can store the cached HTML gzipped to save disk
2311 * space. Pages will then also be served compressed to clients that support it.
2313 * Requires zlib support enabled in PHP.
2315 $wgUseGzip = false;
2318 * Whether MediaWiki should send an ETag header. Seems to cause
2319 * broken behavior with Squid 2.6, see bug 7098.
2321 $wgUseETag = false;
2324 * Clock skew or the one-second resolution of time() can occasionally cause cache
2325 * problems when the user requests two pages within a short period of time. This
2326 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2327 * a grace period.
2329 $wgClockSkewFudge = 5;
2332 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2333 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2334 * was previously done in the default LocalSettings.php file.
2336 * On high-traffic wikis, this should be set to false, to avoid the need to
2337 * check the file modification time, and to avoid the performance impact of
2338 * unnecessary cache invalidations.
2340 $wgInvalidateCacheOnLocalSettingsChange = true;
2342 /** @} */ # end of cache settings
2344 /************************************************************************//**
2345 * @name HTTP proxy (Squid) settings
2347 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2348 * although they are referred to as Squid settings for historical reasons.
2350 * Achieving a high hit ratio with an HTTP proxy requires special
2351 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2352 * more details.
2354 * @{
2358 * Enable/disable Squid.
2359 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2361 $wgUseSquid = false;
2364 * If you run Squid3 with ESI support, enable this (default:false):
2366 $wgUseESI = false;
2369 * Send X-Vary-Options header for better caching (requires patched Squid)
2371 $wgUseXVO = false;
2374 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2375 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2376 * and need to split the cache between HTTP and HTTPS for API requests,
2377 * feed requests and HTTP redirect responses in order to prevent cache
2378 * pollution. This does not affect 'normal' requests to index.php other than
2379 * HTTP redirects.
2381 $wgVaryOnXFP = false;
2384 * Internal server name as known to Squid, if different.
2386 * @par Example:
2387 * @code
2388 * $wgInternalServer = 'http://yourinternal.tld:8000';
2389 * @endcode
2391 $wgInternalServer = false;
2394 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2395 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2396 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2397 * days
2399 $wgSquidMaxage = 18000;
2402 * Default maximum age for raw CSS/JS accesses
2404 $wgForcedRawSMaxage = 300;
2407 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2409 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2410 * headers sent/modified from these proxies when obtaining the remote IP address
2412 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2414 $wgSquidServers = array();
2417 * As above, except these servers aren't purged on page changes; use to set a
2418 * list of trusted proxies, etc. Supports both individual IP addresses and
2419 * CIDR blocks.
2420 * @since 1.23 Supports CIDR ranges
2422 $wgSquidServersNoPurge = array();
2425 * Maximum number of titles to purge in any one client operation
2427 $wgMaxSquidPurgeTitles = 400;
2430 * Whether to use a Host header in purge requests sent to the proxy servers
2431 * configured in $wgSquidServers. Set this to false to support Squid
2432 * configured in forward-proxy mode.
2434 * If this is set to true, a Host header will be sent, and only the path
2435 * component of the URL will appear on the request line, as if the request
2436 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2437 * request. Squid supports this style of request only if reverse-proxy mode
2438 * (http_port ... accel) is enabled.
2440 * If this is set to false, no Host header will be sent, and the absolute URL
2441 * will be sent in the request line, as is the standard for an HTTP proxy
2442 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2443 * by Varnish, but is supported by Squid in either configuration (forward or
2444 * reverse).
2446 * @since 1.21
2448 $wgSquidPurgeUseHostHeader = true;
2451 * Routing configuration for HTCP multicast purging. Add elements here to
2452 * enable HTCP and determine which purges are sent where. If set to an empty
2453 * array, HTCP is disabled.
2455 * Each key in this array is a regular expression to match against the purged
2456 * URL, or an empty string to match all URLs. The purged URL is matched against
2457 * the regexes in the order specified, and the first rule whose regex matches
2458 * is used, all remaining rules will thus be ignored.
2460 * @par Example configuration to send purges for upload.wikimedia.org to one
2461 * multicast group and all other purges to another:
2462 * @code
2463 * $wgHTCPRouting = array(
2464 * '|^https?://upload\.wikimedia\.org|' => array(
2465 * 'host' => '239.128.0.113',
2466 * 'port' => 4827,
2467 * ),
2468 * '' => array(
2469 * 'host' => '239.128.0.112',
2470 * 'port' => 4827,
2471 * ),
2472 * );
2473 * @endcode
2475 * You can also pass an array of hosts to send purges too. This is useful when
2476 * you have several multicast groups or unicast address that should receive a
2477 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2479 * @par Example of sending purges to multiple hosts:
2480 * @code
2481 * $wgHTCPRouting = array(
2482 * '' => array(
2483 * // Purges to text caches using multicast
2484 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2485 * // Purges to a hardcoded list of caches
2486 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2487 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2488 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2489 * ),
2490 * );
2491 * @endcode
2493 * @since 1.22
2495 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2496 * For back compatibility purposes, whenever its array is empty
2497 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2499 * @see $wgHTCPMulticastTTL
2501 $wgHTCPRouting = array();
2504 * HTCP multicast TTL.
2505 * @see $wgHTCPRouting
2507 $wgHTCPMulticastTTL = 1;
2510 * Should forwarded Private IPs be accepted?
2512 $wgUsePrivateIPs = false;
2514 /** @} */ # end of HTTP proxy settings
2516 /************************************************************************//**
2517 * @name Language, regional and character encoding settings
2518 * @{
2522 * Site language code. See languages/Names.php for languages supported by
2523 * MediaWiki out of the box. Not all languages listed there have translations,
2524 * see languages/messages/ for the list of languages with some localisation.
2526 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2527 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2529 * This defines the default interface language for all users, but users can
2530 * change it in their preferences.
2532 * This also defines the language of pages in the wiki. The content is wrapped
2533 * in a html element with lang=XX attribute. This behavior can be overridden
2534 * via hooks, see Title::getPageLanguage.
2536 $wgLanguageCode = 'en';
2539 * Language cache size, or really how many languages can we handle
2540 * simultaneously without degrading to crawl speed.
2542 $wgLangObjCacheSize = 10;
2545 * Some languages need different word forms, usually for different cases.
2546 * Used in Language::convertGrammar().
2548 * @par Example:
2549 * @code
2550 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2551 * @endcode
2553 $wgGrammarForms = array();
2556 * Treat language links as magic connectors, not inline links
2558 $wgInterwikiMagic = true;
2561 * Hide interlanguage links from the sidebar
2563 $wgHideInterlanguageLinks = false;
2566 * List of additional interwiki prefixes that should be treated as
2567 * interlanguage links (i.e. placed in the sidebar).
2568 * Notes:
2569 * - This will not do anything unless the prefixes are defined in the interwiki
2570 * map.
2571 * - The display text for these custom interlanguage links will be fetched from
2572 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2573 * this array.
2574 * - A friendly name for each site, used for tooltip text, may optionally be
2575 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2576 * the prefix in this array.
2578 $wgExtraInterlanguageLinkPrefixes = array();
2581 * List of language names or overrides for default names in Names.php
2583 $wgExtraLanguageNames = array();
2586 * List of language codes that don't correspond to an actual language.
2587 * These codes are mostly left-offs from renames, or other legacy things.
2588 * This array makes them not appear as a selectable language on the installer,
2589 * and excludes them when running the transstat.php script.
2591 $wgDummyLanguageCodes = array(
2592 'als' => 'gsw',
2593 'bat-smg' => 'sgs',
2594 'be-x-old' => 'be-tarask',
2595 'bh' => 'bho',
2596 'fiu-vro' => 'vro',
2597 'no' => 'nb',
2598 'qqq' => 'qqq', # Used for message documentation.
2599 'qqx' => 'qqx', # Used for viewing message keys.
2600 'roa-rup' => 'rup',
2601 'simple' => 'en',
2602 'zh-classical' => 'lzh',
2603 'zh-min-nan' => 'nan',
2604 'zh-yue' => 'yue',
2608 * Character set for use in the article edit box. Language-specific encodings
2609 * may be defined.
2611 * This historic feature is one of the first that was added by former MediaWiki
2612 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2614 $wgEditEncoding = '';
2617 * Set this to true to replace Arabic presentation forms with their standard
2618 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2619 * set to "ar".
2621 * Note that pages with titles containing presentation forms will become
2622 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2624 $wgFixArabicUnicode = true;
2627 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2628 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2629 * set to "ml". Note that some clients (even new clients as of 2010) do not
2630 * support these characters.
2632 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2633 * fix any ZWJ sequences in existing page titles.
2635 $wgFixMalayalamUnicode = true;
2638 * Set this to always convert certain Unicode sequences to modern ones
2639 * regardless of the content language. This has a small performance
2640 * impact.
2642 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2643 * details.
2645 * @since 1.17
2647 $wgAllUnicodeFixes = false;
2650 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2651 * loading old revisions not marked with "utf-8" flag. Use this when
2652 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2653 * burdensome mass conversion of old text data.
2655 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2656 * user names, etc still must be converted en masse in the database before
2657 * continuing as a UTF-8 wiki.
2659 $wgLegacyEncoding = false;
2662 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2663 * regexps : "/regexp/" matching problematic browsers. These browsers will
2664 * be served encoded unicode in the edit box instead of real unicode.
2666 $wgBrowserBlackList = array(
2668 * Netscape 2-4 detection
2669 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2670 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2671 * with a negative assertion. The [UIN] identifier specifies the level of security
2672 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2673 * The language string is unreliable, it is missing on NS4 Mac.
2675 * Reference: http://www.psychedelix.com/agents/index.shtml
2677 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2678 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2679 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2682 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2683 * Þ to <THORN> and Ð to <ETH>
2685 * Known useragents:
2686 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2687 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2688 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2689 * - [...]
2691 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2692 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2694 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2697 * Google wireless transcoder, seems to eat a lot of chars alive
2698 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2700 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2704 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2705 * create stub reference rows in the text table instead of copying
2706 * the full text of all current entries from 'cur' to 'text'.
2708 * This will speed up the conversion step for large sites, but
2709 * requires that the cur table be kept around for those revisions
2710 * to remain viewable.
2712 * This option affects the updaters *only*. Any present cur stub
2713 * revisions will be readable at runtime regardless of this setting.
2715 $wgLegacySchemaConversion = false;
2718 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2719 * the interface is set to English.
2721 $wgAmericanDates = false;
2724 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2725 * numerals in interface.
2727 $wgTranslateNumerals = true;
2730 * Translation using MediaWiki: namespace.
2731 * Interface messages will be loaded from the database.
2733 $wgUseDatabaseMessages = true;
2736 * Expiry time for the message cache key
2738 $wgMsgCacheExpiry = 86400;
2741 * Maximum entry size in the message cache, in bytes
2743 $wgMaxMsgCacheEntrySize = 10000;
2746 * Whether to enable language variant conversion.
2748 $wgDisableLangConversion = false;
2751 * Whether to enable language variant conversion for links.
2753 $wgDisableTitleConversion = false;
2756 * Default variant code, if false, the default will be the language code
2758 $wgDefaultLanguageVariant = false;
2761 * Disabled variants array of language variant conversion.
2763 * @par Example:
2764 * @code
2765 * $wgDisabledVariants[] = 'zh-mo';
2766 * $wgDisabledVariants[] = 'zh-my';
2767 * @endcode
2769 $wgDisabledVariants = array();
2772 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2773 * path format that describes which parts of the URL contain the
2774 * language variant.
2776 * @par Example:
2777 * @code
2778 * $wgLanguageCode = 'sr';
2779 * $wgVariantArticlePath = '/$2/$1';
2780 * $wgArticlePath = '/wiki/$1';
2781 * @endcode
2783 * A link to /wiki/ would be redirected to /sr/Главна_страна
2785 * It is important that $wgArticlePath not overlap with possible values
2786 * of $wgVariantArticlePath.
2788 $wgVariantArticlePath = false;
2791 * Show a bar of language selection links in the user login and user
2792 * registration forms; edit the "loginlanguagelinks" message to
2793 * customise these.
2795 $wgLoginLanguageSelector = false;
2798 * When translating messages with wfMessage(), it is not always clear what
2799 * should be considered UI messages and what should be content messages.
2801 * For example, for the English Wikipedia, there should be only one 'mainpage',
2802 * so when getting the link for 'mainpage', we should treat it as site content
2803 * and call ->inContentLanguage()->text(), but for rendering the text of the
2804 * link, we call ->text(). The code behaves this way by default. However,
2805 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2806 * and the like for different languages. This array provides a way to override
2807 * the default behavior.
2809 * @par Example:
2810 * To allow language-specific main page and community
2811 * portal:
2812 * @code
2813 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2814 * @endcode
2816 $wgForceUIMsgAsContentMsg = array();
2819 * Fake out the timezone that the server thinks it's in. This will be used for
2820 * date display and not for what's stored in the DB. Leave to null to retain
2821 * your server's OS-based timezone value.
2823 * This variable is currently used only for signature formatting and for local
2824 * time/date parser variables ({{LOCALTIME}} etc.)
2826 * Timezones can be translated by editing MediaWiki messages of type
2827 * timezone-nameinlowercase like timezone-utc.
2829 * A list of usable timezones can found at:
2830 * http://php.net/manual/en/timezones.php
2832 * @par Examples:
2833 * @code
2834 * $wgLocaltimezone = 'UTC';
2835 * $wgLocaltimezone = 'GMT';
2836 * $wgLocaltimezone = 'PST8PDT';
2837 * $wgLocaltimezone = 'Europe/Sweden';
2838 * $wgLocaltimezone = 'CET';
2839 * @endcode
2841 $wgLocaltimezone = null;
2844 * Set an offset from UTC in minutes to use for the default timezone setting
2845 * for anonymous users and new user accounts.
2847 * This setting is used for most date/time displays in the software, and is
2848 * overridable in user preferences. It is *not* used for signature timestamps.
2850 * By default, this will be set to match $wgLocaltimezone.
2852 $wgLocalTZoffset = null;
2854 /** @} */ # End of language/charset settings
2856 /*************************************************************************//**
2857 * @name Output format and skin settings
2858 * @{
2862 * The default Content-Type header.
2864 $wgMimeType = 'text/html';
2867 * Previously used as content type in HTML script tags. This is now ignored since
2868 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2869 * It was also previously used by RawAction to determine the ctype query parameter
2870 * value that will result in a javascript response.
2871 * @deprecated since 1.22
2873 $wgJsMimeType = null;
2876 * The default xmlns attribute. The option to define this has been removed.
2877 * The value of this variable is no longer used by core and is set to a fixed
2878 * value in Setup.php for compatibility with extensions that depend on the value
2879 * of this variable being set. Such a dependency however is deprecated.
2880 * @deprecated since 1.22
2882 $wgXhtmlDefaultNamespace = null;
2885 * Previously used to determine if we should output an HTML5 doctype.
2886 * This is no longer used as we always output HTML5 now. For compatibility with
2887 * extensions that still check the value of this config it's value is now forced
2888 * to true by Setup.php.
2889 * @deprecated since 1.22
2891 $wgHtml5 = true;
2894 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2895 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2896 * (like if it's left at the default null value), it will be auto-initialized
2897 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2898 * ever actually set this to anything.
2900 $wgHtml5Version = null;
2903 * Temporary variable that allows HTMLForms to be rendered as tables.
2904 * Table based layouts cause various issues when designing for mobile.
2905 * This global allows skins or extensions a means to force non-table based rendering.
2906 * Setting to false forces form components to always render as div elements.
2907 * @since 1.24
2909 $wgHTMLFormAllowTableFormat = true;
2912 * Temporary variable that applies MediaWiki UI wherever it can be supported.
2913 * Temporary variable that should be removed when mediawiki ui is more
2914 * stable and change has been communicated.
2915 * @since 1.24
2917 $wgUseMediaWikiUIEverywhere = false;
2920 * Enabled RDFa attributes for use in wikitext.
2921 * NOTE: Interaction with HTML5 is somewhat underspecified.
2923 $wgAllowRdfaAttributes = false;
2926 * Enabled HTML5 microdata attributes for use in wikitext.
2928 $wgAllowMicrodataAttributes = false;
2931 * Should we try to make our HTML output well-formed XML? If set to false,
2932 * output will be a few bytes shorter, and the HTML will arguably be more
2933 * readable. If set to true, life will be much easier for the authors of
2934 * screen-scraping bots, and the HTML will arguably be more readable.
2936 * Setting this to false may omit quotation marks on some attributes, omit
2937 * slashes from some self-closing tags, omit some ending tags, etc., where
2938 * permitted by HTML5. Setting it to true will not guarantee that all pages
2939 * will be well-formed, although non-well-formed pages should be rare and it's
2940 * a bug if you find one. Conversely, setting it to false doesn't mean that
2941 * all XML-y constructs will be omitted, just that they might be.
2943 * Because of compatibility with screen-scraping bots, and because it's
2944 * controversial, this is currently left to true by default.
2946 $wgWellFormedXml = true;
2949 * Permit other namespaces in addition to the w3.org default.
2951 * Use the prefix for the key and the namespace for the value.
2953 * @par Example:
2954 * @code
2955 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2956 * @endcode
2957 * Normally we wouldn't have to define this in the root "<html>"
2958 * element, but IE needs it there in some circumstances.
2960 * This is ignored if $wgMimeType is set to a non-XML MIME type.
2962 $wgXhtmlNamespaces = array();
2965 * Show IP address, for non-logged in users. It's necessary to switch this off
2966 * for some forms of caching.
2967 * @warning Will disable file cache.
2969 $wgShowIPinHeader = true;
2972 * Site notice shown at the top of each page
2974 * MediaWiki:Sitenotice page, which will override this. You can also
2975 * provide a separate message for logged-out users using the
2976 * MediaWiki:Anonnotice page.
2978 $wgSiteNotice = '';
2981 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2983 $wgSiteSupportPage = '';
2986 * Validate the overall output using tidy and refuse
2987 * to display the page if it's not valid.
2989 $wgValidateAllHtml = false;
2992 * Default skin, for new users and anonymous visitors. Registered users may
2993 * change this to any one of the other available skins in their preferences.
2995 $wgDefaultSkin = 'vector';
2998 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3000 * @since 1.24
3002 $wgFallbackSkin = 'fallback';
3005 * Specify the names of skins that should not be presented in the list of
3006 * available skins in user preferences. If you want to remove a skin entirely,
3007 * remove it from the skins/ directory and its entry from LocalSettings.php.
3009 $wgSkipSkins = array();
3012 * @deprecated since 1.23; use $wgSkipSkins instead
3014 $wgSkipSkin = '';
3017 * Allow user Javascript page?
3018 * This enables a lot of neat customizations, but may
3019 * increase security risk to users and server load.
3021 $wgAllowUserJs = false;
3024 * Allow user Cascading Style Sheets (CSS)?
3025 * This enables a lot of neat customizations, but may
3026 * increase security risk to users and server load.
3028 $wgAllowUserCss = false;
3031 * Allow user-preferences implemented in CSS?
3032 * This allows users to customise the site appearance to a greater
3033 * degree; disabling it will improve page load times.
3035 $wgAllowUserCssPrefs = true;
3038 * Use the site's Javascript page?
3040 $wgUseSiteJs = true;
3043 * Use the site's Cascading Style Sheets (CSS)?
3045 $wgUseSiteCss = true;
3048 * Break out of framesets. This can be used to prevent clickjacking attacks,
3049 * or to prevent external sites from framing your site with ads.
3051 $wgBreakFrames = false;
3054 * The X-Frame-Options header to send on pages sensitive to clickjacking
3055 * attacks, such as edit pages. This prevents those pages from being displayed
3056 * in a frame or iframe. The options are:
3058 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3060 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3061 * to allow framing within a trusted domain. This is insecure if there
3062 * is a page on the same domain which allows framing of arbitrary URLs.
3064 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3065 * full compromise of local user accounts. Private wikis behind a
3066 * corporate firewall are especially vulnerable. This is not
3067 * recommended.
3069 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3070 * not just edit pages.
3072 $wgEditPageFrameOptions = 'DENY';
3075 * Disallow framing of API pages directly, by setting the X-Frame-Options
3076 * header. Since the API returns CSRF tokens, allowing the results to be
3077 * framed can compromise your user's account security.
3078 * Options are:
3079 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3080 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3081 * - false: Allow all framing.
3082 * Note: $wgBreakFrames will override this for human formatted API output.
3084 $wgApiFrameOptions = 'DENY';
3087 * Disable output compression (enabled by default if zlib is available)
3089 $wgDisableOutputCompression = false;
3092 * Should we allow a broader set of characters in id attributes, per HTML5? If
3093 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3094 * functionality is ready, it will be on by default with no option.
3096 * Currently this appears to work fine in all browsers, but it's disabled by
3097 * default because it normalizes id's a bit too aggressively, breaking preexisting
3098 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3100 $wgExperimentalHtmlIds = false;
3103 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3104 * You can add new icons to the built in copyright or poweredby, or you can create
3105 * a new block. Though note that you may need to add some custom css to get good styling
3106 * of new blocks in monobook. vector and modern should work without any special css.
3108 * $wgFooterIcons itself is a key/value array.
3109 * The key is the name of a block that the icons will be wrapped in. The final id varies
3110 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3111 * turns it into mw_poweredby.
3112 * The value is either key/value array of icons or a string.
3113 * In the key/value array the key may or may not be used by the skin but it can
3114 * be used to find the icon and unset it or change the icon if needed.
3115 * This is useful for disabling icons that are set by extensions.
3116 * The value should be either a string or an array. If it is a string it will be output
3117 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3118 * for the icon, the following keys are used:
3119 * - src: An absolute url to the image to use for the icon, this is recommended
3120 * but not required, however some skins will ignore icons without an image
3121 * - url: The url to use in the a element around the text or icon, if not set an a element will
3122 * not be outputted
3123 * - alt: This is the text form of the icon, it will be displayed without an image in
3124 * skins like Modern or if src is not set, and will otherwise be used as
3125 * the alt="" for the image. This key is required.
3126 * - width and height: If the icon specified by src is not of the standard size
3127 * you can specify the size of image to use with these keys.
3128 * Otherwise they will default to the standard 88x31.
3129 * @todo Reformat documentation.
3131 $wgFooterIcons = array(
3132 "copyright" => array(
3133 "copyright" => array(), // placeholder for the built in copyright icon
3135 "poweredby" => array(
3136 "mediawiki" => array(
3137 "src" => null, // Defaults to "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3138 "url" => "//www.mediawiki.org/",
3139 "alt" => "Powered by MediaWiki",
3145 * Login / create account link behavior when it's possible for anonymous users
3146 * to create an account.
3147 * - true = use a combined login / create account link
3148 * - false = split login and create account into two separate links
3150 $wgUseCombinedLoginLink = false;
3153 * Display user edit counts in various prominent places.
3155 $wgEdititis = false;
3158 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3159 * status code, mangling or hiding MediaWiki's output. If you are using such a
3160 * host, you should start looking for a better one. While you're doing that,
3161 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3162 * that the generated error pages can be seen.
3164 * In cases where for technical reasons it is more important for MediaWiki to
3165 * send the correct status code than for the body to be transmitted intact,
3166 * this configuration variable is ignored.
3168 $wgSend404Code = true;
3171 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3172 * rollback. The numeric value of the variable are the limit up to are counted.
3173 * If the value is false or 0, the edits are not counted. Disabling this will
3174 * furthermore prevent MediaWiki from hiding some useless rollback links.
3176 * @since 1.20
3178 $wgShowRollbackEditCount = 10;
3181 * Output a <link rel="canonical"> tag on every page indicating the canonical
3182 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3183 * detection of the current server is unreliable, the link is sent
3184 * unconditionally.
3186 $wgEnableCanonicalServerLink = false;
3188 /** @} */ # End of output format settings }
3190 /*************************************************************************//**
3191 * @name Resource loader settings
3192 * @{
3196 * Client-side resource modules.
3198 * Extensions should add their resource loader module definitions
3199 * to the $wgResourceModules variable.
3201 * @par Example:
3202 * @code
3203 * $wgResourceModules['ext.myExtension'] = array(
3204 * 'scripts' => 'myExtension.js',
3205 * 'styles' => 'myExtension.css',
3206 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3207 * 'localBasePath' => __DIR__,
3208 * 'remoteExtPath' => 'MyExtension',
3209 * );
3210 * @endcode
3212 $wgResourceModules = array();
3215 * Skin-specific styles for resource modules.
3217 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3218 * not be modified or disabled.
3220 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3222 * @par Example:
3223 * @code
3224 * $wgResourceModules['bar'] = array(
3225 * 'scripts' => 'resources/bar/bar.js',
3226 * 'styles' => 'resources/bar/main.css',
3227 * );
3229 * $wgResourceModuleSkinStyles['foo'] = array(
3230 * 'bar' => 'skins/Foo/bar.css',
3231 * );
3232 * @endcode
3234 * This is mostly equivalent to:
3236 * @par Equivalent:
3237 * @code
3238 * $wgResourceModules['bar'] = array(
3239 * 'scripts' => 'resources/bar/bar.js',
3240 * 'styles' => 'resources/bar/main.css',
3241 * 'skinStyles' => array(
3242 * 'foo' => skins/Foo/bar.css',
3243 * ),
3244 * );
3245 * @endcode
3247 * If the module already defines its own entry in `skinStyles` for a given skin, then
3248 * $wgResourceModuleSkinStyles is ignored.
3250 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3251 * of replacing them. This can be done using the `+` prefix.
3253 * @par Example:
3254 * @code
3255 * $wgResourceModules['bar'] = array(
3256 * 'scripts' => 'resources/bar/bar.js',
3257 * 'styles' => 'resources/bar/basic.css',
3258 * 'skinStyles' => array(
3259 * 'default' => 'resources/bar/additional.css',
3260 * ),
3261 * );
3262 * // Note the '+' character:
3263 * $wgResourceModuleSkinStyles['+foo'] = array(
3264 * 'bar' => 'skins/Foo/bar.css',
3265 * );
3266 * @endcode
3268 * This is mostly equivalent to:
3270 * @par Equivalent:
3271 * @code
3272 * $wgResourceModules['bar'] = array(
3273 * 'scripts' => 'resources/bar/bar.js',
3274 * 'styles' => 'resources/bar/basic.css',
3275 * 'skinStyles' => array(
3276 * 'default' => 'resources/bar/additional.css',
3277 * 'foo' => array(
3278 * 'resources/bar/additional.css',
3279 * 'skins/Foo/bar.css',
3280 * ),
3281 * ),
3282 * );
3283 * @endcode
3285 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3286 * disabled by a skin. To provide default styles that may be extended or replaced,
3287 * use `skinStyles['default']`.
3289 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3290 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3291 * Either for all skin styles at once (first example below) or for each module separately (second
3292 * example).
3294 * @par Example:
3295 * @code
3296 * $wgResourceModuleSkinStyles['foo'] = array(
3297 * 'bar' => 'bar.css',
3298 * 'quux' => 'quux.css',
3299 * 'remoteSkinPath' => 'Foo',
3300 * 'localBasePath' => __DIR__,
3301 * );
3303 * $wgResourceModuleSkinStyles['foo'] = array(
3304 * 'bar' => array(
3305 * 'bar.css',
3306 * 'remoteSkinPath' => 'Foo',
3307 * 'localBasePath' => __DIR__,
3308 * ),
3309 * 'quux' => array(
3310 * 'quux.css',
3311 * 'remoteSkinPath' => 'Foo',
3312 * 'localBasePath' => __DIR__,
3313 * ),
3314 * );
3315 * @endcode
3317 $wgResourceModuleSkinStyles = array();
3320 * Extensions should register foreign module sources here. 'local' is a
3321 * built-in source that is not in this array, but defined by
3322 * ResourceLoader::__construct() so that it cannot be unset.
3324 * @par Example:
3325 * @code
3326 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3327 * @endcode
3329 $wgResourceLoaderSources = array();
3332 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3333 * If not set, then $wgScriptPath will be used as a fallback.
3335 $wgResourceBasePath = null;
3338 * Maximum time in seconds to cache resources served by the resource loader.
3339 * Used to set last modified headers (max-age/s-maxage).
3341 * Following options to distinguish:
3342 * - versioned: Used for modules with a version, because changing version
3343 * numbers causes cache misses. This normally has a long expiry time.
3344 * - unversioned: Used for modules without a version to propagate changes
3345 * quickly to clients. Also used for modules with errors to recover quickly.
3346 * This normally has a short expiry time.
3348 * Expiry time for the options to distinguish:
3349 * - server: Squid/Varnish but also any other public proxy cache between the
3350 * client and MediaWiki.
3351 * - client: On the client side (e.g. in the browser cache).
3353 $wgResourceLoaderMaxage = array(
3354 'versioned' => array(
3355 'server' => 30 * 24 * 60 * 60, // 30 days
3356 'client' => 30 * 24 * 60 * 60, // 30 days
3358 'unversioned' => array(
3359 'server' => 5 * 60, // 5 minutes
3360 'client' => 5 * 60, // 5 minutes
3365 * The default debug mode (on/off) for of ResourceLoader requests.
3367 * This will still be overridden when the debug URL parameter is used.
3369 $wgResourceLoaderDebug = false;
3372 * Enable embedding of certain resources using Edge Side Includes. This will
3373 * improve performance but only works if there is something in front of the
3374 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3376 $wgResourceLoaderUseESI = false;
3379 * Put each statement on its own line when minifying JavaScript. This makes
3380 * debugging in non-debug mode a bit easier.
3382 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3385 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3386 * the minifier will try not to produce lines longer than this, but may be
3387 * forced to do so in certain cases.
3389 $wgResourceLoaderMinifierMaxLineLength = 1000;
3392 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3393 * dependencies.
3395 $wgIncludeLegacyJavaScript = true;
3398 * Whether to include the jQuery Migrate library, which lets legacy JS that
3399 * requires jQuery 1.8.x to work and breaks with 1.9.x+.
3401 * @since 1.24
3402 * @deprecated since 1.24, to be removed in 1.25
3404 $wgIncludejQueryMigrate = false;
3407 * Whether to preload the mediawiki.util module as blocking module in the top
3408 * queue.
3410 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3411 * allowed modules to lack dependencies on 'popular' modules that were likely
3412 * loaded already.
3414 * This setting is to aid scripts during migration by providing mediawiki.util
3415 * unconditionally (which was the most commonly missed dependency).
3416 * It doesn't cover all missing dependencies obviously but should fix most of
3417 * them.
3419 * This should be removed at some point after site/user scripts have been fixed.
3420 * Enable this if your wiki has a large amount of user/site scripts that are
3421 * lacking dependencies.
3422 * @todo Deprecate
3424 $wgPreloadJavaScriptMwUtil = false;
3427 * Whether or not to assign configuration variables to the global window object.
3429 * If this is set to false, old code using deprecated variables will no longer
3430 * work.
3432 * @par Example of legacy code:
3433 * @code{,js}
3434 * if ( window.wgRestrictionEdit ) { ... }
3435 * @endcode
3436 * or:
3437 * @code{,js}
3438 * if ( wgIsArticle ) { ... }
3439 * @endcode
3441 * Instead, one needs to use mw.config.
3442 * @par Example using mw.config global configuration:
3443 * @code{,js}
3444 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3445 * @endcode
3446 * or:
3447 * @code{,js}
3448 * if ( mw.config.get('wgIsArticle') ) { ... }
3449 * @endcode
3451 $wgLegacyJavaScriptGlobals = true;
3454 * If set to a positive number, ResourceLoader will not generate URLs whose
3455 * query string is more than this many characters long, and will instead use
3456 * multiple requests with shorter query strings. This degrades performance,
3457 * but may be needed if your web server has a low (less than, say 1024)
3458 * query string length limit or a low value for suhosin.get.max_value_length
3459 * that you can't increase.
3461 * If set to a negative number, ResourceLoader will assume there is no query
3462 * string length limit.
3464 * Defaults to a value based on php configuration.
3466 $wgResourceLoaderMaxQueryLength = false;
3469 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3470 * prior to minification to validate it.
3472 * Parse errors will result in a JS exception being thrown during module load,
3473 * which avoids breaking other modules loaded in the same request.
3475 $wgResourceLoaderValidateJS = true;
3478 * If set to true, statically-sourced (file-backed) JavaScript resources will
3479 * be parsed for validity before being bundled up into ResourceLoader modules.
3481 * This can be helpful for development by providing better error messages in
3482 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3483 * and may fail on large pre-bundled frameworks.
3485 $wgResourceLoaderValidateStaticJS = false;
3488 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3489 * will be enabled. This is an experimental feature that's supposed to make
3490 * JavaScript load faster.
3492 $wgResourceLoaderExperimentalAsyncLoading = false;
3495 * Global LESS variables. An associative array binding variable names to
3496 * LESS code snippets representing their values.
3498 * Adding an item here is equivalent to writing `@variable: value;`
3499 * at the beginning of all your .less files, with all the consequences.
3500 * In particular, string values must be escaped and quoted.
3502 * Changes to LESS variables do not trigger cache invalidation.
3504 * @par Example:
3505 * @code
3506 * $wgResourceLoaderLESSVars = array(
3507 * 'baseFontSize' => '1em',
3508 * 'smallFontSize' => '0.75em',
3509 * 'WikimediaBlue' => '#006699',
3510 * );
3511 * @endcode
3512 * @since 1.22
3514 $wgResourceLoaderLESSVars = array();
3517 * Custom LESS functions. An associative array mapping function name to PHP
3518 * callable.
3520 * Changes to LESS functions do not trigger cache invalidation.
3522 * @since 1.22
3523 * @deprecated since 1.24 Questionable usefulness and problematic to support,
3524 * will be removed in the future.
3526 $wgResourceLoaderLESSFunctions = array();
3529 * Default import paths for LESS modules. LESS files referenced in @import
3530 * statements will be looked up here first, and relative to the importing file
3531 * second. To avoid collisions, it's important for the LESS files in these
3532 * directories to have a common, predictable file name prefix.
3534 * Extensions need not (and should not) register paths in
3535 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3536 * currently compiling LESS file, which allows each extension to freely import
3537 * files from its own tree.
3539 * @since 1.22
3541 $wgResourceLoaderLESSImportPaths = array(
3542 "$IP/resources/src/mediawiki.less/",
3546 * Whether ResourceLoader should attempt to persist modules in localStorage on
3547 * browsers that support the Web Storage API.
3549 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3551 $wgResourceLoaderStorageEnabled = false;
3554 * Cache version for client-side ResourceLoader module storage. You can trigger
3555 * invalidation of the contents of the module store by incrementing this value.
3557 * @since 1.23
3559 $wgResourceLoaderStorageVersion = 1;
3561 /** @} */ # End of resource loader settings }
3563 /*************************************************************************//**
3564 * @name Page title and interwiki link settings
3565 * @{
3569 * Name of the project namespace. If left set to false, $wgSitename will be
3570 * used instead.
3572 $wgMetaNamespace = false;
3575 * Name of the project talk namespace.
3577 * Normally you can ignore this and it will be something like
3578 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3579 * manually for grammatical reasons.
3581 $wgMetaNamespaceTalk = false;
3584 * Additional namespaces. If the namespaces defined in Language.php and
3585 * Namespace.php are insufficient, you can create new ones here, for example,
3586 * to import Help files in other languages. You can also override the namespace
3587 * names of existing namespaces. Extensions developers should use
3588 * $wgCanonicalNamespaceNames.
3590 * @warning Once you delete a namespace, the pages in that namespace will
3591 * no longer be accessible. If you rename it, then you can access them through
3592 * the new namespace name.
3594 * Custom namespaces should start at 100 to avoid conflicting with standard
3595 * namespaces, and should always follow the even/odd main/talk pattern.
3597 * @par Example:
3598 * @code
3599 * $wgExtraNamespaces = array(
3600 * 100 => "Hilfe",
3601 * 101 => "Hilfe_Diskussion",
3602 * 102 => "Aide",
3603 * 103 => "Discussion_Aide"
3604 * );
3605 * @endcode
3607 * @todo Add a note about maintenance/namespaceDupes.php
3609 $wgExtraNamespaces = array();
3612 * Same as above, but for namespaces with gender distinction.
3613 * Note: the default form for the namespace should also be set
3614 * using $wgExtraNamespaces for the same index.
3615 * @since 1.18
3617 $wgExtraGenderNamespaces = array();
3620 * Namespace aliases.
3622 * These are alternate names for the primary localised namespace names, which
3623 * are defined by $wgExtraNamespaces and the language file. If a page is
3624 * requested with such a prefix, the request will be redirected to the primary
3625 * name.
3627 * Set this to a map from namespace names to IDs.
3629 * @par Example:
3630 * @code
3631 * $wgNamespaceAliases = array(
3632 * 'Wikipedian' => NS_USER,
3633 * 'Help' => 100,
3634 * );
3635 * @endcode
3637 $wgNamespaceAliases = array();
3640 * Allowed title characters -- regex character class
3641 * Don't change this unless you know what you're doing
3643 * Problematic punctuation:
3644 * - []{}|# Are needed for link syntax, never enable these
3645 * - <> Causes problems with HTML escaping, don't use
3646 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3647 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3648 * corrupted by apache
3649 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3651 * All three of these punctuation problems can be avoided by using an alias,
3652 * instead of a rewrite rule of either variety.
3654 * The problem with % is that when using a path to query rewrite rule, URLs are
3655 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3656 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3657 * for this, indeed double escaping would break if the double-escaped title was
3658 * passed in the query string rather than the path. This is a minor security issue
3659 * because articles can be created such that they are hard to view or edit.
3661 * In some rare cases you may wish to remove + for compatibility with old links.
3663 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3664 * this breaks interlanguage links
3666 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3669 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3671 * @deprecated since 1.23; use $wgLocalInterwikis instead
3673 $wgLocalInterwiki = false;
3676 * Array for multiple $wgLocalInterwiki values, in case there are several
3677 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3678 * set, its value is prepended to this array, for backwards compatibility.
3680 * Note, recent changes feeds use only the first entry in this array (or
3681 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3683 $wgLocalInterwikis = array();
3686 * Expiry time for cache of interwiki table
3688 $wgInterwikiExpiry = 10800;
3691 * @name Interwiki caching settings.
3692 * @{
3696 *$wgInterwikiCache specifies path to constant database file.
3698 * This cdb database is generated by dumpInterwiki from maintenance and has
3699 * such key formats:
3700 * - dbname:key - a simple key (e.g. enwiki:meta)
3701 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3702 * - __global:key - global-scope key (e.g. __global:meta)
3703 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3705 * Sites mapping just specifies site name, other keys provide "local url"
3706 * data layout.
3708 $wgInterwikiCache = false;
3711 * Specify number of domains to check for messages.
3712 * - 1: Just wiki(db)-level
3713 * - 2: wiki and global levels
3714 * - 3: site levels
3716 $wgInterwikiScopes = 3;
3719 * Fallback site, if unable to resolve from cache
3721 $wgInterwikiFallbackSite = 'wiki';
3723 /** @} */ # end of Interwiki caching settings.
3726 * If local interwikis are set up which allow redirects,
3727 * set this regexp to restrict URLs which will be displayed
3728 * as 'redirected from' links.
3730 * @par Example:
3731 * It might look something like this:
3732 * @code
3733 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3734 * @endcode
3736 * Leave at false to avoid displaying any incoming redirect markers.
3737 * This does not affect intra-wiki redirects, which don't change
3738 * the URL.
3740 $wgRedirectSources = false;
3743 * Set this to false to avoid forcing the first letter of links to capitals.
3745 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3746 * appearing with a capital at the beginning of a sentence will *not* go to the
3747 * same place as links in the middle of a sentence using a lowercase initial.
3749 $wgCapitalLinks = true;
3752 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3753 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3754 * true by default (and setting them has no effect), due to various things that
3755 * require them to be so. Also, since Talk namespaces need to directly mirror their
3756 * associated content namespaces, the values for those are ignored in favor of the
3757 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3758 * NS_FILE.
3760 * @par Example:
3761 * @code
3762 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3763 * @endcode
3765 $wgCapitalLinkOverrides = array();
3768 * Which namespaces should support subpages?
3769 * See Language.php for a list of namespaces.
3771 $wgNamespacesWithSubpages = array(
3772 NS_TALK => true,
3773 NS_USER => true,
3774 NS_USER_TALK => true,
3775 NS_PROJECT => true,
3776 NS_PROJECT_TALK => true,
3777 NS_FILE_TALK => true,
3778 NS_MEDIAWIKI => true,
3779 NS_MEDIAWIKI_TALK => true,
3780 NS_TEMPLATE_TALK => true,
3781 NS_HELP => true,
3782 NS_HELP_TALK => true,
3783 NS_CATEGORY_TALK => true
3787 * Array holding default tracking category names.
3789 * Array contains the system messages for each tracking category.
3790 * Tracking categories allow pages with certain characteristics to be tracked.
3791 * It works by adding any such page to a category automatically.
3793 * A message with the suffix '-desc' should be added as a description message
3794 * to have extra information on Special:TrackingCategories.
3796 * @since 1.23
3798 $wgTrackingCategories = array(
3799 'index-category',
3800 'noindex-category',
3801 'duplicate-args-category',
3802 'expensive-parserfunction-category',
3803 'post-expand-template-argument-category',
3804 'post-expand-template-inclusion-category',
3805 'hidden-category-category',
3806 'broken-file-category',
3807 'node-count-exceeded-category',
3808 'expansion-depth-exceeded-category',
3812 * Array of namespaces which can be deemed to contain valid "content", as far
3813 * as the site statistics are concerned. Useful if additional namespaces also
3814 * contain "content" which should be considered when generating a count of the
3815 * number of articles in the wiki.
3817 $wgContentNamespaces = array( NS_MAIN );
3820 * Max number of redirects to follow when resolving redirects.
3821 * 1 means only the first redirect is followed (default behavior).
3822 * 0 or less means no redirects are followed.
3824 $wgMaxRedirects = 1;
3827 * Array of invalid page redirect targets.
3828 * Attempting to create a redirect to any of the pages in this array
3829 * will make the redirect fail.
3830 * Userlogout is hard-coded, so it does not need to be listed here.
3831 * (bug 10569) Disallow Mypage and Mytalk as well.
3833 * As of now, this only checks special pages. Redirects to pages in
3834 * other namespaces cannot be invalidated by this variable.
3836 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3838 /** @} */ # End of title and interwiki settings }
3840 /************************************************************************//**
3841 * @name Parser settings
3842 * These settings configure the transformation from wikitext to HTML.
3843 * @{
3847 * Parser configuration. Associative array with the following members:
3849 * class The class name
3851 * preprocessorClass The preprocessor class. Two classes are currently available:
3852 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3853 * storage, and Preprocessor_DOM, which uses the DOM module for
3854 * temporary storage. Preprocessor_DOM generally uses less memory;
3855 * the speed of the two is roughly the same.
3857 * If this parameter is not given, it uses Preprocessor_DOM if the
3858 * DOM module is available, otherwise it uses Preprocessor_Hash.
3860 * The entire associative array will be passed through to the constructor as
3861 * the first parameter. Note that only Setup.php can use this variable --
3862 * the configuration will change at runtime via $wgParser member functions, so
3863 * the contents of this variable will be out-of-date. The variable can only be
3864 * changed during LocalSettings.php, in particular, it can't be changed during
3865 * an extension setup function.
3867 $wgParserConf = array(
3868 'class' => 'Parser',
3869 #'preprocessorClass' => 'Preprocessor_Hash',
3873 * Maximum indent level of toc.
3875 $wgMaxTocLevel = 999;
3878 * A complexity limit on template expansion: the maximum number of nodes visited
3879 * by PPFrame::expand()
3881 $wgMaxPPNodeCount = 1000000;
3884 * A complexity limit on template expansion: the maximum number of elements
3885 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3886 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3887 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3888 * this default corresponds to about 155 MB.
3890 * When the limit is exceeded, an exception is thrown.
3892 $wgMaxGeneratedPPNodeCount = 1000000;
3895 * Maximum recursion depth for templates within templates.
3896 * The current parser adds two levels to the PHP call stack for each template,
3897 * and xdebug limits the call stack to 100 by default. So this should hopefully
3898 * stop the parser before it hits the xdebug limit.
3900 $wgMaxTemplateDepth = 40;
3903 * @see $wgMaxTemplateDepth
3905 $wgMaxPPExpandDepth = 40;
3908 * URL schemes that should be recognized as valid by wfParseUrl().
3910 * WARNING: Do not add 'file:' to this or internal file links will be broken.
3911 * Instead, if you want to support file links, add 'file://'. The same applies
3912 * to any other protocols with the same name as a namespace. See bug #44011 for
3913 * more information.
3915 * @see wfParseUrl
3917 $wgUrlProtocols = array(
3918 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3919 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3920 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3921 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3925 * If true, removes (substitutes) templates in "~~~~" signatures.
3927 $wgCleanSignatures = true;
3930 * Whether to allow inline image pointing to other websites
3932 $wgAllowExternalImages = false;
3935 * If the above is false, you can specify an exception here. Image URLs
3936 * that start with this string are then rendered, while all others are not.
3937 * You can use this to set up a trusted, simple repository of images.
3938 * You may also specify an array of strings to allow multiple sites
3940 * @par Examples:
3941 * @code
3942 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3943 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3944 * @endcode
3946 $wgAllowExternalImagesFrom = '';
3949 * If $wgAllowExternalImages is false, you can allow an on-wiki
3950 * whitelist of regular expression fragments to match the image URL
3951 * against. If the image matches one of the regular expression fragments,
3952 * The image will be displayed.
3954 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3955 * Or false to disable it
3957 $wgEnableImageWhitelist = true;
3960 * A different approach to the above: simply allow the "<img>" tag to be used.
3961 * This allows you to specify alt text and other attributes, copy-paste HTML to
3962 * your wiki more easily, etc. However, allowing external images in any manner
3963 * will allow anyone with editing rights to snoop on your visitors' IP
3964 * addresses and so forth, if they wanted to, by inserting links to images on
3965 * sites they control.
3967 $wgAllowImageTag = false;
3970 * $wgUseTidy: use tidy to make sure HTML output is sane.
3971 * Tidy is a free tool that fixes broken HTML.
3972 * See http://www.w3.org/People/Raggett/tidy/
3974 * - $wgTidyBin should be set to the path of the binary and
3975 * - $wgTidyConf to the path of the configuration file.
3976 * - $wgTidyOpts can include any number of parameters.
3977 * - $wgTidyInternal controls the use of the PECL extension or the
3978 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3979 * of spawning a separate program.
3980 * Normally you shouldn't need to override the setting except for
3981 * debugging. To install, use 'pear install tidy' and add a line
3982 * 'extension=tidy.so' to php.ini.
3984 $wgUseTidy = false;
3987 * @see $wgUseTidy
3989 $wgAlwaysUseTidy = false;
3992 * @see $wgUseTidy
3994 $wgTidyBin = 'tidy';
3997 * @see $wgUseTidy
3999 $wgTidyConf = $IP . '/includes/tidy.conf';
4002 * @see $wgUseTidy
4004 $wgTidyOpts = '';
4007 * @see $wgUseTidy
4009 $wgTidyInternal = extension_loaded( 'tidy' );
4012 * Put tidy warnings in HTML comments
4013 * Only works for internal tidy.
4015 $wgDebugTidy = false;
4018 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4019 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4020 * TO RESTRICT EDITING to only those that you trust
4022 $wgRawHtml = false;
4025 * Set a default target for external links, e.g. _blank to pop up a new window
4027 $wgExternalLinkTarget = false;
4030 * If true, external URL links in wiki text will be given the
4031 * rel="nofollow" attribute as a hint to search engines that
4032 * they should not be followed for ranking purposes as they
4033 * are user-supplied and thus subject to spamming.
4035 $wgNoFollowLinks = true;
4038 * Namespaces in which $wgNoFollowLinks doesn't apply.
4039 * See Language.php for a list of namespaces.
4041 $wgNoFollowNsExceptions = array();
4044 * If this is set to an array of domains, external links to these domain names
4045 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4046 * value of $wgNoFollowLinks. For instance:
4048 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4049 * 'mediawiki.org' );
4051 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4052 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4053 * etc.
4055 * Defaults to mediawiki.org for the links included in the software by default.
4057 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4060 * Allow DISPLAYTITLE to change title display
4062 $wgAllowDisplayTitle = true;
4065 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4066 * canonical DB key. Also disallow some inline CSS rules like display: none;
4067 * which can cause the text to be hidden or unselectable.
4069 $wgRestrictDisplayTitle = true;
4072 * Maximum number of calls per parse to expensive parser functions such as
4073 * PAGESINCATEGORY.
4075 $wgExpensiveParserFunctionLimit = 100;
4078 * Preprocessor caching threshold
4079 * Setting it to 'false' will disable the preprocessor cache.
4081 $wgPreprocessorCacheThreshold = 1000;
4084 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4086 $wgEnableScaryTranscluding = false;
4089 * Expiry time for transcluded templates cached in transcache database table.
4090 * Only used $wgEnableInterwikiTranscluding is set to true.
4092 $wgTranscludeCacheExpiry = 3600;
4094 /** @} */ # end of parser settings }
4096 /************************************************************************//**
4097 * @name Statistics
4098 * @{
4102 * Method used to determine if a page in a content namespace should be counted
4103 * as a valid article.
4105 * Redirect pages will never be counted as valid articles.
4107 * This variable can have the following values:
4108 * - 'any': all pages as considered as valid articles
4109 * - 'comma': the page must contain a comma to be considered valid
4110 * - 'link': the page must contain a [[wiki link]] to be considered valid
4112 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4114 * Retroactively changing this variable will not affect the existing count,
4115 * to update it, you will need to run the maintenance/updateArticleCount.php
4116 * script.
4118 $wgArticleCountMethod = 'link';
4121 * How many days user must be idle before he is considered inactive. Will affect
4122 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4123 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4124 * You might want to leave this as the default value, to provide comparable
4125 * numbers between different wikis.
4127 $wgActiveUserDays = 30;
4129 /** @} */ # End of statistics }
4131 /************************************************************************//**
4132 * @name User accounts, authentication
4133 * @{
4137 * For compatibility with old installations set to false
4138 * @deprecated since 1.24 will be removed in future
4140 $wgPasswordSalt = true;
4143 * Specifies the minimal length of a user password. If set to 0, empty pass-
4144 * words are allowed.
4146 $wgMinimalPasswordLength = 1;
4149 * Specifies if users should be sent to a password-reset form on login, if their
4150 * password doesn't meet the requirements of User::isValidPassword().
4151 * @since 1.23
4153 $wgInvalidPasswordReset = true;
4156 * Default password type to use when hashing user passwords
4158 * @since 1.24
4160 $wgPasswordDefault = 'pbkdf2';
4163 * Configuration for built-in password types. Maps the password type
4164 * to an array of options. The 'class' option is the Password class to
4165 * use. All other options are class-dependent.
4167 * An advanced example:
4168 * @code
4169 * $wgPasswordConfig['bcrypt-peppered'] = array(
4170 * 'class' => 'EncryptedPassword',
4171 * 'underlying' => 'bcrypt',
4172 * 'secrets' => array(),
4173 * 'cipher' => MCRYPT_RIJNDAEL_256,
4174 * 'mode' => MCRYPT_MODE_CBC,
4175 * 'cost' => 5,
4176 * );
4177 * @endcode
4179 * @since 1.24
4181 $wgPasswordConfig = array(
4182 'A' => array(
4183 'class' => 'MWOldPassword',
4185 'B' => array(
4186 'class' => 'MWSaltedPassword',
4188 'pbkdf2-legacyA' => array(
4189 'class' => 'LayeredParameterizedPassword',
4190 'types' => array(
4191 'A',
4192 'pbkdf2',
4195 'pbkdf2-legacyB' => array(
4196 'class' => 'LayeredParameterizedPassword',
4197 'types' => array(
4198 'B',
4199 'pbkdf2',
4202 'bcrypt' => array(
4203 'class' => 'BcryptPassword',
4204 'cost' => 9,
4206 'pbkdf2' => array(
4207 'class' => 'Pbkdf2Password',
4208 'algo' => 'sha256',
4209 'cost' => '10000',
4210 'length' => '128',
4215 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4216 * with a temporary password you can use to get back into the account") identified by
4217 * various bits of data. Setting all of these to false (or the whole variable to false)
4218 * has the effect of disabling password resets entirely
4220 $wgPasswordResetRoutes = array(
4221 'username' => true,
4222 'email' => false,
4226 * Maximum number of Unicode characters in signature
4228 $wgMaxSigChars = 255;
4231 * Maximum number of bytes in username. You want to run the maintenance
4232 * script ./maintenance/checkUsernames.php once you have changed this value.
4234 $wgMaxNameChars = 255;
4237 * Array of usernames which may not be registered or logged in from
4238 * Maintenance scripts can still use these
4240 $wgReservedUsernames = array(
4241 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4242 'Conversion script', // Used for the old Wikipedia software upgrade
4243 'Maintenance script', // Maintenance scripts which perform editing, image import script
4244 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4245 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4246 'msg:double-redirect-fixer', // Automatic double redirect fix
4247 'msg:usermessage-editor', // Default user for leaving user messages
4248 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4252 * Settings added to this array will override the default globals for the user
4253 * preferences used by anonymous visitors and newly created accounts.
4254 * For instance, to disable editing on double clicks:
4255 * $wgDefaultUserOptions ['editondblclick'] = 0;
4257 $wgDefaultUserOptions = array(
4258 'ccmeonemails' => 0,
4259 'cols' => 80,
4260 'date' => 'default',
4261 'diffonly' => 0,
4262 'disablemail' => 0,
4263 'editfont' => 'default',
4264 'editondblclick' => 0,
4265 'editsectiononrightclick' => 0,
4266 'enotifminoredits' => 0,
4267 'enotifrevealaddr' => 0,
4268 'enotifusertalkpages' => 1,
4269 'enotifwatchlistpages' => 1,
4270 'extendwatchlist' => 1,
4271 'fancysig' => 0,
4272 'forceeditsummary' => 0,
4273 'gender' => 'unknown',
4274 'hideminor' => 0,
4275 'hidepatrolled' => 0,
4276 'imagesize' => 2,
4277 'math' => 1,
4278 'minordefault' => 0,
4279 'newpageshidepatrolled' => 0,
4280 'nickname' => '',
4281 'norollbackdiff' => 0,
4282 'numberheadings' => 0,
4283 'previewonfirst' => 0,
4284 'previewontop' => 1,
4285 'rcdays' => 7,
4286 'rclimit' => 50,
4287 'rows' => 25,
4288 'showhiddencats' => 0,
4289 'shownumberswatching' => 1,
4290 'showtoolbar' => 1,
4291 'skin' => false,
4292 'stubthreshold' => 0,
4293 'thumbsize' => 5,
4294 'underline' => 2,
4295 'uselivepreview' => 0,
4296 'usenewrc' => 1,
4297 'watchcreations' => 1,
4298 'watchdefault' => 1,
4299 'watchdeletion' => 0,
4300 'watchlistdays' => 3.0,
4301 'watchlisthideanons' => 0,
4302 'watchlisthidebots' => 0,
4303 'watchlisthideliu' => 0,
4304 'watchlisthideminor' => 0,
4305 'watchlisthideown' => 0,
4306 'watchlisthidepatrolled' => 0,
4307 'watchmoves' => 0,
4308 'watchrollback' => 0,
4309 'wllimit' => 250,
4310 'useeditwarning' => 1,
4311 'prefershttps' => 1,
4315 * An array of preferences to not show for the user
4317 $wgHiddenPrefs = array();
4320 * Characters to prevent during new account creations.
4321 * This is used in a regular expression character class during
4322 * registration (regex metacharacters like / are escaped).
4324 $wgInvalidUsernameCharacters = '@';
4327 * Character used as a delimiter when testing for interwiki userrights
4328 * (In Special:UserRights, it is possible to modify users on different
4329 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4331 * It is recommended that you have this delimiter in
4332 * $wgInvalidUsernameCharacters above, or you will not be able to
4333 * modify the user rights of those users via Special:UserRights
4335 $wgUserrightsInterwikiDelimiter = '@';
4338 * This is to let user authenticate using https when they come from http.
4339 * Based on an idea by George Herbert on wikitech-l:
4340 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4341 * @since 1.17
4343 $wgSecureLogin = false;
4345 /** @} */ # end user accounts }
4347 /************************************************************************//**
4348 * @name User rights, access control and monitoring
4349 * @{
4353 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4355 $wgAutoblockExpiry = 86400;
4358 * Set this to true to allow blocked users to edit their own user talk page.
4360 $wgBlockAllowsUTEdit = false;
4363 * Allow sysops to ban users from accessing Emailuser
4365 $wgSysopEmailBans = true;
4368 * Limits on the possible sizes of range blocks.
4370 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4371 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4372 * half the number of bits avoids such errors, and allows entire ISPs to be
4373 * blocked using a small number of range blocks.
4375 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4376 * customer, so range blocks larger than /64 (half the number of bits) will
4377 * plainly be required. RFC 4692 implies that a very large ISP may be
4378 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4379 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4381 $wgBlockCIDRLimit = array(
4382 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4383 'IPv6' => 19,
4387 * If true, blocked users will not be allowed to login. When using this with
4388 * a public wiki, the effect of logging out blocked users may actually be
4389 * avers: unless the user's address is also blocked (e.g. auto-block),
4390 * logging the user out will again allow reading and editing, just as for
4391 * anonymous visitors.
4393 $wgBlockDisablesLogin = false;
4396 * Pages anonymous user may see, set as an array of pages titles.
4398 * @par Example:
4399 * @code
4400 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4401 * @endcode
4403 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4405 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4406 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4408 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4409 * will remain readable. You can use img_auth.php to protect uploaded files,
4410 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4412 $wgWhitelistRead = false;
4415 * Pages anonymous user may see, set as an array of regular expressions.
4417 * This function will match the regexp against the title name, which
4418 * is without underscore.
4420 * @par Example:
4421 * To whitelist [[Main Page]]:
4422 * @code
4423 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4424 * @endcode
4426 * @note Unless ^ and/or $ is specified, a regular expression might match
4427 * pages not intended to be whitelisted. The above example will also
4428 * whitelist a page named 'Security Main Page'.
4430 * @par Example:
4431 * To allow reading any page starting with 'User' regardless of the case:
4432 * @code
4433 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4434 * @endcode
4435 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4437 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4438 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4440 $wgWhitelistReadRegexp = false;
4443 * Should editors be required to have a validated e-mail
4444 * address before being allowed to edit?
4446 $wgEmailConfirmToEdit = false;
4449 * Permission keys given to users in each group.
4451 * This is an array where the keys are all groups and each value is an
4452 * array of the format (right => boolean).
4454 * The second format is used to support per-namespace permissions.
4455 * Note that this feature does not fully work for all permission types.
4457 * All users are implicitly in the '*' group including anonymous visitors;
4458 * logged-in users are all implicitly in the 'user' group. These will be
4459 * combined with the permissions of all groups that a given user is listed
4460 * in in the user_groups table.
4462 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4463 * doing! This will wipe all permissions, and may mean that your users are
4464 * unable to perform certain essential tasks or access new functionality
4465 * when new permissions are introduced and default grants established.
4467 * Functionality to make pages inaccessible has not been extensively tested
4468 * for security. Use at your own risk!
4470 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4472 $wgGroupPermissions = array();
4474 /** @cond file_level_code */
4475 // Implicit group for all visitors
4476 $wgGroupPermissions['*']['createaccount'] = true;
4477 $wgGroupPermissions['*']['read'] = true;
4478 $wgGroupPermissions['*']['edit'] = true;
4479 $wgGroupPermissions['*']['createpage'] = true;
4480 $wgGroupPermissions['*']['createtalk'] = true;
4481 $wgGroupPermissions['*']['writeapi'] = true;
4482 $wgGroupPermissions['*']['editmyusercss'] = true;
4483 $wgGroupPermissions['*']['editmyuserjs'] = true;
4484 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4485 $wgGroupPermissions['*']['editmywatchlist'] = true;
4486 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4487 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4488 $wgGroupPermissions['*']['editmyoptions'] = true;
4489 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4491 // Implicit group for all logged-in accounts
4492 $wgGroupPermissions['user']['move'] = true;
4493 $wgGroupPermissions['user']['move-subpages'] = true;
4494 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4495 $wgGroupPermissions['user']['move-categorypages'] = true;
4496 $wgGroupPermissions['user']['movefile'] = true;
4497 $wgGroupPermissions['user']['read'] = true;
4498 $wgGroupPermissions['user']['edit'] = true;
4499 $wgGroupPermissions['user']['createpage'] = true;
4500 $wgGroupPermissions['user']['createtalk'] = true;
4501 $wgGroupPermissions['user']['writeapi'] = true;
4502 $wgGroupPermissions['user']['upload'] = true;
4503 $wgGroupPermissions['user']['reupload'] = true;
4504 $wgGroupPermissions['user']['reupload-shared'] = true;
4505 $wgGroupPermissions['user']['minoredit'] = true;
4506 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4507 $wgGroupPermissions['user']['sendemail'] = true;
4509 // Implicit group for accounts that pass $wgAutoConfirmAge
4510 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4511 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4513 // Users with bot privilege can have their edits hidden
4514 // from various log pages by default
4515 $wgGroupPermissions['bot']['bot'] = true;
4516 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4517 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4518 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4519 $wgGroupPermissions['bot']['autopatrol'] = true;
4520 $wgGroupPermissions['bot']['suppressredirect'] = true;
4521 $wgGroupPermissions['bot']['apihighlimits'] = true;
4522 $wgGroupPermissions['bot']['writeapi'] = true;
4524 // Most extra permission abilities go to this group
4525 $wgGroupPermissions['sysop']['block'] = true;
4526 $wgGroupPermissions['sysop']['createaccount'] = true;
4527 $wgGroupPermissions['sysop']['delete'] = true;
4528 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4529 $wgGroupPermissions['sysop']['bigdelete'] = true;
4530 // can view deleted history entries, but not see or restore the text
4531 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4532 // can view deleted revision text
4533 $wgGroupPermissions['sysop']['deletedtext'] = true;
4534 $wgGroupPermissions['sysop']['undelete'] = true;
4535 $wgGroupPermissions['sysop']['editinterface'] = true;
4536 $wgGroupPermissions['sysop']['editusercss'] = true;
4537 $wgGroupPermissions['sysop']['edituserjs'] = true;
4538 $wgGroupPermissions['sysop']['import'] = true;
4539 $wgGroupPermissions['sysop']['importupload'] = true;
4540 $wgGroupPermissions['sysop']['move'] = true;
4541 $wgGroupPermissions['sysop']['move-subpages'] = true;
4542 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4543 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4544 $wgGroupPermissions['sysop']['patrol'] = true;
4545 $wgGroupPermissions['sysop']['autopatrol'] = true;
4546 $wgGroupPermissions['sysop']['protect'] = true;
4547 $wgGroupPermissions['sysop']['editprotected'] = true;
4548 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4549 $wgGroupPermissions['sysop']['rollback'] = true;
4550 $wgGroupPermissions['sysop']['upload'] = true;
4551 $wgGroupPermissions['sysop']['reupload'] = true;
4552 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4553 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4554 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4555 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4556 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4557 $wgGroupPermissions['sysop']['blockemail'] = true;
4558 $wgGroupPermissions['sysop']['markbotedits'] = true;
4559 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4560 $wgGroupPermissions['sysop']['browsearchive'] = true;
4561 $wgGroupPermissions['sysop']['noratelimit'] = true;
4562 $wgGroupPermissions['sysop']['movefile'] = true;
4563 $wgGroupPermissions['sysop']['unblockself'] = true;
4564 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4565 #$wgGroupPermissions['sysop']['pagelang'] = true;
4566 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4567 $wgGroupPermissions['sysop']['mergehistory'] = true;
4569 // Permission to change users' group assignments
4570 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4571 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4572 // Permission to change users' groups assignments across wikis
4573 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4574 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4575 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4577 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4578 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4579 // To hide usernames from users and Sysops
4580 #$wgGroupPermissions['suppress']['hideuser'] = true;
4581 // To hide revisions/log items from users and Sysops
4582 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4583 // To view revisions/log items hidden from users and Sysops
4584 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4585 // For private suppression log access
4586 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4589 * The developer group is deprecated, but can be activated if need be
4590 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4591 * that a lock file be defined and creatable/removable by the web
4592 * server.
4594 # $wgGroupPermissions['developer']['siteadmin'] = true;
4596 /** @endcond */
4599 * Permission keys revoked from users in each group.
4601 * This acts the same way as wgGroupPermissions above, except that
4602 * if the user is in a group here, the permission will be removed from them.
4604 * Improperly setting this could mean that your users will be unable to perform
4605 * certain essential tasks, so use at your own risk!
4607 $wgRevokePermissions = array();
4610 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4612 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4615 * A map of group names that the user is in, to group names that those users
4616 * are allowed to add or revoke.
4618 * Setting the list of groups to add or revoke to true is equivalent to "any
4619 * group".
4621 * @par Example:
4622 * To allow sysops to add themselves to the "bot" group:
4623 * @code
4624 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4625 * @endcode
4627 * @par Example:
4628 * Implicit groups may be used for the source group, for instance:
4629 * @code
4630 * $wgGroupsRemoveFromSelf = array( '*' => true );
4631 * @endcode
4632 * This allows users in the '*' group (i.e. any user) to remove themselves from
4633 * any group that they happen to be in.
4635 $wgGroupsAddToSelf = array();
4638 * @see $wgGroupsAddToSelf
4640 $wgGroupsRemoveFromSelf = array();
4643 * Set of available actions that can be restricted via action=protect
4644 * You probably shouldn't change this.
4645 * Translated through restriction-* messages.
4646 * Title::getRestrictionTypes() will remove restrictions that are not
4647 * applicable to a specific title (create and upload)
4649 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4652 * Rights which can be required for each protection level (via action=protect)
4654 * You can add a new protection level that requires a specific
4655 * permission by manipulating this array. The ordering of elements
4656 * dictates the order on the protection form's lists.
4658 * - '' will be ignored (i.e. unprotected)
4659 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4660 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4662 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4665 * Restriction levels that can be used with cascading protection
4667 * A page can only be protected with cascading protection if the
4668 * requested restriction level is included in this array.
4670 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4671 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4673 $wgCascadingRestrictionLevels = array( 'sysop' );
4676 * Restriction levels that should be considered "semiprotected"
4678 * Certain places in the interface recognize a dichotomy between "protected"
4679 * and "semiprotected", without further distinguishing the specific levels. In
4680 * general, if anyone can be eligible to edit a protection level merely by
4681 * reaching some condition in $wgAutopromote, it should probably be considered
4682 * "semiprotected".
4684 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4685 * 'sysop' is not changed, since it really shouldn't be here.
4687 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4690 * Set the minimum permissions required to edit pages in each
4691 * namespace. If you list more than one permission, a user must
4692 * have all of them to edit pages in that namespace.
4694 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4696 $wgNamespaceProtection = array();
4699 * Pages in namespaces in this array can not be used as templates.
4701 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4702 * namespaces constants (NS_USER, NS_MAIN...).
4704 * Among other things, this may be useful to enforce read-restrictions
4705 * which may otherwise be bypassed by using the template mechanism.
4707 $wgNonincludableNamespaces = array();
4710 * Number of seconds an account is required to age before it's given the
4711 * implicit 'autoconfirm' group membership. This can be used to limit
4712 * privileges of new accounts.
4714 * Accounts created by earlier versions of the software may not have a
4715 * recorded creation date, and will always be considered to pass the age test.
4717 * When left at 0, all registered accounts will pass.
4719 * @par Example:
4720 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4721 * @code
4722 * $wgAutoConfirmAge = 600; // ten minutes
4723 * @endcode
4724 * Set age to one day:
4725 * @code
4726 * $wgAutoConfirmAge = 3600*24; // one day
4727 * @endcode
4729 $wgAutoConfirmAge = 0;
4732 * Number of edits an account requires before it is autoconfirmed.
4733 * Passing both this AND the time requirement is needed. Example:
4735 * @par Example:
4736 * @code
4737 * $wgAutoConfirmCount = 50;
4738 * @endcode
4740 $wgAutoConfirmCount = 0;
4743 * Automatically add a usergroup to any user who matches certain conditions.
4745 * @todo Redocument $wgAutopromote
4747 * The format is
4748 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4749 * where cond1, cond2, ... are themselves conditions; *OR*
4750 * APCOND_EMAILCONFIRMED, *OR*
4751 * array( APCOND_EMAILCONFIRMED ), *OR*
4752 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4753 * array( APCOND_AGE, seconds since registration ), *OR*
4754 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4755 * array( APCOND_ISIP, ip ), *OR*
4756 * array( APCOND_IPINRANGE, range ), *OR*
4757 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4758 * array( APCOND_BLOCKED ), *OR*
4759 * array( APCOND_ISBOT ), *OR*
4760 * similar constructs defined by extensions.
4762 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4763 * user who has provided an e-mail address.
4765 $wgAutopromote = array(
4766 'autoconfirmed' => array( '&',
4767 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4768 array( APCOND_AGE, &$wgAutoConfirmAge ),
4773 * Automatically add a usergroup to any user who matches certain conditions.
4775 * Does not add the user to the group again if it has been removed.
4776 * Also, does not remove the group if the user no longer meets the criteria.
4778 * The format is:
4779 * @code
4780 * array( event => criteria, ... )
4781 * @endcode
4782 * Where event is either:
4783 * - 'onEdit' (when user edits)
4784 * - 'onView' (when user views the wiki)
4786 * Criteria has the same format as $wgAutopromote
4788 * @see $wgAutopromote
4789 * @since 1.18
4791 $wgAutopromoteOnce = array(
4792 'onEdit' => array(),
4793 'onView' => array()
4797 * Put user rights log entries for autopromotion in recent changes?
4798 * @since 1.18
4800 $wgAutopromoteOnceLogInRC = true;
4803 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4804 * can assign which groups at Special:Userrights.
4806 * @par Example:
4807 * Bureaucrats can add any group:
4808 * @code
4809 * $wgAddGroups['bureaucrat'] = true;
4810 * @endcode
4811 * Bureaucrats can only remove bots and sysops:
4812 * @code
4813 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4814 * @endcode
4815 * Sysops can make bots:
4816 * @code
4817 * $wgAddGroups['sysop'] = array( 'bot' );
4818 * @endcode
4819 * Sysops can disable other sysops in an emergency, and disable bots:
4820 * @code
4821 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4822 * @endcode
4824 $wgAddGroups = array();
4827 * @see $wgAddGroups
4829 $wgRemoveGroups = array();
4832 * A list of available rights, in addition to the ones defined by the core.
4833 * For extensions only.
4835 $wgAvailableRights = array();
4838 * Optional to restrict deletion of pages with higher revision counts
4839 * to users with the 'bigdelete' permission. (Default given to sysops.)
4841 $wgDeleteRevisionsLimit = 0;
4844 * The maximum number of edits a user can have and
4845 * can still be hidden by users with the hideuser permission.
4846 * This is limited for performance reason.
4847 * Set to false to disable the limit.
4848 * @since 1.23
4850 $wgHideUserContribLimit = 1000;
4853 * Number of accounts each IP address may create, 0 to disable.
4855 * @warning Requires memcached
4857 $wgAccountCreationThrottle = 0;
4860 * Edits matching these regular expressions in body text
4861 * will be recognised as spam and rejected automatically.
4863 * There's no administrator override on-wiki, so be careful what you set. :)
4864 * May be an array of regexes or a single string for backwards compatibility.
4866 * @see http://en.wikipedia.org/wiki/Regular_expression
4868 * @note Each regex needs a beginning/end delimiter, eg: # or /
4870 $wgSpamRegex = array();
4873 * Same as the above except for edit summaries
4875 $wgSummarySpamRegex = array();
4878 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4879 * proxies
4880 * @since 1.16
4882 $wgEnableDnsBlacklist = false;
4885 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4887 * This is an array of either a URL or an array with the URL and a key (should
4888 * the blacklist require a key).
4890 * @par Example:
4891 * @code
4892 * $wgDnsBlacklistUrls = array(
4893 * // String containing URL
4894 * 'http.dnsbl.sorbs.net.',
4895 * // Array with URL and key, for services that require a key
4896 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4897 * // Array with just the URL. While this works, it is recommended that you
4898 * // just use a string as shown above
4899 * array( 'opm.tornevall.org.' )
4900 * );
4901 * @endcode
4903 * @note You should end the domain name with a . to avoid searching your
4904 * eventual domain search suffixes.
4905 * @since 1.16
4907 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4910 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4911 * what the other methods might say.
4913 $wgProxyWhitelist = array();
4916 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4917 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4918 * (transparent) proxies without needing to block the proxies themselves.
4920 $wgApplyIpBlocksToXff = false;
4923 * Simple rate limiter options to brake edit floods.
4925 * Maximum number actions allowed in the given number of seconds; after that
4926 * the violating client receives HTTP 500 error pages until the period
4927 * elapses.
4929 * @par Example:
4930 * To set a generic maximum of 4 hits in 60 seconds:
4931 * @code
4932 * $wgRateLimits = array( 4, 60 );
4933 * @endcode
4935 * You could also limit per action and then type of users. See the inline
4936 * code for a template to use.
4938 * This option set is experimental and likely to change.
4940 * @warning Requires memcached.
4942 $wgRateLimits = array(
4943 'edit' => array(
4944 'anon' => null, // for any and all anonymous edits (aggregate)
4945 'user' => null, // for each logged-in user
4946 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4947 'ip' => null, // for each anon and recent account
4948 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4950 'move' => array(
4951 'user' => null,
4952 'newbie' => null,
4953 'ip' => null,
4954 'subnet' => null,
4956 'mailpassword' => array( // triggering password resets emails
4957 'anon' => null,
4959 'emailuser' => array( // emailing other users using MediaWiki
4960 'user' => null,
4962 'linkpurge' => array( // purges of link tables
4963 'anon' => null,
4964 'user' => null,
4965 'newbie' => null,
4966 'ip' => null,
4967 'subnet' => null,
4969 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4970 'anon' => null,
4971 'user' => null,
4972 'newbie' => null,
4973 'ip' => null,
4974 'subnet' => null,
4976 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
4977 'anon' => null,
4978 'user' => null,
4979 'newbie' => null,
4980 'ip' => null,
4981 'subnet' => null,
4986 * Set to a filename to log rate limiter hits.
4988 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
4990 $wgRateLimitLog = null;
4993 * Array of IPs which should be excluded from rate limits.
4994 * This may be useful for whitelisting NAT gateways for conferences, etc.
4996 $wgRateLimitsExcludedIPs = array();
4999 * Log IP addresses in the recentchanges table; can be accessed only by
5000 * extensions (e.g. CheckUser) or a DB admin
5001 * Used for retroactive autoblocks
5003 $wgPutIPinRC = true;
5006 * Integer defining default number of entries to show on
5007 * special pages which are query-pages such as Special:Whatlinkshere.
5009 $wgQueryPageDefaultLimit = 50;
5012 * Limit password attempts to X attempts per Y seconds per IP per account.
5014 * @warning Requires memcached.
5016 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5018 /** @} */ # end of user rights settings
5020 /************************************************************************//**
5021 * @name Proxy scanner settings
5022 * @{
5026 * This should always be customised in LocalSettings.php
5028 $wgSecretKey = false;
5031 * Big list of banned IP addresses.
5033 * This can have the following formats:
5034 * - An array of addresses, either in the values
5035 * or the keys (for backward compatibility)
5036 * - A string, in that case this is the path to a file
5037 * containing the list of IP addresses, one per line
5039 $wgProxyList = array();
5041 /** @} */ # end of proxy scanner settings
5043 /************************************************************************//**
5044 * @name Cookie settings
5045 * @{
5049 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5051 $wgCookieExpiration = 180 * 86400;
5054 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5055 * or ".any.subdomain.net"
5057 $wgCookieDomain = '';
5060 * Set this variable if you want to restrict cookies to a certain path within
5061 * the domain specified by $wgCookieDomain.
5063 $wgCookiePath = '/';
5066 * Whether the "secure" flag should be set on the cookie. This can be:
5067 * - true: Set secure flag
5068 * - false: Don't set secure flag
5069 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5071 $wgCookieSecure = 'detect';
5074 * By default, MediaWiki checks if the client supports cookies during the
5075 * login process, so that it can display an informative error message if
5076 * cookies are disabled. Set this to true if you want to disable this cookie
5077 * check.
5079 $wgDisableCookieCheck = false;
5082 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5083 * to a string to use a custom prefix. Setting it to false causes the database
5084 * name to be used as a prefix.
5086 $wgCookiePrefix = false;
5089 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5090 * in browsers that support this feature. This can mitigates some classes of
5091 * XSS attack.
5093 $wgCookieHttpOnly = true;
5096 * A list of cookies that vary the cache (for use by extensions)
5098 $wgCacheVaryCookies = array();
5101 * Override to customise the session name
5103 $wgSessionName = false;
5105 /** @} */ # end of cookie settings }
5107 /************************************************************************//**
5108 * @name LaTeX (mathematical formulas)
5109 * @{
5113 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5114 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5115 * (ImageMagick) installed and available in the PATH.
5116 * Please see math/README for more information.
5118 $wgUseTeX = false;
5120 /** @} */ # end LaTeX }
5122 /************************************************************************//**
5123 * @name Profiling, testing and debugging
5125 * To enable profiling, edit StartProfiler.php
5127 * @{
5131 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5132 * The debug log file should be not be publicly accessible if it is used, as it
5133 * may contain private data.
5135 $wgDebugLogFile = '';
5138 * Prefix for debug log lines
5140 $wgDebugLogPrefix = '';
5143 * If true, instead of redirecting, show a page with a link to the redirect
5144 * destination. This allows for the inspection of PHP error messages, and easy
5145 * resubmission of form data. For developer use only.
5147 $wgDebugRedirects = false;
5150 * If true, log debugging data from action=raw and load.php.
5151 * This is normally false to avoid overlapping debug entries due to gen=css
5152 * and gen=js requests.
5154 $wgDebugRawPage = false;
5157 * Send debug data to an HTML comment in the output.
5159 * This may occasionally be useful when supporting a non-technical end-user.
5160 * It's more secure than exposing the debug log file to the web, since the
5161 * output only contains private data for the current user. But it's not ideal
5162 * for development use since data is lost on fatal errors and redirects.
5164 $wgDebugComments = false;
5167 * Extensive database transaction state debugging
5169 * @since 1.20
5171 $wgDebugDBTransactions = false;
5174 * Write SQL queries to the debug log.
5176 * This setting is only used $wgLBFactoryConf['class'] is set to
5177 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5178 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5179 * connection to achieve the same functionality.
5181 $wgDebugDumpSql = false;
5184 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5185 * trimming.
5186 * @since 1.24
5188 $wgDebugDumpSqlLength = 500;
5191 * Map of string log group names to log destinations.
5193 * If set, wfDebugLog() output for that group will go to that file instead
5194 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5195 * in production.
5197 * Log destinations may be one of the following:
5198 * - false to completely remove from the output, including from $wgDebugLogFile.
5199 * - string values specifying a filename or URI.
5200 * - associative array mapping 'destination' key to the desired filename or URI.
5201 * The associative array may also contain a 'sample' key with an integer value,
5202 * specifying a sampling factor.
5204 * @par Example:
5205 * @code
5206 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5207 * @endcode
5209 * @par Advanced example:
5210 * @code
5211 * $wgDebugLogGroups['memcached'] = array(
5212 * 'destination' => '/var/log/mediawiki/memcached.log',
5213 * 'sample' => 1000, // log 1 message out of every 1,000.
5214 * );
5215 * @endcode
5217 $wgDebugLogGroups = array();
5220 * Default service provider for creating MWLogger instances.
5222 * The value should be an array suitable for use with
5223 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5224 * implement the MWLoggerSpi interface. See ObjectFactory for additional
5225 * details.
5227 * Alternately the MWLogger::registerProvider method can be called to inject
5228 * an MWLoggerSpi instance into MWLogger and bypass the use of this
5229 * configuration variable entirely.
5231 * @since 1.25
5232 * @var array $wgMWLoggerDefaultSpi
5233 * @see MwLogger
5235 $wgMWLoggerDefaultSpi = array(
5236 'class' => 'MWLoggerLegacySpi',
5240 * Display debug data at the bottom of the main content area.
5242 * Useful for developers and technical users trying to working on a closed wiki.
5244 $wgShowDebug = false;
5247 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5248 * Since 1.19 also includes memory usage.
5250 $wgDebugTimestamps = false;
5253 * Print HTTP headers for every request in the debug information.
5255 $wgDebugPrintHttpHeaders = true;
5258 * Show the contents of $wgHooks in Special:Version
5260 $wgSpecialVersionShowHooks = false;
5263 * Whether to show "we're sorry, but there has been a database error" pages.
5264 * Displaying errors aids in debugging, but may display information useful
5265 * to an attacker.
5267 $wgShowSQLErrors = false;
5270 * If set to true, uncaught exceptions will print a complete stack trace
5271 * to output. This should only be used for debugging, as it may reveal
5272 * private information in function parameters due to PHP's backtrace
5273 * formatting.
5275 $wgShowExceptionDetails = false;
5278 * If true, show a backtrace for database errors
5280 * @note This setting only applies when connection errors and query errors are
5281 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5282 * including those in which an uncaught exception is thrown from within the
5283 * exception handler.
5285 $wgShowDBErrorBacktrace = false;
5288 * If true, send the exception backtrace to the error log
5290 $wgLogExceptionBacktrace = true;
5293 * Expose backend server host names through the API and various HTML comments
5295 $wgShowHostnames = false;
5298 * Override server hostname detection with a hardcoded value.
5299 * Should be a string, default false.
5300 * @since 1.20
5302 $wgOverrideHostname = false;
5305 * If set to true MediaWiki will throw notices for some possible error
5306 * conditions and for deprecated functions.
5308 $wgDevelopmentWarnings = false;
5311 * Release limitation to wfDeprecated warnings, if set to a release number
5312 * development warnings will not be generated for deprecations added in releases
5313 * after the limit.
5315 $wgDeprecationReleaseLimit = false;
5318 * Only record profiling info for pages that took longer than this
5320 $wgProfileLimit = 0.0;
5323 * Don't put non-profiling info into log file
5325 * @deprecated since 1.23, set the log file in
5326 * $wgDebugLogGroups['profileoutput'] instead.
5328 $wgProfileOnly = false;
5331 * If true, print a raw call tree instead of per-function report
5333 $wgProfileCallTree = false;
5336 * Should application server host be put into profiling table
5338 $wgProfilePerHost = false;
5341 * Host for UDP profiler.
5343 * The host should be running a daemon which can be obtained from MediaWiki
5344 * Git at:
5345 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5347 $wgUDPProfilerHost = '127.0.0.1';
5350 * Port for UDP profiler.
5351 * @see $wgUDPProfilerHost
5353 $wgUDPProfilerPort = '3811';
5356 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5357 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5358 * arguments. You can use sprintf's argument numbering/swapping capability to
5359 * repeat, re-order or omit fields.
5361 * @see $wgStatsFormatString
5362 * @since 1.22
5364 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5367 * Output debug message on every wfProfileIn/wfProfileOut
5369 $wgDebugFunctionEntry = false;
5372 * Destination for wfIncrStats() data...
5373 * 'cache' to go into the system cache, if enabled (memcached)
5374 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5375 * false to disable
5377 $wgStatsMethod = 'cache';
5380 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5381 * be aggregated over more than one wiki. The string will be used in place of
5382 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5383 * will be used.
5385 $wgAggregateStatsID = false;
5388 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5389 * formatted. Its value should be a format string suitable for a sprintf()
5390 * invocation with (id, count, key) arguments, where 'id' is either
5391 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5392 * is being incremented, and 'key' is the metric name.
5394 * @see $wgUDPProfilerFormatString
5395 * @see $wgAggregateStatsID
5396 * @since 1.22
5398 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5401 * InfoAction retrieves a list of transclusion links (both to and from).
5402 * This number puts a limit on that query in the case of highly transcluded
5403 * templates.
5405 $wgPageInfoTransclusionLimit = 50;
5408 * Set this to an integer to only do synchronous site_stats updates
5409 * one every *this many* updates. The other requests go into pending
5410 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5411 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5413 $wgSiteStatsAsyncFactor = false;
5416 * Parser test suite files to be run by parserTests.php when no specific
5417 * filename is passed to it.
5419 * Extensions may add their own tests to this array, or site-local tests
5420 * may be added via LocalSettings.php
5422 * Use full paths.
5424 $wgParserTestFiles = array(
5425 "$IP/tests/parser/parserTests.txt",
5426 "$IP/tests/parser/extraParserTests.txt"
5430 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5432 $wgEnableJavaScriptTest = false;
5435 * Configuration for javascript testing.
5437 $wgJavaScriptTestConfig = array(
5438 'qunit' => array(
5439 // Page where documentation can be found relevant to the QUnit test suite being ran.
5440 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5441 // documentation link in the "javascripttest-qunit-intro" message.
5442 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5443 // If you are submitting the QUnit test suite to a TestSwarm instance,
5444 // point this to the "inject.js" script of that instance. This is was registers
5445 // the QUnit hooks to extract the test results and push them back up into the
5446 // TestSwarm database.
5447 // @example 'http://localhost/testswarm/js/inject.js'
5448 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5449 'testswarm-injectjs' => false,
5454 * Overwrite the caching key prefix with custom value.
5455 * @since 1.19
5457 $wgCachePrefix = false;
5460 * Display the new debugging toolbar. This also enables profiling on database
5461 * queries and other useful output.
5462 * Will disable file cache.
5464 * @since 1.19
5466 $wgDebugToolbar = false;
5468 /** @} */ # end of profiling, testing and debugging }
5470 /************************************************************************//**
5471 * @name Search
5472 * @{
5476 * Set this to true to disable the full text search feature.
5478 $wgDisableTextSearch = false;
5481 * Set to true to have nicer highlighted text in search results,
5482 * by default off due to execution overhead
5484 $wgAdvancedSearchHighlighting = false;
5487 * Regexp to match word boundaries, defaults for non-CJK languages
5488 * should be empty for CJK since the words are not separate
5490 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5493 * Template for OpenSearch suggestions, defaults to API action=opensearch
5495 * Sites with heavy load would typically have these point to a custom
5496 * PHP wrapper to avoid firing up mediawiki for every keystroke
5498 * Placeholders: {searchTerms}
5500 $wgOpenSearchTemplate = false;
5503 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5504 * false if you've disabled scripts that use api?action=opensearch and
5505 * want reduce load caused by cached scripts still pulling suggestions.
5506 * It will let the API fallback by responding with an empty array.
5508 $wgEnableOpenSearchSuggest = true;
5511 * Integer defining default number of entries to show on
5512 * OpenSearch call.
5514 $wgOpenSearchDefaultLimit = 10;
5517 * Expiry time for search suggestion responses
5519 $wgSearchSuggestCacheExpiry = 1200;
5522 * If you've disabled search semi-permanently, this also disables updates to the
5523 * table. If you ever re-enable, be sure to rebuild the search table.
5525 $wgDisableSearchUpdate = false;
5528 * List of namespaces which are searched by default.
5530 * @par Example:
5531 * @code
5532 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5533 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5534 * @endcode
5536 $wgNamespacesToBeSearchedDefault = array(
5537 NS_MAIN => true,
5541 * Disable the internal MySQL-based search, to allow it to be
5542 * implemented by an extension instead.
5544 $wgDisableInternalSearch = false;
5547 * Set this to a URL to forward search requests to some external location.
5548 * If the URL includes '$1', this will be replaced with the URL-encoded
5549 * search term.
5551 * @par Example:
5552 * To forward to Google you'd have something like:
5553 * @code
5554 * $wgSearchForwardUrl =
5555 * 'http://www.google.com/search?q=$1' .
5556 * '&domains=http://example.com' .
5557 * '&sitesearch=http://example.com' .
5558 * '&ie=utf-8&oe=utf-8';
5559 * @endcode
5561 $wgSearchForwardUrl = null;
5564 * Search form behavior.
5565 * - true = use Go & Search buttons
5566 * - false = use Go button & Advanced search link
5568 $wgUseTwoButtonsSearchForm = true;
5571 * Array of namespaces to generate a Google sitemap for when the
5572 * maintenance/generateSitemap.php script is run, or false if one is to be
5573 * generated for all namespaces.
5575 $wgSitemapNamespaces = false;
5578 * Custom namespace priorities for sitemaps. Setting this will allow you to
5579 * set custom priorities to namespaces when sitemaps are generated using the
5580 * maintenance/generateSitemap.php script.
5582 * This should be a map of namespace IDs to priority
5583 * @par Example:
5584 * @code
5585 * $wgSitemapNamespacesPriorities = array(
5586 * NS_USER => '0.9',
5587 * NS_HELP => '0.0',
5588 * );
5589 * @endcode
5591 $wgSitemapNamespacesPriorities = false;
5594 * If true, searches for IP addresses will be redirected to that IP's
5595 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5596 * [[Special:Contributions/1.2.3.4]]
5598 $wgEnableSearchContributorsByIP = true;
5600 /** @} */ # end of search settings
5602 /************************************************************************//**
5603 * @name Edit user interface
5604 * @{
5608 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5609 * fall back to the old behavior (no merging).
5611 $wgDiff3 = '/usr/bin/diff3';
5614 * Path to the GNU diff utility.
5616 $wgDiff = '/usr/bin/diff';
5619 * Which namespaces have special treatment where they should be preview-on-open
5620 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5621 * can specify namespaces of pages they have special treatment for
5623 $wgPreviewOnOpenNamespaces = array(
5624 NS_CATEGORY => true
5628 * Enable the UniversalEditButton for browsers that support it
5629 * (currently only Firefox with an extension)
5630 * See http://universaleditbutton.org for more background information
5632 $wgUniversalEditButton = true;
5635 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5636 * will try to automatically create one. This feature can be disabled by set-
5637 * ting this variable false.
5639 $wgUseAutomaticEditSummaries = true;
5641 /** @} */ # end edit UI }
5643 /************************************************************************//**
5644 * @name Maintenance
5645 * See also $wgSiteNotice
5646 * @{
5650 * @cond file_level_code
5651 * Set $wgCommandLineMode if it's not set already, to avoid notices
5653 if ( !isset( $wgCommandLineMode ) ) {
5654 $wgCommandLineMode = false;
5656 /** @endcond */
5659 * For colorized maintenance script output, is your terminal background dark ?
5661 $wgCommandLineDarkBg = false;
5664 * Set this to a string to put the wiki into read-only mode. The text will be
5665 * used as an explanation to users.
5667 * This prevents most write operations via the web interface. Cache updates may
5668 * still be possible. To prevent database writes completely, use the read_only
5669 * option in MySQL.
5671 $wgReadOnly = null;
5674 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5675 * Its contents will be shown to users as part of the read-only warning
5676 * message.
5678 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5680 $wgReadOnlyFile = false;
5683 * When you run the web-based upgrade utility, it will tell you what to set
5684 * this to in order to authorize the upgrade process. It will subsequently be
5685 * used as a password, to authorize further upgrades.
5687 * For security, do not set this to a guessable string. Use the value supplied
5688 * by the install/upgrade process. To cause the upgrader to generate a new key,
5689 * delete the old key from LocalSettings.php.
5691 $wgUpgradeKey = false;
5694 * Fully specified path to git binary
5696 $wgGitBin = '/usr/bin/git';
5699 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5701 * Key is a pattern passed to preg_match() and preg_replace(),
5702 * without the delimiters (which are #) and must match the whole URL.
5703 * The value is the replacement for the key (it can contain $1, etc.)
5704 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5705 * full SHA-1 of the HEAD revision.
5706 * %r will be replaced with a URL-encoded version of $1.
5708 * @since 1.20
5710 $wgGitRepositoryViewers = array(
5711 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5712 'https://git.wikimedia.org/tree/%r/%H',
5713 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5714 'https://git.wikimedia.org/tree/%r/%H',
5717 /** @} */ # End of maintenance }
5719 /************************************************************************//**
5720 * @name Recent changes, new pages, watchlist and history
5721 * @{
5725 * Recentchanges items are periodically purged; entries older than this many
5726 * seconds will go.
5727 * Default: 90 days = about three months
5729 $wgRCMaxAge = 90 * 24 * 3600;
5732 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5733 * higher than what will be stored. Note that this is disabled by default
5734 * because we sometimes do have RC data which is beyond the limit for some
5735 * reason, and some users may use the high numbers to display that data which
5736 * is still there.
5738 $wgRCFilterByAge = false;
5741 * List of Limits options to list in the Special:Recentchanges and
5742 * Special:Recentchangeslinked pages.
5744 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5747 * List of Days options to list in the Special:Recentchanges and
5748 * Special:Recentchangeslinked pages.
5750 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5753 * Destinations to which notifications about recent changes
5754 * should be sent.
5756 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5757 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5758 * specified server.
5759 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5761 * The common options are:
5762 * * 'uri' -- the address to which the notices are to be sent.
5763 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5764 * produce the text to send. This can also be an object of the class.
5765 * * 'omit_bots' -- whether the bot edits should be in the feed
5766 * * 'omit_anon' -- whether anonymous edits should be in the feed
5767 * * 'omit_user' -- whether edits by registered users should be in the feed
5768 * * 'omit_minor' -- whether minor edits should be in the feed
5769 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5771 * The IRC-specific options are:
5772 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5773 * the first entry in the $wgLocalInterwikis array (or the value of
5774 * $wgLocalInterwiki, if set)
5776 * The JSON-specific options are:
5777 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5779 * @example $wgRCFeeds['example'] = array(
5780 * 'formatter' => 'JSONRCFeedFormatter',
5781 * 'uri' => "udp://localhost:1336",
5782 * 'add_interwiki_prefix' => false,
5783 * 'omit_bots' => true,
5784 * );
5785 * @example $wgRCFeeds['exampleirc'] = array(
5786 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5787 * 'uri' => "udp://localhost:1338",
5788 * 'add_interwiki_prefix' => false,
5789 * 'omit_bots' => true,
5790 * );
5791 * @since 1.22
5793 $wgRCFeeds = array();
5796 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5797 * Keys are scheme names, values are names of engine classes.
5799 $wgRCEngines = array(
5800 'redis' => 'RedisPubSubFeedEngine',
5801 'udp' => 'UDPRCFeedEngine',
5805 * Use RC Patrolling to check for vandalism
5807 $wgUseRCPatrol = true;
5810 * Use new page patrolling to check new pages on Special:Newpages
5812 $wgUseNPPatrol = true;
5815 * Log autopatrol actions to the log table
5817 $wgLogAutopatrol = true;
5820 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5822 $wgFeed = true;
5825 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5826 * eg Recentchanges, Newpages.
5828 $wgFeedLimit = 50;
5831 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5832 * A cached version will continue to be served out even if changes
5833 * are made, until this many seconds runs out since the last render.
5835 * If set to 0, feed caching is disabled. Use this for debugging only;
5836 * feed generation can be pretty slow with diffs.
5838 $wgFeedCacheTimeout = 60;
5841 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5842 * pages larger than this size.
5844 $wgFeedDiffCutoff = 32768;
5847 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5848 * every page. Some sites might have a different feed they'd like to promote
5849 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5850 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5851 * as value.
5852 * @par Example:
5853 * Configure the 'atom' feed to http://example.com/somefeed.xml
5854 * @code
5855 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5856 * @endcode
5858 $wgOverrideSiteFeed = array();
5861 * Available feeds objects.
5862 * Should probably only be defined when a page is syndicated ie when
5863 * $wgOut->isSyndicated() is true.
5865 $wgFeedClasses = array(
5866 'rss' => 'RSSFeed',
5867 'atom' => 'AtomFeed',
5871 * Which feed types should we provide by default? This can include 'rss',
5872 * 'atom', neither, or both.
5874 $wgAdvertisedFeedTypes = array( 'atom' );
5877 * Show watching users in recent changes, watchlist and page history views
5879 $wgRCShowWatchingUsers = false; # UPO
5882 * Show the amount of changed characters in recent changes
5884 $wgRCShowChangedSize = true;
5887 * If the difference between the character counts of the text
5888 * before and after the edit is below that value, the value will be
5889 * highlighted on the RC page.
5891 $wgRCChangedSizeThreshold = 500;
5894 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5895 * view for watched pages with new changes
5897 $wgShowUpdatedMarker = true;
5900 * Disable links to talk pages of anonymous users (IPs) in listings on special
5901 * pages like page history, Special:Recentchanges, etc.
5903 $wgDisableAnonTalk = false;
5906 * Enable filtering of categories in Recentchanges
5908 $wgAllowCategorizedRecentChanges = false;
5911 * Allow filtering by change tag in recentchanges, history, etc
5912 * Has no effect if no tags are defined in valid_tag.
5914 $wgUseTagFilter = true;
5917 * If set to an integer, pages that are watched by this many users or more
5918 * will not require the unwatchedpages permission to view the number of
5919 * watchers.
5921 * @since 1.21
5923 $wgUnwatchedPageThreshold = false;
5926 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5927 * certain types of edits.
5929 * To register a new one:
5930 * @code
5931 * $wgRecentChangesFlags['flag'] => array(
5932 * // message for the letter displayed next to rows on changes lists
5933 * 'letter' => 'letter-msg',
5934 * // message for the tooltip of the letter
5935 * 'title' => 'tooltip-msg',
5936 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
5937 * 'legend' => 'legend-msg',
5938 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
5939 * 'class' => 'css-class',
5940 * );
5941 * @endcode
5943 * @since 1.22
5945 $wgRecentChangesFlags = array(
5946 'newpage' => array(
5947 'letter' => 'newpageletter',
5948 'title' => 'recentchanges-label-newpage',
5949 'legend' => 'recentchanges-legend-newpage',
5951 'minor' => array(
5952 'letter' => 'minoreditletter',
5953 'title' => 'recentchanges-label-minor',
5954 'legend' => 'recentchanges-legend-minor',
5955 'class' => 'minoredit',
5957 'bot' => array(
5958 'letter' => 'boteditletter',
5959 'title' => 'recentchanges-label-bot',
5960 'legend' => 'recentchanges-legend-bot',
5961 'class' => 'botedit',
5963 'unpatrolled' => array(
5964 'letter' => 'unpatrolledletter',
5965 'title' => 'recentchanges-label-unpatrolled',
5966 'legend' => 'recentchanges-legend-unpatrolled',
5970 /** @} */ # end RC/watchlist }
5972 /************************************************************************//**
5973 * @name Copyright and credits settings
5974 * @{
5978 * Override for copyright metadata.
5980 * This is the name of the page containing information about the wiki's copyright status,
5981 * which will be added as a link in the footer if it is specified. It overrides
5982 * $wgRightsUrl if both are specified.
5984 $wgRightsPage = null;
5987 * Set this to specify an external URL containing details about the content license used on your
5988 * wiki.
5989 * If $wgRightsPage is set then this setting is ignored.
5991 $wgRightsUrl = null;
5994 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5995 * link.
5996 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5997 * of the page will also be used as the link if this variable is not set.
5999 $wgRightsText = null;
6002 * Override for copyright metadata.
6004 $wgRightsIcon = null;
6007 * Set this to some HTML to override the rights icon with an arbitrary logo
6008 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6010 $wgCopyrightIcon = null;
6013 * Set this to true if you want detailed copyright information forms on Upload.
6015 $wgUseCopyrightUpload = false;
6018 * Set this to the number of authors that you want to be credited below an
6019 * article text. Set it to zero to hide the attribution block, and a negative
6020 * number (like -1) to show all authors. Note that this will require 2-3 extra
6021 * database hits, which can have a not insignificant impact on performance for
6022 * large wikis.
6024 $wgMaxCredits = 0;
6027 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6028 * Otherwise, link to a separate credits page.
6030 $wgShowCreditsIfMax = true;
6032 /** @} */ # end of copyright and credits settings }
6034 /************************************************************************//**
6035 * @name Import / Export
6036 * @{
6040 * List of interwiki prefixes for wikis we'll accept as sources for
6041 * Special:Import (for sysops). Since complete page history can be imported,
6042 * these should be 'trusted'.
6044 * This can either be a regular array, or an associative map specifying
6045 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6046 * e.g.
6047 * @code
6048 * $wgImportSources = array(
6049 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6050 * 'wikispecies',
6051 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6052 * );
6053 * @endcode
6055 * If a user has the 'import' permission but not the 'importupload' permission,
6056 * they will only be able to run imports through this transwiki interface.
6058 $wgImportSources = array();
6061 * Optional default target namespace for interwiki imports.
6062 * Can use this to create an incoming "transwiki"-style queue.
6063 * Set to numeric key, not the name.
6065 * Users may override this in the Special:Import dialog.
6067 $wgImportTargetNamespace = null;
6070 * If set to false, disables the full-history option on Special:Export.
6071 * This is currently poorly optimized for long edit histories, so is
6072 * disabled on Wikimedia's sites.
6074 $wgExportAllowHistory = true;
6077 * If set nonzero, Special:Export requests for history of pages with
6078 * more revisions than this will be rejected. On some big sites things
6079 * could get bogged down by very very long pages.
6081 $wgExportMaxHistory = 0;
6084 * Return distinct author list (when not returning full history)
6086 $wgExportAllowListContributors = false;
6089 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6090 * up to this specified level, which will cause it to include all
6091 * pages linked to from the pages you specify. Since this number
6092 * can become *insanely large* and could easily break your wiki,
6093 * it's disabled by default for now.
6095 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6096 * crazy-big export from being done by someone setting the depth number too
6097 * high. In other words, last resort safety net.
6099 $wgExportMaxLinkDepth = 0;
6102 * Whether to allow the "export all pages in namespace" option
6104 $wgExportFromNamespaces = false;
6107 * Whether to allow exporting the entire wiki into a single file
6109 $wgExportAllowAll = false;
6111 /** @} */ # end of import/export }
6113 /*************************************************************************//**
6114 * @name Extensions
6115 * @{
6119 * A list of callback functions which are called once MediaWiki is fully
6120 * initialised
6122 $wgExtensionFunctions = array();
6125 * Extension messages files.
6127 * Associative array mapping extension name to the filename where messages can be
6128 * found. The file should contain variable assignments. Any of the variables
6129 * present in languages/messages/MessagesEn.php may be defined, but $messages
6130 * is the most common.
6132 * Variables defined in extensions will override conflicting variables defined
6133 * in the core.
6135 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6136 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6137 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6138 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6140 * Extensions using the JSON message format can preserve backward compatibility with
6141 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6142 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6143 * as for the $wgMessagesDirs entry.
6145 * @par Example:
6146 * @code
6147 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6148 * @endcode
6150 $wgExtensionMessagesFiles = array();
6153 * Extension messages directories.
6155 * Associative array mapping extension name to the path of the directory where message files can
6156 * be found. The message files are expected to be JSON files named for their language code, e.g.
6157 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6158 * message directories.
6160 * @par Simple example:
6161 * @code
6162 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6163 * @endcode
6165 * @par Complex example:
6166 * @code
6167 * $wgMessagesDirs['Example'] = array(
6168 * __DIR__ . '/lib/ve/i18n',
6169 * __DIR__ . '/lib/oojs-ui/i18n',
6170 * __DIR__ . '/i18n',
6172 * @endcode
6173 * @since 1.23
6175 $wgMessagesDirs = array(
6176 'core' => "$IP/languages/i18n",
6177 'api' => "$IP/includes/api/i18n",
6178 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
6182 * Array of files with list(s) of extension entry points to be used in
6183 * maintenance/mergeMessageFileList.php
6184 * @since 1.22
6186 $wgExtensionEntryPointListFiles = array();
6189 * Parser output hooks.
6190 * This is an associative array where the key is an extension-defined tag
6191 * (typically the extension name), and the value is a PHP callback.
6192 * These will be called as an OutputPageParserOutput hook, if the relevant
6193 * tag has been registered with the parser output object.
6195 * Registration is done with $pout->addOutputHook( $tag, $data ).
6197 * The callback has the form:
6198 * @code
6199 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6200 * @endcode
6202 $wgParserOutputHooks = array();
6205 * Whether to include the NewPP limit report as a HTML comment
6207 $wgEnableParserLimitReporting = true;
6210 * List of valid skin names
6212 * The key should be the name in all lower case, the value should be a properly
6213 * cased name for the skin. This value will be prefixed with "Skin" to create
6214 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6215 * if you wish to have access to the full list.
6217 $wgValidSkinNames = array();
6220 * Special page list. This is an associative array mapping the (canonical) names of
6221 * special pages to either a class name to be instantiated, or a callback to use for
6222 * creating the special page object. In both cases, the result must be an instance of
6223 * SpecialPage.
6225 $wgSpecialPages = array();
6228 * Array mapping class names to filenames, for autoloading.
6230 $wgAutoloadClasses = array();
6233 * Switch controlling legacy case-insensitive classloading.
6234 * Do not disable if your wiki must support data created by PHP4, or by
6235 * MediaWiki 1.4 or earlier.
6237 $wgAutoloadAttemptLowercase = true;
6240 * An array of information about installed extensions keyed by their type.
6242 * All but 'name', 'path' and 'author' can be omitted.
6244 * @code
6245 * $wgExtensionCredits[$type][] = array(
6246 * 'path' => __FILE__,
6247 * 'name' => 'Example extension',
6248 * 'namemsg' => 'exampleextension-name',
6249 * 'author' => array(
6250 * 'Foo Barstein',
6251 * ),
6252 * 'version' => '1.9.0',
6253 * 'url' => 'http://example.org/example-extension/',
6254 * 'descriptionmsg' => 'exampleextension-desc',
6255 * 'license-name' => 'GPL-2.0',
6256 * );
6257 * @endcode
6259 * The extensions are listed on Special:Version. This page also looks for a file
6260 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6261 * view said file. When the 'license-name' key is specified, this file is
6262 * interpreted as wikitext.
6264 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6265 * 'skin', 'api', or 'other', or any additional types as specified through the
6266 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6268 * - name: Name of extension as an inline string instead of localizable message.
6269 * Do not omit this even if 'namemsg' is provided, as it is used to override
6270 * the path Special:Version uses to find extension's license info, and is
6271 * required for backwards-compatibility with MediaWiki 1.23 and older.
6273 * - namemsg (since MW 1.24): A message key for a message containing the
6274 * extension's name, if the name is localizable. (For example, skin names
6275 * usually are.)
6277 * - author: A string or an array of strings. Authors can be linked using
6278 * the regular wikitext link syntax. To have an internationalized version of
6279 * "and others" show, add an element "...". This element can also be linked,
6280 * for instance "[http://example ...]".
6282 * - descriptionmsg: A message key or an an array with message key and parameters:
6283 * `'descriptionmsg' => 'exampleextension-desc',`
6285 * - description: Description of extension as an inline string instead of
6286 * localizable message (omit in favour of 'descriptionmsg').
6288 * - license-name: Short name of the license (used as label for the link), such
6289 * as "GPL-2.0" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6291 $wgExtensionCredits = array();
6294 * Authentication plugin.
6295 * @var $wgAuth AuthPlugin
6297 $wgAuth = null;
6300 * Global list of hooks.
6302 * The key is one of the events made available by MediaWiki, you can find
6303 * a description for most of them in docs/hooks.txt. The array is used
6304 * internally by Hook:run().
6306 * The value can be one of:
6308 * - A function name:
6309 * @code
6310 * $wgHooks['event_name'][] = $function;
6311 * @endcode
6312 * - A function with some data:
6313 * @code
6314 * $wgHooks['event_name'][] = array( $function, $data );
6315 * @endcode
6316 * - A an object method:
6317 * @code
6318 * $wgHooks['event_name'][] = array( $object, 'method' );
6319 * @endcode
6320 * - A closure:
6321 * @code
6322 * $wgHooks['event_name'][] = function ( $hookParam ) {
6323 * // Handler code goes here.
6324 * };
6325 * @endcode
6327 * @warning You should always append to an event array or you will end up
6328 * deleting a previous registered hook.
6330 * @warning Hook handlers should be registered at file scope. Registering
6331 * handlers after file scope can lead to unexpected results due to caching.
6333 $wgHooks = array();
6336 * Maps jobs to their handling classes; extensions
6337 * can add to this to provide custom jobs
6339 $wgJobClasses = array(
6340 'refreshLinks' => 'RefreshLinksJob',
6341 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6342 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6343 'sendMail' => 'EmaillingJob',
6344 'enotifNotify' => 'EnotifNotifyJob',
6345 'fixDoubleRedirect' => 'DoubleRedirectJob',
6346 'uploadFromUrl' => 'UploadFromUrlJob',
6347 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6348 'PublishStashedFile' => 'PublishStashedFileJob',
6349 'ThumbnailRender' => 'ThumbnailRenderJob',
6350 'null' => 'NullJob'
6354 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6355 * special flags are set. The values here are keys of $wgJobClasses.
6357 * These can be:
6358 * - Very long-running jobs.
6359 * - Jobs that you would never want to run as part of a page rendering request.
6360 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6361 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6362 * These settings should be global to all wikis.
6364 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6367 * Map of job types to how many job "work items" should be run per second
6368 * on each job runner process. The meaning of "work items" varies per job,
6369 * but typically would be something like "pages to update". A single job
6370 * may have a variable number of work items, as is the case with batch jobs.
6371 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6372 * These settings should be global to all wikis.
6373 * @var float[]
6375 $wgJobBackoffThrottling = array();
6378 * Map of job types to configuration arrays.
6379 * This determines which queue class and storage system is used for each job type.
6380 * Job types that do not have explicit configuration will use the 'default' config.
6381 * These settings should be global to all wikis.
6383 $wgJobTypeConf = array(
6384 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6388 * Which aggregator to use for tracking which queues have jobs.
6389 * These settings should be global to all wikis.
6391 $wgJobQueueAggregator = array(
6392 'class' => 'JobQueueAggregatorMemc'
6396 * Additional functions to be performed with updateSpecialPages.
6397 * Expensive Querypages are already updated.
6399 $wgSpecialPageCacheUpdates = array(
6400 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6401 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6405 * Hooks that are used for outputting exceptions. Format is:
6406 * $wgExceptionHooks[] = $funcname
6407 * or:
6408 * $wgExceptionHooks[] = array( $class, $funcname )
6409 * Hooks should return strings or false
6411 $wgExceptionHooks = array();
6414 * Page property link table invalidation lists. When a page property
6415 * changes, this may require other link tables to be updated (eg
6416 * adding __HIDDENCAT__ means the hiddencat tracking category will
6417 * have been added, so the categorylinks table needs to be rebuilt).
6418 * This array can be added to by extensions.
6420 $wgPagePropLinkInvalidations = array(
6421 'hiddencat' => 'categorylinks',
6424 /** @} */ # End extensions }
6426 /*************************************************************************//**
6427 * @name Categories
6428 * @{
6432 * Use experimental, DMOZ-like category browser
6434 $wgUseCategoryBrowser = false;
6437 * On category pages, show thumbnail gallery for images belonging to that
6438 * category instead of listing them as articles.
6440 $wgCategoryMagicGallery = true;
6443 * Paging limit for categories
6445 $wgCategoryPagingLimit = 200;
6448 * Specify how category names should be sorted, when listed on a category page.
6449 * A sorting scheme is also known as a collation.
6451 * Available values are:
6453 * - uppercase: Converts the category name to upper case, and sorts by that.
6455 * - identity: Does no conversion. Sorts by binary value of the string.
6457 * - uca-default: Provides access to the Unicode Collation Algorithm with
6458 * the default element table. This is a compromise collation which sorts
6459 * all languages in a mediocre way. However, it is better than "uppercase".
6461 * To use the uca-default collation, you must have PHP's intl extension
6462 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6463 * resulting collation will depend on the version of ICU installed on the
6464 * server.
6466 * After you change this, you must run maintenance/updateCollation.php to fix
6467 * the sort keys in the database.
6469 * Extensions can define there own collations by subclassing Collation
6470 * and using the Collation::factory hook.
6472 $wgCategoryCollation = 'uppercase';
6474 /** @} */ # End categories }
6476 /*************************************************************************//**
6477 * @name Logging
6478 * @{
6482 * The logging system has two levels: an event type, which describes the
6483 * general category and can be viewed as a named subset of all logs; and
6484 * an action, which is a specific kind of event that can exist in that
6485 * log type.
6487 $wgLogTypes = array(
6489 'block',
6490 'protect',
6491 'rights',
6492 'delete',
6493 'upload',
6494 'move',
6495 'import',
6496 'patrol',
6497 'merge',
6498 'suppress',
6502 * This restricts log access to those who have a certain right
6503 * Users without this will not see it in the option menu and can not view it
6504 * Restricted logs are not added to recent changes
6505 * Logs should remain non-transcludable
6506 * Format: logtype => permissiontype
6508 $wgLogRestrictions = array(
6509 'suppress' => 'suppressionlog'
6513 * Show/hide links on Special:Log will be shown for these log types.
6515 * This is associative array of log type => boolean "hide by default"
6517 * See $wgLogTypes for a list of available log types.
6519 * @par Example:
6520 * @code
6521 * $wgFilterLogTypes = array(
6522 * 'move' => true,
6523 * 'import' => false,
6524 * );
6525 * @endcode
6527 * Will display show/hide links for the move and import logs. Move logs will be
6528 * hidden by default unless the link is clicked. Import logs will be shown by
6529 * default, and hidden when the link is clicked.
6531 * A message of the form log-show-hide-[type] should be added, and will be used
6532 * for the link text.
6534 $wgFilterLogTypes = array(
6535 'patrol' => true
6539 * Lists the message key string for each log type. The localized messages
6540 * will be listed in the user interface.
6542 * Extensions with custom log types may add to this array.
6544 * @since 1.19, if you follow the naming convention log-name-TYPE,
6545 * where TYPE is your log type, yoy don't need to use this array.
6547 $wgLogNames = array(
6548 '' => 'all-logs-page',
6549 'block' => 'blocklogpage',
6550 'protect' => 'protectlogpage',
6551 'rights' => 'rightslog',
6552 'delete' => 'dellogpage',
6553 'upload' => 'uploadlogpage',
6554 'move' => 'movelogpage',
6555 'import' => 'importlogpage',
6556 'patrol' => 'patrol-log-page',
6557 'merge' => 'mergelog',
6558 'suppress' => 'suppressionlog',
6562 * Lists the message key string for descriptive text to be shown at the
6563 * top of each log type.
6565 * Extensions with custom log types may add to this array.
6567 * @since 1.19, if you follow the naming convention log-description-TYPE,
6568 * where TYPE is your log type, yoy don't need to use this array.
6570 $wgLogHeaders = array(
6571 '' => 'alllogstext',
6572 'block' => 'blocklogtext',
6573 'protect' => 'protectlogtext',
6574 'rights' => 'rightslogtext',
6575 'delete' => 'dellogpagetext',
6576 'upload' => 'uploadlogpagetext',
6577 'move' => 'movelogpagetext',
6578 'import' => 'importlogpagetext',
6579 'patrol' => 'patrol-log-header',
6580 'merge' => 'mergelogpagetext',
6581 'suppress' => 'suppressionlogtext',
6585 * Lists the message key string for formatting individual events of each
6586 * type and action when listed in the logs.
6588 * Extensions with custom log types may add to this array.
6590 $wgLogActions = array(
6591 'block/block' => 'blocklogentry',
6592 'block/unblock' => 'unblocklogentry',
6593 'block/reblock' => 'reblock-logentry',
6594 'protect/protect' => 'protectedarticle',
6595 'protect/modify' => 'modifiedarticleprotection',
6596 'protect/unprotect' => 'unprotectedarticle',
6597 'protect/move_prot' => 'movedarticleprotection',
6598 'import/upload' => 'import-logentry-upload',
6599 'import/interwiki' => 'import-logentry-interwiki',
6600 'suppress/block' => 'blocklogentry',
6601 'suppress/reblock' => 'reblock-logentry',
6605 * The same as above, but here values are names of functions,
6606 * not messages.
6607 * @see LogPage::actionText
6608 * @see LogFormatter
6610 $wgLogActionsHandlers = array(
6611 'move/move' => 'MoveLogFormatter',
6612 'move/move_redir' => 'MoveLogFormatter',
6613 'delete/delete' => 'DeleteLogFormatter',
6614 'delete/restore' => 'DeleteLogFormatter',
6615 'delete/revision' => 'DeleteLogFormatter',
6616 'delete/event' => 'DeleteLogFormatter',
6617 'suppress/revision' => 'DeleteLogFormatter',
6618 'suppress/event' => 'DeleteLogFormatter',
6619 'suppress/delete' => 'DeleteLogFormatter',
6620 'patrol/patrol' => 'PatrolLogFormatter',
6621 'rights/rights' => 'RightsLogFormatter',
6622 'rights/autopromote' => 'RightsLogFormatter',
6623 'upload/upload' => 'LogFormatter',
6624 'upload/overwrite' => 'LogFormatter',
6625 'upload/revert' => 'LogFormatter',
6626 'merge/merge' => 'MergeLogFormatter',
6630 * Maintain a log of newusers at Log/newusers?
6632 $wgNewUserLog = true;
6634 /** @} */ # end logging }
6636 /*************************************************************************//**
6637 * @name Special pages (general and miscellaneous)
6638 * @{
6642 * Allow special page inclusions such as {{Special:Allpages}}
6644 $wgAllowSpecialInclusion = true;
6647 * Set this to an array of special page names to prevent
6648 * maintenance/updateSpecialPages.php from updating those pages.
6650 $wgDisableQueryPageUpdate = false;
6653 * List of special pages, followed by what subtitle they should go under
6654 * at Special:SpecialPages
6656 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6658 $wgSpecialPageGroups = array();
6661 * On Special:Unusedimages, consider images "used", if they are put
6662 * into a category. Default (false) is not to count those as used.
6664 $wgCountCategorizedImagesAsUsed = false;
6667 * Maximum number of links to a redirect page listed on
6668 * Special:Whatlinkshere/RedirectDestination
6670 $wgMaxRedirectLinksRetrieved = 500;
6672 /** @} */ # end special pages }
6674 /*************************************************************************//**
6675 * @name Actions
6676 * @{
6680 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6681 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6682 * 'foo' => true Load the class FooAction which subclasses Action
6683 * If something is specified in the getActionOverrides()
6684 * of the relevant Page object it will be used
6685 * instead of the default class.
6686 * 'foo' => false The action is disabled; show an error message
6687 * Unsetting core actions will probably cause things to complain loudly.
6689 $wgActions = array(
6690 'credits' => true,
6691 'delete' => true,
6692 'edit' => true,
6693 'history' => true,
6694 'info' => true,
6695 'markpatrolled' => true,
6696 'protect' => true,
6697 'purge' => true,
6698 'raw' => true,
6699 'render' => true,
6700 'revert' => true,
6701 'revisiondelete' => true,
6702 'rollback' => true,
6703 'submit' => true,
6704 'unprotect' => true,
6705 'unwatch' => true,
6706 'view' => true,
6707 'watch' => true,
6710 /** @} */ # end actions }
6712 /*************************************************************************//**
6713 * @name Robot (search engine crawler) policy
6714 * See also $wgNoFollowLinks.
6715 * @{
6719 * Default robot policy. The default policy is to encourage indexing and fol-
6720 * lowing of links. It may be overridden on a per-namespace and/or per-page
6721 * basis.
6723 $wgDefaultRobotPolicy = 'index,follow';
6726 * Robot policies per namespaces. The default policy is given above, the array
6727 * is made of namespace constants as defined in includes/Defines.php. You can-
6728 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6729 * nofollow. This is because a number of special pages (e.g., ListPages) have
6730 * many permutations of options that display the same data under redundant
6731 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6732 * pages, all alike, and never reaching your actual content.
6734 * @par Example:
6735 * @code
6736 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6737 * @endcode
6739 $wgNamespaceRobotPolicies = array();
6742 * Robot policies per article. These override the per-namespace robot policies.
6743 * Must be in the form of an array where the key part is a properly canonicalised
6744 * text form title and the value is a robot policy.
6746 * @par Example:
6747 * @code
6748 * $wgArticleRobotPolicies = array(
6749 * 'Main Page' => 'noindex,follow',
6750 * 'User:Bob' => 'index,follow',
6751 * );
6752 * @endcode
6754 * @par Example that DOES NOT WORK because the names are not canonical text
6755 * forms:
6756 * @code
6757 * $wgArticleRobotPolicies = array(
6758 * # Underscore, not space!
6759 * 'Main_Page' => 'noindex,follow',
6760 * # "Project", not the actual project name!
6761 * 'Project:X' => 'index,follow',
6762 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6763 * 'abc' => 'noindex,nofollow'
6764 * );
6765 * @endcode
6767 $wgArticleRobotPolicies = array();
6770 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6771 * will not function, so users can't decide whether pages in that namespace are
6772 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6774 * @par Example:
6775 * @code
6776 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6777 * @endcode
6779 $wgExemptFromUserRobotsControl = null;
6781 /** @} */ # End robot policy }
6783 /************************************************************************//**
6784 * @name AJAX and API
6785 * Note: The AJAX entry point which this section refers to is gradually being
6786 * replaced by the API entry point, api.php. They are essentially equivalent.
6787 * Both of them are used for dynamic client-side features, via XHR.
6788 * @{
6792 * Enable the MediaWiki API for convenient access to
6793 * machine-readable data via api.php
6795 * See https://www.mediawiki.org/wiki/API
6797 $wgEnableAPI = true;
6800 * Allow the API to be used to perform write operations
6801 * (page edits, rollback, etc.) when an authorised user
6802 * accesses it
6804 $wgEnableWriteAPI = true;
6808 * WARNING: SECURITY THREAT - debug use only
6810 * Disables many security checks in the API for debugging purposes.
6811 * This flag should never be used on the production servers, as it introduces
6812 * a number of potential security holes. Even when enabled, the validation
6813 * will still be performed, but instead of failing, API will return a warning.
6814 * Also, there will always be a warning notifying that this flag is set.
6815 * At this point, the flag allows GET requests to go through for modules
6816 * requiring POST.
6818 * @since 1.21
6820 $wgDebugAPI = false;
6823 * API module extensions.
6825 * Associative array mapping module name to modules specs;
6826 * Each module spec is an associative array containing at least
6827 * the 'class' key for the module's class, and optionally a
6828 * 'factory' key for the factory function to use for the module.
6830 * That factory function will be called with two parameters,
6831 * the parent module (an instance of ApiBase, usually ApiMain)
6832 * and the name the module was registered under. The return
6833 * value must be an instance of the class given in the 'class'
6834 * field.
6836 * For backward compatibility, the module spec may also be a
6837 * simple string containing the module's class name. In that
6838 * case, the class' constructor will be called with the parent
6839 * module and module name as parameters, as described above.
6841 * Examples for registering API modules:
6843 * @code
6844 * $wgAPIModules['foo'] = 'ApiFoo';
6845 * $wgAPIModules['bar'] = array(
6846 * 'class' => 'ApiBar',
6847 * 'factory' => function( $main, $name ) { ... }
6848 * );
6849 * $wgAPIModules['xyzzy'] = array(
6850 * 'class' => 'ApiXyzzy',
6851 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
6852 * );
6853 * @endcode
6855 * Extension modules may override the core modules.
6856 * See ApiMain::$Modules for a list of the core modules.
6858 $wgAPIModules = array();
6861 * API format module extensions.
6862 * Associative array mapping format module name to module specs (see $wgAPIModules).
6863 * Extension modules may override the core modules.
6865 * See ApiMain::$Formats for a list of the core format modules.
6867 $wgAPIFormatModules = array();
6870 * API Query meta module extensions.
6871 * Associative array mapping meta module name to module specs (see $wgAPIModules).
6872 * Extension modules may override the core modules.
6874 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6876 $wgAPIMetaModules = array();
6879 * API Query prop module extensions.
6880 * Associative array mapping prop module name to module specs (see $wgAPIModules).
6881 * Extension modules may override the core modules.
6883 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6885 $wgAPIPropModules = array();
6888 * API Query list module extensions.
6889 * Associative array mapping list module name to module specs (see $wgAPIModules).
6890 * Extension modules may override the core modules.
6892 * See ApiQuery::$QueryListModules for a list of the core list modules.
6894 $wgAPIListModules = array();
6897 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6898 * @deprecated since 1.21
6900 $wgAPIGeneratorModules = array();
6903 * Maximum amount of rows to scan in a DB query in the API
6904 * The default value is generally fine
6906 $wgAPIMaxDBRows = 5000;
6909 * The maximum size (in bytes) of an API result.
6910 * @warning Do not set this lower than $wgMaxArticleSize*1024
6912 $wgAPIMaxResultSize = 8388608;
6915 * The maximum number of uncached diffs that can be retrieved in one API
6916 * request. Set this to 0 to disable API diffs altogether
6918 $wgAPIMaxUncachedDiffs = 1;
6921 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6922 * API request logging
6924 $wgAPIRequestLog = false;
6927 * Set the timeout for the API help text cache. If set to 0, caching disabled
6929 $wgAPICacheHelpTimeout = 60 * 60;
6932 * The ApiQueryQueryPages module should skip pages that are redundant to true
6933 * API queries.
6935 $wgAPIUselessQueryPages = array(
6936 'MIMEsearch', // aiprop=mime
6937 'LinkSearch', // list=exturlusage
6938 'FileDuplicateSearch', // prop=duplicatefiles
6942 * Enable AJAX framework
6944 $wgUseAjax = true;
6947 * List of Ajax-callable functions.
6948 * Extensions acting as Ajax callbacks must register here
6950 $wgAjaxExportList = array();
6953 * Enable watching/unwatching pages using AJAX.
6954 * Requires $wgUseAjax to be true too.
6956 $wgAjaxWatch = true;
6959 * Enable AJAX check for file overwrite, pre-upload
6961 $wgAjaxUploadDestCheck = true;
6964 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6966 $wgAjaxLicensePreview = true;
6969 * Settings for incoming cross-site AJAX requests:
6970 * Newer browsers support cross-site AJAX when the target resource allows requests
6971 * from the origin domain by the Access-Control-Allow-Origin header.
6972 * This is currently only used by the API (requests to api.php)
6973 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6975 * - '*' matches any number of characters
6976 * - '?' matches any 1 character
6978 * @par Example:
6979 * @code
6980 * $wgCrossSiteAJAXdomains = array(
6981 * 'www.mediawiki.org',
6982 * '*.wikipedia.org',
6983 * '*.wikimedia.org',
6984 * '*.wiktionary.org',
6985 * );
6986 * @endcode
6988 $wgCrossSiteAJAXdomains = array();
6991 * Domains that should not be allowed to make AJAX requests,
6992 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6993 * Uses the same syntax as $wgCrossSiteAJAXdomains
6995 $wgCrossSiteAJAXdomainExceptions = array();
6997 /** @} */ # End AJAX and API }
6999 /************************************************************************//**
7000 * @name Shell and process control
7001 * @{
7005 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7007 $wgMaxShellMemory = 307200;
7010 * Maximum file size created by shell processes under linux, in KB
7011 * ImageMagick convert for example can be fairly hungry for scratch space
7013 $wgMaxShellFileSize = 102400;
7016 * Maximum CPU time in seconds for shell processes under Linux
7018 $wgMaxShellTime = 180;
7021 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7022 * would measure) in seconds for shell processes under Linux
7024 $wgMaxShellWallClockTime = 180;
7027 * Under Linux: a cgroup directory used to constrain memory usage of shell
7028 * commands. The directory must be writable by the user which runs MediaWiki.
7030 * If specified, this is used instead of ulimit, which is inaccurate, and
7031 * causes malloc() to return NULL, which exposes bugs in C applications, making
7032 * them segfault or deadlock.
7034 * A wrapper script will create a cgroup for each shell command that runs, as
7035 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7036 * kernel will send a SIGKILL signal to a process in the subgroup.
7038 * @par Example:
7039 * @code
7040 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7041 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7042 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7043 * @endcode
7045 * The reliability of cgroup cleanup can be improved by installing a
7046 * notify_on_release script in the root cgroup, see e.g.
7047 * https://gerrit.wikimedia.org/r/#/c/40784
7049 $wgShellCgroup = false;
7052 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7054 $wgPhpCli = '/usr/bin/php';
7057 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7058 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7059 * character set. Only the character set is relevant.
7061 $wgShellLocale = 'en_US.utf8';
7063 /** @} */ # End shell }
7065 /************************************************************************//**
7066 * @name HTTP client
7067 * @{
7071 * Timeout for HTTP requests done internally, in seconds.
7073 $wgHTTPTimeout = 25;
7076 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7078 $wgAsyncHTTPTimeout = 25;
7081 * Proxy to use for CURL requests.
7083 $wgHTTPProxy = false;
7086 * Local virtual hosts.
7088 * This lists domains that are configured as virtual hosts on the same machine.
7089 * If a request is to be made to a domain listed here, or any subdomain thereof,
7090 * then no proxy will be used.
7091 * Command-line scripts are not affected by this setting and will always use
7092 * proxy if it is configured.
7093 * @since 1.25
7095 $wgLocalVirtualHosts = array();
7098 * Timeout for connections done internally (in seconds)
7099 * Only works for curl
7101 $wgHTTPConnectTimeout = 5e0;
7103 /** @} */ # End HTTP client }
7105 /************************************************************************//**
7106 * @name Job queue
7107 * See also $wgEnotifUseJobQ.
7108 * @{
7112 * Number of jobs to perform per request. May be less than one in which case
7113 * jobs are performed probabalistically. If this is zero, jobs will not be done
7114 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7115 * be run periodically.
7117 $wgJobRunRate = 1;
7120 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7121 * to handle the job execution, instead of blocking the request until the job
7122 * execution finishes.
7123 * @since 1.23
7125 $wgRunJobsAsync = true;
7128 * Number of rows to update per job
7130 $wgUpdateRowsPerJob = 500;
7133 * Number of rows to update per query
7135 $wgUpdateRowsPerQuery = 100;
7137 /** @} */ # End job queue }
7139 /************************************************************************//**
7140 * @name Miscellaneous
7141 * @{
7145 * Name of the external diff engine to use
7147 $wgExternalDiffEngine = false;
7150 * Disable redirects to special pages and interwiki redirects, which use a 302
7151 * and have no "redirected from" link.
7153 * @note This is only for articles with #REDIRECT in them. URL's containing a
7154 * local interwiki prefix (or a non-canonical special page name) are still hard
7155 * redirected regardless of this setting.
7157 $wgDisableHardRedirects = false;
7160 * LinkHolderArray batch size
7161 * For debugging
7163 $wgLinkHolderBatchSize = 1000;
7166 * By default MediaWiki does not register links pointing to same server in
7167 * externallinks dataset, use this value to override:
7169 $wgRegisterInternalExternals = false;
7172 * Maximum number of pages to move at once when moving subpages with a page.
7174 $wgMaximumMovedPages = 100;
7177 * Fix double redirects after a page move.
7178 * Tends to conflict with page move vandalism, use only on a private wiki.
7180 $wgFixDoubleRedirects = false;
7183 * Allow redirection to another page when a user logs in.
7184 * To enable, set to a string like 'Main Page'
7186 $wgRedirectOnLogin = null;
7189 * Configuration for processing pool control, for use in high-traffic wikis.
7190 * An implementation is provided in the PoolCounter extension.
7192 * This configuration array maps pool types to an associative array. The only
7193 * defined key in the associative array is "class", which gives the class name.
7194 * The remaining elements are passed through to the class as constructor
7195 * parameters.
7197 * @par Example:
7198 * @code
7199 * $wgPoolCounterConf = array( 'ArticleView' => array(
7200 * 'class' => 'PoolCounter_Client',
7201 * 'timeout' => 15, // wait timeout in seconds
7202 * 'workers' => 5, // maximum number of active threads in each pool
7203 * 'maxqueue' => 50, // maximum number of total threads in each pool
7204 * ... any extension-specific options...
7205 * );
7206 * @endcode
7208 $wgPoolCounterConf = null;
7211 * To disable file delete/restore temporarily
7213 $wgUploadMaintenance = false;
7216 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7217 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7218 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7219 * (except for the special case of JS and CS pages).
7221 * @since 1.21
7223 $wgNamespaceContentModels = array();
7226 * How to react if a plain text version of a non-text Content object is requested using
7227 * ContentHandler::getContentText():
7229 * * 'ignore': return null
7230 * * 'fail': throw an MWException
7231 * * 'serialize': serialize to default format
7233 * @since 1.21
7235 $wgContentHandlerTextFallback = 'ignore';
7238 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7239 * This way, the ContentHandler facility can be used without any additional information in the
7240 * database. A page's content model is then derived solely from the page's title. This however
7241 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7242 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7243 * a title that would default to a different content model.
7245 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7246 * handling is less robust and less flexible.
7248 * @since 1.21
7250 $wgContentHandlerUseDB = true;
7253 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7254 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7255 * the effect on the database they would have on a wikitext page.
7257 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7258 * or at least parse only the contents of comments in the scripts.
7260 * @since 1.21
7262 $wgTextModelsToParse = array(
7263 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7264 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7265 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7269 * Whether the user must enter their password to change their e-mail address
7271 * @since 1.20
7273 $wgRequirePasswordforEmailChange = true;
7276 * Register handlers for specific types of sites.
7278 * @since 1.20
7280 $wgSiteTypes = array(
7281 'mediawiki' => 'MediaWikiSite',
7285 * Whether the page_props table has a pp_sortkey column. Set to false in case
7286 * the respective database schema change was not applied.
7287 * @since 1.23
7289 $wgPagePropsHaveSortkey = true;
7292 * Port where you have HTTPS running
7293 * Supports HTTPS on non-standard ports
7294 * @see bug 65184
7295 * @since 1.24
7297 $wgHttpsPort = 443;
7300 * Secret and algorithm for hmac-based key derivation function (fast,
7301 * cryptographically secure random numbers).
7302 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7303 * be used.
7304 * @since 1.24
7306 $wgHKDFSecret = false;
7307 $wgHKDFAlgorithm = 'sha256';
7310 * Enable page language feature
7311 * Allows setting page language in database
7312 * @var bool
7313 * @since 1.24
7315 $wgPageLanguageUseDB = false;
7318 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7319 * Set this only if the fields are fully populated. This may be removed in 1.25.
7320 * @var bool
7321 * @since 1.24
7323 $wgUseLinkNamespaceDBFields = true;
7326 * For really cool vim folding this needs to be at the end:
7327 * vim: foldmarker=@{,@} foldmethod=marker
7328 * @}