Merge "Move actual OldChangesList line formatting to separate method"
[mediawiki.git] / includes / DefaultSettings.php
blob5fc73776a920d23fa387dae3410e607a588795d2
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.24alpha';
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 "{$wgStylePath}/common/images/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, mime_content_type 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 * Default parameters for the "<gallery>" tag
1248 $wgGalleryOptions = array(
1249 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1250 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1251 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1252 'captionLength' => 25, // Length of caption to truncate (in characters)
1253 'showBytes' => true, // Show the filesize in bytes in categories
1254 'mode' => 'traditional',
1258 * Adjust width of upright images when parameter 'upright' is used
1259 * This allows a nicer look for upright images without the need to fix the width
1260 * by hardcoded px in wiki sourcecode.
1262 $wgThumbUpright = 0.75;
1265 * Default value for chmoding of new directories.
1267 $wgDirectoryMode = 0777;
1270 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1272 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1273 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1274 * images in after loading the original low-resolution versions depending on the reported
1275 * window.devicePixelRatio.
1277 $wgResponsiveImages = true;
1280 * @name DJVU settings
1281 * @{
1285 * Path of the djvudump executable
1286 * Enable this and $wgDjvuRenderer to enable djvu rendering
1287 * example: $wgDjvuDump = 'djvudump';
1289 $wgDjvuDump = null;
1292 * Path of the ddjvu DJVU renderer
1293 * Enable this and $wgDjvuDump to enable djvu rendering
1294 * example: $wgDjvuRenderer = 'ddjvu';
1296 $wgDjvuRenderer = null;
1299 * Path of the djvutxt DJVU text extraction utility
1300 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1301 * example: $wgDjvuTxt = 'djvutxt';
1303 $wgDjvuTxt = null;
1306 * Path of the djvutoxml executable
1307 * This works like djvudump except much, much slower as of version 3.5.
1309 * For now we recommend you use djvudump instead. The djvuxml output is
1310 * probably more stable, so we'll switch back to it as soon as they fix
1311 * the efficiency problem.
1312 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1314 * @par Example:
1315 * @code
1316 * $wgDjvuToXML = 'djvutoxml';
1317 * @endcode
1319 $wgDjvuToXML = null;
1322 * Shell command for the DJVU post processor
1323 * Default: pnmtojpeg, since ddjvu generates ppm output
1324 * Set this to false to output the ppm file directly.
1326 $wgDjvuPostProcessor = 'pnmtojpeg';
1329 * File extension for the DJVU post processor output
1331 $wgDjvuOutputExtension = 'jpg';
1333 /** @} */ # end of DJvu }
1335 /** @} */ # end of file uploads }
1337 /************************************************************************//**
1338 * @name Email settings
1339 * @{
1344 * Site admin email address.
1346 * Defaults to "wikiadmin@{$wgServerName}".
1348 $wgEmergencyContact = false;
1351 * Password reminder email address.
1353 * The address we should use as sender when a user is requesting his password.
1355 * Defaults to "apache@{$wgServerName}".
1357 $wgPasswordSender = false;
1360 * Password reminder name
1362 * @deprecated since 1.23; use the system message 'emailsender' instead.
1364 $wgPasswordSenderName = 'MediaWiki Mail';
1367 * Dummy address which should be accepted during mail send action.
1368 * It might be necessary to adapt the address or to set it equal
1369 * to the $wgEmergencyContact address.
1371 $wgNoReplyAddress = 'reply@not.possible';
1374 * Set to true to enable the e-mail basic features:
1375 * Password reminders, etc. If sending e-mail on your
1376 * server doesn't work, you might want to disable this.
1378 $wgEnableEmail = true;
1381 * Set to true to enable user-to-user e-mail.
1382 * This can potentially be abused, as it's hard to track.
1384 $wgEnableUserEmail = true;
1387 * Set to true to put the sending user's email in a Reply-To header
1388 * instead of From. ($wgEmergencyContact will be used as From.)
1390 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1391 * which can cause problems with SPF validation and leak recipient addresses
1392 * when bounces are sent to the sender.
1394 $wgUserEmailUseReplyTo = false;
1397 * Minimum time, in hours, which must elapse between password reminder
1398 * emails for a given account. This is to prevent abuse by mail flooding.
1400 $wgPasswordReminderResendTime = 24;
1403 * The time, in seconds, when an emailed temporary password expires.
1405 $wgNewPasswordExpiry = 3600 * 24 * 7;
1408 * The time, in seconds, when an email confirmation email expires
1410 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1413 * The number of days that a user's password is good for. After this number of days, the
1414 * user will be asked to reset their password. Set to false to disable password expiration.
1416 $wgPasswordExpirationDays = false;
1419 * If a user's password is expired, the number of seconds when they can still login,
1420 * and cancel their password change, but are sent to the password change form on each login.
1422 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1425 * SMTP Mode.
1427 * For using a direct (authenticated) SMTP server connection.
1428 * Default to false or fill an array :
1430 * @code
1431 * $wgSMTP = array(
1432 * 'host' => 'SMTP domain',
1433 * 'IDHost' => 'domain for MessageID',
1434 * 'port' => '25',
1435 * 'auth' => [true|false],
1436 * 'username' => [SMTP username],
1437 * 'password' => [SMTP password],
1438 * );
1439 * @endcode
1441 $wgSMTP = false;
1444 * Additional email parameters, will be passed as the last argument to mail() call.
1445 * If using safe_mode this has no effect
1447 $wgAdditionalMailParams = null;
1450 * For parts of the system that have been updated to provide HTML email content, send
1451 * both text and HTML parts as the body of the email
1453 $wgAllowHTMLEmail = false;
1456 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1457 * from $wgEmergencyContact
1459 $wgEnotifFromEditor = false;
1461 // TODO move UPO to preferences probably ?
1462 # If set to true, users get a corresponding option in their preferences and can choose to
1463 # enable or disable at their discretion
1464 # If set to false, the corresponding input form on the user preference page is suppressed
1465 # It call this to be a "user-preferences-option (UPO)"
1468 * Require email authentication before sending mail to an email address.
1469 * This is highly recommended. It prevents MediaWiki from being used as an open
1470 * spam relay.
1472 $wgEmailAuthentication = true;
1475 * Allow users to enable email notification ("enotif") on watchlist changes.
1477 $wgEnotifWatchlist = false;
1480 * Allow users to enable email notification ("enotif") when someone edits their
1481 * user talk page.
1483 $wgEnotifUserTalk = false;
1486 * Set the Reply-to address in notifications to the editor's address, if user
1487 * allowed this in the preferences.
1489 $wgEnotifRevealEditorAddress = false;
1492 * Send notification mails on minor edits to watchlist pages. This is enabled
1493 * by default. Does not affect user talk notifications.
1495 $wgEnotifMinorEdits = true;
1498 * Send a generic mail instead of a personalised mail for each user. This
1499 * always uses UTC as the time zone, and doesn't include the username.
1501 * For pages with many users watching, this can significantly reduce mail load.
1502 * Has no effect when using sendmail rather than SMTP.
1504 $wgEnotifImpersonal = false;
1507 * Maximum number of users to mail at once when using impersonal mail. Should
1508 * match the limit on your mail server.
1510 $wgEnotifMaxRecips = 500;
1513 * Send mails via the job queue. This can be useful to reduce the time it
1514 * takes to save a page that a lot of people are watching.
1516 $wgEnotifUseJobQ = false;
1519 * Use real name instead of username in e-mail "from" field.
1521 $wgEnotifUseRealName = false;
1524 * Array of usernames who will be sent a notification email for every change
1525 * which occurs on a wiki. Users will not be notified of their own changes.
1527 $wgUsersNotifiedOnAllChanges = array();
1529 /** @} */ # end of email settings
1531 /************************************************************************//**
1532 * @name Database settings
1533 * @{
1537 * Database host name or IP address
1539 $wgDBserver = 'localhost';
1542 * Database port number (for PostgreSQL and Microsoft SQL Server).
1544 $wgDBport = 5432;
1547 * Name of the database
1549 $wgDBname = 'my_wiki';
1552 * Database username
1554 $wgDBuser = 'wikiuser';
1557 * Database user's password
1559 $wgDBpassword = '';
1562 * Database type
1564 $wgDBtype = 'mysql';
1567 * Whether to use SSL in DB connection.
1569 * This setting is only used $wgLBFactoryConf['class'] is set to
1570 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1571 * the DBO_SSL flag must be set in the 'flags' option of the database
1572 * connection to achieve the same functionality.
1574 $wgDBssl = false;
1577 * Whether to use compression in DB connection.
1579 * This setting is only used $wgLBFactoryConf['class'] is set to
1580 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1581 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1582 * connection to achieve the same functionality.
1584 $wgDBcompress = false;
1587 * Separate username for maintenance tasks. Leave as null to use the default.
1589 $wgDBadminuser = null;
1592 * Separate password for maintenance tasks. Leave as null to use the default.
1594 $wgDBadminpassword = null;
1597 * Search type.
1598 * Leave as null to select the default search engine for the
1599 * selected database type (eg SearchMySQL), or set to a class
1600 * name to override to a custom search engine.
1602 $wgSearchType = null;
1605 * Alternative search types
1606 * Sometimes you want to support multiple search engines for testing. This
1607 * allows users to select their search engine of choice via url parameters
1608 * to Special:Search and the action=search API. If using this, there's no
1609 * need to add $wgSearchType to it, that is handled automatically.
1611 $wgSearchTypeAlternatives = null;
1614 * Table name prefix
1616 $wgDBprefix = '';
1619 * MySQL table options to use during installation or update
1621 $wgDBTableOptions = 'ENGINE=InnoDB';
1624 * SQL Mode - default is turning off all modes, including strict, if set.
1625 * null can be used to skip the setting for performance reasons and assume
1626 * DBA has done his best job.
1627 * String override can be used for some additional fun :-)
1629 $wgSQLMode = '';
1632 * Mediawiki schema
1634 $wgDBmwschema = null;
1637 * To override default SQLite data directory ($docroot/../data)
1639 $wgSQLiteDataDir = '';
1642 * Make all database connections secretly go to localhost. Fool the load balancer
1643 * thinking there is an arbitrarily large cluster of servers to connect to.
1644 * Useful for debugging.
1646 $wgAllDBsAreLocalhost = false;
1649 * Shared database for multiple wikis. Commonly used for storing a user table
1650 * for single sign-on. The server for this database must be the same as for the
1651 * main database.
1653 * For backwards compatibility the shared prefix is set to the same as the local
1654 * prefix, and the user table is listed in the default list of shared tables.
1655 * The user_properties table is also added so that users will continue to have their
1656 * preferences shared (preferences were stored in the user table prior to 1.16)
1658 * $wgSharedTables may be customized with a list of tables to share in the shared
1659 * database. However it is advised to limit what tables you do share as many of
1660 * MediaWiki's tables may have side effects if you try to share them.
1662 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1663 * $wgDBprefix.
1665 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1666 * access remote databases. Using wfGetLB() allows the shared database to
1667 * reside on separate servers to the wiki's own database, with suitable
1668 * configuration of $wgLBFactoryConf.
1670 $wgSharedDB = null;
1673 * @see $wgSharedDB
1675 $wgSharedPrefix = false;
1678 * @see $wgSharedDB
1680 $wgSharedTables = array( 'user', 'user_properties' );
1683 * Database load balancer
1684 * This is a two-dimensional array, an array of server info structures
1685 * Fields are:
1686 * - host: Host name
1687 * - dbname: Default database name
1688 * - user: DB user
1689 * - password: DB password
1690 * - type: DB type
1692 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1693 * If this is zero for any given server, no normal query traffic will be
1694 * sent to it. It will be excluded from lag checks in maintenance scripts.
1695 * The only way it can receive traffic is if groupLoads is used.
1697 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1698 * to several groups, the most specific group defined here is used.
1700 * - flags: bit field
1701 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1702 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1703 * - DBO_TRX -- wrap entire request in a transaction
1704 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1705 * - DBO_PERSISTENT -- enables persistent database connections
1706 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1707 * - DBO_COMPRESS -- uses internal compression in database connections,
1708 * if available
1710 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1712 * These and any other user-defined properties will be assigned to the mLBInfo member
1713 * variable of the Database object.
1715 * Leave at false to use the single-server variables above. If you set this
1716 * variable, the single-server variables will generally be ignored (except
1717 * perhaps in some command-line scripts).
1719 * The first server listed in this array (with key 0) will be the master. The
1720 * rest of the servers will be slaves. To prevent writes to your slaves due to
1721 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1722 * slaves in my.cnf. You can set read_only mode at runtime using:
1724 * @code
1725 * SET @@read_only=1;
1726 * @endcode
1728 * Since the effect of writing to a slave is so damaging and difficult to clean
1729 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1730 * our masters, and then set read_only=0 on masters at runtime.
1732 $wgDBservers = false;
1735 * Load balancer factory configuration
1736 * To set up a multi-master wiki farm, set the class here to something that
1737 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1738 * The class identified here is responsible for reading $wgDBservers,
1739 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1741 * The LBFactoryMulti class is provided for this purpose, please see
1742 * includes/db/LBFactoryMulti.php for configuration information.
1744 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1747 * How long to wait for a slave to catch up to the master
1748 * @deprecated since 1.24
1750 $wgMasterWaitTimeout = 10;
1753 * File to log database errors to
1755 $wgDBerrorLog = false;
1758 * Timezone to use in the error log.
1759 * Defaults to the wiki timezone ($wgLocaltimezone).
1761 * A list of usable timezones can found at:
1762 * http://php.net/manual/en/timezones.php
1764 * @par Examples:
1765 * @code
1766 * $wgLocaltimezone = 'UTC';
1767 * $wgLocaltimezone = 'GMT';
1768 * $wgLocaltimezone = 'PST8PDT';
1769 * $wgLocaltimezone = 'Europe/Sweden';
1770 * $wgLocaltimezone = 'CET';
1771 * @endcode
1773 * @since 1.20
1775 $wgDBerrorLogTZ = false;
1778 * Scale load balancer polling time so that under overload conditions, the
1779 * database server receives a SHOW STATUS query at an average interval of this
1780 * many microseconds
1782 $wgDBAvgStatusPoll = 2000;
1785 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1786 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1788 * @warning THIS IS EXPERIMENTAL!
1790 * May break if you're not using the table defs from mysql5/tables.sql.
1791 * May break if you're upgrading an existing wiki if set differently.
1792 * Broken symptoms likely to include incorrect behavior with page titles,
1793 * usernames, comments etc containing non-ASCII characters.
1794 * Might also cause failures on the object cache and other things.
1796 * Even correct usage may cause failures with Unicode supplementary
1797 * characters (those not in the Basic Multilingual Plane) unless MySQL
1798 * has enhanced their Unicode support.
1800 $wgDBmysql5 = false;
1803 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1805 * To use this feature set to true and use a datasource defined as
1806 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1807 * block).
1809 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1810 * Pool) that maintains established sessions and reuses them on new
1811 * connections.
1813 * Not completely tested, but it should fall back on normal connection
1814 * in case the pool is full or the datasource is not configured as
1815 * pooled.
1816 * And the other way around; using oci_pconnect on a non pooled
1817 * datasource should produce a normal connection.
1819 * When it comes to frequent shortlived DB connections like with MW
1820 * Oracle tends to s***. The problem is the driver connects to the
1821 * database reasonably fast, but establishing a session takes time and
1822 * resources. MW does not rely on session state (as it does not use
1823 * features such as package variables) so establishing a valid session
1824 * is in this case an unwanted overhead that just slows things down.
1826 * @warning EXPERIMENTAL!
1829 $wgDBOracleDRCP = false;
1832 * Other wikis on this site, can be administered from a single developer
1833 * account.
1834 * Array numeric key => database name
1836 $wgLocalDatabases = array();
1839 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1840 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1841 * show a more obvious warning.
1843 $wgSlaveLagWarning = 10;
1846 * @see $wgSlaveLagWarning
1848 $wgSlaveLagCritical = 30;
1851 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1853 $wgDBWindowsAuthentication = false;
1855 /**@}*/ # End of DB settings }
1857 /************************************************************************//**
1858 * @name Text storage
1859 * @{
1863 * We can also compress text stored in the 'text' table. If this is set on, new
1864 * revisions will be compressed on page save if zlib support is available. Any
1865 * compressed revisions will be decompressed on load regardless of this setting,
1866 * but will not be readable at all* if zlib support is not available.
1868 $wgCompressRevisions = false;
1871 * External stores allow including content
1872 * from non database sources following URL links.
1874 * Short names of ExternalStore classes may be specified in an array here:
1875 * @code
1876 * $wgExternalStores = array("http","file","custom")...
1877 * @endcode
1879 * CAUTION: Access to database might lead to code execution
1881 $wgExternalStores = array();
1884 * An array of external MySQL servers.
1886 * @par Example:
1887 * Create a cluster named 'cluster1' containing three servers:
1888 * @code
1889 * $wgExternalServers = array(
1890 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1891 * );
1892 * @endcode
1894 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1895 * another class.
1897 $wgExternalServers = array();
1900 * The place to put new revisions, false to put them in the local text table.
1901 * Part of a URL, e.g. DB://cluster1
1903 * Can be an array instead of a single string, to enable data distribution. Keys
1904 * must be consecutive integers, starting at zero.
1906 * @par Example:
1907 * @code
1908 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1909 * @endcode
1911 * @var array
1913 $wgDefaultExternalStore = false;
1916 * Revision text may be cached in $wgMemc to reduce load on external storage
1917 * servers and object extraction overhead for frequently-loaded revisions.
1919 * Set to 0 to disable, or number of seconds before cache expiry.
1921 $wgRevisionCacheExpiry = 0;
1923 /** @} */ # end text storage }
1925 /************************************************************************//**
1926 * @name Performance hacks and limits
1927 * @{
1931 * Disable database-intensive features
1933 $wgMiserMode = false;
1936 * Disable all query pages if miser mode is on, not just some
1938 $wgDisableQueryPages = false;
1941 * Number of rows to cache in 'querycache' table when miser mode is on
1943 $wgQueryCacheLimit = 1000;
1946 * Number of links to a page required before it is deemed "wanted"
1948 $wgWantedPagesThreshold = 1;
1951 * Enable slow parser functions
1953 $wgAllowSlowParserFunctions = false;
1956 * Allow schema updates
1958 $wgAllowSchemaUpdates = true;
1961 * Anti-lock flags - bitfield
1962 * - ALF_NO_LINK_LOCK:
1963 * Don't use locking reads when updating the link table. This is
1964 * necessary for wikis with a high edit rate for performance
1965 * reasons, but may cause link table inconsistency
1967 $wgAntiLockFlags = 0;
1970 * Maximum article size in kilobytes
1972 $wgMaxArticleSize = 2048;
1975 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1976 * raise PHP's memory limit if it's below this amount.
1978 $wgMemoryLimit = "50M";
1980 /** @} */ # end performance hacks }
1982 /************************************************************************//**
1983 * @name Cache settings
1984 * @{
1988 * Directory for caching data in the local filesystem. Should not be accessible
1989 * from the web. Set this to false to not use any local caches.
1991 * Note: if multiple wikis share the same localisation cache directory, they
1992 * must all have the same set of extensions. You can set a directory just for
1993 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1995 $wgCacheDirectory = false;
1998 * Main cache type. This should be a cache with fast access, but it may have
1999 * limited space. By default, it is disabled, since the database is not fast
2000 * enough to make it worthwhile.
2002 * The options are:
2004 * - CACHE_ANYTHING: Use anything, as long as it works
2005 * - CACHE_NONE: Do not cache
2006 * - CACHE_DB: Store cache objects in the DB
2007 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2008 * - CACHE_ACCEL: APC, XCache or WinCache
2009 * - (other): A string may be used which identifies a cache
2010 * configuration in $wgObjectCaches.
2012 * @see $wgMessageCacheType, $wgParserCacheType
2014 $wgMainCacheType = CACHE_NONE;
2017 * The cache type for storing the contents of the MediaWiki namespace. This
2018 * cache is used for a small amount of data which is expensive to regenerate.
2020 * For available types see $wgMainCacheType.
2022 $wgMessageCacheType = CACHE_ANYTHING;
2025 * The cache type for storing article HTML. This is used to store data which
2026 * is expensive to regenerate, and benefits from having plenty of storage space.
2028 * For available types see $wgMainCacheType.
2030 $wgParserCacheType = CACHE_ANYTHING;
2033 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2035 * For available types see $wgMainCacheType.
2037 $wgSessionCacheType = CACHE_ANYTHING;
2040 * The cache type for storing language conversion tables,
2041 * which are used when parsing certain text and interface messages.
2043 * For available types see $wgMainCacheType.
2045 * @since 1.20
2047 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2050 * Advanced object cache configuration.
2052 * Use this to define the class names and constructor parameters which are used
2053 * for the various cache types. Custom cache types may be defined here and
2054 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2055 * or $wgLanguageConverterCacheType.
2057 * The format is an associative array where the key is a cache identifier, and
2058 * the value is an associative array of parameters. The "class" parameter is the
2059 * class name which will be used. Alternatively, a "factory" parameter may be
2060 * given, giving a callable function which will generate a suitable cache object.
2062 $wgObjectCaches = array(
2063 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2064 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
2066 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2067 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2068 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached' ),
2070 'apc' => array( 'class' => 'APCBagOStuff' ),
2071 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2072 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2073 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2074 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2075 'hash' => array( 'class' => 'HashBagOStuff' ),
2079 * The expiry time for the parser cache, in seconds.
2080 * The default is 86400 (one day).
2082 $wgParserCacheExpireTime = 86400;
2085 * Deprecated alias for $wgSessionsInObjectCache.
2087 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2089 $wgSessionsInMemcached = false;
2092 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2093 * can be useful to improve performance, or to avoid the locking behavior of
2094 * PHP's default session handler, which tends to prevent multiple requests for
2095 * the same user from acting concurrently.
2097 $wgSessionsInObjectCache = false;
2100 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2101 * enabled, in seconds.
2103 $wgObjectCacheSessionExpiry = 3600;
2106 * This is used for setting php's session.save_handler. In practice, you will
2107 * almost never need to change this ever. Other options might be 'user' or
2108 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2109 * useful if you're doing cross-application sessions, see bug 11381)
2111 $wgSessionHandler = null;
2114 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2116 $wgMemCachedDebug = false;
2119 * The list of MemCached servers and port numbers
2121 $wgMemCachedServers = array( '127.0.0.1:11211' );
2124 * Use persistent connections to MemCached, which are shared across multiple
2125 * requests.
2127 $wgMemCachedPersistent = false;
2130 * Read/write timeout for MemCached server communication, in microseconds.
2132 $wgMemCachedTimeout = 500000;
2135 * Set this to true to make a local copy of the message cache, for use in
2136 * addition to memcached. The files will be put in $wgCacheDirectory.
2138 $wgUseLocalMessageCache = false;
2141 * Instead of caching everything, only cache those messages which have
2142 * been customised in the site content language. This means that
2143 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2144 * This option is probably only useful for translatewiki.net.
2146 $wgAdaptiveMessageCache = false;
2149 * Localisation cache configuration. Associative array with keys:
2150 * class: The class to use. May be overridden by extensions.
2152 * store: The location to store cache data. May be 'files', 'db' or
2153 * 'detect'. If set to "files", data will be in CDB files. If set
2154 * to "db", data will be stored to the database. If set to
2155 * "detect", files will be used if $wgCacheDirectory is set,
2156 * otherwise the database will be used.
2158 * storeClass: The class name for the underlying storage. If set to a class
2159 * name, it overrides the "store" setting.
2161 * storeDirectory: If the store class puts its data in files, this is the
2162 * directory it will use. If this is false, $wgCacheDirectory
2163 * will be used.
2165 * manualRecache: Set this to true to disable cache updates on web requests.
2166 * Use maintenance/rebuildLocalisationCache.php instead.
2168 $wgLocalisationCacheConf = array(
2169 'class' => 'LocalisationCache',
2170 'store' => 'detect',
2171 'storeClass' => false,
2172 'storeDirectory' => false,
2173 'manualRecache' => false,
2177 * Allow client-side caching of pages
2179 $wgCachePages = true;
2182 * Set this to current time to invalidate all prior cached pages. Affects both
2183 * client-side and server-side caching.
2184 * You can get the current date on your server by using the command:
2185 * @verbatim
2186 * date +%Y%m%d%H%M%S
2187 * @endverbatim
2189 $wgCacheEpoch = '20030516000000';
2192 * Directory where GitInfo will look for pre-computed cache files. If false,
2193 * $wgCacheDirectory/gitinfo will be used.
2195 $wgGitInfoCacheDirectory = false;
2198 * Bump this number when changing the global style sheets and JavaScript.
2200 * It should be appended in the query string of static CSS and JS includes,
2201 * to ensure that client-side caches do not keep obsolete copies of global
2202 * styles.
2204 $wgStyleVersion = '303';
2207 * This will cache static pages for non-logged-in users to reduce
2208 * database traffic on public sites.
2209 * Automatically sets $wgShowIPinHeader = false
2210 * ResourceLoader requests to default language and skins are cached
2211 * as well as single module requests.
2213 $wgUseFileCache = false;
2216 * Depth of the subdirectory hierarchy to be created under
2217 * $wgFileCacheDirectory. The subdirectories will be named based on
2218 * the MD5 hash of the title. A value of 0 means all cache files will
2219 * be put directly into the main file cache directory.
2221 $wgFileCacheDepth = 2;
2224 * Keep parsed pages in a cache (objectcache table or memcached)
2225 * to speed up output of the same page viewed by another user with the
2226 * same options.
2228 * This can provide a significant speedup for medium to large pages,
2229 * so you probably want to keep it on. Extensions that conflict with the
2230 * parser cache should disable the cache on a per-page basis instead.
2232 $wgEnableParserCache = true;
2235 * Append a configured value to the parser cache and the sitenotice key so
2236 * that they can be kept separate for some class of activity.
2238 $wgRenderHashAppend = '';
2241 * If on, the sidebar navigation links are cached for users with the
2242 * current language set. This can save a touch of load on a busy site
2243 * by shaving off extra message lookups.
2245 * However it is also fragile: changing the site configuration, or
2246 * having a variable $wgArticlePath, can produce broken links that
2247 * don't update as expected.
2249 $wgEnableSidebarCache = false;
2252 * Expiry time for the sidebar cache, in seconds
2254 $wgSidebarCacheExpiry = 86400;
2257 * When using the file cache, we can store the cached HTML gzipped to save disk
2258 * space. Pages will then also be served compressed to clients that support it.
2260 * Requires zlib support enabled in PHP.
2262 $wgUseGzip = false;
2265 * Whether MediaWiki should send an ETag header. Seems to cause
2266 * broken behavior with Squid 2.6, see bug 7098.
2268 $wgUseETag = false;
2271 * Clock skew or the one-second resolution of time() can occasionally cause cache
2272 * problems when the user requests two pages within a short period of time. This
2273 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2274 * a grace period.
2276 $wgClockSkewFudge = 5;
2279 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2280 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2281 * was previously done in the default LocalSettings.php file.
2283 * On high-traffic wikis, this should be set to false, to avoid the need to
2284 * check the file modification time, and to avoid the performance impact of
2285 * unnecessary cache invalidations.
2287 $wgInvalidateCacheOnLocalSettingsChange = true;
2289 /** @} */ # end of cache settings
2291 /************************************************************************//**
2292 * @name HTTP proxy (Squid) settings
2294 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2295 * although they are referred to as Squid settings for historical reasons.
2297 * Achieving a high hit ratio with an HTTP proxy requires special
2298 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2299 * more details.
2301 * @{
2305 * Enable/disable Squid.
2306 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2308 $wgUseSquid = false;
2311 * If you run Squid3 with ESI support, enable this (default:false):
2313 $wgUseESI = false;
2316 * Send X-Vary-Options header for better caching (requires patched Squid)
2318 $wgUseXVO = false;
2321 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2322 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2323 * and need to split the cache between HTTP and HTTPS for API requests,
2324 * feed requests and HTTP redirect responses in order to prevent cache
2325 * pollution. This does not affect 'normal' requests to index.php other than
2326 * HTTP redirects.
2328 $wgVaryOnXFP = false;
2331 * Internal server name as known to Squid, if different.
2333 * @par Example:
2334 * @code
2335 * $wgInternalServer = 'http://yourinternal.tld:8000';
2336 * @endcode
2338 $wgInternalServer = false;
2341 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2342 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2343 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2344 * days
2346 $wgSquidMaxage = 18000;
2349 * Default maximum age for raw CSS/JS accesses
2351 $wgForcedRawSMaxage = 300;
2354 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2356 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2357 * headers sent/modified from these proxies when obtaining the remote IP address
2359 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2361 $wgSquidServers = array();
2364 * As above, except these servers aren't purged on page changes; use to set a
2365 * list of trusted proxies, etc. Supports both individual IP addresses and
2366 * CIDR blocks.
2367 * @since 1.23 Supports CIDR ranges
2369 $wgSquidServersNoPurge = array();
2372 * Maximum number of titles to purge in any one client operation
2374 $wgMaxSquidPurgeTitles = 400;
2377 * Whether to use a Host header in purge requests sent to the proxy servers
2378 * configured in $wgSquidServers. Set this to false to support Squid
2379 * configured in forward-proxy mode.
2381 * If this is set to true, a Host header will be sent, and only the path
2382 * component of the URL will appear on the request line, as if the request
2383 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2384 * request. Squid supports this style of request only if reverse-proxy mode
2385 * (http_port ... accel) is enabled.
2387 * If this is set to false, no Host header will be sent, and the absolute URL
2388 * will be sent in the request line, as is the standard for an HTTP proxy
2389 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2390 * by Varnish, but is supported by Squid in either configuration (forward or
2391 * reverse).
2393 * @since 1.21
2395 $wgSquidPurgeUseHostHeader = true;
2398 * Routing configuration for HTCP multicast purging. Add elements here to
2399 * enable HTCP and determine which purges are sent where. If set to an empty
2400 * array, HTCP is disabled.
2402 * Each key in this array is a regular expression to match against the purged
2403 * URL, or an empty string to match all URLs. The purged URL is matched against
2404 * the regexes in the order specified, and the first rule whose regex matches
2405 * is used, all remaining rules will thus be ignored.
2407 * @par Example configuration to send purges for upload.wikimedia.org to one
2408 * multicast group and all other purges to another:
2409 * @code
2410 * $wgHTCPRouting = array(
2411 * '|^https?://upload\.wikimedia\.org|' => array(
2412 * 'host' => '239.128.0.113',
2413 * 'port' => 4827,
2414 * ),
2415 * '' => array(
2416 * 'host' => '239.128.0.112',
2417 * 'port' => 4827,
2418 * ),
2419 * );
2420 * @endcode
2422 * You can also pass an array of hosts to send purges too. This is useful when
2423 * you have several multicast groups or unicast address that should receive a
2424 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2426 * @par Example of sending purges to multiple hosts:
2427 * @code
2428 * $wgHTCPRouting = array(
2429 * '' => array(
2430 * // Purges to text caches using multicast
2431 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2432 * // Purges to a hardcoded list of caches
2433 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2434 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2435 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2436 * ),
2437 * );
2438 * @endcode
2440 * @since 1.22
2442 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2443 * For back compatibility purposes, whenever its array is empty
2444 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2446 * @see $wgHTCPMulticastTTL
2448 $wgHTCPRouting = array();
2451 * HTCP multicast TTL.
2452 * @see $wgHTCPRouting
2454 $wgHTCPMulticastTTL = 1;
2457 * Should forwarded Private IPs be accepted?
2459 $wgUsePrivateIPs = false;
2461 /** @} */ # end of HTTP proxy settings
2463 /************************************************************************//**
2464 * @name Language, regional and character encoding settings
2465 * @{
2469 * Site language code. See languages/Names.php for languages supported by
2470 * MediaWiki out of the box. Not all languages listed there have translations,
2471 * see languages/messages/ for the list of languages with some localisation.
2473 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2474 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2476 * This defines the default interface language for all users, but users can
2477 * change it in their preferences.
2479 * This also defines the language of pages in the wiki. The content is wrapped
2480 * in a html element with lang=XX attribute. This behavior can be overridden
2481 * via hooks, see Title::getPageLanguage.
2483 $wgLanguageCode = 'en';
2486 * Language cache size, or really how many languages can we handle
2487 * simultaneously without degrading to crawl speed.
2489 $wgLangObjCacheSize = 10;
2492 * Some languages need different word forms, usually for different cases.
2493 * Used in Language::convertGrammar().
2495 * @par Example:
2496 * @code
2497 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2498 * @endcode
2500 $wgGrammarForms = array();
2503 * Treat language links as magic connectors, not inline links
2505 $wgInterwikiMagic = true;
2508 * Hide interlanguage links from the sidebar
2510 $wgHideInterlanguageLinks = false;
2513 * List of additional interwiki prefixes that should be treated as
2514 * interlanguage links (i.e. placed in the sidebar).
2515 * Notes:
2516 * - This will not do anything unless the prefixes are defined in the interwiki
2517 * map.
2518 * - The display text for these custom interlanguage links will be fetched from
2519 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2520 * this array.
2521 * - A friendly name for each site, used for tooltip text, may optionally be
2522 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2523 * the prefix in this array.
2525 $wgExtraInterlanguageLinkPrefixes = array();
2528 * List of language names or overrides for default names in Names.php
2530 $wgExtraLanguageNames = array();
2533 * List of language codes that don't correspond to an actual language.
2534 * These codes are mostly left-offs from renames, or other legacy things.
2535 * This array makes them not appear as a selectable language on the installer,
2536 * and excludes them when running the transstat.php script.
2538 $wgDummyLanguageCodes = array(
2539 'als' => 'gsw',
2540 'bat-smg' => 'sgs',
2541 'be-x-old' => 'be-tarask',
2542 'bh' => 'bho',
2543 'fiu-vro' => 'vro',
2544 'no' => 'nb',
2545 'qqq' => 'qqq', # Used for message documentation.
2546 'qqx' => 'qqx', # Used for viewing message keys.
2547 'roa-rup' => 'rup',
2548 'simple' => 'en',
2549 'zh-classical' => 'lzh',
2550 'zh-min-nan' => 'nan',
2551 'zh-yue' => 'yue',
2555 * Character set for use in the article edit box. Language-specific encodings
2556 * may be defined.
2558 * This historic feature is one of the first that was added by former MediaWiki
2559 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2561 $wgEditEncoding = '';
2564 * Set this to true to replace Arabic presentation forms with their standard
2565 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2566 * set to "ar".
2568 * Note that pages with titles containing presentation forms will become
2569 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2571 $wgFixArabicUnicode = true;
2574 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2575 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2576 * set to "ml". Note that some clients (even new clients as of 2010) do not
2577 * support these characters.
2579 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2580 * fix any ZWJ sequences in existing page titles.
2582 $wgFixMalayalamUnicode = true;
2585 * Set this to always convert certain Unicode sequences to modern ones
2586 * regardless of the content language. This has a small performance
2587 * impact.
2589 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2590 * details.
2592 * @since 1.17
2594 $wgAllUnicodeFixes = false;
2597 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2598 * loading old revisions not marked with "utf-8" flag. Use this when
2599 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2600 * burdensome mass conversion of old text data.
2602 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2603 * user names, etc still must be converted en masse in the database before
2604 * continuing as a UTF-8 wiki.
2606 $wgLegacyEncoding = false;
2609 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2610 * regexps : "/regexp/" matching problematic browsers. These browsers will
2611 * be served encoded unicode in the edit box instead of real unicode.
2613 $wgBrowserBlackList = array(
2615 * Netscape 2-4 detection
2616 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2617 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2618 * with a negative assertion. The [UIN] identifier specifies the level of security
2619 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2620 * The language string is unreliable, it is missing on NS4 Mac.
2622 * Reference: http://www.psychedelix.com/agents/index.shtml
2624 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2625 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2626 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2629 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2630 * Þ to <THORN> and Ð to <ETH>
2632 * Known useragents:
2633 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2634 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2635 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2636 * - [...]
2638 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2639 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2641 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2644 * Google wireless transcoder, seems to eat a lot of chars alive
2645 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2647 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2651 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2652 * create stub reference rows in the text table instead of copying
2653 * the full text of all current entries from 'cur' to 'text'.
2655 * This will speed up the conversion step for large sites, but
2656 * requires that the cur table be kept around for those revisions
2657 * to remain viewable.
2659 * This option affects the updaters *only*. Any present cur stub
2660 * revisions will be readable at runtime regardless of this setting.
2662 $wgLegacySchemaConversion = false;
2665 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2666 * the interface is set to English.
2668 $wgAmericanDates = false;
2671 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2672 * numerals in interface.
2674 $wgTranslateNumerals = true;
2677 * Translation using MediaWiki: namespace.
2678 * Interface messages will be loaded from the database.
2680 $wgUseDatabaseMessages = true;
2683 * Expiry time for the message cache key
2685 $wgMsgCacheExpiry = 86400;
2688 * Maximum entry size in the message cache, in bytes
2690 $wgMaxMsgCacheEntrySize = 10000;
2693 * Whether to enable language variant conversion.
2695 $wgDisableLangConversion = false;
2698 * Whether to enable language variant conversion for links.
2700 $wgDisableTitleConversion = false;
2703 * Default variant code, if false, the default will be the language code
2705 $wgDefaultLanguageVariant = false;
2708 * Disabled variants array of language variant conversion.
2710 * @par Example:
2711 * @code
2712 * $wgDisabledVariants[] = 'zh-mo';
2713 * $wgDisabledVariants[] = 'zh-my';
2714 * @endcode
2716 $wgDisabledVariants = array();
2719 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2720 * path format that describes which parts of the URL contain the
2721 * language variant.
2723 * @par Example:
2724 * @code
2725 * $wgLanguageCode = 'sr';
2726 * $wgVariantArticlePath = '/$2/$1';
2727 * $wgArticlePath = '/wiki/$1';
2728 * @endcode
2730 * A link to /wiki/ would be redirected to /sr/Главна_страна
2732 * It is important that $wgArticlePath not overlap with possible values
2733 * of $wgVariantArticlePath.
2735 $wgVariantArticlePath = false;
2738 * Show a bar of language selection links in the user login and user
2739 * registration forms; edit the "loginlanguagelinks" message to
2740 * customise these.
2742 $wgLoginLanguageSelector = false;
2745 * When translating messages with wfMessage(), it is not always clear what
2746 * should be considered UI messages and what should be content messages.
2748 * For example, for the English Wikipedia, there should be only one 'mainpage',
2749 * so when getting the link for 'mainpage', we should treat it as site content
2750 * and call ->inContentLanguage()->text(), but for rendering the text of the
2751 * link, we call ->text(). The code behaves this way by default. However,
2752 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2753 * and the like for different languages. This array provides a way to override
2754 * the default behavior.
2756 * @par Example:
2757 * To allow language-specific main page and community
2758 * portal:
2759 * @code
2760 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2761 * @endcode
2763 $wgForceUIMsgAsContentMsg = array();
2766 * Fake out the timezone that the server thinks it's in. This will be used for
2767 * date display and not for what's stored in the DB. Leave to null to retain
2768 * your server's OS-based timezone value.
2770 * This variable is currently used only for signature formatting and for local
2771 * time/date parser variables ({{LOCALTIME}} etc.)
2773 * Timezones can be translated by editing MediaWiki messages of type
2774 * timezone-nameinlowercase like timezone-utc.
2776 * A list of usable timezones can found at:
2777 * http://php.net/manual/en/timezones.php
2779 * @par Examples:
2780 * @code
2781 * $wgLocaltimezone = 'UTC';
2782 * $wgLocaltimezone = 'GMT';
2783 * $wgLocaltimezone = 'PST8PDT';
2784 * $wgLocaltimezone = 'Europe/Sweden';
2785 * $wgLocaltimezone = 'CET';
2786 * @endcode
2788 $wgLocaltimezone = null;
2791 * Set an offset from UTC in minutes to use for the default timezone setting
2792 * for anonymous users and new user accounts.
2794 * This setting is used for most date/time displays in the software, and is
2795 * overridable in user preferences. It is *not* used for signature timestamps.
2797 * By default, this will be set to match $wgLocaltimezone.
2799 $wgLocalTZoffset = null;
2801 /** @} */ # End of language/charset settings
2803 /*************************************************************************//**
2804 * @name Output format and skin settings
2805 * @{
2809 * The default Content-Type header.
2811 $wgMimeType = 'text/html';
2814 * Previously used as content type in HTML script tags. This is now ignored since
2815 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2816 * It was also previously used by RawAction to determine the ctype query parameter
2817 * value that will result in a javascript response.
2818 * @deprecated since 1.22
2820 $wgJsMimeType = null;
2823 * The default xmlns attribute. The option to define this has been removed.
2824 * The value of this variable is no longer used by core and is set to a fixed
2825 * value in Setup.php for compatibility with extensions that depend on the value
2826 * of this variable being set. Such a dependency however is deprecated.
2827 * @deprecated since 1.22
2829 $wgXhtmlDefaultNamespace = null;
2832 * Previously used to determine if we should output an HTML5 doctype.
2833 * This is no longer used as we always output HTML5 now. For compatibility with
2834 * extensions that still check the value of this config it's value is now forced
2835 * to true by Setup.php.
2836 * @deprecated since 1.22
2838 $wgHtml5 = true;
2841 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2842 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2843 * (like if it's left at the default null value), it will be auto-initialized
2844 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2845 * ever actually set this to anything.
2847 $wgHtml5Version = null;
2850 * Temporary variable that allows HTMLForms to be rendered as tables.
2851 * Table based layouts cause various issues when designing for mobile.
2852 * This global allows skins or extensions a means to force non-table based rendering.
2853 * Setting to false forces form components to always render as div elements.
2854 * @since 1.24
2856 $wgHTMLFormAllowTableFormat = true;
2859 * Temporary variable that applies MediaWiki UI wherever it can be supported.
2860 * Temporary variable that should be removed when mediawiki ui is more
2861 * stable and change has been communicated.
2862 * @since 1.24
2864 $wgUseMediaWikiUIEverywhere = false;
2867 * Enabled RDFa attributes for use in wikitext.
2868 * NOTE: Interaction with HTML5 is somewhat underspecified.
2870 $wgAllowRdfaAttributes = false;
2873 * Enabled HTML5 microdata attributes for use in wikitext.
2875 $wgAllowMicrodataAttributes = false;
2878 * Should we try to make our HTML output well-formed XML? If set to false,
2879 * output will be a few bytes shorter, and the HTML will arguably be more
2880 * readable. If set to true, life will be much easier for the authors of
2881 * screen-scraping bots, and the HTML will arguably be more readable.
2883 * Setting this to false may omit quotation marks on some attributes, omit
2884 * slashes from some self-closing tags, omit some ending tags, etc., where
2885 * permitted by HTML5. Setting it to true will not guarantee that all pages
2886 * will be well-formed, although non-well-formed pages should be rare and it's
2887 * a bug if you find one. Conversely, setting it to false doesn't mean that
2888 * all XML-y constructs will be omitted, just that they might be.
2890 * Because of compatibility with screen-scraping bots, and because it's
2891 * controversial, this is currently left to true by default.
2893 $wgWellFormedXml = true;
2896 * Permit other namespaces in addition to the w3.org default.
2898 * Use the prefix for the key and the namespace for the value.
2900 * @par Example:
2901 * @code
2902 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2903 * @endcode
2904 * Normally we wouldn't have to define this in the root "<html>"
2905 * element, but IE needs it there in some circumstances.
2907 * This is ignored if $wgMimeType is set to a non-XML MIME type.
2909 $wgXhtmlNamespaces = array();
2912 * Show IP address, for non-logged in users. It's necessary to switch this off
2913 * for some forms of caching.
2914 * @warning Will disable file cache.
2916 $wgShowIPinHeader = true;
2919 * Site notice shown at the top of each page
2921 * MediaWiki:Sitenotice page, which will override this. You can also
2922 * provide a separate message for logged-out users using the
2923 * MediaWiki:Anonnotice page.
2925 $wgSiteNotice = '';
2928 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2930 $wgSiteSupportPage = '';
2933 * Validate the overall output using tidy and refuse
2934 * to display the page if it's not valid.
2936 $wgValidateAllHtml = false;
2939 * Default skin, for new users and anonymous visitors. Registered users may
2940 * change this to any one of the other available skins in their preferences.
2942 $wgDefaultSkin = 'vector';
2945 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
2947 * @since 1.24
2949 $wgFallbackSkin = 'fallback';
2952 * Specify the names of skins that should not be presented in the list of
2953 * available skins in user preferences. If you want to remove a skin entirely,
2954 * remove it from the skins/ directory and its entry from LocalSettings.php.
2956 $wgSkipSkins = array();
2959 * @deprecated since 1.23; use $wgSkipSkins instead
2961 $wgSkipSkin = '';
2964 * Allow user Javascript page?
2965 * This enables a lot of neat customizations, but may
2966 * increase security risk to users and server load.
2968 $wgAllowUserJs = false;
2971 * Allow user Cascading Style Sheets (CSS)?
2972 * This enables a lot of neat customizations, but may
2973 * increase security risk to users and server load.
2975 $wgAllowUserCss = false;
2978 * Allow user-preferences implemented in CSS?
2979 * This allows users to customise the site appearance to a greater
2980 * degree; disabling it will improve page load times.
2982 $wgAllowUserCssPrefs = true;
2985 * Use the site's Javascript page?
2987 $wgUseSiteJs = true;
2990 * Use the site's Cascading Style Sheets (CSS)?
2992 $wgUseSiteCss = true;
2995 * Break out of framesets. This can be used to prevent clickjacking attacks,
2996 * or to prevent external sites from framing your site with ads.
2998 $wgBreakFrames = false;
3001 * The X-Frame-Options header to send on pages sensitive to clickjacking
3002 * attacks, such as edit pages. This prevents those pages from being displayed
3003 * in a frame or iframe. The options are:
3005 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3007 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3008 * to allow framing within a trusted domain. This is insecure if there
3009 * is a page on the same domain which allows framing of arbitrary URLs.
3011 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3012 * full compromise of local user accounts. Private wikis behind a
3013 * corporate firewall are especially vulnerable. This is not
3014 * recommended.
3016 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3017 * not just edit pages.
3019 $wgEditPageFrameOptions = 'DENY';
3022 * Disallow framing of API pages directly, by setting the X-Frame-Options
3023 * header. Since the API returns CSRF tokens, allowing the results to be
3024 * framed can compromise your user's account security.
3025 * Options are:
3026 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3027 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3028 * - false: Allow all framing.
3030 $wgApiFrameOptions = 'DENY';
3033 * Disable output compression (enabled by default if zlib is available)
3035 $wgDisableOutputCompression = false;
3038 * Should we allow a broader set of characters in id attributes, per HTML5? If
3039 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3040 * functionality is ready, it will be on by default with no option.
3042 * Currently this appears to work fine in all browsers, but it's disabled by
3043 * default because it normalizes id's a bit too aggressively, breaking preexisting
3044 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3046 $wgExperimentalHtmlIds = false;
3049 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3050 * You can add new icons to the built in copyright or poweredby, or you can create
3051 * a new block. Though note that you may need to add some custom css to get good styling
3052 * of new blocks in monobook. vector and modern should work without any special css.
3054 * $wgFooterIcons itself is a key/value array.
3055 * The key is the name of a block that the icons will be wrapped in. The final id varies
3056 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3057 * turns it into mw_poweredby.
3058 * The value is either key/value array of icons or a string.
3059 * In the key/value array the key may or may not be used by the skin but it can
3060 * be used to find the icon and unset it or change the icon if needed.
3061 * This is useful for disabling icons that are set by extensions.
3062 * The value should be either a string or an array. If it is a string it will be output
3063 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3064 * for the icon, the following keys are used:
3065 * - src: An absolute url to the image to use for the icon, this is recommended
3066 * but not required, however some skins will ignore icons without an image
3067 * - url: The url to use in the a element around the text or icon, if not set an a element will
3068 * not be outputted
3069 * - alt: This is the text form of the icon, it will be displayed without an image in
3070 * skins like Modern or if src is not set, and will otherwise be used as
3071 * the alt="" for the image. This key is required.
3072 * - width and height: If the icon specified by src is not of the standard size
3073 * you can specify the size of image to use with these keys.
3074 * Otherwise they will default to the standard 88x31.
3075 * @todo Reformat documentation.
3077 $wgFooterIcons = array(
3078 "copyright" => array(
3079 "copyright" => array(), // placeholder for the built in copyright icon
3081 "poweredby" => array(
3082 "mediawiki" => array(
3083 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
3084 "url" => "//www.mediawiki.org/",
3085 "alt" => "Powered by MediaWiki",
3091 * Login / create account link behavior when it's possible for anonymous users
3092 * to create an account.
3093 * - true = use a combined login / create account link
3094 * - false = split login and create account into two separate links
3096 $wgUseCombinedLoginLink = false;
3099 * Display user edit counts in various prominent places.
3101 $wgEdititis = false;
3104 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3105 * status code, mangling or hiding MediaWiki's output. If you are using such a
3106 * host, you should start looking for a better one. While you're doing that,
3107 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3108 * that the generated error pages can be seen.
3110 * In cases where for technical reasons it is more important for MediaWiki to
3111 * send the correct status code than for the body to be transmitted intact,
3112 * this configuration variable is ignored.
3114 $wgSend404Code = true;
3117 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3118 * rollback. The numeric value of the variable are the limit up to are counted.
3119 * If the value is false or 0, the edits are not counted. Disabling this will
3120 * furthermore prevent MediaWiki from hiding some useless rollback links.
3122 * @since 1.20
3124 $wgShowRollbackEditCount = 10;
3127 * Output a <link rel="canonical"> tag on every page indicating the canonical
3128 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3129 * detection of the current server is unreliable, the link is sent
3130 * unconditionally.
3132 $wgEnableCanonicalServerLink = false;
3134 /** @} */ # End of output format settings }
3136 /*************************************************************************//**
3137 * @name Resource loader settings
3138 * @{
3142 * Client-side resource modules.
3144 * Extensions should add their resource loader module definitions
3145 * to the $wgResourceModules variable.
3147 * @par Example:
3148 * @code
3149 * $wgResourceModules['ext.myExtension'] = array(
3150 * 'scripts' => 'myExtension.js',
3151 * 'styles' => 'myExtension.css',
3152 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3153 * 'localBasePath' => __DIR__,
3154 * 'remoteExtPath' => 'MyExtension',
3155 * );
3156 * @endcode
3158 $wgResourceModules = array();
3161 * Skin-specific styles for resource modules.
3163 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3164 * not be modified or disabled.
3166 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3168 * @par Example:
3169 * @code
3170 * $wgResourceModules['bar'] = array(
3171 * 'scripts' => 'resources/bar/bar.js',
3172 * 'styles' => 'resources/bar/main.css',
3173 * );
3175 * $wgResourceModuleSkinStyles['foo'] = array(
3176 * 'bar' => 'skins/Foo/bar.css',
3177 * );
3178 * @endcode
3180 * This is mostly equivalent to:
3182 * @par Equivalent:
3183 * @code
3184 * $wgResourceModules['bar'] = array(
3185 * 'scripts' => 'resources/bar/bar.js',
3186 * 'styles' => 'resources/bar/main.css',
3187 * 'skinStyles' => array(
3188 * 'foo' => skins/Foo/bar.css',
3189 * ),
3190 * );
3191 * @endcode
3193 * If the module already defines its own entry in `skinStyles` for a given skin, then
3194 * $wgResourceModuleSkinStyles is ignored.
3196 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3197 * of replacing them. This can be done using the `+` prefix.
3199 * @par Example:
3200 * @code
3201 * $wgResourceModules['bar'] = array(
3202 * 'scripts' => 'resources/bar/bar.js',
3203 * 'styles' => 'resources/bar/basic.css',
3204 * 'skinStyles' => array(
3205 * 'default' => 'resources/bar/additional.css',
3206 * ),
3207 * );
3208 * // Note the '+' character:
3209 * $wgResourceModuleSkinStyles['+foo'] = array(
3210 * 'bar' => 'skins/Foo/bar.css',
3211 * );
3212 * @endcode
3214 * This is mostly equivalent to:
3216 * @par Equivalent:
3217 * @code
3218 * $wgResourceModules['bar'] = array(
3219 * 'scripts' => 'resources/bar/bar.js',
3220 * 'styles' => 'resources/bar/basic.css',
3221 * 'skinStyles' => array(
3222 * 'default' => 'resources/bar/additional.css',
3223 * 'foo' => array(
3224 * 'resources/bar/additional.css',
3225 * 'skins/Foo/bar.css',
3226 * ),
3227 * ),
3228 * );
3229 * @endcode
3231 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3232 * disabled by a skin. To provide default styles that may be extended or replaced,
3233 * use `skinStyles['default']`.
3235 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3236 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3237 * Either for all skin styles at once (first example below) or for each module separately (second
3238 * example).
3240 * @par Example:
3241 * @code
3242 * $wgResourceModuleSkinStyles['foo'] = array(
3243 * 'bar' => 'bar.css',
3244 * 'quux' => 'quux.css',
3245 * 'remoteSkinPath' => 'Foo',
3246 * 'localBasePath' => __DIR__,
3247 * );
3249 * $wgResourceModuleSkinStyles['foo'] = array(
3250 * 'bar' => array(
3251 * 'bar.css',
3252 * 'remoteSkinPath' => 'Foo',
3253 * 'localBasePath' => __DIR__,
3254 * ),
3255 * 'quux' => array(
3256 * 'quux.css',
3257 * 'remoteSkinPath' => 'Foo',
3258 * 'localBasePath' => __DIR__,
3259 * ),
3260 * );
3261 * @endcode
3263 $wgResourceModuleSkinStyles = array();
3266 * Extensions should register foreign module sources here. 'local' is a
3267 * built-in source that is not in this array, but defined by
3268 * ResourceLoader::__construct() so that it cannot be unset.
3270 * @par Example:
3271 * @code
3272 * $wgResourceLoaderSources['foo'] = array(
3273 * 'loadScript' => 'http://example.org/w/load.php',
3274 * 'apiScript' => 'http://example.org/w/api.php'
3275 * );
3276 * @endcode
3278 $wgResourceLoaderSources = array();
3281 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3282 * If not set, then $wgScriptPath will be used as a fallback.
3284 $wgResourceBasePath = null;
3287 * Maximum time in seconds to cache resources served by the resource loader.
3288 * Used to set last modified headers (max-age/s-maxage).
3290 * Following options to distinguish:
3291 * - versioned: Used for modules with a version, because changing version
3292 * numbers causes cache misses. This normally has a long expiry time.
3293 * - unversioned: Used for modules without a version to propagate changes
3294 * quickly to clients. Also used for modules with errors to recover quickly.
3295 * This normally has a short expiry time.
3297 * Expiry time for the options to distinguish:
3298 * - server: Squid/Varnish but also any other public proxy cache between the
3299 * client and MediaWiki.
3300 * - client: On the client side (e.g. in the browser cache).
3302 $wgResourceLoaderMaxage = array(
3303 'versioned' => array(
3304 'server' => 30 * 24 * 60 * 60, // 30 days
3305 'client' => 30 * 24 * 60 * 60, // 30 days
3307 'unversioned' => array(
3308 'server' => 5 * 60, // 5 minutes
3309 'client' => 5 * 60, // 5 minutes
3314 * The default debug mode (on/off) for of ResourceLoader requests.
3316 * This will still be overridden when the debug URL parameter is used.
3318 $wgResourceLoaderDebug = false;
3321 * Enable embedding of certain resources using Edge Side Includes. This will
3322 * improve performance but only works if there is something in front of the
3323 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3325 $wgResourceLoaderUseESI = false;
3328 * Put each statement on its own line when minifying JavaScript. This makes
3329 * debugging in non-debug mode a bit easier.
3331 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3334 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3335 * the minifier will try not to produce lines longer than this, but may be
3336 * forced to do so in certain cases.
3338 $wgResourceLoaderMinifierMaxLineLength = 1000;
3341 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3342 * dependencies.
3344 $wgIncludeLegacyJavaScript = true;
3347 * Whether to include the jQuery Migrate library, which lets legacy JS that
3348 * requires jQuery 1.8.x to work and breaks with 1.9.x+.
3350 * @since 1.24
3351 * @deprecated since 1.24, to be removed in 1.25
3353 $wgIncludejQueryMigrate = false;
3356 * Whether to preload the mediawiki.util module as blocking module in the top
3357 * queue.
3359 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3360 * allowed modules to lack dependencies on 'popular' modules that were likely
3361 * loaded already.
3363 * This setting is to aid scripts during migration by providing mediawiki.util
3364 * unconditionally (which was the most commonly missed dependency).
3365 * It doesn't cover all missing dependencies obviously but should fix most of
3366 * them.
3368 * This should be removed at some point after site/user scripts have been fixed.
3369 * Enable this if your wiki has a large amount of user/site scripts that are
3370 * lacking dependencies.
3371 * @todo Deprecate
3373 $wgPreloadJavaScriptMwUtil = false;
3376 * Whether or not to assign configuration variables to the global window object.
3378 * If this is set to false, old code using deprecated variables will no longer
3379 * work.
3381 * @par Example of legacy code:
3382 * @code{,js}
3383 * if ( window.wgRestrictionEdit ) { ... }
3384 * @endcode
3385 * or:
3386 * @code{,js}
3387 * if ( wgIsArticle ) { ... }
3388 * @endcode
3390 * Instead, one needs to use mw.config.
3391 * @par Example using mw.config global configuration:
3392 * @code{,js}
3393 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3394 * @endcode
3395 * or:
3396 * @code{,js}
3397 * if ( mw.config.get('wgIsArticle') ) { ... }
3398 * @endcode
3400 $wgLegacyJavaScriptGlobals = true;
3403 * If set to a positive number, ResourceLoader will not generate URLs whose
3404 * query string is more than this many characters long, and will instead use
3405 * multiple requests with shorter query strings. This degrades performance,
3406 * but may be needed if your web server has a low (less than, say 1024)
3407 * query string length limit or a low value for suhosin.get.max_value_length
3408 * that you can't increase.
3410 * If set to a negative number, ResourceLoader will assume there is no query
3411 * string length limit.
3413 * Defaults to a value based on php configuration.
3415 $wgResourceLoaderMaxQueryLength = false;
3418 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3419 * prior to minification to validate it.
3421 * Parse errors will result in a JS exception being thrown during module load,
3422 * which avoids breaking other modules loaded in the same request.
3424 $wgResourceLoaderValidateJS = true;
3427 * If set to true, statically-sourced (file-backed) JavaScript resources will
3428 * be parsed for validity before being bundled up into ResourceLoader modules.
3430 * This can be helpful for development by providing better error messages in
3431 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3432 * and may fail on large pre-bundled frameworks.
3434 $wgResourceLoaderValidateStaticJS = false;
3437 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3438 * will be enabled. This is an experimental feature that's supposed to make
3439 * JavaScript load faster.
3441 $wgResourceLoaderExperimentalAsyncLoading = false;
3444 * Global LESS variables. An associative array binding variable names to
3445 * LESS code snippets representing their values.
3447 * Adding an item here is equivalent to writing `@variable: value;`
3448 * at the beginning of all your .less files, with all the consequences.
3449 * In particular, string values must be escaped and quoted.
3451 * Changes to LESS variables do not trigger cache invalidation.
3453 * @par Example:
3454 * @code
3455 * $wgResourceLoaderLESSVars = array(
3456 * 'baseFontSize' => '1em',
3457 * 'smallFontSize' => '0.75em',
3458 * 'WikimediaBlue' => '#006699',
3459 * );
3460 * @endcode
3461 * @since 1.22
3463 $wgResourceLoaderLESSVars = array();
3466 * Custom LESS functions. An associative array mapping function name to PHP
3467 * callable.
3469 * Changes to LESS functions do not trigger cache invalidation.
3471 * @since 1.22
3473 $wgResourceLoaderLESSFunctions = array(
3474 'embeddable' => 'ResourceLoaderLESSFunctions::embeddable',
3475 'embed' => 'ResourceLoaderLESSFunctions::embed',
3479 * Default import paths for LESS modules. LESS files referenced in @import
3480 * statements will be looked up here first, and relative to the importing file
3481 * second. To avoid collisions, it's important for the LESS files in these
3482 * directories to have a common, predictable file name prefix.
3484 * Extensions need not (and should not) register paths in
3485 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3486 * currently compiling LESS file, which allows each extension to freely import
3487 * files from its own tree.
3489 * @since 1.22
3491 $wgResourceLoaderLESSImportPaths = array(
3492 "$IP/resources/src/mediawiki.less/",
3496 * Whether ResourceLoader should attempt to persist modules in localStorage on
3497 * browsers that support the Web Storage API.
3499 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3501 $wgResourceLoaderStorageEnabled = false;
3504 * Cache version for client-side ResourceLoader module storage. You can trigger
3505 * invalidation of the contents of the module store by incrementing this value.
3507 * @since 1.23
3509 $wgResourceLoaderStorageVersion = 1;
3511 /** @} */ # End of resource loader settings }
3513 /*************************************************************************//**
3514 * @name Page title and interwiki link settings
3515 * @{
3519 * Name of the project namespace. If left set to false, $wgSitename will be
3520 * used instead.
3522 $wgMetaNamespace = false;
3525 * Name of the project talk namespace.
3527 * Normally you can ignore this and it will be something like
3528 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3529 * manually for grammatical reasons.
3531 $wgMetaNamespaceTalk = false;
3534 * Additional namespaces. If the namespaces defined in Language.php and
3535 * Namespace.php are insufficient, you can create new ones here, for example,
3536 * to import Help files in other languages. You can also override the namespace
3537 * names of existing namespaces. Extensions developers should use
3538 * $wgCanonicalNamespaceNames.
3540 * @warning Once you delete a namespace, the pages in that namespace will
3541 * no longer be accessible. If you rename it, then you can access them through
3542 * the new namespace name.
3544 * Custom namespaces should start at 100 to avoid conflicting with standard
3545 * namespaces, and should always follow the even/odd main/talk pattern.
3547 * @par Example:
3548 * @code
3549 * $wgExtraNamespaces = array(
3550 * 100 => "Hilfe",
3551 * 101 => "Hilfe_Diskussion",
3552 * 102 => "Aide",
3553 * 103 => "Discussion_Aide"
3554 * );
3555 * @endcode
3557 * @todo Add a note about maintenance/namespaceDupes.php
3559 $wgExtraNamespaces = array();
3562 * Same as above, but for namespaces with gender distinction.
3563 * Note: the default form for the namespace should also be set
3564 * using $wgExtraNamespaces for the same index.
3565 * @since 1.18
3567 $wgExtraGenderNamespaces = array();
3570 * Namespace aliases.
3572 * These are alternate names for the primary localised namespace names, which
3573 * are defined by $wgExtraNamespaces and the language file. If a page is
3574 * requested with such a prefix, the request will be redirected to the primary
3575 * name.
3577 * Set this to a map from namespace names to IDs.
3579 * @par Example:
3580 * @code
3581 * $wgNamespaceAliases = array(
3582 * 'Wikipedian' => NS_USER,
3583 * 'Help' => 100,
3584 * );
3585 * @endcode
3587 $wgNamespaceAliases = array();
3590 * Allowed title characters -- regex character class
3591 * Don't change this unless you know what you're doing
3593 * Problematic punctuation:
3594 * - []{}|# Are needed for link syntax, never enable these
3595 * - <> Causes problems with HTML escaping, don't use
3596 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3597 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3598 * corrupted by apache
3599 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3601 * All three of these punctuation problems can be avoided by using an alias,
3602 * instead of a rewrite rule of either variety.
3604 * The problem with % is that when using a path to query rewrite rule, URLs are
3605 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3606 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3607 * for this, indeed double escaping would break if the double-escaped title was
3608 * passed in the query string rather than the path. This is a minor security issue
3609 * because articles can be created such that they are hard to view or edit.
3611 * In some rare cases you may wish to remove + for compatibility with old links.
3613 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3614 * this breaks interlanguage links
3616 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3619 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3621 * @deprecated since 1.23; use $wgLocalInterwikis instead
3623 $wgLocalInterwiki = false;
3626 * Array for multiple $wgLocalInterwiki values, in case there are several
3627 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3628 * set, its value is prepended to this array, for backwards compatibility.
3630 * Note, recent changes feeds use only the first entry in this array (or
3631 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3633 $wgLocalInterwikis = array();
3636 * Expiry time for cache of interwiki table
3638 $wgInterwikiExpiry = 10800;
3641 * @name Interwiki caching settings.
3642 * @{
3646 *$wgInterwikiCache specifies path to constant database file.
3648 * This cdb database is generated by dumpInterwiki from maintenance and has
3649 * such key formats:
3650 * - dbname:key - a simple key (e.g. enwiki:meta)
3651 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3652 * - __global:key - global-scope key (e.g. __global:meta)
3653 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3655 * Sites mapping just specifies site name, other keys provide "local url"
3656 * data layout.
3658 $wgInterwikiCache = false;
3661 * Specify number of domains to check for messages.
3662 * - 1: Just wiki(db)-level
3663 * - 2: wiki and global levels
3664 * - 3: site levels
3666 $wgInterwikiScopes = 3;
3669 * Fallback site, if unable to resolve from cache
3671 $wgInterwikiFallbackSite = 'wiki';
3673 /** @} */ # end of Interwiki caching settings.
3676 * If local interwikis are set up which allow redirects,
3677 * set this regexp to restrict URLs which will be displayed
3678 * as 'redirected from' links.
3680 * @par Example:
3681 * It might look something like this:
3682 * @code
3683 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3684 * @endcode
3686 * Leave at false to avoid displaying any incoming redirect markers.
3687 * This does not affect intra-wiki redirects, which don't change
3688 * the URL.
3690 $wgRedirectSources = false;
3693 * Set this to false to avoid forcing the first letter of links to capitals.
3695 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3696 * appearing with a capital at the beginning of a sentence will *not* go to the
3697 * same place as links in the middle of a sentence using a lowercase initial.
3699 $wgCapitalLinks = true;
3702 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3703 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3704 * true by default (and setting them has no effect), due to various things that
3705 * require them to be so. Also, since Talk namespaces need to directly mirror their
3706 * associated content namespaces, the values for those are ignored in favor of the
3707 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3708 * NS_FILE.
3710 * @par Example:
3711 * @code
3712 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3713 * @endcode
3715 $wgCapitalLinkOverrides = array();
3718 * Which namespaces should support subpages?
3719 * See Language.php for a list of namespaces.
3721 $wgNamespacesWithSubpages = array(
3722 NS_TALK => true,
3723 NS_USER => true,
3724 NS_USER_TALK => true,
3725 NS_PROJECT => true,
3726 NS_PROJECT_TALK => true,
3727 NS_FILE_TALK => true,
3728 NS_MEDIAWIKI => true,
3729 NS_MEDIAWIKI_TALK => true,
3730 NS_TEMPLATE_TALK => true,
3731 NS_HELP => true,
3732 NS_HELP_TALK => true,
3733 NS_CATEGORY_TALK => true
3737 * Array holding default tracking category names.
3739 * Array contains the system messages for each tracking category.
3740 * Tracking categories allow pages with certain characteristics to be tracked.
3741 * It works by adding any such page to a category automatically.
3743 * A message with the suffix '-desc' should be added as a description message
3744 * to have extra information on Special:TrackingCategories.
3746 * @since 1.23
3748 $wgTrackingCategories = array(
3749 'index-category',
3750 'noindex-category',
3751 'expensive-parserfunction-category',
3752 'post-expand-template-argument-category',
3753 'post-expand-template-inclusion-category',
3754 'hidden-category-category',
3755 'broken-file-category',
3756 'node-count-exceeded-category',
3757 'expansion-depth-exceeded-category',
3761 * Array of namespaces which can be deemed to contain valid "content", as far
3762 * as the site statistics are concerned. Useful if additional namespaces also
3763 * contain "content" which should be considered when generating a count of the
3764 * number of articles in the wiki.
3766 $wgContentNamespaces = array( NS_MAIN );
3769 * Max number of redirects to follow when resolving redirects.
3770 * 1 means only the first redirect is followed (default behavior).
3771 * 0 or less means no redirects are followed.
3773 $wgMaxRedirects = 1;
3776 * Array of invalid page redirect targets.
3777 * Attempting to create a redirect to any of the pages in this array
3778 * will make the redirect fail.
3779 * Userlogout is hard-coded, so it does not need to be listed here.
3780 * (bug 10569) Disallow Mypage and Mytalk as well.
3782 * As of now, this only checks special pages. Redirects to pages in
3783 * other namespaces cannot be invalidated by this variable.
3785 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3787 /** @} */ # End of title and interwiki settings }
3789 /************************************************************************//**
3790 * @name Parser settings
3791 * These settings configure the transformation from wikitext to HTML.
3792 * @{
3796 * Parser configuration. Associative array with the following members:
3798 * class The class name
3800 * preprocessorClass The preprocessor class. Two classes are currently available:
3801 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3802 * storage, and Preprocessor_DOM, which uses the DOM module for
3803 * temporary storage. Preprocessor_DOM generally uses less memory;
3804 * the speed of the two is roughly the same.
3806 * If this parameter is not given, it uses Preprocessor_DOM if the
3807 * DOM module is available, otherwise it uses Preprocessor_Hash.
3809 * The entire associative array will be passed through to the constructor as
3810 * the first parameter. Note that only Setup.php can use this variable --
3811 * the configuration will change at runtime via $wgParser member functions, so
3812 * the contents of this variable will be out-of-date. The variable can only be
3813 * changed during LocalSettings.php, in particular, it can't be changed during
3814 * an extension setup function.
3816 $wgParserConf = array(
3817 'class' => 'Parser',
3818 #'preprocessorClass' => 'Preprocessor_Hash',
3822 * Maximum indent level of toc.
3824 $wgMaxTocLevel = 999;
3827 * A complexity limit on template expansion: the maximum number of nodes visited
3828 * by PPFrame::expand()
3830 $wgMaxPPNodeCount = 1000000;
3833 * A complexity limit on template expansion: the maximum number of elements
3834 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3835 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3836 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3837 * this default corresponds to about 155 MB.
3839 * When the limit is exceeded, an exception is thrown.
3841 $wgMaxGeneratedPPNodeCount = 1000000;
3844 * Maximum recursion depth for templates within templates.
3845 * The current parser adds two levels to the PHP call stack for each template,
3846 * and xdebug limits the call stack to 100 by default. So this should hopefully
3847 * stop the parser before it hits the xdebug limit.
3849 $wgMaxTemplateDepth = 40;
3852 * @see $wgMaxTemplateDepth
3854 $wgMaxPPExpandDepth = 40;
3857 * URL schemes that should be recognized as valid by wfParseUrl().
3858 * @see wfParseUrl
3860 $wgUrlProtocols = array(
3861 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3862 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3863 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3864 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3868 * If true, removes (substitutes) templates in "~~~~" signatures.
3870 $wgCleanSignatures = true;
3873 * Whether to allow inline image pointing to other websites
3875 $wgAllowExternalImages = false;
3878 * If the above is false, you can specify an exception here. Image URLs
3879 * that start with this string are then rendered, while all others are not.
3880 * You can use this to set up a trusted, simple repository of images.
3881 * You may also specify an array of strings to allow multiple sites
3883 * @par Examples:
3884 * @code
3885 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3886 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3887 * @endcode
3889 $wgAllowExternalImagesFrom = '';
3892 * If $wgAllowExternalImages is false, you can allow an on-wiki
3893 * whitelist of regular expression fragments to match the image URL
3894 * against. If the image matches one of the regular expression fragments,
3895 * The image will be displayed.
3897 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3898 * Or false to disable it
3900 $wgEnableImageWhitelist = true;
3903 * A different approach to the above: simply allow the "<img>" tag to be used.
3904 * This allows you to specify alt text and other attributes, copy-paste HTML to
3905 * your wiki more easily, etc. However, allowing external images in any manner
3906 * will allow anyone with editing rights to snoop on your visitors' IP
3907 * addresses and so forth, if they wanted to, by inserting links to images on
3908 * sites they control.
3910 $wgAllowImageTag = false;
3913 * $wgUseTidy: use tidy to make sure HTML output is sane.
3914 * Tidy is a free tool that fixes broken HTML.
3915 * See http://www.w3.org/People/Raggett/tidy/
3917 * - $wgTidyBin should be set to the path of the binary and
3918 * - $wgTidyConf to the path of the configuration file.
3919 * - $wgTidyOpts can include any number of parameters.
3920 * - $wgTidyInternal controls the use of the PECL extension or the
3921 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3922 * of spawning a separate program.
3923 * Normally you shouldn't need to override the setting except for
3924 * debugging. To install, use 'pear install tidy' and add a line
3925 * 'extension=tidy.so' to php.ini.
3927 $wgUseTidy = false;
3930 * @see $wgUseTidy
3932 $wgAlwaysUseTidy = false;
3935 * @see $wgUseTidy
3937 $wgTidyBin = 'tidy';
3940 * @see $wgUseTidy
3942 $wgTidyConf = $IP . '/includes/tidy.conf';
3945 * @see $wgUseTidy
3947 $wgTidyOpts = '';
3950 * @see $wgUseTidy
3952 $wgTidyInternal = extension_loaded( 'tidy' );
3955 * Put tidy warnings in HTML comments
3956 * Only works for internal tidy.
3958 $wgDebugTidy = false;
3961 * Allow raw, unchecked HTML in "<html>...</html>" sections.
3962 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3963 * TO RESTRICT EDITING to only those that you trust
3965 $wgRawHtml = false;
3968 * Set a default target for external links, e.g. _blank to pop up a new window
3970 $wgExternalLinkTarget = false;
3973 * If true, external URL links in wiki text will be given the
3974 * rel="nofollow" attribute as a hint to search engines that
3975 * they should not be followed for ranking purposes as they
3976 * are user-supplied and thus subject to spamming.
3978 $wgNoFollowLinks = true;
3981 * Namespaces in which $wgNoFollowLinks doesn't apply.
3982 * See Language.php for a list of namespaces.
3984 $wgNoFollowNsExceptions = array();
3987 * If this is set to an array of domains, external links to these domain names
3988 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3989 * value of $wgNoFollowLinks. For instance:
3991 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
3992 * 'mediawiki.org' );
3994 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3995 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3996 * etc.
3998 * Defaults to mediawiki.org for the links included in the software by default.
4000 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4003 * Allow DISPLAYTITLE to change title display
4005 $wgAllowDisplayTitle = true;
4008 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4009 * canonical DB key. Also disallow some inline CSS rules like display: none;
4010 * which can cause the text to be hidden or unselectable.
4012 $wgRestrictDisplayTitle = true;
4015 * Maximum number of calls per parse to expensive parser functions such as
4016 * PAGESINCATEGORY.
4018 $wgExpensiveParserFunctionLimit = 100;
4021 * Preprocessor caching threshold
4022 * Setting it to 'false' will disable the preprocessor cache.
4024 $wgPreprocessorCacheThreshold = 1000;
4027 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4029 $wgEnableScaryTranscluding = false;
4032 * Expiry time for transcluded templates cached in transcache database table.
4033 * Only used $wgEnableInterwikiTranscluding is set to true.
4035 $wgTranscludeCacheExpiry = 3600;
4037 /** @} */ # end of parser settings }
4039 /************************************************************************//**
4040 * @name Statistics
4041 * @{
4045 * Method used to determine if a page in a content namespace should be counted
4046 * as a valid article.
4048 * Redirect pages will never be counted as valid articles.
4050 * This variable can have the following values:
4051 * - 'any': all pages as considered as valid articles
4052 * - 'comma': the page must contain a comma to be considered valid
4053 * - 'link': the page must contain a [[wiki link]] to be considered valid
4055 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4057 * Retroactively changing this variable will not affect the existing count,
4058 * to update it, you will need to run the maintenance/updateArticleCount.php
4059 * script.
4061 $wgArticleCountMethod = 'link';
4064 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
4065 * values are easier on the database. A value of 1 causes the counters to be
4066 * updated on every hit, any higher value n cause them to update *on average*
4067 * every n hits. Should be set to either 1 or something largish, eg 1000, for
4068 * maximum efficiency.
4070 $wgHitcounterUpdateFreq = 1;
4073 * How many days user must be idle before he is considered inactive. Will affect
4074 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4075 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4076 * You might want to leave this as the default value, to provide comparable
4077 * numbers between different wikis.
4079 $wgActiveUserDays = 30;
4081 /** @} */ # End of statistics }
4083 /************************************************************************//**
4084 * @name User accounts, authentication
4085 * @{
4089 * For compatibility with old installations set to false
4090 * @deprecated since 1.24 will be removed in future
4092 $wgPasswordSalt = true;
4095 * Specifies the minimal length of a user password. If set to 0, empty pass-
4096 * words are allowed.
4098 $wgMinimalPasswordLength = 1;
4101 * Specifies if users should be sent to a password-reset form on login, if their
4102 * password doesn't meet the requirements of User::isValidPassword().
4103 * @since 1.23
4105 $wgInvalidPasswordReset = true;
4108 * Default password type to use when hashing user passwords
4110 * @since 1.24
4112 $wgPasswordDefault = 'pbkdf2';
4115 * Configuration for built-in password types. Maps the password type
4116 * to an array of options. The 'class' option is the Password class to
4117 * use. All other options are class-dependent.
4119 * An advanced example:
4120 * @code
4121 * $wgPasswordConfig['bcrypt-peppered'] = array(
4122 * 'class' => 'EncryptedPassword',
4123 * 'underlying' => 'bcrypt',
4124 * 'secrets' => array(),
4125 * 'cipher' => MCRYPT_RIJNDAEL_256,
4126 * 'mode' => MCRYPT_MODE_CBC,
4127 * 'cost' => 5,
4128 * );
4129 * @endcode
4131 * @since 1.24
4133 $wgPasswordConfig = array(
4134 'A' => array(
4135 'class' => 'MWOldPassword',
4137 'B' => array(
4138 'class' => 'MWSaltedPassword',
4140 'pbkdf2-legacyA' => array(
4141 'class' => 'LayeredParameterizedPassword',
4142 'types' => array(
4143 'A',
4144 'pbkdf2',
4147 'pbkdf2-legacyB' => array(
4148 'class' => 'LayeredParameterizedPassword',
4149 'types' => array(
4150 'B',
4151 'pbkdf2',
4154 'bcrypt' => array(
4155 'class' => 'BcryptPassword',
4156 'cost' => 9,
4158 'pbkdf2' => array(
4159 'class' => 'Pbkdf2Password',
4160 'algo' => 'sha256',
4161 'cost' => '10000',
4162 'length' => '128',
4167 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4168 * with a temporary password you can use to get back into the account") identified by
4169 * various bits of data. Setting all of these to false (or the whole variable to false)
4170 * has the effect of disabling password resets entirely
4172 $wgPasswordResetRoutes = array(
4173 'username' => true,
4174 'email' => false,
4178 * Maximum number of Unicode characters in signature
4180 $wgMaxSigChars = 255;
4183 * Maximum number of bytes in username. You want to run the maintenance
4184 * script ./maintenance/checkUsernames.php once you have changed this value.
4186 $wgMaxNameChars = 255;
4189 * Array of usernames which may not be registered or logged in from
4190 * Maintenance scripts can still use these
4192 $wgReservedUsernames = array(
4193 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4194 'Conversion script', // Used for the old Wikipedia software upgrade
4195 'Maintenance script', // Maintenance scripts which perform editing, image import script
4196 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4197 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4198 'msg:double-redirect-fixer', // Automatic double redirect fix
4199 'msg:usermessage-editor', // Default user for leaving user messages
4200 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4204 * Settings added to this array will override the default globals for the user
4205 * preferences used by anonymous visitors and newly created accounts.
4206 * For instance, to disable editing on double clicks:
4207 * $wgDefaultUserOptions ['editondblclick'] = 0;
4209 $wgDefaultUserOptions = array(
4210 'ccmeonemails' => 0,
4211 'cols' => 80,
4212 'date' => 'default',
4213 'diffonly' => 0,
4214 'disablemail' => 0,
4215 'editfont' => 'default',
4216 'editondblclick' => 0,
4217 'editsectiononrightclick' => 0,
4218 'enotifminoredits' => 0,
4219 'enotifrevealaddr' => 0,
4220 'enotifusertalkpages' => 1,
4221 'enotifwatchlistpages' => 1,
4222 'extendwatchlist' => 0,
4223 'fancysig' => 0,
4224 'forceeditsummary' => 0,
4225 'gender' => 'unknown',
4226 'hideminor' => 0,
4227 'hidepatrolled' => 0,
4228 'imagesize' => 2,
4229 'math' => 1,
4230 'minordefault' => 0,
4231 'newpageshidepatrolled' => 0,
4232 'nickname' => '',
4233 'norollbackdiff' => 0,
4234 'numberheadings' => 0,
4235 'previewonfirst' => 0,
4236 'previewontop' => 1,
4237 'rcdays' => 7,
4238 'rclimit' => 50,
4239 'rows' => 25,
4240 'showhiddencats' => 0,
4241 'shownumberswatching' => 1,
4242 'showtoolbar' => 1,
4243 'skin' => false,
4244 'stubthreshold' => 0,
4245 'thumbsize' => 5,
4246 'underline' => 2,
4247 'uselivepreview' => 0,
4248 'usenewrc' => 0,
4249 'watchcreations' => 1,
4250 'watchdefault' => 1,
4251 'watchdeletion' => 0,
4252 'watchlistdays' => 3.0,
4253 'watchlisthideanons' => 0,
4254 'watchlisthidebots' => 0,
4255 'watchlisthideliu' => 0,
4256 'watchlisthideminor' => 0,
4257 'watchlisthideown' => 0,
4258 'watchlisthidepatrolled' => 0,
4259 'watchmoves' => 0,
4260 'watchrollback' => 0,
4261 'wllimit' => 250,
4262 'useeditwarning' => 1,
4263 'prefershttps' => 1,
4267 * An array of preferences to not show for the user
4269 $wgHiddenPrefs = array();
4272 * Characters to prevent during new account creations.
4273 * This is used in a regular expression character class during
4274 * registration (regex metacharacters like / are escaped).
4276 $wgInvalidUsernameCharacters = '@';
4279 * Character used as a delimiter when testing for interwiki userrights
4280 * (In Special:UserRights, it is possible to modify users on different
4281 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4283 * It is recommended that you have this delimiter in
4284 * $wgInvalidUsernameCharacters above, or you will not be able to
4285 * modify the user rights of those users via Special:UserRights
4287 $wgUserrightsInterwikiDelimiter = '@';
4290 * This is to let user authenticate using https when they come from http.
4291 * Based on an idea by George Herbert on wikitech-l:
4292 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4293 * @since 1.17
4295 $wgSecureLogin = false;
4297 /** @} */ # end user accounts }
4299 /************************************************************************//**
4300 * @name User rights, access control and monitoring
4301 * @{
4305 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4307 $wgAutoblockExpiry = 86400;
4310 * Set this to true to allow blocked users to edit their own user talk page.
4312 $wgBlockAllowsUTEdit = false;
4315 * Allow sysops to ban users from accessing Emailuser
4317 $wgSysopEmailBans = true;
4320 * Limits on the possible sizes of range blocks.
4322 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4323 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4324 * half the number of bits avoids such errors, and allows entire ISPs to be
4325 * blocked using a small number of range blocks.
4327 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4328 * customer, so range blocks larger than /64 (half the number of bits) will
4329 * plainly be required. RFC 4692 implies that a very large ISP may be
4330 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4331 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4333 $wgBlockCIDRLimit = array(
4334 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4335 'IPv6' => 19,
4339 * If true, blocked users will not be allowed to login. When using this with
4340 * a public wiki, the effect of logging out blocked users may actually be
4341 * avers: unless the user's address is also blocked (e.g. auto-block),
4342 * logging the user out will again allow reading and editing, just as for
4343 * anonymous visitors.
4345 $wgBlockDisablesLogin = false;
4348 * Pages anonymous user may see, set as an array of pages titles.
4350 * @par Example:
4351 * @code
4352 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4353 * @endcode
4355 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4357 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4358 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4360 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4361 * will remain readable. You can use img_auth.php to protect uploaded files,
4362 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4364 $wgWhitelistRead = false;
4367 * Pages anonymous user may see, set as an array of regular expressions.
4369 * This function will match the regexp against the title name, which
4370 * is without underscore.
4372 * @par Example:
4373 * To whitelist [[Main Page]]:
4374 * @code
4375 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4376 * @endcode
4378 * @note Unless ^ and/or $ is specified, a regular expression might match
4379 * pages not intended to be whitelisted. The above example will also
4380 * whitelist a page named 'Security Main Page'.
4382 * @par Example:
4383 * To allow reading any page starting with 'User' regardless of the case:
4384 * @code
4385 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4386 * @endcode
4387 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4389 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4390 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4392 $wgWhitelistReadRegexp = false;
4395 * Should editors be required to have a validated e-mail
4396 * address before being allowed to edit?
4398 $wgEmailConfirmToEdit = false;
4401 * Permission keys given to users in each group.
4403 * This is an array where the keys are all groups and each value is an
4404 * array of the format (right => boolean).
4406 * The second format is used to support per-namespace permissions.
4407 * Note that this feature does not fully work for all permission types.
4409 * All users are implicitly in the '*' group including anonymous visitors;
4410 * logged-in users are all implicitly in the 'user' group. These will be
4411 * combined with the permissions of all groups that a given user is listed
4412 * in in the user_groups table.
4414 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4415 * doing! This will wipe all permissions, and may mean that your users are
4416 * unable to perform certain essential tasks or access new functionality
4417 * when new permissions are introduced and default grants established.
4419 * Functionality to make pages inaccessible has not been extensively tested
4420 * for security. Use at your own risk!
4422 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4424 $wgGroupPermissions = array();
4426 /** @cond file_level_code */
4427 // Implicit group for all visitors
4428 $wgGroupPermissions['*']['createaccount'] = true;
4429 $wgGroupPermissions['*']['read'] = true;
4430 $wgGroupPermissions['*']['edit'] = true;
4431 $wgGroupPermissions['*']['createpage'] = true;
4432 $wgGroupPermissions['*']['createtalk'] = true;
4433 $wgGroupPermissions['*']['writeapi'] = true;
4434 $wgGroupPermissions['*']['editmyusercss'] = true;
4435 $wgGroupPermissions['*']['editmyuserjs'] = true;
4436 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4437 $wgGroupPermissions['*']['editmywatchlist'] = true;
4438 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4439 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4440 $wgGroupPermissions['*']['editmyoptions'] = true;
4441 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4443 // Implicit group for all logged-in accounts
4444 $wgGroupPermissions['user']['move'] = true;
4445 $wgGroupPermissions['user']['move-subpages'] = true;
4446 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4447 $wgGroupPermissions['user']['move-categorypages'] = true;
4448 $wgGroupPermissions['user']['movefile'] = true;
4449 $wgGroupPermissions['user']['read'] = true;
4450 $wgGroupPermissions['user']['edit'] = true;
4451 $wgGroupPermissions['user']['createpage'] = true;
4452 $wgGroupPermissions['user']['createtalk'] = true;
4453 $wgGroupPermissions['user']['writeapi'] = true;
4454 $wgGroupPermissions['user']['upload'] = true;
4455 $wgGroupPermissions['user']['reupload'] = true;
4456 $wgGroupPermissions['user']['reupload-shared'] = true;
4457 $wgGroupPermissions['user']['minoredit'] = true;
4458 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4459 $wgGroupPermissions['user']['sendemail'] = true;
4461 // Implicit group for accounts that pass $wgAutoConfirmAge
4462 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4463 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4465 // Users with bot privilege can have their edits hidden
4466 // from various log pages by default
4467 $wgGroupPermissions['bot']['bot'] = true;
4468 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4469 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4470 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4471 $wgGroupPermissions['bot']['autopatrol'] = true;
4472 $wgGroupPermissions['bot']['suppressredirect'] = true;
4473 $wgGroupPermissions['bot']['apihighlimits'] = true;
4474 $wgGroupPermissions['bot']['writeapi'] = true;
4476 // Most extra permission abilities go to this group
4477 $wgGroupPermissions['sysop']['block'] = true;
4478 $wgGroupPermissions['sysop']['createaccount'] = true;
4479 $wgGroupPermissions['sysop']['delete'] = true;
4480 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4481 $wgGroupPermissions['sysop']['bigdelete'] = true;
4482 // can view deleted history entries, but not see or restore the text
4483 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4484 // can view deleted revision text
4485 $wgGroupPermissions['sysop']['deletedtext'] = true;
4486 $wgGroupPermissions['sysop']['undelete'] = true;
4487 $wgGroupPermissions['sysop']['editinterface'] = true;
4488 $wgGroupPermissions['sysop']['editusercss'] = true;
4489 $wgGroupPermissions['sysop']['edituserjs'] = true;
4490 $wgGroupPermissions['sysop']['import'] = true;
4491 $wgGroupPermissions['sysop']['importupload'] = true;
4492 $wgGroupPermissions['sysop']['move'] = true;
4493 $wgGroupPermissions['sysop']['move-subpages'] = true;
4494 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4495 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4496 $wgGroupPermissions['sysop']['patrol'] = true;
4497 $wgGroupPermissions['sysop']['autopatrol'] = true;
4498 $wgGroupPermissions['sysop']['protect'] = true;
4499 $wgGroupPermissions['sysop']['editprotected'] = true;
4500 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4501 $wgGroupPermissions['sysop']['rollback'] = true;
4502 $wgGroupPermissions['sysop']['upload'] = true;
4503 $wgGroupPermissions['sysop']['reupload'] = true;
4504 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4505 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4506 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4507 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4508 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4509 $wgGroupPermissions['sysop']['blockemail'] = true;
4510 $wgGroupPermissions['sysop']['markbotedits'] = true;
4511 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4512 $wgGroupPermissions['sysop']['browsearchive'] = true;
4513 $wgGroupPermissions['sysop']['noratelimit'] = true;
4514 $wgGroupPermissions['sysop']['movefile'] = true;
4515 $wgGroupPermissions['sysop']['unblockself'] = true;
4516 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4517 #$wgGroupPermissions['sysop']['pagelang'] = true;
4518 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4519 $wgGroupPermissions['sysop']['mergehistory'] = true;
4521 // Permission to change users' group assignments
4522 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4523 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4524 // Permission to change users' groups assignments across wikis
4525 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4526 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4527 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4529 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4530 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4531 // To hide usernames from users and Sysops
4532 #$wgGroupPermissions['suppress']['hideuser'] = true;
4533 // To hide revisions/log items from users and Sysops
4534 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4535 // To view revisions/log items hidden from users and Sysops
4536 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4537 // For private suppression log access
4538 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4541 * The developer group is deprecated, but can be activated if need be
4542 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4543 * that a lock file be defined and creatable/removable by the web
4544 * server.
4546 # $wgGroupPermissions['developer']['siteadmin'] = true;
4548 /** @endcond */
4551 * Permission keys revoked from users in each group.
4553 * This acts the same way as wgGroupPermissions above, except that
4554 * if the user is in a group here, the permission will be removed from them.
4556 * Improperly setting this could mean that your users will be unable to perform
4557 * certain essential tasks, so use at your own risk!
4559 $wgRevokePermissions = array();
4562 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4564 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4567 * A map of group names that the user is in, to group names that those users
4568 * are allowed to add or revoke.
4570 * Setting the list of groups to add or revoke to true is equivalent to "any
4571 * group".
4573 * @par Example:
4574 * To allow sysops to add themselves to the "bot" group:
4575 * @code
4576 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4577 * @endcode
4579 * @par Example:
4580 * Implicit groups may be used for the source group, for instance:
4581 * @code
4582 * $wgGroupsRemoveFromSelf = array( '*' => true );
4583 * @endcode
4584 * This allows users in the '*' group (i.e. any user) to remove themselves from
4585 * any group that they happen to be in.
4587 $wgGroupsAddToSelf = array();
4590 * @see $wgGroupsAddToSelf
4592 $wgGroupsRemoveFromSelf = array();
4595 * Set of available actions that can be restricted via action=protect
4596 * You probably shouldn't change this.
4597 * Translated through restriction-* messages.
4598 * Title::getRestrictionTypes() will remove restrictions that are not
4599 * applicable to a specific title (create and upload)
4601 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4604 * Rights which can be required for each protection level (via action=protect)
4606 * You can add a new protection level that requires a specific
4607 * permission by manipulating this array. The ordering of elements
4608 * dictates the order on the protection form's lists.
4610 * - '' will be ignored (i.e. unprotected)
4611 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4612 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4614 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4617 * Restriction levels that can be used with cascading protection
4619 * A page can only be protected with cascading protection if the
4620 * requested restriction level is included in this array.
4622 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4623 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4625 $wgCascadingRestrictionLevels = array( 'sysop' );
4628 * Restriction levels that should be considered "semiprotected"
4630 * Certain places in the interface recognize a dichotomy between "protected"
4631 * and "semiprotected", without further distinguishing the specific levels. In
4632 * general, if anyone can be eligible to edit a protection level merely by
4633 * reaching some condition in $wgAutopromote, it should probably be considered
4634 * "semiprotected".
4636 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4637 * 'sysop' is not changed, since it really shouldn't be here.
4639 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4642 * Set the minimum permissions required to edit pages in each
4643 * namespace. If you list more than one permission, a user must
4644 * have all of them to edit pages in that namespace.
4646 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4648 $wgNamespaceProtection = array();
4651 * Pages in namespaces in this array can not be used as templates.
4653 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4654 * namespaces constants (NS_USER, NS_MAIN...).
4656 * Among other things, this may be useful to enforce read-restrictions
4657 * which may otherwise be bypassed by using the template mechanism.
4659 $wgNonincludableNamespaces = array();
4662 * Number of seconds an account is required to age before it's given the
4663 * implicit 'autoconfirm' group membership. This can be used to limit
4664 * privileges of new accounts.
4666 * Accounts created by earlier versions of the software may not have a
4667 * recorded creation date, and will always be considered to pass the age test.
4669 * When left at 0, all registered accounts will pass.
4671 * @par Example:
4672 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4673 * @code
4674 * $wgAutoConfirmAge = 600; // ten minutes
4675 * @endcode
4676 * Set age to one day:
4677 * @code
4678 * $wgAutoConfirmAge = 3600*24; // one day
4679 * @endcode
4681 $wgAutoConfirmAge = 0;
4684 * Number of edits an account requires before it is autoconfirmed.
4685 * Passing both this AND the time requirement is needed. Example:
4687 * @par Example:
4688 * @code
4689 * $wgAutoConfirmCount = 50;
4690 * @endcode
4692 $wgAutoConfirmCount = 0;
4695 * Automatically add a usergroup to any user who matches certain conditions.
4697 * @todo Redocument $wgAutopromote
4699 * The format is
4700 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4701 * where cond1, cond2, ... are themselves conditions; *OR*
4702 * APCOND_EMAILCONFIRMED, *OR*
4703 * array( APCOND_EMAILCONFIRMED ), *OR*
4704 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4705 * array( APCOND_AGE, seconds since registration ), *OR*
4706 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4707 * array( APCOND_ISIP, ip ), *OR*
4708 * array( APCOND_IPINRANGE, range ), *OR*
4709 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4710 * array( APCOND_BLOCKED ), *OR*
4711 * array( APCOND_ISBOT ), *OR*
4712 * similar constructs defined by extensions.
4714 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4715 * user who has provided an e-mail address.
4717 $wgAutopromote = array(
4718 'autoconfirmed' => array( '&',
4719 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4720 array( APCOND_AGE, &$wgAutoConfirmAge ),
4725 * Automatically add a usergroup to any user who matches certain conditions.
4727 * Does not add the user to the group again if it has been removed.
4728 * Also, does not remove the group if the user no longer meets the criteria.
4730 * The format is:
4731 * @code
4732 * array( event => criteria, ... )
4733 * @endcode
4734 * Where event is either:
4735 * - 'onEdit' (when user edits)
4736 * - 'onView' (when user views the wiki)
4738 * Criteria has the same format as $wgAutopromote
4740 * @see $wgAutopromote
4741 * @since 1.18
4743 $wgAutopromoteOnce = array(
4744 'onEdit' => array(),
4745 'onView' => array()
4749 * Put user rights log entries for autopromotion in recent changes?
4750 * @since 1.18
4752 $wgAutopromoteOnceLogInRC = true;
4755 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4756 * can assign which groups at Special:Userrights.
4758 * @par Example:
4759 * Bureaucrats can add any group:
4760 * @code
4761 * $wgAddGroups['bureaucrat'] = true;
4762 * @endcode
4763 * Bureaucrats can only remove bots and sysops:
4764 * @code
4765 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4766 * @endcode
4767 * Sysops can make bots:
4768 * @code
4769 * $wgAddGroups['sysop'] = array( 'bot' );
4770 * @endcode
4771 * Sysops can disable other sysops in an emergency, and disable bots:
4772 * @code
4773 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4774 * @endcode
4776 $wgAddGroups = array();
4779 * @see $wgAddGroups
4781 $wgRemoveGroups = array();
4784 * A list of available rights, in addition to the ones defined by the core.
4785 * For extensions only.
4787 $wgAvailableRights = array();
4790 * Optional to restrict deletion of pages with higher revision counts
4791 * to users with the 'bigdelete' permission. (Default given to sysops.)
4793 $wgDeleteRevisionsLimit = 0;
4796 * The maximum number of edits a user can have and
4797 * can still be hidden by users with the hideuser permission.
4798 * This is limited for performance reason.
4799 * Set to false to disable the limit.
4800 * @since 1.23
4802 $wgHideUserContribLimit = 1000;
4805 * Number of accounts each IP address may create, 0 to disable.
4807 * @warning Requires memcached
4809 $wgAccountCreationThrottle = 0;
4812 * Edits matching these regular expressions in body text
4813 * will be recognised as spam and rejected automatically.
4815 * There's no administrator override on-wiki, so be careful what you set. :)
4816 * May be an array of regexes or a single string for backwards compatibility.
4818 * @see http://en.wikipedia.org/wiki/Regular_expression
4820 * @note Each regex needs a beginning/end delimiter, eg: # or /
4822 $wgSpamRegex = array();
4825 * Same as the above except for edit summaries
4827 $wgSummarySpamRegex = array();
4830 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4831 * proxies
4832 * @since 1.16
4834 $wgEnableDnsBlacklist = false;
4837 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4839 * This is an array of either a URL or an array with the URL and a key (should
4840 * the blacklist require a key).
4842 * @par Example:
4843 * @code
4844 * $wgDnsBlacklistUrls = array(
4845 * // String containing URL
4846 * 'http.dnsbl.sorbs.net.',
4847 * // Array with URL and key, for services that require a key
4848 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4849 * // Array with just the URL. While this works, it is recommended that you
4850 * // just use a string as shown above
4851 * array( 'opm.tornevall.org.' )
4852 * );
4853 * @endcode
4855 * @note You should end the domain name with a . to avoid searching your
4856 * eventual domain search suffixes.
4857 * @since 1.16
4859 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4862 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4863 * what the other methods might say.
4865 $wgProxyWhitelist = array();
4868 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4869 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4870 * (transparent) proxies without needing to block the proxies themselves.
4872 $wgApplyIpBlocksToXff = false;
4875 * Simple rate limiter options to brake edit floods.
4877 * Maximum number actions allowed in the given number of seconds; after that
4878 * the violating client receives HTTP 500 error pages until the period
4879 * elapses.
4881 * @par Example:
4882 * To set a generic maximum of 4 hits in 60 seconds:
4883 * @code
4884 * $wgRateLimits = array( 4, 60 );
4885 * @endcode
4887 * You could also limit per action and then type of users. See the inline
4888 * code for a template to use.
4890 * This option set is experimental and likely to change.
4892 * @warning Requires memcached.
4894 $wgRateLimits = array(
4895 'edit' => array(
4896 'anon' => null, // for any and all anonymous edits (aggregate)
4897 'user' => null, // for each logged-in user
4898 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4899 'ip' => null, // for each anon and recent account
4900 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4902 'move' => array(
4903 'user' => null,
4904 'newbie' => null,
4905 'ip' => null,
4906 'subnet' => null,
4908 'mailpassword' => array( // triggering password resets emails
4909 'anon' => null,
4911 'emailuser' => array( // emailing other users using MediaWiki
4912 'user' => null,
4914 'linkpurge' => array( // purges of link tables
4915 'anon' => null,
4916 'user' => null,
4917 'newbie' => null,
4918 'ip' => null,
4919 'subnet' => null,
4921 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4922 'anon' => null,
4923 'user' => null,
4924 'newbie' => null,
4925 'ip' => null,
4926 'subnet' => null,
4928 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
4929 'anon' => null,
4930 'user' => null,
4931 'newbie' => null,
4932 'ip' => null,
4933 'subnet' => null,
4938 * Set to a filename to log rate limiter hits.
4940 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
4942 $wgRateLimitLog = null;
4945 * Array of IPs which should be excluded from rate limits.
4946 * This may be useful for whitelisting NAT gateways for conferences, etc.
4948 $wgRateLimitsExcludedIPs = array();
4951 * Log IP addresses in the recentchanges table; can be accessed only by
4952 * extensions (e.g. CheckUser) or a DB admin
4953 * Used for retroactive autoblocks
4955 $wgPutIPinRC = true;
4958 * Integer defining default number of entries to show on
4959 * special pages which are query-pages such as Special:Whatlinkshere.
4961 $wgQueryPageDefaultLimit = 50;
4964 * Limit password attempts to X attempts per Y seconds per IP per account.
4966 * @warning Requires memcached.
4968 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4970 /** @} */ # end of user rights settings
4972 /************************************************************************//**
4973 * @name Proxy scanner settings
4974 * @{
4978 * This should always be customised in LocalSettings.php
4980 $wgSecretKey = false;
4983 * Big list of banned IP addresses.
4985 * This can have the following formats:
4986 * - An array of addresses, either in the values
4987 * or the keys (for backward compatibility)
4988 * - A string, in that case this is the path to a file
4989 * containing the list of IP addresses, one per line
4991 $wgProxyList = array();
4993 /** @} */ # end of proxy scanner settings
4995 /************************************************************************//**
4996 * @name Cookie settings
4997 * @{
5001 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5003 $wgCookieExpiration = 180 * 86400;
5006 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5007 * or ".any.subdomain.net"
5009 $wgCookieDomain = '';
5012 * Set this variable if you want to restrict cookies to a certain path within
5013 * the domain specified by $wgCookieDomain.
5015 $wgCookiePath = '/';
5018 * Whether the "secure" flag should be set on the cookie. This can be:
5019 * - true: Set secure flag
5020 * - false: Don't set secure flag
5021 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5023 $wgCookieSecure = 'detect';
5026 * By default, MediaWiki checks if the client supports cookies during the
5027 * login process, so that it can display an informative error message if
5028 * cookies are disabled. Set this to true if you want to disable this cookie
5029 * check.
5031 $wgDisableCookieCheck = false;
5034 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5035 * to a string to use a custom prefix. Setting it to false causes the database
5036 * name to be used as a prefix.
5038 $wgCookiePrefix = false;
5041 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5042 * in browsers that support this feature. This can mitigates some classes of
5043 * XSS attack.
5045 $wgCookieHttpOnly = true;
5048 * A list of cookies that vary the cache (for use by extensions)
5050 $wgCacheVaryCookies = array();
5053 * Override to customise the session name
5055 $wgSessionName = false;
5057 /** @} */ # end of cookie settings }
5059 /************************************************************************//**
5060 * @name LaTeX (mathematical formulas)
5061 * @{
5065 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5066 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5067 * (ImageMagick) installed and available in the PATH.
5068 * Please see math/README for more information.
5070 $wgUseTeX = false;
5072 /** @} */ # end LaTeX }
5074 /************************************************************************//**
5075 * @name Profiling, testing and debugging
5077 * To enable profiling, edit StartProfiler.php
5079 * @{
5083 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5084 * The debug log file should be not be publicly accessible if it is used, as it
5085 * may contain private data.
5087 $wgDebugLogFile = '';
5090 * Prefix for debug log lines
5092 $wgDebugLogPrefix = '';
5095 * If true, instead of redirecting, show a page with a link to the redirect
5096 * destination. This allows for the inspection of PHP error messages, and easy
5097 * resubmission of form data. For developer use only.
5099 $wgDebugRedirects = false;
5102 * If true, log debugging data from action=raw and load.php.
5103 * This is normally false to avoid overlapping debug entries due to gen=css
5104 * and gen=js requests.
5106 $wgDebugRawPage = false;
5109 * Send debug data to an HTML comment in the output.
5111 * This may occasionally be useful when supporting a non-technical end-user.
5112 * It's more secure than exposing the debug log file to the web, since the
5113 * output only contains private data for the current user. But it's not ideal
5114 * for development use since data is lost on fatal errors and redirects.
5116 $wgDebugComments = false;
5119 * Extensive database transaction state debugging
5121 * @since 1.20
5123 $wgDebugDBTransactions = false;
5126 * Write SQL queries to the debug log.
5128 * This setting is only used $wgLBFactoryConf['class'] is set to
5129 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5130 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5131 * connection to achieve the same functionality.
5133 $wgDebugDumpSql = false;
5136 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5137 * trimming.
5138 * @since 1.24
5140 $wgDebugDumpSqlLength = 500;
5143 * Map of string log group names to log destinations.
5145 * If set, wfDebugLog() output for that group will go to that file instead
5146 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5147 * in production.
5149 * Log destinations may be one of the following:
5150 * - false to completely remove from the output, including from $wgDebugLogFile.
5151 * - string values specifying a filename or URI.
5152 * - associative array mapping 'destination' key to the desired filename or URI.
5153 * The associative array may also contain a 'sample' key with an integer value,
5154 * specifying a sampling factor.
5156 * @par Example:
5157 * @code
5158 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5159 * @endcode
5161 * @par Advanced example:
5162 * @code
5163 * $wgDebugLogGroups['memcached'] = (
5164 * 'destination' => '/var/log/mediawiki/memcached.log',
5165 * 'sample' => 1000, // log 1 message out of every 1,000.
5166 * );
5167 * @endcode
5169 $wgDebugLogGroups = array();
5172 * Display debug data at the bottom of the main content area.
5174 * Useful for developers and technical users trying to working on a closed wiki.
5176 $wgShowDebug = false;
5179 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5180 * Since 1.19 also includes memory usage.
5182 $wgDebugTimestamps = false;
5185 * Print HTTP headers for every request in the debug information.
5187 $wgDebugPrintHttpHeaders = true;
5190 * Show the contents of $wgHooks in Special:Version
5192 $wgSpecialVersionShowHooks = false;
5195 * Whether to show "we're sorry, but there has been a database error" pages.
5196 * Displaying errors aids in debugging, but may display information useful
5197 * to an attacker.
5199 $wgShowSQLErrors = false;
5202 * If set to true, uncaught exceptions will print a complete stack trace
5203 * to output. This should only be used for debugging, as it may reveal
5204 * private information in function parameters due to PHP's backtrace
5205 * formatting.
5207 $wgShowExceptionDetails = false;
5210 * If true, show a backtrace for database errors
5212 * @note This setting only applies when connection errors and query errors are
5213 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5214 * including those in which an uncaught exception is thrown from within the
5215 * exception handler.
5217 $wgShowDBErrorBacktrace = false;
5220 * If true, send the exception backtrace to the error log
5222 $wgLogExceptionBacktrace = true;
5225 * Expose backend server host names through the API and various HTML comments
5227 $wgShowHostnames = false;
5230 * Override server hostname detection with a hardcoded value.
5231 * Should be a string, default false.
5232 * @since 1.20
5234 $wgOverrideHostname = false;
5237 * If set to true MediaWiki will throw notices for some possible error
5238 * conditions and for deprecated functions.
5240 $wgDevelopmentWarnings = false;
5243 * Release limitation to wfDeprecated warnings, if set to a release number
5244 * development warnings will not be generated for deprecations added in releases
5245 * after the limit.
5247 $wgDeprecationReleaseLimit = false;
5250 * Only record profiling info for pages that took longer than this
5252 $wgProfileLimit = 0.0;
5255 * Don't put non-profiling info into log file
5257 * @deprecated since 1.23, set the log file in
5258 * $wgDebugLogGroups['profileoutput'] instead.
5260 $wgProfileOnly = false;
5263 * If true, print a raw call tree instead of per-function report
5265 $wgProfileCallTree = false;
5268 * Should application server host be put into profiling table
5270 $wgProfilePerHost = false;
5273 * Host for UDP profiler.
5275 * The host should be running a daemon which can be obtained from MediaWiki
5276 * Git at:
5277 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5279 $wgUDPProfilerHost = '127.0.0.1';
5282 * Port for UDP profiler.
5283 * @see $wgUDPProfilerHost
5285 $wgUDPProfilerPort = '3811';
5288 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5289 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5290 * arguments. You can use sprintf's argument numbering/swapping capability to
5291 * repeat, re-order or omit fields.
5293 * @see $wgStatsFormatString
5294 * @since 1.22
5296 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5299 * Output debug message on every wfProfileIn/wfProfileOut
5301 $wgDebugFunctionEntry = false;
5304 * Destination for wfIncrStats() data...
5305 * 'cache' to go into the system cache, if enabled (memcached)
5306 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5307 * false to disable
5309 $wgStatsMethod = 'cache';
5312 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5313 * be aggregated over more than one wiki. The string will be used in place of
5314 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5315 * will be used.
5317 $wgAggregateStatsID = false;
5320 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5321 * formatted. Its value should be a format string suitable for a sprintf()
5322 * invocation with (id, count, key) arguments, where 'id' is either
5323 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5324 * is being incremented, and 'key' is the metric name.
5326 * @see $wgUDPProfilerFormatString
5327 * @see $wgAggregateStatsID
5328 * @since 1.22
5330 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5333 * Whereas to count the number of time an article is viewed.
5334 * Does not work if pages are cached (for example with squid).
5336 $wgDisableCounters = false;
5339 * InfoAction retrieves a list of transclusion links (both to and from).
5340 * This number puts a limit on that query in the case of highly transcluded
5341 * templates.
5343 $wgPageInfoTransclusionLimit = 50;
5346 * Set this to an integer to only do synchronous site_stats updates
5347 * one every *this many* updates. The other requests go into pending
5348 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5349 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5351 $wgSiteStatsAsyncFactor = false;
5354 * Parser test suite files to be run by parserTests.php when no specific
5355 * filename is passed to it.
5357 * Extensions may add their own tests to this array, or site-local tests
5358 * may be added via LocalSettings.php
5360 * Use full paths.
5362 $wgParserTestFiles = array(
5363 "$IP/tests/parser/parserTests.txt",
5364 "$IP/tests/parser/extraParserTests.txt"
5368 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5370 $wgEnableJavaScriptTest = false;
5373 * Configuration for javascript testing.
5375 $wgJavaScriptTestConfig = array(
5376 'qunit' => array(
5377 // Page where documentation can be found relevant to the QUnit test suite being ran.
5378 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5379 // documentation link in the "javascripttest-qunit-intro" message.
5380 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5381 // If you are submitting the QUnit test suite to a TestSwarm instance,
5382 // point this to the "inject.js" script of that instance. This is was registers
5383 // the QUnit hooks to extract the test results and push them back up into the
5384 // TestSwarm database.
5385 // @example 'http://localhost/testswarm/js/inject.js'
5386 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5387 'testswarm-injectjs' => false,
5392 * Overwrite the caching key prefix with custom value.
5393 * @since 1.19
5395 $wgCachePrefix = false;
5398 * Display the new debugging toolbar. This also enables profiling on database
5399 * queries and other useful output.
5400 * Will disable file cache.
5402 * @since 1.19
5404 $wgDebugToolbar = false;
5406 /** @} */ # end of profiling, testing and debugging }
5408 /************************************************************************//**
5409 * @name Search
5410 * @{
5414 * Set this to true to disable the full text search feature.
5416 $wgDisableTextSearch = false;
5419 * Set to true to have nicer highlighted text in search results,
5420 * by default off due to execution overhead
5422 $wgAdvancedSearchHighlighting = false;
5425 * Regexp to match word boundaries, defaults for non-CJK languages
5426 * should be empty for CJK since the words are not separate
5428 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5431 * Template for OpenSearch suggestions, defaults to API action=opensearch
5433 * Sites with heavy load would typically have these point to a custom
5434 * PHP wrapper to avoid firing up mediawiki for every keystroke
5436 * Placeholders: {searchTerms}
5438 $wgOpenSearchTemplate = false;
5441 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5442 * false if you've disabled scripts that use api?action=opensearch and
5443 * want reduce load caused by cached scripts still pulling suggestions.
5444 * It will let the API fallback by responding with an empty array.
5446 $wgEnableOpenSearchSuggest = true;
5449 * Integer defining default number of entries to show on
5450 * OpenSearch call.
5452 $wgOpenSearchDefaultLimit = 10;
5455 * Expiry time for search suggestion responses
5457 $wgSearchSuggestCacheExpiry = 1200;
5460 * If you've disabled search semi-permanently, this also disables updates to the
5461 * table. If you ever re-enable, be sure to rebuild the search table.
5463 $wgDisableSearchUpdate = false;
5466 * List of namespaces which are searched by default.
5468 * @par Example:
5469 * @code
5470 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5471 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5472 * @endcode
5474 $wgNamespacesToBeSearchedDefault = array(
5475 NS_MAIN => true,
5479 * Disable the internal MySQL-based search, to allow it to be
5480 * implemented by an extension instead.
5482 $wgDisableInternalSearch = false;
5485 * Set this to a URL to forward search requests to some external location.
5486 * If the URL includes '$1', this will be replaced with the URL-encoded
5487 * search term.
5489 * @par Example:
5490 * To forward to Google you'd have something like:
5491 * @code
5492 * $wgSearchForwardUrl =
5493 * 'http://www.google.com/search?q=$1' .
5494 * '&domains=http://example.com' .
5495 * '&sitesearch=http://example.com' .
5496 * '&ie=utf-8&oe=utf-8';
5497 * @endcode
5499 $wgSearchForwardUrl = null;
5502 * Search form behavior.
5503 * - true = use Go & Search buttons
5504 * - false = use Go button & Advanced search link
5506 $wgUseTwoButtonsSearchForm = true;
5509 * Array of namespaces to generate a Google sitemap for when the
5510 * maintenance/generateSitemap.php script is run, or false if one is to be
5511 * generated for all namespaces.
5513 $wgSitemapNamespaces = false;
5516 * Custom namespace priorities for sitemaps. Setting this will allow you to
5517 * set custom priorities to namespaces when sitemaps are generated using the
5518 * maintenance/generateSitemap.php script.
5520 * This should be a map of namespace IDs to priority
5521 * @par Example:
5522 * @code
5523 * $wgSitemapNamespacesPriorities = array(
5524 * NS_USER => '0.9',
5525 * NS_HELP => '0.0',
5526 * );
5527 * @endcode
5529 $wgSitemapNamespacesPriorities = false;
5532 * If true, searches for IP addresses will be redirected to that IP's
5533 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5534 * [[Special:Contributions/1.2.3.4]]
5536 $wgEnableSearchContributorsByIP = true;
5538 /** @} */ # end of search settings
5540 /************************************************************************//**
5541 * @name Edit user interface
5542 * @{
5546 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5547 * fall back to the old behavior (no merging).
5549 $wgDiff3 = '/usr/bin/diff3';
5552 * Path to the GNU diff utility.
5554 $wgDiff = '/usr/bin/diff';
5557 * Which namespaces have special treatment where they should be preview-on-open
5558 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5559 * can specify namespaces of pages they have special treatment for
5561 $wgPreviewOnOpenNamespaces = array(
5562 NS_CATEGORY => true
5566 * Go button goes straight to the edit screen if the article doesn't exist.
5568 $wgGoToEdit = false;
5571 * Enable the UniversalEditButton for browsers that support it
5572 * (currently only Firefox with an extension)
5573 * See http://universaleditbutton.org for more background information
5575 $wgUniversalEditButton = true;
5578 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5579 * will try to automatically create one. This feature can be disabled by set-
5580 * ting this variable false.
5582 $wgUseAutomaticEditSummaries = true;
5584 /** @} */ # end edit UI }
5586 /************************************************************************//**
5587 * @name Maintenance
5588 * See also $wgSiteNotice
5589 * @{
5593 * @cond file_level_code
5594 * Set $wgCommandLineMode if it's not set already, to avoid notices
5596 if ( !isset( $wgCommandLineMode ) ) {
5597 $wgCommandLineMode = false;
5599 /** @endcond */
5602 * For colorized maintenance script output, is your terminal background dark ?
5604 $wgCommandLineDarkBg = false;
5607 * Set this to a string to put the wiki into read-only mode. The text will be
5608 * used as an explanation to users.
5610 * This prevents most write operations via the web interface. Cache updates may
5611 * still be possible. To prevent database writes completely, use the read_only
5612 * option in MySQL.
5614 $wgReadOnly = null;
5617 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5618 * Its contents will be shown to users as part of the read-only warning
5619 * message.
5621 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5623 $wgReadOnlyFile = false;
5626 * When you run the web-based upgrade utility, it will tell you what to set
5627 * this to in order to authorize the upgrade process. It will subsequently be
5628 * used as a password, to authorize further upgrades.
5630 * For security, do not set this to a guessable string. Use the value supplied
5631 * by the install/upgrade process. To cause the upgrader to generate a new key,
5632 * delete the old key from LocalSettings.php.
5634 $wgUpgradeKey = false;
5637 * Fully specified path to git binary
5639 $wgGitBin = '/usr/bin/git';
5642 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5644 * Key is a pattern passed to preg_match() and preg_replace(),
5645 * without the delimiters (which are #) and must match the whole URL.
5646 * The value is the replacement for the key (it can contain $1, etc.)
5647 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5648 * full SHA-1 of the HEAD revision.
5649 * %r will be replaced with a URL-encoded version of $1.
5651 * @since 1.20
5653 $wgGitRepositoryViewers = array(
5654 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5655 'https://git.wikimedia.org/tree/%r/%H',
5656 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5657 'https://git.wikimedia.org/tree/%r/%H',
5660 /** @} */ # End of maintenance }
5662 /************************************************************************//**
5663 * @name Recent changes, new pages, watchlist and history
5664 * @{
5668 * Recentchanges items are periodically purged; entries older than this many
5669 * seconds will go.
5670 * Default: 13 weeks = about three months
5672 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5675 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5676 * higher than what will be stored. Note that this is disabled by default
5677 * because we sometimes do have RC data which is beyond the limit for some
5678 * reason, and some users may use the high numbers to display that data which
5679 * is still there.
5681 $wgRCFilterByAge = false;
5684 * List of Limits options to list in the Special:Recentchanges and
5685 * Special:Recentchangeslinked pages.
5687 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5690 * List of Days options to list in the Special:Recentchanges and
5691 * Special:Recentchangeslinked pages.
5693 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5696 * Destinations to which notifications about recent changes
5697 * should be sent.
5699 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5700 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5701 * specified server.
5702 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5704 * The common options are:
5705 * * 'uri' -- the address to which the notices are to be sent.
5706 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5707 * produce the text to send. This can also be an object of the class.
5708 * * 'omit_bots' -- whether the bot edits should be in the feed
5709 * * 'omit_anon' -- whether anonymous edits should be in the feed
5710 * * 'omit_user' -- whether edits by registered users should be in the feed
5711 * * 'omit_minor' -- whether minor edits should be in the feed
5712 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5714 * The IRC-specific options are:
5715 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5716 * the first entry in the $wgLocalInterwikis array (or the value of
5717 * $wgLocalInterwiki, if set)
5719 * The JSON-specific options are:
5720 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5722 * @example $wgRCFeeds['example'] = array(
5723 * 'formatter' => 'JSONRCFeedFormatter',
5724 * 'uri' => "udp://localhost:1336",
5725 * 'add_interwiki_prefix' => false,
5726 * 'omit_bots' => true,
5727 * );
5728 * @example $wgRCFeeds['exampleirc'] = array(
5729 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5730 * 'uri' => "udp://localhost:1338",
5731 * 'add_interwiki_prefix' => false,
5732 * 'omit_bots' => true,
5733 * );
5734 * @since 1.22
5736 $wgRCFeeds = array();
5739 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5740 * Keys are scheme names, values are names of engine classes.
5742 $wgRCEngines = array(
5743 'redis' => 'RedisPubSubFeedEngine',
5744 'udp' => 'UDPRCFeedEngine',
5748 * Use RC Patrolling to check for vandalism
5750 $wgUseRCPatrol = true;
5753 * Use new page patrolling to check new pages on Special:Newpages
5755 $wgUseNPPatrol = true;
5758 * Log autopatrol actions to the log table
5760 $wgLogAutopatrol = true;
5763 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5765 $wgFeed = true;
5768 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5769 * eg Recentchanges, Newpages.
5771 $wgFeedLimit = 50;
5774 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5775 * A cached version will continue to be served out even if changes
5776 * are made, until this many seconds runs out since the last render.
5778 * If set to 0, feed caching is disabled. Use this for debugging only;
5779 * feed generation can be pretty slow with diffs.
5781 $wgFeedCacheTimeout = 60;
5784 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5785 * pages larger than this size.
5787 $wgFeedDiffCutoff = 32768;
5790 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5791 * every page. Some sites might have a different feed they'd like to promote
5792 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5793 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5794 * as value.
5795 * @par Example:
5796 * Configure the 'atom' feed to http://example.com/somefeed.xml
5797 * @code
5798 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5799 * @endcode
5801 $wgOverrideSiteFeed = array();
5804 * Available feeds objects.
5805 * Should probably only be defined when a page is syndicated ie when
5806 * $wgOut->isSyndicated() is true.
5808 $wgFeedClasses = array(
5809 'rss' => 'RSSFeed',
5810 'atom' => 'AtomFeed',
5814 * Which feed types should we provide by default? This can include 'rss',
5815 * 'atom', neither, or both.
5817 $wgAdvertisedFeedTypes = array( 'atom' );
5820 * Show watching users in recent changes, watchlist and page history views
5822 $wgRCShowWatchingUsers = false; # UPO
5825 * Show watching users in Page views
5827 $wgPageShowWatchingUsers = false;
5830 * Show the amount of changed characters in recent changes
5832 $wgRCShowChangedSize = true;
5835 * If the difference between the character counts of the text
5836 * before and after the edit is below that value, the value will be
5837 * highlighted on the RC page.
5839 $wgRCChangedSizeThreshold = 500;
5842 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5843 * view for watched pages with new changes
5845 $wgShowUpdatedMarker = true;
5848 * Disable links to talk pages of anonymous users (IPs) in listings on special
5849 * pages like page history, Special:Recentchanges, etc.
5851 $wgDisableAnonTalk = false;
5854 * Enable filtering of categories in Recentchanges
5856 $wgAllowCategorizedRecentChanges = false;
5859 * Allow filtering by change tag in recentchanges, history, etc
5860 * Has no effect if no tags are defined in valid_tag.
5862 $wgUseTagFilter = true;
5865 * If set to an integer, pages that are watched by this many users or more
5866 * will not require the unwatchedpages permission to view the number of
5867 * watchers.
5869 * @since 1.21
5871 $wgUnwatchedPageThreshold = false;
5874 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5875 * certain types of edits.
5877 * To register a new one:
5878 * @code
5879 * $wgRecentChangesFlags['flag'] => array(
5880 * // message for the letter displayed next to rows on changes lists
5881 * 'letter' => 'letter-msg',
5882 * // message for the tooltip of the letter
5883 * 'title' => 'tooltip-msg',
5884 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
5885 * 'legend' => 'legend-msg',
5886 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
5887 * 'class' => 'css-class',
5888 * );
5889 * @endcode
5891 * @since 1.22
5893 $wgRecentChangesFlags = array(
5894 'newpage' => array(
5895 'letter' => 'newpageletter',
5896 'title' => 'recentchanges-label-newpage',
5897 'legend' => 'recentchanges-legend-newpage',
5899 'minor' => array(
5900 'letter' => 'minoreditletter',
5901 'title' => 'recentchanges-label-minor',
5902 'legend' => 'recentchanges-legend-minor',
5903 'class' => 'minoredit',
5905 'bot' => array(
5906 'letter' => 'boteditletter',
5907 'title' => 'recentchanges-label-bot',
5908 'legend' => 'recentchanges-legend-bot',
5909 'class' => 'botedit',
5911 'unpatrolled' => array(
5912 'letter' => 'unpatrolledletter',
5913 'title' => 'recentchanges-label-unpatrolled',
5914 'legend' => 'recentchanges-legend-unpatrolled',
5918 /** @} */ # end RC/watchlist }
5920 /************************************************************************//**
5921 * @name Copyright and credits settings
5922 * @{
5926 * Override for copyright metadata.
5928 * This is the name of the page containing information about the wiki's copyright status,
5929 * which will be added as a link in the footer if it is specified. It overrides
5930 * $wgRightsUrl if both are specified.
5932 $wgRightsPage = null;
5935 * Set this to specify an external URL containing details about the content license used on your
5936 * wiki.
5937 * If $wgRightsPage is set then this setting is ignored.
5939 $wgRightsUrl = null;
5942 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5943 * link.
5944 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5945 * of the page will also be used as the link if this variable is not set.
5947 $wgRightsText = null;
5950 * Override for copyright metadata.
5952 $wgRightsIcon = null;
5955 * Set this to some HTML to override the rights icon with an arbitrary logo
5956 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5958 $wgCopyrightIcon = null;
5961 * Set this to true if you want detailed copyright information forms on Upload.
5963 $wgUseCopyrightUpload = false;
5966 * Set this to the number of authors that you want to be credited below an
5967 * article text. Set it to zero to hide the attribution block, and a negative
5968 * number (like -1) to show all authors. Note that this will require 2-3 extra
5969 * database hits, which can have a not insignificant impact on performance for
5970 * large wikis.
5972 $wgMaxCredits = 0;
5975 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5976 * Otherwise, link to a separate credits page.
5978 $wgShowCreditsIfMax = true;
5980 /** @} */ # end of copyright and credits settings }
5982 /************************************************************************//**
5983 * @name Import / Export
5984 * @{
5988 * List of interwiki prefixes for wikis we'll accept as sources for
5989 * Special:Import (for sysops). Since complete page history can be imported,
5990 * these should be 'trusted'.
5992 * This can either be a regular array, or an associative map specifying
5993 * subprojects on the interwiki map of the target wiki, or a mix of the two,
5994 * e.g.
5995 * @code
5996 * $wgImportSources = array(
5997 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
5998 * 'wikispecies',
5999 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6000 * );
6001 * @endcode
6003 * If a user has the 'import' permission but not the 'importupload' permission,
6004 * they will only be able to run imports through this transwiki interface.
6006 $wgImportSources = array();
6009 * Optional default target namespace for interwiki imports.
6010 * Can use this to create an incoming "transwiki"-style queue.
6011 * Set to numeric key, not the name.
6013 * Users may override this in the Special:Import dialog.
6015 $wgImportTargetNamespace = null;
6018 * If set to false, disables the full-history option on Special:Export.
6019 * This is currently poorly optimized for long edit histories, so is
6020 * disabled on Wikimedia's sites.
6022 $wgExportAllowHistory = true;
6025 * If set nonzero, Special:Export requests for history of pages with
6026 * more revisions than this will be rejected. On some big sites things
6027 * could get bogged down by very very long pages.
6029 $wgExportMaxHistory = 0;
6032 * Return distinct author list (when not returning full history)
6034 $wgExportAllowListContributors = false;
6037 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6038 * up to this specified level, which will cause it to include all
6039 * pages linked to from the pages you specify. Since this number
6040 * can become *insanely large* and could easily break your wiki,
6041 * it's disabled by default for now.
6043 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6044 * crazy-big export from being done by someone setting the depth number too
6045 * high. In other words, last resort safety net.
6047 $wgExportMaxLinkDepth = 0;
6050 * Whether to allow the "export all pages in namespace" option
6052 $wgExportFromNamespaces = false;
6055 * Whether to allow exporting the entire wiki into a single file
6057 $wgExportAllowAll = false;
6059 /** @} */ # end of import/export }
6061 /*************************************************************************//**
6062 * @name Extensions
6063 * @{
6067 * A list of callback functions which are called once MediaWiki is fully
6068 * initialised
6070 $wgExtensionFunctions = array();
6073 * Extension messages files.
6075 * Associative array mapping extension name to the filename where messages can be
6076 * found. The file should contain variable assignments. Any of the variables
6077 * present in languages/messages/MessagesEn.php may be defined, but $messages
6078 * is the most common.
6080 * Variables defined in extensions will override conflicting variables defined
6081 * in the core.
6083 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6084 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6085 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6086 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6088 * Extensions using the JSON message format can preserve backward compatibility with
6089 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6090 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6091 * as for the $wgMessagesDirs entry.
6093 * @par Example:
6094 * @code
6095 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6096 * @endcode
6098 $wgExtensionMessagesFiles = array();
6101 * Extension messages directories.
6103 * Associative array mapping extension name to the path of the directory where message files can
6104 * be found. The message files are expected to be JSON files named for their language code, e.g.
6105 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6106 * message directories.
6108 * @par Simple example:
6109 * @code
6110 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6111 * @endcode
6113 * @par Complex example:
6114 * @code
6115 * $wgMessagesDirs['Example'] = array(
6116 * __DIR__ . '/lib/ve/i18n',
6117 * __DIR__ . '/lib/oojs-ui/i18n',
6118 * __DIR__ . '/i18n',
6120 * @endcode
6121 * @since 1.23
6123 $wgMessagesDirs = array(
6124 'core' => "$IP/languages/i18n",
6125 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
6129 * Array of files with list(s) of extension entry points to be used in
6130 * maintenance/mergeMessageFileList.php
6131 * @since 1.22
6133 $wgExtensionEntryPointListFiles = array();
6136 * Parser output hooks.
6137 * This is an associative array where the key is an extension-defined tag
6138 * (typically the extension name), and the value is a PHP callback.
6139 * These will be called as an OutputPageParserOutput hook, if the relevant
6140 * tag has been registered with the parser output object.
6142 * Registration is done with $pout->addOutputHook( $tag, $data ).
6144 * The callback has the form:
6145 * @code
6146 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6147 * @endcode
6149 $wgParserOutputHooks = array();
6152 * Whether to include the NewPP limit report as a HTML comment
6154 $wgEnableParserLimitReporting = true;
6157 * List of valid skin names
6159 * The key should be the name in all lower case, the value should be a properly
6160 * cased name for the skin. This value will be prefixed with "Skin" to create
6161 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6162 * if you wish to have access to the full list.
6164 $wgValidSkinNames = array();
6167 * Special page list.
6168 * See the top of SpecialPage.php for documentation.
6170 $wgSpecialPages = array();
6173 * Array mapping class names to filenames, for autoloading.
6175 $wgAutoloadClasses = array();
6178 * Switch controlling legacy case-insensitive classloading.
6179 * Do not disable if your wiki must support data created by PHP4, or by
6180 * MediaWiki 1.4 or earlier.
6182 $wgAutoloadAttemptLowercase = true;
6185 * An array of information about installed extensions keyed by their type.
6187 * All but 'name', 'path' and 'author' can be omitted.
6189 * @code
6190 * $wgExtensionCredits[$type][] = array(
6191 * 'path' => __FILE__,
6192 * 'name' => 'Example extension',
6193 * 'namemsg' => 'exampleextension-name',
6194 * 'author' => array(
6195 * 'Foo Barstein',
6196 * ),
6197 * 'version' => '1.9.0',
6198 * 'url' => 'http://example.org/example-extension/',
6199 * 'descriptionmsg' => 'exampleextension-desc',
6200 * 'license-name' => 'GPL-2.0',
6201 * );
6202 * @endcode
6204 * The extensions are listed on Special:Version. This page also looks for a file
6205 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6206 * view said file. When the 'license-name' key is specified, this file is
6207 * interpreted as wikitext.
6209 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6210 * 'skin', 'api', or 'other', or any additional types as specified through the
6211 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6213 * - name: Name of extension as an inline string instead of localizable message.
6214 * Do not omit this even if 'namemsg' is provided, as it is used to override
6215 * the path Special:Version uses to find extension's license info, and is
6216 * required for backwards-compatibility with MediaWiki 1.23 and older.
6218 * - namemsg (since MW 1.24): A message key for a message containing the
6219 * extension's name, if the name is localizable. (For example, skin names
6220 * usually are.)
6222 * - author: A string or an array of strings. Authors can be linked using
6223 * the regular wikitext link syntax. To have an internationalized version of
6224 * "and others" show, add an element "...". This element can also be linked,
6225 * for instance "[http://example ...]".
6227 * - descriptionmsg: A message key or an an array with message key and parameters:
6228 * `'descriptionmsg' => 'exampleextension-desc',`
6230 * - description: Description of extension as an inline string instead of
6231 * localizable message (omit in favour of 'descriptionmsg').
6233 * - license-name: Short name of the license (used as label for the link), such
6234 * as "GPL-2.0" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6236 $wgExtensionCredits = array();
6239 * Authentication plugin.
6240 * @var $wgAuth AuthPlugin
6242 $wgAuth = null;
6245 * Global list of hooks.
6247 * The key is one of the events made available by MediaWiki, you can find
6248 * a description for most of them in docs/hooks.txt. The array is used
6249 * internally by Hook:run().
6251 * The value can be one of:
6253 * - A function name:
6254 * @code
6255 * $wgHooks['event_name'][] = $function;
6256 * @endcode
6257 * - A function with some data:
6258 * @code
6259 * $wgHooks['event_name'][] = array( $function, $data );
6260 * @endcode
6261 * - A an object method:
6262 * @code
6263 * $wgHooks['event_name'][] = array( $object, 'method' );
6264 * @endcode
6265 * - A closure:
6266 * @code
6267 * $wgHooks['event_name'][] = function ( $hookParam ) {
6268 * // Handler code goes here.
6269 * };
6270 * @endcode
6272 * @warning You should always append to an event array or you will end up
6273 * deleting a previous registered hook.
6275 * @warning Hook handlers should be registered at file scope. Registering
6276 * handlers after file scope can lead to unexpected results due to caching.
6278 $wgHooks = array();
6281 * Maps jobs to their handling classes; extensions
6282 * can add to this to provide custom jobs
6284 $wgJobClasses = array(
6285 'refreshLinks' => 'RefreshLinksJob',
6286 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6287 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6288 'sendMail' => 'EmaillingJob',
6289 'enotifNotify' => 'EnotifNotifyJob',
6290 'fixDoubleRedirect' => 'DoubleRedirectJob',
6291 'uploadFromUrl' => 'UploadFromUrlJob',
6292 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6293 'PublishStashedFile' => 'PublishStashedFileJob',
6294 'null' => 'NullJob'
6298 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6299 * special flags are set. The values here are keys of $wgJobClasses.
6301 * These can be:
6302 * - Very long-running jobs.
6303 * - Jobs that you would never want to run as part of a page rendering request.
6304 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6305 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6306 * These settings should be global to all wikis.
6308 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6311 * Map of job types to how many job "work items" should be run per second
6312 * on each job runner process. The meaning of "work items" varies per job,
6313 * but typically would be something like "pages to update". A single job
6314 * may have a variable number of work items, as is the case with batch jobs.
6315 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6316 * These settings should be global to all wikis.
6317 * @var float[]
6319 $wgJobBackoffThrottling = array();
6322 * Map of job types to configuration arrays.
6323 * This determines which queue class and storage system is used for each job type.
6324 * Job types that do not have explicit configuration will use the 'default' config.
6325 * These settings should be global to all wikis.
6327 $wgJobTypeConf = array(
6328 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6332 * Which aggregator to use for tracking which queues have jobs.
6333 * These settings should be global to all wikis.
6335 $wgJobQueueAggregator = array(
6336 'class' => 'JobQueueAggregatorMemc'
6340 * Additional functions to be performed with updateSpecialPages.
6341 * Expensive Querypages are already updated.
6343 $wgSpecialPageCacheUpdates = array(
6344 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6345 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6349 * Hooks that are used for outputting exceptions. Format is:
6350 * $wgExceptionHooks[] = $funcname
6351 * or:
6352 * $wgExceptionHooks[] = array( $class, $funcname )
6353 * Hooks should return strings or false
6355 $wgExceptionHooks = array();
6358 * Page property link table invalidation lists. When a page property
6359 * changes, this may require other link tables to be updated (eg
6360 * adding __HIDDENCAT__ means the hiddencat tracking category will
6361 * have been added, so the categorylinks table needs to be rebuilt).
6362 * This array can be added to by extensions.
6364 $wgPagePropLinkInvalidations = array(
6365 'hiddencat' => 'categorylinks',
6368 /** @} */ # End extensions }
6370 /*************************************************************************//**
6371 * @name Categories
6372 * @{
6376 * Use experimental, DMOZ-like category browser
6378 $wgUseCategoryBrowser = false;
6381 * On category pages, show thumbnail gallery for images belonging to that
6382 * category instead of listing them as articles.
6384 $wgCategoryMagicGallery = true;
6387 * Paging limit for categories
6389 $wgCategoryPagingLimit = 200;
6392 * Specify how category names should be sorted, when listed on a category page.
6393 * A sorting scheme is also known as a collation.
6395 * Available values are:
6397 * - uppercase: Converts the category name to upper case, and sorts by that.
6399 * - identity: Does no conversion. Sorts by binary value of the string.
6401 * - uca-default: Provides access to the Unicode Collation Algorithm with
6402 * the default element table. This is a compromise collation which sorts
6403 * all languages in a mediocre way. However, it is better than "uppercase".
6405 * To use the uca-default collation, you must have PHP's intl extension
6406 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6407 * resulting collation will depend on the version of ICU installed on the
6408 * server.
6410 * After you change this, you must run maintenance/updateCollation.php to fix
6411 * the sort keys in the database.
6413 * Extensions can define there own collations by subclassing Collation
6414 * and using the Collation::factory hook.
6416 $wgCategoryCollation = 'uppercase';
6418 /** @} */ # End categories }
6420 /*************************************************************************//**
6421 * @name Logging
6422 * @{
6426 * The logging system has two levels: an event type, which describes the
6427 * general category and can be viewed as a named subset of all logs; and
6428 * an action, which is a specific kind of event that can exist in that
6429 * log type.
6431 $wgLogTypes = array(
6433 'block',
6434 'protect',
6435 'rights',
6436 'delete',
6437 'upload',
6438 'move',
6439 'import',
6440 'patrol',
6441 'merge',
6442 'suppress',
6446 * This restricts log access to those who have a certain right
6447 * Users without this will not see it in the option menu and can not view it
6448 * Restricted logs are not added to recent changes
6449 * Logs should remain non-transcludable
6450 * Format: logtype => permissiontype
6452 $wgLogRestrictions = array(
6453 'suppress' => 'suppressionlog'
6457 * Show/hide links on Special:Log will be shown for these log types.
6459 * This is associative array of log type => boolean "hide by default"
6461 * See $wgLogTypes for a list of available log types.
6463 * @par Example:
6464 * @code
6465 * $wgFilterLogTypes = array(
6466 * 'move' => true,
6467 * 'import' => false,
6468 * );
6469 * @endcode
6471 * Will display show/hide links for the move and import logs. Move logs will be
6472 * hidden by default unless the link is clicked. Import logs will be shown by
6473 * default, and hidden when the link is clicked.
6475 * A message of the form log-show-hide-[type] should be added, and will be used
6476 * for the link text.
6478 $wgFilterLogTypes = array(
6479 'patrol' => true
6483 * Lists the message key string for each log type. The localized messages
6484 * will be listed in the user interface.
6486 * Extensions with custom log types may add to this array.
6488 * @since 1.19, if you follow the naming convention log-name-TYPE,
6489 * where TYPE is your log type, yoy don't need to use this array.
6491 $wgLogNames = array(
6492 '' => 'all-logs-page',
6493 'block' => 'blocklogpage',
6494 'protect' => 'protectlogpage',
6495 'rights' => 'rightslog',
6496 'delete' => 'dellogpage',
6497 'upload' => 'uploadlogpage',
6498 'move' => 'movelogpage',
6499 'import' => 'importlogpage',
6500 'patrol' => 'patrol-log-page',
6501 'merge' => 'mergelog',
6502 'suppress' => 'suppressionlog',
6506 * Lists the message key string for descriptive text to be shown at the
6507 * top of each log type.
6509 * Extensions with custom log types may add to this array.
6511 * @since 1.19, if you follow the naming convention log-description-TYPE,
6512 * where TYPE is your log type, yoy don't need to use this array.
6514 $wgLogHeaders = array(
6515 '' => 'alllogstext',
6516 'block' => 'blocklogtext',
6517 'protect' => 'protectlogtext',
6518 'rights' => 'rightslogtext',
6519 'delete' => 'dellogpagetext',
6520 'upload' => 'uploadlogpagetext',
6521 'move' => 'movelogpagetext',
6522 'import' => 'importlogpagetext',
6523 'patrol' => 'patrol-log-header',
6524 'merge' => 'mergelogpagetext',
6525 'suppress' => 'suppressionlogtext',
6529 * Lists the message key string for formatting individual events of each
6530 * type and action when listed in the logs.
6532 * Extensions with custom log types may add to this array.
6534 $wgLogActions = array(
6535 'block/block' => 'blocklogentry',
6536 'block/unblock' => 'unblocklogentry',
6537 'block/reblock' => 'reblock-logentry',
6538 'protect/protect' => 'protectedarticle',
6539 'protect/modify' => 'modifiedarticleprotection',
6540 'protect/unprotect' => 'unprotectedarticle',
6541 'protect/move_prot' => 'movedarticleprotection',
6542 'import/upload' => 'import-logentry-upload',
6543 'import/interwiki' => 'import-logentry-interwiki',
6544 'merge/merge' => 'pagemerge-logentry',
6545 'suppress/block' => 'blocklogentry',
6546 'suppress/reblock' => 'reblock-logentry',
6550 * The same as above, but here values are names of functions,
6551 * not messages.
6552 * @see LogPage::actionText
6553 * @see LogFormatter
6555 $wgLogActionsHandlers = array(
6556 'move/move' => 'MoveLogFormatter',
6557 'move/move_redir' => 'MoveLogFormatter',
6558 'delete/delete' => 'DeleteLogFormatter',
6559 'delete/restore' => 'DeleteLogFormatter',
6560 'delete/revision' => 'DeleteLogFormatter',
6561 'delete/event' => 'DeleteLogFormatter',
6562 'suppress/revision' => 'DeleteLogFormatter',
6563 'suppress/event' => 'DeleteLogFormatter',
6564 'suppress/delete' => 'DeleteLogFormatter',
6565 'patrol/patrol' => 'PatrolLogFormatter',
6566 'rights/rights' => 'RightsLogFormatter',
6567 'rights/autopromote' => 'RightsLogFormatter',
6568 'upload/upload' => 'LogFormatter',
6569 'upload/overwrite' => 'LogFormatter',
6570 'upload/revert' => 'LogFormatter',
6574 * Maintain a log of newusers at Log/newusers?
6576 $wgNewUserLog = true;
6578 /** @} */ # end logging }
6580 /*************************************************************************//**
6581 * @name Special pages (general and miscellaneous)
6582 * @{
6586 * Allow special page inclusions such as {{Special:Allpages}}
6588 $wgAllowSpecialInclusion = true;
6591 * Set this to an array of special page names to prevent
6592 * maintenance/updateSpecialPages.php from updating those pages.
6594 $wgDisableQueryPageUpdate = false;
6597 * List of special pages, followed by what subtitle they should go under
6598 * at Special:SpecialPages
6600 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6602 $wgSpecialPageGroups = array();
6605 * On Special:Unusedimages, consider images "used", if they are put
6606 * into a category. Default (false) is not to count those as used.
6608 $wgCountCategorizedImagesAsUsed = false;
6611 * Maximum number of links to a redirect page listed on
6612 * Special:Whatlinkshere/RedirectDestination
6614 $wgMaxRedirectLinksRetrieved = 500;
6616 /** @} */ # end special pages }
6618 /*************************************************************************//**
6619 * @name Actions
6620 * @{
6624 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6625 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6626 * 'foo' => true Load the class FooAction which subclasses Action
6627 * If something is specified in the getActionOverrides()
6628 * of the relevant Page object it will be used
6629 * instead of the default class.
6630 * 'foo' => false The action is disabled; show an error message
6631 * Unsetting core actions will probably cause things to complain loudly.
6633 $wgActions = array(
6634 'credits' => true,
6635 'delete' => true,
6636 'edit' => true,
6637 'history' => true,
6638 'info' => true,
6639 'markpatrolled' => true,
6640 'protect' => true,
6641 'purge' => true,
6642 'raw' => true,
6643 'render' => true,
6644 'revert' => true,
6645 'revisiondelete' => true,
6646 'rollback' => true,
6647 'submit' => true,
6648 'unprotect' => true,
6649 'unwatch' => true,
6650 'view' => true,
6651 'watch' => true,
6654 /** @} */ # end actions }
6656 /*************************************************************************//**
6657 * @name Robot (search engine crawler) policy
6658 * See also $wgNoFollowLinks.
6659 * @{
6663 * Default robot policy. The default policy is to encourage indexing and fol-
6664 * lowing of links. It may be overridden on a per-namespace and/or per-page
6665 * basis.
6667 $wgDefaultRobotPolicy = 'index,follow';
6670 * Robot policies per namespaces. The default policy is given above, the array
6671 * is made of namespace constants as defined in includes/Defines.php. You can-
6672 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6673 * nofollow. This is because a number of special pages (e.g., ListPages) have
6674 * many permutations of options that display the same data under redundant
6675 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6676 * pages, all alike, and never reaching your actual content.
6678 * @par Example:
6679 * @code
6680 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6681 * @endcode
6683 $wgNamespaceRobotPolicies = array();
6686 * Robot policies per article. These override the per-namespace robot policies.
6687 * Must be in the form of an array where the key part is a properly canonicalised
6688 * text form title and the value is a robot policy.
6690 * @par Example:
6691 * @code
6692 * $wgArticleRobotPolicies = array(
6693 * 'Main Page' => 'noindex,follow',
6694 * 'User:Bob' => 'index,follow',
6695 * );
6696 * @endcode
6698 * @par Example that DOES NOT WORK because the names are not canonical text
6699 * forms:
6700 * @code
6701 * $wgArticleRobotPolicies = array(
6702 * # Underscore, not space!
6703 * 'Main_Page' => 'noindex,follow',
6704 * # "Project", not the actual project name!
6705 * 'Project:X' => 'index,follow',
6706 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6707 * 'abc' => 'noindex,nofollow'
6708 * );
6709 * @endcode
6711 $wgArticleRobotPolicies = array();
6714 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6715 * will not function, so users can't decide whether pages in that namespace are
6716 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6718 * @par Example:
6719 * @code
6720 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6721 * @endcode
6723 $wgExemptFromUserRobotsControl = null;
6725 /** @} */ # End robot policy }
6727 /************************************************************************//**
6728 * @name AJAX and API
6729 * Note: The AJAX entry point which this section refers to is gradually being
6730 * replaced by the API entry point, api.php. They are essentially equivalent.
6731 * Both of them are used for dynamic client-side features, via XHR.
6732 * @{
6736 * Enable the MediaWiki API for convenient access to
6737 * machine-readable data via api.php
6739 * See https://www.mediawiki.org/wiki/API
6741 $wgEnableAPI = true;
6744 * Allow the API to be used to perform write operations
6745 * (page edits, rollback, etc.) when an authorised user
6746 * accesses it
6748 $wgEnableWriteAPI = true;
6752 * WARNING: SECURITY THREAT - debug use only
6754 * Disables many security checks in the API for debugging purposes.
6755 * This flag should never be used on the production servers, as it introduces
6756 * a number of potential security holes. Even when enabled, the validation
6757 * will still be performed, but instead of failing, API will return a warning.
6758 * Also, there will always be a warning notifying that this flag is set.
6759 * At this point, the flag allows GET requests to go through for modules
6760 * requiring POST.
6762 * @since 1.21
6764 $wgDebugAPI = false;
6767 * API module extensions.
6769 * Associative array mapping module name to modules specs;
6770 * Each module spec is an associative array containing at least
6771 * the 'class' key for the module's class, and optionally a
6772 * 'factory' key for the factory function to use for the module.
6774 * That factory function will be called with two parameters,
6775 * the parent module (an instance of ApiBase, usually ApiMain)
6776 * and the name the module was registered under. The return
6777 * value must be an instance of the class given in the 'class'
6778 * field.
6780 * For backward compatibility, the module spec may also be a
6781 * simple string containing the module's class name. In that
6782 * case, the class' constructor will be called with the parent
6783 * module and module name as parameters, as described above.
6785 * Examples for registering API modules:
6787 * @code
6788 * $wgAPIModules['foo'] = 'ApiFoo';
6789 * $wgAPIModules['bar'] = array(
6790 * 'class' => 'ApiBar',
6791 * 'factory' => function( $main, $name ) { ... }
6792 * );
6793 * $wgAPIModules['xyzzy'] = array(
6794 * 'class' => 'ApiXyzzy',
6795 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
6796 * );
6797 * @endcode
6799 * Extension modules may override the core modules.
6800 * See ApiMain::$Modules for a list of the core modules.
6802 $wgAPIModules = array();
6805 * API format module extensions.
6806 * Associative array mapping format module name to module specs (see $wgAPIModules).
6807 * Extension modules may override the core modules.
6809 * See ApiMain::$Formats for a list of the core format modules.
6811 $wgAPIFormatModules = array();
6814 * API Query meta module extensions.
6815 * Associative array mapping meta module name to module specs (see $wgAPIModules).
6816 * Extension modules may override the core modules.
6818 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6820 $wgAPIMetaModules = array();
6823 * API Query prop module extensions.
6824 * Associative array mapping prop module name to module specs (see $wgAPIModules).
6825 * Extension modules may override the core modules.
6827 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6829 $wgAPIPropModules = array();
6832 * API Query list module extensions.
6833 * Associative array mapping list module name to module specs (see $wgAPIModules).
6834 * Extension modules may override the core modules.
6836 * See ApiQuery::$QueryListModules for a list of the core list modules.
6838 $wgAPIListModules = array();
6841 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6842 * @deprecated since 1.21
6844 $wgAPIGeneratorModules = array();
6847 * Maximum amount of rows to scan in a DB query in the API
6848 * The default value is generally fine
6850 $wgAPIMaxDBRows = 5000;
6853 * The maximum size (in bytes) of an API result.
6854 * @warning Do not set this lower than $wgMaxArticleSize*1024
6856 $wgAPIMaxResultSize = 8388608;
6859 * The maximum number of uncached diffs that can be retrieved in one API
6860 * request. Set this to 0 to disable API diffs altogether
6862 $wgAPIMaxUncachedDiffs = 1;
6865 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6866 * API request logging
6868 $wgAPIRequestLog = false;
6871 * Set the timeout for the API help text cache. If set to 0, caching disabled
6873 $wgAPICacheHelpTimeout = 60 * 60;
6876 * The ApiQueryQueryPages module should skip pages that are redundant to true
6877 * API queries.
6879 $wgAPIUselessQueryPages = array(
6880 'MIMEsearch', // aiprop=mime
6881 'LinkSearch', // list=exturlusage
6882 'FileDuplicateSearch', // prop=duplicatefiles
6886 * Enable AJAX framework
6888 $wgUseAjax = true;
6891 * List of Ajax-callable functions.
6892 * Extensions acting as Ajax callbacks must register here
6894 $wgAjaxExportList = array();
6897 * Enable watching/unwatching pages using AJAX.
6898 * Requires $wgUseAjax to be true too.
6900 $wgAjaxWatch = true;
6903 * Enable AJAX check for file overwrite, pre-upload
6905 $wgAjaxUploadDestCheck = true;
6908 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6910 $wgAjaxLicensePreview = true;
6913 * Settings for incoming cross-site AJAX requests:
6914 * Newer browsers support cross-site AJAX when the target resource allows requests
6915 * from the origin domain by the Access-Control-Allow-Origin header.
6916 * This is currently only used by the API (requests to api.php)
6917 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6919 * - '*' matches any number of characters
6920 * - '?' matches any 1 character
6922 * @par Example:
6923 * @code
6924 * $wgCrossSiteAJAXdomains = array(
6925 * 'www.mediawiki.org',
6926 * '*.wikipedia.org',
6927 * '*.wikimedia.org',
6928 * '*.wiktionary.org',
6929 * );
6930 * @endcode
6932 $wgCrossSiteAJAXdomains = array();
6935 * Domains that should not be allowed to make AJAX requests,
6936 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6937 * Uses the same syntax as $wgCrossSiteAJAXdomains
6939 $wgCrossSiteAJAXdomainExceptions = array();
6941 /** @} */ # End AJAX and API }
6943 /************************************************************************//**
6944 * @name Shell and process control
6945 * @{
6949 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6951 $wgMaxShellMemory = 307200;
6954 * Maximum file size created by shell processes under linux, in KB
6955 * ImageMagick convert for example can be fairly hungry for scratch space
6957 $wgMaxShellFileSize = 102400;
6960 * Maximum CPU time in seconds for shell processes under Linux
6962 $wgMaxShellTime = 180;
6965 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6966 * would measure) in seconds for shell processes under Linux
6968 $wgMaxShellWallClockTime = 180;
6971 * Under Linux: a cgroup directory used to constrain memory usage of shell
6972 * commands. The directory must be writable by the user which runs MediaWiki.
6974 * If specified, this is used instead of ulimit, which is inaccurate, and
6975 * causes malloc() to return NULL, which exposes bugs in C applications, making
6976 * them segfault or deadlock.
6978 * A wrapper script will create a cgroup for each shell command that runs, as
6979 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6980 * kernel will send a SIGKILL signal to a process in the subgroup.
6982 * @par Example:
6983 * @code
6984 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6985 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6986 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6987 * @endcode
6989 * The reliability of cgroup cleanup can be improved by installing a
6990 * notify_on_release script in the root cgroup, see e.g.
6991 * https://gerrit.wikimedia.org/r/#/c/40784
6993 $wgShellCgroup = false;
6996 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6998 $wgPhpCli = '/usr/bin/php';
7001 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7002 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7003 * character set. Only the character set is relevant.
7005 $wgShellLocale = 'en_US.utf8';
7007 /** @} */ # End shell }
7009 /************************************************************************//**
7010 * @name HTTP client
7011 * @{
7015 * Timeout for HTTP requests done internally, in seconds.
7017 $wgHTTPTimeout = 25;
7020 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7022 $wgAsyncHTTPTimeout = 25;
7025 * Proxy to use for CURL requests.
7027 $wgHTTPProxy = false;
7030 * Timeout for connections done internally (in seconds)
7031 * Only works for curl
7033 $wgHTTPConnectTimeout = 5e0;
7035 /** @} */ # End HTTP client }
7037 /************************************************************************//**
7038 * @name Job queue
7039 * See also $wgEnotifUseJobQ.
7040 * @{
7044 * Number of jobs to perform per request. May be less than one in which case
7045 * jobs are performed probabalistically. If this is zero, jobs will not be done
7046 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7047 * be run periodically.
7049 $wgJobRunRate = 1;
7052 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7053 * to handle the job execution, instead of blocking the request until the job
7054 * execution finishes.
7055 * @since 1.23
7057 $wgRunJobsAsync = true;
7060 * Number of rows to update per job
7062 $wgUpdateRowsPerJob = 500;
7065 * Number of rows to update per query
7067 $wgUpdateRowsPerQuery = 100;
7069 /** @} */ # End job queue }
7071 /************************************************************************//**
7072 * @name Miscellaneous
7073 * @{
7077 * Name of the external diff engine to use
7079 $wgExternalDiffEngine = false;
7082 * Disable redirects to special pages and interwiki redirects, which use a 302
7083 * and have no "redirected from" link.
7085 * @note This is only for articles with #REDIRECT in them. URL's containing a
7086 * local interwiki prefix (or a non-canonical special page name) are still hard
7087 * redirected regardless of this setting.
7089 $wgDisableHardRedirects = false;
7092 * LinkHolderArray batch size
7093 * For debugging
7095 $wgLinkHolderBatchSize = 1000;
7098 * By default MediaWiki does not register links pointing to same server in
7099 * externallinks dataset, use this value to override:
7101 $wgRegisterInternalExternals = false;
7104 * Maximum number of pages to move at once when moving subpages with a page.
7106 $wgMaximumMovedPages = 100;
7109 * Fix double redirects after a page move.
7110 * Tends to conflict with page move vandalism, use only on a private wiki.
7112 $wgFixDoubleRedirects = false;
7115 * Allow redirection to another page when a user logs in.
7116 * To enable, set to a string like 'Main Page'
7118 $wgRedirectOnLogin = null;
7121 * Configuration for processing pool control, for use in high-traffic wikis.
7122 * An implementation is provided in the PoolCounter extension.
7124 * This configuration array maps pool types to an associative array. The only
7125 * defined key in the associative array is "class", which gives the class name.
7126 * The remaining elements are passed through to the class as constructor
7127 * parameters.
7129 * @par Example:
7130 * @code
7131 * $wgPoolCounterConf = array( 'ArticleView' => array(
7132 * 'class' => 'PoolCounter_Client',
7133 * 'timeout' => 15, // wait timeout in seconds
7134 * 'workers' => 5, // maximum number of active threads in each pool
7135 * 'maxqueue' => 50, // maximum number of total threads in each pool
7136 * ... any extension-specific options...
7137 * );
7138 * @endcode
7140 $wgPoolCounterConf = null;
7143 * To disable file delete/restore temporarily
7145 $wgUploadMaintenance = false;
7148 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7149 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7150 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7151 * (except for the special case of JS and CS pages).
7153 * @since 1.21
7155 $wgNamespaceContentModels = array();
7158 * How to react if a plain text version of a non-text Content object is requested using
7159 * ContentHandler::getContentText():
7161 * * 'ignore': return null
7162 * * 'fail': throw an MWException
7163 * * 'serialize': serialize to default format
7165 * @since 1.21
7167 $wgContentHandlerTextFallback = 'ignore';
7170 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7171 * This way, the ContentHandler facility can be used without any additional information in the
7172 * database. A page's content model is then derived solely from the page's title. This however
7173 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7174 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7175 * a title that would default to a different content model.
7177 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7178 * handling is less robust and less flexible.
7180 * @since 1.21
7182 $wgContentHandlerUseDB = true;
7185 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7186 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7187 * the effect on the database they would have on a wikitext page.
7189 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7190 * or at least parse only the contents of comments in the scripts.
7192 * @since 1.21
7194 $wgTextModelsToParse = array(
7195 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7196 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7197 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7201 * Whether the user must enter their password to change their e-mail address
7203 * @since 1.20
7205 $wgRequirePasswordforEmailChange = true;
7208 * Register handlers for specific types of sites.
7210 * @since 1.20
7212 $wgSiteTypes = array(
7213 'mediawiki' => 'MediaWikiSite',
7217 * Whether the page_props table has a pp_sortkey column. Set to false in case
7218 * the respective database schema change was not applied.
7219 * @since 1.23
7221 $wgPagePropsHaveSortkey = true;
7224 * Port where you have HTTPS running
7225 * Supports HTTPS on non-standard ports
7226 * @see bug 65184
7227 * @since 1.24
7229 $wgHttpsPort = 443;
7232 * Secret and algorithm for hmac-based key derivation function (fast,
7233 * cryptographically secure random numbers).
7234 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7235 * be used.
7236 * @since 1.24
7238 $wgHKDFSecret = false;
7239 $wgHKDFAlgorithm = 'sha256';
7242 * Enable page language feature
7243 * Allows setting page language in database
7244 * @var bool
7245 * @since 1.24
7247 $wgPageLanguageUseDB = false;
7250 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7251 * Set this only if the fields are fully populated. This may be removed in 1.25.
7252 * @var bool
7253 * @since 1.24
7255 $wgUseLinkNamespaceDBFields = true;
7258 * For really cool vim folding this needs to be at the end:
7259 * vim: foldmarker=@{,@} foldmethod=marker
7260 * @}