Merge "DatabaseMssql: Don't duplicate body of makeList()"
[mediawiki.git] / includes / DefaultSettings.php
blobd4cdf9e8c8a52af81a4e57821353605c9b1be870
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' => '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
955 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
956 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
957 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
958 . '$output $input',
959 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
960 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
961 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
965 * Pick a converter defined in $wgSVGConverters
967 $wgSVGConverter = 'ImageMagick';
970 * If not in the executable PATH, specify the SVG converter path.
972 $wgSVGConverterPath = '';
975 * Don't scale a SVG larger than this
977 $wgSVGMaxSize = 2048;
980 * Don't read SVG metadata beyond this point.
981 * Default is 1024*256 bytes
983 $wgSVGMetadataCutoff = 262144;
986 * Disallow <title> element in SVG files.
988 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
989 * browsers which can not perform basic stuff like MIME detection and which are
990 * vulnerable to further idiots uploading crap files as images.
992 * When this directive is on, "<title>" will be allowed in files with an
993 * "image/svg+xml" MIME type. You should leave this disabled if your web server
994 * is misconfigured and doesn't send appropriate MIME types for SVG images.
996 $wgAllowTitlesInSVG = false;
999 * The maximum number of pixels a source image can have if it is to be scaled
1000 * down by a scaler that requires the full source image to be decompressed
1001 * and stored in decompressed form, before the thumbnail is generated.
1003 * This provides a limit on memory usage for the decompression side of the
1004 * image scaler. The limit is used when scaling PNGs with any of the
1005 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1006 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1008 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1009 * 12.5 million pixels or 3500x3500.
1011 $wgMaxImageArea = 1.25e7;
1014 * Force thumbnailing of animated GIFs above this size to a single
1015 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1016 * is checked against the total size of all frames in the animation.
1017 * It probably makes sense to keep this equal to $wgMaxImageArea.
1019 $wgMaxAnimatedGifArea = 1.25e7;
1022 * Browsers don't support TIFF inline generally...
1023 * For inline display, we need to convert to PNG or JPEG.
1024 * Note scaling should work with ImageMagick, but may not with GD scaling.
1026 * @par Example:
1027 * @code
1028 * // PNG is lossless, but inefficient for photos
1029 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1030 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1031 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1032 * @endcode
1034 $wgTiffThumbnailType = false;
1037 * If rendered thumbnail files are older than this timestamp, they
1038 * will be rerendered on demand as if the file didn't already exist.
1039 * Update if there is some need to force thumbs and SVG rasterizations
1040 * to rerender, such as fixes to rendering bugs.
1042 $wgThumbnailEpoch = '20030516000000';
1045 * Certain operations are avoided if there were too many recent failures,
1046 * for example, thumbnail generation. Bump this value to invalidate all
1047 * memory of failed operations and thus allow further attempts to resume.
1048 * This is useful when a cause for the failures has been found and fixed.
1050 $wgAttemptFailureEpoch = 1;
1053 * If set, inline scaled images will still produce "<img>" tags ready for
1054 * output instead of showing an error message.
1056 * This may be useful if errors are transitory, especially if the site
1057 * is configured to automatically render thumbnails on request.
1059 * On the other hand, it may obscure error conditions from debugging.
1060 * Enable the debug log or the 'thumbnail' log group to make sure errors
1061 * are logged to a file for review.
1063 $wgIgnoreImageErrors = false;
1066 * Allow thumbnail rendering on page view. If this is false, a valid
1067 * thumbnail URL is still output, but no file will be created at
1068 * the target location. This may save some time if you have a
1069 * thumb.php or 404 handler set up which is faster than the regular
1070 * webserver(s).
1072 $wgGenerateThumbnailOnParse = true;
1075 * Show thumbnails for old images on the image description page
1077 $wgShowArchiveThumbnails = true;
1080 * If set to true, images that contain certain the exif orientation tag will
1081 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1082 * is available that can rotate.
1084 $wgEnableAutoRotation = null;
1087 * Internal name of virus scanner. This serves as a key to the
1088 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1089 * null, every file uploaded will be scanned for viruses.
1091 $wgAntivirus = null;
1094 * Configuration for different virus scanners. This an associative array of
1095 * associative arrays. It contains one setup array per known scanner type.
1096 * The entry is selected by $wgAntivirus, i.e.
1097 * valid values for $wgAntivirus are the keys defined in this array.
1099 * The configuration array for each scanner contains the following keys:
1100 * "command", "codemap", "messagepattern":
1102 * "command" is the full command to call the virus scanner - %f will be
1103 * replaced with the name of the file to scan. If not present, the filename
1104 * will be appended to the command. Note that this must be overwritten if the
1105 * scanner is not in the system path; in that case, please set
1106 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1107 * path.
1109 * "codemap" is a mapping of exit code to return codes of the detectVirus
1110 * function in SpecialUpload.
1111 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1112 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1113 * is not set.
1114 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1115 * the file to have an unsupported format, which is probably immune to
1116 * viruses. This causes the file to pass.
1117 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1118 * no virus was found.
1119 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1120 * a virus.
1121 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1123 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1124 * output. The relevant part should be matched as group one (\1).
1125 * If not defined or the pattern does not match, the full message is shown to the user.
1127 $wgAntivirusSetup = array(
1129 #setup for clamav
1130 'clamav' => array(
1131 'command' => 'clamscan --no-summary ',
1132 'codemap' => array(
1133 "0" => AV_NO_VIRUS, # no virus
1134 "1" => AV_VIRUS_FOUND, # virus found
1135 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1136 "*" => AV_SCAN_FAILED, # else scan failed
1138 'messagepattern' => '/.*?:(.*)/sim',
1143 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1145 $wgAntivirusRequired = true;
1148 * Determines if the MIME type of uploaded files should be checked
1150 $wgVerifyMimeType = true;
1153 * Sets the MIME type definition file to use by MimeMagic.php.
1154 * Set to null, to use built-in defaults only.
1155 * example: $wgMimeTypeFile = '/etc/mime.types';
1157 $wgMimeTypeFile = 'includes/mime.types';
1160 * Sets the MIME type info file to use by MimeMagic.php.
1161 * Set to null, to use built-in defaults only.
1163 $wgMimeInfoFile = 'includes/mime.info';
1166 * Sets an external MIME detector program. The command must print only
1167 * the MIME type to standard output.
1168 * The name of the file to process will be appended to the command given here.
1169 * If not set or NULL, PHP's fileinfo extension will be used if available.
1171 * @par Example:
1172 * @code
1173 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1174 * @endcode
1176 $wgMimeDetectorCommand = null;
1179 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1180 * things, because only a few types of images are needed and file extensions
1181 * can be trusted.
1183 $wgTrivialMimeDetection = false;
1186 * Additional XML types we can allow via MIME-detection.
1187 * array = ( 'rootElement' => 'associatedMimeType' )
1189 $wgXMLMimeTypes = array(
1190 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1191 'svg' => 'image/svg+xml',
1192 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1193 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1194 'html' => 'text/html', // application/xhtml+xml?
1198 * Limit images on image description pages to a user-selectable limit. In order
1199 * to reduce disk usage, limits can only be selected from a list.
1200 * The user preference is saved as an array offset in the database, by default
1201 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1202 * change it if you alter the array (see bug 8858).
1203 * This is the list of settings the user can choose from:
1205 $wgImageLimits = array(
1206 array( 320, 240 ),
1207 array( 640, 480 ),
1208 array( 800, 600 ),
1209 array( 1024, 768 ),
1210 array( 1280, 1024 )
1214 * Adjust thumbnails on image pages according to a user setting. In order to
1215 * reduce disk usage, the values can only be selected from a list. This is the
1216 * list of settings the user can choose from:
1218 $wgThumbLimits = array(
1219 120,
1220 150,
1221 180,
1222 200,
1223 250,
1228 * When defined, is an array of image widths used as buckets for thumbnail generation.
1229 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1230 * always using the original. This will incur a speed gain but cause a quality loss.
1232 * The buckets generation is chained, with each bucket generated based on the above bucket
1233 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1234 * supports it.
1236 $wgThumbnailBuckets = null;
1239 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1240 * above the requested size. The distance represents how many extra pixels of width the bucket
1241 * needs in order to be used as the reference for a given thumbnail. For example, with the
1242 * following buckets:
1244 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1246 * and a distance of 50:
1248 * $wgThumbnailMinimumBucketDistance = 50;
1250 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1251 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1253 $wgThumbnailMinimumBucketDistance = 50;
1256 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1257 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1258 * has a performance impact for the first client to view a certain size.
1260 * This obviously means that more disk space is needed per upload upfront.
1262 * @since 1.25
1265 $wgUploadThumbnailRenderMap = array();
1268 * The method through which the thumbnails will be prerendered for the entries in
1269 * $wgUploadThumbnailRenderMap
1271 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1272 * thumbnail's URL.
1273 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1274 * option uses the job queue to render the thumbnail.
1276 * @since 1.25
1278 $wgUploadThumbnailRenderMethod = 'jobqueue';
1281 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1283 * @since 1.25
1285 $wgUploadThumbnailRenderHttpCustomHost = false;
1288 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1289 * HTTP request to.
1291 * @since 1.25
1293 $wgUploadThumbnailRenderHttpCustomDomain = false;
1296 * Default parameters for the "<gallery>" tag
1298 $wgGalleryOptions = array(
1299 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1300 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1301 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1302 'captionLength' => 25, // Length of caption to truncate (in characters)
1303 'showBytes' => true, // Show the filesize in bytes in categories
1304 'mode' => 'traditional',
1308 * Adjust width of upright images when parameter 'upright' is used
1309 * This allows a nicer look for upright images without the need to fix the width
1310 * by hardcoded px in wiki sourcecode.
1312 $wgThumbUpright = 0.75;
1315 * Default value for chmoding of new directories.
1317 $wgDirectoryMode = 0777;
1320 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1322 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1323 * thumbnails, output via the srcset attribute.
1325 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1326 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1327 * The polyfill can be found in the jquery.hidpi module.
1329 $wgResponsiveImages = true;
1332 * @name DJVU settings
1333 * @{
1337 * Path of the djvudump executable
1338 * Enable this and $wgDjvuRenderer to enable djvu rendering
1339 * example: $wgDjvuDump = 'djvudump';
1341 $wgDjvuDump = null;
1344 * Path of the ddjvu DJVU renderer
1345 * Enable this and $wgDjvuDump to enable djvu rendering
1346 * example: $wgDjvuRenderer = 'ddjvu';
1348 $wgDjvuRenderer = null;
1351 * Path of the djvutxt DJVU text extraction utility
1352 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1353 * example: $wgDjvuTxt = 'djvutxt';
1355 $wgDjvuTxt = null;
1358 * Path of the djvutoxml executable
1359 * This works like djvudump except much, much slower as of version 3.5.
1361 * For now we recommend you use djvudump instead. The djvuxml output is
1362 * probably more stable, so we'll switch back to it as soon as they fix
1363 * the efficiency problem.
1364 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1366 * @par Example:
1367 * @code
1368 * $wgDjvuToXML = 'djvutoxml';
1369 * @endcode
1371 $wgDjvuToXML = null;
1374 * Shell command for the DJVU post processor
1375 * Default: pnmtojpeg, since ddjvu generates ppm output
1376 * Set this to false to output the ppm file directly.
1378 $wgDjvuPostProcessor = 'pnmtojpeg';
1381 * File extension for the DJVU post processor output
1383 $wgDjvuOutputExtension = 'jpg';
1385 /** @} */ # end of DJvu }
1387 /** @} */ # end of file uploads }
1389 /************************************************************************//**
1390 * @name Email settings
1391 * @{
1396 * Site admin email address.
1398 * Defaults to "wikiadmin@$wgServerName".
1400 $wgEmergencyContact = false;
1403 * Password reminder email address.
1405 * The address we should use as sender when a user is requesting his password.
1407 * Defaults to "apache@$wgServerName".
1409 $wgPasswordSender = false;
1412 * Password reminder name
1414 * @deprecated since 1.23; use the system message 'emailsender' instead.
1416 $wgPasswordSenderName = 'MediaWiki Mail';
1419 * Dummy address which should be accepted during mail send action.
1420 * It might be necessary to adapt the address or to set it equal
1421 * to the $wgEmergencyContact address.
1423 $wgNoReplyAddress = 'reply@not.possible';
1426 * Set to true to enable the e-mail basic features:
1427 * Password reminders, etc. If sending e-mail on your
1428 * server doesn't work, you might want to disable this.
1430 $wgEnableEmail = true;
1433 * Set to true to enable user-to-user e-mail.
1434 * This can potentially be abused, as it's hard to track.
1436 $wgEnableUserEmail = true;
1439 * Set to true to put the sending user's email in a Reply-To header
1440 * instead of From. ($wgEmergencyContact will be used as From.)
1442 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1443 * which can cause problems with SPF validation and leak recipient addresses
1444 * when bounces are sent to the sender.
1446 $wgUserEmailUseReplyTo = false;
1449 * Minimum time, in hours, which must elapse between password reminder
1450 * emails for a given account. This is to prevent abuse by mail flooding.
1452 $wgPasswordReminderResendTime = 24;
1455 * The time, in seconds, when an emailed temporary password expires.
1457 $wgNewPasswordExpiry = 3600 * 24 * 7;
1460 * The time, in seconds, when an email confirmation email expires
1462 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1465 * The number of days that a user's password is good for. After this number of days, the
1466 * user will be asked to reset their password. Set to false to disable password expiration.
1468 $wgPasswordExpirationDays = false;
1471 * If a user's password is expired, the number of seconds when they can still login,
1472 * and cancel their password change, but are sent to the password change form on each login.
1474 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1477 * SMTP Mode.
1479 * For using a direct (authenticated) SMTP server connection.
1480 * Default to false or fill an array :
1482 * @code
1483 * $wgSMTP = array(
1484 * 'host' => 'SMTP domain',
1485 * 'IDHost' => 'domain for MessageID',
1486 * 'port' => '25',
1487 * 'auth' => [true|false],
1488 * 'username' => [SMTP username],
1489 * 'password' => [SMTP password],
1490 * );
1491 * @endcode
1493 $wgSMTP = false;
1496 * Additional email parameters, will be passed as the last argument to mail() call.
1497 * If using safe_mode this has no effect
1499 $wgAdditionalMailParams = null;
1502 * For parts of the system that have been updated to provide HTML email content, send
1503 * both text and HTML parts as the body of the email
1505 $wgAllowHTMLEmail = false;
1508 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1509 * from $wgEmergencyContact
1511 $wgEnotifFromEditor = false;
1513 // TODO move UPO to preferences probably ?
1514 # If set to true, users get a corresponding option in their preferences and can choose to
1515 # enable or disable at their discretion
1516 # If set to false, the corresponding input form on the user preference page is suppressed
1517 # It call this to be a "user-preferences-option (UPO)"
1520 * Require email authentication before sending mail to an email address.
1521 * This is highly recommended. It prevents MediaWiki from being used as an open
1522 * spam relay.
1524 $wgEmailAuthentication = true;
1527 * Allow users to enable email notification ("enotif") on watchlist changes.
1529 $wgEnotifWatchlist = false;
1532 * Allow users to enable email notification ("enotif") when someone edits their
1533 * user talk page.
1535 $wgEnotifUserTalk = false;
1538 * Set the Reply-to address in notifications to the editor's address, if user
1539 * allowed this in the preferences.
1541 $wgEnotifRevealEditorAddress = false;
1544 * Send notification mails on minor edits to watchlist pages. This is enabled
1545 * by default. Does not affect user talk notifications.
1547 $wgEnotifMinorEdits = true;
1550 * Send a generic mail instead of a personalised mail for each user. This
1551 * always uses UTC as the time zone, and doesn't include the username.
1553 * For pages with many users watching, this can significantly reduce mail load.
1554 * Has no effect when using sendmail rather than SMTP.
1556 $wgEnotifImpersonal = false;
1559 * Maximum number of users to mail at once when using impersonal mail. Should
1560 * match the limit on your mail server.
1562 $wgEnotifMaxRecips = 500;
1565 * Send mails via the job queue. This can be useful to reduce the time it
1566 * takes to save a page that a lot of people are watching.
1568 $wgEnotifUseJobQ = false;
1571 * Use real name instead of username in e-mail "from" field.
1573 $wgEnotifUseRealName = false;
1576 * Array of usernames who will be sent a notification email for every change
1577 * which occurs on a wiki. Users will not be notified of their own changes.
1579 $wgUsersNotifiedOnAllChanges = array();
1581 /** @} */ # end of email settings
1583 /************************************************************************//**
1584 * @name Database settings
1585 * @{
1589 * Database host name or IP address
1591 $wgDBserver = 'localhost';
1594 * Database port number (for PostgreSQL and Microsoft SQL Server).
1596 $wgDBport = 5432;
1599 * Name of the database
1601 $wgDBname = 'my_wiki';
1604 * Database username
1606 $wgDBuser = 'wikiuser';
1609 * Database user's password
1611 $wgDBpassword = '';
1614 * Database type
1616 $wgDBtype = 'mysql';
1619 * Whether to use SSL in DB connection.
1621 * This setting is only used $wgLBFactoryConf['class'] is set to
1622 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1623 * the DBO_SSL flag must be set in the 'flags' option of the database
1624 * connection to achieve the same functionality.
1626 $wgDBssl = false;
1629 * Whether to use compression in DB connection.
1631 * This setting is only used $wgLBFactoryConf['class'] is set to
1632 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1633 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1634 * connection to achieve the same functionality.
1636 $wgDBcompress = false;
1639 * Separate username for maintenance tasks. Leave as null to use the default.
1641 $wgDBadminuser = null;
1644 * Separate password for maintenance tasks. Leave as null to use the default.
1646 $wgDBadminpassword = null;
1649 * Search type.
1650 * Leave as null to select the default search engine for the
1651 * selected database type (eg SearchMySQL), or set to a class
1652 * name to override to a custom search engine.
1654 $wgSearchType = null;
1657 * Alternative search types
1658 * Sometimes you want to support multiple search engines for testing. This
1659 * allows users to select their search engine of choice via url parameters
1660 * to Special:Search and the action=search API. If using this, there's no
1661 * need to add $wgSearchType to it, that is handled automatically.
1663 $wgSearchTypeAlternatives = null;
1666 * Table name prefix
1668 $wgDBprefix = '';
1671 * MySQL table options to use during installation or update
1673 $wgDBTableOptions = 'ENGINE=InnoDB';
1676 * SQL Mode - default is turning off all modes, including strict, if set.
1677 * null can be used to skip the setting for performance reasons and assume
1678 * DBA has done his best job.
1679 * String override can be used for some additional fun :-)
1681 $wgSQLMode = '';
1684 * Mediawiki schema
1686 $wgDBmwschema = null;
1689 * To override default SQLite data directory ($docroot/../data)
1691 $wgSQLiteDataDir = '';
1694 * Make all database connections secretly go to localhost. Fool the load balancer
1695 * thinking there is an arbitrarily large cluster of servers to connect to.
1696 * Useful for debugging.
1698 $wgAllDBsAreLocalhost = false;
1701 * Shared database for multiple wikis. Commonly used for storing a user table
1702 * for single sign-on. The server for this database must be the same as for the
1703 * main database.
1705 * For backwards compatibility the shared prefix is set to the same as the local
1706 * prefix, and the user table is listed in the default list of shared tables.
1707 * The user_properties table is also added so that users will continue to have their
1708 * preferences shared (preferences were stored in the user table prior to 1.16)
1710 * $wgSharedTables may be customized with a list of tables to share in the shared
1711 * database. However it is advised to limit what tables you do share as many of
1712 * MediaWiki's tables may have side effects if you try to share them.
1714 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1715 * $wgDBprefix.
1717 * $wgSharedSchema is the table schema for the shared database. It defaults to
1718 * $wgDBmwschema.
1720 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1721 * access remote databases. Using wfGetLB() allows the shared database to
1722 * reside on separate servers to the wiki's own database, with suitable
1723 * configuration of $wgLBFactoryConf.
1725 $wgSharedDB = null;
1728 * @see $wgSharedDB
1730 $wgSharedPrefix = false;
1733 * @see $wgSharedDB
1735 $wgSharedTables = array( 'user', 'user_properties' );
1738 * @see $wgSharedDB
1739 * @since 1.23
1741 $wgSharedSchema = false;
1744 * Database load balancer
1745 * This is a two-dimensional array, an array of server info structures
1746 * Fields are:
1747 * - host: Host name
1748 * - dbname: Default database name
1749 * - user: DB user
1750 * - password: DB password
1751 * - type: DB type
1753 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1754 * If this is zero for any given server, no normal query traffic will be
1755 * sent to it. It will be excluded from lag checks in maintenance scripts.
1756 * The only way it can receive traffic is if groupLoads is used.
1758 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1759 * to several groups, the most specific group defined here is used.
1761 * - flags: bit field
1762 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1763 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1764 * - DBO_TRX -- wrap entire request in a transaction
1765 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1766 * - DBO_PERSISTENT -- enables persistent database connections
1767 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1768 * - DBO_COMPRESS -- uses internal compression in database connections,
1769 * if available
1771 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1773 * These and any other user-defined properties will be assigned to the mLBInfo member
1774 * variable of the Database object.
1776 * Leave at false to use the single-server variables above. If you set this
1777 * variable, the single-server variables will generally be ignored (except
1778 * perhaps in some command-line scripts).
1780 * The first server listed in this array (with key 0) will be the master. The
1781 * rest of the servers will be slaves. To prevent writes to your slaves due to
1782 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1783 * slaves in my.cnf. You can set read_only mode at runtime using:
1785 * @code
1786 * SET @@read_only=1;
1787 * @endcode
1789 * Since the effect of writing to a slave is so damaging and difficult to clean
1790 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1791 * our masters, and then set read_only=0 on masters at runtime.
1793 $wgDBservers = false;
1796 * Load balancer factory configuration
1797 * To set up a multi-master wiki farm, set the class here to something that
1798 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1799 * The class identified here is responsible for reading $wgDBservers,
1800 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1802 * The LBFactoryMulti class is provided for this purpose, please see
1803 * includes/db/LBFactoryMulti.php for configuration information.
1805 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1808 * How long to wait for a slave to catch up to the master
1809 * @deprecated since 1.24
1811 $wgMasterWaitTimeout = 10;
1814 * File to log database errors to
1816 $wgDBerrorLog = false;
1819 * Timezone to use in the error log.
1820 * Defaults to the wiki timezone ($wgLocaltimezone).
1822 * A list of usable timezones can found at:
1823 * http://php.net/manual/en/timezones.php
1825 * @par Examples:
1826 * @code
1827 * $wgLocaltimezone = 'UTC';
1828 * $wgLocaltimezone = 'GMT';
1829 * $wgLocaltimezone = 'PST8PDT';
1830 * $wgLocaltimezone = 'Europe/Sweden';
1831 * $wgLocaltimezone = 'CET';
1832 * @endcode
1834 * @since 1.20
1836 $wgDBerrorLogTZ = false;
1839 * Scale load balancer polling time so that under overload conditions, the
1840 * database server receives a SHOW STATUS query at an average interval of this
1841 * many microseconds
1843 $wgDBAvgStatusPoll = 2000;
1846 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1847 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1849 * @warning THIS IS EXPERIMENTAL!
1851 * May break if you're not using the table defs from mysql5/tables.sql.
1852 * May break if you're upgrading an existing wiki if set differently.
1853 * Broken symptoms likely to include incorrect behavior with page titles,
1854 * usernames, comments etc containing non-ASCII characters.
1855 * Might also cause failures on the object cache and other things.
1857 * Even correct usage may cause failures with Unicode supplementary
1858 * characters (those not in the Basic Multilingual Plane) unless MySQL
1859 * has enhanced their Unicode support.
1861 $wgDBmysql5 = false;
1864 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1866 * To use this feature set to true and use a datasource defined as
1867 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1868 * block).
1870 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1871 * Pool) that maintains established sessions and reuses them on new
1872 * connections.
1874 * Not completely tested, but it should fall back on normal connection
1875 * in case the pool is full or the datasource is not configured as
1876 * pooled.
1877 * And the other way around; using oci_pconnect on a non pooled
1878 * datasource should produce a normal connection.
1880 * When it comes to frequent shortlived DB connections like with MW
1881 * Oracle tends to s***. The problem is the driver connects to the
1882 * database reasonably fast, but establishing a session takes time and
1883 * resources. MW does not rely on session state (as it does not use
1884 * features such as package variables) so establishing a valid session
1885 * is in this case an unwanted overhead that just slows things down.
1887 * @warning EXPERIMENTAL!
1890 $wgDBOracleDRCP = false;
1893 * Other wikis on this site, can be administered from a single developer
1894 * account.
1895 * Array numeric key => database name
1897 $wgLocalDatabases = array();
1900 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1901 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1902 * show a more obvious warning.
1904 $wgSlaveLagWarning = 10;
1907 * @see $wgSlaveLagWarning
1909 $wgSlaveLagCritical = 30;
1912 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1914 $wgDBWindowsAuthentication = false;
1916 /**@}*/ # End of DB settings }
1918 /************************************************************************//**
1919 * @name Text storage
1920 * @{
1924 * We can also compress text stored in the 'text' table. If this is set on, new
1925 * revisions will be compressed on page save if zlib support is available. Any
1926 * compressed revisions will be decompressed on load regardless of this setting,
1927 * but will not be readable at all* if zlib support is not available.
1929 $wgCompressRevisions = false;
1932 * External stores allow including content
1933 * from non database sources following URL links.
1935 * Short names of ExternalStore classes may be specified in an array here:
1936 * @code
1937 * $wgExternalStores = array("http","file","custom")...
1938 * @endcode
1940 * CAUTION: Access to database might lead to code execution
1942 $wgExternalStores = array();
1945 * An array of external MySQL servers.
1947 * @par Example:
1948 * Create a cluster named 'cluster1' containing three servers:
1949 * @code
1950 * $wgExternalServers = array(
1951 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1952 * );
1953 * @endcode
1955 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1956 * another class.
1958 $wgExternalServers = array();
1961 * The place to put new revisions, false to put them in the local text table.
1962 * Part of a URL, e.g. DB://cluster1
1964 * Can be an array instead of a single string, to enable data distribution. Keys
1965 * must be consecutive integers, starting at zero.
1967 * @par Example:
1968 * @code
1969 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1970 * @endcode
1972 * @var array
1974 $wgDefaultExternalStore = false;
1977 * Revision text may be cached in $wgMemc to reduce load on external storage
1978 * servers and object extraction overhead for frequently-loaded revisions.
1980 * Set to 0 to disable, or number of seconds before cache expiry.
1982 $wgRevisionCacheExpiry = 0;
1984 /** @} */ # end text storage }
1986 /************************************************************************//**
1987 * @name Performance hacks and limits
1988 * @{
1992 * Disable database-intensive features
1994 $wgMiserMode = false;
1997 * Disable all query pages if miser mode is on, not just some
1999 $wgDisableQueryPages = false;
2002 * Number of rows to cache in 'querycache' table when miser mode is on
2004 $wgQueryCacheLimit = 1000;
2007 * Number of links to a page required before it is deemed "wanted"
2009 $wgWantedPagesThreshold = 1;
2012 * Enable slow parser functions
2014 $wgAllowSlowParserFunctions = false;
2017 * Allow schema updates
2019 $wgAllowSchemaUpdates = true;
2022 * Maximum article size in kilobytes
2024 $wgMaxArticleSize = 2048;
2027 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2028 * raise PHP's memory limit if it's below this amount.
2030 $wgMemoryLimit = "50M";
2032 /** @} */ # end performance hacks }
2034 /************************************************************************//**
2035 * @name Cache settings
2036 * @{
2040 * Directory for caching data in the local filesystem. Should not be accessible
2041 * from the web. Set this to false to not use any local caches.
2043 * Note: if multiple wikis share the same localisation cache directory, they
2044 * must all have the same set of extensions. You can set a directory just for
2045 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2047 $wgCacheDirectory = false;
2050 * Main cache type. This should be a cache with fast access, but it may have
2051 * limited space. By default, it is disabled, since the database is not fast
2052 * enough to make it worthwhile.
2054 * The options are:
2056 * - CACHE_ANYTHING: Use anything, as long as it works
2057 * - CACHE_NONE: Do not cache
2058 * - CACHE_DB: Store cache objects in the DB
2059 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2060 * - CACHE_ACCEL: APC, XCache or WinCache
2061 * - (other): A string may be used which identifies a cache
2062 * configuration in $wgObjectCaches.
2064 * @see $wgMessageCacheType, $wgParserCacheType
2066 $wgMainCacheType = CACHE_NONE;
2069 * The cache type for storing the contents of the MediaWiki namespace. This
2070 * cache is used for a small amount of data which is expensive to regenerate.
2072 * For available types see $wgMainCacheType.
2074 $wgMessageCacheType = CACHE_ANYTHING;
2077 * The cache type for storing article HTML. This is used to store data which
2078 * is expensive to regenerate, and benefits from having plenty of storage space.
2080 * For available types see $wgMainCacheType.
2082 $wgParserCacheType = CACHE_ANYTHING;
2085 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2087 * For available types see $wgMainCacheType.
2089 $wgSessionCacheType = CACHE_ANYTHING;
2092 * The cache type for storing language conversion tables,
2093 * which are used when parsing certain text and interface messages.
2095 * For available types see $wgMainCacheType.
2097 * @since 1.20
2099 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2102 * Advanced object cache configuration.
2104 * Use this to define the class names and constructor parameters which are used
2105 * for the various cache types. Custom cache types may be defined here and
2106 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2107 * or $wgLanguageConverterCacheType.
2109 * The format is an associative array where the key is a cache identifier, and
2110 * the value is an associative array of parameters. The "class" parameter is the
2111 * class name which will be used. Alternatively, a "factory" parameter may be
2112 * given, giving a callable function which will generate a suitable cache object.
2114 $wgObjectCaches = array(
2115 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2116 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2118 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2119 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2120 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached', 'loggroup' => 'memcached' ),
2122 'apc' => array( 'class' => 'APCBagOStuff' ),
2123 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2124 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2125 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2126 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2127 'hash' => array( 'class' => 'HashBagOStuff' ),
2131 * Map of bloom filter store names to configuration arrays.
2133 * Example:
2134 * $wgBloomFilterStores['main'] = array(
2135 * 'cacheId' => 'main-v1',
2136 * 'class' => 'BloomCacheRedis',
2137 * 'redisServers' => array( '127.0.0.1:6379' ),
2138 * 'redisConfig' => array( 'connectTimeout' => 2 )
2139 * );
2141 * A primary bloom filter must be created manually.
2142 * Example in eval.php:
2143 * <code>
2144 * BloomCache::get( 'main' )->init( 'shared', 1000000000, .001 );
2145 * </code>
2146 * The size should be as large as practical given wiki size and resources.
2148 * @since 1.24
2150 $wgBloomFilterStores = array();
2153 * The expiry time for the parser cache, in seconds.
2154 * The default is 86400 (one day).
2156 $wgParserCacheExpireTime = 86400;
2159 * Deprecated alias for $wgSessionsInObjectCache.
2161 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2163 $wgSessionsInMemcached = false;
2166 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2167 * can be useful to improve performance, or to avoid the locking behavior of
2168 * PHP's default session handler, which tends to prevent multiple requests for
2169 * the same user from acting concurrently.
2171 $wgSessionsInObjectCache = false;
2174 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2175 * enabled, in seconds.
2177 $wgObjectCacheSessionExpiry = 3600;
2180 * This is used for setting php's session.save_handler. In practice, you will
2181 * almost never need to change this ever. Other options might be 'user' or
2182 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2183 * useful if you're doing cross-application sessions, see bug 11381)
2185 $wgSessionHandler = null;
2188 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2190 $wgMemCachedDebug = false;
2193 * The list of MemCached servers and port numbers
2195 $wgMemCachedServers = array( '127.0.0.1:11211' );
2198 * Use persistent connections to MemCached, which are shared across multiple
2199 * requests.
2201 $wgMemCachedPersistent = false;
2204 * Read/write timeout for MemCached server communication, in microseconds.
2206 $wgMemCachedTimeout = 500000;
2209 * Set this to true to make a local copy of the message cache, for use in
2210 * addition to memcached. The files will be put in $wgCacheDirectory.
2212 $wgUseLocalMessageCache = false;
2215 * Instead of caching everything, only cache those messages which have
2216 * been customised in the site content language. This means that
2217 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2218 * This option is probably only useful for translatewiki.net.
2220 $wgAdaptiveMessageCache = false;
2223 * Localisation cache configuration. Associative array with keys:
2224 * class: The class to use. May be overridden by extensions.
2226 * store: The location to store cache data. May be 'files', 'db' or
2227 * 'detect'. If set to "files", data will be in CDB files. If set
2228 * to "db", data will be stored to the database. If set to
2229 * "detect", files will be used if $wgCacheDirectory is set,
2230 * otherwise the database will be used.
2232 * storeClass: The class name for the underlying storage. If set to a class
2233 * name, it overrides the "store" setting.
2235 * storeDirectory: If the store class puts its data in files, this is the
2236 * directory it will use. If this is false, $wgCacheDirectory
2237 * will be used.
2239 * manualRecache: Set this to true to disable cache updates on web requests.
2240 * Use maintenance/rebuildLocalisationCache.php instead.
2242 $wgLocalisationCacheConf = array(
2243 'class' => 'LocalisationCache',
2244 'store' => 'detect',
2245 'storeClass' => false,
2246 'storeDirectory' => false,
2247 'manualRecache' => false,
2251 * Allow client-side caching of pages
2253 $wgCachePages = true;
2256 * Set this to current time to invalidate all prior cached pages. Affects both
2257 * client-side and server-side caching.
2258 * You can get the current date on your server by using the command:
2259 * @verbatim
2260 * date +%Y%m%d%H%M%S
2261 * @endverbatim
2263 $wgCacheEpoch = '20030516000000';
2266 * Directory where GitInfo will look for pre-computed cache files. If false,
2267 * $wgCacheDirectory/gitinfo will be used.
2269 $wgGitInfoCacheDirectory = false;
2272 * Bump this number when changing the global style sheets and JavaScript.
2274 * It should be appended in the query string of static CSS and JS includes,
2275 * to ensure that client-side caches do not keep obsolete copies of global
2276 * styles.
2278 $wgStyleVersion = '303';
2281 * This will cache static pages for non-logged-in users to reduce
2282 * database traffic on public sites.
2283 * Automatically sets $wgShowIPinHeader = false
2284 * ResourceLoader requests to default language and skins are cached
2285 * as well as single module requests.
2287 $wgUseFileCache = false;
2290 * Depth of the subdirectory hierarchy to be created under
2291 * $wgFileCacheDirectory. The subdirectories will be named based on
2292 * the MD5 hash of the title. A value of 0 means all cache files will
2293 * be put directly into the main file cache directory.
2295 $wgFileCacheDepth = 2;
2298 * Keep parsed pages in a cache (objectcache table or memcached)
2299 * to speed up output of the same page viewed by another user with the
2300 * same options.
2302 * This can provide a significant speedup for medium to large pages,
2303 * so you probably want to keep it on. Extensions that conflict with the
2304 * parser cache should disable the cache on a per-page basis instead.
2306 $wgEnableParserCache = true;
2309 * Append a configured value to the parser cache and the sitenotice key so
2310 * that they can be kept separate for some class of activity.
2312 $wgRenderHashAppend = '';
2315 * If on, the sidebar navigation links are cached for users with the
2316 * current language set. This can save a touch of load on a busy site
2317 * by shaving off extra message lookups.
2319 * However it is also fragile: changing the site configuration, or
2320 * having a variable $wgArticlePath, can produce broken links that
2321 * don't update as expected.
2323 $wgEnableSidebarCache = false;
2326 * Expiry time for the sidebar cache, in seconds
2328 $wgSidebarCacheExpiry = 86400;
2331 * When using the file cache, we can store the cached HTML gzipped to save disk
2332 * space. Pages will then also be served compressed to clients that support it.
2334 * Requires zlib support enabled in PHP.
2336 $wgUseGzip = false;
2339 * Whether MediaWiki should send an ETag header. Seems to cause
2340 * broken behavior with Squid 2.6, see bug 7098.
2342 $wgUseETag = false;
2345 * Clock skew or the one-second resolution of time() can occasionally cause cache
2346 * problems when the user requests two pages within a short period of time. This
2347 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2348 * a grace period.
2350 $wgClockSkewFudge = 5;
2353 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2354 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2355 * was previously done in the default LocalSettings.php file.
2357 * On high-traffic wikis, this should be set to false, to avoid the need to
2358 * check the file modification time, and to avoid the performance impact of
2359 * unnecessary cache invalidations.
2361 $wgInvalidateCacheOnLocalSettingsChange = true;
2364 * When loading extensions through the extension registration system, this
2365 * can be used to invalidate the cache. A good idea would be to set this to
2366 * one file, you can just `touch` that one to invalidate the cache
2368 * @par Example:
2369 * @code
2370 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2371 * @endcode
2373 * If set to false, the mtime for each individual JSON file will be checked,
2374 * which can be slow if a large number of extensions are being loaded.
2376 * @var int|bool
2378 $wgExtensionInfoMTime = false;
2380 /** @} */ # end of cache settings
2382 /************************************************************************//**
2383 * @name HTTP proxy (Squid) settings
2385 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2386 * although they are referred to as Squid settings for historical reasons.
2388 * Achieving a high hit ratio with an HTTP proxy requires special
2389 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2390 * more details.
2392 * @{
2396 * Enable/disable Squid.
2397 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2399 $wgUseSquid = false;
2402 * If you run Squid3 with ESI support, enable this (default:false):
2404 $wgUseESI = false;
2407 * Send X-Vary-Options header for better caching (requires patched Squid)
2409 $wgUseXVO = false;
2412 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2413 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2414 * and need to split the cache between HTTP and HTTPS for API requests,
2415 * feed requests and HTTP redirect responses in order to prevent cache
2416 * pollution. This does not affect 'normal' requests to index.php other than
2417 * HTTP redirects.
2419 $wgVaryOnXFP = false;
2422 * Internal server name as known to Squid, if different.
2424 * @par Example:
2425 * @code
2426 * $wgInternalServer = 'http://yourinternal.tld:8000';
2427 * @endcode
2429 $wgInternalServer = false;
2432 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2433 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2434 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2435 * days
2437 $wgSquidMaxage = 18000;
2440 * Default maximum age for raw CSS/JS accesses
2442 $wgForcedRawSMaxage = 300;
2445 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2447 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2448 * headers sent/modified from these proxies when obtaining the remote IP address
2450 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2452 $wgSquidServers = array();
2455 * As above, except these servers aren't purged on page changes; use to set a
2456 * list of trusted proxies, etc. Supports both individual IP addresses and
2457 * CIDR blocks.
2458 * @since 1.23 Supports CIDR ranges
2460 $wgSquidServersNoPurge = array();
2463 * Maximum number of titles to purge in any one client operation
2465 $wgMaxSquidPurgeTitles = 400;
2468 * Whether to use a Host header in purge requests sent to the proxy servers
2469 * configured in $wgSquidServers. Set this to false to support Squid
2470 * configured in forward-proxy mode.
2472 * If this is set to true, a Host header will be sent, and only the path
2473 * component of the URL will appear on the request line, as if the request
2474 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2475 * request. Squid supports this style of request only if reverse-proxy mode
2476 * (http_port ... accel) is enabled.
2478 * If this is set to false, no Host header will be sent, and the absolute URL
2479 * will be sent in the request line, as is the standard for an HTTP proxy
2480 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2481 * by Varnish, but is supported by Squid in either configuration (forward or
2482 * reverse).
2484 * @since 1.21
2486 $wgSquidPurgeUseHostHeader = true;
2489 * Routing configuration for HTCP multicast purging. Add elements here to
2490 * enable HTCP and determine which purges are sent where. If set to an empty
2491 * array, HTCP is disabled.
2493 * Each key in this array is a regular expression to match against the purged
2494 * URL, or an empty string to match all URLs. The purged URL is matched against
2495 * the regexes in the order specified, and the first rule whose regex matches
2496 * is used, all remaining rules will thus be ignored.
2498 * @par Example configuration to send purges for upload.wikimedia.org to one
2499 * multicast group and all other purges to another:
2500 * @code
2501 * $wgHTCPRouting = array(
2502 * '|^https?://upload\.wikimedia\.org|' => array(
2503 * 'host' => '239.128.0.113',
2504 * 'port' => 4827,
2505 * ),
2506 * '' => array(
2507 * 'host' => '239.128.0.112',
2508 * 'port' => 4827,
2509 * ),
2510 * );
2511 * @endcode
2513 * You can also pass an array of hosts to send purges too. This is useful when
2514 * you have several multicast groups or unicast address that should receive a
2515 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2517 * @par Example of sending purges to multiple hosts:
2518 * @code
2519 * $wgHTCPRouting = array(
2520 * '' => array(
2521 * // Purges to text caches using multicast
2522 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2523 * // Purges to a hardcoded list of caches
2524 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2525 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2526 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2527 * ),
2528 * );
2529 * @endcode
2531 * @since 1.22
2533 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2534 * For back compatibility purposes, whenever its array is empty
2535 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2537 * @see $wgHTCPMulticastTTL
2539 $wgHTCPRouting = array();
2542 * HTCP multicast TTL.
2543 * @see $wgHTCPRouting
2545 $wgHTCPMulticastTTL = 1;
2548 * Should forwarded Private IPs be accepted?
2550 $wgUsePrivateIPs = false;
2552 /** @} */ # end of HTTP proxy settings
2554 /************************************************************************//**
2555 * @name Language, regional and character encoding settings
2556 * @{
2560 * Site language code. See languages/Names.php for languages supported by
2561 * MediaWiki out of the box. Not all languages listed there have translations,
2562 * see languages/messages/ for the list of languages with some localisation.
2564 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2565 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2567 * This defines the default interface language for all users, but users can
2568 * change it in their preferences.
2570 * This also defines the language of pages in the wiki. The content is wrapped
2571 * in a html element with lang=XX attribute. This behavior can be overridden
2572 * via hooks, see Title::getPageLanguage.
2574 $wgLanguageCode = 'en';
2577 * Language cache size, or really how many languages can we handle
2578 * simultaneously without degrading to crawl speed.
2580 $wgLangObjCacheSize = 10;
2583 * Some languages need different word forms, usually for different cases.
2584 * Used in Language::convertGrammar().
2586 * @par Example:
2587 * @code
2588 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2589 * @endcode
2591 $wgGrammarForms = array();
2594 * Treat language links as magic connectors, not inline links
2596 $wgInterwikiMagic = true;
2599 * Hide interlanguage links from the sidebar
2601 $wgHideInterlanguageLinks = false;
2604 * List of additional interwiki prefixes that should be treated as
2605 * interlanguage links (i.e. placed in the sidebar).
2606 * Notes:
2607 * - This will not do anything unless the prefixes are defined in the interwiki
2608 * map.
2609 * - The display text for these custom interlanguage links will be fetched from
2610 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2611 * this array.
2612 * - A friendly name for each site, used for tooltip text, may optionally be
2613 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2614 * the prefix in this array.
2616 $wgExtraInterlanguageLinkPrefixes = array();
2619 * List of language names or overrides for default names in Names.php
2621 $wgExtraLanguageNames = array();
2624 * List of language codes that don't correspond to an actual language.
2625 * These codes are mostly left-offs from renames, or other legacy things.
2626 * This array makes them not appear as a selectable language on the installer,
2627 * and excludes them when running the transstat.php script.
2629 $wgDummyLanguageCodes = array(
2630 'als' => 'gsw',
2631 'bat-smg' => 'sgs',
2632 'be-x-old' => 'be-tarask',
2633 'bh' => 'bho',
2634 'fiu-vro' => 'vro',
2635 'no' => 'nb',
2636 'qqq' => 'qqq', # Used for message documentation.
2637 'qqx' => 'qqx', # Used for viewing message keys.
2638 'roa-rup' => 'rup',
2639 'simple' => 'en',
2640 'zh-classical' => 'lzh',
2641 'zh-min-nan' => 'nan',
2642 'zh-yue' => 'yue',
2646 * Character set for use in the article edit box. Language-specific encodings
2647 * may be defined.
2649 * This historic feature is one of the first that was added by former MediaWiki
2650 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2652 $wgEditEncoding = '';
2655 * Set this to true to replace Arabic presentation forms with their standard
2656 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2657 * set to "ar".
2659 * Note that pages with titles containing presentation forms will become
2660 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2662 $wgFixArabicUnicode = true;
2665 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2666 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2667 * set to "ml". Note that some clients (even new clients as of 2010) do not
2668 * support these characters.
2670 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2671 * fix any ZWJ sequences in existing page titles.
2673 $wgFixMalayalamUnicode = true;
2676 * Set this to always convert certain Unicode sequences to modern ones
2677 * regardless of the content language. This has a small performance
2678 * impact.
2680 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2681 * details.
2683 * @since 1.17
2685 $wgAllUnicodeFixes = false;
2688 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2689 * loading old revisions not marked with "utf-8" flag. Use this when
2690 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2691 * burdensome mass conversion of old text data.
2693 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2694 * user names, etc still must be converted en masse in the database before
2695 * continuing as a UTF-8 wiki.
2697 $wgLegacyEncoding = false;
2700 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2701 * regexps : "/regexp/" matching problematic browsers. These browsers will
2702 * be served encoded unicode in the edit box instead of real unicode.
2704 $wgBrowserBlackList = array(
2706 * Netscape 2-4 detection
2707 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2708 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2709 * with a negative assertion. The [UIN] identifier specifies the level of security
2710 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2711 * The language string is unreliable, it is missing on NS4 Mac.
2713 * Reference: http://www.psychedelix.com/agents/index.shtml
2715 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2716 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2717 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2720 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2721 * Þ to <THORN> and Ð to <ETH>
2723 * Known useragents:
2724 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2725 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2726 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2727 * - [...]
2729 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2730 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2732 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2735 * Google wireless transcoder, seems to eat a lot of chars alive
2736 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2738 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2742 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2743 * create stub reference rows in the text table instead of copying
2744 * the full text of all current entries from 'cur' to 'text'.
2746 * This will speed up the conversion step for large sites, but
2747 * requires that the cur table be kept around for those revisions
2748 * to remain viewable.
2750 * This option affects the updaters *only*. Any present cur stub
2751 * revisions will be readable at runtime regardless of this setting.
2753 $wgLegacySchemaConversion = false;
2756 * Enable dates like 'May 12' instead of '12 May', if the default date format
2757 * is 'dmy or mdy'.
2759 $wgAmericanDates = false;
2762 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2763 * numerals in interface.
2765 $wgTranslateNumerals = true;
2768 * Translation using MediaWiki: namespace.
2769 * Interface messages will be loaded from the database.
2771 $wgUseDatabaseMessages = true;
2774 * Expiry time for the message cache key
2776 $wgMsgCacheExpiry = 86400;
2779 * Maximum entry size in the message cache, in bytes
2781 $wgMaxMsgCacheEntrySize = 10000;
2784 * Whether to enable language variant conversion.
2786 $wgDisableLangConversion = false;
2789 * Whether to enable language variant conversion for links.
2791 $wgDisableTitleConversion = false;
2794 * Default variant code, if false, the default will be the language code
2796 $wgDefaultLanguageVariant = false;
2799 * Disabled variants array of language variant conversion.
2801 * @par Example:
2802 * @code
2803 * $wgDisabledVariants[] = 'zh-mo';
2804 * $wgDisabledVariants[] = 'zh-my';
2805 * @endcode
2807 $wgDisabledVariants = array();
2810 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2811 * path format that describes which parts of the URL contain the
2812 * language variant.
2814 * @par Example:
2815 * @code
2816 * $wgLanguageCode = 'sr';
2817 * $wgVariantArticlePath = '/$2/$1';
2818 * $wgArticlePath = '/wiki/$1';
2819 * @endcode
2821 * A link to /wiki/ would be redirected to /sr/Главна_страна
2823 * It is important that $wgArticlePath not overlap with possible values
2824 * of $wgVariantArticlePath.
2826 $wgVariantArticlePath = false;
2829 * Show a bar of language selection links in the user login and user
2830 * registration forms; edit the "loginlanguagelinks" message to
2831 * customise these.
2833 $wgLoginLanguageSelector = false;
2836 * When translating messages with wfMessage(), it is not always clear what
2837 * should be considered UI messages and what should be content messages.
2839 * For example, for the English Wikipedia, there should be only one 'mainpage',
2840 * so when getting the link for 'mainpage', we should treat it as site content
2841 * and call ->inContentLanguage()->text(), but for rendering the text of the
2842 * link, we call ->text(). The code behaves this way by default. However,
2843 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2844 * and the like for different languages. This array provides a way to override
2845 * the default behavior.
2847 * @par Example:
2848 * To allow language-specific main page and community
2849 * portal:
2850 * @code
2851 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2852 * @endcode
2854 $wgForceUIMsgAsContentMsg = array();
2857 * Fake out the timezone that the server thinks it's in. This will be used for
2858 * date display and not for what's stored in the DB. Leave to null to retain
2859 * your server's OS-based timezone value.
2861 * This variable is currently used only for signature formatting and for local
2862 * time/date parser variables ({{LOCALTIME}} etc.)
2864 * Timezones can be translated by editing MediaWiki messages of type
2865 * timezone-nameinlowercase like timezone-utc.
2867 * A list of usable timezones can found at:
2868 * http://php.net/manual/en/timezones.php
2870 * @par Examples:
2871 * @code
2872 * $wgLocaltimezone = 'UTC';
2873 * $wgLocaltimezone = 'GMT';
2874 * $wgLocaltimezone = 'PST8PDT';
2875 * $wgLocaltimezone = 'Europe/Sweden';
2876 * $wgLocaltimezone = 'CET';
2877 * @endcode
2879 $wgLocaltimezone = null;
2882 * Set an offset from UTC in minutes to use for the default timezone setting
2883 * for anonymous users and new user accounts.
2885 * This setting is used for most date/time displays in the software, and is
2886 * overridable in user preferences. It is *not* used for signature timestamps.
2888 * By default, this will be set to match $wgLocaltimezone.
2890 $wgLocalTZoffset = null;
2892 /** @} */ # End of language/charset settings
2894 /*************************************************************************//**
2895 * @name Output format and skin settings
2896 * @{
2900 * The default Content-Type header.
2902 $wgMimeType = 'text/html';
2905 * Previously used as content type in HTML script tags. This is now ignored since
2906 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2907 * It was also previously used by RawAction to determine the ctype query parameter
2908 * value that will result in a javascript response.
2909 * @deprecated since 1.22
2911 $wgJsMimeType = null;
2914 * The default xmlns attribute. The option to define this has been removed.
2915 * The value of this variable is no longer used by core and is set to a fixed
2916 * value in Setup.php for compatibility with extensions that depend on the value
2917 * of this variable being set. Such a dependency however is deprecated.
2918 * @deprecated since 1.22
2920 $wgXhtmlDefaultNamespace = null;
2923 * Previously used to determine if we should output an HTML5 doctype.
2924 * This is no longer used as we always output HTML5 now. For compatibility with
2925 * extensions that still check the value of this config it's value is now forced
2926 * to true by Setup.php.
2927 * @deprecated since 1.22
2929 $wgHtml5 = true;
2932 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2933 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2934 * (like if it's left at the default null value), it will be auto-initialized
2935 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2936 * ever actually set this to anything.
2938 $wgHtml5Version = null;
2941 * Temporary variable that allows HTMLForms to be rendered as tables.
2942 * Table based layouts cause various issues when designing for mobile.
2943 * This global allows skins or extensions a means to force non-table based rendering.
2944 * Setting to false forces form components to always render as div elements.
2945 * @since 1.24
2947 $wgHTMLFormAllowTableFormat = true;
2950 * Temporary variable that applies MediaWiki UI wherever it can be supported.
2951 * Temporary variable that should be removed when mediawiki ui is more
2952 * stable and change has been communicated.
2953 * @since 1.24
2955 $wgUseMediaWikiUIEverywhere = false;
2958 * Enabled RDFa attributes for use in wikitext.
2959 * NOTE: Interaction with HTML5 is somewhat underspecified.
2961 $wgAllowRdfaAttributes = false;
2964 * Enabled HTML5 microdata attributes for use in wikitext.
2966 $wgAllowMicrodataAttributes = false;
2969 * Should we try to make our HTML output well-formed XML? If set to false,
2970 * output will be a few bytes shorter, and the HTML will arguably be more
2971 * readable. If set to true, life will be much easier for the authors of
2972 * screen-scraping bots, and the HTML will arguably be more readable.
2974 * Setting this to false may omit quotation marks on some attributes, omit
2975 * slashes from some self-closing tags, omit some ending tags, etc., where
2976 * permitted by HTML5. Setting it to true will not guarantee that all pages
2977 * will be well-formed, although non-well-formed pages should be rare and it's
2978 * a bug if you find one. Conversely, setting it to false doesn't mean that
2979 * all XML-y constructs will be omitted, just that they might be.
2981 * Because of compatibility with screen-scraping bots, and because it's
2982 * controversial, this is currently left to true by default.
2984 $wgWellFormedXml = true;
2987 * Permit other namespaces in addition to the w3.org default.
2989 * Use the prefix for the key and the namespace for the value.
2991 * @par Example:
2992 * @code
2993 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2994 * @endcode
2995 * Normally we wouldn't have to define this in the root "<html>"
2996 * element, but IE needs it there in some circumstances.
2998 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3000 $wgXhtmlNamespaces = array();
3003 * Show IP address, for non-logged in users. It's necessary to switch this off
3004 * for some forms of caching.
3005 * @warning Will disable file cache.
3007 $wgShowIPinHeader = true;
3010 * Site notice shown at the top of each page
3012 * MediaWiki:Sitenotice page, which will override this. You can also
3013 * provide a separate message for logged-out users using the
3014 * MediaWiki:Anonnotice page.
3016 $wgSiteNotice = '';
3019 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3021 $wgSiteSupportPage = '';
3024 * Validate the overall output using tidy and refuse
3025 * to display the page if it's not valid.
3027 $wgValidateAllHtml = false;
3030 * Default skin, for new users and anonymous visitors. Registered users may
3031 * change this to any one of the other available skins in their preferences.
3033 $wgDefaultSkin = 'vector';
3036 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3038 * @since 1.24
3040 $wgFallbackSkin = 'fallback';
3043 * Specify the names of skins that should not be presented in the list of
3044 * available skins in user preferences. If you want to remove a skin entirely,
3045 * remove it from the skins/ directory and its entry from LocalSettings.php.
3047 $wgSkipSkins = array();
3050 * @deprecated since 1.23; use $wgSkipSkins instead
3052 $wgSkipSkin = '';
3055 * Allow user Javascript page?
3056 * This enables a lot of neat customizations, but may
3057 * increase security risk to users and server load.
3059 $wgAllowUserJs = false;
3062 * Allow user Cascading Style Sheets (CSS)?
3063 * This enables a lot of neat customizations, but may
3064 * increase security risk to users and server load.
3066 $wgAllowUserCss = false;
3069 * Allow user-preferences implemented in CSS?
3070 * This allows users to customise the site appearance to a greater
3071 * degree; disabling it will improve page load times.
3073 $wgAllowUserCssPrefs = true;
3076 * Use the site's Javascript page?
3078 $wgUseSiteJs = true;
3081 * Use the site's Cascading Style Sheets (CSS)?
3083 $wgUseSiteCss = true;
3086 * Break out of framesets. This can be used to prevent clickjacking attacks,
3087 * or to prevent external sites from framing your site with ads.
3089 $wgBreakFrames = false;
3092 * The X-Frame-Options header to send on pages sensitive to clickjacking
3093 * attacks, such as edit pages. This prevents those pages from being displayed
3094 * in a frame or iframe. The options are:
3096 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3098 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3099 * to allow framing within a trusted domain. This is insecure if there
3100 * is a page on the same domain which allows framing of arbitrary URLs.
3102 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3103 * full compromise of local user accounts. Private wikis behind a
3104 * corporate firewall are especially vulnerable. This is not
3105 * recommended.
3107 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3108 * not just edit pages.
3110 $wgEditPageFrameOptions = 'DENY';
3113 * Disallow framing of API pages directly, by setting the X-Frame-Options
3114 * header. Since the API returns CSRF tokens, allowing the results to be
3115 * framed can compromise your user's account security.
3116 * Options are:
3117 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3118 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3119 * - false: Allow all framing.
3120 * Note: $wgBreakFrames will override this for human formatted API output.
3122 $wgApiFrameOptions = 'DENY';
3125 * Disable output compression (enabled by default if zlib is available)
3127 $wgDisableOutputCompression = false;
3130 * Should we allow a broader set of characters in id attributes, per HTML5? If
3131 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3132 * functionality is ready, it will be on by default with no option.
3134 * Currently this appears to work fine in all browsers, but it's disabled by
3135 * default because it normalizes id's a bit too aggressively, breaking preexisting
3136 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3138 $wgExperimentalHtmlIds = false;
3141 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3142 * You can add new icons to the built in copyright or poweredby, or you can create
3143 * a new block. Though note that you may need to add some custom css to get good styling
3144 * of new blocks in monobook. vector and modern should work without any special css.
3146 * $wgFooterIcons itself is a key/value array.
3147 * The key is the name of a block that the icons will be wrapped in. The final id varies
3148 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3149 * turns it into mw_poweredby.
3150 * The value is either key/value array of icons or a string.
3151 * In the key/value array the key may or may not be used by the skin but it can
3152 * be used to find the icon and unset it or change the icon if needed.
3153 * This is useful for disabling icons that are set by extensions.
3154 * The value should be either a string or an array. If it is a string it will be output
3155 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3156 * for the icon, the following keys are used:
3157 * - src: An absolute url to the image to use for the icon, this is recommended
3158 * but not required, however some skins will ignore icons without an image
3159 * - srcset: optional additional-resolution images; see HTML5 specs
3160 * - url: The url to use in the a element around the text or icon, if not set an a element will
3161 * not be outputted
3162 * - alt: This is the text form of the icon, it will be displayed without an image in
3163 * skins like Modern or if src is not set, and will otherwise be used as
3164 * the alt="" for the image. This key is required.
3165 * - width and height: If the icon specified by src is not of the standard size
3166 * you can specify the size of image to use with these keys.
3167 * Otherwise they will default to the standard 88x31.
3168 * @todo Reformat documentation.
3170 $wgFooterIcons = array(
3171 "copyright" => array(
3172 "copyright" => array(), // placeholder for the built in copyright icon
3174 "poweredby" => array(
3175 "mediawiki" => array(
3176 "src" => null, // Defaults to point at
3177 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3178 // plus srcset for 1.5x, 2x resolution variants.
3179 "url" => "//www.mediawiki.org/",
3180 "alt" => "Powered by MediaWiki",
3186 * Login / create account link behavior when it's possible for anonymous users
3187 * to create an account.
3188 * - true = use a combined login / create account link
3189 * - false = split login and create account into two separate links
3191 $wgUseCombinedLoginLink = false;
3194 * Display user edit counts in various prominent places.
3196 $wgEdititis = false;
3199 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3200 * status code, mangling or hiding MediaWiki's output. If you are using such a
3201 * host, you should start looking for a better one. While you're doing that,
3202 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3203 * that the generated error pages can be seen.
3205 * In cases where for technical reasons it is more important for MediaWiki to
3206 * send the correct status code than for the body to be transmitted intact,
3207 * this configuration variable is ignored.
3209 $wgSend404Code = true;
3212 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3213 * rollback. The numeric value of the variable are the limit up to are counted.
3214 * If the value is false or 0, the edits are not counted. Disabling this will
3215 * furthermore prevent MediaWiki from hiding some useless rollback links.
3217 * @since 1.20
3219 $wgShowRollbackEditCount = 10;
3222 * Output a <link rel="canonical"> tag on every page indicating the canonical
3223 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3224 * detection of the current server is unreliable, the link is sent
3225 * unconditionally.
3227 $wgEnableCanonicalServerLink = false;
3230 * When OutputHandler is used, mangle any output that contains
3231 * <cross-domain-policy>. Without this, an attacker can send their own
3232 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3233 * the domain root.
3235 * @since 1.25
3237 $wgMangleFlashPolicy = true;
3239 /** @} */ # End of output format settings }
3241 /*************************************************************************//**
3242 * @name Resource loader settings
3243 * @{
3247 * Client-side resource modules.
3249 * Extensions should add their resource loader module definitions
3250 * to the $wgResourceModules variable.
3252 * @par Example:
3253 * @code
3254 * $wgResourceModules['ext.myExtension'] = array(
3255 * 'scripts' => 'myExtension.js',
3256 * 'styles' => 'myExtension.css',
3257 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3258 * 'localBasePath' => __DIR__,
3259 * 'remoteExtPath' => 'MyExtension',
3260 * );
3261 * @endcode
3263 $wgResourceModules = array();
3266 * Skin-specific styles for resource modules.
3268 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3269 * not be modified or disabled.
3271 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3273 * @par Example:
3274 * @code
3275 * $wgResourceModules['bar'] = array(
3276 * 'scripts' => 'resources/bar/bar.js',
3277 * 'styles' => 'resources/bar/main.css',
3278 * );
3280 * $wgResourceModuleSkinStyles['foo'] = array(
3281 * 'bar' => 'skins/Foo/bar.css',
3282 * );
3283 * @endcode
3285 * This is mostly equivalent to:
3287 * @par Equivalent:
3288 * @code
3289 * $wgResourceModules['bar'] = array(
3290 * 'scripts' => 'resources/bar/bar.js',
3291 * 'styles' => 'resources/bar/main.css',
3292 * 'skinStyles' => array(
3293 * 'foo' => skins/Foo/bar.css',
3294 * ),
3295 * );
3296 * @endcode
3298 * If the module already defines its own entry in `skinStyles` for a given skin, then
3299 * $wgResourceModuleSkinStyles is ignored.
3301 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3302 * of replacing them. This can be done using the `+` prefix.
3304 * @par Example:
3305 * @code
3306 * $wgResourceModules['bar'] = array(
3307 * 'scripts' => 'resources/bar/bar.js',
3308 * 'styles' => 'resources/bar/basic.css',
3309 * 'skinStyles' => array(
3310 * 'default' => 'resources/bar/additional.css',
3311 * ),
3312 * );
3313 * // Note the '+' character:
3314 * $wgResourceModuleSkinStyles['foo'] = array(
3315 * '+bar' => 'skins/Foo/bar.css',
3316 * );
3317 * @endcode
3319 * This is mostly equivalent to:
3321 * @par Equivalent:
3322 * @code
3323 * $wgResourceModules['bar'] = array(
3324 * 'scripts' => 'resources/bar/bar.js',
3325 * 'styles' => 'resources/bar/basic.css',
3326 * 'skinStyles' => array(
3327 * 'default' => 'resources/bar/additional.css',
3328 * 'foo' => array(
3329 * 'resources/bar/additional.css',
3330 * 'skins/Foo/bar.css',
3331 * ),
3332 * ),
3333 * );
3334 * @endcode
3336 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3337 * disabled by a skin. To provide default styles that may be extended or replaced,
3338 * use `skinStyles['default']`.
3340 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3341 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3342 * Either for all skin styles at once (first example below) or for each module separately (second
3343 * example).
3345 * @par Example:
3346 * @code
3347 * $wgResourceModuleSkinStyles['foo'] = array(
3348 * 'bar' => 'bar.css',
3349 * 'quux' => 'quux.css',
3350 * 'remoteSkinPath' => 'Foo',
3351 * 'localBasePath' => __DIR__,
3352 * );
3354 * $wgResourceModuleSkinStyles['foo'] = array(
3355 * 'bar' => array(
3356 * 'bar.css',
3357 * 'remoteSkinPath' => 'Foo',
3358 * 'localBasePath' => __DIR__,
3359 * ),
3360 * 'quux' => array(
3361 * 'quux.css',
3362 * 'remoteSkinPath' => 'Foo',
3363 * 'localBasePath' => __DIR__,
3364 * ),
3365 * );
3366 * @endcode
3368 $wgResourceModuleSkinStyles = array();
3371 * Extensions should register foreign module sources here. 'local' is a
3372 * built-in source that is not in this array, but defined by
3373 * ResourceLoader::__construct() so that it cannot be unset.
3375 * @par Example:
3376 * @code
3377 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3378 * @endcode
3380 $wgResourceLoaderSources = array();
3383 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3384 * If not set, then $wgScriptPath will be used as a fallback.
3386 $wgResourceBasePath = null;
3389 * Maximum time in seconds to cache resources served by the resource loader.
3390 * Used to set last modified headers (max-age/s-maxage).
3392 * Following options to distinguish:
3393 * - versioned: Used for modules with a version, because changing version
3394 * numbers causes cache misses. This normally has a long expiry time.
3395 * - unversioned: Used for modules without a version to propagate changes
3396 * quickly to clients. Also used for modules with errors to recover quickly.
3397 * This normally has a short expiry time.
3399 * Expiry time for the options to distinguish:
3400 * - server: Squid/Varnish but also any other public proxy cache between the
3401 * client and MediaWiki.
3402 * - client: On the client side (e.g. in the browser cache).
3404 $wgResourceLoaderMaxage = array(
3405 'versioned' => array(
3406 'server' => 30 * 24 * 60 * 60, // 30 days
3407 'client' => 30 * 24 * 60 * 60, // 30 days
3409 'unversioned' => array(
3410 'server' => 5 * 60, // 5 minutes
3411 'client' => 5 * 60, // 5 minutes
3416 * The default debug mode (on/off) for of ResourceLoader requests.
3418 * This will still be overridden when the debug URL parameter is used.
3420 $wgResourceLoaderDebug = false;
3423 * Enable embedding of certain resources using Edge Side Includes. This will
3424 * improve performance but only works if there is something in front of the
3425 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3427 $wgResourceLoaderUseESI = false;
3430 * Put each statement on its own line when minifying JavaScript. This makes
3431 * debugging in non-debug mode a bit easier.
3433 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3436 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3437 * the minifier will try not to produce lines longer than this, but may be
3438 * forced to do so in certain cases.
3440 $wgResourceLoaderMinifierMaxLineLength = 1000;
3443 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3444 * dependencies.
3446 $wgIncludeLegacyJavaScript = true;
3449 * Whether to preload the mediawiki.util module as blocking module in the top
3450 * queue.
3452 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3453 * allowed modules to lack dependencies on 'popular' modules that were likely
3454 * loaded already.
3456 * This setting is to aid scripts during migration by providing mediawiki.util
3457 * unconditionally (which was the most commonly missed dependency).
3458 * It doesn't cover all missing dependencies obviously but should fix most of
3459 * them.
3461 * This should be removed at some point after site/user scripts have been fixed.
3462 * Enable this if your wiki has a large amount of user/site scripts that are
3463 * lacking dependencies.
3464 * @todo Deprecate
3466 $wgPreloadJavaScriptMwUtil = false;
3469 * Whether or not to assign configuration variables to the global window object.
3471 * If this is set to false, old code using deprecated variables will no longer
3472 * work.
3474 * @par Example of legacy code:
3475 * @code{,js}
3476 * if ( window.wgRestrictionEdit ) { ... }
3477 * @endcode
3478 * or:
3479 * @code{,js}
3480 * if ( wgIsArticle ) { ... }
3481 * @endcode
3483 * Instead, one needs to use mw.config.
3484 * @par Example using mw.config global configuration:
3485 * @code{,js}
3486 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3487 * @endcode
3488 * or:
3489 * @code{,js}
3490 * if ( mw.config.get('wgIsArticle') ) { ... }
3491 * @endcode
3493 $wgLegacyJavaScriptGlobals = true;
3496 * If set to a positive number, ResourceLoader will not generate URLs whose
3497 * query string is more than this many characters long, and will instead use
3498 * multiple requests with shorter query strings. This degrades performance,
3499 * but may be needed if your web server has a low (less than, say 1024)
3500 * query string length limit or a low value for suhosin.get.max_value_length
3501 * that you can't increase.
3503 * If set to a negative number, ResourceLoader will assume there is no query
3504 * string length limit.
3506 * Defaults to a value based on php configuration.
3508 $wgResourceLoaderMaxQueryLength = false;
3511 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3512 * prior to minification to validate it.
3514 * Parse errors will result in a JS exception being thrown during module load,
3515 * which avoids breaking other modules loaded in the same request.
3517 $wgResourceLoaderValidateJS = true;
3520 * If set to true, statically-sourced (file-backed) JavaScript resources will
3521 * be parsed for validity before being bundled up into ResourceLoader modules.
3523 * This can be helpful for development by providing better error messages in
3524 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3525 * and may fail on large pre-bundled frameworks.
3527 $wgResourceLoaderValidateStaticJS = false;
3530 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3531 * will be enabled. This is an experimental feature that's supposed to make
3532 * JavaScript load faster.
3534 $wgResourceLoaderExperimentalAsyncLoading = false;
3537 * Global LESS variables. An associative array binding variable names to
3538 * LESS code snippets representing their values.
3540 * Adding an item here is equivalent to writing `@variable: value;`
3541 * at the beginning of all your .less files, with all the consequences.
3542 * In particular, string values must be escaped and quoted.
3544 * Changes to LESS variables do not trigger cache invalidation.
3546 * If the LESS variables need to be dynamic, you can use the
3547 * ResourceLoaderGetLessVars hook (since 1.25).
3549 * @par Example:
3550 * @code
3551 * $wgResourceLoaderLESSVars = array(
3552 * 'baseFontSize' => '1em',
3553 * 'smallFontSize' => '0.75em',
3554 * 'WikimediaBlue' => '#006699',
3555 * );
3556 * @endcode
3557 * @since 1.22
3559 $wgResourceLoaderLESSVars = array();
3562 * Custom LESS functions. An associative array mapping function name to PHP
3563 * callable.
3565 * Changes to LESS functions do not trigger cache invalidation.
3567 * @since 1.22
3568 * @deprecated since 1.24 Questionable usefulness and problematic to support,
3569 * will be removed in the future.
3571 $wgResourceLoaderLESSFunctions = array();
3574 * Default import paths for LESS modules. LESS files referenced in @import
3575 * statements will be looked up here first, and relative to the importing file
3576 * second. To avoid collisions, it's important for the LESS files in these
3577 * directories to have a common, predictable file name prefix.
3579 * Extensions need not (and should not) register paths in
3580 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3581 * currently compiling LESS file, which allows each extension to freely import
3582 * files from its own tree.
3584 * @since 1.22
3586 $wgResourceLoaderLESSImportPaths = array(
3587 "$IP/resources/src/mediawiki.less/",
3591 * Whether ResourceLoader should attempt to persist modules in localStorage on
3592 * browsers that support the Web Storage API.
3594 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3596 $wgResourceLoaderStorageEnabled = false;
3599 * Cache version for client-side ResourceLoader module storage. You can trigger
3600 * invalidation of the contents of the module store by incrementing this value.
3602 * @since 1.23
3604 $wgResourceLoaderStorageVersion = 1;
3607 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3608 * restricted pages like Special:UserLogin or Special:Preferences where
3609 * JavaScript is disabled for security reasons. As it is possible to
3610 * execute JavaScript through CSS, setting this to true opens up a
3611 * potential security hole. Some sites may "skin" their wiki by using
3612 * site-wide CSS, causing restricted pages to look unstyled and different
3613 * from the rest of the site.
3615 * @since 1.25
3617 $wgAllowSiteCSSOnRestrictedPages = false;
3619 /** @} */ # End of resource loader settings }
3621 /*************************************************************************//**
3622 * @name Page title and interwiki link settings
3623 * @{
3627 * Name of the project namespace. If left set to false, $wgSitename will be
3628 * used instead.
3630 $wgMetaNamespace = false;
3633 * Name of the project talk namespace.
3635 * Normally you can ignore this and it will be something like
3636 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3637 * manually for grammatical reasons.
3639 $wgMetaNamespaceTalk = false;
3642 * Additional namespaces. If the namespaces defined in Language.php and
3643 * Namespace.php are insufficient, you can create new ones here, for example,
3644 * to import Help files in other languages. You can also override the namespace
3645 * names of existing namespaces. Extensions developers should use
3646 * $wgCanonicalNamespaceNames.
3648 * @warning Once you delete a namespace, the pages in that namespace will
3649 * no longer be accessible. If you rename it, then you can access them through
3650 * the new namespace name.
3652 * Custom namespaces should start at 100 to avoid conflicting with standard
3653 * namespaces, and should always follow the even/odd main/talk pattern.
3655 * @par Example:
3656 * @code
3657 * $wgExtraNamespaces = array(
3658 * 100 => "Hilfe",
3659 * 101 => "Hilfe_Diskussion",
3660 * 102 => "Aide",
3661 * 103 => "Discussion_Aide"
3662 * );
3663 * @endcode
3665 * @todo Add a note about maintenance/namespaceDupes.php
3667 $wgExtraNamespaces = array();
3670 * Same as above, but for namespaces with gender distinction.
3671 * Note: the default form for the namespace should also be set
3672 * using $wgExtraNamespaces for the same index.
3673 * @since 1.18
3675 $wgExtraGenderNamespaces = array();
3678 * Namespace aliases.
3680 * These are alternate names for the primary localised namespace names, which
3681 * are defined by $wgExtraNamespaces and the language file. If a page is
3682 * requested with such a prefix, the request will be redirected to the primary
3683 * name.
3685 * Set this to a map from namespace names to IDs.
3687 * @par Example:
3688 * @code
3689 * $wgNamespaceAliases = array(
3690 * 'Wikipedian' => NS_USER,
3691 * 'Help' => 100,
3692 * );
3693 * @endcode
3695 $wgNamespaceAliases = array();
3698 * Allowed title characters -- regex character class
3699 * Don't change this unless you know what you're doing
3701 * Problematic punctuation:
3702 * - []{}|# Are needed for link syntax, never enable these
3703 * - <> Causes problems with HTML escaping, don't use
3704 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3705 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3706 * corrupted by apache
3707 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3709 * All three of these punctuation problems can be avoided by using an alias,
3710 * instead of a rewrite rule of either variety.
3712 * The problem with % is that when using a path to query rewrite rule, URLs are
3713 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3714 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3715 * for this, indeed double escaping would break if the double-escaped title was
3716 * passed in the query string rather than the path. This is a minor security issue
3717 * because articles can be created such that they are hard to view or edit.
3719 * In some rare cases you may wish to remove + for compatibility with old links.
3721 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3722 * this breaks interlanguage links
3724 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3727 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3729 * @deprecated since 1.23; use $wgLocalInterwikis instead
3731 $wgLocalInterwiki = false;
3734 * Array for multiple $wgLocalInterwiki values, in case there are several
3735 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3736 * set, its value is prepended to this array, for backwards compatibility.
3738 * Note, recent changes feeds use only the first entry in this array (or
3739 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3741 $wgLocalInterwikis = array();
3744 * Expiry time for cache of interwiki table
3746 $wgInterwikiExpiry = 10800;
3749 * @name Interwiki caching settings.
3750 * @{
3754 *$wgInterwikiCache specifies path to constant database file.
3756 * This cdb database is generated by dumpInterwiki from maintenance and has
3757 * such key formats:
3758 * - dbname:key - a simple key (e.g. enwiki:meta)
3759 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3760 * - __global:key - global-scope key (e.g. __global:meta)
3761 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3763 * Sites mapping just specifies site name, other keys provide "local url"
3764 * data layout.
3766 $wgInterwikiCache = false;
3769 * Specify number of domains to check for messages.
3770 * - 1: Just wiki(db)-level
3771 * - 2: wiki and global levels
3772 * - 3: site levels
3774 $wgInterwikiScopes = 3;
3777 * Fallback site, if unable to resolve from cache
3779 $wgInterwikiFallbackSite = 'wiki';
3781 /** @} */ # end of Interwiki caching settings.
3784 * @name SiteStore caching settings.
3785 * @{
3789 * Specify the file location for the SiteStore json cache file.
3791 $wgSitesCacheFile = false;
3793 /** @} */ # end of SiteStore caching settings.
3796 * If local interwikis are set up which allow redirects,
3797 * set this regexp to restrict URLs which will be displayed
3798 * as 'redirected from' links.
3800 * @par Example:
3801 * It might look something like this:
3802 * @code
3803 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3804 * @endcode
3806 * Leave at false to avoid displaying any incoming redirect markers.
3807 * This does not affect intra-wiki redirects, which don't change
3808 * the URL.
3810 $wgRedirectSources = false;
3813 * Set this to false to avoid forcing the first letter of links to capitals.
3815 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3816 * appearing with a capital at the beginning of a sentence will *not* go to the
3817 * same place as links in the middle of a sentence using a lowercase initial.
3819 $wgCapitalLinks = true;
3822 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3823 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3824 * true by default (and setting them has no effect), due to various things that
3825 * require them to be so. Also, since Talk namespaces need to directly mirror their
3826 * associated content namespaces, the values for those are ignored in favor of the
3827 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3828 * NS_FILE.
3830 * @par Example:
3831 * @code
3832 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3833 * @endcode
3835 $wgCapitalLinkOverrides = array();
3838 * Which namespaces should support subpages?
3839 * See Language.php for a list of namespaces.
3841 $wgNamespacesWithSubpages = array(
3842 NS_TALK => true,
3843 NS_USER => true,
3844 NS_USER_TALK => true,
3845 NS_PROJECT => true,
3846 NS_PROJECT_TALK => true,
3847 NS_FILE_TALK => true,
3848 NS_MEDIAWIKI => true,
3849 NS_MEDIAWIKI_TALK => true,
3850 NS_TEMPLATE_TALK => true,
3851 NS_HELP => true,
3852 NS_HELP_TALK => true,
3853 NS_CATEGORY_TALK => true
3857 * Array holding default tracking category names.
3859 * Array contains the system messages for each tracking category.
3860 * Tracking categories allow pages with certain characteristics to be tracked.
3861 * It works by adding any such page to a category automatically.
3863 * A message with the suffix '-desc' should be added as a description message
3864 * to have extra information on Special:TrackingCategories.
3866 * @deprecated since 1.25 Extensions should now register tracking categories using
3867 * the new extension registration system.
3869 * @since 1.23
3871 $wgTrackingCategories = array();
3874 * Array of namespaces which can be deemed to contain valid "content", as far
3875 * as the site statistics are concerned. Useful if additional namespaces also
3876 * contain "content" which should be considered when generating a count of the
3877 * number of articles in the wiki.
3879 $wgContentNamespaces = array( NS_MAIN );
3882 * Max number of redirects to follow when resolving redirects.
3883 * 1 means only the first redirect is followed (default behavior).
3884 * 0 or less means no redirects are followed.
3886 $wgMaxRedirects = 1;
3889 * Array of invalid page redirect targets.
3890 * Attempting to create a redirect to any of the pages in this array
3891 * will make the redirect fail.
3892 * Userlogout is hard-coded, so it does not need to be listed here.
3893 * (bug 10569) Disallow Mypage and Mytalk as well.
3895 * As of now, this only checks special pages. Redirects to pages in
3896 * other namespaces cannot be invalidated by this variable.
3898 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3900 /** @} */ # End of title and interwiki settings }
3902 /************************************************************************//**
3903 * @name Parser settings
3904 * These settings configure the transformation from wikitext to HTML.
3905 * @{
3909 * Parser configuration. Associative array with the following members:
3911 * class The class name
3913 * preprocessorClass The preprocessor class. Two classes are currently available:
3914 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3915 * storage, and Preprocessor_DOM, which uses the DOM module for
3916 * temporary storage. Preprocessor_DOM generally uses less memory;
3917 * the speed of the two is roughly the same.
3919 * If this parameter is not given, it uses Preprocessor_DOM if the
3920 * DOM module is available, otherwise it uses Preprocessor_Hash.
3922 * The entire associative array will be passed through to the constructor as
3923 * the first parameter. Note that only Setup.php can use this variable --
3924 * the configuration will change at runtime via $wgParser member functions, so
3925 * the contents of this variable will be out-of-date. The variable can only be
3926 * changed during LocalSettings.php, in particular, it can't be changed during
3927 * an extension setup function.
3929 $wgParserConf = array(
3930 'class' => 'Parser',
3931 #'preprocessorClass' => 'Preprocessor_Hash',
3935 * Maximum indent level of toc.
3937 $wgMaxTocLevel = 999;
3940 * A complexity limit on template expansion: the maximum number of nodes visited
3941 * by PPFrame::expand()
3943 $wgMaxPPNodeCount = 1000000;
3946 * A complexity limit on template expansion: the maximum number of elements
3947 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3948 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3949 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3950 * this default corresponds to about 155 MB.
3952 * When the limit is exceeded, an exception is thrown.
3954 $wgMaxGeneratedPPNodeCount = 1000000;
3957 * Maximum recursion depth for templates within templates.
3958 * The current parser adds two levels to the PHP call stack for each template,
3959 * and xdebug limits the call stack to 100 by default. So this should hopefully
3960 * stop the parser before it hits the xdebug limit.
3962 $wgMaxTemplateDepth = 40;
3965 * @see $wgMaxTemplateDepth
3967 $wgMaxPPExpandDepth = 40;
3970 * URL schemes that should be recognized as valid by wfParseUrl().
3972 * WARNING: Do not add 'file:' to this or internal file links will be broken.
3973 * Instead, if you want to support file links, add 'file://'. The same applies
3974 * to any other protocols with the same name as a namespace. See bug #44011 for
3975 * more information.
3977 * @see wfParseUrl
3979 $wgUrlProtocols = array(
3980 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3981 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3982 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3983 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3987 * If true, removes (substitutes) templates in "~~~~" signatures.
3989 $wgCleanSignatures = true;
3992 * Whether to allow inline image pointing to other websites
3994 $wgAllowExternalImages = false;
3997 * If the above is false, you can specify an exception here. Image URLs
3998 * that start with this string are then rendered, while all others are not.
3999 * You can use this to set up a trusted, simple repository of images.
4000 * You may also specify an array of strings to allow multiple sites
4002 * @par Examples:
4003 * @code
4004 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4005 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4006 * @endcode
4008 $wgAllowExternalImagesFrom = '';
4011 * If $wgAllowExternalImages is false, you can allow an on-wiki
4012 * whitelist of regular expression fragments to match the image URL
4013 * against. If the image matches one of the regular expression fragments,
4014 * The image will be displayed.
4016 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4017 * Or false to disable it
4019 $wgEnableImageWhitelist = true;
4022 * A different approach to the above: simply allow the "<img>" tag to be used.
4023 * This allows you to specify alt text and other attributes, copy-paste HTML to
4024 * your wiki more easily, etc. However, allowing external images in any manner
4025 * will allow anyone with editing rights to snoop on your visitors' IP
4026 * addresses and so forth, if they wanted to, by inserting links to images on
4027 * sites they control.
4029 $wgAllowImageTag = false;
4032 * $wgUseTidy: use tidy to make sure HTML output is sane.
4033 * Tidy is a free tool that fixes broken HTML.
4034 * See http://www.w3.org/People/Raggett/tidy/
4036 * - $wgTidyBin should be set to the path of the binary and
4037 * - $wgTidyConf to the path of the configuration file.
4038 * - $wgTidyOpts can include any number of parameters.
4039 * - $wgTidyInternal controls the use of the PECL extension or the
4040 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
4041 * of spawning a separate program.
4042 * Normally you shouldn't need to override the setting except for
4043 * debugging. To install, use 'pear install tidy' and add a line
4044 * 'extension=tidy.so' to php.ini.
4046 $wgUseTidy = false;
4049 * @see $wgUseTidy
4051 $wgAlwaysUseTidy = false;
4054 * @see $wgUseTidy
4056 $wgTidyBin = 'tidy';
4059 * @see $wgUseTidy
4061 $wgTidyConf = $IP . '/includes/tidy.conf';
4064 * @see $wgUseTidy
4066 $wgTidyOpts = '';
4069 * @see $wgUseTidy
4071 $wgTidyInternal = extension_loaded( 'tidy' );
4074 * Put tidy warnings in HTML comments
4075 * Only works for internal tidy.
4077 $wgDebugTidy = false;
4080 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4081 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4082 * TO RESTRICT EDITING to only those that you trust
4084 $wgRawHtml = false;
4087 * Set a default target for external links, e.g. _blank to pop up a new window
4089 $wgExternalLinkTarget = false;
4092 * If true, external URL links in wiki text will be given the
4093 * rel="nofollow" attribute as a hint to search engines that
4094 * they should not be followed for ranking purposes as they
4095 * are user-supplied and thus subject to spamming.
4097 $wgNoFollowLinks = true;
4100 * Namespaces in which $wgNoFollowLinks doesn't apply.
4101 * See Language.php for a list of namespaces.
4103 $wgNoFollowNsExceptions = array();
4106 * If this is set to an array of domains, external links to these domain names
4107 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4108 * value of $wgNoFollowLinks. For instance:
4110 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4111 * 'mediawiki.org' );
4113 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4114 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4115 * etc.
4117 * Defaults to mediawiki.org for the links included in the software by default.
4119 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4122 * Allow DISPLAYTITLE to change title display
4124 $wgAllowDisplayTitle = true;
4127 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4128 * canonical DB key. Also disallow some inline CSS rules like display: none;
4129 * which can cause the text to be hidden or unselectable.
4131 $wgRestrictDisplayTitle = true;
4134 * Maximum number of calls per parse to expensive parser functions such as
4135 * PAGESINCATEGORY.
4137 $wgExpensiveParserFunctionLimit = 100;
4140 * Preprocessor caching threshold
4141 * Setting it to 'false' will disable the preprocessor cache.
4143 $wgPreprocessorCacheThreshold = 1000;
4146 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4148 $wgEnableScaryTranscluding = false;
4151 * Expiry time for transcluded templates cached in transcache database table.
4152 * Only used $wgEnableInterwikiTranscluding is set to true.
4154 $wgTranscludeCacheExpiry = 3600;
4156 /** @} */ # end of parser settings }
4158 /************************************************************************//**
4159 * @name Statistics
4160 * @{
4164 * Method used to determine if a page in a content namespace should be counted
4165 * as a valid article.
4167 * Redirect pages will never be counted as valid articles.
4169 * This variable can have the following values:
4170 * - 'any': all pages as considered as valid articles
4171 * - 'comma': the page must contain a comma to be considered valid
4172 * - 'link': the page must contain a [[wiki link]] to be considered valid
4174 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4176 * Retroactively changing this variable will not affect the existing count,
4177 * to update it, you will need to run the maintenance/updateArticleCount.php
4178 * script.
4180 $wgArticleCountMethod = 'link';
4183 * How many days user must be idle before he is considered inactive. Will affect
4184 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4185 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4186 * You might want to leave this as the default value, to provide comparable
4187 * numbers between different wikis.
4189 $wgActiveUserDays = 30;
4191 /** @} */ # End of statistics }
4193 /************************************************************************//**
4194 * @name User accounts, authentication
4195 * @{
4199 * For compatibility with old installations set to false
4200 * @deprecated since 1.24 will be removed in future
4202 $wgPasswordSalt = true;
4205 * Specifies the minimal length of a user password. If set to 0, empty pass-
4206 * words are allowed.
4208 $wgMinimalPasswordLength = 1;
4211 * Specifies if users should be sent to a password-reset form on login, if their
4212 * password doesn't meet the requirements of User::isValidPassword().
4213 * @since 1.23
4215 $wgInvalidPasswordReset = true;
4218 * Default password type to use when hashing user passwords
4220 * @since 1.24
4222 $wgPasswordDefault = 'pbkdf2';
4225 * Configuration for built-in password types. Maps the password type
4226 * to an array of options. The 'class' option is the Password class to
4227 * use. All other options are class-dependent.
4229 * An advanced example:
4230 * @code
4231 * $wgPasswordConfig['bcrypt-peppered'] = array(
4232 * 'class' => 'EncryptedPassword',
4233 * 'underlying' => 'bcrypt',
4234 * 'secrets' => array(),
4235 * 'cipher' => MCRYPT_RIJNDAEL_256,
4236 * 'mode' => MCRYPT_MODE_CBC,
4237 * 'cost' => 5,
4238 * );
4239 * @endcode
4241 * @since 1.24
4243 $wgPasswordConfig = array(
4244 'A' => array(
4245 'class' => 'MWOldPassword',
4247 'B' => array(
4248 'class' => 'MWSaltedPassword',
4250 'pbkdf2-legacyA' => array(
4251 'class' => 'LayeredParameterizedPassword',
4252 'types' => array(
4253 'A',
4254 'pbkdf2',
4257 'pbkdf2-legacyB' => array(
4258 'class' => 'LayeredParameterizedPassword',
4259 'types' => array(
4260 'B',
4261 'pbkdf2',
4264 'bcrypt' => array(
4265 'class' => 'BcryptPassword',
4266 'cost' => 9,
4268 'pbkdf2' => array(
4269 'class' => 'Pbkdf2Password',
4270 'algo' => 'sha256',
4271 'cost' => '10000',
4272 'length' => '128',
4277 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4278 * with a temporary password you can use to get back into the account") identified by
4279 * various bits of data. Setting all of these to false (or the whole variable to false)
4280 * has the effect of disabling password resets entirely
4282 $wgPasswordResetRoutes = array(
4283 'username' => true,
4284 'email' => false,
4288 * Maximum number of Unicode characters in signature
4290 $wgMaxSigChars = 255;
4293 * Maximum number of bytes in username. You want to run the maintenance
4294 * script ./maintenance/checkUsernames.php once you have changed this value.
4296 $wgMaxNameChars = 255;
4299 * Array of usernames which may not be registered or logged in from
4300 * Maintenance scripts can still use these
4302 $wgReservedUsernames = array(
4303 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4304 'Conversion script', // Used for the old Wikipedia software upgrade
4305 'Maintenance script', // Maintenance scripts which perform editing, image import script
4306 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4307 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4308 'msg:double-redirect-fixer', // Automatic double redirect fix
4309 'msg:usermessage-editor', // Default user for leaving user messages
4310 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4314 * Settings added to this array will override the default globals for the user
4315 * preferences used by anonymous visitors and newly created accounts.
4316 * For instance, to disable editing on double clicks:
4317 * $wgDefaultUserOptions ['editondblclick'] = 0;
4319 $wgDefaultUserOptions = array(
4320 'ccmeonemails' => 0,
4321 'cols' => 80,
4322 'date' => 'default',
4323 'diffonly' => 0,
4324 'disablemail' => 0,
4325 'editfont' => 'default',
4326 'editondblclick' => 0,
4327 'editsectiononrightclick' => 0,
4328 'enotifminoredits' => 0,
4329 'enotifrevealaddr' => 0,
4330 'enotifusertalkpages' => 1,
4331 'enotifwatchlistpages' => 1,
4332 'extendwatchlist' => 1,
4333 'fancysig' => 0,
4334 'forceeditsummary' => 0,
4335 'gender' => 'unknown',
4336 'hideminor' => 0,
4337 'hidepatrolled' => 0,
4338 'imagesize' => 2,
4339 'math' => 1,
4340 'minordefault' => 0,
4341 'newpageshidepatrolled' => 0,
4342 'nickname' => '',
4343 'norollbackdiff' => 0,
4344 'numberheadings' => 0,
4345 'previewonfirst' => 0,
4346 'previewontop' => 1,
4347 'rcdays' => 7,
4348 'rclimit' => 50,
4349 'rows' => 25,
4350 'showhiddencats' => 0,
4351 'shownumberswatching' => 1,
4352 'showtoolbar' => 1,
4353 'skin' => false,
4354 'stubthreshold' => 0,
4355 'thumbsize' => 5,
4356 'underline' => 2,
4357 'uselivepreview' => 0,
4358 'usenewrc' => 1,
4359 'watchcreations' => 1,
4360 'watchdefault' => 1,
4361 'watchdeletion' => 0,
4362 'watchlistdays' => 3.0,
4363 'watchlisthideanons' => 0,
4364 'watchlisthidebots' => 0,
4365 'watchlisthideliu' => 0,
4366 'watchlisthideminor' => 0,
4367 'watchlisthideown' => 0,
4368 'watchlisthidepatrolled' => 0,
4369 'watchmoves' => 0,
4370 'watchrollback' => 0,
4371 'wllimit' => 250,
4372 'useeditwarning' => 1,
4373 'prefershttps' => 1,
4377 * An array of preferences to not show for the user
4379 $wgHiddenPrefs = array();
4382 * Characters to prevent during new account creations.
4383 * This is used in a regular expression character class during
4384 * registration (regex metacharacters like / are escaped).
4386 $wgInvalidUsernameCharacters = '@';
4389 * Character used as a delimiter when testing for interwiki userrights
4390 * (In Special:UserRights, it is possible to modify users on different
4391 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4393 * It is recommended that you have this delimiter in
4394 * $wgInvalidUsernameCharacters above, or you will not be able to
4395 * modify the user rights of those users via Special:UserRights
4397 $wgUserrightsInterwikiDelimiter = '@';
4400 * This is to let user authenticate using https when they come from http.
4401 * Based on an idea by George Herbert on wikitech-l:
4402 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4403 * @since 1.17
4405 $wgSecureLogin = false;
4407 /** @} */ # end user accounts }
4409 /************************************************************************//**
4410 * @name User rights, access control and monitoring
4411 * @{
4415 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4417 $wgAutoblockExpiry = 86400;
4420 * Set this to true to allow blocked users to edit their own user talk page.
4422 $wgBlockAllowsUTEdit = false;
4425 * Allow sysops to ban users from accessing Emailuser
4427 $wgSysopEmailBans = true;
4430 * Limits on the possible sizes of range blocks.
4432 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4433 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4434 * half the number of bits avoids such errors, and allows entire ISPs to be
4435 * blocked using a small number of range blocks.
4437 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4438 * customer, so range blocks larger than /64 (half the number of bits) will
4439 * plainly be required. RFC 4692 implies that a very large ISP may be
4440 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4441 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4443 $wgBlockCIDRLimit = array(
4444 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4445 'IPv6' => 19,
4449 * If true, blocked users will not be allowed to login. When using this with
4450 * a public wiki, the effect of logging out blocked users may actually be
4451 * avers: unless the user's address is also blocked (e.g. auto-block),
4452 * logging the user out will again allow reading and editing, just as for
4453 * anonymous visitors.
4455 $wgBlockDisablesLogin = false;
4458 * Pages anonymous user may see, set as an array of pages titles.
4460 * @par Example:
4461 * @code
4462 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4463 * @endcode
4465 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4467 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4468 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4470 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4471 * will remain readable. You can use img_auth.php to protect uploaded files,
4472 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4474 $wgWhitelistRead = false;
4477 * Pages anonymous user may see, set as an array of regular expressions.
4479 * This function will match the regexp against the title name, which
4480 * is without underscore.
4482 * @par Example:
4483 * To whitelist [[Main Page]]:
4484 * @code
4485 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4486 * @endcode
4488 * @note Unless ^ and/or $ is specified, a regular expression might match
4489 * pages not intended to be whitelisted. The above example will also
4490 * whitelist a page named 'Security Main Page'.
4492 * @par Example:
4493 * To allow reading any page starting with 'User' regardless of the case:
4494 * @code
4495 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4496 * @endcode
4497 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4499 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4500 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4502 $wgWhitelistReadRegexp = false;
4505 * Should editors be required to have a validated e-mail
4506 * address before being allowed to edit?
4508 $wgEmailConfirmToEdit = false;
4511 * Permission keys given to users in each group.
4513 * This is an array where the keys are all groups and each value is an
4514 * array of the format (right => boolean).
4516 * The second format is used to support per-namespace permissions.
4517 * Note that this feature does not fully work for all permission types.
4519 * All users are implicitly in the '*' group including anonymous visitors;
4520 * logged-in users are all implicitly in the 'user' group. These will be
4521 * combined with the permissions of all groups that a given user is listed
4522 * in in the user_groups table.
4524 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4525 * doing! This will wipe all permissions, and may mean that your users are
4526 * unable to perform certain essential tasks or access new functionality
4527 * when new permissions are introduced and default grants established.
4529 * Functionality to make pages inaccessible has not been extensively tested
4530 * for security. Use at your own risk!
4532 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4534 $wgGroupPermissions = array();
4536 /** @cond file_level_code */
4537 // Implicit group for all visitors
4538 $wgGroupPermissions['*']['createaccount'] = true;
4539 $wgGroupPermissions['*']['read'] = true;
4540 $wgGroupPermissions['*']['edit'] = true;
4541 $wgGroupPermissions['*']['createpage'] = true;
4542 $wgGroupPermissions['*']['createtalk'] = true;
4543 $wgGroupPermissions['*']['writeapi'] = true;
4544 $wgGroupPermissions['*']['editmyusercss'] = true;
4545 $wgGroupPermissions['*']['editmyuserjs'] = true;
4546 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4547 $wgGroupPermissions['*']['editmywatchlist'] = true;
4548 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4549 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4550 $wgGroupPermissions['*']['editmyoptions'] = true;
4551 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4553 // Implicit group for all logged-in accounts
4554 $wgGroupPermissions['user']['move'] = true;
4555 $wgGroupPermissions['user']['move-subpages'] = true;
4556 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4557 $wgGroupPermissions['user']['move-categorypages'] = true;
4558 $wgGroupPermissions['user']['movefile'] = true;
4559 $wgGroupPermissions['user']['read'] = true;
4560 $wgGroupPermissions['user']['edit'] = true;
4561 $wgGroupPermissions['user']['createpage'] = true;
4562 $wgGroupPermissions['user']['createtalk'] = true;
4563 $wgGroupPermissions['user']['writeapi'] = true;
4564 $wgGroupPermissions['user']['upload'] = true;
4565 $wgGroupPermissions['user']['reupload'] = true;
4566 $wgGroupPermissions['user']['reupload-shared'] = true;
4567 $wgGroupPermissions['user']['minoredit'] = true;
4568 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4569 $wgGroupPermissions['user']['sendemail'] = true;
4571 // Implicit group for accounts that pass $wgAutoConfirmAge
4572 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4573 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4575 // Users with bot privilege can have their edits hidden
4576 // from various log pages by default
4577 $wgGroupPermissions['bot']['bot'] = true;
4578 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4579 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4580 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4581 $wgGroupPermissions['bot']['autopatrol'] = true;
4582 $wgGroupPermissions['bot']['suppressredirect'] = true;
4583 $wgGroupPermissions['bot']['apihighlimits'] = true;
4584 $wgGroupPermissions['bot']['writeapi'] = true;
4586 // Most extra permission abilities go to this group
4587 $wgGroupPermissions['sysop']['block'] = true;
4588 $wgGroupPermissions['sysop']['createaccount'] = true;
4589 $wgGroupPermissions['sysop']['delete'] = true;
4590 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4591 $wgGroupPermissions['sysop']['bigdelete'] = true;
4592 // can view deleted history entries, but not see or restore the text
4593 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4594 // can view deleted revision text
4595 $wgGroupPermissions['sysop']['deletedtext'] = true;
4596 $wgGroupPermissions['sysop']['undelete'] = true;
4597 $wgGroupPermissions['sysop']['editinterface'] = true;
4598 $wgGroupPermissions['sysop']['editusercss'] = true;
4599 $wgGroupPermissions['sysop']['edituserjs'] = true;
4600 $wgGroupPermissions['sysop']['import'] = true;
4601 $wgGroupPermissions['sysop']['importupload'] = true;
4602 $wgGroupPermissions['sysop']['move'] = true;
4603 $wgGroupPermissions['sysop']['move-subpages'] = true;
4604 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4605 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4606 $wgGroupPermissions['sysop']['patrol'] = true;
4607 $wgGroupPermissions['sysop']['autopatrol'] = true;
4608 $wgGroupPermissions['sysop']['protect'] = true;
4609 $wgGroupPermissions['sysop']['editprotected'] = true;
4610 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4611 $wgGroupPermissions['sysop']['rollback'] = true;
4612 $wgGroupPermissions['sysop']['upload'] = true;
4613 $wgGroupPermissions['sysop']['reupload'] = true;
4614 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4615 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4616 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4617 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4618 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4619 $wgGroupPermissions['sysop']['blockemail'] = true;
4620 $wgGroupPermissions['sysop']['markbotedits'] = true;
4621 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4622 $wgGroupPermissions['sysop']['browsearchive'] = true;
4623 $wgGroupPermissions['sysop']['noratelimit'] = true;
4624 $wgGroupPermissions['sysop']['movefile'] = true;
4625 $wgGroupPermissions['sysop']['unblockself'] = true;
4626 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4627 #$wgGroupPermissions['sysop']['pagelang'] = true;
4628 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4629 $wgGroupPermissions['sysop']['mergehistory'] = true;
4630 $wgGroupPermissions['sysop']['managechangetags'] = true;
4632 // Permission to change users' group assignments
4633 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4634 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4635 // Permission to change users' groups assignments across wikis
4636 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4637 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4638 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4640 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4641 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4642 // To hide usernames from users and Sysops
4643 #$wgGroupPermissions['suppress']['hideuser'] = true;
4644 // To hide revisions/log items from users and Sysops
4645 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4646 // To view revisions/log items hidden from users and Sysops
4647 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4648 // For private suppression log access
4649 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4652 * The developer group is deprecated, but can be activated if need be
4653 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4654 * that a lock file be defined and creatable/removable by the web
4655 * server.
4657 # $wgGroupPermissions['developer']['siteadmin'] = true;
4659 /** @endcond */
4662 * Permission keys revoked from users in each group.
4664 * This acts the same way as wgGroupPermissions above, except that
4665 * if the user is in a group here, the permission will be removed from them.
4667 * Improperly setting this could mean that your users will be unable to perform
4668 * certain essential tasks, so use at your own risk!
4670 $wgRevokePermissions = array();
4673 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4675 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4678 * A map of group names that the user is in, to group names that those users
4679 * are allowed to add or revoke.
4681 * Setting the list of groups to add or revoke to true is equivalent to "any
4682 * group".
4684 * @par Example:
4685 * To allow sysops to add themselves to the "bot" group:
4686 * @code
4687 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4688 * @endcode
4690 * @par Example:
4691 * Implicit groups may be used for the source group, for instance:
4692 * @code
4693 * $wgGroupsRemoveFromSelf = array( '*' => true );
4694 * @endcode
4695 * This allows users in the '*' group (i.e. any user) to remove themselves from
4696 * any group that they happen to be in.
4698 $wgGroupsAddToSelf = array();
4701 * @see $wgGroupsAddToSelf
4703 $wgGroupsRemoveFromSelf = array();
4706 * Set of available actions that can be restricted via action=protect
4707 * You probably shouldn't change this.
4708 * Translated through restriction-* messages.
4709 * Title::getRestrictionTypes() will remove restrictions that are not
4710 * applicable to a specific title (create and upload)
4712 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4715 * Rights which can be required for each protection level (via action=protect)
4717 * You can add a new protection level that requires a specific
4718 * permission by manipulating this array. The ordering of elements
4719 * dictates the order on the protection form's lists.
4721 * - '' will be ignored (i.e. unprotected)
4722 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4723 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4725 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4728 * Restriction levels that can be used with cascading protection
4730 * A page can only be protected with cascading protection if the
4731 * requested restriction level is included in this array.
4733 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4734 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4736 $wgCascadingRestrictionLevels = array( 'sysop' );
4739 * Restriction levels that should be considered "semiprotected"
4741 * Certain places in the interface recognize a dichotomy between "protected"
4742 * and "semiprotected", without further distinguishing the specific levels. In
4743 * general, if anyone can be eligible to edit a protection level merely by
4744 * reaching some condition in $wgAutopromote, it should probably be considered
4745 * "semiprotected".
4747 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4748 * 'sysop' is not changed, since it really shouldn't be here.
4750 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4753 * Set the minimum permissions required to edit pages in each
4754 * namespace. If you list more than one permission, a user must
4755 * have all of them to edit pages in that namespace.
4757 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4759 $wgNamespaceProtection = array();
4762 * Pages in namespaces in this array can not be used as templates.
4764 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4765 * namespaces constants (NS_USER, NS_MAIN...).
4767 * Among other things, this may be useful to enforce read-restrictions
4768 * which may otherwise be bypassed by using the template mechanism.
4770 $wgNonincludableNamespaces = array();
4773 * Number of seconds an account is required to age before it's given the
4774 * implicit 'autoconfirm' group membership. This can be used to limit
4775 * privileges of new accounts.
4777 * Accounts created by earlier versions of the software may not have a
4778 * recorded creation date, and will always be considered to pass the age test.
4780 * When left at 0, all registered accounts will pass.
4782 * @par Example:
4783 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4784 * @code
4785 * $wgAutoConfirmAge = 600; // ten minutes
4786 * @endcode
4787 * Set age to one day:
4788 * @code
4789 * $wgAutoConfirmAge = 3600*24; // one day
4790 * @endcode
4792 $wgAutoConfirmAge = 0;
4795 * Number of edits an account requires before it is autoconfirmed.
4796 * Passing both this AND the time requirement is needed. Example:
4798 * @par Example:
4799 * @code
4800 * $wgAutoConfirmCount = 50;
4801 * @endcode
4803 $wgAutoConfirmCount = 0;
4806 * Automatically add a usergroup to any user who matches certain conditions.
4808 * @todo Redocument $wgAutopromote
4810 * The format is
4811 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4812 * where cond1, cond2, ... are themselves conditions; *OR*
4813 * APCOND_EMAILCONFIRMED, *OR*
4814 * array( APCOND_EMAILCONFIRMED ), *OR*
4815 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4816 * array( APCOND_AGE, seconds since registration ), *OR*
4817 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4818 * array( APCOND_ISIP, ip ), *OR*
4819 * array( APCOND_IPINRANGE, range ), *OR*
4820 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4821 * array( APCOND_BLOCKED ), *OR*
4822 * array( APCOND_ISBOT ), *OR*
4823 * similar constructs defined by extensions.
4825 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4826 * user who has provided an e-mail address.
4828 $wgAutopromote = array(
4829 'autoconfirmed' => array( '&',
4830 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4831 array( APCOND_AGE, &$wgAutoConfirmAge ),
4836 * Automatically add a usergroup to any user who matches certain conditions.
4838 * Does not add the user to the group again if it has been removed.
4839 * Also, does not remove the group if the user no longer meets the criteria.
4841 * The format is:
4842 * @code
4843 * array( event => criteria, ... )
4844 * @endcode
4845 * Where event is either:
4846 * - 'onEdit' (when user edits)
4847 * - 'onView' (when user views the wiki)
4849 * Criteria has the same format as $wgAutopromote
4851 * @see $wgAutopromote
4852 * @since 1.18
4854 $wgAutopromoteOnce = array(
4855 'onEdit' => array(),
4856 'onView' => array()
4860 * Put user rights log entries for autopromotion in recent changes?
4861 * @since 1.18
4863 $wgAutopromoteOnceLogInRC = true;
4866 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4867 * can assign which groups at Special:Userrights.
4869 * @par Example:
4870 * Bureaucrats can add any group:
4871 * @code
4872 * $wgAddGroups['bureaucrat'] = true;
4873 * @endcode
4874 * Bureaucrats can only remove bots and sysops:
4875 * @code
4876 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4877 * @endcode
4878 * Sysops can make bots:
4879 * @code
4880 * $wgAddGroups['sysop'] = array( 'bot' );
4881 * @endcode
4882 * Sysops can disable other sysops in an emergency, and disable bots:
4883 * @code
4884 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4885 * @endcode
4887 $wgAddGroups = array();
4890 * @see $wgAddGroups
4892 $wgRemoveGroups = array();
4895 * A list of available rights, in addition to the ones defined by the core.
4896 * For extensions only.
4898 $wgAvailableRights = array();
4901 * Optional to restrict deletion of pages with higher revision counts
4902 * to users with the 'bigdelete' permission. (Default given to sysops.)
4904 $wgDeleteRevisionsLimit = 0;
4907 * The maximum number of edits a user can have and
4908 * can still be hidden by users with the hideuser permission.
4909 * This is limited for performance reason.
4910 * Set to false to disable the limit.
4911 * @since 1.23
4913 $wgHideUserContribLimit = 1000;
4916 * Number of accounts each IP address may create, 0 to disable.
4918 * @warning Requires memcached
4920 $wgAccountCreationThrottle = 0;
4923 * Edits matching these regular expressions in body text
4924 * will be recognised as spam and rejected automatically.
4926 * There's no administrator override on-wiki, so be careful what you set. :)
4927 * May be an array of regexes or a single string for backwards compatibility.
4929 * @see http://en.wikipedia.org/wiki/Regular_expression
4931 * @note Each regex needs a beginning/end delimiter, eg: # or /
4933 $wgSpamRegex = array();
4936 * Same as the above except for edit summaries
4938 $wgSummarySpamRegex = array();
4941 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4942 * proxies
4943 * @since 1.16
4945 $wgEnableDnsBlacklist = false;
4948 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4950 * This is an array of either a URL or an array with the URL and a key (should
4951 * the blacklist require a key).
4953 * @par Example:
4954 * @code
4955 * $wgDnsBlacklistUrls = array(
4956 * // String containing URL
4957 * 'http.dnsbl.sorbs.net.',
4958 * // Array with URL and key, for services that require a key
4959 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4960 * // Array with just the URL. While this works, it is recommended that you
4961 * // just use a string as shown above
4962 * array( 'opm.tornevall.org.' )
4963 * );
4964 * @endcode
4966 * @note You should end the domain name with a . to avoid searching your
4967 * eventual domain search suffixes.
4968 * @since 1.16
4970 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4973 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4974 * what the other methods might say.
4976 $wgProxyWhitelist = array();
4979 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4980 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4981 * (transparent) proxies without needing to block the proxies themselves.
4983 $wgApplyIpBlocksToXff = false;
4986 * Simple rate limiter options to brake edit floods.
4988 * Maximum number actions allowed in the given number of seconds; after that
4989 * the violating client receives HTTP 500 error pages until the period
4990 * elapses.
4992 * @par Example:
4993 * To set a generic maximum of 4 hits in 60 seconds:
4994 * @code
4995 * $wgRateLimits = array( 4, 60 );
4996 * @endcode
4998 * You could also limit per action and then type of users. See the inline
4999 * code for a template to use.
5001 * This option set is experimental and likely to change.
5003 * @warning Requires memcached.
5005 $wgRateLimits = array(
5006 'edit' => array(
5007 'anon' => null, // for any and all anonymous edits (aggregate)
5008 'user' => null, // for each logged-in user
5009 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
5010 'ip' => null, // for each anon and recent account
5011 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
5013 'move' => array(
5014 'user' => null,
5015 'newbie' => null,
5016 'ip' => null,
5017 'subnet' => null,
5019 'mailpassword' => array( // triggering password resets emails
5020 'anon' => null,
5022 'emailuser' => array( // emailing other users using MediaWiki
5023 'user' => null,
5025 'linkpurge' => array( // purges of link tables
5026 'anon' => null,
5027 'user' => null,
5028 'newbie' => null,
5029 'ip' => null,
5030 'subnet' => null,
5032 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
5033 'anon' => null,
5034 'user' => null,
5035 'newbie' => null,
5036 'ip' => null,
5037 'subnet' => null,
5039 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
5040 'anon' => null,
5041 'user' => null,
5042 'newbie' => null,
5043 'ip' => null,
5044 'subnet' => null,
5046 'stashedit' => array( // stashing edits into cache before save
5047 'anon' => null,
5048 'user' => null,
5049 'newbie' => null,
5050 'ip' => null,
5051 'subnet' => null,
5056 * Set to a filename to log rate limiter hits.
5058 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
5060 $wgRateLimitLog = null;
5063 * Array of IPs which should be excluded from rate limits.
5064 * This may be useful for whitelisting NAT gateways for conferences, etc.
5066 $wgRateLimitsExcludedIPs = array();
5069 * Log IP addresses in the recentchanges table; can be accessed only by
5070 * extensions (e.g. CheckUser) or a DB admin
5071 * Used for retroactive autoblocks
5073 $wgPutIPinRC = true;
5076 * Integer defining default number of entries to show on
5077 * special pages which are query-pages such as Special:Whatlinkshere.
5079 $wgQueryPageDefaultLimit = 50;
5082 * Limit password attempts to X attempts per Y seconds per IP per account.
5084 * @warning Requires memcached.
5086 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5088 /** @} */ # end of user rights settings
5090 /************************************************************************//**
5091 * @name Proxy scanner settings
5092 * @{
5096 * This should always be customised in LocalSettings.php
5098 $wgSecretKey = false;
5101 * Big list of banned IP addresses.
5103 * This can have the following formats:
5104 * - An array of addresses, either in the values
5105 * or the keys (for backward compatibility)
5106 * - A string, in that case this is the path to a file
5107 * containing the list of IP addresses, one per line
5109 $wgProxyList = array();
5111 /** @} */ # end of proxy scanner settings
5113 /************************************************************************//**
5114 * @name Cookie settings
5115 * @{
5119 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5121 $wgCookieExpiration = 180 * 86400;
5124 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5125 * or ".any.subdomain.net"
5127 $wgCookieDomain = '';
5130 * Set this variable if you want to restrict cookies to a certain path within
5131 * the domain specified by $wgCookieDomain.
5133 $wgCookiePath = '/';
5136 * Whether the "secure" flag should be set on the cookie. This can be:
5137 * - true: Set secure flag
5138 * - false: Don't set secure flag
5139 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5141 $wgCookieSecure = 'detect';
5144 * By default, MediaWiki checks if the client supports cookies during the
5145 * login process, so that it can display an informative error message if
5146 * cookies are disabled. Set this to true if you want to disable this cookie
5147 * check.
5149 $wgDisableCookieCheck = false;
5152 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5153 * to a string to use a custom prefix. Setting it to false causes the database
5154 * name to be used as a prefix.
5156 $wgCookiePrefix = false;
5159 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5160 * in browsers that support this feature. This can mitigates some classes of
5161 * XSS attack.
5163 $wgCookieHttpOnly = true;
5166 * A list of cookies that vary the cache (for use by extensions)
5168 $wgCacheVaryCookies = array();
5171 * Override to customise the session name
5173 $wgSessionName = false;
5175 /** @} */ # end of cookie settings }
5177 /************************************************************************//**
5178 * @name LaTeX (mathematical formulas)
5179 * @{
5183 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5184 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5185 * (ImageMagick) installed and available in the PATH.
5186 * Please see math/README for more information.
5188 $wgUseTeX = false;
5190 /** @} */ # end LaTeX }
5192 /************************************************************************//**
5193 * @name Profiling, testing and debugging
5195 * To enable profiling, edit StartProfiler.php
5197 * @{
5201 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5202 * The debug log file should be not be publicly accessible if it is used, as it
5203 * may contain private data.
5205 $wgDebugLogFile = '';
5208 * Prefix for debug log lines
5210 $wgDebugLogPrefix = '';
5213 * If true, instead of redirecting, show a page with a link to the redirect
5214 * destination. This allows for the inspection of PHP error messages, and easy
5215 * resubmission of form data. For developer use only.
5217 $wgDebugRedirects = false;
5220 * If true, log debugging data from action=raw and load.php.
5221 * This is normally false to avoid overlapping debug entries due to gen=css
5222 * and gen=js requests.
5224 $wgDebugRawPage = false;
5227 * Send debug data to an HTML comment in the output.
5229 * This may occasionally be useful when supporting a non-technical end-user.
5230 * It's more secure than exposing the debug log file to the web, since the
5231 * output only contains private data for the current user. But it's not ideal
5232 * for development use since data is lost on fatal errors and redirects.
5234 $wgDebugComments = false;
5237 * Extensive database transaction state debugging
5239 * @since 1.20
5241 $wgDebugDBTransactions = false;
5244 * Write SQL queries to the debug log.
5246 * This setting is only used $wgLBFactoryConf['class'] is set to
5247 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5248 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5249 * connection to achieve the same functionality.
5251 $wgDebugDumpSql = false;
5254 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5255 * trimming.
5256 * @since 1.24
5258 $wgDebugDumpSqlLength = 500;
5261 * Map of string log group names to log destinations.
5263 * If set, wfDebugLog() output for that group will go to that file instead
5264 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5265 * in production.
5267 * Log destinations may be one of the following:
5268 * - false to completely remove from the output, including from $wgDebugLogFile.
5269 * - string values specifying a filename or URI.
5270 * - associative array with keys:
5271 * - 'destination' desired filename or URI.
5272 * - 'sample' an integer value, specifying a sampling factor (optional)
5273 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5274 * to log (optional, since 1.25)
5276 * @par Example:
5277 * @code
5278 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5279 * @endcode
5281 * @par Advanced example:
5282 * @code
5283 * $wgDebugLogGroups['memcached'] = array(
5284 * 'destination' => '/var/log/mediawiki/memcached.log',
5285 * 'sample' => 1000, // log 1 message out of every 1,000.
5286 * 'level' => \Psr\Log\LogLevel::WARNING
5287 * );
5288 * @endcode
5290 $wgDebugLogGroups = array();
5293 * Default service provider for creating Psr\Log\LoggerInterface instances.
5295 * The value should be an array suitable for use with
5296 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5297 * implement the MWLoggerSpi interface. See ObjectFactory for additional
5298 * details.
5300 * Alternately the MWLoggerFactory::registerProvider method can be called to
5301 * inject an MWLoggerSpi instance into MWLoggerFactory and bypass the use of
5302 * this configuration variable entirely.
5304 * @since 1.25
5305 * @var array $wgMWLoggerDefaultSpi
5306 * @see MwLogger
5308 $wgMWLoggerDefaultSpi = array(
5309 'class' => 'MWLoggerLegacySpi',
5313 * Display debug data at the bottom of the main content area.
5315 * Useful for developers and technical users trying to working on a closed wiki.
5317 $wgShowDebug = false;
5320 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5321 * Since 1.19 also includes memory usage.
5323 $wgDebugTimestamps = false;
5326 * Print HTTP headers for every request in the debug information.
5328 $wgDebugPrintHttpHeaders = true;
5331 * Show the contents of $wgHooks in Special:Version
5333 $wgSpecialVersionShowHooks = false;
5336 * Whether to show "we're sorry, but there has been a database error" pages.
5337 * Displaying errors aids in debugging, but may display information useful
5338 * to an attacker.
5340 $wgShowSQLErrors = false;
5343 * If set to true, uncaught exceptions will print a complete stack trace
5344 * to output. This should only be used for debugging, as it may reveal
5345 * private information in function parameters due to PHP's backtrace
5346 * formatting.
5348 $wgShowExceptionDetails = false;
5351 * If true, show a backtrace for database errors
5353 * @note This setting only applies when connection errors and query errors are
5354 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5355 * including those in which an uncaught exception is thrown from within the
5356 * exception handler.
5358 $wgShowDBErrorBacktrace = false;
5361 * If true, send the exception backtrace to the error log
5363 $wgLogExceptionBacktrace = true;
5366 * Expose backend server host names through the API and various HTML comments
5368 $wgShowHostnames = false;
5371 * Override server hostname detection with a hardcoded value.
5372 * Should be a string, default false.
5373 * @since 1.20
5375 $wgOverrideHostname = false;
5378 * If set to true MediaWiki will throw notices for some possible error
5379 * conditions and for deprecated functions.
5381 $wgDevelopmentWarnings = false;
5384 * Release limitation to wfDeprecated warnings, if set to a release number
5385 * development warnings will not be generated for deprecations added in releases
5386 * after the limit.
5388 $wgDeprecationReleaseLimit = false;
5391 * Only record profiling info for pages that took longer than this
5393 $wgProfileLimit = 0.0;
5396 * Don't put non-profiling info into log file
5398 * @deprecated since 1.23, set the log file in
5399 * $wgDebugLogGroups['profileoutput'] instead.
5401 $wgProfileOnly = false;
5404 * If true, print a raw call tree instead of per-function report
5406 $wgProfileCallTree = false;
5409 * Should application server host be put into profiling table
5411 * @deprecated set $wgProfiler['perhost'] = true instead
5413 $wgProfilePerHost = null;
5416 * Host for UDP profiler.
5418 * The host should be running a daemon which can be obtained from MediaWiki
5419 * Git at:
5420 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5422 * @deprecated set $wgProfiler['udphost'] instead
5424 $wgUDPProfilerHost = null;
5427 * Port for UDP profiler.
5428 * @see $wgUDPProfilerHost
5430 * @deprecated set $wgProfiler['udpport'] instead
5432 $wgUDPProfilerPort = null;
5435 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5436 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5437 * arguments. You can use sprintf's argument numbering/swapping capability to
5438 * repeat, re-order or omit fields.
5440 * @see $wgStatsFormatString
5441 * @since 1.22
5443 * @deprecated set $wgProfiler['udpformat'] instead
5445 $wgUDPProfilerFormatString = null;
5448 * Destination for wfIncrStats() data...
5449 * 'cache' to go into the system cache, if enabled (memcached)
5450 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5451 * false to disable
5453 $wgStatsMethod = 'cache';
5456 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5457 * be aggregated over more than one wiki. The string will be used in place of
5458 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5459 * will be used.
5461 $wgAggregateStatsID = false;
5464 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5465 * formatted. Its value should be a format string suitable for a sprintf()
5466 * invocation with (id, count, key) arguments, where 'id' is either
5467 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5468 * is being incremented, and 'key' is the metric name.
5470 * @see $wgUDPProfilerFormatString
5471 * @see $wgAggregateStatsID
5472 * @since 1.22
5474 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5477 * InfoAction retrieves a list of transclusion links (both to and from).
5478 * This number puts a limit on that query in the case of highly transcluded
5479 * templates.
5481 $wgPageInfoTransclusionLimit = 50;
5484 * Set this to an integer to only do synchronous site_stats updates
5485 * one every *this many* updates. The other requests go into pending
5486 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5487 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5489 $wgSiteStatsAsyncFactor = false;
5492 * Parser test suite files to be run by parserTests.php when no specific
5493 * filename is passed to it.
5495 * Extensions may add their own tests to this array, or site-local tests
5496 * may be added via LocalSettings.php
5498 * Use full paths.
5500 $wgParserTestFiles = array(
5501 "$IP/tests/parser/parserTests.txt",
5502 "$IP/tests/parser/extraParserTests.txt"
5506 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5508 $wgEnableJavaScriptTest = false;
5511 * Overwrite the caching key prefix with custom value.
5512 * @since 1.19
5514 $wgCachePrefix = false;
5517 * Display the new debugging toolbar. This also enables profiling on database
5518 * queries and other useful output.
5519 * Will disable file cache.
5521 * @since 1.19
5523 $wgDebugToolbar = false;
5525 /** @} */ # end of profiling, testing and debugging }
5527 /************************************************************************//**
5528 * @name Search
5529 * @{
5533 * Set this to true to disable the full text search feature.
5535 $wgDisableTextSearch = false;
5538 * Set to true to have nicer highlighted text in search results,
5539 * by default off due to execution overhead
5541 $wgAdvancedSearchHighlighting = false;
5544 * Regexp to match word boundaries, defaults for non-CJK languages
5545 * should be empty for CJK since the words are not separate
5547 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5550 * Template for OpenSearch suggestions, defaults to API action=opensearch
5552 * Sites with heavy load would typically have these point to a custom
5553 * PHP wrapper to avoid firing up mediawiki for every keystroke
5555 * Placeholders: {searchTerms}
5557 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5559 $wgOpenSearchTemplate = false;
5562 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5564 * Sites with heavy load would typically have these point to a custom
5565 * PHP wrapper to avoid firing up mediawiki for every keystroke
5567 * Placeholders: {searchTerms}
5569 $wgOpenSearchTemplates = array(
5570 'application/x-suggestions+json' => false,
5571 'application/x-suggestions+xml' => false,
5575 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5576 * false if you've disabled scripts that use api?action=opensearch and
5577 * want reduce load caused by cached scripts still pulling suggestions.
5578 * It will let the API fallback by responding with an empty array.
5580 $wgEnableOpenSearchSuggest = true;
5583 * Integer defining default number of entries to show on
5584 * OpenSearch call.
5586 $wgOpenSearchDefaultLimit = 10;
5589 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
5591 $wgOpenSearchDescriptionLength = 100;
5594 * Expiry time for search suggestion responses
5596 $wgSearchSuggestCacheExpiry = 1200;
5599 * If you've disabled search semi-permanently, this also disables updates to the
5600 * table. If you ever re-enable, be sure to rebuild the search table.
5602 $wgDisableSearchUpdate = false;
5605 * List of namespaces which are searched by default.
5607 * @par Example:
5608 * @code
5609 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5610 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5611 * @endcode
5613 $wgNamespacesToBeSearchedDefault = array(
5614 NS_MAIN => true,
5618 * Disable the internal MySQL-based search, to allow it to be
5619 * implemented by an extension instead.
5621 $wgDisableInternalSearch = false;
5624 * Set this to a URL to forward search requests to some external location.
5625 * If the URL includes '$1', this will be replaced with the URL-encoded
5626 * search term.
5628 * @par Example:
5629 * To forward to Google you'd have something like:
5630 * @code
5631 * $wgSearchForwardUrl =
5632 * 'http://www.google.com/search?q=$1' .
5633 * '&domains=http://example.com' .
5634 * '&sitesearch=http://example.com' .
5635 * '&ie=utf-8&oe=utf-8';
5636 * @endcode
5638 $wgSearchForwardUrl = null;
5641 * Search form behavior.
5642 * - true = use Go & Search buttons
5643 * - false = use Go button & Advanced search link
5645 $wgUseTwoButtonsSearchForm = true;
5648 * Array of namespaces to generate a Google sitemap for when the
5649 * maintenance/generateSitemap.php script is run, or false if one is to be
5650 * generated for all namespaces.
5652 $wgSitemapNamespaces = false;
5655 * Custom namespace priorities for sitemaps. Setting this will allow you to
5656 * set custom priorities to namespaces when sitemaps are generated using the
5657 * maintenance/generateSitemap.php script.
5659 * This should be a map of namespace IDs to priority
5660 * @par Example:
5661 * @code
5662 * $wgSitemapNamespacesPriorities = array(
5663 * NS_USER => '0.9',
5664 * NS_HELP => '0.0',
5665 * );
5666 * @endcode
5668 $wgSitemapNamespacesPriorities = false;
5671 * If true, searches for IP addresses will be redirected to that IP's
5672 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5673 * [[Special:Contributions/1.2.3.4]]
5675 $wgEnableSearchContributorsByIP = true;
5677 /** @} */ # end of search settings
5679 /************************************************************************//**
5680 * @name Edit user interface
5681 * @{
5685 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5686 * fall back to the old behavior (no merging).
5688 $wgDiff3 = '/usr/bin/diff3';
5691 * Path to the GNU diff utility.
5693 $wgDiff = '/usr/bin/diff';
5696 * Which namespaces have special treatment where they should be preview-on-open
5697 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5698 * can specify namespaces of pages they have special treatment for
5700 $wgPreviewOnOpenNamespaces = array(
5701 NS_CATEGORY => true
5705 * Enable the UniversalEditButton for browsers that support it
5706 * (currently only Firefox with an extension)
5707 * See http://universaleditbutton.org for more background information
5709 $wgUniversalEditButton = true;
5712 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5713 * will try to automatically create one. This feature can be disabled by set-
5714 * ting this variable false.
5716 $wgUseAutomaticEditSummaries = true;
5718 /** @} */ # end edit UI }
5720 /************************************************************************//**
5721 * @name Maintenance
5722 * See also $wgSiteNotice
5723 * @{
5727 * @cond file_level_code
5728 * Set $wgCommandLineMode if it's not set already, to avoid notices
5730 if ( !isset( $wgCommandLineMode ) ) {
5731 $wgCommandLineMode = false;
5733 /** @endcond */
5736 * For colorized maintenance script output, is your terminal background dark ?
5738 $wgCommandLineDarkBg = false;
5741 * Set this to a string to put the wiki into read-only mode. The text will be
5742 * used as an explanation to users.
5744 * This prevents most write operations via the web interface. Cache updates may
5745 * still be possible. To prevent database writes completely, use the read_only
5746 * option in MySQL.
5748 $wgReadOnly = null;
5751 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5752 * Its contents will be shown to users as part of the read-only warning
5753 * message.
5755 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5757 $wgReadOnlyFile = false;
5760 * When you run the web-based upgrade utility, it will tell you what to set
5761 * this to in order to authorize the upgrade process. It will subsequently be
5762 * used as a password, to authorize further upgrades.
5764 * For security, do not set this to a guessable string. Use the value supplied
5765 * by the install/upgrade process. To cause the upgrader to generate a new key,
5766 * delete the old key from LocalSettings.php.
5768 $wgUpgradeKey = false;
5771 * Fully specified path to git binary
5773 $wgGitBin = '/usr/bin/git';
5776 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5778 * Key is a pattern passed to preg_match() and preg_replace(),
5779 * without the delimiters (which are #) and must match the whole URL.
5780 * The value is the replacement for the key (it can contain $1, etc.)
5781 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5782 * full SHA-1 of the HEAD revision.
5783 * %r will be replaced with a URL-encoded version of $1.
5785 * @since 1.20
5787 $wgGitRepositoryViewers = array(
5788 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5789 'https://git.wikimedia.org/tree/%r/%H',
5790 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5791 'https://git.wikimedia.org/tree/%r/%H',
5794 /** @} */ # End of maintenance }
5796 /************************************************************************//**
5797 * @name Recent changes, new pages, watchlist and history
5798 * @{
5802 * Recentchanges items are periodically purged; entries older than this many
5803 * seconds will go.
5804 * Default: 90 days = about three months
5806 $wgRCMaxAge = 90 * 24 * 3600;
5809 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5810 * higher than what will be stored. Note that this is disabled by default
5811 * because we sometimes do have RC data which is beyond the limit for some
5812 * reason, and some users may use the high numbers to display that data which
5813 * is still there.
5815 $wgRCFilterByAge = false;
5818 * List of Limits options to list in the Special:Recentchanges and
5819 * Special:Recentchangeslinked pages.
5821 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5824 * List of Days options to list in the Special:Recentchanges and
5825 * Special:Recentchangeslinked pages.
5827 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5830 * Destinations to which notifications about recent changes
5831 * should be sent.
5833 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5834 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5835 * specified server.
5836 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5838 * The common options are:
5839 * * 'uri' -- the address to which the notices are to be sent.
5840 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5841 * produce the text to send. This can also be an object of the class.
5842 * * 'omit_bots' -- whether the bot edits should be in the feed
5843 * * 'omit_anon' -- whether anonymous edits should be in the feed
5844 * * 'omit_user' -- whether edits by registered users should be in the feed
5845 * * 'omit_minor' -- whether minor edits should be in the feed
5846 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5848 * The IRC-specific options are:
5849 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5850 * the first entry in the $wgLocalInterwikis array (or the value of
5851 * $wgLocalInterwiki, if set)
5853 * The JSON-specific options are:
5854 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5856 * @example $wgRCFeeds['example'] = array(
5857 * 'formatter' => 'JSONRCFeedFormatter',
5858 * 'uri' => "udp://localhost:1336",
5859 * 'add_interwiki_prefix' => false,
5860 * 'omit_bots' => true,
5861 * );
5862 * @example $wgRCFeeds['exampleirc'] = array(
5863 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5864 * 'uri' => "udp://localhost:1338",
5865 * 'add_interwiki_prefix' => false,
5866 * 'omit_bots' => true,
5867 * );
5868 * @since 1.22
5870 $wgRCFeeds = array();
5873 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5874 * Keys are scheme names, values are names of engine classes.
5876 $wgRCEngines = array(
5877 'redis' => 'RedisPubSubFeedEngine',
5878 'udp' => 'UDPRCFeedEngine',
5882 * Use RC Patrolling to check for vandalism
5884 $wgUseRCPatrol = true;
5887 * Use new page patrolling to check new pages on Special:Newpages
5889 $wgUseNPPatrol = true;
5892 * Log autopatrol actions to the log table
5894 $wgLogAutopatrol = true;
5897 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5899 $wgFeed = true;
5902 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5903 * eg Recentchanges, Newpages.
5905 $wgFeedLimit = 50;
5908 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5909 * A cached version will continue to be served out even if changes
5910 * are made, until this many seconds runs out since the last render.
5912 * If set to 0, feed caching is disabled. Use this for debugging only;
5913 * feed generation can be pretty slow with diffs.
5915 $wgFeedCacheTimeout = 60;
5918 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5919 * pages larger than this size.
5921 $wgFeedDiffCutoff = 32768;
5924 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5925 * every page. Some sites might have a different feed they'd like to promote
5926 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5927 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5928 * as value.
5929 * @par Example:
5930 * Configure the 'atom' feed to http://example.com/somefeed.xml
5931 * @code
5932 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5933 * @endcode
5935 $wgOverrideSiteFeed = array();
5938 * Available feeds objects.
5939 * Should probably only be defined when a page is syndicated ie when
5940 * $wgOut->isSyndicated() is true.
5942 $wgFeedClasses = array(
5943 'rss' => 'RSSFeed',
5944 'atom' => 'AtomFeed',
5948 * Which feed types should we provide by default? This can include 'rss',
5949 * 'atom', neither, or both.
5951 $wgAdvertisedFeedTypes = array( 'atom' );
5954 * Show watching users in recent changes, watchlist and page history views
5956 $wgRCShowWatchingUsers = false; # UPO
5959 * Show the amount of changed characters in recent changes
5961 $wgRCShowChangedSize = true;
5964 * If the difference between the character counts of the text
5965 * before and after the edit is below that value, the value will be
5966 * highlighted on the RC page.
5968 $wgRCChangedSizeThreshold = 500;
5971 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5972 * view for watched pages with new changes
5974 $wgShowUpdatedMarker = true;
5977 * Disable links to talk pages of anonymous users (IPs) in listings on special
5978 * pages like page history, Special:Recentchanges, etc.
5980 $wgDisableAnonTalk = false;
5983 * Enable filtering of categories in Recentchanges
5985 $wgAllowCategorizedRecentChanges = false;
5988 * Allow filtering by change tag in recentchanges, history, etc
5989 * Has no effect if no tags are defined in valid_tag.
5991 $wgUseTagFilter = true;
5994 * If set to an integer, pages that are watched by this many users or more
5995 * will not require the unwatchedpages permission to view the number of
5996 * watchers.
5998 * @since 1.21
6000 $wgUnwatchedPageThreshold = false;
6003 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6004 * certain types of edits.
6006 * To register a new one:
6007 * @code
6008 * $wgRecentChangesFlags['flag'] => array(
6009 * // message for the letter displayed next to rows on changes lists
6010 * 'letter' => 'letter-msg',
6011 * // message for the tooltip of the letter
6012 * 'title' => 'tooltip-msg',
6013 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6014 * 'legend' => 'legend-msg',
6015 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6016 * 'class' => 'css-class',
6017 * );
6018 * @endcode
6020 * @since 1.22
6022 $wgRecentChangesFlags = array(
6023 'newpage' => array(
6024 'letter' => 'newpageletter',
6025 'title' => 'recentchanges-label-newpage',
6026 'legend' => 'recentchanges-legend-newpage',
6028 'minor' => array(
6029 'letter' => 'minoreditletter',
6030 'title' => 'recentchanges-label-minor',
6031 'legend' => 'recentchanges-legend-minor',
6032 'class' => 'minoredit',
6034 'bot' => array(
6035 'letter' => 'boteditletter',
6036 'title' => 'recentchanges-label-bot',
6037 'legend' => 'recentchanges-legend-bot',
6038 'class' => 'botedit',
6040 'unpatrolled' => array(
6041 'letter' => 'unpatrolledletter',
6042 'title' => 'recentchanges-label-unpatrolled',
6043 'legend' => 'recentchanges-legend-unpatrolled',
6047 /** @} */ # end RC/watchlist }
6049 /************************************************************************//**
6050 * @name Copyright and credits settings
6051 * @{
6055 * Override for copyright metadata.
6057 * This is the name of the page containing information about the wiki's copyright status,
6058 * which will be added as a link in the footer if it is specified. It overrides
6059 * $wgRightsUrl if both are specified.
6061 $wgRightsPage = null;
6064 * Set this to specify an external URL containing details about the content license used on your
6065 * wiki.
6066 * If $wgRightsPage is set then this setting is ignored.
6068 $wgRightsUrl = null;
6071 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6072 * link.
6073 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6074 * of the page will also be used as the link if this variable is not set.
6076 $wgRightsText = null;
6079 * Override for copyright metadata.
6081 $wgRightsIcon = null;
6084 * Set this to some HTML to override the rights icon with an arbitrary logo
6085 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6087 $wgCopyrightIcon = null;
6090 * Set this to true if you want detailed copyright information forms on Upload.
6092 $wgUseCopyrightUpload = false;
6095 * Set this to the number of authors that you want to be credited below an
6096 * article text. Set it to zero to hide the attribution block, and a negative
6097 * number (like -1) to show all authors. Note that this will require 2-3 extra
6098 * database hits, which can have a not insignificant impact on performance for
6099 * large wikis.
6101 $wgMaxCredits = 0;
6104 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6105 * Otherwise, link to a separate credits page.
6107 $wgShowCreditsIfMax = true;
6109 /** @} */ # end of copyright and credits settings }
6111 /************************************************************************//**
6112 * @name Import / Export
6113 * @{
6117 * List of interwiki prefixes for wikis we'll accept as sources for
6118 * Special:Import (for sysops). Since complete page history can be imported,
6119 * these should be 'trusted'.
6121 * This can either be a regular array, or an associative map specifying
6122 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6123 * e.g.
6124 * @code
6125 * $wgImportSources = array(
6126 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6127 * 'wikispecies',
6128 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6129 * );
6130 * @endcode
6132 * If a user has the 'import' permission but not the 'importupload' permission,
6133 * they will only be able to run imports through this transwiki interface.
6135 $wgImportSources = array();
6138 * Optional default target namespace for interwiki imports.
6139 * Can use this to create an incoming "transwiki"-style queue.
6140 * Set to numeric key, not the name.
6142 * Users may override this in the Special:Import dialog.
6144 $wgImportTargetNamespace = null;
6147 * If set to false, disables the full-history option on Special:Export.
6148 * This is currently poorly optimized for long edit histories, so is
6149 * disabled on Wikimedia's sites.
6151 $wgExportAllowHistory = true;
6154 * If set nonzero, Special:Export requests for history of pages with
6155 * more revisions than this will be rejected. On some big sites things
6156 * could get bogged down by very very long pages.
6158 $wgExportMaxHistory = 0;
6161 * Return distinct author list (when not returning full history)
6163 $wgExportAllowListContributors = false;
6166 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6167 * up to this specified level, which will cause it to include all
6168 * pages linked to from the pages you specify. Since this number
6169 * can become *insanely large* and could easily break your wiki,
6170 * it's disabled by default for now.
6172 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6173 * crazy-big export from being done by someone setting the depth number too
6174 * high. In other words, last resort safety net.
6176 $wgExportMaxLinkDepth = 0;
6179 * Whether to allow the "export all pages in namespace" option
6181 $wgExportFromNamespaces = false;
6184 * Whether to allow exporting the entire wiki into a single file
6186 $wgExportAllowAll = false;
6188 /** @} */ # end of import/export }
6190 /*************************************************************************//**
6191 * @name Extensions
6192 * @{
6196 * A list of callback functions which are called once MediaWiki is fully
6197 * initialised
6199 $wgExtensionFunctions = array();
6202 * Extension messages files.
6204 * Associative array mapping extension name to the filename where messages can be
6205 * found. The file should contain variable assignments. Any of the variables
6206 * present in languages/messages/MessagesEn.php may be defined, but $messages
6207 * is the most common.
6209 * Variables defined in extensions will override conflicting variables defined
6210 * in the core.
6212 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6213 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6214 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6215 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6217 * Extensions using the JSON message format can preserve backward compatibility with
6218 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6219 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6220 * as for the $wgMessagesDirs entry.
6222 * @par Example:
6223 * @code
6224 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6225 * @endcode
6227 $wgExtensionMessagesFiles = array();
6230 * Extension messages directories.
6232 * Associative array mapping extension name to the path of the directory where message files can
6233 * be found. The message files are expected to be JSON files named for their language code, e.g.
6234 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6235 * message directories.
6237 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6239 * @par Simple example:
6240 * @code
6241 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6242 * @endcode
6244 * @par Complex example:
6245 * @code
6246 * $wgMessagesDirs['Example'] = array(
6247 * __DIR__ . '/lib/ve/i18n',
6248 * __DIR__ . '/lib/oojs-ui/i18n',
6249 * __DIR__ . '/i18n',
6251 * @endcode
6252 * @since 1.23
6254 $wgMessagesDirs = array();
6257 * Array of files with list(s) of extension entry points to be used in
6258 * maintenance/mergeMessageFileList.php
6259 * @since 1.22
6261 $wgExtensionEntryPointListFiles = array();
6264 * Parser output hooks.
6265 * This is an associative array where the key is an extension-defined tag
6266 * (typically the extension name), and the value is a PHP callback.
6267 * These will be called as an OutputPageParserOutput hook, if the relevant
6268 * tag has been registered with the parser output object.
6270 * Registration is done with $pout->addOutputHook( $tag, $data ).
6272 * The callback has the form:
6273 * @code
6274 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6275 * @endcode
6277 $wgParserOutputHooks = array();
6280 * Whether to include the NewPP limit report as a HTML comment
6282 $wgEnableParserLimitReporting = true;
6285 * List of valid skin names
6287 * The key should be the name in all lower case, the value should be a properly
6288 * cased name for the skin. This value will be prefixed with "Skin" to create
6289 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6290 * if you wish to have access to the full list.
6292 $wgValidSkinNames = array();
6295 * Special page list. This is an associative array mapping the (canonical) names of
6296 * special pages to either a class name to be instantiated, or a callback to use for
6297 * creating the special page object. In both cases, the result must be an instance of
6298 * SpecialPage.
6300 $wgSpecialPages = array();
6303 * Array mapping class names to filenames, for autoloading.
6305 $wgAutoloadClasses = array();
6308 * Switch controlling legacy case-insensitive classloading.
6309 * Do not disable if your wiki must support data created by PHP4, or by
6310 * MediaWiki 1.4 or earlier.
6312 $wgAutoloadAttemptLowercase = true;
6315 * An array of information about installed extensions keyed by their type.
6317 * All but 'name', 'path' and 'author' can be omitted.
6319 * @code
6320 * $wgExtensionCredits[$type][] = array(
6321 * 'path' => __FILE__,
6322 * 'name' => 'Example extension',
6323 * 'namemsg' => 'exampleextension-name',
6324 * 'author' => array(
6325 * 'Foo Barstein',
6326 * ),
6327 * 'version' => '1.9.0',
6328 * 'url' => 'http://example.org/example-extension/',
6329 * 'descriptionmsg' => 'exampleextension-desc',
6330 * 'license-name' => 'GPL-2.0+',
6331 * );
6332 * @endcode
6334 * The extensions are listed on Special:Version. This page also looks for a file
6335 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6336 * view said file. When the 'license-name' key is specified, this file is
6337 * interpreted as wikitext.
6339 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6340 * 'skin', 'api', or 'other', or any additional types as specified through the
6341 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6343 * - name: Name of extension as an inline string instead of localizable message.
6344 * Do not omit this even if 'namemsg' is provided, as it is used to override
6345 * the path Special:Version uses to find extension's license info, and is
6346 * required for backwards-compatibility with MediaWiki 1.23 and older.
6348 * - namemsg (since MW 1.24): A message key for a message containing the
6349 * extension's name, if the name is localizable. (For example, skin names
6350 * usually are.)
6352 * - author: A string or an array of strings. Authors can be linked using
6353 * the regular wikitext link syntax. To have an internationalized version of
6354 * "and others" show, add an element "...". This element can also be linked,
6355 * for instance "[http://example ...]".
6357 * - descriptionmsg: A message key or an an array with message key and parameters:
6358 * `'descriptionmsg' => 'exampleextension-desc',`
6360 * - description: Description of extension as an inline string instead of
6361 * localizable message (omit in favour of 'descriptionmsg').
6363 * - license-name: Short name of the license (used as label for the link), such
6364 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6366 $wgExtensionCredits = array();
6369 * Authentication plugin.
6370 * @var $wgAuth AuthPlugin
6372 $wgAuth = null;
6375 * Global list of hooks.
6377 * The key is one of the events made available by MediaWiki, you can find
6378 * a description for most of them in docs/hooks.txt. The array is used
6379 * internally by Hook:run().
6381 * The value can be one of:
6383 * - A function name:
6384 * @code
6385 * $wgHooks['event_name'][] = $function;
6386 * @endcode
6387 * - A function with some data:
6388 * @code
6389 * $wgHooks['event_name'][] = array( $function, $data );
6390 * @endcode
6391 * - A an object method:
6392 * @code
6393 * $wgHooks['event_name'][] = array( $object, 'method' );
6394 * @endcode
6395 * - A closure:
6396 * @code
6397 * $wgHooks['event_name'][] = function ( $hookParam ) {
6398 * // Handler code goes here.
6399 * };
6400 * @endcode
6402 * @warning You should always append to an event array or you will end up
6403 * deleting a previous registered hook.
6405 * @warning Hook handlers should be registered at file scope. Registering
6406 * handlers after file scope can lead to unexpected results due to caching.
6408 $wgHooks = array();
6411 * Maps jobs to their handling classes; extensions
6412 * can add to this to provide custom jobs
6414 $wgJobClasses = array(
6415 'refreshLinks' => 'RefreshLinksJob',
6416 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6417 'sendMail' => 'EmaillingJob',
6418 'enotifNotify' => 'EnotifNotifyJob',
6419 'fixDoubleRedirect' => 'DoubleRedirectJob',
6420 'uploadFromUrl' => 'UploadFromUrlJob',
6421 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6422 'PublishStashedFile' => 'PublishStashedFileJob',
6423 'ThumbnailRender' => 'ThumbnailRenderJob',
6424 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6425 'null' => 'NullJob'
6429 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6430 * special flags are set. The values here are keys of $wgJobClasses.
6432 * These can be:
6433 * - Very long-running jobs.
6434 * - Jobs that you would never want to run as part of a page rendering request.
6435 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6436 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6437 * These settings should be global to all wikis.
6439 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6442 * Map of job types to how many job "work items" should be run per second
6443 * on each job runner process. The meaning of "work items" varies per job,
6444 * but typically would be something like "pages to update". A single job
6445 * may have a variable number of work items, as is the case with batch jobs.
6446 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6447 * These settings should be global to all wikis.
6448 * @var float[]
6450 $wgJobBackoffThrottling = array();
6453 * Map of job types to configuration arrays.
6454 * This determines which queue class and storage system is used for each job type.
6455 * Job types that do not have explicit configuration will use the 'default' config.
6456 * These settings should be global to all wikis.
6458 $wgJobTypeConf = array(
6459 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6463 * Which aggregator to use for tracking which queues have jobs.
6464 * These settings should be global to all wikis.
6466 $wgJobQueueAggregator = array(
6467 'class' => 'JobQueueAggregatorMemc'
6471 * Additional functions to be performed with updateSpecialPages.
6472 * Expensive Querypages are already updated.
6474 $wgSpecialPageCacheUpdates = array(
6475 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6476 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6480 * Hooks that are used for outputting exceptions. Format is:
6481 * $wgExceptionHooks[] = $funcname
6482 * or:
6483 * $wgExceptionHooks[] = array( $class, $funcname )
6484 * Hooks should return strings or false
6486 $wgExceptionHooks = array();
6489 * Page property link table invalidation lists. When a page property
6490 * changes, this may require other link tables to be updated (eg
6491 * adding __HIDDENCAT__ means the hiddencat tracking category will
6492 * have been added, so the categorylinks table needs to be rebuilt).
6493 * This array can be added to by extensions.
6495 $wgPagePropLinkInvalidations = array(
6496 'hiddencat' => 'categorylinks',
6499 /** @} */ # End extensions }
6501 /*************************************************************************//**
6502 * @name Categories
6503 * @{
6507 * Use experimental, DMOZ-like category browser
6509 $wgUseCategoryBrowser = false;
6512 * On category pages, show thumbnail gallery for images belonging to that
6513 * category instead of listing them as articles.
6515 $wgCategoryMagicGallery = true;
6518 * Paging limit for categories
6520 $wgCategoryPagingLimit = 200;
6523 * Specify how category names should be sorted, when listed on a category page.
6524 * A sorting scheme is also known as a collation.
6526 * Available values are:
6528 * - uppercase: Converts the category name to upper case, and sorts by that.
6530 * - identity: Does no conversion. Sorts by binary value of the string.
6532 * - uca-default: Provides access to the Unicode Collation Algorithm with
6533 * the default element table. This is a compromise collation which sorts
6534 * all languages in a mediocre way. However, it is better than "uppercase".
6536 * To use the uca-default collation, you must have PHP's intl extension
6537 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6538 * resulting collation will depend on the version of ICU installed on the
6539 * server.
6541 * After you change this, you must run maintenance/updateCollation.php to fix
6542 * the sort keys in the database.
6544 * Extensions can define there own collations by subclassing Collation
6545 * and using the Collation::factory hook.
6547 $wgCategoryCollation = 'uppercase';
6549 /** @} */ # End categories }
6551 /*************************************************************************//**
6552 * @name Logging
6553 * @{
6557 * The logging system has two levels: an event type, which describes the
6558 * general category and can be viewed as a named subset of all logs; and
6559 * an action, which is a specific kind of event that can exist in that
6560 * log type.
6562 $wgLogTypes = array(
6564 'block',
6565 'protect',
6566 'rights',
6567 'delete',
6568 'upload',
6569 'move',
6570 'import',
6571 'patrol',
6572 'merge',
6573 'suppress',
6574 'managetags',
6578 * This restricts log access to those who have a certain right
6579 * Users without this will not see it in the option menu and can not view it
6580 * Restricted logs are not added to recent changes
6581 * Logs should remain non-transcludable
6582 * Format: logtype => permissiontype
6584 $wgLogRestrictions = array(
6585 'suppress' => 'suppressionlog'
6589 * Show/hide links on Special:Log will be shown for these log types.
6591 * This is associative array of log type => boolean "hide by default"
6593 * See $wgLogTypes for a list of available log types.
6595 * @par Example:
6596 * @code
6597 * $wgFilterLogTypes = array(
6598 * 'move' => true,
6599 * 'import' => false,
6600 * );
6601 * @endcode
6603 * Will display show/hide links for the move and import logs. Move logs will be
6604 * hidden by default unless the link is clicked. Import logs will be shown by
6605 * default, and hidden when the link is clicked.
6607 * A message of the form log-show-hide-[type] should be added, and will be used
6608 * for the link text.
6610 $wgFilterLogTypes = array(
6611 'patrol' => true
6615 * Lists the message key string for each log type. The localized messages
6616 * will be listed in the user interface.
6618 * Extensions with custom log types may add to this array.
6620 * @since 1.19, if you follow the naming convention log-name-TYPE,
6621 * where TYPE is your log type, yoy don't need to use this array.
6623 $wgLogNames = array(
6624 '' => 'all-logs-page',
6625 'block' => 'blocklogpage',
6626 'protect' => 'protectlogpage',
6627 'rights' => 'rightslog',
6628 'delete' => 'dellogpage',
6629 'upload' => 'uploadlogpage',
6630 'move' => 'movelogpage',
6631 'import' => 'importlogpage',
6632 'patrol' => 'patrol-log-page',
6633 'merge' => 'mergelog',
6634 'suppress' => 'suppressionlog',
6638 * Lists the message key string for descriptive text to be shown at the
6639 * top of each log type.
6641 * Extensions with custom log types may add to this array.
6643 * @since 1.19, if you follow the naming convention log-description-TYPE,
6644 * where TYPE is your log type, yoy don't need to use this array.
6646 $wgLogHeaders = array(
6647 '' => 'alllogstext',
6648 'block' => 'blocklogtext',
6649 'protect' => 'protectlogtext',
6650 'rights' => 'rightslogtext',
6651 'delete' => 'dellogpagetext',
6652 'upload' => 'uploadlogpagetext',
6653 'move' => 'movelogpagetext',
6654 'import' => 'importlogpagetext',
6655 'patrol' => 'patrol-log-header',
6656 'merge' => 'mergelogpagetext',
6657 'suppress' => 'suppressionlogtext',
6661 * Lists the message key string for formatting individual events of each
6662 * type and action when listed in the logs.
6664 * Extensions with custom log types may add to this array.
6666 $wgLogActions = array(
6667 'block/block' => 'blocklogentry',
6668 'block/unblock' => 'unblocklogentry',
6669 'block/reblock' => 'reblock-logentry',
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',
6676 'suppress/block' => 'blocklogentry',
6677 'suppress/reblock' => 'reblock-logentry',
6681 * The same as above, but here values are names of functions,
6682 * not messages.
6683 * @see LogPage::actionText
6684 * @see LogFormatter
6686 $wgLogActionsHandlers = array(
6687 'move/move' => 'MoveLogFormatter',
6688 'move/move_redir' => 'MoveLogFormatter',
6689 'delete/delete' => 'DeleteLogFormatter',
6690 'delete/restore' => 'DeleteLogFormatter',
6691 'delete/revision' => 'DeleteLogFormatter',
6692 'delete/event' => 'DeleteLogFormatter',
6693 'suppress/revision' => 'DeleteLogFormatter',
6694 'suppress/event' => 'DeleteLogFormatter',
6695 'suppress/delete' => 'DeleteLogFormatter',
6696 'patrol/patrol' => 'PatrolLogFormatter',
6697 'rights/rights' => 'RightsLogFormatter',
6698 'rights/autopromote' => 'RightsLogFormatter',
6699 'upload/upload' => 'LogFormatter',
6700 'upload/overwrite' => 'LogFormatter',
6701 'upload/revert' => 'LogFormatter',
6702 'merge/merge' => 'MergeLogFormatter',
6703 'managetags/create' => 'LogFormatter',
6704 'managetags/delete' => 'LogFormatter',
6705 'managetags/activate' => 'LogFormatter',
6706 'managetags/deactivate' => 'LogFormatter',
6710 * Maintain a log of newusers at Log/newusers?
6712 $wgNewUserLog = true;
6714 /** @} */ # end logging }
6716 /*************************************************************************//**
6717 * @name Special pages (general and miscellaneous)
6718 * @{
6722 * Allow special page inclusions such as {{Special:Allpages}}
6724 $wgAllowSpecialInclusion = true;
6727 * Set this to an array of special page names to prevent
6728 * maintenance/updateSpecialPages.php from updating those pages.
6730 $wgDisableQueryPageUpdate = false;
6733 * List of special pages, followed by what subtitle they should go under
6734 * at Special:SpecialPages
6736 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6738 $wgSpecialPageGroups = array();
6741 * On Special:Unusedimages, consider images "used", if they are put
6742 * into a category. Default (false) is not to count those as used.
6744 $wgCountCategorizedImagesAsUsed = false;
6747 * Maximum number of links to a redirect page listed on
6748 * Special:Whatlinkshere/RedirectDestination
6750 $wgMaxRedirectLinksRetrieved = 500;
6752 /** @} */ # end special pages }
6754 /*************************************************************************//**
6755 * @name Actions
6756 * @{
6760 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6761 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6762 * 'foo' => true Load the class FooAction which subclasses Action
6763 * If something is specified in the getActionOverrides()
6764 * of the relevant Page object it will be used
6765 * instead of the default class.
6766 * 'foo' => false The action is disabled; show an error message
6767 * Unsetting core actions will probably cause things to complain loudly.
6769 $wgActions = array(
6770 'credits' => true,
6771 'delete' => true,
6772 'edit' => true,
6773 'history' => true,
6774 'info' => true,
6775 'markpatrolled' => true,
6776 'protect' => true,
6777 'purge' => true,
6778 'raw' => true,
6779 'render' => true,
6780 'revert' => true,
6781 'revisiondelete' => true,
6782 'rollback' => true,
6783 'submit' => true,
6784 'unprotect' => true,
6785 'unwatch' => true,
6786 'view' => true,
6787 'watch' => true,
6790 /** @} */ # end actions }
6792 /*************************************************************************//**
6793 * @name Robot (search engine crawler) policy
6794 * See also $wgNoFollowLinks.
6795 * @{
6799 * Default robot policy. The default policy is to encourage indexing and fol-
6800 * lowing of links. It may be overridden on a per-namespace and/or per-page
6801 * basis.
6803 $wgDefaultRobotPolicy = 'index,follow';
6806 * Robot policies per namespaces. The default policy is given above, the array
6807 * is made of namespace constants as defined in includes/Defines.php. You can-
6808 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6809 * nofollow. This is because a number of special pages (e.g., ListPages) have
6810 * many permutations of options that display the same data under redundant
6811 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6812 * pages, all alike, and never reaching your actual content.
6814 * @par Example:
6815 * @code
6816 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6817 * @endcode
6819 $wgNamespaceRobotPolicies = array();
6822 * Robot policies per article. These override the per-namespace robot policies.
6823 * Must be in the form of an array where the key part is a properly canonicalised
6824 * text form title and the value is a robot policy.
6826 * @par Example:
6827 * @code
6828 * $wgArticleRobotPolicies = array(
6829 * 'Main Page' => 'noindex,follow',
6830 * 'User:Bob' => 'index,follow',
6831 * );
6832 * @endcode
6834 * @par Example that DOES NOT WORK because the names are not canonical text
6835 * forms:
6836 * @code
6837 * $wgArticleRobotPolicies = array(
6838 * # Underscore, not space!
6839 * 'Main_Page' => 'noindex,follow',
6840 * # "Project", not the actual project name!
6841 * 'Project:X' => 'index,follow',
6842 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6843 * 'abc' => 'noindex,nofollow'
6844 * );
6845 * @endcode
6847 $wgArticleRobotPolicies = array();
6850 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6851 * will not function, so users can't decide whether pages in that namespace are
6852 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6854 * @par Example:
6855 * @code
6856 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6857 * @endcode
6859 $wgExemptFromUserRobotsControl = null;
6861 /** @} */ # End robot policy }
6863 /************************************************************************//**
6864 * @name AJAX and API
6865 * Note: The AJAX entry point which this section refers to is gradually being
6866 * replaced by the API entry point, api.php. They are essentially equivalent.
6867 * Both of them are used for dynamic client-side features, via XHR.
6868 * @{
6872 * Enable the MediaWiki API for convenient access to
6873 * machine-readable data via api.php
6875 * See https://www.mediawiki.org/wiki/API
6877 $wgEnableAPI = true;
6880 * Allow the API to be used to perform write operations
6881 * (page edits, rollback, etc.) when an authorised user
6882 * accesses it
6884 $wgEnableWriteAPI = true;
6888 * WARNING: SECURITY THREAT - debug use only
6890 * Disables many security checks in the API for debugging purposes.
6891 * This flag should never be used on the production servers, as it introduces
6892 * a number of potential security holes. Even when enabled, the validation
6893 * will still be performed, but instead of failing, API will return a warning.
6894 * Also, there will always be a warning notifying that this flag is set.
6895 * At this point, the flag allows GET requests to go through for modules
6896 * requiring POST.
6898 * @since 1.21
6900 $wgDebugAPI = false;
6903 * API module extensions.
6905 * Associative array mapping module name to modules specs;
6906 * Each module spec is an associative array containing at least
6907 * the 'class' key for the module's class, and optionally a
6908 * 'factory' key for the factory function to use for the module.
6910 * That factory function will be called with two parameters,
6911 * the parent module (an instance of ApiBase, usually ApiMain)
6912 * and the name the module was registered under. The return
6913 * value must be an instance of the class given in the 'class'
6914 * field.
6916 * For backward compatibility, the module spec may also be a
6917 * simple string containing the module's class name. In that
6918 * case, the class' constructor will be called with the parent
6919 * module and module name as parameters, as described above.
6921 * Examples for registering API modules:
6923 * @code
6924 * $wgAPIModules['foo'] = 'ApiFoo';
6925 * $wgAPIModules['bar'] = array(
6926 * 'class' => 'ApiBar',
6927 * 'factory' => function( $main, $name ) { ... }
6928 * );
6929 * $wgAPIModules['xyzzy'] = array(
6930 * 'class' => 'ApiXyzzy',
6931 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
6932 * );
6933 * @endcode
6935 * Extension modules may override the core modules.
6936 * See ApiMain::$Modules for a list of the core modules.
6938 $wgAPIModules = array();
6941 * API format module extensions.
6942 * Associative array mapping format module name to module specs (see $wgAPIModules).
6943 * Extension modules may override the core modules.
6945 * See ApiMain::$Formats for a list of the core format modules.
6947 $wgAPIFormatModules = array();
6950 * API Query meta module extensions.
6951 * Associative array mapping meta module name to module specs (see $wgAPIModules).
6952 * Extension modules may override the core modules.
6954 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6956 $wgAPIMetaModules = array();
6959 * API Query prop module extensions.
6960 * Associative array mapping prop module name to module specs (see $wgAPIModules).
6961 * Extension modules may override the core modules.
6963 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6965 $wgAPIPropModules = array();
6968 * API Query list module extensions.
6969 * Associative array mapping list module name to module specs (see $wgAPIModules).
6970 * Extension modules may override the core modules.
6972 * See ApiQuery::$QueryListModules for a list of the core list modules.
6974 $wgAPIListModules = array();
6977 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6978 * @deprecated since 1.21
6980 $wgAPIGeneratorModules = array();
6983 * Maximum amount of rows to scan in a DB query in the API
6984 * The default value is generally fine
6986 $wgAPIMaxDBRows = 5000;
6989 * The maximum size (in bytes) of an API result.
6990 * @warning Do not set this lower than $wgMaxArticleSize*1024
6992 $wgAPIMaxResultSize = 8388608;
6995 * The maximum number of uncached diffs that can be retrieved in one API
6996 * request. Set this to 0 to disable API diffs altogether
6998 $wgAPIMaxUncachedDiffs = 1;
7001 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7002 * API request logging
7004 $wgAPIRequestLog = false;
7007 * Set the timeout for the API help text cache. If set to 0, caching disabled
7009 $wgAPICacheHelpTimeout = 60 * 60;
7012 * The ApiQueryQueryPages module should skip pages that are redundant to true
7013 * API queries.
7015 $wgAPIUselessQueryPages = array(
7016 'MIMEsearch', // aiprop=mime
7017 'LinkSearch', // list=exturlusage
7018 'FileDuplicateSearch', // prop=duplicatefiles
7022 * Enable AJAX framework
7024 $wgUseAjax = true;
7027 * List of Ajax-callable functions.
7028 * Extensions acting as Ajax callbacks must register here
7030 $wgAjaxExportList = array();
7033 * Enable watching/unwatching pages using AJAX.
7034 * Requires $wgUseAjax to be true too.
7036 $wgAjaxWatch = true;
7039 * Enable AJAX check for file overwrite, pre-upload
7041 $wgAjaxUploadDestCheck = true;
7044 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7046 $wgAjaxLicensePreview = true;
7049 * Have clients send edits to be prepared when filling in edit summaries.
7050 * This gives the server a head start on the expensive parsing operation.
7052 $wgAjaxEditStash = true;
7055 * Settings for incoming cross-site AJAX requests:
7056 * Newer browsers support cross-site AJAX when the target resource allows requests
7057 * from the origin domain by the Access-Control-Allow-Origin header.
7058 * This is currently only used by the API (requests to api.php)
7059 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7061 * - '*' matches any number of characters
7062 * - '?' matches any 1 character
7064 * @par Example:
7065 * @code
7066 * $wgCrossSiteAJAXdomains = array(
7067 * 'www.mediawiki.org',
7068 * '*.wikipedia.org',
7069 * '*.wikimedia.org',
7070 * '*.wiktionary.org',
7071 * );
7072 * @endcode
7074 $wgCrossSiteAJAXdomains = array();
7077 * Domains that should not be allowed to make AJAX requests,
7078 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7079 * Uses the same syntax as $wgCrossSiteAJAXdomains
7081 $wgCrossSiteAJAXdomainExceptions = array();
7083 /** @} */ # End AJAX and API }
7085 /************************************************************************//**
7086 * @name Shell and process control
7087 * @{
7091 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7093 $wgMaxShellMemory = 307200;
7096 * Maximum file size created by shell processes under linux, in KB
7097 * ImageMagick convert for example can be fairly hungry for scratch space
7099 $wgMaxShellFileSize = 102400;
7102 * Maximum CPU time in seconds for shell processes under Linux
7104 $wgMaxShellTime = 180;
7107 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7108 * would measure) in seconds for shell processes under Linux
7110 $wgMaxShellWallClockTime = 180;
7113 * Under Linux: a cgroup directory used to constrain memory usage of shell
7114 * commands. The directory must be writable by the user which runs MediaWiki.
7116 * If specified, this is used instead of ulimit, which is inaccurate, and
7117 * causes malloc() to return NULL, which exposes bugs in C applications, making
7118 * them segfault or deadlock.
7120 * A wrapper script will create a cgroup for each shell command that runs, as
7121 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7122 * kernel will send a SIGKILL signal to a process in the subgroup.
7124 * @par Example:
7125 * @code
7126 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7127 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7128 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7129 * @endcode
7131 * The reliability of cgroup cleanup can be improved by installing a
7132 * notify_on_release script in the root cgroup, see e.g.
7133 * https://gerrit.wikimedia.org/r/#/c/40784
7135 $wgShellCgroup = false;
7138 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7140 $wgPhpCli = '/usr/bin/php';
7143 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7144 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7145 * character set. Only the character set is relevant.
7147 $wgShellLocale = 'en_US.utf8';
7149 /** @} */ # End shell }
7151 /************************************************************************//**
7152 * @name HTTP client
7153 * @{
7157 * Timeout for HTTP requests done internally, in seconds.
7159 $wgHTTPTimeout = 25;
7162 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7164 $wgAsyncHTTPTimeout = 25;
7167 * Proxy to use for CURL requests.
7169 $wgHTTPProxy = false;
7172 * Local virtual hosts.
7174 * This lists domains that are configured as virtual hosts on the same machine.
7175 * If a request is to be made to a domain listed here, or any subdomain thereof,
7176 * then no proxy will be used.
7177 * Command-line scripts are not affected by this setting and will always use
7178 * proxy if it is configured.
7179 * @since 1.25
7181 $wgLocalVirtualHosts = array();
7184 * Timeout for connections done internally (in seconds)
7185 * Only works for curl
7187 $wgHTTPConnectTimeout = 5e0;
7189 /** @} */ # End HTTP client }
7191 /************************************************************************//**
7192 * @name Job queue
7193 * See also $wgEnotifUseJobQ.
7194 * @{
7198 * Number of jobs to perform per request. May be less than one in which case
7199 * jobs are performed probabalistically. If this is zero, jobs will not be done
7200 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7201 * be run periodically.
7203 $wgJobRunRate = 1;
7206 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7207 * to handle the job execution, instead of blocking the request until the job
7208 * execution finishes.
7209 * @since 1.23
7211 $wgRunJobsAsync = true;
7214 * Number of rows to update per job
7216 $wgUpdateRowsPerJob = 500;
7219 * Number of rows to update per query
7221 $wgUpdateRowsPerQuery = 100;
7223 /** @} */ # End job queue }
7225 /************************************************************************//**
7226 * @name Miscellaneous
7227 * @{
7231 * Name of the external diff engine to use
7233 $wgExternalDiffEngine = false;
7236 * Disable redirects to special pages and interwiki redirects, which use a 302
7237 * and have no "redirected from" link.
7239 * @note This is only for articles with #REDIRECT in them. URL's containing a
7240 * local interwiki prefix (or a non-canonical special page name) are still hard
7241 * redirected regardless of this setting.
7243 $wgDisableHardRedirects = false;
7246 * LinkHolderArray batch size
7247 * For debugging
7249 $wgLinkHolderBatchSize = 1000;
7252 * By default MediaWiki does not register links pointing to same server in
7253 * externallinks dataset, use this value to override:
7255 $wgRegisterInternalExternals = false;
7258 * Maximum number of pages to move at once when moving subpages with a page.
7260 $wgMaximumMovedPages = 100;
7263 * Fix double redirects after a page move.
7264 * Tends to conflict with page move vandalism, use only on a private wiki.
7266 $wgFixDoubleRedirects = false;
7269 * Allow redirection to another page when a user logs in.
7270 * To enable, set to a string like 'Main Page'
7272 $wgRedirectOnLogin = null;
7275 * Configuration for processing pool control, for use in high-traffic wikis.
7276 * An implementation is provided in the PoolCounter extension.
7278 * This configuration array maps pool types to an associative array. The only
7279 * defined key in the associative array is "class", which gives the class name.
7280 * The remaining elements are passed through to the class as constructor
7281 * parameters.
7283 * @par Example:
7284 * @code
7285 * $wgPoolCounterConf = array( 'ArticleView' => array(
7286 * 'class' => 'PoolCounter_Client',
7287 * 'timeout' => 15, // wait timeout in seconds
7288 * 'workers' => 5, // maximum number of active threads in each pool
7289 * 'maxqueue' => 50, // maximum number of total threads in each pool
7290 * ... any extension-specific options...
7291 * );
7292 * @endcode
7294 $wgPoolCounterConf = null;
7297 * To disable file delete/restore temporarily
7299 $wgUploadMaintenance = false;
7302 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7303 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7304 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7305 * (except for the special case of JS and CS pages).
7307 * @since 1.21
7309 $wgNamespaceContentModels = array();
7312 * How to react if a plain text version of a non-text Content object is requested using
7313 * ContentHandler::getContentText():
7315 * * 'ignore': return null
7316 * * 'fail': throw an MWException
7317 * * 'serialize': serialize to default format
7319 * @since 1.21
7321 $wgContentHandlerTextFallback = 'ignore';
7324 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7325 * This way, the ContentHandler facility can be used without any additional information in the
7326 * database. A page's content model is then derived solely from the page's title. This however
7327 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7328 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7329 * a title that would default to a different content model.
7331 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7332 * handling is less robust and less flexible.
7334 * @since 1.21
7336 $wgContentHandlerUseDB = true;
7339 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7340 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7341 * the effect on the database they would have on a wikitext page.
7343 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7344 * or at least parse only the contents of comments in the scripts.
7346 * @since 1.21
7348 $wgTextModelsToParse = array(
7349 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7350 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7351 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7355 * Whether the user must enter their password to change their e-mail address
7357 * @since 1.20
7359 $wgRequirePasswordforEmailChange = true;
7362 * Register handlers for specific types of sites.
7364 * @since 1.20
7366 $wgSiteTypes = array(
7367 'mediawiki' => 'MediaWikiSite',
7371 * Whether the page_props table has a pp_sortkey column. Set to false in case
7372 * the respective database schema change was not applied.
7373 * @since 1.23
7375 $wgPagePropsHaveSortkey = true;
7378 * Port where you have HTTPS running
7379 * Supports HTTPS on non-standard ports
7380 * @see bug 65184
7381 * @since 1.24
7383 $wgHttpsPort = 443;
7386 * Secret for hmac-based key derivation function (fast,
7387 * cryptographically secure random numbers).
7388 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7389 * be used.
7390 * See also: $wgHKDFAlgorithm
7391 * @since 1.24
7393 $wgHKDFSecret = false;
7396 * Algorithm for hmac-based key derivation function (fast,
7397 * cryptographically secure random numbers).
7398 * See also: $wgHKDFSecret
7399 * @since 1.24
7401 $wgHKDFAlgorithm = 'sha256';
7404 * Enable page language feature
7405 * Allows setting page language in database
7406 * @var bool
7407 * @since 1.24
7409 $wgPageLanguageUseDB = false;
7412 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7413 * Set this only if the fields are fully populated. This may be removed in 1.25.
7414 * @var bool
7415 * @since 1.24
7417 $wgUseLinkNamespaceDBFields = true;
7420 * For really cool vim folding this needs to be at the end:
7421 * vim: foldmarker=@{,@} foldmethod=marker
7422 * @}