Localisation updates from https://translatewiki.net.
[mediawiki.git] / includes / DefaultSettings.php
blob89cc1fd4f7c30305773d2d403538c0a0844825c6
1 <?php
2 /**
3 * Default values for MediaWiki configuration settings.
6 * NEVER EDIT THIS FILE
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
38 * @file
41 /**
42 * @defgroup Globalsettings Global settings
45 /**
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
52 die( 1 );
55 /**
56 * wgConf hold the site configuration.
57 * Not used for much in a default install.
58 * @since 1.5
60 $wgConf = new SiteConfiguration;
62 /**
63 * Registry of factory functions to create config objects:
64 * The 'main' key must be set, and the value should be a valid
65 * callable.
66 * @since 1.23
68 $wgConfigRegistry = array(
69 'main' => 'GlobalVarConfig::newInstance'
72 /**
73 * MediaWiki version number
74 * @since 1.2
76 $wgVersion = '1.25alpha';
78 /**
79 * Name of the site. It must be changed in LocalSettings.php
81 $wgSitename = 'MediaWiki';
83 /**
84 * URL of the server.
86 * @par Example:
87 * @code
88 * $wgServer = 'http://example.com';
89 * @endcode
91 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
92 * wrong server, it will redirect incorrectly after you save a page. In that
93 * case, set this variable to fix it.
95 * If you want to use protocol-relative URLs on your wiki, set this to a
96 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
97 * to a fully qualified URL.
99 $wgServer = WebRequest::detectServer();
102 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
103 * Must be fully qualified, even if $wgServer is protocol-relative.
105 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
106 * @since 1.18
108 $wgCanonicalServer = false;
111 * Server name. This is automatically computed by parsing the bare
112 * hostname out of $wgCanonicalServer. It should not be customized.
113 * @since 1.24
115 $wgServerName = false;
117 /************************************************************************//**
118 * @name Script path settings
119 * @{
123 * The path we should point to.
124 * It might be a virtual path in case with use apache mod_rewrite for example.
126 * This *needs* to be set correctly.
128 * Other paths will be set to defaults based on it unless they are directly
129 * set in LocalSettings.php
131 $wgScriptPath = '/wiki';
134 * Whether to support URLs like index.php/Page_title These often break when PHP
135 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
136 * but then again it may not; lighttpd converts incoming path data to lowercase
137 * on systems with case-insensitive filesystems, and there have been reports of
138 * problems on Apache as well.
140 * To be safe we'll continue to keep it off by default.
142 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
143 * incorrect garbage, or to true if it is really correct.
145 * The default $wgArticlePath will be set based on this value at runtime, but if
146 * you have customized it, having this incorrectly set to true can cause
147 * redirect loops when "pretty URLs" are used.
148 * @since 1.2.1
150 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
151 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
152 ( strpos( PHP_SAPI, 'isapi' ) === false );
155 * The extension to append to script names by default. This can either be .php
156 * or .php5.
158 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
159 * variable is provided to support those providers.
160 * @since 1.11
162 $wgScriptExtension = '.php';
164 /**@}*/
166 /************************************************************************//**
167 * @name URLs and file paths
169 * These various web and file path variables are set to their defaults
170 * in Setup.php if they are not explicitly set from LocalSettings.php.
172 * These will relatively rarely need to be set manually, unless you are
173 * splitting style sheets or images outside the main document root.
175 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
176 * the host part, that starts with a slash. In most cases a full URL is also
177 * acceptable. A "directory" is a local file path.
179 * In both paths and directories, trailing slashes should not be included.
181 * @{
185 * The URL path to index.php.
187 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
189 $wgScript = false;
192 * The URL path to load.php.
194 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
195 * @since 1.17
197 $wgLoadScript = false;
200 * The URL path of the skins directory.
201 * Defaults to "{$wgScriptPath}/skins".
202 * @since 1.3
204 $wgStylePath = false;
205 $wgStyleSheetPath = &$wgStylePath;
208 * The URL path of the skins directory. Should not point to an external domain.
209 * Defaults to "{$wgScriptPath}/skins".
210 * @since 1.17
212 $wgLocalStylePath = false;
215 * The URL path of the extensions directory.
216 * Defaults to "{$wgScriptPath}/extensions".
217 * @since 1.16
219 $wgExtensionAssetsPath = false;
222 * Filesystem stylesheets directory.
223 * Defaults to "{$IP}/skins".
224 * @since 1.3
226 $wgStyleDirectory = false;
229 * The URL path for primary article page views. This path should contain $1,
230 * which is replaced by the article title.
232 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
233 * depending on $wgUsePathInfo.
235 $wgArticlePath = false;
238 * The URL path for the images directory.
239 * Defaults to "{$wgScriptPath}/images".
241 $wgUploadPath = false;
244 * The filesystem path of the images directory. Defaults to "{$IP}/images".
246 $wgUploadDirectory = false;
249 * Directory where the cached page will be saved.
250 * Defaults to "{$wgUploadDirectory}/cache".
252 $wgFileCacheDirectory = false;
255 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
256 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
258 $wgLogo = false;
261 * The URL path of the shortcut icon.
262 * @since 1.6
264 $wgFavicon = '/favicon.ico';
267 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
268 * Defaults to no icon.
269 * @since 1.12
271 $wgAppleTouchIcon = false;
274 * Value for the referrer policy meta tag.
275 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
276 * prevents the meta tag from being output.
277 * See http://www.w3.org/TR/referrer-policy/ for details.
279 * @since 1.25
281 $wgReferrerPolicy = false;
284 * The local filesystem path to a temporary directory. This is not required to
285 * be web accessible.
287 * When this setting is set to false, its value will be set through a call
288 * to wfTempDir(). See that methods implementation for the actual detection
289 * logic.
291 * Developers should use the global function wfTempDir() instead of this
292 * variable.
294 * @see wfTempDir()
295 * @note Default changed to false in MediaWiki 1.20.
297 $wgTmpDirectory = false;
300 * If set, this URL is added to the start of $wgUploadPath to form a complete
301 * upload URL.
302 * @since 1.4
304 $wgUploadBaseUrl = '';
307 * To enable remote on-demand scaling, set this to the thumbnail base URL.
308 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
309 * where 'e6' are the first two characters of the MD5 hash of the file name.
310 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
311 * @since 1.17
313 $wgUploadStashScalerBaseUrl = false;
316 * To set 'pretty' URL paths for actions other than
317 * plain page views, add to this array.
319 * @par Example:
320 * Set pretty URL for the edit action:
321 * @code
322 * 'edit' => "$wgScriptPath/edit/$1"
323 * @endcode
325 * There must be an appropriate script or rewrite rule in place to handle these
326 * URLs.
327 * @since 1.5
329 $wgActionPaths = array();
331 /**@}*/
333 /************************************************************************//**
334 * @name Files and file uploads
335 * @{
339 * Uploads have to be specially set up to be secure
341 $wgEnableUploads = false;
344 * The maximum age of temporary (incomplete) uploaded files
346 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
349 * Allows to move images and other media files
351 $wgAllowImageMoving = true;
354 * Enable deferred upload tasks that use the job queue.
355 * Only enable this if job runners are set up for both the
356 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
358 * @note If you use suhosin, this setting is incompatible with
359 * suhosin.session.encrypt.
361 $wgEnableAsyncUploads = false;
364 * These are additional characters that should be replaced with '-' in filenames
366 $wgIllegalFileChars = ":";
369 * What directory to place deleted uploads in.
370 * Defaults to "{$wgUploadDirectory}/deleted".
372 $wgDeletedDirectory = false;
375 * Set this to true if you use img_auth and want the user to see details on why access failed.
377 $wgImgAuthDetails = false;
380 * Map of relative URL directories to match to internal mwstore:// base storage paths.
381 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
382 * if starts with any of the prefixes defined here. The prefixes should not overlap.
383 * The prefix that matches has a corresponding storage path, which the rest of the URL
384 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
386 * Example:
387 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
388 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
389 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
391 * @see $wgFileBackends
393 $wgImgAuthUrlPathMap = array();
396 * File repository structures
398 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
399 * an array of such structures. Each repository structure is an associative
400 * array of properties configuring the repository.
402 * Properties required for all repos:
403 * - class The class name for the repository. May come from the core or an extension.
404 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
405 * FSRepo is also supported for backwards compatibility.
407 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
408 * The name should consist of alpha-numeric characters.
409 * - backend A file backend name (see $wgFileBackends).
411 * For most core repos:
412 * - zones Associative array of zone names that each map to an array with:
413 * container : backend container name the zone is in
414 * directory : root path within container for the zone
415 * url : base URL to the root of the zone
416 * urlsByExt : map of file extension types to base URLs
417 * (useful for using a different cache for videos)
418 * Zones default to using "<repo name>-<zone name>" as the container name
419 * and default to using the container root as the zone's root directory.
420 * Nesting of zone locations within other zones should be avoided.
421 * - url Public zone URL. The 'zones' settings take precedence.
422 * - hashLevels The number of directory levels for hash-based division of files
423 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
424 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
425 * handler instead.
426 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
427 * determines whether filenames implicitly start with a capital letter.
428 * The current implementation may give incorrect description page links
429 * when the local $wgCapitalLinks and initialCapital are mismatched.
430 * - pathDisclosureProtection
431 * May be 'paranoid' to remove all parameters from error messages, 'none' to
432 * leave the paths in unchanged, or 'simple' to replace paths with
433 * placeholders. Default for LocalRepo is 'simple'.
434 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
435 * is 0644.
436 * - directory The local filesystem directory where public files are stored. Not used for
437 * some remote repos.
438 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
439 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
440 * - isPrivate Set this if measures should always be taken to keep the files private.
441 * One should not trust this to assure that the files are not web readable;
442 * the server configuration should be done manually depending on the backend.
444 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
445 * for local repositories:
446 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
447 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
448 * http://en.wikipedia.org/w
449 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
450 * $wgScriptExtension, e.g. .php5 defaults to .php
452 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
453 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
454 * $wgFetchCommonsDescriptions.
455 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
456 * Short thumbnail names only have the width, parameters, and the extension.
458 * ForeignDBRepo:
459 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
460 * equivalent to the corresponding member of $wgDBservers
461 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
462 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
464 * ForeignAPIRepo:
465 * - apibase Use for the foreign API's URL
466 * - apiThumbCacheExpiry How long to locally cache thumbs for
468 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
469 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
470 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
471 * If you set $wgForeignFileRepos to an array of repository structures, those will
472 * be searched after the local file repo.
473 * Otherwise, you will only have access to local media files.
475 * @see Setup.php for an example usage and default initialization.
477 $wgLocalFileRepo = false;
480 * @see $wgLocalFileRepo
482 $wgForeignFileRepos = array();
485 * Use Commons as a remote file repository. Essentially a wrapper, when this
486 * is enabled $wgForeignFileRepos will point at Commons with a set of default
487 * settings
489 $wgUseInstantCommons = false;
492 * File backend structure configuration.
494 * This is an array of file backend configuration arrays.
495 * Each backend configuration has the following parameters:
496 * - 'name' : A unique name for the backend
497 * - 'class' : The file backend class to use
498 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
499 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
501 * See FileBackend::__construct() for more details.
502 * Additional parameters are specific to the file backend class used.
503 * These settings should be global to all wikis when possible.
505 * There are two particularly important aspects about each backend:
506 * - a) Whether it is fully qualified or wiki-relative.
507 * By default, the paths of files are relative to the current wiki,
508 * which works via prefixing them with the current wiki ID when accessed.
509 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
510 * all paths with the specified value instead. This can be useful if
511 * multiple wikis need to share the same data. Note that 'name' is *not*
512 * part of any prefix and thus should not be relied upon for namespacing.
513 * - b) Whether it is only defined for some wikis or is defined on all
514 * wikis in the wiki farm. Defining a backend globally is useful
515 * if multiple wikis need to share the same data.
516 * One should be aware of these aspects when configuring a backend for use with
517 * any basic feature or plugin. For example, suppose an extension stores data for
518 * different wikis in different directories and sometimes needs to access data from
519 * a foreign wiki's directory in order to render a page on given wiki. The extension
520 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
522 $wgFileBackends = array();
525 * Array of configuration arrays for each lock manager.
526 * Each backend configuration has the following parameters:
527 * - 'name' : A unique name for the lock manager
528 * - 'class' : The lock manger class to use
530 * See LockManager::__construct() for more details.
531 * Additional parameters are specific to the lock manager class used.
532 * These settings should be global to all wikis.
534 $wgLockManagers = array();
537 * Show Exif data, on by default if available.
538 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
540 * @note FOR WINDOWS USERS:
541 * To enable Exif functions, add the following lines to the "Windows
542 * extensions" section of php.ini:
543 * @code{.ini}
544 * extension=extensions/php_mbstring.dll
545 * extension=extensions/php_exif.dll
546 * @endcode
548 $wgShowEXIF = function_exists( 'exif_read_data' );
551 * If to automatically update the img_metadata field
552 * if the metadata field is outdated but compatible with the current version.
553 * Defaults to false.
555 $wgUpdateCompatibleMetadata = false;
558 * If you operate multiple wikis, you can define a shared upload path here.
559 * Uploads to this wiki will NOT be put there - they will be put into
560 * $wgUploadDirectory.
561 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
562 * no file of the given name is found in the local repository (for [[File:..]],
563 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
564 * directory.
566 * Note that these configuration settings can now be defined on a per-
567 * repository basis for an arbitrary number of file repositories, using the
568 * $wgForeignFileRepos variable.
570 $wgUseSharedUploads = false;
573 * Full path on the web server where shared uploads can be found
575 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
578 * Fetch commons image description pages and display them on the local wiki?
580 $wgFetchCommonsDescriptions = false;
583 * Path on the file system where shared uploads can be found.
585 $wgSharedUploadDirectory = "/var/www/wiki3/images";
588 * DB name with metadata about shared directory.
589 * Set this to false if the uploads do not come from a wiki.
591 $wgSharedUploadDBname = false;
594 * Optional table prefix used in database.
596 $wgSharedUploadDBprefix = '';
599 * Cache shared metadata in memcached.
600 * Don't do this if the commons wiki is in a different memcached domain
602 $wgCacheSharedUploads = true;
605 * Allow for upload to be copied from an URL.
606 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
607 * You have to assign the user right 'upload_by_url' to a user group, to use this.
609 $wgAllowCopyUploads = false;
612 * Allow asynchronous copy uploads.
613 * This feature is experimental and broken as of r81612.
615 $wgAllowAsyncCopyUploads = false;
618 * A list of domains copy uploads can come from
620 * @since 1.20
622 $wgCopyUploadsDomains = array();
625 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
626 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
627 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
629 $wgCopyUploadsFromSpecialUpload = false;
632 * Proxy to use for copy upload requests.
633 * @since 1.20
635 $wgCopyUploadProxy = false;
638 * Different timeout for upload by url
639 * This could be useful since when fetching large files, you may want a
640 * timeout longer than the default $wgHTTPTimeout. False means fallback
641 * to default.
643 * @since 1.22
645 $wgCopyUploadTimeout = false;
648 * Different timeout for upload by url when run as a background job
649 * This could be useful since when fetching large files via job queue,
650 * you may want a different timeout, especially because there is no
651 * http request being kept alive.
653 * false means fallback to $wgCopyUploadTimeout.
654 * @since 1.22
656 $wgCopyUploadAsyncTimeout = false;
659 * Max size for uploads, in bytes. If not set to an array, applies to all
660 * uploads. If set to an array, per upload type maximums can be set, using the
661 * file and url keys. If the * key is set this value will be used as maximum
662 * for non-specified types.
664 * @par Example:
665 * @code
666 * $wgMaxUploadSize = array(
667 * '*' => 250 * 1024,
668 * 'url' => 500 * 1024,
669 * );
670 * @endcode
671 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
672 * will have a maximum of 500 kB.
674 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
677 * Point the upload navigation link to an external URL
678 * Useful if you want to use a shared repository by default
679 * without disabling local uploads (use $wgEnableUploads = false for that).
681 * @par Example:
682 * @code
683 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
684 * @endcode
686 $wgUploadNavigationUrl = false;
689 * Point the upload link for missing files to an external URL, as with
690 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
691 * appended to it as appropriate.
693 $wgUploadMissingFileUrl = false;
696 * Give a path here to use thumb.php for thumbnail generation on client
697 * request, instead of generating them on render and outputting a static URL.
698 * This is necessary if some of your apache servers don't have read/write
699 * access to the thumbnail path.
701 * @par Example:
702 * @code
703 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
704 * @endcode
706 $wgThumbnailScriptPath = false;
709 * @see $wgThumbnailScriptPath
711 $wgSharedThumbnailScriptPath = false;
714 * Set this to false if you do not want MediaWiki to divide your images
715 * directory into many subdirectories, for improved performance.
717 * It's almost always good to leave this enabled. In previous versions of
718 * MediaWiki, some users set this to false to allow images to be added to the
719 * wiki by simply copying them into $wgUploadDirectory and then running
720 * maintenance/rebuildImages.php to register them in the database. This is no
721 * longer recommended, use maintenance/importImages.php instead.
723 * @note That this variable may be ignored if $wgLocalFileRepo is set.
724 * @todo Deprecate the setting and ultimately remove it from Core.
726 $wgHashedUploadDirectory = true;
729 * Set the following to false especially if you have a set of files that need to
730 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
731 * directory layout.
733 $wgHashedSharedUploadDirectory = true;
736 * Base URL for a repository wiki. Leave this blank if uploads are just stored
737 * in a shared directory and not meant to be accessible through a separate wiki.
738 * Otherwise the image description pages on the local wiki will link to the
739 * image description page on this wiki.
741 * Please specify the namespace, as in the example below.
743 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
746 * This is the list of preferred extensions for uploading files. Uploading files
747 * with extensions not in this list will trigger a warning.
749 * @warning If you add any OpenOffice or Microsoft Office file formats here,
750 * such as odt or doc, and untrusted users are allowed to upload files, then
751 * your wiki will be vulnerable to cross-site request forgery (CSRF).
753 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
756 * Files with these extensions will never be allowed as uploads.
757 * An array of file extensions to blacklist. You should append to this array
758 * if you want to blacklist additional files.
760 $wgFileBlacklist = array(
761 # HTML may contain cookie-stealing JavaScript and web bugs
762 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
763 # PHP scripts may execute arbitrary code on the server
764 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
765 # Other types that may be interpreted by some servers
766 'shtml', 'jhtml', 'pl', 'py', 'cgi',
767 # May contain harmful executables for Windows victims
768 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
771 * Files with these MIME types will never be allowed as uploads
772 * if $wgVerifyMimeType is enabled.
774 $wgMimeTypeBlacklist = array(
775 # HTML may contain cookie-stealing JavaScript and web bugs
776 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
777 # PHP scripts may execute arbitrary code on the server
778 'application/x-php', 'text/x-php',
779 # Other types that may be interpreted by some servers
780 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
781 # Client-side hazards on Internet Explorer
782 'text/scriptlet', 'application/x-msdownload',
783 # Windows metafile, client-side vulnerability on some systems
784 'application/x-msmetafile',
788 * Allow Java archive uploads.
789 * This is not recommended for public wikis since a maliciously-constructed
790 * applet running on the same domain as the wiki can steal the user's cookies.
792 $wgAllowJavaUploads = false;
795 * This is a flag to determine whether or not to check file extensions on upload.
797 * @warning Setting this to false is insecure for public wikis.
799 $wgCheckFileExtensions = true;
802 * If this is turned off, users may override the warning for files not covered
803 * by $wgFileExtensions.
805 * @warning Setting this to false is insecure for public wikis.
807 $wgStrictFileExtensions = true;
810 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
812 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
813 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
815 $wgDisableUploadScriptChecks = false;
818 * Warn if uploaded files are larger than this (in bytes), or false to disable
820 $wgUploadSizeWarning = false;
823 * list of trusted media-types and MIME types.
824 * Use the MEDIATYPE_xxx constants to represent media types.
825 * This list is used by File::isSafeFile
827 * Types not listed here will have a warning about unsafe content
828 * displayed on the images description page. It would also be possible
829 * to use this for further restrictions, like disabling direct
830 * [[media:...]] links for non-trusted formats.
832 $wgTrustedMediaFormats = array(
833 MEDIATYPE_BITMAP, //all bitmap formats
834 MEDIATYPE_AUDIO, //all audio formats
835 MEDIATYPE_VIDEO, //all plain video formats
836 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
837 "application/pdf", //PDF files
838 #"application/x-shockwave-flash", //flash/shockwave movie
842 * Plugins for media file type handling.
843 * Each entry in the array maps a MIME type to a class name
845 $wgMediaHandlers = array(
846 'image/jpeg' => 'JpegHandler',
847 'image/png' => 'PNGHandler',
848 'image/gif' => 'GIFHandler',
849 'image/tiff' => 'TiffHandler',
850 'image/x-ms-bmp' => 'BmpHandler',
851 'image/x-bmp' => 'BmpHandler',
852 'image/x-xcf' => 'XCFHandler',
853 'image/svg+xml' => 'SvgHandler', // official
854 'image/svg' => 'SvgHandler', // compat
855 'image/vnd.djvu' => 'DjVuHandler', // official
856 'image/x.djvu' => 'DjVuHandler', // compat
857 'image/x-djvu' => 'DjVuHandler', // compat
861 * Plugins for page content model handling.
862 * Each entry in the array maps a model id to a class name.
864 * @since 1.21
866 $wgContentHandlers = array(
867 // the usual case
868 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
869 // dumb version, no syntax highlighting
870 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
871 // simple implementation, for use by extensions, etc.
872 CONTENT_MODEL_JSON => 'JsonContentHandler',
873 // dumb version, no syntax highlighting
874 CONTENT_MODEL_CSS => 'CssContentHandler',
875 // plain text, for use by extensions, etc.
876 CONTENT_MODEL_TEXT => 'TextContentHandler',
880 * Whether to enable server-side image thumbnailing. If false, images will
881 * always be sent to the client in full resolution, with appropriate width= and
882 * height= attributes on the <img> tag for the client to do its own scaling.
884 $wgUseImageResize = true;
887 * Resizing can be done using PHP's internal image libraries or using
888 * ImageMagick or another third-party converter, e.g. GraphicMagick.
889 * These support more file formats than PHP, which only supports PNG,
890 * GIF, JPG, XBM and WBMP.
892 * Use Image Magick instead of PHP builtin functions.
894 $wgUseImageMagick = false;
897 * The convert command shipped with ImageMagick
899 $wgImageMagickConvertCommand = '/usr/bin/convert';
902 * Sharpening parameter to ImageMagick
904 $wgSharpenParameter = '0x0.4';
907 * Reduction in linear dimensions below which sharpening will be enabled
909 $wgSharpenReductionThreshold = 0.85;
912 * Temporary directory used for ImageMagick. The directory must exist. Leave
913 * this set to false to let ImageMagick decide for itself.
915 $wgImageMagickTempDir = false;
918 * Use another resizing converter, e.g. GraphicMagick
919 * %s will be replaced with the source path, %d with the destination
920 * %w and %h will be replaced with the width and height.
922 * @par Example for GraphicMagick:
923 * @code
924 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
925 * @endcode
927 * Leave as false to skip this.
929 $wgCustomConvertCommand = false;
932 * used for lossless jpeg rotation
934 * @since 1.21
936 $wgJpegTran = '/usr/bin/jpegtran';
939 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
940 * image formats.
942 $wgExiv2Command = '/usr/bin/exiv2';
945 * Scalable Vector Graphics (SVG) may be uploaded as images.
946 * Since SVG support is not yet standard in browsers, it is
947 * necessary to rasterize SVGs to PNG as a fallback format.
949 * An external program is required to perform this conversion.
950 * If set to an array, the first item is a PHP callable and any further items
951 * are passed as parameters after $srcPath, $dstPath, $width, $height
953 $wgSVGConverters = array(
954 'ImageMagick' =>
955 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
956 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
957 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
958 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
959 . '$output $input',
960 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
961 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
962 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
966 * Pick a converter defined in $wgSVGConverters
968 $wgSVGConverter = 'ImageMagick';
971 * If not in the executable PATH, specify the SVG converter path.
973 $wgSVGConverterPath = '';
976 * Don't scale a SVG larger than this
978 $wgSVGMaxSize = 2048;
981 * Don't read SVG metadata beyond this point.
982 * Default is 1024*256 bytes
984 $wgSVGMetadataCutoff = 262144;
987 * Disallow <title> element in SVG files.
989 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
990 * browsers which can not perform basic stuff like MIME detection and which are
991 * vulnerable to further idiots uploading crap files as images.
993 * When this directive is on, "<title>" will be allowed in files with an
994 * "image/svg+xml" MIME type. You should leave this disabled if your web server
995 * is misconfigured and doesn't send appropriate MIME types for SVG images.
997 $wgAllowTitlesInSVG = false;
1000 * The maximum number of pixels a source image can have if it is to be scaled
1001 * down by a scaler that requires the full source image to be decompressed
1002 * and stored in decompressed form, before the thumbnail is generated.
1004 * This provides a limit on memory usage for the decompression side of the
1005 * image scaler. The limit is used when scaling PNGs with any of the
1006 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1007 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1009 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1010 * 12.5 million pixels or 3500x3500.
1012 $wgMaxImageArea = 1.25e7;
1015 * Force thumbnailing of animated GIFs above this size to a single
1016 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1017 * is checked against the total size of all frames in the animation.
1018 * It probably makes sense to keep this equal to $wgMaxImageArea.
1020 $wgMaxAnimatedGifArea = 1.25e7;
1023 * Browsers don't support TIFF inline generally...
1024 * For inline display, we need to convert to PNG or JPEG.
1025 * Note scaling should work with ImageMagick, but may not with GD scaling.
1027 * @par Example:
1028 * @code
1029 * // PNG is lossless, but inefficient for photos
1030 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1031 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1032 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1033 * @endcode
1035 $wgTiffThumbnailType = false;
1038 * If rendered thumbnail files are older than this timestamp, they
1039 * will be rerendered on demand as if the file didn't already exist.
1040 * Update if there is some need to force thumbs and SVG rasterizations
1041 * to rerender, such as fixes to rendering bugs.
1043 $wgThumbnailEpoch = '20030516000000';
1046 * Certain operations are avoided if there were too many recent failures,
1047 * for example, thumbnail generation. Bump this value to invalidate all
1048 * memory of failed operations and thus allow further attempts to resume.
1049 * This is useful when a cause for the failures has been found and fixed.
1051 $wgAttemptFailureEpoch = 1;
1054 * If set, inline scaled images will still produce "<img>" tags ready for
1055 * output instead of showing an error message.
1057 * This may be useful if errors are transitory, especially if the site
1058 * is configured to automatically render thumbnails on request.
1060 * On the other hand, it may obscure error conditions from debugging.
1061 * Enable the debug log or the 'thumbnail' log group to make sure errors
1062 * are logged to a file for review.
1064 $wgIgnoreImageErrors = false;
1067 * Allow thumbnail rendering on page view. If this is false, a valid
1068 * thumbnail URL is still output, but no file will be created at
1069 * the target location. This may save some time if you have a
1070 * thumb.php or 404 handler set up which is faster than the regular
1071 * webserver(s).
1073 $wgGenerateThumbnailOnParse = true;
1076 * Show thumbnails for old images on the image description page
1078 $wgShowArchiveThumbnails = true;
1081 * If set to true, images that contain certain the exif orientation tag will
1082 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1083 * is available that can rotate.
1085 $wgEnableAutoRotation = null;
1088 * Internal name of virus scanner. This serves as a key to the
1089 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1090 * null, every file uploaded will be scanned for viruses.
1092 $wgAntivirus = null;
1095 * Configuration for different virus scanners. This an associative array of
1096 * associative arrays. It contains one setup array per known scanner type.
1097 * The entry is selected by $wgAntivirus, i.e.
1098 * valid values for $wgAntivirus are the keys defined in this array.
1100 * The configuration array for each scanner contains the following keys:
1101 * "command", "codemap", "messagepattern":
1103 * "command" is the full command to call the virus scanner - %f will be
1104 * replaced with the name of the file to scan. If not present, the filename
1105 * will be appended to the command. Note that this must be overwritten if the
1106 * scanner is not in the system path; in that case, please set
1107 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1108 * path.
1110 * "codemap" is a mapping of exit code to return codes of the detectVirus
1111 * function in SpecialUpload.
1112 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1113 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1114 * is not set.
1115 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1116 * the file to have an unsupported format, which is probably immune to
1117 * viruses. This causes the file to pass.
1118 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1119 * no virus was found.
1120 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1121 * a virus.
1122 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1124 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1125 * output. The relevant part should be matched as group one (\1).
1126 * If not defined or the pattern does not match, the full message is shown to the user.
1128 $wgAntivirusSetup = array(
1130 #setup for clamav
1131 'clamav' => array(
1132 'command' => 'clamscan --no-summary ',
1133 'codemap' => array(
1134 "0" => AV_NO_VIRUS, # no virus
1135 "1" => AV_VIRUS_FOUND, # virus found
1136 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1137 "*" => AV_SCAN_FAILED, # else scan failed
1139 'messagepattern' => '/.*?:(.*)/sim',
1144 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1146 $wgAntivirusRequired = true;
1149 * Determines if the MIME type of uploaded files should be checked
1151 $wgVerifyMimeType = true;
1154 * Sets the MIME type definition file to use by MimeMagic.php.
1155 * Set to null, to use built-in defaults only.
1156 * example: $wgMimeTypeFile = '/etc/mime.types';
1158 $wgMimeTypeFile = 'includes/mime.types';
1161 * Sets the MIME type info file to use by MimeMagic.php.
1162 * Set to null, to use built-in defaults only.
1164 $wgMimeInfoFile = 'includes/mime.info';
1167 * Sets an external MIME detector program. The command must print only
1168 * the MIME type to standard output.
1169 * The name of the file to process will be appended to the command given here.
1170 * If not set or NULL, PHP's fileinfo extension will be used if available.
1172 * @par Example:
1173 * @code
1174 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1175 * @endcode
1177 $wgMimeDetectorCommand = null;
1180 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1181 * things, because only a few types of images are needed and file extensions
1182 * can be trusted.
1184 $wgTrivialMimeDetection = false;
1187 * Additional XML types we can allow via MIME-detection.
1188 * array = ( 'rootElement' => 'associatedMimeType' )
1190 $wgXMLMimeTypes = array(
1191 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1192 'svg' => 'image/svg+xml',
1193 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1194 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1195 'html' => 'text/html', // application/xhtml+xml?
1199 * Limit images on image description pages to a user-selectable limit. In order
1200 * to reduce disk usage, limits can only be selected from a list.
1201 * The user preference is saved as an array offset in the database, by default
1202 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1203 * change it if you alter the array (see bug 8858).
1204 * This is the list of settings the user can choose from:
1206 $wgImageLimits = array(
1207 array( 320, 240 ),
1208 array( 640, 480 ),
1209 array( 800, 600 ),
1210 array( 1024, 768 ),
1211 array( 1280, 1024 )
1215 * Adjust thumbnails on image pages according to a user setting. In order to
1216 * reduce disk usage, the values can only be selected from a list. This is the
1217 * list of settings the user can choose from:
1219 $wgThumbLimits = array(
1220 120,
1221 150,
1222 180,
1223 200,
1224 250,
1229 * When defined, is an array of image widths used as buckets for thumbnail generation.
1230 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1231 * always using the original. This will incur a speed gain but cause a quality loss.
1233 * The buckets generation is chained, with each bucket generated based on the above bucket
1234 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1235 * supports it.
1237 $wgThumbnailBuckets = null;
1240 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1241 * above the requested size. The distance represents how many extra pixels of width the bucket
1242 * needs in order to be used as the reference for a given thumbnail. For example, with the
1243 * following buckets:
1245 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1247 * and a distance of 50:
1249 * $wgThumbnailMinimumBucketDistance = 50;
1251 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1252 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1254 $wgThumbnailMinimumBucketDistance = 50;
1257 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1258 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1259 * has a performance impact for the first client to view a certain size.
1261 * This obviously means that more disk space is needed per upload upfront.
1263 * @since 1.25
1266 $wgUploadThumbnailRenderMap = array();
1269 * The method through which the thumbnails will be prerendered for the entries in
1270 * $wgUploadThumbnailRenderMap
1272 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1273 * thumbnail's URL.
1274 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1275 * option uses the job queue to render the thumbnail.
1277 * @since 1.25
1279 $wgUploadThumbnailRenderMethod = 'jobqueue';
1282 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1284 * @since 1.25
1286 $wgUploadThumbnailRenderHttpCustomHost = false;
1289 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1290 * HTTP request to.
1292 * @since 1.25
1294 $wgUploadThumbnailRenderHttpCustomDomain = false;
1297 * Default parameters for the "<gallery>" tag
1299 $wgGalleryOptions = array(
1300 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1301 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1302 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1303 'captionLength' => 25, // Length of caption to truncate (in characters)
1304 'showBytes' => true, // Show the filesize in bytes in categories
1305 'mode' => 'traditional',
1309 * Adjust width of upright images when parameter 'upright' is used
1310 * This allows a nicer look for upright images without the need to fix the width
1311 * by hardcoded px in wiki sourcecode.
1313 $wgThumbUpright = 0.75;
1316 * Default value for chmoding of new directories.
1318 $wgDirectoryMode = 0777;
1321 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1323 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1324 * thumbnails, output via the srcset attribute.
1326 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1327 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1328 * The polyfill can be found in the jquery.hidpi module.
1330 $wgResponsiveImages = true;
1333 * @name DJVU settings
1334 * @{
1338 * Path of the djvudump executable
1339 * Enable this and $wgDjvuRenderer to enable djvu rendering
1340 * example: $wgDjvuDump = 'djvudump';
1342 $wgDjvuDump = null;
1345 * Path of the ddjvu DJVU renderer
1346 * Enable this and $wgDjvuDump to enable djvu rendering
1347 * example: $wgDjvuRenderer = 'ddjvu';
1349 $wgDjvuRenderer = null;
1352 * Path of the djvutxt DJVU text extraction utility
1353 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1354 * example: $wgDjvuTxt = 'djvutxt';
1356 $wgDjvuTxt = null;
1359 * Path of the djvutoxml executable
1360 * This works like djvudump except much, much slower as of version 3.5.
1362 * For now we recommend you use djvudump instead. The djvuxml output is
1363 * probably more stable, so we'll switch back to it as soon as they fix
1364 * the efficiency problem.
1365 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1367 * @par Example:
1368 * @code
1369 * $wgDjvuToXML = 'djvutoxml';
1370 * @endcode
1372 $wgDjvuToXML = null;
1375 * Shell command for the DJVU post processor
1376 * Default: pnmtojpeg, since ddjvu generates ppm output
1377 * Set this to false to output the ppm file directly.
1379 $wgDjvuPostProcessor = 'pnmtojpeg';
1382 * File extension for the DJVU post processor output
1384 $wgDjvuOutputExtension = 'jpg';
1386 /** @} */ # end of DJvu }
1388 /** @} */ # end of file uploads }
1390 /************************************************************************//**
1391 * @name Email settings
1392 * @{
1397 * Site admin email address.
1399 * Defaults to "wikiadmin@$wgServerName".
1401 $wgEmergencyContact = false;
1404 * Password reminder email address.
1406 * The address we should use as sender when a user is requesting his password.
1408 * Defaults to "apache@$wgServerName".
1410 $wgPasswordSender = false;
1413 * Password reminder name
1415 * @deprecated since 1.23; use the system message 'emailsender' instead.
1417 $wgPasswordSenderName = 'MediaWiki Mail';
1420 * Dummy address which should be accepted during mail send action.
1421 * It might be necessary to adapt the address or to set it equal
1422 * to the $wgEmergencyContact address.
1424 $wgNoReplyAddress = 'reply@not.possible';
1427 * Set to true to enable the e-mail basic features:
1428 * Password reminders, etc. If sending e-mail on your
1429 * server doesn't work, you might want to disable this.
1431 $wgEnableEmail = true;
1434 * Set to true to enable user-to-user e-mail.
1435 * This can potentially be abused, as it's hard to track.
1437 $wgEnableUserEmail = true;
1440 * Set to true to put the sending user's email in a Reply-To header
1441 * instead of From. ($wgEmergencyContact will be used as From.)
1443 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1444 * which can cause problems with SPF validation and leak recipient addresses
1445 * when bounces are sent to the sender.
1447 $wgUserEmailUseReplyTo = false;
1450 * Minimum time, in hours, which must elapse between password reminder
1451 * emails for a given account. This is to prevent abuse by mail flooding.
1453 $wgPasswordReminderResendTime = 24;
1456 * The time, in seconds, when an emailed temporary password expires.
1458 $wgNewPasswordExpiry = 3600 * 24 * 7;
1461 * The time, in seconds, when an email confirmation email expires
1463 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1466 * The number of days that a user's password is good for. After this number of days, the
1467 * user will be asked to reset their password. Set to false to disable password expiration.
1469 $wgPasswordExpirationDays = false;
1472 * If a user's password is expired, the number of seconds when they can still login,
1473 * and cancel their password change, but are sent to the password change form on each login.
1475 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1478 * SMTP Mode.
1480 * For using a direct (authenticated) SMTP server connection.
1481 * Default to false or fill an array :
1483 * @code
1484 * $wgSMTP = array(
1485 * 'host' => 'SMTP domain',
1486 * 'IDHost' => 'domain for MessageID',
1487 * 'port' => '25',
1488 * 'auth' => [true|false],
1489 * 'username' => [SMTP username],
1490 * 'password' => [SMTP password],
1491 * );
1492 * @endcode
1494 $wgSMTP = false;
1497 * Additional email parameters, will be passed as the last argument to mail() call.
1498 * If using safe_mode this has no effect
1500 $wgAdditionalMailParams = null;
1503 * For parts of the system that have been updated to provide HTML email content, send
1504 * both text and HTML parts as the body of the email
1506 $wgAllowHTMLEmail = false;
1509 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1510 * from $wgEmergencyContact
1512 $wgEnotifFromEditor = false;
1514 // TODO move UPO to preferences probably ?
1515 # If set to true, users get a corresponding option in their preferences and can choose to
1516 # enable or disable at their discretion
1517 # If set to false, the corresponding input form on the user preference page is suppressed
1518 # It call this to be a "user-preferences-option (UPO)"
1521 * Require email authentication before sending mail to an email address.
1522 * This is highly recommended. It prevents MediaWiki from being used as an open
1523 * spam relay.
1525 $wgEmailAuthentication = true;
1528 * Allow users to enable email notification ("enotif") on watchlist changes.
1530 $wgEnotifWatchlist = false;
1533 * Allow users to enable email notification ("enotif") when someone edits their
1534 * user talk page.
1536 $wgEnotifUserTalk = false;
1539 * Set the Reply-to address in notifications to the editor's address, if user
1540 * allowed this in the preferences.
1542 $wgEnotifRevealEditorAddress = false;
1545 * Send notification mails on minor edits to watchlist pages. This is enabled
1546 * by default. Does not affect user talk notifications.
1548 $wgEnotifMinorEdits = true;
1551 * Send a generic mail instead of a personalised mail for each user. This
1552 * always uses UTC as the time zone, and doesn't include the username.
1554 * For pages with many users watching, this can significantly reduce mail load.
1555 * Has no effect when using sendmail rather than SMTP.
1557 $wgEnotifImpersonal = false;
1560 * Maximum number of users to mail at once when using impersonal mail. Should
1561 * match the limit on your mail server.
1563 $wgEnotifMaxRecips = 500;
1566 * Send mails via the job queue. This can be useful to reduce the time it
1567 * takes to save a page that a lot of people are watching.
1569 $wgEnotifUseJobQ = false;
1572 * Use real name instead of username in e-mail "from" field.
1574 $wgEnotifUseRealName = false;
1577 * Array of usernames who will be sent a notification email for every change
1578 * which occurs on a wiki. Users will not be notified of their own changes.
1580 $wgUsersNotifiedOnAllChanges = array();
1582 /** @} */ # end of email settings
1584 /************************************************************************//**
1585 * @name Database settings
1586 * @{
1590 * Database host name or IP address
1592 $wgDBserver = 'localhost';
1595 * Database port number (for PostgreSQL and Microsoft SQL Server).
1597 $wgDBport = 5432;
1600 * Name of the database
1602 $wgDBname = 'my_wiki';
1605 * Database username
1607 $wgDBuser = 'wikiuser';
1610 * Database user's password
1612 $wgDBpassword = '';
1615 * Database type
1617 $wgDBtype = 'mysql';
1620 * Whether to use SSL in DB connection.
1622 * This setting is only used $wgLBFactoryConf['class'] is set to
1623 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1624 * the DBO_SSL flag must be set in the 'flags' option of the database
1625 * connection to achieve the same functionality.
1627 $wgDBssl = false;
1630 * Whether to use compression in DB connection.
1632 * This setting is only used $wgLBFactoryConf['class'] is set to
1633 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1634 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1635 * connection to achieve the same functionality.
1637 $wgDBcompress = false;
1640 * Separate username for maintenance tasks. Leave as null to use the default.
1642 $wgDBadminuser = null;
1645 * Separate password for maintenance tasks. Leave as null to use the default.
1647 $wgDBadminpassword = null;
1650 * Search type.
1651 * Leave as null to select the default search engine for the
1652 * selected database type (eg SearchMySQL), or set to a class
1653 * name to override to a custom search engine.
1655 $wgSearchType = null;
1658 * Alternative search types
1659 * Sometimes you want to support multiple search engines for testing. This
1660 * allows users to select their search engine of choice via url parameters
1661 * to Special:Search and the action=search API. If using this, there's no
1662 * need to add $wgSearchType to it, that is handled automatically.
1664 $wgSearchTypeAlternatives = null;
1667 * Table name prefix
1669 $wgDBprefix = '';
1672 * MySQL table options to use during installation or update
1674 $wgDBTableOptions = 'ENGINE=InnoDB';
1677 * SQL Mode - default is turning off all modes, including strict, if set.
1678 * null can be used to skip the setting for performance reasons and assume
1679 * DBA has done his best job.
1680 * String override can be used for some additional fun :-)
1682 $wgSQLMode = '';
1685 * Mediawiki schema
1687 $wgDBmwschema = null;
1690 * To override default SQLite data directory ($docroot/../data)
1692 $wgSQLiteDataDir = '';
1695 * Make all database connections secretly go to localhost. Fool the load balancer
1696 * thinking there is an arbitrarily large cluster of servers to connect to.
1697 * Useful for debugging.
1699 $wgAllDBsAreLocalhost = false;
1702 * Shared database for multiple wikis. Commonly used for storing a user table
1703 * for single sign-on. The server for this database must be the same as for the
1704 * main database.
1706 * For backwards compatibility the shared prefix is set to the same as the local
1707 * prefix, and the user table is listed in the default list of shared tables.
1708 * The user_properties table is also added so that users will continue to have their
1709 * preferences shared (preferences were stored in the user table prior to 1.16)
1711 * $wgSharedTables may be customized with a list of tables to share in the shared
1712 * database. However it is advised to limit what tables you do share as many of
1713 * MediaWiki's tables may have side effects if you try to share them.
1715 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1716 * $wgDBprefix.
1718 * $wgSharedSchema is the table schema for the shared database. It defaults to
1719 * $wgDBmwschema.
1721 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1722 * access remote databases. Using wfGetLB() allows the shared database to
1723 * reside on separate servers to the wiki's own database, with suitable
1724 * configuration of $wgLBFactoryConf.
1726 $wgSharedDB = null;
1729 * @see $wgSharedDB
1731 $wgSharedPrefix = false;
1734 * @see $wgSharedDB
1736 $wgSharedTables = array( 'user', 'user_properties' );
1739 * @see $wgSharedDB
1740 * @since 1.23
1742 $wgSharedSchema = false;
1745 * Database load balancer
1746 * This is a two-dimensional array, an array of server info structures
1747 * Fields are:
1748 * - host: Host name
1749 * - dbname: Default database name
1750 * - user: DB user
1751 * - password: DB password
1752 * - type: DB type
1754 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1755 * If this is zero for any given server, no normal query traffic will be
1756 * sent to it. It will be excluded from lag checks in maintenance scripts.
1757 * The only way it can receive traffic is if groupLoads is used.
1759 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1760 * to several groups, the most specific group defined here is used.
1762 * - flags: bit field
1763 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1764 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1765 * - DBO_TRX -- wrap entire request in a transaction
1766 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1767 * - DBO_PERSISTENT -- enables persistent database connections
1768 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1769 * - DBO_COMPRESS -- uses internal compression in database connections,
1770 * if available
1772 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1774 * These and any other user-defined properties will be assigned to the mLBInfo member
1775 * variable of the Database object.
1777 * Leave at false to use the single-server variables above. If you set this
1778 * variable, the single-server variables will generally be ignored (except
1779 * perhaps in some command-line scripts).
1781 * The first server listed in this array (with key 0) will be the master. The
1782 * rest of the servers will be slaves. To prevent writes to your slaves due to
1783 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1784 * slaves in my.cnf. You can set read_only mode at runtime using:
1786 * @code
1787 * SET @@read_only=1;
1788 * @endcode
1790 * Since the effect of writing to a slave is so damaging and difficult to clean
1791 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1792 * our masters, and then set read_only=0 on masters at runtime.
1794 $wgDBservers = false;
1797 * Load balancer factory configuration
1798 * To set up a multi-master wiki farm, set the class here to something that
1799 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1800 * The class identified here is responsible for reading $wgDBservers,
1801 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1803 * The LBFactoryMulti class is provided for this purpose, please see
1804 * includes/db/LBFactoryMulti.php for configuration information.
1806 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1809 * How long to wait for a slave to catch up to the master
1810 * @deprecated since 1.24
1812 $wgMasterWaitTimeout = 10;
1815 * File to log database errors to
1817 $wgDBerrorLog = false;
1820 * Timezone to use in the error log.
1821 * Defaults to the wiki timezone ($wgLocaltimezone).
1823 * A list of usable timezones can found at:
1824 * http://php.net/manual/en/timezones.php
1826 * @par Examples:
1827 * @code
1828 * $wgLocaltimezone = 'UTC';
1829 * $wgLocaltimezone = 'GMT';
1830 * $wgLocaltimezone = 'PST8PDT';
1831 * $wgLocaltimezone = 'Europe/Sweden';
1832 * $wgLocaltimezone = 'CET';
1833 * @endcode
1835 * @since 1.20
1837 $wgDBerrorLogTZ = false;
1840 * Scale load balancer polling time so that under overload conditions, the
1841 * database server receives a SHOW STATUS query at an average interval of this
1842 * many microseconds
1844 $wgDBAvgStatusPoll = 2000;
1847 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1848 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1850 * @warning THIS IS EXPERIMENTAL!
1852 * May break if you're not using the table defs from mysql5/tables.sql.
1853 * May break if you're upgrading an existing wiki if set differently.
1854 * Broken symptoms likely to include incorrect behavior with page titles,
1855 * usernames, comments etc containing non-ASCII characters.
1856 * Might also cause failures on the object cache and other things.
1858 * Even correct usage may cause failures with Unicode supplementary
1859 * characters (those not in the Basic Multilingual Plane) unless MySQL
1860 * has enhanced their Unicode support.
1862 $wgDBmysql5 = false;
1865 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1867 * To use this feature set to true and use a datasource defined as
1868 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1869 * block).
1871 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1872 * Pool) that maintains established sessions and reuses them on new
1873 * connections.
1875 * Not completely tested, but it should fall back on normal connection
1876 * in case the pool is full or the datasource is not configured as
1877 * pooled.
1878 * And the other way around; using oci_pconnect on a non pooled
1879 * datasource should produce a normal connection.
1881 * When it comes to frequent shortlived DB connections like with MW
1882 * Oracle tends to s***. The problem is the driver connects to the
1883 * database reasonably fast, but establishing a session takes time and
1884 * resources. MW does not rely on session state (as it does not use
1885 * features such as package variables) so establishing a valid session
1886 * is in this case an unwanted overhead that just slows things down.
1888 * @warning EXPERIMENTAL!
1891 $wgDBOracleDRCP = false;
1894 * Other wikis on this site, can be administered from a single developer
1895 * account.
1896 * Array numeric key => database name
1898 $wgLocalDatabases = array();
1901 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1902 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1903 * show a more obvious warning.
1905 $wgSlaveLagWarning = 10;
1908 * @see $wgSlaveLagWarning
1910 $wgSlaveLagCritical = 30;
1913 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1915 $wgDBWindowsAuthentication = false;
1917 /**@}*/ # End of DB settings }
1919 /************************************************************************//**
1920 * @name Text storage
1921 * @{
1925 * We can also compress text stored in the 'text' table. If this is set on, new
1926 * revisions will be compressed on page save if zlib support is available. Any
1927 * compressed revisions will be decompressed on load regardless of this setting,
1928 * but will not be readable at all* if zlib support is not available.
1930 $wgCompressRevisions = false;
1933 * External stores allow including content
1934 * from non database sources following URL links.
1936 * Short names of ExternalStore classes may be specified in an array here:
1937 * @code
1938 * $wgExternalStores = array("http","file","custom")...
1939 * @endcode
1941 * CAUTION: Access to database might lead to code execution
1943 $wgExternalStores = array();
1946 * An array of external MySQL servers.
1948 * @par Example:
1949 * Create a cluster named 'cluster1' containing three servers:
1950 * @code
1951 * $wgExternalServers = array(
1952 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1953 * );
1954 * @endcode
1956 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1957 * another class.
1959 $wgExternalServers = array();
1962 * The place to put new revisions, false to put them in the local text table.
1963 * Part of a URL, e.g. DB://cluster1
1965 * Can be an array instead of a single string, to enable data distribution. Keys
1966 * must be consecutive integers, starting at zero.
1968 * @par Example:
1969 * @code
1970 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1971 * @endcode
1973 * @var array
1975 $wgDefaultExternalStore = false;
1978 * Revision text may be cached in $wgMemc to reduce load on external storage
1979 * servers and object extraction overhead for frequently-loaded revisions.
1981 * Set to 0 to disable, or number of seconds before cache expiry.
1983 $wgRevisionCacheExpiry = 0;
1985 /** @} */ # end text storage }
1987 /************************************************************************//**
1988 * @name Performance hacks and limits
1989 * @{
1993 * Disable database-intensive features
1995 $wgMiserMode = false;
1998 * Disable all query pages if miser mode is on, not just some
2000 $wgDisableQueryPages = false;
2003 * Number of rows to cache in 'querycache' table when miser mode is on
2005 $wgQueryCacheLimit = 1000;
2008 * Number of links to a page required before it is deemed "wanted"
2010 $wgWantedPagesThreshold = 1;
2013 * Enable slow parser functions
2015 $wgAllowSlowParserFunctions = false;
2018 * Allow schema updates
2020 $wgAllowSchemaUpdates = true;
2023 * Maximum article size in kilobytes
2025 $wgMaxArticleSize = 2048;
2028 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2029 * raise PHP's memory limit if it's below this amount.
2031 $wgMemoryLimit = "50M";
2033 /** @} */ # end performance hacks }
2035 /************************************************************************//**
2036 * @name Cache settings
2037 * @{
2041 * Directory for caching data in the local filesystem. Should not be accessible
2042 * from the web. Set this to false to not use any local caches.
2044 * Note: if multiple wikis share the same localisation cache directory, they
2045 * must all have the same set of extensions. You can set a directory just for
2046 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2048 $wgCacheDirectory = false;
2051 * Main cache type. This should be a cache with fast access, but it may have
2052 * limited space. By default, it is disabled, since the database is not fast
2053 * enough to make it worthwhile.
2055 * The options are:
2057 * - CACHE_ANYTHING: Use anything, as long as it works
2058 * - CACHE_NONE: Do not cache
2059 * - CACHE_DB: Store cache objects in the DB
2060 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2061 * - CACHE_ACCEL: APC, XCache or WinCache
2062 * - (other): A string may be used which identifies a cache
2063 * configuration in $wgObjectCaches.
2065 * @see $wgMessageCacheType, $wgParserCacheType
2067 $wgMainCacheType = CACHE_NONE;
2070 * The cache type for storing the contents of the MediaWiki namespace. This
2071 * cache is used for a small amount of data which is expensive to regenerate.
2073 * For available types see $wgMainCacheType.
2075 $wgMessageCacheType = CACHE_ANYTHING;
2078 * The cache type for storing article HTML. This is used to store data which
2079 * is expensive to regenerate, and benefits from having plenty of storage space.
2081 * For available types see $wgMainCacheType.
2083 $wgParserCacheType = CACHE_ANYTHING;
2086 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2088 * For available types see $wgMainCacheType.
2090 $wgSessionCacheType = CACHE_ANYTHING;
2093 * The cache type for storing language conversion tables,
2094 * which are used when parsing certain text and interface messages.
2096 * For available types see $wgMainCacheType.
2098 * @since 1.20
2100 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2103 * Advanced object cache configuration.
2105 * Use this to define the class names and constructor parameters which are used
2106 * for the various cache types. Custom cache types may be defined here and
2107 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2108 * or $wgLanguageConverterCacheType.
2110 * The format is an associative array where the key is a cache identifier, and
2111 * the value is an associative array of parameters. The "class" parameter is the
2112 * class name which will be used. Alternatively, a "factory" parameter may be
2113 * given, giving a callable function which will generate a suitable cache object.
2115 $wgObjectCaches = array(
2116 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2117 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2119 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2120 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2121 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached', 'loggroup' => 'memcached' ),
2123 'apc' => array( 'class' => 'APCBagOStuff' ),
2124 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2125 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2126 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2127 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2128 'hash' => array( 'class' => 'HashBagOStuff' ),
2132 * Map of bloom filter store names to configuration arrays.
2134 * Example:
2135 * $wgBloomFilterStores['main'] = array(
2136 * 'cacheId' => 'main-v1',
2137 * 'class' => 'BloomCacheRedis',
2138 * 'redisServers' => array( '127.0.0.1:6379' ),
2139 * 'redisConfig' => array( 'connectTimeout' => 2 )
2140 * );
2142 * A primary bloom filter must be created manually.
2143 * Example in eval.php:
2144 * <code>
2145 * BloomCache::get( 'main' )->init( 'shared', 1000000000, .001 );
2146 * </code>
2147 * The size should be as large as practical given wiki size and resources.
2149 * @since 1.24
2151 $wgBloomFilterStores = array();
2154 * The expiry time for the parser cache, in seconds.
2155 * The default is 86400 (one day).
2157 $wgParserCacheExpireTime = 86400;
2160 * Deprecated alias for $wgSessionsInObjectCache.
2162 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2164 $wgSessionsInMemcached = false;
2167 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2168 * can be useful to improve performance, or to avoid the locking behavior of
2169 * PHP's default session handler, which tends to prevent multiple requests for
2170 * the same user from acting concurrently.
2172 $wgSessionsInObjectCache = false;
2175 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2176 * enabled, in seconds.
2178 $wgObjectCacheSessionExpiry = 3600;
2181 * This is used for setting php's session.save_handler. In practice, you will
2182 * almost never need to change this ever. Other options might be 'user' or
2183 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2184 * useful if you're doing cross-application sessions, see bug 11381)
2186 $wgSessionHandler = null;
2189 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2191 $wgMemCachedDebug = false;
2194 * The list of MemCached servers and port numbers
2196 $wgMemCachedServers = array( '127.0.0.1:11211' );
2199 * Use persistent connections to MemCached, which are shared across multiple
2200 * requests.
2202 $wgMemCachedPersistent = false;
2205 * Read/write timeout for MemCached server communication, in microseconds.
2207 $wgMemCachedTimeout = 500000;
2210 * Set this to true to make a local copy of the message cache, for use in
2211 * addition to memcached. The files will be put in $wgCacheDirectory.
2213 $wgUseLocalMessageCache = false;
2216 * Instead of caching everything, only cache those messages which have
2217 * been customised in the site content language. This means that
2218 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2219 * This option is probably only useful for translatewiki.net.
2221 $wgAdaptiveMessageCache = false;
2224 * Localisation cache configuration. Associative array with keys:
2225 * class: The class to use. May be overridden by extensions.
2227 * store: The location to store cache data. May be 'files', 'db' or
2228 * 'detect'. If set to "files", data will be in CDB files. If set
2229 * to "db", data will be stored to the database. If set to
2230 * "detect", files will be used if $wgCacheDirectory is set,
2231 * otherwise the database will be used.
2233 * storeClass: The class name for the underlying storage. If set to a class
2234 * name, it overrides the "store" setting.
2236 * storeDirectory: If the store class puts its data in files, this is the
2237 * directory it will use. If this is false, $wgCacheDirectory
2238 * will be used.
2240 * manualRecache: Set this to true to disable cache updates on web requests.
2241 * Use maintenance/rebuildLocalisationCache.php instead.
2243 $wgLocalisationCacheConf = array(
2244 'class' => 'LocalisationCache',
2245 'store' => 'detect',
2246 'storeClass' => false,
2247 'storeDirectory' => false,
2248 'manualRecache' => false,
2252 * Allow client-side caching of pages
2254 $wgCachePages = true;
2257 * Set this to current time to invalidate all prior cached pages. Affects both
2258 * client-side and server-side caching.
2259 * You can get the current date on your server by using the command:
2260 * @verbatim
2261 * date +%Y%m%d%H%M%S
2262 * @endverbatim
2264 $wgCacheEpoch = '20030516000000';
2267 * Directory where GitInfo will look for pre-computed cache files. If false,
2268 * $wgCacheDirectory/gitinfo will be used.
2270 $wgGitInfoCacheDirectory = false;
2273 * Bump this number when changing the global style sheets and JavaScript.
2275 * It should be appended in the query string of static CSS and JS includes,
2276 * to ensure that client-side caches do not keep obsolete copies of global
2277 * styles.
2279 $wgStyleVersion = '303';
2282 * This will cache static pages for non-logged-in users to reduce
2283 * database traffic on public sites.
2284 * Automatically sets $wgShowIPinHeader = false
2285 * ResourceLoader requests to default language and skins are cached
2286 * as well as single module requests.
2288 $wgUseFileCache = false;
2291 * Depth of the subdirectory hierarchy to be created under
2292 * $wgFileCacheDirectory. The subdirectories will be named based on
2293 * the MD5 hash of the title. A value of 0 means all cache files will
2294 * be put directly into the main file cache directory.
2296 $wgFileCacheDepth = 2;
2299 * Keep parsed pages in a cache (objectcache table or memcached)
2300 * to speed up output of the same page viewed by another user with the
2301 * same options.
2303 * This can provide a significant speedup for medium to large pages,
2304 * so you probably want to keep it on. Extensions that conflict with the
2305 * parser cache should disable the cache on a per-page basis instead.
2307 $wgEnableParserCache = true;
2310 * Append a configured value to the parser cache and the sitenotice key so
2311 * that they can be kept separate for some class of activity.
2313 $wgRenderHashAppend = '';
2316 * If on, the sidebar navigation links are cached for users with the
2317 * current language set. This can save a touch of load on a busy site
2318 * by shaving off extra message lookups.
2320 * However it is also fragile: changing the site configuration, or
2321 * having a variable $wgArticlePath, can produce broken links that
2322 * don't update as expected.
2324 $wgEnableSidebarCache = false;
2327 * Expiry time for the sidebar cache, in seconds
2329 $wgSidebarCacheExpiry = 86400;
2332 * When using the file cache, we can store the cached HTML gzipped to save disk
2333 * space. Pages will then also be served compressed to clients that support it.
2335 * Requires zlib support enabled in PHP.
2337 $wgUseGzip = false;
2340 * Whether MediaWiki should send an ETag header. Seems to cause
2341 * broken behavior with Squid 2.6, see bug 7098.
2343 $wgUseETag = false;
2346 * Clock skew or the one-second resolution of time() can occasionally cause cache
2347 * problems when the user requests two pages within a short period of time. This
2348 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2349 * a grace period.
2351 $wgClockSkewFudge = 5;
2354 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2355 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2356 * was previously done in the default LocalSettings.php file.
2358 * On high-traffic wikis, this should be set to false, to avoid the need to
2359 * check the file modification time, and to avoid the performance impact of
2360 * unnecessary cache invalidations.
2362 $wgInvalidateCacheOnLocalSettingsChange = true;
2365 * When loading extensions through the extension registration system, this
2366 * can be used to invalidate the cache. A good idea would be to set this to
2367 * one file, you can just `touch` that one to invalidate the cache
2369 * @par Example:
2370 * @code
2371 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2372 * @endcode
2374 * If set to false, the mtime for each individual JSON file will be checked,
2375 * which can be slow if a large number of extensions are being loaded.
2377 * @var int|bool
2379 $wgExtensionInfoMTime = false;
2381 /** @} */ # end of cache settings
2383 /************************************************************************//**
2384 * @name HTTP proxy (Squid) settings
2386 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2387 * although they are referred to as Squid settings for historical reasons.
2389 * Achieving a high hit ratio with an HTTP proxy requires special
2390 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2391 * more details.
2393 * @{
2397 * Enable/disable Squid.
2398 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2400 $wgUseSquid = false;
2403 * If you run Squid3 with ESI support, enable this (default:false):
2405 $wgUseESI = false;
2408 * Send X-Vary-Options header for better caching (requires patched Squid)
2410 $wgUseXVO = false;
2413 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2414 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2415 * and need to split the cache between HTTP and HTTPS for API requests,
2416 * feed requests and HTTP redirect responses in order to prevent cache
2417 * pollution. This does not affect 'normal' requests to index.php other than
2418 * HTTP redirects.
2420 $wgVaryOnXFP = false;
2423 * Internal server name as known to Squid, if different.
2425 * @par Example:
2426 * @code
2427 * $wgInternalServer = 'http://yourinternal.tld:8000';
2428 * @endcode
2430 $wgInternalServer = false;
2433 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2434 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2435 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2436 * days
2438 $wgSquidMaxage = 18000;
2441 * Default maximum age for raw CSS/JS accesses
2443 $wgForcedRawSMaxage = 300;
2446 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2448 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2449 * headers sent/modified from these proxies when obtaining the remote IP address
2451 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2453 $wgSquidServers = array();
2456 * As above, except these servers aren't purged on page changes; use to set a
2457 * list of trusted proxies, etc. Supports both individual IP addresses and
2458 * CIDR blocks.
2459 * @since 1.23 Supports CIDR ranges
2461 $wgSquidServersNoPurge = array();
2464 * Maximum number of titles to purge in any one client operation
2466 $wgMaxSquidPurgeTitles = 400;
2469 * Whether to use a Host header in purge requests sent to the proxy servers
2470 * configured in $wgSquidServers. Set this to false to support Squid
2471 * configured in forward-proxy mode.
2473 * If this is set to true, a Host header will be sent, and only the path
2474 * component of the URL will appear on the request line, as if the request
2475 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2476 * request. Squid supports this style of request only if reverse-proxy mode
2477 * (http_port ... accel) is enabled.
2479 * If this is set to false, no Host header will be sent, and the absolute URL
2480 * will be sent in the request line, as is the standard for an HTTP proxy
2481 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2482 * by Varnish, but is supported by Squid in either configuration (forward or
2483 * reverse).
2485 * @since 1.21
2487 $wgSquidPurgeUseHostHeader = true;
2490 * Routing configuration for HTCP multicast purging. Add elements here to
2491 * enable HTCP and determine which purges are sent where. If set to an empty
2492 * array, HTCP is disabled.
2494 * Each key in this array is a regular expression to match against the purged
2495 * URL, or an empty string to match all URLs. The purged URL is matched against
2496 * the regexes in the order specified, and the first rule whose regex matches
2497 * is used, all remaining rules will thus be ignored.
2499 * @par Example configuration to send purges for upload.wikimedia.org to one
2500 * multicast group and all other purges to another:
2501 * @code
2502 * $wgHTCPRouting = array(
2503 * '|^https?://upload\.wikimedia\.org|' => array(
2504 * 'host' => '239.128.0.113',
2505 * 'port' => 4827,
2506 * ),
2507 * '' => array(
2508 * 'host' => '239.128.0.112',
2509 * 'port' => 4827,
2510 * ),
2511 * );
2512 * @endcode
2514 * You can also pass an array of hosts to send purges too. This is useful when
2515 * you have several multicast groups or unicast address that should receive a
2516 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2518 * @par Example of sending purges to multiple hosts:
2519 * @code
2520 * $wgHTCPRouting = array(
2521 * '' => array(
2522 * // Purges to text caches using multicast
2523 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2524 * // Purges to a hardcoded list of caches
2525 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2526 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2527 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2528 * ),
2529 * );
2530 * @endcode
2532 * @since 1.22
2534 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2535 * For back compatibility purposes, whenever its array is empty
2536 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2538 * @see $wgHTCPMulticastTTL
2540 $wgHTCPRouting = array();
2543 * HTCP multicast TTL.
2544 * @see $wgHTCPRouting
2546 $wgHTCPMulticastTTL = 1;
2549 * Should forwarded Private IPs be accepted?
2551 $wgUsePrivateIPs = false;
2553 /** @} */ # end of HTTP proxy settings
2555 /************************************************************************//**
2556 * @name Language, regional and character encoding settings
2557 * @{
2561 * Site language code. See languages/Names.php for languages supported by
2562 * MediaWiki out of the box. Not all languages listed there have translations,
2563 * see languages/messages/ for the list of languages with some localisation.
2565 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2566 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2568 * This defines the default interface language for all users, but users can
2569 * change it in their preferences.
2571 * This also defines the language of pages in the wiki. The content is wrapped
2572 * in a html element with lang=XX attribute. This behavior can be overridden
2573 * via hooks, see Title::getPageLanguage.
2575 $wgLanguageCode = 'en';
2578 * Language cache size, or really how many languages can we handle
2579 * simultaneously without degrading to crawl speed.
2581 $wgLangObjCacheSize = 10;
2584 * Some languages need different word forms, usually for different cases.
2585 * Used in Language::convertGrammar().
2587 * @par Example:
2588 * @code
2589 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2590 * @endcode
2592 $wgGrammarForms = array();
2595 * Treat language links as magic connectors, not inline links
2597 $wgInterwikiMagic = true;
2600 * Hide interlanguage links from the sidebar
2602 $wgHideInterlanguageLinks = false;
2605 * List of additional interwiki prefixes that should be treated as
2606 * interlanguage links (i.e. placed in the sidebar).
2607 * Notes:
2608 * - This will not do anything unless the prefixes are defined in the interwiki
2609 * map.
2610 * - The display text for these custom interlanguage links will be fetched from
2611 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2612 * this array.
2613 * - A friendly name for each site, used for tooltip text, may optionally be
2614 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2615 * the prefix in this array.
2617 $wgExtraInterlanguageLinkPrefixes = array();
2620 * List of language names or overrides for default names in Names.php
2622 $wgExtraLanguageNames = array();
2625 * List of language codes that don't correspond to an actual language.
2626 * These codes are mostly left-offs from renames, or other legacy things.
2627 * This array makes them not appear as a selectable language on the installer,
2628 * and excludes them when running the transstat.php script.
2630 $wgDummyLanguageCodes = array(
2631 'als' => 'gsw',
2632 'bat-smg' => 'sgs',
2633 'be-x-old' => 'be-tarask',
2634 'bh' => 'bho',
2635 'fiu-vro' => 'vro',
2636 'no' => 'nb',
2637 'qqq' => 'qqq', # Used for message documentation.
2638 'qqx' => 'qqx', # Used for viewing message keys.
2639 'roa-rup' => 'rup',
2640 'simple' => 'en',
2641 'zh-classical' => 'lzh',
2642 'zh-min-nan' => 'nan',
2643 'zh-yue' => 'yue',
2647 * Character set for use in the article edit box. Language-specific encodings
2648 * may be defined.
2650 * This historic feature is one of the first that was added by former MediaWiki
2651 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2653 $wgEditEncoding = '';
2656 * Set this to true to replace Arabic presentation forms with their standard
2657 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2658 * set to "ar".
2660 * Note that pages with titles containing presentation forms will become
2661 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2663 $wgFixArabicUnicode = true;
2666 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2667 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2668 * set to "ml". Note that some clients (even new clients as of 2010) do not
2669 * support these characters.
2671 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2672 * fix any ZWJ sequences in existing page titles.
2674 $wgFixMalayalamUnicode = true;
2677 * Set this to always convert certain Unicode sequences to modern ones
2678 * regardless of the content language. This has a small performance
2679 * impact.
2681 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2682 * details.
2684 * @since 1.17
2686 $wgAllUnicodeFixes = false;
2689 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2690 * loading old revisions not marked with "utf-8" flag. Use this when
2691 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2692 * burdensome mass conversion of old text data.
2694 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2695 * user names, etc still must be converted en masse in the database before
2696 * continuing as a UTF-8 wiki.
2698 $wgLegacyEncoding = false;
2701 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2702 * regexps : "/regexp/" matching problematic browsers. These browsers will
2703 * be served encoded unicode in the edit box instead of real unicode.
2705 $wgBrowserBlackList = array(
2707 * Netscape 2-4 detection
2708 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2709 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2710 * with a negative assertion. The [UIN] identifier specifies the level of security
2711 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2712 * The language string is unreliable, it is missing on NS4 Mac.
2714 * Reference: http://www.psychedelix.com/agents/index.shtml
2716 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2717 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2718 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2721 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2722 * Þ to <THORN> and Ð to <ETH>
2724 * Known useragents:
2725 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2726 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2727 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2728 * - [...]
2730 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2731 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2733 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2736 * Google wireless transcoder, seems to eat a lot of chars alive
2737 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2739 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2743 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2744 * create stub reference rows in the text table instead of copying
2745 * the full text of all current entries from 'cur' to 'text'.
2747 * This will speed up the conversion step for large sites, but
2748 * requires that the cur table be kept around for those revisions
2749 * to remain viewable.
2751 * This option affects the updaters *only*. Any present cur stub
2752 * revisions will be readable at runtime regardless of this setting.
2754 $wgLegacySchemaConversion = false;
2757 * Enable dates like 'May 12' instead of '12 May', if the default date format
2758 * is 'dmy or mdy'.
2760 $wgAmericanDates = false;
2763 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2764 * numerals in interface.
2766 $wgTranslateNumerals = true;
2769 * Translation using MediaWiki: namespace.
2770 * Interface messages will be loaded from the database.
2772 $wgUseDatabaseMessages = true;
2775 * Expiry time for the message cache key
2777 $wgMsgCacheExpiry = 86400;
2780 * Maximum entry size in the message cache, in bytes
2782 $wgMaxMsgCacheEntrySize = 10000;
2785 * Whether to enable language variant conversion.
2787 $wgDisableLangConversion = false;
2790 * Whether to enable language variant conversion for links.
2792 $wgDisableTitleConversion = false;
2795 * Default variant code, if false, the default will be the language code
2797 $wgDefaultLanguageVariant = false;
2800 * Disabled variants array of language variant conversion.
2802 * @par Example:
2803 * @code
2804 * $wgDisabledVariants[] = 'zh-mo';
2805 * $wgDisabledVariants[] = 'zh-my';
2806 * @endcode
2808 $wgDisabledVariants = array();
2811 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2812 * path format that describes which parts of the URL contain the
2813 * language variant.
2815 * @par Example:
2816 * @code
2817 * $wgLanguageCode = 'sr';
2818 * $wgVariantArticlePath = '/$2/$1';
2819 * $wgArticlePath = '/wiki/$1';
2820 * @endcode
2822 * A link to /wiki/ would be redirected to /sr/Главна_страна
2824 * It is important that $wgArticlePath not overlap with possible values
2825 * of $wgVariantArticlePath.
2827 $wgVariantArticlePath = false;
2830 * Show a bar of language selection links in the user login and user
2831 * registration forms; edit the "loginlanguagelinks" message to
2832 * customise these.
2834 $wgLoginLanguageSelector = false;
2837 * When translating messages with wfMessage(), it is not always clear what
2838 * should be considered UI messages and what should be content messages.
2840 * For example, for the English Wikipedia, there should be only one 'mainpage',
2841 * so when getting the link for 'mainpage', we should treat it as site content
2842 * and call ->inContentLanguage()->text(), but for rendering the text of the
2843 * link, we call ->text(). The code behaves this way by default. However,
2844 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2845 * and the like for different languages. This array provides a way to override
2846 * the default behavior.
2848 * @par Example:
2849 * To allow language-specific main page and community
2850 * portal:
2851 * @code
2852 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2853 * @endcode
2855 $wgForceUIMsgAsContentMsg = array();
2858 * Fake out the timezone that the server thinks it's in. This will be used for
2859 * date display and not for what's stored in the DB. Leave to null to retain
2860 * your server's OS-based timezone value.
2862 * This variable is currently used only for signature formatting and for local
2863 * time/date parser variables ({{LOCALTIME}} etc.)
2865 * Timezones can be translated by editing MediaWiki messages of type
2866 * timezone-nameinlowercase like timezone-utc.
2868 * A list of usable timezones can found at:
2869 * http://php.net/manual/en/timezones.php
2871 * @par Examples:
2872 * @code
2873 * $wgLocaltimezone = 'UTC';
2874 * $wgLocaltimezone = 'GMT';
2875 * $wgLocaltimezone = 'PST8PDT';
2876 * $wgLocaltimezone = 'Europe/Sweden';
2877 * $wgLocaltimezone = 'CET';
2878 * @endcode
2880 $wgLocaltimezone = null;
2883 * Set an offset from UTC in minutes to use for the default timezone setting
2884 * for anonymous users and new user accounts.
2886 * This setting is used for most date/time displays in the software, and is
2887 * overridable in user preferences. It is *not* used for signature timestamps.
2889 * By default, this will be set to match $wgLocaltimezone.
2891 $wgLocalTZoffset = null;
2893 /** @} */ # End of language/charset settings
2895 /*************************************************************************//**
2896 * @name Output format and skin settings
2897 * @{
2901 * The default Content-Type header.
2903 $wgMimeType = 'text/html';
2906 * Previously used as content type in HTML script tags. This is now ignored since
2907 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2908 * It was also previously used by RawAction to determine the ctype query parameter
2909 * value that will result in a javascript response.
2910 * @deprecated since 1.22
2912 $wgJsMimeType = null;
2915 * The default xmlns attribute. The option to define this has been removed.
2916 * The value of this variable is no longer used by core and is set to a fixed
2917 * value in Setup.php for compatibility with extensions that depend on the value
2918 * of this variable being set. Such a dependency however is deprecated.
2919 * @deprecated since 1.22
2921 $wgXhtmlDefaultNamespace = null;
2924 * Previously used to determine if we should output an HTML5 doctype.
2925 * This is no longer used as we always output HTML5 now. For compatibility with
2926 * extensions that still check the value of this config it's value is now forced
2927 * to true by Setup.php.
2928 * @deprecated since 1.22
2930 $wgHtml5 = true;
2933 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2934 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2935 * (like if it's left at the default null value), it will be auto-initialized
2936 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2937 * ever actually set this to anything.
2939 $wgHtml5Version = null;
2942 * Temporary variable that allows HTMLForms to be rendered as tables.
2943 * Table based layouts cause various issues when designing for mobile.
2944 * This global allows skins or extensions a means to force non-table based rendering.
2945 * Setting to false forces form components to always render as div elements.
2946 * @since 1.24
2948 $wgHTMLFormAllowTableFormat = true;
2951 * Temporary variable that applies MediaWiki UI wherever it can be supported.
2952 * Temporary variable that should be removed when mediawiki ui is more
2953 * stable and change has been communicated.
2954 * @since 1.24
2956 $wgUseMediaWikiUIEverywhere = false;
2959 * Enabled RDFa attributes for use in wikitext.
2960 * NOTE: Interaction with HTML5 is somewhat underspecified.
2962 $wgAllowRdfaAttributes = false;
2965 * Enabled HTML5 microdata attributes for use in wikitext.
2967 $wgAllowMicrodataAttributes = false;
2970 * Should we try to make our HTML output well-formed XML? If set to false,
2971 * output will be a few bytes shorter, and the HTML will arguably be more
2972 * readable. If set to true, life will be much easier for the authors of
2973 * screen-scraping bots, and the HTML will arguably be more readable.
2975 * Setting this to false may omit quotation marks on some attributes, omit
2976 * slashes from some self-closing tags, omit some ending tags, etc., where
2977 * permitted by HTML5. Setting it to true will not guarantee that all pages
2978 * will be well-formed, although non-well-formed pages should be rare and it's
2979 * a bug if you find one. Conversely, setting it to false doesn't mean that
2980 * all XML-y constructs will be omitted, just that they might be.
2982 * Because of compatibility with screen-scraping bots, and because it's
2983 * controversial, this is currently left to true by default.
2985 $wgWellFormedXml = true;
2988 * Permit other namespaces in addition to the w3.org default.
2990 * Use the prefix for the key and the namespace for the value.
2992 * @par Example:
2993 * @code
2994 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2995 * @endcode
2996 * Normally we wouldn't have to define this in the root "<html>"
2997 * element, but IE needs it there in some circumstances.
2999 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3001 $wgXhtmlNamespaces = array();
3004 * Show IP address, for non-logged in users. It's necessary to switch this off
3005 * for some forms of caching.
3006 * @warning Will disable file cache.
3008 $wgShowIPinHeader = true;
3011 * Site notice shown at the top of each page
3013 * MediaWiki:Sitenotice page, which will override this. You can also
3014 * provide a separate message for logged-out users using the
3015 * MediaWiki:Anonnotice page.
3017 $wgSiteNotice = '';
3020 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3022 $wgSiteSupportPage = '';
3025 * Validate the overall output using tidy and refuse
3026 * to display the page if it's not valid.
3028 $wgValidateAllHtml = false;
3031 * Default skin, for new users and anonymous visitors. Registered users may
3032 * change this to any one of the other available skins in their preferences.
3034 $wgDefaultSkin = 'vector';
3037 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3039 * @since 1.24
3041 $wgFallbackSkin = 'fallback';
3044 * Specify the names of skins that should not be presented in the list of
3045 * available skins in user preferences. If you want to remove a skin entirely,
3046 * remove it from the skins/ directory and its entry from LocalSettings.php.
3048 $wgSkipSkins = array();
3051 * @deprecated since 1.23; use $wgSkipSkins instead
3053 $wgSkipSkin = '';
3056 * Allow user Javascript page?
3057 * This enables a lot of neat customizations, but may
3058 * increase security risk to users and server load.
3060 $wgAllowUserJs = false;
3063 * Allow user Cascading Style Sheets (CSS)?
3064 * This enables a lot of neat customizations, but may
3065 * increase security risk to users and server load.
3067 $wgAllowUserCss = false;
3070 * Allow user-preferences implemented in CSS?
3071 * This allows users to customise the site appearance to a greater
3072 * degree; disabling it will improve page load times.
3074 $wgAllowUserCssPrefs = true;
3077 * Use the site's Javascript page?
3079 $wgUseSiteJs = true;
3082 * Use the site's Cascading Style Sheets (CSS)?
3084 $wgUseSiteCss = true;
3087 * Break out of framesets. This can be used to prevent clickjacking attacks,
3088 * or to prevent external sites from framing your site with ads.
3090 $wgBreakFrames = false;
3093 * The X-Frame-Options header to send on pages sensitive to clickjacking
3094 * attacks, such as edit pages. This prevents those pages from being displayed
3095 * in a frame or iframe. The options are:
3097 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3099 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3100 * to allow framing within a trusted domain. This is insecure if there
3101 * is a page on the same domain which allows framing of arbitrary URLs.
3103 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3104 * full compromise of local user accounts. Private wikis behind a
3105 * corporate firewall are especially vulnerable. This is not
3106 * recommended.
3108 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3109 * not just edit pages.
3111 $wgEditPageFrameOptions = 'DENY';
3114 * Disallow framing of API pages directly, by setting the X-Frame-Options
3115 * header. Since the API returns CSRF tokens, allowing the results to be
3116 * framed can compromise your user's account security.
3117 * Options are:
3118 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3119 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3120 * - false: Allow all framing.
3121 * Note: $wgBreakFrames will override this for human formatted API output.
3123 $wgApiFrameOptions = 'DENY';
3126 * Disable output compression (enabled by default if zlib is available)
3128 $wgDisableOutputCompression = false;
3131 * Should we allow a broader set of characters in id attributes, per HTML5? If
3132 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3133 * functionality is ready, it will be on by default with no option.
3135 * Currently this appears to work fine in all browsers, but it's disabled by
3136 * default because it normalizes id's a bit too aggressively, breaking preexisting
3137 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3139 $wgExperimentalHtmlIds = false;
3142 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3143 * You can add new icons to the built in copyright or poweredby, or you can create
3144 * a new block. Though note that you may need to add some custom css to get good styling
3145 * of new blocks in monobook. vector and modern should work without any special css.
3147 * $wgFooterIcons itself is a key/value array.
3148 * The key is the name of a block that the icons will be wrapped in. The final id varies
3149 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3150 * turns it into mw_poweredby.
3151 * The value is either key/value array of icons or a string.
3152 * In the key/value array the key may or may not be used by the skin but it can
3153 * be used to find the icon and unset it or change the icon if needed.
3154 * This is useful for disabling icons that are set by extensions.
3155 * The value should be either a string or an array. If it is a string it will be output
3156 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3157 * for the icon, the following keys are used:
3158 * - src: An absolute url to the image to use for the icon, this is recommended
3159 * but not required, however some skins will ignore icons without an image
3160 * - srcset: optional additional-resolution images; see HTML5 specs
3161 * - url: The url to use in the a element around the text or icon, if not set an a element will
3162 * not be outputted
3163 * - alt: This is the text form of the icon, it will be displayed without an image in
3164 * skins like Modern or if src is not set, and will otherwise be used as
3165 * the alt="" for the image. This key is required.
3166 * - width and height: If the icon specified by src is not of the standard size
3167 * you can specify the size of image to use with these keys.
3168 * Otherwise they will default to the standard 88x31.
3169 * @todo Reformat documentation.
3171 $wgFooterIcons = array(
3172 "copyright" => array(
3173 "copyright" => array(), // placeholder for the built in copyright icon
3175 "poweredby" => array(
3176 "mediawiki" => array(
3177 // Defaults to point at
3178 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3179 // plus srcset for 1.5x, 2x resolution variants.
3180 "src" => null,
3181 "url" => "//www.mediawiki.org/",
3182 "alt" => "Powered by MediaWiki",
3188 * Login / create account link behavior when it's possible for anonymous users
3189 * to create an account.
3190 * - true = use a combined login / create account link
3191 * - false = split login and create account into two separate links
3193 $wgUseCombinedLoginLink = false;
3196 * Display user edit counts in various prominent places.
3198 $wgEdititis = false;
3201 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3202 * status code, mangling or hiding MediaWiki's output. If you are using such a
3203 * host, you should start looking for a better one. While you're doing that,
3204 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3205 * that the generated error pages can be seen.
3207 * In cases where for technical reasons it is more important for MediaWiki to
3208 * send the correct status code than for the body to be transmitted intact,
3209 * this configuration variable is ignored.
3211 $wgSend404Code = true;
3214 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3215 * rollback. The numeric value of the variable are the limit up to are counted.
3216 * If the value is false or 0, the edits are not counted. Disabling this will
3217 * furthermore prevent MediaWiki from hiding some useless rollback links.
3219 * @since 1.20
3221 $wgShowRollbackEditCount = 10;
3224 * Output a <link rel="canonical"> tag on every page indicating the canonical
3225 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3226 * detection of the current server is unreliable, the link is sent
3227 * unconditionally.
3229 $wgEnableCanonicalServerLink = false;
3232 * When OutputHandler is used, mangle any output that contains
3233 * <cross-domain-policy>. Without this, an attacker can send their own
3234 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3235 * the domain root.
3237 * @since 1.25
3239 $wgMangleFlashPolicy = true;
3241 /** @} */ # End of output format settings }
3243 /*************************************************************************//**
3244 * @name Resource loader settings
3245 * @{
3249 * Client-side resource modules.
3251 * Extensions should add their resource loader module definitions
3252 * to the $wgResourceModules variable.
3254 * @par Example:
3255 * @code
3256 * $wgResourceModules['ext.myExtension'] = array(
3257 * 'scripts' => 'myExtension.js',
3258 * 'styles' => 'myExtension.css',
3259 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3260 * 'localBasePath' => __DIR__,
3261 * 'remoteExtPath' => 'MyExtension',
3262 * );
3263 * @endcode
3265 $wgResourceModules = array();
3268 * Skin-specific styles for resource modules.
3270 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3271 * not be modified or disabled.
3273 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3275 * @par Example:
3276 * @code
3277 * $wgResourceModules['bar'] = array(
3278 * 'scripts' => 'resources/bar/bar.js',
3279 * 'styles' => 'resources/bar/main.css',
3280 * );
3282 * $wgResourceModuleSkinStyles['foo'] = array(
3283 * 'bar' => 'skins/Foo/bar.css',
3284 * );
3285 * @endcode
3287 * This is mostly equivalent to:
3289 * @par Equivalent:
3290 * @code
3291 * $wgResourceModules['bar'] = array(
3292 * 'scripts' => 'resources/bar/bar.js',
3293 * 'styles' => 'resources/bar/main.css',
3294 * 'skinStyles' => array(
3295 * 'foo' => skins/Foo/bar.css',
3296 * ),
3297 * );
3298 * @endcode
3300 * If the module already defines its own entry in `skinStyles` for a given skin, then
3301 * $wgResourceModuleSkinStyles is ignored.
3303 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3304 * of replacing them. This can be done using the `+` prefix.
3306 * @par Example:
3307 * @code
3308 * $wgResourceModules['bar'] = array(
3309 * 'scripts' => 'resources/bar/bar.js',
3310 * 'styles' => 'resources/bar/basic.css',
3311 * 'skinStyles' => array(
3312 * 'default' => 'resources/bar/additional.css',
3313 * ),
3314 * );
3315 * // Note the '+' character:
3316 * $wgResourceModuleSkinStyles['foo'] = array(
3317 * '+bar' => 'skins/Foo/bar.css',
3318 * );
3319 * @endcode
3321 * This is mostly equivalent to:
3323 * @par Equivalent:
3324 * @code
3325 * $wgResourceModules['bar'] = array(
3326 * 'scripts' => 'resources/bar/bar.js',
3327 * 'styles' => 'resources/bar/basic.css',
3328 * 'skinStyles' => array(
3329 * 'default' => 'resources/bar/additional.css',
3330 * 'foo' => array(
3331 * 'resources/bar/additional.css',
3332 * 'skins/Foo/bar.css',
3333 * ),
3334 * ),
3335 * );
3336 * @endcode
3338 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3339 * disabled by a skin. To provide default styles that may be extended or replaced,
3340 * use `skinStyles['default']`.
3342 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3343 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3344 * Either for all skin styles at once (first example below) or for each module separately (second
3345 * example).
3347 * @par Example:
3348 * @code
3349 * $wgResourceModuleSkinStyles['foo'] = array(
3350 * 'bar' => 'bar.css',
3351 * 'quux' => 'quux.css',
3352 * 'remoteSkinPath' => 'Foo',
3353 * 'localBasePath' => __DIR__,
3354 * );
3356 * $wgResourceModuleSkinStyles['foo'] = array(
3357 * 'bar' => array(
3358 * 'bar.css',
3359 * 'remoteSkinPath' => 'Foo',
3360 * 'localBasePath' => __DIR__,
3361 * ),
3362 * 'quux' => array(
3363 * 'quux.css',
3364 * 'remoteSkinPath' => 'Foo',
3365 * 'localBasePath' => __DIR__,
3366 * ),
3367 * );
3368 * @endcode
3370 $wgResourceModuleSkinStyles = array();
3373 * Extensions should register foreign module sources here. 'local' is a
3374 * built-in source that is not in this array, but defined by
3375 * ResourceLoader::__construct() so that it cannot be unset.
3377 * @par Example:
3378 * @code
3379 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3380 * @endcode
3382 $wgResourceLoaderSources = array();
3385 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3386 * If not set, then $wgScriptPath will be used as a fallback.
3388 $wgResourceBasePath = null;
3391 * Maximum time in seconds to cache resources served by the resource loader.
3392 * Used to set last modified headers (max-age/s-maxage).
3394 * Following options to distinguish:
3395 * - versioned: Used for modules with a version, because changing version
3396 * numbers causes cache misses. This normally has a long expiry time.
3397 * - unversioned: Used for modules without a version to propagate changes
3398 * quickly to clients. Also used for modules with errors to recover quickly.
3399 * This normally has a short expiry time.
3401 * Expiry time for the options to distinguish:
3402 * - server: Squid/Varnish but also any other public proxy cache between the
3403 * client and MediaWiki.
3404 * - client: On the client side (e.g. in the browser cache).
3406 $wgResourceLoaderMaxage = array(
3407 'versioned' => array(
3408 'server' => 30 * 24 * 60 * 60, // 30 days
3409 'client' => 30 * 24 * 60 * 60, // 30 days
3411 'unversioned' => array(
3412 'server' => 5 * 60, // 5 minutes
3413 'client' => 5 * 60, // 5 minutes
3418 * The default debug mode (on/off) for of ResourceLoader requests.
3420 * This will still be overridden when the debug URL parameter is used.
3422 $wgResourceLoaderDebug = false;
3425 * Enable embedding of certain resources using Edge Side Includes. This will
3426 * improve performance but only works if there is something in front of the
3427 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3429 $wgResourceLoaderUseESI = false;
3432 * Put each statement on its own line when minifying JavaScript. This makes
3433 * debugging in non-debug mode a bit easier.
3435 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3438 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3439 * the minifier will try not to produce lines longer than this, but may be
3440 * forced to do so in certain cases.
3442 $wgResourceLoaderMinifierMaxLineLength = 1000;
3445 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3446 * dependencies.
3448 $wgIncludeLegacyJavaScript = true;
3451 * Whether to preload the mediawiki.util module as blocking module in the top
3452 * queue.
3454 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3455 * allowed modules to lack dependencies on 'popular' modules that were likely
3456 * loaded already.
3458 * This setting is to aid scripts during migration by providing mediawiki.util
3459 * unconditionally (which was the most commonly missed dependency).
3460 * It doesn't cover all missing dependencies obviously but should fix most of
3461 * them.
3463 * This should be removed at some point after site/user scripts have been fixed.
3464 * Enable this if your wiki has a large amount of user/site scripts that are
3465 * lacking dependencies.
3466 * @todo Deprecate
3468 $wgPreloadJavaScriptMwUtil = false;
3471 * Whether or not to assign configuration variables to the global window object.
3473 * If this is set to false, old code using deprecated variables will no longer
3474 * work.
3476 * @par Example of legacy code:
3477 * @code{,js}
3478 * if ( window.wgRestrictionEdit ) { ... }
3479 * @endcode
3480 * or:
3481 * @code{,js}
3482 * if ( wgIsArticle ) { ... }
3483 * @endcode
3485 * Instead, one needs to use mw.config.
3486 * @par Example using mw.config global configuration:
3487 * @code{,js}
3488 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3489 * @endcode
3490 * or:
3491 * @code{,js}
3492 * if ( mw.config.get('wgIsArticle') ) { ... }
3493 * @endcode
3495 $wgLegacyJavaScriptGlobals = true;
3498 * If set to a positive number, ResourceLoader will not generate URLs whose
3499 * query string is more than this many characters long, and will instead use
3500 * multiple requests with shorter query strings. This degrades performance,
3501 * but may be needed if your web server has a low (less than, say 1024)
3502 * query string length limit or a low value for suhosin.get.max_value_length
3503 * that you can't increase.
3505 * If set to a negative number, ResourceLoader will assume there is no query
3506 * string length limit.
3508 * Defaults to a value based on php configuration.
3510 $wgResourceLoaderMaxQueryLength = false;
3513 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3514 * prior to minification to validate it.
3516 * Parse errors will result in a JS exception being thrown during module load,
3517 * which avoids breaking other modules loaded in the same request.
3519 $wgResourceLoaderValidateJS = true;
3522 * If set to true, statically-sourced (file-backed) JavaScript resources will
3523 * be parsed for validity before being bundled up into ResourceLoader modules.
3525 * This can be helpful for development by providing better error messages in
3526 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3527 * and may fail on large pre-bundled frameworks.
3529 $wgResourceLoaderValidateStaticJS = false;
3532 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3533 * will be enabled. This is an experimental feature that's supposed to make
3534 * JavaScript load faster.
3536 $wgResourceLoaderExperimentalAsyncLoading = false;
3539 * Global LESS variables. An associative array binding variable names to
3540 * LESS code snippets representing their values.
3542 * Adding an item here is equivalent to writing `@variable: value;`
3543 * at the beginning of all your .less files, with all the consequences.
3544 * In particular, string values must be escaped and quoted.
3546 * Changes to LESS variables do not trigger cache invalidation.
3548 * If the LESS variables need to be dynamic, you can use the
3549 * ResourceLoaderGetLessVars hook (since 1.25).
3551 * @par Example:
3552 * @code
3553 * $wgResourceLoaderLESSVars = array(
3554 * 'baseFontSize' => '1em',
3555 * 'smallFontSize' => '0.75em',
3556 * 'WikimediaBlue' => '#006699',
3557 * );
3558 * @endcode
3559 * @since 1.22
3561 $wgResourceLoaderLESSVars = array();
3564 * Custom LESS functions. An associative array mapping function name to PHP
3565 * callable.
3567 * Changes to LESS functions do not trigger cache invalidation.
3569 * @since 1.22
3570 * @deprecated since 1.24 Questionable usefulness and problematic to support,
3571 * will be removed in the future.
3573 $wgResourceLoaderLESSFunctions = array();
3576 * Default import paths for LESS modules. LESS files referenced in @import
3577 * statements will be looked up here first, and relative to the importing file
3578 * second. To avoid collisions, it's important for the LESS files in these
3579 * directories to have a common, predictable file name prefix.
3581 * Extensions need not (and should not) register paths in
3582 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3583 * currently compiling LESS file, which allows each extension to freely import
3584 * files from its own tree.
3586 * @since 1.22
3588 $wgResourceLoaderLESSImportPaths = array(
3589 "$IP/resources/src/mediawiki.less/",
3593 * Whether ResourceLoader should attempt to persist modules in localStorage on
3594 * browsers that support the Web Storage API.
3596 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3598 $wgResourceLoaderStorageEnabled = false;
3601 * Cache version for client-side ResourceLoader module storage. You can trigger
3602 * invalidation of the contents of the module store by incrementing this value.
3604 * @since 1.23
3606 $wgResourceLoaderStorageVersion = 1;
3609 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3610 * restricted pages like Special:UserLogin or Special:Preferences where
3611 * JavaScript is disabled for security reasons. As it is possible to
3612 * execute JavaScript through CSS, setting this to true opens up a
3613 * potential security hole. Some sites may "skin" their wiki by using
3614 * site-wide CSS, causing restricted pages to look unstyled and different
3615 * from the rest of the site.
3617 * @since 1.25
3619 $wgAllowSiteCSSOnRestrictedPages = false;
3621 /** @} */ # End of resource loader settings }
3623 /*************************************************************************//**
3624 * @name Page title and interwiki link settings
3625 * @{
3629 * Name of the project namespace. If left set to false, $wgSitename will be
3630 * used instead.
3632 $wgMetaNamespace = false;
3635 * Name of the project talk namespace.
3637 * Normally you can ignore this and it will be something like
3638 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3639 * manually for grammatical reasons.
3641 $wgMetaNamespaceTalk = false;
3644 * Additional namespaces. If the namespaces defined in Language.php and
3645 * Namespace.php are insufficient, you can create new ones here, for example,
3646 * to import Help files in other languages. You can also override the namespace
3647 * names of existing namespaces. Extensions developers should use
3648 * $wgCanonicalNamespaceNames.
3650 * @warning Once you delete a namespace, the pages in that namespace will
3651 * no longer be accessible. If you rename it, then you can access them through
3652 * the new namespace name.
3654 * Custom namespaces should start at 100 to avoid conflicting with standard
3655 * namespaces, and should always follow the even/odd main/talk pattern.
3657 * @par Example:
3658 * @code
3659 * $wgExtraNamespaces = array(
3660 * 100 => "Hilfe",
3661 * 101 => "Hilfe_Diskussion",
3662 * 102 => "Aide",
3663 * 103 => "Discussion_Aide"
3664 * );
3665 * @endcode
3667 * @todo Add a note about maintenance/namespaceDupes.php
3669 $wgExtraNamespaces = array();
3672 * Same as above, but for namespaces with gender distinction.
3673 * Note: the default form for the namespace should also be set
3674 * using $wgExtraNamespaces for the same index.
3675 * @since 1.18
3677 $wgExtraGenderNamespaces = array();
3680 * Namespace aliases.
3682 * These are alternate names for the primary localised namespace names, which
3683 * are defined by $wgExtraNamespaces and the language file. If a page is
3684 * requested with such a prefix, the request will be redirected to the primary
3685 * name.
3687 * Set this to a map from namespace names to IDs.
3689 * @par Example:
3690 * @code
3691 * $wgNamespaceAliases = array(
3692 * 'Wikipedian' => NS_USER,
3693 * 'Help' => 100,
3694 * );
3695 * @endcode
3697 $wgNamespaceAliases = array();
3700 * Allowed title characters -- regex character class
3701 * Don't change this unless you know what you're doing
3703 * Problematic punctuation:
3704 * - []{}|# Are needed for link syntax, never enable these
3705 * - <> Causes problems with HTML escaping, don't use
3706 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3707 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3708 * corrupted by apache
3709 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3711 * All three of these punctuation problems can be avoided by using an alias,
3712 * instead of a rewrite rule of either variety.
3714 * The problem with % is that when using a path to query rewrite rule, URLs are
3715 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3716 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3717 * for this, indeed double escaping would break if the double-escaped title was
3718 * passed in the query string rather than the path. This is a minor security issue
3719 * because articles can be created such that they are hard to view or edit.
3721 * In some rare cases you may wish to remove + for compatibility with old links.
3723 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3724 * this breaks interlanguage links
3726 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3729 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3731 * @deprecated since 1.23; use $wgLocalInterwikis instead
3733 $wgLocalInterwiki = false;
3736 * Array for multiple $wgLocalInterwiki values, in case there are several
3737 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3738 * set, its value is prepended to this array, for backwards compatibility.
3740 * Note, recent changes feeds use only the first entry in this array (or
3741 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3743 $wgLocalInterwikis = array();
3746 * Expiry time for cache of interwiki table
3748 $wgInterwikiExpiry = 10800;
3751 * @name Interwiki caching settings.
3752 * @{
3756 *$wgInterwikiCache specifies path to constant database file.
3758 * This cdb database is generated by dumpInterwiki from maintenance and has
3759 * such key formats:
3760 * - dbname:key - a simple key (e.g. enwiki:meta)
3761 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3762 * - __global:key - global-scope key (e.g. __global:meta)
3763 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3765 * Sites mapping just specifies site name, other keys provide "local url"
3766 * data layout.
3768 $wgInterwikiCache = false;
3771 * Specify number of domains to check for messages.
3772 * - 1: Just wiki(db)-level
3773 * - 2: wiki and global levels
3774 * - 3: site levels
3776 $wgInterwikiScopes = 3;
3779 * Fallback site, if unable to resolve from cache
3781 $wgInterwikiFallbackSite = 'wiki';
3783 /** @} */ # end of Interwiki caching settings.
3786 * @name SiteStore caching settings.
3787 * @{
3791 * Specify the file location for the SiteStore json cache file.
3793 $wgSitesCacheFile = false;
3795 /** @} */ # end of SiteStore caching settings.
3798 * If local interwikis are set up which allow redirects,
3799 * set this regexp to restrict URLs which will be displayed
3800 * as 'redirected from' links.
3802 * @par Example:
3803 * It might look something like this:
3804 * @code
3805 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3806 * @endcode
3808 * Leave at false to avoid displaying any incoming redirect markers.
3809 * This does not affect intra-wiki redirects, which don't change
3810 * the URL.
3812 $wgRedirectSources = false;
3815 * Set this to false to avoid forcing the first letter of links to capitals.
3817 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3818 * appearing with a capital at the beginning of a sentence will *not* go to the
3819 * same place as links in the middle of a sentence using a lowercase initial.
3821 $wgCapitalLinks = true;
3824 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3825 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3826 * true by default (and setting them has no effect), due to various things that
3827 * require them to be so. Also, since Talk namespaces need to directly mirror their
3828 * associated content namespaces, the values for those are ignored in favor of the
3829 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3830 * NS_FILE.
3832 * @par Example:
3833 * @code
3834 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3835 * @endcode
3837 $wgCapitalLinkOverrides = array();
3840 * Which namespaces should support subpages?
3841 * See Language.php for a list of namespaces.
3843 $wgNamespacesWithSubpages = array(
3844 NS_TALK => true,
3845 NS_USER => true,
3846 NS_USER_TALK => true,
3847 NS_PROJECT => true,
3848 NS_PROJECT_TALK => true,
3849 NS_FILE_TALK => true,
3850 NS_MEDIAWIKI => true,
3851 NS_MEDIAWIKI_TALK => true,
3852 NS_TEMPLATE_TALK => true,
3853 NS_HELP => true,
3854 NS_HELP_TALK => true,
3855 NS_CATEGORY_TALK => true
3859 * Array holding default tracking category names.
3861 * Array contains the system messages for each tracking category.
3862 * Tracking categories allow pages with certain characteristics to be tracked.
3863 * It works by adding any such page to a category automatically.
3865 * A message with the suffix '-desc' should be added as a description message
3866 * to have extra information on Special:TrackingCategories.
3868 * @deprecated since 1.25 Extensions should now register tracking categories using
3869 * the new extension registration system.
3871 * @since 1.23
3873 $wgTrackingCategories = array();
3876 * Array of namespaces which can be deemed to contain valid "content", as far
3877 * as the site statistics are concerned. Useful if additional namespaces also
3878 * contain "content" which should be considered when generating a count of the
3879 * number of articles in the wiki.
3881 $wgContentNamespaces = array( NS_MAIN );
3884 * Max number of redirects to follow when resolving redirects.
3885 * 1 means only the first redirect is followed (default behavior).
3886 * 0 or less means no redirects are followed.
3888 $wgMaxRedirects = 1;
3891 * Array of invalid page redirect targets.
3892 * Attempting to create a redirect to any of the pages in this array
3893 * will make the redirect fail.
3894 * Userlogout is hard-coded, so it does not need to be listed here.
3895 * (bug 10569) Disallow Mypage and Mytalk as well.
3897 * As of now, this only checks special pages. Redirects to pages in
3898 * other namespaces cannot be invalidated by this variable.
3900 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3902 /** @} */ # End of title and interwiki settings }
3904 /************************************************************************//**
3905 * @name Parser settings
3906 * These settings configure the transformation from wikitext to HTML.
3907 * @{
3911 * Parser configuration. Associative array with the following members:
3913 * class The class name
3915 * preprocessorClass The preprocessor class. Two classes are currently available:
3916 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3917 * storage, and Preprocessor_DOM, which uses the DOM module for
3918 * temporary storage. Preprocessor_DOM generally uses less memory;
3919 * the speed of the two is roughly the same.
3921 * If this parameter is not given, it uses Preprocessor_DOM if the
3922 * DOM module is available, otherwise it uses Preprocessor_Hash.
3924 * The entire associative array will be passed through to the constructor as
3925 * the first parameter. Note that only Setup.php can use this variable --
3926 * the configuration will change at runtime via $wgParser member functions, so
3927 * the contents of this variable will be out-of-date. The variable can only be
3928 * changed during LocalSettings.php, in particular, it can't be changed during
3929 * an extension setup function.
3931 $wgParserConf = array(
3932 'class' => 'Parser',
3933 #'preprocessorClass' => 'Preprocessor_Hash',
3937 * Maximum indent level of toc.
3939 $wgMaxTocLevel = 999;
3942 * A complexity limit on template expansion: the maximum number of nodes visited
3943 * by PPFrame::expand()
3945 $wgMaxPPNodeCount = 1000000;
3948 * A complexity limit on template expansion: the maximum number of elements
3949 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3950 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3951 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3952 * this default corresponds to about 155 MB.
3954 * When the limit is exceeded, an exception is thrown.
3956 $wgMaxGeneratedPPNodeCount = 1000000;
3959 * Maximum recursion depth for templates within templates.
3960 * The current parser adds two levels to the PHP call stack for each template,
3961 * and xdebug limits the call stack to 100 by default. So this should hopefully
3962 * stop the parser before it hits the xdebug limit.
3964 $wgMaxTemplateDepth = 40;
3967 * @see $wgMaxTemplateDepth
3969 $wgMaxPPExpandDepth = 40;
3972 * URL schemes that should be recognized as valid by wfParseUrl().
3974 * WARNING: Do not add 'file:' to this or internal file links will be broken.
3975 * Instead, if you want to support file links, add 'file://'. The same applies
3976 * to any other protocols with the same name as a namespace. See bug #44011 for
3977 * more information.
3979 * @see wfParseUrl
3981 $wgUrlProtocols = array(
3982 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3983 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3984 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3985 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3989 * If true, removes (substitutes) templates in "~~~~" signatures.
3991 $wgCleanSignatures = true;
3994 * Whether to allow inline image pointing to other websites
3996 $wgAllowExternalImages = false;
3999 * If the above is false, you can specify an exception here. Image URLs
4000 * that start with this string are then rendered, while all others are not.
4001 * You can use this to set up a trusted, simple repository of images.
4002 * You may also specify an array of strings to allow multiple sites
4004 * @par Examples:
4005 * @code
4006 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4007 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4008 * @endcode
4010 $wgAllowExternalImagesFrom = '';
4013 * If $wgAllowExternalImages is false, you can allow an on-wiki
4014 * whitelist of regular expression fragments to match the image URL
4015 * against. If the image matches one of the regular expression fragments,
4016 * The image will be displayed.
4018 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4019 * Or false to disable it
4021 $wgEnableImageWhitelist = true;
4024 * A different approach to the above: simply allow the "<img>" tag to be used.
4025 * This allows you to specify alt text and other attributes, copy-paste HTML to
4026 * your wiki more easily, etc. However, allowing external images in any manner
4027 * will allow anyone with editing rights to snoop on your visitors' IP
4028 * addresses and so forth, if they wanted to, by inserting links to images on
4029 * sites they control.
4031 $wgAllowImageTag = false;
4034 * $wgUseTidy: use tidy to make sure HTML output is sane.
4035 * Tidy is a free tool that fixes broken HTML.
4036 * See http://www.w3.org/People/Raggett/tidy/
4038 * - $wgTidyBin should be set to the path of the binary and
4039 * - $wgTidyConf to the path of the configuration file.
4040 * - $wgTidyOpts can include any number of parameters.
4041 * - $wgTidyInternal controls the use of the PECL extension or the
4042 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
4043 * of spawning a separate program.
4044 * Normally you shouldn't need to override the setting except for
4045 * debugging. To install, use 'pear install tidy' and add a line
4046 * 'extension=tidy.so' to php.ini.
4048 $wgUseTidy = false;
4051 * @see $wgUseTidy
4053 $wgAlwaysUseTidy = false;
4056 * @see $wgUseTidy
4058 $wgTidyBin = 'tidy';
4061 * @see $wgUseTidy
4063 $wgTidyConf = $IP . '/includes/tidy.conf';
4066 * @see $wgUseTidy
4068 $wgTidyOpts = '';
4071 * @see $wgUseTidy
4073 $wgTidyInternal = extension_loaded( 'tidy' );
4076 * Put tidy warnings in HTML comments
4077 * Only works for internal tidy.
4079 $wgDebugTidy = false;
4082 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4083 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4084 * TO RESTRICT EDITING to only those that you trust
4086 $wgRawHtml = false;
4089 * Set a default target for external links, e.g. _blank to pop up a new window
4091 $wgExternalLinkTarget = false;
4094 * If true, external URL links in wiki text will be given the
4095 * rel="nofollow" attribute as a hint to search engines that
4096 * they should not be followed for ranking purposes as they
4097 * are user-supplied and thus subject to spamming.
4099 $wgNoFollowLinks = true;
4102 * Namespaces in which $wgNoFollowLinks doesn't apply.
4103 * See Language.php for a list of namespaces.
4105 $wgNoFollowNsExceptions = array();
4108 * If this is set to an array of domains, external links to these domain names
4109 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4110 * value of $wgNoFollowLinks. For instance:
4112 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4113 * 'mediawiki.org' );
4115 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4116 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4117 * etc.
4119 * Defaults to mediawiki.org for the links included in the software by default.
4121 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4124 * Allow DISPLAYTITLE to change title display
4126 $wgAllowDisplayTitle = true;
4129 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4130 * canonical DB key. Also disallow some inline CSS rules like display: none;
4131 * which can cause the text to be hidden or unselectable.
4133 $wgRestrictDisplayTitle = true;
4136 * Maximum number of calls per parse to expensive parser functions such as
4137 * PAGESINCATEGORY.
4139 $wgExpensiveParserFunctionLimit = 100;
4142 * Preprocessor caching threshold
4143 * Setting it to 'false' will disable the preprocessor cache.
4145 $wgPreprocessorCacheThreshold = 1000;
4148 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4150 $wgEnableScaryTranscluding = false;
4153 * Expiry time for transcluded templates cached in transcache database table.
4154 * Only used $wgEnableInterwikiTranscluding is set to true.
4156 $wgTranscludeCacheExpiry = 3600;
4158 /** @} */ # end of parser settings }
4160 /************************************************************************//**
4161 * @name Statistics
4162 * @{
4166 * Method used to determine if a page in a content namespace should be counted
4167 * as a valid article.
4169 * Redirect pages will never be counted as valid articles.
4171 * This variable can have the following values:
4172 * - 'any': all pages as considered as valid articles
4173 * - 'comma': the page must contain a comma to be considered valid
4174 * - 'link': the page must contain a [[wiki link]] to be considered valid
4176 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4178 * Retroactively changing this variable will not affect the existing count,
4179 * to update it, you will need to run the maintenance/updateArticleCount.php
4180 * script.
4182 $wgArticleCountMethod = 'link';
4185 * How many days user must be idle before he is considered inactive. Will affect
4186 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4187 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4188 * You might want to leave this as the default value, to provide comparable
4189 * numbers between different wikis.
4191 $wgActiveUserDays = 30;
4193 /** @} */ # End of statistics }
4195 /************************************************************************//**
4196 * @name User accounts, authentication
4197 * @{
4201 * For compatibility with old installations set to false
4202 * @deprecated since 1.24 will be removed in future
4204 $wgPasswordSalt = true;
4207 * Specifies the minimal length of a user password. If set to 0, empty pass-
4208 * words are allowed.
4210 $wgMinimalPasswordLength = 1;
4213 * Specifies if users should be sent to a password-reset form on login, if their
4214 * password doesn't meet the requirements of User::isValidPassword().
4215 * @since 1.23
4217 $wgInvalidPasswordReset = true;
4220 * Default password type to use when hashing user passwords
4222 * @since 1.24
4224 $wgPasswordDefault = 'pbkdf2';
4227 * Configuration for built-in password types. Maps the password type
4228 * to an array of options. The 'class' option is the Password class to
4229 * use. All other options are class-dependent.
4231 * An advanced example:
4232 * @code
4233 * $wgPasswordConfig['bcrypt-peppered'] = array(
4234 * 'class' => 'EncryptedPassword',
4235 * 'underlying' => 'bcrypt',
4236 * 'secrets' => array(),
4237 * 'cipher' => MCRYPT_RIJNDAEL_256,
4238 * 'mode' => MCRYPT_MODE_CBC,
4239 * 'cost' => 5,
4240 * );
4241 * @endcode
4243 * @since 1.24
4245 $wgPasswordConfig = array(
4246 'A' => array(
4247 'class' => 'MWOldPassword',
4249 'B' => array(
4250 'class' => 'MWSaltedPassword',
4252 'pbkdf2-legacyA' => array(
4253 'class' => 'LayeredParameterizedPassword',
4254 'types' => array(
4255 'A',
4256 'pbkdf2',
4259 'pbkdf2-legacyB' => array(
4260 'class' => 'LayeredParameterizedPassword',
4261 'types' => array(
4262 'B',
4263 'pbkdf2',
4266 'bcrypt' => array(
4267 'class' => 'BcryptPassword',
4268 'cost' => 9,
4270 'pbkdf2' => array(
4271 'class' => 'Pbkdf2Password',
4272 'algo' => 'sha256',
4273 'cost' => '10000',
4274 'length' => '128',
4279 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4280 * with a temporary password you can use to get back into the account") identified by
4281 * various bits of data. Setting all of these to false (or the whole variable to false)
4282 * has the effect of disabling password resets entirely
4284 $wgPasswordResetRoutes = array(
4285 'username' => true,
4286 'email' => false,
4290 * Maximum number of Unicode characters in signature
4292 $wgMaxSigChars = 255;
4295 * Maximum number of bytes in username. You want to run the maintenance
4296 * script ./maintenance/checkUsernames.php once you have changed this value.
4298 $wgMaxNameChars = 255;
4301 * Array of usernames which may not be registered or logged in from
4302 * Maintenance scripts can still use these
4304 $wgReservedUsernames = array(
4305 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4306 'Conversion script', // Used for the old Wikipedia software upgrade
4307 'Maintenance script', // Maintenance scripts which perform editing, image import script
4308 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4309 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4310 'msg:double-redirect-fixer', // Automatic double redirect fix
4311 'msg:usermessage-editor', // Default user for leaving user messages
4312 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4316 * Settings added to this array will override the default globals for the user
4317 * preferences used by anonymous visitors and newly created accounts.
4318 * For instance, to disable editing on double clicks:
4319 * $wgDefaultUserOptions ['editondblclick'] = 0;
4321 $wgDefaultUserOptions = array(
4322 'ccmeonemails' => 0,
4323 'cols' => 80,
4324 'date' => 'default',
4325 'diffonly' => 0,
4326 'disablemail' => 0,
4327 'editfont' => 'default',
4328 'editondblclick' => 0,
4329 'editsectiononrightclick' => 0,
4330 'enotifminoredits' => 0,
4331 'enotifrevealaddr' => 0,
4332 'enotifusertalkpages' => 1,
4333 'enotifwatchlistpages' => 1,
4334 'extendwatchlist' => 1,
4335 'fancysig' => 0,
4336 'forceeditsummary' => 0,
4337 'gender' => 'unknown',
4338 'hideminor' => 0,
4339 'hidepatrolled' => 0,
4340 'imagesize' => 2,
4341 'math' => 1,
4342 'minordefault' => 0,
4343 'newpageshidepatrolled' => 0,
4344 'nickname' => '',
4345 'norollbackdiff' => 0,
4346 'numberheadings' => 0,
4347 'previewonfirst' => 0,
4348 'previewontop' => 1,
4349 'rcdays' => 7,
4350 'rclimit' => 50,
4351 'rows' => 25,
4352 'showhiddencats' => 0,
4353 'shownumberswatching' => 1,
4354 'showtoolbar' => 1,
4355 'skin' => false,
4356 'stubthreshold' => 0,
4357 'thumbsize' => 5,
4358 'underline' => 2,
4359 'uselivepreview' => 0,
4360 'usenewrc' => 1,
4361 'watchcreations' => 1,
4362 'watchdefault' => 1,
4363 'watchdeletion' => 0,
4364 'watchlistdays' => 3.0,
4365 'watchlisthideanons' => 0,
4366 'watchlisthidebots' => 0,
4367 'watchlisthideliu' => 0,
4368 'watchlisthideminor' => 0,
4369 'watchlisthideown' => 0,
4370 'watchlisthidepatrolled' => 0,
4371 'watchmoves' => 0,
4372 'watchrollback' => 0,
4373 'wllimit' => 250,
4374 'useeditwarning' => 1,
4375 'prefershttps' => 1,
4379 * An array of preferences to not show for the user
4381 $wgHiddenPrefs = array();
4384 * Characters to prevent during new account creations.
4385 * This is used in a regular expression character class during
4386 * registration (regex metacharacters like / are escaped).
4388 $wgInvalidUsernameCharacters = '@';
4391 * Character used as a delimiter when testing for interwiki userrights
4392 * (In Special:UserRights, it is possible to modify users on different
4393 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4395 * It is recommended that you have this delimiter in
4396 * $wgInvalidUsernameCharacters above, or you will not be able to
4397 * modify the user rights of those users via Special:UserRights
4399 $wgUserrightsInterwikiDelimiter = '@';
4402 * This is to let user authenticate using https when they come from http.
4403 * Based on an idea by George Herbert on wikitech-l:
4404 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4405 * @since 1.17
4407 $wgSecureLogin = false;
4409 /** @} */ # end user accounts }
4411 /************************************************************************//**
4412 * @name User rights, access control and monitoring
4413 * @{
4417 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4419 $wgAutoblockExpiry = 86400;
4422 * Set this to true to allow blocked users to edit their own user talk page.
4424 $wgBlockAllowsUTEdit = false;
4427 * Allow sysops to ban users from accessing Emailuser
4429 $wgSysopEmailBans = true;
4432 * Limits on the possible sizes of range blocks.
4434 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4435 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4436 * half the number of bits avoids such errors, and allows entire ISPs to be
4437 * blocked using a small number of range blocks.
4439 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4440 * customer, so range blocks larger than /64 (half the number of bits) will
4441 * plainly be required. RFC 4692 implies that a very large ISP may be
4442 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4443 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4445 $wgBlockCIDRLimit = array(
4446 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4447 'IPv6' => 19,
4451 * If true, blocked users will not be allowed to login. When using this with
4452 * a public wiki, the effect of logging out blocked users may actually be
4453 * avers: unless the user's address is also blocked (e.g. auto-block),
4454 * logging the user out will again allow reading and editing, just as for
4455 * anonymous visitors.
4457 $wgBlockDisablesLogin = false;
4460 * Pages anonymous user may see, set as an array of pages titles.
4462 * @par Example:
4463 * @code
4464 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4465 * @endcode
4467 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4469 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4470 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4472 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4473 * will remain readable. You can use img_auth.php to protect uploaded files,
4474 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4476 $wgWhitelistRead = false;
4479 * Pages anonymous user may see, set as an array of regular expressions.
4481 * This function will match the regexp against the title name, which
4482 * is without underscore.
4484 * @par Example:
4485 * To whitelist [[Main Page]]:
4486 * @code
4487 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4488 * @endcode
4490 * @note Unless ^ and/or $ is specified, a regular expression might match
4491 * pages not intended to be whitelisted. The above example will also
4492 * whitelist a page named 'Security Main Page'.
4494 * @par Example:
4495 * To allow reading any page starting with 'User' regardless of the case:
4496 * @code
4497 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4498 * @endcode
4499 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4501 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4502 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4504 $wgWhitelistReadRegexp = false;
4507 * Should editors be required to have a validated e-mail
4508 * address before being allowed to edit?
4510 $wgEmailConfirmToEdit = false;
4513 * Permission keys given to users in each group.
4515 * This is an array where the keys are all groups and each value is an
4516 * array of the format (right => boolean).
4518 * The second format is used to support per-namespace permissions.
4519 * Note that this feature does not fully work for all permission types.
4521 * All users are implicitly in the '*' group including anonymous visitors;
4522 * logged-in users are all implicitly in the 'user' group. These will be
4523 * combined with the permissions of all groups that a given user is listed
4524 * in in the user_groups table.
4526 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4527 * doing! This will wipe all permissions, and may mean that your users are
4528 * unable to perform certain essential tasks or access new functionality
4529 * when new permissions are introduced and default grants established.
4531 * Functionality to make pages inaccessible has not been extensively tested
4532 * for security. Use at your own risk!
4534 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4536 $wgGroupPermissions = array();
4538 /** @cond file_level_code */
4539 // Implicit group for all visitors
4540 $wgGroupPermissions['*']['createaccount'] = true;
4541 $wgGroupPermissions['*']['read'] = true;
4542 $wgGroupPermissions['*']['edit'] = true;
4543 $wgGroupPermissions['*']['createpage'] = true;
4544 $wgGroupPermissions['*']['createtalk'] = true;
4545 $wgGroupPermissions['*']['writeapi'] = true;
4546 $wgGroupPermissions['*']['editmyusercss'] = true;
4547 $wgGroupPermissions['*']['editmyuserjs'] = true;
4548 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4549 $wgGroupPermissions['*']['editmywatchlist'] = true;
4550 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4551 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4552 $wgGroupPermissions['*']['editmyoptions'] = true;
4553 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4555 // Implicit group for all logged-in accounts
4556 $wgGroupPermissions['user']['move'] = true;
4557 $wgGroupPermissions['user']['move-subpages'] = true;
4558 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4559 $wgGroupPermissions['user']['move-categorypages'] = true;
4560 $wgGroupPermissions['user']['movefile'] = true;
4561 $wgGroupPermissions['user']['read'] = true;
4562 $wgGroupPermissions['user']['edit'] = true;
4563 $wgGroupPermissions['user']['createpage'] = true;
4564 $wgGroupPermissions['user']['createtalk'] = true;
4565 $wgGroupPermissions['user']['writeapi'] = true;
4566 $wgGroupPermissions['user']['upload'] = true;
4567 $wgGroupPermissions['user']['reupload'] = true;
4568 $wgGroupPermissions['user']['reupload-shared'] = true;
4569 $wgGroupPermissions['user']['minoredit'] = true;
4570 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4571 $wgGroupPermissions['user']['sendemail'] = true;
4573 // Implicit group for accounts that pass $wgAutoConfirmAge
4574 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4575 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4577 // Users with bot privilege can have their edits hidden
4578 // from various log pages by default
4579 $wgGroupPermissions['bot']['bot'] = true;
4580 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4581 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4582 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4583 $wgGroupPermissions['bot']['autopatrol'] = true;
4584 $wgGroupPermissions['bot']['suppressredirect'] = true;
4585 $wgGroupPermissions['bot']['apihighlimits'] = true;
4586 $wgGroupPermissions['bot']['writeapi'] = true;
4588 // Most extra permission abilities go to this group
4589 $wgGroupPermissions['sysop']['block'] = true;
4590 $wgGroupPermissions['sysop']['createaccount'] = true;
4591 $wgGroupPermissions['sysop']['delete'] = true;
4592 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4593 $wgGroupPermissions['sysop']['bigdelete'] = true;
4594 // can view deleted history entries, but not see or restore the text
4595 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4596 // can view deleted revision text
4597 $wgGroupPermissions['sysop']['deletedtext'] = true;
4598 $wgGroupPermissions['sysop']['undelete'] = true;
4599 $wgGroupPermissions['sysop']['editinterface'] = true;
4600 $wgGroupPermissions['sysop']['editusercss'] = true;
4601 $wgGroupPermissions['sysop']['edituserjs'] = true;
4602 $wgGroupPermissions['sysop']['import'] = true;
4603 $wgGroupPermissions['sysop']['importupload'] = true;
4604 $wgGroupPermissions['sysop']['move'] = true;
4605 $wgGroupPermissions['sysop']['move-subpages'] = true;
4606 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4607 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4608 $wgGroupPermissions['sysop']['patrol'] = true;
4609 $wgGroupPermissions['sysop']['autopatrol'] = true;
4610 $wgGroupPermissions['sysop']['protect'] = true;
4611 $wgGroupPermissions['sysop']['editprotected'] = true;
4612 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4613 $wgGroupPermissions['sysop']['rollback'] = true;
4614 $wgGroupPermissions['sysop']['upload'] = true;
4615 $wgGroupPermissions['sysop']['reupload'] = true;
4616 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4617 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4618 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4619 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4620 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4621 $wgGroupPermissions['sysop']['blockemail'] = true;
4622 $wgGroupPermissions['sysop']['markbotedits'] = true;
4623 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4624 $wgGroupPermissions['sysop']['browsearchive'] = true;
4625 $wgGroupPermissions['sysop']['noratelimit'] = true;
4626 $wgGroupPermissions['sysop']['movefile'] = true;
4627 $wgGroupPermissions['sysop']['unblockself'] = true;
4628 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4629 #$wgGroupPermissions['sysop']['pagelang'] = true;
4630 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4631 $wgGroupPermissions['sysop']['mergehistory'] = true;
4632 $wgGroupPermissions['sysop']['managechangetags'] = true;
4634 // Permission to change users' group assignments
4635 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4636 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4637 // Permission to change users' groups assignments across wikis
4638 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4639 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4640 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4642 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4643 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4644 // To hide usernames from users and Sysops
4645 #$wgGroupPermissions['suppress']['hideuser'] = true;
4646 // To hide revisions/log items from users and Sysops
4647 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4648 // To view revisions/log items hidden from users and Sysops
4649 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4650 // For private suppression log access
4651 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4654 * The developer group is deprecated, but can be activated if need be
4655 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4656 * that a lock file be defined and creatable/removable by the web
4657 * server.
4659 # $wgGroupPermissions['developer']['siteadmin'] = true;
4661 /** @endcond */
4664 * Permission keys revoked from users in each group.
4666 * This acts the same way as wgGroupPermissions above, except that
4667 * if the user is in a group here, the permission will be removed from them.
4669 * Improperly setting this could mean that your users will be unable to perform
4670 * certain essential tasks, so use at your own risk!
4672 $wgRevokePermissions = array();
4675 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4677 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4680 * A map of group names that the user is in, to group names that those users
4681 * are allowed to add or revoke.
4683 * Setting the list of groups to add or revoke to true is equivalent to "any
4684 * group".
4686 * @par Example:
4687 * To allow sysops to add themselves to the "bot" group:
4688 * @code
4689 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4690 * @endcode
4692 * @par Example:
4693 * Implicit groups may be used for the source group, for instance:
4694 * @code
4695 * $wgGroupsRemoveFromSelf = array( '*' => true );
4696 * @endcode
4697 * This allows users in the '*' group (i.e. any user) to remove themselves from
4698 * any group that they happen to be in.
4700 $wgGroupsAddToSelf = array();
4703 * @see $wgGroupsAddToSelf
4705 $wgGroupsRemoveFromSelf = array();
4708 * Set of available actions that can be restricted via action=protect
4709 * You probably shouldn't change this.
4710 * Translated through restriction-* messages.
4711 * Title::getRestrictionTypes() will remove restrictions that are not
4712 * applicable to a specific title (create and upload)
4714 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4717 * Rights which can be required for each protection level (via action=protect)
4719 * You can add a new protection level that requires a specific
4720 * permission by manipulating this array. The ordering of elements
4721 * dictates the order on the protection form's lists.
4723 * - '' will be ignored (i.e. unprotected)
4724 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4725 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4727 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4730 * Restriction levels that can be used with cascading protection
4732 * A page can only be protected with cascading protection if the
4733 * requested restriction level is included in this array.
4735 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4736 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4738 $wgCascadingRestrictionLevels = array( 'sysop' );
4741 * Restriction levels that should be considered "semiprotected"
4743 * Certain places in the interface recognize a dichotomy between "protected"
4744 * and "semiprotected", without further distinguishing the specific levels. In
4745 * general, if anyone can be eligible to edit a protection level merely by
4746 * reaching some condition in $wgAutopromote, it should probably be considered
4747 * "semiprotected".
4749 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4750 * 'sysop' is not changed, since it really shouldn't be here.
4752 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4755 * Set the minimum permissions required to edit pages in each
4756 * namespace. If you list more than one permission, a user must
4757 * have all of them to edit pages in that namespace.
4759 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4761 $wgNamespaceProtection = array();
4764 * Pages in namespaces in this array can not be used as templates.
4766 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4767 * namespaces constants (NS_USER, NS_MAIN...).
4769 * Among other things, this may be useful to enforce read-restrictions
4770 * which may otherwise be bypassed by using the template mechanism.
4772 $wgNonincludableNamespaces = array();
4775 * Number of seconds an account is required to age before it's given the
4776 * implicit 'autoconfirm' group membership. This can be used to limit
4777 * privileges of new accounts.
4779 * Accounts created by earlier versions of the software may not have a
4780 * recorded creation date, and will always be considered to pass the age test.
4782 * When left at 0, all registered accounts will pass.
4784 * @par Example:
4785 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4786 * @code
4787 * $wgAutoConfirmAge = 600; // ten minutes
4788 * @endcode
4789 * Set age to one day:
4790 * @code
4791 * $wgAutoConfirmAge = 3600*24; // one day
4792 * @endcode
4794 $wgAutoConfirmAge = 0;
4797 * Number of edits an account requires before it is autoconfirmed.
4798 * Passing both this AND the time requirement is needed. Example:
4800 * @par Example:
4801 * @code
4802 * $wgAutoConfirmCount = 50;
4803 * @endcode
4805 $wgAutoConfirmCount = 0;
4808 * Automatically add a usergroup to any user who matches certain conditions.
4810 * @todo Redocument $wgAutopromote
4812 * The format is
4813 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4814 * where cond1, cond2, ... are themselves conditions; *OR*
4815 * APCOND_EMAILCONFIRMED, *OR*
4816 * array( APCOND_EMAILCONFIRMED ), *OR*
4817 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4818 * array( APCOND_AGE, seconds since registration ), *OR*
4819 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4820 * array( APCOND_ISIP, ip ), *OR*
4821 * array( APCOND_IPINRANGE, range ), *OR*
4822 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4823 * array( APCOND_BLOCKED ), *OR*
4824 * array( APCOND_ISBOT ), *OR*
4825 * similar constructs defined by extensions.
4827 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4828 * user who has provided an e-mail address.
4830 $wgAutopromote = array(
4831 'autoconfirmed' => array( '&',
4832 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4833 array( APCOND_AGE, &$wgAutoConfirmAge ),
4838 * Automatically add a usergroup to any user who matches certain conditions.
4840 * Does not add the user to the group again if it has been removed.
4841 * Also, does not remove the group if the user no longer meets the criteria.
4843 * The format is:
4844 * @code
4845 * array( event => criteria, ... )
4846 * @endcode
4847 * Where event is either:
4848 * - 'onEdit' (when user edits)
4849 * - 'onView' (when user views the wiki)
4851 * Criteria has the same format as $wgAutopromote
4853 * @see $wgAutopromote
4854 * @since 1.18
4856 $wgAutopromoteOnce = array(
4857 'onEdit' => array(),
4858 'onView' => array()
4862 * Put user rights log entries for autopromotion in recent changes?
4863 * @since 1.18
4865 $wgAutopromoteOnceLogInRC = true;
4868 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4869 * can assign which groups at Special:Userrights.
4871 * @par Example:
4872 * Bureaucrats can add any group:
4873 * @code
4874 * $wgAddGroups['bureaucrat'] = true;
4875 * @endcode
4876 * Bureaucrats can only remove bots and sysops:
4877 * @code
4878 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4879 * @endcode
4880 * Sysops can make bots:
4881 * @code
4882 * $wgAddGroups['sysop'] = array( 'bot' );
4883 * @endcode
4884 * Sysops can disable other sysops in an emergency, and disable bots:
4885 * @code
4886 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4887 * @endcode
4889 $wgAddGroups = array();
4892 * @see $wgAddGroups
4894 $wgRemoveGroups = array();
4897 * A list of available rights, in addition to the ones defined by the core.
4898 * For extensions only.
4900 $wgAvailableRights = array();
4903 * Optional to restrict deletion of pages with higher revision counts
4904 * to users with the 'bigdelete' permission. (Default given to sysops.)
4906 $wgDeleteRevisionsLimit = 0;
4909 * The maximum number of edits a user can have and
4910 * can still be hidden by users with the hideuser permission.
4911 * This is limited for performance reason.
4912 * Set to false to disable the limit.
4913 * @since 1.23
4915 $wgHideUserContribLimit = 1000;
4918 * Number of accounts each IP address may create, 0 to disable.
4920 * @warning Requires memcached
4922 $wgAccountCreationThrottle = 0;
4925 * Edits matching these regular expressions in body text
4926 * will be recognised as spam and rejected automatically.
4928 * There's no administrator override on-wiki, so be careful what you set. :)
4929 * May be an array of regexes or a single string for backwards compatibility.
4931 * @see http://en.wikipedia.org/wiki/Regular_expression
4933 * @note Each regex needs a beginning/end delimiter, eg: # or /
4935 $wgSpamRegex = array();
4938 * Same as the above except for edit summaries
4940 $wgSummarySpamRegex = array();
4943 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4944 * proxies
4945 * @since 1.16
4947 $wgEnableDnsBlacklist = false;
4950 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4952 * This is an array of either a URL or an array with the URL and a key (should
4953 * the blacklist require a key).
4955 * @par Example:
4956 * @code
4957 * $wgDnsBlacklistUrls = array(
4958 * // String containing URL
4959 * 'http.dnsbl.sorbs.net.',
4960 * // Array with URL and key, for services that require a key
4961 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4962 * // Array with just the URL. While this works, it is recommended that you
4963 * // just use a string as shown above
4964 * array( 'opm.tornevall.org.' )
4965 * );
4966 * @endcode
4968 * @note You should end the domain name with a . to avoid searching your
4969 * eventual domain search suffixes.
4970 * @since 1.16
4972 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4975 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4976 * what the other methods might say.
4978 $wgProxyWhitelist = array();
4981 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4982 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4983 * (transparent) proxies without needing to block the proxies themselves.
4985 $wgApplyIpBlocksToXff = false;
4988 * Simple rate limiter options to brake edit floods.
4990 * Maximum number actions allowed in the given number of seconds; after that
4991 * the violating client receives HTTP 500 error pages until the period
4992 * elapses.
4994 * @par Example:
4995 * To set a generic maximum of 4 hits in 60 seconds:
4996 * @code
4997 * $wgRateLimits = array( 4, 60 );
4998 * @endcode
5000 * You could also limit per action and then type of users. See the inline
5001 * code for a template to use.
5003 * This option set is experimental and likely to change.
5005 * @warning Requires memcached.
5007 $wgRateLimits = array(
5008 'edit' => array(
5009 'anon' => null, // for any and all anonymous edits (aggregate)
5010 'user' => null, // for each logged-in user
5011 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
5012 'ip' => null, // for each anon and recent account
5013 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
5015 'move' => array(
5016 'user' => null,
5017 'newbie' => null,
5018 'ip' => null,
5019 'subnet' => null,
5021 'mailpassword' => array( // triggering password resets emails
5022 'anon' => null,
5024 'emailuser' => array( // emailing other users using MediaWiki
5025 'user' => null,
5027 'linkpurge' => array( // purges of link tables
5028 'anon' => null,
5029 'user' => null,
5030 'newbie' => null,
5031 'ip' => null,
5032 'subnet' => null,
5034 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
5035 'anon' => null,
5036 'user' => null,
5037 'newbie' => null,
5038 'ip' => null,
5039 'subnet' => null,
5041 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
5042 'anon' => null,
5043 'user' => null,
5044 'newbie' => null,
5045 'ip' => null,
5046 'subnet' => null,
5048 'stashedit' => array( // stashing edits into cache before save
5049 'anon' => null,
5050 'user' => null,
5051 'newbie' => null,
5052 'ip' => null,
5053 'subnet' => null,
5058 * Set to a filename to log rate limiter hits.
5060 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
5062 $wgRateLimitLog = null;
5065 * Array of IPs which should be excluded from rate limits.
5066 * This may be useful for whitelisting NAT gateways for conferences, etc.
5068 $wgRateLimitsExcludedIPs = array();
5071 * Log IP addresses in the recentchanges table; can be accessed only by
5072 * extensions (e.g. CheckUser) or a DB admin
5073 * Used for retroactive autoblocks
5075 $wgPutIPinRC = true;
5078 * Integer defining default number of entries to show on
5079 * special pages which are query-pages such as Special:Whatlinkshere.
5081 $wgQueryPageDefaultLimit = 50;
5084 * Limit password attempts to X attempts per Y seconds per IP per account.
5086 * @warning Requires memcached.
5088 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5090 /** @} */ # end of user rights settings
5092 /************************************************************************//**
5093 * @name Proxy scanner settings
5094 * @{
5098 * This should always be customised in LocalSettings.php
5100 $wgSecretKey = false;
5103 * Big list of banned IP addresses.
5105 * This can have the following formats:
5106 * - An array of addresses, either in the values
5107 * or the keys (for backward compatibility)
5108 * - A string, in that case this is the path to a file
5109 * containing the list of IP addresses, one per line
5111 $wgProxyList = array();
5113 /** @} */ # end of proxy scanner settings
5115 /************************************************************************//**
5116 * @name Cookie settings
5117 * @{
5121 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5123 $wgCookieExpiration = 180 * 86400;
5126 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5127 * or ".any.subdomain.net"
5129 $wgCookieDomain = '';
5132 * Set this variable if you want to restrict cookies to a certain path within
5133 * the domain specified by $wgCookieDomain.
5135 $wgCookiePath = '/';
5138 * Whether the "secure" flag should be set on the cookie. This can be:
5139 * - true: Set secure flag
5140 * - false: Don't set secure flag
5141 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5143 $wgCookieSecure = 'detect';
5146 * By default, MediaWiki checks if the client supports cookies during the
5147 * login process, so that it can display an informative error message if
5148 * cookies are disabled. Set this to true if you want to disable this cookie
5149 * check.
5151 $wgDisableCookieCheck = false;
5154 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5155 * to a string to use a custom prefix. Setting it to false causes the database
5156 * name to be used as a prefix.
5158 $wgCookiePrefix = false;
5161 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5162 * in browsers that support this feature. This can mitigates some classes of
5163 * XSS attack.
5165 $wgCookieHttpOnly = true;
5168 * A list of cookies that vary the cache (for use by extensions)
5170 $wgCacheVaryCookies = array();
5173 * Override to customise the session name
5175 $wgSessionName = false;
5177 /** @} */ # end of cookie settings }
5179 /************************************************************************//**
5180 * @name LaTeX (mathematical formulas)
5181 * @{
5185 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5186 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5187 * (ImageMagick) installed and available in the PATH.
5188 * Please see math/README for more information.
5190 $wgUseTeX = false;
5192 /** @} */ # end LaTeX }
5194 /************************************************************************//**
5195 * @name Profiling, testing and debugging
5197 * To enable profiling, edit StartProfiler.php
5199 * @{
5203 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5204 * The debug log file should be not be publicly accessible if it is used, as it
5205 * may contain private data.
5207 $wgDebugLogFile = '';
5210 * Prefix for debug log lines
5212 $wgDebugLogPrefix = '';
5215 * If true, instead of redirecting, show a page with a link to the redirect
5216 * destination. This allows for the inspection of PHP error messages, and easy
5217 * resubmission of form data. For developer use only.
5219 $wgDebugRedirects = false;
5222 * If true, log debugging data from action=raw and load.php.
5223 * This is normally false to avoid overlapping debug entries due to gen=css
5224 * and gen=js requests.
5226 $wgDebugRawPage = false;
5229 * Send debug data to an HTML comment in the output.
5231 * This may occasionally be useful when supporting a non-technical end-user.
5232 * It's more secure than exposing the debug log file to the web, since the
5233 * output only contains private data for the current user. But it's not ideal
5234 * for development use since data is lost on fatal errors and redirects.
5236 $wgDebugComments = false;
5239 * Extensive database transaction state debugging
5241 * @since 1.20
5243 $wgDebugDBTransactions = false;
5246 * Write SQL queries to the debug log.
5248 * This setting is only used $wgLBFactoryConf['class'] is set to
5249 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5250 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5251 * connection to achieve the same functionality.
5253 $wgDebugDumpSql = false;
5256 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5257 * trimming.
5258 * @since 1.24
5260 $wgDebugDumpSqlLength = 500;
5263 * Map of string log group names to log destinations.
5265 * If set, wfDebugLog() output for that group will go to that file instead
5266 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5267 * in production.
5269 * Log destinations may be one of the following:
5270 * - false to completely remove from the output, including from $wgDebugLogFile.
5271 * - string values specifying a filename or URI.
5272 * - associative array with keys:
5273 * - 'destination' desired filename or URI.
5274 * - 'sample' an integer value, specifying a sampling factor (optional)
5275 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5276 * to log (optional, since 1.25)
5278 * @par Example:
5279 * @code
5280 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5281 * @endcode
5283 * @par Advanced example:
5284 * @code
5285 * $wgDebugLogGroups['memcached'] = array(
5286 * 'destination' => '/var/log/mediawiki/memcached.log',
5287 * 'sample' => 1000, // log 1 message out of every 1,000.
5288 * 'level' => \Psr\Log\LogLevel::WARNING
5289 * );
5290 * @endcode
5292 $wgDebugLogGroups = array();
5295 * Default service provider for creating Psr\Log\LoggerInterface instances.
5297 * The value should be an array suitable for use with
5298 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5299 * implement the MWLoggerSpi interface. See ObjectFactory for additional
5300 * details.
5302 * Alternately the MWLoggerFactory::registerProvider method can be called to
5303 * inject an MWLoggerSpi instance into MWLoggerFactory and bypass the use of
5304 * this configuration variable entirely.
5306 * @since 1.25
5307 * @var array $wgMWLoggerDefaultSpi
5308 * @see MwLogger
5310 $wgMWLoggerDefaultSpi = array(
5311 'class' => 'MWLoggerLegacySpi',
5315 * Display debug data at the bottom of the main content area.
5317 * Useful for developers and technical users trying to working on a closed wiki.
5319 $wgShowDebug = false;
5322 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5323 * Since 1.19 also includes memory usage.
5325 $wgDebugTimestamps = false;
5328 * Print HTTP headers for every request in the debug information.
5330 $wgDebugPrintHttpHeaders = true;
5333 * Show the contents of $wgHooks in Special:Version
5335 $wgSpecialVersionShowHooks = false;
5338 * Whether to show "we're sorry, but there has been a database error" pages.
5339 * Displaying errors aids in debugging, but may display information useful
5340 * to an attacker.
5342 $wgShowSQLErrors = false;
5345 * If set to true, uncaught exceptions will print a complete stack trace
5346 * to output. This should only be used for debugging, as it may reveal
5347 * private information in function parameters due to PHP's backtrace
5348 * formatting.
5350 $wgShowExceptionDetails = false;
5353 * If true, show a backtrace for database errors
5355 * @note This setting only applies when connection errors and query errors are
5356 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5357 * including those in which an uncaught exception is thrown from within the
5358 * exception handler.
5360 $wgShowDBErrorBacktrace = false;
5363 * If true, send the exception backtrace to the error log
5365 $wgLogExceptionBacktrace = true;
5368 * Expose backend server host names through the API and various HTML comments
5370 $wgShowHostnames = false;
5373 * Override server hostname detection with a hardcoded value.
5374 * Should be a string, default false.
5375 * @since 1.20
5377 $wgOverrideHostname = false;
5380 * If set to true MediaWiki will throw notices for some possible error
5381 * conditions and for deprecated functions.
5383 $wgDevelopmentWarnings = false;
5386 * Release limitation to wfDeprecated warnings, if set to a release number
5387 * development warnings will not be generated for deprecations added in releases
5388 * after the limit.
5390 $wgDeprecationReleaseLimit = false;
5393 * Only record profiling info for pages that took longer than this
5395 $wgProfileLimit = 0.0;
5398 * Don't put non-profiling info into log file
5400 * @deprecated since 1.23, set the log file in
5401 * $wgDebugLogGroups['profileoutput'] instead.
5403 $wgProfileOnly = false;
5406 * If true, print a raw call tree instead of per-function report
5408 $wgProfileCallTree = false;
5411 * Should application server host be put into profiling table
5413 * @deprecated set $wgProfiler['perhost'] = true instead
5415 $wgProfilePerHost = null;
5418 * Host for UDP profiler.
5420 * The host should be running a daemon which can be obtained from MediaWiki
5421 * Git at:
5422 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5424 * @deprecated set $wgProfiler['udphost'] instead
5426 $wgUDPProfilerHost = null;
5429 * Port for UDP profiler.
5430 * @see $wgUDPProfilerHost
5432 * @deprecated set $wgProfiler['udpport'] instead
5434 $wgUDPProfilerPort = null;
5437 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5438 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5439 * arguments. You can use sprintf's argument numbering/swapping capability to
5440 * repeat, re-order or omit fields.
5442 * @see $wgStatsFormatString
5443 * @since 1.22
5445 * @deprecated set $wgProfiler['udpformat'] instead
5447 $wgUDPProfilerFormatString = null;
5450 * Destination for wfIncrStats() data...
5451 * 'cache' to go into the system cache, if enabled (memcached)
5452 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5453 * false to disable
5455 $wgStatsMethod = 'cache';
5458 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5459 * be aggregated over more than one wiki. The string will be used in place of
5460 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5461 * will be used.
5463 $wgAggregateStatsID = false;
5466 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5467 * formatted. Its value should be a format string suitable for a sprintf()
5468 * invocation with (id, count, key) arguments, where 'id' is either
5469 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5470 * is being incremented, and 'key' is the metric name.
5472 * @see $wgUDPProfilerFormatString
5473 * @see $wgAggregateStatsID
5474 * @since 1.22
5476 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5479 * InfoAction retrieves a list of transclusion links (both to and from).
5480 * This number puts a limit on that query in the case of highly transcluded
5481 * templates.
5483 $wgPageInfoTransclusionLimit = 50;
5486 * Set this to an integer to only do synchronous site_stats updates
5487 * one every *this many* updates. The other requests go into pending
5488 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5489 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5491 $wgSiteStatsAsyncFactor = false;
5494 * Parser test suite files to be run by parserTests.php when no specific
5495 * filename is passed to it.
5497 * Extensions may add their own tests to this array, or site-local tests
5498 * may be added via LocalSettings.php
5500 * Use full paths.
5502 $wgParserTestFiles = array(
5503 "$IP/tests/parser/parserTests.txt",
5504 "$IP/tests/parser/extraParserTests.txt"
5508 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5510 $wgEnableJavaScriptTest = false;
5513 * Overwrite the caching key prefix with custom value.
5514 * @since 1.19
5516 $wgCachePrefix = false;
5519 * Display the new debugging toolbar. This also enables profiling on database
5520 * queries and other useful output.
5521 * Will disable file cache.
5523 * @since 1.19
5525 $wgDebugToolbar = false;
5527 /** @} */ # end of profiling, testing and debugging }
5529 /************************************************************************//**
5530 * @name Search
5531 * @{
5535 * Set this to true to disable the full text search feature.
5537 $wgDisableTextSearch = false;
5540 * Set to true to have nicer highlighted text in search results,
5541 * by default off due to execution overhead
5543 $wgAdvancedSearchHighlighting = false;
5546 * Regexp to match word boundaries, defaults for non-CJK languages
5547 * should be empty for CJK since the words are not separate
5549 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5552 * Template for OpenSearch suggestions, defaults to API action=opensearch
5554 * Sites with heavy load would typically have these point to a custom
5555 * PHP wrapper to avoid firing up mediawiki for every keystroke
5557 * Placeholders: {searchTerms}
5559 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5561 $wgOpenSearchTemplate = false;
5564 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5566 * Sites with heavy load would typically have these point to a custom
5567 * PHP wrapper to avoid firing up mediawiki for every keystroke
5569 * Placeholders: {searchTerms}
5571 $wgOpenSearchTemplates = array(
5572 'application/x-suggestions+json' => false,
5573 'application/x-suggestions+xml' => false,
5577 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5578 * false if you've disabled scripts that use api?action=opensearch and
5579 * want reduce load caused by cached scripts still pulling suggestions.
5580 * It will let the API fallback by responding with an empty array.
5582 $wgEnableOpenSearchSuggest = true;
5585 * Integer defining default number of entries to show on
5586 * OpenSearch call.
5588 $wgOpenSearchDefaultLimit = 10;
5591 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
5593 $wgOpenSearchDescriptionLength = 100;
5596 * Expiry time for search suggestion responses
5598 $wgSearchSuggestCacheExpiry = 1200;
5601 * If you've disabled search semi-permanently, this also disables updates to the
5602 * table. If you ever re-enable, be sure to rebuild the search table.
5604 $wgDisableSearchUpdate = false;
5607 * List of namespaces which are searched by default.
5609 * @par Example:
5610 * @code
5611 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5612 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5613 * @endcode
5615 $wgNamespacesToBeSearchedDefault = array(
5616 NS_MAIN => true,
5620 * Disable the internal MySQL-based search, to allow it to be
5621 * implemented by an extension instead.
5623 $wgDisableInternalSearch = false;
5626 * Set this to a URL to forward search requests to some external location.
5627 * If the URL includes '$1', this will be replaced with the URL-encoded
5628 * search term.
5630 * @par Example:
5631 * To forward to Google you'd have something like:
5632 * @code
5633 * $wgSearchForwardUrl =
5634 * 'http://www.google.com/search?q=$1' .
5635 * '&domains=http://example.com' .
5636 * '&sitesearch=http://example.com' .
5637 * '&ie=utf-8&oe=utf-8';
5638 * @endcode
5640 $wgSearchForwardUrl = null;
5643 * Search form behavior.
5644 * - true = use Go & Search buttons
5645 * - false = use Go button & Advanced search link
5647 $wgUseTwoButtonsSearchForm = true;
5650 * Array of namespaces to generate a Google sitemap for when the
5651 * maintenance/generateSitemap.php script is run, or false if one is to be
5652 * generated for all namespaces.
5654 $wgSitemapNamespaces = false;
5657 * Custom namespace priorities for sitemaps. Setting this will allow you to
5658 * set custom priorities to namespaces when sitemaps are generated using the
5659 * maintenance/generateSitemap.php script.
5661 * This should be a map of namespace IDs to priority
5662 * @par Example:
5663 * @code
5664 * $wgSitemapNamespacesPriorities = array(
5665 * NS_USER => '0.9',
5666 * NS_HELP => '0.0',
5667 * );
5668 * @endcode
5670 $wgSitemapNamespacesPriorities = false;
5673 * If true, searches for IP addresses will be redirected to that IP's
5674 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5675 * [[Special:Contributions/1.2.3.4]]
5677 $wgEnableSearchContributorsByIP = true;
5679 /** @} */ # end of search settings
5681 /************************************************************************//**
5682 * @name Edit user interface
5683 * @{
5687 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5688 * fall back to the old behavior (no merging).
5690 $wgDiff3 = '/usr/bin/diff3';
5693 * Path to the GNU diff utility.
5695 $wgDiff = '/usr/bin/diff';
5698 * Which namespaces have special treatment where they should be preview-on-open
5699 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5700 * can specify namespaces of pages they have special treatment for
5702 $wgPreviewOnOpenNamespaces = array(
5703 NS_CATEGORY => true
5707 * Enable the UniversalEditButton for browsers that support it
5708 * (currently only Firefox with an extension)
5709 * See http://universaleditbutton.org for more background information
5711 $wgUniversalEditButton = true;
5714 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5715 * will try to automatically create one. This feature can be disabled by set-
5716 * ting this variable false.
5718 $wgUseAutomaticEditSummaries = true;
5720 /** @} */ # end edit UI }
5722 /************************************************************************//**
5723 * @name Maintenance
5724 * See also $wgSiteNotice
5725 * @{
5729 * @cond file_level_code
5730 * Set $wgCommandLineMode if it's not set already, to avoid notices
5732 if ( !isset( $wgCommandLineMode ) ) {
5733 $wgCommandLineMode = false;
5735 /** @endcond */
5738 * For colorized maintenance script output, is your terminal background dark ?
5740 $wgCommandLineDarkBg = false;
5743 * Set this to a string to put the wiki into read-only mode. The text will be
5744 * used as an explanation to users.
5746 * This prevents most write operations via the web interface. Cache updates may
5747 * still be possible. To prevent database writes completely, use the read_only
5748 * option in MySQL.
5750 $wgReadOnly = null;
5753 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5754 * Its contents will be shown to users as part of the read-only warning
5755 * message.
5757 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5759 $wgReadOnlyFile = false;
5762 * When you run the web-based upgrade utility, it will tell you what to set
5763 * this to in order to authorize the upgrade process. It will subsequently be
5764 * used as a password, to authorize further upgrades.
5766 * For security, do not set this to a guessable string. Use the value supplied
5767 * by the install/upgrade process. To cause the upgrader to generate a new key,
5768 * delete the old key from LocalSettings.php.
5770 $wgUpgradeKey = false;
5773 * Fully specified path to git binary
5775 $wgGitBin = '/usr/bin/git';
5778 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5780 * Key is a pattern passed to preg_match() and preg_replace(),
5781 * without the delimiters (which are #) and must match the whole URL.
5782 * The value is the replacement for the key (it can contain $1, etc.)
5783 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5784 * full SHA-1 of the HEAD revision.
5785 * %r will be replaced with a URL-encoded version of $1.
5787 * @since 1.20
5789 $wgGitRepositoryViewers = array(
5790 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5791 'https://git.wikimedia.org/tree/%r/%H',
5792 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5793 'https://git.wikimedia.org/tree/%r/%H',
5796 /** @} */ # End of maintenance }
5798 /************************************************************************//**
5799 * @name Recent changes, new pages, watchlist and history
5800 * @{
5804 * Recentchanges items are periodically purged; entries older than this many
5805 * seconds will go.
5806 * Default: 90 days = about three months
5808 $wgRCMaxAge = 90 * 24 * 3600;
5811 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5812 * higher than what will be stored. Note that this is disabled by default
5813 * because we sometimes do have RC data which is beyond the limit for some
5814 * reason, and some users may use the high numbers to display that data which
5815 * is still there.
5817 $wgRCFilterByAge = false;
5820 * List of Limits options to list in the Special:Recentchanges and
5821 * Special:Recentchangeslinked pages.
5823 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5826 * List of Days options to list in the Special:Recentchanges and
5827 * Special:Recentchangeslinked pages.
5829 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5832 * Destinations to which notifications about recent changes
5833 * should be sent.
5835 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5836 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5837 * specified server.
5838 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5840 * The common options are:
5841 * * 'uri' -- the address to which the notices are to be sent.
5842 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5843 * produce the text to send. This can also be an object of the class.
5844 * * 'omit_bots' -- whether the bot edits should be in the feed
5845 * * 'omit_anon' -- whether anonymous edits should be in the feed
5846 * * 'omit_user' -- whether edits by registered users should be in the feed
5847 * * 'omit_minor' -- whether minor edits should be in the feed
5848 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5850 * The IRC-specific options are:
5851 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5852 * the first entry in the $wgLocalInterwikis array (or the value of
5853 * $wgLocalInterwiki, if set)
5855 * The JSON-specific options are:
5856 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5858 * @example $wgRCFeeds['example'] = array(
5859 * 'formatter' => 'JSONRCFeedFormatter',
5860 * 'uri' => "udp://localhost:1336",
5861 * 'add_interwiki_prefix' => false,
5862 * 'omit_bots' => true,
5863 * );
5864 * @example $wgRCFeeds['exampleirc'] = array(
5865 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5866 * 'uri' => "udp://localhost:1338",
5867 * 'add_interwiki_prefix' => false,
5868 * 'omit_bots' => true,
5869 * );
5870 * @since 1.22
5872 $wgRCFeeds = array();
5875 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5876 * Keys are scheme names, values are names of engine classes.
5878 $wgRCEngines = array(
5879 'redis' => 'RedisPubSubFeedEngine',
5880 'udp' => 'UDPRCFeedEngine',
5884 * Use RC Patrolling to check for vandalism
5886 $wgUseRCPatrol = true;
5889 * Use new page patrolling to check new pages on Special:Newpages
5891 $wgUseNPPatrol = true;
5894 * Log autopatrol actions to the log table
5896 $wgLogAutopatrol = true;
5899 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5901 $wgFeed = true;
5904 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5905 * eg Recentchanges, Newpages.
5907 $wgFeedLimit = 50;
5910 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5911 * A cached version will continue to be served out even if changes
5912 * are made, until this many seconds runs out since the last render.
5914 * If set to 0, feed caching is disabled. Use this for debugging only;
5915 * feed generation can be pretty slow with diffs.
5917 $wgFeedCacheTimeout = 60;
5920 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5921 * pages larger than this size.
5923 $wgFeedDiffCutoff = 32768;
5926 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5927 * every page. Some sites might have a different feed they'd like to promote
5928 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5929 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5930 * as value.
5931 * @par Example:
5932 * Configure the 'atom' feed to http://example.com/somefeed.xml
5933 * @code
5934 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5935 * @endcode
5937 $wgOverrideSiteFeed = array();
5940 * Available feeds objects.
5941 * Should probably only be defined when a page is syndicated ie when
5942 * $wgOut->isSyndicated() is true.
5944 $wgFeedClasses = array(
5945 'rss' => 'RSSFeed',
5946 'atom' => 'AtomFeed',
5950 * Which feed types should we provide by default? This can include 'rss',
5951 * 'atom', neither, or both.
5953 $wgAdvertisedFeedTypes = array( 'atom' );
5956 * Show watching users in recent changes, watchlist and page history views
5958 $wgRCShowWatchingUsers = false; # UPO
5961 * Show the amount of changed characters in recent changes
5963 $wgRCShowChangedSize = true;
5966 * If the difference between the character counts of the text
5967 * before and after the edit is below that value, the value will be
5968 * highlighted on the RC page.
5970 $wgRCChangedSizeThreshold = 500;
5973 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5974 * view for watched pages with new changes
5976 $wgShowUpdatedMarker = true;
5979 * Disable links to talk pages of anonymous users (IPs) in listings on special
5980 * pages like page history, Special:Recentchanges, etc.
5982 $wgDisableAnonTalk = false;
5985 * Enable filtering of categories in Recentchanges
5987 $wgAllowCategorizedRecentChanges = false;
5990 * Allow filtering by change tag in recentchanges, history, etc
5991 * Has no effect if no tags are defined in valid_tag.
5993 $wgUseTagFilter = true;
5996 * If set to an integer, pages that are watched by this many users or more
5997 * will not require the unwatchedpages permission to view the number of
5998 * watchers.
6000 * @since 1.21
6002 $wgUnwatchedPageThreshold = false;
6005 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6006 * certain types of edits.
6008 * To register a new one:
6009 * @code
6010 * $wgRecentChangesFlags['flag'] => array(
6011 * // message for the letter displayed next to rows on changes lists
6012 * 'letter' => 'letter-msg',
6013 * // message for the tooltip of the letter
6014 * 'title' => 'tooltip-msg',
6015 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6016 * 'legend' => 'legend-msg',
6017 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6018 * 'class' => 'css-class',
6019 * );
6020 * @endcode
6022 * @since 1.22
6024 $wgRecentChangesFlags = array(
6025 'newpage' => array(
6026 'letter' => 'newpageletter',
6027 'title' => 'recentchanges-label-newpage',
6028 'legend' => 'recentchanges-legend-newpage',
6030 'minor' => array(
6031 'letter' => 'minoreditletter',
6032 'title' => 'recentchanges-label-minor',
6033 'legend' => 'recentchanges-legend-minor',
6034 'class' => 'minoredit',
6036 'bot' => array(
6037 'letter' => 'boteditletter',
6038 'title' => 'recentchanges-label-bot',
6039 'legend' => 'recentchanges-legend-bot',
6040 'class' => 'botedit',
6042 'unpatrolled' => array(
6043 'letter' => 'unpatrolledletter',
6044 'title' => 'recentchanges-label-unpatrolled',
6045 'legend' => 'recentchanges-legend-unpatrolled',
6049 /** @} */ # end RC/watchlist }
6051 /************************************************************************//**
6052 * @name Copyright and credits settings
6053 * @{
6057 * Override for copyright metadata.
6059 * This is the name of the page containing information about the wiki's copyright status,
6060 * which will be added as a link in the footer if it is specified. It overrides
6061 * $wgRightsUrl if both are specified.
6063 $wgRightsPage = null;
6066 * Set this to specify an external URL containing details about the content license used on your
6067 * wiki.
6068 * If $wgRightsPage is set then this setting is ignored.
6070 $wgRightsUrl = null;
6073 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6074 * link.
6075 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6076 * of the page will also be used as the link if this variable is not set.
6078 $wgRightsText = null;
6081 * Override for copyright metadata.
6083 $wgRightsIcon = null;
6086 * Set this to some HTML to override the rights icon with an arbitrary logo
6087 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6089 $wgCopyrightIcon = null;
6092 * Set this to true if you want detailed copyright information forms on Upload.
6094 $wgUseCopyrightUpload = false;
6097 * Set this to the number of authors that you want to be credited below an
6098 * article text. Set it to zero to hide the attribution block, and a negative
6099 * number (like -1) to show all authors. Note that this will require 2-3 extra
6100 * database hits, which can have a not insignificant impact on performance for
6101 * large wikis.
6103 $wgMaxCredits = 0;
6106 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6107 * Otherwise, link to a separate credits page.
6109 $wgShowCreditsIfMax = true;
6111 /** @} */ # end of copyright and credits settings }
6113 /************************************************************************//**
6114 * @name Import / Export
6115 * @{
6119 * List of interwiki prefixes for wikis we'll accept as sources for
6120 * Special:Import (for sysops). Since complete page history can be imported,
6121 * these should be 'trusted'.
6123 * This can either be a regular array, or an associative map specifying
6124 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6125 * e.g.
6126 * @code
6127 * $wgImportSources = array(
6128 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6129 * 'wikispecies',
6130 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6131 * );
6132 * @endcode
6134 * If a user has the 'import' permission but not the 'importupload' permission,
6135 * they will only be able to run imports through this transwiki interface.
6137 $wgImportSources = array();
6140 * Optional default target namespace for interwiki imports.
6141 * Can use this to create an incoming "transwiki"-style queue.
6142 * Set to numeric key, not the name.
6144 * Users may override this in the Special:Import dialog.
6146 $wgImportTargetNamespace = null;
6149 * If set to false, disables the full-history option on Special:Export.
6150 * This is currently poorly optimized for long edit histories, so is
6151 * disabled on Wikimedia's sites.
6153 $wgExportAllowHistory = true;
6156 * If set nonzero, Special:Export requests for history of pages with
6157 * more revisions than this will be rejected. On some big sites things
6158 * could get bogged down by very very long pages.
6160 $wgExportMaxHistory = 0;
6163 * Return distinct author list (when not returning full history)
6165 $wgExportAllowListContributors = false;
6168 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6169 * up to this specified level, which will cause it to include all
6170 * pages linked to from the pages you specify. Since this number
6171 * can become *insanely large* and could easily break your wiki,
6172 * it's disabled by default for now.
6174 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6175 * crazy-big export from being done by someone setting the depth number too
6176 * high. In other words, last resort safety net.
6178 $wgExportMaxLinkDepth = 0;
6181 * Whether to allow the "export all pages in namespace" option
6183 $wgExportFromNamespaces = false;
6186 * Whether to allow exporting the entire wiki into a single file
6188 $wgExportAllowAll = false;
6190 /** @} */ # end of import/export }
6192 /*************************************************************************//**
6193 * @name Extensions
6194 * @{
6198 * A list of callback functions which are called once MediaWiki is fully
6199 * initialised
6201 $wgExtensionFunctions = array();
6204 * Extension messages files.
6206 * Associative array mapping extension name to the filename where messages can be
6207 * found. The file should contain variable assignments. Any of the variables
6208 * present in languages/messages/MessagesEn.php may be defined, but $messages
6209 * is the most common.
6211 * Variables defined in extensions will override conflicting variables defined
6212 * in the core.
6214 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6215 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6216 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6217 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6219 * Extensions using the JSON message format can preserve backward compatibility with
6220 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6221 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6222 * as for the $wgMessagesDirs entry.
6224 * @par Example:
6225 * @code
6226 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6227 * @endcode
6229 $wgExtensionMessagesFiles = array();
6232 * Extension messages directories.
6234 * Associative array mapping extension name to the path of the directory where message files can
6235 * be found. The message files are expected to be JSON files named for their language code, e.g.
6236 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6237 * message directories.
6239 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6241 * @par Simple example:
6242 * @code
6243 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6244 * @endcode
6246 * @par Complex example:
6247 * @code
6248 * $wgMessagesDirs['Example'] = array(
6249 * __DIR__ . '/lib/ve/i18n',
6250 * __DIR__ . '/lib/oojs-ui/i18n',
6251 * __DIR__ . '/i18n',
6253 * @endcode
6254 * @since 1.23
6256 $wgMessagesDirs = array();
6259 * Array of files with list(s) of extension entry points to be used in
6260 * maintenance/mergeMessageFileList.php
6261 * @since 1.22
6263 $wgExtensionEntryPointListFiles = array();
6266 * Parser output hooks.
6267 * This is an associative array where the key is an extension-defined tag
6268 * (typically the extension name), and the value is a PHP callback.
6269 * These will be called as an OutputPageParserOutput hook, if the relevant
6270 * tag has been registered with the parser output object.
6272 * Registration is done with $pout->addOutputHook( $tag, $data ).
6274 * The callback has the form:
6275 * @code
6276 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6277 * @endcode
6279 $wgParserOutputHooks = array();
6282 * Whether to include the NewPP limit report as a HTML comment
6284 $wgEnableParserLimitReporting = true;
6287 * List of valid skin names
6289 * The key should be the name in all lower case, the value should be a properly
6290 * cased name for the skin. This value will be prefixed with "Skin" to create
6291 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6292 * if you wish to have access to the full list.
6294 $wgValidSkinNames = array();
6297 * Special page list. This is an associative array mapping the (canonical) names of
6298 * special pages to either a class name to be instantiated, or a callback to use for
6299 * creating the special page object. In both cases, the result must be an instance of
6300 * SpecialPage.
6302 $wgSpecialPages = array();
6305 * Array mapping class names to filenames, for autoloading.
6307 $wgAutoloadClasses = array();
6310 * Switch controlling legacy case-insensitive classloading.
6311 * Do not disable if your wiki must support data created by PHP4, or by
6312 * MediaWiki 1.4 or earlier.
6314 $wgAutoloadAttemptLowercase = true;
6317 * An array of information about installed extensions keyed by their type.
6319 * All but 'name', 'path' and 'author' can be omitted.
6321 * @code
6322 * $wgExtensionCredits[$type][] = array(
6323 * 'path' => __FILE__,
6324 * 'name' => 'Example extension',
6325 * 'namemsg' => 'exampleextension-name',
6326 * 'author' => array(
6327 * 'Foo Barstein',
6328 * ),
6329 * 'version' => '1.9.0',
6330 * 'url' => 'http://example.org/example-extension/',
6331 * 'descriptionmsg' => 'exampleextension-desc',
6332 * 'license-name' => 'GPL-2.0+',
6333 * );
6334 * @endcode
6336 * The extensions are listed on Special:Version. This page also looks for a file
6337 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6338 * view said file. When the 'license-name' key is specified, this file is
6339 * interpreted as wikitext.
6341 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6342 * 'skin', 'api', or 'other', or any additional types as specified through the
6343 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6345 * - name: Name of extension as an inline string instead of localizable message.
6346 * Do not omit this even if 'namemsg' is provided, as it is used to override
6347 * the path Special:Version uses to find extension's license info, and is
6348 * required for backwards-compatibility with MediaWiki 1.23 and older.
6350 * - namemsg (since MW 1.24): A message key for a message containing the
6351 * extension's name, if the name is localizable. (For example, skin names
6352 * usually are.)
6354 * - author: A string or an array of strings. Authors can be linked using
6355 * the regular wikitext link syntax. To have an internationalized version of
6356 * "and others" show, add an element "...". This element can also be linked,
6357 * for instance "[http://example ...]".
6359 * - descriptionmsg: A message key or an an array with message key and parameters:
6360 * `'descriptionmsg' => 'exampleextension-desc',`
6362 * - description: Description of extension as an inline string instead of
6363 * localizable message (omit in favour of 'descriptionmsg').
6365 * - license-name: Short name of the license (used as label for the link), such
6366 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6368 $wgExtensionCredits = array();
6371 * Authentication plugin.
6372 * @var $wgAuth AuthPlugin
6374 $wgAuth = null;
6377 * Global list of hooks.
6379 * The key is one of the events made available by MediaWiki, you can find
6380 * a description for most of them in docs/hooks.txt. The array is used
6381 * internally by Hook:run().
6383 * The value can be one of:
6385 * - A function name:
6386 * @code
6387 * $wgHooks['event_name'][] = $function;
6388 * @endcode
6389 * - A function with some data:
6390 * @code
6391 * $wgHooks['event_name'][] = array( $function, $data );
6392 * @endcode
6393 * - A an object method:
6394 * @code
6395 * $wgHooks['event_name'][] = array( $object, 'method' );
6396 * @endcode
6397 * - A closure:
6398 * @code
6399 * $wgHooks['event_name'][] = function ( $hookParam ) {
6400 * // Handler code goes here.
6401 * };
6402 * @endcode
6404 * @warning You should always append to an event array or you will end up
6405 * deleting a previous registered hook.
6407 * @warning Hook handlers should be registered at file scope. Registering
6408 * handlers after file scope can lead to unexpected results due to caching.
6410 $wgHooks = array();
6413 * Maps jobs to their handling classes; extensions
6414 * can add to this to provide custom jobs
6416 $wgJobClasses = array(
6417 'refreshLinks' => 'RefreshLinksJob',
6418 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6419 'sendMail' => 'EmaillingJob',
6420 'enotifNotify' => 'EnotifNotifyJob',
6421 'fixDoubleRedirect' => 'DoubleRedirectJob',
6422 'uploadFromUrl' => 'UploadFromUrlJob',
6423 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6424 'PublishStashedFile' => 'PublishStashedFileJob',
6425 'ThumbnailRender' => 'ThumbnailRenderJob',
6426 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6427 'refreshLinksPrioritized' => 'RefreshLinksJob', // for cascading protection
6428 'null' => 'NullJob'
6432 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6433 * special flags are set. The values here are keys of $wgJobClasses.
6435 * These can be:
6436 * - Very long-running jobs.
6437 * - Jobs that you would never want to run as part of a page rendering request.
6438 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6439 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6440 * These settings should be global to all wikis.
6442 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6445 * Map of job types to how many job "work items" should be run per second
6446 * on each job runner process. The meaning of "work items" varies per job,
6447 * but typically would be something like "pages to update". A single job
6448 * may have a variable number of work items, as is the case with batch jobs.
6449 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6450 * These settings should be global to all wikis.
6451 * @var float[]
6453 $wgJobBackoffThrottling = array();
6456 * Map of job types to configuration arrays.
6457 * This determines which queue class and storage system is used for each job type.
6458 * Job types that do not have explicit configuration will use the 'default' config.
6459 * These settings should be global to all wikis.
6461 $wgJobTypeConf = array(
6462 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6466 * Which aggregator to use for tracking which queues have jobs.
6467 * These settings should be global to all wikis.
6469 $wgJobQueueAggregator = array(
6470 'class' => 'JobQueueAggregatorNull'
6474 * Additional functions to be performed with updateSpecialPages.
6475 * Expensive Querypages are already updated.
6477 $wgSpecialPageCacheUpdates = array(
6478 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6479 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6483 * Hooks that are used for outputting exceptions. Format is:
6484 * $wgExceptionHooks[] = $funcname
6485 * or:
6486 * $wgExceptionHooks[] = array( $class, $funcname )
6487 * Hooks should return strings or false
6489 $wgExceptionHooks = array();
6492 * Page property link table invalidation lists. When a page property
6493 * changes, this may require other link tables to be updated (eg
6494 * adding __HIDDENCAT__ means the hiddencat tracking category will
6495 * have been added, so the categorylinks table needs to be rebuilt).
6496 * This array can be added to by extensions.
6498 $wgPagePropLinkInvalidations = array(
6499 'hiddencat' => 'categorylinks',
6502 /** @} */ # End extensions }
6504 /*************************************************************************//**
6505 * @name Categories
6506 * @{
6510 * Use experimental, DMOZ-like category browser
6512 $wgUseCategoryBrowser = false;
6515 * On category pages, show thumbnail gallery for images belonging to that
6516 * category instead of listing them as articles.
6518 $wgCategoryMagicGallery = true;
6521 * Paging limit for categories
6523 $wgCategoryPagingLimit = 200;
6526 * Specify how category names should be sorted, when listed on a category page.
6527 * A sorting scheme is also known as a collation.
6529 * Available values are:
6531 * - uppercase: Converts the category name to upper case, and sorts by that.
6533 * - identity: Does no conversion. Sorts by binary value of the string.
6535 * - uca-default: Provides access to the Unicode Collation Algorithm with
6536 * the default element table. This is a compromise collation which sorts
6537 * all languages in a mediocre way. However, it is better than "uppercase".
6539 * To use the uca-default collation, you must have PHP's intl extension
6540 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6541 * resulting collation will depend on the version of ICU installed on the
6542 * server.
6544 * After you change this, you must run maintenance/updateCollation.php to fix
6545 * the sort keys in the database.
6547 * Extensions can define there own collations by subclassing Collation
6548 * and using the Collation::factory hook.
6550 $wgCategoryCollation = 'uppercase';
6552 /** @} */ # End categories }
6554 /*************************************************************************//**
6555 * @name Logging
6556 * @{
6560 * The logging system has two levels: an event type, which describes the
6561 * general category and can be viewed as a named subset of all logs; and
6562 * an action, which is a specific kind of event that can exist in that
6563 * log type.
6565 $wgLogTypes = array(
6567 'block',
6568 'protect',
6569 'rights',
6570 'delete',
6571 'upload',
6572 'move',
6573 'import',
6574 'patrol',
6575 'merge',
6576 'suppress',
6577 'managetags',
6581 * This restricts log access to those who have a certain right
6582 * Users without this will not see it in the option menu and can not view it
6583 * Restricted logs are not added to recent changes
6584 * Logs should remain non-transcludable
6585 * Format: logtype => permissiontype
6587 $wgLogRestrictions = array(
6588 'suppress' => 'suppressionlog'
6592 * Show/hide links on Special:Log will be shown for these log types.
6594 * This is associative array of log type => boolean "hide by default"
6596 * See $wgLogTypes for a list of available log types.
6598 * @par Example:
6599 * @code
6600 * $wgFilterLogTypes = array(
6601 * 'move' => true,
6602 * 'import' => false,
6603 * );
6604 * @endcode
6606 * Will display show/hide links for the move and import logs. Move logs will be
6607 * hidden by default unless the link is clicked. Import logs will be shown by
6608 * default, and hidden when the link is clicked.
6610 * A message of the form log-show-hide-[type] should be added, and will be used
6611 * for the link text.
6613 $wgFilterLogTypes = array(
6614 'patrol' => true
6618 * Lists the message key string for each log type. The localized messages
6619 * will be listed in the user interface.
6621 * Extensions with custom log types may add to this array.
6623 * @since 1.19, if you follow the naming convention log-name-TYPE,
6624 * where TYPE is your log type, yoy don't need to use this array.
6626 $wgLogNames = array(
6627 '' => 'all-logs-page',
6628 'block' => 'blocklogpage',
6629 'protect' => 'protectlogpage',
6630 'rights' => 'rightslog',
6631 'delete' => 'dellogpage',
6632 'upload' => 'uploadlogpage',
6633 'move' => 'movelogpage',
6634 'import' => 'importlogpage',
6635 'patrol' => 'patrol-log-page',
6636 'merge' => 'mergelog',
6637 'suppress' => 'suppressionlog',
6641 * Lists the message key string for descriptive text to be shown at the
6642 * top of each log type.
6644 * Extensions with custom log types may add to this array.
6646 * @since 1.19, if you follow the naming convention log-description-TYPE,
6647 * where TYPE is your log type, yoy don't need to use this array.
6649 $wgLogHeaders = array(
6650 '' => 'alllogstext',
6651 'block' => 'blocklogtext',
6652 'protect' => 'protectlogtext',
6653 'rights' => 'rightslogtext',
6654 'delete' => 'dellogpagetext',
6655 'upload' => 'uploadlogpagetext',
6656 'move' => 'movelogpagetext',
6657 'import' => 'importlogpagetext',
6658 'patrol' => 'patrol-log-header',
6659 'merge' => 'mergelogpagetext',
6660 'suppress' => 'suppressionlogtext',
6664 * Lists the message key string for formatting individual events of each
6665 * type and action when listed in the logs.
6667 * Extensions with custom log types may add to this array.
6669 $wgLogActions = array(
6670 'protect/protect' => 'protectedarticle',
6671 'protect/modify' => 'modifiedarticleprotection',
6672 'protect/unprotect' => 'unprotectedarticle',
6673 'protect/move_prot' => 'movedarticleprotection',
6674 'import/upload' => 'import-logentry-upload',
6675 'import/interwiki' => 'import-logentry-interwiki',
6679 * The same as above, but here values are names of functions,
6680 * not messages.
6681 * @see LogPage::actionText
6682 * @see LogFormatter
6684 $wgLogActionsHandlers = array(
6685 'move/move' => 'MoveLogFormatter',
6686 'move/move_redir' => 'MoveLogFormatter',
6687 'delete/delete' => 'DeleteLogFormatter',
6688 'delete/restore' => 'DeleteLogFormatter',
6689 'delete/revision' => 'DeleteLogFormatter',
6690 'delete/event' => 'DeleteLogFormatter',
6691 'suppress/revision' => 'DeleteLogFormatter',
6692 'suppress/event' => 'DeleteLogFormatter',
6693 'suppress/delete' => 'DeleteLogFormatter',
6694 'patrol/patrol' => 'PatrolLogFormatter',
6695 'rights/rights' => 'RightsLogFormatter',
6696 'rights/autopromote' => 'RightsLogFormatter',
6697 'upload/upload' => 'LogFormatter',
6698 'upload/overwrite' => 'LogFormatter',
6699 'upload/revert' => 'LogFormatter',
6700 'merge/merge' => 'MergeLogFormatter',
6701 'managetags/create' => 'LogFormatter',
6702 'managetags/delete' => 'LogFormatter',
6703 'managetags/activate' => 'LogFormatter',
6704 'managetags/deactivate' => 'LogFormatter',
6705 'block/block' => 'BlockLogFormatter',
6706 'block/unblock' => 'BlockLogFormatter',
6707 'block/reblock' => 'BlockLogFormatter',
6708 'suppress/block' => 'BlockLogFormatter',
6709 'suppress/reblock' => 'BlockLogFormatter',
6713 * Maintain a log of newusers at Log/newusers?
6715 $wgNewUserLog = true;
6717 /** @} */ # end logging }
6719 /*************************************************************************//**
6720 * @name Special pages (general and miscellaneous)
6721 * @{
6725 * Allow special page inclusions such as {{Special:Allpages}}
6727 $wgAllowSpecialInclusion = true;
6730 * Set this to an array of special page names to prevent
6731 * maintenance/updateSpecialPages.php from updating those pages.
6733 $wgDisableQueryPageUpdate = false;
6736 * List of special pages, followed by what subtitle they should go under
6737 * at Special:SpecialPages
6739 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6741 $wgSpecialPageGroups = array();
6744 * On Special:Unusedimages, consider images "used", if they are put
6745 * into a category. Default (false) is not to count those as used.
6747 $wgCountCategorizedImagesAsUsed = false;
6750 * Maximum number of links to a redirect page listed on
6751 * Special:Whatlinkshere/RedirectDestination
6753 $wgMaxRedirectLinksRetrieved = 500;
6755 /** @} */ # end special pages }
6757 /*************************************************************************//**
6758 * @name Actions
6759 * @{
6763 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6764 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6765 * 'foo' => true Load the class FooAction which subclasses Action
6766 * If something is specified in the getActionOverrides()
6767 * of the relevant Page object it will be used
6768 * instead of the default class.
6769 * 'foo' => false The action is disabled; show an error message
6770 * Unsetting core actions will probably cause things to complain loudly.
6772 $wgActions = array(
6773 'credits' => true,
6774 'delete' => true,
6775 'edit' => true,
6776 'history' => true,
6777 'info' => true,
6778 'markpatrolled' => true,
6779 'protect' => true,
6780 'purge' => true,
6781 'raw' => true,
6782 'render' => true,
6783 'revert' => true,
6784 'revisiondelete' => true,
6785 'rollback' => true,
6786 'submit' => true,
6787 'unprotect' => true,
6788 'unwatch' => true,
6789 'view' => true,
6790 'watch' => true,
6793 /** @} */ # end actions }
6795 /*************************************************************************//**
6796 * @name Robot (search engine crawler) policy
6797 * See also $wgNoFollowLinks.
6798 * @{
6802 * Default robot policy. The default policy is to encourage indexing and fol-
6803 * lowing of links. It may be overridden on a per-namespace and/or per-page
6804 * basis.
6806 $wgDefaultRobotPolicy = 'index,follow';
6809 * Robot policies per namespaces. The default policy is given above, the array
6810 * is made of namespace constants as defined in includes/Defines.php. You can-
6811 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6812 * nofollow. This is because a number of special pages (e.g., ListPages) have
6813 * many permutations of options that display the same data under redundant
6814 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6815 * pages, all alike, and never reaching your actual content.
6817 * @par Example:
6818 * @code
6819 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6820 * @endcode
6822 $wgNamespaceRobotPolicies = array();
6825 * Robot policies per article. These override the per-namespace robot policies.
6826 * Must be in the form of an array where the key part is a properly canonicalised
6827 * text form title and the value is a robot policy.
6829 * @par Example:
6830 * @code
6831 * $wgArticleRobotPolicies = array(
6832 * 'Main Page' => 'noindex,follow',
6833 * 'User:Bob' => 'index,follow',
6834 * );
6835 * @endcode
6837 * @par Example that DOES NOT WORK because the names are not canonical text
6838 * forms:
6839 * @code
6840 * $wgArticleRobotPolicies = array(
6841 * # Underscore, not space!
6842 * 'Main_Page' => 'noindex,follow',
6843 * # "Project", not the actual project name!
6844 * 'Project:X' => 'index,follow',
6845 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6846 * 'abc' => 'noindex,nofollow'
6847 * );
6848 * @endcode
6850 $wgArticleRobotPolicies = array();
6853 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6854 * will not function, so users can't decide whether pages in that namespace are
6855 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6857 * @par Example:
6858 * @code
6859 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6860 * @endcode
6862 $wgExemptFromUserRobotsControl = null;
6864 /** @} */ # End robot policy }
6866 /************************************************************************//**
6867 * @name AJAX and API
6868 * Note: The AJAX entry point which this section refers to is gradually being
6869 * replaced by the API entry point, api.php. They are essentially equivalent.
6870 * Both of them are used for dynamic client-side features, via XHR.
6871 * @{
6875 * Enable the MediaWiki API for convenient access to
6876 * machine-readable data via api.php
6878 * See https://www.mediawiki.org/wiki/API
6880 $wgEnableAPI = true;
6883 * Allow the API to be used to perform write operations
6884 * (page edits, rollback, etc.) when an authorised user
6885 * accesses it
6887 $wgEnableWriteAPI = true;
6891 * WARNING: SECURITY THREAT - debug use only
6893 * Disables many security checks in the API for debugging purposes.
6894 * This flag should never be used on the production servers, as it introduces
6895 * a number of potential security holes. Even when enabled, the validation
6896 * will still be performed, but instead of failing, API will return a warning.
6897 * Also, there will always be a warning notifying that this flag is set.
6898 * At this point, the flag allows GET requests to go through for modules
6899 * requiring POST.
6901 * @since 1.21
6903 $wgDebugAPI = false;
6906 * API module extensions.
6908 * Associative array mapping module name to modules specs;
6909 * Each module spec is an associative array containing at least
6910 * the 'class' key for the module's class, and optionally a
6911 * 'factory' key for the factory function to use for the module.
6913 * That factory function will be called with two parameters,
6914 * the parent module (an instance of ApiBase, usually ApiMain)
6915 * and the name the module was registered under. The return
6916 * value must be an instance of the class given in the 'class'
6917 * field.
6919 * For backward compatibility, the module spec may also be a
6920 * simple string containing the module's class name. In that
6921 * case, the class' constructor will be called with the parent
6922 * module and module name as parameters, as described above.
6924 * Examples for registering API modules:
6926 * @code
6927 * $wgAPIModules['foo'] = 'ApiFoo';
6928 * $wgAPIModules['bar'] = array(
6929 * 'class' => 'ApiBar',
6930 * 'factory' => function( $main, $name ) { ... }
6931 * );
6932 * $wgAPIModules['xyzzy'] = array(
6933 * 'class' => 'ApiXyzzy',
6934 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
6935 * );
6936 * @endcode
6938 * Extension modules may override the core modules.
6939 * See ApiMain::$Modules for a list of the core modules.
6941 $wgAPIModules = array();
6944 * API format module extensions.
6945 * Associative array mapping format module name to module specs (see $wgAPIModules).
6946 * Extension modules may override the core modules.
6948 * See ApiMain::$Formats for a list of the core format modules.
6950 $wgAPIFormatModules = array();
6953 * API Query meta module extensions.
6954 * Associative array mapping meta module name to module specs (see $wgAPIModules).
6955 * Extension modules may override the core modules.
6957 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6959 $wgAPIMetaModules = array();
6962 * API Query prop module extensions.
6963 * Associative array mapping prop module name to module specs (see $wgAPIModules).
6964 * Extension modules may override the core modules.
6966 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6968 $wgAPIPropModules = array();
6971 * API Query list module extensions.
6972 * Associative array mapping list module name to module specs (see $wgAPIModules).
6973 * Extension modules may override the core modules.
6975 * See ApiQuery::$QueryListModules for a list of the core list modules.
6977 $wgAPIListModules = array();
6980 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6981 * @deprecated since 1.21
6983 $wgAPIGeneratorModules = array();
6986 * Maximum amount of rows to scan in a DB query in the API
6987 * The default value is generally fine
6989 $wgAPIMaxDBRows = 5000;
6992 * The maximum size (in bytes) of an API result.
6993 * @warning Do not set this lower than $wgMaxArticleSize*1024
6995 $wgAPIMaxResultSize = 8388608;
6998 * The maximum number of uncached diffs that can be retrieved in one API
6999 * request. Set this to 0 to disable API diffs altogether
7001 $wgAPIMaxUncachedDiffs = 1;
7004 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7005 * API request logging
7007 $wgAPIRequestLog = false;
7010 * Set the timeout for the API help text cache. If set to 0, caching disabled
7012 $wgAPICacheHelpTimeout = 60 * 60;
7015 * The ApiQueryQueryPages module should skip pages that are redundant to true
7016 * API queries.
7018 $wgAPIUselessQueryPages = array(
7019 'MIMEsearch', // aiprop=mime
7020 'LinkSearch', // list=exturlusage
7021 'FileDuplicateSearch', // prop=duplicatefiles
7025 * Enable AJAX framework
7027 $wgUseAjax = true;
7030 * List of Ajax-callable functions.
7031 * Extensions acting as Ajax callbacks must register here
7033 $wgAjaxExportList = array();
7036 * Enable watching/unwatching pages using AJAX.
7037 * Requires $wgUseAjax to be true too.
7039 $wgAjaxWatch = true;
7042 * Enable AJAX check for file overwrite, pre-upload
7044 $wgAjaxUploadDestCheck = true;
7047 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7049 $wgAjaxLicensePreview = true;
7052 * Have clients send edits to be prepared when filling in edit summaries.
7053 * This gives the server a head start on the expensive parsing operation.
7055 $wgAjaxEditStash = true;
7058 * Settings for incoming cross-site AJAX requests:
7059 * Newer browsers support cross-site AJAX when the target resource allows requests
7060 * from the origin domain by the Access-Control-Allow-Origin header.
7061 * This is currently only used by the API (requests to api.php)
7062 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7064 * - '*' matches any number of characters
7065 * - '?' matches any 1 character
7067 * @par Example:
7068 * @code
7069 * $wgCrossSiteAJAXdomains = array(
7070 * 'www.mediawiki.org',
7071 * '*.wikipedia.org',
7072 * '*.wikimedia.org',
7073 * '*.wiktionary.org',
7074 * );
7075 * @endcode
7077 $wgCrossSiteAJAXdomains = array();
7080 * Domains that should not be allowed to make AJAX requests,
7081 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7082 * Uses the same syntax as $wgCrossSiteAJAXdomains
7084 $wgCrossSiteAJAXdomainExceptions = array();
7086 /** @} */ # End AJAX and API }
7088 /************************************************************************//**
7089 * @name Shell and process control
7090 * @{
7094 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7096 $wgMaxShellMemory = 307200;
7099 * Maximum file size created by shell processes under linux, in KB
7100 * ImageMagick convert for example can be fairly hungry for scratch space
7102 $wgMaxShellFileSize = 102400;
7105 * Maximum CPU time in seconds for shell processes under Linux
7107 $wgMaxShellTime = 180;
7110 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7111 * would measure) in seconds for shell processes under Linux
7113 $wgMaxShellWallClockTime = 180;
7116 * Under Linux: a cgroup directory used to constrain memory usage of shell
7117 * commands. The directory must be writable by the user which runs MediaWiki.
7119 * If specified, this is used instead of ulimit, which is inaccurate, and
7120 * causes malloc() to return NULL, which exposes bugs in C applications, making
7121 * them segfault or deadlock.
7123 * A wrapper script will create a cgroup for each shell command that runs, as
7124 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7125 * kernel will send a SIGKILL signal to a process in the subgroup.
7127 * @par Example:
7128 * @code
7129 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7130 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7131 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7132 * @endcode
7134 * The reliability of cgroup cleanup can be improved by installing a
7135 * notify_on_release script in the root cgroup, see e.g.
7136 * https://gerrit.wikimedia.org/r/#/c/40784
7138 $wgShellCgroup = false;
7141 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7143 $wgPhpCli = '/usr/bin/php';
7146 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7147 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7148 * character set. Only the character set is relevant.
7150 $wgShellLocale = 'en_US.utf8';
7152 /** @} */ # End shell }
7154 /************************************************************************//**
7155 * @name HTTP client
7156 * @{
7160 * Timeout for HTTP requests done internally, in seconds.
7162 $wgHTTPTimeout = 25;
7165 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7167 $wgAsyncHTTPTimeout = 25;
7170 * Proxy to use for CURL requests.
7172 $wgHTTPProxy = false;
7175 * Local virtual hosts.
7177 * This lists domains that are configured as virtual hosts on the same machine.
7178 * If a request is to be made to a domain listed here, or any subdomain thereof,
7179 * then no proxy will be used.
7180 * Command-line scripts are not affected by this setting and will always use
7181 * proxy if it is configured.
7182 * @since 1.25
7184 $wgLocalVirtualHosts = array();
7187 * Timeout for connections done internally (in seconds)
7188 * Only works for curl
7190 $wgHTTPConnectTimeout = 5e0;
7192 /** @} */ # End HTTP client }
7194 /************************************************************************//**
7195 * @name Job queue
7196 * See also $wgEnotifUseJobQ.
7197 * @{
7201 * Number of jobs to perform per request. May be less than one in which case
7202 * jobs are performed probabalistically. If this is zero, jobs will not be done
7203 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7204 * be run periodically.
7206 $wgJobRunRate = 1;
7209 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7210 * to handle the job execution, instead of blocking the request until the job
7211 * execution finishes.
7212 * @since 1.23
7214 $wgRunJobsAsync = true;
7217 * Number of rows to update per job
7219 $wgUpdateRowsPerJob = 500;
7222 * Number of rows to update per query
7224 $wgUpdateRowsPerQuery = 100;
7226 /** @} */ # End job queue }
7228 /************************************************************************//**
7229 * @name Miscellaneous
7230 * @{
7234 * Name of the external diff engine to use
7236 $wgExternalDiffEngine = false;
7239 * Disable redirects to special pages and interwiki redirects, which use a 302
7240 * and have no "redirected from" link.
7242 * @note This is only for articles with #REDIRECT in them. URL's containing a
7243 * local interwiki prefix (or a non-canonical special page name) are still hard
7244 * redirected regardless of this setting.
7246 $wgDisableHardRedirects = false;
7249 * LinkHolderArray batch size
7250 * For debugging
7252 $wgLinkHolderBatchSize = 1000;
7255 * By default MediaWiki does not register links pointing to same server in
7256 * externallinks dataset, use this value to override:
7258 $wgRegisterInternalExternals = false;
7261 * Maximum number of pages to move at once when moving subpages with a page.
7263 $wgMaximumMovedPages = 100;
7266 * Fix double redirects after a page move.
7267 * Tends to conflict with page move vandalism, use only on a private wiki.
7269 $wgFixDoubleRedirects = false;
7272 * Allow redirection to another page when a user logs in.
7273 * To enable, set to a string like 'Main Page'
7275 $wgRedirectOnLogin = null;
7278 * Configuration for processing pool control, for use in high-traffic wikis.
7279 * An implementation is provided in the PoolCounter extension.
7281 * This configuration array maps pool types to an associative array. The only
7282 * defined key in the associative array is "class", which gives the class name.
7283 * The remaining elements are passed through to the class as constructor
7284 * parameters.
7286 * @par Example:
7287 * @code
7288 * $wgPoolCounterConf = array( 'ArticleView' => array(
7289 * 'class' => 'PoolCounter_Client',
7290 * 'timeout' => 15, // wait timeout in seconds
7291 * 'workers' => 5, // maximum number of active threads in each pool
7292 * 'maxqueue' => 50, // maximum number of total threads in each pool
7293 * ... any extension-specific options...
7294 * );
7295 * @endcode
7297 $wgPoolCounterConf = null;
7300 * To disable file delete/restore temporarily
7302 $wgUploadMaintenance = false;
7305 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7306 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7307 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7308 * (except for the special case of JS and CS pages).
7310 * @since 1.21
7312 $wgNamespaceContentModels = array();
7315 * How to react if a plain text version of a non-text Content object is requested using
7316 * ContentHandler::getContentText():
7318 * * 'ignore': return null
7319 * * 'fail': throw an MWException
7320 * * 'serialize': serialize to default format
7322 * @since 1.21
7324 $wgContentHandlerTextFallback = 'ignore';
7327 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7328 * This way, the ContentHandler facility can be used without any additional information in the
7329 * database. A page's content model is then derived solely from the page's title. This however
7330 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7331 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7332 * a title that would default to a different content model.
7334 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7335 * handling is less robust and less flexible.
7337 * @since 1.21
7339 $wgContentHandlerUseDB = true;
7342 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7343 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7344 * the effect on the database they would have on a wikitext page.
7346 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7347 * or at least parse only the contents of comments in the scripts.
7349 * @since 1.21
7351 $wgTextModelsToParse = array(
7352 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7353 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7354 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7358 * Whether the user must enter their password to change their e-mail address
7360 * @since 1.20
7362 $wgRequirePasswordforEmailChange = true;
7365 * Register handlers for specific types of sites.
7367 * @since 1.20
7369 $wgSiteTypes = array(
7370 'mediawiki' => 'MediaWikiSite',
7374 * Whether the page_props table has a pp_sortkey column. Set to false in case
7375 * the respective database schema change was not applied.
7376 * @since 1.23
7378 $wgPagePropsHaveSortkey = true;
7381 * Port where you have HTTPS running
7382 * Supports HTTPS on non-standard ports
7383 * @see bug 65184
7384 * @since 1.24
7386 $wgHttpsPort = 443;
7389 * Secret for hmac-based key derivation function (fast,
7390 * cryptographically secure random numbers).
7391 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7392 * be used.
7393 * See also: $wgHKDFAlgorithm
7394 * @since 1.24
7396 $wgHKDFSecret = false;
7399 * Algorithm for hmac-based key derivation function (fast,
7400 * cryptographically secure random numbers).
7401 * See also: $wgHKDFSecret
7402 * @since 1.24
7404 $wgHKDFAlgorithm = 'sha256';
7407 * Enable page language feature
7408 * Allows setting page language in database
7409 * @var bool
7410 * @since 1.24
7412 $wgPageLanguageUseDB = false;
7415 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7416 * Set this only if the fields are fully populated. This may be removed in 1.25.
7417 * @var bool
7418 * @since 1.24
7420 $wgUseLinkNamespaceDBFields = true;
7423 * For really cool vim folding this needs to be at the end:
7424 * vim: foldmarker=@{,@} foldmethod=marker
7425 * @}