Reset RequestContext between tests
[mediawiki.git] / includes / DefaultSettings.php
blob5d098695f9785c3f936f9e8514f74888671e1cd7
1 <?php
2 /**
3 * Default values for MediaWiki configuration settings.
6 * NEVER EDIT THIS FILE
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
38 * @file
41 /**
42 * @defgroup Globalsettings Global settings
45 /**
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
52 die( 1 );
55 /**
56 * wgConf hold the site configuration.
57 * Not used for much in a default install.
58 * @since 1.5
60 $wgConf = new SiteConfiguration;
62 /**
63 * Registry of factory functions to create config objects:
64 * The 'main' key must be set, and the value should be a valid
65 * callable.
66 * @since 1.23
68 $wgConfigRegistry = array(
69 'main' => 'GlobalVarConfig::newInstance'
72 /**
73 * MediaWiki version number
74 * @since 1.2
76 $wgVersion = '1.24alpha';
78 /**
79 * Name of the site. It must be changed in LocalSettings.php
81 $wgSitename = 'MediaWiki';
83 /**
84 * URL of the server.
86 * @par Example:
87 * @code
88 * $wgServer = 'http://example.com';
89 * @endcode
91 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
92 * wrong server, it will redirect incorrectly after you save a page. In that
93 * case, set this variable to fix it.
95 * If you want to use protocol-relative URLs on your wiki, set this to a
96 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
97 * to a fully qualified URL.
99 $wgServer = WebRequest::detectServer();
102 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
103 * Must be fully qualified, even if $wgServer is protocol-relative.
105 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
106 * @since 1.18
108 $wgCanonicalServer = false;
111 * Server name. This is automatically computed by parsing the bare
112 * hostname out of $wgCanonicalServer. It should not be customized.
113 * @since 1.24
115 $wgServerName = false;
117 /************************************************************************//**
118 * @name Script path settings
119 * @{
123 * The path we should point to.
124 * It might be a virtual path in case with use apache mod_rewrite for example.
126 * This *needs* to be set correctly.
128 * Other paths will be set to defaults based on it unless they are directly
129 * set in LocalSettings.php
131 $wgScriptPath = '/wiki';
134 * Whether to support URLs like index.php/Page_title These often break when PHP
135 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
136 * but then again it may not; lighttpd converts incoming path data to lowercase
137 * on systems with case-insensitive filesystems, and there have been reports of
138 * problems on Apache as well.
140 * To be safe we'll continue to keep it off by default.
142 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
143 * incorrect garbage, or to true if it is really correct.
145 * The default $wgArticlePath will be set based on this value at runtime, but if
146 * you have customized it, having this incorrectly set to true can cause
147 * redirect loops when "pretty URLs" are used.
148 * @since 1.2.1
150 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
151 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
152 ( strpos( PHP_SAPI, 'isapi' ) === false );
155 * The extension to append to script names by default. This can either be .php
156 * or .php5.
158 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
159 * variable is provided to support those providers.
160 * @since 1.11
162 $wgScriptExtension = '.php';
164 /**@}*/
166 /************************************************************************//**
167 * @name URLs and file paths
169 * These various web and file path variables are set to their defaults
170 * in Setup.php if they are not explicitly set from LocalSettings.php.
172 * These will relatively rarely need to be set manually, unless you are
173 * splitting style sheets or images outside the main document root.
175 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
176 * the host part, that starts with a slash. In most cases a full URL is also
177 * acceptable. A "directory" is a local file path.
179 * In both paths and directories, trailing slashes should not be included.
181 * @{
185 * The URL path to index.php.
187 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
189 $wgScript = false;
192 * The URL path to load.php.
194 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
195 * @since 1.17
197 $wgLoadScript = false;
200 * The URL path of the skins directory.
201 * Defaults to "{$wgScriptPath}/skins".
202 * @since 1.3
204 $wgStylePath = false;
205 $wgStyleSheetPath = &$wgStylePath;
208 * The URL path of the skins directory. Should not point to an external domain.
209 * Defaults to "{$wgScriptPath}/skins".
210 * @since 1.17
212 $wgLocalStylePath = false;
215 * The URL path of the extensions directory.
216 * Defaults to "{$wgScriptPath}/extensions".
217 * @since 1.16
219 $wgExtensionAssetsPath = false;
222 * Filesystem stylesheets directory.
223 * Defaults to "{$IP}/skins".
224 * @since 1.3
226 $wgStyleDirectory = false;
229 * The URL path for primary article page views. This path should contain $1,
230 * which is replaced by the article title.
232 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
233 * depending on $wgUsePathInfo.
235 $wgArticlePath = false;
238 * The URL path for the images directory.
239 * Defaults to "{$wgScriptPath}/images".
241 $wgUploadPath = false;
244 * The filesystem path of the images directory. Defaults to "{$IP}/images".
246 $wgUploadDirectory = false;
249 * Directory where the cached page will be saved.
250 * Defaults to "{$wgUploadDirectory}/cache".
252 $wgFileCacheDirectory = false;
255 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
256 * Defaults to "{$wgStylePath}/common/images/wiki.png".
258 $wgLogo = false;
261 * The URL path of the shortcut icon.
262 * @since 1.6
264 $wgFavicon = '/favicon.ico';
267 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
268 * Defaults to no icon.
269 * @since 1.12
271 $wgAppleTouchIcon = false;
274 * The local filesystem path to a temporary directory. This is not required to
275 * be web accessible.
277 * When this setting is set to false, its value will be set through a call
278 * to wfTempDir(). See that methods implementation for the actual detection
279 * logic.
281 * Developers should use the global function wfTempDir() instead of this
282 * variable.
284 * @see wfTempDir()
285 * @note Default changed to false in MediaWiki 1.20.
287 $wgTmpDirectory = false;
290 * If set, this URL is added to the start of $wgUploadPath to form a complete
291 * upload URL.
292 * @since 1.4
294 $wgUploadBaseUrl = '';
297 * To enable remote on-demand scaling, set this to the thumbnail base URL.
298 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
299 * where 'e6' are the first two characters of the MD5 hash of the file name.
300 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
301 * @since 1.17
303 $wgUploadStashScalerBaseUrl = false;
306 * To set 'pretty' URL paths for actions other than
307 * plain page views, add to this array.
309 * @par Example:
310 * Set pretty URL for the edit action:
311 * @code
312 * 'edit' => "$wgScriptPath/edit/$1"
313 * @endcode
315 * There must be an appropriate script or rewrite rule in place to handle these
316 * URLs.
317 * @since 1.5
319 $wgActionPaths = array();
321 /**@}*/
323 /************************************************************************//**
324 * @name Files and file uploads
325 * @{
329 * Uploads have to be specially set up to be secure
331 $wgEnableUploads = false;
334 * The maximum age of temporary (incomplete) uploaded files
336 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
339 * Allows to move images and other media files
341 $wgAllowImageMoving = true;
344 * Enable deferred upload tasks that use the job queue.
345 * Only enable this if job runners are set up for both the
346 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
348 * @note If you use suhosin, this setting is incompatible with
349 * suhosin.session.encrypt.
351 $wgEnableAsyncUploads = false;
354 * These are additional characters that should be replaced with '-' in filenames
356 $wgIllegalFileChars = ":";
359 * @deprecated since 1.17 use $wgDeletedDirectory
361 $wgFileStore = array();
364 * What directory to place deleted uploads in.
365 * Defaults to "{$wgUploadDirectory}/deleted".
367 $wgDeletedDirectory = false;
370 * Set this to true if you use img_auth and want the user to see details on why access failed.
372 $wgImgAuthDetails = false;
375 * Map of relative URL directories to match to internal mwstore:// base storage paths.
376 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
377 * if starts with any of the prefixes defined here. The prefixes should not overlap.
378 * The prefix that matches has a corresponding storage path, which the rest of the URL
379 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
381 * Example:
382 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
383 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
384 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
386 * @see $wgFileBackends
388 $wgImgAuthUrlPathMap = array();
391 * File repository structures
393 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
394 * an array of such structures. Each repository structure is an associative
395 * array of properties configuring the repository.
397 * Properties required for all repos:
398 * - class The class name for the repository. May come from the core or an extension.
399 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
400 * FSRepo is also supported for backwards compatibility.
402 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
403 * The name should consist of alpha-numeric characters.
404 * - backend A file backend name (see $wgFileBackends).
406 * For most core repos:
407 * - zones Associative array of zone names that each map to an array with:
408 * container : backend container name the zone is in
409 * directory : root path within container for the zone
410 * url : base URL to the root of the zone
411 * urlsByExt : map of file extension types to base URLs
412 * (useful for using a different cache for videos)
413 * Zones default to using "<repo name>-<zone name>" as the container name
414 * and default to using the container root as the zone's root directory.
415 * Nesting of zone locations within other zones should be avoided.
416 * - url Public zone URL. The 'zones' settings take precedence.
417 * - hashLevels The number of directory levels for hash-based division of files
418 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
419 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
420 * handler instead.
421 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
422 * determines whether filenames implicitly start with a capital letter.
423 * The current implementation may give incorrect description page links
424 * when the local $wgCapitalLinks and initialCapital are mismatched.
425 * - pathDisclosureProtection
426 * May be 'paranoid' to remove all parameters from error messages, 'none' to
427 * leave the paths in unchanged, or 'simple' to replace paths with
428 * placeholders. Default for LocalRepo is 'simple'.
429 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
430 * is 0644.
431 * - directory The local filesystem directory where public files are stored. Not used for
432 * some remote repos.
433 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
434 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
435 * - isPrivate Set this if measures should always be taken to keep the files private.
436 * One should not trust this to assure that the files are not web readable;
437 * the server configuration should be done manually depending on the backend.
439 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
440 * for local repositories:
441 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
442 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
443 * http://en.wikipedia.org/w
444 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
445 * $wgScriptExtension, e.g. .php5 defaults to .php
447 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
448 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
449 * $wgFetchCommonsDescriptions.
450 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
451 * Short thumbnail names only have the width, parameters, and the extension.
453 * ForeignDBRepo:
454 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
455 * equivalent to the corresponding member of $wgDBservers
456 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
457 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
459 * ForeignAPIRepo:
460 * - apibase Use for the foreign API's URL
461 * - apiThumbCacheExpiry How long to locally cache thumbs for
463 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
464 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
465 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
466 * If you set $wgForeignFileRepos to an array of repository structures, those will
467 * be searched after the local file repo.
468 * Otherwise, you will only have access to local media files.
470 * @see Setup.php for an example usage and default initialization.
472 $wgLocalFileRepo = false;
475 * @see $wgLocalFileRepo
477 $wgForeignFileRepos = array();
480 * Use Commons as a remote file repository. Essentially a wrapper, when this
481 * is enabled $wgForeignFileRepos will point at Commons with a set of default
482 * settings
484 $wgUseInstantCommons = false;
487 * File backend structure configuration.
489 * This is an array of file backend configuration arrays.
490 * Each backend configuration has the following parameters:
491 * - 'name' : A unique name for the backend
492 * - 'class' : The file backend class to use
493 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
494 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
496 * See FileBackend::__construct() for more details.
497 * Additional parameters are specific to the file backend class used.
498 * These settings should be global to all wikis when possible.
500 * There are two particularly important aspects about each backend:
501 * - a) Whether it is fully qualified or wiki-relative.
502 * By default, the paths of files are relative to the current wiki,
503 * which works via prefixing them with the current wiki ID when accessed.
504 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
505 * all paths with the specified value instead. This can be useful if
506 * multiple wikis need to share the same data. Note that 'name' is *not*
507 * part of any prefix and thus should not be relied upon for namespacing.
508 * - b) Whether it is only defined for some wikis or is defined on all
509 * wikis in the wiki farm. Defining a backend globally is useful
510 * if multiple wikis need to share the same data.
511 * One should be aware of these aspects when configuring a backend for use with
512 * any basic feature or plugin. For example, suppose an extension stores data for
513 * different wikis in different directories and sometimes needs to access data from
514 * a foreign wiki's directory in order to render a page on given wiki. The extension
515 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
517 $wgFileBackends = array();
520 * Array of configuration arrays for each lock manager.
521 * Each backend configuration has the following parameters:
522 * - 'name' : A unique name for the lock manager
523 * - 'class' : The lock manger class to use
525 * See LockManager::__construct() for more details.
526 * Additional parameters are specific to the lock manager class used.
527 * These settings should be global to all wikis.
529 $wgLockManagers = array();
532 * Show Exif data, on by default if available.
533 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
535 * @note FOR WINDOWS USERS:
536 * To enable Exif functions, add the following lines to the "Windows
537 * extensions" section of php.ini:
538 * @code{.ini}
539 * extension=extensions/php_mbstring.dll
540 * extension=extensions/php_exif.dll
541 * @endcode
543 $wgShowEXIF = function_exists( 'exif_read_data' );
546 * If to automatically update the img_metadata field
547 * if the metadata field is outdated but compatible with the current version.
548 * Defaults to false.
550 $wgUpdateCompatibleMetadata = false;
553 * If you operate multiple wikis, you can define a shared upload path here.
554 * Uploads to this wiki will NOT be put there - they will be put into
555 * $wgUploadDirectory.
556 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
557 * no file of the given name is found in the local repository (for [[File:..]],
558 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
559 * directory.
561 * Note that these configuration settings can now be defined on a per-
562 * repository basis for an arbitrary number of file repositories, using the
563 * $wgForeignFileRepos variable.
565 $wgUseSharedUploads = false;
568 * Full path on the web server where shared uploads can be found
570 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
573 * Fetch commons image description pages and display them on the local wiki?
575 $wgFetchCommonsDescriptions = false;
578 * Path on the file system where shared uploads can be found.
580 $wgSharedUploadDirectory = "/var/www/wiki3/images";
583 * DB name with metadata about shared directory.
584 * Set this to false if the uploads do not come from a wiki.
586 $wgSharedUploadDBname = false;
589 * Optional table prefix used in database.
591 $wgSharedUploadDBprefix = '';
594 * Cache shared metadata in memcached.
595 * Don't do this if the commons wiki is in a different memcached domain
597 $wgCacheSharedUploads = true;
600 * Allow for upload to be copied from an URL.
601 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
602 * You have to assign the user right 'upload_by_url' to a user group, to use this.
604 $wgAllowCopyUploads = false;
607 * Allow asynchronous copy uploads.
608 * This feature is experimental and broken as of r81612.
610 $wgAllowAsyncCopyUploads = false;
613 * A list of domains copy uploads can come from
615 * @since 1.20
617 $wgCopyUploadsDomains = array();
620 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
621 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
622 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
624 $wgCopyUploadsFromSpecialUpload = false;
627 * Proxy to use for copy upload requests.
628 * @since 1.20
630 $wgCopyUploadProxy = false;
633 * Different timeout for upload by url
634 * This could be useful since when fetching large files, you may want a
635 * timeout longer than the default $wgHTTPTimeout. False means fallback
636 * to default.
638 * @since 1.22
640 $wgCopyUploadTimeout = false;
643 * Different timeout for upload by url when run as a background job
644 * This could be useful since when fetching large files via job queue,
645 * you may want a different timeout, especially because there is no
646 * http request being kept alive.
648 * false means fallback to $wgCopyUploadTimeout.
649 * @since 1.22
651 $wgCopyUploadAsyncTimeout = false;
654 * Max size for uploads, in bytes. If not set to an array, applies to all
655 * uploads. If set to an array, per upload type maximums can be set, using the
656 * file and url keys. If the * key is set this value will be used as maximum
657 * for non-specified types.
659 * @par Example:
660 * @code
661 * $wgMaxUploadSize = array(
662 * '*' => 250 * 1024,
663 * 'url' => 500 * 1024,
664 * );
665 * @endcode
666 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
667 * will have a maximum of 500 kB.
669 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
672 * Point the upload navigation link to an external URL
673 * Useful if you want to use a shared repository by default
674 * without disabling local uploads (use $wgEnableUploads = false for that).
676 * @par Example:
677 * @code
678 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
679 * @endcode
681 $wgUploadNavigationUrl = false;
684 * Point the upload link for missing files to an external URL, as with
685 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
686 * appended to it as appropriate.
688 $wgUploadMissingFileUrl = false;
691 * Give a path here to use thumb.php for thumbnail generation on client
692 * request, instead of generating them on render and outputting a static URL.
693 * This is necessary if some of your apache servers don't have read/write
694 * access to the thumbnail path.
696 * @par Example:
697 * @code
698 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
699 * @endcode
701 $wgThumbnailScriptPath = false;
704 * @see $wgThumbnailScriptPath
706 $wgSharedThumbnailScriptPath = false;
709 * Set this to false if you do not want MediaWiki to divide your images
710 * directory into many subdirectories, for improved performance.
712 * It's almost always good to leave this enabled. In previous versions of
713 * MediaWiki, some users set this to false to allow images to be added to the
714 * wiki by simply copying them into $wgUploadDirectory and then running
715 * maintenance/rebuildImages.php to register them in the database. This is no
716 * longer recommended, use maintenance/importImages.php instead.
718 * @note That this variable may be ignored if $wgLocalFileRepo is set.
719 * @todo Deprecate the setting and ultimately remove it from Core.
721 $wgHashedUploadDirectory = true;
724 * Set the following to false especially if you have a set of files that need to
725 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
726 * directory layout.
728 $wgHashedSharedUploadDirectory = true;
731 * Base URL for a repository wiki. Leave this blank if uploads are just stored
732 * in a shared directory and not meant to be accessible through a separate wiki.
733 * Otherwise the image description pages on the local wiki will link to the
734 * image description page on this wiki.
736 * Please specify the namespace, as in the example below.
738 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
741 * This is the list of preferred extensions for uploading files. Uploading files
742 * with extensions not in this list will trigger a warning.
744 * @warning If you add any OpenOffice or Microsoft Office file formats here,
745 * such as odt or doc, and untrusted users are allowed to upload files, then
746 * your wiki will be vulnerable to cross-site request forgery (CSRF).
748 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
751 * Files with these extensions will never be allowed as uploads.
752 * An array of file extensions to blacklist. You should append to this array
753 * if you want to blacklist additional files.
755 $wgFileBlacklist = array(
756 # HTML may contain cookie-stealing JavaScript and web bugs
757 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
758 # PHP scripts may execute arbitrary code on the server
759 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
760 # Other types that may be interpreted by some servers
761 'shtml', 'jhtml', 'pl', 'py', 'cgi',
762 # May contain harmful executables for Windows victims
763 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
766 * Files with these mime types will never be allowed as uploads
767 * if $wgVerifyMimeType is enabled.
769 $wgMimeTypeBlacklist = array(
770 # HTML may contain cookie-stealing JavaScript and web bugs
771 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
772 # PHP scripts may execute arbitrary code on the server
773 'application/x-php', 'text/x-php',
774 # Other types that may be interpreted by some servers
775 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
776 # Client-side hazards on Internet Explorer
777 'text/scriptlet', 'application/x-msdownload',
778 # Windows metafile, client-side vulnerability on some systems
779 'application/x-msmetafile',
783 * Allow Java archive uploads.
784 * This is not recommended for public wikis since a maliciously-constructed
785 * applet running on the same domain as the wiki can steal the user's cookies.
787 $wgAllowJavaUploads = false;
790 * This is a flag to determine whether or not to check file extensions on upload.
792 * @warning Setting this to false is insecure for public wikis.
794 $wgCheckFileExtensions = true;
797 * If this is turned off, users may override the warning for files not covered
798 * by $wgFileExtensions.
800 * @warning Setting this to false is insecure for public wikis.
802 $wgStrictFileExtensions = true;
805 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
807 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
808 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
810 $wgDisableUploadScriptChecks = false;
813 * Warn if uploaded files are larger than this (in bytes), or false to disable
815 $wgUploadSizeWarning = false;
818 * list of trusted media-types and mime types.
819 * Use the MEDIATYPE_xxx constants to represent media types.
820 * This list is used by File::isSafeFile
822 * Types not listed here will have a warning about unsafe content
823 * displayed on the images description page. It would also be possible
824 * to use this for further restrictions, like disabling direct
825 * [[media:...]] links for non-trusted formats.
827 $wgTrustedMediaFormats = array(
828 MEDIATYPE_BITMAP, //all bitmap formats
829 MEDIATYPE_AUDIO, //all audio formats
830 MEDIATYPE_VIDEO, //all plain video formats
831 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
832 "application/pdf", //PDF files
833 #"application/x-shockwave-flash", //flash/shockwave movie
837 * Plugins for media file type handling.
838 * Each entry in the array maps a MIME type to a class name
840 $wgMediaHandlers = array(
841 'image/jpeg' => 'JpegHandler',
842 'image/png' => 'PNGHandler',
843 'image/gif' => 'GIFHandler',
844 'image/tiff' => 'TiffHandler',
845 'image/x-ms-bmp' => 'BmpHandler',
846 'image/x-bmp' => 'BmpHandler',
847 'image/x-xcf' => 'XCFHandler',
848 'image/svg+xml' => 'SvgHandler', // official
849 'image/svg' => 'SvgHandler', // compat
850 'image/vnd.djvu' => 'DjVuHandler', // official
851 'image/x.djvu' => 'DjVuHandler', // compat
852 'image/x-djvu' => 'DjVuHandler', // compat
856 * Plugins for page content model handling.
857 * Each entry in the array maps a model id to a class name.
859 * @since 1.21
861 $wgContentHandlers = array(
862 // the usual case
863 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
864 // dumb version, no syntax highlighting
865 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
866 // dumb version, no syntax highlighting
867 CONTENT_MODEL_CSS => 'CssContentHandler',
868 // plain text, for use by extensions etc
869 CONTENT_MODEL_TEXT => 'TextContentHandler',
873 * Whether to enable server-side image thumbnailing. If false, images will
874 * always be sent to the client in full resolution, with appropriate width= and
875 * height= attributes on the <img> tag for the client to do its own scaling.
877 $wgUseImageResize = true;
880 * Resizing can be done using PHP's internal image libraries or using
881 * ImageMagick or another third-party converter, e.g. GraphicMagick.
882 * These support more file formats than PHP, which only supports PNG,
883 * GIF, JPG, XBM and WBMP.
885 * Use Image Magick instead of PHP builtin functions.
887 $wgUseImageMagick = false;
890 * The convert command shipped with ImageMagick
892 $wgImageMagickConvertCommand = '/usr/bin/convert';
895 * Sharpening parameter to ImageMagick
897 $wgSharpenParameter = '0x0.4';
900 * Reduction in linear dimensions below which sharpening will be enabled
902 $wgSharpenReductionThreshold = 0.85;
905 * Temporary directory used for ImageMagick. The directory must exist. Leave
906 * this set to false to let ImageMagick decide for itself.
908 $wgImageMagickTempDir = false;
911 * Use another resizing converter, e.g. GraphicMagick
912 * %s will be replaced with the source path, %d with the destination
913 * %w and %h will be replaced with the width and height.
915 * @par Example for GraphicMagick:
916 * @code
917 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
918 * @endcode
920 * Leave as false to skip this.
922 $wgCustomConvertCommand = false;
925 * used for lossless jpeg rotation
927 * @since 1.21
929 $wgJpegTran = '/usr/bin/jpegtran';
932 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
933 * image formats.
935 $wgExiv2Command = '/usr/bin/exiv2';
938 * Scalable Vector Graphics (SVG) may be uploaded as images.
939 * Since SVG support is not yet standard in browsers, it is
940 * necessary to rasterize SVGs to PNG as a fallback format.
942 * An external program is required to perform this conversion.
943 * If set to an array, the first item is a PHP callable and any further items
944 * are passed as parameters after $srcPath, $dstPath, $width, $height
946 $wgSVGConverters = array(
947 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
948 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
949 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
950 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
951 . '$output $input',
952 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
953 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
954 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
958 * Pick a converter defined in $wgSVGConverters
960 $wgSVGConverter = 'ImageMagick';
963 * If not in the executable PATH, specify the SVG converter path.
965 $wgSVGConverterPath = '';
968 * Don't scale a SVG larger than this
970 $wgSVGMaxSize = 2048;
973 * Don't read SVG metadata beyond this point.
974 * Default is 1024*256 bytes
976 $wgSVGMetadataCutoff = 262144;
979 * Disallow <title> element in SVG files.
981 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
982 * browsers which can not perform basic stuff like MIME detection and which are
983 * vulnerable to further idiots uploading crap files as images.
985 * When this directive is on, "<title>" will be allowed in files with an
986 * "image/svg+xml" MIME type. You should leave this disabled if your web server
987 * is misconfigured and doesn't send appropriate MIME types for SVG images.
989 $wgAllowTitlesInSVG = false;
992 * The maximum number of pixels a source image can have if it is to be scaled
993 * down by a scaler that requires the full source image to be decompressed
994 * and stored in decompressed form, before the thumbnail is generated.
996 * This provides a limit on memory usage for the decompression side of the
997 * image scaler. The limit is used when scaling PNGs with any of the
998 * built-in image scalers, such as ImageMagick or GD. It is ignored for
999 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1001 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1002 * 12.5 million pixels or 3500x3500.
1004 $wgMaxImageArea = 1.25e7;
1007 * Force thumbnailing of animated GIFs above this size to a single
1008 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1009 * is checked against the total size of all frames in the animation.
1010 * It probably makes sense to keep this equal to $wgMaxImageArea.
1012 $wgMaxAnimatedGifArea = 1.25e7;
1015 * Browsers don't support TIFF inline generally...
1016 * For inline display, we need to convert to PNG or JPEG.
1017 * Note scaling should work with ImageMagick, but may not with GD scaling.
1019 * @par Example:
1020 * @code
1021 * // PNG is lossless, but inefficient for photos
1022 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1023 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1024 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1025 * @endcode
1027 $wgTiffThumbnailType = false;
1030 * If rendered thumbnail files are older than this timestamp, they
1031 * will be rerendered on demand as if the file didn't already exist.
1032 * Update if there is some need to force thumbs and SVG rasterizations
1033 * to rerender, such as fixes to rendering bugs.
1035 $wgThumbnailEpoch = '20030516000000';
1038 * Certain operations are avoided if there were too many recent failures,
1039 * for example, thumbnail generation. Bump this value to invalidate all
1040 * memory of failed operations and thus allow further attempts to resume.
1041 * This is useful when a cause for the failures has been found and fixed.
1043 $wgAttemptFailureEpoch = 1;
1046 * If set, inline scaled images will still produce "<img>" tags ready for
1047 * output instead of showing an error message.
1049 * This may be useful if errors are transitory, especially if the site
1050 * is configured to automatically render thumbnails on request.
1052 * On the other hand, it may obscure error conditions from debugging.
1053 * Enable the debug log or the 'thumbnail' log group to make sure errors
1054 * are logged to a file for review.
1056 $wgIgnoreImageErrors = false;
1059 * Allow thumbnail rendering on page view. If this is false, a valid
1060 * thumbnail URL is still output, but no file will be created at
1061 * the target location. This may save some time if you have a
1062 * thumb.php or 404 handler set up which is faster than the regular
1063 * webserver(s).
1065 $wgGenerateThumbnailOnParse = true;
1068 * Show thumbnails for old images on the image description page
1070 $wgShowArchiveThumbnails = true;
1073 * If set to true, images that contain certain the exif orientation tag will
1074 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1075 * is available that can rotate.
1077 $wgEnableAutoRotation = null;
1080 * Internal name of virus scanner. This serves as a key to the
1081 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1082 * null, every file uploaded will be scanned for viruses.
1084 $wgAntivirus = null;
1087 * Configuration for different virus scanners. This an associative array of
1088 * associative arrays. It contains one setup array per known scanner type.
1089 * The entry is selected by $wgAntivirus, i.e.
1090 * valid values for $wgAntivirus are the keys defined in this array.
1092 * The configuration array for each scanner contains the following keys:
1093 * "command", "codemap", "messagepattern":
1095 * "command" is the full command to call the virus scanner - %f will be
1096 * replaced with the name of the file to scan. If not present, the filename
1097 * will be appended to the command. Note that this must be overwritten if the
1098 * scanner is not in the system path; in that case, please set
1099 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1100 * path.
1102 * "codemap" is a mapping of exit code to return codes of the detectVirus
1103 * function in SpecialUpload.
1104 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1105 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1106 * is not set.
1107 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1108 * the file to have an unsupported format, which is probably immune to
1109 * viruses. This causes the file to pass.
1110 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1111 * no virus was found.
1112 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1113 * a virus.
1114 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1116 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1117 * output. The relevant part should be matched as group one (\1).
1118 * If not defined or the pattern does not match, the full message is shown to the user.
1120 $wgAntivirusSetup = array(
1122 #setup for clamav
1123 'clamav' => array(
1124 'command' => 'clamscan --no-summary ',
1125 'codemap' => array(
1126 "0" => AV_NO_VIRUS, # no virus
1127 "1" => AV_VIRUS_FOUND, # virus found
1128 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1129 "*" => AV_SCAN_FAILED, # else scan failed
1131 'messagepattern' => '/.*?:(.*)/sim',
1136 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1138 $wgAntivirusRequired = true;
1141 * Determines if the mime type of uploaded files should be checked
1143 $wgVerifyMimeType = true;
1146 * Sets the mime type definition file to use by MimeMagic.php.
1147 * Set to null, to use built-in defaults only.
1148 * example: $wgMimeTypeFile = '/etc/mime.types';
1150 $wgMimeTypeFile = 'includes/mime.types';
1153 * Sets the mime type info file to use by MimeMagic.php.
1154 * Set to null, to use built-in defaults only.
1156 $wgMimeInfoFile = 'includes/mime.info';
1159 * Sets an external mime detector program. The command must print only
1160 * the mime type to standard output.
1161 * The name of the file to process will be appended to the command given here.
1162 * If not set or NULL, mime_content_type will be used if available.
1164 * @par Example:
1165 * @code
1166 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
1167 * @endcode
1169 $wgMimeDetectorCommand = null;
1172 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
1173 * things, because only a few types of images are needed and file extensions
1174 * can be trusted.
1176 $wgTrivialMimeDetection = false;
1179 * Additional XML types we can allow via mime-detection.
1180 * array = ( 'rootElement' => 'associatedMimeType' )
1182 $wgXMLMimeTypes = array(
1183 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1184 'svg' => 'image/svg+xml',
1185 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1186 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1187 'html' => 'text/html', // application/xhtml+xml?
1191 * Limit images on image description pages to a user-selectable limit. In order
1192 * to reduce disk usage, limits can only be selected from a list.
1193 * The user preference is saved as an array offset in the database, by default
1194 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1195 * change it if you alter the array (see bug 8858).
1196 * This is the list of settings the user can choose from:
1198 $wgImageLimits = array(
1199 array( 320, 240 ),
1200 array( 640, 480 ),
1201 array( 800, 600 ),
1202 array( 1024, 768 ),
1203 array( 1280, 1024 )
1207 * Adjust thumbnails on image pages according to a user setting. In order to
1208 * reduce disk usage, the values can only be selected from a list. This is the
1209 * list of settings the user can choose from:
1211 $wgThumbLimits = array(
1212 120,
1213 150,
1214 180,
1215 200,
1216 250,
1221 * Default parameters for the "<gallery>" tag
1223 $wgGalleryOptions = array(
1224 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1225 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1226 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1227 'captionLength' => 25, // Length of caption to truncate (in characters)
1228 'showBytes' => true, // Show the filesize in bytes in categories
1229 'mode' => 'traditional',
1233 * Adjust width of upright images when parameter 'upright' is used
1234 * This allows a nicer look for upright images without the need to fix the width
1235 * by hardcoded px in wiki sourcecode.
1237 $wgThumbUpright = 0.75;
1240 * Default value for chmoding of new directories.
1242 $wgDirectoryMode = 0777;
1245 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1247 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1248 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1249 * images in after loading the original low-resolution versions depending on the reported
1250 * window.devicePixelRatio.
1252 $wgResponsiveImages = true;
1255 * @name DJVU settings
1256 * @{
1260 * Path of the djvudump executable
1261 * Enable this and $wgDjvuRenderer to enable djvu rendering
1262 * example: $wgDjvuDump = 'djvudump';
1264 $wgDjvuDump = null;
1267 * Path of the ddjvu DJVU renderer
1268 * Enable this and $wgDjvuDump to enable djvu rendering
1269 * example: $wgDjvuRenderer = 'ddjvu';
1271 $wgDjvuRenderer = null;
1274 * Path of the djvutxt DJVU text extraction utility
1275 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1276 * example: $wgDjvuTxt = 'djvutxt';
1278 $wgDjvuTxt = null;
1281 * Path of the djvutoxml executable
1282 * This works like djvudump except much, much slower as of version 3.5.
1284 * For now we recommend you use djvudump instead. The djvuxml output is
1285 * probably more stable, so we'll switch back to it as soon as they fix
1286 * the efficiency problem.
1287 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1289 * @par Example:
1290 * @code
1291 * $wgDjvuToXML = 'djvutoxml';
1292 * @endcode
1294 $wgDjvuToXML = null;
1297 * Shell command for the DJVU post processor
1298 * Default: pnmtojpeg, since ddjvu generates ppm output
1299 * Set this to false to output the ppm file directly.
1301 $wgDjvuPostProcessor = 'pnmtojpeg';
1304 * File extension for the DJVU post processor output
1306 $wgDjvuOutputExtension = 'jpg';
1308 /** @} */ # end of DJvu }
1310 /** @} */ # end of file uploads }
1312 /************************************************************************//**
1313 * @name Email settings
1314 * @{
1319 * Site admin email address.
1321 * Defaults to "wikiadmin@{$wgServerName}".
1323 $wgEmergencyContact = false;
1326 * Password reminder email address.
1328 * The address we should use as sender when a user is requesting his password.
1330 * Defaults to "apache@{$wgServerName}".
1332 $wgPasswordSender = false;
1335 * Password reminder name
1337 * @deprecated since 1.23; use the system message 'emailsender' instead.
1339 $wgPasswordSenderName = 'MediaWiki Mail';
1342 * Dummy address which should be accepted during mail send action.
1343 * It might be necessary to adapt the address or to set it equal
1344 * to the $wgEmergencyContact address.
1346 $wgNoReplyAddress = 'reply@not.possible';
1349 * Set to true to enable the e-mail basic features:
1350 * Password reminders, etc. If sending e-mail on your
1351 * server doesn't work, you might want to disable this.
1353 $wgEnableEmail = true;
1356 * Set to true to enable user-to-user e-mail.
1357 * This can potentially be abused, as it's hard to track.
1359 $wgEnableUserEmail = true;
1362 * Set to true to put the sending user's email in a Reply-To header
1363 * instead of From. ($wgEmergencyContact will be used as From.)
1365 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1366 * which can cause problems with SPF validation and leak recipient addresses
1367 * when bounces are sent to the sender.
1369 $wgUserEmailUseReplyTo = false;
1372 * Minimum time, in hours, which must elapse between password reminder
1373 * emails for a given account. This is to prevent abuse by mail flooding.
1375 $wgPasswordReminderResendTime = 24;
1378 * The time, in seconds, when an emailed temporary password expires.
1380 $wgNewPasswordExpiry = 3600 * 24 * 7;
1383 * The time, in seconds, when an email confirmation email expires
1385 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1388 * The number of days that a user's password is good for. After this number of days, the
1389 * user will be asked to reset their password. Set to false to disable password expiration.
1391 $wgPasswordExpirationDays = false;
1394 * If a user's password is expired, the number of seconds when they can still login,
1395 * and cancel their password change, but are sent to the password change form on each login.
1397 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1400 * SMTP Mode.
1402 * For using a direct (authenticated) SMTP server connection.
1403 * Default to false or fill an array :
1405 * @code
1406 * $wgSMTP = array(
1407 * 'host' => 'SMTP domain',
1408 * 'IDHost' => 'domain for MessageID',
1409 * 'port' => '25',
1410 * 'auth' => [true|false],
1411 * 'username' => [SMTP username],
1412 * 'password' => [SMTP password],
1413 * );
1414 * @endcode
1416 $wgSMTP = false;
1419 * Additional email parameters, will be passed as the last argument to mail() call.
1420 * If using safe_mode this has no effect
1422 $wgAdditionalMailParams = null;
1425 * For parts of the system that have been updated to provide HTML email content, send
1426 * both text and HTML parts as the body of the email
1428 $wgAllowHTMLEmail = false;
1431 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1432 * from $wgEmergencyContact
1434 $wgEnotifFromEditor = false;
1436 // TODO move UPO to preferences probably ?
1437 # If set to true, users get a corresponding option in their preferences and can choose to
1438 # enable or disable at their discretion
1439 # If set to false, the corresponding input form on the user preference page is suppressed
1440 # It call this to be a "user-preferences-option (UPO)"
1443 * Require email authentication before sending mail to an email address.
1444 * This is highly recommended. It prevents MediaWiki from being used as an open
1445 * spam relay.
1447 $wgEmailAuthentication = true;
1450 * Allow users to enable email notification ("enotif") on watchlist changes.
1452 $wgEnotifWatchlist = false;
1455 * Allow users to enable email notification ("enotif") when someone edits their
1456 * user talk page.
1458 $wgEnotifUserTalk = false;
1461 * Set the Reply-to address in notifications to the editor's address, if user
1462 * allowed this in the preferences.
1464 $wgEnotifRevealEditorAddress = false;
1467 * Send notification mails on minor edits to watchlist pages. This is enabled
1468 * by default. Does not affect user talk notifications.
1470 $wgEnotifMinorEdits = true;
1473 * Send a generic mail instead of a personalised mail for each user. This
1474 * always uses UTC as the time zone, and doesn't include the username.
1476 * For pages with many users watching, this can significantly reduce mail load.
1477 * Has no effect when using sendmail rather than SMTP.
1479 $wgEnotifImpersonal = false;
1482 * Maximum number of users to mail at once when using impersonal mail. Should
1483 * match the limit on your mail server.
1485 $wgEnotifMaxRecips = 500;
1488 * Send mails via the job queue. This can be useful to reduce the time it
1489 * takes to save a page that a lot of people are watching.
1491 $wgEnotifUseJobQ = false;
1494 * Use real name instead of username in e-mail "from" field.
1496 $wgEnotifUseRealName = false;
1499 * Array of usernames who will be sent a notification email for every change
1500 * which occurs on a wiki. Users will not be notified of their own changes.
1502 $wgUsersNotifiedOnAllChanges = array();
1504 /** @} */ # end of email settings
1506 /************************************************************************//**
1507 * @name Database settings
1508 * @{
1512 * Database host name or IP address
1514 $wgDBserver = 'localhost';
1517 * Database port number (for PostgreSQL)
1519 $wgDBport = 5432;
1522 * Name of the database
1524 $wgDBname = 'my_wiki';
1527 * Database username
1529 $wgDBuser = 'wikiuser';
1532 * Database user's password
1534 $wgDBpassword = '';
1537 * Database type
1539 $wgDBtype = 'mysql';
1542 * Whether to use SSL in DB connection.
1544 $wgDBssl = false;
1547 * Whether to use compression in DB connection.
1549 $wgDBcompress = false;
1552 * Separate username for maintenance tasks. Leave as null to use the default.
1554 $wgDBadminuser = null;
1557 * Separate password for maintenance tasks. Leave as null to use the default.
1559 $wgDBadminpassword = null;
1562 * Search type.
1563 * Leave as null to select the default search engine for the
1564 * selected database type (eg SearchMySQL), or set to a class
1565 * name to override to a custom search engine.
1567 $wgSearchType = null;
1570 * Alternative search types
1571 * Sometimes you want to support multiple search engines for testing. This
1572 * allows users to select their search engine of choice via url parameters
1573 * to Special:Search and the action=search API. If using this, there's no
1574 * need to add $wgSearchType to it, that is handled automatically.
1576 $wgSearchTypeAlternatives = null;
1579 * Table name prefix
1581 $wgDBprefix = '';
1584 * MySQL table options to use during installation or update
1586 $wgDBTableOptions = 'ENGINE=InnoDB';
1589 * SQL Mode - default is turning off all modes, including strict, if set.
1590 * null can be used to skip the setting for performance reasons and assume
1591 * DBA has done his best job.
1592 * String override can be used for some additional fun :-)
1594 $wgSQLMode = '';
1597 * Mediawiki schema
1599 $wgDBmwschema = null;
1602 * To override default SQLite data directory ($docroot/../data)
1604 $wgSQLiteDataDir = '';
1607 * Make all database connections secretly go to localhost. Fool the load balancer
1608 * thinking there is an arbitrarily large cluster of servers to connect to.
1609 * Useful for debugging.
1611 $wgAllDBsAreLocalhost = false;
1614 * Shared database for multiple wikis. Commonly used for storing a user table
1615 * for single sign-on. The server for this database must be the same as for the
1616 * main database.
1618 * For backwards compatibility the shared prefix is set to the same as the local
1619 * prefix, and the user table is listed in the default list of shared tables.
1620 * The user_properties table is also added so that users will continue to have their
1621 * preferences shared (preferences were stored in the user table prior to 1.16)
1623 * $wgSharedTables may be customized with a list of tables to share in the shared
1624 * database. However it is advised to limit what tables you do share as many of
1625 * MediaWiki's tables may have side effects if you try to share them.
1627 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1628 * $wgDBprefix.
1630 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1631 * access remote databases. Using wfGetLB() allows the shared database to
1632 * reside on separate servers to the wiki's own database, with suitable
1633 * configuration of $wgLBFactoryConf.
1635 $wgSharedDB = null;
1638 * @see $wgSharedDB
1640 $wgSharedPrefix = false;
1643 * @see $wgSharedDB
1645 $wgSharedTables = array( 'user', 'user_properties' );
1648 * Database load balancer
1649 * This is a two-dimensional array, an array of server info structures
1650 * Fields are:
1651 * - host: Host name
1652 * - dbname: Default database name
1653 * - user: DB user
1654 * - password: DB password
1655 * - type: "mysql" or "postgres"
1657 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1658 * If this is zero for any given server, no normal query traffic will be
1659 * sent to it. It will be excluded from lag checks in maintenance scripts.
1660 * The only way it can receive traffic is if groupLoads is used.
1662 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1663 * to several groups, the most specific group defined here is used.
1665 * - flags: bit field
1666 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1667 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1668 * - DBO_TRX -- wrap entire request in a transaction
1669 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1670 * - DBO_PERSISTENT -- enables persistent database connections
1671 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1672 * - DBO_COMPRESS -- uses internal compression in database connections,
1673 * if available
1675 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1677 * These and any other user-defined properties will be assigned to the mLBInfo member
1678 * variable of the Database object.
1680 * Leave at false to use the single-server variables above. If you set this
1681 * variable, the single-server variables will generally be ignored (except
1682 * perhaps in some command-line scripts).
1684 * The first server listed in this array (with key 0) will be the master. The
1685 * rest of the servers will be slaves. To prevent writes to your slaves due to
1686 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1687 * slaves in my.cnf. You can set read_only mode at runtime using:
1689 * @code
1690 * SET @@read_only=1;
1691 * @endcode
1693 * Since the effect of writing to a slave is so damaging and difficult to clean
1694 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1695 * our masters, and then set read_only=0 on masters at runtime.
1697 $wgDBservers = false;
1700 * Load balancer factory configuration
1701 * To set up a multi-master wiki farm, set the class here to something that
1702 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1703 * The class identified here is responsible for reading $wgDBservers,
1704 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1706 * The LBFactoryMulti class is provided for this purpose, please see
1707 * includes/db/LBFactoryMulti.php for configuration information.
1709 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1712 * How long to wait for a slave to catch up to the master
1713 * @deprecated since 1.24
1715 $wgMasterWaitTimeout = 10;
1718 * File to log database errors to
1720 $wgDBerrorLog = false;
1723 * Timezone to use in the error log.
1724 * Defaults to the wiki timezone ($wgLocaltimezone).
1726 * A list of usable timezones can found at:
1727 * http://php.net/manual/en/timezones.php
1729 * @par Examples:
1730 * @code
1731 * $wgLocaltimezone = 'UTC';
1732 * $wgLocaltimezone = 'GMT';
1733 * $wgLocaltimezone = 'PST8PDT';
1734 * $wgLocaltimezone = 'Europe/Sweden';
1735 * $wgLocaltimezone = 'CET';
1736 * @endcode
1738 * @since 1.20
1740 $wgDBerrorLogTZ = false;
1743 * Scale load balancer polling time so that under overload conditions, the
1744 * database server receives a SHOW STATUS query at an average interval of this
1745 * many microseconds
1747 $wgDBAvgStatusPoll = 2000;
1750 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1751 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1753 * @warning THIS IS EXPERIMENTAL!
1755 * May break if you're not using the table defs from mysql5/tables.sql.
1756 * May break if you're upgrading an existing wiki if set differently.
1757 * Broken symptoms likely to include incorrect behavior with page titles,
1758 * usernames, comments etc containing non-ASCII characters.
1759 * Might also cause failures on the object cache and other things.
1761 * Even correct usage may cause failures with Unicode supplementary
1762 * characters (those not in the Basic Multilingual Plane) unless MySQL
1763 * has enhanced their Unicode support.
1765 $wgDBmysql5 = false;
1768 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1770 * To use this feature set to true and use a datasource defined as
1771 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1772 * block).
1774 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1775 * Pool) that maintains established sessions and reuses them on new
1776 * connections.
1778 * Not completely tested, but it should fall back on normal connection
1779 * in case the pool is full or the datasource is not configured as
1780 * pooled.
1781 * And the other way around; using oci_pconnect on a non pooled
1782 * datasource should produce a normal connection.
1784 * When it comes to frequent shortlived DB connections like with MW
1785 * Oracle tends to s***. The problem is the driver connects to the
1786 * database reasonably fast, but establishing a session takes time and
1787 * resources. MW does not rely on session state (as it does not use
1788 * features such as package variables) so establishing a valid session
1789 * is in this case an unwanted overhead that just slows things down.
1791 * @warning EXPERIMENTAL!
1794 $wgDBOracleDRCP = false;
1797 * Other wikis on this site, can be administered from a single developer
1798 * account.
1799 * Array numeric key => database name
1801 $wgLocalDatabases = array();
1804 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1805 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1806 * show a more obvious warning.
1808 $wgSlaveLagWarning = 10;
1811 * @see $wgSlaveLagWarning
1813 $wgSlaveLagCritical = 30;
1816 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1818 $wgDBWindowsAuthentication = false;
1820 /**@}*/ # End of DB settings }
1822 /************************************************************************//**
1823 * @name Text storage
1824 * @{
1828 * We can also compress text stored in the 'text' table. If this is set on, new
1829 * revisions will be compressed on page save if zlib support is available. Any
1830 * compressed revisions will be decompressed on load regardless of this setting,
1831 * but will not be readable at all* if zlib support is not available.
1833 $wgCompressRevisions = false;
1836 * External stores allow including content
1837 * from non database sources following URL links.
1839 * Short names of ExternalStore classes may be specified in an array here:
1840 * @code
1841 * $wgExternalStores = array("http","file","custom")...
1842 * @endcode
1844 * CAUTION: Access to database might lead to code execution
1846 $wgExternalStores = array();
1849 * An array of external MySQL servers.
1851 * @par Example:
1852 * Create a cluster named 'cluster1' containing three servers:
1853 * @code
1854 * $wgExternalServers = array(
1855 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1856 * );
1857 * @endcode
1859 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1860 * another class.
1862 $wgExternalServers = array();
1865 * The place to put new revisions, false to put them in the local text table.
1866 * Part of a URL, e.g. DB://cluster1
1868 * Can be an array instead of a single string, to enable data distribution. Keys
1869 * must be consecutive integers, starting at zero.
1871 * @par Example:
1872 * @code
1873 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1874 * @endcode
1876 * @var array
1878 $wgDefaultExternalStore = false;
1881 * Revision text may be cached in $wgMemc to reduce load on external storage
1882 * servers and object extraction overhead for frequently-loaded revisions.
1884 * Set to 0 to disable, or number of seconds before cache expiry.
1886 $wgRevisionCacheExpiry = 0;
1888 /** @} */ # end text storage }
1890 /************************************************************************//**
1891 * @name Performance hacks and limits
1892 * @{
1896 * Disable database-intensive features
1898 $wgMiserMode = false;
1901 * Disable all query pages if miser mode is on, not just some
1903 $wgDisableQueryPages = false;
1906 * Number of rows to cache in 'querycache' table when miser mode is on
1908 $wgQueryCacheLimit = 1000;
1911 * Number of links to a page required before it is deemed "wanted"
1913 $wgWantedPagesThreshold = 1;
1916 * Enable slow parser functions
1918 $wgAllowSlowParserFunctions = false;
1921 * Allow schema updates
1923 $wgAllowSchemaUpdates = true;
1926 * Anti-lock flags - bitfield
1927 * - ALF_NO_LINK_LOCK:
1928 * Don't use locking reads when updating the link table. This is
1929 * necessary for wikis with a high edit rate for performance
1930 * reasons, but may cause link table inconsistency
1932 $wgAntiLockFlags = 0;
1935 * Maximum article size in kilobytes
1937 $wgMaxArticleSize = 2048;
1940 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1941 * raise PHP's memory limit if it's below this amount.
1943 $wgMemoryLimit = "50M";
1945 /** @} */ # end performance hacks }
1947 /************************************************************************//**
1948 * @name Cache settings
1949 * @{
1953 * Directory for caching data in the local filesystem. Should not be accessible
1954 * from the web. Set this to false to not use any local caches.
1956 * Note: if multiple wikis share the same localisation cache directory, they
1957 * must all have the same set of extensions. You can set a directory just for
1958 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1960 $wgCacheDirectory = false;
1963 * Main cache type. This should be a cache with fast access, but it may have
1964 * limited space. By default, it is disabled, since the database is not fast
1965 * enough to make it worthwhile.
1967 * The options are:
1969 * - CACHE_ANYTHING: Use anything, as long as it works
1970 * - CACHE_NONE: Do not cache
1971 * - CACHE_DB: Store cache objects in the DB
1972 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
1973 * - CACHE_ACCEL: APC, XCache or WinCache
1974 * - (other): A string may be used which identifies a cache
1975 * configuration in $wgObjectCaches.
1977 * @see $wgMessageCacheType, $wgParserCacheType
1979 $wgMainCacheType = CACHE_NONE;
1982 * The cache type for storing the contents of the MediaWiki namespace. This
1983 * cache is used for a small amount of data which is expensive to regenerate.
1985 * For available types see $wgMainCacheType.
1987 $wgMessageCacheType = CACHE_ANYTHING;
1990 * The cache type for storing article HTML. This is used to store data which
1991 * is expensive to regenerate, and benefits from having plenty of storage space.
1993 * For available types see $wgMainCacheType.
1995 $wgParserCacheType = CACHE_ANYTHING;
1998 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2000 * For available types see $wgMainCacheType.
2002 $wgSessionCacheType = CACHE_ANYTHING;
2005 * The cache type for storing language conversion tables,
2006 * which are used when parsing certain text and interface messages.
2008 * For available types see $wgMainCacheType.
2010 * @since 1.20
2012 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2015 * Advanced object cache configuration.
2017 * Use this to define the class names and constructor parameters which are used
2018 * for the various cache types. Custom cache types may be defined here and
2019 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2020 * or $wgLanguageConverterCacheType.
2022 * The format is an associative array where the key is a cache identifier, and
2023 * the value is an associative array of parameters. The "class" parameter is the
2024 * class name which will be used. Alternatively, a "factory" parameter may be
2025 * given, giving a callable function which will generate a suitable cache object.
2027 $wgObjectCaches = array(
2028 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2029 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
2031 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2032 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2033 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached' ),
2035 'apc' => array( 'class' => 'APCBagOStuff' ),
2036 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2037 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2038 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2039 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2040 'hash' => array( 'class' => 'HashBagOStuff' ),
2044 * The expiry time for the parser cache, in seconds.
2045 * The default is 86400 (one day).
2047 $wgParserCacheExpireTime = 86400;
2050 * Deprecated alias for $wgSessionsInObjectCache.
2052 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2054 $wgSessionsInMemcached = false;
2057 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2058 * can be useful to improve performance, or to avoid the locking behavior of
2059 * PHP's default session handler, which tends to prevent multiple requests for
2060 * the same user from acting concurrently.
2062 $wgSessionsInObjectCache = false;
2065 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2066 * enabled, in seconds.
2068 $wgObjectCacheSessionExpiry = 3600;
2071 * This is used for setting php's session.save_handler. In practice, you will
2072 * almost never need to change this ever. Other options might be 'user' or
2073 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2074 * useful if you're doing cross-application sessions, see bug 11381)
2076 $wgSessionHandler = null;
2079 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2081 $wgMemCachedDebug = false;
2084 * The list of MemCached servers and port numbers
2086 $wgMemCachedServers = array( '127.0.0.1:11211' );
2089 * Use persistent connections to MemCached, which are shared across multiple
2090 * requests.
2092 $wgMemCachedPersistent = false;
2095 * Read/write timeout for MemCached server communication, in microseconds.
2097 $wgMemCachedTimeout = 500000;
2100 * Set this to true to make a local copy of the message cache, for use in
2101 * addition to memcached. The files will be put in $wgCacheDirectory.
2103 $wgUseLocalMessageCache = false;
2106 * Instead of caching everything, only cache those messages which have
2107 * been customised in the site content language. This means that
2108 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2109 * This option is probably only useful for translatewiki.net.
2111 $wgAdaptiveMessageCache = false;
2114 * Localisation cache configuration. Associative array with keys:
2115 * class: The class to use. May be overridden by extensions.
2117 * store: The location to store cache data. May be 'files', 'db' or
2118 * 'detect'. If set to "files", data will be in CDB files. If set
2119 * to "db", data will be stored to the database. If set to
2120 * "detect", files will be used if $wgCacheDirectory is set,
2121 * otherwise the database will be used.
2123 * storeClass: The class name for the underlying storage. If set to a class
2124 * name, it overrides the "store" setting.
2126 * storeDirectory: If the store class puts its data in files, this is the
2127 * directory it will use. If this is false, $wgCacheDirectory
2128 * will be used.
2130 * manualRecache: Set this to true to disable cache updates on web requests.
2131 * Use maintenance/rebuildLocalisationCache.php instead.
2133 $wgLocalisationCacheConf = array(
2134 'class' => 'LocalisationCache',
2135 'store' => 'detect',
2136 'storeClass' => false,
2137 'storeDirectory' => false,
2138 'manualRecache' => false,
2142 * Allow client-side caching of pages
2144 $wgCachePages = true;
2147 * Set this to current time to invalidate all prior cached pages. Affects both
2148 * client-side and server-side caching.
2149 * You can get the current date on your server by using the command:
2150 * @verbatim
2151 * date +%Y%m%d%H%M%S
2152 * @endverbatim
2154 $wgCacheEpoch = '20030516000000';
2157 * Bump this number when changing the global style sheets and JavaScript.
2159 * It should be appended in the query string of static CSS and JS includes,
2160 * to ensure that client-side caches do not keep obsolete copies of global
2161 * styles.
2163 $wgStyleVersion = '303';
2166 * This will cache static pages for non-logged-in users to reduce
2167 * database traffic on public sites.
2168 * Automatically sets $wgShowIPinHeader = false
2169 * ResourceLoader requests to default language and skins are cached
2170 * as well as single module requests.
2172 $wgUseFileCache = false;
2175 * Depth of the subdirectory hierarchy to be created under
2176 * $wgFileCacheDirectory. The subdirectories will be named based on
2177 * the MD5 hash of the title. A value of 0 means all cache files will
2178 * be put directly into the main file cache directory.
2180 $wgFileCacheDepth = 2;
2183 * Keep parsed pages in a cache (objectcache table or memcached)
2184 * to speed up output of the same page viewed by another user with the
2185 * same options.
2187 * This can provide a significant speedup for medium to large pages,
2188 * so you probably want to keep it on. Extensions that conflict with the
2189 * parser cache should disable the cache on a per-page basis instead.
2191 $wgEnableParserCache = true;
2194 * Append a configured value to the parser cache and the sitenotice key so
2195 * that they can be kept separate for some class of activity.
2197 $wgRenderHashAppend = '';
2200 * If on, the sidebar navigation links are cached for users with the
2201 * current language set. This can save a touch of load on a busy site
2202 * by shaving off extra message lookups.
2204 * However it is also fragile: changing the site configuration, or
2205 * having a variable $wgArticlePath, can produce broken links that
2206 * don't update as expected.
2208 $wgEnableSidebarCache = false;
2211 * Expiry time for the sidebar cache, in seconds
2213 $wgSidebarCacheExpiry = 86400;
2216 * When using the file cache, we can store the cached HTML gzipped to save disk
2217 * space. Pages will then also be served compressed to clients that support it.
2219 * Requires zlib support enabled in PHP.
2221 $wgUseGzip = false;
2224 * Whether MediaWiki should send an ETag header. Seems to cause
2225 * broken behavior with Squid 2.6, see bug 7098.
2227 $wgUseETag = false;
2230 * Clock skew or the one-second resolution of time() can occasionally cause cache
2231 * problems when the user requests two pages within a short period of time. This
2232 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2233 * a grace period.
2235 $wgClockSkewFudge = 5;
2238 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2239 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2240 * was previously done in the default LocalSettings.php file.
2242 * On high-traffic wikis, this should be set to false, to avoid the need to
2243 * check the file modification time, and to avoid the performance impact of
2244 * unnecessary cache invalidations.
2246 $wgInvalidateCacheOnLocalSettingsChange = true;
2248 /** @} */ # end of cache settings
2250 /************************************************************************//**
2251 * @name HTTP proxy (Squid) settings
2253 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2254 * although they are referred to as Squid settings for historical reasons.
2256 * Achieving a high hit ratio with an HTTP proxy requires special
2257 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2258 * more details.
2260 * @{
2264 * Enable/disable Squid.
2265 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2267 $wgUseSquid = false;
2270 * If you run Squid3 with ESI support, enable this (default:false):
2272 $wgUseESI = false;
2275 * Send X-Vary-Options header for better caching (requires patched Squid)
2277 $wgUseXVO = false;
2280 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2281 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2282 * and need to split the cache between HTTP and HTTPS for API requests,
2283 * feed requests and HTTP redirect responses in order to prevent cache
2284 * pollution. This does not affect 'normal' requests to index.php other than
2285 * HTTP redirects.
2287 $wgVaryOnXFP = false;
2290 * Internal server name as known to Squid, if different.
2292 * @par Example:
2293 * @code
2294 * $wgInternalServer = 'http://yourinternal.tld:8000';
2295 * @endcode
2297 $wgInternalServer = false;
2300 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2301 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2302 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2303 * days
2305 $wgSquidMaxage = 18000;
2308 * Default maximum age for raw CSS/JS accesses
2310 $wgForcedRawSMaxage = 300;
2313 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2315 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2316 * headers sent/modified from these proxies when obtaining the remote IP address
2318 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2320 $wgSquidServers = array();
2323 * As above, except these servers aren't purged on page changes; use to set a
2324 * list of trusted proxies, etc. Supports both individual IP addresses and
2325 * CIDR blocks.
2326 * @since 1.23 Supports CIDR ranges
2328 $wgSquidServersNoPurge = array();
2331 * Maximum number of titles to purge in any one client operation
2333 $wgMaxSquidPurgeTitles = 400;
2336 * Whether to use a Host header in purge requests sent to the proxy servers
2337 * configured in $wgSquidServers. Set this to false to support Squid
2338 * configured in forward-proxy mode.
2340 * If this is set to true, a Host header will be sent, and only the path
2341 * component of the URL will appear on the request line, as if the request
2342 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2343 * request. Squid supports this style of request only if reverse-proxy mode
2344 * (http_port ... accel) is enabled.
2346 * If this is set to false, no Host header will be sent, and the absolute URL
2347 * will be sent in the request line, as is the standard for an HTTP proxy
2348 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2349 * by Varnish, but is supported by Squid in either configuration (forward or
2350 * reverse).
2352 * @since 1.21
2354 $wgSquidPurgeUseHostHeader = true;
2357 * Routing configuration for HTCP multicast purging. Add elements here to
2358 * enable HTCP and determine which purges are sent where. If set to an empty
2359 * array, HTCP is disabled.
2361 * Each key in this array is a regular expression to match against the purged
2362 * URL, or an empty string to match all URLs. The purged URL is matched against
2363 * the regexes in the order specified, and the first rule whose regex matches
2364 * is used, all remaining rules will thus be ignored.
2366 * @par Example configuration to send purges for upload.wikimedia.org to one
2367 * multicast group and all other purges to another:
2368 * @code
2369 * $wgHTCPRouting = array(
2370 * '|^https?://upload\.wikimedia\.org|' => array(
2371 * 'host' => '239.128.0.113',
2372 * 'port' => 4827,
2373 * ),
2374 * '' => array(
2375 * 'host' => '239.128.0.112',
2376 * 'port' => 4827,
2377 * ),
2378 * );
2379 * @endcode
2381 * You can also pass an array of hosts to send purges too. This is useful when
2382 * you have several multicast groups or unicast address that should receive a
2383 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2385 * @par Example of sending purges to multiple hosts:
2386 * @code
2387 * $wgHTCPRouting = array(
2388 * '' => array(
2389 * // Purges to text caches using multicast
2390 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2391 * // Purges to a hardcoded list of caches
2392 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2393 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2394 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2395 * ),
2396 * );
2397 * @endcode
2399 * @since 1.22
2401 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2402 * For back compatibility purposes, whenever its array is empty
2403 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2405 * @see $wgHTCPMulticastTTL
2407 $wgHTCPRouting = array();
2410 * @deprecated since 1.22, please use $wgHTCPRouting instead.
2412 * Whenever this is set and $wgHTCPRouting evaluates to false, $wgHTCPRouting
2413 * will be set to this value.
2414 * This is merely for back compatibility.
2416 * @since 1.20
2418 $wgHTCPMulticastRouting = null;
2421 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
2423 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
2424 * present in the earliest Squid implementations of the protocol.
2426 * This setting is DEPRECATED in favor of $wgHTCPRouting , and kept for
2427 * backwards compatibility only. If $wgHTCPRouting is set, this setting is
2428 * ignored. If $wgHTCPRouting is not set and this setting is, it is used to
2429 * populate $wgHTCPRouting.
2431 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2432 * favor of $wgHTCPRouting.
2434 $wgHTCPMulticastAddress = false;
2437 * HTCP multicast port.
2438 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2439 * favor of $wgHTCPRouting.
2441 * @see $wgHTCPMulticastAddress
2443 $wgHTCPPort = 4827;
2446 * HTCP multicast TTL.
2447 * @see $wgHTCPRouting
2449 $wgHTCPMulticastTTL = 1;
2452 * Should forwarded Private IPs be accepted?
2454 $wgUsePrivateIPs = false;
2456 /** @} */ # end of HTTP proxy settings
2458 /************************************************************************//**
2459 * @name Language, regional and character encoding settings
2460 * @{
2464 * Site language code. See languages/Names.php for languages supported by
2465 * MediaWiki out of the box. Not all languages listed there have translations,
2466 * see languages/messages/ for the list of languages with some localisation.
2468 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2469 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2471 * This defines the default interface language for all users, but users can
2472 * change it in their preferences.
2474 * This also defines the language of pages in the wiki. The content is wrapped
2475 * in a html element with lang=XX attribute. This behavior can be overridden
2476 * via hooks, see Title::getPageLanguage.
2478 $wgLanguageCode = 'en';
2481 * Language cache size, or really how many languages can we handle
2482 * simultaneously without degrading to crawl speed.
2484 $wgLangObjCacheSize = 10;
2487 * Some languages need different word forms, usually for different cases.
2488 * Used in Language::convertGrammar().
2490 * @par Example:
2491 * @code
2492 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2493 * @endcode
2495 $wgGrammarForms = array();
2498 * Treat language links as magic connectors, not inline links
2500 $wgInterwikiMagic = true;
2503 * Hide interlanguage links from the sidebar
2505 $wgHideInterlanguageLinks = false;
2508 * List of additional interwiki prefixes that should be treated as
2509 * interlanguage links (i.e. placed in the sidebar).
2510 * Notes:
2511 * - This will not do anything unless the prefixes are defined in the interwiki
2512 * map.
2513 * - The display text for these custom interlanguage links will be fetched from
2514 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2515 * this array.
2516 * - A friendly name for each site, used for tooltip text, may optionally be
2517 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2518 * the prefix in this array.
2520 $wgExtraInterlanguageLinkPrefixes = array();
2523 * List of language names or overrides for default names in Names.php
2525 $wgExtraLanguageNames = array();
2528 * List of language codes that don't correspond to an actual language.
2529 * These codes are mostly left-offs from renames, or other legacy things.
2530 * This array makes them not appear as a selectable language on the installer,
2531 * and excludes them when running the transstat.php script.
2533 $wgDummyLanguageCodes = array(
2534 'als' => 'gsw',
2535 'bat-smg' => 'sgs',
2536 'be-x-old' => 'be-tarask',
2537 'bh' => 'bho',
2538 'fiu-vro' => 'vro',
2539 'no' => 'nb',
2540 'qqq' => 'qqq', # Used for message documentation.
2541 'qqx' => 'qqx', # Used for viewing message keys.
2542 'roa-rup' => 'rup',
2543 'simple' => 'en',
2544 'zh-classical' => 'lzh',
2545 'zh-min-nan' => 'nan',
2546 'zh-yue' => 'yue',
2550 * Character set for use in the article edit box. Language-specific encodings
2551 * may be defined.
2553 * This historic feature is one of the first that was added by former MediaWiki
2554 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2556 $wgEditEncoding = '';
2559 * Set this to true to replace Arabic presentation forms with their standard
2560 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2561 * set to "ar".
2563 * Note that pages with titles containing presentation forms will become
2564 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2566 $wgFixArabicUnicode = true;
2569 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2570 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2571 * set to "ml". Note that some clients (even new clients as of 2010) do not
2572 * support these characters.
2574 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2575 * fix any ZWJ sequences in existing page titles.
2577 $wgFixMalayalamUnicode = true;
2580 * Set this to always convert certain Unicode sequences to modern ones
2581 * regardless of the content language. This has a small performance
2582 * impact.
2584 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2585 * details.
2587 * @since 1.17
2589 $wgAllUnicodeFixes = false;
2592 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2593 * loading old revisions not marked with "utf-8" flag. Use this when
2594 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2595 * burdensome mass conversion of old text data.
2597 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2598 * user names, etc still must be converted en masse in the database before
2599 * continuing as a UTF-8 wiki.
2601 $wgLegacyEncoding = false;
2604 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2605 * regexps : "/regexp/" matching problematic browsers. These browsers will
2606 * be served encoded unicode in the edit box instead of real unicode.
2608 $wgBrowserBlackList = array(
2610 * Netscape 2-4 detection
2611 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2612 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2613 * with a negative assertion. The [UIN] identifier specifies the level of security
2614 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2615 * The language string is unreliable, it is missing on NS4 Mac.
2617 * Reference: http://www.psychedelix.com/agents/index.shtml
2619 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2620 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2621 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2624 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2625 * Þ to <THORN> and Ð to <ETH>
2627 * Known useragents:
2628 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2629 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2630 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2631 * - [...]
2633 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2634 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2636 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2639 * Google wireless transcoder, seems to eat a lot of chars alive
2640 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2642 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2646 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2647 * create stub reference rows in the text table instead of copying
2648 * the full text of all current entries from 'cur' to 'text'.
2650 * This will speed up the conversion step for large sites, but
2651 * requires that the cur table be kept around for those revisions
2652 * to remain viewable.
2654 * This option affects the updaters *only*. Any present cur stub
2655 * revisions will be readable at runtime regardless of this setting.
2657 $wgLegacySchemaConversion = false;
2660 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2661 * the interface is set to English.
2663 $wgAmericanDates = false;
2666 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2667 * numerals in interface.
2669 $wgTranslateNumerals = true;
2672 * Translation using MediaWiki: namespace.
2673 * Interface messages will be loaded from the database.
2675 $wgUseDatabaseMessages = true;
2678 * Expiry time for the message cache key
2680 $wgMsgCacheExpiry = 86400;
2683 * Maximum entry size in the message cache, in bytes
2685 $wgMaxMsgCacheEntrySize = 10000;
2688 * Whether to enable language variant conversion.
2690 $wgDisableLangConversion = false;
2693 * Whether to enable language variant conversion for links.
2695 $wgDisableTitleConversion = false;
2698 * Whether to enable canonical language links in meta data.
2700 $wgCanonicalLanguageLinks = true;
2703 * Default variant code, if false, the default will be the language code
2705 $wgDefaultLanguageVariant = false;
2708 * Disabled variants array of language variant conversion.
2710 * @par Example:
2711 * @code
2712 * $wgDisabledVariants[] = 'zh-mo';
2713 * $wgDisabledVariants[] = 'zh-my';
2714 * @endcode
2716 $wgDisabledVariants = array();
2719 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2720 * path format that describes which parts of the URL contain the
2721 * language variant.
2723 * @par Example:
2724 * @code
2725 * $wgLanguageCode = 'sr';
2726 * $wgVariantArticlePath = '/$2/$1';
2727 * $wgArticlePath = '/wiki/$1';
2728 * @endcode
2730 * A link to /wiki/ would be redirected to /sr/Главна_страна
2732 * It is important that $wgArticlePath not overlap with possible values
2733 * of $wgVariantArticlePath.
2735 $wgVariantArticlePath = false;
2738 * Show a bar of language selection links in the user login and user
2739 * registration forms; edit the "loginlanguagelinks" message to
2740 * customise these.
2742 $wgLoginLanguageSelector = false;
2745 * When translating messages with wfMessage(), it is not always clear what
2746 * should be considered UI messages and what should be content messages.
2748 * For example, for the English Wikipedia, there should be only one 'mainpage',
2749 * so when getting the link for 'mainpage', we should treat it as site content
2750 * and call ->inContentLanguage()->text(), but for rendering the text of the
2751 * link, we call ->text(). The code behaves this way by default. However,
2752 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2753 * and the like for different languages. This array provides a way to override
2754 * the default behavior.
2756 * @par Example:
2757 * To allow language-specific main page and community
2758 * portal:
2759 * @code
2760 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2761 * @endcode
2763 $wgForceUIMsgAsContentMsg = array();
2766 * Fake out the timezone that the server thinks it's in. This will be used for
2767 * date display and not for what's stored in the DB. Leave to null to retain
2768 * your server's OS-based timezone value.
2770 * This variable is currently used only for signature formatting and for local
2771 * time/date parser variables ({{LOCALTIME}} etc.)
2773 * Timezones can be translated by editing MediaWiki messages of type
2774 * timezone-nameinlowercase like timezone-utc.
2776 * A list of usable timezones can found at:
2777 * http://php.net/manual/en/timezones.php
2779 * @par Examples:
2780 * @code
2781 * $wgLocaltimezone = 'UTC';
2782 * $wgLocaltimezone = 'GMT';
2783 * $wgLocaltimezone = 'PST8PDT';
2784 * $wgLocaltimezone = 'Europe/Sweden';
2785 * $wgLocaltimezone = 'CET';
2786 * @endcode
2788 $wgLocaltimezone = null;
2791 * Set an offset from UTC in minutes to use for the default timezone setting
2792 * for anonymous users and new user accounts.
2794 * This setting is used for most date/time displays in the software, and is
2795 * overridable in user preferences. It is *not* used for signature timestamps.
2797 * By default, this will be set to match $wgLocaltimezone.
2799 $wgLocalTZoffset = null;
2801 /** @} */ # End of language/charset settings
2803 /*************************************************************************//**
2804 * @name Output format and skin settings
2805 * @{
2809 * The default Content-Type header.
2811 $wgMimeType = 'text/html';
2814 * Previously used as content type in HTML script tags. This is now ignored since
2815 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2816 * It was also previously used by RawAction to determine the ctype query parameter
2817 * value that will result in a javascript response.
2818 * @deprecated since 1.22
2820 $wgJsMimeType = null;
2823 * The default xmlns attribute. The option to define this has been removed.
2824 * The value of this variable is no longer used by core and is set to a fixed
2825 * value in Setup.php for compatibility with extensions that depend on the value
2826 * of this variable being set. Such a dependency however is deprecated.
2827 * @deprecated since 1.22
2829 $wgXhtmlDefaultNamespace = null;
2832 * Previously used to determine if we should output an HTML5 doctype.
2833 * This is no longer used as we always output HTML5 now. For compatibility with
2834 * extensions that still check the value of this config it's value is now forced
2835 * to true by Setup.php.
2836 * @deprecated since 1.22
2838 $wgHtml5 = true;
2841 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2842 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2843 * (like if it's left at the default null value), it will be auto-initialized
2844 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2845 * ever actually set this to anything.
2847 $wgHtml5Version = null;
2850 * Enabled RDFa attributes for use in wikitext.
2851 * NOTE: Interaction with HTML5 is somewhat underspecified.
2853 $wgAllowRdfaAttributes = false;
2856 * Enabled HTML5 microdata attributes for use in wikitext.
2858 $wgAllowMicrodataAttributes = false;
2861 * Should we try to make our HTML output well-formed XML? If set to false,
2862 * output will be a few bytes shorter, and the HTML will arguably be more
2863 * readable. If set to true, life will be much easier for the authors of
2864 * screen-scraping bots, and the HTML will arguably be more readable.
2866 * Setting this to false may omit quotation marks on some attributes, omit
2867 * slashes from some self-closing tags, omit some ending tags, etc., where
2868 * permitted by HTML5. Setting it to true will not guarantee that all pages
2869 * will be well-formed, although non-well-formed pages should be rare and it's
2870 * a bug if you find one. Conversely, setting it to false doesn't mean that
2871 * all XML-y constructs will be omitted, just that they might be.
2873 * Because of compatibility with screen-scraping bots, and because it's
2874 * controversial, this is currently left to true by default.
2876 $wgWellFormedXml = true;
2879 * Permit other namespaces in addition to the w3.org default.
2881 * Use the prefix for the key and the namespace for the value.
2883 * @par Example:
2884 * @code
2885 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2886 * @endcode
2887 * Normally we wouldn't have to define this in the root "<html>"
2888 * element, but IE needs it there in some circumstances.
2890 * This is ignored if $wgMimeType is set to a non-XML mimetype.
2892 $wgXhtmlNamespaces = array();
2895 * Show IP address, for non-logged in users. It's necessary to switch this off
2896 * for some forms of caching.
2897 * @warning Will disable file cache.
2899 $wgShowIPinHeader = true;
2902 * Site notice shown at the top of each page
2904 * MediaWiki:Sitenotice page, which will override this. You can also
2905 * provide a separate message for logged-out users using the
2906 * MediaWiki:Anonnotice page.
2908 $wgSiteNotice = '';
2911 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2913 $wgSiteSupportPage = '';
2916 * Validate the overall output using tidy and refuse
2917 * to display the page if it's not valid.
2919 $wgValidateAllHtml = false;
2922 * Default skin, for new users and anonymous visitors. Registered users may
2923 * change this to any one of the other available skins in their preferences.
2924 * This has to be completely lowercase; see the "skins" directory for the list
2925 * of available skins.
2927 $wgDefaultSkin = 'vector';
2930 * Specify the name of a skin that should not be presented in the list of
2931 * available skins. Use for blacklisting a skin which you do not want to
2932 * remove from the .../skins/ directory
2934 * @deprecated since 1.23; use $wgSkipSkins instead
2936 $wgSkipSkin = '';
2939 * Array for more like $wgSkipSkin.
2941 $wgSkipSkins = array();
2944 * Allow user Javascript page?
2945 * This enables a lot of neat customizations, but may
2946 * increase security risk to users and server load.
2948 $wgAllowUserJs = false;
2951 * Allow user Cascading Style Sheets (CSS)?
2952 * This enables a lot of neat customizations, but may
2953 * increase security risk to users and server load.
2955 $wgAllowUserCss = false;
2958 * Allow user-preferences implemented in CSS?
2959 * This allows users to customise the site appearance to a greater
2960 * degree; disabling it will improve page load times.
2962 $wgAllowUserCssPrefs = true;
2965 * Use the site's Javascript page?
2967 $wgUseSiteJs = true;
2970 * Use the site's Cascading Style Sheets (CSS)?
2972 $wgUseSiteCss = true;
2975 * Break out of framesets. This can be used to prevent clickjacking attacks,
2976 * or to prevent external sites from framing your site with ads.
2978 $wgBreakFrames = false;
2981 * The X-Frame-Options header to send on pages sensitive to clickjacking
2982 * attacks, such as edit pages. This prevents those pages from being displayed
2983 * in a frame or iframe. The options are:
2985 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2987 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
2988 * to allow framing within a trusted domain. This is insecure if there
2989 * is a page on the same domain which allows framing of arbitrary URLs.
2991 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
2992 * full compromise of local user accounts. Private wikis behind a
2993 * corporate firewall are especially vulnerable. This is not
2994 * recommended.
2996 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
2997 * not just edit pages.
2999 $wgEditPageFrameOptions = 'DENY';
3002 * Disallow framing of API pages directly, by setting the X-Frame-Options
3003 * header. Since the API returns CSRF tokens, allowing the results to be
3004 * framed can compromise your user's account security.
3005 * Options are:
3006 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3007 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3008 * - false: Allow all framing.
3010 $wgApiFrameOptions = 'DENY';
3013 * Disable output compression (enabled by default if zlib is available)
3015 $wgDisableOutputCompression = false;
3018 * Should we allow a broader set of characters in id attributes, per HTML5? If
3019 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3020 * functionality is ready, it will be on by default with no option.
3022 * Currently this appears to work fine in all browsers, but it's disabled by
3023 * default because it normalizes id's a bit too aggressively, breaking preexisting
3024 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3026 $wgExperimentalHtmlIds = false;
3029 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3030 * You can add new icons to the built in copyright or poweredby, or you can create
3031 * a new block. Though note that you may need to add some custom css to get good styling
3032 * of new blocks in monobook. vector and modern should work without any special css.
3034 * $wgFooterIcons itself is a key/value array.
3035 * The key is the name of a block that the icons will be wrapped in. The final id varies
3036 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3037 * turns it into mw_poweredby.
3038 * The value is either key/value array of icons or a string.
3039 * In the key/value array the key may or may not be used by the skin but it can
3040 * be used to find the icon and unset it or change the icon if needed.
3041 * This is useful for disabling icons that are set by extensions.
3042 * The value should be either a string or an array. If it is a string it will be output
3043 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3044 * for the icon, the following keys are used:
3045 * - src: An absolute url to the image to use for the icon, this is recommended
3046 * but not required, however some skins will ignore icons without an image
3047 * - url: The url to use in the a element around the text or icon, if not set an a element will
3048 * not be outputted
3049 * - alt: This is the text form of the icon, it will be displayed without an image in
3050 * skins like Modern or if src is not set, and will otherwise be used as
3051 * the alt="" for the image. This key is required.
3052 * - width and height: If the icon specified by src is not of the standard size
3053 * you can specify the size of image to use with these keys.
3054 * Otherwise they will default to the standard 88x31.
3055 * @todo Reformat documentation.
3057 $wgFooterIcons = array(
3058 "copyright" => array(
3059 "copyright" => array(), // placeholder for the built in copyright icon
3061 "poweredby" => array(
3062 "mediawiki" => array(
3063 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
3064 "url" => "//www.mediawiki.org/",
3065 "alt" => "Powered by MediaWiki",
3071 * Login / create account link behavior when it's possible for anonymous users
3072 * to create an account.
3073 * - true = use a combined login / create account link
3074 * - false = split login and create account into two separate links
3076 $wgUseCombinedLoginLink = false;
3079 * Search form look for Vector skin only.
3080 * - true = use an icon search button
3081 * - false = use Go & Search buttons
3083 $wgVectorUseSimpleSearch = true;
3086 * Watch and unwatch as an icon rather than a link for Vector skin only.
3087 * - true = use an icon watch/unwatch button
3088 * - false = use watch/unwatch text link
3090 $wgVectorUseIconWatch = true;
3093 * Display user edit counts in various prominent places.
3095 $wgEdititis = false;
3098 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3099 * status code, mangling or hiding MediaWiki's output. If you are using such a
3100 * host, you should start looking for a better one. While you're doing that,
3101 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3102 * that the generated error pages can be seen.
3104 * In cases where for technical reasons it is more important for MediaWiki to
3105 * send the correct status code than for the body to be transmitted intact,
3106 * this configuration variable is ignored.
3108 $wgSend404Code = true;
3111 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3112 * rollback. The numeric value of the variable are the limit up to are counted.
3113 * If the value is false or 0, the edits are not counted. Disabling this will
3114 * furthermore prevent MediaWiki from hiding some useless rollback links.
3116 * @since 1.20
3118 $wgShowRollbackEditCount = 10;
3121 * Output a <link rel="canonical"> tag on every page indicating the canonical
3122 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3123 * detection of the current server is unreliable, the link is sent
3124 * unconditionally.
3126 $wgEnableCanonicalServerLink = false;
3128 /** @} */ # End of output format settings }
3130 /*************************************************************************//**
3131 * @name Resource loader settings
3132 * @{
3136 * Client-side resource modules.
3138 * Extensions should add their resource loader module definitions
3139 * to the $wgResourceModules variable.
3141 * @par Example:
3142 * @code
3143 * $wgResourceModules['ext.myExtension'] = array(
3144 * 'scripts' => 'myExtension.js',
3145 * 'styles' => 'myExtension.css',
3146 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3147 * 'localBasePath' => __DIR__,
3148 * 'remoteExtPath' => 'MyExtension',
3149 * );
3150 * @endcode
3152 $wgResourceModules = array();
3155 * Extensions should register foreign module sources here. 'local' is a
3156 * built-in source that is not in this array, but defined by
3157 * ResourceLoader::__construct() so that it cannot be unset.
3159 * @par Example:
3160 * @code
3161 * $wgResourceLoaderSources['foo'] = array(
3162 * 'loadScript' => 'http://example.org/w/load.php',
3163 * 'apiScript' => 'http://example.org/w/api.php'
3164 * );
3165 * @endcode
3167 $wgResourceLoaderSources = array();
3170 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3171 * If not set, then $wgScriptPath will be used as a fallback.
3173 $wgResourceBasePath = null;
3176 * Maximum time in seconds to cache resources served by the resource loader.
3177 * Used to set last modified headers (max-age/s-maxage).
3179 * Following options to distinguish:
3180 * - versioned: Used for modules with a version, because changing version
3181 * numbers causes cache misses. This normally has a long expiry time.
3182 * - unversioned: Used for modules without a version to propagate changes
3183 * quickly to clients. Also used for modules with errors to recover quickly.
3184 * This normally has a short expiry time.
3186 * Expiry time for the options to distinguish:
3187 * - server: Squid/Varnish but also any other public proxy cache between the
3188 * client and MediaWiki.
3189 * - client: On the client side (e.g. in the browser cache).
3191 $wgResourceLoaderMaxage = array(
3192 'versioned' => array(
3193 'server' => 30 * 24 * 60 * 60, // 30 days
3194 'client' => 30 * 24 * 60 * 60, // 30 days
3196 'unversioned' => array(
3197 'server' => 5 * 60, // 5 minutes
3198 'client' => 5 * 60, // 5 minutes
3203 * The default debug mode (on/off) for of ResourceLoader requests.
3205 * This will still be overridden when the debug URL parameter is used.
3207 $wgResourceLoaderDebug = false;
3210 * Enable embedding of certain resources using Edge Side Includes. This will
3211 * improve performance but only works if there is something in front of the
3212 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3214 $wgResourceLoaderUseESI = false;
3217 * Put each statement on its own line when minifying JavaScript. This makes
3218 * debugging in non-debug mode a bit easier.
3220 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3223 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3224 * the minifier will try not to produce lines longer than this, but may be
3225 * forced to do so in certain cases.
3227 $wgResourceLoaderMinifierMaxLineLength = 1000;
3230 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3231 * dependencies.
3233 $wgIncludeLegacyJavaScript = true;
3236 * Whether to include the jQuery Migrate library, which lets legacy JS that
3237 * requires jQuery 1.8.x to work and breaks with 1.9.x+.
3239 * @since 1.24
3240 * @deprecated since 1.24, to be removed in 1.25
3242 $wgIncludejQueryMigrate = false;
3245 * Whether to preload the mediawiki.util module as blocking module in the top
3246 * queue.
3248 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3249 * allowed modules to lack dependencies on 'popular' modules that were likely
3250 * loaded already.
3252 * This setting is to aid scripts during migration by providing mediawiki.util
3253 * unconditionally (which was the most commonly missed dependency).
3254 * It doesn't cover all missing dependencies obviously but should fix most of
3255 * them.
3257 * This should be removed at some point after site/user scripts have been fixed.
3258 * Enable this if your wiki has a large amount of user/site scripts that are
3259 * lacking dependencies.
3260 * @todo Deprecate
3262 $wgPreloadJavaScriptMwUtil = false;
3265 * Whether or not to assign configuration variables to the global window object.
3267 * If this is set to false, old code using deprecated variables will no longer
3268 * work.
3270 * @par Example of legacy code:
3271 * @code{,js}
3272 * if ( window.wgRestrictionEdit ) { ... }
3273 * @endcode
3274 * or:
3275 * @code{,js}
3276 * if ( wgIsArticle ) { ... }
3277 * @endcode
3279 * Instead, one needs to use mw.config.
3280 * @par Example using mw.config global configuration:
3281 * @code{,js}
3282 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3283 * @endcode
3284 * or:
3285 * @code{,js}
3286 * if ( mw.config.get('wgIsArticle') ) { ... }
3287 * @endcode
3289 $wgLegacyJavaScriptGlobals = true;
3292 * If set to a positive number, ResourceLoader will not generate URLs whose
3293 * query string is more than this many characters long, and will instead use
3294 * multiple requests with shorter query strings. This degrades performance,
3295 * but may be needed if your web server has a low (less than, say 1024)
3296 * query string length limit or a low value for suhosin.get.max_value_length
3297 * that you can't increase.
3299 * If set to a negative number, ResourceLoader will assume there is no query
3300 * string length limit.
3302 * Defaults to a value based on php configuration.
3304 $wgResourceLoaderMaxQueryLength = false;
3307 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3308 * prior to minification to validate it.
3310 * Parse errors will result in a JS exception being thrown during module load,
3311 * which avoids breaking other modules loaded in the same request.
3313 $wgResourceLoaderValidateJS = true;
3316 * If set to true, statically-sourced (file-backed) JavaScript resources will
3317 * be parsed for validity before being bundled up into ResourceLoader modules.
3319 * This can be helpful for development by providing better error messages in
3320 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3321 * and may fail on large pre-bundled frameworks.
3323 $wgResourceLoaderValidateStaticJS = false;
3326 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3327 * will be enabled. This is an experimental feature that's supposed to make
3328 * JavaScript load faster.
3330 $wgResourceLoaderExperimentalAsyncLoading = false;
3333 * Global LESS variables. An associative array binding variable names to CSS
3334 * string values.
3336 * Because the hashed contents of this array are used to construct the cache key
3337 * that ResourceLoader uses to look up LESS compilation results, updating this
3338 * array can be used to deliberately invalidate the set of cached results.
3340 * @par Example:
3341 * @code
3342 * $wgResourceLoaderLESSVars = array(
3343 * 'baseFontSize' => '1em',
3344 * 'smallFontSize' => '0.75em',
3345 * 'WikimediaBlue' => '#006699',
3346 * );
3347 * @endcode
3348 * @since 1.22
3350 $wgResourceLoaderLESSVars = array();
3353 * Custom LESS functions. An associative array mapping function name to PHP
3354 * callable.
3356 * Changes to LESS functions do not trigger cache invalidation. If you update
3357 * the behavior of a LESS function and need to invalidate stale compilation
3358 * results, you can touch one of values in $wgResourceLoaderLESSVars, as
3359 * documented above.
3361 * @since 1.22
3363 $wgResourceLoaderLESSFunctions = array(
3364 'embeddable' => 'ResourceLoaderLESSFunctions::embeddable',
3365 'embed' => 'ResourceLoaderLESSFunctions::embed',
3369 * Default import paths for LESS modules. LESS files referenced in @import
3370 * statements will be looked up here first, and relative to the importing file
3371 * second. To avoid collisions, it's important for the LESS files in these
3372 * directories to have a common, predictable file name prefix.
3374 * Extensions need not (and should not) register paths in
3375 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3376 * currently compiling LESS file, which allows each extension to freely import
3377 * files from its own tree.
3379 * @since 1.22
3381 $wgResourceLoaderLESSImportPaths = array(
3382 "$IP/resources/src/mediawiki.less/",
3386 * Whether ResourceLoader should attempt to persist modules in localStorage on
3387 * browsers that support the Web Storage API.
3389 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3391 $wgResourceLoaderStorageEnabled = false;
3394 * Cache version for client-side ResourceLoader module storage. You can trigger
3395 * invalidation of the contents of the module store by incrementing this value.
3397 * @since 1.23
3399 $wgResourceLoaderStorageVersion = 1;
3401 /** @} */ # End of resource loader settings }
3403 /*************************************************************************//**
3404 * @name Page title and interwiki link settings
3405 * @{
3409 * Name of the project namespace. If left set to false, $wgSitename will be
3410 * used instead.
3412 $wgMetaNamespace = false;
3415 * Name of the project talk namespace.
3417 * Normally you can ignore this and it will be something like
3418 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3419 * manually for grammatical reasons.
3421 $wgMetaNamespaceTalk = false;
3424 * Additional namespaces. If the namespaces defined in Language.php and
3425 * Namespace.php are insufficient, you can create new ones here, for example,
3426 * to import Help files in other languages. You can also override the namespace
3427 * names of existing namespaces. Extensions developers should use
3428 * $wgCanonicalNamespaceNames.
3430 * @warning Once you delete a namespace, the pages in that namespace will
3431 * no longer be accessible. If you rename it, then you can access them through
3432 * the new namespace name.
3434 * Custom namespaces should start at 100 to avoid conflicting with standard
3435 * namespaces, and should always follow the even/odd main/talk pattern.
3437 * @par Example:
3438 * @code
3439 * $wgExtraNamespaces = array(
3440 * 100 => "Hilfe",
3441 * 101 => "Hilfe_Diskussion",
3442 * 102 => "Aide",
3443 * 103 => "Discussion_Aide"
3444 * );
3445 * @endcode
3447 * @todo Add a note about maintenance/namespaceDupes.php
3449 $wgExtraNamespaces = array();
3452 * Same as above, but for namespaces with gender distinction.
3453 * Note: the default form for the namespace should also be set
3454 * using $wgExtraNamespaces for the same index.
3455 * @since 1.18
3457 $wgExtraGenderNamespaces = array();
3460 * Namespace aliases.
3462 * These are alternate names for the primary localised namespace names, which
3463 * are defined by $wgExtraNamespaces and the language file. If a page is
3464 * requested with such a prefix, the request will be redirected to the primary
3465 * name.
3467 * Set this to a map from namespace names to IDs.
3469 * @par Example:
3470 * @code
3471 * $wgNamespaceAliases = array(
3472 * 'Wikipedian' => NS_USER,
3473 * 'Help' => 100,
3474 * );
3475 * @endcode
3477 $wgNamespaceAliases = array();
3480 * Allowed title characters -- regex character class
3481 * Don't change this unless you know what you're doing
3483 * Problematic punctuation:
3484 * - []{}|# Are needed for link syntax, never enable these
3485 * - <> Causes problems with HTML escaping, don't use
3486 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3487 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3488 * corrupted by apache
3489 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3491 * All three of these punctuation problems can be avoided by using an alias,
3492 * instead of a rewrite rule of either variety.
3494 * The problem with % is that when using a path to query rewrite rule, URLs are
3495 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3496 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3497 * for this, indeed double escaping would break if the double-escaped title was
3498 * passed in the query string rather than the path. This is a minor security issue
3499 * because articles can be created such that they are hard to view or edit.
3501 * In some rare cases you may wish to remove + for compatibility with old links.
3503 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3504 * this breaks interlanguage links
3506 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3509 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3511 * @deprecated since 1.23; use $wgLocalInterwikis instead
3513 $wgLocalInterwiki = false;
3516 * Array for multiple $wgLocalInterwiki values, in case there are several
3517 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3518 * set, its value is prepended to this array, for backwards compatibility.
3520 * Note, recent changes feeds use only the first entry in this array (or
3521 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3523 $wgLocalInterwikis = array();
3526 * Expiry time for cache of interwiki table
3528 $wgInterwikiExpiry = 10800;
3531 * @name Interwiki caching settings.
3532 * @{
3536 *$wgInterwikiCache specifies path to constant database file.
3538 * This cdb database is generated by dumpInterwiki from maintenance and has
3539 * such key formats:
3540 * - dbname:key - a simple key (e.g. enwiki:meta)
3541 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3542 * - __global:key - global-scope key (e.g. __global:meta)
3543 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3545 * Sites mapping just specifies site name, other keys provide "local url"
3546 * data layout.
3548 $wgInterwikiCache = false;
3551 * Specify number of domains to check for messages.
3552 * - 1: Just wiki(db)-level
3553 * - 2: wiki and global levels
3554 * - 3: site levels
3556 $wgInterwikiScopes = 3;
3559 * Fallback site, if unable to resolve from cache
3561 $wgInterwikiFallbackSite = 'wiki';
3563 /** @} */ # end of Interwiki caching settings.
3566 * If local interwikis are set up which allow redirects,
3567 * set this regexp to restrict URLs which will be displayed
3568 * as 'redirected from' links.
3570 * @par Example:
3571 * It might look something like this:
3572 * @code
3573 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3574 * @endcode
3576 * Leave at false to avoid displaying any incoming redirect markers.
3577 * This does not affect intra-wiki redirects, which don't change
3578 * the URL.
3580 $wgRedirectSources = false;
3583 * Set this to false to avoid forcing the first letter of links to capitals.
3585 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3586 * appearing with a capital at the beginning of a sentence will *not* go to the
3587 * same place as links in the middle of a sentence using a lowercase initial.
3589 $wgCapitalLinks = true;
3592 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3593 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3594 * true by default (and setting them has no effect), due to various things that
3595 * require them to be so. Also, since Talk namespaces need to directly mirror their
3596 * associated content namespaces, the values for those are ignored in favor of the
3597 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3598 * NS_FILE.
3600 * @par Example:
3601 * @code
3602 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3603 * @endcode
3605 $wgCapitalLinkOverrides = array();
3608 * Which namespaces should support subpages?
3609 * See Language.php for a list of namespaces.
3611 $wgNamespacesWithSubpages = array(
3612 NS_TALK => true,
3613 NS_USER => true,
3614 NS_USER_TALK => true,
3615 NS_PROJECT => true,
3616 NS_PROJECT_TALK => true,
3617 NS_FILE_TALK => true,
3618 NS_MEDIAWIKI => true,
3619 NS_MEDIAWIKI_TALK => true,
3620 NS_TEMPLATE_TALK => true,
3621 NS_HELP => true,
3622 NS_HELP_TALK => true,
3623 NS_CATEGORY_TALK => true
3627 * Array holding default tracking category names.
3629 * Array contains the system messages for each tracking category.
3630 * Tracking categories allow pages with certain characteristics to be tracked.
3631 * It works by adding any such page to a category automatically.
3633 * A message with the suffix '-desc' should be added as a description message
3634 * to have extra information on Special:TrackingCategories.
3636 * @since 1.23
3638 $wgTrackingCategories = array(
3639 'index-category',
3640 'noindex-category',
3641 'expensive-parserfunction-category',
3642 'post-expand-template-argument-category',
3643 'post-expand-template-inclusion-category',
3644 'hidden-category-category',
3645 'broken-file-category',
3646 'node-count-exceeded-category',
3647 'expansion-depth-exceeded-category',
3651 * Array of namespaces which can be deemed to contain valid "content", as far
3652 * as the site statistics are concerned. Useful if additional namespaces also
3653 * contain "content" which should be considered when generating a count of the
3654 * number of articles in the wiki.
3656 $wgContentNamespaces = array( NS_MAIN );
3659 * Max number of redirects to follow when resolving redirects.
3660 * 1 means only the first redirect is followed (default behavior).
3661 * 0 or less means no redirects are followed.
3663 $wgMaxRedirects = 1;
3666 * Array of invalid page redirect targets.
3667 * Attempting to create a redirect to any of the pages in this array
3668 * will make the redirect fail.
3669 * Userlogout is hard-coded, so it does not need to be listed here.
3670 * (bug 10569) Disallow Mypage and Mytalk as well.
3672 * As of now, this only checks special pages. Redirects to pages in
3673 * other namespaces cannot be invalidated by this variable.
3675 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3677 /** @} */ # End of title and interwiki settings }
3679 /************************************************************************//**
3680 * @name Parser settings
3681 * These settings configure the transformation from wikitext to HTML.
3682 * @{
3686 * Parser configuration. Associative array with the following members:
3688 * class The class name
3690 * preprocessorClass The preprocessor class. Two classes are currently available:
3691 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3692 * storage, and Preprocessor_DOM, which uses the DOM module for
3693 * temporary storage. Preprocessor_DOM generally uses less memory;
3694 * the speed of the two is roughly the same.
3696 * If this parameter is not given, it uses Preprocessor_DOM if the
3697 * DOM module is available, otherwise it uses Preprocessor_Hash.
3699 * The entire associative array will be passed through to the constructor as
3700 * the first parameter. Note that only Setup.php can use this variable --
3701 * the configuration will change at runtime via $wgParser member functions, so
3702 * the contents of this variable will be out-of-date. The variable can only be
3703 * changed during LocalSettings.php, in particular, it can't be changed during
3704 * an extension setup function.
3706 $wgParserConf = array(
3707 'class' => 'Parser',
3708 #'preprocessorClass' => 'Preprocessor_Hash',
3712 * Maximum indent level of toc.
3714 $wgMaxTocLevel = 999;
3717 * A complexity limit on template expansion: the maximum number of nodes visited
3718 * by PPFrame::expand()
3720 $wgMaxPPNodeCount = 1000000;
3723 * A complexity limit on template expansion: the maximum number of elements
3724 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3725 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3726 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3727 * this default corresponds to about 155 MB.
3729 * When the limit is exceeded, an exception is thrown.
3731 $wgMaxGeneratedPPNodeCount = 1000000;
3734 * Maximum recursion depth for templates within templates.
3735 * The current parser adds two levels to the PHP call stack for each template,
3736 * and xdebug limits the call stack to 100 by default. So this should hopefully
3737 * stop the parser before it hits the xdebug limit.
3739 $wgMaxTemplateDepth = 40;
3742 * @see $wgMaxTemplateDepth
3744 $wgMaxPPExpandDepth = 40;
3747 * URL schemes that should be recognized as valid by wfParseUrl().
3748 * @see wfParseUrl
3750 $wgUrlProtocols = array(
3751 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3752 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3753 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3754 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3758 * If true, removes (substitutes) templates in "~~~~" signatures.
3760 $wgCleanSignatures = true;
3763 * Whether to allow inline image pointing to other websites
3765 $wgAllowExternalImages = false;
3768 * If the above is false, you can specify an exception here. Image URLs
3769 * that start with this string are then rendered, while all others are not.
3770 * You can use this to set up a trusted, simple repository of images.
3771 * You may also specify an array of strings to allow multiple sites
3773 * @par Examples:
3774 * @code
3775 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3776 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3777 * @endcode
3779 $wgAllowExternalImagesFrom = '';
3782 * If $wgAllowExternalImages is false, you can allow an on-wiki
3783 * whitelist of regular expression fragments to match the image URL
3784 * against. If the image matches one of the regular expression fragments,
3785 * The image will be displayed.
3787 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3788 * Or false to disable it
3790 $wgEnableImageWhitelist = true;
3793 * A different approach to the above: simply allow the "<img>" tag to be used.
3794 * This allows you to specify alt text and other attributes, copy-paste HTML to
3795 * your wiki more easily, etc. However, allowing external images in any manner
3796 * will allow anyone with editing rights to snoop on your visitors' IP
3797 * addresses and so forth, if they wanted to, by inserting links to images on
3798 * sites they control.
3800 $wgAllowImageTag = false;
3803 * $wgUseTidy: use tidy to make sure HTML output is sane.
3804 * Tidy is a free tool that fixes broken HTML.
3805 * See http://www.w3.org/People/Raggett/tidy/
3807 * - $wgTidyBin should be set to the path of the binary and
3808 * - $wgTidyConf to the path of the configuration file.
3809 * - $wgTidyOpts can include any number of parameters.
3810 * - $wgTidyInternal controls the use of the PECL extension or the
3811 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3812 * of spawning a separate program.
3813 * Normally you shouldn't need to override the setting except for
3814 * debugging. To install, use 'pear install tidy' and add a line
3815 * 'extension=tidy.so' to php.ini.
3817 $wgUseTidy = false;
3820 * @see $wgUseTidy
3822 $wgAlwaysUseTidy = false;
3825 * @see $wgUseTidy
3827 $wgTidyBin = 'tidy';
3830 * @see $wgUseTidy
3832 $wgTidyConf = $IP . '/includes/tidy.conf';
3835 * @see $wgUseTidy
3837 $wgTidyOpts = '';
3840 * @see $wgUseTidy
3842 $wgTidyInternal = extension_loaded( 'tidy' );
3845 * Put tidy warnings in HTML comments
3846 * Only works for internal tidy.
3848 $wgDebugTidy = false;
3851 * Allow raw, unchecked HTML in "<html>...</html>" sections.
3852 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3853 * TO RESTRICT EDITING to only those that you trust
3855 $wgRawHtml = false;
3858 * Set a default target for external links, e.g. _blank to pop up a new window
3860 $wgExternalLinkTarget = false;
3863 * If true, external URL links in wiki text will be given the
3864 * rel="nofollow" attribute as a hint to search engines that
3865 * they should not be followed for ranking purposes as they
3866 * are user-supplied and thus subject to spamming.
3868 $wgNoFollowLinks = true;
3871 * Namespaces in which $wgNoFollowLinks doesn't apply.
3872 * See Language.php for a list of namespaces.
3874 $wgNoFollowNsExceptions = array();
3877 * If this is set to an array of domains, external links to these domain names
3878 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3879 * value of $wgNoFollowLinks. For instance:
3881 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
3882 * 'mediawiki.org' );
3884 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3885 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3886 * etc.
3888 * Defaults to mediawiki.org for the links included in the software by default.
3890 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
3893 * Allow DISPLAYTITLE to change title display
3895 $wgAllowDisplayTitle = true;
3898 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
3899 * canonical DB key. Also disallow some inline CSS rules like display: none;
3900 * which can cause the text to be hidden or unselectable.
3902 $wgRestrictDisplayTitle = true;
3905 * Maximum number of calls per parse to expensive parser functions such as
3906 * PAGESINCATEGORY.
3908 $wgExpensiveParserFunctionLimit = 100;
3911 * Preprocessor caching threshold
3912 * Setting it to 'false' will disable the preprocessor cache.
3914 $wgPreprocessorCacheThreshold = 1000;
3917 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
3919 $wgEnableScaryTranscluding = false;
3922 * Expiry time for transcluded templates cached in transcache database table.
3923 * Only used $wgEnableInterwikiTranscluding is set to true.
3925 $wgTranscludeCacheExpiry = 3600;
3927 /** @} */ # end of parser settings }
3929 /************************************************************************//**
3930 * @name Statistics
3931 * @{
3935 * Method used to determine if a page in a content namespace should be counted
3936 * as a valid article.
3938 * Redirect pages will never be counted as valid articles.
3940 * This variable can have the following values:
3941 * - 'any': all pages as considered as valid articles
3942 * - 'comma': the page must contain a comma to be considered valid
3943 * - 'link': the page must contain a [[wiki link]] to be considered valid
3944 * - null: the value will be set at run time depending on $wgUseCommaCount:
3945 * if $wgUseCommaCount is false, it will be 'link', if it is true
3946 * it will be 'comma'
3948 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
3950 * Retroactively changing this variable will not affect the existing count,
3951 * to update it, you will need to run the maintenance/updateArticleCount.php
3952 * script.
3954 $wgArticleCountMethod = null;
3957 * Backward compatibility setting, will set $wgArticleCountMethod if it is null.
3958 * @deprecated since 1.18; use $wgArticleCountMethod instead
3960 $wgUseCommaCount = false;
3963 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
3964 * values are easier on the database. A value of 1 causes the counters to be
3965 * updated on every hit, any higher value n cause them to update *on average*
3966 * every n hits. Should be set to either 1 or something largish, eg 1000, for
3967 * maximum efficiency.
3969 $wgHitcounterUpdateFreq = 1;
3972 * How many days user must be idle before he is considered inactive. Will affect
3973 * the number shown on Special:Statistics, Special:ActiveUsers, and the
3974 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
3975 * You might want to leave this as the default value, to provide comparable
3976 * numbers between different wikis.
3978 $wgActiveUserDays = 30;
3980 /** @} */ # End of statistics }
3982 /************************************************************************//**
3983 * @name User accounts, authentication
3984 * @{
3988 * For compatibility with old installations set to false
3990 $wgPasswordSalt = true;
3993 * Specifies the minimal length of a user password. If set to 0, empty pass-
3994 * words are allowed.
3996 $wgMinimalPasswordLength = 1;
3999 * Specifies if users should be sent to a password-reset form on login, if their
4000 * password doesn't meet the requirements of User::isValidPassword().
4001 * @since 1.23
4003 $wgInvalidPasswordReset = true;
4006 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4007 * with a temporary password you can use to get back into the account") identified by
4008 * various bits of data. Setting all of these to false (or the whole variable to false)
4009 * has the effect of disabling password resets entirely
4011 $wgPasswordResetRoutes = array(
4012 'username' => true,
4013 'email' => false,
4017 * Maximum number of Unicode characters in signature
4019 $wgMaxSigChars = 255;
4022 * Maximum number of bytes in username. You want to run the maintenance
4023 * script ./maintenance/checkUsernames.php once you have changed this value.
4025 $wgMaxNameChars = 255;
4028 * Array of usernames which may not be registered or logged in from
4029 * Maintenance scripts can still use these
4031 $wgReservedUsernames = array(
4032 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4033 'Conversion script', // Used for the old Wikipedia software upgrade
4034 'Maintenance script', // Maintenance scripts which perform editing, image import script
4035 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4036 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4037 'msg:double-redirect-fixer', // Automatic double redirect fix
4038 'msg:usermessage-editor', // Default user for leaving user messages
4039 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4043 * Settings added to this array will override the default globals for the user
4044 * preferences used by anonymous visitors and newly created accounts.
4045 * For instance, to disable editing on double clicks:
4046 * $wgDefaultUserOptions ['editondblclick'] = 0;
4048 $wgDefaultUserOptions = array(
4049 'ccmeonemails' => 0,
4050 'cols' => 80,
4051 'date' => 'default',
4052 'diffonly' => 0,
4053 'disablemail' => 0,
4054 'editfont' => 'default',
4055 'editondblclick' => 0,
4056 'editsectiononrightclick' => 0,
4057 'enotifminoredits' => 0,
4058 'enotifrevealaddr' => 0,
4059 'enotifusertalkpages' => 1,
4060 'enotifwatchlistpages' => 1,
4061 'extendwatchlist' => 0,
4062 'fancysig' => 0,
4063 'forceeditsummary' => 0,
4064 'gender' => 'unknown',
4065 'hideminor' => 0,
4066 'hidepatrolled' => 0,
4067 'imagesize' => 2,
4068 'math' => 1,
4069 'minordefault' => 0,
4070 'newpageshidepatrolled' => 0,
4071 'nickname' => '',
4072 'norollbackdiff' => 0,
4073 'numberheadings' => 0,
4074 'previewonfirst' => 0,
4075 'previewontop' => 1,
4076 'rcdays' => 7,
4077 'rclimit' => 50,
4078 'rows' => 25,
4079 'showhiddencats' => 0,
4080 'shownumberswatching' => 1,
4081 'showtoolbar' => 1,
4082 'skin' => false,
4083 'stubthreshold' => 0,
4084 'thumbsize' => 2,
4085 'underline' => 2,
4086 'uselivepreview' => 0,
4087 'usenewrc' => 0,
4088 'watchcreations' => 1,
4089 'watchdefault' => 1,
4090 'watchdeletion' => 0,
4091 'watchlistdays' => 3.0,
4092 'watchlisthideanons' => 0,
4093 'watchlisthidebots' => 0,
4094 'watchlisthideliu' => 0,
4095 'watchlisthideminor' => 0,
4096 'watchlisthideown' => 0,
4097 'watchlisthidepatrolled' => 0,
4098 'watchmoves' => 0,
4099 'wllimit' => 250,
4100 'useeditwarning' => 1,
4101 'prefershttps' => 1,
4105 * An array of preferences to not show for the user
4107 $wgHiddenPrefs = array();
4110 * Characters to prevent during new account creations.
4111 * This is used in a regular expression character class during
4112 * registration (regex metacharacters like / are escaped).
4114 $wgInvalidUsernameCharacters = '@';
4117 * Character used as a delimiter when testing for interwiki userrights
4118 * (In Special:UserRights, it is possible to modify users on different
4119 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4121 * It is recommended that you have this delimiter in
4122 * $wgInvalidUsernameCharacters above, or you will not be able to
4123 * modify the user rights of those users via Special:UserRights
4125 $wgUserrightsInterwikiDelimiter = '@';
4128 * This is to let user authenticate using https when they come from http.
4129 * Based on an idea by George Herbert on wikitech-l:
4130 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4131 * @since 1.17
4133 $wgSecureLogin = false;
4135 /** @} */ # end user accounts }
4137 /************************************************************************//**
4138 * @name User rights, access control and monitoring
4139 * @{
4143 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4145 $wgAutoblockExpiry = 86400;
4148 * Set this to true to allow blocked users to edit their own user talk page.
4150 $wgBlockAllowsUTEdit = false;
4153 * Allow sysops to ban users from accessing Emailuser
4155 $wgSysopEmailBans = true;
4158 * Limits on the possible sizes of range blocks.
4160 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4161 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4162 * half the number of bits avoids such errors, and allows entire ISPs to be
4163 * blocked using a small number of range blocks.
4165 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4166 * customer, so range blocks larger than /64 (half the number of bits) will
4167 * plainly be required. RFC 4692 implies that a very large ISP may be
4168 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4169 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4171 $wgBlockCIDRLimit = array(
4172 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4173 'IPv6' => 19,
4177 * If true, blocked users will not be allowed to login. When using this with
4178 * a public wiki, the effect of logging out blocked users may actually be
4179 * avers: unless the user's address is also blocked (e.g. auto-block),
4180 * logging the user out will again allow reading and editing, just as for
4181 * anonymous visitors.
4183 $wgBlockDisablesLogin = false;
4186 * Pages anonymous user may see, set as an array of pages titles.
4188 * @par Example:
4189 * @code
4190 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4191 * @endcode
4193 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4195 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4196 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4198 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4199 * will remain readable. You can use img_auth.php to protect uploaded files,
4200 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4202 $wgWhitelistRead = false;
4205 * Pages anonymous user may see, set as an array of regular expressions.
4207 * This function will match the regexp against the title name, which
4208 * is without underscore.
4210 * @par Example:
4211 * To whitelist [[Main Page]]:
4212 * @code
4213 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4214 * @endcode
4216 * @note Unless ^ and/or $ is specified, a regular expression might match
4217 * pages not intended to be whitelisted. The above example will also
4218 * whitelist a page named 'Security Main Page'.
4220 * @par Example:
4221 * To allow reading any page starting with 'User' regardless of the case:
4222 * @code
4223 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4224 * @endcode
4225 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4227 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4228 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4230 $wgWhitelistReadRegexp = false;
4233 * Should editors be required to have a validated e-mail
4234 * address before being allowed to edit?
4236 $wgEmailConfirmToEdit = false;
4239 * Permission keys given to users in each group.
4241 * This is an array where the keys are all groups and each value is an
4242 * array of the format (right => boolean).
4244 * The second format is used to support per-namespace permissions.
4245 * Note that this feature does not fully work for all permission types.
4247 * All users are implicitly in the '*' group including anonymous visitors;
4248 * logged-in users are all implicitly in the 'user' group. These will be
4249 * combined with the permissions of all groups that a given user is listed
4250 * in in the user_groups table.
4252 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4253 * doing! This will wipe all permissions, and may mean that your users are
4254 * unable to perform certain essential tasks or access new functionality
4255 * when new permissions are introduced and default grants established.
4257 * Functionality to make pages inaccessible has not been extensively tested
4258 * for security. Use at your own risk!
4260 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4262 $wgGroupPermissions = array();
4264 /** @cond file_level_code */
4265 // Implicit group for all visitors
4266 $wgGroupPermissions['*']['createaccount'] = true;
4267 $wgGroupPermissions['*']['read'] = true;
4268 $wgGroupPermissions['*']['edit'] = true;
4269 $wgGroupPermissions['*']['createpage'] = true;
4270 $wgGroupPermissions['*']['createtalk'] = true;
4271 $wgGroupPermissions['*']['writeapi'] = true;
4272 $wgGroupPermissions['*']['editmyusercss'] = true;
4273 $wgGroupPermissions['*']['editmyuserjs'] = true;
4274 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4275 $wgGroupPermissions['*']['editmywatchlist'] = true;
4276 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4277 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4278 $wgGroupPermissions['*']['editmyoptions'] = true;
4279 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4281 // Implicit group for all logged-in accounts
4282 $wgGroupPermissions['user']['move'] = true;
4283 $wgGroupPermissions['user']['move-subpages'] = true;
4284 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4285 $wgGroupPermissions['user']['move-categorypages'] = true;
4286 $wgGroupPermissions['user']['movefile'] = true;
4287 $wgGroupPermissions['user']['read'] = true;
4288 $wgGroupPermissions['user']['edit'] = true;
4289 $wgGroupPermissions['user']['createpage'] = true;
4290 $wgGroupPermissions['user']['createtalk'] = true;
4291 $wgGroupPermissions['user']['writeapi'] = true;
4292 $wgGroupPermissions['user']['upload'] = true;
4293 $wgGroupPermissions['user']['reupload'] = true;
4294 $wgGroupPermissions['user']['reupload-shared'] = true;
4295 $wgGroupPermissions['user']['minoredit'] = true;
4296 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4297 $wgGroupPermissions['user']['sendemail'] = true;
4299 // Implicit group for accounts that pass $wgAutoConfirmAge
4300 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4301 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4303 // Users with bot privilege can have their edits hidden
4304 // from various log pages by default
4305 $wgGroupPermissions['bot']['bot'] = true;
4306 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4307 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4308 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4309 $wgGroupPermissions['bot']['autopatrol'] = true;
4310 $wgGroupPermissions['bot']['suppressredirect'] = true;
4311 $wgGroupPermissions['bot']['apihighlimits'] = true;
4312 $wgGroupPermissions['bot']['writeapi'] = true;
4314 // Most extra permission abilities go to this group
4315 $wgGroupPermissions['sysop']['block'] = true;
4316 $wgGroupPermissions['sysop']['createaccount'] = true;
4317 $wgGroupPermissions['sysop']['delete'] = true;
4318 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4319 $wgGroupPermissions['sysop']['bigdelete'] = true;
4320 // can view deleted history entries, but not see or restore the text
4321 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4322 // can view deleted revision text
4323 $wgGroupPermissions['sysop']['deletedtext'] = true;
4324 $wgGroupPermissions['sysop']['undelete'] = true;
4325 $wgGroupPermissions['sysop']['editinterface'] = true;
4326 $wgGroupPermissions['sysop']['editusercss'] = true;
4327 $wgGroupPermissions['sysop']['edituserjs'] = true;
4328 $wgGroupPermissions['sysop']['import'] = true;
4329 $wgGroupPermissions['sysop']['importupload'] = true;
4330 $wgGroupPermissions['sysop']['move'] = true;
4331 $wgGroupPermissions['sysop']['move-subpages'] = true;
4332 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4333 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4334 $wgGroupPermissions['sysop']['patrol'] = true;
4335 $wgGroupPermissions['sysop']['autopatrol'] = true;
4336 $wgGroupPermissions['sysop']['protect'] = true;
4337 $wgGroupPermissions['sysop']['editprotected'] = true;
4338 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4339 $wgGroupPermissions['sysop']['rollback'] = true;
4340 $wgGroupPermissions['sysop']['upload'] = true;
4341 $wgGroupPermissions['sysop']['reupload'] = true;
4342 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4343 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4344 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4345 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4346 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4347 $wgGroupPermissions['sysop']['blockemail'] = true;
4348 $wgGroupPermissions['sysop']['markbotedits'] = true;
4349 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4350 $wgGroupPermissions['sysop']['browsearchive'] = true;
4351 $wgGroupPermissions['sysop']['noratelimit'] = true;
4352 $wgGroupPermissions['sysop']['movefile'] = true;
4353 $wgGroupPermissions['sysop']['unblockself'] = true;
4354 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4355 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4356 #$wgGroupPermissions['sysop']['mergehistory'] = true;
4358 // Permission to change users' group assignments
4359 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4360 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4361 // Permission to change users' groups assignments across wikis
4362 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4363 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4364 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4366 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4367 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4368 // To hide usernames from users and Sysops
4369 #$wgGroupPermissions['suppress']['hideuser'] = true;
4370 // To hide revisions/log items from users and Sysops
4371 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4372 // For private suppression log access
4373 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4376 * The developer group is deprecated, but can be activated if need be
4377 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4378 * that a lock file be defined and creatable/removable by the web
4379 * server.
4381 # $wgGroupPermissions['developer']['siteadmin'] = true;
4383 /** @endcond */
4386 * Permission keys revoked from users in each group.
4388 * This acts the same way as wgGroupPermissions above, except that
4389 * if the user is in a group here, the permission will be removed from them.
4391 * Improperly setting this could mean that your users will be unable to perform
4392 * certain essential tasks, so use at your own risk!
4394 $wgRevokePermissions = array();
4397 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4399 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4402 * A map of group names that the user is in, to group names that those users
4403 * are allowed to add or revoke.
4405 * Setting the list of groups to add or revoke to true is equivalent to "any
4406 * group".
4408 * @par Example:
4409 * To allow sysops to add themselves to the "bot" group:
4410 * @code
4411 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4412 * @endcode
4414 * @par Example:
4415 * Implicit groups may be used for the source group, for instance:
4416 * @code
4417 * $wgGroupsRemoveFromSelf = array( '*' => true );
4418 * @endcode
4419 * This allows users in the '*' group (i.e. any user) to remove themselves from
4420 * any group that they happen to be in.
4422 $wgGroupsAddToSelf = array();
4425 * @see $wgGroupsAddToSelf
4427 $wgGroupsRemoveFromSelf = array();
4430 * Set of available actions that can be restricted via action=protect
4431 * You probably shouldn't change this.
4432 * Translated through restriction-* messages.
4433 * Title::getRestrictionTypes() will remove restrictions that are not
4434 * applicable to a specific title (create and upload)
4436 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4439 * Rights which can be required for each protection level (via action=protect)
4441 * You can add a new protection level that requires a specific
4442 * permission by manipulating this array. The ordering of elements
4443 * dictates the order on the protection form's lists.
4445 * - '' will be ignored (i.e. unprotected)
4446 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4447 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4449 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4452 * Restriction levels that can be used with cascading protection
4454 * A page can only be protected with cascading protection if the
4455 * requested restriction level is included in this array.
4457 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4458 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4460 $wgCascadingRestrictionLevels = array( 'sysop' );
4463 * Restriction levels that should be considered "semiprotected"
4465 * Certain places in the interface recognize a dichotomy between "protected"
4466 * and "semiprotected", without further distinguishing the specific levels. In
4467 * general, if anyone can be eligible to edit a protection level merely by
4468 * reaching some condition in $wgAutopromote, it should probably be considered
4469 * "semiprotected".
4471 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4472 * 'sysop' is not changed, since it really shouldn't be here.
4474 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4477 * Set the minimum permissions required to edit pages in each
4478 * namespace. If you list more than one permission, a user must
4479 * have all of them to edit pages in that namespace.
4481 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4483 $wgNamespaceProtection = array();
4486 * Pages in namespaces in this array can not be used as templates.
4488 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4489 * namespaces constants (NS_USER, NS_MAIN...).
4491 * Among other things, this may be useful to enforce read-restrictions
4492 * which may otherwise be bypassed by using the template mechanism.
4494 $wgNonincludableNamespaces = array();
4497 * Number of seconds an account is required to age before it's given the
4498 * implicit 'autoconfirm' group membership. This can be used to limit
4499 * privileges of new accounts.
4501 * Accounts created by earlier versions of the software may not have a
4502 * recorded creation date, and will always be considered to pass the age test.
4504 * When left at 0, all registered accounts will pass.
4506 * @par Example:
4507 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4508 * @code
4509 * $wgAutoConfirmAge = 600; // ten minutes
4510 * @endcode
4511 * Set age to one day:
4512 * @code
4513 * $wgAutoConfirmAge = 3600*24; // one day
4514 * @endcode
4516 $wgAutoConfirmAge = 0;
4519 * Number of edits an account requires before it is autoconfirmed.
4520 * Passing both this AND the time requirement is needed. Example:
4522 * @par Example:
4523 * @code
4524 * $wgAutoConfirmCount = 50;
4525 * @endcode
4527 $wgAutoConfirmCount = 0;
4530 * Automatically add a usergroup to any user who matches certain conditions.
4532 * @todo Redocument $wgAutopromote
4534 * The format is
4535 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4536 * where cond1, cond2, ... are themselves conditions; *OR*
4537 * APCOND_EMAILCONFIRMED, *OR*
4538 * array( APCOND_EMAILCONFIRMED ), *OR*
4539 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4540 * array( APCOND_AGE, seconds since registration ), *OR*
4541 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4542 * array( APCOND_ISIP, ip ), *OR*
4543 * array( APCOND_IPINRANGE, range ), *OR*
4544 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4545 * array( APCOND_BLOCKED ), *OR*
4546 * array( APCOND_ISBOT ), *OR*
4547 * similar constructs defined by extensions.
4549 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4550 * user who has provided an e-mail address.
4552 $wgAutopromote = array(
4553 'autoconfirmed' => array( '&',
4554 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4555 array( APCOND_AGE, &$wgAutoConfirmAge ),
4560 * Automatically add a usergroup to any user who matches certain conditions.
4562 * Does not add the user to the group again if it has been removed.
4563 * Also, does not remove the group if the user no longer meets the criteria.
4565 * The format is:
4566 * @code
4567 * array( event => criteria, ... )
4568 * @endcode
4569 * Where event is either:
4570 * - 'onEdit' (when user edits)
4571 * - 'onView' (when user views the wiki)
4573 * Criteria has the same format as $wgAutopromote
4575 * @see $wgAutopromote
4576 * @since 1.18
4578 $wgAutopromoteOnce = array(
4579 'onEdit' => array(),
4580 'onView' => array()
4584 * Put user rights log entries for autopromotion in recent changes?
4585 * @since 1.18
4587 $wgAutopromoteOnceLogInRC = true;
4590 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4591 * can assign which groups at Special:Userrights.
4593 * @par Example:
4594 * Bureaucrats can add any group:
4595 * @code
4596 * $wgAddGroups['bureaucrat'] = true;
4597 * @endcode
4598 * Bureaucrats can only remove bots and sysops:
4599 * @code
4600 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4601 * @endcode
4602 * Sysops can make bots:
4603 * @code
4604 * $wgAddGroups['sysop'] = array( 'bot' );
4605 * @endcode
4606 * Sysops can disable other sysops in an emergency, and disable bots:
4607 * @code
4608 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4609 * @endcode
4611 $wgAddGroups = array();
4614 * @see $wgAddGroups
4616 $wgRemoveGroups = array();
4619 * A list of available rights, in addition to the ones defined by the core.
4620 * For extensions only.
4622 $wgAvailableRights = array();
4625 * Optional to restrict deletion of pages with higher revision counts
4626 * to users with the 'bigdelete' permission. (Default given to sysops.)
4628 $wgDeleteRevisionsLimit = 0;
4631 * The maximum number of edits a user can have and
4632 * can still be hidden by users with the hideuser permission.
4633 * This is limited for performance reason.
4634 * Set to false to disable the limit.
4635 * @since 1.23
4637 $wgHideUserContribLimit = 1000;
4640 * Number of accounts each IP address may create, 0 to disable.
4642 * @warning Requires memcached
4644 $wgAccountCreationThrottle = 0;
4647 * Edits matching these regular expressions in body text
4648 * will be recognised as spam and rejected automatically.
4650 * There's no administrator override on-wiki, so be careful what you set. :)
4651 * May be an array of regexes or a single string for backwards compatibility.
4653 * @see http://en.wikipedia.org/wiki/Regular_expression
4655 * @note Each regex needs a beginning/end delimiter, eg: # or /
4657 $wgSpamRegex = array();
4660 * Same as the above except for edit summaries
4662 $wgSummarySpamRegex = array();
4665 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4666 * proxies
4667 * @since 1.16
4669 $wgEnableDnsBlacklist = false;
4672 * @deprecated since 1.17 Use $wgEnableDnsBlacklist instead, only kept for
4673 * backward compatibility.
4675 $wgEnableSorbs = false;
4678 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4680 * This is an array of either a URL or an array with the URL and a key (should
4681 * the blacklist require a key).
4683 * @par Example:
4684 * @code
4685 * $wgDnsBlacklistUrls = array(
4686 * // String containing URL
4687 * 'http.dnsbl.sorbs.net.',
4688 * // Array with URL and key, for services that require a key
4689 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4690 * // Array with just the URL. While this works, it is recommended that you
4691 * // just use a string as shown above
4692 * array( 'opm.tornevall.org.' )
4693 * );
4694 * @endcode
4696 * @note You should end the domain name with a . to avoid searching your
4697 * eventual domain search suffixes.
4698 * @since 1.16
4700 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4703 * @deprecated since 1.17 Use $wgDnsBlacklistUrls instead, only kept for
4704 * backward compatibility.
4706 $wgSorbsUrl = array();
4709 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4710 * what the other methods might say.
4712 $wgProxyWhitelist = array();
4715 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4716 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4717 * (transparent) proxies without needing to block the proxies themselves.
4719 $wgApplyIpBlocksToXff = false;
4722 * Simple rate limiter options to brake edit floods.
4724 * Maximum number actions allowed in the given number of seconds; after that
4725 * the violating client receives HTTP 500 error pages until the period
4726 * elapses.
4728 * @par Example:
4729 * To set a generic maximum of 4 hits in 60 seconds:
4730 * @code
4731 * $wgRateLimits = array( 4, 60 );
4732 * @endcode
4734 * You could also limit per action and then type of users. See the inline
4735 * code for a template to use.
4737 * This option set is experimental and likely to change.
4739 * @warning Requires memcached.
4741 $wgRateLimits = array(
4742 'edit' => array(
4743 'anon' => null, // for any and all anonymous edits (aggregate)
4744 'user' => null, // for each logged-in user
4745 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4746 'ip' => null, // for each anon and recent account
4747 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4749 'move' => array(
4750 'user' => null,
4751 'newbie' => null,
4752 'ip' => null,
4753 'subnet' => null,
4755 'mailpassword' => array( // triggering password resets emails
4756 'anon' => null,
4758 'emailuser' => array( // emailing other users using MediaWiki
4759 'user' => null,
4761 'linkpurge' => array( // purges of link tables
4762 'anon' => null,
4763 'user' => null,
4764 'newbie' => null,
4765 'ip' => null,
4766 'subnet' => null,
4768 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4769 'anon' => null,
4770 'user' => null,
4771 'newbie' => null,
4772 'ip' => null,
4773 'subnet' => null,
4775 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
4776 'anon' => null,
4777 'user' => null,
4778 'newbie' => null,
4779 'ip' => null,
4780 'subnet' => null,
4785 * Set to a filename to log rate limiter hits.
4787 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
4789 $wgRateLimitLog = null;
4792 * Array of IPs which should be excluded from rate limits.
4793 * This may be useful for whitelisting NAT gateways for conferences, etc.
4795 $wgRateLimitsExcludedIPs = array();
4798 * Log IP addresses in the recentchanges table; can be accessed only by
4799 * extensions (e.g. CheckUser) or a DB admin
4800 * Used for retroactive autoblocks
4802 $wgPutIPinRC = true;
4805 * Integer defining default number of entries to show on
4806 * special pages which are query-pages such as Special:Whatlinkshere.
4808 $wgQueryPageDefaultLimit = 50;
4811 * Limit password attempts to X attempts per Y seconds per IP per account.
4813 * @warning Requires memcached.
4815 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4817 /** @} */ # end of user rights settings
4819 /************************************************************************//**
4820 * @name Proxy scanner settings
4821 * @{
4825 * This should always be customised in LocalSettings.php
4827 $wgSecretKey = false;
4830 * Big list of banned IP addresses.
4832 * This can have the following formats:
4833 * - An array of addresses, either in the values
4834 * or the keys (for backward compatibility)
4835 * - A string, in that case this is the path to a file
4836 * containing the list of IP addresses, one per line
4838 $wgProxyList = array();
4840 /** @} */ # end of proxy scanner settings
4842 /************************************************************************//**
4843 * @name Cookie settings
4844 * @{
4848 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
4850 $wgCookieExpiration = 180 * 86400;
4853 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
4854 * or ".any.subdomain.net"
4856 $wgCookieDomain = '';
4859 * Set this variable if you want to restrict cookies to a certain path within
4860 * the domain specified by $wgCookieDomain.
4862 $wgCookiePath = '/';
4865 * Whether the "secure" flag should be set on the cookie. This can be:
4866 * - true: Set secure flag
4867 * - false: Don't set secure flag
4868 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
4870 $wgCookieSecure = 'detect';
4873 * By default, MediaWiki checks if the client supports cookies during the
4874 * login process, so that it can display an informative error message if
4875 * cookies are disabled. Set this to true if you want to disable this cookie
4876 * check.
4878 $wgDisableCookieCheck = false;
4881 * Cookies generated by MediaWiki have names starting with this prefix. Set it
4882 * to a string to use a custom prefix. Setting it to false causes the database
4883 * name to be used as a prefix.
4885 $wgCookiePrefix = false;
4888 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
4889 * in browsers that support this feature. This can mitigates some classes of
4890 * XSS attack.
4892 $wgCookieHttpOnly = true;
4895 * A list of cookies that vary the cache (for use by extensions)
4897 $wgCacheVaryCookies = array();
4900 * Override to customise the session name
4902 $wgSessionName = false;
4904 /** @} */ # end of cookie settings }
4906 /************************************************************************//**
4907 * @name LaTeX (mathematical formulas)
4908 * @{
4912 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
4913 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
4914 * (ImageMagick) installed and available in the PATH.
4915 * Please see math/README for more information.
4917 $wgUseTeX = false;
4919 /** @} */ # end LaTeX }
4921 /************************************************************************//**
4922 * @name Profiling, testing and debugging
4924 * To enable profiling, edit StartProfiler.php
4926 * @{
4930 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
4931 * The debug log file should be not be publicly accessible if it is used, as it
4932 * may contain private data.
4934 $wgDebugLogFile = '';
4937 * Prefix for debug log lines
4939 $wgDebugLogPrefix = '';
4942 * If true, instead of redirecting, show a page with a link to the redirect
4943 * destination. This allows for the inspection of PHP error messages, and easy
4944 * resubmission of form data. For developer use only.
4946 $wgDebugRedirects = false;
4949 * If true, log debugging data from action=raw and load.php.
4950 * This is normally false to avoid overlapping debug entries due to gen=css
4951 * and gen=js requests.
4953 $wgDebugRawPage = false;
4956 * Send debug data to an HTML comment in the output.
4958 * This may occasionally be useful when supporting a non-technical end-user.
4959 * It's more secure than exposing the debug log file to the web, since the
4960 * output only contains private data for the current user. But it's not ideal
4961 * for development use since data is lost on fatal errors and redirects.
4963 $wgDebugComments = false;
4966 * Extensive database transaction state debugging
4968 * @since 1.20
4970 $wgDebugDBTransactions = false;
4973 * Write SQL queries to the debug log
4975 $wgDebugDumpSql = false;
4978 * Map of string log group names to log destinations.
4980 * If set, wfDebugLog() output for that group will go to that file instead
4981 * of the regular $wgDebugLogFile. Useful for enabling selective logging
4982 * in production.
4984 * Log destinations may be one of the following:
4985 * - false to completely remove from the output, including from $wgDebugLogFile.
4986 * - string values specifying a filename or URI.
4987 * - associative array mapping 'destination' key to the desired filename or URI.
4988 * The associative array may also contain a 'sample' key with an integer value,
4989 * specifying a sampling factor.
4991 * @par Example:
4992 * @code
4993 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
4994 * @endcode
4996 * @par Advanced example:
4997 * @code
4998 * $wgDebugLogGroups['memcached'] = (
4999 * 'destination' => '/var/log/mediawiki/memcached.log',
5000 * 'sample' => 1000, // log 1 message out of every 1,000.
5001 * );
5002 * @endcode
5004 $wgDebugLogGroups = array();
5007 * Display debug data at the bottom of the main content area.
5009 * Useful for developers and technical users trying to working on a closed wiki.
5011 $wgShowDebug = false;
5014 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5015 * Since 1.19 also includes memory usage.
5017 $wgDebugTimestamps = false;
5020 * Print HTTP headers for every request in the debug information.
5022 $wgDebugPrintHttpHeaders = true;
5025 * Show the contents of $wgHooks in Special:Version
5027 $wgSpecialVersionShowHooks = false;
5030 * Whether to show "we're sorry, but there has been a database error" pages.
5031 * Displaying errors aids in debugging, but may display information useful
5032 * to an attacker.
5034 $wgShowSQLErrors = false;
5037 * If set to true, uncaught exceptions will print a complete stack trace
5038 * to output. This should only be used for debugging, as it may reveal
5039 * private information in function parameters due to PHP's backtrace
5040 * formatting.
5042 $wgShowExceptionDetails = false;
5045 * If true, show a backtrace for database errors
5047 * @note This setting only applies when connection errors and query errors are
5048 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5049 * including those in which an uncaught exception is thrown from within the
5050 * exception handler.
5052 $wgShowDBErrorBacktrace = false;
5055 * If true, send the exception backtrace to the error log
5057 $wgLogExceptionBacktrace = true;
5060 * Expose backend server host names through the API and various HTML comments
5062 $wgShowHostnames = false;
5065 * Override server hostname detection with a hardcoded value.
5066 * Should be a string, default false.
5067 * @since 1.20
5069 $wgOverrideHostname = false;
5072 * If set to true MediaWiki will throw notices for some possible error
5073 * conditions and for deprecated functions.
5075 $wgDevelopmentWarnings = false;
5078 * Release limitation to wfDeprecated warnings, if set to a release number
5079 * development warnings will not be generated for deprecations added in releases
5080 * after the limit.
5082 $wgDeprecationReleaseLimit = false;
5085 * Only record profiling info for pages that took longer than this
5087 $wgProfileLimit = 0.0;
5090 * Don't put non-profiling info into log file
5092 * @deprecated since 1.23, set the log file in
5093 * $wgDebugLogGroups['profileoutput'] instead.
5095 $wgProfileOnly = false;
5098 * If true, print a raw call tree instead of per-function report
5100 $wgProfileCallTree = false;
5103 * Should application server host be put into profiling table
5105 $wgProfilePerHost = false;
5108 * Host for UDP profiler.
5110 * The host should be running a daemon which can be obtained from MediaWiki
5111 * Git at:
5112 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5114 $wgUDPProfilerHost = '127.0.0.1';
5117 * Port for UDP profiler.
5118 * @see $wgUDPProfilerHost
5120 $wgUDPProfilerPort = '3811';
5123 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5124 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name) as arguments.
5125 * You can use sprintf's argument numbering/swapping capability to repeat,
5126 * re-order or omit fields.
5128 * @see $wgStatsFormatString
5129 * @since 1.22
5131 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5134 * Output debug message on every wfProfileIn/wfProfileOut
5136 $wgDebugFunctionEntry = false;
5139 * Destination for wfIncrStats() data...
5140 * 'cache' to go into the system cache, if enabled (memcached)
5141 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5142 * false to disable
5144 $wgStatsMethod = 'cache';
5147 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5148 * be aggregated over more than one wiki. The string will be used in place of
5149 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5150 * will be used.
5152 $wgAggregateStatsID = false;
5155 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5156 * formatted. Its value should be a format string suitable for a sprintf()
5157 * invocation with (id, count, key) arguments, where 'id' is either
5158 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5159 * is being incremented, and 'key' is the metric name.
5161 * @see $wgUDPProfilerFormatString
5162 * @see $wgAggregateStatsID
5163 * @since 1.22
5165 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5168 * Whereas to count the number of time an article is viewed.
5169 * Does not work if pages are cached (for example with squid).
5171 $wgDisableCounters = false;
5174 * InfoAction retrieves a list of transclusion links (both to and from).
5175 * This number puts a limit on that query in the case of highly transcluded
5176 * templates.
5178 $wgPageInfoTransclusionLimit = 50;
5181 * Set this to an integer to only do synchronous site_stats updates
5182 * one every *this many* updates. The other requests go into pending
5183 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5184 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5186 $wgSiteStatsAsyncFactor = false;
5189 * Parser test suite files to be run by parserTests.php when no specific
5190 * filename is passed to it.
5192 * Extensions may add their own tests to this array, or site-local tests
5193 * may be added via LocalSettings.php
5195 * Use full paths.
5197 $wgParserTestFiles = array(
5198 "$IP/tests/parser/parserTests.txt",
5199 "$IP/tests/parser/extraParserTests.txt"
5203 * If configured, specifies target CodeReview installation to send test
5204 * result data from 'parserTests.php --upload'
5206 * Something like this:
5207 * $wgParserTestRemote = array(
5208 * 'api-url' => 'https://www.mediawiki.org/w/api.php',
5209 * 'repo' => 'MediaWiki',
5210 * 'suite' => 'ParserTests',
5211 * 'path' => '/trunk/phase3', // not used client-side; for reference
5212 * 'secret' => 'qmoicj3mc4mcklmqw', // Shared secret used in HMAC validation
5213 * );
5215 $wgParserTestRemote = false;
5218 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5220 $wgEnableJavaScriptTest = false;
5223 * Configuration for javascript testing.
5225 $wgJavaScriptTestConfig = array(
5226 'qunit' => array(
5227 // Page where documentation can be found relevant to the QUnit test suite being ran.
5228 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5229 // documentation link in the "javascripttest-qunit-intro" message.
5230 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5231 // If you are submitting the QUnit test suite to a TestSwarm instance,
5232 // point this to the "inject.js" script of that instance. This is was registers
5233 // the QUnit hooks to extract the test results and push them back up into the
5234 // TestSwarm database.
5235 // @example 'http://localhost/testswarm/js/inject.js'
5236 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5237 'testswarm-injectjs' => false,
5242 * Overwrite the caching key prefix with custom value.
5243 * @since 1.19
5245 $wgCachePrefix = false;
5248 * Display the new debugging toolbar. This also enables profiling on database
5249 * queries and other useful output.
5250 * Will disable file cache.
5252 * @since 1.19
5254 $wgDebugToolbar = false;
5256 /** @} */ # end of profiling, testing and debugging }
5258 /************************************************************************//**
5259 * @name Search
5260 * @{
5264 * Set this to true to disable the full text search feature.
5266 $wgDisableTextSearch = false;
5269 * Set to true to have nicer highlighted text in search results,
5270 * by default off due to execution overhead
5272 $wgAdvancedSearchHighlighting = false;
5275 * Regexp to match word boundaries, defaults for non-CJK languages
5276 * should be empty for CJK since the words are not separate
5278 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5281 * Set to true to have the search engine count total
5282 * search matches to present in the Special:Search UI.
5283 * Not supported by every search engine shipped with MW.
5285 * This could however be slow on larger wikis, and is pretty flaky
5286 * with the current title vs content split. Recommend avoiding until
5287 * that's been worked out cleanly; but this may aid in testing the
5288 * search UI and API to confirm that the result count works.
5290 $wgCountTotalSearchHits = false;
5293 * Template for OpenSearch suggestions, defaults to API action=opensearch
5295 * Sites with heavy load would typically have these point to a custom
5296 * PHP wrapper to avoid firing up mediawiki for every keystroke
5298 * Placeholders: {searchTerms}
5300 $wgOpenSearchTemplate = false;
5303 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5304 * false if you've disabled scripts that use api?action=opensearch and
5305 * want reduce load caused by cached scripts still pulling suggestions.
5306 * It will let the API fallback by responding with an empty array.
5308 $wgEnableOpenSearchSuggest = true;
5311 * Integer defining default number of entries to show on
5312 * OpenSearch call.
5314 $wgOpenSearchDefaultLimit = 10;
5317 * Expiry time for search suggestion responses
5319 $wgSearchSuggestCacheExpiry = 1200;
5322 * If you've disabled search semi-permanently, this also disables updates to the
5323 * table. If you ever re-enable, be sure to rebuild the search table.
5325 $wgDisableSearchUpdate = false;
5328 * List of namespaces which are searched by default.
5330 * @par Example:
5331 * @code
5332 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5333 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5334 * @endcode
5336 $wgNamespacesToBeSearchedDefault = array(
5337 NS_MAIN => true,
5341 * Disable the internal MySQL-based search, to allow it to be
5342 * implemented by an extension instead.
5344 $wgDisableInternalSearch = false;
5347 * Set this to a URL to forward search requests to some external location.
5348 * If the URL includes '$1', this will be replaced with the URL-encoded
5349 * search term.
5351 * @par Example:
5352 * To forward to Google you'd have something like:
5353 * @code
5354 * $wgSearchForwardUrl =
5355 * 'http://www.google.com/search?q=$1' .
5356 * '&domains=http://example.com' .
5357 * '&sitesearch=http://example.com' .
5358 * '&ie=utf-8&oe=utf-8';
5359 * @endcode
5361 $wgSearchForwardUrl = null;
5364 * Search form behavior.
5365 * - true = use Go & Search buttons
5366 * - false = use Go button & Advanced search link
5368 $wgUseTwoButtonsSearchForm = true;
5371 * Array of namespaces to generate a Google sitemap for when the
5372 * maintenance/generateSitemap.php script is run, or false if one is to be
5373 * generated for all namespaces.
5375 $wgSitemapNamespaces = false;
5378 * Custom namespace priorities for sitemaps. Setting this will allow you to
5379 * set custom priorities to namespaces when sitemaps are generated using the
5380 * maintenance/generateSitemap.php script.
5382 * This should be a map of namespace IDs to priority
5383 * @par Example:
5384 * @code
5385 * $wgSitemapNamespacesPriorities = array(
5386 * NS_USER => '0.9',
5387 * NS_HELP => '0.0',
5388 * );
5389 * @endcode
5391 $wgSitemapNamespacesPriorities = false;
5394 * If true, searches for IP addresses will be redirected to that IP's
5395 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5396 * [[Special:Contributions/1.2.3.4]]
5398 $wgEnableSearchContributorsByIP = true;
5400 /** @} */ # end of search settings
5402 /************************************************************************//**
5403 * @name Edit user interface
5404 * @{
5408 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5409 * fall back to the old behavior (no merging).
5411 $wgDiff3 = '/usr/bin/diff3';
5414 * Path to the GNU diff utility.
5416 $wgDiff = '/usr/bin/diff';
5419 * Which namespaces have special treatment where they should be preview-on-open
5420 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5421 * can specify namespaces of pages they have special treatment for
5423 $wgPreviewOnOpenNamespaces = array(
5424 NS_CATEGORY => true
5428 * Go button goes straight to the edit screen if the article doesn't exist.
5430 $wgGoToEdit = false;
5433 * Enable the UniversalEditButton for browsers that support it
5434 * (currently only Firefox with an extension)
5435 * See http://universaleditbutton.org for more background information
5437 $wgUniversalEditButton = true;
5440 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5441 * will try to automatically create one. This feature can be disabled by set-
5442 * ting this variable false.
5444 $wgUseAutomaticEditSummaries = true;
5446 /** @} */ # end edit UI }
5448 /************************************************************************//**
5449 * @name Maintenance
5450 * See also $wgSiteNotice
5451 * @{
5455 * @cond file_level_code
5456 * Set $wgCommandLineMode if it's not set already, to avoid notices
5458 if ( !isset( $wgCommandLineMode ) ) {
5459 $wgCommandLineMode = false;
5461 /** @endcond */
5464 * For colorized maintenance script output, is your terminal background dark ?
5466 $wgCommandLineDarkBg = false;
5469 * Set this to a string to put the wiki into read-only mode. The text will be
5470 * used as an explanation to users.
5472 * This prevents most write operations via the web interface. Cache updates may
5473 * still be possible. To prevent database writes completely, use the read_only
5474 * option in MySQL.
5476 $wgReadOnly = null;
5479 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5480 * Its contents will be shown to users as part of the read-only warning
5481 * message.
5483 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5485 $wgReadOnlyFile = false;
5488 * When you run the web-based upgrade utility, it will tell you what to set
5489 * this to in order to authorize the upgrade process. It will subsequently be
5490 * used as a password, to authorize further upgrades.
5492 * For security, do not set this to a guessable string. Use the value supplied
5493 * by the install/upgrade process. To cause the upgrader to generate a new key,
5494 * delete the old key from LocalSettings.php.
5496 $wgUpgradeKey = false;
5499 * Fully specified path to git binary
5501 $wgGitBin = '/usr/bin/git';
5504 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5506 * Key is a pattern passed to preg_match() and preg_replace(),
5507 * without the delimiters (which are #) and must match the whole URL.
5508 * The value is the replacement for the key (it can contain $1, etc.)
5509 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5510 * full SHA-1 of the HEAD revision.
5511 * %r will be replaced with a URL-encoded version of $1.
5513 * @since 1.20
5515 $wgGitRepositoryViewers = array(
5516 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5517 'https://git.wikimedia.org/commit/%r/%H',
5518 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5519 'https://git.wikimedia.org/commit/%r/%H',
5522 /** @} */ # End of maintenance }
5524 /************************************************************************//**
5525 * @name Recent changes, new pages, watchlist and history
5526 * @{
5530 * Recentchanges items are periodically purged; entries older than this many
5531 * seconds will go.
5532 * Default: 13 weeks = about three months
5534 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5537 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5538 * higher than what will be stored. Note that this is disabled by default
5539 * because we sometimes do have RC data which is beyond the limit for some
5540 * reason, and some users may use the high numbers to display that data which
5541 * is still there.
5543 $wgRCFilterByAge = false;
5546 * List of Limits options to list in the Special:Recentchanges and
5547 * Special:Recentchangeslinked pages.
5549 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5552 * List of Days options to list in the Special:Recentchanges and
5553 * Special:Recentchangeslinked pages.
5555 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5558 * Send recent changes updates via UDP. The updates will be formatted for IRC.
5559 * Set this to the IP address of the receiver.
5561 * @deprecated since 1.22, use $wgRCFeeds
5563 $wgRC2UDPAddress = false;
5566 * Port number for RC updates
5568 * @deprecated since 1.22, use $wgRCFeeds
5570 $wgRC2UDPPort = false;
5573 * Prefix to prepend to each UDP packet.
5574 * This can be used to identify the wiki. A script is available called
5575 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
5576 * tab to identify the IRC channel to send the log line to.
5578 * @deprecated since 1.22, use $wgRCFeeds
5580 $wgRC2UDPPrefix = '';
5583 * If this is set to true, the first entry in the $wgLocalInterwikis array (or
5584 * the value of $wgLocalInterwiki, if set) will be prepended to links in the IRC
5585 * feed. If this is set to a string, that string will be used as the prefix.
5587 * @deprecated since 1.22, use $wgRCFeeds
5589 $wgRC2UDPInterwikiPrefix = false;
5592 * Set to true to omit "bot" edits (by users with the bot permission) from the
5593 * UDP feed.
5595 * @deprecated since 1.22, use $wgRCFeeds
5597 $wgRC2UDPOmitBots = false;
5600 * Destinations to which notifications about recent changes
5601 * should be sent.
5603 * As of MediaWiki 1.22, the only supported 'engine' parameter option in core
5604 * is 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5605 * specified server.
5606 * The common options are:
5607 * * 'uri' -- the address to which the notices are to be sent.
5608 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5609 * produce the text to send. This can also be an object of the class.
5610 * * 'omit_bots' -- whether the bot edits should be in the feed
5611 * * 'omit_anon' -- whether anonymous edits should be in the feed
5612 * * 'omit_user' -- whether edits by registered users should be in the feed
5613 * * 'omit_minor' -- whether minor edits should be in the feed
5614 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5615 * The IRC-specific options are:
5616 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5617 * the first entry in the $wgLocalInterwikis array (or the value of
5618 * $wgLocalInterwiki, if set)
5619 * The JSON-specific options are:
5620 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5622 * To ensure backwards-compatibility, whenever $wgRC2UDPAddress is set, a
5623 * 'default' feed will be created reusing the deprecated $wgRC2UDP* variables.
5625 * @example $wgRCFeeds['example'] = array(
5626 * 'formatter' => 'JSONRCFeedFormatter',
5627 * 'uri' => "udp://localhost:1336",
5628 * 'add_interwiki_prefix' => false,
5629 * 'omit_bots' => true,
5630 * );
5631 * @example $wgRCFeeds['exampleirc'] = array(
5632 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5633 * 'uri' => "udp://localhost:1338",
5634 * 'add_interwiki_prefix' => false,
5635 * 'omit_bots' => true,
5636 * );
5637 * @since 1.22
5639 $wgRCFeeds = array();
5642 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5643 * Keys are scheme names, values are names of engine classes.
5645 $wgRCEngines = array(
5646 'redis' => 'RedisPubSubFeedEngine',
5647 'udp' => 'UDPRCFeedEngine',
5651 * Use RC Patrolling to check for vandalism
5653 $wgUseRCPatrol = true;
5656 * Use new page patrolling to check new pages on Special:Newpages
5658 $wgUseNPPatrol = true;
5661 * Log autopatrol actions to the log table
5663 $wgLogAutopatrol = true;
5666 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5668 $wgFeed = true;
5671 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5672 * eg Recentchanges, Newpages.
5674 $wgFeedLimit = 50;
5677 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5678 * A cached version will continue to be served out even if changes
5679 * are made, until this many seconds runs out since the last render.
5681 * If set to 0, feed caching is disabled. Use this for debugging only;
5682 * feed generation can be pretty slow with diffs.
5684 $wgFeedCacheTimeout = 60;
5687 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5688 * pages larger than this size.
5690 $wgFeedDiffCutoff = 32768;
5693 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5694 * every page. Some sites might have a different feed they'd like to promote
5695 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5696 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5697 * as value.
5698 * @par Example:
5699 * Configure the 'atom' feed to http://example.com/somefeed.xml
5700 * @code
5701 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5702 * @endcode
5704 $wgOverrideSiteFeed = array();
5707 * Available feeds objects.
5708 * Should probably only be defined when a page is syndicated ie when
5709 * $wgOut->isSyndicated() is true.
5711 $wgFeedClasses = array(
5712 'rss' => 'RSSFeed',
5713 'atom' => 'AtomFeed',
5717 * Which feed types should we provide by default? This can include 'rss',
5718 * 'atom', neither, or both.
5720 $wgAdvertisedFeedTypes = array( 'atom' );
5723 * Show watching users in recent changes, watchlist and page history views
5725 $wgRCShowWatchingUsers = false; # UPO
5728 * Show watching users in Page views
5730 $wgPageShowWatchingUsers = false;
5733 * Show the amount of changed characters in recent changes
5735 $wgRCShowChangedSize = true;
5738 * If the difference between the character counts of the text
5739 * before and after the edit is below that value, the value will be
5740 * highlighted on the RC page.
5742 $wgRCChangedSizeThreshold = 500;
5745 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5746 * view for watched pages with new changes
5748 $wgShowUpdatedMarker = true;
5751 * Disable links to talk pages of anonymous users (IPs) in listings on special
5752 * pages like page history, Special:Recentchanges, etc.
5754 $wgDisableAnonTalk = false;
5757 * Enable filtering of categories in Recentchanges
5759 $wgAllowCategorizedRecentChanges = false;
5762 * Allow filtering by change tag in recentchanges, history, etc
5763 * Has no effect if no tags are defined in valid_tag.
5765 $wgUseTagFilter = true;
5768 * If set to an integer, pages that are watched by this many users or more
5769 * will not require the unwatchedpages permission to view the number of
5770 * watchers.
5772 * @since 1.21
5774 $wgUnwatchedPageThreshold = false;
5777 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5778 * certain types of edits.
5780 * To register a new one:
5781 * @code
5782 * $wgRecentChangesFlags['flag'] => array(
5783 * // message for the letter displayed next to rows on changes lists
5784 * 'letter' => 'letter-msg',
5785 * // message for the tooltip of the letter
5786 * 'title' => 'tooltip-msg',
5787 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
5788 * 'legend' => 'legend-msg',
5789 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
5790 * 'class' => 'css-class',
5791 * );
5792 * @endcode
5794 * @since 1.22
5796 $wgRecentChangesFlags = array(
5797 'newpage' => array(
5798 'letter' => 'newpageletter',
5799 'title' => 'recentchanges-label-newpage',
5800 'legend' => 'recentchanges-legend-newpage',
5802 'minor' => array(
5803 'letter' => 'minoreditletter',
5804 'title' => 'recentchanges-label-minor',
5805 'legend' => 'recentchanges-legend-minor',
5806 'class' => 'minoredit',
5808 'bot' => array(
5809 'letter' => 'boteditletter',
5810 'title' => 'recentchanges-label-bot',
5811 'legend' => 'recentchanges-legend-bot',
5812 'class' => 'botedit',
5814 'unpatrolled' => array(
5815 'letter' => 'unpatrolledletter',
5816 'title' => 'recentchanges-label-unpatrolled',
5817 'legend' => 'recentchanges-legend-unpatrolled',
5821 /** @} */ # end RC/watchlist }
5823 /************************************************************************//**
5824 * @name Copyright and credits settings
5825 * @{
5829 * Override for copyright metadata.
5831 * This is the name of the page containing information about the wiki's copyright status,
5832 * which will be added as a link in the footer if it is specified. It overrides
5833 * $wgRightsUrl if both are specified.
5835 $wgRightsPage = null;
5838 * Set this to specify an external URL containing details about the content license used on your
5839 * wiki.
5840 * If $wgRightsPage is set then this setting is ignored.
5842 $wgRightsUrl = null;
5845 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5846 * link.
5847 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5848 * of the page will also be used as the link if this variable is not set.
5850 $wgRightsText = null;
5853 * Override for copyright metadata.
5855 $wgRightsIcon = null;
5858 * Set this to some HTML to override the rights icon with an arbitrary logo
5859 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5861 $wgCopyrightIcon = null;
5864 * Set this to true if you want detailed copyright information forms on Upload.
5866 $wgUseCopyrightUpload = false;
5869 * Set this to the number of authors that you want to be credited below an
5870 * article text. Set it to zero to hide the attribution block, and a negative
5871 * number (like -1) to show all authors. Note that this will require 2-3 extra
5872 * database hits, which can have a not insignificant impact on performance for
5873 * large wikis.
5875 $wgMaxCredits = 0;
5878 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5879 * Otherwise, link to a separate credits page.
5881 $wgShowCreditsIfMax = true;
5883 /** @} */ # end of copyright and credits settings }
5885 /************************************************************************//**
5886 * @name Import / Export
5887 * @{
5891 * List of interwiki prefixes for wikis we'll accept as sources for
5892 * Special:Import (for sysops). Since complete page history can be imported,
5893 * these should be 'trusted'.
5895 * If a user has the 'import' permission but not the 'importupload' permission,
5896 * they will only be able to run imports through this transwiki interface.
5898 $wgImportSources = array();
5901 * Optional default target namespace for interwiki imports.
5902 * Can use this to create an incoming "transwiki"-style queue.
5903 * Set to numeric key, not the name.
5905 * Users may override this in the Special:Import dialog.
5907 $wgImportTargetNamespace = null;
5910 * If set to false, disables the full-history option on Special:Export.
5911 * This is currently poorly optimized for long edit histories, so is
5912 * disabled on Wikimedia's sites.
5914 $wgExportAllowHistory = true;
5917 * If set nonzero, Special:Export requests for history of pages with
5918 * more revisions than this will be rejected. On some big sites things
5919 * could get bogged down by very very long pages.
5921 $wgExportMaxHistory = 0;
5924 * Return distinct author list (when not returning full history)
5926 $wgExportAllowListContributors = false;
5929 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
5930 * up to this specified level, which will cause it to include all
5931 * pages linked to from the pages you specify. Since this number
5932 * can become *insanely large* and could easily break your wiki,
5933 * it's disabled by default for now.
5935 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
5936 * crazy-big export from being done by someone setting the depth number too
5937 * high. In other words, last resort safety net.
5939 $wgExportMaxLinkDepth = 0;
5942 * Whether to allow the "export all pages in namespace" option
5944 $wgExportFromNamespaces = false;
5947 * Whether to allow exporting the entire wiki into a single file
5949 $wgExportAllowAll = false;
5951 /** @} */ # end of import/export }
5953 /*************************************************************************//**
5954 * @name Extensions
5955 * @{
5959 * A list of callback functions which are called once MediaWiki is fully
5960 * initialised
5962 $wgExtensionFunctions = array();
5965 * Extension messages files.
5967 * Associative array mapping extension name to the filename where messages can be
5968 * found. The file should contain variable assignments. Any of the variables
5969 * present in languages/messages/MessagesEn.php may be defined, but $messages
5970 * is the most common.
5972 * Variables defined in extensions will override conflicting variables defined
5973 * in the core.
5975 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
5976 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
5977 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
5978 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
5980 * Extensions using the JSON message format can preserve backward compatibility with
5981 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
5982 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
5983 * as for the $wgMessagesDirs entry.
5985 * @par Example:
5986 * @code
5987 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
5988 * @endcode
5990 $wgExtensionMessagesFiles = array();
5993 * Extension messages directories.
5995 * Associative array mapping extension name to the path of the directory where message files can
5996 * be found. The message files are expected to be JSON files named for their language code, e.g.
5997 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
5998 * message directories.
6000 * @par Simple example:
6001 * @code
6002 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6003 * @endcode
6005 * @par Complex example:
6006 * @code
6007 * $wgMessagesDirs['Example'] = array(
6008 * __DIR__ . '/lib/ve/i18n',
6009 * __DIR__ . '/lib/oojs-ui/i18n',
6010 * __DIR__ . '/i18n',
6012 * @endcode
6013 * @since 1.23
6015 $wgMessagesDirs = array(
6016 'core' => "$IP/languages/i18n",
6017 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
6021 * Array of files with list(s) of extension entry points to be used in
6022 * maintenance/mergeMessageFileList.php
6023 * @since 1.22
6025 $wgExtensionEntryPointListFiles = array();
6028 * Parser output hooks.
6029 * This is an associative array where the key is an extension-defined tag
6030 * (typically the extension name), and the value is a PHP callback.
6031 * These will be called as an OutputPageParserOutput hook, if the relevant
6032 * tag has been registered with the parser output object.
6034 * Registration is done with $pout->addOutputHook( $tag, $data ).
6036 * The callback has the form:
6037 * @code
6038 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6039 * @endcode
6041 $wgParserOutputHooks = array();
6044 * Whether to include the NewPP limit report as a HTML comment
6046 $wgEnableParserLimitReporting = true;
6049 * List of valid skin names.
6050 * The key should be the name in all lower case, the value should be a properly
6051 * cased name for the skin. This value will be prefixed with "Skin" to create the
6052 * class name of the skin to load, and if the skin's class cannot be found through
6053 * the autoloader it will be used to load a .php file by that name in the skins directory.
6054 * The default skins will be added later, by Skin::getSkinNames(). Use
6055 * Skin::getSkinNames() as an accessor if you wish to have access to the full list.
6057 $wgValidSkinNames = array();
6060 * Special page list.
6061 * See the top of SpecialPage.php for documentation.
6063 $wgSpecialPages = array();
6066 * Array mapping class names to filenames, for autoloading.
6068 $wgAutoloadClasses = array();
6071 * Switch controlling legacy case-insensitive classloading.
6072 * Do not disable if your wiki must support data created by PHP4, or by
6073 * MediaWiki 1.4 or earlier.
6075 $wgAutoloadAttemptLowercase = true;
6078 * An array of information about installed extensions keyed by their type.
6080 * All but 'name', 'path' and 'author' can be omitted.
6082 * @code
6083 * $wgExtensionCredits[$type][] = array(
6084 * 'path' => __FILE__,
6085 * 'name' => 'Example extension',
6086 * 'namemsg' => 'exampleextension-name',
6087 * 'author' => array(
6088 * 'Foo Barstein',
6089 * ),
6090 * 'version' => '1.9.0',
6091 * 'url' => 'http://example.org/example-extension/',
6092 * 'descriptionmsg' => 'exampleextension-desc',
6093 * 'license-name' => 'GPL-2.0',
6094 * );
6095 * @endcode
6097 * The extensions are listed on Special:Version. This page also looks for a file
6098 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6099 * view said file. When the 'license-name' key is specified, this file is
6100 * interpreted as wikitext.
6102 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6103 * 'skin', 'api', or 'other', or any additional types as specified through the
6104 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6106 * - name: Name of extension as an inline string instead of localizable message.
6107 * Do not omit this even if 'namemsg' is provided, as it is used to override
6108 * the path Special:Version uses to find extension's license info, and is
6109 * required for backwards-compatibility with MediaWiki 1.23 and older.
6111 * - namemsg (since MW 1.24): A message key for a message containing the
6112 * extension's name, if the name is localizable. (For example, skin names
6113 * usually are.)
6115 * - author: A string or an array of strings. Authors can be linked using
6116 * the regular wikitext link syntax. To have an internationalized version of
6117 * "and others" show, add an element "...". This element can also be linked,
6118 * for instance "[http://example ...]".
6120 * - descriptionmsg: A message key or an an array with message key and parameters:
6121 * `'descriptionmsg' => 'exampleextension-desc',`
6123 * - description: Description of extension as an inline string instead of
6124 * localizable message (omit in favour of 'descriptionmsg').
6126 * - license-name: Short name of the license (used as label for the link), such
6127 * as "GPL-2.0" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6129 $wgExtensionCredits = array();
6132 * Authentication plugin.
6133 * @var $wgAuth AuthPlugin
6135 $wgAuth = null;
6138 * Global list of hooks.
6140 * The key is one of the events made available by MediaWiki, you can find
6141 * a description for most of them in docs/hooks.txt. The array is used
6142 * internally by Hook:run().
6144 * The value can be one of:
6146 * - A function name:
6147 * @code
6148 * $wgHooks['event_name'][] = $function;
6149 * @endcode
6150 * - A function with some data:
6151 * @code
6152 * $wgHooks['event_name'][] = array( $function, $data );
6153 * @endcode
6154 * - A an object method:
6155 * @code
6156 * $wgHooks['event_name'][] = array( $object, 'method' );
6157 * @endcode
6158 * - A closure:
6159 * @code
6160 * $wgHooks['event_name'][] = function ( $hookParam ) {
6161 * // Handler code goes here.
6162 * };
6163 * @endcode
6165 * @warning You should always append to an event array or you will end up
6166 * deleting a previous registered hook.
6168 * @warning Hook handlers should be registered at file scope. Registering
6169 * handlers after file scope can lead to unexpected results due to caching.
6171 $wgHooks = array();
6174 * Maps jobs to their handling classes; extensions
6175 * can add to this to provide custom jobs
6177 $wgJobClasses = array(
6178 'refreshLinks' => 'RefreshLinksJob',
6179 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6180 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6181 'sendMail' => 'EmaillingJob',
6182 'enotifNotify' => 'EnotifNotifyJob',
6183 'fixDoubleRedirect' => 'DoubleRedirectJob',
6184 'uploadFromUrl' => 'UploadFromUrlJob',
6185 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6186 'PublishStashedFile' => 'PublishStashedFileJob',
6187 'null' => 'NullJob'
6191 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6192 * special flags are set. The values here are keys of $wgJobClasses.
6194 * These can be:
6195 * - Very long-running jobs.
6196 * - Jobs that you would never want to run as part of a page rendering request.
6197 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6198 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6199 * These settings should be global to all wikis.
6201 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6204 * Map of job types to how many job "work items" should be run per second
6205 * on each job runner process. The meaning of "work items" varies per job,
6206 * but typically would be something like "pages to update". A single job
6207 * may have a variable number of work items, as is the case with batch jobs.
6208 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6209 * These settings should be global to all wikis.
6210 * @var float[]
6212 $wgJobBackoffThrottling = array();
6215 * Map of job types to configuration arrays.
6216 * This determines which queue class and storage system is used for each job type.
6217 * Job types that do not have explicit configuration will use the 'default' config.
6218 * These settings should be global to all wikis.
6220 $wgJobTypeConf = array(
6221 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6225 * Which aggregator to use for tracking which queues have jobs.
6226 * These settings should be global to all wikis.
6228 $wgJobQueueAggregator = array(
6229 'class' => 'JobQueueAggregatorMemc'
6233 * Additional functions to be performed with updateSpecialPages.
6234 * Expensive Querypages are already updated.
6236 $wgSpecialPageCacheUpdates = array(
6237 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6238 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6242 * Hooks that are used for outputting exceptions. Format is:
6243 * $wgExceptionHooks[] = $funcname
6244 * or:
6245 * $wgExceptionHooks[] = array( $class, $funcname )
6246 * Hooks should return strings or false
6248 $wgExceptionHooks = array();
6251 * Page property link table invalidation lists. When a page property
6252 * changes, this may require other link tables to be updated (eg
6253 * adding __HIDDENCAT__ means the hiddencat tracking category will
6254 * have been added, so the categorylinks table needs to be rebuilt).
6255 * This array can be added to by extensions.
6257 $wgPagePropLinkInvalidations = array(
6258 'hiddencat' => 'categorylinks',
6261 /** @} */ # End extensions }
6263 /*************************************************************************//**
6264 * @name Categories
6265 * @{
6269 * Use experimental, DMOZ-like category browser
6271 $wgUseCategoryBrowser = false;
6274 * On category pages, show thumbnail gallery for images belonging to that
6275 * category instead of listing them as articles.
6277 $wgCategoryMagicGallery = true;
6280 * Paging limit for categories
6282 $wgCategoryPagingLimit = 200;
6285 * Specify how category names should be sorted, when listed on a category page.
6286 * A sorting scheme is also known as a collation.
6288 * Available values are:
6290 * - uppercase: Converts the category name to upper case, and sorts by that.
6292 * - identity: Does no conversion. Sorts by binary value of the string.
6294 * - uca-default: Provides access to the Unicode Collation Algorithm with
6295 * the default element table. This is a compromise collation which sorts
6296 * all languages in a mediocre way. However, it is better than "uppercase".
6298 * To use the uca-default collation, you must have PHP's intl extension
6299 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6300 * resulting collation will depend on the version of ICU installed on the
6301 * server.
6303 * After you change this, you must run maintenance/updateCollation.php to fix
6304 * the sort keys in the database.
6306 * Extensions can define there own collations by subclassing Collation
6307 * and using the Collation::factory hook.
6309 $wgCategoryCollation = 'uppercase';
6311 /** @} */ # End categories }
6313 /*************************************************************************//**
6314 * @name Logging
6315 * @{
6319 * The logging system has two levels: an event type, which describes the
6320 * general category and can be viewed as a named subset of all logs; and
6321 * an action, which is a specific kind of event that can exist in that
6322 * log type.
6324 $wgLogTypes = array(
6326 'block',
6327 'protect',
6328 'rights',
6329 'delete',
6330 'upload',
6331 'move',
6332 'import',
6333 'patrol',
6334 'merge',
6335 'suppress',
6339 * This restricts log access to those who have a certain right
6340 * Users without this will not see it in the option menu and can not view it
6341 * Restricted logs are not added to recent changes
6342 * Logs should remain non-transcludable
6343 * Format: logtype => permissiontype
6345 $wgLogRestrictions = array(
6346 'suppress' => 'suppressionlog'
6350 * Show/hide links on Special:Log will be shown for these log types.
6352 * This is associative array of log type => boolean "hide by default"
6354 * See $wgLogTypes for a list of available log types.
6356 * @par Example:
6357 * @code
6358 * $wgFilterLogTypes = array(
6359 * 'move' => true,
6360 * 'import' => false,
6361 * );
6362 * @endcode
6364 * Will display show/hide links for the move and import logs. Move logs will be
6365 * hidden by default unless the link is clicked. Import logs will be shown by
6366 * default, and hidden when the link is clicked.
6368 * A message of the form log-show-hide-[type] should be added, and will be used
6369 * for the link text.
6371 $wgFilterLogTypes = array(
6372 'patrol' => true
6376 * Lists the message key string for each log type. The localized messages
6377 * will be listed in the user interface.
6379 * Extensions with custom log types may add to this array.
6381 * @since 1.19, if you follow the naming convention log-name-TYPE,
6382 * where TYPE is your log type, yoy don't need to use this array.
6384 $wgLogNames = array(
6385 '' => 'all-logs-page',
6386 'block' => 'blocklogpage',
6387 'protect' => 'protectlogpage',
6388 'rights' => 'rightslog',
6389 'delete' => 'dellogpage',
6390 'upload' => 'uploadlogpage',
6391 'move' => 'movelogpage',
6392 'import' => 'importlogpage',
6393 'patrol' => 'patrol-log-page',
6394 'merge' => 'mergelog',
6395 'suppress' => 'suppressionlog',
6399 * Lists the message key string for descriptive text to be shown at the
6400 * top of each log type.
6402 * Extensions with custom log types may add to this array.
6404 * @since 1.19, if you follow the naming convention log-description-TYPE,
6405 * where TYPE is your log type, yoy don't need to use this array.
6407 $wgLogHeaders = array(
6408 '' => 'alllogstext',
6409 'block' => 'blocklogtext',
6410 'protect' => 'protectlogtext',
6411 'rights' => 'rightslogtext',
6412 'delete' => 'dellogpagetext',
6413 'upload' => 'uploadlogpagetext',
6414 'move' => 'movelogpagetext',
6415 'import' => 'importlogpagetext',
6416 'patrol' => 'patrol-log-header',
6417 'merge' => 'mergelogpagetext',
6418 'suppress' => 'suppressionlogtext',
6422 * Lists the message key string for formatting individual events of each
6423 * type and action when listed in the logs.
6425 * Extensions with custom log types may add to this array.
6427 $wgLogActions = array(
6428 'block/block' => 'blocklogentry',
6429 'block/unblock' => 'unblocklogentry',
6430 'block/reblock' => 'reblock-logentry',
6431 'protect/protect' => 'protectedarticle',
6432 'protect/modify' => 'modifiedarticleprotection',
6433 'protect/unprotect' => 'unprotectedarticle',
6434 'protect/move_prot' => 'movedarticleprotection',
6435 'upload/upload' => 'uploadedimage',
6436 'upload/overwrite' => 'overwroteimage',
6437 'upload/revert' => 'uploadedimage',
6438 'import/upload' => 'import-logentry-upload',
6439 'import/interwiki' => 'import-logentry-interwiki',
6440 'merge/merge' => 'pagemerge-logentry',
6441 'suppress/block' => 'blocklogentry',
6442 'suppress/reblock' => 'reblock-logentry',
6446 * The same as above, but here values are names of functions,
6447 * not messages.
6448 * @see LogPage::actionText
6449 * @see LogFormatter
6451 $wgLogActionsHandlers = array(
6452 'move/move' => 'MoveLogFormatter',
6453 'move/move_redir' => 'MoveLogFormatter',
6454 'delete/delete' => 'DeleteLogFormatter',
6455 'delete/restore' => 'DeleteLogFormatter',
6456 'delete/revision' => 'DeleteLogFormatter',
6457 'delete/event' => 'DeleteLogFormatter',
6458 'suppress/revision' => 'DeleteLogFormatter',
6459 'suppress/event' => 'DeleteLogFormatter',
6460 'suppress/delete' => 'DeleteLogFormatter',
6461 'patrol/patrol' => 'PatrolLogFormatter',
6462 'rights/rights' => 'RightsLogFormatter',
6463 'rights/autopromote' => 'RightsLogFormatter',
6467 * Maintain a log of newusers at Log/newusers?
6469 $wgNewUserLog = true;
6471 /** @} */ # end logging }
6473 /*************************************************************************//**
6474 * @name Special pages (general and miscellaneous)
6475 * @{
6479 * Allow special page inclusions such as {{Special:Allpages}}
6481 $wgAllowSpecialInclusion = true;
6484 * Set this to an array of special page names to prevent
6485 * maintenance/updateSpecialPages.php from updating those pages.
6487 $wgDisableQueryPageUpdate = false;
6490 * List of special pages, followed by what subtitle they should go under
6491 * at Special:SpecialPages
6493 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6495 $wgSpecialPageGroups = array();
6498 * Whether or not to sort special pages in Special:Specialpages
6500 $wgSortSpecialPages = true;
6503 * On Special:Unusedimages, consider images "used", if they are put
6504 * into a category. Default (false) is not to count those as used.
6506 $wgCountCategorizedImagesAsUsed = false;
6509 * Maximum number of links to a redirect page listed on
6510 * Special:Whatlinkshere/RedirectDestination
6512 $wgMaxRedirectLinksRetrieved = 500;
6514 /** @} */ # end special pages }
6516 /*************************************************************************//**
6517 * @name Actions
6518 * @{
6522 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6523 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6524 * 'foo' => true Load the class FooAction which subclasses Action
6525 * If something is specified in the getActionOverrides()
6526 * of the relevant Page object it will be used
6527 * instead of the default class.
6528 * 'foo' => false The action is disabled; show an error message
6529 * Unsetting core actions will probably cause things to complain loudly.
6531 $wgActions = array(
6532 'credits' => true,
6533 'delete' => true,
6534 'edit' => true,
6535 'history' => true,
6536 'info' => true,
6537 'markpatrolled' => true,
6538 'protect' => true,
6539 'purge' => true,
6540 'raw' => true,
6541 'render' => true,
6542 'revert' => true,
6543 'revisiondelete' => true,
6544 'rollback' => true,
6545 'submit' => true,
6546 'unprotect' => true,
6547 'unwatch' => true,
6548 'view' => true,
6549 'watch' => true,
6552 /** @} */ # end actions }
6554 /*************************************************************************//**
6555 * @name Robot (search engine crawler) policy
6556 * See also $wgNoFollowLinks.
6557 * @{
6561 * Default robot policy. The default policy is to encourage indexing and fol-
6562 * lowing of links. It may be overridden on a per-namespace and/or per-page
6563 * basis.
6565 $wgDefaultRobotPolicy = 'index,follow';
6568 * Robot policies per namespaces. The default policy is given above, the array
6569 * is made of namespace constants as defined in includes/Defines.php. You can-
6570 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6571 * nofollow. This is because a number of special pages (e.g., ListPages) have
6572 * many permutations of options that display the same data under redundant
6573 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6574 * pages, all alike, and never reaching your actual content.
6576 * @par Example:
6577 * @code
6578 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6579 * @endcode
6581 $wgNamespaceRobotPolicies = array();
6584 * Robot policies per article. These override the per-namespace robot policies.
6585 * Must be in the form of an array where the key part is a properly canonicalised
6586 * text form title and the value is a robot policy.
6588 * @par Example:
6589 * @code
6590 * $wgArticleRobotPolicies = array(
6591 * 'Main Page' => 'noindex,follow',
6592 * 'User:Bob' => 'index,follow',
6593 * );
6594 * @endcode
6596 * @par Example that DOES NOT WORK because the names are not canonical text
6597 * forms:
6598 * @code
6599 * $wgArticleRobotPolicies = array(
6600 * # Underscore, not space!
6601 * 'Main_Page' => 'noindex,follow',
6602 * # "Project", not the actual project name!
6603 * 'Project:X' => 'index,follow',
6604 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6605 * 'abc' => 'noindex,nofollow'
6606 * );
6607 * @endcode
6609 $wgArticleRobotPolicies = array();
6612 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6613 * will not function, so users can't decide whether pages in that namespace are
6614 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6616 * @par Example:
6617 * @code
6618 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6619 * @endcode
6621 $wgExemptFromUserRobotsControl = null;
6623 /** @} */ # End robot policy }
6625 /************************************************************************//**
6626 * @name AJAX and API
6627 * Note: The AJAX entry point which this section refers to is gradually being
6628 * replaced by the API entry point, api.php. They are essentially equivalent.
6629 * Both of them are used for dynamic client-side features, via XHR.
6630 * @{
6634 * Enable the MediaWiki API for convenient access to
6635 * machine-readable data via api.php
6637 * See https://www.mediawiki.org/wiki/API
6639 $wgEnableAPI = true;
6642 * Allow the API to be used to perform write operations
6643 * (page edits, rollback, etc.) when an authorised user
6644 * accesses it
6646 $wgEnableWriteAPI = true;
6650 * WARNING: SECURITY THREAT - debug use only
6652 * Disables many security checks in the API for debugging purposes.
6653 * This flag should never be used on the production servers, as it introduces
6654 * a number of potential security holes. Even when enabled, the validation
6655 * will still be performed, but instead of failing, API will return a warning.
6656 * Also, there will always be a warning notifying that this flag is set.
6657 * At this point, the flag allows GET requests to go through for modules
6658 * requiring POST.
6660 * @since 1.21
6662 $wgDebugAPI = false;
6665 * API module extensions.
6666 * Associative array mapping module name to class name.
6667 * Extension modules may override the core modules.
6669 * See ApiMain::$Modules for a list of the core modules.
6671 $wgAPIModules = array();
6674 * API format module extensions.
6675 * Associative array mapping format module name to class name.
6676 * Extension modules may override the core modules.
6678 * See ApiMain::$Formats for a list of the core format modules.
6680 $wgAPIFormatModules = array();
6683 * API Query meta module extensions.
6684 * Associative array mapping meta module name to class name.
6685 * Extension modules may override the core modules.
6687 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6689 $wgAPIMetaModules = array();
6692 * API Query prop module extensions.
6693 * Associative array mapping properties module name to class name.
6694 * Extension modules may override the core modules.
6696 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6698 $wgAPIPropModules = array();
6701 * API Query list module extensions.
6702 * Associative array mapping list module name to class name.
6703 * Extension modules may override the core modules.
6705 * See ApiQuery::$QueryListModules for a list of the core list modules.
6707 $wgAPIListModules = array();
6710 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6711 * @deprecated since 1.21
6713 $wgAPIGeneratorModules = array();
6716 * Maximum amount of rows to scan in a DB query in the API
6717 * The default value is generally fine
6719 $wgAPIMaxDBRows = 5000;
6722 * The maximum size (in bytes) of an API result.
6723 * @warning Do not set this lower than $wgMaxArticleSize*1024
6725 $wgAPIMaxResultSize = 8388608;
6728 * The maximum number of uncached diffs that can be retrieved in one API
6729 * request. Set this to 0 to disable API diffs altogether
6731 $wgAPIMaxUncachedDiffs = 1;
6734 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6735 * API request logging
6737 $wgAPIRequestLog = false;
6740 * Set the timeout for the API help text cache. If set to 0, caching disabled
6742 $wgAPICacheHelpTimeout = 60 * 60;
6745 * The ApiQueryQueryPages module should skip pages that are redundant to true
6746 * API queries.
6748 $wgAPIUselessQueryPages = array(
6749 'MIMEsearch', // aiprop=mime
6750 'LinkSearch', // list=exturlusage
6751 'FileDuplicateSearch', // prop=duplicatefiles
6755 * Enable AJAX framework
6757 $wgUseAjax = true;
6760 * List of Ajax-callable functions.
6761 * Extensions acting as Ajax callbacks must register here
6763 $wgAjaxExportList = array();
6766 * Enable watching/unwatching pages using AJAX.
6767 * Requires $wgUseAjax to be true too.
6769 $wgAjaxWatch = true;
6772 * Enable AJAX check for file overwrite, pre-upload
6774 $wgAjaxUploadDestCheck = true;
6777 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6779 $wgAjaxLicensePreview = true;
6782 * Settings for incoming cross-site AJAX requests:
6783 * Newer browsers support cross-site AJAX when the target resource allows requests
6784 * from the origin domain by the Access-Control-Allow-Origin header.
6785 * This is currently only used by the API (requests to api.php)
6786 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6788 * - '*' matches any number of characters
6789 * - '?' matches any 1 character
6791 * @par Example:
6792 * @code
6793 * $wgCrossSiteAJAXdomains = array(
6794 * 'www.mediawiki.org',
6795 * '*.wikipedia.org',
6796 * '*.wikimedia.org',
6797 * '*.wiktionary.org',
6798 * );
6799 * @endcode
6801 $wgCrossSiteAJAXdomains = array();
6804 * Domains that should not be allowed to make AJAX requests,
6805 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6806 * Uses the same syntax as $wgCrossSiteAJAXdomains
6808 $wgCrossSiteAJAXdomainExceptions = array();
6810 /** @} */ # End AJAX and API }
6812 /************************************************************************//**
6813 * @name Shell and process control
6814 * @{
6818 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6820 $wgMaxShellMemory = 307200;
6823 * Maximum file size created by shell processes under linux, in KB
6824 * ImageMagick convert for example can be fairly hungry for scratch space
6826 $wgMaxShellFileSize = 102400;
6829 * Maximum CPU time in seconds for shell processes under Linux
6831 $wgMaxShellTime = 180;
6834 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6835 * would measure) in seconds for shell processes under Linux
6837 $wgMaxShellWallClockTime = 180;
6840 * Under Linux: a cgroup directory used to constrain memory usage of shell
6841 * commands. The directory must be writable by the user which runs MediaWiki.
6843 * If specified, this is used instead of ulimit, which is inaccurate, and
6844 * causes malloc() to return NULL, which exposes bugs in C applications, making
6845 * them segfault or deadlock.
6847 * A wrapper script will create a cgroup for each shell command that runs, as
6848 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6849 * kernel will send a SIGKILL signal to a process in the subgroup.
6851 * @par Example:
6852 * @code
6853 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6854 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6855 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6856 * @endcode
6858 * The reliability of cgroup cleanup can be improved by installing a
6859 * notify_on_release script in the root cgroup, see e.g.
6860 * https://gerrit.wikimedia.org/r/#/c/40784
6862 $wgShellCgroup = false;
6865 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6867 $wgPhpCli = '/usr/bin/php';
6870 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
6871 * For Unix-like operating systems, set this to to a locale that has a UTF-8
6872 * character set. Only the character set is relevant.
6874 $wgShellLocale = 'en_US.utf8';
6876 /** @} */ # End shell }
6878 /************************************************************************//**
6879 * @name HTTP client
6880 * @{
6884 * Timeout for HTTP requests done internally
6886 $wgHTTPTimeout = 25;
6889 * Timeout for Asynchronous (background) HTTP requests
6891 $wgAsyncHTTPTimeout = 25;
6894 * Proxy to use for CURL requests.
6896 $wgHTTPProxy = false;
6899 * Timeout for connections done internally (in seconds)
6900 * Only works for curl
6902 $wgHTTPConnectTimeout = 5e0;
6904 /** @} */ # End HTTP client }
6906 /************************************************************************//**
6907 * @name Job queue
6908 * See also $wgEnotifUseJobQ.
6909 * @{
6913 * Number of jobs to perform per request. May be less than one in which case
6914 * jobs are performed probabalistically. If this is zero, jobs will not be done
6915 * during ordinary apache requests. In this case, maintenance/runJobs.php should
6916 * be run periodically.
6918 $wgJobRunRate = 1;
6921 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
6922 * to handle the job execution, instead of blocking the request until the job
6923 * execution finishes.
6924 * @since 1.23
6926 $wgRunJobsAsync = true;
6929 * Number of rows to update per job
6931 $wgUpdateRowsPerJob = 500;
6934 * Number of rows to update per query
6936 $wgUpdateRowsPerQuery = 100;
6938 /** @} */ # End job queue }
6940 /************************************************************************//**
6941 * @name Miscellaneous
6942 * @{
6946 * Name of the external diff engine to use
6948 $wgExternalDiffEngine = false;
6951 * Disable redirects to special pages and interwiki redirects, which use a 302
6952 * and have no "redirected from" link.
6954 * @note This is only for articles with #REDIRECT in them. URL's containing a
6955 * local interwiki prefix (or a non-canonical special page name) are still hard
6956 * redirected regardless of this setting.
6958 $wgDisableHardRedirects = false;
6961 * LinkHolderArray batch size
6962 * For debugging
6964 $wgLinkHolderBatchSize = 1000;
6967 * By default MediaWiki does not register links pointing to same server in
6968 * externallinks dataset, use this value to override:
6970 $wgRegisterInternalExternals = false;
6973 * Maximum number of pages to move at once when moving subpages with a page.
6975 $wgMaximumMovedPages = 100;
6978 * Fix double redirects after a page move.
6979 * Tends to conflict with page move vandalism, use only on a private wiki.
6981 $wgFixDoubleRedirects = false;
6984 * Allow redirection to another page when a user logs in.
6985 * To enable, set to a string like 'Main Page'
6987 $wgRedirectOnLogin = null;
6990 * Configuration for processing pool control, for use in high-traffic wikis.
6991 * An implementation is provided in the PoolCounter extension.
6993 * This configuration array maps pool types to an associative array. The only
6994 * defined key in the associative array is "class", which gives the class name.
6995 * The remaining elements are passed through to the class as constructor
6996 * parameters.
6998 * @par Example:
6999 * @code
7000 * $wgPoolCounterConf = array( 'ArticleView' => array(
7001 * 'class' => 'PoolCounter_Client',
7002 * 'timeout' => 15, // wait timeout in seconds
7003 * 'workers' => 5, // maximum number of active threads in each pool
7004 * 'maxqueue' => 50, // maximum number of total threads in each pool
7005 * ... any extension-specific options...
7006 * );
7007 * @endcode
7009 $wgPoolCounterConf = null;
7012 * To disable file delete/restore temporarily
7014 $wgUploadMaintenance = false;
7017 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7018 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7019 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7020 * (except for the special case of JS and CS pages).
7022 * @since 1.21
7024 $wgNamespaceContentModels = array();
7027 * How to react if a plain text version of a non-text Content object is requested using
7028 * ContentHandler::getContentText():
7030 * * 'ignore': return null
7031 * * 'fail': throw an MWException
7032 * * 'serialize': serialize to default format
7034 * @since 1.21
7036 $wgContentHandlerTextFallback = 'ignore';
7039 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7040 * This way, the ContentHandler facility can be used without any additional information in the
7041 * database. A page's content model is then derived solely from the page's title. This however
7042 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7043 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7044 * a title that would default to a different content model.
7046 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7047 * handling is less robust and less flexible.
7049 * @since 1.21
7051 $wgContentHandlerUseDB = true;
7054 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7055 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7056 * the effect on the database they would have on a wikitext page.
7058 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7059 * or at least parse only the contents of comments in the scripts.
7061 * @since 1.21
7063 $wgTextModelsToParse = array(
7064 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7065 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7066 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7070 * Whether the user must enter their password to change their e-mail address
7072 * @since 1.20
7074 $wgRequirePasswordforEmailChange = true;
7077 * Register handlers for specific types of sites.
7079 * @since 1.20
7081 $wgSiteTypes = array(
7082 'mediawiki' => 'MediaWikiSite',
7086 * Formerly a list of files for HipHop compilation
7087 * @deprecated since 1.22
7089 $wgCompiledFiles = array();
7092 * Whether the page_props table has a pp_sortkey column. Set to false in case
7093 * the respective database schema change was not applied.
7094 * @since 1.23
7096 $wgPagePropsHaveSortkey = true;
7099 * Port where you have HTTPS running
7100 * Supports HTTPS on non-standard ports
7101 * @see bug 65184
7102 * @since 1.24
7104 $wgHttpsPort = 443;
7107 * Secret and algorithm for hmac-based key derivation function (fast,
7108 * cryptographically secure random numbers).
7109 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7110 * be used.
7111 * @since 1.24
7113 $wgHKDFSecret = false;
7114 $wgHKDFAlgorithm = 'sha256';
7117 * For really cool vim folding this needs to be at the end:
7118 * vim: foldmarker=@{,@} foldmethod=marker
7119 * @}