Merge "mediawiki.api: Use then() in getToken instead of manual Deferred wrapping"
[mediawiki.git] / includes / DefaultSettings.php
blobe011d4a19f4497d3cfe6ccc9f11988985c10660a
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 * Class name to use for accessing Config.
64 * Currently only 'GlobalConfig' is available
65 * @since 1.23
67 $wgConfigClass = 'GlobalConfig';
69 /**
70 * MediaWiki version number
71 * @since 1.2
73 $wgVersion = '1.24alpha';
75 /**
76 * Name of the site. It must be changed in LocalSettings.php
78 $wgSitename = 'MediaWiki';
80 /**
81 * URL of the server.
83 * @par Example:
84 * @code
85 * $wgServer = 'http://example.com';
86 * @endcode
88 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
89 * wrong server, it will redirect incorrectly after you save a page. In that
90 * case, set this variable to fix it.
92 * If you want to use protocol-relative URLs on your wiki, set this to a
93 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
94 * to a fully qualified URL.
96 $wgServer = WebRequest::detectServer();
98 /**
99 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
100 * Must be fully qualified, even if $wgServer is protocol-relative.
102 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
103 * @since 1.18
105 $wgCanonicalServer = false;
108 * Server name. This is automatically computed by parsing the bare
109 * hostname out of $wgCanonicalServer. It should not be customized.
110 * @since 1.24
112 $wgServerName = false;
114 /************************************************************************//**
115 * @name Script path settings
116 * @{
120 * The path we should point to.
121 * It might be a virtual path in case with use apache mod_rewrite for example.
123 * This *needs* to be set correctly.
125 * Other paths will be set to defaults based on it unless they are directly
126 * set in LocalSettings.php
128 $wgScriptPath = '/wiki';
131 * Whether to support URLs like index.php/Page_title These often break when PHP
132 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
133 * but then again it may not; lighttpd converts incoming path data to lowercase
134 * on systems with case-insensitive filesystems, and there have been reports of
135 * problems on Apache as well.
137 * To be safe we'll continue to keep it off by default.
139 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
140 * incorrect garbage, or to true if it is really correct.
142 * The default $wgArticlePath will be set based on this value at runtime, but if
143 * you have customized it, having this incorrectly set to true can cause
144 * redirect loops when "pretty URLs" are used.
145 * @since 1.2.1
147 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
148 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
149 ( strpos( PHP_SAPI, 'isapi' ) === false );
152 * The extension to append to script names by default. This can either be .php
153 * or .php5.
155 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
156 * variable is provided to support those providers.
157 * @since 1.11
159 $wgScriptExtension = '.php';
161 /**@}*/
163 /************************************************************************//**
164 * @name URLs and file paths
166 * These various web and file path variables are set to their defaults
167 * in Setup.php if they are not explicitly set from LocalSettings.php.
169 * These will relatively rarely need to be set manually, unless you are
170 * splitting style sheets or images outside the main document root.
172 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
173 * the host part, that starts with a slash. In most cases a full URL is also
174 * acceptable. A "directory" is a local file path.
176 * In both paths and directories, trailing slashes should not be included.
178 * @{
182 * The URL path to index.php.
184 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
186 $wgScript = false;
189 * The URL path to load.php.
191 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
192 * @since 1.17
194 $wgLoadScript = false;
197 * The URL path of the skins directory.
198 * Defaults to "{$wgScriptPath}/skins".
199 * @since 1.3
201 $wgStylePath = false;
202 $wgStyleSheetPath = &$wgStylePath;
205 * The URL path of the skins directory. Should not point to an external domain.
206 * Defaults to "{$wgScriptPath}/skins".
207 * @since 1.17
209 $wgLocalStylePath = false;
212 * The URL path of the extensions directory.
213 * Defaults to "{$wgScriptPath}/extensions".
214 * @since 1.16
216 $wgExtensionAssetsPath = false;
219 * Filesystem stylesheets directory.
220 * Defaults to "{$IP}/skins".
221 * @since 1.3
223 $wgStyleDirectory = false;
226 * The URL path for primary article page views. This path should contain $1,
227 * which is replaced by the article title.
229 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
230 * depending on $wgUsePathInfo.
232 $wgArticlePath = false;
235 * The URL path for the images directory.
236 * Defaults to "{$wgScriptPath}/images".
238 $wgUploadPath = false;
241 * The filesystem path of the images directory. Defaults to "{$IP}/images".
243 $wgUploadDirectory = false;
246 * Directory where the cached page will be saved.
247 * Defaults to "{$wgUploadDirectory}/cache".
249 $wgFileCacheDirectory = false;
252 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
253 * Defaults to "{$wgStylePath}/common/images/wiki.png".
255 $wgLogo = false;
258 * The URL path of the shortcut icon.
259 * @since 1.6
261 $wgFavicon = '/favicon.ico';
264 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
265 * Defaults to no icon.
266 * @since 1.12
268 $wgAppleTouchIcon = false;
271 * The local filesystem path to a temporary directory. This is not required to
272 * be web accessible.
274 * When this setting is set to false, its value will be set through a call
275 * to wfTempDir(). See that methods implementation for the actual detection
276 * logic.
278 * Developers should use the global function wfTempDir() instead of this
279 * variable.
281 * @see wfTempDir()
282 * @note Default changed to false in MediaWiki 1.20.
284 $wgTmpDirectory = false;
287 * If set, this URL is added to the start of $wgUploadPath to form a complete
288 * upload URL.
289 * @since 1.4
291 $wgUploadBaseUrl = '';
294 * To enable remote on-demand scaling, set this to the thumbnail base URL.
295 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
296 * where 'e6' are the first two characters of the MD5 hash of the file name.
297 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
298 * @since 1.17
300 $wgUploadStashScalerBaseUrl = false;
303 * To set 'pretty' URL paths for actions other than
304 * plain page views, add to this array.
306 * @par Example:
307 * Set pretty URL for the edit action:
308 * @code
309 * 'edit' => "$wgScriptPath/edit/$1"
310 * @endcode
312 * There must be an appropriate script or rewrite rule in place to handle these
313 * URLs.
314 * @since 1.5
316 $wgActionPaths = array();
318 /**@}*/
320 /************************************************************************//**
321 * @name Files and file uploads
322 * @{
326 * Uploads have to be specially set up to be secure
328 $wgEnableUploads = false;
331 * The maximum age of temporary (incomplete) uploaded files
333 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
336 * Allows to move images and other media files
338 $wgAllowImageMoving = true;
341 * Enable deferred upload tasks that use the job queue.
342 * Only enable this if job runners are set up for both the
343 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
345 * @note If you use suhosin, this setting is incompatible with
346 * suhosin.session.encrypt.
348 $wgEnableAsyncUploads = false;
351 * These are additional characters that should be replaced with '-' in filenames
353 $wgIllegalFileChars = ":";
356 * @deprecated since 1.17 use $wgDeletedDirectory
358 $wgFileStore = array();
361 * What directory to place deleted uploads in.
362 * Defaults to "{$wgUploadDirectory}/deleted".
364 $wgDeletedDirectory = false;
367 * Set this to true if you use img_auth and want the user to see details on why access failed.
369 $wgImgAuthDetails = false;
372 * Map of relative URL directories to match to internal mwstore:// base storage paths.
373 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
374 * if starts with any of the prefixes defined here. The prefixes should not overlap.
375 * The prefix that matches has a corresponding storage path, which the rest of the URL
376 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
378 * Example:
379 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
380 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
381 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
383 * @see $wgFileBackends
385 $wgImgAuthUrlPathMap = array();
388 * File repository structures
390 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
391 * an array of such structures. Each repository structure is an associative
392 * array of properties configuring the repository.
394 * Properties required for all repos:
395 * - class The class name for the repository. May come from the core or an extension.
396 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
397 * FSRepo is also supported for backwards compatibility.
399 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
400 * The name should consist of alpha-numeric characters.
401 * - backend A file backend name (see $wgFileBackends).
403 * For most core repos:
404 * - zones Associative array of zone names that each map to an array with:
405 * container : backend container name the zone is in
406 * directory : root path within container for the zone
407 * url : base URL to the root of the zone
408 * urlsByExt : map of file extension types to base URLs
409 * (useful for using a different cache for videos)
410 * Zones default to using "<repo name>-<zone name>" as the container name
411 * and default to using the container root as the zone's root directory.
412 * Nesting of zone locations within other zones should be avoided.
413 * - url Public zone URL. The 'zones' settings take precedence.
414 * - hashLevels The number of directory levels for hash-based division of files
415 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
416 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
417 * handler instead.
418 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
419 * determines whether filenames implicitly start with a capital letter.
420 * The current implementation may give incorrect description page links
421 * when the local $wgCapitalLinks and initialCapital are mismatched.
422 * - pathDisclosureProtection
423 * May be 'paranoid' to remove all parameters from error messages, 'none' to
424 * leave the paths in unchanged, or 'simple' to replace paths with
425 * placeholders. Default for LocalRepo is 'simple'.
426 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
427 * is 0644.
428 * - directory The local filesystem directory where public files are stored. Not used for
429 * some remote repos.
430 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
431 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
432 * - isPrivate Set this if measures should always be taken to keep the files private.
433 * One should not trust this to assure that the files are not web readable;
434 * the server configuration should be done manually depending on the backend.
436 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
437 * for local repositories:
438 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
439 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
440 * http://en.wikipedia.org/w
441 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
442 * $wgScriptExtension, e.g. .php5 defaults to .php
444 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
445 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
446 * $wgFetchCommonsDescriptions.
447 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
448 * Short thumbnail names only have the width, parameters, and the extension.
450 * ForeignDBRepo:
451 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
452 * equivalent to the corresponding member of $wgDBservers
453 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
454 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
456 * ForeignAPIRepo:
457 * - apibase Use for the foreign API's URL
458 * - apiThumbCacheExpiry How long to locally cache thumbs for
460 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
461 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
462 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
463 * If you set $wgForeignFileRepos to an array of repository structures, those will
464 * be searched after the local file repo.
465 * Otherwise, you will only have access to local media files.
467 * @see Setup.php for an example usage and default initialization.
469 $wgLocalFileRepo = false;
472 * @see $wgLocalFileRepo
474 $wgForeignFileRepos = array();
477 * Use Commons as a remote file repository. Essentially a wrapper, when this
478 * is enabled $wgForeignFileRepos will point at Commons with a set of default
479 * settings
481 $wgUseInstantCommons = false;
484 * File backend structure configuration.
486 * This is an array of file backend configuration arrays.
487 * Each backend configuration has the following parameters:
488 * - 'name' : A unique name for the backend
489 * - 'class' : The file backend class to use
490 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
491 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
493 * See FileBackend::__construct() for more details.
494 * Additional parameters are specific to the file backend class used.
495 * These settings should be global to all wikis when possible.
497 * There are two particularly important aspects about each backend:
498 * - a) Whether it is fully qualified or wiki-relative.
499 * By default, the paths of files are relative to the current wiki,
500 * which works via prefixing them with the current wiki ID when accessed.
501 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
502 * all paths with the specified value instead. This can be useful if
503 * multiple wikis need to share the same data. Note that 'name' is *not*
504 * part of any prefix and thus should not be relied upon for namespacing.
505 * - b) Whether it is only defined for some wikis or is defined on all
506 * wikis in the wiki farm. Defining a backend globally is useful
507 * if multiple wikis need to share the same data.
508 * One should be aware of these aspects when configuring a backend for use with
509 * any basic feature or plugin. For example, suppose an extension stores data for
510 * different wikis in different directories and sometimes needs to access data from
511 * a foreign wiki's directory in order to render a page on given wiki. The extension
512 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
514 $wgFileBackends = array();
517 * Array of configuration arrays for each lock manager.
518 * Each backend configuration has the following parameters:
519 * - 'name' : A unique name for the lock manager
520 * - 'class' : The lock manger class to use
522 * See LockManager::__construct() for more details.
523 * Additional parameters are specific to the lock manager class used.
524 * These settings should be global to all wikis.
526 $wgLockManagers = array();
529 * Show Exif data, on by default if available.
530 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
532 * @note FOR WINDOWS USERS:
533 * To enable Exif functions, add the following lines to the "Windows
534 * extensions" section of php.ini:
535 * @code{.ini}
536 * extension=extensions/php_mbstring.dll
537 * extension=extensions/php_exif.dll
538 * @endcode
540 $wgShowEXIF = function_exists( 'exif_read_data' );
543 * If to automatically update the img_metadata field
544 * if the metadata field is outdated but compatible with the current version.
545 * Defaults to false.
547 $wgUpdateCompatibleMetadata = false;
550 * If you operate multiple wikis, you can define a shared upload path here.
551 * Uploads to this wiki will NOT be put there - they will be put into
552 * $wgUploadDirectory.
553 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
554 * no file of the given name is found in the local repository (for [[File:..]],
555 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
556 * directory.
558 * Note that these configuration settings can now be defined on a per-
559 * repository basis for an arbitrary number of file repositories, using the
560 * $wgForeignFileRepos variable.
562 $wgUseSharedUploads = false;
565 * Full path on the web server where shared uploads can be found
567 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
570 * Fetch commons image description pages and display them on the local wiki?
572 $wgFetchCommonsDescriptions = false;
575 * Path on the file system where shared uploads can be found.
577 $wgSharedUploadDirectory = "/var/www/wiki3/images";
580 * DB name with metadata about shared directory.
581 * Set this to false if the uploads do not come from a wiki.
583 $wgSharedUploadDBname = false;
586 * Optional table prefix used in database.
588 $wgSharedUploadDBprefix = '';
591 * Cache shared metadata in memcached.
592 * Don't do this if the commons wiki is in a different memcached domain
594 $wgCacheSharedUploads = true;
597 * Allow for upload to be copied from an URL.
598 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
599 * You have to assign the user right 'upload_by_url' to a user group, to use this.
601 $wgAllowCopyUploads = false;
604 * Allow asynchronous copy uploads.
605 * This feature is experimental and broken as of r81612.
607 $wgAllowAsyncCopyUploads = false;
610 * A list of domains copy uploads can come from
612 * @since 1.20
614 $wgCopyUploadsDomains = array();
617 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
618 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
619 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
621 $wgCopyUploadsFromSpecialUpload = false;
624 * Proxy to use for copy upload requests.
625 * @since 1.20
627 $wgCopyUploadProxy = false;
630 * Different timeout for upload by url
631 * This could be useful since when fetching large files, you may want a
632 * timeout longer than the default $wgHTTPTimeout. False means fallback
633 * to default.
635 * @since 1.22
637 $wgCopyUploadTimeout = false;
640 * Different timeout for upload by url when run as a background job
641 * This could be useful since when fetching large files via job queue,
642 * you may want a different timeout, especially because there is no
643 * http request being kept alive.
645 * false means fallback to $wgCopyUploadTimeout.
646 * @since 1.22
648 $wgCopyUploadAsyncTimeout = false;
651 * Max size for uploads, in bytes. If not set to an array, applies to all
652 * uploads. If set to an array, per upload type maximums can be set, using the
653 * file and url keys. If the * key is set this value will be used as maximum
654 * for non-specified types.
656 * @par Example:
657 * @code
658 * $wgMaxUploadSize = array(
659 * '*' => 250 * 1024,
660 * 'url' => 500 * 1024,
661 * );
662 * @endcode
663 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
664 * will have a maximum of 500 kB.
666 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
669 * Point the upload navigation link to an external URL
670 * Useful if you want to use a shared repository by default
671 * without disabling local uploads (use $wgEnableUploads = false for that).
673 * @par Example:
674 * @code
675 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
676 * @endcode
678 $wgUploadNavigationUrl = false;
681 * Point the upload link for missing files to an external URL, as with
682 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
683 * appended to it as appropriate.
685 $wgUploadMissingFileUrl = false;
688 * Give a path here to use thumb.php for thumbnail generation on client
689 * request, instead of generating them on render and outputting a static URL.
690 * This is necessary if some of your apache servers don't have read/write
691 * access to the thumbnail path.
693 * @par Example:
694 * @code
695 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
696 * @endcode
698 $wgThumbnailScriptPath = false;
701 * @see $wgThumbnailScriptPath
703 $wgSharedThumbnailScriptPath = false;
706 * Set this to false if you do not want MediaWiki to divide your images
707 * directory into many subdirectories, for improved performance.
709 * It's almost always good to leave this enabled. In previous versions of
710 * MediaWiki, some users set this to false to allow images to be added to the
711 * wiki by simply copying them into $wgUploadDirectory and then running
712 * maintenance/rebuildImages.php to register them in the database. This is no
713 * longer recommended, use maintenance/importImages.php instead.
715 * @note That this variable may be ignored if $wgLocalFileRepo is set.
716 * @todo Deprecate the setting and ultimately remove it from Core.
718 $wgHashedUploadDirectory = true;
721 * Set the following to false especially if you have a set of files that need to
722 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
723 * directory layout.
725 $wgHashedSharedUploadDirectory = true;
728 * Base URL for a repository wiki. Leave this blank if uploads are just stored
729 * in a shared directory and not meant to be accessible through a separate wiki.
730 * Otherwise the image description pages on the local wiki will link to the
731 * image description page on this wiki.
733 * Please specify the namespace, as in the example below.
735 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
738 * This is the list of preferred extensions for uploading files. Uploading files
739 * with extensions not in this list will trigger a warning.
741 * @warning If you add any OpenOffice or Microsoft Office file formats here,
742 * such as odt or doc, and untrusted users are allowed to upload files, then
743 * your wiki will be vulnerable to cross-site request forgery (CSRF).
745 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
748 * Files with these extensions will never be allowed as uploads.
749 * An array of file extensions to blacklist. You should append to this array
750 * if you want to blacklist additional files.
752 $wgFileBlacklist = array(
753 # HTML may contain cookie-stealing JavaScript and web bugs
754 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
755 # PHP scripts may execute arbitrary code on the server
756 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
757 # Other types that may be interpreted by some servers
758 'shtml', 'jhtml', 'pl', 'py', 'cgi',
759 # May contain harmful executables for Windows victims
760 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
763 * Files with these mime types will never be allowed as uploads
764 * if $wgVerifyMimeType is enabled.
766 $wgMimeTypeBlacklist = array(
767 # HTML may contain cookie-stealing JavaScript and web bugs
768 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
769 # PHP scripts may execute arbitrary code on the server
770 'application/x-php', 'text/x-php',
771 # Other types that may be interpreted by some servers
772 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
773 # Client-side hazards on Internet Explorer
774 'text/scriptlet', 'application/x-msdownload',
775 # Windows metafile, client-side vulnerability on some systems
776 'application/x-msmetafile',
780 * Allow Java archive uploads.
781 * This is not recommended for public wikis since a maliciously-constructed
782 * applet running on the same domain as the wiki can steal the user's cookies.
784 $wgAllowJavaUploads = false;
787 * This is a flag to determine whether or not to check file extensions on upload.
789 * @warning Setting this to false is insecure for public wikis.
791 $wgCheckFileExtensions = true;
794 * If this is turned off, users may override the warning for files not covered
795 * by $wgFileExtensions.
797 * @warning Setting this to false is insecure for public wikis.
799 $wgStrictFileExtensions = true;
802 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
804 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
805 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
807 $wgDisableUploadScriptChecks = false;
810 * Warn if uploaded files are larger than this (in bytes), or false to disable
812 $wgUploadSizeWarning = false;
815 * list of trusted media-types and mime types.
816 * Use the MEDIATYPE_xxx constants to represent media types.
817 * This list is used by File::isSafeFile
819 * Types not listed here will have a warning about unsafe content
820 * displayed on the images description page. It would also be possible
821 * to use this for further restrictions, like disabling direct
822 * [[media:...]] links for non-trusted formats.
824 $wgTrustedMediaFormats = array(
825 MEDIATYPE_BITMAP, //all bitmap formats
826 MEDIATYPE_AUDIO, //all audio formats
827 MEDIATYPE_VIDEO, //all plain video formats
828 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
829 "application/pdf", //PDF files
830 #"application/x-shockwave-flash", //flash/shockwave movie
834 * Plugins for media file type handling.
835 * Each entry in the array maps a MIME type to a class name
837 $wgMediaHandlers = array(
838 'image/jpeg' => 'JpegHandler',
839 'image/png' => 'PNGHandler',
840 'image/gif' => 'GIFHandler',
841 'image/tiff' => 'TiffHandler',
842 'image/x-ms-bmp' => 'BmpHandler',
843 'image/x-bmp' => 'BmpHandler',
844 'image/x-xcf' => 'XCFHandler',
845 'image/svg+xml' => 'SvgHandler', // official
846 'image/svg' => 'SvgHandler', // compat
847 'image/vnd.djvu' => 'DjVuHandler', // official
848 'image/x.djvu' => 'DjVuHandler', // compat
849 'image/x-djvu' => 'DjVuHandler', // compat
853 * Plugins for page content model handling.
854 * Each entry in the array maps a model id to a class name.
856 * @since 1.21
858 $wgContentHandlers = array(
859 // the usual case
860 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
861 // dumb version, no syntax highlighting
862 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
863 // dumb version, no syntax highlighting
864 CONTENT_MODEL_CSS => 'CssContentHandler',
865 // plain text, for use by extensions etc
866 CONTENT_MODEL_TEXT => 'TextContentHandler',
870 * Whether to enable server-side image thumbnailing. If false, images will
871 * always be sent to the client in full resolution, with appropriate width= and
872 * height= attributes on the <img> tag for the client to do its own scaling.
874 $wgUseImageResize = true;
877 * Resizing can be done using PHP's internal image libraries or using
878 * ImageMagick or another third-party converter, e.g. GraphicMagick.
879 * These support more file formats than PHP, which only supports PNG,
880 * GIF, JPG, XBM and WBMP.
882 * Use Image Magick instead of PHP builtin functions.
884 $wgUseImageMagick = false;
887 * The convert command shipped with ImageMagick
889 $wgImageMagickConvertCommand = '/usr/bin/convert';
892 * Sharpening parameter to ImageMagick
894 $wgSharpenParameter = '0x0.4';
897 * Reduction in linear dimensions below which sharpening will be enabled
899 $wgSharpenReductionThreshold = 0.85;
902 * Temporary directory used for ImageMagick. The directory must exist. Leave
903 * this set to false to let ImageMagick decide for itself.
905 $wgImageMagickTempDir = false;
908 * Use another resizing converter, e.g. GraphicMagick
909 * %s will be replaced with the source path, %d with the destination
910 * %w and %h will be replaced with the width and height.
912 * @par Example for GraphicMagick:
913 * @code
914 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
915 * @endcode
917 * Leave as false to skip this.
919 $wgCustomConvertCommand = false;
922 * used for lossless jpeg rotation
924 * @since 1.21
926 $wgJpegTran = '/usr/bin/jpegtran';
929 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
930 * image formats.
932 $wgExiv2Command = '/usr/bin/exiv2';
935 * Scalable Vector Graphics (SVG) may be uploaded as images.
936 * Since SVG support is not yet standard in browsers, it is
937 * necessary to rasterize SVGs to PNG as a fallback format.
939 * An external program is required to perform this conversion.
940 * If set to an array, the first item is a PHP callable and any further items
941 * are passed as parameters after $srcPath, $dstPath, $width, $height
943 $wgSVGConverters = array(
944 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
945 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
946 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
947 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
948 . '$output $input',
949 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
950 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
951 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
955 * Pick a converter defined in $wgSVGConverters
957 $wgSVGConverter = 'ImageMagick';
960 * If not in the executable PATH, specify the SVG converter path.
962 $wgSVGConverterPath = '';
965 * Don't scale a SVG larger than this
967 $wgSVGMaxSize = 2048;
970 * Don't read SVG metadata beyond this point.
971 * Default is 1024*256 bytes
973 $wgSVGMetadataCutoff = 262144;
976 * Disallow <title> element in SVG files.
978 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
979 * browsers which can not perform basic stuff like MIME detection and which are
980 * vulnerable to further idiots uploading crap files as images.
982 * When this directive is on, "<title>" will be allowed in files with an
983 * "image/svg+xml" MIME type. You should leave this disabled if your web server
984 * is misconfigured and doesn't send appropriate MIME types for SVG images.
986 $wgAllowTitlesInSVG = false;
989 * The maximum number of pixels a source image can have if it is to be scaled
990 * down by a scaler that requires the full source image to be decompressed
991 * and stored in decompressed form, before the thumbnail is generated.
993 * This provides a limit on memory usage for the decompression side of the
994 * image scaler. The limit is used when scaling PNGs with any of the
995 * built-in image scalers, such as ImageMagick or GD. It is ignored for
996 * JPEGs with ImageMagick, and when using the VipsScaler extension.
998 * The default is 50 MB if decompressed to RGBA form, which corresponds to
999 * 12.5 million pixels or 3500x3500.
1001 $wgMaxImageArea = 1.25e7;
1004 * Force thumbnailing of animated GIFs above this size to a single
1005 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1006 * is checked against the total size of all frames in the animation.
1007 * It probably makes sense to keep this equal to $wgMaxImageArea.
1009 $wgMaxAnimatedGifArea = 1.25e7;
1012 * Browsers don't support TIFF inline generally...
1013 * For inline display, we need to convert to PNG or JPEG.
1014 * Note scaling should work with ImageMagick, but may not with GD scaling.
1016 * @par Example:
1017 * @code
1018 * // PNG is lossless, but inefficient for photos
1019 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1020 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1021 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1022 * @endcode
1024 $wgTiffThumbnailType = false;
1027 * If rendered thumbnail files are older than this timestamp, they
1028 * will be rerendered on demand as if the file didn't already exist.
1029 * Update if there is some need to force thumbs and SVG rasterizations
1030 * to rerender, such as fixes to rendering bugs.
1032 $wgThumbnailEpoch = '20030516000000';
1035 * Certain operations are avoided if there were too many recent failures,
1036 * for example, thumbnail generation. Bump this value to invalidate all
1037 * memory of failed operations and thus allow further attempts to resume.
1038 * This is useful when a cause for the failures has been found and fixed.
1040 $wgAttemptFailureEpoch = 1;
1043 * If set, inline scaled images will still produce "<img>" tags ready for
1044 * output instead of showing an error message.
1046 * This may be useful if errors are transitory, especially if the site
1047 * is configured to automatically render thumbnails on request.
1049 * On the other hand, it may obscure error conditions from debugging.
1050 * Enable the debug log or the 'thumbnail' log group to make sure errors
1051 * are logged to a file for review.
1053 $wgIgnoreImageErrors = false;
1056 * Allow thumbnail rendering on page view. If this is false, a valid
1057 * thumbnail URL is still output, but no file will be created at
1058 * the target location. This may save some time if you have a
1059 * thumb.php or 404 handler set up which is faster than the regular
1060 * webserver(s).
1062 $wgGenerateThumbnailOnParse = true;
1065 * Show thumbnails for old images on the image description page
1067 $wgShowArchiveThumbnails = true;
1070 * If set to true, images that contain certain the exif orientation tag will
1071 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1072 * is available that can rotate.
1074 $wgEnableAutoRotation = null;
1077 * Internal name of virus scanner. This serves as a key to the
1078 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1079 * null, every file uploaded will be scanned for viruses.
1081 $wgAntivirus = null;
1084 * Configuration for different virus scanners. This an associative array of
1085 * associative arrays. It contains one setup array per known scanner type.
1086 * The entry is selected by $wgAntivirus, i.e.
1087 * valid values for $wgAntivirus are the keys defined in this array.
1089 * The configuration array for each scanner contains the following keys:
1090 * "command", "codemap", "messagepattern":
1092 * "command" is the full command to call the virus scanner - %f will be
1093 * replaced with the name of the file to scan. If not present, the filename
1094 * will be appended to the command. Note that this must be overwritten if the
1095 * scanner is not in the system path; in that case, please set
1096 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1097 * path.
1099 * "codemap" is a mapping of exit code to return codes of the detectVirus
1100 * function in SpecialUpload.
1101 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1102 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1103 * is not set.
1104 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1105 * the file to have an unsupported format, which is probably immune to
1106 * viruses. This causes the file to pass.
1107 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1108 * no virus was found.
1109 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1110 * a virus.
1111 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1113 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1114 * output. The relevant part should be matched as group one (\1).
1115 * If not defined or the pattern does not match, the full message is shown to the user.
1117 $wgAntivirusSetup = array(
1119 #setup for clamav
1120 'clamav' => array(
1121 'command' => 'clamscan --no-summary ',
1122 'codemap' => array(
1123 "0" => AV_NO_VIRUS, # no virus
1124 "1" => AV_VIRUS_FOUND, # virus found
1125 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1126 "*" => AV_SCAN_FAILED, # else scan failed
1128 'messagepattern' => '/.*?:(.*)/sim',
1133 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1135 $wgAntivirusRequired = true;
1138 * Determines if the mime type of uploaded files should be checked
1140 $wgVerifyMimeType = true;
1143 * Sets the mime type definition file to use by MimeMagic.php.
1144 * Set to null, to use built-in defaults only.
1145 * example: $wgMimeTypeFile = '/etc/mime.types';
1147 $wgMimeTypeFile = 'includes/mime.types';
1150 * Sets the mime type info file to use by MimeMagic.php.
1151 * Set to null, to use built-in defaults only.
1153 $wgMimeInfoFile = 'includes/mime.info';
1156 * Sets an external mime detector program. The command must print only
1157 * the mime type to standard output.
1158 * The name of the file to process will be appended to the command given here.
1159 * If not set or NULL, mime_content_type will be used if available.
1161 * @par Example:
1162 * @code
1163 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
1164 * @endcode
1166 $wgMimeDetectorCommand = null;
1169 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
1170 * things, because only a few types of images are needed and file extensions
1171 * can be trusted.
1173 $wgTrivialMimeDetection = false;
1176 * Additional XML types we can allow via mime-detection.
1177 * array = ( 'rootElement' => 'associatedMimeType' )
1179 $wgXMLMimeTypes = array(
1180 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1181 'svg' => 'image/svg+xml',
1182 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1183 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1184 'html' => 'text/html', // application/xhtml+xml?
1188 * Limit images on image description pages to a user-selectable limit. In order
1189 * to reduce disk usage, limits can only be selected from a list.
1190 * The user preference is saved as an array offset in the database, by default
1191 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1192 * change it if you alter the array (see bug 8858).
1193 * This is the list of settings the user can choose from:
1195 $wgImageLimits = array(
1196 array( 320, 240 ),
1197 array( 640, 480 ),
1198 array( 800, 600 ),
1199 array( 1024, 768 ),
1200 array( 1280, 1024 )
1204 * Adjust thumbnails on image pages according to a user setting. In order to
1205 * reduce disk usage, the values can only be selected from a list. This is the
1206 * list of settings the user can choose from:
1208 $wgThumbLimits = array(
1209 120,
1210 150,
1211 180,
1212 200,
1213 250,
1218 * Default parameters for the "<gallery>" tag
1220 $wgGalleryOptions = array(
1221 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1222 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1223 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1224 'captionLength' => 25, // Length of caption to truncate (in characters)
1225 'showBytes' => true, // Show the filesize in bytes in categories
1226 'mode' => 'traditional',
1230 * Adjust width of upright images when parameter 'upright' is used
1231 * This allows a nicer look for upright images without the need to fix the width
1232 * by hardcoded px in wiki sourcecode.
1234 $wgThumbUpright = 0.75;
1237 * Default value for chmoding of new directories.
1239 $wgDirectoryMode = 0777;
1242 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1244 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1245 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1246 * images in after loading the original low-resolution versions depending on the reported
1247 * window.devicePixelRatio.
1249 $wgResponsiveImages = true;
1252 * @name DJVU settings
1253 * @{
1257 * Path of the djvudump executable
1258 * Enable this and $wgDjvuRenderer to enable djvu rendering
1259 * example: $wgDjvuDump = 'djvudump';
1261 $wgDjvuDump = null;
1264 * Path of the ddjvu DJVU renderer
1265 * Enable this and $wgDjvuDump to enable djvu rendering
1266 * example: $wgDjvuRenderer = 'ddjvu';
1268 $wgDjvuRenderer = null;
1271 * Path of the djvutxt DJVU text extraction utility
1272 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1273 * example: $wgDjvuTxt = 'djvutxt';
1275 $wgDjvuTxt = null;
1278 * Path of the djvutoxml executable
1279 * This works like djvudump except much, much slower as of version 3.5.
1281 * For now we recommend you use djvudump instead. The djvuxml output is
1282 * probably more stable, so we'll switch back to it as soon as they fix
1283 * the efficiency problem.
1284 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1286 * @par Example:
1287 * @code
1288 * $wgDjvuToXML = 'djvutoxml';
1289 * @endcode
1291 $wgDjvuToXML = null;
1294 * Shell command for the DJVU post processor
1295 * Default: pnmtopng, since ddjvu generates ppm output
1296 * Set this to false to output the ppm file directly.
1298 $wgDjvuPostProcessor = 'pnmtojpeg';
1301 * File extension for the DJVU post processor output
1303 $wgDjvuOutputExtension = 'jpg';
1305 /** @} */ # end of DJvu }
1307 /** @} */ # end of file uploads }
1309 /************************************************************************//**
1310 * @name Email settings
1311 * @{
1316 * Site admin email address.
1318 * Defaults to "wikiadmin@{$wgServerName}".
1320 $wgEmergencyContact = false;
1323 * Password reminder email address.
1325 * The address we should use as sender when a user is requesting his password.
1327 * Defaults to "apache@{$wgServerName}".
1329 $wgPasswordSender = false;
1332 * Password reminder name
1334 * @deprecated since 1.23; use the system message 'emailsender' instead.
1336 $wgPasswordSenderName = 'MediaWiki Mail';
1339 * Dummy address which should be accepted during mail send action.
1340 * It might be necessary to adapt the address or to set it equal
1341 * to the $wgEmergencyContact address.
1343 $wgNoReplyAddress = 'reply@not.possible';
1346 * Set to true to enable the e-mail basic features:
1347 * Password reminders, etc. If sending e-mail on your
1348 * server doesn't work, you might want to disable this.
1350 $wgEnableEmail = true;
1353 * Set to true to enable user-to-user e-mail.
1354 * This can potentially be abused, as it's hard to track.
1356 $wgEnableUserEmail = true;
1359 * Set to true to put the sending user's email in a Reply-To header
1360 * instead of From. ($wgEmergencyContact will be used as From.)
1362 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1363 * which can cause problems with SPF validation and leak recipient addresses
1364 * when bounces are sent to the sender.
1366 $wgUserEmailUseReplyTo = false;
1369 * Minimum time, in hours, which must elapse between password reminder
1370 * emails for a given account. This is to prevent abuse by mail flooding.
1372 $wgPasswordReminderResendTime = 24;
1375 * The time, in seconds, when an emailed temporary password expires.
1377 $wgNewPasswordExpiry = 3600 * 24 * 7;
1380 * The time, in seconds, when an email confirmation email expires
1382 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1385 * The number of days that a user's password is good for. After this number of days, the
1386 * user will be asked to reset their password. Set to false to disable password expiration.
1388 $wgPasswordExpirationDays = false;
1391 * If a user's password is expired, the number of seconds when they can still login,
1392 * and cancel their password change, but are sent to the password change form on each login.
1394 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1397 * SMTP Mode.
1399 * For using a direct (authenticated) SMTP server connection.
1400 * Default to false or fill an array :
1402 * @code
1403 * $wgSMTP = array(
1404 * 'host' => 'SMTP domain',
1405 * 'IDHost' => 'domain for MessageID',
1406 * 'port' => '25',
1407 * 'auth' => [true|false],
1408 * 'username' => [SMTP username],
1409 * 'password' => [SMTP password],
1410 * );
1411 * @endcode
1413 $wgSMTP = false;
1416 * Additional email parameters, will be passed as the last argument to mail() call.
1417 * If using safe_mode this has no effect
1419 $wgAdditionalMailParams = null;
1422 * For parts of the system that have been updated to provide HTML email content, send
1423 * both text and HTML parts as the body of the email
1425 $wgAllowHTMLEmail = false;
1428 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1429 * from $wgEmergencyContact
1431 $wgEnotifFromEditor = false;
1433 // TODO move UPO to preferences probably ?
1434 # If set to true, users get a corresponding option in their preferences and can choose to
1435 # enable or disable at their discretion
1436 # If set to false, the corresponding input form on the user preference page is suppressed
1437 # It call this to be a "user-preferences-option (UPO)"
1440 * Require email authentication before sending mail to an email address.
1441 * This is highly recommended. It prevents MediaWiki from being used as an open
1442 * spam relay.
1444 $wgEmailAuthentication = true;
1447 * Allow users to enable email notification ("enotif") on watchlist changes.
1449 $wgEnotifWatchlist = false;
1452 * Allow users to enable email notification ("enotif") when someone edits their
1453 * user talk page.
1455 $wgEnotifUserTalk = false;
1458 * Set the Reply-to address in notifications to the editor's address, if user
1459 * allowed this in the preferences.
1461 $wgEnotifRevealEditorAddress = false;
1464 * Send notification mails on minor edits to watchlist pages. This is enabled
1465 * by default. Does not affect user talk notifications.
1467 $wgEnotifMinorEdits = true;
1470 * Send a generic mail instead of a personalised mail for each user. This
1471 * always uses UTC as the time zone, and doesn't include the username.
1473 * For pages with many users watching, this can significantly reduce mail load.
1474 * Has no effect when using sendmail rather than SMTP.
1476 $wgEnotifImpersonal = false;
1479 * Maximum number of users to mail at once when using impersonal mail. Should
1480 * match the limit on your mail server.
1482 $wgEnotifMaxRecips = 500;
1485 * Send mails via the job queue. This can be useful to reduce the time it
1486 * takes to save a page that a lot of people are watching.
1488 $wgEnotifUseJobQ = false;
1491 * Use real name instead of username in e-mail "from" field.
1493 $wgEnotifUseRealName = false;
1496 * Array of usernames who will be sent a notification email for every change
1497 * which occurs on a wiki. Users will not be notified of their own changes.
1499 $wgUsersNotifiedOnAllChanges = array();
1501 /** @} */ # end of email settings
1503 /************************************************************************//**
1504 * @name Database settings
1505 * @{
1509 * Database host name or IP address
1511 $wgDBserver = 'localhost';
1514 * Database port number (for PostgreSQL)
1516 $wgDBport = 5432;
1519 * Name of the database
1521 $wgDBname = 'my_wiki';
1524 * Database username
1526 $wgDBuser = 'wikiuser';
1529 * Database user's password
1531 $wgDBpassword = '';
1534 * Database type
1536 $wgDBtype = 'mysql';
1539 * Whether to use SSL in DB connection.
1541 $wgDBssl = false;
1544 * Whether to use compression in DB connection.
1546 $wgDBcompress = false;
1549 * Separate username for maintenance tasks. Leave as null to use the default.
1551 $wgDBadminuser = null;
1554 * Separate password for maintenance tasks. Leave as null to use the default.
1556 $wgDBadminpassword = null;
1559 * Search type.
1560 * Leave as null to select the default search engine for the
1561 * selected database type (eg SearchMySQL), or set to a class
1562 * name to override to a custom search engine.
1564 $wgSearchType = null;
1567 * Alternative search types
1568 * Sometimes you want to support multiple search engines for testing. This
1569 * allows users to select their search engine of choice via url parameters
1570 * to Special:Search and the action=search API. If using this, there's no
1571 * need to add $wgSearchType to it, that is handled automatically.
1573 $wgSearchTypeAlternatives = null;
1576 * Table name prefix
1578 $wgDBprefix = '';
1581 * MySQL table options to use during installation or update
1583 $wgDBTableOptions = 'ENGINE=InnoDB';
1586 * SQL Mode - default is turning off all modes, including strict, if set.
1587 * null can be used to skip the setting for performance reasons and assume
1588 * DBA has done his best job.
1589 * String override can be used for some additional fun :-)
1591 $wgSQLMode = '';
1594 * Mediawiki schema
1596 $wgDBmwschema = null;
1599 * To override default SQLite data directory ($docroot/../data)
1601 $wgSQLiteDataDir = '';
1604 * Make all database connections secretly go to localhost. Fool the load balancer
1605 * thinking there is an arbitrarily large cluster of servers to connect to.
1606 * Useful for debugging.
1608 $wgAllDBsAreLocalhost = false;
1611 * Shared database for multiple wikis. Commonly used for storing a user table
1612 * for single sign-on. The server for this database must be the same as for the
1613 * main database.
1615 * For backwards compatibility the shared prefix is set to the same as the local
1616 * prefix, and the user table is listed in the default list of shared tables.
1617 * The user_properties table is also added so that users will continue to have their
1618 * preferences shared (preferences were stored in the user table prior to 1.16)
1620 * $wgSharedTables may be customized with a list of tables to share in the shared
1621 * database. However it is advised to limit what tables you do share as many of
1622 * MediaWiki's tables may have side effects if you try to share them.
1624 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1625 * $wgDBprefix.
1627 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1628 * access remote databases. Using wfGetLB() allows the shared database to
1629 * reside on separate servers to the wiki's own database, with suitable
1630 * configuration of $wgLBFactoryConf.
1632 $wgSharedDB = null;
1635 * @see $wgSharedDB
1637 $wgSharedPrefix = false;
1640 * @see $wgSharedDB
1642 $wgSharedTables = array( 'user', 'user_properties' );
1645 * Database load balancer
1646 * This is a two-dimensional array, an array of server info structures
1647 * Fields are:
1648 * - host: Host name
1649 * - dbname: Default database name
1650 * - user: DB user
1651 * - password: DB password
1652 * - type: "mysql" or "postgres"
1654 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1655 * If this is zero for any given server, no normal query traffic will be
1656 * sent to it. It will be excluded from lag checks in maintenance scripts.
1657 * The only way it can receive traffic is if groupLoads is used.
1659 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1660 * to several groups, the most specific group defined here is used.
1662 * - flags: bit field
1663 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1664 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1665 * - DBO_TRX -- wrap entire request in a transaction
1666 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1667 * - DBO_PERSISTENT -- enables persistent database connections
1668 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1669 * - DBO_COMPRESS -- uses internal compression in database connections,
1670 * if available
1672 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1674 * These and any other user-defined properties will be assigned to the mLBInfo member
1675 * variable of the Database object.
1677 * Leave at false to use the single-server variables above. If you set this
1678 * variable, the single-server variables will generally be ignored (except
1679 * perhaps in some command-line scripts).
1681 * The first server listed in this array (with key 0) will be the master. The
1682 * rest of the servers will be slaves. To prevent writes to your slaves due to
1683 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1684 * slaves in my.cnf. You can set read_only mode at runtime using:
1686 * @code
1687 * SET @@read_only=1;
1688 * @endcode
1690 * Since the effect of writing to a slave is so damaging and difficult to clean
1691 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1692 * our masters, and then set read_only=0 on masters at runtime.
1694 $wgDBservers = false;
1697 * Load balancer factory configuration
1698 * To set up a multi-master wiki farm, set the class here to something that
1699 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1700 * The class identified here is responsible for reading $wgDBservers,
1701 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1703 * The LBFactoryMulti class is provided for this purpose, please see
1704 * includes/db/LBFactoryMulti.php for configuration information.
1706 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1709 * How long to wait for a slave to catch up to the master
1711 $wgMasterWaitTimeout = 10;
1714 * File to log database errors to
1716 $wgDBerrorLog = false;
1719 * Timezone to use in the error log.
1720 * Defaults to the wiki timezone ($wgLocaltimezone).
1722 * A list of usable timezones can found at:
1723 * http://php.net/manual/en/timezones.php
1725 * @par Examples:
1726 * @code
1727 * $wgLocaltimezone = 'UTC';
1728 * $wgLocaltimezone = 'GMT';
1729 * $wgLocaltimezone = 'PST8PDT';
1730 * $wgLocaltimezone = 'Europe/Sweden';
1731 * $wgLocaltimezone = 'CET';
1732 * @endcode
1734 * @since 1.20
1736 $wgDBerrorLogTZ = false;
1739 * When to give an error message
1741 $wgDBClusterTimeout = 10;
1744 * Scale load balancer polling time so that under overload conditions, the
1745 * database server receives a SHOW STATUS query at an average interval of this
1746 * many microseconds
1748 $wgDBAvgStatusPoll = 2000;
1751 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1752 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1754 * @warning THIS IS EXPERIMENTAL!
1756 * May break if you're not using the table defs from mysql5/tables.sql.
1757 * May break if you're upgrading an existing wiki if set differently.
1758 * Broken symptoms likely to include incorrect behavior with page titles,
1759 * usernames, comments etc containing non-ASCII characters.
1760 * Might also cause failures on the object cache and other things.
1762 * Even correct usage may cause failures with Unicode supplementary
1763 * characters (those not in the Basic Multilingual Plane) unless MySQL
1764 * has enhanced their Unicode support.
1766 $wgDBmysql5 = false;
1769 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1771 * To use this feature set to true and use a datasource defined as
1772 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1773 * block).
1775 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1776 * Pool) that maintains established sessions and reuses them on new
1777 * connections.
1779 * Not completely tested, but it should fall back on normal connection
1780 * in case the pool is full or the datasource is not configured as
1781 * pooled.
1782 * And the other way around; using oci_pconnect on a non pooled
1783 * datasource should produce a normal connection.
1785 * When it comes to frequent shortlived DB connections like with MW
1786 * Oracle tends to s***. The problem is the driver connects to the
1787 * database reasonably fast, but establishing a session takes time and
1788 * resources. MW does not rely on session state (as it does not use
1789 * features such as package variables) so establishing a valid session
1790 * is in this case an unwanted overhead that just slows things down.
1792 * @warning EXPERIMENTAL!
1795 $wgDBOracleDRCP = false;
1798 * Other wikis on this site, can be administered from a single developer
1799 * account.
1800 * Array numeric key => database name
1802 $wgLocalDatabases = array();
1805 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1806 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1807 * show a more obvious warning.
1809 $wgSlaveLagWarning = 10;
1812 * @see $wgSlaveLagWarning
1814 $wgSlaveLagCritical = 30;
1817 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1819 $wgDBWindowsAuthentication = false;
1821 /**@}*/ # End of DB settings }
1823 /************************************************************************//**
1824 * @name Text storage
1825 * @{
1829 * We can also compress text stored in the 'text' table. If this is set on, new
1830 * revisions will be compressed on page save if zlib support is available. Any
1831 * compressed revisions will be decompressed on load regardless of this setting,
1832 * but will not be readable at all* if zlib support is not available.
1834 $wgCompressRevisions = false;
1837 * External stores allow including content
1838 * from non database sources following URL links.
1840 * Short names of ExternalStore classes may be specified in an array here:
1841 * @code
1842 * $wgExternalStores = array("http","file","custom")...
1843 * @endcode
1845 * CAUTION: Access to database might lead to code execution
1847 $wgExternalStores = array();
1850 * An array of external MySQL servers.
1852 * @par Example:
1853 * Create a cluster named 'cluster1' containing three servers:
1854 * @code
1855 * $wgExternalServers = array(
1856 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1857 * );
1858 * @endcode
1860 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1861 * another class.
1863 $wgExternalServers = array();
1866 * The place to put new revisions, false to put them in the local text table.
1867 * Part of a URL, e.g. DB://cluster1
1869 * Can be an array instead of a single string, to enable data distribution. Keys
1870 * must be consecutive integers, starting at zero.
1872 * @par Example:
1873 * @code
1874 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1875 * @endcode
1877 * @var array
1879 $wgDefaultExternalStore = false;
1882 * Revision text may be cached in $wgMemc to reduce load on external storage
1883 * servers and object extraction overhead for frequently-loaded revisions.
1885 * Set to 0 to disable, or number of seconds before cache expiry.
1887 $wgRevisionCacheExpiry = 0;
1889 /** @} */ # end text storage }
1891 /************************************************************************//**
1892 * @name Performance hacks and limits
1893 * @{
1897 * Disable database-intensive features
1899 $wgMiserMode = false;
1902 * Disable all query pages if miser mode is on, not just some
1904 $wgDisableQueryPages = false;
1907 * Number of rows to cache in 'querycache' table when miser mode is on
1909 $wgQueryCacheLimit = 1000;
1912 * Number of links to a page required before it is deemed "wanted"
1914 $wgWantedPagesThreshold = 1;
1917 * Enable slow parser functions
1919 $wgAllowSlowParserFunctions = false;
1922 * Allow schema updates
1924 $wgAllowSchemaUpdates = true;
1927 * Anti-lock flags - bitfield
1928 * - ALF_NO_LINK_LOCK:
1929 * Don't use locking reads when updating the link table. This is
1930 * necessary for wikis with a high edit rate for performance
1931 * reasons, but may cause link table inconsistency
1933 $wgAntiLockFlags = 0;
1936 * Maximum article size in kilobytes
1938 $wgMaxArticleSize = 2048;
1941 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1942 * raise PHP's memory limit if it's below this amount.
1944 $wgMemoryLimit = "50M";
1946 /** @} */ # end performance hacks }
1948 /************************************************************************//**
1949 * @name Cache settings
1950 * @{
1954 * Directory for caching data in the local filesystem. Should not be accessible
1955 * from the web. Set this to false to not use any local caches.
1957 * Note: if multiple wikis share the same localisation cache directory, they
1958 * must all have the same set of extensions. You can set a directory just for
1959 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1961 $wgCacheDirectory = false;
1964 * Main cache type. This should be a cache with fast access, but it may have
1965 * limited space. By default, it is disabled, since the database is not fast
1966 * enough to make it worthwhile.
1968 * The options are:
1970 * - CACHE_ANYTHING: Use anything, as long as it works
1971 * - CACHE_NONE: Do not cache
1972 * - CACHE_DB: Store cache objects in the DB
1973 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
1974 * - CACHE_ACCEL: APC, XCache or WinCache
1975 * - (other): A string may be used which identifies a cache
1976 * configuration in $wgObjectCaches.
1978 * @see $wgMessageCacheType, $wgParserCacheType
1980 $wgMainCacheType = CACHE_NONE;
1983 * The cache type for storing the contents of the MediaWiki namespace. This
1984 * cache is used for a small amount of data which is expensive to regenerate.
1986 * For available types see $wgMainCacheType.
1988 $wgMessageCacheType = CACHE_ANYTHING;
1991 * The cache type for storing article HTML. This is used to store data which
1992 * is expensive to regenerate, and benefits from having plenty of storage space.
1994 * For available types see $wgMainCacheType.
1996 $wgParserCacheType = CACHE_ANYTHING;
1999 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2001 * For available types see $wgMainCacheType.
2003 $wgSessionCacheType = CACHE_ANYTHING;
2006 * The cache type for storing language conversion tables,
2007 * which are used when parsing certain text and interface messages.
2009 * For available types see $wgMainCacheType.
2011 * @since 1.20
2013 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2016 * Advanced object cache configuration.
2018 * Use this to define the class names and constructor parameters which are used
2019 * for the various cache types. Custom cache types may be defined here and
2020 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2021 * or $wgLanguageConverterCacheType.
2023 * The format is an associative array where the key is a cache identifier, and
2024 * the value is an associative array of parameters. The "class" parameter is the
2025 * class name which will be used. Alternatively, a "factory" parameter may be
2026 * given, giving a callable function which will generate a suitable cache object.
2028 $wgObjectCaches = array(
2029 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
2030 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
2032 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
2033 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
2034 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached' ),
2036 'apc' => array( 'class' => 'APCBagOStuff' ),
2037 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2038 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2039 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2040 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2041 'hash' => array( 'class' => 'HashBagOStuff' ),
2045 * The expiry time for the parser cache, in seconds.
2046 * The default is 86400 (one day).
2048 $wgParserCacheExpireTime = 86400;
2051 * Deprecated alias for $wgSessionsInObjectCache.
2053 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2055 $wgSessionsInMemcached = false;
2058 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2059 * can be useful to improve performance, or to avoid the locking behavior of
2060 * PHP's default session handler, which tends to prevent multiple requests for
2061 * the same user from acting concurrently.
2063 $wgSessionsInObjectCache = false;
2066 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2067 * enabled, in seconds.
2069 $wgObjectCacheSessionExpiry = 3600;
2072 * This is used for setting php's session.save_handler. In practice, you will
2073 * almost never need to change this ever. Other options might be 'user' or
2074 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2075 * useful if you're doing cross-application sessions, see bug 11381)
2077 $wgSessionHandler = null;
2080 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2082 $wgMemCachedDebug = false;
2085 * The list of MemCached servers and port numbers
2087 $wgMemCachedServers = array( '127.0.0.1:11211' );
2090 * Use persistent connections to MemCached, which are shared across multiple
2091 * requests.
2093 $wgMemCachedPersistent = false;
2096 * Read/write timeout for MemCached server communication, in microseconds.
2098 $wgMemCachedTimeout = 500000;
2101 * Set this to true to make a local copy of the message cache, for use in
2102 * addition to memcached. The files will be put in $wgCacheDirectory.
2104 $wgUseLocalMessageCache = false;
2107 * Instead of caching everything, only cache those messages which have
2108 * been customised in the site content language. This means that
2109 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2110 * This option is probably only useful for translatewiki.net.
2112 $wgAdaptiveMessageCache = false;
2115 * Localisation cache configuration. Associative array with keys:
2116 * class: The class to use. May be overridden by extensions.
2118 * store: The location to store cache data. May be 'files', 'db' or
2119 * 'detect'. If set to "files", data will be in CDB files. If set
2120 * to "db", data will be stored to the database. If set to
2121 * "detect", files will be used if $wgCacheDirectory is set,
2122 * otherwise the database will be used.
2124 * storeClass: The class name for the underlying storage. If set to a class
2125 * name, it overrides the "store" setting.
2127 * storeDirectory: If the store class puts its data in files, this is the
2128 * directory it will use. If this is false, $wgCacheDirectory
2129 * will be used.
2131 * manualRecache: Set this to true to disable cache updates on web requests.
2132 * Use maintenance/rebuildLocalisationCache.php instead.
2134 $wgLocalisationCacheConf = array(
2135 'class' => 'LocalisationCache',
2136 'store' => 'detect',
2137 'storeClass' => false,
2138 'storeDirectory' => false,
2139 'manualRecache' => false,
2143 * Allow client-side caching of pages
2145 $wgCachePages = true;
2148 * Set this to current time to invalidate all prior cached pages. Affects both
2149 * client-side and server-side caching.
2150 * You can get the current date on your server by using the command:
2151 * @verbatim
2152 * date +%Y%m%d%H%M%S
2153 * @endverbatim
2155 $wgCacheEpoch = '20030516000000';
2158 * Bump this number when changing the global style sheets and JavaScript.
2160 * It should be appended in the query string of static CSS and JS includes,
2161 * to ensure that client-side caches do not keep obsolete copies of global
2162 * styles.
2164 $wgStyleVersion = '303';
2167 * This will cache static pages for non-logged-in users to reduce
2168 * database traffic on public sites.
2169 * Automatically sets $wgShowIPinHeader = false
2170 * ResourceLoader requests to default language and skins are cached
2171 * as well as single module requests.
2173 $wgUseFileCache = false;
2176 * Depth of the subdirectory hierarchy to be created under
2177 * $wgFileCacheDirectory. The subdirectories will be named based on
2178 * the MD5 hash of the title. A value of 0 means all cache files will
2179 * be put directly into the main file cache directory.
2181 $wgFileCacheDepth = 2;
2184 * Keep parsed pages in a cache (objectcache table or memcached)
2185 * to speed up output of the same page viewed by another user with the
2186 * same options.
2188 * This can provide a significant speedup for medium to large pages,
2189 * so you probably want to keep it on. Extensions that conflict with the
2190 * parser cache should disable the cache on a per-page basis instead.
2192 $wgEnableParserCache = true;
2195 * Append a configured value to the parser cache and the sitenotice key so
2196 * that they can be kept separate for some class of activity.
2198 $wgRenderHashAppend = '';
2201 * If on, the sidebar navigation links are cached for users with the
2202 * current language set. This can save a touch of load on a busy site
2203 * by shaving off extra message lookups.
2205 * However it is also fragile: changing the site configuration, or
2206 * having a variable $wgArticlePath, can produce broken links that
2207 * don't update as expected.
2209 $wgEnableSidebarCache = false;
2212 * Expiry time for the sidebar cache, in seconds
2214 $wgSidebarCacheExpiry = 86400;
2217 * When using the file cache, we can store the cached HTML gzipped to save disk
2218 * space. Pages will then also be served compressed to clients that support it.
2220 * Requires zlib support enabled in PHP.
2222 $wgUseGzip = false;
2225 * Whether MediaWiki should send an ETag header. Seems to cause
2226 * broken behavior with Squid 2.6, see bug 7098.
2228 $wgUseETag = false;
2231 * Clock skew or the one-second resolution of time() can occasionally cause cache
2232 * problems when the user requests two pages within a short period of time. This
2233 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2234 * a grace period.
2236 $wgClockSkewFudge = 5;
2239 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2240 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2241 * was previously done in the default LocalSettings.php file.
2243 * On high-traffic wikis, this should be set to false, to avoid the need to
2244 * check the file modification time, and to avoid the performance impact of
2245 * unnecessary cache invalidations.
2247 $wgInvalidateCacheOnLocalSettingsChange = true;
2249 /** @} */ # end of cache settings
2251 /************************************************************************//**
2252 * @name HTTP proxy (Squid) settings
2254 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2255 * although they are referred to as Squid settings for historical reasons.
2257 * Achieving a high hit ratio with an HTTP proxy requires special
2258 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2259 * more details.
2261 * @{
2265 * Enable/disable Squid.
2266 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2268 $wgUseSquid = false;
2271 * If you run Squid3 with ESI support, enable this (default:false):
2273 $wgUseESI = false;
2276 * Send X-Vary-Options header for better caching (requires patched Squid)
2278 $wgUseXVO = false;
2281 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2282 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2283 * and need to split the cache between HTTP and HTTPS for API requests,
2284 * feed requests and HTTP redirect responses in order to prevent cache
2285 * pollution. This does not affect 'normal' requests to index.php other than
2286 * HTTP redirects.
2288 $wgVaryOnXFP = false;
2291 * Internal server name as known to Squid, if different.
2293 * @par Example:
2294 * @code
2295 * $wgInternalServer = 'http://yourinternal.tld:8000';
2296 * @endcode
2298 $wgInternalServer = false;
2301 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2302 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2303 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2304 * days
2306 $wgSquidMaxage = 18000;
2309 * Default maximum age for raw CSS/JS accesses
2311 $wgForcedRawSMaxage = 300;
2314 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2316 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2317 * headers sent/modified from these proxies when obtaining the remote IP address
2319 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2321 $wgSquidServers = array();
2324 * As above, except these servers aren't purged on page changes; use to set a
2325 * list of trusted proxies, etc. Supports both individual IP addresses and
2326 * CIDR blocks.
2327 * @since 1.23 Supports CIDR ranges
2329 $wgSquidServersNoPurge = array();
2332 * Maximum number of titles to purge in any one client operation
2334 $wgMaxSquidPurgeTitles = 400;
2337 * Whether to use a Host header in purge requests sent to the proxy servers
2338 * configured in $wgSquidServers. Set this to false to support Squid
2339 * configured in forward-proxy mode.
2341 * If this is set to true, a Host header will be sent, and only the path
2342 * component of the URL will appear on the request line, as if the request
2343 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2344 * request. Squid supports this style of request only if reverse-proxy mode
2345 * (http_port ... accel) is enabled.
2347 * If this is set to false, no Host header will be sent, and the absolute URL
2348 * will be sent in the request line, as is the standard for an HTTP proxy
2349 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2350 * by Varnish, but is supported by Squid in either configuration (forward or
2351 * reverse).
2353 * @since 1.21
2355 $wgSquidPurgeUseHostHeader = true;
2358 * Routing configuration for HTCP multicast purging. Add elements here to
2359 * enable HTCP and determine which purges are sent where. If set to an empty
2360 * array, HTCP is disabled.
2362 * Each key in this array is a regular expression to match against the purged
2363 * URL, or an empty string to match all URLs. The purged URL is matched against
2364 * the regexes in the order specified, and the first rule whose regex matches
2365 * is used, all remaining rules will thus be ignored.
2367 * @par Example configuration to send purges for upload.wikimedia.org to one
2368 * multicast group and all other purges to another:
2369 * @code
2370 * $wgHTCPRouting = array(
2371 * '|^https?://upload\.wikimedia\.org|' => array(
2372 * 'host' => '239.128.0.113',
2373 * 'port' => 4827,
2374 * ),
2375 * '' => array(
2376 * 'host' => '239.128.0.112',
2377 * 'port' => 4827,
2378 * ),
2379 * );
2380 * @endcode
2382 * You can also pass an array of hosts to send purges too. This is useful when
2383 * you have several multicast groups or unicast address that should receive a
2384 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2386 * @par Example of sending purges to multiple hosts:
2387 * @code
2388 * $wgHTCPRouting = array(
2389 * '' => array(
2390 * // Purges to text caches using multicast
2391 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2392 * // Purges to a hardcoded list of caches
2393 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2394 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2395 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2396 * ),
2397 * );
2398 * @endcode
2400 * @since 1.22
2402 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2403 * For back compatibility purposes, whenever its array is empty
2404 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2406 * @see $wgHTCPMulticastTTL
2408 $wgHTCPRouting = array();
2411 * @deprecated since 1.22, please use $wgHTCPRouting instead.
2413 * Whenever this is set and $wgHTCPRouting evaluates to false, $wgHTCPRouting
2414 * will be set to this value.
2415 * This is merely for back compatibility.
2417 * @since 1.20
2419 $wgHTCPMulticastRouting = null;
2422 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
2424 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
2425 * present in the earliest Squid implementations of the protocol.
2427 * This setting is DEPRECATED in favor of $wgHTCPRouting , and kept for
2428 * backwards compatibility only. If $wgHTCPRouting is set, this setting is
2429 * ignored. If $wgHTCPRouting is not set and this setting is, it is used to
2430 * populate $wgHTCPRouting.
2432 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2433 * favor of $wgHTCPRouting.
2435 $wgHTCPMulticastAddress = false;
2438 * HTCP multicast port.
2439 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2440 * favor of $wgHTCPRouting.
2442 * @see $wgHTCPMulticastAddress
2444 $wgHTCPPort = 4827;
2447 * HTCP multicast TTL.
2448 * @see $wgHTCPRouting
2450 $wgHTCPMulticastTTL = 1;
2453 * Should forwarded Private IPs be accepted?
2455 $wgUsePrivateIPs = false;
2457 /** @} */ # end of HTTP proxy settings
2459 /************************************************************************//**
2460 * @name Language, regional and character encoding settings
2461 * @{
2465 * Site language code. See languages/Names.php for languages supported by
2466 * MediaWiki out of the box. Not all languages listed there have translations,
2467 * see languages/messages/ for the list of languages with some localisation.
2469 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2470 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2472 * This defines the default interface language for all users, but users can
2473 * change it in their preferences.
2475 * This also defines the language of pages in the wiki. The content is wrapped
2476 * in a html element with lang=XX attribute. This behavior can be overridden
2477 * via hooks, see Title::getPageLanguage.
2479 $wgLanguageCode = 'en';
2482 * Language cache size, or really how many languages can we handle
2483 * simultaneously without degrading to crawl speed.
2485 $wgLangObjCacheSize = 10;
2488 * Some languages need different word forms, usually for different cases.
2489 * Used in Language::convertGrammar().
2491 * @par Example:
2492 * @code
2493 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2494 * @endcode
2496 $wgGrammarForms = array();
2499 * Treat language links as magic connectors, not inline links
2501 $wgInterwikiMagic = true;
2504 * Hide interlanguage links from the sidebar
2506 $wgHideInterlanguageLinks = false;
2509 * List of language names or overrides for default names in Names.php
2511 $wgExtraLanguageNames = array();
2514 * List of language codes that don't correspond to an actual language.
2515 * These codes are mostly left-offs from renames, or other legacy things.
2516 * This array makes them not appear as a selectable language on the installer,
2517 * and excludes them when running the transstat.php script.
2519 $wgDummyLanguageCodes = array(
2520 'als' => 'gsw',
2521 'bat-smg' => 'sgs',
2522 'be-x-old' => 'be-tarask',
2523 'bh' => 'bho',
2524 'fiu-vro' => 'vro',
2525 'no' => 'nb',
2526 'qqq' => 'qqq', # Used for message documentation.
2527 'qqx' => 'qqx', # Used for viewing message keys.
2528 'roa-rup' => 'rup',
2529 'simple' => 'en',
2530 'zh-classical' => 'lzh',
2531 'zh-min-nan' => 'nan',
2532 'zh-yue' => 'yue',
2536 * Character set for use in the article edit box. Language-specific encodings
2537 * may be defined.
2539 * This historic feature is one of the first that was added by former MediaWiki
2540 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2542 $wgEditEncoding = '';
2545 * Set this to true to replace Arabic presentation forms with their standard
2546 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2547 * set to "ar".
2549 * Note that pages with titles containing presentation forms will become
2550 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2552 $wgFixArabicUnicode = true;
2555 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2556 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2557 * set to "ml". Note that some clients (even new clients as of 2010) do not
2558 * support these characters.
2560 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2561 * fix any ZWJ sequences in existing page titles.
2563 $wgFixMalayalamUnicode = true;
2566 * Set this to always convert certain Unicode sequences to modern ones
2567 * regardless of the content language. This has a small performance
2568 * impact.
2570 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2571 * details.
2573 * @since 1.17
2575 $wgAllUnicodeFixes = false;
2578 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2579 * loading old revisions not marked with "utf-8" flag. Use this when
2580 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2581 * burdensome mass conversion of old text data.
2583 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2584 * user names, etc still must be converted en masse in the database before
2585 * continuing as a UTF-8 wiki.
2587 $wgLegacyEncoding = false;
2590 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2591 * regexps : "/regexp/" matching problematic browsers. These browsers will
2592 * be served encoded unicode in the edit box instead of real unicode.
2594 $wgBrowserBlackList = array(
2596 * Netscape 2-4 detection
2597 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2598 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2599 * with a negative assertion. The [UIN] identifier specifies the level of security
2600 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2601 * The language string is unreliable, it is missing on NS4 Mac.
2603 * Reference: http://www.psychedelix.com/agents/index.shtml
2605 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2606 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2607 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2610 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2611 * Þ to <THORN> and Ð to <ETH>
2613 * Known useragents:
2614 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2615 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2616 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2617 * - [...]
2619 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2620 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2622 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2625 * Google wireless transcoder, seems to eat a lot of chars alive
2626 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2628 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2632 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2633 * create stub reference rows in the text table instead of copying
2634 * the full text of all current entries from 'cur' to 'text'.
2636 * This will speed up the conversion step for large sites, but
2637 * requires that the cur table be kept around for those revisions
2638 * to remain viewable.
2640 * This option affects the updaters *only*. Any present cur stub
2641 * revisions will be readable at runtime regardless of this setting.
2643 $wgLegacySchemaConversion = false;
2646 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2647 * the interface is set to English.
2649 $wgAmericanDates = false;
2652 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2653 * numerals in interface.
2655 $wgTranslateNumerals = true;
2658 * Translation using MediaWiki: namespace.
2659 * Interface messages will be loaded from the database.
2661 $wgUseDatabaseMessages = true;
2664 * Expiry time for the message cache key
2666 $wgMsgCacheExpiry = 86400;
2669 * Maximum entry size in the message cache, in bytes
2671 $wgMaxMsgCacheEntrySize = 10000;
2674 * Whether to enable language variant conversion.
2676 $wgDisableLangConversion = false;
2679 * Whether to enable language variant conversion for links.
2681 $wgDisableTitleConversion = false;
2684 * Whether to enable canonical language links in meta data.
2686 $wgCanonicalLanguageLinks = true;
2689 * Default variant code, if false, the default will be the language code
2691 $wgDefaultLanguageVariant = false;
2694 * Disabled variants array of language variant conversion.
2696 * @par Example:
2697 * @code
2698 * $wgDisabledVariants[] = 'zh-mo';
2699 * $wgDisabledVariants[] = 'zh-my';
2700 * @endcode
2702 $wgDisabledVariants = array();
2705 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2706 * path format that describes which parts of the URL contain the
2707 * language variant.
2709 * @par Example:
2710 * @code
2711 * $wgLanguageCode = 'sr';
2712 * $wgVariantArticlePath = '/$2/$1';
2713 * $wgArticlePath = '/wiki/$1';
2714 * @endcode
2716 * A link to /wiki/ would be redirected to /sr/Главна_страна
2718 * It is important that $wgArticlePath not overlap with possible values
2719 * of $wgVariantArticlePath.
2721 $wgVariantArticlePath = false;
2724 * Show a bar of language selection links in the user login and user
2725 * registration forms; edit the "loginlanguagelinks" message to
2726 * customise these.
2728 $wgLoginLanguageSelector = false;
2731 * When translating messages with wfMessage(), it is not always clear what
2732 * should be considered UI messages and what should be content messages.
2734 * For example, for the English Wikipedia, there should be only one 'mainpage',
2735 * so when getting the link for 'mainpage', we should treat it as site content
2736 * and call ->inContentLanguage()->text(), but for rendering the text of the
2737 * link, we call ->text(). The code behaves this way by default. However,
2738 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2739 * and the like for different languages. This array provides a way to override
2740 * the default behavior.
2742 * @par Example:
2743 * To allow language-specific main page and community
2744 * portal:
2745 * @code
2746 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2747 * @endcode
2749 $wgForceUIMsgAsContentMsg = array();
2752 * Fake out the timezone that the server thinks it's in. This will be used for
2753 * date display and not for what's stored in the DB. Leave to null to retain
2754 * your server's OS-based timezone value.
2756 * This variable is currently used only for signature formatting and for local
2757 * time/date parser variables ({{LOCALTIME}} etc.)
2759 * Timezones can be translated by editing MediaWiki messages of type
2760 * timezone-nameinlowercase like timezone-utc.
2762 * A list of usable timezones can found at:
2763 * http://php.net/manual/en/timezones.php
2765 * @par Examples:
2766 * @code
2767 * $wgLocaltimezone = 'UTC';
2768 * $wgLocaltimezone = 'GMT';
2769 * $wgLocaltimezone = 'PST8PDT';
2770 * $wgLocaltimezone = 'Europe/Sweden';
2771 * $wgLocaltimezone = 'CET';
2772 * @endcode
2774 $wgLocaltimezone = null;
2777 * Set an offset from UTC in minutes to use for the default timezone setting
2778 * for anonymous users and new user accounts.
2780 * This setting is used for most date/time displays in the software, and is
2781 * overridable in user preferences. It is *not* used for signature timestamps.
2783 * By default, this will be set to match $wgLocaltimezone.
2785 $wgLocalTZoffset = null;
2787 /** @} */ # End of language/charset settings
2789 /*************************************************************************//**
2790 * @name Output format and skin settings
2791 * @{
2795 * The default Content-Type header.
2797 $wgMimeType = 'text/html';
2800 * Previously used as content type in HTML script tags. This is now ignored since
2801 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2802 * It was also previously used by RawAction to determine the ctype query parameter
2803 * value that will result in a javascript response.
2804 * @deprecated since 1.22
2806 $wgJsMimeType = null;
2809 * The default xmlns attribute. The option to define this has been removed.
2810 * The value of this variable is no longer used by core and is set to a fixed
2811 * value in Setup.php for compatibility with extensions that depend on the value
2812 * of this variable being set. Such a dependency however is deprecated.
2813 * @deprecated since 1.22
2815 $wgXhtmlDefaultNamespace = null;
2818 * Previously used to determine if we should output an HTML5 doctype.
2819 * This is no longer used as we always output HTML5 now. For compatibility with
2820 * extensions that still check the value of this config it's value is now forced
2821 * to true by Setup.php.
2822 * @deprecated since 1.22
2824 $wgHtml5 = true;
2827 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2828 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2829 * (like if it's left at the default null value), it will be auto-initialized
2830 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2831 * ever actually set this to anything.
2833 $wgHtml5Version = null;
2836 * Enabled RDFa attributes for use in wikitext.
2837 * NOTE: Interaction with HTML5 is somewhat underspecified.
2839 $wgAllowRdfaAttributes = false;
2842 * Enabled HTML5 microdata attributes for use in wikitext.
2844 $wgAllowMicrodataAttributes = false;
2847 * Should we try to make our HTML output well-formed XML? If set to false,
2848 * output will be a few bytes shorter, and the HTML will arguably be more
2849 * readable. If set to true, life will be much easier for the authors of
2850 * screen-scraping bots, and the HTML will arguably be more readable.
2852 * Setting this to false may omit quotation marks on some attributes, omit
2853 * slashes from some self-closing tags, omit some ending tags, etc., where
2854 * permitted by HTML5. Setting it to true will not guarantee that all pages
2855 * will be well-formed, although non-well-formed pages should be rare and it's
2856 * a bug if you find one. Conversely, setting it to false doesn't mean that
2857 * all XML-y constructs will be omitted, just that they might be.
2859 * Because of compatibility with screen-scraping bots, and because it's
2860 * controversial, this is currently left to true by default.
2862 $wgWellFormedXml = true;
2865 * Permit other namespaces in addition to the w3.org default.
2867 * Use the prefix for the key and the namespace for the value.
2869 * @par Example:
2870 * @code
2871 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2872 * @endcode
2873 * Normally we wouldn't have to define this in the root "<html>"
2874 * element, but IE needs it there in some circumstances.
2876 * This is ignored if $wgMimeType is set to a non-XML mimetype.
2878 $wgXhtmlNamespaces = array();
2881 * Show IP address, for non-logged in users. It's necessary to switch this off
2882 * for some forms of caching.
2883 * @warning Will disable file cache.
2885 $wgShowIPinHeader = true;
2888 * Site notice shown at the top of each page
2890 * MediaWiki:Sitenotice page, which will override this. You can also
2891 * provide a separate message for logged-out users using the
2892 * MediaWiki:Anonnotice page.
2894 $wgSiteNotice = '';
2897 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2899 $wgSiteSupportPage = '';
2902 * Validate the overall output using tidy and refuse
2903 * to display the page if it's not valid.
2905 $wgValidateAllHtml = false;
2908 * Default skin, for new users and anonymous visitors. Registered users may
2909 * change this to any one of the other available skins in their preferences.
2910 * This has to be completely lowercase; see the "skins" directory for the list
2911 * of available skins.
2913 $wgDefaultSkin = 'vector';
2916 * Specify the name of a skin that should not be presented in the list of
2917 * available skins. Use for blacklisting a skin which you do not want to
2918 * remove from the .../skins/ directory
2920 * @deprecated since 1.23; use $wgSkipSkins instead
2922 $wgSkipSkin = '';
2925 * Array for more like $wgSkipSkin.
2927 $wgSkipSkins = array();
2930 * Allow user Javascript page?
2931 * This enables a lot of neat customizations, but may
2932 * increase security risk to users and server load.
2934 $wgAllowUserJs = false;
2937 * Allow user Cascading Style Sheets (CSS)?
2938 * This enables a lot of neat customizations, but may
2939 * increase security risk to users and server load.
2941 $wgAllowUserCss = false;
2944 * Allow user-preferences implemented in CSS?
2945 * This allows users to customise the site appearance to a greater
2946 * degree; disabling it will improve page load times.
2948 $wgAllowUserCssPrefs = true;
2951 * Use the site's Javascript page?
2953 $wgUseSiteJs = true;
2956 * Use the site's Cascading Style Sheets (CSS)?
2958 $wgUseSiteCss = true;
2961 * Break out of framesets. This can be used to prevent clickjacking attacks,
2962 * or to prevent external sites from framing your site with ads.
2964 $wgBreakFrames = false;
2967 * The X-Frame-Options header to send on pages sensitive to clickjacking
2968 * attacks, such as edit pages. This prevents those pages from being displayed
2969 * in a frame or iframe. The options are:
2971 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2973 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
2974 * to allow framing within a trusted domain. This is insecure if there
2975 * is a page on the same domain which allows framing of arbitrary URLs.
2977 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
2978 * full compromise of local user accounts. Private wikis behind a
2979 * corporate firewall are especially vulnerable. This is not
2980 * recommended.
2982 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
2983 * not just edit pages.
2985 $wgEditPageFrameOptions = 'DENY';
2988 * Disallow framing of API pages directly, by setting the X-Frame-Options
2989 * header. Since the API returns CSRF tokens, allowing the results to be
2990 * framed can compromise your user's account security.
2991 * Options are:
2992 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2993 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
2994 * - false: Allow all framing.
2996 $wgApiFrameOptions = 'DENY';
2999 * Disable output compression (enabled by default if zlib is available)
3001 $wgDisableOutputCompression = false;
3004 * Should we allow a broader set of characters in id attributes, per HTML5? If
3005 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3006 * functionality is ready, it will be on by default with no option.
3008 * Currently this appears to work fine in all browsers, but it's disabled by
3009 * default because it normalizes id's a bit too aggressively, breaking preexisting
3010 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3012 $wgExperimentalHtmlIds = false;
3015 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3016 * You can add new icons to the built in copyright or poweredby, or you can create
3017 * a new block. Though note that you may need to add some custom css to get good styling
3018 * of new blocks in monobook. vector and modern should work without any special css.
3020 * $wgFooterIcons itself is a key/value array.
3021 * The key is the name of a block that the icons will be wrapped in. The final id varies
3022 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3023 * turns it into mw_poweredby.
3024 * The value is either key/value array of icons or a string.
3025 * In the key/value array the key may or may not be used by the skin but it can
3026 * be used to find the icon and unset it or change the icon if needed.
3027 * This is useful for disabling icons that are set by extensions.
3028 * The value should be either a string or an array. If it is a string it will be output
3029 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3030 * for the icon, the following keys are used:
3031 * - src: An absolute url to the image to use for the icon, this is recommended
3032 * but not required, however some skins will ignore icons without an image
3033 * - url: The url to use in the a element around the text or icon, if not set an a element will
3034 * not be outputted
3035 * - alt: This is the text form of the icon, it will be displayed without an image in
3036 * skins like Modern or if src is not set, and will otherwise be used as
3037 * the alt="" for the image. This key is required.
3038 * - width and height: If the icon specified by src is not of the standard size
3039 * you can specify the size of image to use with these keys.
3040 * Otherwise they will default to the standard 88x31.
3041 * @todo Reformat documentation.
3043 $wgFooterIcons = array(
3044 "copyright" => array(
3045 "copyright" => array(), // placeholder for the built in copyright icon
3047 "poweredby" => array(
3048 "mediawiki" => array(
3049 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
3050 "url" => "//www.mediawiki.org/",
3051 "alt" => "Powered by MediaWiki",
3057 * Login / create account link behavior when it's possible for anonymous users
3058 * to create an account.
3059 * - true = use a combined login / create account link
3060 * - false = split login and create account into two separate links
3062 $wgUseCombinedLoginLink = false;
3065 * Search form look for Vector skin only.
3066 * - true = use an icon search button
3067 * - false = use Go & Search buttons
3069 $wgVectorUseSimpleSearch = true;
3072 * Watch and unwatch as an icon rather than a link for Vector skin only.
3073 * - true = use an icon watch/unwatch button
3074 * - false = use watch/unwatch text link
3076 $wgVectorUseIconWatch = true;
3079 * Display user edit counts in various prominent places.
3081 $wgEdititis = false;
3084 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3085 * status code, mangling or hiding MediaWiki's output. If you are using such a
3086 * host, you should start looking for a better one. While you're doing that,
3087 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3088 * that the generated error pages can be seen.
3090 * In cases where for technical reasons it is more important for MediaWiki to
3091 * send the correct status code than for the body to be transmitted intact,
3092 * this configuration variable is ignored.
3094 $wgSend404Code = true;
3097 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3098 * rollback. The numeric value of the variable are the limit up to are counted.
3099 * If the value is false or 0, the edits are not counted. Disabling this will
3100 * furthermore prevent MediaWiki from hiding some useless rollback links.
3102 * @since 1.20
3104 $wgShowRollbackEditCount = 10;
3107 * Output a <link rel="canonical"> tag on every page indicating the canonical
3108 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3109 * detection of the current server is unreliable, the link is sent
3110 * unconditionally.
3112 $wgEnableCanonicalServerLink = false;
3114 /** @} */ # End of output format settings }
3116 /*************************************************************************//**
3117 * @name Resource loader settings
3118 * @{
3122 * Client-side resource modules.
3124 * Extensions should add their resource loader module definitions
3125 * to the $wgResourceModules variable.
3127 * @par Example:
3128 * @code
3129 * $wgResourceModules['ext.myExtension'] = array(
3130 * 'scripts' => 'myExtension.js',
3131 * 'styles' => 'myExtension.css',
3132 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3133 * 'localBasePath' => __DIR__,
3134 * 'remoteExtPath' => 'MyExtension',
3135 * );
3136 * @endcode
3138 $wgResourceModules = array();
3141 * Extensions should register foreign module sources here. 'local' is a
3142 * built-in source that is not in this array, but defined by
3143 * ResourceLoader::__construct() so that it cannot be unset.
3145 * @par Example:
3146 * @code
3147 * $wgResourceLoaderSources['foo'] = array(
3148 * 'loadScript' => 'http://example.org/w/load.php',
3149 * 'apiScript' => 'http://example.org/w/api.php'
3150 * );
3151 * @endcode
3153 $wgResourceLoaderSources = array();
3156 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3157 * If not set, then $wgScriptPath will be used as a fallback.
3159 $wgResourceBasePath = null;
3162 * Maximum time in seconds to cache resources served by the resource loader.
3163 * Used to set last modified headers (max-age/s-maxage).
3165 * Following options to distinguish:
3166 * - versioned: Used for modules with a version, because changing version
3167 * numbers causes cache misses. This normally has a long expiry time.
3168 * - unversioned: Used for modules without a version to propagate changes
3169 * quickly to clients. Also used for modules with errors to recover quickly.
3170 * This normally has a short expiry time.
3172 * Expiry time for the options to distinguish:
3173 * - server: Squid/Varnish but also any other public proxy cache between the
3174 * client and MediaWiki.
3175 * - client: On the client side (e.g. in the browser cache).
3177 $wgResourceLoaderMaxage = array(
3178 'versioned' => array(
3179 'server' => 30 * 24 * 60 * 60, // 30 days
3180 'client' => 30 * 24 * 60 * 60, // 30 days
3182 'unversioned' => array(
3183 'server' => 5 * 60, // 5 minutes
3184 'client' => 5 * 60, // 5 minutes
3189 * The default debug mode (on/off) for of ResourceLoader requests.
3191 * This will still be overridden when the debug URL parameter is used.
3193 $wgResourceLoaderDebug = false;
3196 * Enable embedding of certain resources using Edge Side Includes. This will
3197 * improve performance but only works if there is something in front of the
3198 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3200 $wgResourceLoaderUseESI = false;
3203 * Put each statement on its own line when minifying JavaScript. This makes
3204 * debugging in non-debug mode a bit easier.
3206 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3209 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3210 * the minifier will try not to produce lines longer than this, but may be
3211 * forced to do so in certain cases.
3213 $wgResourceLoaderMinifierMaxLineLength = 1000;
3216 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3217 * dependencies.
3219 $wgIncludeLegacyJavaScript = true;
3222 * Whether to preload the mediawiki.util module as blocking module in the top
3223 * queue.
3225 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3226 * allowed modules to lack dependencies on 'popular' modules that were likely
3227 * loaded already.
3229 * This setting is to aid scripts during migration by providing mediawiki.util
3230 * unconditionally (which was the most commonly missed dependency).
3231 * It doesn't cover all missing dependencies obviously but should fix most of
3232 * them.
3234 * This should be removed at some point after site/user scripts have been fixed.
3235 * Enable this if your wiki has a large amount of user/site scripts that are
3236 * lacking dependencies.
3237 * @todo Deprecate
3239 $wgPreloadJavaScriptMwUtil = false;
3242 * Whether or not to assign configuration variables to the global window object.
3244 * If this is set to false, old code using deprecated variables will no longer
3245 * work.
3247 * @par Example of legacy code:
3248 * @code{,js}
3249 * if ( window.wgRestrictionEdit ) { ... }
3250 * @endcode
3251 * or:
3252 * @code{,js}
3253 * if ( wgIsArticle ) { ... }
3254 * @endcode
3256 * Instead, one needs to use mw.config.
3257 * @par Example using mw.config global configuration:
3258 * @code{,js}
3259 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3260 * @endcode
3261 * or:
3262 * @code{,js}
3263 * if ( mw.config.get('wgIsArticle') ) { ... }
3264 * @endcode
3266 $wgLegacyJavaScriptGlobals = true;
3269 * If set to a positive number, ResourceLoader will not generate URLs whose
3270 * query string is more than this many characters long, and will instead use
3271 * multiple requests with shorter query strings. This degrades performance,
3272 * but may be needed if your web server has a low (less than, say 1024)
3273 * query string length limit or a low value for suhosin.get.max_value_length
3274 * that you can't increase.
3276 * If set to a negative number, ResourceLoader will assume there is no query
3277 * string length limit.
3279 * Defaults to a value based on php configuration.
3281 $wgResourceLoaderMaxQueryLength = false;
3284 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3285 * prior to minification to validate it.
3287 * Parse errors will result in a JS exception being thrown during module load,
3288 * which avoids breaking other modules loaded in the same request.
3290 $wgResourceLoaderValidateJS = true;
3293 * If set to true, statically-sourced (file-backed) JavaScript resources will
3294 * be parsed for validity before being bundled up into ResourceLoader modules.
3296 * This can be helpful for development by providing better error messages in
3297 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3298 * and may fail on large pre-bundled frameworks.
3300 $wgResourceLoaderValidateStaticJS = false;
3303 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3304 * will be enabled. This is an experimental feature that's supposed to make
3305 * JavaScript load faster.
3307 $wgResourceLoaderExperimentalAsyncLoading = false;
3310 * Global LESS variables. An associative array binding variable names to CSS
3311 * string values.
3313 * Because the hashed contents of this array are used to construct the cache key
3314 * that ResourceLoader uses to look up LESS compilation results, updating this
3315 * array can be used to deliberately invalidate the set of cached results.
3317 * @par Example:
3318 * @code
3319 * $wgResourceLoaderLESSVars = array(
3320 * 'baseFontSize' => '1em',
3321 * 'smallFontSize' => '0.75em',
3322 * 'WikimediaBlue' => '#006699',
3323 * );
3324 * @endcode
3325 * @since 1.22
3327 $wgResourceLoaderLESSVars = array();
3330 * Custom LESS functions. An associative array mapping function name to PHP
3331 * callable.
3333 * Changes to LESS functions do not trigger cache invalidation. If you update
3334 * the behavior of a LESS function and need to invalidate stale compilation
3335 * results, you can touch one of values in $wgResourceLoaderLESSVars, as
3336 * documented above.
3338 * @since 1.22
3340 $wgResourceLoaderLESSFunctions = array(
3341 'embeddable' => 'ResourceLoaderLESSFunctions::embeddable',
3342 'embed' => 'ResourceLoaderLESSFunctions::embed',
3346 * Default import paths for LESS modules. LESS files referenced in @import
3347 * statements will be looked up here first, and relative to the importing file
3348 * second. To avoid collisions, it's important for the LESS files in these
3349 * directories to have a common, predictable file name prefix.
3351 * Extensions need not (and should not) register paths in
3352 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3353 * currently compiling LESS file, which allows each extension to freely import
3354 * files from its own tree.
3356 * @since 1.22
3358 $wgResourceLoaderLESSImportPaths = array(
3359 "$IP/resources/src/mediawiki.less/",
3360 "$IP/skins/vector/",
3364 * Whether ResourceLoader should attempt to persist modules in localStorage on
3365 * browsers that support the Web Storage API.
3367 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3369 $wgResourceLoaderStorageEnabled = false;
3372 * Cache version for client-side ResourceLoader module storage. You can trigger
3373 * invalidation of the contents of the module store by incrementing this value.
3375 * @since 1.23
3377 $wgResourceLoaderStorageVersion = 1;
3379 /** @} */ # End of resource loader settings }
3381 /*************************************************************************//**
3382 * @name Page title and interwiki link settings
3383 * @{
3387 * Name of the project namespace. If left set to false, $wgSitename will be
3388 * used instead.
3390 $wgMetaNamespace = false;
3393 * Name of the project talk namespace.
3395 * Normally you can ignore this and it will be something like
3396 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3397 * manually for grammatical reasons.
3399 $wgMetaNamespaceTalk = false;
3402 * Additional namespaces. If the namespaces defined in Language.php and
3403 * Namespace.php are insufficient, you can create new ones here, for example,
3404 * to import Help files in other languages. You can also override the namespace
3405 * names of existing namespaces. Extensions developers should use
3406 * $wgCanonicalNamespaceNames.
3408 * @warning Once you delete a namespace, the pages in that namespace will
3409 * no longer be accessible. If you rename it, then you can access them through
3410 * the new namespace name.
3412 * Custom namespaces should start at 100 to avoid conflicting with standard
3413 * namespaces, and should always follow the even/odd main/talk pattern.
3415 * @par Example:
3416 * @code
3417 * $wgExtraNamespaces = array(
3418 * 100 => "Hilfe",
3419 * 101 => "Hilfe_Diskussion",
3420 * 102 => "Aide",
3421 * 103 => "Discussion_Aide"
3422 * );
3423 * @endcode
3425 * @todo Add a note about maintenance/namespaceDupes.php
3427 $wgExtraNamespaces = array();
3430 * Same as above, but for namespaces with gender distinction.
3431 * Note: the default form for the namespace should also be set
3432 * using $wgExtraNamespaces for the same index.
3433 * @since 1.18
3435 $wgExtraGenderNamespaces = array();
3438 * Namespace aliases.
3440 * These are alternate names for the primary localised namespace names, which
3441 * are defined by $wgExtraNamespaces and the language file. If a page is
3442 * requested with such a prefix, the request will be redirected to the primary
3443 * name.
3445 * Set this to a map from namespace names to IDs.
3447 * @par Example:
3448 * @code
3449 * $wgNamespaceAliases = array(
3450 * 'Wikipedian' => NS_USER,
3451 * 'Help' => 100,
3452 * );
3453 * @endcode
3455 $wgNamespaceAliases = array();
3458 * Allowed title characters -- regex character class
3459 * Don't change this unless you know what you're doing
3461 * Problematic punctuation:
3462 * - []{}|# Are needed for link syntax, never enable these
3463 * - <> Causes problems with HTML escaping, don't use
3464 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3465 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3466 * corrupted by apache
3467 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3469 * All three of these punctuation problems can be avoided by using an alias,
3470 * instead of a rewrite rule of either variety.
3472 * The problem with % is that when using a path to query rewrite rule, URLs are
3473 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3474 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3475 * for this, indeed double escaping would break if the double-escaped title was
3476 * passed in the query string rather than the path. This is a minor security issue
3477 * because articles can be created such that they are hard to view or edit.
3479 * In some rare cases you may wish to remove + for compatibility with old links.
3481 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3482 * this breaks interlanguage links
3484 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3487 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3489 * @deprecated since 1.23; use $wgLocalInterwikis instead
3491 $wgLocalInterwiki = false;
3494 * Array for multiple $wgLocalInterwiki values, in case there are several
3495 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3496 * set, its value is prepended to this array, for backwards compatibility.
3498 * Note, recent changes feeds use only the first entry in this array (or
3499 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3501 $wgLocalInterwikis = array();
3504 * Expiry time for cache of interwiki table
3506 $wgInterwikiExpiry = 10800;
3509 * @name Interwiki caching settings.
3510 * @{
3514 *$wgInterwikiCache specifies path to constant database file.
3516 * This cdb database is generated by dumpInterwiki from maintenance and has
3517 * such key formats:
3518 * - dbname:key - a simple key (e.g. enwiki:meta)
3519 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3520 * - __global:key - global-scope key (e.g. __global:meta)
3521 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3523 * Sites mapping just specifies site name, other keys provide "local url"
3524 * data layout.
3526 $wgInterwikiCache = false;
3529 * Specify number of domains to check for messages.
3530 * - 1: Just wiki(db)-level
3531 * - 2: wiki and global levels
3532 * - 3: site levels
3534 $wgInterwikiScopes = 3;
3537 * Fallback site, if unable to resolve from cache
3539 $wgInterwikiFallbackSite = 'wiki';
3541 /** @} */ # end of Interwiki caching settings.
3544 * If local interwikis are set up which allow redirects,
3545 * set this regexp to restrict URLs which will be displayed
3546 * as 'redirected from' links.
3548 * @par Example:
3549 * It might look something like this:
3550 * @code
3551 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3552 * @endcode
3554 * Leave at false to avoid displaying any incoming redirect markers.
3555 * This does not affect intra-wiki redirects, which don't change
3556 * the URL.
3558 $wgRedirectSources = false;
3561 * Set this to false to avoid forcing the first letter of links to capitals.
3563 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3564 * appearing with a capital at the beginning of a sentence will *not* go to the
3565 * same place as links in the middle of a sentence using a lowercase initial.
3567 $wgCapitalLinks = true;
3570 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3571 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3572 * true by default (and setting them has no effect), due to various things that
3573 * require them to be so. Also, since Talk namespaces need to directly mirror their
3574 * associated content namespaces, the values for those are ignored in favor of the
3575 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3576 * NS_FILE.
3578 * @par Example:
3579 * @code
3580 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3581 * @endcode
3583 $wgCapitalLinkOverrides = array();
3586 * Which namespaces should support subpages?
3587 * See Language.php for a list of namespaces.
3589 $wgNamespacesWithSubpages = array(
3590 NS_TALK => true,
3591 NS_USER => true,
3592 NS_USER_TALK => true,
3593 NS_PROJECT => true,
3594 NS_PROJECT_TALK => true,
3595 NS_FILE_TALK => true,
3596 NS_MEDIAWIKI => true,
3597 NS_MEDIAWIKI_TALK => true,
3598 NS_TEMPLATE_TALK => true,
3599 NS_HELP => true,
3600 NS_HELP_TALK => true,
3601 NS_CATEGORY_TALK => true
3605 * Array holding default tracking category names.
3607 * Array contains the system messages for each tracking category.
3608 * Tracking categories allow pages with certain characteristics to be tracked.
3609 * It works by adding any such page to a category automatically.
3611 * A message with the suffix '-desc' should be added as a description message
3612 * to have extra information on Special:TrackingCategories.
3614 * @since 1.23
3616 $wgTrackingCategories = array(
3617 'index-category',
3618 'noindex-category',
3619 'expensive-parserfunction-category',
3620 'post-expand-template-argument-category',
3621 'post-expand-template-inclusion-category',
3622 'hidden-category-category',
3623 'broken-file-category',
3624 'node-count-exceeded-category',
3625 'expansion-depth-exceeded-category',
3629 * Array of namespaces which can be deemed to contain valid "content", as far
3630 * as the site statistics are concerned. Useful if additional namespaces also
3631 * contain "content" which should be considered when generating a count of the
3632 * number of articles in the wiki.
3634 $wgContentNamespaces = array( NS_MAIN );
3637 * Max number of redirects to follow when resolving redirects.
3638 * 1 means only the first redirect is followed (default behavior).
3639 * 0 or less means no redirects are followed.
3641 $wgMaxRedirects = 1;
3644 * Array of invalid page redirect targets.
3645 * Attempting to create a redirect to any of the pages in this array
3646 * will make the redirect fail.
3647 * Userlogout is hard-coded, so it does not need to be listed here.
3648 * (bug 10569) Disallow Mypage and Mytalk as well.
3650 * As of now, this only checks special pages. Redirects to pages in
3651 * other namespaces cannot be invalidated by this variable.
3653 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3655 /** @} */ # End of title and interwiki settings }
3657 /************************************************************************//**
3658 * @name Parser settings
3659 * These settings configure the transformation from wikitext to HTML.
3660 * @{
3664 * Parser configuration. Associative array with the following members:
3666 * class The class name
3668 * preprocessorClass The preprocessor class. Two classes are currently available:
3669 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3670 * storage, and Preprocessor_DOM, which uses the DOM module for
3671 * temporary storage. Preprocessor_DOM generally uses less memory;
3672 * the speed of the two is roughly the same.
3674 * If this parameter is not given, it uses Preprocessor_DOM if the
3675 * DOM module is available, otherwise it uses Preprocessor_Hash.
3677 * The entire associative array will be passed through to the constructor as
3678 * the first parameter. Note that only Setup.php can use this variable --
3679 * the configuration will change at runtime via $wgParser member functions, so
3680 * the contents of this variable will be out-of-date. The variable can only be
3681 * changed during LocalSettings.php, in particular, it can't be changed during
3682 * an extension setup function.
3684 $wgParserConf = array(
3685 'class' => 'Parser',
3686 #'preprocessorClass' => 'Preprocessor_Hash',
3690 * Maximum indent level of toc.
3692 $wgMaxTocLevel = 999;
3695 * A complexity limit on template expansion: the maximum number of nodes visited
3696 * by PPFrame::expand()
3698 $wgMaxPPNodeCount = 1000000;
3701 * A complexity limit on template expansion: the maximum number of elements
3702 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3703 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3704 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3705 * this default corresponds to about 155 MB.
3707 * When the limit is exceeded, an exception is thrown.
3709 $wgMaxGeneratedPPNodeCount = 1000000;
3712 * Maximum recursion depth for templates within templates.
3713 * The current parser adds two levels to the PHP call stack for each template,
3714 * and xdebug limits the call stack to 100 by default. So this should hopefully
3715 * stop the parser before it hits the xdebug limit.
3717 $wgMaxTemplateDepth = 40;
3720 * @see $wgMaxTemplateDepth
3722 $wgMaxPPExpandDepth = 40;
3725 * URL schemes that should be recognized as valid by wfParseUrl().
3726 * @see wfParseUrl
3728 $wgUrlProtocols = array(
3729 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3730 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3731 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3732 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3736 * If true, removes (substitutes) templates in "~~~~" signatures.
3738 $wgCleanSignatures = true;
3741 * Whether to allow inline image pointing to other websites
3743 $wgAllowExternalImages = false;
3746 * If the above is false, you can specify an exception here. Image URLs
3747 * that start with this string are then rendered, while all others are not.
3748 * You can use this to set up a trusted, simple repository of images.
3749 * You may also specify an array of strings to allow multiple sites
3751 * @par Examples:
3752 * @code
3753 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3754 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3755 * @endcode
3757 $wgAllowExternalImagesFrom = '';
3760 * If $wgAllowExternalImages is false, you can allow an on-wiki
3761 * whitelist of regular expression fragments to match the image URL
3762 * against. If the image matches one of the regular expression fragments,
3763 * The image will be displayed.
3765 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3766 * Or false to disable it
3768 $wgEnableImageWhitelist = true;
3771 * A different approach to the above: simply allow the "<img>" tag to be used.
3772 * This allows you to specify alt text and other attributes, copy-paste HTML to
3773 * your wiki more easily, etc. However, allowing external images in any manner
3774 * will allow anyone with editing rights to snoop on your visitors' IP
3775 * addresses and so forth, if they wanted to, by inserting links to images on
3776 * sites they control.
3778 $wgAllowImageTag = false;
3781 * $wgUseTidy: use tidy to make sure HTML output is sane.
3782 * Tidy is a free tool that fixes broken HTML.
3783 * See http://www.w3.org/People/Raggett/tidy/
3785 * - $wgTidyBin should be set to the path of the binary and
3786 * - $wgTidyConf to the path of the configuration file.
3787 * - $wgTidyOpts can include any number of parameters.
3788 * - $wgTidyInternal controls the use of the PECL extension or the
3789 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3790 * of spawning a separate program.
3791 * Normally you shouldn't need to override the setting except for
3792 * debugging. To install, use 'pear install tidy' and add a line
3793 * 'extension=tidy.so' to php.ini.
3795 $wgUseTidy = false;
3798 * @see $wgUseTidy
3800 $wgAlwaysUseTidy = false;
3803 * @see $wgUseTidy
3805 $wgTidyBin = 'tidy';
3808 * @see $wgUseTidy
3810 $wgTidyConf = $IP . '/includes/tidy.conf';
3813 * @see $wgUseTidy
3815 $wgTidyOpts = '';
3818 * @see $wgUseTidy
3820 $wgTidyInternal = extension_loaded( 'tidy' );
3823 * Put tidy warnings in HTML comments
3824 * Only works for internal tidy.
3826 $wgDebugTidy = false;
3829 * Allow raw, unchecked HTML in "<html>...</html>" sections.
3830 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3831 * TO RESTRICT EDITING to only those that you trust
3833 $wgRawHtml = false;
3836 * Set a default target for external links, e.g. _blank to pop up a new window
3838 $wgExternalLinkTarget = false;
3841 * If true, external URL links in wiki text will be given the
3842 * rel="nofollow" attribute as a hint to search engines that
3843 * they should not be followed for ranking purposes as they
3844 * are user-supplied and thus subject to spamming.
3846 $wgNoFollowLinks = true;
3849 * Namespaces in which $wgNoFollowLinks doesn't apply.
3850 * See Language.php for a list of namespaces.
3852 $wgNoFollowNsExceptions = array();
3855 * If this is set to an array of domains, external links to these domain names
3856 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3857 * value of $wgNoFollowLinks. For instance:
3859 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
3860 * 'mediawiki.org' );
3862 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3863 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3864 * etc.
3866 * Defaults to mediawiki.org for the links included in the software by default.
3868 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
3871 * Allow DISPLAYTITLE to change title display
3873 $wgAllowDisplayTitle = true;
3876 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
3877 * canonical DB key. Also disallow some inline CSS rules like display: none;
3878 * which can cause the text to be hidden or unselectable.
3880 $wgRestrictDisplayTitle = true;
3883 * Maximum number of calls per parse to expensive parser functions such as
3884 * PAGESINCATEGORY.
3886 $wgExpensiveParserFunctionLimit = 100;
3889 * Preprocessor caching threshold
3890 * Setting it to 'false' will disable the preprocessor cache.
3892 $wgPreprocessorCacheThreshold = 1000;
3895 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
3897 $wgEnableScaryTranscluding = false;
3900 * Expiry time for transcluded templates cached in transcache database table.
3901 * Only used $wgEnableInterwikiTranscluding is set to true.
3903 $wgTranscludeCacheExpiry = 3600;
3905 /** @} */ # end of parser settings }
3907 /************************************************************************//**
3908 * @name Statistics
3909 * @{
3913 * Method used to determine if a page in a content namespace should be counted
3914 * as a valid article.
3916 * Redirect pages will never be counted as valid articles.
3918 * This variable can have the following values:
3919 * - 'any': all pages as considered as valid articles
3920 * - 'comma': the page must contain a comma to be considered valid
3921 * - 'link': the page must contain a [[wiki link]] to be considered valid
3922 * - null: the value will be set at run time depending on $wgUseCommaCount:
3923 * if $wgUseCommaCount is false, it will be 'link', if it is true
3924 * it will be 'comma'
3926 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
3928 * Retroactively changing this variable will not affect the existing count,
3929 * to update it, you will need to run the maintenance/updateArticleCount.php
3930 * script.
3932 $wgArticleCountMethod = null;
3935 * Backward compatibility setting, will set $wgArticleCountMethod if it is null.
3936 * @deprecated since 1.18; use $wgArticleCountMethod instead
3938 $wgUseCommaCount = false;
3941 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
3942 * values are easier on the database. A value of 1 causes the counters to be
3943 * updated on every hit, any higher value n cause them to update *on average*
3944 * every n hits. Should be set to either 1 or something largish, eg 1000, for
3945 * maximum efficiency.
3947 $wgHitcounterUpdateFreq = 1;
3950 * How many days user must be idle before he is considered inactive. Will affect
3951 * the number shown on Special:Statistics, Special:ActiveUsers, and the
3952 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
3953 * You might want to leave this as the default value, to provide comparable
3954 * numbers between different wikis.
3956 $wgActiveUserDays = 30;
3958 /** @} */ # End of statistics }
3960 /************************************************************************//**
3961 * @name User accounts, authentication
3962 * @{
3966 * For compatibility with old installations set to false
3968 $wgPasswordSalt = true;
3971 * Specifies the minimal length of a user password. If set to 0, empty pass-
3972 * words are allowed.
3974 $wgMinimalPasswordLength = 1;
3977 * Specifies if users should be sent to a password-reset form on login, if their
3978 * password doesn't meet the requirements of User::isValidPassword().
3979 * @since 1.23
3981 $wgInvalidPasswordReset = true;
3984 * Whether to allow password resets ("enter some identifying data, and we'll send an email
3985 * with a temporary password you can use to get back into the account") identified by
3986 * various bits of data. Setting all of these to false (or the whole variable to false)
3987 * has the effect of disabling password resets entirely
3989 $wgPasswordResetRoutes = array(
3990 'username' => true,
3991 'email' => false,
3995 * Maximum number of Unicode characters in signature
3997 $wgMaxSigChars = 255;
4000 * Maximum number of bytes in username. You want to run the maintenance
4001 * script ./maintenance/checkUsernames.php once you have changed this value.
4003 $wgMaxNameChars = 255;
4006 * Array of usernames which may not be registered or logged in from
4007 * Maintenance scripts can still use these
4009 $wgReservedUsernames = array(
4010 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4011 'Conversion script', // Used for the old Wikipedia software upgrade
4012 'Maintenance script', // Maintenance scripts which perform editing, image import script
4013 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4014 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4015 'msg:double-redirect-fixer', // Automatic double redirect fix
4016 'msg:usermessage-editor', // Default user for leaving user messages
4017 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4021 * Settings added to this array will override the default globals for the user
4022 * preferences used by anonymous visitors and newly created accounts.
4023 * For instance, to disable editing on double clicks:
4024 * $wgDefaultUserOptions ['editondblclick'] = 0;
4026 $wgDefaultUserOptions = array(
4027 'ccmeonemails' => 0,
4028 'cols' => 80,
4029 'date' => 'default',
4030 'diffonly' => 0,
4031 'disablemail' => 0,
4032 'editfont' => 'default',
4033 'editondblclick' => 0,
4034 'editsectiononrightclick' => 0,
4035 'enotifminoredits' => 0,
4036 'enotifrevealaddr' => 0,
4037 'enotifusertalkpages' => 1,
4038 'enotifwatchlistpages' => 1,
4039 'extendwatchlist' => 0,
4040 'fancysig' => 0,
4041 'forceeditsummary' => 0,
4042 'gender' => 'unknown',
4043 'hideminor' => 0,
4044 'hidepatrolled' => 0,
4045 'imagesize' => 2,
4046 'math' => 1,
4047 'minordefault' => 0,
4048 'newpageshidepatrolled' => 0,
4049 'nickname' => '',
4050 'norollbackdiff' => 0,
4051 'numberheadings' => 0,
4052 'previewonfirst' => 0,
4053 'previewontop' => 1,
4054 'rcdays' => 7,
4055 'rclimit' => 50,
4056 'rows' => 25,
4057 'showhiddencats' => 0,
4058 'shownumberswatching' => 1,
4059 'showtoolbar' => 1,
4060 'skin' => false,
4061 'stubthreshold' => 0,
4062 'thumbsize' => 2,
4063 'underline' => 2,
4064 'uselivepreview' => 0,
4065 'usenewrc' => 0,
4066 'watchcreations' => 1,
4067 'watchdefault' => 1,
4068 'watchdeletion' => 0,
4069 'watchlistdays' => 3.0,
4070 'watchlisthideanons' => 0,
4071 'watchlisthidebots' => 0,
4072 'watchlisthideliu' => 0,
4073 'watchlisthideminor' => 0,
4074 'watchlisthideown' => 0,
4075 'watchlisthidepatrolled' => 0,
4076 'watchmoves' => 0,
4077 'wllimit' => 250,
4078 'useeditwarning' => 1,
4079 'prefershttps' => 1,
4083 * An array of preferences to not show for the user
4085 $wgHiddenPrefs = array();
4088 * Characters to prevent during new account creations.
4089 * This is used in a regular expression character class during
4090 * registration (regex metacharacters like / are escaped).
4092 $wgInvalidUsernameCharacters = '@';
4095 * Character used as a delimiter when testing for interwiki userrights
4096 * (In Special:UserRights, it is possible to modify users on different
4097 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4099 * It is recommended that you have this delimiter in
4100 * $wgInvalidUsernameCharacters above, or you will not be able to
4101 * modify the user rights of those users via Special:UserRights
4103 $wgUserrightsInterwikiDelimiter = '@';
4106 * This is to let user authenticate using https when they come from http.
4107 * Based on an idea by George Herbert on wikitech-l:
4108 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4109 * @since 1.17
4111 $wgSecureLogin = false;
4113 /** @} */ # end user accounts }
4115 /************************************************************************//**
4116 * @name User rights, access control and monitoring
4117 * @{
4121 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4123 $wgAutoblockExpiry = 86400;
4126 * Set this to true to allow blocked users to edit their own user talk page.
4128 $wgBlockAllowsUTEdit = false;
4131 * Allow sysops to ban users from accessing Emailuser
4133 $wgSysopEmailBans = true;
4136 * Limits on the possible sizes of range blocks.
4138 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4139 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4140 * half the number of bits avoids such errors, and allows entire ISPs to be
4141 * blocked using a small number of range blocks.
4143 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4144 * customer, so range blocks larger than /64 (half the number of bits) will
4145 * plainly be required. RFC 4692 implies that a very large ISP may be
4146 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4147 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4149 $wgBlockCIDRLimit = array(
4150 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4151 'IPv6' => 19,
4155 * If true, blocked users will not be allowed to login. When using this with
4156 * a public wiki, the effect of logging out blocked users may actually be
4157 * avers: unless the user's address is also blocked (e.g. auto-block),
4158 * logging the user out will again allow reading and editing, just as for
4159 * anonymous visitors.
4161 $wgBlockDisablesLogin = false;
4164 * Pages anonymous user may see, set as an array of pages titles.
4166 * @par Example:
4167 * @code
4168 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4169 * @endcode
4171 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4173 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4174 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4176 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4177 * will remain readable. You can use img_auth.php to protect uploaded files,
4178 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4180 $wgWhitelistRead = false;
4183 * Pages anonymous user may see, set as an array of regular expressions.
4185 * This function will match the regexp against the title name, which
4186 * is without underscore.
4188 * @par Example:
4189 * To whitelist [[Main Page]]:
4190 * @code
4191 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4192 * @endcode
4194 * @note Unless ^ and/or $ is specified, a regular expression might match
4195 * pages not intended to be whitelisted. The above example will also
4196 * whitelist a page named 'Security Main Page'.
4198 * @par Example:
4199 * To allow reading any page starting with 'User' regardless of the case:
4200 * @code
4201 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4202 * @endcode
4203 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4205 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4206 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4208 $wgWhitelistReadRegexp = false;
4211 * Should editors be required to have a validated e-mail
4212 * address before being allowed to edit?
4214 $wgEmailConfirmToEdit = false;
4217 * Permission keys given to users in each group.
4219 * This is an array where the keys are all groups and each value is an
4220 * array of the format (right => boolean).
4222 * The second format is used to support per-namespace permissions.
4223 * Note that this feature does not fully work for all permission types.
4225 * All users are implicitly in the '*' group including anonymous visitors;
4226 * logged-in users are all implicitly in the 'user' group. These will be
4227 * combined with the permissions of all groups that a given user is listed
4228 * in in the user_groups table.
4230 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4231 * doing! This will wipe all permissions, and may mean that your users are
4232 * unable to perform certain essential tasks or access new functionality
4233 * when new permissions are introduced and default grants established.
4235 * Functionality to make pages inaccessible has not been extensively tested
4236 * for security. Use at your own risk!
4238 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4240 $wgGroupPermissions = array();
4242 /** @cond file_level_code */
4243 // Implicit group for all visitors
4244 $wgGroupPermissions['*']['createaccount'] = true;
4245 $wgGroupPermissions['*']['read'] = true;
4246 $wgGroupPermissions['*']['edit'] = true;
4247 $wgGroupPermissions['*']['createpage'] = true;
4248 $wgGroupPermissions['*']['createtalk'] = true;
4249 $wgGroupPermissions['*']['writeapi'] = true;
4250 $wgGroupPermissions['*']['editmyusercss'] = true;
4251 $wgGroupPermissions['*']['editmyuserjs'] = true;
4252 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4253 $wgGroupPermissions['*']['editmywatchlist'] = true;
4254 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4255 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4256 $wgGroupPermissions['*']['editmyoptions'] = true;
4257 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4259 // Implicit group for all logged-in accounts
4260 $wgGroupPermissions['user']['move'] = true;
4261 $wgGroupPermissions['user']['move-subpages'] = true;
4262 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4263 $wgGroupPermissions['user']['move-categorypages'] = true;
4264 $wgGroupPermissions['user']['movefile'] = true;
4265 $wgGroupPermissions['user']['read'] = true;
4266 $wgGroupPermissions['user']['edit'] = true;
4267 $wgGroupPermissions['user']['createpage'] = true;
4268 $wgGroupPermissions['user']['createtalk'] = true;
4269 $wgGroupPermissions['user']['writeapi'] = true;
4270 $wgGroupPermissions['user']['upload'] = true;
4271 $wgGroupPermissions['user']['reupload'] = true;
4272 $wgGroupPermissions['user']['reupload-shared'] = true;
4273 $wgGroupPermissions['user']['minoredit'] = true;
4274 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4275 $wgGroupPermissions['user']['sendemail'] = true;
4277 // Implicit group for accounts that pass $wgAutoConfirmAge
4278 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4279 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4281 // Users with bot privilege can have their edits hidden
4282 // from various log pages by default
4283 $wgGroupPermissions['bot']['bot'] = true;
4284 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4285 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4286 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4287 $wgGroupPermissions['bot']['autopatrol'] = true;
4288 $wgGroupPermissions['bot']['suppressredirect'] = true;
4289 $wgGroupPermissions['bot']['apihighlimits'] = true;
4290 $wgGroupPermissions['bot']['writeapi'] = true;
4292 // Most extra permission abilities go to this group
4293 $wgGroupPermissions['sysop']['block'] = true;
4294 $wgGroupPermissions['sysop']['createaccount'] = true;
4295 $wgGroupPermissions['sysop']['delete'] = true;
4296 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4297 $wgGroupPermissions['sysop']['bigdelete'] = true;
4298 // can view deleted history entries, but not see or restore the text
4299 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4300 // can view deleted revision text
4301 $wgGroupPermissions['sysop']['deletedtext'] = true;
4302 $wgGroupPermissions['sysop']['undelete'] = true;
4303 $wgGroupPermissions['sysop']['editinterface'] = true;
4304 $wgGroupPermissions['sysop']['editusercss'] = true;
4305 $wgGroupPermissions['sysop']['edituserjs'] = true;
4306 $wgGroupPermissions['sysop']['import'] = true;
4307 $wgGroupPermissions['sysop']['importupload'] = true;
4308 $wgGroupPermissions['sysop']['move'] = true;
4309 $wgGroupPermissions['sysop']['move-subpages'] = true;
4310 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4311 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4312 $wgGroupPermissions['sysop']['patrol'] = true;
4313 $wgGroupPermissions['sysop']['autopatrol'] = true;
4314 $wgGroupPermissions['sysop']['protect'] = true;
4315 $wgGroupPermissions['sysop']['editprotected'] = true;
4316 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4317 $wgGroupPermissions['sysop']['rollback'] = true;
4318 $wgGroupPermissions['sysop']['upload'] = true;
4319 $wgGroupPermissions['sysop']['reupload'] = true;
4320 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4321 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4322 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4323 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4324 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4325 $wgGroupPermissions['sysop']['blockemail'] = true;
4326 $wgGroupPermissions['sysop']['markbotedits'] = true;
4327 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4328 $wgGroupPermissions['sysop']['browsearchive'] = true;
4329 $wgGroupPermissions['sysop']['noratelimit'] = true;
4330 $wgGroupPermissions['sysop']['movefile'] = true;
4331 $wgGroupPermissions['sysop']['unblockself'] = true;
4332 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4333 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4334 #$wgGroupPermissions['sysop']['mergehistory'] = true;
4336 // Permission to change users' group assignments
4337 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4338 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4339 // Permission to change users' groups assignments across wikis
4340 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4341 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4342 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4344 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4345 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4346 // To hide usernames from users and Sysops
4347 #$wgGroupPermissions['suppress']['hideuser'] = true;
4348 // To hide revisions/log items from users and Sysops
4349 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4350 // For private suppression log access
4351 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4354 * The developer group is deprecated, but can be activated if need be
4355 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4356 * that a lock file be defined and creatable/removable by the web
4357 * server.
4359 # $wgGroupPermissions['developer']['siteadmin'] = true;
4361 /** @endcond */
4364 * Permission keys revoked from users in each group.
4366 * This acts the same way as wgGroupPermissions above, except that
4367 * if the user is in a group here, the permission will be removed from them.
4369 * Improperly setting this could mean that your users will be unable to perform
4370 * certain essential tasks, so use at your own risk!
4372 $wgRevokePermissions = array();
4375 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4377 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4380 * A map of group names that the user is in, to group names that those users
4381 * are allowed to add or revoke.
4383 * Setting the list of groups to add or revoke to true is equivalent to "any
4384 * group".
4386 * @par Example:
4387 * To allow sysops to add themselves to the "bot" group:
4388 * @code
4389 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4390 * @endcode
4392 * @par Example:
4393 * Implicit groups may be used for the source group, for instance:
4394 * @code
4395 * $wgGroupsRemoveFromSelf = array( '*' => true );
4396 * @endcode
4397 * This allows users in the '*' group (i.e. any user) to remove themselves from
4398 * any group that they happen to be in.
4400 $wgGroupsAddToSelf = array();
4403 * @see $wgGroupsAddToSelf
4405 $wgGroupsRemoveFromSelf = array();
4408 * Set of available actions that can be restricted via action=protect
4409 * You probably shouldn't change this.
4410 * Translated through restriction-* messages.
4411 * Title::getRestrictionTypes() will remove restrictions that are not
4412 * applicable to a specific title (create and upload)
4414 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4417 * Rights which can be required for each protection level (via action=protect)
4419 * You can add a new protection level that requires a specific
4420 * permission by manipulating this array. The ordering of elements
4421 * dictates the order on the protection form's lists.
4423 * - '' will be ignored (i.e. unprotected)
4424 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4425 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4427 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4430 * Restriction levels that can be used with cascading protection
4432 * A page can only be protected with cascading protection if the
4433 * requested restriction level is included in this array.
4435 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4436 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4438 $wgCascadingRestrictionLevels = array( 'sysop' );
4441 * Restriction levels that should be considered "semiprotected"
4443 * Certain places in the interface recognize a dichotomy between "protected"
4444 * and "semiprotected", without further distinguishing the specific levels. In
4445 * general, if anyone can be eligible to edit a protection level merely by
4446 * reaching some condition in $wgAutopromote, it should probably be considered
4447 * "semiprotected".
4449 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4450 * 'sysop' is not changed, since it really shouldn't be here.
4452 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4455 * Set the minimum permissions required to edit pages in each
4456 * namespace. If you list more than one permission, a user must
4457 * have all of them to edit pages in that namespace.
4459 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4461 $wgNamespaceProtection = array();
4464 * Pages in namespaces in this array can not be used as templates.
4466 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4467 * namespaces constants (NS_USER, NS_MAIN...).
4469 * Among other things, this may be useful to enforce read-restrictions
4470 * which may otherwise be bypassed by using the template mechanism.
4472 $wgNonincludableNamespaces = array();
4475 * Number of seconds an account is required to age before it's given the
4476 * implicit 'autoconfirm' group membership. This can be used to limit
4477 * privileges of new accounts.
4479 * Accounts created by earlier versions of the software may not have a
4480 * recorded creation date, and will always be considered to pass the age test.
4482 * When left at 0, all registered accounts will pass.
4484 * @par Example:
4485 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4486 * @code
4487 * $wgAutoConfirmAge = 600; // ten minutes
4488 * @endcode
4489 * Set age to one day:
4490 * @code
4491 * $wgAutoConfirmAge = 3600*24; // one day
4492 * @endcode
4494 $wgAutoConfirmAge = 0;
4497 * Number of edits an account requires before it is autoconfirmed.
4498 * Passing both this AND the time requirement is needed. Example:
4500 * @par Example:
4501 * @code
4502 * $wgAutoConfirmCount = 50;
4503 * @endcode
4505 $wgAutoConfirmCount = 0;
4508 * Automatically add a usergroup to any user who matches certain conditions.
4510 * @todo Redocument $wgAutopromote
4512 * The format is
4513 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4514 * where cond1, cond2, ... are themselves conditions; *OR*
4515 * APCOND_EMAILCONFIRMED, *OR*
4516 * array( APCOND_EMAILCONFIRMED ), *OR*
4517 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4518 * array( APCOND_AGE, seconds since registration ), *OR*
4519 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4520 * array( APCOND_ISIP, ip ), *OR*
4521 * array( APCOND_IPINRANGE, range ), *OR*
4522 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4523 * array( APCOND_BLOCKED ), *OR*
4524 * array( APCOND_ISBOT ), *OR*
4525 * similar constructs defined by extensions.
4527 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4528 * user who has provided an e-mail address.
4530 $wgAutopromote = array(
4531 'autoconfirmed' => array( '&',
4532 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4533 array( APCOND_AGE, &$wgAutoConfirmAge ),
4538 * Automatically add a usergroup to any user who matches certain conditions.
4540 * Does not add the user to the group again if it has been removed.
4541 * Also, does not remove the group if the user no longer meets the criteria.
4543 * The format is:
4544 * @code
4545 * array( event => criteria, ... )
4546 * @endcode
4547 * Where event is either:
4548 * - 'onEdit' (when user edits)
4549 * - 'onView' (when user views the wiki)
4551 * Criteria has the same format as $wgAutopromote
4553 * @see $wgAutopromote
4554 * @since 1.18
4556 $wgAutopromoteOnce = array(
4557 'onEdit' => array(),
4558 'onView' => array()
4562 * Put user rights log entries for autopromotion in recent changes?
4563 * @since 1.18
4565 $wgAutopromoteOnceLogInRC = true;
4568 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4569 * can assign which groups at Special:Userrights.
4571 * @par Example:
4572 * Bureaucrats can add any group:
4573 * @code
4574 * $wgAddGroups['bureaucrat'] = true;
4575 * @endcode
4576 * Bureaucrats can only remove bots and sysops:
4577 * @code
4578 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4579 * @endcode
4580 * Sysops can make bots:
4581 * @code
4582 * $wgAddGroups['sysop'] = array( 'bot' );
4583 * @endcode
4584 * Sysops can disable other sysops in an emergency, and disable bots:
4585 * @code
4586 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4587 * @endcode
4589 $wgAddGroups = array();
4592 * @see $wgAddGroups
4594 $wgRemoveGroups = array();
4597 * A list of available rights, in addition to the ones defined by the core.
4598 * For extensions only.
4600 $wgAvailableRights = array();
4603 * Optional to restrict deletion of pages with higher revision counts
4604 * to users with the 'bigdelete' permission. (Default given to sysops.)
4606 $wgDeleteRevisionsLimit = 0;
4609 * The maximum number of edits a user can have and
4610 * can still be hidden by users with the hideuser permission.
4611 * This is limited for performance reason.
4612 * Set to false to disable the limit.
4613 * @since 1.23
4615 $wgHideUserContribLimit = 1000;
4618 * Number of accounts each IP address may create, 0 to disable.
4620 * @warning Requires memcached
4622 $wgAccountCreationThrottle = 0;
4625 * Edits matching these regular expressions in body text
4626 * will be recognised as spam and rejected automatically.
4628 * There's no administrator override on-wiki, so be careful what you set. :)
4629 * May be an array of regexes or a single string for backwards compatibility.
4631 * @see http://en.wikipedia.org/wiki/Regular_expression
4633 * @note Each regex needs a beginning/end delimiter, eg: # or /
4635 $wgSpamRegex = array();
4638 * Same as the above except for edit summaries
4640 $wgSummarySpamRegex = array();
4643 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4644 * proxies
4645 * @since 1.16
4647 $wgEnableDnsBlacklist = false;
4650 * @deprecated since 1.17 Use $wgEnableDnsBlacklist instead, only kept for
4651 * backward compatibility.
4653 $wgEnableSorbs = false;
4656 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4658 * This is an array of either a URL or an array with the URL and a key (should
4659 * the blacklist require a key).
4661 * @par Example:
4662 * @code
4663 * $wgDnsBlacklistUrls = array(
4664 * // String containing URL
4665 * 'http.dnsbl.sorbs.net.',
4666 * // Array with URL and key, for services that require a key
4667 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4668 * // Array with just the URL. While this works, it is recommended that you
4669 * // just use a string as shown above
4670 * array( 'opm.tornevall.org.' )
4671 * );
4672 * @endcode
4674 * @note You should end the domain name with a . to avoid searching your
4675 * eventual domain search suffixes.
4676 * @since 1.16
4678 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4681 * @deprecated since 1.17 Use $wgDnsBlacklistUrls instead, only kept for
4682 * backward compatibility.
4684 $wgSorbsUrl = array();
4687 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4688 * what the other methods might say.
4690 $wgProxyWhitelist = array();
4693 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4694 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4695 * (transparent) proxies without needing to block the proxies themselves.
4697 $wgApplyIpBlocksToXff = false;
4700 * Simple rate limiter options to brake edit floods.
4702 * Maximum number actions allowed in the given number of seconds; after that
4703 * the violating client receives HTTP 500 error pages until the period
4704 * elapses.
4706 * @par Example:
4707 * To set a generic maximum of 4 hits in 60 seconds:
4708 * @code
4709 * $wgRateLimits = array( 4, 60 );
4710 * @endcode
4712 * You could also limit per action and then type of users. See the inline
4713 * code for a template to use.
4715 * This option set is experimental and likely to change.
4717 * @warning Requires memcached.
4719 $wgRateLimits = array(
4720 'edit' => array(
4721 'anon' => null, // for any and all anonymous edits (aggregate)
4722 'user' => null, // for each logged-in user
4723 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4724 'ip' => null, // for each anon and recent account
4725 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4727 'move' => array(
4728 'user' => null,
4729 'newbie' => null,
4730 'ip' => null,
4731 'subnet' => null,
4733 'mailpassword' => array( // triggering password resets emails
4734 'anon' => null,
4736 'emailuser' => array( // emailing other users using MediaWiki
4737 'user' => null,
4739 'linkpurge' => array( // purges of link tables
4740 'anon' => null,
4741 'user' => null,
4742 'newbie' => null,
4743 'ip' => null,
4744 'subnet' => null,
4746 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4747 'anon' => null,
4748 'user' => null,
4749 'newbie' => null,
4750 'ip' => null,
4751 'subnet' => null,
4753 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
4754 'anon' => null,
4755 'user' => null,
4756 'newbie' => null,
4757 'ip' => null,
4758 'subnet' => null,
4763 * Set to a filename to log rate limiter hits.
4765 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
4767 $wgRateLimitLog = null;
4770 * Array of IPs which should be excluded from rate limits.
4771 * This may be useful for whitelisting NAT gateways for conferences, etc.
4773 $wgRateLimitsExcludedIPs = array();
4776 * Log IP addresses in the recentchanges table; can be accessed only by
4777 * extensions (e.g. CheckUser) or a DB admin
4778 * Used for retroactive autoblocks
4780 $wgPutIPinRC = true;
4783 * Integer defining default number of entries to show on
4784 * special pages which are query-pages such as Special:Whatlinkshere.
4786 $wgQueryPageDefaultLimit = 50;
4789 * Limit password attempts to X attempts per Y seconds per IP per account.
4791 * @warning Requires memcached.
4793 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4795 /** @} */ # end of user rights settings
4797 /************************************************************************//**
4798 * @name Proxy scanner settings
4799 * @{
4803 * This should always be customised in LocalSettings.php
4805 $wgSecretKey = false;
4808 * Big list of banned IP addresses.
4810 * This can have the following formats:
4811 * - An array of addresses, either in the values
4812 * or the keys (for backward compatibility)
4813 * - A string, in that case this is the path to a file
4814 * containing the list of IP addresses, one per line
4816 $wgProxyList = array();
4819 * @deprecated since 1.14
4821 $wgProxyKey = false;
4823 /** @} */ # end of proxy scanner settings
4825 /************************************************************************//**
4826 * @name Cookie settings
4827 * @{
4831 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
4833 $wgCookieExpiration = 180 * 86400;
4836 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
4837 * or ".any.subdomain.net"
4839 $wgCookieDomain = '';
4842 * Set this variable if you want to restrict cookies to a certain path within
4843 * the domain specified by $wgCookieDomain.
4845 $wgCookiePath = '/';
4848 * Whether the "secure" flag should be set on the cookie. This can be:
4849 * - true: Set secure flag
4850 * - false: Don't set secure flag
4851 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
4853 $wgCookieSecure = 'detect';
4856 * By default, MediaWiki checks if the client supports cookies during the
4857 * login process, so that it can display an informative error message if
4858 * cookies are disabled. Set this to true if you want to disable this cookie
4859 * check.
4861 $wgDisableCookieCheck = false;
4864 * Cookies generated by MediaWiki have names starting with this prefix. Set it
4865 * to a string to use a custom prefix. Setting it to false causes the database
4866 * name to be used as a prefix.
4868 $wgCookiePrefix = false;
4871 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
4872 * in browsers that support this feature. This can mitigates some classes of
4873 * XSS attack.
4875 $wgCookieHttpOnly = true;
4878 * A list of cookies that vary the cache (for use by extensions)
4880 $wgCacheVaryCookies = array();
4883 * Override to customise the session name
4885 $wgSessionName = false;
4887 /** @} */ # end of cookie settings }
4889 /************************************************************************//**
4890 * @name LaTeX (mathematical formulas)
4891 * @{
4895 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
4896 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
4897 * (ImageMagick) installed and available in the PATH.
4898 * Please see math/README for more information.
4900 $wgUseTeX = false;
4902 /** @} */ # end LaTeX }
4904 /************************************************************************//**
4905 * @name Profiling, testing and debugging
4907 * To enable profiling, edit StartProfiler.php
4909 * @{
4913 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
4914 * The debug log file should be not be publicly accessible if it is used, as it
4915 * may contain private data.
4917 $wgDebugLogFile = '';
4920 * Prefix for debug log lines
4922 $wgDebugLogPrefix = '';
4925 * If true, instead of redirecting, show a page with a link to the redirect
4926 * destination. This allows for the inspection of PHP error messages, and easy
4927 * resubmission of form data. For developer use only.
4929 $wgDebugRedirects = false;
4932 * If true, log debugging data from action=raw and load.php.
4933 * This is normally false to avoid overlapping debug entries due to gen=css
4934 * and gen=js requests.
4936 $wgDebugRawPage = false;
4939 * Send debug data to an HTML comment in the output.
4941 * This may occasionally be useful when supporting a non-technical end-user.
4942 * It's more secure than exposing the debug log file to the web, since the
4943 * output only contains private data for the current user. But it's not ideal
4944 * for development use since data is lost on fatal errors and redirects.
4946 $wgDebugComments = false;
4949 * Extensive database transaction state debugging
4951 * @since 1.20
4953 $wgDebugDBTransactions = false;
4956 * Write SQL queries to the debug log
4958 $wgDebugDumpSql = false;
4961 * Map of string log group names to log destinations.
4963 * If set, wfDebugLog() output for that group will go to that file instead
4964 * of the regular $wgDebugLogFile. Useful for enabling selective logging
4965 * in production.
4967 * Log destinations may be one of the following:
4968 * - false to completely remove from the output, including from $wgDebugLogFile.
4969 * - string values specifying a filename or URI.
4970 * - associative array mapping 'destination' key to the desired filename or URI.
4971 * The associative array may also contain a 'sample' key with an integer value,
4972 * specifying a sampling factor.
4974 * @par Example:
4975 * @code
4976 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
4977 * @endcode
4979 * @par Advanced example:
4980 * @code
4981 * $wgDebugLogGroups['memcached'] = (
4982 * 'destination' => '/var/log/mediawiki/memcached.log',
4983 * 'sample' => 1000, // log 1 message out of every 1,000.
4984 * );
4985 * @endcode
4987 $wgDebugLogGroups = array();
4990 * Display debug data at the bottom of the main content area.
4992 * Useful for developers and technical users trying to working on a closed wiki.
4994 $wgShowDebug = false;
4997 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
4998 * Since 1.19 also includes memory usage.
5000 $wgDebugTimestamps = false;
5003 * Print HTTP headers for every request in the debug information.
5005 $wgDebugPrintHttpHeaders = true;
5008 * Show the contents of $wgHooks in Special:Version
5010 $wgSpecialVersionShowHooks = false;
5013 * Whether to show "we're sorry, but there has been a database error" pages.
5014 * Displaying errors aids in debugging, but may display information useful
5015 * to an attacker.
5017 $wgShowSQLErrors = false;
5020 * If set to true, uncaught exceptions will print a complete stack trace
5021 * to output. This should only be used for debugging, as it may reveal
5022 * private information in function parameters due to PHP's backtrace
5023 * formatting.
5025 $wgShowExceptionDetails = false;
5028 * If true, show a backtrace for database errors
5030 * @note This setting only applies when connection errors and query errors are
5031 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5032 * including those in which an uncaught exception is thrown from within the
5033 * exception handler.
5035 $wgShowDBErrorBacktrace = false;
5038 * If true, send the exception backtrace to the error log
5040 $wgLogExceptionBacktrace = true;
5043 * Expose backend server host names through the API and various HTML comments
5045 $wgShowHostnames = false;
5048 * Override server hostname detection with a hardcoded value.
5049 * Should be a string, default false.
5050 * @since 1.20
5052 $wgOverrideHostname = false;
5055 * If set to true MediaWiki will throw notices for some possible error
5056 * conditions and for deprecated functions.
5058 $wgDevelopmentWarnings = false;
5061 * Release limitation to wfDeprecated warnings, if set to a release number
5062 * development warnings will not be generated for deprecations added in releases
5063 * after the limit.
5065 $wgDeprecationReleaseLimit = false;
5068 * Only record profiling info for pages that took longer than this
5070 $wgProfileLimit = 0.0;
5073 * Don't put non-profiling info into log file
5075 * @deprecated since 1.23, set the log file in
5076 * $wgDebugLogGroups['profileoutput'] instead.
5078 $wgProfileOnly = false;
5081 * If true, print a raw call tree instead of per-function report
5083 $wgProfileCallTree = false;
5086 * Should application server host be put into profiling table
5088 $wgProfilePerHost = false;
5091 * Host for UDP profiler.
5093 * The host should be running a daemon which can be obtained from MediaWiki
5094 * Git at:
5095 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5097 $wgUDPProfilerHost = '127.0.0.1';
5100 * Port for UDP profiler.
5101 * @see $wgUDPProfilerHost
5103 $wgUDPProfilerPort = '3811';
5106 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5107 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name) as arguments.
5108 * You can use sprintf's argument numbering/swapping capability to repeat,
5109 * re-order or omit fields.
5111 * @see $wgStatsFormatString
5112 * @since 1.22
5114 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5117 * Output debug message on every wfProfileIn/wfProfileOut
5119 $wgDebugFunctionEntry = false;
5122 * Destination for wfIncrStats() data...
5123 * 'cache' to go into the system cache, if enabled (memcached)
5124 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5125 * false to disable
5127 $wgStatsMethod = 'cache';
5130 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5131 * be aggregated over more than one wiki. The string will be used in place of
5132 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5133 * will be used.
5135 $wgAggregateStatsID = false;
5138 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5139 * formatted. Its value should be a format string suitable for a sprintf()
5140 * invocation with (id, count, key) arguments, where 'id' is either
5141 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5142 * is being incremented, and 'key' is the metric name.
5144 * @see $wgUDPProfilerFormatString
5145 * @see $wgAggregateStatsID
5146 * @since 1.22
5148 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5151 * Whereas to count the number of time an article is viewed.
5152 * Does not work if pages are cached (for example with squid).
5154 $wgDisableCounters = false;
5157 * InfoAction retrieves a list of transclusion links (both to and from).
5158 * This number puts a limit on that query in the case of highly transcluded
5159 * templates.
5161 $wgPageInfoTransclusionLimit = 50;
5164 * Set this to an integer to only do synchronous site_stats updates
5165 * one every *this many* updates. The other requests go into pending
5166 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5167 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5169 $wgSiteStatsAsyncFactor = false;
5172 * Parser test suite files to be run by parserTests.php when no specific
5173 * filename is passed to it.
5175 * Extensions may add their own tests to this array, or site-local tests
5176 * may be added via LocalSettings.php
5178 * Use full paths.
5180 $wgParserTestFiles = array(
5181 "$IP/tests/parser/parserTests.txt",
5182 "$IP/tests/parser/extraParserTests.txt"
5186 * If configured, specifies target CodeReview installation to send test
5187 * result data from 'parserTests.php --upload'
5189 * Something like this:
5190 * $wgParserTestRemote = array(
5191 * 'api-url' => 'https://www.mediawiki.org/w/api.php',
5192 * 'repo' => 'MediaWiki',
5193 * 'suite' => 'ParserTests',
5194 * 'path' => '/trunk/phase3', // not used client-side; for reference
5195 * 'secret' => 'qmoicj3mc4mcklmqw', // Shared secret used in HMAC validation
5196 * );
5198 $wgParserTestRemote = false;
5201 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5203 $wgEnableJavaScriptTest = false;
5206 * Configuration for javascript testing.
5208 $wgJavaScriptTestConfig = array(
5209 'qunit' => array(
5210 // Page where documentation can be found relevant to the QUnit test suite being ran.
5211 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5212 // documentation link in the "javascripttest-qunit-intro" message.
5213 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5214 // If you are submitting the QUnit test suite to a TestSwarm instance,
5215 // point this to the "inject.js" script of that instance. This is was registers
5216 // the QUnit hooks to extract the test results and push them back up into the
5217 // TestSwarm database.
5218 // @example 'http://localhost/testswarm/js/inject.js'
5219 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5220 'testswarm-injectjs' => false,
5225 * Overwrite the caching key prefix with custom value.
5226 * @since 1.19
5228 $wgCachePrefix = false;
5231 * Display the new debugging toolbar. This also enables profiling on database
5232 * queries and other useful output.
5233 * Will disable file cache.
5235 * @since 1.19
5237 $wgDebugToolbar = false;
5239 /** @} */ # end of profiling, testing and debugging }
5241 /************************************************************************//**
5242 * @name Search
5243 * @{
5247 * Set this to true to disable the full text search feature.
5249 $wgDisableTextSearch = false;
5252 * Set to true to have nicer highlighted text in search results,
5253 * by default off due to execution overhead
5255 $wgAdvancedSearchHighlighting = false;
5258 * Regexp to match word boundaries, defaults for non-CJK languages
5259 * should be empty for CJK since the words are not separate
5261 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5264 * Set to true to have the search engine count total
5265 * search matches to present in the Special:Search UI.
5266 * Not supported by every search engine shipped with MW.
5268 * This could however be slow on larger wikis, and is pretty flaky
5269 * with the current title vs content split. Recommend avoiding until
5270 * that's been worked out cleanly; but this may aid in testing the
5271 * search UI and API to confirm that the result count works.
5273 $wgCountTotalSearchHits = false;
5276 * Template for OpenSearch suggestions, defaults to API action=opensearch
5278 * Sites with heavy load would typically have these point to a custom
5279 * PHP wrapper to avoid firing up mediawiki for every keystroke
5281 * Placeholders: {searchTerms}
5283 $wgOpenSearchTemplate = false;
5286 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5287 * false if you've disabled scripts that use api?action=opensearch and
5288 * want reduce load caused by cached scripts still pulling suggestions.
5289 * It will let the API fallback by responding with an empty array.
5291 $wgEnableOpenSearchSuggest = true;
5294 * Integer defining default number of entries to show on
5295 * OpenSearch call.
5297 $wgOpenSearchDefaultLimit = 10;
5300 * Expiry time for search suggestion responses
5302 $wgSearchSuggestCacheExpiry = 1200;
5305 * If you've disabled search semi-permanently, this also disables updates to the
5306 * table. If you ever re-enable, be sure to rebuild the search table.
5308 $wgDisableSearchUpdate = false;
5311 * List of namespaces which are searched by default.
5313 * @par Example:
5314 * @code
5315 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5316 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5317 * @endcode
5319 $wgNamespacesToBeSearchedDefault = array(
5320 NS_MAIN => true,
5324 * Namespaces to be searched when user clicks the "Help" tab
5325 * on Special:Search.
5327 * Same format as $wgNamespacesToBeSearchedDefault.
5329 $wgNamespacesToBeSearchedHelp = array(
5330 NS_PROJECT => true,
5331 NS_HELP => true,
5335 * If set to true the 'searcheverything' preference will be effective only for
5336 * logged-in users.
5337 * Useful for big wikis to maintain different search profiles for anonymous and
5338 * logged-in users.
5340 $wgSearchEverythingOnlyLoggedIn = false;
5343 * Disable the internal MySQL-based search, to allow it to be
5344 * implemented by an extension instead.
5346 $wgDisableInternalSearch = false;
5349 * Set this to a URL to forward search requests to some external location.
5350 * If the URL includes '$1', this will be replaced with the URL-encoded
5351 * search term.
5353 * @par Example:
5354 * To forward to Google you'd have something like:
5355 * @code
5356 * $wgSearchForwardUrl =
5357 * 'http://www.google.com/search?q=$1' .
5358 * '&domains=http://example.com' .
5359 * '&sitesearch=http://example.com' .
5360 * '&ie=utf-8&oe=utf-8';
5361 * @endcode
5363 $wgSearchForwardUrl = null;
5366 * Search form behavior.
5367 * - true = use Go & Search buttons
5368 * - false = use Go button & Advanced search link
5370 $wgUseTwoButtonsSearchForm = true;
5373 * Array of namespaces to generate a Google sitemap for when the
5374 * maintenance/generateSitemap.php script is run, or false if one is to be
5375 * generated for all namespaces.
5377 $wgSitemapNamespaces = false;
5380 * Custom namespace priorities for sitemaps. Setting this will allow you to
5381 * set custom priorities to namespaces when sitemaps are generated using the
5382 * maintenance/generateSitemap.php script.
5384 * This should be a map of namespace IDs to priority
5385 * @par Example:
5386 * @code
5387 * $wgSitemapNamespacesPriorities = array(
5388 * NS_USER => '0.9',
5389 * NS_HELP => '0.0',
5390 * );
5391 * @endcode
5393 $wgSitemapNamespacesPriorities = false;
5396 * If true, searches for IP addresses will be redirected to that IP's
5397 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5398 * [[Special:Contributions/1.2.3.4]]
5400 $wgEnableSearchContributorsByIP = true;
5402 /** @} */ # end of search settings
5404 /************************************************************************//**
5405 * @name Edit user interface
5406 * @{
5410 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5411 * fall back to the old behavior (no merging).
5413 $wgDiff3 = '/usr/bin/diff3';
5416 * Path to the GNU diff utility.
5418 $wgDiff = '/usr/bin/diff';
5421 * Which namespaces have special treatment where they should be preview-on-open
5422 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5423 * can specify namespaces of pages they have special treatment for
5425 $wgPreviewOnOpenNamespaces = array(
5426 NS_CATEGORY => true
5430 * Go button goes straight to the edit screen if the article doesn't exist.
5432 $wgGoToEdit = false;
5435 * Enable the UniversalEditButton for browsers that support it
5436 * (currently only Firefox with an extension)
5437 * See http://universaleditbutton.org for more background information
5439 $wgUniversalEditButton = true;
5442 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5443 * will try to automatically create one. This feature can be disabled by set-
5444 * ting this variable false.
5446 $wgUseAutomaticEditSummaries = true;
5448 /** @} */ # end edit UI }
5450 /************************************************************************//**
5451 * @name Maintenance
5452 * See also $wgSiteNotice
5453 * @{
5457 * @cond file_level_code
5458 * Set $wgCommandLineMode if it's not set already, to avoid notices
5460 if ( !isset( $wgCommandLineMode ) ) {
5461 $wgCommandLineMode = false;
5463 /** @endcond */
5466 * For colorized maintenance script output, is your terminal background dark ?
5468 $wgCommandLineDarkBg = false;
5471 * Set this to a string to put the wiki into read-only mode. The text will be
5472 * used as an explanation to users.
5474 * This prevents most write operations via the web interface. Cache updates may
5475 * still be possible. To prevent database writes completely, use the read_only
5476 * option in MySQL.
5478 $wgReadOnly = null;
5481 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5482 * Its contents will be shown to users as part of the read-only warning
5483 * message.
5485 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5487 $wgReadOnlyFile = false;
5490 * When you run the web-based upgrade utility, it will tell you what to set
5491 * this to in order to authorize the upgrade process. It will subsequently be
5492 * used as a password, to authorize further upgrades.
5494 * For security, do not set this to a guessable string. Use the value supplied
5495 * by the install/upgrade process. To cause the upgrader to generate a new key,
5496 * delete the old key from LocalSettings.php.
5498 $wgUpgradeKey = false;
5501 * Fully specified path to git binary
5503 $wgGitBin = '/usr/bin/git';
5506 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5508 * Key is a pattern passed to preg_match() and preg_replace(),
5509 * without the delimiters (which are #) and must match the whole URL.
5510 * The value is the replacement for the key (it can contain $1, etc.)
5511 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5512 * full SHA-1 of the HEAD revision.
5513 * %r will be replaced with a URL-encoded version of $1.
5515 * @since 1.20
5517 $wgGitRepositoryViewers = array(
5518 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5519 'https://git.wikimedia.org/commit/%r/%H',
5520 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5521 'https://git.wikimedia.org/commit/%r/%H',
5524 /** @} */ # End of maintenance }
5526 /************************************************************************//**
5527 * @name Recent changes, new pages, watchlist and history
5528 * @{
5532 * Recentchanges items are periodically purged; entries older than this many
5533 * seconds will go.
5534 * Default: 13 weeks = about three months
5536 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5539 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5540 * higher than what will be stored. Note that this is disabled by default
5541 * because we sometimes do have RC data which is beyond the limit for some
5542 * reason, and some users may use the high numbers to display that data which
5543 * is still there.
5545 $wgRCFilterByAge = false;
5548 * List of Limits options to list in the Special:Recentchanges and
5549 * Special:Recentchangeslinked pages.
5551 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5554 * List of Days options to list in the Special:Recentchanges and
5555 * Special:Recentchangeslinked pages.
5557 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5560 * Send recent changes updates via UDP. The updates will be formatted for IRC.
5561 * Set this to the IP address of the receiver.
5563 * @deprecated since 1.22, use $wgRCFeeds
5565 $wgRC2UDPAddress = false;
5568 * Port number for RC updates
5570 * @deprecated since 1.22, use $wgRCFeeds
5572 $wgRC2UDPPort = false;
5575 * Prefix to prepend to each UDP packet.
5576 * This can be used to identify the wiki. A script is available called
5577 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
5578 * tab to identify the IRC channel to send the log line to.
5580 * @deprecated since 1.22, use $wgRCFeeds
5582 $wgRC2UDPPrefix = '';
5585 * If this is set to true, the first entry in the $wgLocalInterwikis array (or
5586 * the value of $wgLocalInterwiki, if set) will be prepended to links in the IRC
5587 * feed. If this is set to a string, that string will be used as the prefix.
5589 * @deprecated since 1.22, use $wgRCFeeds
5591 $wgRC2UDPInterwikiPrefix = false;
5594 * Set to true to omit "bot" edits (by users with the bot permission) from the
5595 * UDP feed.
5597 * @deprecated since 1.22, use $wgRCFeeds
5599 $wgRC2UDPOmitBots = false;
5602 * Destinations to which notifications about recent changes
5603 * should be sent.
5605 * As of MediaWiki 1.22, the only supported 'engine' parameter option in core
5606 * is 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5607 * specified server.
5608 * The common options are:
5609 * * 'uri' -- the address to which the notices are to be sent.
5610 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5611 * produce the text to send.
5612 * * 'omit_bots' -- whether the bot edits should be in the feed
5613 * * 'omit_anon' -- whether anonymous edits should be in the feed
5614 * * 'omit_user' -- whether edits by registered users should be in the feed
5615 * * 'omit_minor' -- whether minor edits should be in the feed
5616 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5617 * The IRC-specific options are:
5618 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5619 * the first entry in the $wgLocalInterwikis array (or the value of
5620 * $wgLocalInterwiki, if set)
5621 * The JSON-specific options are:
5622 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5624 * To ensure backwards-compatibility, whenever $wgRC2UDPAddress is set, a
5625 * 'default' feed will be created reusing the deprecated $wgRC2UDP* variables.
5627 * @example $wgRCFeeds['example'] = array(
5628 * 'formatter' => 'JSONRCFeedFormatter',
5629 * 'uri' => "udp://localhost:1336",
5630 * 'add_interwiki_prefix' => false,
5631 * 'omit_bots' => true,
5632 * );
5633 * @example $wgRCFeeds['exampleirc'] = array(
5634 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5635 * 'uri' => "udp://localhost:1338",
5636 * 'add_interwiki_prefix' => false,
5637 * 'omit_bots' => true,
5638 * );
5639 * @since 1.22
5641 $wgRCFeeds = array();
5644 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5645 * Keys are scheme names, values are names of engine classes.
5647 $wgRCEngines = array(
5648 'redis' => 'RedisPubSubFeedEngine',
5649 'udp' => 'UDPRCFeedEngine',
5653 * Enable user search in Special:Newpages
5654 * This is really a temporary hack around an index install bug on some Wikipedias.
5655 * Kill it once fixed.
5657 $wgEnableNewpagesUserFilter = true;
5660 * Use RC Patrolling to check for vandalism
5662 $wgUseRCPatrol = true;
5665 * Use new page patrolling to check new pages on Special:Newpages
5667 $wgUseNPPatrol = true;
5670 * Log autopatrol actions to the log table
5672 $wgLogAutopatrol = true;
5675 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5677 $wgFeed = true;
5680 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5681 * eg Recentchanges, Newpages.
5683 $wgFeedLimit = 50;
5686 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5687 * A cached version will continue to be served out even if changes
5688 * are made, until this many seconds runs out since the last render.
5690 * If set to 0, feed caching is disabled. Use this for debugging only;
5691 * feed generation can be pretty slow with diffs.
5693 $wgFeedCacheTimeout = 60;
5696 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5697 * pages larger than this size.
5699 $wgFeedDiffCutoff = 32768;
5702 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5703 * every page. Some sites might have a different feed they'd like to promote
5704 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5705 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5706 * as value.
5707 * @par Example:
5708 * Configure the 'atom' feed to http://example.com/somefeed.xml
5709 * @code
5710 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5711 * @endcode
5713 $wgOverrideSiteFeed = array();
5716 * Available feeds objects.
5717 * Should probably only be defined when a page is syndicated ie when
5718 * $wgOut->isSyndicated() is true.
5720 $wgFeedClasses = array(
5721 'rss' => 'RSSFeed',
5722 'atom' => 'AtomFeed',
5726 * Which feed types should we provide by default? This can include 'rss',
5727 * 'atom', neither, or both.
5729 $wgAdvertisedFeedTypes = array( 'atom' );
5732 * Show watching users in recent changes, watchlist and page history views
5734 $wgRCShowWatchingUsers = false; # UPO
5737 * Show watching users in Page views
5739 $wgPageShowWatchingUsers = false;
5742 * Show the amount of changed characters in recent changes
5744 $wgRCShowChangedSize = true;
5747 * If the difference between the character counts of the text
5748 * before and after the edit is below that value, the value will be
5749 * highlighted on the RC page.
5751 $wgRCChangedSizeThreshold = 500;
5754 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5755 * view for watched pages with new changes
5757 $wgShowUpdatedMarker = true;
5760 * Disable links to talk pages of anonymous users (IPs) in listings on special
5761 * pages like page history, Special:Recentchanges, etc.
5763 $wgDisableAnonTalk = false;
5766 * Enable filtering of categories in Recentchanges
5768 $wgAllowCategorizedRecentChanges = false;
5771 * Allow filtering by change tag in recentchanges, history, etc
5772 * Has no effect if no tags are defined in valid_tag.
5774 $wgUseTagFilter = true;
5777 * If set to an integer, pages that are watched by this many users or more
5778 * will not require the unwatchedpages permission to view the number of
5779 * watchers.
5781 * @since 1.21
5783 $wgUnwatchedPageThreshold = false;
5786 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5787 * certain types of edits.
5789 * To register a new one:
5790 * @code
5791 * $wgRecentChangesFlags['flag'] => array(
5792 * 'letter' => 'letter-msg',
5793 * 'title' => 'tooltip-msg'
5794 * );
5795 * @endcode
5797 * Optional 'class' allows to set a css class different than the flag name.
5799 * @since 1.22
5801 $wgRecentChangesFlags = array(
5802 'newpage' => array( 'letter' => 'newpageletter',
5803 'title' => 'recentchanges-label-newpage' ),
5804 'minor' => array( 'letter' => 'minoreditletter',
5805 'title' => 'recentchanges-label-minor', 'class' => 'minoredit' ),
5806 'bot' => array( 'letter' => 'boteditletter',
5807 'title' => 'recentchanges-label-bot', 'class' => 'botedit' ),
5808 'unpatrolled' => array( 'letter' => 'unpatrolledletter',
5809 'title' => 'recentchanges-label-unpatrolled' ),
5812 /** @} */ # end RC/watchlist }
5814 /************************************************************************//**
5815 * @name Copyright and credits settings
5816 * @{
5820 * Override for copyright metadata.
5822 * This is the name of the page containing information about the wiki's copyright status,
5823 * which will be added as a link in the footer if it is specified. It overrides
5824 * $wgRightsUrl if both are specified.
5826 $wgRightsPage = null;
5829 * Set this to specify an external URL containing details about the content license used on your
5830 * wiki.
5831 * If $wgRightsPage is set then this setting is ignored.
5833 $wgRightsUrl = null;
5836 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5837 * link.
5838 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5839 * of the page will also be used as the link if this variable is not set.
5841 $wgRightsText = null;
5844 * Override for copyright metadata.
5846 $wgRightsIcon = null;
5849 * Set this to some HTML to override the rights icon with an arbitrary logo
5850 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5852 $wgCopyrightIcon = null;
5855 * Set this to true if you want detailed copyright information forms on Upload.
5857 $wgUseCopyrightUpload = false;
5860 * Set this to the number of authors that you want to be credited below an
5861 * article text. Set it to zero to hide the attribution block, and a negative
5862 * number (like -1) to show all authors. Note that this will require 2-3 extra
5863 * database hits, which can have a not insignificant impact on performance for
5864 * large wikis.
5866 $wgMaxCredits = 0;
5869 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5870 * Otherwise, link to a separate credits page.
5872 $wgShowCreditsIfMax = true;
5874 /** @} */ # end of copyright and credits settings }
5876 /************************************************************************//**
5877 * @name Import / Export
5878 * @{
5882 * List of interwiki prefixes for wikis we'll accept as sources for
5883 * Special:Import (for sysops). Since complete page history can be imported,
5884 * these should be 'trusted'.
5886 * If a user has the 'import' permission but not the 'importupload' permission,
5887 * they will only be able to run imports through this transwiki interface.
5889 $wgImportSources = array();
5892 * Optional default target namespace for interwiki imports.
5893 * Can use this to create an incoming "transwiki"-style queue.
5894 * Set to numeric key, not the name.
5896 * Users may override this in the Special:Import dialog.
5898 $wgImportTargetNamespace = null;
5901 * If set to false, disables the full-history option on Special:Export.
5902 * This is currently poorly optimized for long edit histories, so is
5903 * disabled on Wikimedia's sites.
5905 $wgExportAllowHistory = true;
5908 * If set nonzero, Special:Export requests for history of pages with
5909 * more revisions than this will be rejected. On some big sites things
5910 * could get bogged down by very very long pages.
5912 $wgExportMaxHistory = 0;
5915 * Return distinct author list (when not returning full history)
5917 $wgExportAllowListContributors = false;
5920 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
5921 * up to this specified level, which will cause it to include all
5922 * pages linked to from the pages you specify. Since this number
5923 * can become *insanely large* and could easily break your wiki,
5924 * it's disabled by default for now.
5926 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
5927 * crazy-big export from being done by someone setting the depth number too
5928 * high. In other words, last resort safety net.
5930 $wgExportMaxLinkDepth = 0;
5933 * Whether to allow the "export all pages in namespace" option
5935 $wgExportFromNamespaces = false;
5938 * Whether to allow exporting the entire wiki into a single file
5940 $wgExportAllowAll = false;
5942 /** @} */ # end of import/export }
5944 /*************************************************************************//**
5945 * @name Extensions
5946 * @{
5950 * A list of callback functions which are called once MediaWiki is fully
5951 * initialised
5953 $wgExtensionFunctions = array();
5956 * Extension messages files.
5958 * Associative array mapping extension name to the filename where messages can be
5959 * found. The file should contain variable assignments. Any of the variables
5960 * present in languages/messages/MessagesEn.php may be defined, but $messages
5961 * is the most common.
5963 * Variables defined in extensions will override conflicting variables defined
5964 * in the core.
5966 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
5967 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
5968 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
5969 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
5971 * Extensions using the JSON message format can preserve backward compatibility with
5972 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
5973 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
5974 * as for the $wgMessagesDirs entry.
5976 * @par Example:
5977 * @code
5978 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
5979 * @endcode
5981 $wgExtensionMessagesFiles = array();
5984 * Extension messages directories.
5986 * Associative array mapping extension name to the path of the directory where message files can
5987 * be found. The message files are expected to be JSON files named for their language code, e.g.
5988 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
5989 * message directories.
5991 * @par Simple example:
5992 * @code
5993 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
5994 * @endcode
5996 * @par Complex example:
5997 * @code
5998 * $wgMessagesDirs['Example'] = array(
5999 * __DIR__ . '/lib/ve/i18n',
6000 * __DIR__ . '/lib/oojs-ui/i18n',
6001 * __DIR__ . '/i18n',
6003 * @endcode
6004 * @since 1.23
6006 $wgMessagesDirs = array(
6007 'core' => "$IP/languages/i18n",
6008 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
6012 * Array of files with list(s) of extension entry points to be used in
6013 * maintenance/mergeMessageFileList.php
6014 * @since 1.22
6016 $wgExtensionEntryPointListFiles = array();
6019 * Parser output hooks.
6020 * This is an associative array where the key is an extension-defined tag
6021 * (typically the extension name), and the value is a PHP callback.
6022 * These will be called as an OutputPageParserOutput hook, if the relevant
6023 * tag has been registered with the parser output object.
6025 * Registration is done with $pout->addOutputHook( $tag, $data ).
6027 * The callback has the form:
6028 * @code
6029 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6030 * @endcode
6032 $wgParserOutputHooks = array();
6035 * Whether to include the NewPP limit report as a HTML comment
6037 $wgEnableParserLimitReporting = true;
6040 * List of valid skin names.
6041 * The key should be the name in all lower case, the value should be a properly
6042 * cased name for the skin. This value will be prefixed with "Skin" to create the
6043 * class name of the skin to load, and if the skin's class cannot be found through
6044 * the autoloader it will be used to load a .php file by that name in the skins directory.
6045 * The default skins will be added later, by Skin::getSkinNames(). Use
6046 * Skin::getSkinNames() as an accessor if you wish to have access to the full list.
6048 $wgValidSkinNames = array();
6051 * Special page list.
6052 * See the top of SpecialPage.php for documentation.
6054 $wgSpecialPages = array();
6057 * Array mapping class names to filenames, for autoloading.
6059 $wgAutoloadClasses = array();
6062 * Switch controlling legacy case-insensitive classloading.
6063 * Do not disable if your wiki must support data created by PHP4, or by
6064 * MediaWiki 1.4 or earlier.
6066 $wgAutoloadAttemptLowercase = true;
6069 * An array of information about installed extensions keyed by their type.
6071 * All but 'name', 'path' and 'author' can be omitted.
6073 * @code
6074 * $wgExtensionCredits[$type][] = array(
6075 * 'path' => __FILE__,
6076 * 'name' => 'Example extension',
6077 * 'author' => array(
6078 * 'Foo Barstein',
6079 * ),
6080 * 'version' => '1.9.0',
6081 * 'url' => 'http://example.org/example-extension/',
6082 * 'descriptionmsg' => 'exampleextension-desc',
6083 * 'license-name' => 'GPL-2.0',
6084 * );
6085 * @endcode
6087 * The extensions are listed on Special:Version. This page also looks for a file
6088 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6089 * view said file. When the 'license-name' key is specified, this file is
6090 * interpreted as wikitext.
6092 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media' or 'other'.
6094 * - author: A string or an array of strings. Authors can be linked using
6095 * the regular wikitext link syntax. To have an internationalized version of
6096 * "and others" show, add an element "...". This element can also be linked,
6097 * for instance "[http://example ...]".
6099 * - descriptionmsg: A message key or an an array with message key and parameters:
6100 * `'descriptionmsg' => array( 'exampleextension-desc', param1, param2, ... ),`
6102 * - description: Description of extension as inline string instead of
6103 * localizable message (omit in favour of 'descriptionmsg').
6105 * - license-name: Short name of the license (used as label for the link), such
6106 * as "GPL-2.0" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6108 $wgExtensionCredits = array();
6111 * Authentication plugin.
6112 * @var $wgAuth AuthPlugin
6114 $wgAuth = null;
6117 * Global list of hooks.
6119 * The key is one of the events made available by MediaWiki, you can find
6120 * a description for most of them in docs/hooks.txt. The array is used
6121 * internally by Hook:run().
6123 * The value can be one of:
6125 * - A function name:
6126 * @code
6127 * $wgHooks['event_name'][] = $function;
6128 * @endcode
6129 * - A function with some data:
6130 * @code
6131 * $wgHooks['event_name'][] = array( $function, $data );
6132 * @endcode
6133 * - A an object method:
6134 * @code
6135 * $wgHooks['event_name'][] = array( $object, 'method' );
6136 * @endcode
6137 * - A closure:
6138 * @code
6139 * $wgHooks['event_name'][] = function ( $hookParam ) {
6140 * // Handler code goes here.
6141 * };
6142 * @endcode
6144 * @warning You should always append to an event array or you will end up
6145 * deleting a previous registered hook.
6147 * @warning Hook handlers should be registered at file scope. Registering
6148 * handlers after file scope can lead to unexpected results due to caching.
6150 $wgHooks = array();
6153 * Maps jobs to their handling classes; extensions
6154 * can add to this to provide custom jobs
6156 $wgJobClasses = array(
6157 'refreshLinks' => 'RefreshLinksJob',
6158 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6159 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6160 'sendMail' => 'EmaillingJob',
6161 'enotifNotify' => 'EnotifNotifyJob',
6162 'fixDoubleRedirect' => 'DoubleRedirectJob',
6163 'uploadFromUrl' => 'UploadFromUrlJob',
6164 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6165 'PublishStashedFile' => 'PublishStashedFileJob',
6166 'null' => 'NullJob'
6170 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6171 * special flags are set. The values here are keys of $wgJobClasses.
6173 * These can be:
6174 * - Very long-running jobs.
6175 * - Jobs that you would never want to run as part of a page rendering request.
6176 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6177 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6178 * These settings should be global to all wikis.
6180 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6183 * Map of job types to how many job "work items" should be run per second
6184 * on each job runner process. The meaning of "work items" varies per job,
6185 * but typically would be something like "pages to update". A single job
6186 * may have a variable number of work items, as is the case with batch jobs.
6187 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6188 * These settings should be global to all wikis.
6189 * @var float[]
6191 $wgJobBackoffThrottling = array();
6194 * Map of job types to configuration arrays.
6195 * This determines which queue class and storage system is used for each job type.
6196 * Job types that do not have explicit configuration will use the 'default' config.
6197 * These settings should be global to all wikis.
6199 $wgJobTypeConf = array(
6200 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6204 * Which aggregator to use for tracking which queues have jobs.
6205 * These settings should be global to all wikis.
6207 $wgJobQueueAggregator = array(
6208 'class' => 'JobQueueAggregatorMemc'
6212 * Additional functions to be performed with updateSpecialPages.
6213 * Expensive Querypages are already updated.
6215 $wgSpecialPageCacheUpdates = array(
6216 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6217 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6221 * Hooks that are used for outputting exceptions. Format is:
6222 * $wgExceptionHooks[] = $funcname
6223 * or:
6224 * $wgExceptionHooks[] = array( $class, $funcname )
6225 * Hooks should return strings or false
6227 $wgExceptionHooks = array();
6230 * Page property link table invalidation lists. When a page property
6231 * changes, this may require other link tables to be updated (eg
6232 * adding __HIDDENCAT__ means the hiddencat tracking category will
6233 * have been added, so the categorylinks table needs to be rebuilt).
6234 * This array can be added to by extensions.
6236 $wgPagePropLinkInvalidations = array(
6237 'hiddencat' => 'categorylinks',
6240 /** @} */ # End extensions }
6242 /*************************************************************************//**
6243 * @name Categories
6244 * @{
6248 * Use experimental, DMOZ-like category browser
6250 $wgUseCategoryBrowser = false;
6253 * On category pages, show thumbnail gallery for images belonging to that
6254 * category instead of listing them as articles.
6256 $wgCategoryMagicGallery = true;
6259 * Paging limit for categories
6261 $wgCategoryPagingLimit = 200;
6264 * Specify how category names should be sorted, when listed on a category page.
6265 * A sorting scheme is also known as a collation.
6267 * Available values are:
6269 * - uppercase: Converts the category name to upper case, and sorts by that.
6271 * - identity: Does no conversion. Sorts by binary value of the string.
6273 * - uca-default: Provides access to the Unicode Collation Algorithm with
6274 * the default element table. This is a compromise collation which sorts
6275 * all languages in a mediocre way. However, it is better than "uppercase".
6277 * To use the uca-default collation, you must have PHP's intl extension
6278 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6279 * resulting collation will depend on the version of ICU installed on the
6280 * server.
6282 * After you change this, you must run maintenance/updateCollation.php to fix
6283 * the sort keys in the database.
6285 * Extensions can define there own collations by subclassing Collation
6286 * and using the Collation::factory hook.
6288 $wgCategoryCollation = 'uppercase';
6290 /** @} */ # End categories }
6292 /*************************************************************************//**
6293 * @name Logging
6294 * @{
6298 * The logging system has two levels: an event type, which describes the
6299 * general category and can be viewed as a named subset of all logs; and
6300 * an action, which is a specific kind of event that can exist in that
6301 * log type.
6303 $wgLogTypes = array(
6305 'block',
6306 'protect',
6307 'rights',
6308 'delete',
6309 'upload',
6310 'move',
6311 'import',
6312 'patrol',
6313 'merge',
6314 'suppress',
6318 * This restricts log access to those who have a certain right
6319 * Users without this will not see it in the option menu and can not view it
6320 * Restricted logs are not added to recent changes
6321 * Logs should remain non-transcludable
6322 * Format: logtype => permissiontype
6324 $wgLogRestrictions = array(
6325 'suppress' => 'suppressionlog'
6329 * Show/hide links on Special:Log will be shown for these log types.
6331 * This is associative array of log type => boolean "hide by default"
6333 * See $wgLogTypes for a list of available log types.
6335 * @par Example:
6336 * @code
6337 * $wgFilterLogTypes = array(
6338 * 'move' => true,
6339 * 'import' => false,
6340 * );
6341 * @endcode
6343 * Will display show/hide links for the move and import logs. Move logs will be
6344 * hidden by default unless the link is clicked. Import logs will be shown by
6345 * default, and hidden when the link is clicked.
6347 * A message of the form log-show-hide-[type] should be added, and will be used
6348 * for the link text.
6350 $wgFilterLogTypes = array(
6351 'patrol' => true
6355 * Lists the message key string for each log type. The localized messages
6356 * will be listed in the user interface.
6358 * Extensions with custom log types may add to this array.
6360 * @since 1.19, if you follow the naming convention log-name-TYPE,
6361 * where TYPE is your log type, yoy don't need to use this array.
6363 $wgLogNames = array(
6364 '' => 'all-logs-page',
6365 'block' => 'blocklogpage',
6366 'protect' => 'protectlogpage',
6367 'rights' => 'rightslog',
6368 'delete' => 'dellogpage',
6369 'upload' => 'uploadlogpage',
6370 'move' => 'movelogpage',
6371 'import' => 'importlogpage',
6372 'patrol' => 'patrol-log-page',
6373 'merge' => 'mergelog',
6374 'suppress' => 'suppressionlog',
6378 * Lists the message key string for descriptive text to be shown at the
6379 * top of each log type.
6381 * Extensions with custom log types may add to this array.
6383 * @since 1.19, if you follow the naming convention log-description-TYPE,
6384 * where TYPE is your log type, yoy don't need to use this array.
6386 $wgLogHeaders = array(
6387 '' => 'alllogstext',
6388 'block' => 'blocklogtext',
6389 'protect' => 'protectlogtext',
6390 'rights' => 'rightslogtext',
6391 'delete' => 'dellogpagetext',
6392 'upload' => 'uploadlogpagetext',
6393 'move' => 'movelogpagetext',
6394 'import' => 'importlogpagetext',
6395 'patrol' => 'patrol-log-header',
6396 'merge' => 'mergelogpagetext',
6397 'suppress' => 'suppressionlogtext',
6401 * Lists the message key string for formatting individual events of each
6402 * type and action when listed in the logs.
6404 * Extensions with custom log types may add to this array.
6406 $wgLogActions = array(
6407 'block/block' => 'blocklogentry',
6408 'block/unblock' => 'unblocklogentry',
6409 'block/reblock' => 'reblock-logentry',
6410 'protect/protect' => 'protectedarticle',
6411 'protect/modify' => 'modifiedarticleprotection',
6412 'protect/unprotect' => 'unprotectedarticle',
6413 'protect/move_prot' => 'movedarticleprotection',
6414 'upload/upload' => 'uploadedimage',
6415 'upload/overwrite' => 'overwroteimage',
6416 'upload/revert' => 'uploadedimage',
6417 'import/upload' => 'import-logentry-upload',
6418 'import/interwiki' => 'import-logentry-interwiki',
6419 'merge/merge' => 'pagemerge-logentry',
6420 'suppress/block' => 'blocklogentry',
6421 'suppress/reblock' => 'reblock-logentry',
6425 * The same as above, but here values are names of functions,
6426 * not messages.
6427 * @see LogPage::actionText
6428 * @see LogFormatter
6430 $wgLogActionsHandlers = array(
6431 'move/move' => 'MoveLogFormatter',
6432 'move/move_redir' => 'MoveLogFormatter',
6433 'delete/delete' => 'DeleteLogFormatter',
6434 'delete/restore' => 'DeleteLogFormatter',
6435 'delete/revision' => 'DeleteLogFormatter',
6436 'delete/event' => 'DeleteLogFormatter',
6437 'suppress/revision' => 'DeleteLogFormatter',
6438 'suppress/event' => 'DeleteLogFormatter',
6439 'suppress/delete' => 'DeleteLogFormatter',
6440 'patrol/patrol' => 'PatrolLogFormatter',
6441 'rights/rights' => 'RightsLogFormatter',
6442 'rights/autopromote' => 'RightsLogFormatter',
6446 * Maintain a log of newusers at Log/newusers?
6448 $wgNewUserLog = true;
6450 /** @} */ # end logging }
6452 /*************************************************************************//**
6453 * @name Special pages (general and miscellaneous)
6454 * @{
6458 * Allow special page inclusions such as {{Special:Allpages}}
6460 $wgAllowSpecialInclusion = true;
6463 * Set this to an array of special page names to prevent
6464 * maintenance/updateSpecialPages.php from updating those pages.
6466 $wgDisableQueryPageUpdate = false;
6469 * List of special pages, followed by what subtitle they should go under
6470 * at Special:SpecialPages
6472 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6474 $wgSpecialPageGroups = array();
6477 * Whether or not to sort special pages in Special:Specialpages
6479 $wgSortSpecialPages = true;
6482 * On Special:Unusedimages, consider images "used", if they are put
6483 * into a category. Default (false) is not to count those as used.
6485 $wgCountCategorizedImagesAsUsed = false;
6488 * Maximum number of links to a redirect page listed on
6489 * Special:Whatlinkshere/RedirectDestination
6491 $wgMaxRedirectLinksRetrieved = 500;
6493 /** @} */ # end special pages }
6495 /*************************************************************************//**
6496 * @name Actions
6497 * @{
6501 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6502 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6503 * 'foo' => true Load the class FooAction which subclasses Action
6504 * If something is specified in the getActionOverrides()
6505 * of the relevant Page object it will be used
6506 * instead of the default class.
6507 * 'foo' => false The action is disabled; show an error message
6508 * Unsetting core actions will probably cause things to complain loudly.
6510 $wgActions = array(
6511 'credits' => true,
6512 'delete' => true,
6513 'edit' => true,
6514 'history' => true,
6515 'info' => true,
6516 'markpatrolled' => true,
6517 'protect' => true,
6518 'purge' => true,
6519 'raw' => true,
6520 'render' => true,
6521 'revert' => true,
6522 'revisiondelete' => true,
6523 'rollback' => true,
6524 'submit' => true,
6525 'unprotect' => true,
6526 'unwatch' => true,
6527 'view' => true,
6528 'watch' => true,
6531 /** @} */ # end actions }
6533 /*************************************************************************//**
6534 * @name Robot (search engine crawler) policy
6535 * See also $wgNoFollowLinks.
6536 * @{
6540 * Default robot policy. The default policy is to encourage indexing and fol-
6541 * lowing of links. It may be overridden on a per-namespace and/or per-page
6542 * basis.
6544 $wgDefaultRobotPolicy = 'index,follow';
6547 * Robot policies per namespaces. The default policy is given above, the array
6548 * is made of namespace constants as defined in includes/Defines.php. You can-
6549 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6550 * nofollow. This is because a number of special pages (e.g., ListPages) have
6551 * many permutations of options that display the same data under redundant
6552 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6553 * pages, all alike, and never reaching your actual content.
6555 * @par Example:
6556 * @code
6557 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6558 * @endcode
6560 $wgNamespaceRobotPolicies = array();
6563 * Robot policies per article. These override the per-namespace robot policies.
6564 * Must be in the form of an array where the key part is a properly canonicalised
6565 * text form title and the value is a robot policy.
6567 * @par Example:
6568 * @code
6569 * $wgArticleRobotPolicies = array(
6570 * 'Main Page' => 'noindex,follow',
6571 * 'User:Bob' => 'index,follow',
6572 * );
6573 * @endcode
6575 * @par Example that DOES NOT WORK because the names are not canonical text
6576 * forms:
6577 * @code
6578 * $wgArticleRobotPolicies = array(
6579 * # Underscore, not space!
6580 * 'Main_Page' => 'noindex,follow',
6581 * # "Project", not the actual project name!
6582 * 'Project:X' => 'index,follow',
6583 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6584 * 'abc' => 'noindex,nofollow'
6585 * );
6586 * @endcode
6588 $wgArticleRobotPolicies = array();
6591 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6592 * will not function, so users can't decide whether pages in that namespace are
6593 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6595 * @par Example:
6596 * @code
6597 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6598 * @endcode
6600 $wgExemptFromUserRobotsControl = null;
6602 /** @} */ # End robot policy }
6604 /************************************************************************//**
6605 * @name AJAX and API
6606 * Note: The AJAX entry point which this section refers to is gradually being
6607 * replaced by the API entry point, api.php. They are essentially equivalent.
6608 * Both of them are used for dynamic client-side features, via XHR.
6609 * @{
6613 * Enable the MediaWiki API for convenient access to
6614 * machine-readable data via api.php
6616 * See https://www.mediawiki.org/wiki/API
6618 $wgEnableAPI = true;
6621 * Allow the API to be used to perform write operations
6622 * (page edits, rollback, etc.) when an authorised user
6623 * accesses it
6625 $wgEnableWriteAPI = true;
6629 * WARNING: SECURITY THREAT - debug use only
6631 * Disables many security checks in the API for debugging purposes.
6632 * This flag should never be used on the production servers, as it introduces
6633 * a number of potential security holes. Even when enabled, the validation
6634 * will still be performed, but instead of failing, API will return a warning.
6635 * Also, there will always be a warning notifying that this flag is set.
6636 * At this point, the flag allows GET requests to go through for modules
6637 * requiring POST.
6639 * @since 1.21
6641 $wgDebugAPI = false;
6644 * API module extensions.
6645 * Associative array mapping module name to class name.
6646 * Extension modules may override the core modules.
6648 * See ApiMain::$Modules for a list of the core modules.
6650 $wgAPIModules = array();
6653 * API format module extensions.
6654 * Associative array mapping format module name to class name.
6655 * Extension modules may override the core modules.
6657 * See ApiMain::$Formats for a list of the core format modules.
6659 $wgAPIFormatModules = array();
6662 * API Query meta module extensions.
6663 * Associative array mapping meta module name to class name.
6664 * Extension modules may override the core modules.
6666 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6668 $wgAPIMetaModules = array();
6671 * API Query prop module extensions.
6672 * Associative array mapping properties module name to class name.
6673 * Extension modules may override the core modules.
6675 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6677 $wgAPIPropModules = array();
6680 * API Query list module extensions.
6681 * Associative array mapping list module name to class name.
6682 * Extension modules may override the core modules.
6684 * See ApiQuery::$QueryListModules for a list of the core list modules.
6686 $wgAPIListModules = array();
6689 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6690 * @deprecated since 1.21
6692 $wgAPIGeneratorModules = array();
6695 * Maximum amount of rows to scan in a DB query in the API
6696 * The default value is generally fine
6698 $wgAPIMaxDBRows = 5000;
6701 * The maximum size (in bytes) of an API result.
6702 * @warning Do not set this lower than $wgMaxArticleSize*1024
6704 $wgAPIMaxResultSize = 8388608;
6707 * The maximum number of uncached diffs that can be retrieved in one API
6708 * request. Set this to 0 to disable API diffs altogether
6710 $wgAPIMaxUncachedDiffs = 1;
6713 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6714 * API request logging
6716 $wgAPIRequestLog = false;
6719 * Set the timeout for the API help text cache. If set to 0, caching disabled
6721 $wgAPICacheHelpTimeout = 60 * 60;
6724 * The ApiQueryQueryPages module should skip pages that are redundant to true
6725 * API queries.
6727 $wgAPIUselessQueryPages = array(
6728 'MIMEsearch', // aiprop=mime
6729 'LinkSearch', // list=exturlusage
6730 'FileDuplicateSearch', // prop=duplicatefiles
6734 * Enable AJAX framework
6736 $wgUseAjax = true;
6739 * List of Ajax-callable functions.
6740 * Extensions acting as Ajax callbacks must register here
6742 $wgAjaxExportList = array();
6745 * Enable watching/unwatching pages using AJAX.
6746 * Requires $wgUseAjax to be true too.
6748 $wgAjaxWatch = true;
6751 * Enable AJAX check for file overwrite, pre-upload
6753 $wgAjaxUploadDestCheck = true;
6756 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6758 $wgAjaxLicensePreview = true;
6761 * Settings for incoming cross-site AJAX requests:
6762 * Newer browsers support cross-site AJAX when the target resource allows requests
6763 * from the origin domain by the Access-Control-Allow-Origin header.
6764 * This is currently only used by the API (requests to api.php)
6765 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6767 * - '*' matches any number of characters
6768 * - '?' matches any 1 character
6770 * @par Example:
6771 * @code
6772 * $wgCrossSiteAJAXdomains = array(
6773 * 'www.mediawiki.org',
6774 * '*.wikipedia.org',
6775 * '*.wikimedia.org',
6776 * '*.wiktionary.org',
6777 * );
6778 * @endcode
6780 $wgCrossSiteAJAXdomains = array();
6783 * Domains that should not be allowed to make AJAX requests,
6784 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6785 * Uses the same syntax as $wgCrossSiteAJAXdomains
6787 $wgCrossSiteAJAXdomainExceptions = array();
6789 /** @} */ # End AJAX and API }
6791 /************************************************************************//**
6792 * @name Shell and process control
6793 * @{
6797 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6799 $wgMaxShellMemory = 307200;
6802 * Maximum file size created by shell processes under linux, in KB
6803 * ImageMagick convert for example can be fairly hungry for scratch space
6805 $wgMaxShellFileSize = 102400;
6808 * Maximum CPU time in seconds for shell processes under Linux
6810 $wgMaxShellTime = 180;
6813 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6814 * would measure) in seconds for shell processes under Linux
6816 $wgMaxShellWallClockTime = 180;
6819 * Under Linux: a cgroup directory used to constrain memory usage of shell
6820 * commands. The directory must be writable by the user which runs MediaWiki.
6822 * If specified, this is used instead of ulimit, which is inaccurate, and
6823 * causes malloc() to return NULL, which exposes bugs in C applications, making
6824 * them segfault or deadlock.
6826 * A wrapper script will create a cgroup for each shell command that runs, as
6827 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6828 * kernel will send a SIGKILL signal to a process in the subgroup.
6830 * @par Example:
6831 * @code
6832 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6833 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6834 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6835 * @endcode
6837 * The reliability of cgroup cleanup can be improved by installing a
6838 * notify_on_release script in the root cgroup, see e.g.
6839 * https://gerrit.wikimedia.org/r/#/c/40784
6841 $wgShellCgroup = false;
6844 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6846 $wgPhpCli = '/usr/bin/php';
6849 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
6850 * For Unix-like operating systems, set this to to a locale that has a UTF-8
6851 * character set. Only the character set is relevant.
6853 $wgShellLocale = 'en_US.utf8';
6855 /** @} */ # End shell }
6857 /************************************************************************//**
6858 * @name HTTP client
6859 * @{
6863 * Timeout for HTTP requests done internally
6865 $wgHTTPTimeout = 25;
6868 * Timeout for Asynchronous (background) HTTP requests
6870 $wgAsyncHTTPTimeout = 25;
6873 * Proxy to use for CURL requests.
6875 $wgHTTPProxy = false;
6878 * Timeout for connections done internally (in seconds)
6879 * Only works for curl
6881 $wgHTTPConnectTimeout = 5e0;
6883 /** @} */ # End HTTP client }
6885 /************************************************************************//**
6886 * @name Job queue
6887 * See also $wgEnotifUseJobQ.
6888 * @{
6892 * Number of jobs to perform per request. May be less than one in which case
6893 * jobs are performed probabalistically. If this is zero, jobs will not be done
6894 * during ordinary apache requests. In this case, maintenance/runJobs.php should
6895 * be run periodically.
6897 $wgJobRunRate = 1;
6900 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
6901 * to handle the job execution, instead of blocking the request until the job
6902 * execution finishes.
6903 * @since 1.23
6905 $wgRunJobsAsync = true;
6908 * Number of rows to update per job
6910 $wgUpdateRowsPerJob = 500;
6913 * Number of rows to update per query
6915 $wgUpdateRowsPerQuery = 100;
6917 /** @} */ # End job queue }
6919 /************************************************************************//**
6920 * @name Miscellaneous
6921 * @{
6925 * Name of the external diff engine to use
6927 $wgExternalDiffEngine = false;
6930 * Disable redirects to special pages and interwiki redirects, which use a 302
6931 * and have no "redirected from" link.
6933 * @note This is only for articles with #REDIRECT in them. URL's containing a
6934 * local interwiki prefix (or a non-canonical special page name) are still hard
6935 * redirected regardless of this setting.
6937 $wgDisableHardRedirects = false;
6940 * LinkHolderArray batch size
6941 * For debugging
6943 $wgLinkHolderBatchSize = 1000;
6946 * By default MediaWiki does not register links pointing to same server in
6947 * externallinks dataset, use this value to override:
6949 $wgRegisterInternalExternals = false;
6952 * Maximum number of pages to move at once when moving subpages with a page.
6954 $wgMaximumMovedPages = 100;
6957 * Fix double redirects after a page move.
6958 * Tends to conflict with page move vandalism, use only on a private wiki.
6960 $wgFixDoubleRedirects = false;
6963 * Allow redirection to another page when a user logs in.
6964 * To enable, set to a string like 'Main Page'
6966 $wgRedirectOnLogin = null;
6969 * Configuration for processing pool control, for use in high-traffic wikis.
6970 * An implementation is provided in the PoolCounter extension.
6972 * This configuration array maps pool types to an associative array. The only
6973 * defined key in the associative array is "class", which gives the class name.
6974 * The remaining elements are passed through to the class as constructor
6975 * parameters.
6977 * @par Example:
6978 * @code
6979 * $wgPoolCounterConf = array( 'ArticleView' => array(
6980 * 'class' => 'PoolCounter_Client',
6981 * 'timeout' => 15, // wait timeout in seconds
6982 * 'workers' => 5, // maximum number of active threads in each pool
6983 * 'maxqueue' => 50, // maximum number of total threads in each pool
6984 * ... any extension-specific options...
6985 * );
6986 * @endcode
6988 $wgPoolCounterConf = null;
6991 * To disable file delete/restore temporarily
6993 $wgUploadMaintenance = false;
6996 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
6997 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
6998 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
6999 * (except for the special case of JS and CS pages).
7001 * @since 1.21
7003 $wgNamespaceContentModels = array();
7006 * How to react if a plain text version of a non-text Content object is requested using
7007 * ContentHandler::getContentText():
7009 * * 'ignore': return null
7010 * * 'fail': throw an MWException
7011 * * 'serialize': serialize to default format
7013 * @since 1.21
7015 $wgContentHandlerTextFallback = 'ignore';
7018 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7019 * This way, the ContentHandler facility can be used without any additional information in the
7020 * database. A page's content model is then derived solely from the page's title. This however
7021 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7022 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7023 * a title that would default to a different content model.
7025 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7026 * handling is less robust and less flexible.
7028 * @since 1.21
7030 $wgContentHandlerUseDB = true;
7033 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7034 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7035 * the effect on the database they would have on a wikitext page.
7037 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7038 * or at least parse only the contents of comments in the scripts.
7040 * @since 1.21
7042 $wgTextModelsToParse = array(
7043 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
7044 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
7045 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
7049 * Whether the user must enter their password to change their e-mail address
7051 * @since 1.20
7053 $wgRequirePasswordforEmailChange = true;
7056 * Register handlers for specific types of sites.
7058 * @since 1.20
7060 $wgSiteTypes = array(
7061 'mediawiki' => 'MediaWikiSite',
7065 * Formerly a list of files for HipHop compilation
7066 * @deprecated since 1.22
7068 $wgCompiledFiles = array();
7071 * Whether the page_props table has a pp_sortkey column. Set to false in case
7072 * the respective database schema change was not applied.
7073 * @since 1.23
7075 $wgPagePropsHaveSortkey = true;
7078 * For really cool vim folding this needs to be at the end:
7079 * vim: foldmarker=@{,@} foldmethod=marker
7080 * @}