Add parser tests for bug 52468 and bug 52363.
[mediawiki.git] / includes / DefaultSettings.php
blob8302e6d45ae02eceef9a4b544ce834fd77350880
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 * http://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 * MediaWiki version number
64 * @since 1.2
66 $wgVersion = '1.22alpha';
68 /**
69 * Name of the site. It must be changed in LocalSettings.php
71 $wgSitename = 'MediaWiki';
73 /**
74 * URL of the server.
76 * @par Example:
77 * @code
78 * $wgServer = 'http://example.com';
79 * @endcode
81 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
82 * wrong server, it will redirect incorrectly after you save a page. In that
83 * case, set this variable to fix it.
85 * If you want to use protocol-relative URLs on your wiki, set this to a
86 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
87 * to a fully qualified URL.
89 $wgServer = WebRequest::detectServer();
91 /**
92 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
93 * Must be fully qualified, even if $wgServer is protocol-relative.
95 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
96 * @since 1.18
98 $wgCanonicalServer = false;
100 /************************************************************************//**
101 * @name Script path settings
102 * @{
106 * The path we should point to.
107 * It might be a virtual path in case with use apache mod_rewrite for example.
109 * This *needs* to be set correctly.
111 * Other paths will be set to defaults based on it unless they are directly
112 * set in LocalSettings.php
114 $wgScriptPath = '/wiki';
117 * Whether to support URLs like index.php/Page_title These often break when PHP
118 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
119 * but then again it may not; lighttpd converts incoming path data to lowercase
120 * on systems with case-insensitive filesystems, and there have been reports of
121 * problems on Apache as well.
123 * To be safe we'll continue to keep it off by default.
125 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
126 * incorrect garbage, or to true if it is really correct.
128 * The default $wgArticlePath will be set based on this value at runtime, but if
129 * you have customized it, having this incorrectly set to true can cause
130 * redirect loops when "pretty URLs" are used.
131 * @since 1.2.1
133 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
134 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
135 ( strpos( PHP_SAPI, 'isapi' ) === false );
138 * The extension to append to script names by default. This can either be .php
139 * or .php5.
141 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
142 * variable is provided to support those providers.
143 * @since 1.11
145 $wgScriptExtension = '.php';
147 /**@}*/
149 /************************************************************************//**
150 * @name URLs and file paths
152 * These various web and file path variables are set to their defaults
153 * in Setup.php if they are not explicitly set from LocalSettings.php.
155 * These will relatively rarely need to be set manually, unless you are
156 * splitting style sheets or images outside the main document root.
158 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
159 * the host part, that starts with a slash. In most cases a full URL is also
160 * acceptable. A "directory" is a local file path.
162 * In both paths and directories, trailing slashes should not be included.
164 * @{
168 * The URL path to index.php.
170 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
172 $wgScript = false;
175 * The URL path to load.php.
177 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
178 * @since 1.17
180 $wgLoadScript = false;
183 * The URL path of the skins directory.
184 * Defaults to "{$wgScriptPath}/skins".
185 * @since 1.3
187 $wgStylePath = false;
188 $wgStyleSheetPath = &$wgStylePath;
191 * The URL path of the skins directory. Should not point to an external domain.
192 * Defaults to "{$wgScriptPath}/skins".
193 * @since 1.17
195 $wgLocalStylePath = false;
198 * The URL path of the extensions directory.
199 * Defaults to "{$wgScriptPath}/extensions".
200 * @since 1.16
202 $wgExtensionAssetsPath = false;
205 * Filesystem stylesheets directory.
206 * Defaults to "{$IP}/skins".
207 * @since 1.3
209 $wgStyleDirectory = false;
212 * The URL path for primary article page views. This path should contain $1,
213 * which is replaced by the article title.
215 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
216 * depending on $wgUsePathInfo.
218 $wgArticlePath = false;
221 * The URL path for the images directory.
222 * Defaults to "{$wgScriptPath}/images".
224 $wgUploadPath = false;
227 * The filesystem path of the images directory. Defaults to "{$IP}/images".
229 $wgUploadDirectory = false;
232 * Directory where the cached page will be saved.
233 * Defaults to "{$wgUploadDirectory}/cache".
235 $wgFileCacheDirectory = false;
238 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
239 * Defaults to "{$wgStylePath}/common/images/wiki.png".
241 $wgLogo = false;
244 * The URL path of the shortcut icon.
245 * @since 1.6
247 $wgFavicon = '/favicon.ico';
250 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
251 * Defaults to no icon.
252 * @since 1.12
254 $wgAppleTouchIcon = false;
257 * The local filesystem path to a temporary directory. This is not required to
258 * be web accessible.
260 * When this setting is set to false, its value will be set through a call
261 * to wfTempDir(). See that methods implementation for the actual detection
262 * logic.
264 * Developers should use the global function wfTempDir() instead of this
265 * variable.
267 * @see wfTempDir()
268 * @note Default changed to false in MediaWiki 1.20.
270 $wgTmpDirectory = false;
273 * If set, this URL is added to the start of $wgUploadPath to form a complete
274 * upload URL.
275 * @since 1.4
277 $wgUploadBaseUrl = '';
280 * To enable remote on-demand scaling, set this to the thumbnail base URL.
281 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
282 * where 'e6' are the first two characters of the MD5 hash of the file name.
283 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
284 * @since 1.17
286 $wgUploadStashScalerBaseUrl = false;
289 * To set 'pretty' URL paths for actions other than
290 * plain page views, add to this array.
292 * @par Example:
293 * Set pretty URL for the edit action:
294 * @code
295 * 'edit' => "$wgScriptPath/edit/$1"
296 * @endcode
298 * There must be an appropriate script or rewrite rule in place to handle these
299 * URLs.
300 * @since 1.5
302 $wgActionPaths = array();
304 /**@}*/
306 /************************************************************************//**
307 * @name Files and file uploads
308 * @{
311 /** Uploads have to be specially set up to be secure */
312 $wgEnableUploads = false;
315 * The maximum age of temporary (incomplete) uploaded files
317 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
319 /** Allows to move images and other media files */
320 $wgAllowImageMoving = true;
323 * Enable deferred upload tasks that use the job queue.
324 * Only enable this if job runners are set up for both the
325 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
327 * @note If you use suhosin, this setting is incompatible with
328 * suhosin.session.encrypt.
330 $wgEnableAsyncUploads = false;
333 * These are additional characters that should be replaced with '-' in filenames
335 $wgIllegalFileChars = ":";
338 * @deprecated since 1.17 use $wgDeletedDirectory
340 $wgFileStore = array();
343 * What directory to place deleted uploads in.
344 * Defaults to "{$wgUploadDirectory}/deleted".
346 $wgDeletedDirectory = false;
349 * Set this to true if you use img_auth and want the user to see details on why access failed.
351 $wgImgAuthDetails = false;
354 * If this is enabled, img_auth.php will not allow image access unless the wiki
355 * is private. This improves security when image uploads are hosted on a
356 * separate domain.
358 $wgImgAuthPublicTest = true;
361 * File repository structures
363 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
364 * an array of such structures. Each repository structure is an associative
365 * array of properties configuring the repository.
367 * Properties required for all repos:
368 * - class The class name for the repository. May come from the core or an extension.
369 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
370 * FSRepo is also supported for backwards compatibility.
372 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
373 * The name should consist of alpha-numeric characters.
374 * - backend A file backend name (see $wgFileBackends).
376 * For most core repos:
377 * - zones Associative array of zone names that each map to an array with:
378 * container : backend container name the zone is in
379 * directory : root path within container for the zone
380 * url : base URL to the root of the zone
381 * urlsByExt : map of file extension types to base URLs
382 * (useful for using a different cache for videos)
383 * handlerUrl : base script-handled URL to the root of the zone
384 * (see FileRepo::getZoneHandlerUrl() function)
385 * Zones default to using "<repo name>-<zone name>" as the container name
386 * and default to using the container root as the zone's root directory.
387 * Nesting of zone locations within other zones should be avoided.
388 * - url Public zone URL. The 'zones' settings take precedence.
389 * - hashLevels The number of directory levels for hash-based division of files
390 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
391 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
392 * handler instead.
393 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
394 * determines whether filenames implicitly start with a capital letter.
395 * The current implementation may give incorrect description page links
396 * when the local $wgCapitalLinks and initialCapital are mismatched.
397 * - pathDisclosureProtection
398 * May be 'paranoid' to remove all parameters from error messages, 'none' to
399 * leave the paths in unchanged, or 'simple' to replace paths with
400 * placeholders. Default for LocalRepo is 'simple'.
401 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
402 * is 0644.
403 * - directory The local filesystem directory where public files are stored. Not used for
404 * some remote repos.
405 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
406 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
407 * - isPrivate Set this if measures should always be taken to keep the files private.
408 * One should not trust this to assure that the files are not web readable;
409 * the server configuration should be done manually depending on the backend.
411 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
412 * for local repositories:
413 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
414 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
415 * http://en.wikipedia.org/w
416 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
417 * $wgScriptExtension, e.g. .php5 defaults to .php
419 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
420 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
421 * $wgFetchCommonsDescriptions.
422 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
423 * Short thumbnail names only have the width, parameters, and the extension.
425 * ForeignDBRepo:
426 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
427 * equivalent to the corresponding member of $wgDBservers
428 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
429 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
431 * ForeignAPIRepo:
432 * - apibase Use for the foreign API's URL
433 * - apiThumbCacheExpiry How long to locally cache thumbs for
435 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
436 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
437 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
438 * If you set $wgForeignFileRepos to an array of repository structures, those will
439 * be searched after the local file repo.
440 * Otherwise, you will only have access to local media files.
442 * @see Setup.php for an example usage and default initialization.
444 $wgLocalFileRepo = false;
446 /** @see $wgLocalFileRepo */
447 $wgForeignFileRepos = array();
450 * Use Commons as a remote file repository. Essentially a wrapper, when this
451 * is enabled $wgForeignFileRepos will point at Commons with a set of default
452 * settings
454 $wgUseInstantCommons = false;
457 * File backend structure configuration.
459 * This is an array of file backend configuration arrays.
460 * Each backend configuration has the following parameters:
461 * - 'name' : A unique name for the backend
462 * - 'class' : The file backend class to use
463 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
464 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
466 * See FileBackend::__construct() for more details.
467 * Additional parameters are specific to the file backend class used.
468 * These settings should be global to all wikis when possible.
470 * There are two particularly important aspects about each backend:
471 * - a) Whether it is fully qualified or wiki-relative.
472 * By default, the paths of files are relative to the current wiki,
473 * which works via prefixing them with the current wiki ID when accessed.
474 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
475 * all paths with the specified value instead. This can be useful if
476 * multiple wikis need to share the same data. Note that 'name' is *not*
477 * part of any prefix and thus should not be relied upon for namespacing.
478 * - b) Whether it is only defined for some wikis or is defined on all
479 * wikis in the wiki farm. Defining a backend globally is useful
480 * if multiple wikis need to share the same data.
481 * One should be aware of these aspects when configuring a backend for use with
482 * any basic feature or plugin. For example, suppose an extension stores data for
483 * different wikis in different directories and sometimes needs to access data from
484 * a foreign wiki's directory in order to render a page on given wiki. The extension
485 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
487 $wgFileBackends = array();
490 * Array of configuration arrays for each lock manager.
491 * Each backend configuration has the following parameters:
492 * - 'name' : A unique name for the lock manager
493 * - 'class' : The lock manger class to use
495 * See LockManager::__construct() for more details.
496 * Additional parameters are specific to the lock manager class used.
497 * These settings should be global to all wikis.
499 $wgLockManagers = array();
502 * Show Exif data, on by default if available.
503 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
505 * @note FOR WINDOWS USERS:
506 * To enable Exif functions, add the following lines to the "Windows
507 * extensions" section of php.ini:
508 * @code{.ini}
509 * extension=extensions/php_mbstring.dll
510 * extension=extensions/php_exif.dll
511 * @endcode
513 $wgShowEXIF = function_exists( 'exif_read_data' );
516 * If to automatically update the img_metadata field
517 * if the metadata field is outdated but compatible with the current version.
518 * Defaults to false.
520 $wgUpdateCompatibleMetadata = false;
523 * If you operate multiple wikis, you can define a shared upload path here.
524 * Uploads to this wiki will NOT be put there - they will be put into
525 * $wgUploadDirectory.
526 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
527 * no file of the given name is found in the local repository (for [[File:..]],
528 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
529 * directory.
531 * Note that these configuration settings can now be defined on a per-
532 * repository basis for an arbitrary number of file repositories, using the
533 * $wgForeignFileRepos variable.
535 $wgUseSharedUploads = false;
537 /** Full path on the web server where shared uploads can be found */
538 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
540 /** Fetch commons image description pages and display them on the local wiki? */
541 $wgFetchCommonsDescriptions = false;
543 /** Path on the file system where shared uploads can be found. */
544 $wgSharedUploadDirectory = "/var/www/wiki3/images";
546 /** DB name with metadata about shared directory. Set this to false if the uploads do not come from a wiki. */
547 $wgSharedUploadDBname = false;
549 /** Optional table prefix used in database. */
550 $wgSharedUploadDBprefix = '';
552 /** Cache shared metadata in memcached. Don't do this if the commons wiki is in a different memcached domain */
553 $wgCacheSharedUploads = true;
556 * Allow for upload to be copied from an URL.
557 * The timeout for copy uploads is set by $wgHTTPTimeout.
558 * You have to assign the user right 'upload_by_url' to a user group, to use this.
560 $wgAllowCopyUploads = false;
563 * Allow asynchronous copy uploads.
564 * This feature is experimental and broken as of r81612.
566 $wgAllowAsyncCopyUploads = false;
569 * A list of domains copy uploads can come from
571 * @since 1.20
573 $wgCopyUploadsDomains = array();
576 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
577 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
578 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
580 $wgCopyUploadsFromSpecialUpload = false;
583 * Proxy to use for copy upload requests.
584 * @since 1.20
586 $wgCopyUploadProxy = false;
589 * Max size for uploads, in bytes. If not set to an array, applies to all
590 * uploads. If set to an array, per upload type maximums can be set, using the
591 * file and url keys. If the * key is set this value will be used as maximum
592 * for non-specified types.
594 * @par Example:
595 * @code
596 * $wgMaxUploadSize = array(
597 * '*' => 250 * 1024,
598 * 'url' => 500 * 1024,
599 * );
600 * @endcode
601 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
602 * will have a maximum of 500 kB.
604 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
607 * Point the upload navigation link to an external URL
608 * Useful if you want to use a shared repository by default
609 * without disabling local uploads (use $wgEnableUploads = false for that).
611 * @par Example:
612 * @code
613 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
614 * @endcode
616 $wgUploadNavigationUrl = false;
619 * Point the upload link for missing files to an external URL, as with
620 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
621 * appended to it as appropriate.
623 $wgUploadMissingFileUrl = false;
626 * Give a path here to use thumb.php for thumbnail generation on client
627 * request, instead of generating them on render and outputting a static URL.
628 * This is necessary if some of your apache servers don't have read/write
629 * access to the thumbnail path.
631 * @par Example:
632 * @code
633 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
634 * @endcode
636 $wgThumbnailScriptPath = false;
638 * @see $wgThumbnailScriptPath
640 $wgSharedThumbnailScriptPath = false;
643 * Set this to false if you do not want MediaWiki to divide your images
644 * directory into many subdirectories, for improved performance.
646 * It's almost always good to leave this enabled. In previous versions of
647 * MediaWiki, some users set this to false to allow images to be added to the
648 * wiki by simply copying them into $wgUploadDirectory and then running
649 * maintenance/rebuildImages.php to register them in the database. This is no
650 * longer recommended, use maintenance/importImages.php instead.
652 * @note That this variable may be ignored if $wgLocalFileRepo is set.
653 * @todo Deprecate the setting and ultimately remove it from Core.
655 $wgHashedUploadDirectory = true;
658 * Set the following to false especially if you have a set of files that need to
659 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
660 * directory layout.
662 $wgHashedSharedUploadDirectory = true;
665 * Base URL for a repository wiki. Leave this blank if uploads are just stored
666 * in a shared directory and not meant to be accessible through a separate wiki.
667 * Otherwise the image description pages on the local wiki will link to the
668 * image description page on this wiki.
670 * Please specify the namespace, as in the example below.
672 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
675 * This is the list of preferred extensions for uploading files. Uploading files
676 * with extensions not in this list will trigger a warning.
678 * @warning If you add any OpenOffice or Microsoft Office file formats here,
679 * such as odt or doc, and untrusted users are allowed to upload files, then
680 * your wiki will be vulnerable to cross-site request forgery (CSRF).
682 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
685 * Files with these extensions will never be allowed as uploads.
686 * An array of file extensions to blacklist. You should append to this array
687 * if you want to blacklist additional files.
689 $wgFileBlacklist = array(
690 # HTML may contain cookie-stealing JavaScript and web bugs
691 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
692 # PHP scripts may execute arbitrary code on the server
693 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
694 # Other types that may be interpreted by some servers
695 'shtml', 'jhtml', 'pl', 'py', 'cgi',
696 # May contain harmful executables for Windows victims
697 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
700 * Files with these mime types will never be allowed as uploads
701 * if $wgVerifyMimeType is enabled.
703 $wgMimeTypeBlacklist = array(
704 # HTML may contain cookie-stealing JavaScript and web bugs
705 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
706 # PHP scripts may execute arbitrary code on the server
707 'application/x-php', 'text/x-php',
708 # Other types that may be interpreted by some servers
709 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
710 # Client-side hazards on Internet Explorer
711 'text/scriptlet', 'application/x-msdownload',
712 # Windows metafile, client-side vulnerability on some systems
713 'application/x-msmetafile',
717 * Allow Java archive uploads.
718 * This is not recommended for public wikis since a maliciously-constructed
719 * applet running on the same domain as the wiki can steal the user's cookies.
721 $wgAllowJavaUploads = false;
724 * This is a flag to determine whether or not to check file extensions on upload.
726 * @warning Setting this to false is insecure for public wikis.
728 $wgCheckFileExtensions = true;
731 * If this is turned off, users may override the warning for files not covered
732 * by $wgFileExtensions.
734 * @warning Setting this to false is insecure for public wikis.
736 $wgStrictFileExtensions = true;
739 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
741 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
742 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
744 $wgDisableUploadScriptChecks = false;
747 * Warn if uploaded files are larger than this (in bytes), or false to disable
749 $wgUploadSizeWarning = false;
752 * list of trusted media-types and mime types.
753 * Use the MEDIATYPE_xxx constants to represent media types.
754 * This list is used by File::isSafeFile
756 * Types not listed here will have a warning about unsafe content
757 * displayed on the images description page. It would also be possible
758 * to use this for further restrictions, like disabling direct
759 * [[media:...]] links for non-trusted formats.
761 $wgTrustedMediaFormats = array(
762 MEDIATYPE_BITMAP, //all bitmap formats
763 MEDIATYPE_AUDIO, //all audio formats
764 MEDIATYPE_VIDEO, //all plain video formats
765 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
766 "application/pdf", //PDF files
767 #"application/x-shockwave-flash", //flash/shockwave movie
771 * Plugins for media file type handling.
772 * Each entry in the array maps a MIME type to a class name
774 $wgMediaHandlers = array(
775 'image/jpeg' => 'JpegHandler',
776 'image/png' => 'PNGHandler',
777 'image/gif' => 'GIFHandler',
778 'image/tiff' => 'TiffHandler',
779 'image/x-ms-bmp' => 'BmpHandler',
780 'image/x-bmp' => 'BmpHandler',
781 'image/x-xcf' => 'XCFHandler',
782 'image/svg+xml' => 'SvgHandler', // official
783 'image/svg' => 'SvgHandler', // compat
784 'image/vnd.djvu' => 'DjVuHandler', // official
785 'image/x.djvu' => 'DjVuHandler', // compat
786 'image/x-djvu' => 'DjVuHandler', // compat
790 * Plugins for page content model handling.
791 * Each entry in the array maps a model id to a class name.
793 * @since 1.21
795 $wgContentHandlers = array(
796 // the usual case
797 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
798 // dumb version, no syntax highlighting
799 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
800 // dumb version, no syntax highlighting
801 CONTENT_MODEL_CSS => 'CssContentHandler',
802 // plain text, for use by extensions etc
803 CONTENT_MODEL_TEXT => 'TextContentHandler',
807 * Resizing can be done using PHP's internal image libraries or using
808 * ImageMagick or another third-party converter, e.g. GraphicMagick.
809 * These support more file formats than PHP, which only supports PNG,
810 * GIF, JPG, XBM and WBMP.
812 * Use Image Magick instead of PHP builtin functions.
814 $wgUseImageMagick = false;
815 /** The convert command shipped with ImageMagick */
816 $wgImageMagickConvertCommand = '/usr/bin/convert';
817 /** The identify command shipped with ImageMagick */
818 $wgImageMagickIdentifyCommand = '/usr/bin/identify';
820 /** Sharpening parameter to ImageMagick */
821 $wgSharpenParameter = '0x0.4';
823 /** Reduction in linear dimensions below which sharpening will be enabled */
824 $wgSharpenReductionThreshold = 0.85;
827 * Temporary directory used for ImageMagick. The directory must exist. Leave
828 * this set to false to let ImageMagick decide for itself.
830 $wgImageMagickTempDir = false;
833 * Use another resizing converter, e.g. GraphicMagick
834 * %s will be replaced with the source path, %d with the destination
835 * %w and %h will be replaced with the width and height.
837 * @par Example for GraphicMagick:
838 * @code
839 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
840 * @endcode
842 * Leave as false to skip this.
844 $wgCustomConvertCommand = false;
846 /** used for lossless jpeg rotation
848 * @since 1.21
849 * **/
850 $wgJpegTran = '/usr/bin/jpegtran';
854 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
855 * image formats.
857 $wgExiv2Command = '/usr/bin/exiv2';
860 * Scalable Vector Graphics (SVG) may be uploaded as images.
861 * Since SVG support is not yet standard in browsers, it is
862 * necessary to rasterize SVGs to PNG as a fallback format.
864 * An external program is required to perform this conversion.
865 * If set to an array, the first item is a PHP callable and any further items
866 * are passed as parameters after $srcPath, $dstPath, $width, $height
868 $wgSVGConverters = array(
869 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
870 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
871 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
872 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d $output $input',
873 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
874 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
875 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
878 /** Pick a converter defined in $wgSVGConverters */
879 $wgSVGConverter = 'ImageMagick';
881 /** If not in the executable PATH, specify the SVG converter path. */
882 $wgSVGConverterPath = '';
884 /** Don't scale a SVG larger than this */
885 $wgSVGMaxSize = 2048;
887 /** Don't read SVG metadata beyond this point.
888 * Default is 1024*256 bytes
890 $wgSVGMetadataCutoff = 262144;
893 * Disallow <title> element in SVG files.
895 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
896 * browsers which can not perform basic stuff like MIME detection and which are
897 * vulnerable to further idiots uploading crap files as images.
899 * When this directive is on, "<title>" will be allowed in files with an
900 * "image/svg+xml" MIME type. You should leave this disabled if your web server
901 * is misconfigured and doesn't send appropriate MIME types for SVG images.
903 $wgAllowTitlesInSVG = false;
906 * The maximum number of pixels a source image can have if it is to be scaled
907 * down by a scaler that requires the full source image to be decompressed
908 * and stored in decompressed form, before the thumbnail is generated.
910 * This provides a limit on memory usage for the decompression side of the
911 * image scaler. The limit is used when scaling PNGs with any of the
912 * built-in image scalers, such as ImageMagick or GD. It is ignored for
913 * JPEGs with ImageMagick, and when using the VipsScaler extension.
915 * The default is 50 MB if decompressed to RGBA form, which corresponds to
916 * 12.5 million pixels or 3500x3500.
918 $wgMaxImageArea = 1.25e7;
920 * Force thumbnailing of animated GIFs above this size to a single
921 * frame instead of an animated thumbnail. As of MW 1.17 this limit
922 * is checked against the total size of all frames in the animation.
923 * It probably makes sense to keep this equal to $wgMaxImageArea.
925 $wgMaxAnimatedGifArea = 1.25e7;
927 * Browsers don't support TIFF inline generally...
928 * For inline display, we need to convert to PNG or JPEG.
929 * Note scaling should work with ImageMagick, but may not with GD scaling.
931 * @par Example:
932 * @code
933 * // PNG is lossless, but inefficient for photos
934 * $wgTiffThumbnailType = array( 'png', 'image/png' );
935 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
936 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
937 * @endcode
939 $wgTiffThumbnailType = false;
942 * If rendered thumbnail files are older than this timestamp, they
943 * will be rerendered on demand as if the file didn't already exist.
944 * Update if there is some need to force thumbs and SVG rasterizations
945 * to rerender, such as fixes to rendering bugs.
947 $wgThumbnailEpoch = '20030516000000';
950 * If set, inline scaled images will still produce "<img>" tags ready for
951 * output instead of showing an error message.
953 * This may be useful if errors are transitory, especially if the site
954 * is configured to automatically render thumbnails on request.
956 * On the other hand, it may obscure error conditions from debugging.
957 * Enable the debug log or the 'thumbnail' log group to make sure errors
958 * are logged to a file for review.
960 $wgIgnoreImageErrors = false;
963 * Allow thumbnail rendering on page view. If this is false, a valid
964 * thumbnail URL is still output, but no file will be created at
965 * the target location. This may save some time if you have a
966 * thumb.php or 404 handler set up which is faster than the regular
967 * webserver(s).
969 $wgGenerateThumbnailOnParse = true;
972 * Show thumbnails for old images on the image description page
974 $wgShowArchiveThumbnails = true;
976 /** Obsolete, always true, kept for compatibility with extensions */
977 $wgUseImageResize = true;
980 * If set to true, images that contain certain the exif orientation tag will
981 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
982 * is available that can rotate.
984 $wgEnableAutoRotation = null;
987 * Internal name of virus scanner. This serves as a key to the
988 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
989 * null, every file uploaded will be scanned for viruses.
991 $wgAntivirus = null;
994 * Configuration for different virus scanners. This an associative array of
995 * associative arrays. It contains one setup array per known scanner type.
996 * The entry is selected by $wgAntivirus, i.e.
997 * valid values for $wgAntivirus are the keys defined in this array.
999 * The configuration array for each scanner contains the following keys:
1000 * "command", "codemap", "messagepattern":
1002 * "command" is the full command to call the virus scanner - %f will be
1003 * replaced with the name of the file to scan. If not present, the filename
1004 * will be appended to the command. Note that this must be overwritten if the
1005 * scanner is not in the system path; in that case, please set
1006 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1007 * path.
1009 * "codemap" is a mapping of exit code to return codes of the detectVirus
1010 * function in SpecialUpload.
1011 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1012 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1013 * is not set.
1014 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1015 * the file to have an unsupported format, which is probably immune to
1016 * viruses. This causes the file to pass.
1017 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1018 * no virus was found.
1019 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1020 * a virus.
1021 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1023 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1024 * output. The relevant part should be matched as group one (\1).
1025 * If not defined or the pattern does not match, the full message is shown to the user.
1027 $wgAntivirusSetup = array(
1029 #setup for clamav
1030 'clamav' => array(
1031 'command' => 'clamscan --no-summary ',
1032 'codemap' => array(
1033 "0" => AV_NO_VIRUS, # no virus
1034 "1" => AV_VIRUS_FOUND, # virus found
1035 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1036 "*" => AV_SCAN_FAILED, # else scan failed
1038 'messagepattern' => '/.*?:(.*)/sim',
1042 /** Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. */
1043 $wgAntivirusRequired = true;
1045 /** Determines if the mime type of uploaded files should be checked */
1046 $wgVerifyMimeType = true;
1048 /** Sets the mime type definition file to use by MimeMagic.php. */
1049 $wgMimeTypeFile = 'includes/mime.types';
1050 #$wgMimeTypeFile = '/etc/mime.types';
1051 #$wgMimeTypeFile = null; #use built-in defaults only.
1053 /** Sets the mime type info file to use by MimeMagic.php. */
1054 $wgMimeInfoFile = 'includes/mime.info';
1055 #$wgMimeInfoFile = null; #use built-in defaults only.
1058 * Switch for loading the FileInfo extension by PECL at runtime.
1059 * This should be used only if fileinfo is installed as a shared object
1060 * or a dynamic library.
1062 $wgLoadFileinfoExtension = false;
1064 /** Sets an external mime detector program. The command must print only
1065 * the mime type to standard output.
1066 * The name of the file to process will be appended to the command given here.
1067 * If not set or NULL, mime_content_type will be used if available.
1069 * @par Example:
1070 * @code
1071 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
1072 * @endcode
1074 $wgMimeDetectorCommand = null;
1077 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
1078 * things, because only a few types of images are needed and file extensions
1079 * can be trusted.
1081 $wgTrivialMimeDetection = false;
1084 * Additional XML types we can allow via mime-detection.
1085 * array = ( 'rootElement' => 'associatedMimeType' )
1087 $wgXMLMimeTypes = array(
1088 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1089 'svg' => 'image/svg+xml',
1090 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1091 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1092 'html' => 'text/html', // application/xhtml+xml?
1096 * Limit images on image description pages to a user-selectable limit. In order
1097 * to reduce disk usage, limits can only be selected from a list.
1098 * The user preference is saved as an array offset in the database, by default
1099 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1100 * change it if you alter the array (see bug 8858).
1101 * This is the list of settings the user can choose from:
1103 $wgImageLimits = array(
1104 array( 320, 240 ),
1105 array( 640, 480 ),
1106 array( 800, 600 ),
1107 array( 1024, 768 ),
1108 array( 1280, 1024 )
1112 * Adjust thumbnails on image pages according to a user setting. In order to
1113 * reduce disk usage, the values can only be selected from a list. This is the
1114 * list of settings the user can choose from:
1116 $wgThumbLimits = array(
1117 120,
1118 150,
1119 180,
1120 200,
1121 250,
1126 * Default parameters for the "<gallery>" tag
1128 $wgGalleryOptions = array(
1129 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1130 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1131 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1132 'captionLength' => 25, // Length of caption to truncate (in characters)
1133 'showBytes' => true, // Show the filesize in bytes in categories
1137 * Adjust width of upright images when parameter 'upright' is used
1138 * This allows a nicer look for upright images without the need to fix the width
1139 * by hardcoded px in wiki sourcecode.
1141 $wgThumbUpright = 0.75;
1144 * Default value for chmoding of new directories.
1146 $wgDirectoryMode = 0777;
1149 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1151 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1152 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1153 * images in after loading the original low-resolution versions depending on the reported
1154 * window.devicePixelRatio.
1156 $wgResponsiveImages = true;
1159 * @name DJVU settings
1160 * @{
1163 * Path of the djvudump executable
1164 * Enable this and $wgDjvuRenderer to enable djvu rendering
1166 # $wgDjvuDump = 'djvudump';
1167 $wgDjvuDump = null;
1170 * Path of the ddjvu DJVU renderer
1171 * Enable this and $wgDjvuDump to enable djvu rendering
1173 # $wgDjvuRenderer = 'ddjvu';
1174 $wgDjvuRenderer = null;
1177 * Path of the djvutxt DJVU text extraction utility
1178 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1180 # $wgDjvuTxt = 'djvutxt';
1181 $wgDjvuTxt = null;
1184 * Path of the djvutoxml executable
1185 * This works like djvudump except much, much slower as of version 3.5.
1187 * For now we recommend you use djvudump instead. The djvuxml output is
1188 * probably more stable, so we'll switch back to it as soon as they fix
1189 * the efficiency problem.
1190 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1192 * @par Example:
1193 * @code
1194 * $wgDjvuToXML = 'djvutoxml';
1195 * @endcode
1197 $wgDjvuToXML = null;
1200 * Shell command for the DJVU post processor
1201 * Default: pnmtopng, since ddjvu generates ppm output
1202 * Set this to false to output the ppm file directly.
1204 $wgDjvuPostProcessor = 'pnmtojpeg';
1206 * File extension for the DJVU post processor output
1208 $wgDjvuOutputExtension = 'jpg';
1209 /** @} */ # end of DJvu }
1211 /** @} */ # end of file uploads }
1213 /************************************************************************//**
1214 * @name Email settings
1215 * @{
1218 $serverName = substr( $wgServer, strrpos( $wgServer, '/' ) + 1 );
1221 * Site admin email address.
1223 $wgEmergencyContact = 'wikiadmin@' . $serverName;
1226 * Password reminder email address.
1228 * The address we should use as sender when a user is requesting his password.
1230 $wgPasswordSender = 'apache@' . $serverName;
1232 unset( $serverName ); # Don't leak local variables to global scope
1235 * Password reminder name
1237 $wgPasswordSenderName = 'MediaWiki Mail';
1240 * Dummy address which should be accepted during mail send action.
1241 * It might be necessary to adapt the address or to set it equal
1242 * to the $wgEmergencyContact address.
1244 $wgNoReplyAddress = 'reply@not.possible';
1247 * Set to true to enable the e-mail basic features:
1248 * Password reminders, etc. If sending e-mail on your
1249 * server doesn't work, you might want to disable this.
1251 $wgEnableEmail = true;
1254 * Set to true to enable user-to-user e-mail.
1255 * This can potentially be abused, as it's hard to track.
1257 $wgEnableUserEmail = true;
1260 * Set to true to put the sending user's email in a Reply-To header
1261 * instead of From. ($wgEmergencyContact will be used as From.)
1263 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1264 * which can cause problems with SPF validation and leak recipient addresses
1265 * when bounces are sent to the sender.
1267 $wgUserEmailUseReplyTo = false;
1270 * Minimum time, in hours, which must elapse between password reminder
1271 * emails for a given account. This is to prevent abuse by mail flooding.
1273 $wgPasswordReminderResendTime = 24;
1276 * The time, in seconds, when an emailed temporary password expires.
1278 $wgNewPasswordExpiry = 3600 * 24 * 7;
1281 * The time, in seconds, when an email confirmation email expires
1283 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1286 * SMTP Mode.
1288 * For using a direct (authenticated) SMTP server connection.
1289 * Default to false or fill an array :
1291 * @code
1292 * $wgSMTP = array(
1293 * 'host' => 'SMTP domain',
1294 * 'IDHost' => 'domain for MessageID',
1295 * 'port' => '25',
1296 * 'auth' => [true|false],
1297 * 'username' => [SMTP username],
1298 * 'password' => [SMTP password],
1299 * );
1300 * @endcode
1302 $wgSMTP = false;
1305 * Additional email parameters, will be passed as the last argument to mail() call.
1306 * If using safe_mode this has no effect
1308 $wgAdditionalMailParams = null;
1311 * For parts of the system that have been updated to provide HTML email content, send
1312 * both text and HTML parts as the body of the email
1314 $wgAllowHTMLEmail = false;
1317 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1318 * from $wgEmergencyContact
1320 $wgEnotifFromEditor = false;
1322 // TODO move UPO to preferences probably ?
1323 # If set to true, users get a corresponding option in their preferences and can choose to enable or disable at their discretion
1324 # If set to false, the corresponding input form on the user preference page is suppressed
1325 # It call this to be a "user-preferences-option (UPO)"
1328 * Require email authentication before sending mail to an email address.
1329 * This is highly recommended. It prevents MediaWiki from being used as an open
1330 * spam relay.
1332 $wgEmailAuthentication = true;
1335 * Allow users to enable email notification ("enotif") on watchlist changes.
1337 $wgEnotifWatchlist = false;
1340 * Allow users to enable email notification ("enotif") when someone edits their
1341 * user talk page.
1343 $wgEnotifUserTalk = false;
1346 * Set the Reply-to address in notifications to the editor's address, if user
1347 * allowed this in the preferences.
1349 $wgEnotifRevealEditorAddress = false;
1352 * Send notification mails on minor edits to watchlist pages. This is enabled
1353 * by default. Does not affect user talk notifications.
1355 $wgEnotifMinorEdits = true;
1358 * Send a generic mail instead of a personalised mail for each user. This
1359 * always uses UTC as the time zone, and doesn't include the username.
1361 * For pages with many users watching, this can significantly reduce mail load.
1362 * Has no effect when using sendmail rather than SMTP.
1364 $wgEnotifImpersonal = false;
1367 * Maximum number of users to mail at once when using impersonal mail. Should
1368 * match the limit on your mail server.
1370 $wgEnotifMaxRecips = 500;
1373 * Send mails via the job queue. This can be useful to reduce the time it
1374 * takes to save a page that a lot of people are watching.
1376 $wgEnotifUseJobQ = false;
1379 * Use real name instead of username in e-mail "from" field.
1381 $wgEnotifUseRealName = false;
1384 * Array of usernames who will be sent a notification email for every change
1385 * which occurs on a wiki. Users will not be notified of their own changes.
1387 $wgUsersNotifiedOnAllChanges = array();
1390 /** @} */ # end of email settings
1392 /************************************************************************//**
1393 * @name Database settings
1394 * @{
1396 /** Database host name or IP address */
1397 $wgDBserver = 'localhost';
1398 /** Database port number (for PostgreSQL) */
1399 $wgDBport = 5432;
1400 /** Name of the database */
1401 $wgDBname = 'my_wiki';
1402 /** Database username */
1403 $wgDBuser = 'wikiuser';
1404 /** Database user's password */
1405 $wgDBpassword = '';
1406 /** Database type */
1407 $wgDBtype = 'mysql';
1408 /** Whether to use SSL in DB connection. */
1409 $wgDBssl = false;
1410 /** Whether to use compression in DB connection. */
1411 $wgDBcompress = false;
1413 /** Separate username for maintenance tasks. Leave as null to use the default. */
1414 $wgDBadminuser = null;
1415 /** Separate password for maintenance tasks. Leave as null to use the default. */
1416 $wgDBadminpassword = null;
1419 * Search type.
1420 * Leave as null to select the default search engine for the
1421 * selected database type (eg SearchMySQL), or set to a class
1422 * name to override to a custom search engine.
1424 $wgSearchType = null;
1426 /** Table name prefix */
1427 $wgDBprefix = '';
1428 /** MySQL table options to use during installation or update */
1429 $wgDBTableOptions = 'ENGINE=InnoDB';
1432 * SQL Mode - default is turning off all modes, including strict, if set.
1433 * null can be used to skip the setting for performance reasons and assume
1434 * DBA has done his best job.
1435 * String override can be used for some additional fun :-)
1437 $wgSQLMode = '';
1439 /** Mediawiki schema */
1440 $wgDBmwschema = 'mediawiki';
1442 /** To override default SQLite data directory ($docroot/../data) */
1443 $wgSQLiteDataDir = '';
1446 * Make all database connections secretly go to localhost. Fool the load balancer
1447 * thinking there is an arbitrarily large cluster of servers to connect to.
1448 * Useful for debugging.
1450 $wgAllDBsAreLocalhost = false;
1453 * Shared database for multiple wikis. Commonly used for storing a user table
1454 * for single sign-on. The server for this database must be the same as for the
1455 * main database.
1457 * For backwards compatibility the shared prefix is set to the same as the local
1458 * prefix, and the user table is listed in the default list of shared tables.
1459 * The user_properties table is also added so that users will continue to have their
1460 * preferences shared (preferences were stored in the user table prior to 1.16)
1462 * $wgSharedTables may be customized with a list of tables to share in the shared
1463 * database. However it is advised to limit what tables you do share as many of
1464 * MediaWiki's tables may have side effects if you try to share them.
1466 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1467 * $wgDBprefix.
1469 * @deprecated In new code, use the $wiki parameter to wfGetLB() to access
1470 * remote databases. Using wfGetLB() allows the shared database to reside on
1471 * separate servers to the wiki's own database, with suitable configuration
1472 * of $wgLBFactoryConf.
1474 $wgSharedDB = null;
1476 /** @see $wgSharedDB */
1477 $wgSharedPrefix = false;
1478 /** @see $wgSharedDB */
1479 $wgSharedTables = array( 'user', 'user_properties' );
1482 * Database load balancer
1483 * This is a two-dimensional array, an array of server info structures
1484 * Fields are:
1485 * - host: Host name
1486 * - dbname: Default database name
1487 * - user: DB user
1488 * - password: DB password
1489 * - type: "mysql" or "postgres"
1490 * - load: ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0
1491 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1492 * to several groups, the most specific group defined here is used.
1494 * - flags: bit field
1495 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1496 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1497 * - DBO_TRX -- wrap entire request in a transaction
1498 * - DBO_IGNORE -- ignore errors (not useful in LocalSettings.php)
1499 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1500 * - DBO_PERSISTENT -- enables persistent database connections
1501 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1502 * - DBO_COMPRESS -- uses internal compression in database connections, if available
1504 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1505 * - max threads: (optional) Maximum number of running threads
1507 * These and any other user-defined properties will be assigned to the mLBInfo member
1508 * variable of the Database object.
1510 * Leave at false to use the single-server variables above. If you set this
1511 * variable, the single-server variables will generally be ignored (except
1512 * perhaps in some command-line scripts).
1514 * The first server listed in this array (with key 0) will be the master. The
1515 * rest of the servers will be slaves. To prevent writes to your slaves due to
1516 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1517 * slaves in my.cnf. You can set read_only mode at runtime using:
1519 * @code
1520 * SET @@read_only=1;
1521 * @endcode
1523 * Since the effect of writing to a slave is so damaging and difficult to clean
1524 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1525 * our masters, and then set read_only=0 on masters at runtime.
1527 $wgDBservers = false;
1530 * Load balancer factory configuration
1531 * To set up a multi-master wiki farm, set the class here to something that
1532 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1533 * The class identified here is responsible for reading $wgDBservers,
1534 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1536 * The LBFactory_Multi class is provided for this purpose, please see
1537 * includes/db/LBFactory_Multi.php for configuration information.
1539 $wgLBFactoryConf = array( 'class' => 'LBFactory_Simple' );
1541 /** How long to wait for a slave to catch up to the master */
1542 $wgMasterWaitTimeout = 10;
1544 /** File to log database errors to */
1545 $wgDBerrorLog = false;
1548 * Timezone to use in the error log.
1549 * Defaults to the wiki timezone ($wgLocaltimezone).
1551 * A list of usable timezones can found at:
1552 * http://php.net/manual/en/timezones.php
1554 * @par Examples:
1555 * @code
1556 * $wgLocaltimezone = 'UTC';
1557 * $wgLocaltimezone = 'GMT';
1558 * $wgLocaltimezone = 'PST8PDT';
1559 * $wgLocaltimezone = 'Europe/Sweden';
1560 * $wgLocaltimezone = 'CET';
1561 * @endcode
1563 * @since 1.20
1565 $wgDBerrorLogTZ = false;
1567 /** When to give an error message */
1568 $wgDBClusterTimeout = 10;
1571 * Scale load balancer polling time so that under overload conditions, the
1572 * database server receives a SHOW STATUS query at an average interval of this
1573 * many microseconds
1575 $wgDBAvgStatusPoll = 2000;
1578 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1579 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1581 * @warning THIS IS EXPERIMENTAL!
1583 * May break if you're not using the table defs from mysql5/tables.sql.
1584 * May break if you're upgrading an existing wiki if set differently.
1585 * Broken symptoms likely to include incorrect behavior with page titles,
1586 * usernames, comments etc containing non-ASCII characters.
1587 * Might also cause failures on the object cache and other things.
1589 * Even correct usage may cause failures with Unicode supplementary
1590 * characters (those not in the Basic Multilingual Plane) unless MySQL
1591 * has enhanced their Unicode support.
1593 $wgDBmysql5 = false;
1596 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1598 * To use this feature set to true and use a datasource defined as
1599 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1600 * block).
1602 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1603 * Pool) that maintains established sessions and reuses them on new
1604 * connections.
1606 * Not completely tested, but it should fall back on normal connection
1607 * in case the pool is full or the datasource is not configured as
1608 * pooled.
1609 * And the other way around; using oci_pconnect on a non pooled
1610 * datasource should produce a normal connection.
1612 * When it comes to frequent shortlived DB connections like with MW
1613 * Oracle tends to s***. The problem is the driver connects to the
1614 * database reasonably fast, but establishing a session takes time and
1615 * resources. MW does not rely on session state (as it does not use
1616 * features such as package variables) so establishing a valid session
1617 * is in this case an unwanted overhead that just slows things down.
1619 * @warning EXPERIMENTAL!
1622 $wgDBOracleDRCP = false;
1625 * Other wikis on this site, can be administered from a single developer
1626 * account.
1627 * Array numeric key => database name
1629 $wgLocalDatabases = array();
1632 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1633 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1634 * show a more obvious warning.
1636 $wgSlaveLagWarning = 10;
1637 /** @see $wgSlaveLagWarning */
1638 $wgSlaveLagCritical = 30;
1640 /**@}*/ # End of DB settings }
1642 /************************************************************************//**
1643 * @name Text storage
1644 * @{
1648 * We can also compress text stored in the 'text' table. If this is set on, new
1649 * revisions will be compressed on page save if zlib support is available. Any
1650 * compressed revisions will be decompressed on load regardless of this setting
1651 * *but will not be readable at all* if zlib support is not available.
1653 $wgCompressRevisions = false;
1656 * External stores allow including content
1657 * from non database sources following URL links.
1659 * Short names of ExternalStore classes may be specified in an array here:
1660 * @code
1661 * $wgExternalStores = array("http","file","custom")...
1662 * @endcode
1664 * CAUTION: Access to database might lead to code execution
1666 $wgExternalStores = false;
1669 * An array of external MySQL servers.
1671 * @par Example:
1672 * Create a cluster named 'cluster1' containing three servers:
1673 * @code
1674 * $wgExternalServers = array(
1675 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1676 * );
1677 * @endcode
1679 * Used by LBFactory_Simple, may be ignored if $wgLBFactoryConf is set to
1680 * another class.
1682 $wgExternalServers = array();
1685 * The place to put new revisions, false to put them in the local text table.
1686 * Part of a URL, e.g. DB://cluster1
1688 * Can be an array instead of a single string, to enable data distribution. Keys
1689 * must be consecutive integers, starting at zero.
1691 * @par Example:
1692 * @code
1693 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1694 * @endcode
1696 * @var array
1698 $wgDefaultExternalStore = false;
1701 * Revision text may be cached in $wgMemc to reduce load on external storage
1702 * servers and object extraction overhead for frequently-loaded revisions.
1704 * Set to 0 to disable, or number of seconds before cache expiry.
1706 $wgRevisionCacheExpiry = 0;
1708 /** @} */ # end text storage }
1710 /************************************************************************//**
1711 * @name Performance hacks and limits
1712 * @{
1714 /** Disable database-intensive features */
1715 $wgMiserMode = false;
1716 /** Disable all query pages if miser mode is on, not just some */
1717 $wgDisableQueryPages = false;
1718 /** Number of rows to cache in 'querycache' table when miser mode is on */
1719 $wgQueryCacheLimit = 1000;
1720 /** Number of links to a page required before it is deemed "wanted" */
1721 $wgWantedPagesThreshold = 1;
1722 /** Enable slow parser functions */
1723 $wgAllowSlowParserFunctions = false;
1724 /** Allow schema updates */
1725 $wgAllowSchemaUpdates = true;
1728 * Do DELETE/INSERT for link updates instead of incremental
1730 $wgUseDumbLinkUpdate = false;
1733 * Anti-lock flags - bitfield
1734 * - ALF_NO_LINK_LOCK:
1735 * Don't use locking reads when updating the link table. This is
1736 * necessary for wikis with a high edit rate for performance
1737 * reasons, but may cause link table inconsistency
1739 $wgAntiLockFlags = 0;
1742 * Maximum article size in kilobytes
1744 $wgMaxArticleSize = 2048;
1747 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1748 * raise PHP's memory limit if it's below this amount.
1750 $wgMemoryLimit = "50M";
1752 /** @} */ # end performance hacks }
1754 /************************************************************************//**
1755 * @name Cache settings
1756 * @{
1760 * Directory for caching data in the local filesystem. Should not be accessible
1761 * from the web. Set this to false to not use any local caches.
1763 * Note: if multiple wikis share the same localisation cache directory, they
1764 * must all have the same set of extensions. You can set a directory just for
1765 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1767 $wgCacheDirectory = false;
1770 * Main cache type. This should be a cache with fast access, but it may have
1771 * limited space. By default, it is disabled, since the database is not fast
1772 * enough to make it worthwhile.
1774 * The options are:
1776 * - CACHE_ANYTHING: Use anything, as long as it works
1777 * - CACHE_NONE: Do not cache
1778 * - CACHE_DB: Store cache objects in the DB
1779 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
1780 * - CACHE_ACCEL: APC, XCache or WinCache
1781 * - CACHE_DBA: Use PHP's DBA extension to store in a DBM-style
1782 * database. This is slow, and is not recommended for
1783 * anything other than debugging.
1784 * - (other): A string may be used which identifies a cache
1785 * configuration in $wgObjectCaches.
1787 * @see $wgMessageCacheType, $wgParserCacheType
1789 $wgMainCacheType = CACHE_NONE;
1792 * The cache type for storing the contents of the MediaWiki namespace. This
1793 * cache is used for a small amount of data which is expensive to regenerate.
1795 * For available types see $wgMainCacheType.
1797 $wgMessageCacheType = CACHE_ANYTHING;
1800 * The cache type for storing article HTML. This is used to store data which
1801 * is expensive to regenerate, and benefits from having plenty of storage space.
1803 * For available types see $wgMainCacheType.
1805 $wgParserCacheType = CACHE_ANYTHING;
1808 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
1810 * For available types see $wgMainCacheType.
1812 $wgSessionCacheType = CACHE_ANYTHING;
1815 * The cache type for storing language conversion tables,
1816 * which are used when parsing certain text and interface messages.
1818 * For available types see $wgMainCacheType.
1820 * @since 1.20
1822 $wgLanguageConverterCacheType = CACHE_ANYTHING;
1825 * Advanced object cache configuration.
1827 * Use this to define the class names and constructor parameters which are used
1828 * for the various cache types. Custom cache types may be defined here and
1829 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
1830 * or $wgLanguageConverterCacheType.
1832 * The format is an associative array where the key is a cache identifier, and
1833 * the value is an associative array of parameters. The "class" parameter is the
1834 * class name which will be used. Alternatively, a "factory" parameter may be
1835 * given, giving a callable function which will generate a suitable cache object.
1837 * The other parameters are dependent on the class used.
1838 * - CACHE_DBA uses $wgTmpDirectory by default. The 'dir' parameter let you
1839 * overrides that.
1841 $wgObjectCaches = array(
1842 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
1843 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
1844 CACHE_DBA => array( 'class' => 'DBABagOStuff' ),
1846 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
1847 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
1848 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached' ),
1850 'apc' => array( 'class' => 'APCBagOStuff' ),
1851 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
1852 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
1853 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
1854 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
1855 'hash' => array( 'class' => 'HashBagOStuff' ),
1859 * The expiry time for the parser cache, in seconds.
1860 * The default is 86400 (one day).
1862 $wgParserCacheExpireTime = 86400;
1865 * Select which DBA handler <http://www.php.net/manual/en/dba.requirements.php>
1866 * to use as CACHE_DBA backend.
1868 $wgDBAhandler = 'db3';
1871 * Deprecated alias for $wgSessionsInObjectCache.
1873 * @deprecated since 1.20; Use $wgSessionsInObjectCache
1875 $wgSessionsInMemcached = false;
1878 * Store sessions in an object cache, configured by $wgSessionCacheType. This
1879 * can be useful to improve performance, or to avoid the locking behavior of
1880 * PHP's default session handler, which tends to prevent multiple requests for
1881 * the same user from acting concurrently.
1883 $wgSessionsInObjectCache = false;
1886 * The expiry time to use for session storage when $wgSessionsInObjectCache is
1887 * enabled, in seconds.
1889 $wgObjectCacheSessionExpiry = 3600;
1892 * This is used for setting php's session.save_handler. In practice, you will
1893 * almost never need to change this ever. Other options might be 'user' or
1894 * 'session_mysql.' Setting to null skips setting this entirely (which might be
1895 * useful if you're doing cross-application sessions, see bug 11381)
1897 $wgSessionHandler = null;
1899 /** If enabled, will send MemCached debugging information to $wgDebugLogFile */
1900 $wgMemCachedDebug = false;
1902 /** The list of MemCached servers and port numbers */
1903 $wgMemCachedServers = array( '127.0.0.1:11211' );
1906 * Use persistent connections to MemCached, which are shared across multiple
1907 * requests.
1909 $wgMemCachedPersistent = false;
1912 * Read/write timeout for MemCached server communication, in microseconds.
1914 $wgMemCachedTimeout = 500000;
1917 * Set this to true to make a local copy of the message cache, for use in
1918 * addition to memcached. The files will be put in $wgCacheDirectory.
1920 $wgUseLocalMessageCache = false;
1923 * Instead of caching everything, only cache those messages which have
1924 * been customised in the site content language. This means that
1925 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
1926 * This option is probably only useful for translatewiki.net.
1928 $wgAdaptiveMessageCache = false;
1931 * Localisation cache configuration. Associative array with keys:
1932 * class: The class to use. May be overridden by extensions.
1934 * store: The location to store cache data. May be 'files', 'db' or
1935 * 'detect'. If set to "files", data will be in CDB files. If set
1936 * to "db", data will be stored to the database. If set to
1937 * "detect", files will be used if $wgCacheDirectory is set,
1938 * otherwise the database will be used.
1940 * storeClass: The class name for the underlying storage. If set to a class
1941 * name, it overrides the "store" setting.
1943 * storeDirectory: If the store class puts its data in files, this is the
1944 * directory it will use. If this is false, $wgCacheDirectory
1945 * will be used.
1947 * manualRecache: Set this to true to disable cache updates on web requests.
1948 * Use maintenance/rebuildLocalisationCache.php instead.
1950 $wgLocalisationCacheConf = array(
1951 'class' => 'LocalisationCache',
1952 'store' => 'detect',
1953 'storeClass' => false,
1954 'storeDirectory' => false,
1955 'manualRecache' => false,
1958 /** Allow client-side caching of pages */
1959 $wgCachePages = true;
1962 * Set this to current time to invalidate all prior cached pages. Affects both
1963 * client-side and server-side caching.
1964 * You can get the current date on your server by using the command:
1965 * @verbatim
1966 * date +%Y%m%d%H%M%S
1967 * @endverbatim
1969 $wgCacheEpoch = '20030516000000';
1972 * Bump this number when changing the global style sheets and JavaScript.
1974 * It should be appended in the query string of static CSS and JS includes,
1975 * to ensure that client-side caches do not keep obsolete copies of global
1976 * styles.
1978 $wgStyleVersion = '303';
1981 * This will cache static pages for non-logged-in users to reduce
1982 * database traffic on public sites.
1983 * Must set $wgShowIPinHeader = false
1984 * ResourceLoader requests to default language and skins are cached
1985 * as well as single module requests.
1987 $wgUseFileCache = false;
1990 * Depth of the subdirectory hierarchy to be created under
1991 * $wgFileCacheDirectory. The subdirectories will be named based on
1992 * the MD5 hash of the title. A value of 0 means all cache files will
1993 * be put directly into the main file cache directory.
1995 $wgFileCacheDepth = 2;
1998 * Keep parsed pages in a cache (objectcache table or memcached)
1999 * to speed up output of the same page viewed by another user with the
2000 * same options.
2002 * This can provide a significant speedup for medium to large pages,
2003 * so you probably want to keep it on. Extensions that conflict with the
2004 * parser cache should disable the cache on a per-page basis instead.
2006 $wgEnableParserCache = true;
2009 * Append a configured value to the parser cache and the sitenotice key so
2010 * that they can be kept separate for some class of activity.
2012 $wgRenderHashAppend = '';
2015 * If on, the sidebar navigation links are cached for users with the
2016 * current language set. This can save a touch of load on a busy site
2017 * by shaving off extra message lookups.
2019 * However it is also fragile: changing the site configuration, or
2020 * having a variable $wgArticlePath, can produce broken links that
2021 * don't update as expected.
2023 $wgEnableSidebarCache = false;
2026 * Expiry time for the sidebar cache, in seconds
2028 $wgSidebarCacheExpiry = 86400;
2031 * When using the file cache, we can store the cached HTML gzipped to save disk
2032 * space. Pages will then also be served compressed to clients that support it.
2034 * Requires zlib support enabled in PHP.
2036 $wgUseGzip = false;
2039 * Whether MediaWiki should send an ETag header. Seems to cause
2040 * broken behavior with Squid 2.6, see bug 7098.
2042 $wgUseETag = false;
2044 /** Clock skew or the one-second resolution of time() can occasionally cause cache
2045 * problems when the user requests two pages within a short period of time. This
2046 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2047 * a grace period.
2049 $wgClockSkewFudge = 5;
2052 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2053 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2054 * was previously done in the default LocalSettings.php file.
2056 * On high-traffic wikis, this should be set to false, to avoid the need to
2057 * check the file modification time, and to avoid the performance impact of
2058 * unnecessary cache invalidations.
2060 $wgInvalidateCacheOnLocalSettingsChange = true;
2062 /** @} */ # end of cache settings
2064 /************************************************************************//**
2065 * @name HTTP proxy (Squid) settings
2067 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2068 * although they are referred to as Squid settings for historical reasons.
2070 * Achieving a high hit ratio with an HTTP proxy requires special
2071 * configuration. See http://www.mediawiki.org/wiki/Manual:Squid_caching for
2072 * more details.
2074 * @{
2078 * Enable/disable Squid.
2079 * See http://www.mediawiki.org/wiki/Manual:Squid_caching
2081 $wgUseSquid = false;
2083 /** If you run Squid3 with ESI support, enable this (default:false): */
2084 $wgUseESI = false;
2086 /** Send X-Vary-Options header for better caching (requires patched Squid) */
2087 $wgUseXVO = false;
2089 /** Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2090 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2091 * and need to split the cache between HTTP and HTTPS for API requests,
2092 * feed requests and HTTP redirect responses in order to prevent cache
2093 * pollution. This does not affect 'normal' requests to index.php other than
2094 * HTTP redirects.
2096 $wgVaryOnXFP = false;
2099 * Internal server name as known to Squid, if different.
2101 * @par Example:
2102 * @code
2103 * $wgInternalServer = 'http://yourinternal.tld:8000';
2104 * @endcode
2106 $wgInternalServer = false;
2109 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2110 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2111 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2112 * days
2114 $wgSquidMaxage = 18000;
2117 * Default maximum age for raw CSS/JS accesses
2119 $wgForcedRawSMaxage = 300;
2122 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2124 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2125 * headers sent/modified from these proxies when obtaining the remote IP address
2127 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2129 $wgSquidServers = array();
2132 * As above, except these servers aren't purged on page changes; use to set a
2133 * list of trusted proxies, etc.
2135 $wgSquidServersNoPurge = array();
2137 /** Maximum number of titles to purge in any one client operation */
2138 $wgMaxSquidPurgeTitles = 400;
2141 * Whether to use a Host header in purge requests sent to the proxy servers
2142 * configured in $wgSquidServers. Set this to false to support Squid
2143 * configured in forward-proxy mode.
2145 * If this is set to true, a Host header will be sent, and only the path
2146 * component of the URL will appear on the request line, as if the request
2147 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2148 * request. Squid supports this style of request only if reverse-proxy mode
2149 * (http_port ... accel) is enabled.
2151 * If this is set to false, no Host header will be sent, and the absolute URL
2152 * will be sent in the request line, as is the standard for an HTTP proxy
2153 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2154 * by Varnish, but is supported by Squid in either configuration (forward or
2155 * reverse).
2157 * @since 1.21
2159 $wgSquidPurgeUseHostHeader = true;
2162 * Routing configuration for HTCP multicast purging. Add elements here to
2163 * enable HTCP and determine which purges are sent where. If set to an empty
2164 * array, HTCP is disabled.
2166 * Each key in this array is a regular expression to match against the purged
2167 * URL, or an empty string to match all URLs. The purged URL is matched against
2168 * the regexes in the order specified, and the first rule whose regex matches
2169 * is used, all remaining rules will thus be ignored.
2171 * @par Example configuration to send purges for upload.wikimedia.org to one
2172 * multicast group and all other purges to another:
2173 * @code
2174 * $wgHTCPRouting = array(
2175 * '|^https?://upload\.wikimedia\.org|' => array(
2176 * 'host' => '239.128.0.113',
2177 * 'port' => 4827,
2178 * ),
2179 * '' => array(
2180 * 'host' => '239.128.0.112',
2181 * 'port' => 4827,
2182 * ),
2183 * );
2184 * @endcode
2186 * You can also pass an array of hosts to send purges too. This is useful when
2187 * you have several multicast groups or unicast address that should receive a
2188 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2190 * @par Example of sending purges to multiple hosts:
2191 * @code
2192 * $wgHTCPRouting = array(
2193 * '' => array(
2194 * // Purges to text caches using multicast
2195 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2196 * // Purges to a hardcoded list of caches
2197 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2198 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2199 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2200 * ),
2201 * );
2202 * @endcode
2204 * @since 1.22
2206 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2207 * For back compatibility purposes, whenever its array is empty
2208 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2210 * @see $wgHTCPMulticastTTL
2212 $wgHTCPRouting = array();
2215 * @deprecated since 1.22, please use $wgHTCPRouting instead.
2217 * Whenever this is set and $wgHTCPRouting evaluates to false, $wgHTCPRouting
2218 * will be set to this value.
2219 * This is merely for back compatibility.
2221 * @since 1.20
2223 $wgHTCPMulticastRouting = null;
2226 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
2228 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
2229 * present in the earliest Squid implementations of the protocol.
2231 * This setting is DEPRECATED in favor of $wgHTCPRouting , and kept for
2232 * backwards compatibility only. If $wgHTCPRouting is set, this setting is
2233 * ignored. If $wgHTCPRouting is not set and this setting is, it is used to
2234 * populate $wgHTCPRouting.
2236 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2237 * favor of $wgHTCPRouting.
2239 $wgHTCPMulticastAddress = false;
2242 * HTCP multicast port.
2243 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2244 * favor of $wgHTCPRouting.
2246 * @see $wgHTCPMulticastAddress
2248 $wgHTCPPort = 4827;
2251 * HTCP multicast TTL.
2252 * @see $wgHTCPRouting
2254 $wgHTCPMulticastTTL = 1;
2256 /** Should forwarded Private IPs be accepted? */
2257 $wgUsePrivateIPs = false;
2259 /** @} */ # end of HTTP proxy settings
2261 /************************************************************************//**
2262 * @name Language, regional and character encoding settings
2263 * @{
2267 * Site language code. See languages/Names.php for languages supported by
2268 * MediaWiki out of the box. Not all languages listed there have translations,
2269 * see languages/messages/ for the list of languages with some localisation.
2271 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2272 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2274 * This defines the default interface language for all users, but users can
2275 * change it in their preferences.
2277 * This also defines the language of pages in the wiki. The content is wrapped
2278 * in a html element with lang=XX attribute. This behavior can be overridden
2279 * via hooks, see Title::getPageLanguage.
2281 $wgLanguageCode = 'en';
2284 * Language cache size, or really how many languages can we handle
2285 * simultaneously without degrading to crawl speed.
2287 $wgLangObjCacheSize = 10;
2290 * Some languages need different word forms, usually for different cases.
2291 * Used in Language::convertGrammar().
2293 * @par Example:
2294 * @code
2295 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2296 * @endcode
2298 $wgGrammarForms = array();
2300 /** Treat language links as magic connectors, not inline links */
2301 $wgInterwikiMagic = true;
2303 /** Hide interlanguage links from the sidebar */
2304 $wgHideInterlanguageLinks = false;
2306 /** List of language names or overrides for default names in Names.php */
2307 $wgExtraLanguageNames = array();
2310 * List of language codes that don't correspond to an actual language.
2311 * These codes are mostly left-offs from renames, or other legacy things.
2312 * This array makes them not appear as a selectable language on the installer,
2313 * and excludes them when running the transstat.php script.
2315 $wgDummyLanguageCodes = array(
2316 'als' => 'gsw',
2317 'bat-smg' => 'sgs',
2318 'be-x-old' => 'be-tarask',
2319 'bh' => 'bho',
2320 'fiu-vro' => 'vro',
2321 'no' => 'nb',
2322 'qqq' => 'qqq', # Used for message documentation.
2323 'qqx' => 'qqx', # Used for viewing message keys.
2324 'roa-rup' => 'rup',
2325 'simple' => 'en',
2326 'zh-classical' => 'lzh',
2327 'zh-min-nan' => 'nan',
2328 'zh-yue' => 'yue',
2332 * Character set for use in the article edit box. Language-specific encodings
2333 * may be defined.
2335 * This historic feature is one of the first that was added by former MediaWiki
2336 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2338 $wgEditEncoding = '';
2341 * Set this to true to replace Arabic presentation forms with their standard
2342 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2343 * set to "ar".
2345 * Note that pages with titles containing presentation forms will become
2346 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2348 $wgFixArabicUnicode = true;
2351 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2352 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2353 * set to "ml". Note that some clients (even new clients as of 2010) do not
2354 * support these characters.
2356 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2357 * fix any ZWJ sequences in existing page titles.
2359 $wgFixMalayalamUnicode = true;
2362 * Set this to always convert certain Unicode sequences to modern ones
2363 * regardless of the content language. This has a small performance
2364 * impact.
2366 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2367 * details.
2369 * @since 1.17
2371 $wgAllUnicodeFixes = false;
2374 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2375 * loading old revisions not marked with "utf-8" flag. Use this when
2376 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2377 * burdensome mass conversion of old text data.
2379 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2380 * user names, etc still must be converted en masse in the database before
2381 * continuing as a UTF-8 wiki.
2383 $wgLegacyEncoding = false;
2386 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2387 * regexps : "/regexp/" matching problematic browsers. These browsers will
2388 * be served encoded unicode in the edit box instead of real unicode.
2390 $wgBrowserBlackList = array(
2392 * Netscape 2-4 detection
2393 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2394 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2395 * with a negative assertion. The [UIN] identifier specifies the level of security
2396 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2397 * The language string is unreliable, it is missing on NS4 Mac.
2399 * Reference: http://www.psychedelix.com/agents/index.shtml
2401 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2402 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2403 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2406 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>, Þ to <THORN> and Ð to <ETH>
2408 * Known useragents:
2409 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2410 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2411 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2412 * - [...]
2414 * @link http://en.wikipedia.org/w/index.php?title=User%3A%C6var_Arnfj%F6r%F0_Bjarmason%2Ftestme&diff=12356041&oldid=12355864
2415 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2417 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2420 * Google wireless transcoder, seems to eat a lot of chars alive
2421 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2423 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2427 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2428 * create stub reference rows in the text table instead of copying
2429 * the full text of all current entries from 'cur' to 'text'.
2431 * This will speed up the conversion step for large sites, but
2432 * requires that the cur table be kept around for those revisions
2433 * to remain viewable.
2435 * This option affects the updaters *only*. Any present cur stub
2436 * revisions will be readable at runtime regardless of this setting.
2438 $wgLegacySchemaConversion = false;
2441 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2442 * the interface is set to English.
2444 $wgAmericanDates = false;
2446 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2447 * numerals in interface.
2449 $wgTranslateNumerals = true;
2452 * Translation using MediaWiki: namespace.
2453 * Interface messages will be loaded from the database.
2455 $wgUseDatabaseMessages = true;
2458 * Expiry time for the message cache key
2460 $wgMsgCacheExpiry = 86400;
2463 * Maximum entry size in the message cache, in bytes
2465 $wgMaxMsgCacheEntrySize = 10000;
2467 /** Whether to enable language variant conversion. */
2468 $wgDisableLangConversion = false;
2470 /** Whether to enable language variant conversion for links. */
2471 $wgDisableTitleConversion = false;
2473 /** Whether to enable canonical language links in meta data. */
2474 $wgCanonicalLanguageLinks = true;
2476 /** Default variant code, if false, the default will be the language code */
2477 $wgDefaultLanguageVariant = false;
2480 * Disabled variants array of language variant conversion.
2482 * @par Example:
2483 * @code
2484 * $wgDisabledVariants[] = 'zh-mo';
2485 * $wgDisabledVariants[] = 'zh-my';
2486 * @endcode
2488 $wgDisabledVariants = array();
2491 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2492 * path format that describes which parts of the URL contain the
2493 * language variant.
2495 * @par Example:
2496 * @code
2497 * $wgLanguageCode = 'sr';
2498 * $wgVariantArticlePath = '/$2/$1';
2499 * $wgArticlePath = '/wiki/$1';
2500 * @endcode
2502 * A link to /wiki/ would be redirected to /sr/Главна_страна
2504 * It is important that $wgArticlePath not overlap with possible values
2505 * of $wgVariantArticlePath.
2507 $wgVariantArticlePath = false;
2510 * Show a bar of language selection links in the user login and user
2511 * registration forms; edit the "loginlanguagelinks" message to
2512 * customise these.
2514 $wgLoginLanguageSelector = false;
2517 * When translating messages with wfMessage(), it is not always clear what
2518 * should be considered UI messages and what should be content messages.
2520 * For example, for the English Wikipedia, there should be only one 'mainpage',
2521 * so when getting the link for 'mainpage', we should treat it as site content
2522 * and call ->inContentLanguage()->text(), but for rendering the text of the
2523 * link, we call ->text(). The code behaves this way by default. However,
2524 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2525 * and the like for different languages. This array provides a way to override
2526 * the default behavior.
2528 * @par Example:
2529 * To allow language-specific main page and community
2530 * portal:
2531 * @code
2532 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2533 * @endcode
2535 $wgForceUIMsgAsContentMsg = array();
2538 * Fake out the timezone that the server thinks it's in. This will be used for
2539 * date display and not for what's stored in the DB. Leave to null to retain
2540 * your server's OS-based timezone value.
2542 * This variable is currently used only for signature formatting and for local
2543 * time/date parser variables ({{LOCALTIME}} etc.)
2545 * Timezones can be translated by editing MediaWiki messages of type
2546 * timezone-nameinlowercase like timezone-utc.
2548 * A list of usable timezones can found at:
2549 * http://php.net/manual/en/timezones.php
2551 * @par Examples:
2552 * @code
2553 * $wgLocaltimezone = 'UTC';
2554 * $wgLocaltimezone = 'GMT';
2555 * $wgLocaltimezone = 'PST8PDT';
2556 * $wgLocaltimezone = 'Europe/Sweden';
2557 * $wgLocaltimezone = 'CET';
2558 * @endcode
2560 $wgLocaltimezone = null;
2563 * Set an offset from UTC in minutes to use for the default timezone setting
2564 * for anonymous users and new user accounts.
2566 * This setting is used for most date/time displays in the software, and is
2567 * overridable in user preferences. It is *not* used for signature timestamps.
2569 * By default, this will be set to match $wgLocaltimezone.
2571 $wgLocalTZoffset = null;
2573 /** @} */ # End of language/charset settings
2575 /*************************************************************************//**
2576 * @name Output format and skin settings
2577 * @{
2580 /** The default Content-Type header. */
2581 $wgMimeType = 'text/html';
2584 * Previously used as content type in HTML script tags. This is now ignored since
2585 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2586 * It was also previously used by RawAction to determine the ctype query parameter
2587 * value that will result in a javascript response.
2588 * @deprecated since 1.22
2590 $wgJsMimeType = null;
2593 * The default xmlns attribute. The option to define this has been removed.
2594 * The value of this variable is no longer used by core and is set to a fixed
2595 * value in Setup.php for compatibility with extensions that depend on the value
2596 * of this variable being set. Such a dependency however is deprecated.
2597 * @deprecated since 1.22
2599 $wgXhtmlDefaultNamespace = null;
2602 * Previously used to determine if we should output an HTML5 doctype.
2603 * This is no longer used as we always output HTML5 now. For compatibility with
2604 * extensions that still check the value of this config it's value is now forced
2605 * to true by Setup.php.
2606 * @deprecated since 1.22
2608 $wgHtml5 = true;
2611 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2612 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2613 * (like if it's left at the default null value), it will be auto-initialized
2614 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2615 * ever actually set this to anything.
2617 $wgHtml5Version = null;
2620 * Enabled RDFa attributes for use in wikitext.
2621 * NOTE: Interaction with HTML5 is somewhat underspecified.
2623 $wgAllowRdfaAttributes = false;
2626 * Enabled HTML5 microdata attributes for use in wikitext.
2628 $wgAllowMicrodataAttributes = false;
2631 * Should we try to make our HTML output well-formed XML? If set to false,
2632 * output will be a few bytes shorter, and the HTML will arguably be more
2633 * readable. If set to true, life will be much easier for the authors of
2634 * screen-scraping bots, and the HTML will arguably be more readable.
2636 * Setting this to false may omit quotation marks on some attributes, omit
2637 * slashes from some self-closing tags, omit some ending tags, etc., where
2638 * permitted by HTML5. Setting it to true will not guarantee that all pages
2639 * will be well-formed, although non-well-formed pages should be rare and it's
2640 * a bug if you find one. Conversely, setting it to false doesn't mean that
2641 * all XML-y constructs will be omitted, just that they might be.
2643 * Because of compatibility with screen-scraping bots, and because it's
2644 * controversial, this is currently left to true by default.
2646 $wgWellFormedXml = true;
2649 * Permit other namespaces in addition to the w3.org default.
2651 * Use the prefix for the key and the namespace for the value.
2653 * @par Example:
2654 * @code
2655 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2656 * @endcode
2657 * Normally we wouldn't have to define this in the root "<html>"
2658 * element, but IE needs it there in some circumstances.
2660 * This is ignored if $wgMimeType is set to a non-XML mimetype.
2662 $wgXhtmlNamespaces = array();
2665 * Show IP address, for non-logged in users. It's necessary to switch this off
2666 * for some forms of caching.
2667 * @warning Will disable file cache.
2669 $wgShowIPinHeader = true;
2672 * Site notice shown at the top of each page
2674 * MediaWiki:Sitenotice page, which will override this. You can also
2675 * provide a separate message for logged-out users using the
2676 * MediaWiki:Anonnotice page.
2678 $wgSiteNotice = '';
2681 * A subtitle to add to the tagline, for skins that have it/
2683 $wgExtraSubtitle = '';
2686 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2688 $wgSiteSupportPage = '';
2691 * Validate the overall output using tidy and refuse
2692 * to display the page if it's not valid.
2694 $wgValidateAllHtml = false;
2697 * Default skin, for new users and anonymous visitors. Registered users may
2698 * change this to any one of the other available skins in their preferences.
2699 * This has to be completely lowercase; see the "skins" directory for the list
2700 * of available skins.
2702 $wgDefaultSkin = 'vector';
2705 * Specify the name of a skin that should not be presented in the list of
2706 * available skins. Use for blacklisting a skin which you do not want to
2707 * remove from the .../skins/ directory
2709 $wgSkipSkin = '';
2710 /** Array for more like $wgSkipSkin. */
2711 $wgSkipSkins = array();
2714 * Allow user Javascript page?
2715 * This enables a lot of neat customizations, but may
2716 * increase security risk to users and server load.
2718 $wgAllowUserJs = false;
2721 * Allow user Cascading Style Sheets (CSS)?
2722 * This enables a lot of neat customizations, but may
2723 * increase security risk to users and server load.
2725 $wgAllowUserCss = false;
2728 * Allow user-preferences implemented in CSS?
2729 * This allows users to customise the site appearance to a greater
2730 * degree; disabling it will improve page load times.
2732 $wgAllowUserCssPrefs = true;
2734 /** Use the site's Javascript page? */
2735 $wgUseSiteJs = true;
2737 /** Use the site's Cascading Style Sheets (CSS)? */
2738 $wgUseSiteCss = true;
2741 * Break out of framesets. This can be used to prevent clickjacking attacks,
2742 * or to prevent external sites from framing your site with ads.
2744 $wgBreakFrames = false;
2747 * The X-Frame-Options header to send on pages sensitive to clickjacking
2748 * attacks, such as edit pages. This prevents those pages from being displayed
2749 * in a frame or iframe. The options are:
2751 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2753 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
2754 * to allow framing within a trusted domain. This is insecure if there
2755 * is a page on the same domain which allows framing of arbitrary URLs.
2757 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
2758 * full compromise of local user accounts. Private wikis behind a
2759 * corporate firewall are especially vulnerable. This is not
2760 * recommended.
2762 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
2763 * not just edit pages.
2765 $wgEditPageFrameOptions = 'DENY';
2768 * Disallow framing of API pages directly, by setting the X-Frame-Options
2769 * header. Since the API returns CSRF tokens, allowing the results to be
2770 * framed can compromise your user's account security.
2771 * Options are:
2772 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2773 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
2774 * - false: Allow all framing.
2776 $wgApiFrameOptions = 'DENY';
2779 * Disable output compression (enabled by default if zlib is available)
2781 $wgDisableOutputCompression = false;
2784 * Should we allow a broader set of characters in id attributes, per HTML5? If
2785 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
2786 * functionality is ready, it will be on by default with no option.
2788 * Currently this appears to work fine in all browsers, but it's disabled by
2789 * default because it normalizes id's a bit too aggressively, breaking preexisting
2790 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
2792 $wgExperimentalHtmlIds = false;
2795 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
2796 * You can add new icons to the built in copyright or poweredby, or you can create
2797 * a new block. Though note that you may need to add some custom css to get good styling
2798 * of new blocks in monobook. vector and modern should work without any special css.
2800 * $wgFooterIcons itself is a key/value array.
2801 * The key is the name of a block that the icons will be wrapped in. The final id varies
2802 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
2803 * turns it into mw_poweredby.
2804 * The value is either key/value array of icons or a string.
2805 * In the key/value array the key may or may not be used by the skin but it can
2806 * be used to find the icon and unset it or change the icon if needed.
2807 * This is useful for disabling icons that are set by extensions.
2808 * The value should be either a string or an array. If it is a string it will be output
2809 * directly as html, however some skins may choose to ignore it. An array is the preferred format
2810 * for the icon, the following keys are used:
2811 * - src: An absolute url to the image to use for the icon, this is recommended
2812 * but not required, however some skins will ignore icons without an image
2813 * - url: The url to use in the a element around the text or icon, if not set an a element will not be outputted
2814 * - alt: This is the text form of the icon, it will be displayed without an image in
2815 * skins like Modern or if src is not set, and will otherwise be used as
2816 * the alt="" for the image. This key is required.
2817 * - width and height: If the icon specified by src is not of the standard size
2818 * you can specify the size of image to use with these keys.
2819 * Otherwise they will default to the standard 88x31.
2820 * @todo Reformat documentation.
2822 $wgFooterIcons = array(
2823 "copyright" => array(
2824 "copyright" => array(), // placeholder for the built in copyright icon
2826 "poweredby" => array(
2827 "mediawiki" => array(
2828 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
2829 "url" => "//www.mediawiki.org/",
2830 "alt" => "Powered by MediaWiki",
2836 * Login / create account link behavior when it's possible for anonymous users
2837 * to create an account.
2838 * - true = use a combined login / create account link
2839 * - false = split login and create account into two separate links
2841 $wgUseCombinedLoginLink = false;
2844 * Search form look for Vector skin only.
2845 * - true = use an icon search button
2846 * - false = use Go & Search buttons
2848 $wgVectorUseSimpleSearch = true;
2851 * Watch and unwatch as an icon rather than a link for Vector skin only.
2852 * - true = use an icon watch/unwatch button
2853 * - false = use watch/unwatch text link
2855 $wgVectorUseIconWatch = true;
2858 * Display user edit counts in various prominent places.
2860 $wgEdititis = false;
2863 * Better directionality support (bug 6100 and related).
2864 * Removed in 1.18, still kept here for LiquidThreads backwards compatibility.
2866 * @deprecated since 1.18
2868 $wgBetterDirectionality = true;
2871 * Some web hosts attempt to rewrite all responses with a 404 (not found)
2872 * status code, mangling or hiding MediaWiki's output. If you are using such a
2873 * host, you should start looking for a better one. While you're doing that,
2874 * set this to false to convert some of MediaWiki's 404 responses to 200 so
2875 * that the generated error pages can be seen.
2877 * In cases where for technical reasons it is more important for MediaWiki to
2878 * send the correct status code than for the body to be transmitted intact,
2879 * this configuration variable is ignored.
2881 $wgSend404Code = true;
2884 * The $wgShowRollbackEditCount variable is used to show how many edits will be
2885 * rollback. The numeric value of the variable are the limit up to are counted.
2886 * If the value is false or 0, the edits are not counted. Disabling this will
2887 * furthermore prevent MediaWiki from hiding some useless rollback links.
2889 * @since 1.20
2891 $wgShowRollbackEditCount = 10;
2894 * Output a <link rel="canonical"> tag on every page indicating the canonical
2895 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
2896 * detection of the current server is unreliable, the link is sent
2897 * unconditionally.
2899 $wgEnableCanonicalServerLink = false;
2901 /** @} */ # End of output format settings }
2903 /*************************************************************************//**
2904 * @name Resource loader settings
2905 * @{
2909 * Client-side resource modules.
2911 * Extensions should add their resource loader module definitions
2912 * to the $wgResourceModules variable.
2914 * @par Example:
2915 * @code
2916 * $wgResourceModules['ext.myExtension'] = array(
2917 * 'scripts' => 'myExtension.js',
2918 * 'styles' => 'myExtension.css',
2919 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
2920 * 'localBasePath' => __DIR__,
2921 * 'remoteExtPath' => 'MyExtension',
2922 * );
2923 * @endcode
2925 $wgResourceModules = array();
2928 * Extensions should register foreign module sources here. 'local' is a
2929 * built-in source that is not in this array, but defined by
2930 * ResourceLoader::__construct() so that it cannot be unset.
2932 * @par Example:
2933 * @code
2934 * $wgResourceLoaderSources['foo'] = array(
2935 * 'loadScript' => 'http://example.org/w/load.php',
2936 * 'apiScript' => 'http://example.org/w/api.php'
2937 * );
2938 * @endcode
2940 $wgResourceLoaderSources = array();
2943 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
2944 * If not set, then $wgScriptPath will be used as a fallback.
2946 $wgResourceBasePath = null;
2949 * Maximum time in seconds to cache resources served by the resource loader.
2951 * @todo Document array structure
2953 $wgResourceLoaderMaxage = array(
2954 'versioned' => array(
2955 // Squid/Varnish but also any other public proxy cache between the client and MediaWiki
2956 'server' => 30 * 24 * 60 * 60, // 30 days
2957 // On the client side (e.g. in the browser cache).
2958 'client' => 30 * 24 * 60 * 60, // 30 days
2960 'unversioned' => array(
2961 'server' => 5 * 60, // 5 minutes
2962 'client' => 5 * 60, // 5 minutes
2967 * The default debug mode (on/off) for of ResourceLoader requests.
2969 * This will still be overridden when the debug URL parameter is used.
2971 $wgResourceLoaderDebug = false;
2974 * Enable embedding of certain resources using Edge Side Includes. This will
2975 * improve performance but only works if there is something in front of the
2976 * web server (e..g a Squid or Varnish server) configured to process the ESI.
2978 $wgResourceLoaderUseESI = false;
2981 * Put each statement on its own line when minifying JavaScript. This makes
2982 * debugging in non-debug mode a bit easier.
2984 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
2987 * Maximum line length when minifying JavaScript. This is not a hard maximum:
2988 * the minifier will try not to produce lines longer than this, but may be
2989 * forced to do so in certain cases.
2991 $wgResourceLoaderMinifierMaxLineLength = 1000;
2994 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
2995 * dependencies.
2997 $wgIncludeLegacyJavaScript = true;
3000 * Whether to preload the mediawiki.util module as blocking module in the top
3001 * queue.
3003 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3004 * allowed modules to lack dependencies on 'popular' modules that were likely
3005 * loaded already.
3007 * This setting is to aid scripts during migration by providing mediawiki.util
3008 * unconditionally (which was the most commonly missed dependency).
3009 * It doesn't cover all missing dependencies obviously but should fix most of
3010 * them.
3012 * This should be removed at some point after site/user scripts have been fixed.
3013 * Enable this if your wiki has a large amount of user/site scripts that are
3014 * lacking dependencies.
3015 * @todo Deprecate
3017 $wgPreloadJavaScriptMwUtil = false;
3020 * Whether or not to assign configuration variables to the global window object.
3022 * If this is set to false, old code using deprecated variables will no longer
3023 * work.
3025 * @par Example of legacy code:
3026 * @code{,js}
3027 * if ( window.wgRestrictionEdit ) { ... }
3028 * @endcode
3029 * or:
3030 * @code{,js}
3031 * if ( wgIsArticle ) { ... }
3032 * @endcode
3034 * Instead, one needs to use mw.config.
3035 * @par Example using mw.config global configuration:
3036 * @code{,js}
3037 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3038 * @endcode
3039 * or:
3040 * @code{,js}
3041 * if ( mw.config.get('wgIsArticle') ) { ... }
3042 * @endcode
3044 $wgLegacyJavaScriptGlobals = true;
3047 * If set to a positive number, ResourceLoader will not generate URLs whose
3048 * query string is more than this many characters long, and will instead use
3049 * multiple requests with shorter query strings. This degrades performance,
3050 * but may be needed if your web server has a low (less than, say 1024)
3051 * query string length limit or a low value for suhosin.get.max_value_length
3052 * that you can't increase.
3054 * If set to a negative number, ResourceLoader will assume there is no query
3055 * string length limit.
3057 * Defaults to a value based on php configuration.
3059 $wgResourceLoaderMaxQueryLength = false;
3062 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3063 * prior to minification to validate it.
3065 * Parse errors will result in a JS exception being thrown during module load,
3066 * which avoids breaking other modules loaded in the same request.
3068 $wgResourceLoaderValidateJS = true;
3071 * If set to true, statically-sourced (file-backed) JavaScript resources will
3072 * be parsed for validity before being bundled up into ResourceLoader modules.
3074 * This can be helpful for development by providing better error messages in
3075 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3076 * and may fail on large pre-bundled frameworks.
3078 $wgResourceLoaderValidateStaticJS = false;
3081 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3082 * will be enabled. This is an experimental feature that's supposed to make
3083 * JavaScript load faster.
3085 $wgResourceLoaderExperimentalAsyncLoading = false;
3087 /** @} */ # End of resource loader settings }
3089 /*************************************************************************//**
3090 * @name Page title and interwiki link settings
3091 * @{
3095 * Name of the project namespace. If left set to false, $wgSitename will be
3096 * used instead.
3098 $wgMetaNamespace = false;
3101 * Name of the project talk namespace.
3103 * Normally you can ignore this and it will be something like
3104 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3105 * manually for grammatical reasons.
3107 $wgMetaNamespaceTalk = false;
3110 * Additional namespaces. If the namespaces defined in Language.php and
3111 * Namespace.php are insufficient, you can create new ones here, for example,
3112 * to import Help files in other languages. You can also override the namespace
3113 * names of existing namespaces. Extensions developers should use
3114 * $wgCanonicalNamespaceNames.
3116 * @warning Once you delete a namespace, the pages in that namespace will
3117 * no longer be accessible. If you rename it, then you can access them through
3118 * the new namespace name.
3120 * Custom namespaces should start at 100 to avoid conflicting with standard
3121 * namespaces, and should always follow the even/odd main/talk pattern.
3123 * @par Example:
3124 * @code
3125 * $wgExtraNamespaces = array(
3126 * 100 => "Hilfe",
3127 * 101 => "Hilfe_Diskussion",
3128 * 102 => "Aide",
3129 * 103 => "Discussion_Aide"
3130 * );
3131 * @endcode
3133 * @todo Add a note about maintenance/namespaceDupes.php
3135 $wgExtraNamespaces = array();
3138 * Same as above, but for namespaces with gender distinction.
3139 * Note: the default form for the namespace should also be set
3140 * using $wgExtraNamespaces for the same index.
3141 * @since 1.18
3143 $wgExtraGenderNamespaces = array();
3146 * Namespace aliases.
3148 * These are alternate names for the primary localised namespace names, which
3149 * are defined by $wgExtraNamespaces and the language file. If a page is
3150 * requested with such a prefix, the request will be redirected to the primary
3151 * name.
3153 * Set this to a map from namespace names to IDs.
3155 * @par Example:
3156 * @code
3157 * $wgNamespaceAliases = array(
3158 * 'Wikipedian' => NS_USER,
3159 * 'Help' => 100,
3160 * );
3161 * @endcode
3163 $wgNamespaceAliases = array();
3166 * Allowed title characters -- regex character class
3167 * Don't change this unless you know what you're doing
3169 * Problematic punctuation:
3170 * - []{}|# Are needed for link syntax, never enable these
3171 * - <> Causes problems with HTML escaping, don't use
3172 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3173 * - + Enabled by default, but doesn't work with path to query rewrite rules, corrupted by apache
3174 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3176 * All three of these punctuation problems can be avoided by using an alias,
3177 * instead of a rewrite rule of either variety.
3179 * The problem with % is that when using a path to query rewrite rule, URLs are
3180 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3181 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3182 * for this, indeed double escaping would break if the double-escaped title was
3183 * passed in the query string rather than the path. This is a minor security issue
3184 * because articles can be created such that they are hard to view or edit.
3186 * In some rare cases you may wish to remove + for compatibility with old links.
3188 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3189 * this breaks interlanguage links
3191 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3194 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3196 $wgLocalInterwiki = false;
3199 * Expiry time for cache of interwiki table
3201 $wgInterwikiExpiry = 10800;
3204 * @name Interwiki caching settings.
3205 * @{
3208 *$wgInterwikiCache specifies path to constant database file.
3210 * This cdb database is generated by dumpInterwiki from maintenance and has
3211 * such key formats:
3212 * - dbname:key - a simple key (e.g. enwiki:meta)
3213 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3214 * - __global:key - global-scope key (e.g. __global:meta)
3215 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3217 * Sites mapping just specifies site name, other keys provide "local url"
3218 * data layout.
3220 $wgInterwikiCache = false;
3222 * Specify number of domains to check for messages.
3223 * - 1: Just wiki(db)-level
3224 * - 2: wiki and global levels
3225 * - 3: site levels
3227 $wgInterwikiScopes = 3;
3229 * $wgInterwikiFallbackSite - if unable to resolve from cache
3231 $wgInterwikiFallbackSite = 'wiki';
3232 /** @} */ # end of Interwiki caching settings.
3235 * If local interwikis are set up which allow redirects,
3236 * set this regexp to restrict URLs which will be displayed
3237 * as 'redirected from' links.
3239 * @par Example:
3240 * It might look something like this:
3241 * @code
3242 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3243 * @endcode
3245 * Leave at false to avoid displaying any incoming redirect markers.
3246 * This does not affect intra-wiki redirects, which don't change
3247 * the URL.
3249 $wgRedirectSources = false;
3252 * Set this to false to avoid forcing the first letter of links to capitals.
3254 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3255 * appearing with a capital at the beginning of a sentence will *not* go to the
3256 * same place as links in the middle of a sentence using a lowercase initial.
3258 $wgCapitalLinks = true;
3261 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3262 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3263 * true by default (and setting them has no effect), due to various things that
3264 * require them to be so. Also, since Talk namespaces need to directly mirror their
3265 * associated content namespaces, the values for those are ignored in favor of the
3266 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3267 * NS_FILE.
3269 * @par Example:
3270 * @code
3271 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3272 * @endcode
3274 $wgCapitalLinkOverrides = array();
3276 /** Which namespaces should support subpages?
3277 * See Language.php for a list of namespaces.
3279 $wgNamespacesWithSubpages = array(
3280 NS_TALK => true,
3281 NS_USER => true,
3282 NS_USER_TALK => true,
3283 NS_PROJECT => true,
3284 NS_PROJECT_TALK => true,
3285 NS_FILE_TALK => true,
3286 NS_MEDIAWIKI => true,
3287 NS_MEDIAWIKI_TALK => true,
3288 NS_TEMPLATE_TALK => true,
3289 NS_HELP => true,
3290 NS_HELP_TALK => true,
3291 NS_CATEGORY_TALK => true
3295 * Array of namespaces which can be deemed to contain valid "content", as far
3296 * as the site statistics are concerned. Useful if additional namespaces also
3297 * contain "content" which should be considered when generating a count of the
3298 * number of articles in the wiki.
3300 $wgContentNamespaces = array( NS_MAIN );
3303 * Max number of redirects to follow when resolving redirects.
3304 * 1 means only the first redirect is followed (default behavior).
3305 * 0 or less means no redirects are followed.
3307 $wgMaxRedirects = 1;
3310 * Array of invalid page redirect targets.
3311 * Attempting to create a redirect to any of the pages in this array
3312 * will make the redirect fail.
3313 * Userlogout is hard-coded, so it does not need to be listed here.
3314 * (bug 10569) Disallow Mypage and Mytalk as well.
3316 * As of now, this only checks special pages. Redirects to pages in
3317 * other namespaces cannot be invalidated by this variable.
3319 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3321 /** @} */ # End of title and interwiki settings }
3323 /************************************************************************//**
3324 * @name Parser settings
3325 * These settings configure the transformation from wikitext to HTML.
3326 * @{
3330 * Parser configuration. Associative array with the following members:
3332 * class The class name
3334 * preprocessorClass The preprocessor class. Two classes are currently available:
3335 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3336 * storage, and Preprocessor_DOM, which uses the DOM module for
3337 * temporary storage. Preprocessor_DOM generally uses less memory;
3338 * the speed of the two is roughly the same.
3340 * If this parameter is not given, it uses Preprocessor_DOM if the
3341 * DOM module is available, otherwise it uses Preprocessor_Hash.
3343 * The entire associative array will be passed through to the constructor as
3344 * the first parameter. Note that only Setup.php can use this variable --
3345 * the configuration will change at runtime via $wgParser member functions, so
3346 * the contents of this variable will be out-of-date. The variable can only be
3347 * changed during LocalSettings.php, in particular, it can't be changed during
3348 * an extension setup function.
3350 $wgParserConf = array(
3351 'class' => 'Parser',
3352 #'preprocessorClass' => 'Preprocessor_Hash',
3355 /** Maximum indent level of toc. */
3356 $wgMaxTocLevel = 999;
3359 * A complexity limit on template expansion: the maximum number of nodes visited
3360 * by PPFrame::expand()
3362 $wgMaxPPNodeCount = 1000000;
3365 * A complexity limit on template expansion: the maximum number of elements
3366 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3367 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3368 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3369 * this default corresponds to about 155 MB.
3371 * When the limit is exceeded, an exception is thrown.
3373 $wgMaxGeneratedPPNodeCount = 1000000;
3376 * Maximum recursion depth for templates within templates.
3377 * The current parser adds two levels to the PHP call stack for each template,
3378 * and xdebug limits the call stack to 100 by default. So this should hopefully
3379 * stop the parser before it hits the xdebug limit.
3381 $wgMaxTemplateDepth = 40;
3383 /** @see $wgMaxTemplateDepth */
3384 $wgMaxPPExpandDepth = 40;
3386 /** The external URL protocols */
3387 $wgUrlProtocols = array(
3388 'http://',
3389 'https://',
3390 'ftp://',
3391 'ftps://', // If we allow ftp:// we should allow the secure version.
3392 'ssh://',
3393 'sftp://', // SFTP > FTP
3394 'irc://',
3395 'ircs://', // @bug 28503
3396 'xmpp:', // Another open communication protocol
3397 'sip:',
3398 'sips:',
3399 'gopher://',
3400 'telnet://', // Well if we're going to support the above.. -ævar
3401 'nntp://', // @bug 3808 RFC 1738
3402 'worldwind://',
3403 'mailto:',
3404 'tel:', // If we can make emails linkable, why not phone numbers?
3405 'sms:', // Likewise this is standardized too
3406 'news:',
3407 'svn://',
3408 'git://',
3409 'mms://',
3410 'bitcoin:', // Even registerProtocolHandler whitelists this along with mailto:
3411 'magnet:', // No reason to reject torrents over magnet: when they're allowed over http://
3412 'urn:', // Allow URNs to be used in Microdata/RDFa <link ... href="urn:...">s
3413 'geo:', // geo: urls define locations, they're useful in Microdata/RDFa and when mentioning coordinates.
3414 '//', // for protocol-relative URLs
3418 * If true, removes (substitutes) templates in "~~~~" signatures.
3420 $wgCleanSignatures = true;
3422 /** Whether to allow inline image pointing to other websites */
3423 $wgAllowExternalImages = false;
3426 * If the above is false, you can specify an exception here. Image URLs
3427 * that start with this string are then rendered, while all others are not.
3428 * You can use this to set up a trusted, simple repository of images.
3429 * You may also specify an array of strings to allow multiple sites
3431 * @par Examples:
3432 * @code
3433 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3434 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3435 * @endcode
3437 $wgAllowExternalImagesFrom = '';
3439 /** If $wgAllowExternalImages is false, you can allow an on-wiki
3440 * whitelist of regular expression fragments to match the image URL
3441 * against. If the image matches one of the regular expression fragments,
3442 * The image will be displayed.
3444 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3445 * Or false to disable it
3447 $wgEnableImageWhitelist = true;
3450 * A different approach to the above: simply allow the "<img>" tag to be used.
3451 * This allows you to specify alt text and other attributes, copy-paste HTML to
3452 * your wiki more easily, etc. However, allowing external images in any manner
3453 * will allow anyone with editing rights to snoop on your visitors' IP
3454 * addresses and so forth, if they wanted to, by inserting links to images on
3455 * sites they control.
3457 $wgAllowImageTag = false;
3460 * $wgUseTidy: use tidy to make sure HTML output is sane.
3461 * Tidy is a free tool that fixes broken HTML.
3462 * See http://www.w3.org/People/Raggett/tidy/
3464 * - $wgTidyBin should be set to the path of the binary and
3465 * - $wgTidyConf to the path of the configuration file.
3466 * - $wgTidyOpts can include any number of parameters.
3467 * - $wgTidyInternal controls the use of the PECL extension or the
3468 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3469 * of spawning a separate program.
3470 * Normally you shouldn't need to override the setting except for
3471 * debugging. To install, use 'pear install tidy' and add a line
3472 * 'extension=tidy.so' to php.ini.
3474 $wgUseTidy = false;
3475 /** @see $wgUseTidy */
3476 $wgAlwaysUseTidy = false;
3477 /** @see $wgUseTidy */
3478 $wgTidyBin = 'tidy';
3479 /** @see $wgUseTidy */
3480 $wgTidyConf = $IP . '/includes/tidy.conf';
3481 /** @see $wgUseTidy */
3482 $wgTidyOpts = '';
3483 /** @see $wgUseTidy */
3484 $wgTidyInternal = extension_loaded( 'tidy' );
3487 * Put tidy warnings in HTML comments
3488 * Only works for internal tidy.
3490 $wgDebugTidy = false;
3492 /** Allow raw, unchecked HTML in "<html>...</html>" sections.
3493 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3494 * TO RESTRICT EDITING to only those that you trust
3496 $wgRawHtml = false;
3499 * Set a default target for external links, e.g. _blank to pop up a new window
3501 $wgExternalLinkTarget = false;
3504 * If true, external URL links in wiki text will be given the
3505 * rel="nofollow" attribute as a hint to search engines that
3506 * they should not be followed for ranking purposes as they
3507 * are user-supplied and thus subject to spamming.
3509 $wgNoFollowLinks = true;
3512 * Namespaces in which $wgNoFollowLinks doesn't apply.
3513 * See Language.php for a list of namespaces.
3515 $wgNoFollowNsExceptions = array();
3518 * If this is set to an array of domains, external links to these domain names
3519 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3520 * value of $wgNoFollowLinks. For instance:
3522 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org' );
3524 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3525 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3526 * etc.
3528 $wgNoFollowDomainExceptions = array();
3531 * Allow DISPLAYTITLE to change title display
3533 $wgAllowDisplayTitle = true;
3536 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
3537 * canonical DB key. Also disallow some inline CSS rules like display: none;
3538 * which can cause the text to be hidden or unselectable.
3540 $wgRestrictDisplayTitle = true;
3543 * Maximum number of calls per parse to expensive parser functions such as
3544 * PAGESINCATEGORY.
3546 $wgExpensiveParserFunctionLimit = 100;
3549 * Preprocessor caching threshold
3550 * Setting it to 'false' will disable the preprocessor cache.
3552 $wgPreprocessorCacheThreshold = 1000;
3555 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
3557 $wgEnableScaryTranscluding = false;
3560 * Expiry time for transcluded templates cached in transcache database table.
3561 * Only used $wgEnableInterwikiTranscluding is set to true.
3563 $wgTranscludeCacheExpiry = 3600;
3565 /** @} */ # end of parser settings }
3567 /************************************************************************//**
3568 * @name Statistics
3569 * @{
3573 * Method used to determine if a page in a content namespace should be counted
3574 * as a valid article.
3576 * Redirect pages will never be counted as valid articles.
3578 * This variable can have the following values:
3579 * - 'any': all pages as considered as valid articles
3580 * - 'comma': the page must contain a comma to be considered valid
3581 * - 'link': the page must contain a [[wiki link]] to be considered valid
3582 * - null: the value will be set at run time depending on $wgUseCommaCount:
3583 * if $wgUseCommaCount is false, it will be 'link', if it is true
3584 * it will be 'comma'
3586 * See also See http://www.mediawiki.org/wiki/Manual:Article_count
3588 * Retroactively changing this variable will not affect the existing count,
3589 * to update it, you will need to run the maintenance/updateArticleCount.php
3590 * script.
3592 $wgArticleCountMethod = null;
3595 * Backward compatibility setting, will set $wgArticleCountMethod if it is null.
3596 * @deprecated since 1.18; use $wgArticleCountMethod instead
3598 $wgUseCommaCount = false;
3601 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
3602 * values are easier on the database. A value of 1 causes the counters to be
3603 * updated on every hit, any higher value n cause them to update *on average*
3604 * every n hits. Should be set to either 1 or something largish, eg 1000, for
3605 * maximum efficiency.
3607 $wgHitcounterUpdateFreq = 1;
3610 * How many days user must be idle before he is considered inactive. Will affect
3611 * the number shown on Special:Statistics, Special:ActiveUsers, and the
3612 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
3613 * You might want to leave this as the default value, to provide comparable
3614 * numbers between different wikis.
3616 $wgActiveUserDays = 30;
3618 /** @} */ # End of statistics }
3620 /************************************************************************//**
3621 * @name User accounts, authentication
3622 * @{
3625 /** For compatibility with old installations set to false */
3626 $wgPasswordSalt = true;
3629 * Specifies the minimal length of a user password. If set to 0, empty pass-
3630 * words are allowed.
3632 $wgMinimalPasswordLength = 1;
3635 * Whether to allow password resets ("enter some identifying data, and we'll send an email
3636 * with a temporary password you can use to get back into the account") identified by
3637 * various bits of data. Setting all of these to false (or the whole variable to false)
3638 * has the effect of disabling password resets entirely
3640 $wgPasswordResetRoutes = array(
3641 'username' => true,
3642 'email' => false,
3646 * Maximum number of Unicode characters in signature
3648 $wgMaxSigChars = 255;
3651 * Maximum number of bytes in username. You want to run the maintenance
3652 * script ./maintenance/checkUsernames.php once you have changed this value.
3654 $wgMaxNameChars = 255;
3657 * Array of usernames which may not be registered or logged in from
3658 * Maintenance scripts can still use these
3660 $wgReservedUsernames = array(
3661 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
3662 'Conversion script', // Used for the old Wikipedia software upgrade
3663 'Maintenance script', // Maintenance scripts which perform editing, image import script
3664 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
3665 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
3666 'msg:double-redirect-fixer', // Automatic double redirect fix
3667 'msg:usermessage-editor', // Default user for leaving user messages
3668 'msg:proxyblocker', // For Special:Blockme
3672 * Settings added to this array will override the default globals for the user
3673 * preferences used by anonymous visitors and newly created accounts.
3674 * For instance, to disable section editing links:
3675 * $wgDefaultUserOptions ['editsection'] = 0;
3677 $wgDefaultUserOptions = array(
3678 'ccmeonemails' => 0,
3679 'cols' => 80,
3680 'date' => 'default',
3681 'diffonly' => 0,
3682 'disablemail' => 0,
3683 'disablesuggest' => 0,
3684 'editfont' => 'default',
3685 'editondblclick' => 0,
3686 'editsection' => 1,
3687 'editsectiononrightclick' => 0,
3688 'enotifminoredits' => 0,
3689 'enotifrevealaddr' => 0,
3690 'enotifusertalkpages' => 1,
3691 'enotifwatchlistpages' => 0,
3692 'extendwatchlist' => 0,
3693 'fancysig' => 0,
3694 'forceeditsummary' => 0,
3695 'gender' => 'unknown',
3696 'hideminor' => 0,
3697 'hidepatrolled' => 0,
3698 'imagesize' => 2,
3699 'justify' => 0,
3700 'math' => 1,
3701 'minordefault' => 0,
3702 'newpageshidepatrolled' => 0,
3703 'nocache' => 0,
3704 'noconvertlink' => 0,
3705 'norollbackdiff' => 0,
3706 'numberheadings' => 0,
3707 'previewonfirst' => 0,
3708 'previewontop' => 1,
3709 'rcdays' => 7,
3710 'rclimit' => 50,
3711 'rememberpassword' => 0,
3712 'rows' => 25,
3713 'searchlimit' => 20,
3714 'showhiddencats' => 0,
3715 'shownumberswatching' => 1,
3716 'showtoc' => 1,
3717 'showtoolbar' => 1,
3718 'skin' => false,
3719 'stubthreshold' => 0,
3720 'thumbsize' => 2,
3721 'underline' => 2,
3722 'uselivepreview' => 0,
3723 'usenewrc' => 0,
3724 'watchcreations' => 0,
3725 'watchdefault' => 0,
3726 'watchdeletion' => 0,
3727 'watchlistdays' => 3.0,
3728 'watchlisthideanons' => 0,
3729 'watchlisthidebots' => 0,
3730 'watchlisthideliu' => 0,
3731 'watchlisthideminor' => 0,
3732 'watchlisthideown' => 0,
3733 'watchlisthidepatrolled' => 0,
3734 'watchmoves' => 0,
3735 'wllimit' => 250,
3736 'useeditwarning' => 1,
3739 /** An array of preferences to not show for the user */
3740 $wgHiddenPrefs = array();
3743 * Characters to prevent during new account creations.
3744 * This is used in a regular expression character class during
3745 * registration (regex metacharacters like / are escaped).
3747 $wgInvalidUsernameCharacters = '@';
3750 * Character used as a delimiter when testing for interwiki userrights
3751 * (In Special:UserRights, it is possible to modify users on different
3752 * databases if the delimiter is used, e.g. "Someuser@enwiki").
3754 * It is recommended that you have this delimiter in
3755 * $wgInvalidUsernameCharacters above, or you will not be able to
3756 * modify the user rights of those users via Special:UserRights
3758 $wgUserrightsInterwikiDelimiter = '@';
3761 * This is to let user authenticate using https when they come from http.
3762 * Based on an idea by George Herbert on wikitech-l:
3763 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
3764 * @since 1.17
3766 $wgSecureLogin = false;
3769 * By default, keep users logged in via HTTPS when $wgSecureLogin is also
3770 * true. Users opt-out of HTTPS when they login by de-selecting the checkbox.
3771 * @since 1.21
3773 $wgSecureLoginDefaultHTTPS = true;
3775 /** @} */ # end user accounts }
3777 /************************************************************************//**
3778 * @name User rights, access control and monitoring
3779 * @{
3783 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
3785 $wgAutoblockExpiry = 86400;
3788 * Set this to true to allow blocked users to edit their own user talk page.
3790 $wgBlockAllowsUTEdit = false;
3792 /** Allow sysops to ban users from accessing Emailuser */
3793 $wgSysopEmailBans = true;
3796 * Limits on the possible sizes of range blocks.
3798 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
3799 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
3800 * half the number of bits avoids such errors, and allows entire ISPs to be
3801 * blocked using a small number of range blocks.
3803 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
3804 * customer, so range blocks larger than /64 (half the number of bits) will
3805 * plainly be required. RFC 4692 implies that a very large ISP may be
3806 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
3807 * as our limit. As of 2012, blocking the whole world would require a /4 range.
3809 $wgBlockCIDRLimit = array(
3810 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
3811 'IPv6' => 19,
3815 * If true, blocked users will not be allowed to login. When using this with
3816 * a public wiki, the effect of logging out blocked users may actually be
3817 * avers: unless the user's address is also blocked (e.g. auto-block),
3818 * logging the user out will again allow reading and editing, just as for
3819 * anonymous visitors.
3821 $wgBlockDisablesLogin = false;
3824 * Pages anonymous user may see, set as an array of pages titles.
3826 * @par Example:
3827 * @code
3828 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
3829 * @endcode
3831 * Special:Userlogin and Special:ChangePassword are always whitelisted.
3833 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
3834 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
3836 * @note Also that this will only protect _pages in the wiki_. Uploaded files
3837 * will remain readable. You can use img_auth.php to protect uploaded files,
3838 * see http://www.mediawiki.org/wiki/Manual:Image_Authorization
3840 $wgWhitelistRead = false;
3843 * Pages anonymous user may see, set as an array of regular expressions.
3845 * This function will match the regexp against the title name, which
3846 * is without underscore.
3848 * @par Example:
3849 * To whitelist [[Main Page]]:
3850 * @code
3851 * $wgWhitelistReadRegexp = array( "/Main Page/" );
3852 * @endcode
3854 * @note Unless ^ and/or $ is specified, a regular expression might match
3855 * pages not intended to be whitelisted. The above example will also
3856 * whitelist a page named 'Security Main Page'.
3858 * @par Example:
3859 * To allow reading any page starting with 'User' regardless of the case:
3860 * @code
3861 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
3862 * @endcode
3863 * Will allow both [[User is banned]] and [[User:JohnDoe]]
3865 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
3866 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
3868 $wgWhitelistReadRegexp = false;
3871 * Should editors be required to have a validated e-mail
3872 * address before being allowed to edit?
3874 $wgEmailConfirmToEdit = false;
3877 * Permission keys given to users in each group.
3879 * This is an array where the keys are all groups and each value is an
3880 * array of the format (right => boolean).
3882 * The second format is used to support per-namespace permissions.
3883 * Note that this feature does not fully work for all permission types.
3885 * All users are implicitly in the '*' group including anonymous visitors;
3886 * logged-in users are all implicitly in the 'user' group. These will be
3887 * combined with the permissions of all groups that a given user is listed
3888 * in in the user_groups table.
3890 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
3891 * doing! This will wipe all permissions, and may mean that your users are
3892 * unable to perform certain essential tasks or access new functionality
3893 * when new permissions are introduced and default grants established.
3895 * Functionality to make pages inaccessible has not been extensively tested
3896 * for security. Use at your own risk!
3898 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
3900 $wgGroupPermissions = array();
3902 /** @cond file_level_code */
3903 // Implicit group for all visitors
3904 $wgGroupPermissions['*']['createaccount'] = true;
3905 $wgGroupPermissions['*']['read'] = true;
3906 $wgGroupPermissions['*']['edit'] = true;
3907 $wgGroupPermissions['*']['createpage'] = true;
3908 $wgGroupPermissions['*']['createtalk'] = true;
3909 $wgGroupPermissions['*']['writeapi'] = true;
3910 $wgGroupPermissions['*']['editmyusercss'] = true;
3911 $wgGroupPermissions['*']['editmyuserjs'] = true;
3912 $wgGroupPermissions['*']['viewmywatchlist'] = true;
3913 $wgGroupPermissions['*']['editmywatchlist'] = true;
3914 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
3915 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
3916 $wgGroupPermissions['*']['editmyoptions'] = true;
3917 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
3919 // Implicit group for all logged-in accounts
3920 $wgGroupPermissions['user']['move'] = true;
3921 $wgGroupPermissions['user']['move-subpages'] = true;
3922 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
3923 $wgGroupPermissions['user']['movefile'] = true;
3924 $wgGroupPermissions['user']['read'] = true;
3925 $wgGroupPermissions['user']['edit'] = true;
3926 $wgGroupPermissions['user']['createpage'] = true;
3927 $wgGroupPermissions['user']['createtalk'] = true;
3928 $wgGroupPermissions['user']['writeapi'] = true;
3929 $wgGroupPermissions['user']['upload'] = true;
3930 $wgGroupPermissions['user']['reupload'] = true;
3931 $wgGroupPermissions['user']['reupload-shared'] = true;
3932 $wgGroupPermissions['user']['minoredit'] = true;
3933 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
3934 $wgGroupPermissions['user']['sendemail'] = true;
3936 // Implicit group for accounts that pass $wgAutoConfirmAge
3937 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
3938 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
3940 // Users with bot privilege can have their edits hidden
3941 // from various log pages by default
3942 $wgGroupPermissions['bot']['bot'] = true;
3943 $wgGroupPermissions['bot']['autoconfirmed'] = true;
3944 $wgGroupPermissions['bot']['editsemiprotected'] = true;
3945 $wgGroupPermissions['bot']['nominornewtalk'] = true;
3946 $wgGroupPermissions['bot']['autopatrol'] = true;
3947 $wgGroupPermissions['bot']['suppressredirect'] = true;
3948 $wgGroupPermissions['bot']['apihighlimits'] = true;
3949 $wgGroupPermissions['bot']['writeapi'] = true;
3951 // Most extra permission abilities go to this group
3952 $wgGroupPermissions['sysop']['block'] = true;
3953 $wgGroupPermissions['sysop']['createaccount'] = true;
3954 $wgGroupPermissions['sysop']['delete'] = true;
3955 $wgGroupPermissions['sysop']['bigdelete'] = true; // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
3956 $wgGroupPermissions['sysop']['deletedhistory'] = true; // can view deleted history entries, but not see or restore the text
3957 $wgGroupPermissions['sysop']['deletedtext'] = true; // can view deleted revision text
3958 $wgGroupPermissions['sysop']['undelete'] = true;
3959 $wgGroupPermissions['sysop']['editinterface'] = true;
3960 $wgGroupPermissions['sysop']['editusercss'] = true;
3961 $wgGroupPermissions['sysop']['edituserjs'] = true;
3962 $wgGroupPermissions['sysop']['import'] = true;
3963 $wgGroupPermissions['sysop']['importupload'] = true;
3964 $wgGroupPermissions['sysop']['move'] = true;
3965 $wgGroupPermissions['sysop']['move-subpages'] = true;
3966 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
3967 $wgGroupPermissions['sysop']['patrol'] = true;
3968 $wgGroupPermissions['sysop']['autopatrol'] = true;
3969 $wgGroupPermissions['sysop']['protect'] = true;
3970 $wgGroupPermissions['sysop']['editprotected'] = true;
3971 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
3972 $wgGroupPermissions['sysop']['rollback'] = true;
3973 $wgGroupPermissions['sysop']['upload'] = true;
3974 $wgGroupPermissions['sysop']['reupload'] = true;
3975 $wgGroupPermissions['sysop']['reupload-shared'] = true;
3976 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
3977 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
3978 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
3979 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
3980 $wgGroupPermissions['sysop']['blockemail'] = true;
3981 $wgGroupPermissions['sysop']['markbotedits'] = true;
3982 $wgGroupPermissions['sysop']['apihighlimits'] = true;
3983 $wgGroupPermissions['sysop']['browsearchive'] = true;
3984 $wgGroupPermissions['sysop']['noratelimit'] = true;
3985 $wgGroupPermissions['sysop']['movefile'] = true;
3986 $wgGroupPermissions['sysop']['unblockself'] = true;
3987 $wgGroupPermissions['sysop']['suppressredirect'] = true;
3988 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
3989 #$wgGroupPermissions['sysop']['mergehistory'] = true;
3991 // Permission to change users' group assignments
3992 $wgGroupPermissions['bureaucrat']['userrights'] = true;
3993 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
3994 // Permission to change users' groups assignments across wikis
3995 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
3996 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
3997 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
3999 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4000 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4001 // To hide usernames from users and Sysops
4002 #$wgGroupPermissions['suppress']['hideuser'] = true;
4003 // To hide revisions/log items from users and Sysops
4004 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4005 // For private suppression log access
4006 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4009 * The developer group is deprecated, but can be activated if need be
4010 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4011 * that a lock file be defined and creatable/removable by the web
4012 * server.
4014 # $wgGroupPermissions['developer']['siteadmin'] = true;
4016 /** @endcond */
4019 * Permission keys revoked from users in each group.
4021 * This acts the same way as wgGroupPermissions above, except that
4022 * if the user is in a group here, the permission will be removed from them.
4024 * Improperly setting this could mean that your users will be unable to perform
4025 * certain essential tasks, so use at your own risk!
4027 $wgRevokePermissions = array();
4030 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4032 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4035 * A map of group names that the user is in, to group names that those users
4036 * are allowed to add or revoke.
4038 * Setting the list of groups to add or revoke to true is equivalent to "any
4039 * group".
4041 * @par Example:
4042 * To allow sysops to add themselves to the "bot" group:
4043 * @code
4044 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4045 * @endcode
4047 * @par Example:
4048 * Implicit groups may be used for the source group, for instance:
4049 * @code
4050 * $wgGroupsRemoveFromSelf = array( '*' => true );
4051 * @endcode
4052 * This allows users in the '*' group (i.e. any user) to remove themselves from
4053 * any group that they happen to be in.
4055 $wgGroupsAddToSelf = array();
4057 /** @see $wgGroupsAddToSelf */
4058 $wgGroupsRemoveFromSelf = array();
4061 * Set of available actions that can be restricted via action=protect
4062 * You probably shouldn't change this.
4063 * Translated through restriction-* messages.
4064 * Title::getRestrictionTypes() will remove restrictions that are not
4065 * applicable to a specific title (create and upload)
4067 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4070 * Rights which can be required for each protection level (via action=protect)
4072 * You can add a new protection level that requires a specific
4073 * permission by manipulating this array. The ordering of elements
4074 * dictates the order on the protection form's lists.
4076 * - '' will be ignored (i.e. unprotected)
4077 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4078 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4080 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4083 * Restriction levels that can be used with cascading protection
4085 * A page can only be protected with cascading protection if the
4086 * requested restriction level is included in this array.
4088 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4089 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4091 $wgCascadingRestrictionLevels = array( 'sysop' );
4094 * Set the minimum permissions required to edit pages in each
4095 * namespace. If you list more than one permission, a user must
4096 * have all of them to edit pages in that namespace.
4098 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4100 $wgNamespaceProtection = array();
4103 * Pages in namespaces in this array can not be used as templates.
4105 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4106 * namespaces constants (NS_USER, NS_MAIN...).
4108 * Among other things, this may be useful to enforce read-restrictions
4109 * which may otherwise be bypassed by using the template mechanism.
4111 $wgNonincludableNamespaces = array();
4114 * Number of seconds an account is required to age before it's given the
4115 * implicit 'autoconfirm' group membership. This can be used to limit
4116 * privileges of new accounts.
4118 * Accounts created by earlier versions of the software may not have a
4119 * recorded creation date, and will always be considered to pass the age test.
4121 * When left at 0, all registered accounts will pass.
4123 * @par Example:
4124 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4125 * @code
4126 * $wgAutoConfirmAge = 600; // ten minutes
4127 * @endcode
4128 * Set age to one day:
4129 * @code
4130 * $wgAutoConfirmAge = 3600*24; // one day
4131 * @endcode
4133 $wgAutoConfirmAge = 0;
4136 * Number of edits an account requires before it is autoconfirmed.
4137 * Passing both this AND the time requirement is needed. Example:
4139 * @par Example:
4140 * @code
4141 * $wgAutoConfirmCount = 50;
4142 * @endcode
4144 $wgAutoConfirmCount = 0;
4147 * Automatically add a usergroup to any user who matches certain conditions.
4149 * @todo Redocument $wgAutopromote
4151 * The format is
4152 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4153 * where cond1, cond2, ... are themselves conditions; *OR*
4154 * APCOND_EMAILCONFIRMED, *OR*
4155 * array( APCOND_EMAILCONFIRMED ), *OR*
4156 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4157 * array( APCOND_AGE, seconds since registration ), *OR*
4158 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4159 * array( APCOND_ISIP, ip ), *OR*
4160 * array( APCOND_IPINRANGE, range ), *OR*
4161 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4162 * array( APCOND_BLOCKED ), *OR*
4163 * array( APCOND_ISBOT ), *OR*
4164 * similar constructs defined by extensions.
4166 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4167 * user who has provided an e-mail address.
4169 $wgAutopromote = array(
4170 'autoconfirmed' => array( '&',
4171 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4172 array( APCOND_AGE, &$wgAutoConfirmAge ),
4177 * Automatically add a usergroup to any user who matches certain conditions.
4179 * Does not add the user to the group again if it has been removed.
4180 * Also, does not remove the group if the user no longer meets the criteria.
4182 * The format is:
4183 * @code
4184 * array( event => criteria, ... )
4185 * @endcode
4186 * Where event is either:
4187 * - 'onEdit' (when user edits)
4188 * - 'onView' (when user views the wiki)
4190 * Criteria has the same format as $wgAutopromote
4192 * @see $wgAutopromote
4193 * @since 1.18
4195 $wgAutopromoteOnce = array(
4196 'onEdit' => array(),
4197 'onView' => array()
4201 * Put user rights log entries for autopromotion in recent changes?
4202 * @since 1.18
4204 $wgAutopromoteOnceLogInRC = true;
4207 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4208 * can assign which groups at Special:Userrights.
4210 * @par Example:
4211 * Bureaucrats can add any group:
4212 * @code
4213 * $wgAddGroups['bureaucrat'] = true;
4214 * @endcode
4215 * Bureaucrats can only remove bots and sysops:
4216 * @code
4217 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4218 * @endcode
4219 * Sysops can make bots:
4220 * @code
4221 * $wgAddGroups['sysop'] = array( 'bot' );
4222 * @endcode
4223 * Sysops can disable other sysops in an emergency, and disable bots:
4224 * @code
4225 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4226 * @endcode
4228 $wgAddGroups = array();
4229 /** @see $wgAddGroups */
4230 $wgRemoveGroups = array();
4233 * A list of available rights, in addition to the ones defined by the core.
4234 * For extensions only.
4236 $wgAvailableRights = array();
4239 * Optional to restrict deletion of pages with higher revision counts
4240 * to users with the 'bigdelete' permission. (Default given to sysops.)
4242 $wgDeleteRevisionsLimit = 0;
4245 * Number of accounts each IP address may create, 0 to disable.
4247 * @warning Requires memcached
4249 $wgAccountCreationThrottle = 0;
4252 * Edits matching these regular expressions in body text
4253 * will be recognised as spam and rejected automatically.
4255 * There's no administrator override on-wiki, so be careful what you set. :)
4256 * May be an array of regexes or a single string for backwards compatibility.
4258 * @see http://en.wikipedia.org/wiki/Regular_expression
4260 * @note Each regex needs a beginning/end delimiter, eg: # or /
4262 $wgSpamRegex = array();
4264 /** Same as the above except for edit summaries */
4265 $wgSummarySpamRegex = array();
4268 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4269 * proxies
4270 * @since 1.16
4272 $wgEnableDnsBlacklist = false;
4275 * @deprecated since 1.17 Use $wgEnableDnsBlacklist instead, only kept for
4276 * backward compatibility.
4278 $wgEnableSorbs = false;
4281 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4283 * This is an array of either a URL or an array with the URL and a key (should
4284 * the blacklist require a key).
4286 * @par Example:
4287 * @code
4288 * $wgDnsBlacklistUrls = array(
4289 * // String containing URL
4290 * 'http.dnsbl.sorbs.net.',
4291 * // Array with URL and key, for services that require a key
4292 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4293 * // Array with just the URL. While this works, it is recommended that you
4294 * // just use a string as shown above
4295 * array( 'opm.tornevall.org.' )
4296 * );
4297 * @endcode
4299 * @note You should end the domain name with a . to avoid searching your
4300 * eventual domain search suffixes.
4301 * @since 1.16
4303 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4306 * @deprecated since 1.17 Use $wgDnsBlacklistUrls instead, only kept for
4307 * backward compatibility.
4309 $wgSorbsUrl = array();
4312 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4313 * what the other methods might say.
4315 $wgProxyWhitelist = array();
4318 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4319 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4320 * (transparent) proxies without needing to block the proxies themselves.
4322 $wgApplyIpBlocksToXff = false;
4325 * Simple rate limiter options to brake edit floods.
4327 * Maximum number actions allowed in the given number of seconds; after that
4328 * the violating client receives HTTP 500 error pages until the period
4329 * elapses.
4331 * @par Example:
4332 * To set a generic maximum of 4 hits in 60 seconds:
4333 * @code
4334 * $wgRateLimits = array( 4, 60 );
4335 * @endcode
4337 * You could also limit per action and then type of users. See the inline
4338 * code for a template to use.
4340 * This option set is experimental and likely to change.
4342 * @warning Requires memcached.
4344 $wgRateLimits = array(
4345 'edit' => array(
4346 'anon' => null, // for any and all anonymous edits (aggregate)
4347 'user' => null, // for each logged-in user
4348 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4349 'ip' => null, // for each anon and recent account
4350 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4352 'move' => array(
4353 'user' => null,
4354 'newbie' => null,
4355 'ip' => null,
4356 'subnet' => null,
4358 'mailpassword' => array(
4359 'anon' => null,
4361 'emailuser' => array(
4362 'user' => null,
4367 * Set to a filename to log rate limiter hits.
4369 $wgRateLimitLog = null;
4372 * Array of IPs which should be excluded from rate limits.
4373 * This may be useful for whitelisting NAT gateways for conferences, etc.
4375 $wgRateLimitsExcludedIPs = array();
4378 * Log IP addresses in the recentchanges table; can be accessed only by
4379 * extensions (e.g. CheckUser) or a DB admin
4380 * Used for retroactive autoblocks
4382 $wgPutIPinRC = true;
4385 * Integer defining default number of entries to show on
4386 * special pages which are query-pages such as Special:Whatlinkshere.
4388 $wgQueryPageDefaultLimit = 50;
4391 * Limit password attempts to X attempts per Y seconds per IP per account.
4393 * @warning Requires memcached.
4395 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4397 /** @} */ # end of user rights settings
4399 /************************************************************************//**
4400 * @name Proxy scanner settings
4401 * @{
4405 * If you enable this, every editor's IP address will be scanned for open HTTP
4406 * proxies.
4408 * @warning Don't enable this. Many sysops will report "hostile TCP port scans"
4409 * to your ISP and ask for your server to be shut down.
4410 * You have been warned.
4412 $wgBlockOpenProxies = false;
4413 /** Port we want to scan for a proxy */
4414 $wgProxyPorts = array( 80, 81, 1080, 3128, 6588, 8000, 8080, 8888, 65506 );
4415 /** Script used to scan */
4416 $wgProxyScriptPath = "$IP/maintenance/proxyCheck.php";
4417 /** Expiration time for cached proxy IPs */
4418 $wgProxyMemcExpiry = 86400;
4419 /** This should always be customised in LocalSettings.php */
4420 $wgSecretKey = false;
4423 * Big list of banned IP addresses.
4425 * This can have the following formats:
4426 * - An array of addresses, either in the values
4427 * or the keys (for backward compatibility)
4428 * - A string, in that case this is the path to a file
4429 * containing the list of IP addresses, one per line
4431 $wgProxyList = array();
4434 * @deprecated since 1.14
4436 $wgProxyKey = false;
4438 /** @} */ # end of proxy scanner settings
4440 /************************************************************************//**
4441 * @name Cookie settings
4442 * @{
4446 * Default cookie expiration time. Setting to 0 makes all cookies session-only.
4448 $wgCookieExpiration = 180 * 86400;
4451 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
4452 * or ".any.subdomain.net"
4454 $wgCookieDomain = '';
4457 * Set this variable if you want to restrict cookies to a certain path within
4458 * the domain specified by $wgCookieDomain.
4460 $wgCookiePath = '/';
4463 * Whether the "secure" flag should be set on the cookie. This can be:
4464 * - true: Set secure flag
4465 * - false: Don't set secure flag
4466 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
4468 $wgCookieSecure = 'detect';
4471 * By default, MediaWiki checks if the client supports cookies during the
4472 * login process, so that it can display an informative error message if
4473 * cookies are disabled. Set this to true if you want to disable this cookie
4474 * check.
4476 $wgDisableCookieCheck = false;
4479 * Cookies generated by MediaWiki have names starting with this prefix. Set it
4480 * to a string to use a custom prefix. Setting it to false causes the database
4481 * name to be used as a prefix.
4483 $wgCookiePrefix = false;
4486 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
4487 * in browsers that support this feature. This can mitigates some classes of
4488 * XSS attack.
4490 $wgCookieHttpOnly = true;
4493 * If the requesting browser matches a regex in this blacklist, we won't
4494 * send it cookies with HttpOnly mode, even if $wgCookieHttpOnly is on.
4496 $wgHttpOnlyBlacklist = array(
4497 // Internet Explorer for Mac; sometimes the cookies work, sometimes
4498 // they don't. It's difficult to predict, as combinations of path
4499 // and expiration options affect its parsing.
4500 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
4503 /** A list of cookies that vary the cache (for use by extensions) */
4504 $wgCacheVaryCookies = array();
4506 /** Override to customise the session name */
4507 $wgSessionName = false;
4509 /** @} */ # end of cookie settings }
4511 /************************************************************************//**
4512 * @name LaTeX (mathematical formulas)
4513 * @{
4517 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
4518 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
4519 * (ImageMagick) installed and available in the PATH.
4520 * Please see math/README for more information.
4522 $wgUseTeX = false;
4524 /** @} */ # end LaTeX }
4526 /************************************************************************//**
4527 * @name Profiling, testing and debugging
4529 * To enable profiling, edit StartProfiler.php
4531 * @{
4535 * Filename for debug logging. See http://www.mediawiki.org/wiki/How_to_debug
4536 * The debug log file should be not be publicly accessible if it is used, as it
4537 * may contain private data.
4539 $wgDebugLogFile = '';
4542 * Prefix for debug log lines
4544 $wgDebugLogPrefix = '';
4547 * If true, instead of redirecting, show a page with a link to the redirect
4548 * destination. This allows for the inspection of PHP error messages, and easy
4549 * resubmission of form data. For developer use only.
4551 $wgDebugRedirects = false;
4554 * If true, log debugging data from action=raw and load.php.
4555 * This is normally false to avoid overlapping debug entries due to gen=css
4556 * and gen=js requests.
4558 $wgDebugRawPage = false;
4561 * Send debug data to an HTML comment in the output.
4563 * This may occasionally be useful when supporting a non-technical end-user.
4564 * It's more secure than exposing the debug log file to the web, since the
4565 * output only contains private data for the current user. But it's not ideal
4566 * for development use since data is lost on fatal errors and redirects.
4568 $wgDebugComments = false;
4571 * Extensive database transaction state debugging
4573 * @since 1.20
4575 $wgDebugDBTransactions = false;
4578 * Write SQL queries to the debug log
4580 $wgDebugDumpSql = false;
4583 * Set to an array of log group keys to filenames.
4584 * If set, wfDebugLog() output for that group will go to that file instead
4585 * of the regular $wgDebugLogFile. Useful for enabling selective logging
4586 * in production.
4588 $wgDebugLogGroups = array();
4591 * Display debug data at the bottom of the main content area.
4593 * Useful for developers and technical users trying to working on a closed wiki.
4595 $wgShowDebug = false;
4598 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
4599 * Since 1.19 also includes memory usage.
4601 $wgDebugTimestamps = false;
4604 * Print HTTP headers for every request in the debug information.
4606 $wgDebugPrintHttpHeaders = true;
4609 * Show the contents of $wgHooks in Special:Version
4611 $wgSpecialVersionShowHooks = false;
4614 * Whether to show "we're sorry, but there has been a database error" pages.
4615 * Displaying errors aids in debugging, but may display information useful
4616 * to an attacker.
4618 $wgShowSQLErrors = false;
4621 * If set to true, uncaught exceptions will print a complete stack trace
4622 * to output. This should only be used for debugging, as it may reveal
4623 * private information in function parameters due to PHP's backtrace
4624 * formatting.
4626 $wgShowExceptionDetails = false;
4629 * If true, show a backtrace for database errors
4631 $wgShowDBErrorBacktrace = false;
4634 * If true, send the exception backtrace to the error log
4636 $wgLogExceptionBacktrace = true;
4639 * Expose backend server host names through the API and various HTML comments
4641 $wgShowHostnames = false;
4644 * Override server hostname detection with a hardcoded value.
4645 * Should be a string, default false.
4646 * @since 1.20
4648 $wgOverrideHostname = false;
4651 * If set to true MediaWiki will throw notices for some possible error
4652 * conditions and for deprecated functions.
4654 $wgDevelopmentWarnings = false;
4657 * Release limitation to wfDeprecated warnings, if set to a release number
4658 * development warnings will not be generated for deprecations added in releases
4659 * after the limit.
4661 $wgDeprecationReleaseLimit = false;
4663 /** Only record profiling info for pages that took longer than this */
4664 $wgProfileLimit = 0.0;
4666 /** Don't put non-profiling info into log file */
4667 $wgProfileOnly = false;
4670 * Log sums from profiling into "profiling" table in db.
4672 * You have to create a 'profiling' table in your database before using
4673 * this feature. Run set $wgProfileToDatabase to true in
4674 * LocalSettings.php and run maintenance/update.php or otherwise
4675 * manually add patch-profiling.sql to your database.
4677 * To enable profiling, edit StartProfiler.php
4679 $wgProfileToDatabase = false;
4681 /** If true, print a raw call tree instead of per-function report */
4682 $wgProfileCallTree = false;
4684 /** Should application server host be put into profiling table */
4685 $wgProfilePerHost = false;
4688 * Host for UDP profiler.
4690 * The host should be running a daemon which can be obtained from MediaWiki
4691 * Subversion at: http://svn.wikimedia.org/svnroot/mediawiki/trunk/udpprofile
4693 $wgUDPProfilerHost = '127.0.0.1';
4696 * Port for UDP profiler.
4697 * @see $wgUDPProfilerHost
4699 $wgUDPProfilerPort = '3811';
4701 /** Detects non-matching wfProfileIn/wfProfileOut calls */
4702 $wgDebugProfiling = false;
4704 /** Output debug message on every wfProfileIn/wfProfileOut */
4705 $wgDebugFunctionEntry = false;
4708 * Destination for wfIncrStats() data...
4709 * 'cache' to go into the system cache, if enabled (memcached)
4710 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
4711 * false to disable
4713 $wgStatsMethod = 'cache';
4716 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
4717 * be aggregated over more than one wiki. The string will be used in place of
4718 * the DB name in outgoing UDP packets. If this is set to false, the DB name
4719 * will be used.
4721 $wgAggregateStatsID = false;
4723 /** Whereas to count the number of time an article is viewed.
4724 * Does not work if pages are cached (for example with squid).
4726 $wgDisableCounters = false;
4729 * InfoAction retrieves a list of transclusion links (both to and from).
4730 * This number puts a limit on that query in the case of highly transcluded
4731 * templates.
4733 $wgPageInfoTransclusionLimit = 50;
4736 * Set this to an integer to only do synchronous site_stats updates
4737 * one every *this many* updates. The other requests go into pending
4738 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
4739 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
4741 $wgSiteStatsAsyncFactor = false;
4744 * Parser test suite files to be run by parserTests.php when no specific
4745 * filename is passed to it.
4747 * Extensions may add their own tests to this array, or site-local tests
4748 * may be added via LocalSettings.php
4750 * Use full paths.
4752 $wgParserTestFiles = array(
4753 "$IP/tests/parser/parserTests.txt",
4754 "$IP/tests/parser/extraParserTests.txt"
4758 * If configured, specifies target CodeReview installation to send test
4759 * result data from 'parserTests.php --upload'
4761 * Something like this:
4762 * $wgParserTestRemote = array(
4763 * 'api-url' => 'http://www.mediawiki.org/w/api.php',
4764 * 'repo' => 'MediaWiki',
4765 * 'suite' => 'ParserTests',
4766 * 'path' => '/trunk/phase3', // not used client-side; for reference
4767 * 'secret' => 'qmoicj3mc4mcklmqw', // Shared secret used in HMAC validation
4768 * );
4770 $wgParserTestRemote = false;
4773 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
4775 $wgEnableJavaScriptTest = false;
4778 * Configuration for javascript testing.
4780 $wgJavaScriptTestConfig = array(
4781 'qunit' => array(
4782 // Page where documentation can be found relevant to the QUnit test suite being ran.
4783 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
4784 // documentation link in the "javascripttest-qunit-intro" message.
4785 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
4786 // If you are submitting the QUnit test suite to a TestSwarm instance,
4787 // point this to the "inject.js" script of that instance. This is was registers
4788 // the QUnit hooks to extract the test results and push them back up into the
4789 // TestSwarm database.
4790 // @example 'http://localhost/testswarm/js/inject.js'
4791 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
4792 'testswarm-injectjs' => false,
4797 * Overwrite the caching key prefix with custom value.
4798 * @since 1.19
4800 $wgCachePrefix = false;
4803 * Display the new debugging toolbar. This also enables profiling on database
4804 * queries and other useful output.
4805 * Will disable file cache.
4807 * @since 1.19
4809 $wgDebugToolbar = false;
4811 /** @} */ # end of profiling, testing and debugging }
4813 /************************************************************************//**
4814 * @name Search
4815 * @{
4819 * Set this to true to disable the full text search feature.
4821 $wgDisableTextSearch = false;
4824 * Set to true to have nicer highlighted text in search results,
4825 * by default off due to execution overhead
4827 $wgAdvancedSearchHighlighting = false;
4830 * Regexp to match word boundaries, defaults for non-CJK languages
4831 * should be empty for CJK since the words are not separate
4833 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
4836 * Set to true to have the search engine count total
4837 * search matches to present in the Special:Search UI.
4838 * Not supported by every search engine shipped with MW.
4840 * This could however be slow on larger wikis, and is pretty flaky
4841 * with the current title vs content split. Recommend avoiding until
4842 * that's been worked out cleanly; but this may aid in testing the
4843 * search UI and API to confirm that the result count works.
4845 $wgCountTotalSearchHits = false;
4848 * Template for OpenSearch suggestions, defaults to API action=opensearch
4850 * Sites with heavy load would typically have these point to a custom
4851 * PHP wrapper to avoid firing up mediawiki for every keystroke
4853 * Placeholders: {searchTerms}
4855 $wgOpenSearchTemplate = false;
4858 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
4859 * false if you've disabled scripts that use api?action=opensearch and
4860 * want reduce load caused by cached scripts still pulling suggestions.
4861 * It will let the API fallback by responding with an empty array.
4863 $wgEnableOpenSearchSuggest = true;
4866 * Expiry time for search suggestion responses
4868 $wgSearchSuggestCacheExpiry = 1200;
4871 * If you've disabled search semi-permanently, this also disables updates to the
4872 * table. If you ever re-enable, be sure to rebuild the search table.
4874 $wgDisableSearchUpdate = false;
4877 * List of namespaces which are searched by default.
4879 * @par Example:
4880 * @code
4881 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
4882 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
4883 * @endcode
4885 $wgNamespacesToBeSearchedDefault = array(
4886 NS_MAIN => true,
4890 * Namespaces to be searched when user clicks the "Help" tab
4891 * on Special:Search.
4893 * Same format as $wgNamespacesToBeSearchedDefault.
4895 $wgNamespacesToBeSearchedHelp = array(
4896 NS_PROJECT => true,
4897 NS_HELP => true,
4901 * If set to true the 'searcheverything' preference will be effective only for
4902 * logged-in users.
4903 * Useful for big wikis to maintain different search profiles for anonymous and
4904 * logged-in users.
4906 $wgSearchEverythingOnlyLoggedIn = false;
4909 * Disable the internal MySQL-based search, to allow it to be
4910 * implemented by an extension instead.
4912 $wgDisableInternalSearch = false;
4915 * Set this to a URL to forward search requests to some external location.
4916 * If the URL includes '$1', this will be replaced with the URL-encoded
4917 * search term.
4919 * @par Example:
4920 * To forward to Google you'd have something like:
4921 * @code
4922 * $wgSearchForwardUrl =
4923 * 'http://www.google.com/search?q=$1' .
4924 * '&domains=http://example.com' .
4925 * '&sitesearch=http://example.com' .
4926 * '&ie=utf-8&oe=utf-8';
4927 * @endcode
4929 $wgSearchForwardUrl = null;
4932 * Search form behavior.
4933 * - true = use Go & Search buttons
4934 * - false = use Go button & Advanced search link
4936 $wgUseTwoButtonsSearchForm = true;
4939 * Array of namespaces to generate a Google sitemap for when the
4940 * maintenance/generateSitemap.php script is run, or false if one is to be
4941 * generated for all namespaces.
4943 $wgSitemapNamespaces = false;
4946 * Custom namespace priorities for sitemaps. Setting this will allow you to
4947 * set custom priorities to namespaces when sitemaps are generated using the
4948 * maintenance/generateSitemap.php script.
4950 * This should be a map of namespace IDs to priority
4951 * @par Example:
4952 * @code
4953 * $wgSitemapNamespacesPriorities = array(
4954 * NS_USER => '0.9',
4955 * NS_HELP => '0.0',
4956 * );
4957 * @endcode
4959 $wgSitemapNamespacesPriorities = false;
4962 * If true, searches for IP addresses will be redirected to that IP's
4963 * contributions page. E.g. searching for "1.2.3.4" will redirect to
4964 * [[Special:Contributions/1.2.3.4]]
4966 $wgEnableSearchContributorsByIP = true;
4968 /** @} */ # end of search settings
4970 /************************************************************************//**
4971 * @name Edit user interface
4972 * @{
4976 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
4977 * fall back to the old behavior (no merging).
4979 $wgDiff3 = '/usr/bin/diff3';
4982 * Path to the GNU diff utility.
4984 $wgDiff = '/usr/bin/diff';
4987 * Which namespaces have special treatment where they should be preview-on-open
4988 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
4989 * can specify namespaces of pages they have special treatment for
4991 $wgPreviewOnOpenNamespaces = array(
4992 NS_CATEGORY => true
4995 /** Go button goes straight to the edit screen if the article doesn't exist. */
4996 $wgGoToEdit = false;
4999 * Enable the UniversalEditButton for browsers that support it
5000 * (currently only Firefox with an extension)
5001 * See http://universaleditbutton.org for more background information
5003 $wgUniversalEditButton = true;
5006 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5007 * will try to automatically create one. This feature can be disabled by set-
5008 * ting this variable false.
5010 $wgUseAutomaticEditSummaries = true;
5012 /** @} */ # end edit UI }
5014 /************************************************************************//**
5015 * @name Maintenance
5016 * See also $wgSiteNotice
5017 * @{
5021 * @cond file_level_code
5022 * Set $wgCommandLineMode if it's not set already, to avoid notices
5024 if ( !isset( $wgCommandLineMode ) ) {
5025 $wgCommandLineMode = false;
5027 /** @endcond */
5029 /** For colorized maintenance script output, is your terminal background dark ? */
5030 $wgCommandLineDarkBg = false;
5033 * Array for extensions to register their maintenance scripts with the
5034 * system. The key is the name of the class and the value is the full
5035 * path to the file
5037 $wgMaintenanceScripts = array();
5040 * Set this to a string to put the wiki into read-only mode. The text will be
5041 * used as an explanation to users.
5043 * This prevents most write operations via the web interface. Cache updates may
5044 * still be possible. To prevent database writes completely, use the read_only
5045 * option in MySQL.
5047 $wgReadOnly = null;
5050 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5051 * Its contents will be shown to users as part of the read-only warning
5052 * message.
5054 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5056 $wgReadOnlyFile = false;
5059 * When you run the web-based upgrade utility, it will tell you what to set
5060 * this to in order to authorize the upgrade process. It will subsequently be
5061 * used as a password, to authorize further upgrades.
5063 * For security, do not set this to a guessable string. Use the value supplied
5064 * by the install/upgrade process. To cause the upgrader to generate a new key,
5065 * delete the old key from LocalSettings.php.
5067 $wgUpgradeKey = false;
5070 * Fully specified path to git binary
5072 $wgGitBin = '/usr/bin/git';
5075 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5077 * Key is a pattern passed to preg_match() and preg_replace(),
5078 * without the delimiters (which are #) and must match the whole URL.
5079 * The value is the replacement for the key (it can contain $1, etc.)
5080 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5081 * full SHA-1 of the HEAD revision.
5082 * %r will be replaced with a URL-encoded version of $1.
5084 * @since 1.20
5086 $wgGitRepositoryViewers = array(
5087 'https://gerrit.wikimedia.org/r/p/(.*)' => 'https://git.wikimedia.org/commit/%r/%H',
5088 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' => 'https://git.wikimedia.org/commit/%r/%H',
5091 /** @} */ # End of maintenance }
5093 /************************************************************************//**
5094 * @name Recent changes, new pages, watchlist and history
5095 * @{
5099 * Recentchanges items are periodically purged; entries older than this many
5100 * seconds will go.
5101 * Default: 13 weeks = about three months
5103 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5106 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5107 * higher than what will be stored. Note that this is disabled by default
5108 * because we sometimes do have RC data which is beyond the limit for some
5109 * reason, and some users may use the high numbers to display that data which
5110 * is still there.
5112 $wgRCFilterByAge = false;
5115 * List of Days and Limits options to list in the Special:Recentchanges and
5116 * Special:Recentchangeslinked pages.
5118 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5119 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5122 * Send recent changes updates via UDP. The updates will be formatted for IRC.
5123 * Set this to the IP address of the receiver.
5125 $wgRC2UDPAddress = false;
5128 * Port number for RC updates
5130 $wgRC2UDPPort = false;
5133 * Prefix to prepend to each UDP packet.
5134 * This can be used to identify the wiki. A script is available called
5135 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
5136 * tab to identify the IRC channel to send the log line to.
5138 $wgRC2UDPPrefix = '';
5141 * If this is set to true, $wgLocalInterwiki will be prepended to links in the
5142 * IRC feed. If this is set to a string, that string will be used as the prefix.
5144 $wgRC2UDPInterwikiPrefix = false;
5147 * Set to true to omit "bot" edits (by users with the bot permission) from the
5148 * UDP feed.
5150 $wgRC2UDPOmitBots = false;
5153 * Enable user search in Special:Newpages
5154 * This is really a temporary hack around an index install bug on some Wikipedias.
5155 * Kill it once fixed.
5157 $wgEnableNewpagesUserFilter = true;
5159 /** Use RC Patrolling to check for vandalism */
5160 $wgUseRCPatrol = true;
5162 /** Use new page patrolling to check new pages on Special:Newpages */
5163 $wgUseNPPatrol = true;
5165 /** Log autopatrol actions to the log table */
5166 $wgLogAutopatrol = true;
5168 /** Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages */
5169 $wgFeed = true;
5171 /** Set maximum number of results to return in syndication feeds (RSS, Atom) for
5172 * eg Recentchanges, Newpages. */
5173 $wgFeedLimit = 50;
5175 /** _Minimum_ timeout for cached Recentchanges feed, in seconds.
5176 * A cached version will continue to be served out even if changes
5177 * are made, until this many seconds runs out since the last render.
5179 * If set to 0, feed caching is disabled. Use this for debugging only;
5180 * feed generation can be pretty slow with diffs.
5182 $wgFeedCacheTimeout = 60;
5184 /** When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5185 * pages larger than this size. */
5186 $wgFeedDiffCutoff = 32768;
5188 /** Override the site's default RSS/ATOM feed for recentchanges that appears on
5189 * every page. Some sites might have a different feed they'd like to promote
5190 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5191 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5192 * as value.
5193 * @par Example:
5194 * Configure the 'atom' feed to http://example.com/somefeed.xml
5195 * @code
5196 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5197 * @endcode
5199 $wgOverrideSiteFeed = array();
5202 * Available feeds objects.
5203 * Should probably only be defined when a page is syndicated ie when
5204 * $wgOut->isSyndicated() is true.
5206 $wgFeedClasses = array(
5207 'rss' => 'RSSFeed',
5208 'atom' => 'AtomFeed',
5212 * Which feed types should we provide by default? This can include 'rss',
5213 * 'atom', neither, or both.
5215 $wgAdvertisedFeedTypes = array( 'atom' );
5217 /** Show watching users in recent changes, watchlist and page history views */
5218 $wgRCShowWatchingUsers = false; # UPO
5219 /** Show watching users in Page views */
5220 $wgPageShowWatchingUsers = false;
5221 /** Show the amount of changed characters in recent changes */
5222 $wgRCShowChangedSize = true;
5225 * If the difference between the character counts of the text
5226 * before and after the edit is below that value, the value will be
5227 * highlighted on the RC page.
5229 $wgRCChangedSizeThreshold = 500;
5232 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5233 * view for watched pages with new changes */
5234 $wgShowUpdatedMarker = true;
5237 * Disable links to talk pages of anonymous users (IPs) in listings on special
5238 * pages like page history, Special:Recentchanges, etc.
5240 $wgDisableAnonTalk = false;
5243 * Enable filtering of categories in Recentchanges
5245 $wgAllowCategorizedRecentChanges = false;
5248 * Allow filtering by change tag in recentchanges, history, etc
5249 * Has no effect if no tags are defined in valid_tag.
5251 $wgUseTagFilter = true;
5254 * If set to an integer, pages that are watched by this many users or more
5255 * will not require the unwatchedpages permission to view the number of
5256 * watchers.
5258 * @since 1.21
5260 $wgUnwatchedPageThreshold = false;
5263 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5264 * certain types of edits.
5266 * To register a new one:
5267 * @code
5268 * $wgRecentChangesFlags['flag'] => array(
5269 * 'letter' => 'letter-msg',
5270 * 'title' => 'tooltip-msg'
5271 * );
5272 * @endcode
5274 * Optional 'class' allows to set a css class different than the flag name.
5276 * @since 1.22
5278 $wgRecentChangesFlags = array(
5279 'newpage' => array( 'letter' => 'newpageletter',
5280 'title' => 'recentchanges-label-newpage' ),
5281 'minor' => array( 'letter' => 'minoreditletter',
5282 'title' => 'recentchanges-label-minor', 'class' => 'minoredit' ),
5283 'bot' => array( 'letter' => 'boteditletter',
5284 'title' => 'recentchanges-label-bot', 'class' => 'botedit' ),
5285 'unpatrolled' => array( 'letter' => 'unpatrolledletter',
5286 'title' => 'recentchanges-label-unpatrolled' ),
5289 /** @} */ # end RC/watchlist }
5291 /************************************************************************//**
5292 * @name Copyright and credits settings
5293 * @{
5297 * Override for copyright metadata.
5299 * This is the name of the page containing information about the wiki's copyright status,
5300 * which will be added as a link in the footer if it is specified. It overrides
5301 * $wgRightsUrl if both are specified.
5303 $wgRightsPage = null;
5306 * Set this to specify an external URL containing details about the content license used on your wiki.
5307 * If $wgRightsPage is set then this setting is ignored.
5309 $wgRightsUrl = null;
5312 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link.
5313 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name of the
5314 * page will also be used as the link if this variable is not set.
5316 $wgRightsText = null;
5319 * Override for copyright metadata.
5321 $wgRightsIcon = null;
5324 * Set to an array of metadata terms. Else they will be loaded based on $wgRightsUrl
5326 $wgLicenseTerms = false;
5329 * Set this to some HTML to override the rights icon with an arbitrary logo
5330 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5332 $wgCopyrightIcon = null;
5334 /** Set this to true if you want detailed copyright information forms on Upload. */
5335 $wgUseCopyrightUpload = false;
5338 * Set this to the number of authors that you want to be credited below an
5339 * article text. Set it to zero to hide the attribution block, and a negative
5340 * number (like -1) to show all authors. Note that this will require 2-3 extra
5341 * database hits, which can have a not insignificant impact on performance for
5342 * large wikis.
5344 $wgMaxCredits = 0;
5346 /** If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5347 * Otherwise, link to a separate credits page. */
5348 $wgShowCreditsIfMax = true;
5350 /** @} */ # end of copyright and credits settings }
5352 /************************************************************************//**
5353 * @name Import / Export
5354 * @{
5358 * List of interwiki prefixes for wikis we'll accept as sources for
5359 * Special:Import (for sysops). Since complete page history can be imported,
5360 * these should be 'trusted'.
5362 * If a user has the 'import' permission but not the 'importupload' permission,
5363 * they will only be able to run imports through this transwiki interface.
5365 $wgImportSources = array();
5368 * Optional default target namespace for interwiki imports.
5369 * Can use this to create an incoming "transwiki"-style queue.
5370 * Set to numeric key, not the name.
5372 * Users may override this in the Special:Import dialog.
5374 $wgImportTargetNamespace = null;
5377 * If set to false, disables the full-history option on Special:Export.
5378 * This is currently poorly optimized for long edit histories, so is
5379 * disabled on Wikimedia's sites.
5381 $wgExportAllowHistory = true;
5384 * If set nonzero, Special:Export requests for history of pages with
5385 * more revisions than this will be rejected. On some big sites things
5386 * could get bogged down by very very long pages.
5388 $wgExportMaxHistory = 0;
5391 * Return distinct author list (when not returning full history)
5393 $wgExportAllowListContributors = false;
5396 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
5397 * up to this specified level, which will cause it to include all
5398 * pages linked to from the pages you specify. Since this number
5399 * can become *insanely large* and could easily break your wiki,
5400 * it's disabled by default for now.
5402 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
5403 * crazy-big export from being done by someone setting the depth number too
5404 * high. In other words, last resort safety net.
5406 $wgExportMaxLinkDepth = 0;
5409 * Whether to allow the "export all pages in namespace" option
5411 $wgExportFromNamespaces = false;
5414 * Whether to allow exporting the entire wiki into a single file
5416 $wgExportAllowAll = false;
5418 /** @} */ # end of import/export }
5420 /*************************************************************************//**
5421 * @name Extensions
5422 * @{
5426 * A list of callback functions which are called once MediaWiki is fully
5427 * initialised
5429 $wgExtensionFunctions = array();
5432 * Extension messages files.
5434 * Associative array mapping extension name to the filename where messages can be
5435 * found. The file should contain variable assignments. Any of the variables
5436 * present in languages/messages/MessagesEn.php may be defined, but $messages
5437 * is the most common.
5439 * Variables defined in extensions will override conflicting variables defined
5440 * in the core.
5442 * @par Example:
5443 * @code
5444 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
5445 * @endcode
5447 $wgExtensionMessagesFiles = array();
5450 * Parser output hooks.
5451 * This is an associative array where the key is an extension-defined tag
5452 * (typically the extension name), and the value is a PHP callback.
5453 * These will be called as an OutputPageParserOutput hook, if the relevant
5454 * tag has been registered with the parser output object.
5456 * Registration is done with $pout->addOutputHook( $tag, $data ).
5458 * The callback has the form:
5459 * @code
5460 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
5461 * @endcode
5463 $wgParserOutputHooks = array();
5466 * List of valid skin names.
5467 * The key should be the name in all lower case, the value should be a properly
5468 * cased name for the skin. This value will be prefixed with "Skin" to create the
5469 * class name of the skin to load, and if the skin's class cannot be found through
5470 * the autoloader it will be used to load a .php file by that name in the skins directory.
5471 * The default skins will be added later, by Skin::getSkinNames(). Use
5472 * Skin::getSkinNames() as an accessor if you wish to have access to the full list.
5474 $wgValidSkinNames = array();
5477 * Special page list.
5478 * See the top of SpecialPage.php for documentation.
5480 $wgSpecialPages = array();
5483 * Array mapping class names to filenames, for autoloading.
5485 $wgAutoloadClasses = array();
5488 * An array of extension types and inside that their names, versions, authors,
5489 * urls, descriptions and pointers to localized description msgs. Note that
5490 * the version, url, description and descriptionmsg key can be omitted.
5492 * @code
5493 * $wgExtensionCredits[$type][] = array(
5494 * 'name' => 'Example extension',
5495 * 'version' => 1.9,
5496 * 'path' => __FILE__,
5497 * 'author' => 'Foo Barstein',
5498 * 'url' => 'http://www.example.com/Example%20Extension/',
5499 * 'description' => 'An example extension',
5500 * 'descriptionmsg' => 'exampleextension-desc',
5501 * );
5502 * @endcode
5504 * Where $type is 'specialpage', 'parserhook', 'variable', 'media' or 'other'.
5505 * Where 'descriptionmsg' can be an array with message key and parameters:
5506 * 'descriptionmsg' => array( 'exampleextension-desc', param1, param2, ... ),
5508 * author can be a string or an array of strings. Authors can be linked using
5509 * the regular wikitext link syntax. To have an internationalized version of
5510 * "and others" show, add an element "...". This element can also be linked,
5511 * for instance "[http://example ...]".
5513 $wgExtensionCredits = array();
5516 * Authentication plugin.
5517 * @var $wgAuth AuthPlugin
5519 $wgAuth = null;
5522 * Global list of hooks.
5524 * The key is one of the events made available by MediaWiki, you can find
5525 * a description for most of them in docs/hooks.txt. The array is used
5526 * internally by Hook:run().
5528 * The value can be one of:
5530 * - A function name:
5531 * @code
5532 * $wgHooks['event_name'][] = $function;
5533 * @endcode
5534 * - A function with some data:
5535 * @code
5536 * $wgHooks['event_name'][] = array($function, $data);
5537 * @endcode
5538 * - A an object method:
5539 * @code
5540 * $wgHooks['event_name'][] = array($object, 'method');
5541 * @endcode
5543 * @warning You should always append to an event array or you will end up
5544 * deleting a previous registered hook.
5546 * @todo Does it support PHP closures?
5548 $wgHooks = array();
5551 * Maps jobs to their handling classes; extensions
5552 * can add to this to provide custom jobs
5554 $wgJobClasses = array(
5555 'refreshLinks' => 'RefreshLinksJob',
5556 'refreshLinks2' => 'RefreshLinksJob2',
5557 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
5558 'sendMail' => 'EmaillingJob',
5559 'enotifNotify' => 'EnotifNotifyJob',
5560 'fixDoubleRedirect' => 'DoubleRedirectJob',
5561 'uploadFromUrl' => 'UploadFromUrlJob',
5562 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
5563 'PublishStashedFile' => 'PublishStashedFileJob',
5564 'null' => 'NullJob'
5568 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
5569 * special flags are set. The values here are keys of $wgJobClasses.
5571 * These can be:
5572 * - Very long-running jobs.
5573 * - Jobs that you would never want to run as part of a page rendering request.
5574 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
5575 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
5577 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
5580 * Map of job types to configuration arrays.
5581 * This determines which queue class and storage system is used for each job type.
5582 * Job types that do not have explicit configuration will use the 'default' config.
5583 * These settings should be global to all wikis.
5585 $wgJobTypeConf = array(
5586 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
5590 * Which aggregator to use for tracking which queues have jobs.
5591 * These settings should be global to all wikis.
5593 $wgJobQueueAggregator = array(
5594 'class' => 'JobQueueAggregatorMemc'
5598 * Additional functions to be performed with updateSpecialPages.
5599 * Expensive Querypages are already updated.
5601 $wgSpecialPageCacheUpdates = array(
5602 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
5606 * Hooks that are used for outputting exceptions. Format is:
5607 * $wgExceptionHooks[] = $funcname
5608 * or:
5609 * $wgExceptionHooks[] = array( $class, $funcname )
5610 * Hooks should return strings or false
5612 $wgExceptionHooks = array();
5615 * Page property link table invalidation lists. When a page property
5616 * changes, this may require other link tables to be updated (eg
5617 * adding __HIDDENCAT__ means the hiddencat tracking category will
5618 * have been added, so the categorylinks table needs to be rebuilt).
5619 * This array can be added to by extensions.
5621 $wgPagePropLinkInvalidations = array(
5622 'hiddencat' => 'categorylinks',
5625 /** @} */ # End extensions }
5627 /*************************************************************************//**
5628 * @name Categories
5629 * @{
5633 * Use experimental, DMOZ-like category browser
5635 $wgUseCategoryBrowser = false;
5638 * On category pages, show thumbnail gallery for images belonging to that
5639 * category instead of listing them as articles.
5641 $wgCategoryMagicGallery = true;
5644 * Paging limit for categories
5646 $wgCategoryPagingLimit = 200;
5649 * Specify how category names should be sorted, when listed on a category page.
5650 * A sorting scheme is also known as a collation.
5652 * Available values are:
5654 * - uppercase: Converts the category name to upper case, and sorts by that.
5656 * - identity: Does no conversion. Sorts by binary value of the string.
5658 * - uca-default: Provides access to the Unicode Collation Algorithm with
5659 * the default element table. This is a compromise collation which sorts
5660 * all languages in a mediocre way. However, it is better than "uppercase".
5662 * To use the uca-default collation, you must have PHP's intl extension
5663 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
5664 * resulting collation will depend on the version of ICU installed on the
5665 * server.
5667 * After you change this, you must run maintenance/updateCollation.php to fix
5668 * the sort keys in the database.
5670 * Extensions can define there own collations by subclassing Collation
5671 * and using the Collation::factory hook.
5673 $wgCategoryCollation = 'uppercase';
5675 /** @} */ # End categories }
5677 /*************************************************************************//**
5678 * @name Logging
5679 * @{
5683 * The logging system has two levels: an event type, which describes the
5684 * general category and can be viewed as a named subset of all logs; and
5685 * an action, which is a specific kind of event that can exist in that
5686 * log type.
5688 $wgLogTypes = array(
5690 'block',
5691 'protect',
5692 'rights',
5693 'delete',
5694 'upload',
5695 'move',
5696 'import',
5697 'patrol',
5698 'merge',
5699 'suppress',
5703 * This restricts log access to those who have a certain right
5704 * Users without this will not see it in the option menu and can not view it
5705 * Restricted logs are not added to recent changes
5706 * Logs should remain non-transcludable
5707 * Format: logtype => permissiontype
5709 $wgLogRestrictions = array(
5710 'suppress' => 'suppressionlog'
5714 * Show/hide links on Special:Log will be shown for these log types.
5716 * This is associative array of log type => boolean "hide by default"
5718 * See $wgLogTypes for a list of available log types.
5720 * @par Example:
5721 * @code
5722 * $wgFilterLogTypes = array(
5723 * 'move' => true,
5724 * 'import' => false,
5725 * );
5726 * @endcode
5728 * Will display show/hide links for the move and import logs. Move logs will be
5729 * hidden by default unless the link is clicked. Import logs will be shown by
5730 * default, and hidden when the link is clicked.
5732 * A message of the form log-show-hide-[type] should be added, and will be used
5733 * for the link text.
5735 $wgFilterLogTypes = array(
5736 'patrol' => true
5740 * Lists the message key string for each log type. The localized messages
5741 * will be listed in the user interface.
5743 * Extensions with custom log types may add to this array.
5745 * @since 1.19, if you follow the naming convention log-name-TYPE,
5746 * where TYPE is your log type, yoy don't need to use this array.
5748 $wgLogNames = array(
5749 '' => 'all-logs-page',
5750 'block' => 'blocklogpage',
5751 'protect' => 'protectlogpage',
5752 'rights' => 'rightslog',
5753 'delete' => 'dellogpage',
5754 'upload' => 'uploadlogpage',
5755 'move' => 'movelogpage',
5756 'import' => 'importlogpage',
5757 'patrol' => 'patrol-log-page',
5758 'merge' => 'mergelog',
5759 'suppress' => 'suppressionlog',
5763 * Lists the message key string for descriptive text to be shown at the
5764 * top of each log type.
5766 * Extensions with custom log types may add to this array.
5768 * @since 1.19, if you follow the naming convention log-description-TYPE,
5769 * where TYPE is your log type, yoy don't need to use this array.
5771 $wgLogHeaders = array(
5772 '' => 'alllogstext',
5773 'block' => 'blocklogtext',
5774 'protect' => 'protectlogtext',
5775 'rights' => 'rightslogtext',
5776 'delete' => 'dellogpagetext',
5777 'upload' => 'uploadlogpagetext',
5778 'move' => 'movelogpagetext',
5779 'import' => 'importlogpagetext',
5780 'patrol' => 'patrol-log-header',
5781 'merge' => 'mergelogpagetext',
5782 'suppress' => 'suppressionlogtext',
5786 * Lists the message key string for formatting individual events of each
5787 * type and action when listed in the logs.
5789 * Extensions with custom log types may add to this array.
5791 $wgLogActions = array(
5792 'block/block' => 'blocklogentry',
5793 'block/unblock' => 'unblocklogentry',
5794 'block/reblock' => 'reblock-logentry',
5795 'protect/protect' => 'protectedarticle',
5796 'protect/modify' => 'modifiedarticleprotection',
5797 'protect/unprotect' => 'unprotectedarticle',
5798 'protect/move_prot' => 'movedarticleprotection',
5799 'upload/upload' => 'uploadedimage',
5800 'upload/overwrite' => 'overwroteimage',
5801 'upload/revert' => 'uploadedimage',
5802 'import/upload' => 'import-logentry-upload',
5803 'import/interwiki' => 'import-logentry-interwiki',
5804 'merge/merge' => 'pagemerge-logentry',
5805 'suppress/block' => 'blocklogentry',
5806 'suppress/reblock' => 'reblock-logentry',
5810 * The same as above, but here values are names of functions,
5811 * not messages.
5812 * @see LogPage::actionText
5813 * @see LogFormatter
5815 $wgLogActionsHandlers = array(
5816 'move/move' => 'MoveLogFormatter',
5817 'move/move_redir' => 'MoveLogFormatter',
5818 'delete/delete' => 'DeleteLogFormatter',
5819 'delete/restore' => 'DeleteLogFormatter',
5820 'delete/revision' => 'DeleteLogFormatter',
5821 'delete/event' => 'DeleteLogFormatter',
5822 'suppress/revision' => 'DeleteLogFormatter',
5823 'suppress/event' => 'DeleteLogFormatter',
5824 'suppress/delete' => 'DeleteLogFormatter',
5825 'patrol/patrol' => 'PatrolLogFormatter',
5826 'rights/rights' => 'RightsLogFormatter',
5827 'rights/autopromote' => 'RightsLogFormatter',
5831 * Maintain a log of newusers at Log/newusers?
5833 $wgNewUserLog = true;
5835 /** @} */ # end logging }
5837 /*************************************************************************//**
5838 * @name Special pages (general and miscellaneous)
5839 * @{
5843 * Allow special page inclusions such as {{Special:Allpages}}
5845 $wgAllowSpecialInclusion = true;
5848 * Set this to an array of special page names to prevent
5849 * maintenance/updateSpecialPages.php from updating those pages.
5851 $wgDisableQueryPageUpdate = false;
5854 * List of special pages, followed by what subtitle they should go under
5855 * at Special:SpecialPages
5857 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
5859 $wgSpecialPageGroups = array();
5862 * Whether or not to sort special pages in Special:Specialpages
5864 $wgSortSpecialPages = true;
5867 * On Special:Unusedimages, consider images "used", if they are put
5868 * into a category. Default (false) is not to count those as used.
5870 $wgCountCategorizedImagesAsUsed = false;
5873 * Maximum number of links to a redirect page listed on
5874 * Special:Whatlinkshere/RedirectDestination
5876 $wgMaxRedirectLinksRetrieved = 500;
5878 /** @} */ # end special pages }
5880 /*************************************************************************//**
5881 * @name Actions
5882 * @{
5886 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
5887 * 'foo' => 'ClassName' Load the specified class which subclasses Action
5888 * 'foo' => true Load the class FooAction which subclasses Action
5889 * If something is specified in the getActionOverrides()
5890 * of the relevant Page object it will be used
5891 * instead of the default class.
5892 * 'foo' => false The action is disabled; show an error message
5893 * Unsetting core actions will probably cause things to complain loudly.
5895 $wgActions = array(
5896 'credits' => true,
5897 'delete' => true,
5898 'edit' => true,
5899 'history' => true,
5900 'info' => true,
5901 'markpatrolled' => true,
5902 'protect' => true,
5903 'purge' => true,
5904 'raw' => true,
5905 'render' => true,
5906 'revert' => true,
5907 'revisiondelete' => true,
5908 'rollback' => true,
5909 'submit' => true,
5910 'unprotect' => true,
5911 'unwatch' => true,
5912 'view' => true,
5913 'watch' => true,
5917 * Array of disabled article actions, e.g. view, edit, delete, etc.
5918 * @deprecated since 1.18; just set $wgActions['action'] = false instead
5920 $wgDisabledActions = array();
5922 /** @} */ # end actions }
5924 /*************************************************************************//**
5925 * @name Robot (search engine crawler) policy
5926 * See also $wgNoFollowLinks.
5927 * @{
5931 * Default robot policy. The default policy is to encourage indexing and fol-
5932 * lowing of links. It may be overridden on a per-namespace and/or per-page
5933 * basis.
5935 $wgDefaultRobotPolicy = 'index,follow';
5938 * Robot policies per namespaces. The default policy is given above, the array
5939 * is made of namespace constants as defined in includes/Defines.php. You can-
5940 * not specify a different default policy for NS_SPECIAL: it is always noindex,
5941 * nofollow. This is because a number of special pages (e.g., ListPages) have
5942 * many permutations of options that display the same data under redundant
5943 * URLs, so search engine spiders risk getting lost in a maze of twisty special
5944 * pages, all alike, and never reaching your actual content.
5946 * @par Example:
5947 * @code
5948 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
5949 * @endcode
5951 $wgNamespaceRobotPolicies = array();
5954 * Robot policies per article. These override the per-namespace robot policies.
5955 * Must be in the form of an array where the key part is a properly canonicalised
5956 * text form title and the value is a robot policy.
5958 * @par Example:
5959 * @code
5960 * $wgArticleRobotPolicies = array(
5961 * 'Main Page' => 'noindex,follow',
5962 * 'User:Bob' => 'index,follow',
5963 * );
5964 * @endcode
5966 * @par Example that DOES NOT WORK because the names are not canonical text
5967 * forms:
5968 * @code
5969 * $wgArticleRobotPolicies = array(
5970 * # Underscore, not space!
5971 * 'Main_Page' => 'noindex,follow',
5972 * # "Project", not the actual project name!
5973 * 'Project:X' => 'index,follow',
5974 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
5975 * 'abc' => 'noindex,nofollow'
5976 * );
5977 * @endcode
5979 $wgArticleRobotPolicies = array();
5982 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
5983 * will not function, so users can't decide whether pages in that namespace are
5984 * indexed by search engines. If set to null, default to $wgContentNamespaces.
5986 * @par Example:
5987 * @code
5988 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
5989 * @endcode
5991 $wgExemptFromUserRobotsControl = null;
5993 /** @} */ # End robot policy }
5995 /************************************************************************//**
5996 * @name AJAX and API
5997 * Note: The AJAX entry point which this section refers to is gradually being
5998 * replaced by the API entry point, api.php. They are essentially equivalent.
5999 * Both of them are used for dynamic client-side features, via XHR.
6000 * @{
6004 * Enable the MediaWiki API for convenient access to
6005 * machine-readable data via api.php
6007 * See http://www.mediawiki.org/wiki/API
6009 $wgEnableAPI = true;
6012 * Allow the API to be used to perform write operations
6013 * (page edits, rollback, etc.) when an authorised user
6014 * accesses it
6016 $wgEnableWriteAPI = true;
6020 * WARNING: SECURITY THREAT - debug use only
6022 * Disables many security checks in the API for debugging purposes.
6023 * This flag should never be used on the production servers, as it introduces
6024 * a number of potential security holes. Even when enabled, the validation
6025 * will still be performed, but instead of failing, API will return a warning.
6026 * Also, there will always be a warning notifying that this flag is set.
6027 * At this point, the flag allows GET requests to go through for modules
6028 * requiring POST.
6030 * @since 1.21
6032 $wgDebugAPI = false;
6035 * API module extensions.
6036 * Associative array mapping module name to class name.
6037 * Extension modules may override the core modules.
6038 * @todo Describe each of the variables, group them and add examples
6040 $wgAPIModules = array();
6041 $wgAPIMetaModules = array();
6042 $wgAPIPropModules = array();
6043 $wgAPIListModules = array();
6046 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6047 * @deprecated since 1.21
6049 $wgAPIGeneratorModules = array();
6052 * Maximum amount of rows to scan in a DB query in the API
6053 * The default value is generally fine
6055 $wgAPIMaxDBRows = 5000;
6058 * The maximum size (in bytes) of an API result.
6059 * @warning Do not set this lower than $wgMaxArticleSize*1024
6061 $wgAPIMaxResultSize = 8388608;
6064 * The maximum number of uncached diffs that can be retrieved in one API
6065 * request. Set this to 0 to disable API diffs altogether
6067 $wgAPIMaxUncachedDiffs = 1;
6070 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6071 * API request logging
6073 $wgAPIRequestLog = false;
6076 * Set the timeout for the API help text cache. If set to 0, caching disabled
6078 $wgAPICacheHelpTimeout = 60 * 60;
6081 * The ApiQueryQueryPages module should skip pages that are redundant to true
6082 * API queries.
6084 $wgAPIUselessQueryPages = array(
6085 'MIMEsearch', // aiprop=mime
6086 'LinkSearch', // list=exturlusage
6087 'FileDuplicateSearch', // prop=duplicatefiles
6091 * Enable AJAX framework
6093 $wgUseAjax = true;
6096 * List of Ajax-callable functions.
6097 * Extensions acting as Ajax callbacks must register here
6099 $wgAjaxExportList = array();
6102 * Enable watching/unwatching pages using AJAX.
6103 * Requires $wgUseAjax to be true too.
6105 $wgAjaxWatch = true;
6108 * Enable AJAX check for file overwrite, pre-upload
6110 $wgAjaxUploadDestCheck = true;
6113 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6115 $wgAjaxLicensePreview = true;
6118 * Settings for incoming cross-site AJAX requests:
6119 * Newer browsers support cross-site AJAX when the target resource allows requests
6120 * from the origin domain by the Access-Control-Allow-Origin header.
6121 * This is currently only used by the API (requests to api.php)
6122 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6124 * - '*' matches any number of characters
6125 * - '?' matches any 1 character
6127 * @par Example:
6128 * @code
6129 * $wgCrossSiteAJAXdomains = array(
6130 * 'www.mediawiki.org',
6131 * '*.wikipedia.org',
6132 * '*.wikimedia.org',
6133 * '*.wiktionary.org',
6134 * );
6135 * @endcode
6137 $wgCrossSiteAJAXdomains = array();
6140 * Domains that should not be allowed to make AJAX requests,
6141 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6142 * Uses the same syntax as $wgCrossSiteAJAXdomains
6144 $wgCrossSiteAJAXdomainExceptions = array();
6146 /** @} */ # End AJAX and API }
6148 /************************************************************************//**
6149 * @name Shell and process control
6150 * @{
6154 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6156 $wgMaxShellMemory = 102400;
6159 * Maximum file size created by shell processes under linux, in KB
6160 * ImageMagick convert for example can be fairly hungry for scratch space
6162 $wgMaxShellFileSize = 102400;
6165 * Maximum CPU time in seconds for shell processes under Linux
6167 $wgMaxShellTime = 180;
6170 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6171 * would measure) in seconds for shell processes under Linux
6173 $wgMaxShellWallClockTime = 180;
6176 * Under Linux: a cgroup directory used to constrain memory usage of shell
6177 * commands. The directory must be writable by the user which runs MediaWiki.
6179 * If specified, this is used instead of ulimit, which is inaccurate, and
6180 * causes malloc() to return NULL, which exposes bugs in C applications, making
6181 * them segfault or deadlock.
6183 * A wrapper script will create a cgroup for each shell command that runs, as
6184 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6185 * kernel will send a SIGKILL signal to a process in the subgroup.
6187 * @par Example:
6188 * @code
6189 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6190 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6191 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6192 * @endcode
6194 * The reliability of cgroup cleanup can be improved by installing a
6195 * notify_on_release script in the root cgroup, see e.g.
6196 * https://gerrit.wikimedia.org/r/#/c/40784
6198 $wgShellCgroup = false;
6201 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6203 $wgPhpCli = '/usr/bin/php';
6206 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
6207 * For Unix-like operating systems, set this to to a locale that has a UTF-8
6208 * character set. Only the character set is relevant.
6210 $wgShellLocale = 'en_US.utf8';
6212 /** @} */ # End shell }
6214 /************************************************************************//**
6215 * @name HTTP client
6216 * @{
6220 * Timeout for HTTP requests done internally
6222 $wgHTTPTimeout = 25;
6225 * Timeout for Asynchronous (background) HTTP requests
6227 $wgAsyncHTTPTimeout = 25;
6230 * Proxy to use for CURL requests.
6232 $wgHTTPProxy = false;
6235 * Timeout for connections done internally (in seconds)
6236 * Only works for curl
6238 $wgHTTPConnectTimeout = 5e0;
6240 /** @} */ # End HTTP client }
6242 /************************************************************************//**
6243 * @name Job queue
6244 * See also $wgEnotifUseJobQ.
6245 * @{
6249 * Number of jobs to perform per request. May be less than one in which case
6250 * jobs are performed probabalistically. If this is zero, jobs will not be done
6251 * during ordinary apache requests. In this case, maintenance/runJobs.php should
6252 * be run periodically.
6254 $wgJobRunRate = 1;
6257 * Number of rows to update per job
6259 $wgUpdateRowsPerJob = 500;
6262 * Number of rows to update per query
6264 $wgUpdateRowsPerQuery = 100;
6267 * Do not purge all the pages that use a page when it is edited
6268 * if there are more than this many such pages. This is used to
6269 * avoid invalidating a large portion of the squid/parser cache.
6271 * This setting should factor in any squid/parser cache expiry settings.
6273 $wgMaxBacklinksInvalidate = false;
6275 /** @} */ # End job queue }
6277 /************************************************************************//**
6278 * @name Miscellaneous
6279 * @{
6282 /** Name of the external diff engine to use */
6283 $wgExternalDiffEngine = false;
6286 * Disable redirects to special pages and interwiki redirects, which use a 302
6287 * and have no "redirected from" link.
6289 * @note This is only for articles with #REDIRECT in them. URL's containing a
6290 * local interwiki prefix (or a non-canonical special page name) are still hard
6291 * redirected regardless of this setting.
6293 $wgDisableHardRedirects = false;
6296 * LinkHolderArray batch size
6297 * For debugging
6299 $wgLinkHolderBatchSize = 1000;
6302 * By default MediaWiki does not register links pointing to same server in
6303 * externallinks dataset, use this value to override:
6305 $wgRegisterInternalExternals = false;
6308 * Maximum number of pages to move at once when moving subpages with a page.
6310 $wgMaximumMovedPages = 100;
6313 * Fix double redirects after a page move.
6314 * Tends to conflict with page move vandalism, use only on a private wiki.
6316 $wgFixDoubleRedirects = false;
6319 * Allow redirection to another page when a user logs in.
6320 * To enable, set to a string like 'Main Page'
6322 $wgRedirectOnLogin = null;
6325 * Configuration for processing pool control, for use in high-traffic wikis.
6326 * An implementation is provided in the PoolCounter extension.
6328 * This configuration array maps pool types to an associative array. The only
6329 * defined key in the associative array is "class", which gives the class name.
6330 * The remaining elements are passed through to the class as constructor
6331 * parameters.
6333 * @par Example:
6334 * @code
6335 * $wgPoolCounterConf = array( 'ArticleView' => array(
6336 * 'class' => 'PoolCounter_Client',
6337 * 'timeout' => 15, // wait timeout in seconds
6338 * 'workers' => 5, // maximum number of active threads in each pool
6339 * 'maxqueue' => 50, // maximum number of total threads in each pool
6340 * ... any extension-specific options...
6341 * );
6342 * @endcode
6344 $wgPoolCounterConf = null;
6347 * To disable file delete/restore temporarily
6349 $wgUploadMaintenance = false;
6352 * Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by
6353 * default (use the CONTENT_MODEL_XXX constants). If no special content type is defined for a given namespace,
6354 * pages in that namespace will use the CONTENT_MODEL_WIKITEXT (except for the special case of JS and CS pages).
6356 * @since 1.21
6358 $wgNamespaceContentModels = array();
6361 * How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText():
6363 * * 'ignore': return null
6364 * * 'fail': throw an MWException
6365 * * 'serialize': serialize to default format
6367 * @since 1.21
6369 $wgContentHandlerTextFallback = 'ignore';
6372 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
6373 * This way, the ContentHandler facility can be used without any additional information in the database.
6374 * A page's content model is then derived solely from the page's title. This however means that changing
6375 * a page's default model (e.g. using $wgNamespaceContentModels) will break the page and/or make the content
6376 * inaccessible. This also means that pages can not be moved to a title that would default to a different
6377 * content model.
6379 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content handling
6380 * is less robust and less flexible.
6382 * @since 1.21
6384 $wgContentHandlerUseDB = true;
6387 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
6388 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
6389 * the effect on the database they would have on a wikitext page.
6391 * @todo On the long run, it would be nice to put categories etc into a separate structure,
6392 * or at least parse only the contents of comments in the scripts.
6394 * @since 1.21
6396 $wgTextModelsToParse = array(
6397 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
6398 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
6399 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
6403 * Whether the user must enter their password to change their e-mail address
6405 * @since 1.20
6407 $wgRequirePasswordforEmailChange = true;
6410 * Register handlers for specific types of sites.
6412 * @since 1.20
6414 $wgSiteTypes = array(
6415 'mediawiki' => 'MediaWikiSite',
6419 * Formerly a list of files for HipHop compilation
6420 * @deprecated since 1.22
6422 $wgCompiledFiles = array();
6425 * For really cool vim folding this needs to be at the end:
6426 * vim: foldmarker=@{,@} foldmethod=marker
6427 * @}