Merge "Fixed wrong EnqueueJob comment"
[mediawiki.git] / includes / DefaultSettings.php
blob2ea8b294b65e3d0fc9f0680cf79af9fbf1755041
1 <?php
2 /**
3 * Default values for MediaWiki configuration settings.
6 * NEVER EDIT THIS FILE
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
38 * @file
41 /**
42 * @defgroup Globalsettings Global settings
45 /**
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
52 die( 1 );
55 /** @endcond */
57 /**
58 * wgConf hold the site configuration.
59 * Not used for much in a default install.
60 * @since 1.5
62 $wgConf = new SiteConfiguration;
64 /**
65 * Registry of factory functions to create config objects:
66 * The 'main' key must be set, and the value should be a valid
67 * callable.
68 * @since 1.23
70 $wgConfigRegistry = array(
71 'main' => 'GlobalVarConfig::newInstance'
74 /**
75 * MediaWiki version number
76 * @since 1.2
78 $wgVersion = '1.26alpha';
80 /**
81 * Name of the site. It must be changed in LocalSettings.php
83 $wgSitename = 'MediaWiki';
85 /**
86 * URL of the server.
88 * @par Example:
89 * @code
90 * $wgServer = 'http://example.com';
91 * @endcode
93 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
94 * wrong server, it will redirect incorrectly after you save a page. In that
95 * case, set this variable to fix it.
97 * If you want to use protocol-relative URLs on your wiki, set this to a
98 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
99 * to a fully qualified URL.
101 $wgServer = WebRequest::detectServer();
104 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
105 * Must be fully qualified, even if $wgServer is protocol-relative.
107 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
108 * @since 1.18
110 $wgCanonicalServer = false;
113 * Server name. This is automatically computed by parsing the bare
114 * hostname out of $wgCanonicalServer. It should not be customized.
115 * @since 1.24
117 $wgServerName = false;
119 /************************************************************************//**
120 * @name Script path settings
121 * @{
125 * The path we should point to.
126 * It might be a virtual path in case with use apache mod_rewrite for example.
128 * This *needs* to be set correctly.
130 * Other paths will be set to defaults based on it unless they are directly
131 * set in LocalSettings.php
133 $wgScriptPath = '/wiki';
136 * Whether to support URLs like index.php/Page_title These often break when PHP
137 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
138 * but then again it may not; lighttpd converts incoming path data to lowercase
139 * on systems with case-insensitive filesystems, and there have been reports of
140 * problems on Apache as well.
142 * To be safe we'll continue to keep it off by default.
144 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
145 * incorrect garbage, or to true if it is really correct.
147 * The default $wgArticlePath will be set based on this value at runtime, but if
148 * you have customized it, having this incorrectly set to true can cause
149 * redirect loops when "pretty URLs" are used.
150 * @since 1.2.1
152 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
153 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
154 ( strpos( PHP_SAPI, 'isapi' ) === false );
157 * The extension to append to script names by default.
159 * Some hosting providers used PHP 4 for *.php files, and PHP 5 for *.php5.
160 * This variable was provided to support those providers.
162 * @since 1.11
163 * @deprecated since 1.25; support for '.php5' is being phased out of MediaWiki
164 * proper. Backward-compatibility can be maintained by configuring your web
165 * server to rewrite URLs. See RELEASE-NOTES for details.
167 $wgScriptExtension = '.php';
169 /**@}*/
171 /************************************************************************//**
172 * @name URLs and file paths
174 * These various web and file path variables are set to their defaults
175 * in Setup.php if they are not explicitly set from LocalSettings.php.
177 * These will relatively rarely need to be set manually, unless you are
178 * splitting style sheets or images outside the main document root.
180 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
181 * the host part, that starts with a slash. In most cases a full URL is also
182 * acceptable. A "directory" is a local file path.
184 * In both paths and directories, trailing slashes should not be included.
186 * @{
190 * The URL path to index.php.
192 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
194 $wgScript = false;
197 * The URL path to load.php.
199 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
200 * @since 1.17
202 $wgLoadScript = false;
205 * The URL path of the skins directory.
206 * Defaults to "{$wgScriptPath}/skins".
207 * @since 1.3
209 $wgStylePath = false;
210 $wgStyleSheetPath = &$wgStylePath;
213 * The URL path of the skins directory. Should not point to an external domain.
214 * Defaults to "{$wgScriptPath}/skins".
215 * @since 1.17
217 $wgLocalStylePath = false;
220 * The URL path of the extensions directory.
221 * Defaults to "{$wgScriptPath}/extensions".
222 * @since 1.16
224 $wgExtensionAssetsPath = false;
227 * Filesystem extensions directory.
228 * Defaults to "{$IP}/extensions".
229 * @since 1.25
231 $wgExtensionDirectory = "{$IP}/extensions";
234 * Filesystem stylesheets directory.
235 * Defaults to "{$IP}/skins".
236 * @since 1.3
238 $wgStyleDirectory = "{$IP}/skins";
241 * The URL path for primary article page views. This path should contain $1,
242 * which is replaced by the article title.
244 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
245 * depending on $wgUsePathInfo.
247 $wgArticlePath = false;
250 * The URL path for the images directory.
251 * Defaults to "{$wgScriptPath}/images".
253 $wgUploadPath = false;
256 * The filesystem path of the images directory. Defaults to "{$IP}/images".
258 $wgUploadDirectory = false;
261 * Directory where the cached page will be saved.
262 * Defaults to "{$wgUploadDirectory}/cache".
264 $wgFileCacheDirectory = false;
267 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
268 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
270 $wgLogo = false;
273 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
274 * should be under 135x155 pixels.
275 * Only 1.5x and 2x versions are supported.
277 * @par Example:
278 * @code
279 * $wgLogoHD = array(
280 * "1.5x" => "path/to/1.5x_version.png",
281 * "2x" => "path/to/2x_version.png"
282 * );
283 * @endcode
285 * @since 1.25
287 $wgLogoHD = false;
290 * The URL path of the shortcut icon.
291 * @since 1.6
293 $wgFavicon = '/favicon.ico';
296 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
297 * Defaults to no icon.
298 * @since 1.12
300 $wgAppleTouchIcon = false;
303 * Value for the referrer policy meta tag.
304 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
305 * prevents the meta tag from being output.
306 * See http://www.w3.org/TR/referrer-policy/ for details.
308 * @since 1.25
310 $wgReferrerPolicy = false;
313 * The local filesystem path to a temporary directory. This is not required to
314 * be web accessible.
316 * When this setting is set to false, its value will be set through a call
317 * to wfTempDir(). See that methods implementation for the actual detection
318 * logic.
320 * Developers should use the global function wfTempDir() instead of this
321 * variable.
323 * @see wfTempDir()
324 * @note Default changed to false in MediaWiki 1.20.
326 $wgTmpDirectory = false;
329 * If set, this URL is added to the start of $wgUploadPath to form a complete
330 * upload URL.
331 * @since 1.4
333 $wgUploadBaseUrl = '';
336 * To enable remote on-demand scaling, set this to the thumbnail base URL.
337 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
338 * where 'e6' are the first two characters of the MD5 hash of the file name.
339 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
340 * @since 1.17
342 $wgUploadStashScalerBaseUrl = false;
345 * To set 'pretty' URL paths for actions other than
346 * plain page views, add to this array.
348 * @par Example:
349 * Set pretty URL for the edit action:
350 * @code
351 * 'edit' => "$wgScriptPath/edit/$1"
352 * @endcode
354 * There must be an appropriate script or rewrite rule in place to handle these
355 * URLs.
356 * @since 1.5
358 $wgActionPaths = array();
360 /**@}*/
362 /************************************************************************//**
363 * @name Files and file uploads
364 * @{
368 * Uploads have to be specially set up to be secure
370 $wgEnableUploads = false;
373 * The maximum age of temporary (incomplete) uploaded files
375 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
378 * Allows to move images and other media files
380 $wgAllowImageMoving = true;
383 * Enable deferred upload tasks that use the job queue.
384 * Only enable this if job runners are set up for both the
385 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
387 * @note If you use suhosin, this setting is incompatible with
388 * suhosin.session.encrypt.
390 $wgEnableAsyncUploads = false;
393 * These are additional characters that should be replaced with '-' in filenames
395 $wgIllegalFileChars = ":";
398 * What directory to place deleted uploads in.
399 * Defaults to "{$wgUploadDirectory}/deleted".
401 $wgDeletedDirectory = false;
404 * Set this to true if you use img_auth and want the user to see details on why access failed.
406 $wgImgAuthDetails = false;
409 * Map of relative URL directories to match to internal mwstore:// base storage paths.
410 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
411 * if starts with any of the prefixes defined here. The prefixes should not overlap.
412 * The prefix that matches has a corresponding storage path, which the rest of the URL
413 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
415 * Example:
416 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
417 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
418 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
420 * @see $wgFileBackends
422 $wgImgAuthUrlPathMap = array();
425 * File repository structures
427 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
428 * an array of such structures. Each repository structure is an associative
429 * array of properties configuring the repository.
431 * Properties required for all repos:
432 * - class The class name for the repository. May come from the core or an extension.
433 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
434 * FSRepo is also supported for backwards compatibility.
436 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
437 * The name should consist of alpha-numeric characters.
438 * - backend A file backend name (see $wgFileBackends).
440 * For most core repos:
441 * - zones Associative array of zone names that each map to an array with:
442 * container : backend container name the zone is in
443 * directory : root path within container for the zone
444 * url : base URL to the root of the zone
445 * urlsByExt : map of file extension types to base URLs
446 * (useful for using a different cache for videos)
447 * Zones default to using "<repo name>-<zone name>" as the container name
448 * and default to using the container root as the zone's root directory.
449 * Nesting of zone locations within other zones should be avoided.
450 * - url Public zone URL. The 'zones' settings take precedence.
451 * - hashLevels The number of directory levels for hash-based division of files
452 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
453 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
454 * handler instead.
455 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
456 * determines whether filenames implicitly start with a capital letter.
457 * The current implementation may give incorrect description page links
458 * when the local $wgCapitalLinks and initialCapital are mismatched.
459 * - pathDisclosureProtection
460 * May be 'paranoid' to remove all parameters from error messages, 'none' to
461 * leave the paths in unchanged, or 'simple' to replace paths with
462 * placeholders. Default for LocalRepo is 'simple'.
463 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
464 * is 0644.
465 * - directory The local filesystem directory where public files are stored. Not used for
466 * some remote repos.
467 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
468 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
469 * - isPrivate Set this if measures should always be taken to keep the files private.
470 * One should not trust this to assure that the files are not web readable;
471 * the server configuration should be done manually depending on the backend.
473 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
474 * for local repositories:
475 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
476 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
477 * http://en.wikipedia.org/w
478 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
479 * $wgScriptExtension, e.g. .php5 defaults to .php
481 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
482 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
483 * $wgFetchCommonsDescriptions.
484 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
485 * Short thumbnail names only have the width, parameters, and the extension.
487 * ForeignDBRepo:
488 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
489 * equivalent to the corresponding member of $wgDBservers
490 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
491 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
493 * ForeignAPIRepo:
494 * - apibase Use for the foreign API's URL
495 * - apiThumbCacheExpiry How long to locally cache thumbs for
497 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
498 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
499 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
500 * If you set $wgForeignFileRepos to an array of repository structures, those will
501 * be searched after the local file repo.
502 * Otherwise, you will only have access to local media files.
504 * @see Setup.php for an example usage and default initialization.
506 $wgLocalFileRepo = false;
509 * @see $wgLocalFileRepo
511 $wgForeignFileRepos = array();
514 * Use Commons as a remote file repository. Essentially a wrapper, when this
515 * is enabled $wgForeignFileRepos will point at Commons with a set of default
516 * settings
518 $wgUseInstantCommons = false;
521 * File backend structure configuration.
523 * This is an array of file backend configuration arrays.
524 * Each backend configuration has the following parameters:
525 * - 'name' : A unique name for the backend
526 * - 'class' : The file backend class to use
527 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
528 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
530 * See FileBackend::__construct() for more details.
531 * Additional parameters are specific to the file backend class used.
532 * These settings should be global to all wikis when possible.
534 * There are two particularly important aspects about each backend:
535 * - a) Whether it is fully qualified or wiki-relative.
536 * By default, the paths of files are relative to the current wiki,
537 * which works via prefixing them with the current wiki ID when accessed.
538 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
539 * all paths with the specified value instead. This can be useful if
540 * multiple wikis need to share the same data. Note that 'name' is *not*
541 * part of any prefix and thus should not be relied upon for namespacing.
542 * - b) Whether it is only defined for some wikis or is defined on all
543 * wikis in the wiki farm. Defining a backend globally is useful
544 * if multiple wikis need to share the same data.
545 * One should be aware of these aspects when configuring a backend for use with
546 * any basic feature or plugin. For example, suppose an extension stores data for
547 * different wikis in different directories and sometimes needs to access data from
548 * a foreign wiki's directory in order to render a page on given wiki. The extension
549 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
551 $wgFileBackends = array();
554 * Array of configuration arrays for each lock manager.
555 * Each backend configuration has the following parameters:
556 * - 'name' : A unique name for the lock manager
557 * - 'class' : The lock manger class to use
559 * See LockManager::__construct() for more details.
560 * Additional parameters are specific to the lock manager class used.
561 * These settings should be global to all wikis.
563 $wgLockManagers = array();
566 * Show Exif data, on by default if available.
567 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
569 * @note FOR WINDOWS USERS:
570 * To enable Exif functions, add the following lines to the "Windows
571 * extensions" section of php.ini:
572 * @code{.ini}
573 * extension=extensions/php_mbstring.dll
574 * extension=extensions/php_exif.dll
575 * @endcode
577 $wgShowEXIF = function_exists( 'exif_read_data' );
580 * If to automatically update the img_metadata field
581 * if the metadata field is outdated but compatible with the current version.
582 * Defaults to false.
584 $wgUpdateCompatibleMetadata = false;
587 * If you operate multiple wikis, you can define a shared upload path here.
588 * Uploads to this wiki will NOT be put there - they will be put into
589 * $wgUploadDirectory.
590 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
591 * no file of the given name is found in the local repository (for [[File:..]],
592 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
593 * directory.
595 * Note that these configuration settings can now be defined on a per-
596 * repository basis for an arbitrary number of file repositories, using the
597 * $wgForeignFileRepos variable.
599 $wgUseSharedUploads = false;
602 * Full path on the web server where shared uploads can be found
604 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
607 * Fetch commons image description pages and display them on the local wiki?
609 $wgFetchCommonsDescriptions = false;
612 * Path on the file system where shared uploads can be found.
614 $wgSharedUploadDirectory = "/var/www/wiki3/images";
617 * DB name with metadata about shared directory.
618 * Set this to false if the uploads do not come from a wiki.
620 $wgSharedUploadDBname = false;
623 * Optional table prefix used in database.
625 $wgSharedUploadDBprefix = '';
628 * Cache shared metadata in memcached.
629 * Don't do this if the commons wiki is in a different memcached domain
631 $wgCacheSharedUploads = true;
634 * Allow for upload to be copied from an URL.
635 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
636 * You have to assign the user right 'upload_by_url' to a user group, to use this.
638 $wgAllowCopyUploads = false;
641 * Allow asynchronous copy uploads.
642 * This feature is experimental and broken as of r81612.
644 $wgAllowAsyncCopyUploads = false;
647 * A list of domains copy uploads can come from
649 * @since 1.20
651 $wgCopyUploadsDomains = array();
654 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
655 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
656 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
658 $wgCopyUploadsFromSpecialUpload = false;
661 * Proxy to use for copy upload requests.
662 * @since 1.20
664 $wgCopyUploadProxy = false;
667 * Different timeout for upload by url
668 * This could be useful since when fetching large files, you may want a
669 * timeout longer than the default $wgHTTPTimeout. False means fallback
670 * to default.
672 * @since 1.22
674 $wgCopyUploadTimeout = false;
677 * Different timeout for upload by url when run as a background job
678 * This could be useful since when fetching large files via job queue,
679 * you may want a different timeout, especially because there is no
680 * http request being kept alive.
682 * false means fallback to $wgCopyUploadTimeout.
683 * @since 1.22
685 $wgCopyUploadAsyncTimeout = false;
688 * Max size for uploads, in bytes. If not set to an array, applies to all
689 * uploads. If set to an array, per upload type maximums can be set, using the
690 * file and url keys. If the * key is set this value will be used as maximum
691 * for non-specified types.
693 * @par Example:
694 * @code
695 * $wgMaxUploadSize = array(
696 * '*' => 250 * 1024,
697 * 'url' => 500 * 1024,
698 * );
699 * @endcode
700 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
701 * will have a maximum of 500 kB.
703 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
706 * Point the upload navigation link to an external URL
707 * Useful if you want to use a shared repository by default
708 * without disabling local uploads (use $wgEnableUploads = false for that).
710 * @par Example:
711 * @code
712 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
713 * @endcode
715 $wgUploadNavigationUrl = false;
718 * Point the upload link for missing files to an external URL, as with
719 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
720 * appended to it as appropriate.
722 $wgUploadMissingFileUrl = false;
725 * Give a path here to use thumb.php for thumbnail generation on client
726 * request, instead of generating them on render and outputting a static URL.
727 * This is necessary if some of your apache servers don't have read/write
728 * access to the thumbnail path.
730 * @par Example:
731 * @code
732 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
733 * @endcode
735 $wgThumbnailScriptPath = false;
738 * @see $wgThumbnailScriptPath
740 $wgSharedThumbnailScriptPath = false;
743 * Set this to false if you do not want MediaWiki to divide your images
744 * directory into many subdirectories, for improved performance.
746 * It's almost always good to leave this enabled. In previous versions of
747 * MediaWiki, some users set this to false to allow images to be added to the
748 * wiki by simply copying them into $wgUploadDirectory and then running
749 * maintenance/rebuildImages.php to register them in the database. This is no
750 * longer recommended, use maintenance/importImages.php instead.
752 * @note That this variable may be ignored if $wgLocalFileRepo is set.
753 * @todo Deprecate the setting and ultimately remove it from Core.
755 $wgHashedUploadDirectory = true;
758 * Set the following to false especially if you have a set of files that need to
759 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
760 * directory layout.
762 $wgHashedSharedUploadDirectory = true;
765 * Base URL for a repository wiki. Leave this blank if uploads are just stored
766 * in a shared directory and not meant to be accessible through a separate wiki.
767 * Otherwise the image description pages on the local wiki will link to the
768 * image description page on this wiki.
770 * Please specify the namespace, as in the example below.
772 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
775 * This is the list of preferred extensions for uploading files. Uploading files
776 * with extensions not in this list will trigger a warning.
778 * @warning If you add any OpenOffice or Microsoft Office file formats here,
779 * such as odt or doc, and untrusted users are allowed to upload files, then
780 * your wiki will be vulnerable to cross-site request forgery (CSRF).
782 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
785 * Files with these extensions will never be allowed as uploads.
786 * An array of file extensions to blacklist. You should append to this array
787 * if you want to blacklist additional files.
789 $wgFileBlacklist = array(
790 # HTML may contain cookie-stealing JavaScript and web bugs
791 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
792 # PHP scripts may execute arbitrary code on the server
793 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
794 # Other types that may be interpreted by some servers
795 'shtml', 'jhtml', 'pl', 'py', 'cgi',
796 # May contain harmful executables for Windows victims
797 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
800 * Files with these MIME types will never be allowed as uploads
801 * if $wgVerifyMimeType is enabled.
803 $wgMimeTypeBlacklist = array(
804 # HTML may contain cookie-stealing JavaScript and web bugs
805 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
806 # PHP scripts may execute arbitrary code on the server
807 'application/x-php', 'text/x-php',
808 # Other types that may be interpreted by some servers
809 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
810 # Client-side hazards on Internet Explorer
811 'text/scriptlet', 'application/x-msdownload',
812 # Windows metafile, client-side vulnerability on some systems
813 'application/x-msmetafile',
817 * Allow Java archive uploads.
818 * This is not recommended for public wikis since a maliciously-constructed
819 * applet running on the same domain as the wiki can steal the user's cookies.
821 $wgAllowJavaUploads = false;
824 * This is a flag to determine whether or not to check file extensions on upload.
826 * @warning Setting this to false is insecure for public wikis.
828 $wgCheckFileExtensions = true;
831 * If this is turned off, users may override the warning for files not covered
832 * by $wgFileExtensions.
834 * @warning Setting this to false is insecure for public wikis.
836 $wgStrictFileExtensions = true;
839 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
841 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
842 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
844 $wgDisableUploadScriptChecks = false;
847 * Warn if uploaded files are larger than this (in bytes), or false to disable
849 $wgUploadSizeWarning = false;
852 * list of trusted media-types and MIME types.
853 * Use the MEDIATYPE_xxx constants to represent media types.
854 * This list is used by File::isSafeFile
856 * Types not listed here will have a warning about unsafe content
857 * displayed on the images description page. It would also be possible
858 * to use this for further restrictions, like disabling direct
859 * [[media:...]] links for non-trusted formats.
861 $wgTrustedMediaFormats = array(
862 MEDIATYPE_BITMAP, //all bitmap formats
863 MEDIATYPE_AUDIO, //all audio formats
864 MEDIATYPE_VIDEO, //all plain video formats
865 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
866 "application/pdf", //PDF files
867 #"application/x-shockwave-flash", //flash/shockwave movie
871 * Plugins for media file type handling.
872 * Each entry in the array maps a MIME type to a class name
874 $wgMediaHandlers = array(
875 'image/jpeg' => 'JpegHandler',
876 'image/png' => 'PNGHandler',
877 'image/gif' => 'GIFHandler',
878 'image/tiff' => 'TiffHandler',
879 'image/x-ms-bmp' => 'BmpHandler',
880 'image/x-bmp' => 'BmpHandler',
881 'image/x-xcf' => 'XCFHandler',
882 'image/svg+xml' => 'SvgHandler', // official
883 'image/svg' => 'SvgHandler', // compat
884 'image/vnd.djvu' => 'DjVuHandler', // official
885 'image/x.djvu' => 'DjVuHandler', // compat
886 'image/x-djvu' => 'DjVuHandler', // compat
890 * Plugins for page content model handling.
891 * Each entry in the array maps a model id to a class name.
893 * @since 1.21
895 $wgContentHandlers = array(
896 // the usual case
897 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
898 // dumb version, no syntax highlighting
899 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
900 // simple implementation, for use by extensions, etc.
901 CONTENT_MODEL_JSON => 'JsonContentHandler',
902 // dumb version, no syntax highlighting
903 CONTENT_MODEL_CSS => 'CssContentHandler',
904 // plain text, for use by extensions, etc.
905 CONTENT_MODEL_TEXT => 'TextContentHandler',
909 * Whether to enable server-side image thumbnailing. If false, images will
910 * always be sent to the client in full resolution, with appropriate width= and
911 * height= attributes on the <img> tag for the client to do its own scaling.
913 $wgUseImageResize = true;
916 * Resizing can be done using PHP's internal image libraries or using
917 * ImageMagick or another third-party converter, e.g. GraphicMagick.
918 * These support more file formats than PHP, which only supports PNG,
919 * GIF, JPG, XBM and WBMP.
921 * Use Image Magick instead of PHP builtin functions.
923 $wgUseImageMagick = false;
926 * The convert command shipped with ImageMagick
928 $wgImageMagickConvertCommand = '/usr/bin/convert';
931 * Sharpening parameter to ImageMagick
933 $wgSharpenParameter = '0x0.4';
936 * Reduction in linear dimensions below which sharpening will be enabled
938 $wgSharpenReductionThreshold = 0.85;
941 * Temporary directory used for ImageMagick. The directory must exist. Leave
942 * this set to false to let ImageMagick decide for itself.
944 $wgImageMagickTempDir = false;
947 * Use another resizing converter, e.g. GraphicMagick
948 * %s will be replaced with the source path, %d with the destination
949 * %w and %h will be replaced with the width and height.
951 * @par Example for GraphicMagick:
952 * @code
953 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
954 * @endcode
956 * Leave as false to skip this.
958 $wgCustomConvertCommand = false;
961 * used for lossless jpeg rotation
963 * @since 1.21
965 $wgJpegTran = '/usr/bin/jpegtran';
968 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
969 * image formats.
971 $wgExiv2Command = '/usr/bin/exiv2';
974 * Scalable Vector Graphics (SVG) may be uploaded as images.
975 * Since SVG support is not yet standard in browsers, it is
976 * necessary to rasterize SVGs to PNG as a fallback format.
978 * An external program is required to perform this conversion.
979 * If set to an array, the first item is a PHP callable and any further items
980 * are passed as parameters after $srcPath, $dstPath, $width, $height
982 $wgSVGConverters = array(
983 'ImageMagick' =>
984 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
985 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
986 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
987 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
988 . '$output $input',
989 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
990 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
991 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
995 * Pick a converter defined in $wgSVGConverters
997 $wgSVGConverter = 'ImageMagick';
1000 * If not in the executable PATH, specify the SVG converter path.
1002 $wgSVGConverterPath = '';
1005 * Don't scale a SVG larger than this
1007 $wgSVGMaxSize = 2048;
1010 * Don't read SVG metadata beyond this point.
1011 * Default is 1024*256 bytes
1013 $wgSVGMetadataCutoff = 262144;
1016 * Disallow <title> element in SVG files.
1018 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1019 * browsers which can not perform basic stuff like MIME detection and which are
1020 * vulnerable to further idiots uploading crap files as images.
1022 * When this directive is on, "<title>" will be allowed in files with an
1023 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1024 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1026 $wgAllowTitlesInSVG = false;
1029 * The maximum number of pixels a source image can have if it is to be scaled
1030 * down by a scaler that requires the full source image to be decompressed
1031 * and stored in decompressed form, before the thumbnail is generated.
1033 * This provides a limit on memory usage for the decompression side of the
1034 * image scaler. The limit is used when scaling PNGs with any of the
1035 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1036 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1038 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1039 * 12.5 million pixels or 3500x3500.
1041 $wgMaxImageArea = 1.25e7;
1044 * Force thumbnailing of animated GIFs above this size to a single
1045 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1046 * is checked against the total size of all frames in the animation.
1047 * It probably makes sense to keep this equal to $wgMaxImageArea.
1049 $wgMaxAnimatedGifArea = 1.25e7;
1052 * Browsers don't support TIFF inline generally...
1053 * For inline display, we need to convert to PNG or JPEG.
1054 * Note scaling should work with ImageMagick, but may not with GD scaling.
1056 * @par Example:
1057 * @code
1058 * // PNG is lossless, but inefficient for photos
1059 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1060 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1061 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1062 * @endcode
1064 $wgTiffThumbnailType = false;
1067 * If rendered thumbnail files are older than this timestamp, they
1068 * will be rerendered on demand as if the file didn't already exist.
1069 * Update if there is some need to force thumbs and SVG rasterizations
1070 * to rerender, such as fixes to rendering bugs.
1072 $wgThumbnailEpoch = '20030516000000';
1075 * Certain operations are avoided if there were too many recent failures,
1076 * for example, thumbnail generation. Bump this value to invalidate all
1077 * memory of failed operations and thus allow further attempts to resume.
1078 * This is useful when a cause for the failures has been found and fixed.
1080 $wgAttemptFailureEpoch = 1;
1083 * If set, inline scaled images will still produce "<img>" tags ready for
1084 * output instead of showing an error message.
1086 * This may be useful if errors are transitory, especially if the site
1087 * is configured to automatically render thumbnails on request.
1089 * On the other hand, it may obscure error conditions from debugging.
1090 * Enable the debug log or the 'thumbnail' log group to make sure errors
1091 * are logged to a file for review.
1093 $wgIgnoreImageErrors = false;
1096 * Allow thumbnail rendering on page view. If this is false, a valid
1097 * thumbnail URL is still output, but no file will be created at
1098 * the target location. This may save some time if you have a
1099 * thumb.php or 404 handler set up which is faster than the regular
1100 * webserver(s).
1102 $wgGenerateThumbnailOnParse = true;
1105 * Show thumbnails for old images on the image description page
1107 $wgShowArchiveThumbnails = true;
1110 * If set to true, images that contain certain the exif orientation tag will
1111 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1112 * is available that can rotate.
1114 $wgEnableAutoRotation = null;
1117 * Internal name of virus scanner. This serves as a key to the
1118 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1119 * null, every file uploaded will be scanned for viruses.
1121 $wgAntivirus = null;
1124 * Configuration for different virus scanners. This an associative array of
1125 * associative arrays. It contains one setup array per known scanner type.
1126 * The entry is selected by $wgAntivirus, i.e.
1127 * valid values for $wgAntivirus are the keys defined in this array.
1129 * The configuration array for each scanner contains the following keys:
1130 * "command", "codemap", "messagepattern":
1132 * "command" is the full command to call the virus scanner - %f will be
1133 * replaced with the name of the file to scan. If not present, the filename
1134 * will be appended to the command. Note that this must be overwritten if the
1135 * scanner is not in the system path; in that case, please set
1136 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1137 * path.
1139 * "codemap" is a mapping of exit code to return codes of the detectVirus
1140 * function in SpecialUpload.
1141 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1142 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1143 * is not set.
1144 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1145 * the file to have an unsupported format, which is probably immune to
1146 * viruses. This causes the file to pass.
1147 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1148 * no virus was found.
1149 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1150 * a virus.
1151 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1153 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1154 * output. The relevant part should be matched as group one (\1).
1155 * If not defined or the pattern does not match, the full message is shown to the user.
1157 $wgAntivirusSetup = array(
1159 #setup for clamav
1160 'clamav' => array(
1161 'command' => 'clamscan --no-summary ',
1162 'codemap' => array(
1163 "0" => AV_NO_VIRUS, # no virus
1164 "1" => AV_VIRUS_FOUND, # virus found
1165 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1166 "*" => AV_SCAN_FAILED, # else scan failed
1168 'messagepattern' => '/.*?:(.*)/sim',
1173 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1175 $wgAntivirusRequired = true;
1178 * Determines if the MIME type of uploaded files should be checked
1180 $wgVerifyMimeType = true;
1183 * Sets the MIME type definition file to use by MimeMagic.php.
1184 * Set to null, to use built-in defaults only.
1185 * example: $wgMimeTypeFile = '/etc/mime.types';
1187 $wgMimeTypeFile = 'includes/mime.types';
1190 * Sets the MIME type info file to use by MimeMagic.php.
1191 * Set to null, to use built-in defaults only.
1193 $wgMimeInfoFile = 'includes/mime.info';
1196 * Sets an external MIME detector program. The command must print only
1197 * the MIME type to standard output.
1198 * The name of the file to process will be appended to the command given here.
1199 * If not set or NULL, PHP's fileinfo extension will be used if available.
1201 * @par Example:
1202 * @code
1203 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1204 * @endcode
1206 $wgMimeDetectorCommand = null;
1209 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1210 * things, because only a few types of images are needed and file extensions
1211 * can be trusted.
1213 $wgTrivialMimeDetection = false;
1216 * Additional XML types we can allow via MIME-detection.
1217 * array = ( 'rootElement' => 'associatedMimeType' )
1219 $wgXMLMimeTypes = array(
1220 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1221 'svg' => 'image/svg+xml',
1222 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1223 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1224 'html' => 'text/html', // application/xhtml+xml?
1228 * Limit images on image description pages to a user-selectable limit. In order
1229 * to reduce disk usage, limits can only be selected from a list.
1230 * The user preference is saved as an array offset in the database, by default
1231 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1232 * change it if you alter the array (see bug 8858).
1233 * This is the list of settings the user can choose from:
1235 $wgImageLimits = array(
1236 array( 320, 240 ),
1237 array( 640, 480 ),
1238 array( 800, 600 ),
1239 array( 1024, 768 ),
1240 array( 1280, 1024 )
1244 * Adjust thumbnails on image pages according to a user setting. In order to
1245 * reduce disk usage, the values can only be selected from a list. This is the
1246 * list of settings the user can choose from:
1248 $wgThumbLimits = array(
1249 120,
1250 150,
1251 180,
1252 200,
1253 250,
1258 * When defined, is an array of image widths used as buckets for thumbnail generation.
1259 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1260 * always using the original. This will incur a speed gain but cause a quality loss.
1262 * The buckets generation is chained, with each bucket generated based on the above bucket
1263 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1264 * supports it.
1266 $wgThumbnailBuckets = null;
1269 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1270 * above the requested size. The distance represents how many extra pixels of width the bucket
1271 * needs in order to be used as the reference for a given thumbnail. For example, with the
1272 * following buckets:
1274 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1276 * and a distance of 50:
1278 * $wgThumbnailMinimumBucketDistance = 50;
1280 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1281 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1283 $wgThumbnailMinimumBucketDistance = 50;
1286 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1287 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1288 * has a performance impact for the first client to view a certain size.
1290 * This obviously means that more disk space is needed per upload upfront.
1292 * @since 1.25
1295 $wgUploadThumbnailRenderMap = array();
1298 * The method through which the thumbnails will be prerendered for the entries in
1299 * $wgUploadThumbnailRenderMap
1301 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1302 * thumbnail's URL.
1303 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1304 * option uses the job queue to render the thumbnail.
1306 * @since 1.25
1308 $wgUploadThumbnailRenderMethod = 'jobqueue';
1311 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1313 * @since 1.25
1315 $wgUploadThumbnailRenderHttpCustomHost = false;
1318 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1319 * HTTP request to.
1321 * @since 1.25
1323 $wgUploadThumbnailRenderHttpCustomDomain = false;
1326 * Default parameters for the "<gallery>" tag
1328 $wgGalleryOptions = array(
1329 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1330 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1331 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1332 'captionLength' => 25, // Length of caption to truncate (in characters)
1333 'showBytes' => true, // Show the filesize in bytes in categories
1334 'mode' => 'traditional',
1338 * Adjust width of upright images when parameter 'upright' is used
1339 * This allows a nicer look for upright images without the need to fix the width
1340 * by hardcoded px in wiki sourcecode.
1342 $wgThumbUpright = 0.75;
1345 * Default value for chmoding of new directories.
1347 $wgDirectoryMode = 0777;
1350 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1352 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1353 * thumbnails, output via the srcset attribute.
1355 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1356 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1357 * The polyfill can be found in the jquery.hidpi module.
1359 $wgResponsiveImages = true;
1362 * @name DJVU settings
1363 * @{
1367 * Path of the djvudump executable
1368 * Enable this and $wgDjvuRenderer to enable djvu rendering
1369 * example: $wgDjvuDump = 'djvudump';
1371 $wgDjvuDump = null;
1374 * Path of the ddjvu DJVU renderer
1375 * Enable this and $wgDjvuDump to enable djvu rendering
1376 * example: $wgDjvuRenderer = 'ddjvu';
1378 $wgDjvuRenderer = null;
1381 * Path of the djvutxt DJVU text extraction utility
1382 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1383 * example: $wgDjvuTxt = 'djvutxt';
1385 $wgDjvuTxt = null;
1388 * Path of the djvutoxml executable
1389 * This works like djvudump except much, much slower as of version 3.5.
1391 * For now we recommend you use djvudump instead. The djvuxml output is
1392 * probably more stable, so we'll switch back to it as soon as they fix
1393 * the efficiency problem.
1394 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1396 * @par Example:
1397 * @code
1398 * $wgDjvuToXML = 'djvutoxml';
1399 * @endcode
1401 $wgDjvuToXML = null;
1404 * Shell command for the DJVU post processor
1405 * Default: pnmtojpeg, since ddjvu generates ppm output
1406 * Set this to false to output the ppm file directly.
1408 $wgDjvuPostProcessor = 'pnmtojpeg';
1411 * File extension for the DJVU post processor output
1413 $wgDjvuOutputExtension = 'jpg';
1415 /** @} */ # end of DJvu }
1417 /** @} */ # end of file uploads }
1419 /************************************************************************//**
1420 * @name Email settings
1421 * @{
1426 * Site admin email address.
1428 * Defaults to "wikiadmin@$wgServerName".
1430 $wgEmergencyContact = false;
1433 * Password reminder email address.
1435 * The address we should use as sender when a user is requesting his password.
1437 * Defaults to "apache@$wgServerName".
1439 $wgPasswordSender = false;
1442 * Password reminder name
1444 * @deprecated since 1.23; use the system message 'emailsender' instead.
1446 $wgPasswordSenderName = 'MediaWiki Mail';
1449 * Dummy address which should be accepted during mail send action.
1450 * It might be necessary to adapt the address or to set it equal
1451 * to the $wgEmergencyContact address.
1453 $wgNoReplyAddress = 'reply@not.possible';
1456 * Set to true to enable the e-mail basic features:
1457 * Password reminders, etc. If sending e-mail on your
1458 * server doesn't work, you might want to disable this.
1460 $wgEnableEmail = true;
1463 * Set to true to enable user-to-user e-mail.
1464 * This can potentially be abused, as it's hard to track.
1466 $wgEnableUserEmail = true;
1469 * Set to true to put the sending user's email in a Reply-To header
1470 * instead of From. ($wgEmergencyContact will be used as From.)
1472 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1473 * which can cause problems with SPF validation and leak recipient addresses
1474 * when bounces are sent to the sender.
1476 $wgUserEmailUseReplyTo = false;
1479 * Minimum time, in hours, which must elapse between password reminder
1480 * emails for a given account. This is to prevent abuse by mail flooding.
1482 $wgPasswordReminderResendTime = 24;
1485 * The time, in seconds, when an emailed temporary password expires.
1487 $wgNewPasswordExpiry = 3600 * 24 * 7;
1490 * The time, in seconds, when an email confirmation email expires
1492 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1495 * The number of days that a user's password is good for. After this number of days, the
1496 * user will be asked to reset their password. Set to false to disable password expiration.
1498 $wgPasswordExpirationDays = false;
1501 * If a user's password is expired, the number of seconds when they can still login,
1502 * and cancel their password change, but are sent to the password change form on each login.
1504 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1507 * SMTP Mode.
1509 * For using a direct (authenticated) SMTP server connection.
1510 * Default to false or fill an array :
1512 * @code
1513 * $wgSMTP = array(
1514 * 'host' => 'SMTP domain',
1515 * 'IDHost' => 'domain for MessageID',
1516 * 'port' => '25',
1517 * 'auth' => [true|false],
1518 * 'username' => [SMTP username],
1519 * 'password' => [SMTP password],
1520 * );
1521 * @endcode
1523 $wgSMTP = false;
1526 * Additional email parameters, will be passed as the last argument to mail() call.
1527 * If using safe_mode this has no effect
1529 $wgAdditionalMailParams = null;
1532 * For parts of the system that have been updated to provide HTML email content, send
1533 * both text and HTML parts as the body of the email
1535 $wgAllowHTMLEmail = false;
1538 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1539 * from $wgEmergencyContact
1541 $wgEnotifFromEditor = false;
1543 // TODO move UPO to preferences probably ?
1544 # If set to true, users get a corresponding option in their preferences and can choose to
1545 # enable or disable at their discretion
1546 # If set to false, the corresponding input form on the user preference page is suppressed
1547 # It call this to be a "user-preferences-option (UPO)"
1550 * Require email authentication before sending mail to an email address.
1551 * This is highly recommended. It prevents MediaWiki from being used as an open
1552 * spam relay.
1554 $wgEmailAuthentication = true;
1557 * Allow users to enable email notification ("enotif") on watchlist changes.
1559 $wgEnotifWatchlist = false;
1562 * Allow users to enable email notification ("enotif") when someone edits their
1563 * user talk page.
1565 $wgEnotifUserTalk = false;
1568 * Set the Reply-to address in notifications to the editor's address, if user
1569 * allowed this in the preferences.
1571 $wgEnotifRevealEditorAddress = false;
1574 * Send notification mails on minor edits to watchlist pages. This is enabled
1575 * by default. Does not affect user talk notifications.
1577 $wgEnotifMinorEdits = true;
1580 * Send a generic mail instead of a personalised mail for each user. This
1581 * always uses UTC as the time zone, and doesn't include the username.
1583 * For pages with many users watching, this can significantly reduce mail load.
1584 * Has no effect when using sendmail rather than SMTP.
1586 $wgEnotifImpersonal = false;
1589 * Maximum number of users to mail at once when using impersonal mail. Should
1590 * match the limit on your mail server.
1592 $wgEnotifMaxRecips = 500;
1595 * Send mails via the job queue. This can be useful to reduce the time it
1596 * takes to save a page that a lot of people are watching.
1598 $wgEnotifUseJobQ = false;
1601 * Use the job queue for user activity updates like updating "last visited"
1602 * fields for email notifications of page changes. This should only be enabled
1603 * if the jobs have a dedicated runner to avoid update lag.
1605 * @since 1.26
1607 $wgActivityUpdatesUseJobQueue = false;
1610 * Use real name instead of username in e-mail "from" field.
1612 $wgEnotifUseRealName = false;
1615 * Array of usernames who will be sent a notification email for every change
1616 * which occurs on a wiki. Users will not be notified of their own changes.
1618 $wgUsersNotifiedOnAllChanges = array();
1620 /** @} */ # end of email settings
1622 /************************************************************************//**
1623 * @name Database settings
1624 * @{
1628 * Database host name or IP address
1630 $wgDBserver = 'localhost';
1633 * Database port number (for PostgreSQL and Microsoft SQL Server).
1635 $wgDBport = 5432;
1638 * Name of the database
1640 $wgDBname = 'my_wiki';
1643 * Database username
1645 $wgDBuser = 'wikiuser';
1648 * Database user's password
1650 $wgDBpassword = '';
1653 * Database type
1655 $wgDBtype = 'mysql';
1658 * Whether to use SSL in DB connection.
1660 * This setting is only used $wgLBFactoryConf['class'] is set to
1661 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1662 * the DBO_SSL flag must be set in the 'flags' option of the database
1663 * connection to achieve the same functionality.
1665 $wgDBssl = false;
1668 * Whether to use compression in DB connection.
1670 * This setting is only used $wgLBFactoryConf['class'] is set to
1671 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1672 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1673 * connection to achieve the same functionality.
1675 $wgDBcompress = false;
1678 * Separate username for maintenance tasks. Leave as null to use the default.
1680 $wgDBadminuser = null;
1683 * Separate password for maintenance tasks. Leave as null to use the default.
1685 $wgDBadminpassword = null;
1688 * Search type.
1689 * Leave as null to select the default search engine for the
1690 * selected database type (eg SearchMySQL), or set to a class
1691 * name to override to a custom search engine.
1693 $wgSearchType = null;
1696 * Alternative search types
1697 * Sometimes you want to support multiple search engines for testing. This
1698 * allows users to select their search engine of choice via url parameters
1699 * to Special:Search and the action=search API. If using this, there's no
1700 * need to add $wgSearchType to it, that is handled automatically.
1702 $wgSearchTypeAlternatives = null;
1705 * Table name prefix
1707 $wgDBprefix = '';
1710 * MySQL table options to use during installation or update
1712 $wgDBTableOptions = 'ENGINE=InnoDB';
1715 * SQL Mode - default is turning off all modes, including strict, if set.
1716 * null can be used to skip the setting for performance reasons and assume
1717 * DBA has done his best job.
1718 * String override can be used for some additional fun :-)
1720 $wgSQLMode = '';
1723 * Mediawiki schema
1725 $wgDBmwschema = null;
1728 * To override default SQLite data directory ($docroot/../data)
1730 $wgSQLiteDataDir = '';
1733 * Make all database connections secretly go to localhost. Fool the load balancer
1734 * thinking there is an arbitrarily large cluster of servers to connect to.
1735 * Useful for debugging.
1737 $wgAllDBsAreLocalhost = false;
1740 * Shared database for multiple wikis. Commonly used for storing a user table
1741 * for single sign-on. The server for this database must be the same as for the
1742 * main database.
1744 * For backwards compatibility the shared prefix is set to the same as the local
1745 * prefix, and the user table is listed in the default list of shared tables.
1746 * The user_properties table is also added so that users will continue to have their
1747 * preferences shared (preferences were stored in the user table prior to 1.16)
1749 * $wgSharedTables may be customized with a list of tables to share in the shared
1750 * database. However it is advised to limit what tables you do share as many of
1751 * MediaWiki's tables may have side effects if you try to share them.
1753 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1754 * $wgDBprefix.
1756 * $wgSharedSchema is the table schema for the shared database. It defaults to
1757 * $wgDBmwschema.
1759 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1760 * access remote databases. Using wfGetLB() allows the shared database to
1761 * reside on separate servers to the wiki's own database, with suitable
1762 * configuration of $wgLBFactoryConf.
1764 $wgSharedDB = null;
1767 * @see $wgSharedDB
1769 $wgSharedPrefix = false;
1772 * @see $wgSharedDB
1774 $wgSharedTables = array( 'user', 'user_properties' );
1777 * @see $wgSharedDB
1778 * @since 1.23
1780 $wgSharedSchema = false;
1783 * Database load balancer
1784 * This is a two-dimensional array, an array of server info structures
1785 * Fields are:
1786 * - host: Host name
1787 * - dbname: Default database name
1788 * - user: DB user
1789 * - password: DB password
1790 * - type: DB type
1792 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1793 * If this is zero for any given server, no normal query traffic will be
1794 * sent to it. It will be excluded from lag checks in maintenance scripts.
1795 * The only way it can receive traffic is if groupLoads is used.
1797 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1798 * to several groups, the most specific group defined here is used.
1800 * - flags: bit field
1801 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1802 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1803 * - DBO_TRX -- wrap entire request in a transaction
1804 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1805 * - DBO_PERSISTENT -- enables persistent database connections
1806 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1807 * - DBO_COMPRESS -- uses internal compression in database connections,
1808 * if available
1810 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1812 * These and any other user-defined properties will be assigned to the mLBInfo member
1813 * variable of the Database object.
1815 * Leave at false to use the single-server variables above. If you set this
1816 * variable, the single-server variables will generally be ignored (except
1817 * perhaps in some command-line scripts).
1819 * The first server listed in this array (with key 0) will be the master. The
1820 * rest of the servers will be slaves. To prevent writes to your slaves due to
1821 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1822 * slaves in my.cnf. You can set read_only mode at runtime using:
1824 * @code
1825 * SET @@read_only=1;
1826 * @endcode
1828 * Since the effect of writing to a slave is so damaging and difficult to clean
1829 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1830 * our masters, and then set read_only=0 on masters at runtime.
1832 $wgDBservers = false;
1835 * Load balancer factory configuration
1836 * To set up a multi-master wiki farm, set the class here to something that
1837 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1838 * The class identified here is responsible for reading $wgDBservers,
1839 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1841 * The LBFactoryMulti class is provided for this purpose, please see
1842 * includes/db/LBFactoryMulti.php for configuration information.
1844 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1847 * How long to wait for a slave to catch up to the master
1848 * @deprecated since 1.24
1850 $wgMasterWaitTimeout = 10;
1853 * File to log database errors to
1855 $wgDBerrorLog = false;
1858 * Timezone to use in the error log.
1859 * Defaults to the wiki timezone ($wgLocaltimezone).
1861 * A list of usable timezones can found at:
1862 * http://php.net/manual/en/timezones.php
1864 * @par Examples:
1865 * @code
1866 * $wgDBerrorLogTZ = 'UTC';
1867 * $wgDBerrorLogTZ = 'GMT';
1868 * $wgDBerrorLogTZ = 'PST8PDT';
1869 * $wgDBerrorLogTZ = 'Europe/Sweden';
1870 * $wgDBerrorLogTZ = 'CET';
1871 * @endcode
1873 * @since 1.20
1875 $wgDBerrorLogTZ = false;
1878 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1879 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1881 * @warning THIS IS EXPERIMENTAL!
1883 * May break if you're not using the table defs from mysql5/tables.sql.
1884 * May break if you're upgrading an existing wiki if set differently.
1885 * Broken symptoms likely to include incorrect behavior with page titles,
1886 * usernames, comments etc containing non-ASCII characters.
1887 * Might also cause failures on the object cache and other things.
1889 * Even correct usage may cause failures with Unicode supplementary
1890 * characters (those not in the Basic Multilingual Plane) unless MySQL
1891 * has enhanced their Unicode support.
1893 $wgDBmysql5 = false;
1896 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1898 * To use this feature set to true and use a datasource defined as
1899 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1900 * block).
1902 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1903 * Pool) that maintains established sessions and reuses them on new
1904 * connections.
1906 * Not completely tested, but it should fall back on normal connection
1907 * in case the pool is full or the datasource is not configured as
1908 * pooled.
1909 * And the other way around; using oci_pconnect on a non pooled
1910 * datasource should produce a normal connection.
1912 * When it comes to frequent shortlived DB connections like with MW
1913 * Oracle tends to s***. The problem is the driver connects to the
1914 * database reasonably fast, but establishing a session takes time and
1915 * resources. MW does not rely on session state (as it does not use
1916 * features such as package variables) so establishing a valid session
1917 * is in this case an unwanted overhead that just slows things down.
1919 * @warning EXPERIMENTAL!
1922 $wgDBOracleDRCP = false;
1925 * Other wikis on this site, can be administered from a single developer
1926 * account.
1927 * Array numeric key => database name
1929 $wgLocalDatabases = array();
1932 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1933 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1934 * show a more obvious warning.
1936 $wgSlaveLagWarning = 10;
1939 * @see $wgSlaveLagWarning
1941 $wgSlaveLagCritical = 30;
1944 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1946 $wgDBWindowsAuthentication = false;
1948 /**@}*/ # End of DB settings }
1950 /************************************************************************//**
1951 * @name Text storage
1952 * @{
1956 * We can also compress text stored in the 'text' table. If this is set on, new
1957 * revisions will be compressed on page save if zlib support is available. Any
1958 * compressed revisions will be decompressed on load regardless of this setting,
1959 * but will not be readable at all* if zlib support is not available.
1961 $wgCompressRevisions = false;
1964 * External stores allow including content
1965 * from non database sources following URL links.
1967 * Short names of ExternalStore classes may be specified in an array here:
1968 * @code
1969 * $wgExternalStores = array("http","file","custom")...
1970 * @endcode
1972 * CAUTION: Access to database might lead to code execution
1974 $wgExternalStores = array();
1977 * An array of external MySQL servers.
1979 * @par Example:
1980 * Create a cluster named 'cluster1' containing three servers:
1981 * @code
1982 * $wgExternalServers = array(
1983 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1984 * );
1985 * @endcode
1987 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1988 * another class.
1990 $wgExternalServers = array();
1993 * The place to put new revisions, false to put them in the local text table.
1994 * Part of a URL, e.g. DB://cluster1
1996 * Can be an array instead of a single string, to enable data distribution. Keys
1997 * must be consecutive integers, starting at zero.
1999 * @par Example:
2000 * @code
2001 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
2002 * @endcode
2004 * @var array
2006 $wgDefaultExternalStore = false;
2009 * Revision text may be cached in $wgMemc to reduce load on external storage
2010 * servers and object extraction overhead for frequently-loaded revisions.
2012 * Set to 0 to disable, or number of seconds before cache expiry.
2014 $wgRevisionCacheExpiry = 0;
2016 /** @} */ # end text storage }
2018 /************************************************************************//**
2019 * @name Performance hacks and limits
2020 * @{
2024 * Disable database-intensive features
2026 $wgMiserMode = false;
2029 * Disable all query pages if miser mode is on, not just some
2031 $wgDisableQueryPages = false;
2034 * Number of rows to cache in 'querycache' table when miser mode is on
2036 $wgQueryCacheLimit = 1000;
2039 * Number of links to a page required before it is deemed "wanted"
2041 $wgWantedPagesThreshold = 1;
2044 * Enable slow parser functions
2046 $wgAllowSlowParserFunctions = false;
2049 * Allow schema updates
2051 $wgAllowSchemaUpdates = true;
2054 * Maximum article size in kilobytes
2056 $wgMaxArticleSize = 2048;
2059 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2060 * raise PHP's memory limit if it's below this amount.
2062 $wgMemoryLimit = "50M";
2064 /** @} */ # end performance hacks }
2066 /************************************************************************//**
2067 * @name Cache settings
2068 * @{
2072 * Directory for caching data in the local filesystem. Should not be accessible
2073 * from the web. Set this to false to not use any local caches.
2075 * Note: if multiple wikis share the same localisation cache directory, they
2076 * must all have the same set of extensions. You can set a directory just for
2077 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2079 $wgCacheDirectory = false;
2082 * Main cache type. This should be a cache with fast access, but it may have
2083 * limited space. By default, it is disabled, since the stock database cache
2084 * is not fast enough to make it worthwhile.
2086 * The options are:
2088 * - CACHE_ANYTHING: Use anything, as long as it works
2089 * - CACHE_NONE: Do not cache
2090 * - CACHE_DB: Store cache objects in the DB
2091 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2092 * - CACHE_ACCEL: APC, XCache or WinCache
2093 * - (other): A string may be used which identifies a cache
2094 * configuration in $wgObjectCaches.
2096 * @see $wgMessageCacheType, $wgParserCacheType
2098 $wgMainCacheType = CACHE_NONE;
2101 * The cache type for storing the contents of the MediaWiki namespace. This
2102 * cache is used for a small amount of data which is expensive to regenerate.
2104 * For available types see $wgMainCacheType.
2106 $wgMessageCacheType = CACHE_ANYTHING;
2109 * The cache type for storing article HTML. This is used to store data which
2110 * is expensive to regenerate, and benefits from having plenty of storage space.
2112 * For available types see $wgMainCacheType.
2114 $wgParserCacheType = CACHE_ANYTHING;
2117 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2119 * For available types see $wgMainCacheType.
2121 $wgSessionCacheType = CACHE_ANYTHING;
2124 * The cache type for storing language conversion tables,
2125 * which are used when parsing certain text and interface messages.
2127 * For available types see $wgMainCacheType.
2129 * @since 1.20
2131 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2134 * Advanced object cache configuration.
2136 * Use this to define the class names and constructor parameters which are used
2137 * for the various cache types. Custom cache types may be defined here and
2138 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2139 * or $wgLanguageConverterCacheType.
2141 * The format is an associative array where the key is a cache identifier, and
2142 * the value is an associative array of parameters. The "class" parameter is the
2143 * class name which will be used. Alternatively, a "factory" parameter may be
2144 * given, giving a callable function which will generate a suitable cache object.
2146 $wgObjectCaches = array(
2147 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2148 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2150 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2151 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2152 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached', 'loggroup' => 'memcached' ),
2154 'apc' => array( 'class' => 'APCBagOStuff' ),
2155 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2156 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2157 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2158 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2159 'hash' => array( 'class' => 'HashBagOStuff' ),
2163 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2164 * but it may have limited space. By default, it is disabled, since the basic stock
2165 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2166 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2167 * cache with a relayer of type EventRelayerNull.
2169 * The options are:
2170 * - false: Configure the cache using $wgMainCacheType, without using
2171 * a relayer (only matters if there are multiple data-centers)
2172 * - CACHE_NONE: Do not cache
2173 * - (other): A string may be used which identifies a cache
2174 * configuration in $wgWANObjectCaches
2175 * @since 1.26
2177 $wgMainWANCache = false;
2180 * Advanced WAN object cache configuration.
2182 * Each WAN cache wraps a registered object cache (for the local cluster)
2183 * and it must also be configured to point to a PubSub instance. Subscribers
2184 * must be configured to relay purges to the actual cache servers.
2186 * The format is an associative array where the key is a cache identifier, and
2187 * the value is an associative array of parameters. The "cacheId" parameter is
2188 * a cache identifier from $wgObjectCaches. The "relayerConfig" parameter is an
2189 * array used to construct an EventRelayer object. The "pool" parameter is a
2190 * string that is used as a PubSub channel prefix.
2192 * @since 1.26
2194 $wgWANObjectCaches = array(
2195 CACHE_NONE => array(
2196 'class' => 'WANObjectCache',
2197 'cacheId' => CACHE_NONE,
2198 'pool' => 'mediawiki-main-none',
2199 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2201 /* Example of a simple single data-center cache:
2202 'memcached-php' => array(
2203 'class' => 'WANObjectCache',
2204 'cacheId' => 'memcached-php',
2205 'pool' => 'mediawiki-main-memcached',
2206 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2212 * Main object stash type. This should be a fast storage system for storing
2213 * lightweight data like hit counters and user activity. Sites with multiple
2214 * data-centers should have this use a store that replicates all writes. The
2215 * store should have enough consistency for CAS operations to be usable.
2217 * The options are:
2218 * - db: Store cache objects in the DB
2219 * - (other): A string may be used which identifies a cache
2220 * configuration in $wgObjectCaches
2222 * @since 1.26
2224 $wgMainStash = 'db';
2227 * The expiry time for the parser cache, in seconds.
2228 * The default is 86400 (one day).
2230 $wgParserCacheExpireTime = 86400;
2233 * Deprecated alias for $wgSessionsInObjectCache.
2235 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2237 $wgSessionsInMemcached = false;
2240 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2241 * can be useful to improve performance, or to avoid the locking behavior of
2242 * PHP's default session handler, which tends to prevent multiple requests for
2243 * the same user from acting concurrently.
2245 $wgSessionsInObjectCache = false;
2248 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2249 * enabled, in seconds.
2251 $wgObjectCacheSessionExpiry = 3600;
2254 * This is used for setting php's session.save_handler. In practice, you will
2255 * almost never need to change this ever. Other options might be 'user' or
2256 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2257 * useful if you're doing cross-application sessions, see bug 11381)
2259 $wgSessionHandler = null;
2262 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2264 $wgMemCachedDebug = false;
2267 * The list of MemCached servers and port numbers
2269 $wgMemCachedServers = array( '127.0.0.1:11211' );
2272 * Use persistent connections to MemCached, which are shared across multiple
2273 * requests.
2275 $wgMemCachedPersistent = false;
2278 * Read/write timeout for MemCached server communication, in microseconds.
2280 $wgMemCachedTimeout = 500000;
2283 * Set this to true to make a local copy of the message cache, for use in
2284 * addition to memcached. The files will be put in $wgCacheDirectory.
2286 $wgUseLocalMessageCache = false;
2289 * Instead of caching everything, only cache those messages which have
2290 * been customised in the site content language. This means that
2291 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2292 * This option is probably only useful for translatewiki.net.
2294 $wgAdaptiveMessageCache = false;
2297 * Localisation cache configuration. Associative array with keys:
2298 * class: The class to use. May be overridden by extensions.
2300 * store: The location to store cache data. May be 'files', 'db' or
2301 * 'detect'. If set to "files", data will be in CDB files. If set
2302 * to "db", data will be stored to the database. If set to
2303 * "detect", files will be used if $wgCacheDirectory is set,
2304 * otherwise the database will be used.
2306 * storeClass: The class name for the underlying storage. If set to a class
2307 * name, it overrides the "store" setting.
2309 * storeDirectory: If the store class puts its data in files, this is the
2310 * directory it will use. If this is false, $wgCacheDirectory
2311 * will be used.
2313 * manualRecache: Set this to true to disable cache updates on web requests.
2314 * Use maintenance/rebuildLocalisationCache.php instead.
2316 $wgLocalisationCacheConf = array(
2317 'class' => 'LocalisationCache',
2318 'store' => 'detect',
2319 'storeClass' => false,
2320 'storeDirectory' => false,
2321 'manualRecache' => false,
2325 * Allow client-side caching of pages
2327 $wgCachePages = true;
2330 * Set this to current time to invalidate all prior cached pages. Affects both
2331 * client-side and server-side caching.
2332 * You can get the current date on your server by using the command:
2333 * @verbatim
2334 * date +%Y%m%d%H%M%S
2335 * @endverbatim
2337 $wgCacheEpoch = '20030516000000';
2340 * Directory where GitInfo will look for pre-computed cache files. If false,
2341 * $wgCacheDirectory/gitinfo will be used.
2343 $wgGitInfoCacheDirectory = false;
2346 * Bump this number when changing the global style sheets and JavaScript.
2348 * It should be appended in the query string of static CSS and JS includes,
2349 * to ensure that client-side caches do not keep obsolete copies of global
2350 * styles.
2352 $wgStyleVersion = '303';
2355 * This will cache static pages for non-logged-in users to reduce
2356 * database traffic on public sites.
2357 * Automatically sets $wgShowIPinHeader = false
2358 * ResourceLoader requests to default language and skins are cached
2359 * as well as single module requests.
2361 $wgUseFileCache = false;
2364 * Depth of the subdirectory hierarchy to be created under
2365 * $wgFileCacheDirectory. The subdirectories will be named based on
2366 * the MD5 hash of the title. A value of 0 means all cache files will
2367 * be put directly into the main file cache directory.
2369 $wgFileCacheDepth = 2;
2372 * Keep parsed pages in a cache (objectcache table or memcached)
2373 * to speed up output of the same page viewed by another user with the
2374 * same options.
2376 * This can provide a significant speedup for medium to large pages,
2377 * so you probably want to keep it on. Extensions that conflict with the
2378 * parser cache should disable the cache on a per-page basis instead.
2380 $wgEnableParserCache = true;
2383 * Append a configured value to the parser cache and the sitenotice key so
2384 * that they can be kept separate for some class of activity.
2386 $wgRenderHashAppend = '';
2389 * If on, the sidebar navigation links are cached for users with the
2390 * current language set. This can save a touch of load on a busy site
2391 * by shaving off extra message lookups.
2393 * However it is also fragile: changing the site configuration, or
2394 * having a variable $wgArticlePath, can produce broken links that
2395 * don't update as expected.
2397 $wgEnableSidebarCache = false;
2400 * Expiry time for the sidebar cache, in seconds
2402 $wgSidebarCacheExpiry = 86400;
2405 * When using the file cache, we can store the cached HTML gzipped to save disk
2406 * space. Pages will then also be served compressed to clients that support it.
2408 * Requires zlib support enabled in PHP.
2410 $wgUseGzip = false;
2413 * Whether MediaWiki should send an ETag header. Seems to cause
2414 * broken behavior with Squid 2.6, see bug 7098.
2416 $wgUseETag = false;
2419 * Clock skew or the one-second resolution of time() can occasionally cause cache
2420 * problems when the user requests two pages within a short period of time. This
2421 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2422 * a grace period.
2424 $wgClockSkewFudge = 5;
2427 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2428 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2429 * was previously done in the default LocalSettings.php file.
2431 * On high-traffic wikis, this should be set to false, to avoid the need to
2432 * check the file modification time, and to avoid the performance impact of
2433 * unnecessary cache invalidations.
2435 $wgInvalidateCacheOnLocalSettingsChange = true;
2438 * When loading extensions through the extension registration system, this
2439 * can be used to invalidate the cache. A good idea would be to set this to
2440 * one file, you can just `touch` that one to invalidate the cache
2442 * @par Example:
2443 * @code
2444 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2445 * @endcode
2447 * If set to false, the mtime for each individual JSON file will be checked,
2448 * which can be slow if a large number of extensions are being loaded.
2450 * @var int|bool
2452 $wgExtensionInfoMTime = false;
2454 /** @} */ # end of cache settings
2456 /************************************************************************//**
2457 * @name HTTP proxy (Squid) settings
2459 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2460 * although they are referred to as Squid settings for historical reasons.
2462 * Achieving a high hit ratio with an HTTP proxy requires special
2463 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2464 * more details.
2466 * @{
2470 * Enable/disable Squid.
2471 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2473 $wgUseSquid = false;
2476 * If you run Squid3 with ESI support, enable this (default:false):
2478 $wgUseESI = false;
2481 * Send X-Vary-Options header for better caching (requires patched Squid)
2483 $wgUseXVO = false;
2486 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2487 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2488 * and need to split the cache between HTTP and HTTPS for API requests,
2489 * feed requests and HTTP redirect responses in order to prevent cache
2490 * pollution. This does not affect 'normal' requests to index.php other than
2491 * HTTP redirects.
2493 $wgVaryOnXFP = false;
2496 * Internal server name as known to Squid, if different.
2498 * @par Example:
2499 * @code
2500 * $wgInternalServer = 'http://yourinternal.tld:8000';
2501 * @endcode
2503 $wgInternalServer = false;
2506 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2507 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2508 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2509 * days
2511 $wgSquidMaxage = 18000;
2514 * Default maximum age for raw CSS/JS accesses
2516 $wgForcedRawSMaxage = 300;
2519 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2521 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2522 * headers sent/modified from these proxies when obtaining the remote IP address
2524 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2526 $wgSquidServers = array();
2529 * As above, except these servers aren't purged on page changes; use to set a
2530 * list of trusted proxies, etc. Supports both individual IP addresses and
2531 * CIDR blocks.
2532 * @since 1.23 Supports CIDR ranges
2534 $wgSquidServersNoPurge = array();
2537 * Maximum number of titles to purge in any one client operation
2539 $wgMaxSquidPurgeTitles = 400;
2542 * Whether to use a Host header in purge requests sent to the proxy servers
2543 * configured in $wgSquidServers. Set this to false to support Squid
2544 * configured in forward-proxy mode.
2546 * If this is set to true, a Host header will be sent, and only the path
2547 * component of the URL will appear on the request line, as if the request
2548 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2549 * request. Squid supports this style of request only if reverse-proxy mode
2550 * (http_port ... accel) is enabled.
2552 * If this is set to false, no Host header will be sent, and the absolute URL
2553 * will be sent in the request line, as is the standard for an HTTP proxy
2554 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2555 * by Varnish, but is supported by Squid in either configuration (forward or
2556 * reverse).
2558 * @since 1.21
2560 $wgSquidPurgeUseHostHeader = true;
2563 * Routing configuration for HTCP multicast purging. Add elements here to
2564 * enable HTCP and determine which purges are sent where. If set to an empty
2565 * array, HTCP is disabled.
2567 * Each key in this array is a regular expression to match against the purged
2568 * URL, or an empty string to match all URLs. The purged URL is matched against
2569 * the regexes in the order specified, and the first rule whose regex matches
2570 * is used, all remaining rules will thus be ignored.
2572 * @par Example configuration to send purges for upload.wikimedia.org to one
2573 * multicast group and all other purges to another:
2574 * @code
2575 * $wgHTCPRouting = array(
2576 * '|^https?://upload\.wikimedia\.org|' => array(
2577 * 'host' => '239.128.0.113',
2578 * 'port' => 4827,
2579 * ),
2580 * '' => array(
2581 * 'host' => '239.128.0.112',
2582 * 'port' => 4827,
2583 * ),
2584 * );
2585 * @endcode
2587 * You can also pass an array of hosts to send purges too. This is useful when
2588 * you have several multicast groups or unicast address that should receive a
2589 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2591 * @par Example of sending purges to multiple hosts:
2592 * @code
2593 * $wgHTCPRouting = array(
2594 * '' => array(
2595 * // Purges to text caches using multicast
2596 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2597 * // Purges to a hardcoded list of caches
2598 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2599 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2600 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2601 * ),
2602 * );
2603 * @endcode
2605 * @since 1.22
2607 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2608 * For back compatibility purposes, whenever its array is empty
2609 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2611 * @see $wgHTCPMulticastTTL
2613 $wgHTCPRouting = array();
2616 * HTCP multicast TTL.
2617 * @see $wgHTCPRouting
2619 $wgHTCPMulticastTTL = 1;
2622 * Should forwarded Private IPs be accepted?
2624 $wgUsePrivateIPs = false;
2626 /** @} */ # end of HTTP proxy settings
2628 /************************************************************************//**
2629 * @name Language, regional and character encoding settings
2630 * @{
2634 * Site language code. See languages/Names.php for languages supported by
2635 * MediaWiki out of the box. Not all languages listed there have translations,
2636 * see languages/messages/ for the list of languages with some localisation.
2638 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2639 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2641 * This defines the default interface language for all users, but users can
2642 * change it in their preferences.
2644 * This also defines the language of pages in the wiki. The content is wrapped
2645 * in a html element with lang=XX attribute. This behavior can be overridden
2646 * via hooks, see Title::getPageLanguage.
2648 $wgLanguageCode = 'en';
2651 * Language cache size, or really how many languages can we handle
2652 * simultaneously without degrading to crawl speed.
2654 $wgLangObjCacheSize = 10;
2657 * Some languages need different word forms, usually for different cases.
2658 * Used in Language::convertGrammar().
2660 * @par Example:
2661 * @code
2662 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2663 * @endcode
2665 $wgGrammarForms = array();
2668 * Treat language links as magic connectors, not inline links
2670 $wgInterwikiMagic = true;
2673 * Hide interlanguage links from the sidebar
2675 $wgHideInterlanguageLinks = false;
2678 * List of additional interwiki prefixes that should be treated as
2679 * interlanguage links (i.e. placed in the sidebar).
2680 * Notes:
2681 * - This will not do anything unless the prefixes are defined in the interwiki
2682 * map.
2683 * - The display text for these custom interlanguage links will be fetched from
2684 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2685 * this array.
2686 * - A friendly name for each site, used for tooltip text, may optionally be
2687 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2688 * the prefix in this array.
2690 $wgExtraInterlanguageLinkPrefixes = array();
2693 * List of language names or overrides for default names in Names.php
2695 $wgExtraLanguageNames = array();
2698 * List of language codes that don't correspond to an actual language.
2699 * These codes are mostly left-offs from renames, or other legacy things.
2700 * This array makes them not appear as a selectable language on the installer,
2701 * and excludes them when running the transstat.php script.
2703 $wgDummyLanguageCodes = array(
2704 'als' => 'gsw',
2705 'bat-smg' => 'sgs',
2706 'be-x-old' => 'be-tarask',
2707 'bh' => 'bho',
2708 'fiu-vro' => 'vro',
2709 'no' => 'nb',
2710 'qqq' => 'qqq', # Used for message documentation.
2711 'qqx' => 'qqx', # Used for viewing message keys.
2712 'roa-rup' => 'rup',
2713 'simple' => 'en',
2714 'zh-classical' => 'lzh',
2715 'zh-min-nan' => 'nan',
2716 'zh-yue' => 'yue',
2720 * Character set for use in the article edit box. Language-specific encodings
2721 * may be defined.
2723 * This historic feature is one of the first that was added by former MediaWiki
2724 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2726 $wgEditEncoding = '';
2729 * Set this to true to replace Arabic presentation forms with their standard
2730 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2731 * set to "ar".
2733 * Note that pages with titles containing presentation forms will become
2734 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2736 $wgFixArabicUnicode = true;
2739 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2740 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2741 * set to "ml". Note that some clients (even new clients as of 2010) do not
2742 * support these characters.
2744 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2745 * fix any ZWJ sequences in existing page titles.
2747 $wgFixMalayalamUnicode = true;
2750 * Set this to always convert certain Unicode sequences to modern ones
2751 * regardless of the content language. This has a small performance
2752 * impact.
2754 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2755 * details.
2757 * @since 1.17
2759 $wgAllUnicodeFixes = false;
2762 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2763 * loading old revisions not marked with "utf-8" flag. Use this when
2764 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2765 * burdensome mass conversion of old text data.
2767 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2768 * user names, etc still must be converted en masse in the database before
2769 * continuing as a UTF-8 wiki.
2771 $wgLegacyEncoding = false;
2774 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2775 * regexps : "/regexp/" matching problematic browsers. These browsers will
2776 * be served encoded unicode in the edit box instead of real unicode.
2778 $wgBrowserBlackList = array(
2780 * Netscape 2-4 detection
2781 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2782 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2783 * with a negative assertion. The [UIN] identifier specifies the level of security
2784 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2785 * The language string is unreliable, it is missing on NS4 Mac.
2787 * Reference: http://www.psychedelix.com/agents/index.shtml
2789 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2790 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2791 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2794 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2795 * Þ to <THORN> and Ð to <ETH>
2797 * Known useragents:
2798 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2799 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2800 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2801 * - [...]
2803 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2804 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2806 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2809 * Google wireless transcoder, seems to eat a lot of chars alive
2810 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2812 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2816 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2817 * create stub reference rows in the text table instead of copying
2818 * the full text of all current entries from 'cur' to 'text'.
2820 * This will speed up the conversion step for large sites, but
2821 * requires that the cur table be kept around for those revisions
2822 * to remain viewable.
2824 * This option affects the updaters *only*. Any present cur stub
2825 * revisions will be readable at runtime regardless of this setting.
2827 $wgLegacySchemaConversion = false;
2830 * Enable dates like 'May 12' instead of '12 May', if the default date format
2831 * is 'dmy or mdy'.
2833 $wgAmericanDates = false;
2836 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2837 * numerals in interface.
2839 $wgTranslateNumerals = true;
2842 * Translation using MediaWiki: namespace.
2843 * Interface messages will be loaded from the database.
2845 $wgUseDatabaseMessages = true;
2848 * Expiry time for the message cache key
2850 $wgMsgCacheExpiry = 86400;
2853 * Maximum entry size in the message cache, in bytes
2855 $wgMaxMsgCacheEntrySize = 10000;
2858 * Whether to enable language variant conversion.
2860 $wgDisableLangConversion = false;
2863 * Whether to enable language variant conversion for links.
2865 $wgDisableTitleConversion = false;
2868 * Default variant code, if false, the default will be the language code
2870 $wgDefaultLanguageVariant = false;
2873 * Disabled variants array of language variant conversion.
2875 * @par Example:
2876 * @code
2877 * $wgDisabledVariants[] = 'zh-mo';
2878 * $wgDisabledVariants[] = 'zh-my';
2879 * @endcode
2881 $wgDisabledVariants = array();
2884 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2885 * path format that describes which parts of the URL contain the
2886 * language variant.
2888 * @par Example:
2889 * @code
2890 * $wgLanguageCode = 'sr';
2891 * $wgVariantArticlePath = '/$2/$1';
2892 * $wgArticlePath = '/wiki/$1';
2893 * @endcode
2895 * A link to /wiki/ would be redirected to /sr/Главна_страна
2897 * It is important that $wgArticlePath not overlap with possible values
2898 * of $wgVariantArticlePath.
2900 $wgVariantArticlePath = false;
2903 * Show a bar of language selection links in the user login and user
2904 * registration forms; edit the "loginlanguagelinks" message to
2905 * customise these.
2907 $wgLoginLanguageSelector = false;
2910 * When translating messages with wfMessage(), it is not always clear what
2911 * should be considered UI messages and what should be content messages.
2913 * For example, for the English Wikipedia, there should be only one 'mainpage',
2914 * so when getting the link for 'mainpage', we should treat it as site content
2915 * and call ->inContentLanguage()->text(), but for rendering the text of the
2916 * link, we call ->text(). The code behaves this way by default. However,
2917 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2918 * and the like for different languages. This array provides a way to override
2919 * the default behavior.
2921 * @par Example:
2922 * To allow language-specific main page and community
2923 * portal:
2924 * @code
2925 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2926 * @endcode
2928 $wgForceUIMsgAsContentMsg = array();
2931 * Fake out the timezone that the server thinks it's in. This will be used for
2932 * date display and not for what's stored in the DB. Leave to null to retain
2933 * your server's OS-based timezone value.
2935 * This variable is currently used only for signature formatting and for local
2936 * time/date parser variables ({{LOCALTIME}} etc.)
2938 * Timezones can be translated by editing MediaWiki messages of type
2939 * timezone-nameinlowercase like timezone-utc.
2941 * A list of usable timezones can found at:
2942 * http://php.net/manual/en/timezones.php
2944 * @par Examples:
2945 * @code
2946 * $wgLocaltimezone = 'UTC';
2947 * $wgLocaltimezone = 'GMT';
2948 * $wgLocaltimezone = 'PST8PDT';
2949 * $wgLocaltimezone = 'Europe/Sweden';
2950 * $wgLocaltimezone = 'CET';
2951 * @endcode
2953 $wgLocaltimezone = null;
2956 * Set an offset from UTC in minutes to use for the default timezone setting
2957 * for anonymous users and new user accounts.
2959 * This setting is used for most date/time displays in the software, and is
2960 * overridable in user preferences. It is *not* used for signature timestamps.
2962 * By default, this will be set to match $wgLocaltimezone.
2964 $wgLocalTZoffset = null;
2966 /** @} */ # End of language/charset settings
2968 /*************************************************************************//**
2969 * @name Output format and skin settings
2970 * @{
2974 * The default Content-Type header.
2976 $wgMimeType = 'text/html';
2979 * Previously used as content type in HTML script tags. This is now ignored since
2980 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2981 * It was also previously used by RawAction to determine the ctype query parameter
2982 * value that will result in a javascript response.
2983 * @deprecated since 1.22
2985 $wgJsMimeType = null;
2988 * The default xmlns attribute. The option to define this has been removed.
2989 * The value of this variable is no longer used by core and is set to a fixed
2990 * value in Setup.php for compatibility with extensions that depend on the value
2991 * of this variable being set. Such a dependency however is deprecated.
2992 * @deprecated since 1.22
2994 $wgXhtmlDefaultNamespace = null;
2997 * Previously used to determine if we should output an HTML5 doctype.
2998 * This is no longer used as we always output HTML5 now. For compatibility with
2999 * extensions that still check the value of this config it's value is now forced
3000 * to true by Setup.php.
3001 * @deprecated since 1.22
3003 $wgHtml5 = true;
3006 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
3007 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
3008 * (like if it's left at the default null value), it will be auto-initialized
3009 * to the correct value for RDFa+HTML5. As such, you should have no reason to
3010 * ever actually set this to anything.
3012 $wgHtml5Version = null;
3015 * Temporary variable that allows HTMLForms to be rendered as tables.
3016 * Table based layouts cause various issues when designing for mobile.
3017 * This global allows skins or extensions a means to force non-table based rendering.
3018 * Setting to false forces form components to always render as div elements.
3019 * @since 1.24
3021 $wgHTMLFormAllowTableFormat = true;
3024 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3025 * Temporary variable that should be removed when mediawiki ui is more
3026 * stable and change has been communicated.
3027 * @since 1.24
3029 $wgUseMediaWikiUIEverywhere = false;
3032 * Enabled RDFa attributes for use in wikitext.
3033 * NOTE: Interaction with HTML5 is somewhat underspecified.
3035 $wgAllowRdfaAttributes = false;
3038 * Enabled HTML5 microdata attributes for use in wikitext.
3040 $wgAllowMicrodataAttributes = false;
3043 * Should we try to make our HTML output well-formed XML? If set to false,
3044 * output will be a few bytes shorter, and the HTML will arguably be more
3045 * readable. If set to true, life will be much easier for the authors of
3046 * screen-scraping bots, and the HTML will arguably be more readable.
3048 * Setting this to false may omit quotation marks on some attributes, omit
3049 * slashes from some self-closing tags, omit some ending tags, etc., where
3050 * permitted by HTML5. Setting it to true will not guarantee that all pages
3051 * will be well-formed, although non-well-formed pages should be rare and it's
3052 * a bug if you find one. Conversely, setting it to false doesn't mean that
3053 * all XML-y constructs will be omitted, just that they might be.
3055 * Because of compatibility with screen-scraping bots, and because it's
3056 * controversial, this is currently left to true by default.
3058 $wgWellFormedXml = true;
3061 * Permit other namespaces in addition to the w3.org default.
3063 * Use the prefix for the key and the namespace for the value.
3065 * @par Example:
3066 * @code
3067 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3068 * @endcode
3069 * Normally we wouldn't have to define this in the root "<html>"
3070 * element, but IE needs it there in some circumstances.
3072 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3074 $wgXhtmlNamespaces = array();
3077 * Show IP address, for non-logged in users. It's necessary to switch this off
3078 * for some forms of caching.
3079 * @warning Will disable file cache.
3081 $wgShowIPinHeader = true;
3084 * Site notice shown at the top of each page
3086 * MediaWiki:Sitenotice page, which will override this. You can also
3087 * provide a separate message for logged-out users using the
3088 * MediaWiki:Anonnotice page.
3090 $wgSiteNotice = '';
3093 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3095 $wgSiteSupportPage = '';
3098 * Validate the overall output using tidy and refuse
3099 * to display the page if it's not valid.
3101 $wgValidateAllHtml = false;
3104 * Default skin, for new users and anonymous visitors. Registered users may
3105 * change this to any one of the other available skins in their preferences.
3107 $wgDefaultSkin = 'vector';
3110 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3112 * @since 1.24
3114 $wgFallbackSkin = 'fallback';
3117 * Specify the names of skins that should not be presented in the list of
3118 * available skins in user preferences. If you want to remove a skin entirely,
3119 * remove it from the skins/ directory and its entry from LocalSettings.php.
3121 $wgSkipSkins = array();
3124 * @deprecated since 1.23; use $wgSkipSkins instead
3126 $wgSkipSkin = '';
3129 * Allow user Javascript page?
3130 * This enables a lot of neat customizations, but may
3131 * increase security risk to users and server load.
3133 $wgAllowUserJs = false;
3136 * Allow user Cascading Style Sheets (CSS)?
3137 * This enables a lot of neat customizations, but may
3138 * increase security risk to users and server load.
3140 $wgAllowUserCss = false;
3143 * Allow user-preferences implemented in CSS?
3144 * This allows users to customise the site appearance to a greater
3145 * degree; disabling it will improve page load times.
3147 $wgAllowUserCssPrefs = true;
3150 * Use the site's Javascript page?
3152 $wgUseSiteJs = true;
3155 * Use the site's Cascading Style Sheets (CSS)?
3157 $wgUseSiteCss = true;
3160 * Break out of framesets. This can be used to prevent clickjacking attacks,
3161 * or to prevent external sites from framing your site with ads.
3163 $wgBreakFrames = false;
3166 * The X-Frame-Options header to send on pages sensitive to clickjacking
3167 * attacks, such as edit pages. This prevents those pages from being displayed
3168 * in a frame or iframe. The options are:
3170 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3172 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3173 * to allow framing within a trusted domain. This is insecure if there
3174 * is a page on the same domain which allows framing of arbitrary URLs.
3176 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3177 * full compromise of local user accounts. Private wikis behind a
3178 * corporate firewall are especially vulnerable. This is not
3179 * recommended.
3181 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3182 * not just edit pages.
3184 $wgEditPageFrameOptions = 'DENY';
3187 * Disallow framing of API pages directly, by setting the X-Frame-Options
3188 * header. Since the API returns CSRF tokens, allowing the results to be
3189 * framed can compromise your user's account security.
3190 * Options are:
3191 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3192 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3193 * - false: Allow all framing.
3194 * Note: $wgBreakFrames will override this for human formatted API output.
3196 $wgApiFrameOptions = 'DENY';
3199 * Disable output compression (enabled by default if zlib is available)
3201 $wgDisableOutputCompression = false;
3204 * Should we allow a broader set of characters in id attributes, per HTML5? If
3205 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3206 * functionality is ready, it will be on by default with no option.
3208 * Currently this appears to work fine in all browsers, but it's disabled by
3209 * default because it normalizes id's a bit too aggressively, breaking preexisting
3210 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3212 $wgExperimentalHtmlIds = false;
3215 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3216 * You can add new icons to the built in copyright or poweredby, or you can create
3217 * a new block. Though note that you may need to add some custom css to get good styling
3218 * of new blocks in monobook. vector and modern should work without any special css.
3220 * $wgFooterIcons itself is a key/value array.
3221 * The key is the name of a block that the icons will be wrapped in. The final id varies
3222 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3223 * turns it into mw_poweredby.
3224 * The value is either key/value array of icons or a string.
3225 * In the key/value array the key may or may not be used by the skin but it can
3226 * be used to find the icon and unset it or change the icon if needed.
3227 * This is useful for disabling icons that are set by extensions.
3228 * The value should be either a string or an array. If it is a string it will be output
3229 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3230 * for the icon, the following keys are used:
3231 * - src: An absolute url to the image to use for the icon, this is recommended
3232 * but not required, however some skins will ignore icons without an image
3233 * - srcset: optional additional-resolution images; see HTML5 specs
3234 * - url: The url to use in the a element around the text or icon, if not set an a element will
3235 * not be outputted
3236 * - alt: This is the text form of the icon, it will be displayed without an image in
3237 * skins like Modern or if src is not set, and will otherwise be used as
3238 * the alt="" for the image. This key is required.
3239 * - width and height: If the icon specified by src is not of the standard size
3240 * you can specify the size of image to use with these keys.
3241 * Otherwise they will default to the standard 88x31.
3242 * @todo Reformat documentation.
3244 $wgFooterIcons = array(
3245 "copyright" => array(
3246 "copyright" => array(), // placeholder for the built in copyright icon
3248 "poweredby" => array(
3249 "mediawiki" => array(
3250 // Defaults to point at
3251 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3252 // plus srcset for 1.5x, 2x resolution variants.
3253 "src" => null,
3254 "url" => "//www.mediawiki.org/",
3255 "alt" => "Powered by MediaWiki",
3261 * Login / create account link behavior when it's possible for anonymous users
3262 * to create an account.
3263 * - true = use a combined login / create account link
3264 * - false = split login and create account into two separate links
3266 $wgUseCombinedLoginLink = false;
3269 * Display user edit counts in various prominent places.
3271 $wgEdititis = false;
3274 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3275 * status code, mangling or hiding MediaWiki's output. If you are using such a
3276 * host, you should start looking for a better one. While you're doing that,
3277 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3278 * that the generated error pages can be seen.
3280 * In cases where for technical reasons it is more important for MediaWiki to
3281 * send the correct status code than for the body to be transmitted intact,
3282 * this configuration variable is ignored.
3284 $wgSend404Code = true;
3287 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3288 * rollback. The numeric value of the variable are the limit up to are counted.
3289 * If the value is false or 0, the edits are not counted. Disabling this will
3290 * furthermore prevent MediaWiki from hiding some useless rollback links.
3292 * @since 1.20
3294 $wgShowRollbackEditCount = 10;
3297 * Output a <link rel="canonical"> tag on every page indicating the canonical
3298 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3299 * detection of the current server is unreliable, the link is sent
3300 * unconditionally.
3302 $wgEnableCanonicalServerLink = false;
3305 * When OutputHandler is used, mangle any output that contains
3306 * <cross-domain-policy>. Without this, an attacker can send their own
3307 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3308 * the domain root.
3310 * @since 1.25
3312 $wgMangleFlashPolicy = true;
3314 /** @} */ # End of output format settings }
3316 /*************************************************************************//**
3317 * @name Resource loader settings
3318 * @{
3322 * Client-side resource modules.
3324 * Extensions should add their resource loader module definitions
3325 * to the $wgResourceModules variable.
3327 * @par Example:
3328 * @code
3329 * $wgResourceModules['ext.myExtension'] = array(
3330 * 'scripts' => 'myExtension.js',
3331 * 'styles' => 'myExtension.css',
3332 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3333 * 'localBasePath' => __DIR__,
3334 * 'remoteExtPath' => 'MyExtension',
3335 * );
3336 * @endcode
3338 $wgResourceModules = array();
3341 * Skin-specific styles for resource modules.
3343 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3344 * not be modified or disabled.
3346 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3348 * @par Example:
3349 * @code
3350 * $wgResourceModules['bar'] = array(
3351 * 'scripts' => 'resources/bar/bar.js',
3352 * 'styles' => 'resources/bar/main.css',
3353 * );
3355 * $wgResourceModuleSkinStyles['foo'] = array(
3356 * 'bar' => 'skins/Foo/bar.css',
3357 * );
3358 * @endcode
3360 * This is mostly equivalent to:
3362 * @par Equivalent:
3363 * @code
3364 * $wgResourceModules['bar'] = array(
3365 * 'scripts' => 'resources/bar/bar.js',
3366 * 'styles' => 'resources/bar/main.css',
3367 * 'skinStyles' => array(
3368 * 'foo' => skins/Foo/bar.css',
3369 * ),
3370 * );
3371 * @endcode
3373 * If the module already defines its own entry in `skinStyles` for a given skin, then
3374 * $wgResourceModuleSkinStyles is ignored.
3376 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3377 * of replacing them. This can be done using the `+` prefix.
3379 * @par Example:
3380 * @code
3381 * $wgResourceModules['bar'] = array(
3382 * 'scripts' => 'resources/bar/bar.js',
3383 * 'styles' => 'resources/bar/basic.css',
3384 * 'skinStyles' => array(
3385 * 'default' => 'resources/bar/additional.css',
3386 * ),
3387 * );
3388 * // Note the '+' character:
3389 * $wgResourceModuleSkinStyles['foo'] = array(
3390 * '+bar' => 'skins/Foo/bar.css',
3391 * );
3392 * @endcode
3394 * This is mostly equivalent to:
3396 * @par Equivalent:
3397 * @code
3398 * $wgResourceModules['bar'] = array(
3399 * 'scripts' => 'resources/bar/bar.js',
3400 * 'styles' => 'resources/bar/basic.css',
3401 * 'skinStyles' => array(
3402 * 'default' => 'resources/bar/additional.css',
3403 * 'foo' => array(
3404 * 'resources/bar/additional.css',
3405 * 'skins/Foo/bar.css',
3406 * ),
3407 * ),
3408 * );
3409 * @endcode
3411 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3412 * disabled by a skin. To provide default styles that may be extended or replaced,
3413 * use `skinStyles['default']`.
3415 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3416 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3418 * @par Example:
3419 * @code
3420 * $wgResourceModuleSkinStyles['foo'] = array(
3421 * 'bar' => 'bar.css',
3422 * 'quux' => 'quux.css',
3423 * 'remoteSkinPath' => 'Foo',
3424 * 'localBasePath' => __DIR__,
3425 * );
3426 * @endcode
3428 $wgResourceModuleSkinStyles = array();
3431 * Extensions should register foreign module sources here. 'local' is a
3432 * built-in source that is not in this array, but defined by
3433 * ResourceLoader::__construct() so that it cannot be unset.
3435 * @par Example:
3436 * @code
3437 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3438 * @endcode
3440 $wgResourceLoaderSources = array();
3443 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3444 * If not set, then $wgScriptPath will be used as a fallback.
3446 $wgResourceBasePath = null;
3449 * Maximum time in seconds to cache resources served by the resource loader.
3450 * Used to set last modified headers (max-age/s-maxage).
3452 * Following options to distinguish:
3453 * - versioned: Used for modules with a version, because changing version
3454 * numbers causes cache misses. This normally has a long expiry time.
3455 * - unversioned: Used for modules without a version to propagate changes
3456 * quickly to clients. Also used for modules with errors to recover quickly.
3457 * This normally has a short expiry time.
3459 * Expiry time for the options to distinguish:
3460 * - server: Squid/Varnish but also any other public proxy cache between the
3461 * client and MediaWiki.
3462 * - client: On the client side (e.g. in the browser cache).
3464 $wgResourceLoaderMaxage = array(
3465 'versioned' => array(
3466 'server' => 30 * 24 * 60 * 60, // 30 days
3467 'client' => 30 * 24 * 60 * 60, // 30 days
3469 'unversioned' => array(
3470 'server' => 5 * 60, // 5 minutes
3471 'client' => 5 * 60, // 5 minutes
3476 * The default debug mode (on/off) for of ResourceLoader requests.
3478 * This will still be overridden when the debug URL parameter is used.
3480 $wgResourceLoaderDebug = false;
3483 * Enable embedding of certain resources using Edge Side Includes. This will
3484 * improve performance but only works if there is something in front of the
3485 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3487 $wgResourceLoaderUseESI = false;
3490 * Put each statement on its own line when minifying JavaScript. This makes
3491 * debugging in non-debug mode a bit easier.
3493 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3496 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3497 * the minifier will try not to produce lines longer than this, but may be
3498 * forced to do so in certain cases.
3500 $wgResourceLoaderMinifierMaxLineLength = 1000;
3503 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3504 * dependencies.
3506 $wgIncludeLegacyJavaScript = true;
3509 * Whether to preload the mediawiki.util module as blocking module in the top
3510 * queue.
3512 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3513 * allowed modules to lack dependencies on 'popular' modules that were likely
3514 * loaded already.
3516 * This setting is to aid scripts during migration by providing mediawiki.util
3517 * unconditionally (which was the most commonly missed dependency).
3518 * It doesn't cover all missing dependencies obviously but should fix most of
3519 * them.
3521 * This should be removed at some point after site/user scripts have been fixed.
3522 * Enable this if your wiki has a large amount of user/site scripts that are
3523 * lacking dependencies.
3524 * @todo Deprecate
3526 $wgPreloadJavaScriptMwUtil = false;
3529 * Whether or not to assign configuration variables to the global window object.
3531 * If this is set to false, old code using deprecated variables will no longer
3532 * work.
3534 * @par Example of legacy code:
3535 * @code{,js}
3536 * if ( window.wgRestrictionEdit ) { ... }
3537 * @endcode
3538 * or:
3539 * @code{,js}
3540 * if ( wgIsArticle ) { ... }
3541 * @endcode
3543 * Instead, one needs to use mw.config.
3544 * @par Example using mw.config global configuration:
3545 * @code{,js}
3546 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3547 * @endcode
3548 * or:
3549 * @code{,js}
3550 * if ( mw.config.get('wgIsArticle') ) { ... }
3551 * @endcode
3553 $wgLegacyJavaScriptGlobals = true;
3556 * If set to a positive number, ResourceLoader will not generate URLs whose
3557 * query string is more than this many characters long, and will instead use
3558 * multiple requests with shorter query strings. This degrades performance,
3559 * but may be needed if your web server has a low (less than, say 1024)
3560 * query string length limit or a low value for suhosin.get.max_value_length
3561 * that you can't increase.
3563 * If set to a negative number, ResourceLoader will assume there is no query
3564 * string length limit.
3566 * Defaults to a value based on php configuration.
3568 $wgResourceLoaderMaxQueryLength = false;
3571 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3572 * prior to minification to validate it.
3574 * Parse errors will result in a JS exception being thrown during module load,
3575 * which avoids breaking other modules loaded in the same request.
3577 $wgResourceLoaderValidateJS = true;
3580 * If set to true, statically-sourced (file-backed) JavaScript resources will
3581 * be parsed for validity before being bundled up into ResourceLoader modules.
3583 * This can be helpful for development by providing better error messages in
3584 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3585 * and may fail on large pre-bundled frameworks.
3587 $wgResourceLoaderValidateStaticJS = false;
3590 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3591 * will be enabled. This is an experimental feature that's supposed to make
3592 * JavaScript load faster.
3594 $wgResourceLoaderExperimentalAsyncLoading = false;
3597 * Global LESS variables. An associative array binding variable names to
3598 * LESS code snippets representing their values.
3600 * Adding an item here is equivalent to writing `@variable: value;`
3601 * at the beginning of all your .less files, with all the consequences.
3602 * In particular, string values must be escaped and quoted.
3604 * Changes to LESS variables do not trigger cache invalidation.
3606 * If the LESS variables need to be dynamic, you can use the
3607 * ResourceLoaderGetLessVars hook (since 1.25).
3609 * @par Example:
3610 * @code
3611 * $wgResourceLoaderLESSVars = array(
3612 * 'baseFontSize' => '1em',
3613 * 'smallFontSize' => '0.75em',
3614 * 'WikimediaBlue' => '#006699',
3615 * );
3616 * @endcode
3617 * @since 1.22
3619 $wgResourceLoaderLESSVars = array();
3622 * Custom LESS functions. An associative array mapping function name to PHP
3623 * callable.
3625 * Changes to LESS functions do not trigger cache invalidation.
3627 * @since 1.22
3628 * @deprecated since 1.24 Questionable usefulness and problematic to support,
3629 * will be removed in the future.
3631 $wgResourceLoaderLESSFunctions = array();
3634 * Default import paths for LESS modules. LESS files referenced in @import
3635 * statements will be looked up here first, and relative to the importing file
3636 * second. To avoid collisions, it's important for the LESS files in these
3637 * directories to have a common, predictable file name prefix.
3639 * Extensions need not (and should not) register paths in
3640 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3641 * currently compiling LESS file, which allows each extension to freely import
3642 * files from its own tree.
3644 * @since 1.22
3646 $wgResourceLoaderLESSImportPaths = array(
3647 "$IP/resources/src/mediawiki.less/",
3651 * Whether ResourceLoader should attempt to persist modules in localStorage on
3652 * browsers that support the Web Storage API.
3654 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3656 $wgResourceLoaderStorageEnabled = false;
3659 * Cache version for client-side ResourceLoader module storage. You can trigger
3660 * invalidation of the contents of the module store by incrementing this value.
3662 * @since 1.23
3664 $wgResourceLoaderStorageVersion = 1;
3667 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3668 * restricted pages like Special:UserLogin or Special:Preferences where
3669 * JavaScript is disabled for security reasons. As it is possible to
3670 * execute JavaScript through CSS, setting this to true opens up a
3671 * potential security hole. Some sites may "skin" their wiki by using
3672 * site-wide CSS, causing restricted pages to look unstyled and different
3673 * from the rest of the site.
3675 * @since 1.25
3677 $wgAllowSiteCSSOnRestrictedPages = false;
3679 /** @} */ # End of resource loader settings }
3681 /*************************************************************************//**
3682 * @name Page title and interwiki link settings
3683 * @{
3687 * Name of the project namespace. If left set to false, $wgSitename will be
3688 * used instead.
3690 $wgMetaNamespace = false;
3693 * Name of the project talk namespace.
3695 * Normally you can ignore this and it will be something like
3696 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3697 * manually for grammatical reasons.
3699 $wgMetaNamespaceTalk = false;
3702 * Additional namespaces. If the namespaces defined in Language.php and
3703 * Namespace.php are insufficient, you can create new ones here, for example,
3704 * to import Help files in other languages. You can also override the namespace
3705 * names of existing namespaces. Extensions developers should use
3706 * $wgCanonicalNamespaceNames.
3708 * @warning Once you delete a namespace, the pages in that namespace will
3709 * no longer be accessible. If you rename it, then you can access them through
3710 * the new namespace name.
3712 * Custom namespaces should start at 100 to avoid conflicting with standard
3713 * namespaces, and should always follow the even/odd main/talk pattern.
3715 * @par Example:
3716 * @code
3717 * $wgExtraNamespaces = array(
3718 * 100 => "Hilfe",
3719 * 101 => "Hilfe_Diskussion",
3720 * 102 => "Aide",
3721 * 103 => "Discussion_Aide"
3722 * );
3723 * @endcode
3725 * @todo Add a note about maintenance/namespaceDupes.php
3727 $wgExtraNamespaces = array();
3730 * Same as above, but for namespaces with gender distinction.
3731 * Note: the default form for the namespace should also be set
3732 * using $wgExtraNamespaces for the same index.
3733 * @since 1.18
3735 $wgExtraGenderNamespaces = array();
3738 * Namespace aliases.
3740 * These are alternate names for the primary localised namespace names, which
3741 * are defined by $wgExtraNamespaces and the language file. If a page is
3742 * requested with such a prefix, the request will be redirected to the primary
3743 * name.
3745 * Set this to a map from namespace names to IDs.
3747 * @par Example:
3748 * @code
3749 * $wgNamespaceAliases = array(
3750 * 'Wikipedian' => NS_USER,
3751 * 'Help' => 100,
3752 * );
3753 * @endcode
3755 $wgNamespaceAliases = array();
3758 * Allowed title characters -- regex character class
3759 * Don't change this unless you know what you're doing
3761 * Problematic punctuation:
3762 * - []{}|# Are needed for link syntax, never enable these
3763 * - <> Causes problems with HTML escaping, don't use
3764 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3765 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3766 * corrupted by apache
3767 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3769 * All three of these punctuation problems can be avoided by using an alias,
3770 * instead of a rewrite rule of either variety.
3772 * The problem with % is that when using a path to query rewrite rule, URLs are
3773 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3774 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3775 * for this, indeed double escaping would break if the double-escaped title was
3776 * passed in the query string rather than the path. This is a minor security issue
3777 * because articles can be created such that they are hard to view or edit.
3779 * In some rare cases you may wish to remove + for compatibility with old links.
3781 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3782 * this breaks interlanguage links
3784 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3787 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3789 * @deprecated since 1.23; use $wgLocalInterwikis instead
3791 $wgLocalInterwiki = false;
3794 * Array for multiple $wgLocalInterwiki values, in case there are several
3795 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3796 * set, its value is prepended to this array, for backwards compatibility.
3798 * Note, recent changes feeds use only the first entry in this array (or
3799 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3801 $wgLocalInterwikis = array();
3804 * Expiry time for cache of interwiki table
3806 $wgInterwikiExpiry = 10800;
3809 * @name Interwiki caching settings.
3810 * @{
3814 *$wgInterwikiCache specifies path to constant database file.
3816 * This cdb database is generated by dumpInterwiki from maintenance and has
3817 * such key formats:
3818 * - dbname:key - a simple key (e.g. enwiki:meta)
3819 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3820 * - __global:key - global-scope key (e.g. __global:meta)
3821 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3823 * Sites mapping just specifies site name, other keys provide "local url"
3824 * data layout.
3826 $wgInterwikiCache = false;
3829 * Specify number of domains to check for messages.
3830 * - 1: Just wiki(db)-level
3831 * - 2: wiki and global levels
3832 * - 3: site levels
3834 $wgInterwikiScopes = 3;
3837 * Fallback site, if unable to resolve from cache
3839 $wgInterwikiFallbackSite = 'wiki';
3841 /** @} */ # end of Interwiki caching settings.
3844 * @name SiteStore caching settings.
3845 * @{
3849 * Specify the file location for the Sites json cache file.
3851 $wgSitesCacheFile = false;
3853 /** @} */ # end of SiteStore caching settings.
3856 * If local interwikis are set up which allow redirects,
3857 * set this regexp to restrict URLs which will be displayed
3858 * as 'redirected from' links.
3860 * @par Example:
3861 * It might look something like this:
3862 * @code
3863 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3864 * @endcode
3866 * Leave at false to avoid displaying any incoming redirect markers.
3867 * This does not affect intra-wiki redirects, which don't change
3868 * the URL.
3870 $wgRedirectSources = false;
3873 * Set this to false to avoid forcing the first letter of links to capitals.
3875 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3876 * appearing with a capital at the beginning of a sentence will *not* go to the
3877 * same place as links in the middle of a sentence using a lowercase initial.
3879 $wgCapitalLinks = true;
3882 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3883 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3884 * true by default (and setting them has no effect), due to various things that
3885 * require them to be so. Also, since Talk namespaces need to directly mirror their
3886 * associated content namespaces, the values for those are ignored in favor of the
3887 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3888 * NS_FILE.
3890 * @par Example:
3891 * @code
3892 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3893 * @endcode
3895 $wgCapitalLinkOverrides = array();
3898 * Which namespaces should support subpages?
3899 * See Language.php for a list of namespaces.
3901 $wgNamespacesWithSubpages = array(
3902 NS_TALK => true,
3903 NS_USER => true,
3904 NS_USER_TALK => true,
3905 NS_PROJECT => true,
3906 NS_PROJECT_TALK => true,
3907 NS_FILE_TALK => true,
3908 NS_MEDIAWIKI => true,
3909 NS_MEDIAWIKI_TALK => true,
3910 NS_TEMPLATE_TALK => true,
3911 NS_HELP => true,
3912 NS_HELP_TALK => true,
3913 NS_CATEGORY_TALK => true
3917 * Array holding default tracking category names.
3919 * Array contains the system messages for each tracking category.
3920 * Tracking categories allow pages with certain characteristics to be tracked.
3921 * It works by adding any such page to a category automatically.
3923 * A message with the suffix '-desc' should be added as a description message
3924 * to have extra information on Special:TrackingCategories.
3926 * @deprecated since 1.25 Extensions should now register tracking categories using
3927 * the new extension registration system.
3929 * @since 1.23
3931 $wgTrackingCategories = array();
3934 * Array of namespaces which can be deemed to contain valid "content", as far
3935 * as the site statistics are concerned. Useful if additional namespaces also
3936 * contain "content" which should be considered when generating a count of the
3937 * number of articles in the wiki.
3939 $wgContentNamespaces = array( NS_MAIN );
3942 * Max number of redirects to follow when resolving redirects.
3943 * 1 means only the first redirect is followed (default behavior).
3944 * 0 or less means no redirects are followed.
3946 $wgMaxRedirects = 1;
3949 * Array of invalid page redirect targets.
3950 * Attempting to create a redirect to any of the pages in this array
3951 * will make the redirect fail.
3952 * Userlogout is hard-coded, so it does not need to be listed here.
3953 * (bug 10569) Disallow Mypage and Mytalk as well.
3955 * As of now, this only checks special pages. Redirects to pages in
3956 * other namespaces cannot be invalidated by this variable.
3958 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3960 /** @} */ # End of title and interwiki settings }
3962 /************************************************************************//**
3963 * @name Parser settings
3964 * These settings configure the transformation from wikitext to HTML.
3965 * @{
3969 * Parser configuration. Associative array with the following members:
3971 * class The class name
3973 * preprocessorClass The preprocessor class. Two classes are currently available:
3974 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3975 * storage, and Preprocessor_DOM, which uses the DOM module for
3976 * temporary storage. Preprocessor_DOM generally uses less memory;
3977 * the speed of the two is roughly the same.
3979 * If this parameter is not given, it uses Preprocessor_DOM if the
3980 * DOM module is available, otherwise it uses Preprocessor_Hash.
3982 * The entire associative array will be passed through to the constructor as
3983 * the first parameter. Note that only Setup.php can use this variable --
3984 * the configuration will change at runtime via $wgParser member functions, so
3985 * the contents of this variable will be out-of-date. The variable can only be
3986 * changed during LocalSettings.php, in particular, it can't be changed during
3987 * an extension setup function.
3989 $wgParserConf = array(
3990 'class' => 'Parser',
3991 #'preprocessorClass' => 'Preprocessor_Hash',
3995 * Maximum indent level of toc.
3997 $wgMaxTocLevel = 999;
4000 * A complexity limit on template expansion: the maximum number of nodes visited
4001 * by PPFrame::expand()
4003 $wgMaxPPNodeCount = 1000000;
4006 * A complexity limit on template expansion: the maximum number of elements
4007 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4008 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4009 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4010 * this default corresponds to about 155 MB.
4012 * When the limit is exceeded, an exception is thrown.
4014 $wgMaxGeneratedPPNodeCount = 1000000;
4017 * Maximum recursion depth for templates within templates.
4018 * The current parser adds two levels to the PHP call stack for each template,
4019 * and xdebug limits the call stack to 100 by default. So this should hopefully
4020 * stop the parser before it hits the xdebug limit.
4022 $wgMaxTemplateDepth = 40;
4025 * @see $wgMaxTemplateDepth
4027 $wgMaxPPExpandDepth = 40;
4030 * URL schemes that should be recognized as valid by wfParseUrl().
4032 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4033 * Instead, if you want to support file links, add 'file://'. The same applies
4034 * to any other protocols with the same name as a namespace. See bug #44011 for
4035 * more information.
4037 * @see wfParseUrl
4039 $wgUrlProtocols = array(
4040 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4041 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4042 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4043 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4047 * If true, removes (by substituting) templates in signatures.
4049 $wgCleanSignatures = true;
4052 * Whether to allow inline image pointing to other websites
4054 $wgAllowExternalImages = false;
4057 * If the above is false, you can specify an exception here. Image URLs
4058 * that start with this string are then rendered, while all others are not.
4059 * You can use this to set up a trusted, simple repository of images.
4060 * You may also specify an array of strings to allow multiple sites
4062 * @par Examples:
4063 * @code
4064 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4065 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4066 * @endcode
4068 $wgAllowExternalImagesFrom = '';
4071 * If $wgAllowExternalImages is false, you can allow an on-wiki
4072 * whitelist of regular expression fragments to match the image URL
4073 * against. If the image matches one of the regular expression fragments,
4074 * The image will be displayed.
4076 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4077 * Or false to disable it
4079 $wgEnableImageWhitelist = true;
4082 * A different approach to the above: simply allow the "<img>" tag to be used.
4083 * This allows you to specify alt text and other attributes, copy-paste HTML to
4084 * your wiki more easily, etc. However, allowing external images in any manner
4085 * will allow anyone with editing rights to snoop on your visitors' IP
4086 * addresses and so forth, if they wanted to, by inserting links to images on
4087 * sites they control.
4089 $wgAllowImageTag = false;
4092 * $wgUseTidy: use tidy to make sure HTML output is sane.
4093 * Tidy is a free tool that fixes broken HTML.
4094 * See http://www.w3.org/People/Raggett/tidy/
4096 * - $wgTidyBin should be set to the path of the binary and
4097 * - $wgTidyConf to the path of the configuration file.
4098 * - $wgTidyOpts can include any number of parameters.
4099 * - $wgTidyInternal controls the use of the PECL extension or the
4100 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
4101 * of spawning a separate program.
4102 * Normally you shouldn't need to override the setting except for
4103 * debugging. To install, use 'pear install tidy' and add a line
4104 * 'extension=tidy.so' to php.ini.
4106 $wgUseTidy = false;
4109 * @see $wgUseTidy
4111 $wgAlwaysUseTidy = false;
4114 * @see $wgUseTidy
4116 $wgTidyBin = 'tidy';
4119 * @see $wgUseTidy
4121 $wgTidyConf = $IP . '/includes/tidy.conf';
4124 * @see $wgUseTidy
4126 $wgTidyOpts = '';
4129 * @see $wgUseTidy
4131 $wgTidyInternal = extension_loaded( 'tidy' );
4134 * Put tidy warnings in HTML comments
4135 * Only works for internal tidy.
4137 $wgDebugTidy = false;
4140 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4141 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4142 * TO RESTRICT EDITING to only those that you trust
4144 $wgRawHtml = false;
4147 * Set a default target for external links, e.g. _blank to pop up a new window
4149 $wgExternalLinkTarget = false;
4152 * If true, external URL links in wiki text will be given the
4153 * rel="nofollow" attribute as a hint to search engines that
4154 * they should not be followed for ranking purposes as they
4155 * are user-supplied and thus subject to spamming.
4157 $wgNoFollowLinks = true;
4160 * Namespaces in which $wgNoFollowLinks doesn't apply.
4161 * See Language.php for a list of namespaces.
4163 $wgNoFollowNsExceptions = array();
4166 * If this is set to an array of domains, external links to these domain names
4167 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4168 * value of $wgNoFollowLinks. For instance:
4170 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4171 * 'mediawiki.org' );
4173 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4174 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4175 * etc.
4177 * Defaults to mediawiki.org for the links included in the software by default.
4179 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4182 * Allow DISPLAYTITLE to change title display
4184 $wgAllowDisplayTitle = true;
4187 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4188 * canonical DB key. Also disallow some inline CSS rules like display: none;
4189 * which can cause the text to be hidden or unselectable.
4191 $wgRestrictDisplayTitle = true;
4194 * Maximum number of calls per parse to expensive parser functions such as
4195 * PAGESINCATEGORY.
4197 $wgExpensiveParserFunctionLimit = 100;
4200 * Preprocessor caching threshold
4201 * Setting it to 'false' will disable the preprocessor cache.
4203 $wgPreprocessorCacheThreshold = 1000;
4206 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4208 $wgEnableScaryTranscluding = false;
4211 * Expiry time for transcluded templates cached in transcache database table.
4212 * Only used $wgEnableInterwikiTranscluding is set to true.
4214 $wgTranscludeCacheExpiry = 3600;
4216 /** @} */ # end of parser settings }
4218 /************************************************************************//**
4219 * @name Statistics
4220 * @{
4224 * Method used to determine if a page in a content namespace should be counted
4225 * as a valid article.
4227 * Redirect pages will never be counted as valid articles.
4229 * This variable can have the following values:
4230 * - 'any': all pages as considered as valid articles
4231 * - 'comma': the page must contain a comma to be considered valid
4232 * - 'link': the page must contain a [[wiki link]] to be considered valid
4234 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4236 * Retroactively changing this variable will not affect the existing count,
4237 * to update it, you will need to run the maintenance/updateArticleCount.php
4238 * script.
4240 $wgArticleCountMethod = 'link';
4243 * How many days user must be idle before he is considered inactive. Will affect
4244 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4245 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4246 * You might want to leave this as the default value, to provide comparable
4247 * numbers between different wikis.
4249 $wgActiveUserDays = 30;
4251 /** @} */ # End of statistics }
4253 /************************************************************************//**
4254 * @name User accounts, authentication
4255 * @{
4259 * For compatibility with old installations set to false
4260 * @deprecated since 1.24 will be removed in future
4262 $wgPasswordSalt = true;
4265 * Specifies the minimal length of a user password. If set to 0, empty pass-
4266 * words are allowed.
4268 $wgMinimalPasswordLength = 1;
4271 * Specifies the maximal length of a user password (T64685).
4273 * It is not recommended to make this greater than the default, as it can
4274 * allow DoS attacks by users setting really long passwords. In addition,
4275 * this should not be lowered too much, as it enforces weak passwords.
4277 * @warning Unlike other password settings, user with passwords greater than
4278 * the maximum will not be able to log in.
4280 $wgMaximalPasswordLength = 4096;
4283 * Specifies if users should be sent to a password-reset form on login, if their
4284 * password doesn't meet the requirements of User::isValidPassword().
4285 * @since 1.23
4287 $wgInvalidPasswordReset = true;
4290 * Default password type to use when hashing user passwords
4292 * @since 1.24
4294 $wgPasswordDefault = 'pbkdf2';
4297 * Configuration for built-in password types. Maps the password type
4298 * to an array of options. The 'class' option is the Password class to
4299 * use. All other options are class-dependent.
4301 * An advanced example:
4302 * @code
4303 * $wgPasswordConfig['bcrypt-peppered'] = array(
4304 * 'class' => 'EncryptedPassword',
4305 * 'underlying' => 'bcrypt',
4306 * 'secrets' => array(),
4307 * 'cipher' => MCRYPT_RIJNDAEL_256,
4308 * 'mode' => MCRYPT_MODE_CBC,
4309 * 'cost' => 5,
4310 * );
4311 * @endcode
4313 * @since 1.24
4315 $wgPasswordConfig = array(
4316 'A' => array(
4317 'class' => 'MWOldPassword',
4319 'B' => array(
4320 'class' => 'MWSaltedPassword',
4322 'pbkdf2-legacyA' => array(
4323 'class' => 'LayeredParameterizedPassword',
4324 'types' => array(
4325 'A',
4326 'pbkdf2',
4329 'pbkdf2-legacyB' => array(
4330 'class' => 'LayeredParameterizedPassword',
4331 'types' => array(
4332 'B',
4333 'pbkdf2',
4336 'bcrypt' => array(
4337 'class' => 'BcryptPassword',
4338 'cost' => 9,
4340 'pbkdf2' => array(
4341 'class' => 'Pbkdf2Password',
4342 'algo' => 'sha256',
4343 'cost' => '10000',
4344 'length' => '128',
4349 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4350 * with a temporary password you can use to get back into the account") identified by
4351 * various bits of data. Setting all of these to false (or the whole variable to false)
4352 * has the effect of disabling password resets entirely
4354 $wgPasswordResetRoutes = array(
4355 'username' => true,
4356 'email' => false,
4360 * Maximum number of Unicode characters in signature
4362 $wgMaxSigChars = 255;
4365 * Maximum number of bytes in username. You want to run the maintenance
4366 * script ./maintenance/checkUsernames.php once you have changed this value.
4368 $wgMaxNameChars = 255;
4371 * Array of usernames which may not be registered or logged in from
4372 * Maintenance scripts can still use these
4374 $wgReservedUsernames = array(
4375 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4376 'Conversion script', // Used for the old Wikipedia software upgrade
4377 'Maintenance script', // Maintenance scripts which perform editing, image import script
4378 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4379 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4380 'msg:double-redirect-fixer', // Automatic double redirect fix
4381 'msg:usermessage-editor', // Default user for leaving user messages
4382 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4383 'msg:spambot_username', // Used by cleanupSpam.php
4387 * Settings added to this array will override the default globals for the user
4388 * preferences used by anonymous visitors and newly created accounts.
4389 * For instance, to disable editing on double clicks:
4390 * $wgDefaultUserOptions ['editondblclick'] = 0;
4392 $wgDefaultUserOptions = array(
4393 'ccmeonemails' => 0,
4394 'cols' => 80,
4395 'date' => 'default',
4396 'diffonly' => 0,
4397 'disablemail' => 0,
4398 'editfont' => 'default',
4399 'editondblclick' => 0,
4400 'editsectiononrightclick' => 0,
4401 'enotifminoredits' => 0,
4402 'enotifrevealaddr' => 0,
4403 'enotifusertalkpages' => 1,
4404 'enotifwatchlistpages' => 1,
4405 'extendwatchlist' => 1,
4406 'fancysig' => 0,
4407 'forceeditsummary' => 0,
4408 'gender' => 'unknown',
4409 'hideminor' => 0,
4410 'hidepatrolled' => 0,
4411 'imagesize' => 2,
4412 'math' => 1,
4413 'minordefault' => 0,
4414 'newpageshidepatrolled' => 0,
4415 'nickname' => '',
4416 'norollbackdiff' => 0,
4417 'numberheadings' => 0,
4418 'previewonfirst' => 0,
4419 'previewontop' => 1,
4420 'rcdays' => 7,
4421 'rclimit' => 50,
4422 'rows' => 25,
4423 'showhiddencats' => 0,
4424 'shownumberswatching' => 1,
4425 'showtoolbar' => 1,
4426 'skin' => false,
4427 'stubthreshold' => 0,
4428 'thumbsize' => 5,
4429 'underline' => 2,
4430 'uselivepreview' => 0,
4431 'usenewrc' => 1,
4432 'watchcreations' => 1,
4433 'watchdefault' => 1,
4434 'watchdeletion' => 0,
4435 'watchlistdays' => 3.0,
4436 'watchlisthideanons' => 0,
4437 'watchlisthidebots' => 0,
4438 'watchlisthideliu' => 0,
4439 'watchlisthideminor' => 0,
4440 'watchlisthideown' => 0,
4441 'watchlisthidepatrolled' => 0,
4442 'watchmoves' => 0,
4443 'watchrollback' => 0,
4444 'wllimit' => 250,
4445 'useeditwarning' => 1,
4446 'prefershttps' => 1,
4450 * An array of preferences to not show for the user
4452 $wgHiddenPrefs = array();
4455 * Characters to prevent during new account creations.
4456 * This is used in a regular expression character class during
4457 * registration (regex metacharacters like / are escaped).
4459 $wgInvalidUsernameCharacters = '@:';
4462 * Character used as a delimiter when testing for interwiki userrights
4463 * (In Special:UserRights, it is possible to modify users on different
4464 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4466 * It is recommended that you have this delimiter in
4467 * $wgInvalidUsernameCharacters above, or you will not be able to
4468 * modify the user rights of those users via Special:UserRights
4470 $wgUserrightsInterwikiDelimiter = '@';
4473 * This is to let user authenticate using https when they come from http.
4474 * Based on an idea by George Herbert on wikitech-l:
4475 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4476 * @since 1.17
4478 $wgSecureLogin = false;
4480 /** @} */ # end user accounts }
4482 /************************************************************************//**
4483 * @name User rights, access control and monitoring
4484 * @{
4488 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4490 $wgAutoblockExpiry = 86400;
4493 * Set this to true to allow blocked users to edit their own user talk page.
4495 $wgBlockAllowsUTEdit = false;
4498 * Allow sysops to ban users from accessing Emailuser
4500 $wgSysopEmailBans = true;
4503 * Limits on the possible sizes of range blocks.
4505 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4506 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4507 * half the number of bits avoids such errors, and allows entire ISPs to be
4508 * blocked using a small number of range blocks.
4510 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4511 * customer, so range blocks larger than /64 (half the number of bits) will
4512 * plainly be required. RFC 4692 implies that a very large ISP may be
4513 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4514 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4516 $wgBlockCIDRLimit = array(
4517 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4518 'IPv6' => 19,
4522 * If true, blocked users will not be allowed to login. When using this with
4523 * a public wiki, the effect of logging out blocked users may actually be
4524 * avers: unless the user's address is also blocked (e.g. auto-block),
4525 * logging the user out will again allow reading and editing, just as for
4526 * anonymous visitors.
4528 $wgBlockDisablesLogin = false;
4531 * Pages anonymous user may see, set as an array of pages titles.
4533 * @par Example:
4534 * @code
4535 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4536 * @endcode
4538 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4540 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4541 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4543 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4544 * will remain readable. You can use img_auth.php to protect uploaded files,
4545 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4547 $wgWhitelistRead = false;
4550 * Pages anonymous user may see, set as an array of regular expressions.
4552 * This function will match the regexp against the title name, which
4553 * is without underscore.
4555 * @par Example:
4556 * To whitelist [[Main Page]]:
4557 * @code
4558 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4559 * @endcode
4561 * @note Unless ^ and/or $ is specified, a regular expression might match
4562 * pages not intended to be whitelisted. The above example will also
4563 * whitelist a page named 'Security Main Page'.
4565 * @par Example:
4566 * To allow reading any page starting with 'User' regardless of the case:
4567 * @code
4568 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4569 * @endcode
4570 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4572 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4573 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4575 $wgWhitelistReadRegexp = false;
4578 * Should editors be required to have a validated e-mail
4579 * address before being allowed to edit?
4581 $wgEmailConfirmToEdit = false;
4584 * Permission keys given to users in each group.
4586 * This is an array where the keys are all groups and each value is an
4587 * array of the format (right => boolean).
4589 * The second format is used to support per-namespace permissions.
4590 * Note that this feature does not fully work for all permission types.
4592 * All users are implicitly in the '*' group including anonymous visitors;
4593 * logged-in users are all implicitly in the 'user' group. These will be
4594 * combined with the permissions of all groups that a given user is listed
4595 * in in the user_groups table.
4597 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4598 * doing! This will wipe all permissions, and may mean that your users are
4599 * unable to perform certain essential tasks or access new functionality
4600 * when new permissions are introduced and default grants established.
4602 * Functionality to make pages inaccessible has not been extensively tested
4603 * for security. Use at your own risk!
4605 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4607 $wgGroupPermissions = array();
4609 /** @cond file_level_code */
4610 // Implicit group for all visitors
4611 $wgGroupPermissions['*']['createaccount'] = true;
4612 $wgGroupPermissions['*']['read'] = true;
4613 $wgGroupPermissions['*']['edit'] = true;
4614 $wgGroupPermissions['*']['createpage'] = true;
4615 $wgGroupPermissions['*']['createtalk'] = true;
4616 $wgGroupPermissions['*']['writeapi'] = true;
4617 $wgGroupPermissions['*']['editmyusercss'] = true;
4618 $wgGroupPermissions['*']['editmyuserjs'] = true;
4619 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4620 $wgGroupPermissions['*']['editmywatchlist'] = true;
4621 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4622 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4623 $wgGroupPermissions['*']['editmyoptions'] = true;
4624 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4626 // Implicit group for all logged-in accounts
4627 $wgGroupPermissions['user']['move'] = true;
4628 $wgGroupPermissions['user']['move-subpages'] = true;
4629 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4630 $wgGroupPermissions['user']['move-categorypages'] = true;
4631 $wgGroupPermissions['user']['movefile'] = true;
4632 $wgGroupPermissions['user']['read'] = true;
4633 $wgGroupPermissions['user']['edit'] = true;
4634 $wgGroupPermissions['user']['createpage'] = true;
4635 $wgGroupPermissions['user']['createtalk'] = true;
4636 $wgGroupPermissions['user']['writeapi'] = true;
4637 $wgGroupPermissions['user']['upload'] = true;
4638 $wgGroupPermissions['user']['reupload'] = true;
4639 $wgGroupPermissions['user']['reupload-shared'] = true;
4640 $wgGroupPermissions['user']['minoredit'] = true;
4641 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4642 $wgGroupPermissions['user']['sendemail'] = true;
4643 $wgGroupPermissions['user']['applychangetags'] = true;
4644 $wgGroupPermissions['user']['changetags'] = true;
4646 // Implicit group for accounts that pass $wgAutoConfirmAge
4647 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4648 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4650 // Users with bot privilege can have their edits hidden
4651 // from various log pages by default
4652 $wgGroupPermissions['bot']['bot'] = true;
4653 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4654 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4655 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4656 $wgGroupPermissions['bot']['autopatrol'] = true;
4657 $wgGroupPermissions['bot']['suppressredirect'] = true;
4658 $wgGroupPermissions['bot']['apihighlimits'] = true;
4659 $wgGroupPermissions['bot']['writeapi'] = true;
4661 // Most extra permission abilities go to this group
4662 $wgGroupPermissions['sysop']['block'] = true;
4663 $wgGroupPermissions['sysop']['createaccount'] = true;
4664 $wgGroupPermissions['sysop']['delete'] = true;
4665 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4666 $wgGroupPermissions['sysop']['bigdelete'] = true;
4667 // can view deleted history entries, but not see or restore the text
4668 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4669 // can view deleted revision text
4670 $wgGroupPermissions['sysop']['deletedtext'] = true;
4671 $wgGroupPermissions['sysop']['undelete'] = true;
4672 $wgGroupPermissions['sysop']['editinterface'] = true;
4673 $wgGroupPermissions['sysop']['editusercss'] = true;
4674 $wgGroupPermissions['sysop']['edituserjs'] = true;
4675 $wgGroupPermissions['sysop']['import'] = true;
4676 $wgGroupPermissions['sysop']['importupload'] = true;
4677 $wgGroupPermissions['sysop']['move'] = true;
4678 $wgGroupPermissions['sysop']['move-subpages'] = true;
4679 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4680 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4681 $wgGroupPermissions['sysop']['patrol'] = true;
4682 $wgGroupPermissions['sysop']['autopatrol'] = true;
4683 $wgGroupPermissions['sysop']['protect'] = true;
4684 $wgGroupPermissions['sysop']['editprotected'] = true;
4685 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4686 $wgGroupPermissions['sysop']['rollback'] = true;
4687 $wgGroupPermissions['sysop']['upload'] = true;
4688 $wgGroupPermissions['sysop']['reupload'] = true;
4689 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4690 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4691 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4692 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4693 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4694 $wgGroupPermissions['sysop']['blockemail'] = true;
4695 $wgGroupPermissions['sysop']['markbotedits'] = true;
4696 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4697 $wgGroupPermissions['sysop']['browsearchive'] = true;
4698 $wgGroupPermissions['sysop']['noratelimit'] = true;
4699 $wgGroupPermissions['sysop']['movefile'] = true;
4700 $wgGroupPermissions['sysop']['unblockself'] = true;
4701 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4702 #$wgGroupPermissions['sysop']['pagelang'] = true;
4703 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4704 $wgGroupPermissions['sysop']['mergehistory'] = true;
4705 $wgGroupPermissions['sysop']['managechangetags'] = true;
4707 // Permission to change users' group assignments
4708 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4709 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4710 // Permission to change users' groups assignments across wikis
4711 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4712 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4713 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4715 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4716 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4717 // To hide usernames from users and Sysops
4718 #$wgGroupPermissions['suppress']['hideuser'] = true;
4719 // To hide revisions/log items from users and Sysops
4720 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4721 // To view revisions/log items hidden from users and Sysops
4722 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4723 // For private suppression log access
4724 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4727 * The developer group is deprecated, but can be activated if need be
4728 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4729 * that a lock file be defined and creatable/removable by the web
4730 * server.
4732 # $wgGroupPermissions['developer']['siteadmin'] = true;
4734 /** @endcond */
4737 * Permission keys revoked from users in each group.
4739 * This acts the same way as wgGroupPermissions above, except that
4740 * if the user is in a group here, the permission will be removed from them.
4742 * Improperly setting this could mean that your users will be unable to perform
4743 * certain essential tasks, so use at your own risk!
4745 $wgRevokePermissions = array();
4748 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4750 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4753 * A map of group names that the user is in, to group names that those users
4754 * are allowed to add or revoke.
4756 * Setting the list of groups to add or revoke to true is equivalent to "any
4757 * group".
4759 * @par Example:
4760 * To allow sysops to add themselves to the "bot" group:
4761 * @code
4762 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4763 * @endcode
4765 * @par Example:
4766 * Implicit groups may be used for the source group, for instance:
4767 * @code
4768 * $wgGroupsRemoveFromSelf = array( '*' => true );
4769 * @endcode
4770 * This allows users in the '*' group (i.e. any user) to remove themselves from
4771 * any group that they happen to be in.
4773 $wgGroupsAddToSelf = array();
4776 * @see $wgGroupsAddToSelf
4778 $wgGroupsRemoveFromSelf = array();
4781 * Set of available actions that can be restricted via action=protect
4782 * You probably shouldn't change this.
4783 * Translated through restriction-* messages.
4784 * Title::getRestrictionTypes() will remove restrictions that are not
4785 * applicable to a specific title (create and upload)
4787 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4790 * Rights which can be required for each protection level (via action=protect)
4792 * You can add a new protection level that requires a specific
4793 * permission by manipulating this array. The ordering of elements
4794 * dictates the order on the protection form's lists.
4796 * - '' will be ignored (i.e. unprotected)
4797 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4798 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4800 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4803 * Restriction levels that can be used with cascading protection
4805 * A page can only be protected with cascading protection if the
4806 * requested restriction level is included in this array.
4808 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4809 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4811 $wgCascadingRestrictionLevels = array( 'sysop' );
4814 * Restriction levels that should be considered "semiprotected"
4816 * Certain places in the interface recognize a dichotomy between "protected"
4817 * and "semiprotected", without further distinguishing the specific levels. In
4818 * general, if anyone can be eligible to edit a protection level merely by
4819 * reaching some condition in $wgAutopromote, it should probably be considered
4820 * "semiprotected".
4822 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4823 * 'sysop' is not changed, since it really shouldn't be here.
4825 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4828 * Set the minimum permissions required to edit pages in each
4829 * namespace. If you list more than one permission, a user must
4830 * have all of them to edit pages in that namespace.
4832 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4834 $wgNamespaceProtection = array();
4837 * Pages in namespaces in this array can not be used as templates.
4839 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4840 * namespaces constants (NS_USER, NS_MAIN...).
4842 * Among other things, this may be useful to enforce read-restrictions
4843 * which may otherwise be bypassed by using the template mechanism.
4845 $wgNonincludableNamespaces = array();
4848 * Number of seconds an account is required to age before it's given the
4849 * implicit 'autoconfirm' group membership. This can be used to limit
4850 * privileges of new accounts.
4852 * Accounts created by earlier versions of the software may not have a
4853 * recorded creation date, and will always be considered to pass the age test.
4855 * When left at 0, all registered accounts will pass.
4857 * @par Example:
4858 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4859 * @code
4860 * $wgAutoConfirmAge = 600; // ten minutes
4861 * @endcode
4862 * Set age to one day:
4863 * @code
4864 * $wgAutoConfirmAge = 3600*24; // one day
4865 * @endcode
4867 $wgAutoConfirmAge = 0;
4870 * Number of edits an account requires before it is autoconfirmed.
4871 * Passing both this AND the time requirement is needed. Example:
4873 * @par Example:
4874 * @code
4875 * $wgAutoConfirmCount = 50;
4876 * @endcode
4878 $wgAutoConfirmCount = 0;
4881 * Automatically add a usergroup to any user who matches certain conditions.
4883 * @todo Redocument $wgAutopromote
4885 * The format is
4886 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4887 * where cond1, cond2, ... are themselves conditions; *OR*
4888 * APCOND_EMAILCONFIRMED, *OR*
4889 * array( APCOND_EMAILCONFIRMED ), *OR*
4890 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4891 * array( APCOND_AGE, seconds since registration ), *OR*
4892 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4893 * array( APCOND_ISIP, ip ), *OR*
4894 * array( APCOND_IPINRANGE, range ), *OR*
4895 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4896 * array( APCOND_BLOCKED ), *OR*
4897 * array( APCOND_ISBOT ), *OR*
4898 * similar constructs defined by extensions.
4900 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4901 * user who has provided an e-mail address.
4903 $wgAutopromote = array(
4904 'autoconfirmed' => array( '&',
4905 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4906 array( APCOND_AGE, &$wgAutoConfirmAge ),
4911 * Automatically add a usergroup to any user who matches certain conditions.
4913 * Does not add the user to the group again if it has been removed.
4914 * Also, does not remove the group if the user no longer meets the criteria.
4916 * The format is:
4917 * @code
4918 * array( event => criteria, ... )
4919 * @endcode
4920 * Where event is either:
4921 * - 'onEdit' (when user edits)
4923 * Criteria has the same format as $wgAutopromote
4925 * @see $wgAutopromote
4926 * @since 1.18
4928 $wgAutopromoteOnce = array(
4929 'onEdit' => array(),
4933 * Put user rights log entries for autopromotion in recent changes?
4934 * @since 1.18
4936 $wgAutopromoteOnceLogInRC = true;
4939 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4940 * can assign which groups at Special:Userrights.
4942 * @par Example:
4943 * Bureaucrats can add any group:
4944 * @code
4945 * $wgAddGroups['bureaucrat'] = true;
4946 * @endcode
4947 * Bureaucrats can only remove bots and sysops:
4948 * @code
4949 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4950 * @endcode
4951 * Sysops can make bots:
4952 * @code
4953 * $wgAddGroups['sysop'] = array( 'bot' );
4954 * @endcode
4955 * Sysops can disable other sysops in an emergency, and disable bots:
4956 * @code
4957 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4958 * @endcode
4960 $wgAddGroups = array();
4963 * @see $wgAddGroups
4965 $wgRemoveGroups = array();
4968 * A list of available rights, in addition to the ones defined by the core.
4969 * For extensions only.
4971 $wgAvailableRights = array();
4974 * Optional to restrict deletion of pages with higher revision counts
4975 * to users with the 'bigdelete' permission. (Default given to sysops.)
4977 $wgDeleteRevisionsLimit = 0;
4980 * The maximum number of edits a user can have and
4981 * can still be hidden by users with the hideuser permission.
4982 * This is limited for performance reason.
4983 * Set to false to disable the limit.
4984 * @since 1.23
4986 $wgHideUserContribLimit = 1000;
4989 * Number of accounts each IP address may create, 0 to disable.
4991 * @warning Requires memcached
4993 $wgAccountCreationThrottle = 0;
4996 * Edits matching these regular expressions in body text
4997 * will be recognised as spam and rejected automatically.
4999 * There's no administrator override on-wiki, so be careful what you set. :)
5000 * May be an array of regexes or a single string for backwards compatibility.
5002 * @see http://en.wikipedia.org/wiki/Regular_expression
5004 * @note Each regex needs a beginning/end delimiter, eg: # or /
5006 $wgSpamRegex = array();
5009 * Same as the above except for edit summaries
5011 $wgSummarySpamRegex = array();
5014 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5015 * proxies
5016 * @since 1.16
5018 $wgEnableDnsBlacklist = false;
5021 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5023 * This is an array of either a URL or an array with the URL and a key (should
5024 * the blacklist require a key).
5026 * @par Example:
5027 * @code
5028 * $wgDnsBlacklistUrls = array(
5029 * // String containing URL
5030 * 'http.dnsbl.sorbs.net.',
5031 * // Array with URL and key, for services that require a key
5032 * array( 'dnsbl.httpbl.net.', 'mykey' ),
5033 * // Array with just the URL. While this works, it is recommended that you
5034 * // just use a string as shown above
5035 * array( 'opm.tornevall.org.' )
5036 * );
5037 * @endcode
5039 * @note You should end the domain name with a . to avoid searching your
5040 * eventual domain search suffixes.
5041 * @since 1.16
5043 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
5046 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5047 * what the other methods might say.
5049 $wgProxyWhitelist = array();
5052 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5053 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5054 * (transparent) proxies without needing to block the proxies themselves.
5056 $wgApplyIpBlocksToXff = false;
5059 * Simple rate limiter options to brake edit floods.
5061 * Maximum number actions allowed in the given number of seconds; after that
5062 * the violating client receives HTTP 500 error pages until the period
5063 * elapses.
5065 * @par Example:
5066 * To set a generic maximum of 4 hits in 60 seconds:
5067 * @code
5068 * $wgRateLimits = array( 4, 60 );
5069 * @endcode
5071 * You could also limit per action and then type of users. See the inline
5072 * code for a template to use.
5074 * This option set is experimental and likely to change.
5076 * @warning Requires memcached.
5078 $wgRateLimits = array(
5079 'edit' => array(
5080 'anon' => null, // for any and all anonymous edits (aggregate)
5081 'user' => null, // for each logged-in user
5082 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
5083 'ip' => null, // for each anon and recent account
5084 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
5086 'move' => array(
5087 'user' => null,
5088 'newbie' => null,
5089 'ip' => null,
5090 'subnet' => null,
5092 'mailpassword' => array( // triggering password resets emails
5093 'anon' => null,
5095 'emailuser' => array( // emailing other users using MediaWiki
5096 'user' => null,
5098 'linkpurge' => array( // purges of link tables
5099 'anon' => null,
5100 'user' => null,
5101 'newbie' => null,
5102 'ip' => null,
5103 'subnet' => null,
5105 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
5106 'anon' => null,
5107 'user' => null,
5108 'newbie' => null,
5109 'ip' => null,
5110 'subnet' => null,
5112 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
5113 'anon' => null,
5114 'user' => null,
5115 'newbie' => null,
5116 'ip' => null,
5117 'subnet' => null,
5119 'stashedit' => array( // stashing edits into cache before save
5120 'anon' => null,
5121 'user' => null,
5122 'newbie' => null,
5123 'ip' => null,
5124 'subnet' => null,
5126 'changetag' => array( // adding or removing change tags
5127 'user' => null,
5128 'newbie' => null,
5133 * Set to a filename to log rate limiter hits.
5135 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
5137 $wgRateLimitLog = null;
5140 * Array of IPs which should be excluded from rate limits.
5141 * This may be useful for whitelisting NAT gateways for conferences, etc.
5143 $wgRateLimitsExcludedIPs = array();
5146 * Log IP addresses in the recentchanges table; can be accessed only by
5147 * extensions (e.g. CheckUser) or a DB admin
5148 * Used for retroactive autoblocks
5150 $wgPutIPinRC = true;
5153 * Integer defining default number of entries to show on
5154 * special pages which are query-pages such as Special:Whatlinkshere.
5156 $wgQueryPageDefaultLimit = 50;
5159 * Limit password attempts to X attempts per Y seconds per IP per account.
5161 * @warning Requires memcached.
5163 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5165 /** @} */ # end of user rights settings
5167 /************************************************************************//**
5168 * @name Proxy scanner settings
5169 * @{
5173 * This should always be customised in LocalSettings.php
5175 $wgSecretKey = false;
5178 * Big list of banned IP addresses.
5180 * This can have the following formats:
5181 * - An array of addresses, either in the values
5182 * or the keys (for backward compatibility)
5183 * - A string, in that case this is the path to a file
5184 * containing the list of IP addresses, one per line
5186 $wgProxyList = array();
5188 /** @} */ # end of proxy scanner settings
5190 /************************************************************************//**
5191 * @name Cookie settings
5192 * @{
5196 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5198 $wgCookieExpiration = 180 * 86400;
5201 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5202 * or ".any.subdomain.net"
5204 $wgCookieDomain = '';
5207 * Set this variable if you want to restrict cookies to a certain path within
5208 * the domain specified by $wgCookieDomain.
5210 $wgCookiePath = '/';
5213 * Whether the "secure" flag should be set on the cookie. This can be:
5214 * - true: Set secure flag
5215 * - false: Don't set secure flag
5216 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5218 $wgCookieSecure = 'detect';
5221 * By default, MediaWiki checks if the client supports cookies during the
5222 * login process, so that it can display an informative error message if
5223 * cookies are disabled. Set this to true if you want to disable this cookie
5224 * check.
5226 $wgDisableCookieCheck = false;
5229 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5230 * to a string to use a custom prefix. Setting it to false causes the database
5231 * name to be used as a prefix.
5233 $wgCookiePrefix = false;
5236 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5237 * in browsers that support this feature. This can mitigates some classes of
5238 * XSS attack.
5240 $wgCookieHttpOnly = true;
5243 * A list of cookies that vary the cache (for use by extensions)
5245 $wgCacheVaryCookies = array();
5248 * Override to customise the session name
5250 $wgSessionName = false;
5252 /** @} */ # end of cookie settings }
5254 /************************************************************************//**
5255 * @name LaTeX (mathematical formulas)
5256 * @{
5260 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5261 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5262 * (ImageMagick) installed and available in the PATH.
5263 * Please see math/README for more information.
5265 $wgUseTeX = false;
5267 /** @} */ # end LaTeX }
5269 /************************************************************************//**
5270 * @name Profiling, testing and debugging
5272 * To enable profiling, edit StartProfiler.php
5274 * @{
5278 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5279 * The debug log file should be not be publicly accessible if it is used, as it
5280 * may contain private data.
5282 $wgDebugLogFile = '';
5285 * Prefix for debug log lines
5287 $wgDebugLogPrefix = '';
5290 * If true, instead of redirecting, show a page with a link to the redirect
5291 * destination. This allows for the inspection of PHP error messages, and easy
5292 * resubmission of form data. For developer use only.
5294 $wgDebugRedirects = false;
5297 * If true, log debugging data from action=raw and load.php.
5298 * This is normally false to avoid overlapping debug entries due to gen=css
5299 * and gen=js requests.
5301 $wgDebugRawPage = false;
5304 * Send debug data to an HTML comment in the output.
5306 * This may occasionally be useful when supporting a non-technical end-user.
5307 * It's more secure than exposing the debug log file to the web, since the
5308 * output only contains private data for the current user. But it's not ideal
5309 * for development use since data is lost on fatal errors and redirects.
5311 $wgDebugComments = false;
5314 * Extensive database transaction state debugging
5316 * @since 1.20
5318 $wgDebugDBTransactions = false;
5321 * Write SQL queries to the debug log.
5323 * This setting is only used $wgLBFactoryConf['class'] is set to
5324 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5325 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5326 * connection to achieve the same functionality.
5328 $wgDebugDumpSql = false;
5331 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5332 * trimming.
5333 * @since 1.24
5335 $wgDebugDumpSqlLength = 500;
5338 * Performance expectations for DB usage
5340 * @since 1.26
5342 $wgTrxProfilerLimits = array(
5343 // Basic GET and POST requests
5344 'GET' => array(
5345 'masterConns' => 0,
5346 'writes' => 0,
5347 'readQueryTime' => 5
5349 'POST' => array(
5350 'readQueryTime' => 5,
5351 'writeQueryTime' => 1,
5352 'maxAffected' => 500
5354 // Background job runner
5355 'JobRunner' => array(
5356 'readQueryTime' => 30,
5357 'writeQueryTime' => 5,
5358 'maxAffected' => 500
5360 // Command-line scripts
5361 'Maintenance' => array(
5362 'writeQueryTime' => 5,
5363 'maxAffected' => 1000
5368 * Map of string log group names to log destinations.
5370 * If set, wfDebugLog() output for that group will go to that file instead
5371 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5372 * in production.
5374 * Log destinations may be one of the following:
5375 * - false to completely remove from the output, including from $wgDebugLogFile.
5376 * - string values specifying a filename or URI.
5377 * - associative array with keys:
5378 * - 'destination' desired filename or URI.
5379 * - 'sample' an integer value, specifying a sampling factor (optional)
5380 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5381 * to log (optional, since 1.25)
5383 * @par Example:
5384 * @code
5385 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5386 * @endcode
5388 * @par Advanced example:
5389 * @code
5390 * $wgDebugLogGroups['memcached'] = array(
5391 * 'destination' => '/var/log/mediawiki/memcached.log',
5392 * 'sample' => 1000, // log 1 message out of every 1,000.
5393 * 'level' => \Psr\Log\LogLevel::WARNING
5394 * );
5395 * @endcode
5397 $wgDebugLogGroups = array();
5400 * Default service provider for creating Psr\Log\LoggerInterface instances.
5402 * The value should be an array suitable for use with
5403 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5404 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
5405 * details.
5407 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
5408 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
5409 * and bypass the use of this configuration variable entirely.
5411 * @par To completely disable logging:
5412 * @code
5413 * $wgMWLoggerDefaultSpi = array( 'class' => '\\MediaWiki\\Logger\\NullSpi' );
5414 * @endcode
5416 * @since 1.25
5417 * @var array $wgMWLoggerDefaultSpi
5418 * @see MwLogger
5420 $wgMWLoggerDefaultSpi = array(
5421 'class' => '\\MediaWiki\\Logger\\LegacySpi',
5425 * Display debug data at the bottom of the main content area.
5427 * Useful for developers and technical users trying to working on a closed wiki.
5429 $wgShowDebug = false;
5432 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5433 * Since 1.19 also includes memory usage.
5435 $wgDebugTimestamps = false;
5438 * Print HTTP headers for every request in the debug information.
5440 $wgDebugPrintHttpHeaders = true;
5443 * Show the contents of $wgHooks in Special:Version
5445 $wgSpecialVersionShowHooks = false;
5448 * Whether to show "we're sorry, but there has been a database error" pages.
5449 * Displaying errors aids in debugging, but may display information useful
5450 * to an attacker.
5452 $wgShowSQLErrors = false;
5455 * If set to true, uncaught exceptions will print a complete stack trace
5456 * to output. This should only be used for debugging, as it may reveal
5457 * private information in function parameters due to PHP's backtrace
5458 * formatting.
5460 $wgShowExceptionDetails = false;
5463 * If true, show a backtrace for database errors
5465 * @note This setting only applies when connection errors and query errors are
5466 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5467 * including those in which an uncaught exception is thrown from within the
5468 * exception handler.
5470 $wgShowDBErrorBacktrace = false;
5473 * If true, send the exception backtrace to the error log
5475 $wgLogExceptionBacktrace = true;
5478 * Expose backend server host names through the API and various HTML comments
5480 $wgShowHostnames = false;
5483 * Override server hostname detection with a hardcoded value.
5484 * Should be a string, default false.
5485 * @since 1.20
5487 $wgOverrideHostname = false;
5490 * If set to true MediaWiki will throw notices for some possible error
5491 * conditions and for deprecated functions.
5493 $wgDevelopmentWarnings = false;
5496 * Release limitation to wfDeprecated warnings, if set to a release number
5497 * development warnings will not be generated for deprecations added in releases
5498 * after the limit.
5500 $wgDeprecationReleaseLimit = false;
5503 * Only record profiling info for pages that took longer than this
5504 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
5506 $wgProfileLimit = 0.0;
5509 * Don't put non-profiling info into log file
5511 * @deprecated since 1.23, set the log file in
5512 * $wgDebugLogGroups['profileoutput'] instead.
5514 $wgProfileOnly = false;
5517 * If true, print a raw call tree instead of per-function report
5519 $wgProfileCallTree = false;
5522 * Should application server host be put into profiling table
5524 * @deprecated set $wgProfiler['perhost'] = true instead
5526 $wgProfilePerHost = null;
5529 * Host for UDP profiler.
5531 * The host should be running a daemon which can be obtained from MediaWiki
5532 * Git at:
5533 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5535 * @deprecated set $wgProfiler['udphost'] instead
5537 $wgUDPProfilerHost = null;
5540 * Port for UDP profiler.
5541 * @see $wgUDPProfilerHost
5543 * @deprecated set $wgProfiler['udpport'] instead
5545 $wgUDPProfilerPort = null;
5548 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5549 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5550 * arguments. You can use sprintf's argument numbering/swapping capability to
5551 * repeat, re-order or omit fields.
5553 * @see $wgStatsFormatString
5554 * @since 1.22
5556 * @deprecated set $wgProfiler['udpformat'] instead
5558 $wgUDPProfilerFormatString = null;
5561 * Destination for wfIncrStats() data...
5562 * 'cache' to go into the system cache, if enabled (memcached)
5563 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5564 * false to disable
5566 $wgStatsMethod = 'cache';
5569 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5570 * be aggregated over more than one wiki. The string will be used in place of
5571 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5572 * will be used.
5574 $wgAggregateStatsID = false;
5577 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5578 * formatted. Its value should be a format string suitable for a sprintf()
5579 * invocation with (id, count, key) arguments, where 'id' is either
5580 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5581 * is being incremented, and 'key' is the metric name.
5583 * @see $wgUDPProfilerFormatString
5584 * @see $wgAggregateStatsID
5585 * @since 1.22
5587 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5590 * InfoAction retrieves a list of transclusion links (both to and from).
5591 * This number puts a limit on that query in the case of highly transcluded
5592 * templates.
5594 $wgPageInfoTransclusionLimit = 50;
5597 * Set this to an integer to only do synchronous site_stats updates
5598 * one every *this many* updates. The other requests go into pending
5599 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5600 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5602 $wgSiteStatsAsyncFactor = false;
5605 * Parser test suite files to be run by parserTests.php when no specific
5606 * filename is passed to it.
5608 * Extensions may add their own tests to this array, or site-local tests
5609 * may be added via LocalSettings.php
5611 * Use full paths.
5613 $wgParserTestFiles = array(
5614 "$IP/tests/parser/parserTests.txt",
5615 "$IP/tests/parser/extraParserTests.txt"
5619 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5621 $wgEnableJavaScriptTest = false;
5624 * Overwrite the caching key prefix with custom value.
5625 * @since 1.19
5627 $wgCachePrefix = false;
5630 * Display the new debugging toolbar. This also enables profiling on database
5631 * queries and other useful output.
5632 * Will disable file cache.
5634 * @since 1.19
5636 $wgDebugToolbar = false;
5638 /** @} */ # end of profiling, testing and debugging }
5640 /************************************************************************//**
5641 * @name Search
5642 * @{
5646 * Set this to true to disable the full text search feature.
5648 $wgDisableTextSearch = false;
5651 * Set to true to have nicer highlighted text in search results,
5652 * by default off due to execution overhead
5654 $wgAdvancedSearchHighlighting = false;
5657 * Regexp to match word boundaries, defaults for non-CJK languages
5658 * should be empty for CJK since the words are not separate
5660 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5663 * Template for OpenSearch suggestions, defaults to API action=opensearch
5665 * Sites with heavy load would typically have these point to a custom
5666 * PHP wrapper to avoid firing up mediawiki for every keystroke
5668 * Placeholders: {searchTerms}
5670 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5672 $wgOpenSearchTemplate = false;
5675 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5677 * Sites with heavy load would typically have these point to a custom
5678 * PHP wrapper to avoid firing up mediawiki for every keystroke
5680 * Placeholders: {searchTerms}
5682 $wgOpenSearchTemplates = array(
5683 'application/x-suggestions+json' => false,
5684 'application/x-suggestions+xml' => false,
5688 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5689 * false if you've disabled scripts that use api?action=opensearch and
5690 * want reduce load caused by cached scripts still pulling suggestions.
5691 * It will let the API fallback by responding with an empty array.
5693 $wgEnableOpenSearchSuggest = true;
5696 * Integer defining default number of entries to show on
5697 * OpenSearch call.
5699 $wgOpenSearchDefaultLimit = 10;
5702 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
5704 $wgOpenSearchDescriptionLength = 100;
5707 * Expiry time for search suggestion responses
5709 $wgSearchSuggestCacheExpiry = 1200;
5712 * If you've disabled search semi-permanently, this also disables updates to the
5713 * table. If you ever re-enable, be sure to rebuild the search table.
5715 $wgDisableSearchUpdate = false;
5718 * List of namespaces which are searched by default.
5720 * @par Example:
5721 * @code
5722 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5723 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5724 * @endcode
5726 $wgNamespacesToBeSearchedDefault = array(
5727 NS_MAIN => true,
5731 * Disable the internal MySQL-based search, to allow it to be
5732 * implemented by an extension instead.
5734 $wgDisableInternalSearch = false;
5737 * Set this to a URL to forward search requests to some external location.
5738 * If the URL includes '$1', this will be replaced with the URL-encoded
5739 * search term.
5741 * @par Example:
5742 * To forward to Google you'd have something like:
5743 * @code
5744 * $wgSearchForwardUrl =
5745 * 'http://www.google.com/search?q=$1' .
5746 * '&domains=http://example.com' .
5747 * '&sitesearch=http://example.com' .
5748 * '&ie=utf-8&oe=utf-8';
5749 * @endcode
5751 $wgSearchForwardUrl = null;
5754 * Search form behavior.
5755 * - true = use Go & Search buttons
5756 * - false = use Go button & Advanced search link
5758 $wgUseTwoButtonsSearchForm = true;
5761 * Array of namespaces to generate a Google sitemap for when the
5762 * maintenance/generateSitemap.php script is run, or false if one is to be
5763 * generated for all namespaces.
5765 $wgSitemapNamespaces = false;
5768 * Custom namespace priorities for sitemaps. Setting this will allow you to
5769 * set custom priorities to namespaces when sitemaps are generated using the
5770 * maintenance/generateSitemap.php script.
5772 * This should be a map of namespace IDs to priority
5773 * @par Example:
5774 * @code
5775 * $wgSitemapNamespacesPriorities = array(
5776 * NS_USER => '0.9',
5777 * NS_HELP => '0.0',
5778 * );
5779 * @endcode
5781 $wgSitemapNamespacesPriorities = false;
5784 * If true, searches for IP addresses will be redirected to that IP's
5785 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5786 * [[Special:Contributions/1.2.3.4]]
5788 $wgEnableSearchContributorsByIP = true;
5790 /** @} */ # end of search settings
5792 /************************************************************************//**
5793 * @name Edit user interface
5794 * @{
5798 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5799 * fall back to the old behavior (no merging).
5801 $wgDiff3 = '/usr/bin/diff3';
5804 * Path to the GNU diff utility.
5806 $wgDiff = '/usr/bin/diff';
5809 * Which namespaces have special treatment where they should be preview-on-open
5810 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5811 * can specify namespaces of pages they have special treatment for
5813 $wgPreviewOnOpenNamespaces = array(
5814 NS_CATEGORY => true
5818 * Enable the UniversalEditButton for browsers that support it
5819 * (currently only Firefox with an extension)
5820 * See http://universaleditbutton.org for more background information
5822 $wgUniversalEditButton = true;
5825 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5826 * will try to automatically create one. This feature can be disabled by set-
5827 * ting this variable false.
5829 $wgUseAutomaticEditSummaries = true;
5831 /** @} */ # end edit UI }
5833 /************************************************************************//**
5834 * @name Maintenance
5835 * See also $wgSiteNotice
5836 * @{
5840 * @cond file_level_code
5841 * Set $wgCommandLineMode if it's not set already, to avoid notices
5843 if ( !isset( $wgCommandLineMode ) ) {
5844 $wgCommandLineMode = false;
5846 /** @endcond */
5849 * For colorized maintenance script output, is your terminal background dark ?
5851 $wgCommandLineDarkBg = false;
5854 * Set this to a string to put the wiki into read-only mode. The text will be
5855 * used as an explanation to users.
5857 * This prevents most write operations via the web interface. Cache updates may
5858 * still be possible. To prevent database writes completely, use the read_only
5859 * option in MySQL.
5861 $wgReadOnly = null;
5864 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5865 * Its contents will be shown to users as part of the read-only warning
5866 * message.
5868 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5870 $wgReadOnlyFile = false;
5873 * When you run the web-based upgrade utility, it will tell you what to set
5874 * this to in order to authorize the upgrade process. It will subsequently be
5875 * used as a password, to authorize further upgrades.
5877 * For security, do not set this to a guessable string. Use the value supplied
5878 * by the install/upgrade process. To cause the upgrader to generate a new key,
5879 * delete the old key from LocalSettings.php.
5881 $wgUpgradeKey = false;
5884 * Fully specified path to git binary
5886 $wgGitBin = '/usr/bin/git';
5889 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5891 * Key is a pattern passed to preg_match() and preg_replace(),
5892 * without the delimiters (which are #) and must match the whole URL.
5893 * The value is the replacement for the key (it can contain $1, etc.)
5894 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5895 * full SHA-1 of the HEAD revision.
5896 * %r will be replaced with a URL-encoded version of $1.
5898 * @since 1.20
5900 $wgGitRepositoryViewers = array(
5901 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5902 'https://git.wikimedia.org/tree/%r/%H',
5903 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5904 'https://git.wikimedia.org/tree/%r/%H',
5907 /** @} */ # End of maintenance }
5909 /************************************************************************//**
5910 * @name Recent changes, new pages, watchlist and history
5911 * @{
5915 * Recentchanges items are periodically purged; entries older than this many
5916 * seconds will go.
5917 * Default: 90 days = about three months
5919 $wgRCMaxAge = 90 * 24 * 3600;
5922 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5923 * higher than what will be stored. Note that this is disabled by default
5924 * because we sometimes do have RC data which is beyond the limit for some
5925 * reason, and some users may use the high numbers to display that data which
5926 * is still there.
5928 $wgRCFilterByAge = false;
5931 * List of Limits options to list in the Special:Recentchanges and
5932 * Special:Recentchangeslinked pages.
5934 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5937 * List of Days options to list in the Special:Recentchanges and
5938 * Special:Recentchangeslinked pages.
5940 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5943 * Destinations to which notifications about recent changes
5944 * should be sent.
5946 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5947 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5948 * specified server.
5949 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5951 * The common options are:
5952 * * 'uri' -- the address to which the notices are to be sent.
5953 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5954 * produce the text to send. This can also be an object of the class.
5955 * * 'omit_bots' -- whether the bot edits should be in the feed
5956 * * 'omit_anon' -- whether anonymous edits should be in the feed
5957 * * 'omit_user' -- whether edits by registered users should be in the feed
5958 * * 'omit_minor' -- whether minor edits should be in the feed
5959 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5961 * The IRC-specific options are:
5962 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5963 * the first entry in the $wgLocalInterwikis array (or the value of
5964 * $wgLocalInterwiki, if set)
5966 * The JSON-specific options are:
5967 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5969 * @example $wgRCFeeds['example'] = array(
5970 * 'formatter' => 'JSONRCFeedFormatter',
5971 * 'uri' => "udp://localhost:1336",
5972 * 'add_interwiki_prefix' => false,
5973 * 'omit_bots' => true,
5974 * );
5975 * @example $wgRCFeeds['exampleirc'] = array(
5976 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5977 * 'uri' => "udp://localhost:1338",
5978 * 'add_interwiki_prefix' => false,
5979 * 'omit_bots' => true,
5980 * );
5981 * @since 1.22
5983 $wgRCFeeds = array();
5986 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5987 * Keys are scheme names, values are names of engine classes.
5989 $wgRCEngines = array(
5990 'redis' => 'RedisPubSubFeedEngine',
5991 'udp' => 'UDPRCFeedEngine',
5995 * Use RC Patrolling to check for vandalism
5997 $wgUseRCPatrol = true;
6000 * Use new page patrolling to check new pages on Special:Newpages
6002 $wgUseNPPatrol = true;
6005 * Log autopatrol actions to the log table
6007 $wgLogAutopatrol = true;
6010 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6012 $wgFeed = true;
6015 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6016 * eg Recentchanges, Newpages.
6018 $wgFeedLimit = 50;
6021 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6022 * A cached version will continue to be served out even if changes
6023 * are made, until this many seconds runs out since the last render.
6025 * If set to 0, feed caching is disabled. Use this for debugging only;
6026 * feed generation can be pretty slow with diffs.
6028 $wgFeedCacheTimeout = 60;
6031 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6032 * pages larger than this size.
6034 $wgFeedDiffCutoff = 32768;
6037 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6038 * every page. Some sites might have a different feed they'd like to promote
6039 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6040 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6041 * as value.
6042 * @par Example:
6043 * Configure the 'atom' feed to http://example.com/somefeed.xml
6044 * @code
6045 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6046 * @endcode
6048 $wgOverrideSiteFeed = array();
6051 * Available feeds objects.
6052 * Should probably only be defined when a page is syndicated ie when
6053 * $wgOut->isSyndicated() is true.
6055 $wgFeedClasses = array(
6056 'rss' => 'RSSFeed',
6057 'atom' => 'AtomFeed',
6061 * Which feed types should we provide by default? This can include 'rss',
6062 * 'atom', neither, or both.
6064 $wgAdvertisedFeedTypes = array( 'atom' );
6067 * Show watching users in recent changes, watchlist and page history views
6069 $wgRCShowWatchingUsers = false; # UPO
6072 * Show the amount of changed characters in recent changes
6074 $wgRCShowChangedSize = true;
6077 * If the difference between the character counts of the text
6078 * before and after the edit is below that value, the value will be
6079 * highlighted on the RC page.
6081 $wgRCChangedSizeThreshold = 500;
6084 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6085 * view for watched pages with new changes
6087 $wgShowUpdatedMarker = true;
6090 * Disable links to talk pages of anonymous users (IPs) in listings on special
6091 * pages like page history, Special:Recentchanges, etc.
6093 $wgDisableAnonTalk = false;
6096 * Enable filtering of categories in Recentchanges
6098 $wgAllowCategorizedRecentChanges = false;
6101 * Allow filtering by change tag in recentchanges, history, etc
6102 * Has no effect if no tags are defined in valid_tag.
6104 $wgUseTagFilter = true;
6107 * If set to an integer, pages that are watched by this many users or more
6108 * will not require the unwatchedpages permission to view the number of
6109 * watchers.
6111 * @since 1.21
6113 $wgUnwatchedPageThreshold = false;
6116 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6117 * certain types of edits.
6119 * To register a new one:
6120 * @code
6121 * $wgRecentChangesFlags['flag'] => array(
6122 * // message for the letter displayed next to rows on changes lists
6123 * 'letter' => 'letter-msg',
6124 * // message for the tooltip of the letter
6125 * 'title' => 'tooltip-msg',
6126 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6127 * 'legend' => 'legend-msg',
6128 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6129 * 'class' => 'css-class',
6130 * );
6131 * @endcode
6133 * @since 1.22
6135 $wgRecentChangesFlags = array(
6136 'newpage' => array(
6137 'letter' => 'newpageletter',
6138 'title' => 'recentchanges-label-newpage',
6139 'legend' => 'recentchanges-legend-newpage',
6141 'minor' => array(
6142 'letter' => 'minoreditletter',
6143 'title' => 'recentchanges-label-minor',
6144 'legend' => 'recentchanges-legend-minor',
6145 'class' => 'minoredit',
6147 'bot' => array(
6148 'letter' => 'boteditletter',
6149 'title' => 'recentchanges-label-bot',
6150 'legend' => 'recentchanges-legend-bot',
6151 'class' => 'botedit',
6153 'unpatrolled' => array(
6154 'letter' => 'unpatrolledletter',
6155 'title' => 'recentchanges-label-unpatrolled',
6156 'legend' => 'recentchanges-legend-unpatrolled',
6160 /** @} */ # end RC/watchlist }
6162 /************************************************************************//**
6163 * @name Copyright and credits settings
6164 * @{
6168 * Override for copyright metadata.
6170 * This is the name of the page containing information about the wiki's copyright status,
6171 * which will be added as a link in the footer if it is specified. It overrides
6172 * $wgRightsUrl if both are specified.
6174 $wgRightsPage = null;
6177 * Set this to specify an external URL containing details about the content license used on your
6178 * wiki.
6179 * If $wgRightsPage is set then this setting is ignored.
6181 $wgRightsUrl = null;
6184 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6185 * link.
6186 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6187 * of the page will also be used as the link if this variable is not set.
6189 $wgRightsText = null;
6192 * Override for copyright metadata.
6194 $wgRightsIcon = null;
6197 * Set this to some HTML to override the rights icon with an arbitrary logo
6198 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6200 $wgCopyrightIcon = null;
6203 * Set this to true if you want detailed copyright information forms on Upload.
6205 $wgUseCopyrightUpload = false;
6208 * Set this to the number of authors that you want to be credited below an
6209 * article text. Set it to zero to hide the attribution block, and a negative
6210 * number (like -1) to show all authors. Note that this will require 2-3 extra
6211 * database hits, which can have a not insignificant impact on performance for
6212 * large wikis.
6214 $wgMaxCredits = 0;
6217 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6218 * Otherwise, link to a separate credits page.
6220 $wgShowCreditsIfMax = true;
6222 /** @} */ # end of copyright and credits settings }
6224 /************************************************************************//**
6225 * @name Import / Export
6226 * @{
6230 * List of interwiki prefixes for wikis we'll accept as sources for
6231 * Special:Import (for sysops). Since complete page history can be imported,
6232 * these should be 'trusted'.
6234 * This can either be a regular array, or an associative map specifying
6235 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6236 * e.g.
6237 * @code
6238 * $wgImportSources = array(
6239 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6240 * 'wikispecies',
6241 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6242 * );
6243 * @endcode
6245 * If a user has the 'import' permission but not the 'importupload' permission,
6246 * they will only be able to run imports through this transwiki interface.
6248 $wgImportSources = array();
6251 * Optional default target namespace for interwiki imports.
6252 * Can use this to create an incoming "transwiki"-style queue.
6253 * Set to numeric key, not the name.
6255 * Users may override this in the Special:Import dialog.
6257 $wgImportTargetNamespace = null;
6260 * If set to false, disables the full-history option on Special:Export.
6261 * This is currently poorly optimized for long edit histories, so is
6262 * disabled on Wikimedia's sites.
6264 $wgExportAllowHistory = true;
6267 * If set nonzero, Special:Export requests for history of pages with
6268 * more revisions than this will be rejected. On some big sites things
6269 * could get bogged down by very very long pages.
6271 $wgExportMaxHistory = 0;
6274 * Return distinct author list (when not returning full history)
6276 $wgExportAllowListContributors = false;
6279 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6280 * up to this specified level, which will cause it to include all
6281 * pages linked to from the pages you specify. Since this number
6282 * can become *insanely large* and could easily break your wiki,
6283 * it's disabled by default for now.
6285 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6286 * crazy-big export from being done by someone setting the depth number too
6287 * high. In other words, last resort safety net.
6289 $wgExportMaxLinkDepth = 0;
6292 * Whether to allow the "export all pages in namespace" option
6294 $wgExportFromNamespaces = false;
6297 * Whether to allow exporting the entire wiki into a single file
6299 $wgExportAllowAll = false;
6301 /** @} */ # end of import/export }
6303 /*************************************************************************//**
6304 * @name Extensions
6305 * @{
6309 * A list of callback functions which are called once MediaWiki is fully
6310 * initialised
6312 $wgExtensionFunctions = array();
6315 * Extension messages files.
6317 * Associative array mapping extension name to the filename where messages can be
6318 * found. The file should contain variable assignments. Any of the variables
6319 * present in languages/messages/MessagesEn.php may be defined, but $messages
6320 * is the most common.
6322 * Variables defined in extensions will override conflicting variables defined
6323 * in the core.
6325 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6326 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6327 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6328 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6330 * Extensions using the JSON message format can preserve backward compatibility with
6331 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6332 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6333 * as for the $wgMessagesDirs entry.
6335 * @par Example:
6336 * @code
6337 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6338 * @endcode
6340 $wgExtensionMessagesFiles = array();
6343 * Extension messages directories.
6345 * Associative array mapping extension name to the path of the directory where message files can
6346 * be found. The message files are expected to be JSON files named for their language code, e.g.
6347 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6348 * message directories.
6350 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6352 * @par Simple example:
6353 * @code
6354 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6355 * @endcode
6357 * @par Complex example:
6358 * @code
6359 * $wgMessagesDirs['Example'] = array(
6360 * __DIR__ . '/lib/ve/i18n',
6361 * __DIR__ . '/lib/oojs-ui/i18n',
6362 * __DIR__ . '/i18n',
6364 * @endcode
6365 * @since 1.23
6367 $wgMessagesDirs = array();
6370 * Array of files with list(s) of extension entry points to be used in
6371 * maintenance/mergeMessageFileList.php
6372 * @since 1.22
6374 $wgExtensionEntryPointListFiles = array();
6377 * Parser output hooks.
6378 * This is an associative array where the key is an extension-defined tag
6379 * (typically the extension name), and the value is a PHP callback.
6380 * These will be called as an OutputPageParserOutput hook, if the relevant
6381 * tag has been registered with the parser output object.
6383 * Registration is done with $pout->addOutputHook( $tag, $data ).
6385 * The callback has the form:
6386 * @code
6387 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6388 * @endcode
6390 $wgParserOutputHooks = array();
6393 * Whether to include the NewPP limit report as a HTML comment
6395 $wgEnableParserLimitReporting = true;
6398 * List of valid skin names
6400 * The key should be the name in all lower case, the value should be a properly
6401 * cased name for the skin. This value will be prefixed with "Skin" to create
6402 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6403 * if you wish to have access to the full list.
6405 $wgValidSkinNames = array();
6408 * Special page list. This is an associative array mapping the (canonical) names of
6409 * special pages to either a class name to be instantiated, or a callback to use for
6410 * creating the special page object. In both cases, the result must be an instance of
6411 * SpecialPage.
6413 $wgSpecialPages = array();
6416 * Array mapping class names to filenames, for autoloading.
6418 $wgAutoloadClasses = array();
6421 * Switch controlling legacy case-insensitive classloading.
6422 * Do not disable if your wiki must support data created by PHP4, or by
6423 * MediaWiki 1.4 or earlier.
6425 $wgAutoloadAttemptLowercase = true;
6428 * An array of information about installed extensions keyed by their type.
6430 * All but 'name', 'path' and 'author' can be omitted.
6432 * @code
6433 * $wgExtensionCredits[$type][] = array(
6434 * 'path' => __FILE__,
6435 * 'name' => 'Example extension',
6436 * 'namemsg' => 'exampleextension-name',
6437 * 'author' => array(
6438 * 'Foo Barstein',
6439 * ),
6440 * 'version' => '1.9.0',
6441 * 'url' => 'http://example.org/example-extension/',
6442 * 'descriptionmsg' => 'exampleextension-desc',
6443 * 'license-name' => 'GPL-2.0+',
6444 * );
6445 * @endcode
6447 * The extensions are listed on Special:Version. This page also looks for a file
6448 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6449 * view said file. When the 'license-name' key is specified, this file is
6450 * interpreted as wikitext.
6452 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6453 * 'skin', 'api', or 'other', or any additional types as specified through the
6454 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6456 * - name: Name of extension as an inline string instead of localizable message.
6457 * Do not omit this even if 'namemsg' is provided, as it is used to override
6458 * the path Special:Version uses to find extension's license info, and is
6459 * required for backwards-compatibility with MediaWiki 1.23 and older.
6461 * - namemsg (since MW 1.24): A message key for a message containing the
6462 * extension's name, if the name is localizable. (For example, skin names
6463 * usually are.)
6465 * - author: A string or an array of strings. Authors can be linked using
6466 * the regular wikitext link syntax. To have an internationalized version of
6467 * "and others" show, add an element "...". This element can also be linked,
6468 * for instance "[http://example ...]".
6470 * - descriptionmsg: A message key or an an array with message key and parameters:
6471 * `'descriptionmsg' => 'exampleextension-desc',`
6473 * - description: Description of extension as an inline string instead of
6474 * localizable message (omit in favour of 'descriptionmsg').
6476 * - license-name: Short name of the license (used as label for the link), such
6477 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6479 $wgExtensionCredits = array();
6482 * Authentication plugin.
6483 * @var $wgAuth AuthPlugin
6485 $wgAuth = null;
6488 * Global list of hooks.
6490 * The key is one of the events made available by MediaWiki, you can find
6491 * a description for most of them in docs/hooks.txt. The array is used
6492 * internally by Hook:run().
6494 * The value can be one of:
6496 * - A function name:
6497 * @code
6498 * $wgHooks['event_name'][] = $function;
6499 * @endcode
6500 * - A function with some data:
6501 * @code
6502 * $wgHooks['event_name'][] = array( $function, $data );
6503 * @endcode
6504 * - A an object method:
6505 * @code
6506 * $wgHooks['event_name'][] = array( $object, 'method' );
6507 * @endcode
6508 * - A closure:
6509 * @code
6510 * $wgHooks['event_name'][] = function ( $hookParam ) {
6511 * // Handler code goes here.
6512 * };
6513 * @endcode
6515 * @warning You should always append to an event array or you will end up
6516 * deleting a previous registered hook.
6518 * @warning Hook handlers should be registered at file scope. Registering
6519 * handlers after file scope can lead to unexpected results due to caching.
6521 $wgHooks = array();
6524 * Maps jobs to their handling classes; extensions
6525 * can add to this to provide custom jobs
6527 $wgJobClasses = array(
6528 'refreshLinks' => 'RefreshLinksJob',
6529 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6530 'sendMail' => 'EmaillingJob',
6531 'enotifNotify' => 'EnotifNotifyJob',
6532 'fixDoubleRedirect' => 'DoubleRedirectJob',
6533 'uploadFromUrl' => 'UploadFromUrlJob',
6534 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6535 'PublishStashedFile' => 'PublishStashedFileJob',
6536 'ThumbnailRender' => 'ThumbnailRenderJob',
6537 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6538 'refreshLinksPrioritized' => 'RefreshLinksJob', // for cascading protection
6539 'activityUpdateJob' => 'ActivityUpdateJob',
6540 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
6541 'null' => 'NullJob'
6545 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6546 * special flags are set. The values here are keys of $wgJobClasses.
6548 * These can be:
6549 * - Very long-running jobs.
6550 * - Jobs that you would never want to run as part of a page rendering request.
6551 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6552 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6553 * These settings should be global to all wikis.
6555 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6558 * Map of job types to how many job "work items" should be run per second
6559 * on each job runner process. The meaning of "work items" varies per job,
6560 * but typically would be something like "pages to update". A single job
6561 * may have a variable number of work items, as is the case with batch jobs.
6562 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6563 * These settings should be global to all wikis.
6564 * @var float[]
6566 $wgJobBackoffThrottling = array();
6569 * Make job runners commit changes for slave-lag prone jobs one job at a time.
6570 * This is useful if there are many job workers that race on slave lag checks.
6571 * If set, jobs taking this many seconds of DB write time have serialized commits.
6573 * Note that affected jobs may have worse lock contention. Also, if they affect
6574 * several DBs at once they may have a smaller chance of being atomic due to the
6575 * possibility of connection loss while queueing up to commit. Affected jobs may
6576 * also fail due to the commit lock acquisition timeout.
6578 * @var float|bool
6579 * @since 1.26
6581 $wgJobSerialCommitThreshold = false;
6584 * Map of job types to configuration arrays.
6585 * This determines which queue class and storage system is used for each job type.
6586 * Job types that do not have explicit configuration will use the 'default' config.
6587 * These settings should be global to all wikis.
6589 $wgJobTypeConf = array(
6590 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6594 * Which aggregator to use for tracking which queues have jobs.
6595 * These settings should be global to all wikis.
6597 $wgJobQueueAggregator = array(
6598 'class' => 'JobQueueAggregatorNull'
6602 * Additional functions to be performed with updateSpecialPages.
6603 * Expensive Querypages are already updated.
6605 $wgSpecialPageCacheUpdates = array(
6606 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
6610 * Hooks that are used for outputting exceptions. Format is:
6611 * $wgExceptionHooks[] = $funcname
6612 * or:
6613 * $wgExceptionHooks[] = array( $class, $funcname )
6614 * Hooks should return strings or false
6616 $wgExceptionHooks = array();
6619 * Page property link table invalidation lists. When a page property
6620 * changes, this may require other link tables to be updated (eg
6621 * adding __HIDDENCAT__ means the hiddencat tracking category will
6622 * have been added, so the categorylinks table needs to be rebuilt).
6623 * This array can be added to by extensions.
6625 $wgPagePropLinkInvalidations = array(
6626 'hiddencat' => 'categorylinks',
6629 /** @} */ # End extensions }
6631 /*************************************************************************//**
6632 * @name Categories
6633 * @{
6637 * Use experimental, DMOZ-like category browser
6639 $wgUseCategoryBrowser = false;
6642 * On category pages, show thumbnail gallery for images belonging to that
6643 * category instead of listing them as articles.
6645 $wgCategoryMagicGallery = true;
6648 * Paging limit for categories
6650 $wgCategoryPagingLimit = 200;
6653 * Specify how category names should be sorted, when listed on a category page.
6654 * A sorting scheme is also known as a collation.
6656 * Available values are:
6658 * - uppercase: Converts the category name to upper case, and sorts by that.
6660 * - identity: Does no conversion. Sorts by binary value of the string.
6662 * - uca-default: Provides access to the Unicode Collation Algorithm with
6663 * the default element table. This is a compromise collation which sorts
6664 * all languages in a mediocre way. However, it is better than "uppercase".
6666 * To use the uca-default collation, you must have PHP's intl extension
6667 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6668 * resulting collation will depend on the version of ICU installed on the
6669 * server.
6671 * After you change this, you must run maintenance/updateCollation.php to fix
6672 * the sort keys in the database.
6674 * Extensions can define there own collations by subclassing Collation
6675 * and using the Collation::factory hook.
6677 $wgCategoryCollation = 'uppercase';
6679 /** @} */ # End categories }
6681 /*************************************************************************//**
6682 * @name Logging
6683 * @{
6687 * The logging system has two levels: an event type, which describes the
6688 * general category and can be viewed as a named subset of all logs; and
6689 * an action, which is a specific kind of event that can exist in that
6690 * log type.
6692 $wgLogTypes = array(
6694 'block',
6695 'protect',
6696 'rights',
6697 'delete',
6698 'upload',
6699 'move',
6700 'import',
6701 'patrol',
6702 'merge',
6703 'suppress',
6704 'tag',
6705 'managetags',
6709 * This restricts log access to those who have a certain right
6710 * Users without this will not see it in the option menu and can not view it
6711 * Restricted logs are not added to recent changes
6712 * Logs should remain non-transcludable
6713 * Format: logtype => permissiontype
6715 $wgLogRestrictions = array(
6716 'suppress' => 'suppressionlog'
6720 * Show/hide links on Special:Log will be shown for these log types.
6722 * This is associative array of log type => boolean "hide by default"
6724 * See $wgLogTypes for a list of available log types.
6726 * @par Example:
6727 * @code
6728 * $wgFilterLogTypes = array(
6729 * 'move' => true,
6730 * 'import' => false,
6731 * );
6732 * @endcode
6734 * Will display show/hide links for the move and import logs. Move logs will be
6735 * hidden by default unless the link is clicked. Import logs will be shown by
6736 * default, and hidden when the link is clicked.
6738 * A message of the form log-show-hide-[type] should be added, and will be used
6739 * for the link text.
6741 $wgFilterLogTypes = array(
6742 'patrol' => true,
6743 'tag' => true,
6747 * Lists the message key string for each log type. The localized messages
6748 * will be listed in the user interface.
6750 * Extensions with custom log types may add to this array.
6752 * @since 1.19, if you follow the naming convention log-name-TYPE,
6753 * where TYPE is your log type, yoy don't need to use this array.
6755 $wgLogNames = array(
6756 '' => 'all-logs-page',
6757 'block' => 'blocklogpage',
6758 'protect' => 'protectlogpage',
6759 'rights' => 'rightslog',
6760 'delete' => 'dellogpage',
6761 'upload' => 'uploadlogpage',
6762 'move' => 'movelogpage',
6763 'import' => 'importlogpage',
6764 'patrol' => 'patrol-log-page',
6765 'merge' => 'mergelog',
6766 'suppress' => 'suppressionlog',
6770 * Lists the message key string for descriptive text to be shown at the
6771 * top of each log type.
6773 * Extensions with custom log types may add to this array.
6775 * @since 1.19, if you follow the naming convention log-description-TYPE,
6776 * where TYPE is your log type, yoy don't need to use this array.
6778 $wgLogHeaders = array(
6779 '' => 'alllogstext',
6780 'block' => 'blocklogtext',
6781 'protect' => 'protectlogtext',
6782 'rights' => 'rightslogtext',
6783 'delete' => 'dellogpagetext',
6784 'upload' => 'uploadlogpagetext',
6785 'move' => 'movelogpagetext',
6786 'import' => 'importlogpagetext',
6787 'patrol' => 'patrol-log-header',
6788 'merge' => 'mergelogpagetext',
6789 'suppress' => 'suppressionlogtext',
6793 * Lists the message key string for formatting individual events of each
6794 * type and action when listed in the logs.
6796 * Extensions with custom log types may add to this array.
6798 $wgLogActions = array(
6799 'protect/protect' => 'protectedarticle',
6800 'protect/modify' => 'modifiedarticleprotection',
6801 'protect/unprotect' => 'unprotectedarticle',
6802 'protect/move_prot' => 'movedarticleprotection',
6806 * The same as above, but here values are names of classes,
6807 * not messages.
6808 * @see LogPage::actionText
6809 * @see LogFormatter
6811 $wgLogActionsHandlers = array(
6812 'move/move' => 'MoveLogFormatter',
6813 'move/move_redir' => 'MoveLogFormatter',
6814 'delete/delete' => 'DeleteLogFormatter',
6815 'delete/restore' => 'DeleteLogFormatter',
6816 'delete/revision' => 'DeleteLogFormatter',
6817 'delete/event' => 'DeleteLogFormatter',
6818 'suppress/revision' => 'DeleteLogFormatter',
6819 'suppress/event' => 'DeleteLogFormatter',
6820 'suppress/delete' => 'DeleteLogFormatter',
6821 'patrol/patrol' => 'PatrolLogFormatter',
6822 'rights/rights' => 'RightsLogFormatter',
6823 'rights/autopromote' => 'RightsLogFormatter',
6824 'upload/upload' => 'UploadLogFormatter',
6825 'upload/overwrite' => 'UploadLogFormatter',
6826 'upload/revert' => 'UploadLogFormatter',
6827 'merge/merge' => 'MergeLogFormatter',
6828 'tag/update' => 'TagLogFormatter',
6829 'managetags/create' => 'LogFormatter',
6830 'managetags/delete' => 'LogFormatter',
6831 'managetags/activate' => 'LogFormatter',
6832 'managetags/deactivate' => 'LogFormatter',
6833 'block/block' => 'BlockLogFormatter',
6834 'block/unblock' => 'BlockLogFormatter',
6835 'block/reblock' => 'BlockLogFormatter',
6836 'suppress/block' => 'BlockLogFormatter',
6837 'suppress/reblock' => 'BlockLogFormatter',
6838 'import/upload' => 'LogFormatter',
6839 'import/interwiki' => 'LogFormatter',
6843 * Maintain a log of newusers at Log/newusers?
6845 $wgNewUserLog = true;
6847 /** @} */ # end logging }
6849 /*************************************************************************//**
6850 * @name Special pages (general and miscellaneous)
6851 * @{
6855 * Allow special page inclusions such as {{Special:Allpages}}
6857 $wgAllowSpecialInclusion = true;
6860 * Set this to an array of special page names to prevent
6861 * maintenance/updateSpecialPages.php from updating those pages.
6863 $wgDisableQueryPageUpdate = false;
6866 * List of special pages, followed by what subtitle they should go under
6867 * at Special:SpecialPages
6869 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6871 $wgSpecialPageGroups = array();
6874 * On Special:Unusedimages, consider images "used", if they are put
6875 * into a category. Default (false) is not to count those as used.
6877 $wgCountCategorizedImagesAsUsed = false;
6880 * Maximum number of links to a redirect page listed on
6881 * Special:Whatlinkshere/RedirectDestination
6883 $wgMaxRedirectLinksRetrieved = 500;
6885 /** @} */ # end special pages }
6887 /*************************************************************************//**
6888 * @name Actions
6889 * @{
6893 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6894 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6895 * 'foo' => true Load the class FooAction which subclasses Action
6896 * If something is specified in the getActionOverrides()
6897 * of the relevant Page object it will be used
6898 * instead of the default class.
6899 * 'foo' => false The action is disabled; show an error message
6900 * Unsetting core actions will probably cause things to complain loudly.
6902 $wgActions = array(
6903 'credits' => true,
6904 'delete' => true,
6905 'edit' => true,
6906 'editchangetags' => 'SpecialPageAction',
6907 'history' => true,
6908 'info' => true,
6909 'markpatrolled' => true,
6910 'protect' => true,
6911 'purge' => true,
6912 'raw' => true,
6913 'render' => true,
6914 'revert' => true,
6915 'revisiondelete' => 'SpecialPageAction',
6916 'rollback' => true,
6917 'submit' => true,
6918 'unprotect' => true,
6919 'unwatch' => true,
6920 'view' => true,
6921 'watch' => true,
6924 /** @} */ # end actions }
6926 /*************************************************************************//**
6927 * @name Robot (search engine crawler) policy
6928 * See also $wgNoFollowLinks.
6929 * @{
6933 * Default robot policy. The default policy is to encourage indexing and fol-
6934 * lowing of links. It may be overridden on a per-namespace and/or per-page
6935 * basis.
6937 $wgDefaultRobotPolicy = 'index,follow';
6940 * Robot policies per namespaces. The default policy is given above, the array
6941 * is made of namespace constants as defined in includes/Defines.php. You can-
6942 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6943 * nofollow. This is because a number of special pages (e.g., ListPages) have
6944 * many permutations of options that display the same data under redundant
6945 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6946 * pages, all alike, and never reaching your actual content.
6948 * @par Example:
6949 * @code
6950 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6951 * @endcode
6953 $wgNamespaceRobotPolicies = array();
6956 * Robot policies per article. These override the per-namespace robot policies.
6957 * Must be in the form of an array where the key part is a properly canonicalised
6958 * text form title and the value is a robot policy.
6960 * @par Example:
6961 * @code
6962 * $wgArticleRobotPolicies = array(
6963 * 'Main Page' => 'noindex,follow',
6964 * 'User:Bob' => 'index,follow',
6965 * );
6966 * @endcode
6968 * @par Example that DOES NOT WORK because the names are not canonical text
6969 * forms:
6970 * @code
6971 * $wgArticleRobotPolicies = array(
6972 * # Underscore, not space!
6973 * 'Main_Page' => 'noindex,follow',
6974 * # "Project", not the actual project name!
6975 * 'Project:X' => 'index,follow',
6976 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6977 * 'abc' => 'noindex,nofollow'
6978 * );
6979 * @endcode
6981 $wgArticleRobotPolicies = array();
6984 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6985 * will not function, so users can't decide whether pages in that namespace are
6986 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6988 * @par Example:
6989 * @code
6990 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6991 * @endcode
6993 $wgExemptFromUserRobotsControl = null;
6995 /** @} */ # End robot policy }
6997 /************************************************************************//**
6998 * @name AJAX and API
6999 * Note: The AJAX entry point which this section refers to is gradually being
7000 * replaced by the API entry point, api.php. They are essentially equivalent.
7001 * Both of them are used for dynamic client-side features, via XHR.
7002 * @{
7006 * Enable the MediaWiki API for convenient access to
7007 * machine-readable data via api.php
7009 * See https://www.mediawiki.org/wiki/API
7011 $wgEnableAPI = true;
7014 * Allow the API to be used to perform write operations
7015 * (page edits, rollback, etc.) when an authorised user
7016 * accesses it
7018 $wgEnableWriteAPI = true;
7022 * WARNING: SECURITY THREAT - debug use only
7024 * Disables many security checks in the API for debugging purposes.
7025 * This flag should never be used on the production servers, as it introduces
7026 * a number of potential security holes. Even when enabled, the validation
7027 * will still be performed, but instead of failing, API will return a warning.
7028 * Also, there will always be a warning notifying that this flag is set.
7029 * At this point, the flag allows GET requests to go through for modules
7030 * requiring POST.
7032 * @since 1.21
7034 $wgDebugAPI = false;
7037 * API module extensions.
7039 * Associative array mapping module name to modules specs;
7040 * Each module spec is an associative array containing at least
7041 * the 'class' key for the module's class, and optionally a
7042 * 'factory' key for the factory function to use for the module.
7044 * That factory function will be called with two parameters,
7045 * the parent module (an instance of ApiBase, usually ApiMain)
7046 * and the name the module was registered under. The return
7047 * value must be an instance of the class given in the 'class'
7048 * field.
7050 * For backward compatibility, the module spec may also be a
7051 * simple string containing the module's class name. In that
7052 * case, the class' constructor will be called with the parent
7053 * module and module name as parameters, as described above.
7055 * Examples for registering API modules:
7057 * @code
7058 * $wgAPIModules['foo'] = 'ApiFoo';
7059 * $wgAPIModules['bar'] = array(
7060 * 'class' => 'ApiBar',
7061 * 'factory' => function( $main, $name ) { ... }
7062 * );
7063 * $wgAPIModules['xyzzy'] = array(
7064 * 'class' => 'ApiXyzzy',
7065 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
7066 * );
7067 * @endcode
7069 * Extension modules may override the core modules.
7070 * See ApiMain::$Modules for a list of the core modules.
7072 $wgAPIModules = array();
7075 * API format module extensions.
7076 * Associative array mapping format module name to module specs (see $wgAPIModules).
7077 * Extension modules may override the core modules.
7079 * See ApiMain::$Formats for a list of the core format modules.
7081 $wgAPIFormatModules = array();
7084 * API Query meta module extensions.
7085 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7086 * Extension modules may override the core modules.
7088 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7090 $wgAPIMetaModules = array();
7093 * API Query prop module extensions.
7094 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7095 * Extension modules may override the core modules.
7097 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7099 $wgAPIPropModules = array();
7102 * API Query list module extensions.
7103 * Associative array mapping list module name to module specs (see $wgAPIModules).
7104 * Extension modules may override the core modules.
7106 * See ApiQuery::$QueryListModules for a list of the core list modules.
7108 $wgAPIListModules = array();
7111 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
7112 * @deprecated since 1.21
7114 $wgAPIGeneratorModules = array();
7117 * Maximum amount of rows to scan in a DB query in the API
7118 * The default value is generally fine
7120 $wgAPIMaxDBRows = 5000;
7123 * The maximum size (in bytes) of an API result.
7124 * @warning Do not set this lower than $wgMaxArticleSize*1024
7126 $wgAPIMaxResultSize = 8388608;
7129 * The maximum number of uncached diffs that can be retrieved in one API
7130 * request. Set this to 0 to disable API diffs altogether
7132 $wgAPIMaxUncachedDiffs = 1;
7135 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7136 * API request logging
7138 $wgAPIRequestLog = false;
7141 * Set the timeout for the API help text cache. If set to 0, caching disabled
7143 $wgAPICacheHelpTimeout = 60 * 60;
7146 * The ApiQueryQueryPages module should skip pages that are redundant to true
7147 * API queries.
7149 $wgAPIUselessQueryPages = array(
7150 'MIMEsearch', // aiprop=mime
7151 'LinkSearch', // list=exturlusage
7152 'FileDuplicateSearch', // prop=duplicatefiles
7156 * Enable AJAX framework
7158 $wgUseAjax = true;
7161 * List of Ajax-callable functions.
7162 * Extensions acting as Ajax callbacks must register here
7164 $wgAjaxExportList = array();
7167 * Enable watching/unwatching pages using AJAX.
7168 * Requires $wgUseAjax to be true too.
7170 $wgAjaxWatch = true;
7173 * Enable AJAX check for file overwrite, pre-upload
7175 $wgAjaxUploadDestCheck = true;
7178 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7180 $wgAjaxLicensePreview = true;
7183 * Have clients send edits to be prepared when filling in edit summaries.
7184 * This gives the server a head start on the expensive parsing operation.
7186 $wgAjaxEditStash = true;
7189 * Settings for incoming cross-site AJAX requests:
7190 * Newer browsers support cross-site AJAX when the target resource allows requests
7191 * from the origin domain by the Access-Control-Allow-Origin header.
7192 * This is currently only used by the API (requests to api.php)
7193 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7195 * - '*' matches any number of characters
7196 * - '?' matches any 1 character
7198 * @par Example:
7199 * @code
7200 * $wgCrossSiteAJAXdomains = array(
7201 * 'www.mediawiki.org',
7202 * '*.wikipedia.org',
7203 * '*.wikimedia.org',
7204 * '*.wiktionary.org',
7205 * );
7206 * @endcode
7208 $wgCrossSiteAJAXdomains = array();
7211 * Domains that should not be allowed to make AJAX requests,
7212 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7213 * Uses the same syntax as $wgCrossSiteAJAXdomains
7215 $wgCrossSiteAJAXdomainExceptions = array();
7217 /** @} */ # End AJAX and API }
7219 /************************************************************************//**
7220 * @name Shell and process control
7221 * @{
7225 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7227 $wgMaxShellMemory = 307200;
7230 * Maximum file size created by shell processes under linux, in KB
7231 * ImageMagick convert for example can be fairly hungry for scratch space
7233 $wgMaxShellFileSize = 102400;
7236 * Maximum CPU time in seconds for shell processes under Linux
7238 $wgMaxShellTime = 180;
7241 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7242 * would measure) in seconds for shell processes under Linux
7244 $wgMaxShellWallClockTime = 180;
7247 * Under Linux: a cgroup directory used to constrain memory usage of shell
7248 * commands. The directory must be writable by the user which runs MediaWiki.
7250 * If specified, this is used instead of ulimit, which is inaccurate, and
7251 * causes malloc() to return NULL, which exposes bugs in C applications, making
7252 * them segfault or deadlock.
7254 * A wrapper script will create a cgroup for each shell command that runs, as
7255 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7256 * kernel will send a SIGKILL signal to a process in the subgroup.
7258 * @par Example:
7259 * @code
7260 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7261 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7262 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7263 * @endcode
7265 * The reliability of cgroup cleanup can be improved by installing a
7266 * notify_on_release script in the root cgroup, see e.g.
7267 * https://gerrit.wikimedia.org/r/#/c/40784
7269 $wgShellCgroup = false;
7272 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7274 $wgPhpCli = '/usr/bin/php';
7277 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7278 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7279 * character set. Only the character set is relevant.
7281 $wgShellLocale = 'en_US.utf8';
7283 /** @} */ # End shell }
7285 /************************************************************************//**
7286 * @name HTTP client
7287 * @{
7291 * Timeout for HTTP requests done internally, in seconds.
7293 $wgHTTPTimeout = 25;
7296 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7298 $wgAsyncHTTPTimeout = 25;
7301 * Proxy to use for CURL requests.
7303 $wgHTTPProxy = false;
7306 * Local virtual hosts.
7308 * This lists domains that are configured as virtual hosts on the same machine.
7309 * If a request is to be made to a domain listed here, or any subdomain thereof,
7310 * then no proxy will be used.
7311 * Command-line scripts are not affected by this setting and will always use
7312 * proxy if it is configured.
7313 * @since 1.25
7315 $wgLocalVirtualHosts = array();
7318 * Timeout for connections done internally (in seconds)
7319 * Only works for curl
7321 $wgHTTPConnectTimeout = 5e0;
7323 /** @} */ # End HTTP client }
7325 /************************************************************************//**
7326 * @name Job queue
7327 * See also $wgEnotifUseJobQ.
7328 * @{
7332 * Number of jobs to perform per request. May be less than one in which case
7333 * jobs are performed probabalistically. If this is zero, jobs will not be done
7334 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7335 * be run periodically.
7337 $wgJobRunRate = 1;
7340 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7341 * to handle the job execution, instead of blocking the request until the job
7342 * execution finishes.
7343 * @since 1.23
7345 $wgRunJobsAsync = true;
7348 * Number of rows to update per job
7350 $wgUpdateRowsPerJob = 500;
7353 * Number of rows to update per query
7355 $wgUpdateRowsPerQuery = 100;
7357 /** @} */ # End job queue }
7359 /************************************************************************//**
7360 * @name Miscellaneous
7361 * @{
7365 * Name of the external diff engine to use
7367 $wgExternalDiffEngine = false;
7370 * Disable redirects to special pages and interwiki redirects, which use a 302
7371 * and have no "redirected from" link.
7373 * @note This is only for articles with #REDIRECT in them. URL's containing a
7374 * local interwiki prefix (or a non-canonical special page name) are still hard
7375 * redirected regardless of this setting.
7377 $wgDisableHardRedirects = false;
7380 * LinkHolderArray batch size
7381 * For debugging
7383 $wgLinkHolderBatchSize = 1000;
7386 * By default MediaWiki does not register links pointing to same server in
7387 * externallinks dataset, use this value to override:
7389 $wgRegisterInternalExternals = false;
7392 * Maximum number of pages to move at once when moving subpages with a page.
7394 $wgMaximumMovedPages = 100;
7397 * Fix double redirects after a page move.
7398 * Tends to conflict with page move vandalism, use only on a private wiki.
7400 $wgFixDoubleRedirects = false;
7403 * Allow redirection to another page when a user logs in.
7404 * To enable, set to a string like 'Main Page'
7406 $wgRedirectOnLogin = null;
7409 * Configuration for processing pool control, for use in high-traffic wikis.
7410 * An implementation is provided in the PoolCounter extension.
7412 * This configuration array maps pool types to an associative array. The only
7413 * defined key in the associative array is "class", which gives the class name.
7414 * The remaining elements are passed through to the class as constructor
7415 * parameters.
7417 * @par Example:
7418 * @code
7419 * $wgPoolCounterConf = array( 'ArticleView' => array(
7420 * 'class' => 'PoolCounter_Client',
7421 * 'timeout' => 15, // wait timeout in seconds
7422 * 'workers' => 5, // maximum number of active threads in each pool
7423 * 'maxqueue' => 50, // maximum number of total threads in each pool
7424 * ... any extension-specific options...
7425 * );
7426 * @endcode
7428 $wgPoolCounterConf = null;
7431 * To disable file delete/restore temporarily
7433 $wgUploadMaintenance = false;
7436 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7437 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7438 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7439 * (except for the special case of JS and CS pages).
7441 * @since 1.21
7443 $wgNamespaceContentModels = array();
7446 * How to react if a plain text version of a non-text Content object is requested using
7447 * ContentHandler::getContentText():
7449 * * 'ignore': return null
7450 * * 'fail': throw an MWException
7451 * * 'serialize': serialize to default format
7453 * @since 1.21
7455 $wgContentHandlerTextFallback = 'ignore';
7458 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7459 * This way, the ContentHandler facility can be used without any additional information in the
7460 * database. A page's content model is then derived solely from the page's title. This however
7461 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7462 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7463 * a title that would default to a different content model.
7465 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7466 * handling is less robust and less flexible.
7468 * @since 1.21
7470 $wgContentHandlerUseDB = true;
7473 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7474 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7475 * the effect on the database they would have on a wikitext page.
7477 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7478 * or at least parse only the contents of comments in the scripts.
7480 * @since 1.21
7482 $wgTextModelsToParse = array(
7483 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7484 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7485 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7489 * Whether the user must enter their password to change their e-mail address
7491 * @since 1.20
7493 $wgRequirePasswordforEmailChange = true;
7496 * Register handlers for specific types of sites.
7498 * @since 1.20
7500 $wgSiteTypes = array(
7501 'mediawiki' => 'MediaWikiSite',
7505 * Whether the page_props table has a pp_sortkey column. Set to false in case
7506 * the respective database schema change was not applied.
7507 * @since 1.23
7509 $wgPagePropsHaveSortkey = true;
7512 * Port where you have HTTPS running
7513 * Supports HTTPS on non-standard ports
7514 * @see bug 65184
7515 * @since 1.24
7517 $wgHttpsPort = 443;
7520 * Secret for hmac-based key derivation function (fast,
7521 * cryptographically secure random numbers).
7522 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7523 * be used.
7524 * See also: $wgHKDFAlgorithm
7525 * @since 1.24
7527 $wgHKDFSecret = false;
7530 * Algorithm for hmac-based key derivation function (fast,
7531 * cryptographically secure random numbers).
7532 * See also: $wgHKDFSecret
7533 * @since 1.24
7535 $wgHKDFAlgorithm = 'sha256';
7538 * Enable page language feature
7539 * Allows setting page language in database
7540 * @var bool
7541 * @since 1.24
7543 $wgPageLanguageUseDB = false;
7546 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7547 * Set this only if the fields are fully populated. This may be removed in 1.25.
7548 * @var bool
7549 * @since 1.24
7551 $wgUseLinkNamespaceDBFields = true;
7554 * Global configuration variable for Virtual REST Services.
7555 * Parameters for different services are to be declared inside
7556 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
7557 * array. Global parameters will be merged with service-specific ones. The
7558 * result will then be passed to VirtualRESTService::__construct() in the
7559 * module.
7561 * Example config for Parsoid:
7563 * $wgVirtualRestConfig['modules']['parsoid'] = array(
7564 * 'url' => 'http://localhost:8000',
7565 * 'prefix' => 'enwiki',
7566 * );
7568 * @var array
7569 * @since 1.25
7571 $wgVirtualRestConfig = array(
7572 'modules' => array(),
7573 'global' => array(
7574 # Timeout in seconds
7575 'timeout' => 360,
7576 'forwardCookies' => false,
7577 'HTTPProxy' => null
7582 * For really cool vim folding this needs to be at the end:
7583 * vim: foldmarker=@{,@} foldmethod=marker
7584 * @}