Merge "Fixed EnqueueJob::newFromLocalJobs docs"
[mediawiki.git] / includes / DefaultSettings.php
blob51e807c46ce8ecca1ad73e8346976781506f2234
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. This can either be .php
158 * or .php5.
160 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
161 * variable is provided to support those providers.
162 * @since 1.11
164 $wgScriptExtension = '.php';
166 /**@}*/
168 /************************************************************************//**
169 * @name URLs and file paths
171 * These various web and file path variables are set to their defaults
172 * in Setup.php if they are not explicitly set from LocalSettings.php.
174 * These will relatively rarely need to be set manually, unless you are
175 * splitting style sheets or images outside the main document root.
177 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
178 * the host part, that starts with a slash. In most cases a full URL is also
179 * acceptable. A "directory" is a local file path.
181 * In both paths and directories, trailing slashes should not be included.
183 * @{
187 * The URL path to index.php.
189 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
191 $wgScript = false;
194 * The URL path to load.php.
196 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
197 * @since 1.17
199 $wgLoadScript = false;
202 * The URL path of the skins directory.
203 * Defaults to "{$wgScriptPath}/skins".
204 * @since 1.3
206 $wgStylePath = false;
207 $wgStyleSheetPath = &$wgStylePath;
210 * The URL path of the skins directory. Should not point to an external domain.
211 * Defaults to "{$wgScriptPath}/skins".
212 * @since 1.17
214 $wgLocalStylePath = false;
217 * The URL path of the extensions directory.
218 * Defaults to "{$wgScriptPath}/extensions".
219 * @since 1.16
221 $wgExtensionAssetsPath = false;
224 * Filesystem stylesheets directory.
225 * Defaults to "{$IP}/skins".
226 * @since 1.3
228 $wgStyleDirectory = false;
231 * The URL path for primary article page views. This path should contain $1,
232 * which is replaced by the article title.
234 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
235 * depending on $wgUsePathInfo.
237 $wgArticlePath = false;
240 * The URL path for the images directory.
241 * Defaults to "{$wgScriptPath}/images".
243 $wgUploadPath = false;
246 * The filesystem path of the images directory. Defaults to "{$IP}/images".
248 $wgUploadDirectory = false;
251 * Directory where the cached page will be saved.
252 * Defaults to "{$wgUploadDirectory}/cache".
254 $wgFileCacheDirectory = false;
257 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
258 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
260 $wgLogo = false;
263 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
264 * should be under 135x155 pixels.
265 * Only 1.5x and 2x versions are supported.
267 * @par Example:
268 * @code
269 * $wgLogoHD = array(
270 * "1.5x" => "path/to/1.5x_version.png",
271 * "2x" => "path/to/2x_version.png"
272 * );
273 * @endcode
275 * @since 1.25
277 $wgLogoHD = false;
280 * The URL path of the shortcut icon.
281 * @since 1.6
283 $wgFavicon = '/favicon.ico';
286 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
287 * Defaults to no icon.
288 * @since 1.12
290 $wgAppleTouchIcon = false;
293 * Value for the referrer policy meta tag.
294 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
295 * prevents the meta tag from being output.
296 * See http://www.w3.org/TR/referrer-policy/ for details.
298 * @since 1.25
300 $wgReferrerPolicy = false;
303 * The local filesystem path to a temporary directory. This is not required to
304 * be web accessible.
306 * When this setting is set to false, its value will be set through a call
307 * to wfTempDir(). See that methods implementation for the actual detection
308 * logic.
310 * Developers should use the global function wfTempDir() instead of this
311 * variable.
313 * @see wfTempDir()
314 * @note Default changed to false in MediaWiki 1.20.
316 $wgTmpDirectory = false;
319 * If set, this URL is added to the start of $wgUploadPath to form a complete
320 * upload URL.
321 * @since 1.4
323 $wgUploadBaseUrl = '';
326 * To enable remote on-demand scaling, set this to the thumbnail base URL.
327 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
328 * where 'e6' are the first two characters of the MD5 hash of the file name.
329 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
330 * @since 1.17
332 $wgUploadStashScalerBaseUrl = false;
335 * To set 'pretty' URL paths for actions other than
336 * plain page views, add to this array.
338 * @par Example:
339 * Set pretty URL for the edit action:
340 * @code
341 * 'edit' => "$wgScriptPath/edit/$1"
342 * @endcode
344 * There must be an appropriate script or rewrite rule in place to handle these
345 * URLs.
346 * @since 1.5
348 $wgActionPaths = array();
350 /**@}*/
352 /************************************************************************//**
353 * @name Files and file uploads
354 * @{
358 * Uploads have to be specially set up to be secure
360 $wgEnableUploads = false;
363 * The maximum age of temporary (incomplete) uploaded files
365 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
368 * Allows to move images and other media files
370 $wgAllowImageMoving = true;
373 * Enable deferred upload tasks that use the job queue.
374 * Only enable this if job runners are set up for both the
375 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
377 * @note If you use suhosin, this setting is incompatible with
378 * suhosin.session.encrypt.
380 $wgEnableAsyncUploads = false;
383 * These are additional characters that should be replaced with '-' in filenames
385 $wgIllegalFileChars = ":";
388 * What directory to place deleted uploads in.
389 * Defaults to "{$wgUploadDirectory}/deleted".
391 $wgDeletedDirectory = false;
394 * Set this to true if you use img_auth and want the user to see details on why access failed.
396 $wgImgAuthDetails = false;
399 * Map of relative URL directories to match to internal mwstore:// base storage paths.
400 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
401 * if starts with any of the prefixes defined here. The prefixes should not overlap.
402 * The prefix that matches has a corresponding storage path, which the rest of the URL
403 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
405 * Example:
406 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
407 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
408 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
410 * @see $wgFileBackends
412 $wgImgAuthUrlPathMap = array();
415 * File repository structures
417 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
418 * an array of such structures. Each repository structure is an associative
419 * array of properties configuring the repository.
421 * Properties required for all repos:
422 * - class The class name for the repository. May come from the core or an extension.
423 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
424 * FSRepo is also supported for backwards compatibility.
426 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
427 * The name should consist of alpha-numeric characters.
428 * - backend A file backend name (see $wgFileBackends).
430 * For most core repos:
431 * - zones Associative array of zone names that each map to an array with:
432 * container : backend container name the zone is in
433 * directory : root path within container for the zone
434 * url : base URL to the root of the zone
435 * urlsByExt : map of file extension types to base URLs
436 * (useful for using a different cache for videos)
437 * Zones default to using "<repo name>-<zone name>" as the container name
438 * and default to using the container root as the zone's root directory.
439 * Nesting of zone locations within other zones should be avoided.
440 * - url Public zone URL. The 'zones' settings take precedence.
441 * - hashLevels The number of directory levels for hash-based division of files
442 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
443 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
444 * handler instead.
445 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
446 * determines whether filenames implicitly start with a capital letter.
447 * The current implementation may give incorrect description page links
448 * when the local $wgCapitalLinks and initialCapital are mismatched.
449 * - pathDisclosureProtection
450 * May be 'paranoid' to remove all parameters from error messages, 'none' to
451 * leave the paths in unchanged, or 'simple' to replace paths with
452 * placeholders. Default for LocalRepo is 'simple'.
453 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
454 * is 0644.
455 * - directory The local filesystem directory where public files are stored. Not used for
456 * some remote repos.
457 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
458 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
459 * - isPrivate Set this if measures should always be taken to keep the files private.
460 * One should not trust this to assure that the files are not web readable;
461 * the server configuration should be done manually depending on the backend.
463 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
464 * for local repositories:
465 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
466 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
467 * http://en.wikipedia.org/w
468 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
469 * $wgScriptExtension, e.g. .php5 defaults to .php
471 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
472 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
473 * $wgFetchCommonsDescriptions.
474 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
475 * Short thumbnail names only have the width, parameters, and the extension.
477 * ForeignDBRepo:
478 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
479 * equivalent to the corresponding member of $wgDBservers
480 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
481 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
483 * ForeignAPIRepo:
484 * - apibase Use for the foreign API's URL
485 * - apiThumbCacheExpiry How long to locally cache thumbs for
487 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
488 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
489 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
490 * If you set $wgForeignFileRepos to an array of repository structures, those will
491 * be searched after the local file repo.
492 * Otherwise, you will only have access to local media files.
494 * @see Setup.php for an example usage and default initialization.
496 $wgLocalFileRepo = false;
499 * @see $wgLocalFileRepo
501 $wgForeignFileRepos = array();
504 * Use Commons as a remote file repository. Essentially a wrapper, when this
505 * is enabled $wgForeignFileRepos will point at Commons with a set of default
506 * settings
508 $wgUseInstantCommons = false;
511 * File backend structure configuration.
513 * This is an array of file backend configuration arrays.
514 * Each backend configuration has the following parameters:
515 * - 'name' : A unique name for the backend
516 * - 'class' : The file backend class to use
517 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
518 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
520 * See FileBackend::__construct() for more details.
521 * Additional parameters are specific to the file backend class used.
522 * These settings should be global to all wikis when possible.
524 * There are two particularly important aspects about each backend:
525 * - a) Whether it is fully qualified or wiki-relative.
526 * By default, the paths of files are relative to the current wiki,
527 * which works via prefixing them with the current wiki ID when accessed.
528 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
529 * all paths with the specified value instead. This can be useful if
530 * multiple wikis need to share the same data. Note that 'name' is *not*
531 * part of any prefix and thus should not be relied upon for namespacing.
532 * - b) Whether it is only defined for some wikis or is defined on all
533 * wikis in the wiki farm. Defining a backend globally is useful
534 * if multiple wikis need to share the same data.
535 * One should be aware of these aspects when configuring a backend for use with
536 * any basic feature or plugin. For example, suppose an extension stores data for
537 * different wikis in different directories and sometimes needs to access data from
538 * a foreign wiki's directory in order to render a page on given wiki. The extension
539 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
541 $wgFileBackends = array();
544 * Array of configuration arrays for each lock manager.
545 * Each backend configuration has the following parameters:
546 * - 'name' : A unique name for the lock manager
547 * - 'class' : The lock manger class to use
549 * See LockManager::__construct() for more details.
550 * Additional parameters are specific to the lock manager class used.
551 * These settings should be global to all wikis.
553 $wgLockManagers = array();
556 * Show Exif data, on by default if available.
557 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
559 * @note FOR WINDOWS USERS:
560 * To enable Exif functions, add the following lines to the "Windows
561 * extensions" section of php.ini:
562 * @code{.ini}
563 * extension=extensions/php_mbstring.dll
564 * extension=extensions/php_exif.dll
565 * @endcode
567 $wgShowEXIF = function_exists( 'exif_read_data' );
570 * If to automatically update the img_metadata field
571 * if the metadata field is outdated but compatible with the current version.
572 * Defaults to false.
574 $wgUpdateCompatibleMetadata = false;
577 * If you operate multiple wikis, you can define a shared upload path here.
578 * Uploads to this wiki will NOT be put there - they will be put into
579 * $wgUploadDirectory.
580 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
581 * no file of the given name is found in the local repository (for [[File:..]],
582 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
583 * directory.
585 * Note that these configuration settings can now be defined on a per-
586 * repository basis for an arbitrary number of file repositories, using the
587 * $wgForeignFileRepos variable.
589 $wgUseSharedUploads = false;
592 * Full path on the web server where shared uploads can be found
594 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
597 * Fetch commons image description pages and display them on the local wiki?
599 $wgFetchCommonsDescriptions = false;
602 * Path on the file system where shared uploads can be found.
604 $wgSharedUploadDirectory = "/var/www/wiki3/images";
607 * DB name with metadata about shared directory.
608 * Set this to false if the uploads do not come from a wiki.
610 $wgSharedUploadDBname = false;
613 * Optional table prefix used in database.
615 $wgSharedUploadDBprefix = '';
618 * Cache shared metadata in memcached.
619 * Don't do this if the commons wiki is in a different memcached domain
621 $wgCacheSharedUploads = true;
624 * Allow for upload to be copied from an URL.
625 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
626 * You have to assign the user right 'upload_by_url' to a user group, to use this.
628 $wgAllowCopyUploads = false;
631 * Allow asynchronous copy uploads.
632 * This feature is experimental and broken as of r81612.
634 $wgAllowAsyncCopyUploads = false;
637 * A list of domains copy uploads can come from
639 * @since 1.20
641 $wgCopyUploadsDomains = array();
644 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
645 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
646 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
648 $wgCopyUploadsFromSpecialUpload = false;
651 * Proxy to use for copy upload requests.
652 * @since 1.20
654 $wgCopyUploadProxy = false;
657 * Different timeout for upload by url
658 * This could be useful since when fetching large files, you may want a
659 * timeout longer than the default $wgHTTPTimeout. False means fallback
660 * to default.
662 * @since 1.22
664 $wgCopyUploadTimeout = false;
667 * Different timeout for upload by url when run as a background job
668 * This could be useful since when fetching large files via job queue,
669 * you may want a different timeout, especially because there is no
670 * http request being kept alive.
672 * false means fallback to $wgCopyUploadTimeout.
673 * @since 1.22
675 $wgCopyUploadAsyncTimeout = false;
678 * Max size for uploads, in bytes. If not set to an array, applies to all
679 * uploads. If set to an array, per upload type maximums can be set, using the
680 * file and url keys. If the * key is set this value will be used as maximum
681 * for non-specified types.
683 * @par Example:
684 * @code
685 * $wgMaxUploadSize = array(
686 * '*' => 250 * 1024,
687 * 'url' => 500 * 1024,
688 * );
689 * @endcode
690 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
691 * will have a maximum of 500 kB.
693 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
696 * Point the upload navigation link to an external URL
697 * Useful if you want to use a shared repository by default
698 * without disabling local uploads (use $wgEnableUploads = false for that).
700 * @par Example:
701 * @code
702 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
703 * @endcode
705 $wgUploadNavigationUrl = false;
708 * Point the upload link for missing files to an external URL, as with
709 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
710 * appended to it as appropriate.
712 $wgUploadMissingFileUrl = false;
715 * Give a path here to use thumb.php for thumbnail generation on client
716 * request, instead of generating them on render and outputting a static URL.
717 * This is necessary if some of your apache servers don't have read/write
718 * access to the thumbnail path.
720 * @par Example:
721 * @code
722 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
723 * @endcode
725 $wgThumbnailScriptPath = false;
728 * @see $wgThumbnailScriptPath
730 $wgSharedThumbnailScriptPath = false;
733 * Set this to false if you do not want MediaWiki to divide your images
734 * directory into many subdirectories, for improved performance.
736 * It's almost always good to leave this enabled. In previous versions of
737 * MediaWiki, some users set this to false to allow images to be added to the
738 * wiki by simply copying them into $wgUploadDirectory and then running
739 * maintenance/rebuildImages.php to register them in the database. This is no
740 * longer recommended, use maintenance/importImages.php instead.
742 * @note That this variable may be ignored if $wgLocalFileRepo is set.
743 * @todo Deprecate the setting and ultimately remove it from Core.
745 $wgHashedUploadDirectory = true;
748 * Set the following to false especially if you have a set of files that need to
749 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
750 * directory layout.
752 $wgHashedSharedUploadDirectory = true;
755 * Base URL for a repository wiki. Leave this blank if uploads are just stored
756 * in a shared directory and not meant to be accessible through a separate wiki.
757 * Otherwise the image description pages on the local wiki will link to the
758 * image description page on this wiki.
760 * Please specify the namespace, as in the example below.
762 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
765 * This is the list of preferred extensions for uploading files. Uploading files
766 * with extensions not in this list will trigger a warning.
768 * @warning If you add any OpenOffice or Microsoft Office file formats here,
769 * such as odt or doc, and untrusted users are allowed to upload files, then
770 * your wiki will be vulnerable to cross-site request forgery (CSRF).
772 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
775 * Files with these extensions will never be allowed as uploads.
776 * An array of file extensions to blacklist. You should append to this array
777 * if you want to blacklist additional files.
779 $wgFileBlacklist = array(
780 # HTML may contain cookie-stealing JavaScript and web bugs
781 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
782 # PHP scripts may execute arbitrary code on the server
783 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
784 # Other types that may be interpreted by some servers
785 'shtml', 'jhtml', 'pl', 'py', 'cgi',
786 # May contain harmful executables for Windows victims
787 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
790 * Files with these MIME types will never be allowed as uploads
791 * if $wgVerifyMimeType is enabled.
793 $wgMimeTypeBlacklist = array(
794 # HTML may contain cookie-stealing JavaScript and web bugs
795 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
796 # PHP scripts may execute arbitrary code on the server
797 'application/x-php', 'text/x-php',
798 # Other types that may be interpreted by some servers
799 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
800 # Client-side hazards on Internet Explorer
801 'text/scriptlet', 'application/x-msdownload',
802 # Windows metafile, client-side vulnerability on some systems
803 'application/x-msmetafile',
807 * Allow Java archive uploads.
808 * This is not recommended for public wikis since a maliciously-constructed
809 * applet running on the same domain as the wiki can steal the user's cookies.
811 $wgAllowJavaUploads = false;
814 * This is a flag to determine whether or not to check file extensions on upload.
816 * @warning Setting this to false is insecure for public wikis.
818 $wgCheckFileExtensions = true;
821 * If this is turned off, users may override the warning for files not covered
822 * by $wgFileExtensions.
824 * @warning Setting this to false is insecure for public wikis.
826 $wgStrictFileExtensions = true;
829 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
831 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
832 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
834 $wgDisableUploadScriptChecks = false;
837 * Warn if uploaded files are larger than this (in bytes), or false to disable
839 $wgUploadSizeWarning = false;
842 * list of trusted media-types and MIME types.
843 * Use the MEDIATYPE_xxx constants to represent media types.
844 * This list is used by File::isSafeFile
846 * Types not listed here will have a warning about unsafe content
847 * displayed on the images description page. It would also be possible
848 * to use this for further restrictions, like disabling direct
849 * [[media:...]] links for non-trusted formats.
851 $wgTrustedMediaFormats = array(
852 MEDIATYPE_BITMAP, //all bitmap formats
853 MEDIATYPE_AUDIO, //all audio formats
854 MEDIATYPE_VIDEO, //all plain video formats
855 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
856 "application/pdf", //PDF files
857 #"application/x-shockwave-flash", //flash/shockwave movie
861 * Plugins for media file type handling.
862 * Each entry in the array maps a MIME type to a class name
864 $wgMediaHandlers = array(
865 'image/jpeg' => 'JpegHandler',
866 'image/png' => 'PNGHandler',
867 'image/gif' => 'GIFHandler',
868 'image/tiff' => 'TiffHandler',
869 'image/x-ms-bmp' => 'BmpHandler',
870 'image/x-bmp' => 'BmpHandler',
871 'image/x-xcf' => 'XCFHandler',
872 'image/svg+xml' => 'SvgHandler', // official
873 'image/svg' => 'SvgHandler', // compat
874 'image/vnd.djvu' => 'DjVuHandler', // official
875 'image/x.djvu' => 'DjVuHandler', // compat
876 'image/x-djvu' => 'DjVuHandler', // compat
880 * Plugins for page content model handling.
881 * Each entry in the array maps a model id to a class name.
883 * @since 1.21
885 $wgContentHandlers = array(
886 // the usual case
887 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
888 // dumb version, no syntax highlighting
889 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
890 // simple implementation, for use by extensions, etc.
891 CONTENT_MODEL_JSON => 'JsonContentHandler',
892 // dumb version, no syntax highlighting
893 CONTENT_MODEL_CSS => 'CssContentHandler',
894 // plain text, for use by extensions, etc.
895 CONTENT_MODEL_TEXT => 'TextContentHandler',
899 * Whether to enable server-side image thumbnailing. If false, images will
900 * always be sent to the client in full resolution, with appropriate width= and
901 * height= attributes on the <img> tag for the client to do its own scaling.
903 $wgUseImageResize = true;
906 * Resizing can be done using PHP's internal image libraries or using
907 * ImageMagick or another third-party converter, e.g. GraphicMagick.
908 * These support more file formats than PHP, which only supports PNG,
909 * GIF, JPG, XBM and WBMP.
911 * Use Image Magick instead of PHP builtin functions.
913 $wgUseImageMagick = false;
916 * The convert command shipped with ImageMagick
918 $wgImageMagickConvertCommand = '/usr/bin/convert';
921 * Sharpening parameter to ImageMagick
923 $wgSharpenParameter = '0x0.4';
926 * Reduction in linear dimensions below which sharpening will be enabled
928 $wgSharpenReductionThreshold = 0.85;
931 * Temporary directory used for ImageMagick. The directory must exist. Leave
932 * this set to false to let ImageMagick decide for itself.
934 $wgImageMagickTempDir = false;
937 * Use another resizing converter, e.g. GraphicMagick
938 * %s will be replaced with the source path, %d with the destination
939 * %w and %h will be replaced with the width and height.
941 * @par Example for GraphicMagick:
942 * @code
943 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
944 * @endcode
946 * Leave as false to skip this.
948 $wgCustomConvertCommand = false;
951 * used for lossless jpeg rotation
953 * @since 1.21
955 $wgJpegTran = '/usr/bin/jpegtran';
958 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
959 * image formats.
961 $wgExiv2Command = '/usr/bin/exiv2';
964 * Scalable Vector Graphics (SVG) may be uploaded as images.
965 * Since SVG support is not yet standard in browsers, it is
966 * necessary to rasterize SVGs to PNG as a fallback format.
968 * An external program is required to perform this conversion.
969 * If set to an array, the first item is a PHP callable and any further items
970 * are passed as parameters after $srcPath, $dstPath, $width, $height
972 $wgSVGConverters = array(
973 'ImageMagick' =>
974 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
975 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
976 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
977 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
978 . '$output $input',
979 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
980 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
981 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
985 * Pick a converter defined in $wgSVGConverters
987 $wgSVGConverter = 'ImageMagick';
990 * If not in the executable PATH, specify the SVG converter path.
992 $wgSVGConverterPath = '';
995 * Don't scale a SVG larger than this
997 $wgSVGMaxSize = 2048;
1000 * Don't read SVG metadata beyond this point.
1001 * Default is 1024*256 bytes
1003 $wgSVGMetadataCutoff = 262144;
1006 * Disallow <title> element in SVG files.
1008 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1009 * browsers which can not perform basic stuff like MIME detection and which are
1010 * vulnerable to further idiots uploading crap files as images.
1012 * When this directive is on, "<title>" will be allowed in files with an
1013 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1014 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1016 $wgAllowTitlesInSVG = false;
1019 * The maximum number of pixels a source image can have if it is to be scaled
1020 * down by a scaler that requires the full source image to be decompressed
1021 * and stored in decompressed form, before the thumbnail is generated.
1023 * This provides a limit on memory usage for the decompression side of the
1024 * image scaler. The limit is used when scaling PNGs with any of the
1025 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1026 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1028 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1029 * 12.5 million pixels or 3500x3500.
1031 $wgMaxImageArea = 1.25e7;
1034 * Force thumbnailing of animated GIFs above this size to a single
1035 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1036 * is checked against the total size of all frames in the animation.
1037 * It probably makes sense to keep this equal to $wgMaxImageArea.
1039 $wgMaxAnimatedGifArea = 1.25e7;
1042 * Browsers don't support TIFF inline generally...
1043 * For inline display, we need to convert to PNG or JPEG.
1044 * Note scaling should work with ImageMagick, but may not with GD scaling.
1046 * @par Example:
1047 * @code
1048 * // PNG is lossless, but inefficient for photos
1049 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1050 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1051 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1052 * @endcode
1054 $wgTiffThumbnailType = false;
1057 * If rendered thumbnail files are older than this timestamp, they
1058 * will be rerendered on demand as if the file didn't already exist.
1059 * Update if there is some need to force thumbs and SVG rasterizations
1060 * to rerender, such as fixes to rendering bugs.
1062 $wgThumbnailEpoch = '20030516000000';
1065 * Certain operations are avoided if there were too many recent failures,
1066 * for example, thumbnail generation. Bump this value to invalidate all
1067 * memory of failed operations and thus allow further attempts to resume.
1068 * This is useful when a cause for the failures has been found and fixed.
1070 $wgAttemptFailureEpoch = 1;
1073 * If set, inline scaled images will still produce "<img>" tags ready for
1074 * output instead of showing an error message.
1076 * This may be useful if errors are transitory, especially if the site
1077 * is configured to automatically render thumbnails on request.
1079 * On the other hand, it may obscure error conditions from debugging.
1080 * Enable the debug log or the 'thumbnail' log group to make sure errors
1081 * are logged to a file for review.
1083 $wgIgnoreImageErrors = false;
1086 * Allow thumbnail rendering on page view. If this is false, a valid
1087 * thumbnail URL is still output, but no file will be created at
1088 * the target location. This may save some time if you have a
1089 * thumb.php or 404 handler set up which is faster than the regular
1090 * webserver(s).
1092 $wgGenerateThumbnailOnParse = true;
1095 * Show thumbnails for old images on the image description page
1097 $wgShowArchiveThumbnails = true;
1100 * If set to true, images that contain certain the exif orientation tag will
1101 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1102 * is available that can rotate.
1104 $wgEnableAutoRotation = null;
1107 * Internal name of virus scanner. This serves as a key to the
1108 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1109 * null, every file uploaded will be scanned for viruses.
1111 $wgAntivirus = null;
1114 * Configuration for different virus scanners. This an associative array of
1115 * associative arrays. It contains one setup array per known scanner type.
1116 * The entry is selected by $wgAntivirus, i.e.
1117 * valid values for $wgAntivirus are the keys defined in this array.
1119 * The configuration array for each scanner contains the following keys:
1120 * "command", "codemap", "messagepattern":
1122 * "command" is the full command to call the virus scanner - %f will be
1123 * replaced with the name of the file to scan. If not present, the filename
1124 * will be appended to the command. Note that this must be overwritten if the
1125 * scanner is not in the system path; in that case, please set
1126 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1127 * path.
1129 * "codemap" is a mapping of exit code to return codes of the detectVirus
1130 * function in SpecialUpload.
1131 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1132 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1133 * is not set.
1134 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1135 * the file to have an unsupported format, which is probably immune to
1136 * viruses. This causes the file to pass.
1137 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1138 * no virus was found.
1139 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1140 * a virus.
1141 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1143 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1144 * output. The relevant part should be matched as group one (\1).
1145 * If not defined or the pattern does not match, the full message is shown to the user.
1147 $wgAntivirusSetup = array(
1149 #setup for clamav
1150 'clamav' => array(
1151 'command' => 'clamscan --no-summary ',
1152 'codemap' => array(
1153 "0" => AV_NO_VIRUS, # no virus
1154 "1" => AV_VIRUS_FOUND, # virus found
1155 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1156 "*" => AV_SCAN_FAILED, # else scan failed
1158 'messagepattern' => '/.*?:(.*)/sim',
1163 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1165 $wgAntivirusRequired = true;
1168 * Determines if the MIME type of uploaded files should be checked
1170 $wgVerifyMimeType = true;
1173 * Sets the MIME type definition file to use by MimeMagic.php.
1174 * Set to null, to use built-in defaults only.
1175 * example: $wgMimeTypeFile = '/etc/mime.types';
1177 $wgMimeTypeFile = 'includes/mime.types';
1180 * Sets the MIME type info file to use by MimeMagic.php.
1181 * Set to null, to use built-in defaults only.
1183 $wgMimeInfoFile = 'includes/mime.info';
1186 * Sets an external MIME detector program. The command must print only
1187 * the MIME type to standard output.
1188 * The name of the file to process will be appended to the command given here.
1189 * If not set or NULL, PHP's fileinfo extension will be used if available.
1191 * @par Example:
1192 * @code
1193 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1194 * @endcode
1196 $wgMimeDetectorCommand = null;
1199 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1200 * things, because only a few types of images are needed and file extensions
1201 * can be trusted.
1203 $wgTrivialMimeDetection = false;
1206 * Additional XML types we can allow via MIME-detection.
1207 * array = ( 'rootElement' => 'associatedMimeType' )
1209 $wgXMLMimeTypes = array(
1210 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1211 'svg' => 'image/svg+xml',
1212 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1213 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1214 'html' => 'text/html', // application/xhtml+xml?
1218 * Limit images on image description pages to a user-selectable limit. In order
1219 * to reduce disk usage, limits can only be selected from a list.
1220 * The user preference is saved as an array offset in the database, by default
1221 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1222 * change it if you alter the array (see bug 8858).
1223 * This is the list of settings the user can choose from:
1225 $wgImageLimits = array(
1226 array( 320, 240 ),
1227 array( 640, 480 ),
1228 array( 800, 600 ),
1229 array( 1024, 768 ),
1230 array( 1280, 1024 )
1234 * Adjust thumbnails on image pages according to a user setting. In order to
1235 * reduce disk usage, the values can only be selected from a list. This is the
1236 * list of settings the user can choose from:
1238 $wgThumbLimits = array(
1239 120,
1240 150,
1241 180,
1242 200,
1243 250,
1248 * When defined, is an array of image widths used as buckets for thumbnail generation.
1249 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1250 * always using the original. This will incur a speed gain but cause a quality loss.
1252 * The buckets generation is chained, with each bucket generated based on the above bucket
1253 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1254 * supports it.
1256 $wgThumbnailBuckets = null;
1259 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1260 * above the requested size. The distance represents how many extra pixels of width the bucket
1261 * needs in order to be used as the reference for a given thumbnail. For example, with the
1262 * following buckets:
1264 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1266 * and a distance of 50:
1268 * $wgThumbnailMinimumBucketDistance = 50;
1270 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1271 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1273 $wgThumbnailMinimumBucketDistance = 50;
1276 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1277 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1278 * has a performance impact for the first client to view a certain size.
1280 * This obviously means that more disk space is needed per upload upfront.
1282 * @since 1.25
1285 $wgUploadThumbnailRenderMap = array();
1288 * The method through which the thumbnails will be prerendered for the entries in
1289 * $wgUploadThumbnailRenderMap
1291 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1292 * thumbnail's URL.
1293 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1294 * option uses the job queue to render the thumbnail.
1296 * @since 1.25
1298 $wgUploadThumbnailRenderMethod = 'jobqueue';
1301 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1303 * @since 1.25
1305 $wgUploadThumbnailRenderHttpCustomHost = false;
1308 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1309 * HTTP request to.
1311 * @since 1.25
1313 $wgUploadThumbnailRenderHttpCustomDomain = false;
1316 * Default parameters for the "<gallery>" tag
1318 $wgGalleryOptions = array(
1319 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1320 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1321 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1322 'captionLength' => 25, // Length of caption to truncate (in characters)
1323 'showBytes' => true, // Show the filesize in bytes in categories
1324 'mode' => 'traditional',
1328 * Adjust width of upright images when parameter 'upright' is used
1329 * This allows a nicer look for upright images without the need to fix the width
1330 * by hardcoded px in wiki sourcecode.
1332 $wgThumbUpright = 0.75;
1335 * Default value for chmoding of new directories.
1337 $wgDirectoryMode = 0777;
1340 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1342 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1343 * thumbnails, output via the srcset attribute.
1345 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1346 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1347 * The polyfill can be found in the jquery.hidpi module.
1349 $wgResponsiveImages = true;
1352 * @name DJVU settings
1353 * @{
1357 * Path of the djvudump executable
1358 * Enable this and $wgDjvuRenderer to enable djvu rendering
1359 * example: $wgDjvuDump = 'djvudump';
1361 $wgDjvuDump = null;
1364 * Path of the ddjvu DJVU renderer
1365 * Enable this and $wgDjvuDump to enable djvu rendering
1366 * example: $wgDjvuRenderer = 'ddjvu';
1368 $wgDjvuRenderer = null;
1371 * Path of the djvutxt DJVU text extraction utility
1372 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1373 * example: $wgDjvuTxt = 'djvutxt';
1375 $wgDjvuTxt = null;
1378 * Path of the djvutoxml executable
1379 * This works like djvudump except much, much slower as of version 3.5.
1381 * For now we recommend you use djvudump instead. The djvuxml output is
1382 * probably more stable, so we'll switch back to it as soon as they fix
1383 * the efficiency problem.
1384 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1386 * @par Example:
1387 * @code
1388 * $wgDjvuToXML = 'djvutoxml';
1389 * @endcode
1391 $wgDjvuToXML = null;
1394 * Shell command for the DJVU post processor
1395 * Default: pnmtojpeg, since ddjvu generates ppm output
1396 * Set this to false to output the ppm file directly.
1398 $wgDjvuPostProcessor = 'pnmtojpeg';
1401 * File extension for the DJVU post processor output
1403 $wgDjvuOutputExtension = 'jpg';
1405 /** @} */ # end of DJvu }
1407 /** @} */ # end of file uploads }
1409 /************************************************************************//**
1410 * @name Email settings
1411 * @{
1416 * Site admin email address.
1418 * Defaults to "wikiadmin@$wgServerName".
1420 $wgEmergencyContact = false;
1423 * Password reminder email address.
1425 * The address we should use as sender when a user is requesting his password.
1427 * Defaults to "apache@$wgServerName".
1429 $wgPasswordSender = false;
1432 * Password reminder name
1434 * @deprecated since 1.23; use the system message 'emailsender' instead.
1436 $wgPasswordSenderName = 'MediaWiki Mail';
1439 * Dummy address which should be accepted during mail send action.
1440 * It might be necessary to adapt the address or to set it equal
1441 * to the $wgEmergencyContact address.
1443 $wgNoReplyAddress = 'reply@not.possible';
1446 * Set to true to enable the e-mail basic features:
1447 * Password reminders, etc. If sending e-mail on your
1448 * server doesn't work, you might want to disable this.
1450 $wgEnableEmail = true;
1453 * Set to true to enable user-to-user e-mail.
1454 * This can potentially be abused, as it's hard to track.
1456 $wgEnableUserEmail = true;
1459 * Set to true to put the sending user's email in a Reply-To header
1460 * instead of From. ($wgEmergencyContact will be used as From.)
1462 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1463 * which can cause problems with SPF validation and leak recipient addresses
1464 * when bounces are sent to the sender.
1466 $wgUserEmailUseReplyTo = false;
1469 * Minimum time, in hours, which must elapse between password reminder
1470 * emails for a given account. This is to prevent abuse by mail flooding.
1472 $wgPasswordReminderResendTime = 24;
1475 * The time, in seconds, when an emailed temporary password expires.
1477 $wgNewPasswordExpiry = 3600 * 24 * 7;
1480 * The time, in seconds, when an email confirmation email expires
1482 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1485 * The number of days that a user's password is good for. After this number of days, the
1486 * user will be asked to reset their password. Set to false to disable password expiration.
1488 $wgPasswordExpirationDays = false;
1491 * If a user's password is expired, the number of seconds when they can still login,
1492 * and cancel their password change, but are sent to the password change form on each login.
1494 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1497 * SMTP Mode.
1499 * For using a direct (authenticated) SMTP server connection.
1500 * Default to false or fill an array :
1502 * @code
1503 * $wgSMTP = array(
1504 * 'host' => 'SMTP domain',
1505 * 'IDHost' => 'domain for MessageID',
1506 * 'port' => '25',
1507 * 'auth' => [true|false],
1508 * 'username' => [SMTP username],
1509 * 'password' => [SMTP password],
1510 * );
1511 * @endcode
1513 $wgSMTP = false;
1516 * Additional email parameters, will be passed as the last argument to mail() call.
1517 * If using safe_mode this has no effect
1519 $wgAdditionalMailParams = null;
1522 * For parts of the system that have been updated to provide HTML email content, send
1523 * both text and HTML parts as the body of the email
1525 $wgAllowHTMLEmail = false;
1528 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1529 * from $wgEmergencyContact
1531 $wgEnotifFromEditor = false;
1533 // TODO move UPO to preferences probably ?
1534 # If set to true, users get a corresponding option in their preferences and can choose to
1535 # enable or disable at their discretion
1536 # If set to false, the corresponding input form on the user preference page is suppressed
1537 # It call this to be a "user-preferences-option (UPO)"
1540 * Require email authentication before sending mail to an email address.
1541 * This is highly recommended. It prevents MediaWiki from being used as an open
1542 * spam relay.
1544 $wgEmailAuthentication = true;
1547 * Allow users to enable email notification ("enotif") on watchlist changes.
1549 $wgEnotifWatchlist = false;
1552 * Allow users to enable email notification ("enotif") when someone edits their
1553 * user talk page.
1555 $wgEnotifUserTalk = false;
1558 * Set the Reply-to address in notifications to the editor's address, if user
1559 * allowed this in the preferences.
1561 $wgEnotifRevealEditorAddress = false;
1564 * Send notification mails on minor edits to watchlist pages. This is enabled
1565 * by default. Does not affect user talk notifications.
1567 $wgEnotifMinorEdits = true;
1570 * Send a generic mail instead of a personalised mail for each user. This
1571 * always uses UTC as the time zone, and doesn't include the username.
1573 * For pages with many users watching, this can significantly reduce mail load.
1574 * Has no effect when using sendmail rather than SMTP.
1576 $wgEnotifImpersonal = false;
1579 * Maximum number of users to mail at once when using impersonal mail. Should
1580 * match the limit on your mail server.
1582 $wgEnotifMaxRecips = 500;
1585 * Send mails via the job queue. This can be useful to reduce the time it
1586 * takes to save a page that a lot of people are watching.
1588 $wgEnotifUseJobQ = false;
1591 * Use the job queue for user activity updates like updating "last visited"
1592 * fields for email notifications of page changes. This should only be enabled
1593 * if the jobs have a dedicated runner to avoid update lag.
1595 * @since 1.26
1597 $wgActivityUpdatesUseJobQueue = false;
1600 * Use real name instead of username in e-mail "from" field.
1602 $wgEnotifUseRealName = false;
1605 * Array of usernames who will be sent a notification email for every change
1606 * which occurs on a wiki. Users will not be notified of their own changes.
1608 $wgUsersNotifiedOnAllChanges = array();
1610 /** @} */ # end of email settings
1612 /************************************************************************//**
1613 * @name Database settings
1614 * @{
1618 * Database host name or IP address
1620 $wgDBserver = 'localhost';
1623 * Database port number (for PostgreSQL and Microsoft SQL Server).
1625 $wgDBport = 5432;
1628 * Name of the database
1630 $wgDBname = 'my_wiki';
1633 * Database username
1635 $wgDBuser = 'wikiuser';
1638 * Database user's password
1640 $wgDBpassword = '';
1643 * Database type
1645 $wgDBtype = 'mysql';
1648 * Whether to use SSL in DB connection.
1650 * This setting is only used $wgLBFactoryConf['class'] is set to
1651 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1652 * the DBO_SSL flag must be set in the 'flags' option of the database
1653 * connection to achieve the same functionality.
1655 $wgDBssl = false;
1658 * Whether to use compression 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_COMPRESS flag must be set in the 'flags' option of the database
1663 * connection to achieve the same functionality.
1665 $wgDBcompress = false;
1668 * Separate username for maintenance tasks. Leave as null to use the default.
1670 $wgDBadminuser = null;
1673 * Separate password for maintenance tasks. Leave as null to use the default.
1675 $wgDBadminpassword = null;
1678 * Search type.
1679 * Leave as null to select the default search engine for the
1680 * selected database type (eg SearchMySQL), or set to a class
1681 * name to override to a custom search engine.
1683 $wgSearchType = null;
1686 * Alternative search types
1687 * Sometimes you want to support multiple search engines for testing. This
1688 * allows users to select their search engine of choice via url parameters
1689 * to Special:Search and the action=search API. If using this, there's no
1690 * need to add $wgSearchType to it, that is handled automatically.
1692 $wgSearchTypeAlternatives = null;
1695 * Table name prefix
1697 $wgDBprefix = '';
1700 * MySQL table options to use during installation or update
1702 $wgDBTableOptions = 'ENGINE=InnoDB';
1705 * SQL Mode - default is turning off all modes, including strict, if set.
1706 * null can be used to skip the setting for performance reasons and assume
1707 * DBA has done his best job.
1708 * String override can be used for some additional fun :-)
1710 $wgSQLMode = '';
1713 * Mediawiki schema
1715 $wgDBmwschema = null;
1718 * To override default SQLite data directory ($docroot/../data)
1720 $wgSQLiteDataDir = '';
1723 * Make all database connections secretly go to localhost. Fool the load balancer
1724 * thinking there is an arbitrarily large cluster of servers to connect to.
1725 * Useful for debugging.
1727 $wgAllDBsAreLocalhost = false;
1730 * Shared database for multiple wikis. Commonly used for storing a user table
1731 * for single sign-on. The server for this database must be the same as for the
1732 * main database.
1734 * For backwards compatibility the shared prefix is set to the same as the local
1735 * prefix, and the user table is listed in the default list of shared tables.
1736 * The user_properties table is also added so that users will continue to have their
1737 * preferences shared (preferences were stored in the user table prior to 1.16)
1739 * $wgSharedTables may be customized with a list of tables to share in the shared
1740 * database. However it is advised to limit what tables you do share as many of
1741 * MediaWiki's tables may have side effects if you try to share them.
1743 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1744 * $wgDBprefix.
1746 * $wgSharedSchema is the table schema for the shared database. It defaults to
1747 * $wgDBmwschema.
1749 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1750 * access remote databases. Using wfGetLB() allows the shared database to
1751 * reside on separate servers to the wiki's own database, with suitable
1752 * configuration of $wgLBFactoryConf.
1754 $wgSharedDB = null;
1757 * @see $wgSharedDB
1759 $wgSharedPrefix = false;
1762 * @see $wgSharedDB
1764 $wgSharedTables = array( 'user', 'user_properties' );
1767 * @see $wgSharedDB
1768 * @since 1.23
1770 $wgSharedSchema = false;
1773 * Database load balancer
1774 * This is a two-dimensional array, an array of server info structures
1775 * Fields are:
1776 * - host: Host name
1777 * - dbname: Default database name
1778 * - user: DB user
1779 * - password: DB password
1780 * - type: DB type
1782 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1783 * If this is zero for any given server, no normal query traffic will be
1784 * sent to it. It will be excluded from lag checks in maintenance scripts.
1785 * The only way it can receive traffic is if groupLoads is used.
1787 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1788 * to several groups, the most specific group defined here is used.
1790 * - flags: bit field
1791 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1792 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1793 * - DBO_TRX -- wrap entire request in a transaction
1794 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1795 * - DBO_PERSISTENT -- enables persistent database connections
1796 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1797 * - DBO_COMPRESS -- uses internal compression in database connections,
1798 * if available
1800 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1802 * These and any other user-defined properties will be assigned to the mLBInfo member
1803 * variable of the Database object.
1805 * Leave at false to use the single-server variables above. If you set this
1806 * variable, the single-server variables will generally be ignored (except
1807 * perhaps in some command-line scripts).
1809 * The first server listed in this array (with key 0) will be the master. The
1810 * rest of the servers will be slaves. To prevent writes to your slaves due to
1811 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1812 * slaves in my.cnf. You can set read_only mode at runtime using:
1814 * @code
1815 * SET @@read_only=1;
1816 * @endcode
1818 * Since the effect of writing to a slave is so damaging and difficult to clean
1819 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1820 * our masters, and then set read_only=0 on masters at runtime.
1822 $wgDBservers = false;
1825 * Load balancer factory configuration
1826 * To set up a multi-master wiki farm, set the class here to something that
1827 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1828 * The class identified here is responsible for reading $wgDBservers,
1829 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1831 * The LBFactoryMulti class is provided for this purpose, please see
1832 * includes/db/LBFactoryMulti.php for configuration information.
1834 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1837 * How long to wait for a slave to catch up to the master
1838 * @deprecated since 1.24
1840 $wgMasterWaitTimeout = 10;
1843 * File to log database errors to
1845 $wgDBerrorLog = false;
1848 * Timezone to use in the error log.
1849 * Defaults to the wiki timezone ($wgLocaltimezone).
1851 * A list of usable timezones can found at:
1852 * http://php.net/manual/en/timezones.php
1854 * @par Examples:
1855 * @code
1856 * $wgDBerrorLogTZ = 'UTC';
1857 * $wgDBerrorLogTZ = 'GMT';
1858 * $wgDBerrorLogTZ = 'PST8PDT';
1859 * $wgDBerrorLogTZ = 'Europe/Sweden';
1860 * $wgDBerrorLogTZ = 'CET';
1861 * @endcode
1863 * @since 1.20
1865 $wgDBerrorLogTZ = false;
1868 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1869 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1871 * @warning THIS IS EXPERIMENTAL!
1873 * May break if you're not using the table defs from mysql5/tables.sql.
1874 * May break if you're upgrading an existing wiki if set differently.
1875 * Broken symptoms likely to include incorrect behavior with page titles,
1876 * usernames, comments etc containing non-ASCII characters.
1877 * Might also cause failures on the object cache and other things.
1879 * Even correct usage may cause failures with Unicode supplementary
1880 * characters (those not in the Basic Multilingual Plane) unless MySQL
1881 * has enhanced their Unicode support.
1883 $wgDBmysql5 = false;
1886 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1888 * To use this feature set to true and use a datasource defined as
1889 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1890 * block).
1892 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1893 * Pool) that maintains established sessions and reuses them on new
1894 * connections.
1896 * Not completely tested, but it should fall back on normal connection
1897 * in case the pool is full or the datasource is not configured as
1898 * pooled.
1899 * And the other way around; using oci_pconnect on a non pooled
1900 * datasource should produce a normal connection.
1902 * When it comes to frequent shortlived DB connections like with MW
1903 * Oracle tends to s***. The problem is the driver connects to the
1904 * database reasonably fast, but establishing a session takes time and
1905 * resources. MW does not rely on session state (as it does not use
1906 * features such as package variables) so establishing a valid session
1907 * is in this case an unwanted overhead that just slows things down.
1909 * @warning EXPERIMENTAL!
1912 $wgDBOracleDRCP = false;
1915 * Other wikis on this site, can be administered from a single developer
1916 * account.
1917 * Array numeric key => database name
1919 $wgLocalDatabases = array();
1922 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1923 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1924 * show a more obvious warning.
1926 $wgSlaveLagWarning = 10;
1929 * @see $wgSlaveLagWarning
1931 $wgSlaveLagCritical = 30;
1934 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1936 $wgDBWindowsAuthentication = false;
1938 /**@}*/ # End of DB settings }
1940 /************************************************************************//**
1941 * @name Text storage
1942 * @{
1946 * We can also compress text stored in the 'text' table. If this is set on, new
1947 * revisions will be compressed on page save if zlib support is available. Any
1948 * compressed revisions will be decompressed on load regardless of this setting,
1949 * but will not be readable at all* if zlib support is not available.
1951 $wgCompressRevisions = false;
1954 * External stores allow including content
1955 * from non database sources following URL links.
1957 * Short names of ExternalStore classes may be specified in an array here:
1958 * @code
1959 * $wgExternalStores = array("http","file","custom")...
1960 * @endcode
1962 * CAUTION: Access to database might lead to code execution
1964 $wgExternalStores = array();
1967 * An array of external MySQL servers.
1969 * @par Example:
1970 * Create a cluster named 'cluster1' containing three servers:
1971 * @code
1972 * $wgExternalServers = array(
1973 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1974 * );
1975 * @endcode
1977 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1978 * another class.
1980 $wgExternalServers = array();
1983 * The place to put new revisions, false to put them in the local text table.
1984 * Part of a URL, e.g. DB://cluster1
1986 * Can be an array instead of a single string, to enable data distribution. Keys
1987 * must be consecutive integers, starting at zero.
1989 * @par Example:
1990 * @code
1991 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1992 * @endcode
1994 * @var array
1996 $wgDefaultExternalStore = false;
1999 * Revision text may be cached in $wgMemc to reduce load on external storage
2000 * servers and object extraction overhead for frequently-loaded revisions.
2002 * Set to 0 to disable, or number of seconds before cache expiry.
2004 $wgRevisionCacheExpiry = 0;
2006 /** @} */ # end text storage }
2008 /************************************************************************//**
2009 * @name Performance hacks and limits
2010 * @{
2014 * Disable database-intensive features
2016 $wgMiserMode = false;
2019 * Disable all query pages if miser mode is on, not just some
2021 $wgDisableQueryPages = false;
2024 * Number of rows to cache in 'querycache' table when miser mode is on
2026 $wgQueryCacheLimit = 1000;
2029 * Number of links to a page required before it is deemed "wanted"
2031 $wgWantedPagesThreshold = 1;
2034 * Enable slow parser functions
2036 $wgAllowSlowParserFunctions = false;
2039 * Allow schema updates
2041 $wgAllowSchemaUpdates = true;
2044 * Maximum article size in kilobytes
2046 $wgMaxArticleSize = 2048;
2049 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2050 * raise PHP's memory limit if it's below this amount.
2052 $wgMemoryLimit = "50M";
2054 /** @} */ # end performance hacks }
2056 /************************************************************************//**
2057 * @name Cache settings
2058 * @{
2062 * Directory for caching data in the local filesystem. Should not be accessible
2063 * from the web. Set this to false to not use any local caches.
2065 * Note: if multiple wikis share the same localisation cache directory, they
2066 * must all have the same set of extensions. You can set a directory just for
2067 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2069 $wgCacheDirectory = false;
2072 * Main cache type. This should be a cache with fast access, but it may have
2073 * limited space. By default, it is disabled, since the stock database cache
2074 * is not fast enough to make it worthwhile.
2076 * The options are:
2078 * - CACHE_ANYTHING: Use anything, as long as it works
2079 * - CACHE_NONE: Do not cache
2080 * - CACHE_DB: Store cache objects in the DB
2081 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2082 * - CACHE_ACCEL: APC, XCache or WinCache
2083 * - (other): A string may be used which identifies a cache
2084 * configuration in $wgObjectCaches.
2086 * @see $wgMessageCacheType, $wgParserCacheType
2088 $wgMainCacheType = CACHE_NONE;
2091 * The cache type for storing the contents of the MediaWiki namespace. This
2092 * cache is used for a small amount of data which is expensive to regenerate.
2094 * For available types see $wgMainCacheType.
2096 $wgMessageCacheType = CACHE_ANYTHING;
2099 * The cache type for storing article HTML. This is used to store data which
2100 * is expensive to regenerate, and benefits from having plenty of storage space.
2102 * For available types see $wgMainCacheType.
2104 $wgParserCacheType = CACHE_ANYTHING;
2107 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2109 * For available types see $wgMainCacheType.
2111 $wgSessionCacheType = CACHE_ANYTHING;
2114 * The cache type for storing language conversion tables,
2115 * which are used when parsing certain text and interface messages.
2117 * For available types see $wgMainCacheType.
2119 * @since 1.20
2121 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2124 * Advanced object cache configuration.
2126 * Use this to define the class names and constructor parameters which are used
2127 * for the various cache types. Custom cache types may be defined here and
2128 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2129 * or $wgLanguageConverterCacheType.
2131 * The format is an associative array where the key is a cache identifier, and
2132 * the value is an associative array of parameters. The "class" parameter is the
2133 * class name which will be used. Alternatively, a "factory" parameter may be
2134 * given, giving a callable function which will generate a suitable cache object.
2136 $wgObjectCaches = array(
2137 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2138 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2140 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2141 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2142 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached', 'loggroup' => 'memcached' ),
2144 'apc' => array( 'class' => 'APCBagOStuff' ),
2145 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2146 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2147 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2148 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2149 'hash' => array( 'class' => 'HashBagOStuff' ),
2153 * Main cache Wide-Area-Network cache type. This should be a cache with fast access,
2154 * but it may have limited space. By default, it is disabled, since the basic stock
2155 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2156 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2157 * cache with a relayer of type EventRelayerNull.
2159 * The options are:
2160 * - false: Configure the cache using $wgMainCacheType, without using
2161 * a relayer (only matters if there are multiple data-centers)
2162 * - CACHE_NONE: Do not cache
2163 * - (other): A string may be used which identifies a cache
2164 * configuration in $wgWANObjectCaches.
2166 $wgMainWANCache = false;
2169 * Advanced WAN object cache configuration.
2171 * Each WAN cache wraps a registered object cache (for the local cluster)
2172 * and it must also be configured to point to a PubSub instance. Subscribers
2173 * must be configured to relay purges to the actual cache servers.
2175 * The format is an associative array where the key is a cache identifier, and
2176 * the value is an associative array of parameters. The "cacheId" parameter is
2177 * a cache identifier from $wgObjectCaches. The "relayerConfig" parameter is an
2178 * array used to construct an EventRelayer object. The "pool" parameter is a
2179 * string that is used as a PubSub channel prefix.
2181 $wgWANObjectCaches = array(
2182 CACHE_NONE => array(
2183 'class' => 'WANObjectCache',
2184 'cacheId' => CACHE_NONE,
2185 'pool' => 'mediawiki-main-none',
2186 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2188 /* Example of a simple single data-center cache:
2189 'memcached-php' => array(
2190 'class' => 'WANObjectCache',
2191 'cacheId' => 'memcached-php',
2192 'pool' => 'mediawiki-main-memcached',
2193 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2199 * The expiry time for the parser cache, in seconds.
2200 * The default is 86400 (one day).
2202 $wgParserCacheExpireTime = 86400;
2205 * Deprecated alias for $wgSessionsInObjectCache.
2207 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2209 $wgSessionsInMemcached = false;
2212 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2213 * can be useful to improve performance, or to avoid the locking behavior of
2214 * PHP's default session handler, which tends to prevent multiple requests for
2215 * the same user from acting concurrently.
2217 $wgSessionsInObjectCache = false;
2220 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2221 * enabled, in seconds.
2223 $wgObjectCacheSessionExpiry = 3600;
2226 * This is used for setting php's session.save_handler. In practice, you will
2227 * almost never need to change this ever. Other options might be 'user' or
2228 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2229 * useful if you're doing cross-application sessions, see bug 11381)
2231 $wgSessionHandler = null;
2234 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2236 $wgMemCachedDebug = false;
2239 * The list of MemCached servers and port numbers
2241 $wgMemCachedServers = array( '127.0.0.1:11211' );
2244 * Use persistent connections to MemCached, which are shared across multiple
2245 * requests.
2247 $wgMemCachedPersistent = false;
2250 * Read/write timeout for MemCached server communication, in microseconds.
2252 $wgMemCachedTimeout = 500000;
2255 * Set this to true to make a local copy of the message cache, for use in
2256 * addition to memcached. The files will be put in $wgCacheDirectory.
2258 $wgUseLocalMessageCache = false;
2261 * Instead of caching everything, only cache those messages which have
2262 * been customised in the site content language. This means that
2263 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2264 * This option is probably only useful for translatewiki.net.
2266 $wgAdaptiveMessageCache = false;
2269 * Localisation cache configuration. Associative array with keys:
2270 * class: The class to use. May be overridden by extensions.
2272 * store: The location to store cache data. May be 'files', 'db' or
2273 * 'detect'. If set to "files", data will be in CDB files. If set
2274 * to "db", data will be stored to the database. If set to
2275 * "detect", files will be used if $wgCacheDirectory is set,
2276 * otherwise the database will be used.
2278 * storeClass: The class name for the underlying storage. If set to a class
2279 * name, it overrides the "store" setting.
2281 * storeDirectory: If the store class puts its data in files, this is the
2282 * directory it will use. If this is false, $wgCacheDirectory
2283 * will be used.
2285 * manualRecache: Set this to true to disable cache updates on web requests.
2286 * Use maintenance/rebuildLocalisationCache.php instead.
2288 $wgLocalisationCacheConf = array(
2289 'class' => 'LocalisationCache',
2290 'store' => 'detect',
2291 'storeClass' => false,
2292 'storeDirectory' => false,
2293 'manualRecache' => false,
2297 * Allow client-side caching of pages
2299 $wgCachePages = true;
2302 * Set this to current time to invalidate all prior cached pages. Affects both
2303 * client-side and server-side caching.
2304 * You can get the current date on your server by using the command:
2305 * @verbatim
2306 * date +%Y%m%d%H%M%S
2307 * @endverbatim
2309 $wgCacheEpoch = '20030516000000';
2312 * Directory where GitInfo will look for pre-computed cache files. If false,
2313 * $wgCacheDirectory/gitinfo will be used.
2315 $wgGitInfoCacheDirectory = false;
2318 * Bump this number when changing the global style sheets and JavaScript.
2320 * It should be appended in the query string of static CSS and JS includes,
2321 * to ensure that client-side caches do not keep obsolete copies of global
2322 * styles.
2324 $wgStyleVersion = '303';
2327 * This will cache static pages for non-logged-in users to reduce
2328 * database traffic on public sites.
2329 * Automatically sets $wgShowIPinHeader = false
2330 * ResourceLoader requests to default language and skins are cached
2331 * as well as single module requests.
2333 $wgUseFileCache = false;
2336 * Depth of the subdirectory hierarchy to be created under
2337 * $wgFileCacheDirectory. The subdirectories will be named based on
2338 * the MD5 hash of the title. A value of 0 means all cache files will
2339 * be put directly into the main file cache directory.
2341 $wgFileCacheDepth = 2;
2344 * Keep parsed pages in a cache (objectcache table or memcached)
2345 * to speed up output of the same page viewed by another user with the
2346 * same options.
2348 * This can provide a significant speedup for medium to large pages,
2349 * so you probably want to keep it on. Extensions that conflict with the
2350 * parser cache should disable the cache on a per-page basis instead.
2352 $wgEnableParserCache = true;
2355 * Append a configured value to the parser cache and the sitenotice key so
2356 * that they can be kept separate for some class of activity.
2358 $wgRenderHashAppend = '';
2361 * If on, the sidebar navigation links are cached for users with the
2362 * current language set. This can save a touch of load on a busy site
2363 * by shaving off extra message lookups.
2365 * However it is also fragile: changing the site configuration, or
2366 * having a variable $wgArticlePath, can produce broken links that
2367 * don't update as expected.
2369 $wgEnableSidebarCache = false;
2372 * Expiry time for the sidebar cache, in seconds
2374 $wgSidebarCacheExpiry = 86400;
2377 * When using the file cache, we can store the cached HTML gzipped to save disk
2378 * space. Pages will then also be served compressed to clients that support it.
2380 * Requires zlib support enabled in PHP.
2382 $wgUseGzip = false;
2385 * Whether MediaWiki should send an ETag header. Seems to cause
2386 * broken behavior with Squid 2.6, see bug 7098.
2388 $wgUseETag = false;
2391 * Clock skew or the one-second resolution of time() can occasionally cause cache
2392 * problems when the user requests two pages within a short period of time. This
2393 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2394 * a grace period.
2396 $wgClockSkewFudge = 5;
2399 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2400 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2401 * was previously done in the default LocalSettings.php file.
2403 * On high-traffic wikis, this should be set to false, to avoid the need to
2404 * check the file modification time, and to avoid the performance impact of
2405 * unnecessary cache invalidations.
2407 $wgInvalidateCacheOnLocalSettingsChange = true;
2410 * When loading extensions through the extension registration system, this
2411 * can be used to invalidate the cache. A good idea would be to set this to
2412 * one file, you can just `touch` that one to invalidate the cache
2414 * @par Example:
2415 * @code
2416 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2417 * @endcode
2419 * If set to false, the mtime for each individual JSON file will be checked,
2420 * which can be slow if a large number of extensions are being loaded.
2422 * @var int|bool
2424 $wgExtensionInfoMTime = false;
2426 /** @} */ # end of cache settings
2428 /************************************************************************//**
2429 * @name HTTP proxy (Squid) settings
2431 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2432 * although they are referred to as Squid settings for historical reasons.
2434 * Achieving a high hit ratio with an HTTP proxy requires special
2435 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2436 * more details.
2438 * @{
2442 * Enable/disable Squid.
2443 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2445 $wgUseSquid = false;
2448 * If you run Squid3 with ESI support, enable this (default:false):
2450 $wgUseESI = false;
2453 * Send X-Vary-Options header for better caching (requires patched Squid)
2455 $wgUseXVO = false;
2458 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2459 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2460 * and need to split the cache between HTTP and HTTPS for API requests,
2461 * feed requests and HTTP redirect responses in order to prevent cache
2462 * pollution. This does not affect 'normal' requests to index.php other than
2463 * HTTP redirects.
2465 $wgVaryOnXFP = false;
2468 * Internal server name as known to Squid, if different.
2470 * @par Example:
2471 * @code
2472 * $wgInternalServer = 'http://yourinternal.tld:8000';
2473 * @endcode
2475 $wgInternalServer = false;
2478 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2479 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2480 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2481 * days
2483 $wgSquidMaxage = 18000;
2486 * Default maximum age for raw CSS/JS accesses
2488 $wgForcedRawSMaxage = 300;
2491 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2493 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2494 * headers sent/modified from these proxies when obtaining the remote IP address
2496 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2498 $wgSquidServers = array();
2501 * As above, except these servers aren't purged on page changes; use to set a
2502 * list of trusted proxies, etc. Supports both individual IP addresses and
2503 * CIDR blocks.
2504 * @since 1.23 Supports CIDR ranges
2506 $wgSquidServersNoPurge = array();
2509 * Maximum number of titles to purge in any one client operation
2511 $wgMaxSquidPurgeTitles = 400;
2514 * Whether to use a Host header in purge requests sent to the proxy servers
2515 * configured in $wgSquidServers. Set this to false to support Squid
2516 * configured in forward-proxy mode.
2518 * If this is set to true, a Host header will be sent, and only the path
2519 * component of the URL will appear on the request line, as if the request
2520 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2521 * request. Squid supports this style of request only if reverse-proxy mode
2522 * (http_port ... accel) is enabled.
2524 * If this is set to false, no Host header will be sent, and the absolute URL
2525 * will be sent in the request line, as is the standard for an HTTP proxy
2526 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2527 * by Varnish, but is supported by Squid in either configuration (forward or
2528 * reverse).
2530 * @since 1.21
2532 $wgSquidPurgeUseHostHeader = true;
2535 * Routing configuration for HTCP multicast purging. Add elements here to
2536 * enable HTCP and determine which purges are sent where. If set to an empty
2537 * array, HTCP is disabled.
2539 * Each key in this array is a regular expression to match against the purged
2540 * URL, or an empty string to match all URLs. The purged URL is matched against
2541 * the regexes in the order specified, and the first rule whose regex matches
2542 * is used, all remaining rules will thus be ignored.
2544 * @par Example configuration to send purges for upload.wikimedia.org to one
2545 * multicast group and all other purges to another:
2546 * @code
2547 * $wgHTCPRouting = array(
2548 * '|^https?://upload\.wikimedia\.org|' => array(
2549 * 'host' => '239.128.0.113',
2550 * 'port' => 4827,
2551 * ),
2552 * '' => array(
2553 * 'host' => '239.128.0.112',
2554 * 'port' => 4827,
2555 * ),
2556 * );
2557 * @endcode
2559 * You can also pass an array of hosts to send purges too. This is useful when
2560 * you have several multicast groups or unicast address that should receive a
2561 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2563 * @par Example of sending purges to multiple hosts:
2564 * @code
2565 * $wgHTCPRouting = array(
2566 * '' => array(
2567 * // Purges to text caches using multicast
2568 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2569 * // Purges to a hardcoded list of caches
2570 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2571 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2572 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2573 * ),
2574 * );
2575 * @endcode
2577 * @since 1.22
2579 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2580 * For back compatibility purposes, whenever its array is empty
2581 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2583 * @see $wgHTCPMulticastTTL
2585 $wgHTCPRouting = array();
2588 * HTCP multicast TTL.
2589 * @see $wgHTCPRouting
2591 $wgHTCPMulticastTTL = 1;
2594 * Should forwarded Private IPs be accepted?
2596 $wgUsePrivateIPs = false;
2598 /** @} */ # end of HTTP proxy settings
2600 /************************************************************************//**
2601 * @name Language, regional and character encoding settings
2602 * @{
2606 * Site language code. See languages/Names.php for languages supported by
2607 * MediaWiki out of the box. Not all languages listed there have translations,
2608 * see languages/messages/ for the list of languages with some localisation.
2610 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2611 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2613 * This defines the default interface language for all users, but users can
2614 * change it in their preferences.
2616 * This also defines the language of pages in the wiki. The content is wrapped
2617 * in a html element with lang=XX attribute. This behavior can be overridden
2618 * via hooks, see Title::getPageLanguage.
2620 $wgLanguageCode = 'en';
2623 * Language cache size, or really how many languages can we handle
2624 * simultaneously without degrading to crawl speed.
2626 $wgLangObjCacheSize = 10;
2629 * Some languages need different word forms, usually for different cases.
2630 * Used in Language::convertGrammar().
2632 * @par Example:
2633 * @code
2634 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2635 * @endcode
2637 $wgGrammarForms = array();
2640 * Treat language links as magic connectors, not inline links
2642 $wgInterwikiMagic = true;
2645 * Hide interlanguage links from the sidebar
2647 $wgHideInterlanguageLinks = false;
2650 * List of additional interwiki prefixes that should be treated as
2651 * interlanguage links (i.e. placed in the sidebar).
2652 * Notes:
2653 * - This will not do anything unless the prefixes are defined in the interwiki
2654 * map.
2655 * - The display text for these custom interlanguage links will be fetched from
2656 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2657 * this array.
2658 * - A friendly name for each site, used for tooltip text, may optionally be
2659 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2660 * the prefix in this array.
2662 $wgExtraInterlanguageLinkPrefixes = array();
2665 * List of language names or overrides for default names in Names.php
2667 $wgExtraLanguageNames = array();
2670 * List of language codes that don't correspond to an actual language.
2671 * These codes are mostly left-offs from renames, or other legacy things.
2672 * This array makes them not appear as a selectable language on the installer,
2673 * and excludes them when running the transstat.php script.
2675 $wgDummyLanguageCodes = array(
2676 'als' => 'gsw',
2677 'bat-smg' => 'sgs',
2678 'be-x-old' => 'be-tarask',
2679 'bh' => 'bho',
2680 'fiu-vro' => 'vro',
2681 'no' => 'nb',
2682 'qqq' => 'qqq', # Used for message documentation.
2683 'qqx' => 'qqx', # Used for viewing message keys.
2684 'roa-rup' => 'rup',
2685 'simple' => 'en',
2686 'zh-classical' => 'lzh',
2687 'zh-min-nan' => 'nan',
2688 'zh-yue' => 'yue',
2692 * Character set for use in the article edit box. Language-specific encodings
2693 * may be defined.
2695 * This historic feature is one of the first that was added by former MediaWiki
2696 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2698 $wgEditEncoding = '';
2701 * Set this to true to replace Arabic presentation forms with their standard
2702 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2703 * set to "ar".
2705 * Note that pages with titles containing presentation forms will become
2706 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2708 $wgFixArabicUnicode = true;
2711 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2712 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2713 * set to "ml". Note that some clients (even new clients as of 2010) do not
2714 * support these characters.
2716 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2717 * fix any ZWJ sequences in existing page titles.
2719 $wgFixMalayalamUnicode = true;
2722 * Set this to always convert certain Unicode sequences to modern ones
2723 * regardless of the content language. This has a small performance
2724 * impact.
2726 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2727 * details.
2729 * @since 1.17
2731 $wgAllUnicodeFixes = false;
2734 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2735 * loading old revisions not marked with "utf-8" flag. Use this when
2736 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2737 * burdensome mass conversion of old text data.
2739 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2740 * user names, etc still must be converted en masse in the database before
2741 * continuing as a UTF-8 wiki.
2743 $wgLegacyEncoding = false;
2746 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2747 * regexps : "/regexp/" matching problematic browsers. These browsers will
2748 * be served encoded unicode in the edit box instead of real unicode.
2750 $wgBrowserBlackList = array(
2752 * Netscape 2-4 detection
2753 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2754 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2755 * with a negative assertion. The [UIN] identifier specifies the level of security
2756 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2757 * The language string is unreliable, it is missing on NS4 Mac.
2759 * Reference: http://www.psychedelix.com/agents/index.shtml
2761 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2762 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2763 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2766 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2767 * Þ to <THORN> and Ð to <ETH>
2769 * Known useragents:
2770 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2771 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2772 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2773 * - [...]
2775 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2776 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2778 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2781 * Google wireless transcoder, seems to eat a lot of chars alive
2782 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2784 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2788 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2789 * create stub reference rows in the text table instead of copying
2790 * the full text of all current entries from 'cur' to 'text'.
2792 * This will speed up the conversion step for large sites, but
2793 * requires that the cur table be kept around for those revisions
2794 * to remain viewable.
2796 * This option affects the updaters *only*. Any present cur stub
2797 * revisions will be readable at runtime regardless of this setting.
2799 $wgLegacySchemaConversion = false;
2802 * Enable dates like 'May 12' instead of '12 May', if the default date format
2803 * is 'dmy or mdy'.
2805 $wgAmericanDates = false;
2808 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2809 * numerals in interface.
2811 $wgTranslateNumerals = true;
2814 * Translation using MediaWiki: namespace.
2815 * Interface messages will be loaded from the database.
2817 $wgUseDatabaseMessages = true;
2820 * Expiry time for the message cache key
2822 $wgMsgCacheExpiry = 86400;
2825 * Maximum entry size in the message cache, in bytes
2827 $wgMaxMsgCacheEntrySize = 10000;
2830 * Whether to enable language variant conversion.
2832 $wgDisableLangConversion = false;
2835 * Whether to enable language variant conversion for links.
2837 $wgDisableTitleConversion = false;
2840 * Default variant code, if false, the default will be the language code
2842 $wgDefaultLanguageVariant = false;
2845 * Disabled variants array of language variant conversion.
2847 * @par Example:
2848 * @code
2849 * $wgDisabledVariants[] = 'zh-mo';
2850 * $wgDisabledVariants[] = 'zh-my';
2851 * @endcode
2853 $wgDisabledVariants = array();
2856 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2857 * path format that describes which parts of the URL contain the
2858 * language variant.
2860 * @par Example:
2861 * @code
2862 * $wgLanguageCode = 'sr';
2863 * $wgVariantArticlePath = '/$2/$1';
2864 * $wgArticlePath = '/wiki/$1';
2865 * @endcode
2867 * A link to /wiki/ would be redirected to /sr/Главна_страна
2869 * It is important that $wgArticlePath not overlap with possible values
2870 * of $wgVariantArticlePath.
2872 $wgVariantArticlePath = false;
2875 * Show a bar of language selection links in the user login and user
2876 * registration forms; edit the "loginlanguagelinks" message to
2877 * customise these.
2879 $wgLoginLanguageSelector = false;
2882 * When translating messages with wfMessage(), it is not always clear what
2883 * should be considered UI messages and what should be content messages.
2885 * For example, for the English Wikipedia, there should be only one 'mainpage',
2886 * so when getting the link for 'mainpage', we should treat it as site content
2887 * and call ->inContentLanguage()->text(), but for rendering the text of the
2888 * link, we call ->text(). The code behaves this way by default. However,
2889 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2890 * and the like for different languages. This array provides a way to override
2891 * the default behavior.
2893 * @par Example:
2894 * To allow language-specific main page and community
2895 * portal:
2896 * @code
2897 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2898 * @endcode
2900 $wgForceUIMsgAsContentMsg = array();
2903 * Fake out the timezone that the server thinks it's in. This will be used for
2904 * date display and not for what's stored in the DB. Leave to null to retain
2905 * your server's OS-based timezone value.
2907 * This variable is currently used only for signature formatting and for local
2908 * time/date parser variables ({{LOCALTIME}} etc.)
2910 * Timezones can be translated by editing MediaWiki messages of type
2911 * timezone-nameinlowercase like timezone-utc.
2913 * A list of usable timezones can found at:
2914 * http://php.net/manual/en/timezones.php
2916 * @par Examples:
2917 * @code
2918 * $wgLocaltimezone = 'UTC';
2919 * $wgLocaltimezone = 'GMT';
2920 * $wgLocaltimezone = 'PST8PDT';
2921 * $wgLocaltimezone = 'Europe/Sweden';
2922 * $wgLocaltimezone = 'CET';
2923 * @endcode
2925 $wgLocaltimezone = null;
2928 * Set an offset from UTC in minutes to use for the default timezone setting
2929 * for anonymous users and new user accounts.
2931 * This setting is used for most date/time displays in the software, and is
2932 * overridable in user preferences. It is *not* used for signature timestamps.
2934 * By default, this will be set to match $wgLocaltimezone.
2936 $wgLocalTZoffset = null;
2938 /** @} */ # End of language/charset settings
2940 /*************************************************************************//**
2941 * @name Output format and skin settings
2942 * @{
2946 * The default Content-Type header.
2948 $wgMimeType = 'text/html';
2951 * Previously used as content type in HTML script tags. This is now ignored since
2952 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2953 * It was also previously used by RawAction to determine the ctype query parameter
2954 * value that will result in a javascript response.
2955 * @deprecated since 1.22
2957 $wgJsMimeType = null;
2960 * The default xmlns attribute. The option to define this has been removed.
2961 * The value of this variable is no longer used by core and is set to a fixed
2962 * value in Setup.php for compatibility with extensions that depend on the value
2963 * of this variable being set. Such a dependency however is deprecated.
2964 * @deprecated since 1.22
2966 $wgXhtmlDefaultNamespace = null;
2969 * Previously used to determine if we should output an HTML5 doctype.
2970 * This is no longer used as we always output HTML5 now. For compatibility with
2971 * extensions that still check the value of this config it's value is now forced
2972 * to true by Setup.php.
2973 * @deprecated since 1.22
2975 $wgHtml5 = true;
2978 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2979 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2980 * (like if it's left at the default null value), it will be auto-initialized
2981 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2982 * ever actually set this to anything.
2984 $wgHtml5Version = null;
2987 * Temporary variable that allows HTMLForms to be rendered as tables.
2988 * Table based layouts cause various issues when designing for mobile.
2989 * This global allows skins or extensions a means to force non-table based rendering.
2990 * Setting to false forces form components to always render as div elements.
2991 * @since 1.24
2993 $wgHTMLFormAllowTableFormat = true;
2996 * Temporary variable that applies MediaWiki UI wherever it can be supported.
2997 * Temporary variable that should be removed when mediawiki ui is more
2998 * stable and change has been communicated.
2999 * @since 1.24
3001 $wgUseMediaWikiUIEverywhere = false;
3004 * Enabled RDFa attributes for use in wikitext.
3005 * NOTE: Interaction with HTML5 is somewhat underspecified.
3007 $wgAllowRdfaAttributes = false;
3010 * Enabled HTML5 microdata attributes for use in wikitext.
3012 $wgAllowMicrodataAttributes = false;
3015 * Should we try to make our HTML output well-formed XML? If set to false,
3016 * output will be a few bytes shorter, and the HTML will arguably be more
3017 * readable. If set to true, life will be much easier for the authors of
3018 * screen-scraping bots, and the HTML will arguably be more readable.
3020 * Setting this to false may omit quotation marks on some attributes, omit
3021 * slashes from some self-closing tags, omit some ending tags, etc., where
3022 * permitted by HTML5. Setting it to true will not guarantee that all pages
3023 * will be well-formed, although non-well-formed pages should be rare and it's
3024 * a bug if you find one. Conversely, setting it to false doesn't mean that
3025 * all XML-y constructs will be omitted, just that they might be.
3027 * Because of compatibility with screen-scraping bots, and because it's
3028 * controversial, this is currently left to true by default.
3030 $wgWellFormedXml = true;
3033 * Permit other namespaces in addition to the w3.org default.
3035 * Use the prefix for the key and the namespace for the value.
3037 * @par Example:
3038 * @code
3039 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3040 * @endcode
3041 * Normally we wouldn't have to define this in the root "<html>"
3042 * element, but IE needs it there in some circumstances.
3044 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3046 $wgXhtmlNamespaces = array();
3049 * Show IP address, for non-logged in users. It's necessary to switch this off
3050 * for some forms of caching.
3051 * @warning Will disable file cache.
3053 $wgShowIPinHeader = true;
3056 * Site notice shown at the top of each page
3058 * MediaWiki:Sitenotice page, which will override this. You can also
3059 * provide a separate message for logged-out users using the
3060 * MediaWiki:Anonnotice page.
3062 $wgSiteNotice = '';
3065 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3067 $wgSiteSupportPage = '';
3070 * Validate the overall output using tidy and refuse
3071 * to display the page if it's not valid.
3073 $wgValidateAllHtml = false;
3076 * Default skin, for new users and anonymous visitors. Registered users may
3077 * change this to any one of the other available skins in their preferences.
3079 $wgDefaultSkin = 'vector';
3082 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3084 * @since 1.24
3086 $wgFallbackSkin = 'fallback';
3089 * Specify the names of skins that should not be presented in the list of
3090 * available skins in user preferences. If you want to remove a skin entirely,
3091 * remove it from the skins/ directory and its entry from LocalSettings.php.
3093 $wgSkipSkins = array();
3096 * @deprecated since 1.23; use $wgSkipSkins instead
3098 $wgSkipSkin = '';
3101 * Allow user Javascript page?
3102 * This enables a lot of neat customizations, but may
3103 * increase security risk to users and server load.
3105 $wgAllowUserJs = false;
3108 * Allow user Cascading Style Sheets (CSS)?
3109 * This enables a lot of neat customizations, but may
3110 * increase security risk to users and server load.
3112 $wgAllowUserCss = false;
3115 * Allow user-preferences implemented in CSS?
3116 * This allows users to customise the site appearance to a greater
3117 * degree; disabling it will improve page load times.
3119 $wgAllowUserCssPrefs = true;
3122 * Use the site's Javascript page?
3124 $wgUseSiteJs = true;
3127 * Use the site's Cascading Style Sheets (CSS)?
3129 $wgUseSiteCss = true;
3132 * Break out of framesets. This can be used to prevent clickjacking attacks,
3133 * or to prevent external sites from framing your site with ads.
3135 $wgBreakFrames = false;
3138 * The X-Frame-Options header to send on pages sensitive to clickjacking
3139 * attacks, such as edit pages. This prevents those pages from being displayed
3140 * in a frame or iframe. The options are:
3142 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3144 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3145 * to allow framing within a trusted domain. This is insecure if there
3146 * is a page on the same domain which allows framing of arbitrary URLs.
3148 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3149 * full compromise of local user accounts. Private wikis behind a
3150 * corporate firewall are especially vulnerable. This is not
3151 * recommended.
3153 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3154 * not just edit pages.
3156 $wgEditPageFrameOptions = 'DENY';
3159 * Disallow framing of API pages directly, by setting the X-Frame-Options
3160 * header. Since the API returns CSRF tokens, allowing the results to be
3161 * framed can compromise your user's account security.
3162 * Options are:
3163 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3164 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3165 * - false: Allow all framing.
3166 * Note: $wgBreakFrames will override this for human formatted API output.
3168 $wgApiFrameOptions = 'DENY';
3171 * Disable output compression (enabled by default if zlib is available)
3173 $wgDisableOutputCompression = false;
3176 * Should we allow a broader set of characters in id attributes, per HTML5? If
3177 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3178 * functionality is ready, it will be on by default with no option.
3180 * Currently this appears to work fine in all browsers, but it's disabled by
3181 * default because it normalizes id's a bit too aggressively, breaking preexisting
3182 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3184 $wgExperimentalHtmlIds = false;
3187 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3188 * You can add new icons to the built in copyright or poweredby, or you can create
3189 * a new block. Though note that you may need to add some custom css to get good styling
3190 * of new blocks in monobook. vector and modern should work without any special css.
3192 * $wgFooterIcons itself is a key/value array.
3193 * The key is the name of a block that the icons will be wrapped in. The final id varies
3194 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3195 * turns it into mw_poweredby.
3196 * The value is either key/value array of icons or a string.
3197 * In the key/value array the key may or may not be used by the skin but it can
3198 * be used to find the icon and unset it or change the icon if needed.
3199 * This is useful for disabling icons that are set by extensions.
3200 * The value should be either a string or an array. If it is a string it will be output
3201 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3202 * for the icon, the following keys are used:
3203 * - src: An absolute url to the image to use for the icon, this is recommended
3204 * but not required, however some skins will ignore icons without an image
3205 * - srcset: optional additional-resolution images; see HTML5 specs
3206 * - url: The url to use in the a element around the text or icon, if not set an a element will
3207 * not be outputted
3208 * - alt: This is the text form of the icon, it will be displayed without an image in
3209 * skins like Modern or if src is not set, and will otherwise be used as
3210 * the alt="" for the image. This key is required.
3211 * - width and height: If the icon specified by src is not of the standard size
3212 * you can specify the size of image to use with these keys.
3213 * Otherwise they will default to the standard 88x31.
3214 * @todo Reformat documentation.
3216 $wgFooterIcons = array(
3217 "copyright" => array(
3218 "copyright" => array(), // placeholder for the built in copyright icon
3220 "poweredby" => array(
3221 "mediawiki" => array(
3222 // Defaults to point at
3223 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3224 // plus srcset for 1.5x, 2x resolution variants.
3225 "src" => null,
3226 "url" => "//www.mediawiki.org/",
3227 "alt" => "Powered by MediaWiki",
3233 * Login / create account link behavior when it's possible for anonymous users
3234 * to create an account.
3235 * - true = use a combined login / create account link
3236 * - false = split login and create account into two separate links
3238 $wgUseCombinedLoginLink = false;
3241 * Display user edit counts in various prominent places.
3243 $wgEdititis = false;
3246 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3247 * status code, mangling or hiding MediaWiki's output. If you are using such a
3248 * host, you should start looking for a better one. While you're doing that,
3249 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3250 * that the generated error pages can be seen.
3252 * In cases where for technical reasons it is more important for MediaWiki to
3253 * send the correct status code than for the body to be transmitted intact,
3254 * this configuration variable is ignored.
3256 $wgSend404Code = true;
3259 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3260 * rollback. The numeric value of the variable are the limit up to are counted.
3261 * If the value is false or 0, the edits are not counted. Disabling this will
3262 * furthermore prevent MediaWiki from hiding some useless rollback links.
3264 * @since 1.20
3266 $wgShowRollbackEditCount = 10;
3269 * Output a <link rel="canonical"> tag on every page indicating the canonical
3270 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3271 * detection of the current server is unreliable, the link is sent
3272 * unconditionally.
3274 $wgEnableCanonicalServerLink = false;
3277 * When OutputHandler is used, mangle any output that contains
3278 * <cross-domain-policy>. Without this, an attacker can send their own
3279 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3280 * the domain root.
3282 * @since 1.25
3284 $wgMangleFlashPolicy = true;
3286 /** @} */ # End of output format settings }
3288 /*************************************************************************//**
3289 * @name Resource loader settings
3290 * @{
3294 * Client-side resource modules.
3296 * Extensions should add their resource loader module definitions
3297 * to the $wgResourceModules variable.
3299 * @par Example:
3300 * @code
3301 * $wgResourceModules['ext.myExtension'] = array(
3302 * 'scripts' => 'myExtension.js',
3303 * 'styles' => 'myExtension.css',
3304 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3305 * 'localBasePath' => __DIR__,
3306 * 'remoteExtPath' => 'MyExtension',
3307 * );
3308 * @endcode
3310 $wgResourceModules = array();
3313 * Skin-specific styles for resource modules.
3315 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3316 * not be modified or disabled.
3318 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3320 * @par Example:
3321 * @code
3322 * $wgResourceModules['bar'] = array(
3323 * 'scripts' => 'resources/bar/bar.js',
3324 * 'styles' => 'resources/bar/main.css',
3325 * );
3327 * $wgResourceModuleSkinStyles['foo'] = array(
3328 * 'bar' => 'skins/Foo/bar.css',
3329 * );
3330 * @endcode
3332 * This is mostly equivalent to:
3334 * @par Equivalent:
3335 * @code
3336 * $wgResourceModules['bar'] = array(
3337 * 'scripts' => 'resources/bar/bar.js',
3338 * 'styles' => 'resources/bar/main.css',
3339 * 'skinStyles' => array(
3340 * 'foo' => skins/Foo/bar.css',
3341 * ),
3342 * );
3343 * @endcode
3345 * If the module already defines its own entry in `skinStyles` for a given skin, then
3346 * $wgResourceModuleSkinStyles is ignored.
3348 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3349 * of replacing them. This can be done using the `+` prefix.
3351 * @par Example:
3352 * @code
3353 * $wgResourceModules['bar'] = array(
3354 * 'scripts' => 'resources/bar/bar.js',
3355 * 'styles' => 'resources/bar/basic.css',
3356 * 'skinStyles' => array(
3357 * 'default' => 'resources/bar/additional.css',
3358 * ),
3359 * );
3360 * // Note the '+' character:
3361 * $wgResourceModuleSkinStyles['foo'] = array(
3362 * '+bar' => 'skins/Foo/bar.css',
3363 * );
3364 * @endcode
3366 * This is mostly equivalent to:
3368 * @par Equivalent:
3369 * @code
3370 * $wgResourceModules['bar'] = array(
3371 * 'scripts' => 'resources/bar/bar.js',
3372 * 'styles' => 'resources/bar/basic.css',
3373 * 'skinStyles' => array(
3374 * 'default' => 'resources/bar/additional.css',
3375 * 'foo' => array(
3376 * 'resources/bar/additional.css',
3377 * 'skins/Foo/bar.css',
3378 * ),
3379 * ),
3380 * );
3381 * @endcode
3383 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3384 * disabled by a skin. To provide default styles that may be extended or replaced,
3385 * use `skinStyles['default']`.
3387 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3388 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3390 * @par Example:
3391 * @code
3392 * $wgResourceModuleSkinStyles['foo'] = array(
3393 * 'bar' => 'bar.css',
3394 * 'quux' => 'quux.css',
3395 * 'remoteSkinPath' => 'Foo',
3396 * 'localBasePath' => __DIR__,
3397 * );
3398 * @endcode
3400 $wgResourceModuleSkinStyles = array();
3403 * Extensions should register foreign module sources here. 'local' is a
3404 * built-in source that is not in this array, but defined by
3405 * ResourceLoader::__construct() so that it cannot be unset.
3407 * @par Example:
3408 * @code
3409 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3410 * @endcode
3412 $wgResourceLoaderSources = array();
3415 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3416 * If not set, then $wgScriptPath will be used as a fallback.
3418 $wgResourceBasePath = null;
3421 * Maximum time in seconds to cache resources served by the resource loader.
3422 * Used to set last modified headers (max-age/s-maxage).
3424 * Following options to distinguish:
3425 * - versioned: Used for modules with a version, because changing version
3426 * numbers causes cache misses. This normally has a long expiry time.
3427 * - unversioned: Used for modules without a version to propagate changes
3428 * quickly to clients. Also used for modules with errors to recover quickly.
3429 * This normally has a short expiry time.
3431 * Expiry time for the options to distinguish:
3432 * - server: Squid/Varnish but also any other public proxy cache between the
3433 * client and MediaWiki.
3434 * - client: On the client side (e.g. in the browser cache).
3436 $wgResourceLoaderMaxage = array(
3437 'versioned' => array(
3438 'server' => 30 * 24 * 60 * 60, // 30 days
3439 'client' => 30 * 24 * 60 * 60, // 30 days
3441 'unversioned' => array(
3442 'server' => 5 * 60, // 5 minutes
3443 'client' => 5 * 60, // 5 minutes
3448 * The default debug mode (on/off) for of ResourceLoader requests.
3450 * This will still be overridden when the debug URL parameter is used.
3452 $wgResourceLoaderDebug = false;
3455 * Enable embedding of certain resources using Edge Side Includes. This will
3456 * improve performance but only works if there is something in front of the
3457 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3459 $wgResourceLoaderUseESI = false;
3462 * Put each statement on its own line when minifying JavaScript. This makes
3463 * debugging in non-debug mode a bit easier.
3465 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3468 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3469 * the minifier will try not to produce lines longer than this, but may be
3470 * forced to do so in certain cases.
3472 $wgResourceLoaderMinifierMaxLineLength = 1000;
3475 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3476 * dependencies.
3478 $wgIncludeLegacyJavaScript = true;
3481 * Whether to preload the mediawiki.util module as blocking module in the top
3482 * queue.
3484 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3485 * allowed modules to lack dependencies on 'popular' modules that were likely
3486 * loaded already.
3488 * This setting is to aid scripts during migration by providing mediawiki.util
3489 * unconditionally (which was the most commonly missed dependency).
3490 * It doesn't cover all missing dependencies obviously but should fix most of
3491 * them.
3493 * This should be removed at some point after site/user scripts have been fixed.
3494 * Enable this if your wiki has a large amount of user/site scripts that are
3495 * lacking dependencies.
3496 * @todo Deprecate
3498 $wgPreloadJavaScriptMwUtil = false;
3501 * Whether or not to assign configuration variables to the global window object.
3503 * If this is set to false, old code using deprecated variables will no longer
3504 * work.
3506 * @par Example of legacy code:
3507 * @code{,js}
3508 * if ( window.wgRestrictionEdit ) { ... }
3509 * @endcode
3510 * or:
3511 * @code{,js}
3512 * if ( wgIsArticle ) { ... }
3513 * @endcode
3515 * Instead, one needs to use mw.config.
3516 * @par Example using mw.config global configuration:
3517 * @code{,js}
3518 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3519 * @endcode
3520 * or:
3521 * @code{,js}
3522 * if ( mw.config.get('wgIsArticle') ) { ... }
3523 * @endcode
3525 $wgLegacyJavaScriptGlobals = true;
3528 * If set to a positive number, ResourceLoader will not generate URLs whose
3529 * query string is more than this many characters long, and will instead use
3530 * multiple requests with shorter query strings. This degrades performance,
3531 * but may be needed if your web server has a low (less than, say 1024)
3532 * query string length limit or a low value for suhosin.get.max_value_length
3533 * that you can't increase.
3535 * If set to a negative number, ResourceLoader will assume there is no query
3536 * string length limit.
3538 * Defaults to a value based on php configuration.
3540 $wgResourceLoaderMaxQueryLength = false;
3543 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3544 * prior to minification to validate it.
3546 * Parse errors will result in a JS exception being thrown during module load,
3547 * which avoids breaking other modules loaded in the same request.
3549 $wgResourceLoaderValidateJS = true;
3552 * If set to true, statically-sourced (file-backed) JavaScript resources will
3553 * be parsed for validity before being bundled up into ResourceLoader modules.
3555 * This can be helpful for development by providing better error messages in
3556 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3557 * and may fail on large pre-bundled frameworks.
3559 $wgResourceLoaderValidateStaticJS = false;
3562 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3563 * will be enabled. This is an experimental feature that's supposed to make
3564 * JavaScript load faster.
3566 $wgResourceLoaderExperimentalAsyncLoading = false;
3569 * Global LESS variables. An associative array binding variable names to
3570 * LESS code snippets representing their values.
3572 * Adding an item here is equivalent to writing `@variable: value;`
3573 * at the beginning of all your .less files, with all the consequences.
3574 * In particular, string values must be escaped and quoted.
3576 * Changes to LESS variables do not trigger cache invalidation.
3578 * If the LESS variables need to be dynamic, you can use the
3579 * ResourceLoaderGetLessVars hook (since 1.25).
3581 * @par Example:
3582 * @code
3583 * $wgResourceLoaderLESSVars = array(
3584 * 'baseFontSize' => '1em',
3585 * 'smallFontSize' => '0.75em',
3586 * 'WikimediaBlue' => '#006699',
3587 * );
3588 * @endcode
3589 * @since 1.22
3591 $wgResourceLoaderLESSVars = array();
3594 * Custom LESS functions. An associative array mapping function name to PHP
3595 * callable.
3597 * Changes to LESS functions do not trigger cache invalidation.
3599 * @since 1.22
3600 * @deprecated since 1.24 Questionable usefulness and problematic to support,
3601 * will be removed in the future.
3603 $wgResourceLoaderLESSFunctions = array();
3606 * Default import paths for LESS modules. LESS files referenced in @import
3607 * statements will be looked up here first, and relative to the importing file
3608 * second. To avoid collisions, it's important for the LESS files in these
3609 * directories to have a common, predictable file name prefix.
3611 * Extensions need not (and should not) register paths in
3612 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3613 * currently compiling LESS file, which allows each extension to freely import
3614 * files from its own tree.
3616 * @since 1.22
3618 $wgResourceLoaderLESSImportPaths = array(
3619 "$IP/resources/src/mediawiki.less/",
3623 * Whether ResourceLoader should attempt to persist modules in localStorage on
3624 * browsers that support the Web Storage API.
3626 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3628 $wgResourceLoaderStorageEnabled = false;
3631 * Cache version for client-side ResourceLoader module storage. You can trigger
3632 * invalidation of the contents of the module store by incrementing this value.
3634 * @since 1.23
3636 $wgResourceLoaderStorageVersion = 1;
3639 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3640 * restricted pages like Special:UserLogin or Special:Preferences where
3641 * JavaScript is disabled for security reasons. As it is possible to
3642 * execute JavaScript through CSS, setting this to true opens up a
3643 * potential security hole. Some sites may "skin" their wiki by using
3644 * site-wide CSS, causing restricted pages to look unstyled and different
3645 * from the rest of the site.
3647 * @since 1.25
3649 $wgAllowSiteCSSOnRestrictedPages = false;
3651 /** @} */ # End of resource loader settings }
3653 /*************************************************************************//**
3654 * @name Page title and interwiki link settings
3655 * @{
3659 * Name of the project namespace. If left set to false, $wgSitename will be
3660 * used instead.
3662 $wgMetaNamespace = false;
3665 * Name of the project talk namespace.
3667 * Normally you can ignore this and it will be something like
3668 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3669 * manually for grammatical reasons.
3671 $wgMetaNamespaceTalk = false;
3674 * Additional namespaces. If the namespaces defined in Language.php and
3675 * Namespace.php are insufficient, you can create new ones here, for example,
3676 * to import Help files in other languages. You can also override the namespace
3677 * names of existing namespaces. Extensions developers should use
3678 * $wgCanonicalNamespaceNames.
3680 * @warning Once you delete a namespace, the pages in that namespace will
3681 * no longer be accessible. If you rename it, then you can access them through
3682 * the new namespace name.
3684 * Custom namespaces should start at 100 to avoid conflicting with standard
3685 * namespaces, and should always follow the even/odd main/talk pattern.
3687 * @par Example:
3688 * @code
3689 * $wgExtraNamespaces = array(
3690 * 100 => "Hilfe",
3691 * 101 => "Hilfe_Diskussion",
3692 * 102 => "Aide",
3693 * 103 => "Discussion_Aide"
3694 * );
3695 * @endcode
3697 * @todo Add a note about maintenance/namespaceDupes.php
3699 $wgExtraNamespaces = array();
3702 * Same as above, but for namespaces with gender distinction.
3703 * Note: the default form for the namespace should also be set
3704 * using $wgExtraNamespaces for the same index.
3705 * @since 1.18
3707 $wgExtraGenderNamespaces = array();
3710 * Namespace aliases.
3712 * These are alternate names for the primary localised namespace names, which
3713 * are defined by $wgExtraNamespaces and the language file. If a page is
3714 * requested with such a prefix, the request will be redirected to the primary
3715 * name.
3717 * Set this to a map from namespace names to IDs.
3719 * @par Example:
3720 * @code
3721 * $wgNamespaceAliases = array(
3722 * 'Wikipedian' => NS_USER,
3723 * 'Help' => 100,
3724 * );
3725 * @endcode
3727 $wgNamespaceAliases = array();
3730 * Allowed title characters -- regex character class
3731 * Don't change this unless you know what you're doing
3733 * Problematic punctuation:
3734 * - []{}|# Are needed for link syntax, never enable these
3735 * - <> Causes problems with HTML escaping, don't use
3736 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3737 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3738 * corrupted by apache
3739 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3741 * All three of these punctuation problems can be avoided by using an alias,
3742 * instead of a rewrite rule of either variety.
3744 * The problem with % is that when using a path to query rewrite rule, URLs are
3745 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3746 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3747 * for this, indeed double escaping would break if the double-escaped title was
3748 * passed in the query string rather than the path. This is a minor security issue
3749 * because articles can be created such that they are hard to view or edit.
3751 * In some rare cases you may wish to remove + for compatibility with old links.
3753 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3754 * this breaks interlanguage links
3756 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3759 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3761 * @deprecated since 1.23; use $wgLocalInterwikis instead
3763 $wgLocalInterwiki = false;
3766 * Array for multiple $wgLocalInterwiki values, in case there are several
3767 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3768 * set, its value is prepended to this array, for backwards compatibility.
3770 * Note, recent changes feeds use only the first entry in this array (or
3771 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3773 $wgLocalInterwikis = array();
3776 * Expiry time for cache of interwiki table
3778 $wgInterwikiExpiry = 10800;
3781 * @name Interwiki caching settings.
3782 * @{
3786 *$wgInterwikiCache specifies path to constant database file.
3788 * This cdb database is generated by dumpInterwiki from maintenance and has
3789 * such key formats:
3790 * - dbname:key - a simple key (e.g. enwiki:meta)
3791 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3792 * - __global:key - global-scope key (e.g. __global:meta)
3793 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3795 * Sites mapping just specifies site name, other keys provide "local url"
3796 * data layout.
3798 $wgInterwikiCache = false;
3801 * Specify number of domains to check for messages.
3802 * - 1: Just wiki(db)-level
3803 * - 2: wiki and global levels
3804 * - 3: site levels
3806 $wgInterwikiScopes = 3;
3809 * Fallback site, if unable to resolve from cache
3811 $wgInterwikiFallbackSite = 'wiki';
3813 /** @} */ # end of Interwiki caching settings.
3816 * @name SiteStore caching settings.
3817 * @{
3821 * Specify the file location for the Sites json cache file.
3823 $wgSitesCacheFile = false;
3825 /** @} */ # end of SiteStore caching settings.
3828 * If local interwikis are set up which allow redirects,
3829 * set this regexp to restrict URLs which will be displayed
3830 * as 'redirected from' links.
3832 * @par Example:
3833 * It might look something like this:
3834 * @code
3835 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3836 * @endcode
3838 * Leave at false to avoid displaying any incoming redirect markers.
3839 * This does not affect intra-wiki redirects, which don't change
3840 * the URL.
3842 $wgRedirectSources = false;
3845 * Set this to false to avoid forcing the first letter of links to capitals.
3847 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3848 * appearing with a capital at the beginning of a sentence will *not* go to the
3849 * same place as links in the middle of a sentence using a lowercase initial.
3851 $wgCapitalLinks = true;
3854 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3855 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3856 * true by default (and setting them has no effect), due to various things that
3857 * require them to be so. Also, since Talk namespaces need to directly mirror their
3858 * associated content namespaces, the values for those are ignored in favor of the
3859 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3860 * NS_FILE.
3862 * @par Example:
3863 * @code
3864 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3865 * @endcode
3867 $wgCapitalLinkOverrides = array();
3870 * Which namespaces should support subpages?
3871 * See Language.php for a list of namespaces.
3873 $wgNamespacesWithSubpages = array(
3874 NS_TALK => true,
3875 NS_USER => true,
3876 NS_USER_TALK => true,
3877 NS_PROJECT => true,
3878 NS_PROJECT_TALK => true,
3879 NS_FILE_TALK => true,
3880 NS_MEDIAWIKI => true,
3881 NS_MEDIAWIKI_TALK => true,
3882 NS_TEMPLATE_TALK => true,
3883 NS_HELP => true,
3884 NS_HELP_TALK => true,
3885 NS_CATEGORY_TALK => true
3889 * Array holding default tracking category names.
3891 * Array contains the system messages for each tracking category.
3892 * Tracking categories allow pages with certain characteristics to be tracked.
3893 * It works by adding any such page to a category automatically.
3895 * A message with the suffix '-desc' should be added as a description message
3896 * to have extra information on Special:TrackingCategories.
3898 * @deprecated since 1.25 Extensions should now register tracking categories using
3899 * the new extension registration system.
3901 * @since 1.23
3903 $wgTrackingCategories = array();
3906 * Array of namespaces which can be deemed to contain valid "content", as far
3907 * as the site statistics are concerned. Useful if additional namespaces also
3908 * contain "content" which should be considered when generating a count of the
3909 * number of articles in the wiki.
3911 $wgContentNamespaces = array( NS_MAIN );
3914 * Max number of redirects to follow when resolving redirects.
3915 * 1 means only the first redirect is followed (default behavior).
3916 * 0 or less means no redirects are followed.
3918 $wgMaxRedirects = 1;
3921 * Array of invalid page redirect targets.
3922 * Attempting to create a redirect to any of the pages in this array
3923 * will make the redirect fail.
3924 * Userlogout is hard-coded, so it does not need to be listed here.
3925 * (bug 10569) Disallow Mypage and Mytalk as well.
3927 * As of now, this only checks special pages. Redirects to pages in
3928 * other namespaces cannot be invalidated by this variable.
3930 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3932 /** @} */ # End of title and interwiki settings }
3934 /************************************************************************//**
3935 * @name Parser settings
3936 * These settings configure the transformation from wikitext to HTML.
3937 * @{
3941 * Parser configuration. Associative array with the following members:
3943 * class The class name
3945 * preprocessorClass The preprocessor class. Two classes are currently available:
3946 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3947 * storage, and Preprocessor_DOM, which uses the DOM module for
3948 * temporary storage. Preprocessor_DOM generally uses less memory;
3949 * the speed of the two is roughly the same.
3951 * If this parameter is not given, it uses Preprocessor_DOM if the
3952 * DOM module is available, otherwise it uses Preprocessor_Hash.
3954 * The entire associative array will be passed through to the constructor as
3955 * the first parameter. Note that only Setup.php can use this variable --
3956 * the configuration will change at runtime via $wgParser member functions, so
3957 * the contents of this variable will be out-of-date. The variable can only be
3958 * changed during LocalSettings.php, in particular, it can't be changed during
3959 * an extension setup function.
3961 $wgParserConf = array(
3962 'class' => 'Parser',
3963 #'preprocessorClass' => 'Preprocessor_Hash',
3967 * Maximum indent level of toc.
3969 $wgMaxTocLevel = 999;
3972 * A complexity limit on template expansion: the maximum number of nodes visited
3973 * by PPFrame::expand()
3975 $wgMaxPPNodeCount = 1000000;
3978 * A complexity limit on template expansion: the maximum number of elements
3979 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3980 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3981 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3982 * this default corresponds to about 155 MB.
3984 * When the limit is exceeded, an exception is thrown.
3986 $wgMaxGeneratedPPNodeCount = 1000000;
3989 * Maximum recursion depth for templates within templates.
3990 * The current parser adds two levels to the PHP call stack for each template,
3991 * and xdebug limits the call stack to 100 by default. So this should hopefully
3992 * stop the parser before it hits the xdebug limit.
3994 $wgMaxTemplateDepth = 40;
3997 * @see $wgMaxTemplateDepth
3999 $wgMaxPPExpandDepth = 40;
4002 * URL schemes that should be recognized as valid by wfParseUrl().
4004 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4005 * Instead, if you want to support file links, add 'file://'. The same applies
4006 * to any other protocols with the same name as a namespace. See bug #44011 for
4007 * more information.
4009 * @see wfParseUrl
4011 $wgUrlProtocols = array(
4012 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4013 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4014 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4015 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4019 * If true, removes (by substituting) templates in signatures.
4021 $wgCleanSignatures = true;
4024 * Whether to allow inline image pointing to other websites
4026 $wgAllowExternalImages = false;
4029 * If the above is false, you can specify an exception here. Image URLs
4030 * that start with this string are then rendered, while all others are not.
4031 * You can use this to set up a trusted, simple repository of images.
4032 * You may also specify an array of strings to allow multiple sites
4034 * @par Examples:
4035 * @code
4036 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4037 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4038 * @endcode
4040 $wgAllowExternalImagesFrom = '';
4043 * If $wgAllowExternalImages is false, you can allow an on-wiki
4044 * whitelist of regular expression fragments to match the image URL
4045 * against. If the image matches one of the regular expression fragments,
4046 * The image will be displayed.
4048 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4049 * Or false to disable it
4051 $wgEnableImageWhitelist = true;
4054 * A different approach to the above: simply allow the "<img>" tag to be used.
4055 * This allows you to specify alt text and other attributes, copy-paste HTML to
4056 * your wiki more easily, etc. However, allowing external images in any manner
4057 * will allow anyone with editing rights to snoop on your visitors' IP
4058 * addresses and so forth, if they wanted to, by inserting links to images on
4059 * sites they control.
4061 $wgAllowImageTag = false;
4064 * $wgUseTidy: use tidy to make sure HTML output is sane.
4065 * Tidy is a free tool that fixes broken HTML.
4066 * See http://www.w3.org/People/Raggett/tidy/
4068 * - $wgTidyBin should be set to the path of the binary and
4069 * - $wgTidyConf to the path of the configuration file.
4070 * - $wgTidyOpts can include any number of parameters.
4071 * - $wgTidyInternal controls the use of the PECL extension or the
4072 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
4073 * of spawning a separate program.
4074 * Normally you shouldn't need to override the setting except for
4075 * debugging. To install, use 'pear install tidy' and add a line
4076 * 'extension=tidy.so' to php.ini.
4078 $wgUseTidy = false;
4081 * @see $wgUseTidy
4083 $wgAlwaysUseTidy = false;
4086 * @see $wgUseTidy
4088 $wgTidyBin = 'tidy';
4091 * @see $wgUseTidy
4093 $wgTidyConf = $IP . '/includes/tidy.conf';
4096 * @see $wgUseTidy
4098 $wgTidyOpts = '';
4101 * @see $wgUseTidy
4103 $wgTidyInternal = extension_loaded( 'tidy' );
4106 * Put tidy warnings in HTML comments
4107 * Only works for internal tidy.
4109 $wgDebugTidy = false;
4112 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4113 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4114 * TO RESTRICT EDITING to only those that you trust
4116 $wgRawHtml = false;
4119 * Set a default target for external links, e.g. _blank to pop up a new window
4121 $wgExternalLinkTarget = false;
4124 * If true, external URL links in wiki text will be given the
4125 * rel="nofollow" attribute as a hint to search engines that
4126 * they should not be followed for ranking purposes as they
4127 * are user-supplied and thus subject to spamming.
4129 $wgNoFollowLinks = true;
4132 * Namespaces in which $wgNoFollowLinks doesn't apply.
4133 * See Language.php for a list of namespaces.
4135 $wgNoFollowNsExceptions = array();
4138 * If this is set to an array of domains, external links to these domain names
4139 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4140 * value of $wgNoFollowLinks. For instance:
4142 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4143 * 'mediawiki.org' );
4145 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4146 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4147 * etc.
4149 * Defaults to mediawiki.org for the links included in the software by default.
4151 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4154 * Allow DISPLAYTITLE to change title display
4156 $wgAllowDisplayTitle = true;
4159 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4160 * canonical DB key. Also disallow some inline CSS rules like display: none;
4161 * which can cause the text to be hidden or unselectable.
4163 $wgRestrictDisplayTitle = true;
4166 * Maximum number of calls per parse to expensive parser functions such as
4167 * PAGESINCATEGORY.
4169 $wgExpensiveParserFunctionLimit = 100;
4172 * Preprocessor caching threshold
4173 * Setting it to 'false' will disable the preprocessor cache.
4175 $wgPreprocessorCacheThreshold = 1000;
4178 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4180 $wgEnableScaryTranscluding = false;
4183 * Expiry time for transcluded templates cached in transcache database table.
4184 * Only used $wgEnableInterwikiTranscluding is set to true.
4186 $wgTranscludeCacheExpiry = 3600;
4188 /** @} */ # end of parser settings }
4190 /************************************************************************//**
4191 * @name Statistics
4192 * @{
4196 * Method used to determine if a page in a content namespace should be counted
4197 * as a valid article.
4199 * Redirect pages will never be counted as valid articles.
4201 * This variable can have the following values:
4202 * - 'any': all pages as considered as valid articles
4203 * - 'comma': the page must contain a comma to be considered valid
4204 * - 'link': the page must contain a [[wiki link]] to be considered valid
4206 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4208 * Retroactively changing this variable will not affect the existing count,
4209 * to update it, you will need to run the maintenance/updateArticleCount.php
4210 * script.
4212 $wgArticleCountMethod = 'link';
4215 * How many days user must be idle before he is considered inactive. Will affect
4216 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4217 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4218 * You might want to leave this as the default value, to provide comparable
4219 * numbers between different wikis.
4221 $wgActiveUserDays = 30;
4223 /** @} */ # End of statistics }
4225 /************************************************************************//**
4226 * @name User accounts, authentication
4227 * @{
4231 * For compatibility with old installations set to false
4232 * @deprecated since 1.24 will be removed in future
4234 $wgPasswordSalt = true;
4237 * Specifies the minimal length of a user password. If set to 0, empty pass-
4238 * words are allowed.
4240 $wgMinimalPasswordLength = 1;
4243 * Specifies the maximal length of a user password (T64685).
4245 * It is not recommended to make this greater than the default, as it can
4246 * allow DoS attacks by users setting really long passwords. In addition,
4247 * this should not be lowered too much, as it enforces weak passwords.
4249 * @warning Unlike other password settings, user with passwords greater than
4250 * the maximum will not be able to log in.
4252 $wgMaximalPasswordLength = 4096;
4255 * Specifies if users should be sent to a password-reset form on login, if their
4256 * password doesn't meet the requirements of User::isValidPassword().
4257 * @since 1.23
4259 $wgInvalidPasswordReset = true;
4262 * Default password type to use when hashing user passwords
4264 * @since 1.24
4266 $wgPasswordDefault = 'pbkdf2';
4269 * Configuration for built-in password types. Maps the password type
4270 * to an array of options. The 'class' option is the Password class to
4271 * use. All other options are class-dependent.
4273 * An advanced example:
4274 * @code
4275 * $wgPasswordConfig['bcrypt-peppered'] = array(
4276 * 'class' => 'EncryptedPassword',
4277 * 'underlying' => 'bcrypt',
4278 * 'secrets' => array(),
4279 * 'cipher' => MCRYPT_RIJNDAEL_256,
4280 * 'mode' => MCRYPT_MODE_CBC,
4281 * 'cost' => 5,
4282 * );
4283 * @endcode
4285 * @since 1.24
4287 $wgPasswordConfig = array(
4288 'A' => array(
4289 'class' => 'MWOldPassword',
4291 'B' => array(
4292 'class' => 'MWSaltedPassword',
4294 'pbkdf2-legacyA' => array(
4295 'class' => 'LayeredParameterizedPassword',
4296 'types' => array(
4297 'A',
4298 'pbkdf2',
4301 'pbkdf2-legacyB' => array(
4302 'class' => 'LayeredParameterizedPassword',
4303 'types' => array(
4304 'B',
4305 'pbkdf2',
4308 'bcrypt' => array(
4309 'class' => 'BcryptPassword',
4310 'cost' => 9,
4312 'pbkdf2' => array(
4313 'class' => 'Pbkdf2Password',
4314 'algo' => 'sha256',
4315 'cost' => '10000',
4316 'length' => '128',
4321 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4322 * with a temporary password you can use to get back into the account") identified by
4323 * various bits of data. Setting all of these to false (or the whole variable to false)
4324 * has the effect of disabling password resets entirely
4326 $wgPasswordResetRoutes = array(
4327 'username' => true,
4328 'email' => false,
4332 * Maximum number of Unicode characters in signature
4334 $wgMaxSigChars = 255;
4337 * Maximum number of bytes in username. You want to run the maintenance
4338 * script ./maintenance/checkUsernames.php once you have changed this value.
4340 $wgMaxNameChars = 255;
4343 * Array of usernames which may not be registered or logged in from
4344 * Maintenance scripts can still use these
4346 $wgReservedUsernames = array(
4347 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4348 'Conversion script', // Used for the old Wikipedia software upgrade
4349 'Maintenance script', // Maintenance scripts which perform editing, image import script
4350 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4351 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4352 'msg:double-redirect-fixer', // Automatic double redirect fix
4353 'msg:usermessage-editor', // Default user for leaving user messages
4354 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4355 'msg:spambot_username', // Used by cleanupSpam.php
4359 * Settings added to this array will override the default globals for the user
4360 * preferences used by anonymous visitors and newly created accounts.
4361 * For instance, to disable editing on double clicks:
4362 * $wgDefaultUserOptions ['editondblclick'] = 0;
4364 $wgDefaultUserOptions = array(
4365 'ccmeonemails' => 0,
4366 'cols' => 80,
4367 'date' => 'default',
4368 'diffonly' => 0,
4369 'disablemail' => 0,
4370 'editfont' => 'default',
4371 'editondblclick' => 0,
4372 'editsectiononrightclick' => 0,
4373 'enotifminoredits' => 0,
4374 'enotifrevealaddr' => 0,
4375 'enotifusertalkpages' => 1,
4376 'enotifwatchlistpages' => 1,
4377 'extendwatchlist' => 1,
4378 'fancysig' => 0,
4379 'forceeditsummary' => 0,
4380 'gender' => 'unknown',
4381 'hideminor' => 0,
4382 'hidepatrolled' => 0,
4383 'imagesize' => 2,
4384 'math' => 1,
4385 'minordefault' => 0,
4386 'newpageshidepatrolled' => 0,
4387 'nickname' => '',
4388 'norollbackdiff' => 0,
4389 'numberheadings' => 0,
4390 'previewonfirst' => 0,
4391 'previewontop' => 1,
4392 'rcdays' => 7,
4393 'rclimit' => 50,
4394 'rows' => 25,
4395 'showhiddencats' => 0,
4396 'shownumberswatching' => 1,
4397 'showtoolbar' => 1,
4398 'skin' => false,
4399 'stubthreshold' => 0,
4400 'thumbsize' => 5,
4401 'underline' => 2,
4402 'uselivepreview' => 0,
4403 'usenewrc' => 1,
4404 'watchcreations' => 1,
4405 'watchdefault' => 1,
4406 'watchdeletion' => 0,
4407 'watchlistdays' => 3.0,
4408 'watchlisthideanons' => 0,
4409 'watchlisthidebots' => 0,
4410 'watchlisthideliu' => 0,
4411 'watchlisthideminor' => 0,
4412 'watchlisthideown' => 0,
4413 'watchlisthidepatrolled' => 0,
4414 'watchmoves' => 0,
4415 'watchrollback' => 0,
4416 'wllimit' => 250,
4417 'useeditwarning' => 1,
4418 'prefershttps' => 1,
4422 * An array of preferences to not show for the user
4424 $wgHiddenPrefs = array();
4427 * Characters to prevent during new account creations.
4428 * This is used in a regular expression character class during
4429 * registration (regex metacharacters like / are escaped).
4431 $wgInvalidUsernameCharacters = '@';
4434 * Character used as a delimiter when testing for interwiki userrights
4435 * (In Special:UserRights, it is possible to modify users on different
4436 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4438 * It is recommended that you have this delimiter in
4439 * $wgInvalidUsernameCharacters above, or you will not be able to
4440 * modify the user rights of those users via Special:UserRights
4442 $wgUserrightsInterwikiDelimiter = '@';
4445 * This is to let user authenticate using https when they come from http.
4446 * Based on an idea by George Herbert on wikitech-l:
4447 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4448 * @since 1.17
4450 $wgSecureLogin = false;
4452 /** @} */ # end user accounts }
4454 /************************************************************************//**
4455 * @name User rights, access control and monitoring
4456 * @{
4460 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4462 $wgAutoblockExpiry = 86400;
4465 * Set this to true to allow blocked users to edit their own user talk page.
4467 $wgBlockAllowsUTEdit = false;
4470 * Allow sysops to ban users from accessing Emailuser
4472 $wgSysopEmailBans = true;
4475 * Limits on the possible sizes of range blocks.
4477 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4478 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4479 * half the number of bits avoids such errors, and allows entire ISPs to be
4480 * blocked using a small number of range blocks.
4482 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4483 * customer, so range blocks larger than /64 (half the number of bits) will
4484 * plainly be required. RFC 4692 implies that a very large ISP may be
4485 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4486 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4488 $wgBlockCIDRLimit = array(
4489 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4490 'IPv6' => 19,
4494 * If true, blocked users will not be allowed to login. When using this with
4495 * a public wiki, the effect of logging out blocked users may actually be
4496 * avers: unless the user's address is also blocked (e.g. auto-block),
4497 * logging the user out will again allow reading and editing, just as for
4498 * anonymous visitors.
4500 $wgBlockDisablesLogin = false;
4503 * Pages anonymous user may see, set as an array of pages titles.
4505 * @par Example:
4506 * @code
4507 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4508 * @endcode
4510 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4512 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4513 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4515 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4516 * will remain readable. You can use img_auth.php to protect uploaded files,
4517 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4519 $wgWhitelistRead = false;
4522 * Pages anonymous user may see, set as an array of regular expressions.
4524 * This function will match the regexp against the title name, which
4525 * is without underscore.
4527 * @par Example:
4528 * To whitelist [[Main Page]]:
4529 * @code
4530 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4531 * @endcode
4533 * @note Unless ^ and/or $ is specified, a regular expression might match
4534 * pages not intended to be whitelisted. The above example will also
4535 * whitelist a page named 'Security Main Page'.
4537 * @par Example:
4538 * To allow reading any page starting with 'User' regardless of the case:
4539 * @code
4540 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4541 * @endcode
4542 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4544 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4545 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4547 $wgWhitelistReadRegexp = false;
4550 * Should editors be required to have a validated e-mail
4551 * address before being allowed to edit?
4553 $wgEmailConfirmToEdit = false;
4556 * Permission keys given to users in each group.
4558 * This is an array where the keys are all groups and each value is an
4559 * array of the format (right => boolean).
4561 * The second format is used to support per-namespace permissions.
4562 * Note that this feature does not fully work for all permission types.
4564 * All users are implicitly in the '*' group including anonymous visitors;
4565 * logged-in users are all implicitly in the 'user' group. These will be
4566 * combined with the permissions of all groups that a given user is listed
4567 * in in the user_groups table.
4569 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4570 * doing! This will wipe all permissions, and may mean that your users are
4571 * unable to perform certain essential tasks or access new functionality
4572 * when new permissions are introduced and default grants established.
4574 * Functionality to make pages inaccessible has not been extensively tested
4575 * for security. Use at your own risk!
4577 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4579 $wgGroupPermissions = array();
4581 /** @cond file_level_code */
4582 // Implicit group for all visitors
4583 $wgGroupPermissions['*']['createaccount'] = true;
4584 $wgGroupPermissions['*']['read'] = true;
4585 $wgGroupPermissions['*']['edit'] = true;
4586 $wgGroupPermissions['*']['createpage'] = true;
4587 $wgGroupPermissions['*']['createtalk'] = true;
4588 $wgGroupPermissions['*']['writeapi'] = true;
4589 $wgGroupPermissions['*']['editmyusercss'] = true;
4590 $wgGroupPermissions['*']['editmyuserjs'] = true;
4591 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4592 $wgGroupPermissions['*']['editmywatchlist'] = true;
4593 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4594 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4595 $wgGroupPermissions['*']['editmyoptions'] = true;
4596 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4598 // Implicit group for all logged-in accounts
4599 $wgGroupPermissions['user']['move'] = true;
4600 $wgGroupPermissions['user']['move-subpages'] = true;
4601 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4602 $wgGroupPermissions['user']['move-categorypages'] = true;
4603 $wgGroupPermissions['user']['movefile'] = true;
4604 $wgGroupPermissions['user']['read'] = true;
4605 $wgGroupPermissions['user']['edit'] = true;
4606 $wgGroupPermissions['user']['createpage'] = true;
4607 $wgGroupPermissions['user']['createtalk'] = true;
4608 $wgGroupPermissions['user']['writeapi'] = true;
4609 $wgGroupPermissions['user']['upload'] = true;
4610 $wgGroupPermissions['user']['reupload'] = true;
4611 $wgGroupPermissions['user']['reupload-shared'] = true;
4612 $wgGroupPermissions['user']['minoredit'] = true;
4613 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4614 $wgGroupPermissions['user']['sendemail'] = true;
4615 $wgGroupPermissions['user']['applychangetags'] = true;
4616 $wgGroupPermissions['user']['changetags'] = true;
4618 // Implicit group for accounts that pass $wgAutoConfirmAge
4619 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4620 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4622 // Users with bot privilege can have their edits hidden
4623 // from various log pages by default
4624 $wgGroupPermissions['bot']['bot'] = true;
4625 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4626 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4627 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4628 $wgGroupPermissions['bot']['autopatrol'] = true;
4629 $wgGroupPermissions['bot']['suppressredirect'] = true;
4630 $wgGroupPermissions['bot']['apihighlimits'] = true;
4631 $wgGroupPermissions['bot']['writeapi'] = true;
4633 // Most extra permission abilities go to this group
4634 $wgGroupPermissions['sysop']['block'] = true;
4635 $wgGroupPermissions['sysop']['createaccount'] = true;
4636 $wgGroupPermissions['sysop']['delete'] = true;
4637 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4638 $wgGroupPermissions['sysop']['bigdelete'] = true;
4639 // can view deleted history entries, but not see or restore the text
4640 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4641 // can view deleted revision text
4642 $wgGroupPermissions['sysop']['deletedtext'] = true;
4643 $wgGroupPermissions['sysop']['undelete'] = true;
4644 $wgGroupPermissions['sysop']['editinterface'] = true;
4645 $wgGroupPermissions['sysop']['editusercss'] = true;
4646 $wgGroupPermissions['sysop']['edituserjs'] = true;
4647 $wgGroupPermissions['sysop']['import'] = true;
4648 $wgGroupPermissions['sysop']['importupload'] = true;
4649 $wgGroupPermissions['sysop']['move'] = true;
4650 $wgGroupPermissions['sysop']['move-subpages'] = true;
4651 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4652 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4653 $wgGroupPermissions['sysop']['patrol'] = true;
4654 $wgGroupPermissions['sysop']['autopatrol'] = true;
4655 $wgGroupPermissions['sysop']['protect'] = true;
4656 $wgGroupPermissions['sysop']['editprotected'] = true;
4657 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4658 $wgGroupPermissions['sysop']['rollback'] = true;
4659 $wgGroupPermissions['sysop']['upload'] = true;
4660 $wgGroupPermissions['sysop']['reupload'] = true;
4661 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4662 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4663 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4664 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4665 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4666 $wgGroupPermissions['sysop']['blockemail'] = true;
4667 $wgGroupPermissions['sysop']['markbotedits'] = true;
4668 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4669 $wgGroupPermissions['sysop']['browsearchive'] = true;
4670 $wgGroupPermissions['sysop']['noratelimit'] = true;
4671 $wgGroupPermissions['sysop']['movefile'] = true;
4672 $wgGroupPermissions['sysop']['unblockself'] = true;
4673 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4674 #$wgGroupPermissions['sysop']['pagelang'] = true;
4675 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4676 $wgGroupPermissions['sysop']['mergehistory'] = true;
4677 $wgGroupPermissions['sysop']['managechangetags'] = true;
4679 // Permission to change users' group assignments
4680 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4681 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4682 // Permission to change users' groups assignments across wikis
4683 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4684 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4685 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4687 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4688 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4689 // To hide usernames from users and Sysops
4690 #$wgGroupPermissions['suppress']['hideuser'] = true;
4691 // To hide revisions/log items from users and Sysops
4692 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4693 // To view revisions/log items hidden from users and Sysops
4694 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4695 // For private suppression log access
4696 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4699 * The developer group is deprecated, but can be activated if need be
4700 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4701 * that a lock file be defined and creatable/removable by the web
4702 * server.
4704 # $wgGroupPermissions['developer']['siteadmin'] = true;
4706 /** @endcond */
4709 * Permission keys revoked from users in each group.
4711 * This acts the same way as wgGroupPermissions above, except that
4712 * if the user is in a group here, the permission will be removed from them.
4714 * Improperly setting this could mean that your users will be unable to perform
4715 * certain essential tasks, so use at your own risk!
4717 $wgRevokePermissions = array();
4720 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4722 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4725 * A map of group names that the user is in, to group names that those users
4726 * are allowed to add or revoke.
4728 * Setting the list of groups to add or revoke to true is equivalent to "any
4729 * group".
4731 * @par Example:
4732 * To allow sysops to add themselves to the "bot" group:
4733 * @code
4734 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4735 * @endcode
4737 * @par Example:
4738 * Implicit groups may be used for the source group, for instance:
4739 * @code
4740 * $wgGroupsRemoveFromSelf = array( '*' => true );
4741 * @endcode
4742 * This allows users in the '*' group (i.e. any user) to remove themselves from
4743 * any group that they happen to be in.
4745 $wgGroupsAddToSelf = array();
4748 * @see $wgGroupsAddToSelf
4750 $wgGroupsRemoveFromSelf = array();
4753 * Set of available actions that can be restricted via action=protect
4754 * You probably shouldn't change this.
4755 * Translated through restriction-* messages.
4756 * Title::getRestrictionTypes() will remove restrictions that are not
4757 * applicable to a specific title (create and upload)
4759 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4762 * Rights which can be required for each protection level (via action=protect)
4764 * You can add a new protection level that requires a specific
4765 * permission by manipulating this array. The ordering of elements
4766 * dictates the order on the protection form's lists.
4768 * - '' will be ignored (i.e. unprotected)
4769 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4770 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4772 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4775 * Restriction levels that can be used with cascading protection
4777 * A page can only be protected with cascading protection if the
4778 * requested restriction level is included in this array.
4780 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4781 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4783 $wgCascadingRestrictionLevels = array( 'sysop' );
4786 * Restriction levels that should be considered "semiprotected"
4788 * Certain places in the interface recognize a dichotomy between "protected"
4789 * and "semiprotected", without further distinguishing the specific levels. In
4790 * general, if anyone can be eligible to edit a protection level merely by
4791 * reaching some condition in $wgAutopromote, it should probably be considered
4792 * "semiprotected".
4794 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4795 * 'sysop' is not changed, since it really shouldn't be here.
4797 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4800 * Set the minimum permissions required to edit pages in each
4801 * namespace. If you list more than one permission, a user must
4802 * have all of them to edit pages in that namespace.
4804 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4806 $wgNamespaceProtection = array();
4809 * Pages in namespaces in this array can not be used as templates.
4811 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4812 * namespaces constants (NS_USER, NS_MAIN...).
4814 * Among other things, this may be useful to enforce read-restrictions
4815 * which may otherwise be bypassed by using the template mechanism.
4817 $wgNonincludableNamespaces = array();
4820 * Number of seconds an account is required to age before it's given the
4821 * implicit 'autoconfirm' group membership. This can be used to limit
4822 * privileges of new accounts.
4824 * Accounts created by earlier versions of the software may not have a
4825 * recorded creation date, and will always be considered to pass the age test.
4827 * When left at 0, all registered accounts will pass.
4829 * @par Example:
4830 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4831 * @code
4832 * $wgAutoConfirmAge = 600; // ten minutes
4833 * @endcode
4834 * Set age to one day:
4835 * @code
4836 * $wgAutoConfirmAge = 3600*24; // one day
4837 * @endcode
4839 $wgAutoConfirmAge = 0;
4842 * Number of edits an account requires before it is autoconfirmed.
4843 * Passing both this AND the time requirement is needed. Example:
4845 * @par Example:
4846 * @code
4847 * $wgAutoConfirmCount = 50;
4848 * @endcode
4850 $wgAutoConfirmCount = 0;
4853 * Automatically add a usergroup to any user who matches certain conditions.
4855 * @todo Redocument $wgAutopromote
4857 * The format is
4858 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4859 * where cond1, cond2, ... are themselves conditions; *OR*
4860 * APCOND_EMAILCONFIRMED, *OR*
4861 * array( APCOND_EMAILCONFIRMED ), *OR*
4862 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4863 * array( APCOND_AGE, seconds since registration ), *OR*
4864 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4865 * array( APCOND_ISIP, ip ), *OR*
4866 * array( APCOND_IPINRANGE, range ), *OR*
4867 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4868 * array( APCOND_BLOCKED ), *OR*
4869 * array( APCOND_ISBOT ), *OR*
4870 * similar constructs defined by extensions.
4872 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4873 * user who has provided an e-mail address.
4875 $wgAutopromote = array(
4876 'autoconfirmed' => array( '&',
4877 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4878 array( APCOND_AGE, &$wgAutoConfirmAge ),
4883 * Automatically add a usergroup to any user who matches certain conditions.
4885 * Does not add the user to the group again if it has been removed.
4886 * Also, does not remove the group if the user no longer meets the criteria.
4888 * The format is:
4889 * @code
4890 * array( event => criteria, ... )
4891 * @endcode
4892 * Where event is either:
4893 * - 'onEdit' (when user edits)
4895 * Criteria has the same format as $wgAutopromote
4897 * @see $wgAutopromote
4898 * @since 1.18
4900 $wgAutopromoteOnce = array(
4901 'onEdit' => array(),
4905 * Put user rights log entries for autopromotion in recent changes?
4906 * @since 1.18
4908 $wgAutopromoteOnceLogInRC = true;
4911 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4912 * can assign which groups at Special:Userrights.
4914 * @par Example:
4915 * Bureaucrats can add any group:
4916 * @code
4917 * $wgAddGroups['bureaucrat'] = true;
4918 * @endcode
4919 * Bureaucrats can only remove bots and sysops:
4920 * @code
4921 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4922 * @endcode
4923 * Sysops can make bots:
4924 * @code
4925 * $wgAddGroups['sysop'] = array( 'bot' );
4926 * @endcode
4927 * Sysops can disable other sysops in an emergency, and disable bots:
4928 * @code
4929 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4930 * @endcode
4932 $wgAddGroups = array();
4935 * @see $wgAddGroups
4937 $wgRemoveGroups = array();
4940 * A list of available rights, in addition to the ones defined by the core.
4941 * For extensions only.
4943 $wgAvailableRights = array();
4946 * Optional to restrict deletion of pages with higher revision counts
4947 * to users with the 'bigdelete' permission. (Default given to sysops.)
4949 $wgDeleteRevisionsLimit = 0;
4952 * The maximum number of edits a user can have and
4953 * can still be hidden by users with the hideuser permission.
4954 * This is limited for performance reason.
4955 * Set to false to disable the limit.
4956 * @since 1.23
4958 $wgHideUserContribLimit = 1000;
4961 * Number of accounts each IP address may create, 0 to disable.
4963 * @warning Requires memcached
4965 $wgAccountCreationThrottle = 0;
4968 * Edits matching these regular expressions in body text
4969 * will be recognised as spam and rejected automatically.
4971 * There's no administrator override on-wiki, so be careful what you set. :)
4972 * May be an array of regexes or a single string for backwards compatibility.
4974 * @see http://en.wikipedia.org/wiki/Regular_expression
4976 * @note Each regex needs a beginning/end delimiter, eg: # or /
4978 $wgSpamRegex = array();
4981 * Same as the above except for edit summaries
4983 $wgSummarySpamRegex = array();
4986 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4987 * proxies
4988 * @since 1.16
4990 $wgEnableDnsBlacklist = false;
4993 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4995 * This is an array of either a URL or an array with the URL and a key (should
4996 * the blacklist require a key).
4998 * @par Example:
4999 * @code
5000 * $wgDnsBlacklistUrls = array(
5001 * // String containing URL
5002 * 'http.dnsbl.sorbs.net.',
5003 * // Array with URL and key, for services that require a key
5004 * array( 'dnsbl.httpbl.net.', 'mykey' ),
5005 * // Array with just the URL. While this works, it is recommended that you
5006 * // just use a string as shown above
5007 * array( 'opm.tornevall.org.' )
5008 * );
5009 * @endcode
5011 * @note You should end the domain name with a . to avoid searching your
5012 * eventual domain search suffixes.
5013 * @since 1.16
5015 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
5018 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5019 * what the other methods might say.
5021 $wgProxyWhitelist = array();
5024 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5025 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5026 * (transparent) proxies without needing to block the proxies themselves.
5028 $wgApplyIpBlocksToXff = false;
5031 * Simple rate limiter options to brake edit floods.
5033 * Maximum number actions allowed in the given number of seconds; after that
5034 * the violating client receives HTTP 500 error pages until the period
5035 * elapses.
5037 * @par Example:
5038 * To set a generic maximum of 4 hits in 60 seconds:
5039 * @code
5040 * $wgRateLimits = array( 4, 60 );
5041 * @endcode
5043 * You could also limit per action and then type of users. See the inline
5044 * code for a template to use.
5046 * This option set is experimental and likely to change.
5048 * @warning Requires memcached.
5050 $wgRateLimits = array(
5051 'edit' => array(
5052 'anon' => null, // for any and all anonymous edits (aggregate)
5053 'user' => null, // for each logged-in user
5054 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
5055 'ip' => null, // for each anon and recent account
5056 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
5058 'move' => array(
5059 'user' => null,
5060 'newbie' => null,
5061 'ip' => null,
5062 'subnet' => null,
5064 'mailpassword' => array( // triggering password resets emails
5065 'anon' => null,
5067 'emailuser' => array( // emailing other users using MediaWiki
5068 'user' => null,
5070 'linkpurge' => array( // purges of link tables
5071 'anon' => null,
5072 'user' => null,
5073 'newbie' => null,
5074 'ip' => null,
5075 'subnet' => null,
5077 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
5078 'anon' => null,
5079 'user' => null,
5080 'newbie' => null,
5081 'ip' => null,
5082 'subnet' => null,
5084 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
5085 'anon' => null,
5086 'user' => null,
5087 'newbie' => null,
5088 'ip' => null,
5089 'subnet' => null,
5091 'stashedit' => array( // stashing edits into cache before save
5092 'anon' => null,
5093 'user' => null,
5094 'newbie' => null,
5095 'ip' => null,
5096 'subnet' => null,
5098 'changetag' => array( // adding or removing change tags
5099 'user' => null,
5100 'newbie' => null,
5105 * Set to a filename to log rate limiter hits.
5107 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
5109 $wgRateLimitLog = null;
5112 * Array of IPs which should be excluded from rate limits.
5113 * This may be useful for whitelisting NAT gateways for conferences, etc.
5115 $wgRateLimitsExcludedIPs = array();
5118 * Log IP addresses in the recentchanges table; can be accessed only by
5119 * extensions (e.g. CheckUser) or a DB admin
5120 * Used for retroactive autoblocks
5122 $wgPutIPinRC = true;
5125 * Integer defining default number of entries to show on
5126 * special pages which are query-pages such as Special:Whatlinkshere.
5128 $wgQueryPageDefaultLimit = 50;
5131 * Limit password attempts to X attempts per Y seconds per IP per account.
5133 * @warning Requires memcached.
5135 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5137 /** @} */ # end of user rights settings
5139 /************************************************************************//**
5140 * @name Proxy scanner settings
5141 * @{
5145 * This should always be customised in LocalSettings.php
5147 $wgSecretKey = false;
5150 * Big list of banned IP addresses.
5152 * This can have the following formats:
5153 * - An array of addresses, either in the values
5154 * or the keys (for backward compatibility)
5155 * - A string, in that case this is the path to a file
5156 * containing the list of IP addresses, one per line
5158 $wgProxyList = array();
5160 /** @} */ # end of proxy scanner settings
5162 /************************************************************************//**
5163 * @name Cookie settings
5164 * @{
5168 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5170 $wgCookieExpiration = 180 * 86400;
5173 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5174 * or ".any.subdomain.net"
5176 $wgCookieDomain = '';
5179 * Set this variable if you want to restrict cookies to a certain path within
5180 * the domain specified by $wgCookieDomain.
5182 $wgCookiePath = '/';
5185 * Whether the "secure" flag should be set on the cookie. This can be:
5186 * - true: Set secure flag
5187 * - false: Don't set secure flag
5188 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5190 $wgCookieSecure = 'detect';
5193 * By default, MediaWiki checks if the client supports cookies during the
5194 * login process, so that it can display an informative error message if
5195 * cookies are disabled. Set this to true if you want to disable this cookie
5196 * check.
5198 $wgDisableCookieCheck = false;
5201 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5202 * to a string to use a custom prefix. Setting it to false causes the database
5203 * name to be used as a prefix.
5205 $wgCookiePrefix = false;
5208 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5209 * in browsers that support this feature. This can mitigates some classes of
5210 * XSS attack.
5212 $wgCookieHttpOnly = true;
5215 * A list of cookies that vary the cache (for use by extensions)
5217 $wgCacheVaryCookies = array();
5220 * Override to customise the session name
5222 $wgSessionName = false;
5224 /** @} */ # end of cookie settings }
5226 /************************************************************************//**
5227 * @name LaTeX (mathematical formulas)
5228 * @{
5232 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5233 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5234 * (ImageMagick) installed and available in the PATH.
5235 * Please see math/README for more information.
5237 $wgUseTeX = false;
5239 /** @} */ # end LaTeX }
5241 /************************************************************************//**
5242 * @name Profiling, testing and debugging
5244 * To enable profiling, edit StartProfiler.php
5246 * @{
5250 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5251 * The debug log file should be not be publicly accessible if it is used, as it
5252 * may contain private data.
5254 $wgDebugLogFile = '';
5257 * Prefix for debug log lines
5259 $wgDebugLogPrefix = '';
5262 * If true, instead of redirecting, show a page with a link to the redirect
5263 * destination. This allows for the inspection of PHP error messages, and easy
5264 * resubmission of form data. For developer use only.
5266 $wgDebugRedirects = false;
5269 * If true, log debugging data from action=raw and load.php.
5270 * This is normally false to avoid overlapping debug entries due to gen=css
5271 * and gen=js requests.
5273 $wgDebugRawPage = false;
5276 * Send debug data to an HTML comment in the output.
5278 * This may occasionally be useful when supporting a non-technical end-user.
5279 * It's more secure than exposing the debug log file to the web, since the
5280 * output only contains private data for the current user. But it's not ideal
5281 * for development use since data is lost on fatal errors and redirects.
5283 $wgDebugComments = false;
5286 * Extensive database transaction state debugging
5288 * @since 1.20
5290 $wgDebugDBTransactions = false;
5293 * Write SQL queries to the debug log.
5295 * This setting is only used $wgLBFactoryConf['class'] is set to
5296 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5297 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5298 * connection to achieve the same functionality.
5300 $wgDebugDumpSql = false;
5303 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5304 * trimming.
5305 * @since 1.24
5307 $wgDebugDumpSqlLength = 500;
5310 * Performance expectations for DB usage
5312 * @since 1.26
5314 $wgTrxProfilerLimits = array(
5315 // Basic GET and POST requests
5316 'GET' => array( 'masterConns' => 0, 'writes' => 0, 'readQueryTime' => 5 ),
5317 'POST' => array( 'maxAffected' => 500, 'readQueryTime' => 5, 'writeQueryTime' => 1 ),
5318 // Background job runner
5319 'JobRunner' => array( 'maxAffected' => 500, 'readQueryTime' => 30, 'writeQueryTime' => 5 ),
5320 // Command-line scripts
5321 'Maintenance' => array( 'maxAffected' => 1000, 'writeQueryTime' => 5 )
5325 * Map of string log group names to log destinations.
5327 * If set, wfDebugLog() output for that group will go to that file instead
5328 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5329 * in production.
5331 * Log destinations may be one of the following:
5332 * - false to completely remove from the output, including from $wgDebugLogFile.
5333 * - string values specifying a filename or URI.
5334 * - associative array with keys:
5335 * - 'destination' desired filename or URI.
5336 * - 'sample' an integer value, specifying a sampling factor (optional)
5337 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5338 * to log (optional, since 1.25)
5340 * @par Example:
5341 * @code
5342 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5343 * @endcode
5345 * @par Advanced example:
5346 * @code
5347 * $wgDebugLogGroups['memcached'] = array(
5348 * 'destination' => '/var/log/mediawiki/memcached.log',
5349 * 'sample' => 1000, // log 1 message out of every 1,000.
5350 * 'level' => \Psr\Log\LogLevel::WARNING
5351 * );
5352 * @endcode
5354 $wgDebugLogGroups = array();
5357 * Default service provider for creating Psr\Log\LoggerInterface instances.
5359 * The value should be an array suitable for use with
5360 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5361 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
5362 * details.
5364 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
5365 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
5366 * and bypass the use of this configuration variable entirely.
5368 * @par To completely disable logging:
5369 * @code
5370 * $wgMWLoggerDefaultSpi = array( 'class' => '\\MediaWiki\\Logger\\NullSpi' );
5371 * @endcode
5373 * @since 1.25
5374 * @var array $wgMWLoggerDefaultSpi
5375 * @see MwLogger
5377 $wgMWLoggerDefaultSpi = array(
5378 'class' => '\\MediaWiki\\Logger\\LegacySpi',
5382 * Display debug data at the bottom of the main content area.
5384 * Useful for developers and technical users trying to working on a closed wiki.
5386 $wgShowDebug = false;
5389 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5390 * Since 1.19 also includes memory usage.
5392 $wgDebugTimestamps = false;
5395 * Print HTTP headers for every request in the debug information.
5397 $wgDebugPrintHttpHeaders = true;
5400 * Show the contents of $wgHooks in Special:Version
5402 $wgSpecialVersionShowHooks = false;
5405 * Whether to show "we're sorry, but there has been a database error" pages.
5406 * Displaying errors aids in debugging, but may display information useful
5407 * to an attacker.
5409 $wgShowSQLErrors = false;
5412 * If set to true, uncaught exceptions will print a complete stack trace
5413 * to output. This should only be used for debugging, as it may reveal
5414 * private information in function parameters due to PHP's backtrace
5415 * formatting.
5417 $wgShowExceptionDetails = false;
5420 * If true, show a backtrace for database errors
5422 * @note This setting only applies when connection errors and query errors are
5423 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5424 * including those in which an uncaught exception is thrown from within the
5425 * exception handler.
5427 $wgShowDBErrorBacktrace = false;
5430 * If true, send the exception backtrace to the error log
5432 $wgLogExceptionBacktrace = true;
5435 * Expose backend server host names through the API and various HTML comments
5437 $wgShowHostnames = false;
5440 * Override server hostname detection with a hardcoded value.
5441 * Should be a string, default false.
5442 * @since 1.20
5444 $wgOverrideHostname = false;
5447 * If set to true MediaWiki will throw notices for some possible error
5448 * conditions and for deprecated functions.
5450 $wgDevelopmentWarnings = false;
5453 * Release limitation to wfDeprecated warnings, if set to a release number
5454 * development warnings will not be generated for deprecations added in releases
5455 * after the limit.
5457 $wgDeprecationReleaseLimit = false;
5460 * Only record profiling info for pages that took longer than this
5461 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
5463 $wgProfileLimit = 0.0;
5466 * Don't put non-profiling info into log file
5468 * @deprecated since 1.23, set the log file in
5469 * $wgDebugLogGroups['profileoutput'] instead.
5471 $wgProfileOnly = false;
5474 * If true, print a raw call tree instead of per-function report
5476 $wgProfileCallTree = false;
5479 * Should application server host be put into profiling table
5481 * @deprecated set $wgProfiler['perhost'] = true instead
5483 $wgProfilePerHost = null;
5486 * Host for UDP profiler.
5488 * The host should be running a daemon which can be obtained from MediaWiki
5489 * Git at:
5490 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5492 * @deprecated set $wgProfiler['udphost'] instead
5494 $wgUDPProfilerHost = null;
5497 * Port for UDP profiler.
5498 * @see $wgUDPProfilerHost
5500 * @deprecated set $wgProfiler['udpport'] instead
5502 $wgUDPProfilerPort = null;
5505 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5506 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5507 * arguments. You can use sprintf's argument numbering/swapping capability to
5508 * repeat, re-order or omit fields.
5510 * @see $wgStatsFormatString
5511 * @since 1.22
5513 * @deprecated set $wgProfiler['udpformat'] instead
5515 $wgUDPProfilerFormatString = null;
5518 * Destination for wfIncrStats() data...
5519 * 'cache' to go into the system cache, if enabled (memcached)
5520 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5521 * false to disable
5523 $wgStatsMethod = 'cache';
5526 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5527 * be aggregated over more than one wiki. The string will be used in place of
5528 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5529 * will be used.
5531 $wgAggregateStatsID = false;
5534 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5535 * formatted. Its value should be a format string suitable for a sprintf()
5536 * invocation with (id, count, key) arguments, where 'id' is either
5537 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5538 * is being incremented, and 'key' is the metric name.
5540 * @see $wgUDPProfilerFormatString
5541 * @see $wgAggregateStatsID
5542 * @since 1.22
5544 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5547 * InfoAction retrieves a list of transclusion links (both to and from).
5548 * This number puts a limit on that query in the case of highly transcluded
5549 * templates.
5551 $wgPageInfoTransclusionLimit = 50;
5554 * Set this to an integer to only do synchronous site_stats updates
5555 * one every *this many* updates. The other requests go into pending
5556 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5557 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5559 $wgSiteStatsAsyncFactor = false;
5562 * Parser test suite files to be run by parserTests.php when no specific
5563 * filename is passed to it.
5565 * Extensions may add their own tests to this array, or site-local tests
5566 * may be added via LocalSettings.php
5568 * Use full paths.
5570 $wgParserTestFiles = array(
5571 "$IP/tests/parser/parserTests.txt",
5572 "$IP/tests/parser/extraParserTests.txt"
5576 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5578 $wgEnableJavaScriptTest = false;
5581 * Overwrite the caching key prefix with custom value.
5582 * @since 1.19
5584 $wgCachePrefix = false;
5587 * Display the new debugging toolbar. This also enables profiling on database
5588 * queries and other useful output.
5589 * Will disable file cache.
5591 * @since 1.19
5593 $wgDebugToolbar = false;
5595 /** @} */ # end of profiling, testing and debugging }
5597 /************************************************************************//**
5598 * @name Search
5599 * @{
5603 * Set this to true to disable the full text search feature.
5605 $wgDisableTextSearch = false;
5608 * Set to true to have nicer highlighted text in search results,
5609 * by default off due to execution overhead
5611 $wgAdvancedSearchHighlighting = false;
5614 * Regexp to match word boundaries, defaults for non-CJK languages
5615 * should be empty for CJK since the words are not separate
5617 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5620 * Template for OpenSearch suggestions, defaults to API action=opensearch
5622 * Sites with heavy load would typically have these point to a custom
5623 * PHP wrapper to avoid firing up mediawiki for every keystroke
5625 * Placeholders: {searchTerms}
5627 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5629 $wgOpenSearchTemplate = false;
5632 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5634 * Sites with heavy load would typically have these point to a custom
5635 * PHP wrapper to avoid firing up mediawiki for every keystroke
5637 * Placeholders: {searchTerms}
5639 $wgOpenSearchTemplates = array(
5640 'application/x-suggestions+json' => false,
5641 'application/x-suggestions+xml' => false,
5645 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5646 * false if you've disabled scripts that use api?action=opensearch and
5647 * want reduce load caused by cached scripts still pulling suggestions.
5648 * It will let the API fallback by responding with an empty array.
5650 $wgEnableOpenSearchSuggest = true;
5653 * Integer defining default number of entries to show on
5654 * OpenSearch call.
5656 $wgOpenSearchDefaultLimit = 10;
5659 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
5661 $wgOpenSearchDescriptionLength = 100;
5664 * Expiry time for search suggestion responses
5666 $wgSearchSuggestCacheExpiry = 1200;
5669 * If you've disabled search semi-permanently, this also disables updates to the
5670 * table. If you ever re-enable, be sure to rebuild the search table.
5672 $wgDisableSearchUpdate = false;
5675 * List of namespaces which are searched by default.
5677 * @par Example:
5678 * @code
5679 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5680 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5681 * @endcode
5683 $wgNamespacesToBeSearchedDefault = array(
5684 NS_MAIN => true,
5688 * Disable the internal MySQL-based search, to allow it to be
5689 * implemented by an extension instead.
5691 $wgDisableInternalSearch = false;
5694 * Set this to a URL to forward search requests to some external location.
5695 * If the URL includes '$1', this will be replaced with the URL-encoded
5696 * search term.
5698 * @par Example:
5699 * To forward to Google you'd have something like:
5700 * @code
5701 * $wgSearchForwardUrl =
5702 * 'http://www.google.com/search?q=$1' .
5703 * '&domains=http://example.com' .
5704 * '&sitesearch=http://example.com' .
5705 * '&ie=utf-8&oe=utf-8';
5706 * @endcode
5708 $wgSearchForwardUrl = null;
5711 * Search form behavior.
5712 * - true = use Go & Search buttons
5713 * - false = use Go button & Advanced search link
5715 $wgUseTwoButtonsSearchForm = true;
5718 * Array of namespaces to generate a Google sitemap for when the
5719 * maintenance/generateSitemap.php script is run, or false if one is to be
5720 * generated for all namespaces.
5722 $wgSitemapNamespaces = false;
5725 * Custom namespace priorities for sitemaps. Setting this will allow you to
5726 * set custom priorities to namespaces when sitemaps are generated using the
5727 * maintenance/generateSitemap.php script.
5729 * This should be a map of namespace IDs to priority
5730 * @par Example:
5731 * @code
5732 * $wgSitemapNamespacesPriorities = array(
5733 * NS_USER => '0.9',
5734 * NS_HELP => '0.0',
5735 * );
5736 * @endcode
5738 $wgSitemapNamespacesPriorities = false;
5741 * If true, searches for IP addresses will be redirected to that IP's
5742 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5743 * [[Special:Contributions/1.2.3.4]]
5745 $wgEnableSearchContributorsByIP = true;
5747 /** @} */ # end of search settings
5749 /************************************************************************//**
5750 * @name Edit user interface
5751 * @{
5755 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5756 * fall back to the old behavior (no merging).
5758 $wgDiff3 = '/usr/bin/diff3';
5761 * Path to the GNU diff utility.
5763 $wgDiff = '/usr/bin/diff';
5766 * Which namespaces have special treatment where they should be preview-on-open
5767 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5768 * can specify namespaces of pages they have special treatment for
5770 $wgPreviewOnOpenNamespaces = array(
5771 NS_CATEGORY => true
5775 * Enable the UniversalEditButton for browsers that support it
5776 * (currently only Firefox with an extension)
5777 * See http://universaleditbutton.org for more background information
5779 $wgUniversalEditButton = true;
5782 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5783 * will try to automatically create one. This feature can be disabled by set-
5784 * ting this variable false.
5786 $wgUseAutomaticEditSummaries = true;
5788 /** @} */ # end edit UI }
5790 /************************************************************************//**
5791 * @name Maintenance
5792 * See also $wgSiteNotice
5793 * @{
5797 * @cond file_level_code
5798 * Set $wgCommandLineMode if it's not set already, to avoid notices
5800 if ( !isset( $wgCommandLineMode ) ) {
5801 $wgCommandLineMode = false;
5803 /** @endcond */
5806 * For colorized maintenance script output, is your terminal background dark ?
5808 $wgCommandLineDarkBg = false;
5811 * Set this to a string to put the wiki into read-only mode. The text will be
5812 * used as an explanation to users.
5814 * This prevents most write operations via the web interface. Cache updates may
5815 * still be possible. To prevent database writes completely, use the read_only
5816 * option in MySQL.
5818 $wgReadOnly = null;
5821 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5822 * Its contents will be shown to users as part of the read-only warning
5823 * message.
5825 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5827 $wgReadOnlyFile = false;
5830 * When you run the web-based upgrade utility, it will tell you what to set
5831 * this to in order to authorize the upgrade process. It will subsequently be
5832 * used as a password, to authorize further upgrades.
5834 * For security, do not set this to a guessable string. Use the value supplied
5835 * by the install/upgrade process. To cause the upgrader to generate a new key,
5836 * delete the old key from LocalSettings.php.
5838 $wgUpgradeKey = false;
5841 * Fully specified path to git binary
5843 $wgGitBin = '/usr/bin/git';
5846 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5848 * Key is a pattern passed to preg_match() and preg_replace(),
5849 * without the delimiters (which are #) and must match the whole URL.
5850 * The value is the replacement for the key (it can contain $1, etc.)
5851 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5852 * full SHA-1 of the HEAD revision.
5853 * %r will be replaced with a URL-encoded version of $1.
5855 * @since 1.20
5857 $wgGitRepositoryViewers = array(
5858 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5859 'https://git.wikimedia.org/tree/%r/%H',
5860 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5861 'https://git.wikimedia.org/tree/%r/%H',
5864 /** @} */ # End of maintenance }
5866 /************************************************************************//**
5867 * @name Recent changes, new pages, watchlist and history
5868 * @{
5872 * Recentchanges items are periodically purged; entries older than this many
5873 * seconds will go.
5874 * Default: 90 days = about three months
5876 $wgRCMaxAge = 90 * 24 * 3600;
5879 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5880 * higher than what will be stored. Note that this is disabled by default
5881 * because we sometimes do have RC data which is beyond the limit for some
5882 * reason, and some users may use the high numbers to display that data which
5883 * is still there.
5885 $wgRCFilterByAge = false;
5888 * List of Limits options to list in the Special:Recentchanges and
5889 * Special:Recentchangeslinked pages.
5891 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5894 * List of Days options to list in the Special:Recentchanges and
5895 * Special:Recentchangeslinked pages.
5897 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5900 * Destinations to which notifications about recent changes
5901 * should be sent.
5903 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5904 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5905 * specified server.
5906 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5908 * The common options are:
5909 * * 'uri' -- the address to which the notices are to be sent.
5910 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5911 * produce the text to send. This can also be an object of the class.
5912 * * 'omit_bots' -- whether the bot edits should be in the feed
5913 * * 'omit_anon' -- whether anonymous edits should be in the feed
5914 * * 'omit_user' -- whether edits by registered users should be in the feed
5915 * * 'omit_minor' -- whether minor edits should be in the feed
5916 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5918 * The IRC-specific options are:
5919 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5920 * the first entry in the $wgLocalInterwikis array (or the value of
5921 * $wgLocalInterwiki, if set)
5923 * The JSON-specific options are:
5924 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5926 * @example $wgRCFeeds['example'] = array(
5927 * 'formatter' => 'JSONRCFeedFormatter',
5928 * 'uri' => "udp://localhost:1336",
5929 * 'add_interwiki_prefix' => false,
5930 * 'omit_bots' => true,
5931 * );
5932 * @example $wgRCFeeds['exampleirc'] = array(
5933 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5934 * 'uri' => "udp://localhost:1338",
5935 * 'add_interwiki_prefix' => false,
5936 * 'omit_bots' => true,
5937 * );
5938 * @since 1.22
5940 $wgRCFeeds = array();
5943 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5944 * Keys are scheme names, values are names of engine classes.
5946 $wgRCEngines = array(
5947 'redis' => 'RedisPubSubFeedEngine',
5948 'udp' => 'UDPRCFeedEngine',
5952 * Use RC Patrolling to check for vandalism
5954 $wgUseRCPatrol = true;
5957 * Use new page patrolling to check new pages on Special:Newpages
5959 $wgUseNPPatrol = true;
5962 * Log autopatrol actions to the log table
5964 $wgLogAutopatrol = true;
5967 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5969 $wgFeed = true;
5972 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5973 * eg Recentchanges, Newpages.
5975 $wgFeedLimit = 50;
5978 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5979 * A cached version will continue to be served out even if changes
5980 * are made, until this many seconds runs out since the last render.
5982 * If set to 0, feed caching is disabled. Use this for debugging only;
5983 * feed generation can be pretty slow with diffs.
5985 $wgFeedCacheTimeout = 60;
5988 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5989 * pages larger than this size.
5991 $wgFeedDiffCutoff = 32768;
5994 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5995 * every page. Some sites might have a different feed they'd like to promote
5996 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5997 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5998 * as value.
5999 * @par Example:
6000 * Configure the 'atom' feed to http://example.com/somefeed.xml
6001 * @code
6002 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6003 * @endcode
6005 $wgOverrideSiteFeed = array();
6008 * Available feeds objects.
6009 * Should probably only be defined when a page is syndicated ie when
6010 * $wgOut->isSyndicated() is true.
6012 $wgFeedClasses = array(
6013 'rss' => 'RSSFeed',
6014 'atom' => 'AtomFeed',
6018 * Which feed types should we provide by default? This can include 'rss',
6019 * 'atom', neither, or both.
6021 $wgAdvertisedFeedTypes = array( 'atom' );
6024 * Show watching users in recent changes, watchlist and page history views
6026 $wgRCShowWatchingUsers = false; # UPO
6029 * Show the amount of changed characters in recent changes
6031 $wgRCShowChangedSize = true;
6034 * If the difference between the character counts of the text
6035 * before and after the edit is below that value, the value will be
6036 * highlighted on the RC page.
6038 $wgRCChangedSizeThreshold = 500;
6041 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6042 * view for watched pages with new changes
6044 $wgShowUpdatedMarker = true;
6047 * Disable links to talk pages of anonymous users (IPs) in listings on special
6048 * pages like page history, Special:Recentchanges, etc.
6050 $wgDisableAnonTalk = false;
6053 * Enable filtering of categories in Recentchanges
6055 $wgAllowCategorizedRecentChanges = false;
6058 * Allow filtering by change tag in recentchanges, history, etc
6059 * Has no effect if no tags are defined in valid_tag.
6061 $wgUseTagFilter = true;
6064 * If set to an integer, pages that are watched by this many users or more
6065 * will not require the unwatchedpages permission to view the number of
6066 * watchers.
6068 * @since 1.21
6070 $wgUnwatchedPageThreshold = false;
6073 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6074 * certain types of edits.
6076 * To register a new one:
6077 * @code
6078 * $wgRecentChangesFlags['flag'] => array(
6079 * // message for the letter displayed next to rows on changes lists
6080 * 'letter' => 'letter-msg',
6081 * // message for the tooltip of the letter
6082 * 'title' => 'tooltip-msg',
6083 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6084 * 'legend' => 'legend-msg',
6085 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6086 * 'class' => 'css-class',
6087 * );
6088 * @endcode
6090 * @since 1.22
6092 $wgRecentChangesFlags = array(
6093 'newpage' => array(
6094 'letter' => 'newpageletter',
6095 'title' => 'recentchanges-label-newpage',
6096 'legend' => 'recentchanges-legend-newpage',
6098 'minor' => array(
6099 'letter' => 'minoreditletter',
6100 'title' => 'recentchanges-label-minor',
6101 'legend' => 'recentchanges-legend-minor',
6102 'class' => 'minoredit',
6104 'bot' => array(
6105 'letter' => 'boteditletter',
6106 'title' => 'recentchanges-label-bot',
6107 'legend' => 'recentchanges-legend-bot',
6108 'class' => 'botedit',
6110 'unpatrolled' => array(
6111 'letter' => 'unpatrolledletter',
6112 'title' => 'recentchanges-label-unpatrolled',
6113 'legend' => 'recentchanges-legend-unpatrolled',
6117 /** @} */ # end RC/watchlist }
6119 /************************************************************************//**
6120 * @name Copyright and credits settings
6121 * @{
6125 * Override for copyright metadata.
6127 * This is the name of the page containing information about the wiki's copyright status,
6128 * which will be added as a link in the footer if it is specified. It overrides
6129 * $wgRightsUrl if both are specified.
6131 $wgRightsPage = null;
6134 * Set this to specify an external URL containing details about the content license used on your
6135 * wiki.
6136 * If $wgRightsPage is set then this setting is ignored.
6138 $wgRightsUrl = null;
6141 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6142 * link.
6143 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6144 * of the page will also be used as the link if this variable is not set.
6146 $wgRightsText = null;
6149 * Override for copyright metadata.
6151 $wgRightsIcon = null;
6154 * Set this to some HTML to override the rights icon with an arbitrary logo
6155 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6157 $wgCopyrightIcon = null;
6160 * Set this to true if you want detailed copyright information forms on Upload.
6162 $wgUseCopyrightUpload = false;
6165 * Set this to the number of authors that you want to be credited below an
6166 * article text. Set it to zero to hide the attribution block, and a negative
6167 * number (like -1) to show all authors. Note that this will require 2-3 extra
6168 * database hits, which can have a not insignificant impact on performance for
6169 * large wikis.
6171 $wgMaxCredits = 0;
6174 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6175 * Otherwise, link to a separate credits page.
6177 $wgShowCreditsIfMax = true;
6179 /** @} */ # end of copyright and credits settings }
6181 /************************************************************************//**
6182 * @name Import / Export
6183 * @{
6187 * List of interwiki prefixes for wikis we'll accept as sources for
6188 * Special:Import (for sysops). Since complete page history can be imported,
6189 * these should be 'trusted'.
6191 * This can either be a regular array, or an associative map specifying
6192 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6193 * e.g.
6194 * @code
6195 * $wgImportSources = array(
6196 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6197 * 'wikispecies',
6198 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6199 * );
6200 * @endcode
6202 * If a user has the 'import' permission but not the 'importupload' permission,
6203 * they will only be able to run imports through this transwiki interface.
6205 $wgImportSources = array();
6208 * Optional default target namespace for interwiki imports.
6209 * Can use this to create an incoming "transwiki"-style queue.
6210 * Set to numeric key, not the name.
6212 * Users may override this in the Special:Import dialog.
6214 $wgImportTargetNamespace = null;
6217 * If set to false, disables the full-history option on Special:Export.
6218 * This is currently poorly optimized for long edit histories, so is
6219 * disabled on Wikimedia's sites.
6221 $wgExportAllowHistory = true;
6224 * If set nonzero, Special:Export requests for history of pages with
6225 * more revisions than this will be rejected. On some big sites things
6226 * could get bogged down by very very long pages.
6228 $wgExportMaxHistory = 0;
6231 * Return distinct author list (when not returning full history)
6233 $wgExportAllowListContributors = false;
6236 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6237 * up to this specified level, which will cause it to include all
6238 * pages linked to from the pages you specify. Since this number
6239 * can become *insanely large* and could easily break your wiki,
6240 * it's disabled by default for now.
6242 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6243 * crazy-big export from being done by someone setting the depth number too
6244 * high. In other words, last resort safety net.
6246 $wgExportMaxLinkDepth = 0;
6249 * Whether to allow the "export all pages in namespace" option
6251 $wgExportFromNamespaces = false;
6254 * Whether to allow exporting the entire wiki into a single file
6256 $wgExportAllowAll = false;
6258 /** @} */ # end of import/export }
6260 /*************************************************************************//**
6261 * @name Extensions
6262 * @{
6266 * A list of callback functions which are called once MediaWiki is fully
6267 * initialised
6269 $wgExtensionFunctions = array();
6272 * Extension messages files.
6274 * Associative array mapping extension name to the filename where messages can be
6275 * found. The file should contain variable assignments. Any of the variables
6276 * present in languages/messages/MessagesEn.php may be defined, but $messages
6277 * is the most common.
6279 * Variables defined in extensions will override conflicting variables defined
6280 * in the core.
6282 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6283 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6284 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6285 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6287 * Extensions using the JSON message format can preserve backward compatibility with
6288 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6289 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6290 * as for the $wgMessagesDirs entry.
6292 * @par Example:
6293 * @code
6294 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6295 * @endcode
6297 $wgExtensionMessagesFiles = array();
6300 * Extension messages directories.
6302 * Associative array mapping extension name to the path of the directory where message files can
6303 * be found. The message files are expected to be JSON files named for their language code, e.g.
6304 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6305 * message directories.
6307 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6309 * @par Simple example:
6310 * @code
6311 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6312 * @endcode
6314 * @par Complex example:
6315 * @code
6316 * $wgMessagesDirs['Example'] = array(
6317 * __DIR__ . '/lib/ve/i18n',
6318 * __DIR__ . '/lib/oojs-ui/i18n',
6319 * __DIR__ . '/i18n',
6321 * @endcode
6322 * @since 1.23
6324 $wgMessagesDirs = array();
6327 * Array of files with list(s) of extension entry points to be used in
6328 * maintenance/mergeMessageFileList.php
6329 * @since 1.22
6331 $wgExtensionEntryPointListFiles = array();
6334 * Parser output hooks.
6335 * This is an associative array where the key is an extension-defined tag
6336 * (typically the extension name), and the value is a PHP callback.
6337 * These will be called as an OutputPageParserOutput hook, if the relevant
6338 * tag has been registered with the parser output object.
6340 * Registration is done with $pout->addOutputHook( $tag, $data ).
6342 * The callback has the form:
6343 * @code
6344 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6345 * @endcode
6347 $wgParserOutputHooks = array();
6350 * Whether to include the NewPP limit report as a HTML comment
6352 $wgEnableParserLimitReporting = true;
6355 * List of valid skin names
6357 * The key should be the name in all lower case, the value should be a properly
6358 * cased name for the skin. This value will be prefixed with "Skin" to create
6359 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6360 * if you wish to have access to the full list.
6362 $wgValidSkinNames = array();
6365 * Special page list. This is an associative array mapping the (canonical) names of
6366 * special pages to either a class name to be instantiated, or a callback to use for
6367 * creating the special page object. In both cases, the result must be an instance of
6368 * SpecialPage.
6370 $wgSpecialPages = array();
6373 * Array mapping class names to filenames, for autoloading.
6375 $wgAutoloadClasses = array();
6378 * Switch controlling legacy case-insensitive classloading.
6379 * Do not disable if your wiki must support data created by PHP4, or by
6380 * MediaWiki 1.4 or earlier.
6382 $wgAutoloadAttemptLowercase = true;
6385 * An array of information about installed extensions keyed by their type.
6387 * All but 'name', 'path' and 'author' can be omitted.
6389 * @code
6390 * $wgExtensionCredits[$type][] = array(
6391 * 'path' => __FILE__,
6392 * 'name' => 'Example extension',
6393 * 'namemsg' => 'exampleextension-name',
6394 * 'author' => array(
6395 * 'Foo Barstein',
6396 * ),
6397 * 'version' => '1.9.0',
6398 * 'url' => 'http://example.org/example-extension/',
6399 * 'descriptionmsg' => 'exampleextension-desc',
6400 * 'license-name' => 'GPL-2.0+',
6401 * );
6402 * @endcode
6404 * The extensions are listed on Special:Version. This page also looks for a file
6405 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6406 * view said file. When the 'license-name' key is specified, this file is
6407 * interpreted as wikitext.
6409 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6410 * 'skin', 'api', or 'other', or any additional types as specified through the
6411 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6413 * - name: Name of extension as an inline string instead of localizable message.
6414 * Do not omit this even if 'namemsg' is provided, as it is used to override
6415 * the path Special:Version uses to find extension's license info, and is
6416 * required for backwards-compatibility with MediaWiki 1.23 and older.
6418 * - namemsg (since MW 1.24): A message key for a message containing the
6419 * extension's name, if the name is localizable. (For example, skin names
6420 * usually are.)
6422 * - author: A string or an array of strings. Authors can be linked using
6423 * the regular wikitext link syntax. To have an internationalized version of
6424 * "and others" show, add an element "...". This element can also be linked,
6425 * for instance "[http://example ...]".
6427 * - descriptionmsg: A message key or an an array with message key and parameters:
6428 * `'descriptionmsg' => 'exampleextension-desc',`
6430 * - description: Description of extension as an inline string instead of
6431 * localizable message (omit in favour of 'descriptionmsg').
6433 * - license-name: Short name of the license (used as label for the link), such
6434 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6436 $wgExtensionCredits = array();
6439 * Authentication plugin.
6440 * @var $wgAuth AuthPlugin
6442 $wgAuth = null;
6445 * Global list of hooks.
6447 * The key is one of the events made available by MediaWiki, you can find
6448 * a description for most of them in docs/hooks.txt. The array is used
6449 * internally by Hook:run().
6451 * The value can be one of:
6453 * - A function name:
6454 * @code
6455 * $wgHooks['event_name'][] = $function;
6456 * @endcode
6457 * - A function with some data:
6458 * @code
6459 * $wgHooks['event_name'][] = array( $function, $data );
6460 * @endcode
6461 * - A an object method:
6462 * @code
6463 * $wgHooks['event_name'][] = array( $object, 'method' );
6464 * @endcode
6465 * - A closure:
6466 * @code
6467 * $wgHooks['event_name'][] = function ( $hookParam ) {
6468 * // Handler code goes here.
6469 * };
6470 * @endcode
6472 * @warning You should always append to an event array or you will end up
6473 * deleting a previous registered hook.
6475 * @warning Hook handlers should be registered at file scope. Registering
6476 * handlers after file scope can lead to unexpected results due to caching.
6478 $wgHooks = array();
6481 * Maps jobs to their handling classes; extensions
6482 * can add to this to provide custom jobs
6484 $wgJobClasses = array(
6485 'refreshLinks' => 'RefreshLinksJob',
6486 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6487 'sendMail' => 'EmaillingJob',
6488 'enotifNotify' => 'EnotifNotifyJob',
6489 'fixDoubleRedirect' => 'DoubleRedirectJob',
6490 'uploadFromUrl' => 'UploadFromUrlJob',
6491 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6492 'PublishStashedFile' => 'PublishStashedFileJob',
6493 'ThumbnailRender' => 'ThumbnailRenderJob',
6494 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6495 'refreshLinksPrioritized' => 'RefreshLinksJob', // for cascading protection
6496 'activityUpdateJob' => 'ActivityUpdateJob',
6497 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
6498 'null' => 'NullJob'
6502 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6503 * special flags are set. The values here are keys of $wgJobClasses.
6505 * These can be:
6506 * - Very long-running jobs.
6507 * - Jobs that you would never want to run as part of a page rendering request.
6508 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6509 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6510 * These settings should be global to all wikis.
6512 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6515 * Map of job types to how many job "work items" should be run per second
6516 * on each job runner process. The meaning of "work items" varies per job,
6517 * but typically would be something like "pages to update". A single job
6518 * may have a variable number of work items, as is the case with batch jobs.
6519 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6520 * These settings should be global to all wikis.
6521 * @var float[]
6523 $wgJobBackoffThrottling = array();
6526 * Make job runners commit changes for slave-lag prone jobs one job at a time.
6527 * This is useful if there are many job workers that race on slave lag checks.
6528 * If set, jobs taking this many seconds of DB write time have serialized commits.
6530 * Note that affected jobs may have worse lock contention. Also, if they affect
6531 * several DBs at once they may have a smaller chance of being atomic due to the
6532 * possibility of connection loss while queueing up to commit. Affected jobs may
6533 * also fail due to the commit lock acquisition timeout.
6535 * @var float|bool
6536 * @since 1.26
6538 $wgJobSerialCommitThreshold = false;
6541 * Map of job types to configuration arrays.
6542 * This determines which queue class and storage system is used for each job type.
6543 * Job types that do not have explicit configuration will use the 'default' config.
6544 * These settings should be global to all wikis.
6546 $wgJobTypeConf = array(
6547 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6551 * Which aggregator to use for tracking which queues have jobs.
6552 * These settings should be global to all wikis.
6554 $wgJobQueueAggregator = array(
6555 'class' => 'JobQueueAggregatorNull'
6559 * Additional functions to be performed with updateSpecialPages.
6560 * Expensive Querypages are already updated.
6562 $wgSpecialPageCacheUpdates = array(
6563 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
6567 * Hooks that are used for outputting exceptions. Format is:
6568 * $wgExceptionHooks[] = $funcname
6569 * or:
6570 * $wgExceptionHooks[] = array( $class, $funcname )
6571 * Hooks should return strings or false
6573 $wgExceptionHooks = array();
6576 * Page property link table invalidation lists. When a page property
6577 * changes, this may require other link tables to be updated (eg
6578 * adding __HIDDENCAT__ means the hiddencat tracking category will
6579 * have been added, so the categorylinks table needs to be rebuilt).
6580 * This array can be added to by extensions.
6582 $wgPagePropLinkInvalidations = array(
6583 'hiddencat' => 'categorylinks',
6586 /** @} */ # End extensions }
6588 /*************************************************************************//**
6589 * @name Categories
6590 * @{
6594 * Use experimental, DMOZ-like category browser
6596 $wgUseCategoryBrowser = false;
6599 * On category pages, show thumbnail gallery for images belonging to that
6600 * category instead of listing them as articles.
6602 $wgCategoryMagicGallery = true;
6605 * Paging limit for categories
6607 $wgCategoryPagingLimit = 200;
6610 * Specify how category names should be sorted, when listed on a category page.
6611 * A sorting scheme is also known as a collation.
6613 * Available values are:
6615 * - uppercase: Converts the category name to upper case, and sorts by that.
6617 * - identity: Does no conversion. Sorts by binary value of the string.
6619 * - uca-default: Provides access to the Unicode Collation Algorithm with
6620 * the default element table. This is a compromise collation which sorts
6621 * all languages in a mediocre way. However, it is better than "uppercase".
6623 * To use the uca-default collation, you must have PHP's intl extension
6624 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6625 * resulting collation will depend on the version of ICU installed on the
6626 * server.
6628 * After you change this, you must run maintenance/updateCollation.php to fix
6629 * the sort keys in the database.
6631 * Extensions can define there own collations by subclassing Collation
6632 * and using the Collation::factory hook.
6634 $wgCategoryCollation = 'uppercase';
6636 /** @} */ # End categories }
6638 /*************************************************************************//**
6639 * @name Logging
6640 * @{
6644 * The logging system has two levels: an event type, which describes the
6645 * general category and can be viewed as a named subset of all logs; and
6646 * an action, which is a specific kind of event that can exist in that
6647 * log type.
6649 $wgLogTypes = array(
6651 'block',
6652 'protect',
6653 'rights',
6654 'delete',
6655 'upload',
6656 'move',
6657 'import',
6658 'patrol',
6659 'merge',
6660 'suppress',
6661 'tag',
6662 'managetags',
6666 * This restricts log access to those who have a certain right
6667 * Users without this will not see it in the option menu and can not view it
6668 * Restricted logs are not added to recent changes
6669 * Logs should remain non-transcludable
6670 * Format: logtype => permissiontype
6672 $wgLogRestrictions = array(
6673 'suppress' => 'suppressionlog'
6677 * Show/hide links on Special:Log will be shown for these log types.
6679 * This is associative array of log type => boolean "hide by default"
6681 * See $wgLogTypes for a list of available log types.
6683 * @par Example:
6684 * @code
6685 * $wgFilterLogTypes = array(
6686 * 'move' => true,
6687 * 'import' => false,
6688 * );
6689 * @endcode
6691 * Will display show/hide links for the move and import logs. Move logs will be
6692 * hidden by default unless the link is clicked. Import logs will be shown by
6693 * default, and hidden when the link is clicked.
6695 * A message of the form log-show-hide-[type] should be added, and will be used
6696 * for the link text.
6698 $wgFilterLogTypes = array(
6699 'patrol' => true,
6700 'tag' => true,
6704 * Lists the message key string for each log type. The localized messages
6705 * will be listed in the user interface.
6707 * Extensions with custom log types may add to this array.
6709 * @since 1.19, if you follow the naming convention log-name-TYPE,
6710 * where TYPE is your log type, yoy don't need to use this array.
6712 $wgLogNames = array(
6713 '' => 'all-logs-page',
6714 'block' => 'blocklogpage',
6715 'protect' => 'protectlogpage',
6716 'rights' => 'rightslog',
6717 'delete' => 'dellogpage',
6718 'upload' => 'uploadlogpage',
6719 'move' => 'movelogpage',
6720 'import' => 'importlogpage',
6721 'patrol' => 'patrol-log-page',
6722 'merge' => 'mergelog',
6723 'suppress' => 'suppressionlog',
6727 * Lists the message key string for descriptive text to be shown at the
6728 * top of each log type.
6730 * Extensions with custom log types may add to this array.
6732 * @since 1.19, if you follow the naming convention log-description-TYPE,
6733 * where TYPE is your log type, yoy don't need to use this array.
6735 $wgLogHeaders = array(
6736 '' => 'alllogstext',
6737 'block' => 'blocklogtext',
6738 'protect' => 'protectlogtext',
6739 'rights' => 'rightslogtext',
6740 'delete' => 'dellogpagetext',
6741 'upload' => 'uploadlogpagetext',
6742 'move' => 'movelogpagetext',
6743 'import' => 'importlogpagetext',
6744 'patrol' => 'patrol-log-header',
6745 'merge' => 'mergelogpagetext',
6746 'suppress' => 'suppressionlogtext',
6750 * Lists the message key string for formatting individual events of each
6751 * type and action when listed in the logs.
6753 * Extensions with custom log types may add to this array.
6755 $wgLogActions = array(
6756 'protect/protect' => 'protectedarticle',
6757 'protect/modify' => 'modifiedarticleprotection',
6758 'protect/unprotect' => 'unprotectedarticle',
6759 'protect/move_prot' => 'movedarticleprotection',
6763 * The same as above, but here values are names of classes,
6764 * not messages.
6765 * @see LogPage::actionText
6766 * @see LogFormatter
6768 $wgLogActionsHandlers = array(
6769 'move/move' => 'MoveLogFormatter',
6770 'move/move_redir' => 'MoveLogFormatter',
6771 'delete/delete' => 'DeleteLogFormatter',
6772 'delete/restore' => 'DeleteLogFormatter',
6773 'delete/revision' => 'DeleteLogFormatter',
6774 'delete/event' => 'DeleteLogFormatter',
6775 'suppress/revision' => 'DeleteLogFormatter',
6776 'suppress/event' => 'DeleteLogFormatter',
6777 'suppress/delete' => 'DeleteLogFormatter',
6778 'patrol/patrol' => 'PatrolLogFormatter',
6779 'rights/rights' => 'RightsLogFormatter',
6780 'rights/autopromote' => 'RightsLogFormatter',
6781 'upload/upload' => 'UploadLogFormatter',
6782 'upload/overwrite' => 'UploadLogFormatter',
6783 'upload/revert' => 'UploadLogFormatter',
6784 'merge/merge' => 'MergeLogFormatter',
6785 'tag/update' => 'TagLogFormatter',
6786 'managetags/create' => 'LogFormatter',
6787 'managetags/delete' => 'LogFormatter',
6788 'managetags/activate' => 'LogFormatter',
6789 'managetags/deactivate' => 'LogFormatter',
6790 'block/block' => 'BlockLogFormatter',
6791 'block/unblock' => 'BlockLogFormatter',
6792 'block/reblock' => 'BlockLogFormatter',
6793 'suppress/block' => 'BlockLogFormatter',
6794 'suppress/reblock' => 'BlockLogFormatter',
6795 'import/upload' => 'LogFormatter',
6796 'import/interwiki' => 'LogFormatter',
6800 * Maintain a log of newusers at Log/newusers?
6802 $wgNewUserLog = true;
6804 /** @} */ # end logging }
6806 /*************************************************************************//**
6807 * @name Special pages (general and miscellaneous)
6808 * @{
6812 * Allow special page inclusions such as {{Special:Allpages}}
6814 $wgAllowSpecialInclusion = true;
6817 * Set this to an array of special page names to prevent
6818 * maintenance/updateSpecialPages.php from updating those pages.
6820 $wgDisableQueryPageUpdate = false;
6823 * List of special pages, followed by what subtitle they should go under
6824 * at Special:SpecialPages
6826 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6828 $wgSpecialPageGroups = array();
6831 * On Special:Unusedimages, consider images "used", if they are put
6832 * into a category. Default (false) is not to count those as used.
6834 $wgCountCategorizedImagesAsUsed = false;
6837 * Maximum number of links to a redirect page listed on
6838 * Special:Whatlinkshere/RedirectDestination
6840 $wgMaxRedirectLinksRetrieved = 500;
6842 /** @} */ # end special pages }
6844 /*************************************************************************//**
6845 * @name Actions
6846 * @{
6850 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6851 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6852 * 'foo' => true Load the class FooAction which subclasses Action
6853 * If something is specified in the getActionOverrides()
6854 * of the relevant Page object it will be used
6855 * instead of the default class.
6856 * 'foo' => false The action is disabled; show an error message
6857 * Unsetting core actions will probably cause things to complain loudly.
6859 $wgActions = array(
6860 'credits' => true,
6861 'delete' => true,
6862 'edit' => true,
6863 'editchangetags' => 'SpecialPageAction',
6864 'history' => true,
6865 'info' => true,
6866 'markpatrolled' => true,
6867 'protect' => true,
6868 'purge' => true,
6869 'raw' => true,
6870 'render' => true,
6871 'revert' => true,
6872 'revisiondelete' => 'SpecialPageAction',
6873 'rollback' => true,
6874 'submit' => true,
6875 'unprotect' => true,
6876 'unwatch' => true,
6877 'view' => true,
6878 'watch' => true,
6881 /** @} */ # end actions }
6883 /*************************************************************************//**
6884 * @name Robot (search engine crawler) policy
6885 * See also $wgNoFollowLinks.
6886 * @{
6890 * Default robot policy. The default policy is to encourage indexing and fol-
6891 * lowing of links. It may be overridden on a per-namespace and/or per-page
6892 * basis.
6894 $wgDefaultRobotPolicy = 'index,follow';
6897 * Robot policies per namespaces. The default policy is given above, the array
6898 * is made of namespace constants as defined in includes/Defines.php. You can-
6899 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6900 * nofollow. This is because a number of special pages (e.g., ListPages) have
6901 * many permutations of options that display the same data under redundant
6902 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6903 * pages, all alike, and never reaching your actual content.
6905 * @par Example:
6906 * @code
6907 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6908 * @endcode
6910 $wgNamespaceRobotPolicies = array();
6913 * Robot policies per article. These override the per-namespace robot policies.
6914 * Must be in the form of an array where the key part is a properly canonicalised
6915 * text form title and the value is a robot policy.
6917 * @par Example:
6918 * @code
6919 * $wgArticleRobotPolicies = array(
6920 * 'Main Page' => 'noindex,follow',
6921 * 'User:Bob' => 'index,follow',
6922 * );
6923 * @endcode
6925 * @par Example that DOES NOT WORK because the names are not canonical text
6926 * forms:
6927 * @code
6928 * $wgArticleRobotPolicies = array(
6929 * # Underscore, not space!
6930 * 'Main_Page' => 'noindex,follow',
6931 * # "Project", not the actual project name!
6932 * 'Project:X' => 'index,follow',
6933 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6934 * 'abc' => 'noindex,nofollow'
6935 * );
6936 * @endcode
6938 $wgArticleRobotPolicies = array();
6941 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6942 * will not function, so users can't decide whether pages in that namespace are
6943 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6945 * @par Example:
6946 * @code
6947 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6948 * @endcode
6950 $wgExemptFromUserRobotsControl = null;
6952 /** @} */ # End robot policy }
6954 /************************************************************************//**
6955 * @name AJAX and API
6956 * Note: The AJAX entry point which this section refers to is gradually being
6957 * replaced by the API entry point, api.php. They are essentially equivalent.
6958 * Both of them are used for dynamic client-side features, via XHR.
6959 * @{
6963 * Enable the MediaWiki API for convenient access to
6964 * machine-readable data via api.php
6966 * See https://www.mediawiki.org/wiki/API
6968 $wgEnableAPI = true;
6971 * Allow the API to be used to perform write operations
6972 * (page edits, rollback, etc.) when an authorised user
6973 * accesses it
6975 $wgEnableWriteAPI = true;
6979 * WARNING: SECURITY THREAT - debug use only
6981 * Disables many security checks in the API for debugging purposes.
6982 * This flag should never be used on the production servers, as it introduces
6983 * a number of potential security holes. Even when enabled, the validation
6984 * will still be performed, but instead of failing, API will return a warning.
6985 * Also, there will always be a warning notifying that this flag is set.
6986 * At this point, the flag allows GET requests to go through for modules
6987 * requiring POST.
6989 * @since 1.21
6991 $wgDebugAPI = false;
6994 * API module extensions.
6996 * Associative array mapping module name to modules specs;
6997 * Each module spec is an associative array containing at least
6998 * the 'class' key for the module's class, and optionally a
6999 * 'factory' key for the factory function to use for the module.
7001 * That factory function will be called with two parameters,
7002 * the parent module (an instance of ApiBase, usually ApiMain)
7003 * and the name the module was registered under. The return
7004 * value must be an instance of the class given in the 'class'
7005 * field.
7007 * For backward compatibility, the module spec may also be a
7008 * simple string containing the module's class name. In that
7009 * case, the class' constructor will be called with the parent
7010 * module and module name as parameters, as described above.
7012 * Examples for registering API modules:
7014 * @code
7015 * $wgAPIModules['foo'] = 'ApiFoo';
7016 * $wgAPIModules['bar'] = array(
7017 * 'class' => 'ApiBar',
7018 * 'factory' => function( $main, $name ) { ... }
7019 * );
7020 * $wgAPIModules['xyzzy'] = array(
7021 * 'class' => 'ApiXyzzy',
7022 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
7023 * );
7024 * @endcode
7026 * Extension modules may override the core modules.
7027 * See ApiMain::$Modules for a list of the core modules.
7029 $wgAPIModules = array();
7032 * API format module extensions.
7033 * Associative array mapping format module name to module specs (see $wgAPIModules).
7034 * Extension modules may override the core modules.
7036 * See ApiMain::$Formats for a list of the core format modules.
7038 $wgAPIFormatModules = array();
7041 * API Query meta module extensions.
7042 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7043 * Extension modules may override the core modules.
7045 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7047 $wgAPIMetaModules = array();
7050 * API Query prop module extensions.
7051 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7052 * Extension modules may override the core modules.
7054 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7056 $wgAPIPropModules = array();
7059 * API Query list module extensions.
7060 * Associative array mapping list module name to module specs (see $wgAPIModules).
7061 * Extension modules may override the core modules.
7063 * See ApiQuery::$QueryListModules for a list of the core list modules.
7065 $wgAPIListModules = array();
7068 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
7069 * @deprecated since 1.21
7071 $wgAPIGeneratorModules = array();
7074 * Maximum amount of rows to scan in a DB query in the API
7075 * The default value is generally fine
7077 $wgAPIMaxDBRows = 5000;
7080 * The maximum size (in bytes) of an API result.
7081 * @warning Do not set this lower than $wgMaxArticleSize*1024
7083 $wgAPIMaxResultSize = 8388608;
7086 * The maximum number of uncached diffs that can be retrieved in one API
7087 * request. Set this to 0 to disable API diffs altogether
7089 $wgAPIMaxUncachedDiffs = 1;
7092 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7093 * API request logging
7095 $wgAPIRequestLog = false;
7098 * Set the timeout for the API help text cache. If set to 0, caching disabled
7100 $wgAPICacheHelpTimeout = 60 * 60;
7103 * The ApiQueryQueryPages module should skip pages that are redundant to true
7104 * API queries.
7106 $wgAPIUselessQueryPages = array(
7107 'MIMEsearch', // aiprop=mime
7108 'LinkSearch', // list=exturlusage
7109 'FileDuplicateSearch', // prop=duplicatefiles
7113 * Enable AJAX framework
7115 $wgUseAjax = true;
7118 * List of Ajax-callable functions.
7119 * Extensions acting as Ajax callbacks must register here
7121 $wgAjaxExportList = array();
7124 * Enable watching/unwatching pages using AJAX.
7125 * Requires $wgUseAjax to be true too.
7127 $wgAjaxWatch = true;
7130 * Enable AJAX check for file overwrite, pre-upload
7132 $wgAjaxUploadDestCheck = true;
7135 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7137 $wgAjaxLicensePreview = true;
7140 * Have clients send edits to be prepared when filling in edit summaries.
7141 * This gives the server a head start on the expensive parsing operation.
7143 $wgAjaxEditStash = true;
7146 * Settings for incoming cross-site AJAX requests:
7147 * Newer browsers support cross-site AJAX when the target resource allows requests
7148 * from the origin domain by the Access-Control-Allow-Origin header.
7149 * This is currently only used by the API (requests to api.php)
7150 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7152 * - '*' matches any number of characters
7153 * - '?' matches any 1 character
7155 * @par Example:
7156 * @code
7157 * $wgCrossSiteAJAXdomains = array(
7158 * 'www.mediawiki.org',
7159 * '*.wikipedia.org',
7160 * '*.wikimedia.org',
7161 * '*.wiktionary.org',
7162 * );
7163 * @endcode
7165 $wgCrossSiteAJAXdomains = array();
7168 * Domains that should not be allowed to make AJAX requests,
7169 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7170 * Uses the same syntax as $wgCrossSiteAJAXdomains
7172 $wgCrossSiteAJAXdomainExceptions = array();
7174 /** @} */ # End AJAX and API }
7176 /************************************************************************//**
7177 * @name Shell and process control
7178 * @{
7182 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7184 $wgMaxShellMemory = 307200;
7187 * Maximum file size created by shell processes under linux, in KB
7188 * ImageMagick convert for example can be fairly hungry for scratch space
7190 $wgMaxShellFileSize = 102400;
7193 * Maximum CPU time in seconds for shell processes under Linux
7195 $wgMaxShellTime = 180;
7198 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7199 * would measure) in seconds for shell processes under Linux
7201 $wgMaxShellWallClockTime = 180;
7204 * Under Linux: a cgroup directory used to constrain memory usage of shell
7205 * commands. The directory must be writable by the user which runs MediaWiki.
7207 * If specified, this is used instead of ulimit, which is inaccurate, and
7208 * causes malloc() to return NULL, which exposes bugs in C applications, making
7209 * them segfault or deadlock.
7211 * A wrapper script will create a cgroup for each shell command that runs, as
7212 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7213 * kernel will send a SIGKILL signal to a process in the subgroup.
7215 * @par Example:
7216 * @code
7217 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7218 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7219 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7220 * @endcode
7222 * The reliability of cgroup cleanup can be improved by installing a
7223 * notify_on_release script in the root cgroup, see e.g.
7224 * https://gerrit.wikimedia.org/r/#/c/40784
7226 $wgShellCgroup = false;
7229 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7231 $wgPhpCli = '/usr/bin/php';
7234 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7235 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7236 * character set. Only the character set is relevant.
7238 $wgShellLocale = 'en_US.utf8';
7240 /** @} */ # End shell }
7242 /************************************************************************//**
7243 * @name HTTP client
7244 * @{
7248 * Timeout for HTTP requests done internally, in seconds.
7250 $wgHTTPTimeout = 25;
7253 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7255 $wgAsyncHTTPTimeout = 25;
7258 * Proxy to use for CURL requests.
7260 $wgHTTPProxy = false;
7263 * Local virtual hosts.
7265 * This lists domains that are configured as virtual hosts on the same machine.
7266 * If a request is to be made to a domain listed here, or any subdomain thereof,
7267 * then no proxy will be used.
7268 * Command-line scripts are not affected by this setting and will always use
7269 * proxy if it is configured.
7270 * @since 1.25
7272 $wgLocalVirtualHosts = array();
7275 * Timeout for connections done internally (in seconds)
7276 * Only works for curl
7278 $wgHTTPConnectTimeout = 5e0;
7280 /** @} */ # End HTTP client }
7282 /************************************************************************//**
7283 * @name Job queue
7284 * See also $wgEnotifUseJobQ.
7285 * @{
7289 * Number of jobs to perform per request. May be less than one in which case
7290 * jobs are performed probabalistically. If this is zero, jobs will not be done
7291 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7292 * be run periodically.
7294 $wgJobRunRate = 1;
7297 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7298 * to handle the job execution, instead of blocking the request until the job
7299 * execution finishes.
7300 * @since 1.23
7302 $wgRunJobsAsync = true;
7305 * Number of rows to update per job
7307 $wgUpdateRowsPerJob = 500;
7310 * Number of rows to update per query
7312 $wgUpdateRowsPerQuery = 100;
7314 /** @} */ # End job queue }
7316 /************************************************************************//**
7317 * @name Miscellaneous
7318 * @{
7322 * Name of the external diff engine to use
7324 $wgExternalDiffEngine = false;
7327 * Disable redirects to special pages and interwiki redirects, which use a 302
7328 * and have no "redirected from" link.
7330 * @note This is only for articles with #REDIRECT in them. URL's containing a
7331 * local interwiki prefix (or a non-canonical special page name) are still hard
7332 * redirected regardless of this setting.
7334 $wgDisableHardRedirects = false;
7337 * LinkHolderArray batch size
7338 * For debugging
7340 $wgLinkHolderBatchSize = 1000;
7343 * By default MediaWiki does not register links pointing to same server in
7344 * externallinks dataset, use this value to override:
7346 $wgRegisterInternalExternals = false;
7349 * Maximum number of pages to move at once when moving subpages with a page.
7351 $wgMaximumMovedPages = 100;
7354 * Fix double redirects after a page move.
7355 * Tends to conflict with page move vandalism, use only on a private wiki.
7357 $wgFixDoubleRedirects = false;
7360 * Allow redirection to another page when a user logs in.
7361 * To enable, set to a string like 'Main Page'
7363 $wgRedirectOnLogin = null;
7366 * Configuration for processing pool control, for use in high-traffic wikis.
7367 * An implementation is provided in the PoolCounter extension.
7369 * This configuration array maps pool types to an associative array. The only
7370 * defined key in the associative array is "class", which gives the class name.
7371 * The remaining elements are passed through to the class as constructor
7372 * parameters.
7374 * @par Example:
7375 * @code
7376 * $wgPoolCounterConf = array( 'ArticleView' => array(
7377 * 'class' => 'PoolCounter_Client',
7378 * 'timeout' => 15, // wait timeout in seconds
7379 * 'workers' => 5, // maximum number of active threads in each pool
7380 * 'maxqueue' => 50, // maximum number of total threads in each pool
7381 * ... any extension-specific options...
7382 * );
7383 * @endcode
7385 $wgPoolCounterConf = null;
7388 * To disable file delete/restore temporarily
7390 $wgUploadMaintenance = false;
7393 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7394 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7395 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7396 * (except for the special case of JS and CS pages).
7398 * @since 1.21
7400 $wgNamespaceContentModels = array();
7403 * How to react if a plain text version of a non-text Content object is requested using
7404 * ContentHandler::getContentText():
7406 * * 'ignore': return null
7407 * * 'fail': throw an MWException
7408 * * 'serialize': serialize to default format
7410 * @since 1.21
7412 $wgContentHandlerTextFallback = 'ignore';
7415 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7416 * This way, the ContentHandler facility can be used without any additional information in the
7417 * database. A page's content model is then derived solely from the page's title. This however
7418 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7419 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7420 * a title that would default to a different content model.
7422 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7423 * handling is less robust and less flexible.
7425 * @since 1.21
7427 $wgContentHandlerUseDB = true;
7430 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7431 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7432 * the effect on the database they would have on a wikitext page.
7434 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7435 * or at least parse only the contents of comments in the scripts.
7437 * @since 1.21
7439 $wgTextModelsToParse = array(
7440 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7441 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7442 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7446 * Whether the user must enter their password to change their e-mail address
7448 * @since 1.20
7450 $wgRequirePasswordforEmailChange = true;
7453 * Register handlers for specific types of sites.
7455 * @since 1.20
7457 $wgSiteTypes = array(
7458 'mediawiki' => 'MediaWikiSite',
7462 * Whether the page_props table has a pp_sortkey column. Set to false in case
7463 * the respective database schema change was not applied.
7464 * @since 1.23
7466 $wgPagePropsHaveSortkey = true;
7469 * Port where you have HTTPS running
7470 * Supports HTTPS on non-standard ports
7471 * @see bug 65184
7472 * @since 1.24
7474 $wgHttpsPort = 443;
7477 * Secret for hmac-based key derivation function (fast,
7478 * cryptographically secure random numbers).
7479 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7480 * be used.
7481 * See also: $wgHKDFAlgorithm
7482 * @since 1.24
7484 $wgHKDFSecret = false;
7487 * Algorithm for hmac-based key derivation function (fast,
7488 * cryptographically secure random numbers).
7489 * See also: $wgHKDFSecret
7490 * @since 1.24
7492 $wgHKDFAlgorithm = 'sha256';
7495 * Enable page language feature
7496 * Allows setting page language in database
7497 * @var bool
7498 * @since 1.24
7500 $wgPageLanguageUseDB = false;
7503 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7504 * Set this only if the fields are fully populated. This may be removed in 1.25.
7505 * @var bool
7506 * @since 1.24
7508 $wgUseLinkNamespaceDBFields = true;
7511 * Global configuration variable for Virtual REST Services.
7512 * Parameters for different services are to be declared inside
7513 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
7514 * array. Global parameters will be merged with service-specific ones. The
7515 * result will then be passed to VirtualRESTService::__construct() in the
7516 * module.
7518 * Example config for Parsoid:
7520 * $wgVirtualRestConfig['modules']['parsoid'] = array(
7521 * 'url' => 'http://localhost:8000',
7522 * 'prefix' => 'enwiki',
7523 * );
7525 * @var array
7526 * @since 1.25
7528 $wgVirtualRestConfig = array(
7529 'modules' => array(),
7530 'global' => array(
7531 # Timeout in seconds
7532 'timeout' => 360,
7533 'forwardCookies' => false,
7534 'HTTPProxy' => null
7539 * For really cool vim folding this needs to be at the end:
7540 * vim: foldmarker=@{,@} foldmethod=marker
7541 * @}