3 * Default values for MediaWiki configuration settings.
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
42 * @defgroup Globalsettings Global settings
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";
56 * wgConf hold the site configuration.
57 * Not used for much in a default install.
60 $wgConf = new SiteConfiguration
;
63 * Registry of factory functions to create config objects:
64 * The 'main' key must be set, and the value should be a valid
68 $wgConfigRegistry = array(
69 'main' => 'GlobalVarConfig::newInstance'
73 * MediaWiki version number
76 $wgVersion = '1.24alpha';
79 * Name of the site. It must be changed in LocalSettings.php
81 $wgSitename = 'MediaWiki';
88 * $wgServer = 'http://example.com';
91 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
92 * wrong server, it will redirect incorrectly after you save a page. In that
93 * case, set this variable to fix it.
95 * If you want to use protocol-relative URLs on your wiki, set this to a
96 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
97 * to a fully qualified URL.
99 $wgServer = WebRequest
::detectServer();
102 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
103 * Must be fully qualified, even if $wgServer is protocol-relative.
105 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
108 $wgCanonicalServer = false;
111 * Server name. This is automatically computed by parsing the bare
112 * hostname out of $wgCanonicalServer. It should not be customized.
115 $wgServerName = false;
117 /************************************************************************//**
118 * @name Script path settings
123 * The path we should point to.
124 * It might be a virtual path in case with use apache mod_rewrite for example.
126 * This *needs* to be set correctly.
128 * Other paths will be set to defaults based on it unless they are directly
129 * set in LocalSettings.php
131 $wgScriptPath = '/wiki';
134 * Whether to support URLs like index.php/Page_title These often break when PHP
135 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
136 * but then again it may not; lighttpd converts incoming path data to lowercase
137 * on systems with case-insensitive filesystems, and there have been reports of
138 * problems on Apache as well.
140 * To be safe we'll continue to keep it off by default.
142 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
143 * incorrect garbage, or to true if it is really correct.
145 * The default $wgArticlePath will be set based on this value at runtime, but if
146 * you have customized it, having this incorrectly set to true can cause
147 * redirect loops when "pretty URLs" are used.
150 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
151 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
152 ( strpos( PHP_SAPI
, 'isapi' ) === false );
155 * The extension to append to script names by default. This can either be .php
158 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
159 * variable is provided to support those providers.
162 $wgScriptExtension = '.php';
166 /************************************************************************//**
167 * @name URLs and file paths
169 * These various web and file path variables are set to their defaults
170 * in Setup.php if they are not explicitly set from LocalSettings.php.
172 * These will relatively rarely need to be set manually, unless you are
173 * splitting style sheets or images outside the main document root.
175 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
176 * the host part, that starts with a slash. In most cases a full URL is also
177 * acceptable. A "directory" is a local file path.
179 * In both paths and directories, trailing slashes should not be included.
185 * The URL path to index.php.
187 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
192 * The URL path to load.php.
194 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
197 $wgLoadScript = false;
200 * The URL path of the skins directory.
201 * Defaults to "{$wgScriptPath}/skins".
204 $wgStylePath = false;
205 $wgStyleSheetPath = &$wgStylePath;
208 * The URL path of the skins directory. Should not point to an external domain.
209 * Defaults to "{$wgScriptPath}/skins".
212 $wgLocalStylePath = false;
215 * The URL path of the extensions directory.
216 * Defaults to "{$wgScriptPath}/extensions".
219 $wgExtensionAssetsPath = false;
222 * Filesystem stylesheets directory.
223 * Defaults to "{$IP}/skins".
226 $wgStyleDirectory = false;
229 * The URL path for primary article page views. This path should contain $1,
230 * which is replaced by the article title.
232 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
233 * depending on $wgUsePathInfo.
235 $wgArticlePath = false;
238 * The URL path for the images directory.
239 * Defaults to "{$wgScriptPath}/images".
241 $wgUploadPath = false;
244 * The filesystem path of the images directory. Defaults to "{$IP}/images".
246 $wgUploadDirectory = false;
249 * Directory where the cached page will be saved.
250 * Defaults to "{$wgUploadDirectory}/cache".
252 $wgFileCacheDirectory = false;
255 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
256 * Defaults to "{$wgStylePath}/common/images/wiki.png".
261 * The URL path of the shortcut icon.
264 $wgFavicon = '/favicon.ico';
267 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
268 * Defaults to no icon.
271 $wgAppleTouchIcon = false;
274 * The local filesystem path to a temporary directory. This is not required to
277 * When this setting is set to false, its value will be set through a call
278 * to wfTempDir(). See that methods implementation for the actual detection
281 * Developers should use the global function wfTempDir() instead of this
285 * @note Default changed to false in MediaWiki 1.20.
287 $wgTmpDirectory = false;
290 * If set, this URL is added to the start of $wgUploadPath to form a complete
294 $wgUploadBaseUrl = '';
297 * To enable remote on-demand scaling, set this to the thumbnail base URL.
298 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
299 * where 'e6' are the first two characters of the MD5 hash of the file name.
300 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
303 $wgUploadStashScalerBaseUrl = false;
306 * To set 'pretty' URL paths for actions other than
307 * plain page views, add to this array.
310 * Set pretty URL for the edit action:
312 * 'edit' => "$wgScriptPath/edit/$1"
315 * There must be an appropriate script or rewrite rule in place to handle these
319 $wgActionPaths = array();
323 /************************************************************************//**
324 * @name Files and file uploads
329 * Uploads have to be specially set up to be secure
331 $wgEnableUploads = false;
334 * The maximum age of temporary (incomplete) uploaded files
336 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
339 * Allows to move images and other media files
341 $wgAllowImageMoving = true;
344 * Enable deferred upload tasks that use the job queue.
345 * Only enable this if job runners are set up for both the
346 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
348 * @note If you use suhosin, this setting is incompatible with
349 * suhosin.session.encrypt.
351 $wgEnableAsyncUploads = false;
354 * These are additional characters that should be replaced with '-' in filenames
356 $wgIllegalFileChars = ":";
359 * What directory to place deleted uploads in.
360 * Defaults to "{$wgUploadDirectory}/deleted".
362 $wgDeletedDirectory = false;
365 * Set this to true if you use img_auth and want the user to see details on why access failed.
367 $wgImgAuthDetails = false;
370 * Map of relative URL directories to match to internal mwstore:// base storage paths.
371 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
372 * if starts with any of the prefixes defined here. The prefixes should not overlap.
373 * The prefix that matches has a corresponding storage path, which the rest of the URL
374 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
377 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
378 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
379 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
381 * @see $wgFileBackends
383 $wgImgAuthUrlPathMap = array();
386 * File repository structures
388 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
389 * an array of such structures. Each repository structure is an associative
390 * array of properties configuring the repository.
392 * Properties required for all repos:
393 * - class The class name for the repository. May come from the core or an extension.
394 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
395 * FSRepo is also supported for backwards compatibility.
397 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
398 * The name should consist of alpha-numeric characters.
399 * - backend A file backend name (see $wgFileBackends).
401 * For most core repos:
402 * - zones Associative array of zone names that each map to an array with:
403 * container : backend container name the zone is in
404 * directory : root path within container for the zone
405 * url : base URL to the root of the zone
406 * urlsByExt : map of file extension types to base URLs
407 * (useful for using a different cache for videos)
408 * Zones default to using "<repo name>-<zone name>" as the container name
409 * and default to using the container root as the zone's root directory.
410 * Nesting of zone locations within other zones should be avoided.
411 * - url Public zone URL. The 'zones' settings take precedence.
412 * - hashLevels The number of directory levels for hash-based division of files
413 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
414 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
416 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
417 * determines whether filenames implicitly start with a capital letter.
418 * The current implementation may give incorrect description page links
419 * when the local $wgCapitalLinks and initialCapital are mismatched.
420 * - pathDisclosureProtection
421 * May be 'paranoid' to remove all parameters from error messages, 'none' to
422 * leave the paths in unchanged, or 'simple' to replace paths with
423 * placeholders. Default for LocalRepo is 'simple'.
424 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
426 * - directory The local filesystem directory where public files are stored. Not used for
428 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
429 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
430 * - isPrivate Set this if measures should always be taken to keep the files private.
431 * One should not trust this to assure that the files are not web readable;
432 * the server configuration should be done manually depending on the backend.
434 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
435 * for local repositories:
436 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
437 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
438 * http://en.wikipedia.org/w
439 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
440 * $wgScriptExtension, e.g. .php5 defaults to .php
442 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
443 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
444 * $wgFetchCommonsDescriptions.
445 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
446 * Short thumbnail names only have the width, parameters, and the extension.
449 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
450 * equivalent to the corresponding member of $wgDBservers
451 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
452 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
455 * - apibase Use for the foreign API's URL
456 * - apiThumbCacheExpiry How long to locally cache thumbs for
458 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
459 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
460 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
461 * If you set $wgForeignFileRepos to an array of repository structures, those will
462 * be searched after the local file repo.
463 * Otherwise, you will only have access to local media files.
465 * @see Setup.php for an example usage and default initialization.
467 $wgLocalFileRepo = false;
470 * @see $wgLocalFileRepo
472 $wgForeignFileRepos = array();
475 * Use Commons as a remote file repository. Essentially a wrapper, when this
476 * is enabled $wgForeignFileRepos will point at Commons with a set of default
479 $wgUseInstantCommons = false;
482 * File backend structure configuration.
484 * This is an array of file backend configuration arrays.
485 * Each backend configuration has the following parameters:
486 * - 'name' : A unique name for the backend
487 * - 'class' : The file backend class to use
488 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
489 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
491 * See FileBackend::__construct() for more details.
492 * Additional parameters are specific to the file backend class used.
493 * These settings should be global to all wikis when possible.
495 * There are two particularly important aspects about each backend:
496 * - a) Whether it is fully qualified or wiki-relative.
497 * By default, the paths of files are relative to the current wiki,
498 * which works via prefixing them with the current wiki ID when accessed.
499 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
500 * all paths with the specified value instead. This can be useful if
501 * multiple wikis need to share the same data. Note that 'name' is *not*
502 * part of any prefix and thus should not be relied upon for namespacing.
503 * - b) Whether it is only defined for some wikis or is defined on all
504 * wikis in the wiki farm. Defining a backend globally is useful
505 * if multiple wikis need to share the same data.
506 * One should be aware of these aspects when configuring a backend for use with
507 * any basic feature or plugin. For example, suppose an extension stores data for
508 * different wikis in different directories and sometimes needs to access data from
509 * a foreign wiki's directory in order to render a page on given wiki. The extension
510 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
512 $wgFileBackends = array();
515 * Array of configuration arrays for each lock manager.
516 * Each backend configuration has the following parameters:
517 * - 'name' : A unique name for the lock manager
518 * - 'class' : The lock manger class to use
520 * See LockManager::__construct() for more details.
521 * Additional parameters are specific to the lock manager class used.
522 * These settings should be global to all wikis.
524 $wgLockManagers = array();
527 * Show Exif data, on by default if available.
528 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
530 * @note FOR WINDOWS USERS:
531 * To enable Exif functions, add the following lines to the "Windows
532 * extensions" section of php.ini:
534 * extension=extensions/php_mbstring.dll
535 * extension=extensions/php_exif.dll
538 $wgShowEXIF = function_exists( 'exif_read_data' );
541 * If to automatically update the img_metadata field
542 * if the metadata field is outdated but compatible with the current version.
545 $wgUpdateCompatibleMetadata = false;
548 * If you operate multiple wikis, you can define a shared upload path here.
549 * Uploads to this wiki will NOT be put there - they will be put into
550 * $wgUploadDirectory.
551 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
552 * no file of the given name is found in the local repository (for [[File:..]],
553 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
556 * Note that these configuration settings can now be defined on a per-
557 * repository basis for an arbitrary number of file repositories, using the
558 * $wgForeignFileRepos variable.
560 $wgUseSharedUploads = false;
563 * Full path on the web server where shared uploads can be found
565 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
568 * Fetch commons image description pages and display them on the local wiki?
570 $wgFetchCommonsDescriptions = false;
573 * Path on the file system where shared uploads can be found.
575 $wgSharedUploadDirectory = "/var/www/wiki3/images";
578 * DB name with metadata about shared directory.
579 * Set this to false if the uploads do not come from a wiki.
581 $wgSharedUploadDBname = false;
584 * Optional table prefix used in database.
586 $wgSharedUploadDBprefix = '';
589 * Cache shared metadata in memcached.
590 * Don't do this if the commons wiki is in a different memcached domain
592 $wgCacheSharedUploads = true;
595 * Allow for upload to be copied from an URL.
596 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
597 * You have to assign the user right 'upload_by_url' to a user group, to use this.
599 $wgAllowCopyUploads = false;
602 * Allow asynchronous copy uploads.
603 * This feature is experimental and broken as of r81612.
605 $wgAllowAsyncCopyUploads = false;
608 * A list of domains copy uploads can come from
612 $wgCopyUploadsDomains = array();
615 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
616 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
617 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
619 $wgCopyUploadsFromSpecialUpload = false;
622 * Proxy to use for copy upload requests.
625 $wgCopyUploadProxy = false;
628 * Different timeout for upload by url
629 * This could be useful since when fetching large files, you may want a
630 * timeout longer than the default $wgHTTPTimeout. False means fallback
635 $wgCopyUploadTimeout = false;
638 * Different timeout for upload by url when run as a background job
639 * This could be useful since when fetching large files via job queue,
640 * you may want a different timeout, especially because there is no
641 * http request being kept alive.
643 * false means fallback to $wgCopyUploadTimeout.
646 $wgCopyUploadAsyncTimeout = false;
649 * Max size for uploads, in bytes. If not set to an array, applies to all
650 * uploads. If set to an array, per upload type maximums can be set, using the
651 * file and url keys. If the * key is set this value will be used as maximum
652 * for non-specified types.
656 * $wgMaxUploadSize = array(
658 * 'url' => 500 * 1024,
661 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
662 * will have a maximum of 500 kB.
664 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
667 * Point the upload navigation link to an external URL
668 * Useful if you want to use a shared repository by default
669 * without disabling local uploads (use $wgEnableUploads = false for that).
673 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
676 $wgUploadNavigationUrl = false;
679 * Point the upload link for missing files to an external URL, as with
680 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
681 * appended to it as appropriate.
683 $wgUploadMissingFileUrl = false;
686 * Give a path here to use thumb.php for thumbnail generation on client
687 * request, instead of generating them on render and outputting a static URL.
688 * This is necessary if some of your apache servers don't have read/write
689 * access to the thumbnail path.
693 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
696 $wgThumbnailScriptPath = false;
699 * @see $wgThumbnailScriptPath
701 $wgSharedThumbnailScriptPath = false;
704 * Set this to false if you do not want MediaWiki to divide your images
705 * directory into many subdirectories, for improved performance.
707 * It's almost always good to leave this enabled. In previous versions of
708 * MediaWiki, some users set this to false to allow images to be added to the
709 * wiki by simply copying them into $wgUploadDirectory and then running
710 * maintenance/rebuildImages.php to register them in the database. This is no
711 * longer recommended, use maintenance/importImages.php instead.
713 * @note That this variable may be ignored if $wgLocalFileRepo is set.
714 * @todo Deprecate the setting and ultimately remove it from Core.
716 $wgHashedUploadDirectory = true;
719 * Set the following to false especially if you have a set of files that need to
720 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
723 $wgHashedSharedUploadDirectory = true;
726 * Base URL for a repository wiki. Leave this blank if uploads are just stored
727 * in a shared directory and not meant to be accessible through a separate wiki.
728 * Otherwise the image description pages on the local wiki will link to the
729 * image description page on this wiki.
731 * Please specify the namespace, as in the example below.
733 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
736 * This is the list of preferred extensions for uploading files. Uploading files
737 * with extensions not in this list will trigger a warning.
739 * @warning If you add any OpenOffice or Microsoft Office file formats here,
740 * such as odt or doc, and untrusted users are allowed to upload files, then
741 * your wiki will be vulnerable to cross-site request forgery (CSRF).
743 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
746 * Files with these extensions will never be allowed as uploads.
747 * An array of file extensions to blacklist. You should append to this array
748 * if you want to blacklist additional files.
750 $wgFileBlacklist = array(
751 # HTML may contain cookie-stealing JavaScript and web bugs
752 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
753 # PHP scripts may execute arbitrary code on the server
754 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
755 # Other types that may be interpreted by some servers
756 'shtml', 'jhtml', 'pl', 'py', 'cgi',
757 # May contain harmful executables for Windows victims
758 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
761 * Files with these mime types will never be allowed as uploads
762 * if $wgVerifyMimeType is enabled.
764 $wgMimeTypeBlacklist = array(
765 # HTML may contain cookie-stealing JavaScript and web bugs
766 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
767 # PHP scripts may execute arbitrary code on the server
768 'application/x-php', 'text/x-php',
769 # Other types that may be interpreted by some servers
770 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
771 # Client-side hazards on Internet Explorer
772 'text/scriptlet', 'application/x-msdownload',
773 # Windows metafile, client-side vulnerability on some systems
774 'application/x-msmetafile',
778 * Allow Java archive uploads.
779 * This is not recommended for public wikis since a maliciously-constructed
780 * applet running on the same domain as the wiki can steal the user's cookies.
782 $wgAllowJavaUploads = false;
785 * This is a flag to determine whether or not to check file extensions on upload.
787 * @warning Setting this to false is insecure for public wikis.
789 $wgCheckFileExtensions = true;
792 * If this is turned off, users may override the warning for files not covered
793 * by $wgFileExtensions.
795 * @warning Setting this to false is insecure for public wikis.
797 $wgStrictFileExtensions = true;
800 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
802 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
803 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
805 $wgDisableUploadScriptChecks = false;
808 * Warn if uploaded files are larger than this (in bytes), or false to disable
810 $wgUploadSizeWarning = false;
813 * list of trusted media-types and mime types.
814 * Use the MEDIATYPE_xxx constants to represent media types.
815 * This list is used by File::isSafeFile
817 * Types not listed here will have a warning about unsafe content
818 * displayed on the images description page. It would also be possible
819 * to use this for further restrictions, like disabling direct
820 * [[media:...]] links for non-trusted formats.
822 $wgTrustedMediaFormats = array(
823 MEDIATYPE_BITMAP
, //all bitmap formats
824 MEDIATYPE_AUDIO
, //all audio formats
825 MEDIATYPE_VIDEO
, //all plain video formats
826 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
827 "application/pdf", //PDF files
828 #"application/x-shockwave-flash", //flash/shockwave movie
832 * Plugins for media file type handling.
833 * Each entry in the array maps a MIME type to a class name
835 $wgMediaHandlers = array(
836 'image/jpeg' => 'JpegHandler',
837 'image/png' => 'PNGHandler',
838 'image/gif' => 'GIFHandler',
839 'image/tiff' => 'TiffHandler',
840 'image/x-ms-bmp' => 'BmpHandler',
841 'image/x-bmp' => 'BmpHandler',
842 'image/x-xcf' => 'XCFHandler',
843 'image/svg+xml' => 'SvgHandler', // official
844 'image/svg' => 'SvgHandler', // compat
845 'image/vnd.djvu' => 'DjVuHandler', // official
846 'image/x.djvu' => 'DjVuHandler', // compat
847 'image/x-djvu' => 'DjVuHandler', // compat
851 * Plugins for page content model handling.
852 * Each entry in the array maps a model id to a class name.
856 $wgContentHandlers = array(
858 CONTENT_MODEL_WIKITEXT
=> 'WikitextContentHandler',
859 // dumb version, no syntax highlighting
860 CONTENT_MODEL_JAVASCRIPT
=> 'JavaScriptContentHandler',
861 // dumb version, no syntax highlighting
862 CONTENT_MODEL_CSS
=> 'CssContentHandler',
863 // plain text, for use by extensions etc
864 CONTENT_MODEL_TEXT
=> 'TextContentHandler',
868 * Whether to enable server-side image thumbnailing. If false, images will
869 * always be sent to the client in full resolution, with appropriate width= and
870 * height= attributes on the <img> tag for the client to do its own scaling.
872 $wgUseImageResize = true;
875 * Resizing can be done using PHP's internal image libraries or using
876 * ImageMagick or another third-party converter, e.g. GraphicMagick.
877 * These support more file formats than PHP, which only supports PNG,
878 * GIF, JPG, XBM and WBMP.
880 * Use Image Magick instead of PHP builtin functions.
882 $wgUseImageMagick = false;
885 * The convert command shipped with ImageMagick
887 $wgImageMagickConvertCommand = '/usr/bin/convert';
890 * Sharpening parameter to ImageMagick
892 $wgSharpenParameter = '0x0.4';
895 * Reduction in linear dimensions below which sharpening will be enabled
897 $wgSharpenReductionThreshold = 0.85;
900 * Temporary directory used for ImageMagick. The directory must exist. Leave
901 * this set to false to let ImageMagick decide for itself.
903 $wgImageMagickTempDir = false;
906 * Use another resizing converter, e.g. GraphicMagick
907 * %s will be replaced with the source path, %d with the destination
908 * %w and %h will be replaced with the width and height.
910 * @par Example for GraphicMagick:
912 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
915 * Leave as false to skip this.
917 $wgCustomConvertCommand = false;
920 * used for lossless jpeg rotation
924 $wgJpegTran = '/usr/bin/jpegtran';
927 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
930 $wgExiv2Command = '/usr/bin/exiv2';
933 * Scalable Vector Graphics (SVG) may be uploaded as images.
934 * Since SVG support is not yet standard in browsers, it is
935 * necessary to rasterize SVGs to PNG as a fallback format.
937 * An external program is required to perform this conversion.
938 * If set to an array, the first item is a PHP callable and any further items
939 * are passed as parameters after $srcPath, $dstPath, $width, $height
941 $wgSVGConverters = array(
942 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
943 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
944 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
945 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
947 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
948 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
949 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
953 * Pick a converter defined in $wgSVGConverters
955 $wgSVGConverter = 'ImageMagick';
958 * If not in the executable PATH, specify the SVG converter path.
960 $wgSVGConverterPath = '';
963 * Don't scale a SVG larger than this
965 $wgSVGMaxSize = 2048;
968 * Don't read SVG metadata beyond this point.
969 * Default is 1024*256 bytes
971 $wgSVGMetadataCutoff = 262144;
974 * Disallow <title> element in SVG files.
976 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
977 * browsers which can not perform basic stuff like MIME detection and which are
978 * vulnerable to further idiots uploading crap files as images.
980 * When this directive is on, "<title>" will be allowed in files with an
981 * "image/svg+xml" MIME type. You should leave this disabled if your web server
982 * is misconfigured and doesn't send appropriate MIME types for SVG images.
984 $wgAllowTitlesInSVG = false;
987 * The maximum number of pixels a source image can have if it is to be scaled
988 * down by a scaler that requires the full source image to be decompressed
989 * and stored in decompressed form, before the thumbnail is generated.
991 * This provides a limit on memory usage for the decompression side of the
992 * image scaler. The limit is used when scaling PNGs with any of the
993 * built-in image scalers, such as ImageMagick or GD. It is ignored for
994 * JPEGs with ImageMagick, and when using the VipsScaler extension.
996 * The default is 50 MB if decompressed to RGBA form, which corresponds to
997 * 12.5 million pixels or 3500x3500.
999 $wgMaxImageArea = 1.25e7
;
1002 * Force thumbnailing of animated GIFs above this size to a single
1003 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1004 * is checked against the total size of all frames in the animation.
1005 * It probably makes sense to keep this equal to $wgMaxImageArea.
1007 $wgMaxAnimatedGifArea = 1.25e7
;
1010 * Browsers don't support TIFF inline generally...
1011 * For inline display, we need to convert to PNG or JPEG.
1012 * Note scaling should work with ImageMagick, but may not with GD scaling.
1016 * // PNG is lossless, but inefficient for photos
1017 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1018 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1019 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1022 $wgTiffThumbnailType = false;
1025 * If rendered thumbnail files are older than this timestamp, they
1026 * will be rerendered on demand as if the file didn't already exist.
1027 * Update if there is some need to force thumbs and SVG rasterizations
1028 * to rerender, such as fixes to rendering bugs.
1030 $wgThumbnailEpoch = '20030516000000';
1033 * Certain operations are avoided if there were too many recent failures,
1034 * for example, thumbnail generation. Bump this value to invalidate all
1035 * memory of failed operations and thus allow further attempts to resume.
1036 * This is useful when a cause for the failures has been found and fixed.
1038 $wgAttemptFailureEpoch = 1;
1041 * If set, inline scaled images will still produce "<img>" tags ready for
1042 * output instead of showing an error message.
1044 * This may be useful if errors are transitory, especially if the site
1045 * is configured to automatically render thumbnails on request.
1047 * On the other hand, it may obscure error conditions from debugging.
1048 * Enable the debug log or the 'thumbnail' log group to make sure errors
1049 * are logged to a file for review.
1051 $wgIgnoreImageErrors = false;
1054 * Allow thumbnail rendering on page view. If this is false, a valid
1055 * thumbnail URL is still output, but no file will be created at
1056 * the target location. This may save some time if you have a
1057 * thumb.php or 404 handler set up which is faster than the regular
1060 $wgGenerateThumbnailOnParse = true;
1063 * Show thumbnails for old images on the image description page
1065 $wgShowArchiveThumbnails = true;
1068 * If set to true, images that contain certain the exif orientation tag will
1069 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1070 * is available that can rotate.
1072 $wgEnableAutoRotation = null;
1075 * Internal name of virus scanner. This serves as a key to the
1076 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1077 * null, every file uploaded will be scanned for viruses.
1079 $wgAntivirus = null;
1082 * Configuration for different virus scanners. This an associative array of
1083 * associative arrays. It contains one setup array per known scanner type.
1084 * The entry is selected by $wgAntivirus, i.e.
1085 * valid values for $wgAntivirus are the keys defined in this array.
1087 * The configuration array for each scanner contains the following keys:
1088 * "command", "codemap", "messagepattern":
1090 * "command" is the full command to call the virus scanner - %f will be
1091 * replaced with the name of the file to scan. If not present, the filename
1092 * will be appended to the command. Note that this must be overwritten if the
1093 * scanner is not in the system path; in that case, please set
1094 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1097 * "codemap" is a mapping of exit code to return codes of the detectVirus
1098 * function in SpecialUpload.
1099 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1100 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1102 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1103 * the file to have an unsupported format, which is probably immune to
1104 * viruses. This causes the file to pass.
1105 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1106 * no virus was found.
1107 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1109 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1111 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1112 * output. The relevant part should be matched as group one (\1).
1113 * If not defined or the pattern does not match, the full message is shown to the user.
1115 $wgAntivirusSetup = array(
1119 'command' => 'clamscan --no-summary ',
1121 "0" => AV_NO_VIRUS
, # no virus
1122 "1" => AV_VIRUS_FOUND
, # virus found
1123 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1124 "*" => AV_SCAN_FAILED
, # else scan failed
1126 'messagepattern' => '/.*?:(.*)/sim',
1131 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1133 $wgAntivirusRequired = true;
1136 * Determines if the mime type of uploaded files should be checked
1138 $wgVerifyMimeType = true;
1141 * Sets the mime type definition file to use by MimeMagic.php.
1142 * Set to null, to use built-in defaults only.
1143 * example: $wgMimeTypeFile = '/etc/mime.types';
1145 $wgMimeTypeFile = 'includes/mime.types';
1148 * Sets the mime type info file to use by MimeMagic.php.
1149 * Set to null, to use built-in defaults only.
1151 $wgMimeInfoFile = 'includes/mime.info';
1154 * Sets an external mime detector program. The command must print only
1155 * the mime type to standard output.
1156 * The name of the file to process will be appended to the command given here.
1157 * If not set or NULL, mime_content_type will be used if available.
1161 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
1164 $wgMimeDetectorCommand = null;
1167 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
1168 * things, because only a few types of images are needed and file extensions
1171 $wgTrivialMimeDetection = false;
1174 * Additional XML types we can allow via mime-detection.
1175 * array = ( 'rootElement' => 'associatedMimeType' )
1177 $wgXMLMimeTypes = array(
1178 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1179 'svg' => 'image/svg+xml',
1180 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1181 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1182 'html' => 'text/html', // application/xhtml+xml?
1186 * Limit images on image description pages to a user-selectable limit. In order
1187 * to reduce disk usage, limits can only be selected from a list.
1188 * The user preference is saved as an array offset in the database, by default
1189 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1190 * change it if you alter the array (see bug 8858).
1191 * This is the list of settings the user can choose from:
1193 $wgImageLimits = array(
1202 * Adjust thumbnails on image pages according to a user setting. In order to
1203 * reduce disk usage, the values can only be selected from a list. This is the
1204 * list of settings the user can choose from:
1206 $wgThumbLimits = array(
1216 * When defined, is an array of image widths used as buckets for thumbnail generation.
1217 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1218 * always using the original. This will incur a speed gain but cause a quality loss.
1220 * The buckets generation is chained, with each bucket generated based on the above bucket
1221 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1224 $wgThumbnailBuckets = null;
1227 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1228 * above the requested size. The distance represents how many extra pixels of width the bucket
1229 * needs in order to be used as the reference for a given thumbnail. For example, with the
1230 * following buckets:
1232 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1234 * and a distance of 50:
1236 * $wgThumbnailMinimumBucketDistance = 50;
1238 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1239 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1241 $wgThumbnailMinimumBucketDistance = 50;
1244 * Default parameters for the "<gallery>" tag
1246 $wgGalleryOptions = array(
1247 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1248 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1249 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1250 'captionLength' => 25, // Length of caption to truncate (in characters)
1251 'showBytes' => true, // Show the filesize in bytes in categories
1252 'mode' => 'traditional',
1256 * Adjust width of upright images when parameter 'upright' is used
1257 * This allows a nicer look for upright images without the need to fix the width
1258 * by hardcoded px in wiki sourcecode.
1260 $wgThumbUpright = 0.75;
1263 * Default value for chmoding of new directories.
1265 $wgDirectoryMode = 0777;
1268 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1270 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1271 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1272 * images in after loading the original low-resolution versions depending on the reported
1273 * window.devicePixelRatio.
1275 $wgResponsiveImages = true;
1278 * @name DJVU settings
1283 * Path of the djvudump executable
1284 * Enable this and $wgDjvuRenderer to enable djvu rendering
1285 * example: $wgDjvuDump = 'djvudump';
1290 * Path of the ddjvu DJVU renderer
1291 * Enable this and $wgDjvuDump to enable djvu rendering
1292 * example: $wgDjvuRenderer = 'ddjvu';
1294 $wgDjvuRenderer = null;
1297 * Path of the djvutxt DJVU text extraction utility
1298 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1299 * example: $wgDjvuTxt = 'djvutxt';
1304 * Path of the djvutoxml executable
1305 * This works like djvudump except much, much slower as of version 3.5.
1307 * For now we recommend you use djvudump instead. The djvuxml output is
1308 * probably more stable, so we'll switch back to it as soon as they fix
1309 * the efficiency problem.
1310 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1314 * $wgDjvuToXML = 'djvutoxml';
1317 $wgDjvuToXML = null;
1320 * Shell command for the DJVU post processor
1321 * Default: pnmtojpeg, since ddjvu generates ppm output
1322 * Set this to false to output the ppm file directly.
1324 $wgDjvuPostProcessor = 'pnmtojpeg';
1327 * File extension for the DJVU post processor output
1329 $wgDjvuOutputExtension = 'jpg';
1331 /** @} */ # end of DJvu }
1333 /** @} */ # end of file uploads }
1335 /************************************************************************//**
1336 * @name Email settings
1342 * Site admin email address.
1344 * Defaults to "wikiadmin@{$wgServerName}".
1346 $wgEmergencyContact = false;
1349 * Password reminder email address.
1351 * The address we should use as sender when a user is requesting his password.
1353 * Defaults to "apache@{$wgServerName}".
1355 $wgPasswordSender = false;
1358 * Password reminder name
1360 * @deprecated since 1.23; use the system message 'emailsender' instead.
1362 $wgPasswordSenderName = 'MediaWiki Mail';
1365 * Dummy address which should be accepted during mail send action.
1366 * It might be necessary to adapt the address or to set it equal
1367 * to the $wgEmergencyContact address.
1369 $wgNoReplyAddress = 'reply@not.possible';
1372 * Set to true to enable the e-mail basic features:
1373 * Password reminders, etc. If sending e-mail on your
1374 * server doesn't work, you might want to disable this.
1376 $wgEnableEmail = true;
1379 * Set to true to enable user-to-user e-mail.
1380 * This can potentially be abused, as it's hard to track.
1382 $wgEnableUserEmail = true;
1385 * Set to true to put the sending user's email in a Reply-To header
1386 * instead of From. ($wgEmergencyContact will be used as From.)
1388 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1389 * which can cause problems with SPF validation and leak recipient addresses
1390 * when bounces are sent to the sender.
1392 $wgUserEmailUseReplyTo = false;
1395 * Minimum time, in hours, which must elapse between password reminder
1396 * emails for a given account. This is to prevent abuse by mail flooding.
1398 $wgPasswordReminderResendTime = 24;
1401 * The time, in seconds, when an emailed temporary password expires.
1403 $wgNewPasswordExpiry = 3600 * 24 * 7;
1406 * The time, in seconds, when an email confirmation email expires
1408 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1411 * The number of days that a user's password is good for. After this number of days, the
1412 * user will be asked to reset their password. Set to false to disable password expiration.
1414 $wgPasswordExpirationDays = false;
1417 * If a user's password is expired, the number of seconds when they can still login,
1418 * and cancel their password change, but are sent to the password change form on each login.
1420 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1425 * For using a direct (authenticated) SMTP server connection.
1426 * Default to false or fill an array :
1430 * 'host' => 'SMTP domain',
1431 * 'IDHost' => 'domain for MessageID',
1433 * 'auth' => [true|false],
1434 * 'username' => [SMTP username],
1435 * 'password' => [SMTP password],
1442 * Additional email parameters, will be passed as the last argument to mail() call.
1443 * If using safe_mode this has no effect
1445 $wgAdditionalMailParams = null;
1448 * For parts of the system that have been updated to provide HTML email content, send
1449 * both text and HTML parts as the body of the email
1451 $wgAllowHTMLEmail = false;
1454 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1455 * from $wgEmergencyContact
1457 $wgEnotifFromEditor = false;
1459 // TODO move UPO to preferences probably ?
1460 # If set to true, users get a corresponding option in their preferences and can choose to
1461 # enable or disable at their discretion
1462 # If set to false, the corresponding input form on the user preference page is suppressed
1463 # It call this to be a "user-preferences-option (UPO)"
1466 * Require email authentication before sending mail to an email address.
1467 * This is highly recommended. It prevents MediaWiki from being used as an open
1470 $wgEmailAuthentication = true;
1473 * Allow users to enable email notification ("enotif") on watchlist changes.
1475 $wgEnotifWatchlist = false;
1478 * Allow users to enable email notification ("enotif") when someone edits their
1481 $wgEnotifUserTalk = false;
1484 * Set the Reply-to address in notifications to the editor's address, if user
1485 * allowed this in the preferences.
1487 $wgEnotifRevealEditorAddress = false;
1490 * Send notification mails on minor edits to watchlist pages. This is enabled
1491 * by default. Does not affect user talk notifications.
1493 $wgEnotifMinorEdits = true;
1496 * Send a generic mail instead of a personalised mail for each user. This
1497 * always uses UTC as the time zone, and doesn't include the username.
1499 * For pages with many users watching, this can significantly reduce mail load.
1500 * Has no effect when using sendmail rather than SMTP.
1502 $wgEnotifImpersonal = false;
1505 * Maximum number of users to mail at once when using impersonal mail. Should
1506 * match the limit on your mail server.
1508 $wgEnotifMaxRecips = 500;
1511 * Send mails via the job queue. This can be useful to reduce the time it
1512 * takes to save a page that a lot of people are watching.
1514 $wgEnotifUseJobQ = false;
1517 * Use real name instead of username in e-mail "from" field.
1519 $wgEnotifUseRealName = false;
1522 * Array of usernames who will be sent a notification email for every change
1523 * which occurs on a wiki. Users will not be notified of their own changes.
1525 $wgUsersNotifiedOnAllChanges = array();
1527 /** @} */ # end of email settings
1529 /************************************************************************//**
1530 * @name Database settings
1535 * Database host name or IP address
1537 $wgDBserver = 'localhost';
1540 * Database port number (for PostgreSQL and Microsoft SQL Server).
1545 * Name of the database
1547 $wgDBname = 'my_wiki';
1552 $wgDBuser = 'wikiuser';
1555 * Database user's password
1562 $wgDBtype = 'mysql';
1565 * Whether to use SSL in DB connection.
1567 * This setting is only used $wgLBFactoryConf['class'] is set to
1568 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1569 * the DBO_SSL flag must be set in the 'flags' option of the database
1570 * connection to achieve the same functionality.
1575 * Whether to use compression in DB connection.
1577 * This setting is only used $wgLBFactoryConf['class'] is set to
1578 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1579 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1580 * connection to achieve the same functionality.
1582 $wgDBcompress = false;
1585 * Separate username for maintenance tasks. Leave as null to use the default.
1587 $wgDBadminuser = null;
1590 * Separate password for maintenance tasks. Leave as null to use the default.
1592 $wgDBadminpassword = null;
1596 * Leave as null to select the default search engine for the
1597 * selected database type (eg SearchMySQL), or set to a class
1598 * name to override to a custom search engine.
1600 $wgSearchType = null;
1603 * Alternative search types
1604 * Sometimes you want to support multiple search engines for testing. This
1605 * allows users to select their search engine of choice via url parameters
1606 * to Special:Search and the action=search API. If using this, there's no
1607 * need to add $wgSearchType to it, that is handled automatically.
1609 $wgSearchTypeAlternatives = null;
1617 * MySQL table options to use during installation or update
1619 $wgDBTableOptions = 'ENGINE=InnoDB';
1622 * SQL Mode - default is turning off all modes, including strict, if set.
1623 * null can be used to skip the setting for performance reasons and assume
1624 * DBA has done his best job.
1625 * String override can be used for some additional fun :-)
1632 $wgDBmwschema = null;
1635 * To override default SQLite data directory ($docroot/../data)
1637 $wgSQLiteDataDir = '';
1640 * Make all database connections secretly go to localhost. Fool the load balancer
1641 * thinking there is an arbitrarily large cluster of servers to connect to.
1642 * Useful for debugging.
1644 $wgAllDBsAreLocalhost = false;
1647 * Shared database for multiple wikis. Commonly used for storing a user table
1648 * for single sign-on. The server for this database must be the same as for the
1651 * For backwards compatibility the shared prefix is set to the same as the local
1652 * prefix, and the user table is listed in the default list of shared tables.
1653 * The user_properties table is also added so that users will continue to have their
1654 * preferences shared (preferences were stored in the user table prior to 1.16)
1656 * $wgSharedTables may be customized with a list of tables to share in the shared
1657 * database. However it is advised to limit what tables you do share as many of
1658 * MediaWiki's tables may have side effects if you try to share them.
1660 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1663 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1664 * access remote databases. Using wfGetLB() allows the shared database to
1665 * reside on separate servers to the wiki's own database, with suitable
1666 * configuration of $wgLBFactoryConf.
1673 $wgSharedPrefix = false;
1678 $wgSharedTables = array( 'user', 'user_properties' );
1681 * Database load balancer
1682 * This is a two-dimensional array, an array of server info structures
1685 * - dbname: Default database name
1687 * - password: DB password
1690 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1691 * If this is zero for any given server, no normal query traffic will be
1692 * sent to it. It will be excluded from lag checks in maintenance scripts.
1693 * The only way it can receive traffic is if groupLoads is used.
1695 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1696 * to several groups, the most specific group defined here is used.
1698 * - flags: bit field
1699 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1700 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1701 * - DBO_TRX -- wrap entire request in a transaction
1702 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1703 * - DBO_PERSISTENT -- enables persistent database connections
1704 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1705 * - DBO_COMPRESS -- uses internal compression in database connections,
1708 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1710 * These and any other user-defined properties will be assigned to the mLBInfo member
1711 * variable of the Database object.
1713 * Leave at false to use the single-server variables above. If you set this
1714 * variable, the single-server variables will generally be ignored (except
1715 * perhaps in some command-line scripts).
1717 * The first server listed in this array (with key 0) will be the master. The
1718 * rest of the servers will be slaves. To prevent writes to your slaves due to
1719 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1720 * slaves in my.cnf. You can set read_only mode at runtime using:
1723 * SET @@read_only=1;
1726 * Since the effect of writing to a slave is so damaging and difficult to clean
1727 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1728 * our masters, and then set read_only=0 on masters at runtime.
1730 $wgDBservers = false;
1733 * Load balancer factory configuration
1734 * To set up a multi-master wiki farm, set the class here to something that
1735 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1736 * The class identified here is responsible for reading $wgDBservers,
1737 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1739 * The LBFactoryMulti class is provided for this purpose, please see
1740 * includes/db/LBFactoryMulti.php for configuration information.
1742 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1745 * How long to wait for a slave to catch up to the master
1746 * @deprecated since 1.24
1748 $wgMasterWaitTimeout = 10;
1751 * File to log database errors to
1753 $wgDBerrorLog = false;
1756 * Timezone to use in the error log.
1757 * Defaults to the wiki timezone ($wgLocaltimezone).
1759 * A list of usable timezones can found at:
1760 * http://php.net/manual/en/timezones.php
1764 * $wgLocaltimezone = 'UTC';
1765 * $wgLocaltimezone = 'GMT';
1766 * $wgLocaltimezone = 'PST8PDT';
1767 * $wgLocaltimezone = 'Europe/Sweden';
1768 * $wgLocaltimezone = 'CET';
1773 $wgDBerrorLogTZ = false;
1776 * Scale load balancer polling time so that under overload conditions, the
1777 * database server receives a SHOW STATUS query at an average interval of this
1780 $wgDBAvgStatusPoll = 2000;
1783 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1784 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1786 * @warning THIS IS EXPERIMENTAL!
1788 * May break if you're not using the table defs from mysql5/tables.sql.
1789 * May break if you're upgrading an existing wiki if set differently.
1790 * Broken symptoms likely to include incorrect behavior with page titles,
1791 * usernames, comments etc containing non-ASCII characters.
1792 * Might also cause failures on the object cache and other things.
1794 * Even correct usage may cause failures with Unicode supplementary
1795 * characters (those not in the Basic Multilingual Plane) unless MySQL
1796 * has enhanced their Unicode support.
1798 $wgDBmysql5 = false;
1801 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1803 * To use this feature set to true and use a datasource defined as
1804 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1807 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1808 * Pool) that maintains established sessions and reuses them on new
1811 * Not completely tested, but it should fall back on normal connection
1812 * in case the pool is full or the datasource is not configured as
1814 * And the other way around; using oci_pconnect on a non pooled
1815 * datasource should produce a normal connection.
1817 * When it comes to frequent shortlived DB connections like with MW
1818 * Oracle tends to s***. The problem is the driver connects to the
1819 * database reasonably fast, but establishing a session takes time and
1820 * resources. MW does not rely on session state (as it does not use
1821 * features such as package variables) so establishing a valid session
1822 * is in this case an unwanted overhead that just slows things down.
1824 * @warning EXPERIMENTAL!
1827 $wgDBOracleDRCP = false;
1830 * Other wikis on this site, can be administered from a single developer
1832 * Array numeric key => database name
1834 $wgLocalDatabases = array();
1837 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1838 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1839 * show a more obvious warning.
1841 $wgSlaveLagWarning = 10;
1844 * @see $wgSlaveLagWarning
1846 $wgSlaveLagCritical = 30;
1849 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1851 $wgDBWindowsAuthentication = false;
1853 /**@}*/ # End of DB settings }
1855 /************************************************************************//**
1856 * @name Text storage
1861 * We can also compress text stored in the 'text' table. If this is set on, new
1862 * revisions will be compressed on page save if zlib support is available. Any
1863 * compressed revisions will be decompressed on load regardless of this setting,
1864 * but will not be readable at all* if zlib support is not available.
1866 $wgCompressRevisions = false;
1869 * External stores allow including content
1870 * from non database sources following URL links.
1872 * Short names of ExternalStore classes may be specified in an array here:
1874 * $wgExternalStores = array("http","file","custom")...
1877 * CAUTION: Access to database might lead to code execution
1879 $wgExternalStores = array();
1882 * An array of external MySQL servers.
1885 * Create a cluster named 'cluster1' containing three servers:
1887 * $wgExternalServers = array(
1888 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1892 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1895 $wgExternalServers = array();
1898 * The place to put new revisions, false to put them in the local text table.
1899 * Part of a URL, e.g. DB://cluster1
1901 * Can be an array instead of a single string, to enable data distribution. Keys
1902 * must be consecutive integers, starting at zero.
1906 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1911 $wgDefaultExternalStore = false;
1914 * Revision text may be cached in $wgMemc to reduce load on external storage
1915 * servers and object extraction overhead for frequently-loaded revisions.
1917 * Set to 0 to disable, or number of seconds before cache expiry.
1919 $wgRevisionCacheExpiry = 0;
1921 /** @} */ # end text storage }
1923 /************************************************************************//**
1924 * @name Performance hacks and limits
1929 * Disable database-intensive features
1931 $wgMiserMode = false;
1934 * Disable all query pages if miser mode is on, not just some
1936 $wgDisableQueryPages = false;
1939 * Number of rows to cache in 'querycache' table when miser mode is on
1941 $wgQueryCacheLimit = 1000;
1944 * Number of links to a page required before it is deemed "wanted"
1946 $wgWantedPagesThreshold = 1;
1949 * Enable slow parser functions
1951 $wgAllowSlowParserFunctions = false;
1954 * Allow schema updates
1956 $wgAllowSchemaUpdates = true;
1959 * Anti-lock flags - bitfield
1960 * - ALF_NO_LINK_LOCK:
1961 * Don't use locking reads when updating the link table. This is
1962 * necessary for wikis with a high edit rate for performance
1963 * reasons, but may cause link table inconsistency
1965 $wgAntiLockFlags = 0;
1968 * Maximum article size in kilobytes
1970 $wgMaxArticleSize = 2048;
1973 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1974 * raise PHP's memory limit if it's below this amount.
1976 $wgMemoryLimit = "50M";
1978 /** @} */ # end performance hacks }
1980 /************************************************************************//**
1981 * @name Cache settings
1986 * Directory for caching data in the local filesystem. Should not be accessible
1987 * from the web. Set this to false to not use any local caches.
1989 * Note: if multiple wikis share the same localisation cache directory, they
1990 * must all have the same set of extensions. You can set a directory just for
1991 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1993 $wgCacheDirectory = false;
1996 * Main cache type. This should be a cache with fast access, but it may have
1997 * limited space. By default, it is disabled, since the database is not fast
1998 * enough to make it worthwhile.
2002 * - CACHE_ANYTHING: Use anything, as long as it works
2003 * - CACHE_NONE: Do not cache
2004 * - CACHE_DB: Store cache objects in the DB
2005 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2006 * - CACHE_ACCEL: APC, XCache or WinCache
2007 * - (other): A string may be used which identifies a cache
2008 * configuration in $wgObjectCaches.
2010 * @see $wgMessageCacheType, $wgParserCacheType
2012 $wgMainCacheType = CACHE_NONE
;
2015 * The cache type for storing the contents of the MediaWiki namespace. This
2016 * cache is used for a small amount of data which is expensive to regenerate.
2018 * For available types see $wgMainCacheType.
2020 $wgMessageCacheType = CACHE_ANYTHING
;
2023 * The cache type for storing article HTML. This is used to store data which
2024 * is expensive to regenerate, and benefits from having plenty of storage space.
2026 * For available types see $wgMainCacheType.
2028 $wgParserCacheType = CACHE_ANYTHING
;
2031 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2033 * For available types see $wgMainCacheType.
2035 $wgSessionCacheType = CACHE_ANYTHING
;
2038 * The cache type for storing language conversion tables,
2039 * which are used when parsing certain text and interface messages.
2041 * For available types see $wgMainCacheType.
2045 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2048 * Advanced object cache configuration.
2050 * Use this to define the class names and constructor parameters which are used
2051 * for the various cache types. Custom cache types may be defined here and
2052 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2053 * or $wgLanguageConverterCacheType.
2055 * The format is an associative array where the key is a cache identifier, and
2056 * the value is an associative array of parameters. The "class" parameter is the
2057 * class name which will be used. Alternatively, a "factory" parameter may be
2058 * given, giving a callable function which will generate a suitable cache object.
2060 $wgObjectCaches = array(
2061 CACHE_NONE
=> array( 'class' => 'EmptyBagOStuff' ),
2062 CACHE_DB
=> array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
2064 CACHE_ANYTHING
=> array( 'factory' => 'ObjectCache::newAnything' ),
2065 CACHE_ACCEL
=> array( 'factory' => 'ObjectCache::newAccelerator' ),
2066 CACHE_MEMCACHED
=> array( 'factory' => 'ObjectCache::newMemcached' ),
2068 'apc' => array( 'class' => 'APCBagOStuff' ),
2069 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2070 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2071 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2072 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2073 'hash' => array( 'class' => 'HashBagOStuff' ),
2077 * The expiry time for the parser cache, in seconds.
2078 * The default is 86400 (one day).
2080 $wgParserCacheExpireTime = 86400;
2083 * Deprecated alias for $wgSessionsInObjectCache.
2085 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2087 $wgSessionsInMemcached = false;
2090 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2091 * can be useful to improve performance, or to avoid the locking behavior of
2092 * PHP's default session handler, which tends to prevent multiple requests for
2093 * the same user from acting concurrently.
2095 $wgSessionsInObjectCache = false;
2098 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2099 * enabled, in seconds.
2101 $wgObjectCacheSessionExpiry = 3600;
2104 * This is used for setting php's session.save_handler. In practice, you will
2105 * almost never need to change this ever. Other options might be 'user' or
2106 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2107 * useful if you're doing cross-application sessions, see bug 11381)
2109 $wgSessionHandler = null;
2112 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2114 $wgMemCachedDebug = false;
2117 * The list of MemCached servers and port numbers
2119 $wgMemCachedServers = array( '127.0.0.1:11211' );
2122 * Use persistent connections to MemCached, which are shared across multiple
2125 $wgMemCachedPersistent = false;
2128 * Read/write timeout for MemCached server communication, in microseconds.
2130 $wgMemCachedTimeout = 500000;
2133 * Set this to true to make a local copy of the message cache, for use in
2134 * addition to memcached. The files will be put in $wgCacheDirectory.
2136 $wgUseLocalMessageCache = false;
2139 * Instead of caching everything, only cache those messages which have
2140 * been customised in the site content language. This means that
2141 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2142 * This option is probably only useful for translatewiki.net.
2144 $wgAdaptiveMessageCache = false;
2147 * Localisation cache configuration. Associative array with keys:
2148 * class: The class to use. May be overridden by extensions.
2150 * store: The location to store cache data. May be 'files', 'db' or
2151 * 'detect'. If set to "files", data will be in CDB files. If set
2152 * to "db", data will be stored to the database. If set to
2153 * "detect", files will be used if $wgCacheDirectory is set,
2154 * otherwise the database will be used.
2156 * storeClass: The class name for the underlying storage. If set to a class
2157 * name, it overrides the "store" setting.
2159 * storeDirectory: If the store class puts its data in files, this is the
2160 * directory it will use. If this is false, $wgCacheDirectory
2163 * manualRecache: Set this to true to disable cache updates on web requests.
2164 * Use maintenance/rebuildLocalisationCache.php instead.
2166 $wgLocalisationCacheConf = array(
2167 'class' => 'LocalisationCache',
2168 'store' => 'detect',
2169 'storeClass' => false,
2170 'storeDirectory' => false,
2171 'manualRecache' => false,
2175 * Allow client-side caching of pages
2177 $wgCachePages = true;
2180 * Set this to current time to invalidate all prior cached pages. Affects both
2181 * client-side and server-side caching.
2182 * You can get the current date on your server by using the command:
2184 * date +%Y%m%d%H%M%S
2187 $wgCacheEpoch = '20030516000000';
2190 * Directory where GitInfo will look for pre-computed cache files. If false,
2191 * $wgCacheDirectory/gitinfo will be used.
2193 $wgGitInfoCacheDirectory = false;
2196 * Bump this number when changing the global style sheets and JavaScript.
2198 * It should be appended in the query string of static CSS and JS includes,
2199 * to ensure that client-side caches do not keep obsolete copies of global
2202 $wgStyleVersion = '303';
2205 * This will cache static pages for non-logged-in users to reduce
2206 * database traffic on public sites.
2207 * Automatically sets $wgShowIPinHeader = false
2208 * ResourceLoader requests to default language and skins are cached
2209 * as well as single module requests.
2211 $wgUseFileCache = false;
2214 * Depth of the subdirectory hierarchy to be created under
2215 * $wgFileCacheDirectory. The subdirectories will be named based on
2216 * the MD5 hash of the title. A value of 0 means all cache files will
2217 * be put directly into the main file cache directory.
2219 $wgFileCacheDepth = 2;
2222 * Keep parsed pages in a cache (objectcache table or memcached)
2223 * to speed up output of the same page viewed by another user with the
2226 * This can provide a significant speedup for medium to large pages,
2227 * so you probably want to keep it on. Extensions that conflict with the
2228 * parser cache should disable the cache on a per-page basis instead.
2230 $wgEnableParserCache = true;
2233 * Append a configured value to the parser cache and the sitenotice key so
2234 * that they can be kept separate for some class of activity.
2236 $wgRenderHashAppend = '';
2239 * If on, the sidebar navigation links are cached for users with the
2240 * current language set. This can save a touch of load on a busy site
2241 * by shaving off extra message lookups.
2243 * However it is also fragile: changing the site configuration, or
2244 * having a variable $wgArticlePath, can produce broken links that
2245 * don't update as expected.
2247 $wgEnableSidebarCache = false;
2250 * Expiry time for the sidebar cache, in seconds
2252 $wgSidebarCacheExpiry = 86400;
2255 * When using the file cache, we can store the cached HTML gzipped to save disk
2256 * space. Pages will then also be served compressed to clients that support it.
2258 * Requires zlib support enabled in PHP.
2263 * Whether MediaWiki should send an ETag header. Seems to cause
2264 * broken behavior with Squid 2.6, see bug 7098.
2269 * Clock skew or the one-second resolution of time() can occasionally cause cache
2270 * problems when the user requests two pages within a short period of time. This
2271 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2274 $wgClockSkewFudge = 5;
2277 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2278 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2279 * was previously done in the default LocalSettings.php file.
2281 * On high-traffic wikis, this should be set to false, to avoid the need to
2282 * check the file modification time, and to avoid the performance impact of
2283 * unnecessary cache invalidations.
2285 $wgInvalidateCacheOnLocalSettingsChange = true;
2287 /** @} */ # end of cache settings
2289 /************************************************************************//**
2290 * @name HTTP proxy (Squid) settings
2292 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2293 * although they are referred to as Squid settings for historical reasons.
2295 * Achieving a high hit ratio with an HTTP proxy requires special
2296 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2303 * Enable/disable Squid.
2304 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2306 $wgUseSquid = false;
2309 * If you run Squid3 with ESI support, enable this (default:false):
2314 * Send X-Vary-Options header for better caching (requires patched Squid)
2319 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2320 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2321 * and need to split the cache between HTTP and HTTPS for API requests,
2322 * feed requests and HTTP redirect responses in order to prevent cache
2323 * pollution. This does not affect 'normal' requests to index.php other than
2326 $wgVaryOnXFP = false;
2329 * Internal server name as known to Squid, if different.
2333 * $wgInternalServer = 'http://yourinternal.tld:8000';
2336 $wgInternalServer = false;
2339 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2340 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2341 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2344 $wgSquidMaxage = 18000;
2347 * Default maximum age for raw CSS/JS accesses
2349 $wgForcedRawSMaxage = 300;
2352 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2354 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2355 * headers sent/modified from these proxies when obtaining the remote IP address
2357 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2359 $wgSquidServers = array();
2362 * As above, except these servers aren't purged on page changes; use to set a
2363 * list of trusted proxies, etc. Supports both individual IP addresses and
2365 * @since 1.23 Supports CIDR ranges
2367 $wgSquidServersNoPurge = array();
2370 * Maximum number of titles to purge in any one client operation
2372 $wgMaxSquidPurgeTitles = 400;
2375 * Whether to use a Host header in purge requests sent to the proxy servers
2376 * configured in $wgSquidServers. Set this to false to support Squid
2377 * configured in forward-proxy mode.
2379 * If this is set to true, a Host header will be sent, and only the path
2380 * component of the URL will appear on the request line, as if the request
2381 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2382 * request. Squid supports this style of request only if reverse-proxy mode
2383 * (http_port ... accel) is enabled.
2385 * If this is set to false, no Host header will be sent, and the absolute URL
2386 * will be sent in the request line, as is the standard for an HTTP proxy
2387 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2388 * by Varnish, but is supported by Squid in either configuration (forward or
2393 $wgSquidPurgeUseHostHeader = true;
2396 * Routing configuration for HTCP multicast purging. Add elements here to
2397 * enable HTCP and determine which purges are sent where. If set to an empty
2398 * array, HTCP is disabled.
2400 * Each key in this array is a regular expression to match against the purged
2401 * URL, or an empty string to match all URLs. The purged URL is matched against
2402 * the regexes in the order specified, and the first rule whose regex matches
2403 * is used, all remaining rules will thus be ignored.
2405 * @par Example configuration to send purges for upload.wikimedia.org to one
2406 * multicast group and all other purges to another:
2408 * $wgHTCPRouting = array(
2409 * '|^https?://upload\.wikimedia\.org|' => array(
2410 * 'host' => '239.128.0.113',
2414 * 'host' => '239.128.0.112',
2420 * You can also pass an array of hosts to send purges too. This is useful when
2421 * you have several multicast groups or unicast address that should receive a
2422 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2424 * @par Example of sending purges to multiple hosts:
2426 * $wgHTCPRouting = array(
2428 * // Purges to text caches using multicast
2429 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2430 * // Purges to a hardcoded list of caches
2431 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2432 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2433 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2440 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2441 * For back compatibility purposes, whenever its array is empty
2442 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2444 * @see $wgHTCPMulticastTTL
2446 $wgHTCPRouting = array();
2449 * @deprecated since 1.22, please use $wgHTCPRouting instead.
2451 * Whenever this is set and $wgHTCPRouting evaluates to false, $wgHTCPRouting
2452 * will be set to this value.
2453 * This is merely for back compatibility.
2457 $wgHTCPMulticastRouting = null;
2460 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
2462 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
2463 * present in the earliest Squid implementations of the protocol.
2465 * This setting is DEPRECATED in favor of $wgHTCPRouting , and kept for
2466 * backwards compatibility only. If $wgHTCPRouting is set, this setting is
2467 * ignored. If $wgHTCPRouting is not set and this setting is, it is used to
2468 * populate $wgHTCPRouting.
2470 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2471 * favor of $wgHTCPRouting.
2473 $wgHTCPMulticastAddress = false;
2476 * HTCP multicast port.
2477 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2478 * favor of $wgHTCPRouting.
2480 * @see $wgHTCPMulticastAddress
2485 * HTCP multicast TTL.
2486 * @see $wgHTCPRouting
2488 $wgHTCPMulticastTTL = 1;
2491 * Should forwarded Private IPs be accepted?
2493 $wgUsePrivateIPs = false;
2495 /** @} */ # end of HTTP proxy settings
2497 /************************************************************************//**
2498 * @name Language, regional and character encoding settings
2503 * Site language code. See languages/Names.php for languages supported by
2504 * MediaWiki out of the box. Not all languages listed there have translations,
2505 * see languages/messages/ for the list of languages with some localisation.
2507 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2508 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2510 * This defines the default interface language for all users, but users can
2511 * change it in their preferences.
2513 * This also defines the language of pages in the wiki. The content is wrapped
2514 * in a html element with lang=XX attribute. This behavior can be overridden
2515 * via hooks, see Title::getPageLanguage.
2517 $wgLanguageCode = 'en';
2520 * Language cache size, or really how many languages can we handle
2521 * simultaneously without degrading to crawl speed.
2523 $wgLangObjCacheSize = 10;
2526 * Some languages need different word forms, usually for different cases.
2527 * Used in Language::convertGrammar().
2531 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2534 $wgGrammarForms = array();
2537 * Treat language links as magic connectors, not inline links
2539 $wgInterwikiMagic = true;
2542 * Hide interlanguage links from the sidebar
2544 $wgHideInterlanguageLinks = false;
2547 * List of additional interwiki prefixes that should be treated as
2548 * interlanguage links (i.e. placed in the sidebar).
2550 * - This will not do anything unless the prefixes are defined in the interwiki
2552 * - The display text for these custom interlanguage links will be fetched from
2553 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2555 * - A friendly name for each site, used for tooltip text, may optionally be
2556 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2557 * the prefix in this array.
2559 $wgExtraInterlanguageLinkPrefixes = array();
2562 * List of language names or overrides for default names in Names.php
2564 $wgExtraLanguageNames = array();
2567 * List of language codes that don't correspond to an actual language.
2568 * These codes are mostly left-offs from renames, or other legacy things.
2569 * This array makes them not appear as a selectable language on the installer,
2570 * and excludes them when running the transstat.php script.
2572 $wgDummyLanguageCodes = array(
2575 'be-x-old' => 'be-tarask',
2579 'qqq' => 'qqq', # Used for message documentation.
2580 'qqx' => 'qqx', # Used for viewing message keys.
2583 'zh-classical' => 'lzh',
2584 'zh-min-nan' => 'nan',
2589 * Character set for use in the article edit box. Language-specific encodings
2592 * This historic feature is one of the first that was added by former MediaWiki
2593 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2595 $wgEditEncoding = '';
2598 * Set this to true to replace Arabic presentation forms with their standard
2599 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2602 * Note that pages with titles containing presentation forms will become
2603 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2605 $wgFixArabicUnicode = true;
2608 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2609 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2610 * set to "ml". Note that some clients (even new clients as of 2010) do not
2611 * support these characters.
2613 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2614 * fix any ZWJ sequences in existing page titles.
2616 $wgFixMalayalamUnicode = true;
2619 * Set this to always convert certain Unicode sequences to modern ones
2620 * regardless of the content language. This has a small performance
2623 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2628 $wgAllUnicodeFixes = false;
2631 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2632 * loading old revisions not marked with "utf-8" flag. Use this when
2633 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2634 * burdensome mass conversion of old text data.
2636 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2637 * user names, etc still must be converted en masse in the database before
2638 * continuing as a UTF-8 wiki.
2640 $wgLegacyEncoding = false;
2643 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2644 * regexps : "/regexp/" matching problematic browsers. These browsers will
2645 * be served encoded unicode in the edit box instead of real unicode.
2647 $wgBrowserBlackList = array(
2649 * Netscape 2-4 detection
2650 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2651 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2652 * with a negative assertion. The [UIN] identifier specifies the level of security
2653 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2654 * The language string is unreliable, it is missing on NS4 Mac.
2656 * Reference: http://www.psychedelix.com/agents/index.shtml
2658 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2659 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2660 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2663 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2664 * Þ to <THORN> and Ð to <ETH>
2667 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2668 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2669 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2672 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2673 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2675 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2678 * Google wireless transcoder, seems to eat a lot of chars alive
2679 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2681 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2685 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2686 * create stub reference rows in the text table instead of copying
2687 * the full text of all current entries from 'cur' to 'text'.
2689 * This will speed up the conversion step for large sites, but
2690 * requires that the cur table be kept around for those revisions
2691 * to remain viewable.
2693 * This option affects the updaters *only*. Any present cur stub
2694 * revisions will be readable at runtime regardless of this setting.
2696 $wgLegacySchemaConversion = false;
2699 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2700 * the interface is set to English.
2702 $wgAmericanDates = false;
2705 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2706 * numerals in interface.
2708 $wgTranslateNumerals = true;
2711 * Translation using MediaWiki: namespace.
2712 * Interface messages will be loaded from the database.
2714 $wgUseDatabaseMessages = true;
2717 * Expiry time for the message cache key
2719 $wgMsgCacheExpiry = 86400;
2722 * Maximum entry size in the message cache, in bytes
2724 $wgMaxMsgCacheEntrySize = 10000;
2727 * Whether to enable language variant conversion.
2729 $wgDisableLangConversion = false;
2732 * Whether to enable language variant conversion for links.
2734 $wgDisableTitleConversion = false;
2737 * Whether to enable canonical language links in meta data.
2739 $wgCanonicalLanguageLinks = true;
2742 * Default variant code, if false, the default will be the language code
2744 $wgDefaultLanguageVariant = false;
2747 * Disabled variants array of language variant conversion.
2751 * $wgDisabledVariants[] = 'zh-mo';
2752 * $wgDisabledVariants[] = 'zh-my';
2755 $wgDisabledVariants = array();
2758 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2759 * path format that describes which parts of the URL contain the
2764 * $wgLanguageCode = 'sr';
2765 * $wgVariantArticlePath = '/$2/$1';
2766 * $wgArticlePath = '/wiki/$1';
2769 * A link to /wiki/ would be redirected to /sr/Главна_страна
2771 * It is important that $wgArticlePath not overlap with possible values
2772 * of $wgVariantArticlePath.
2774 $wgVariantArticlePath = false;
2777 * Show a bar of language selection links in the user login and user
2778 * registration forms; edit the "loginlanguagelinks" message to
2781 $wgLoginLanguageSelector = false;
2784 * When translating messages with wfMessage(), it is not always clear what
2785 * should be considered UI messages and what should be content messages.
2787 * For example, for the English Wikipedia, there should be only one 'mainpage',
2788 * so when getting the link for 'mainpage', we should treat it as site content
2789 * and call ->inContentLanguage()->text(), but for rendering the text of the
2790 * link, we call ->text(). The code behaves this way by default. However,
2791 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2792 * and the like for different languages. This array provides a way to override
2793 * the default behavior.
2796 * To allow language-specific main page and community
2799 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2802 $wgForceUIMsgAsContentMsg = array();
2805 * Fake out the timezone that the server thinks it's in. This will be used for
2806 * date display and not for what's stored in the DB. Leave to null to retain
2807 * your server's OS-based timezone value.
2809 * This variable is currently used only for signature formatting and for local
2810 * time/date parser variables ({{LOCALTIME}} etc.)
2812 * Timezones can be translated by editing MediaWiki messages of type
2813 * timezone-nameinlowercase like timezone-utc.
2815 * A list of usable timezones can found at:
2816 * http://php.net/manual/en/timezones.php
2820 * $wgLocaltimezone = 'UTC';
2821 * $wgLocaltimezone = 'GMT';
2822 * $wgLocaltimezone = 'PST8PDT';
2823 * $wgLocaltimezone = 'Europe/Sweden';
2824 * $wgLocaltimezone = 'CET';
2827 $wgLocaltimezone = null;
2830 * Set an offset from UTC in minutes to use for the default timezone setting
2831 * for anonymous users and new user accounts.
2833 * This setting is used for most date/time displays in the software, and is
2834 * overridable in user preferences. It is *not* used for signature timestamps.
2836 * By default, this will be set to match $wgLocaltimezone.
2838 $wgLocalTZoffset = null;
2840 /** @} */ # End of language/charset settings
2842 /*************************************************************************//**
2843 * @name Output format and skin settings
2848 * The default Content-Type header.
2850 $wgMimeType = 'text/html';
2853 * Previously used as content type in HTML script tags. This is now ignored since
2854 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2855 * It was also previously used by RawAction to determine the ctype query parameter
2856 * value that will result in a javascript response.
2857 * @deprecated since 1.22
2859 $wgJsMimeType = null;
2862 * The default xmlns attribute. The option to define this has been removed.
2863 * The value of this variable is no longer used by core and is set to a fixed
2864 * value in Setup.php for compatibility with extensions that depend on the value
2865 * of this variable being set. Such a dependency however is deprecated.
2866 * @deprecated since 1.22
2868 $wgXhtmlDefaultNamespace = null;
2871 * Previously used to determine if we should output an HTML5 doctype.
2872 * This is no longer used as we always output HTML5 now. For compatibility with
2873 * extensions that still check the value of this config it's value is now forced
2874 * to true by Setup.php.
2875 * @deprecated since 1.22
2880 * Defines the value of the version attribute in the <html> tag, if any.
2881 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2882 * (like if it's left at the default null value), it will be auto-initialized
2883 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2884 * ever actually set this to anything.
2886 $wgHtml5Version = null;
2889 * Enabled RDFa attributes for use in wikitext.
2890 * NOTE: Interaction with HTML5 is somewhat underspecified.
2892 $wgAllowRdfaAttributes = false;
2895 * Enabled HTML5 microdata attributes for use in wikitext.
2897 $wgAllowMicrodataAttributes = false;
2900 * Should we try to make our HTML output well-formed XML? If set to false,
2901 * output will be a few bytes shorter, and the HTML will arguably be more
2902 * readable. If set to true, life will be much easier for the authors of
2903 * screen-scraping bots, and the HTML will arguably be more readable.
2905 * Setting this to false may omit quotation marks on some attributes, omit
2906 * slashes from some self-closing tags, omit some ending tags, etc., where
2907 * permitted by HTML5. Setting it to true will not guarantee that all pages
2908 * will be well-formed, although non-well-formed pages should be rare and it's
2909 * a bug if you find one. Conversely, setting it to false doesn't mean that
2910 * all XML-y constructs will be omitted, just that they might be.
2912 * Because of compatibility with screen-scraping bots, and because it's
2913 * controversial, this is currently left to true by default.
2915 $wgWellFormedXml = true;
2918 * Permit other namespaces in addition to the w3.org default.
2920 * Use the prefix for the key and the namespace for the value.
2924 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2926 * Normally we wouldn't have to define this in the root "<html>"
2927 * element, but IE needs it there in some circumstances.
2929 * This is ignored if $wgMimeType is set to a non-XML mimetype.
2931 $wgXhtmlNamespaces = array();
2934 * Show IP address, for non-logged in users. It's necessary to switch this off
2935 * for some forms of caching.
2936 * @warning Will disable file cache.
2938 $wgShowIPinHeader = true;
2941 * Site notice shown at the top of each page
2943 * MediaWiki:Sitenotice page, which will override this. You can also
2944 * provide a separate message for logged-out users using the
2945 * MediaWiki:Anonnotice page.
2950 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2952 $wgSiteSupportPage = '';
2955 * Validate the overall output using tidy and refuse
2956 * to display the page if it's not valid.
2958 $wgValidateAllHtml = false;
2961 * Default skin, for new users and anonymous visitors. Registered users may
2962 * change this to any one of the other available skins in their preferences.
2964 $wgDefaultSkin = 'vector';
2967 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
2971 $wgFallbackSkin = 'vector';
2974 * Specify the names of skins that should not be presented in the list of
2975 * available skins in user preferences. If you want to remove a skin entirely,
2976 * remove it from the skins/ directory and its entry from LocalSettings.php.
2978 $wgSkipSkins = array();
2981 * @deprecated since 1.23; use $wgSkipSkins instead
2986 * Allow user Javascript page?
2987 * This enables a lot of neat customizations, but may
2988 * increase security risk to users and server load.
2990 $wgAllowUserJs = false;
2993 * Allow user Cascading Style Sheets (CSS)?
2994 * This enables a lot of neat customizations, but may
2995 * increase security risk to users and server load.
2997 $wgAllowUserCss = false;
3000 * Allow user-preferences implemented in CSS?
3001 * This allows users to customise the site appearance to a greater
3002 * degree; disabling it will improve page load times.
3004 $wgAllowUserCssPrefs = true;
3007 * Use the site's Javascript page?
3009 $wgUseSiteJs = true;
3012 * Use the site's Cascading Style Sheets (CSS)?
3014 $wgUseSiteCss = true;
3017 * Break out of framesets. This can be used to prevent clickjacking attacks,
3018 * or to prevent external sites from framing your site with ads.
3020 $wgBreakFrames = false;
3023 * The X-Frame-Options header to send on pages sensitive to clickjacking
3024 * attacks, such as edit pages. This prevents those pages from being displayed
3025 * in a frame or iframe. The options are:
3027 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3029 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3030 * to allow framing within a trusted domain. This is insecure if there
3031 * is a page on the same domain which allows framing of arbitrary URLs.
3033 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3034 * full compromise of local user accounts. Private wikis behind a
3035 * corporate firewall are especially vulnerable. This is not
3038 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3039 * not just edit pages.
3041 $wgEditPageFrameOptions = 'DENY';
3044 * Disallow framing of API pages directly, by setting the X-Frame-Options
3045 * header. Since the API returns CSRF tokens, allowing the results to be
3046 * framed can compromise your user's account security.
3048 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3049 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3050 * - false: Allow all framing.
3052 $wgApiFrameOptions = 'DENY';
3055 * Disable output compression (enabled by default if zlib is available)
3057 $wgDisableOutputCompression = false;
3060 * Should we allow a broader set of characters in id attributes, per HTML5? If
3061 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3062 * functionality is ready, it will be on by default with no option.
3064 * Currently this appears to work fine in all browsers, but it's disabled by
3065 * default because it normalizes id's a bit too aggressively, breaking preexisting
3066 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3068 $wgExperimentalHtmlIds = false;
3071 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3072 * You can add new icons to the built in copyright or poweredby, or you can create
3073 * a new block. Though note that you may need to add some custom css to get good styling
3074 * of new blocks in monobook. vector and modern should work without any special css.
3076 * $wgFooterIcons itself is a key/value array.
3077 * The key is the name of a block that the icons will be wrapped in. The final id varies
3078 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3079 * turns it into mw_poweredby.
3080 * The value is either key/value array of icons or a string.
3081 * In the key/value array the key may or may not be used by the skin but it can
3082 * be used to find the icon and unset it or change the icon if needed.
3083 * This is useful for disabling icons that are set by extensions.
3084 * The value should be either a string or an array. If it is a string it will be output
3085 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3086 * for the icon, the following keys are used:
3087 * - src: An absolute url to the image to use for the icon, this is recommended
3088 * but not required, however some skins will ignore icons without an image
3089 * - url: The url to use in the a element around the text or icon, if not set an a element will
3091 * - alt: This is the text form of the icon, it will be displayed without an image in
3092 * skins like Modern or if src is not set, and will otherwise be used as
3093 * the alt="" for the image. This key is required.
3094 * - width and height: If the icon specified by src is not of the standard size
3095 * you can specify the size of image to use with these keys.
3096 * Otherwise they will default to the standard 88x31.
3097 * @todo Reformat documentation.
3099 $wgFooterIcons = array(
3100 "copyright" => array(
3101 "copyright" => array(), // placeholder for the built in copyright icon
3103 "poweredby" => array(
3104 "mediawiki" => array(
3105 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
3106 "url" => "//www.mediawiki.org/",
3107 "alt" => "Powered by MediaWiki",
3113 * Login / create account link behavior when it's possible for anonymous users
3114 * to create an account.
3115 * - true = use a combined login / create account link
3116 * - false = split login and create account into two separate links
3118 $wgUseCombinedLoginLink = false;
3121 * Search form look for Vector skin only.
3122 * - true = use an icon search button
3123 * - false = use Go & Search buttons
3125 $wgVectorUseSimpleSearch = true;
3128 * Watch and unwatch as an icon rather than a link for Vector skin only.
3129 * - true = use an icon watch/unwatch button
3130 * - false = use watch/unwatch text link
3132 $wgVectorUseIconWatch = true;
3135 * Display user edit counts in various prominent places.
3137 $wgEdititis = false;
3140 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3141 * status code, mangling or hiding MediaWiki's output. If you are using such a
3142 * host, you should start looking for a better one. While you're doing that,
3143 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3144 * that the generated error pages can be seen.
3146 * In cases where for technical reasons it is more important for MediaWiki to
3147 * send the correct status code than for the body to be transmitted intact,
3148 * this configuration variable is ignored.
3150 $wgSend404Code = true;
3153 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3154 * rollback. The numeric value of the variable are the limit up to are counted.
3155 * If the value is false or 0, the edits are not counted. Disabling this will
3156 * furthermore prevent MediaWiki from hiding some useless rollback links.
3160 $wgShowRollbackEditCount = 10;
3163 * Output a <link rel="canonical"> tag on every page indicating the canonical
3164 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3165 * detection of the current server is unreliable, the link is sent
3168 $wgEnableCanonicalServerLink = false;
3170 /** @} */ # End of output format settings }
3172 /*************************************************************************//**
3173 * @name Resource loader settings
3178 * Client-side resource modules.
3180 * Extensions should add their resource loader module definitions
3181 * to the $wgResourceModules variable.
3185 * $wgResourceModules['ext.myExtension'] = array(
3186 * 'scripts' => 'myExtension.js',
3187 * 'styles' => 'myExtension.css',
3188 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3189 * 'localBasePath' => __DIR__,
3190 * 'remoteExtPath' => 'MyExtension',
3194 $wgResourceModules = array();
3197 * Extensions should register foreign module sources here. 'local' is a
3198 * built-in source that is not in this array, but defined by
3199 * ResourceLoader::__construct() so that it cannot be unset.
3203 * $wgResourceLoaderSources['foo'] = array(
3204 * 'loadScript' => 'http://example.org/w/load.php',
3205 * 'apiScript' => 'http://example.org/w/api.php'
3209 $wgResourceLoaderSources = array();
3212 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3213 * If not set, then $wgScriptPath will be used as a fallback.
3215 $wgResourceBasePath = null;
3218 * Maximum time in seconds to cache resources served by the resource loader.
3219 * Used to set last modified headers (max-age/s-maxage).
3221 * Following options to distinguish:
3222 * - versioned: Used for modules with a version, because changing version
3223 * numbers causes cache misses. This normally has a long expiry time.
3224 * - unversioned: Used for modules without a version to propagate changes
3225 * quickly to clients. Also used for modules with errors to recover quickly.
3226 * This normally has a short expiry time.
3228 * Expiry time for the options to distinguish:
3229 * - server: Squid/Varnish but also any other public proxy cache between the
3230 * client and MediaWiki.
3231 * - client: On the client side (e.g. in the browser cache).
3233 $wgResourceLoaderMaxage = array(
3234 'versioned' => array(
3235 'server' => 30 * 24 * 60 * 60, // 30 days
3236 'client' => 30 * 24 * 60 * 60, // 30 days
3238 'unversioned' => array(
3239 'server' => 5 * 60, // 5 minutes
3240 'client' => 5 * 60, // 5 minutes
3245 * The default debug mode (on/off) for of ResourceLoader requests.
3247 * This will still be overridden when the debug URL parameter is used.
3249 $wgResourceLoaderDebug = false;
3252 * Enable embedding of certain resources using Edge Side Includes. This will
3253 * improve performance but only works if there is something in front of the
3254 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3256 $wgResourceLoaderUseESI = false;
3259 * Put each statement on its own line when minifying JavaScript. This makes
3260 * debugging in non-debug mode a bit easier.
3262 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3265 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3266 * the minifier will try not to produce lines longer than this, but may be
3267 * forced to do so in certain cases.
3269 $wgResourceLoaderMinifierMaxLineLength = 1000;
3272 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3275 $wgIncludeLegacyJavaScript = true;
3278 * Whether to include the jQuery Migrate library, which lets legacy JS that
3279 * requires jQuery 1.8.x to work and breaks with 1.9.x+.
3282 * @deprecated since 1.24, to be removed in 1.25
3284 $wgIncludejQueryMigrate = false;
3287 * Whether to preload the mediawiki.util module as blocking module in the top
3290 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3291 * allowed modules to lack dependencies on 'popular' modules that were likely
3294 * This setting is to aid scripts during migration by providing mediawiki.util
3295 * unconditionally (which was the most commonly missed dependency).
3296 * It doesn't cover all missing dependencies obviously but should fix most of
3299 * This should be removed at some point after site/user scripts have been fixed.
3300 * Enable this if your wiki has a large amount of user/site scripts that are
3301 * lacking dependencies.
3304 $wgPreloadJavaScriptMwUtil = false;
3307 * Whether or not to assign configuration variables to the global window object.
3309 * If this is set to false, old code using deprecated variables will no longer
3312 * @par Example of legacy code:
3314 * if ( window.wgRestrictionEdit ) { ... }
3318 * if ( wgIsArticle ) { ... }
3321 * Instead, one needs to use mw.config.
3322 * @par Example using mw.config global configuration:
3324 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3328 * if ( mw.config.get('wgIsArticle') ) { ... }
3331 $wgLegacyJavaScriptGlobals = true;
3334 * If set to a positive number, ResourceLoader will not generate URLs whose
3335 * query string is more than this many characters long, and will instead use
3336 * multiple requests with shorter query strings. This degrades performance,
3337 * but may be needed if your web server has a low (less than, say 1024)
3338 * query string length limit or a low value for suhosin.get.max_value_length
3339 * that you can't increase.
3341 * If set to a negative number, ResourceLoader will assume there is no query
3342 * string length limit.
3344 * Defaults to a value based on php configuration.
3346 $wgResourceLoaderMaxQueryLength = false;
3349 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3350 * prior to minification to validate it.
3352 * Parse errors will result in a JS exception being thrown during module load,
3353 * which avoids breaking other modules loaded in the same request.
3355 $wgResourceLoaderValidateJS = true;
3358 * If set to true, statically-sourced (file-backed) JavaScript resources will
3359 * be parsed for validity before being bundled up into ResourceLoader modules.
3361 * This can be helpful for development by providing better error messages in
3362 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3363 * and may fail on large pre-bundled frameworks.
3365 $wgResourceLoaderValidateStaticJS = false;
3368 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3369 * will be enabled. This is an experimental feature that's supposed to make
3370 * JavaScript load faster.
3372 $wgResourceLoaderExperimentalAsyncLoading = false;
3375 * Global LESS variables. An associative array binding variable names to CSS
3378 * Because the hashed contents of this array are used to construct the cache key
3379 * that ResourceLoader uses to look up LESS compilation results, updating this
3380 * array can be used to deliberately invalidate the set of cached results.
3384 * $wgResourceLoaderLESSVars = array(
3385 * 'baseFontSize' => '1em',
3386 * 'smallFontSize' => '0.75em',
3387 * 'WikimediaBlue' => '#006699',
3392 $wgResourceLoaderLESSVars = array();
3395 * Custom LESS functions. An associative array mapping function name to PHP
3398 * Changes to LESS functions do not trigger cache invalidation. If you update
3399 * the behavior of a LESS function and need to invalidate stale compilation
3400 * results, you can touch one of values in $wgResourceLoaderLESSVars, as
3405 $wgResourceLoaderLESSFunctions = array(
3406 'embeddable' => 'ResourceLoaderLESSFunctions::embeddable',
3407 'embed' => 'ResourceLoaderLESSFunctions::embed',
3411 * Default import paths for LESS modules. LESS files referenced in @import
3412 * statements will be looked up here first, and relative to the importing file
3413 * second. To avoid collisions, it's important for the LESS files in these
3414 * directories to have a common, predictable file name prefix.
3416 * Extensions need not (and should not) register paths in
3417 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3418 * currently compiling LESS file, which allows each extension to freely import
3419 * files from its own tree.
3423 $wgResourceLoaderLESSImportPaths = array(
3424 "$IP/resources/src/mediawiki.less/",
3428 * Whether ResourceLoader should attempt to persist modules in localStorage on
3429 * browsers that support the Web Storage API.
3431 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3433 $wgResourceLoaderStorageEnabled = false;
3436 * Cache version for client-side ResourceLoader module storage. You can trigger
3437 * invalidation of the contents of the module store by incrementing this value.
3441 $wgResourceLoaderStorageVersion = 1;
3443 /** @} */ # End of resource loader settings }
3445 /*************************************************************************//**
3446 * @name Page title and interwiki link settings
3451 * Name of the project namespace. If left set to false, $wgSitename will be
3454 $wgMetaNamespace = false;
3457 * Name of the project talk namespace.
3459 * Normally you can ignore this and it will be something like
3460 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3461 * manually for grammatical reasons.
3463 $wgMetaNamespaceTalk = false;
3466 * Additional namespaces. If the namespaces defined in Language.php and
3467 * Namespace.php are insufficient, you can create new ones here, for example,
3468 * to import Help files in other languages. You can also override the namespace
3469 * names of existing namespaces. Extensions developers should use
3470 * $wgCanonicalNamespaceNames.
3472 * @warning Once you delete a namespace, the pages in that namespace will
3473 * no longer be accessible. If you rename it, then you can access them through
3474 * the new namespace name.
3476 * Custom namespaces should start at 100 to avoid conflicting with standard
3477 * namespaces, and should always follow the even/odd main/talk pattern.
3481 * $wgExtraNamespaces = array(
3483 * 101 => "Hilfe_Diskussion",
3485 * 103 => "Discussion_Aide"
3489 * @todo Add a note about maintenance/namespaceDupes.php
3491 $wgExtraNamespaces = array();
3494 * Same as above, but for namespaces with gender distinction.
3495 * Note: the default form for the namespace should also be set
3496 * using $wgExtraNamespaces for the same index.
3499 $wgExtraGenderNamespaces = array();
3502 * Namespace aliases.
3504 * These are alternate names for the primary localised namespace names, which
3505 * are defined by $wgExtraNamespaces and the language file. If a page is
3506 * requested with such a prefix, the request will be redirected to the primary
3509 * Set this to a map from namespace names to IDs.
3513 * $wgNamespaceAliases = array(
3514 * 'Wikipedian' => NS_USER,
3519 $wgNamespaceAliases = array();
3522 * Allowed title characters -- regex character class
3523 * Don't change this unless you know what you're doing
3525 * Problematic punctuation:
3526 * - []{}|# Are needed for link syntax, never enable these
3527 * - <> Causes problems with HTML escaping, don't use
3528 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3529 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3530 * corrupted by apache
3531 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3533 * All three of these punctuation problems can be avoided by using an alias,
3534 * instead of a rewrite rule of either variety.
3536 * The problem with % is that when using a path to query rewrite rule, URLs are
3537 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3538 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3539 * for this, indeed double escaping would break if the double-escaped title was
3540 * passed in the query string rather than the path. This is a minor security issue
3541 * because articles can be created such that they are hard to view or edit.
3543 * In some rare cases you may wish to remove + for compatibility with old links.
3545 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3546 * this breaks interlanguage links
3548 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3551 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3553 * @deprecated since 1.23; use $wgLocalInterwikis instead
3555 $wgLocalInterwiki = false;
3558 * Array for multiple $wgLocalInterwiki values, in case there are several
3559 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3560 * set, its value is prepended to this array, for backwards compatibility.
3562 * Note, recent changes feeds use only the first entry in this array (or
3563 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3565 $wgLocalInterwikis = array();
3568 * Expiry time for cache of interwiki table
3570 $wgInterwikiExpiry = 10800;
3573 * @name Interwiki caching settings.
3578 *$wgInterwikiCache specifies path to constant database file.
3580 * This cdb database is generated by dumpInterwiki from maintenance and has
3582 * - dbname:key - a simple key (e.g. enwiki:meta)
3583 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3584 * - __global:key - global-scope key (e.g. __global:meta)
3585 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3587 * Sites mapping just specifies site name, other keys provide "local url"
3590 $wgInterwikiCache = false;
3593 * Specify number of domains to check for messages.
3594 * - 1: Just wiki(db)-level
3595 * - 2: wiki and global levels
3598 $wgInterwikiScopes = 3;
3601 * Fallback site, if unable to resolve from cache
3603 $wgInterwikiFallbackSite = 'wiki';
3605 /** @} */ # end of Interwiki caching settings.
3608 * If local interwikis are set up which allow redirects,
3609 * set this regexp to restrict URLs which will be displayed
3610 * as 'redirected from' links.
3613 * It might look something like this:
3615 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3618 * Leave at false to avoid displaying any incoming redirect markers.
3619 * This does not affect intra-wiki redirects, which don't change
3622 $wgRedirectSources = false;
3625 * Set this to false to avoid forcing the first letter of links to capitals.
3627 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3628 * appearing with a capital at the beginning of a sentence will *not* go to the
3629 * same place as links in the middle of a sentence using a lowercase initial.
3631 $wgCapitalLinks = true;
3634 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3635 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3636 * true by default (and setting them has no effect), due to various things that
3637 * require them to be so. Also, since Talk namespaces need to directly mirror their
3638 * associated content namespaces, the values for those are ignored in favor of the
3639 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3644 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3647 $wgCapitalLinkOverrides = array();
3650 * Which namespaces should support subpages?
3651 * See Language.php for a list of namespaces.
3653 $wgNamespacesWithSubpages = array(
3656 NS_USER_TALK
=> true,
3658 NS_PROJECT_TALK
=> true,
3659 NS_FILE_TALK
=> true,
3660 NS_MEDIAWIKI
=> true,
3661 NS_MEDIAWIKI_TALK
=> true,
3662 NS_TEMPLATE_TALK
=> true,
3664 NS_HELP_TALK
=> true,
3665 NS_CATEGORY_TALK
=> true
3669 * Array holding default tracking category names.
3671 * Array contains the system messages for each tracking category.
3672 * Tracking categories allow pages with certain characteristics to be tracked.
3673 * It works by adding any such page to a category automatically.
3675 * A message with the suffix '-desc' should be added as a description message
3676 * to have extra information on Special:TrackingCategories.
3680 $wgTrackingCategories = array(
3683 'expensive-parserfunction-category',
3684 'post-expand-template-argument-category',
3685 'post-expand-template-inclusion-category',
3686 'hidden-category-category',
3687 'broken-file-category',
3688 'node-count-exceeded-category',
3689 'expansion-depth-exceeded-category',
3693 * Array of namespaces which can be deemed to contain valid "content", as far
3694 * as the site statistics are concerned. Useful if additional namespaces also
3695 * contain "content" which should be considered when generating a count of the
3696 * number of articles in the wiki.
3698 $wgContentNamespaces = array( NS_MAIN
);
3701 * Max number of redirects to follow when resolving redirects.
3702 * 1 means only the first redirect is followed (default behavior).
3703 * 0 or less means no redirects are followed.
3705 $wgMaxRedirects = 1;
3708 * Array of invalid page redirect targets.
3709 * Attempting to create a redirect to any of the pages in this array
3710 * will make the redirect fail.
3711 * Userlogout is hard-coded, so it does not need to be listed here.
3712 * (bug 10569) Disallow Mypage and Mytalk as well.
3714 * As of now, this only checks special pages. Redirects to pages in
3715 * other namespaces cannot be invalidated by this variable.
3717 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3719 /** @} */ # End of title and interwiki settings }
3721 /************************************************************************//**
3722 * @name Parser settings
3723 * These settings configure the transformation from wikitext to HTML.
3728 * Parser configuration. Associative array with the following members:
3730 * class The class name
3732 * preprocessorClass The preprocessor class. Two classes are currently available:
3733 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3734 * storage, and Preprocessor_DOM, which uses the DOM module for
3735 * temporary storage. Preprocessor_DOM generally uses less memory;
3736 * the speed of the two is roughly the same.
3738 * If this parameter is not given, it uses Preprocessor_DOM if the
3739 * DOM module is available, otherwise it uses Preprocessor_Hash.
3741 * The entire associative array will be passed through to the constructor as
3742 * the first parameter. Note that only Setup.php can use this variable --
3743 * the configuration will change at runtime via $wgParser member functions, so
3744 * the contents of this variable will be out-of-date. The variable can only be
3745 * changed during LocalSettings.php, in particular, it can't be changed during
3746 * an extension setup function.
3748 $wgParserConf = array(
3749 'class' => 'Parser',
3750 #'preprocessorClass' => 'Preprocessor_Hash',
3754 * Maximum indent level of toc.
3756 $wgMaxTocLevel = 999;
3759 * A complexity limit on template expansion: the maximum number of nodes visited
3760 * by PPFrame::expand()
3762 $wgMaxPPNodeCount = 1000000;
3765 * A complexity limit on template expansion: the maximum number of elements
3766 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3767 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3768 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3769 * this default corresponds to about 155 MB.
3771 * When the limit is exceeded, an exception is thrown.
3773 $wgMaxGeneratedPPNodeCount = 1000000;
3776 * Maximum recursion depth for templates within templates.
3777 * The current parser adds two levels to the PHP call stack for each template,
3778 * and xdebug limits the call stack to 100 by default. So this should hopefully
3779 * stop the parser before it hits the xdebug limit.
3781 $wgMaxTemplateDepth = 40;
3784 * @see $wgMaxTemplateDepth
3786 $wgMaxPPExpandDepth = 40;
3789 * URL schemes that should be recognized as valid by wfParseUrl().
3792 $wgUrlProtocols = array(
3793 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3794 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3795 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3796 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3800 * If true, removes (substitutes) templates in "~~~~" signatures.
3802 $wgCleanSignatures = true;
3805 * Whether to allow inline image pointing to other websites
3807 $wgAllowExternalImages = false;
3810 * If the above is false, you can specify an exception here. Image URLs
3811 * that start with this string are then rendered, while all others are not.
3812 * You can use this to set up a trusted, simple repository of images.
3813 * You may also specify an array of strings to allow multiple sites
3817 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3818 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3821 $wgAllowExternalImagesFrom = '';
3824 * If $wgAllowExternalImages is false, you can allow an on-wiki
3825 * whitelist of regular expression fragments to match the image URL
3826 * against. If the image matches one of the regular expression fragments,
3827 * The image will be displayed.
3829 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3830 * Or false to disable it
3832 $wgEnableImageWhitelist = true;
3835 * A different approach to the above: simply allow the "<img>" tag to be used.
3836 * This allows you to specify alt text and other attributes, copy-paste HTML to
3837 * your wiki more easily, etc. However, allowing external images in any manner
3838 * will allow anyone with editing rights to snoop on your visitors' IP
3839 * addresses and so forth, if they wanted to, by inserting links to images on
3840 * sites they control.
3842 $wgAllowImageTag = false;
3845 * $wgUseTidy: use tidy to make sure HTML output is sane.
3846 * Tidy is a free tool that fixes broken HTML.
3847 * See http://www.w3.org/People/Raggett/tidy/
3849 * - $wgTidyBin should be set to the path of the binary and
3850 * - $wgTidyConf to the path of the configuration file.
3851 * - $wgTidyOpts can include any number of parameters.
3852 * - $wgTidyInternal controls the use of the PECL extension or the
3853 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3854 * of spawning a separate program.
3855 * Normally you shouldn't need to override the setting except for
3856 * debugging. To install, use 'pear install tidy' and add a line
3857 * 'extension=tidy.so' to php.ini.
3864 $wgAlwaysUseTidy = false;
3869 $wgTidyBin = 'tidy';
3874 $wgTidyConf = $IP . '/includes/tidy.conf';
3884 $wgTidyInternal = extension_loaded( 'tidy' );
3887 * Put tidy warnings in HTML comments
3888 * Only works for internal tidy.
3890 $wgDebugTidy = false;
3893 * Allow raw, unchecked HTML in "<html>...</html>" sections.
3894 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3895 * TO RESTRICT EDITING to only those that you trust
3900 * Set a default target for external links, e.g. _blank to pop up a new window
3902 $wgExternalLinkTarget = false;
3905 * If true, external URL links in wiki text will be given the
3906 * rel="nofollow" attribute as a hint to search engines that
3907 * they should not be followed for ranking purposes as they
3908 * are user-supplied and thus subject to spamming.
3910 $wgNoFollowLinks = true;
3913 * Namespaces in which $wgNoFollowLinks doesn't apply.
3914 * See Language.php for a list of namespaces.
3916 $wgNoFollowNsExceptions = array();
3919 * If this is set to an array of domains, external links to these domain names
3920 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3921 * value of $wgNoFollowLinks. For instance:
3923 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
3924 * 'mediawiki.org' );
3926 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3927 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3930 * Defaults to mediawiki.org for the links included in the software by default.
3932 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
3935 * Allow DISPLAYTITLE to change title display
3937 $wgAllowDisplayTitle = true;
3940 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
3941 * canonical DB key. Also disallow some inline CSS rules like display: none;
3942 * which can cause the text to be hidden or unselectable.
3944 $wgRestrictDisplayTitle = true;
3947 * Maximum number of calls per parse to expensive parser functions such as
3950 $wgExpensiveParserFunctionLimit = 100;
3953 * Preprocessor caching threshold
3954 * Setting it to 'false' will disable the preprocessor cache.
3956 $wgPreprocessorCacheThreshold = 1000;
3959 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
3961 $wgEnableScaryTranscluding = false;
3964 * Expiry time for transcluded templates cached in transcache database table.
3965 * Only used $wgEnableInterwikiTranscluding is set to true.
3967 $wgTranscludeCacheExpiry = 3600;
3969 /** @} */ # end of parser settings }
3971 /************************************************************************//**
3977 * Method used to determine if a page in a content namespace should be counted
3978 * as a valid article.
3980 * Redirect pages will never be counted as valid articles.
3982 * This variable can have the following values:
3983 * - 'any': all pages as considered as valid articles
3984 * - 'comma': the page must contain a comma to be considered valid
3985 * - 'link': the page must contain a [[wiki link]] to be considered valid
3987 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
3989 * Retroactively changing this variable will not affect the existing count,
3990 * to update it, you will need to run the maintenance/updateArticleCount.php
3993 $wgArticleCountMethod = 'link';
3996 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
3997 * values are easier on the database. A value of 1 causes the counters to be
3998 * updated on every hit, any higher value n cause them to update *on average*
3999 * every n hits. Should be set to either 1 or something largish, eg 1000, for
4000 * maximum efficiency.
4002 $wgHitcounterUpdateFreq = 1;
4005 * How many days user must be idle before he is considered inactive. Will affect
4006 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4007 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4008 * You might want to leave this as the default value, to provide comparable
4009 * numbers between different wikis.
4011 $wgActiveUserDays = 30;
4013 /** @} */ # End of statistics }
4015 /************************************************************************//**
4016 * @name User accounts, authentication
4021 * For compatibility with old installations set to false
4023 $wgPasswordSalt = true;
4026 * Specifies the minimal length of a user password. If set to 0, empty pass-
4027 * words are allowed.
4029 $wgMinimalPasswordLength = 1;
4032 * Specifies if users should be sent to a password-reset form on login, if their
4033 * password doesn't meet the requirements of User::isValidPassword().
4036 $wgInvalidPasswordReset = true;
4039 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4040 * with a temporary password you can use to get back into the account") identified by
4041 * various bits of data. Setting all of these to false (or the whole variable to false)
4042 * has the effect of disabling password resets entirely
4044 $wgPasswordResetRoutes = array(
4050 * Maximum number of Unicode characters in signature
4052 $wgMaxSigChars = 255;
4055 * Maximum number of bytes in username. You want to run the maintenance
4056 * script ./maintenance/checkUsernames.php once you have changed this value.
4058 $wgMaxNameChars = 255;
4061 * Array of usernames which may not be registered or logged in from
4062 * Maintenance scripts can still use these
4064 $wgReservedUsernames = array(
4065 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4066 'Conversion script', // Used for the old Wikipedia software upgrade
4067 'Maintenance script', // Maintenance scripts which perform editing, image import script
4068 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4069 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4070 'msg:double-redirect-fixer', // Automatic double redirect fix
4071 'msg:usermessage-editor', // Default user for leaving user messages
4072 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4076 * Settings added to this array will override the default globals for the user
4077 * preferences used by anonymous visitors and newly created accounts.
4078 * For instance, to disable editing on double clicks:
4079 * $wgDefaultUserOptions ['editondblclick'] = 0;
4081 $wgDefaultUserOptions = array(
4082 'ccmeonemails' => 0,
4084 'date' => 'default',
4087 'editfont' => 'default',
4088 'editondblclick' => 0,
4089 'editsectiononrightclick' => 0,
4090 'enotifminoredits' => 0,
4091 'enotifrevealaddr' => 0,
4092 'enotifusertalkpages' => 1,
4093 'enotifwatchlistpages' => 1,
4094 'extendwatchlist' => 0,
4096 'forceeditsummary' => 0,
4097 'gender' => 'unknown',
4099 'hidepatrolled' => 0,
4102 'minordefault' => 0,
4103 'newpageshidepatrolled' => 0,
4105 'norollbackdiff' => 0,
4106 'numberheadings' => 0,
4107 'previewonfirst' => 0,
4108 'previewontop' => 1,
4112 'showhiddencats' => 0,
4113 'shownumberswatching' => 1,
4116 'stubthreshold' => 0,
4119 'uselivepreview' => 0,
4121 'watchcreations' => 1,
4122 'watchdefault' => 1,
4123 'watchdeletion' => 0,
4124 'watchlistdays' => 3.0,
4125 'watchlisthideanons' => 0,
4126 'watchlisthidebots' => 0,
4127 'watchlisthideliu' => 0,
4128 'watchlisthideminor' => 0,
4129 'watchlisthideown' => 0,
4130 'watchlisthidepatrolled' => 0,
4133 'useeditwarning' => 1,
4134 'prefershttps' => 1,
4138 * An array of preferences to not show for the user
4140 $wgHiddenPrefs = array();
4143 * Characters to prevent during new account creations.
4144 * This is used in a regular expression character class during
4145 * registration (regex metacharacters like / are escaped).
4147 $wgInvalidUsernameCharacters = '@';
4150 * Character used as a delimiter when testing for interwiki userrights
4151 * (In Special:UserRights, it is possible to modify users on different
4152 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4154 * It is recommended that you have this delimiter in
4155 * $wgInvalidUsernameCharacters above, or you will not be able to
4156 * modify the user rights of those users via Special:UserRights
4158 $wgUserrightsInterwikiDelimiter = '@';
4161 * This is to let user authenticate using https when they come from http.
4162 * Based on an idea by George Herbert on wikitech-l:
4163 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4166 $wgSecureLogin = false;
4168 /** @} */ # end user accounts }
4170 /************************************************************************//**
4171 * @name User rights, access control and monitoring
4176 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4178 $wgAutoblockExpiry = 86400;
4181 * Set this to true to allow blocked users to edit their own user talk page.
4183 $wgBlockAllowsUTEdit = false;
4186 * Allow sysops to ban users from accessing Emailuser
4188 $wgSysopEmailBans = true;
4191 * Limits on the possible sizes of range blocks.
4193 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4194 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4195 * half the number of bits avoids such errors, and allows entire ISPs to be
4196 * blocked using a small number of range blocks.
4198 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4199 * customer, so range blocks larger than /64 (half the number of bits) will
4200 * plainly be required. RFC 4692 implies that a very large ISP may be
4201 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4202 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4204 $wgBlockCIDRLimit = array(
4205 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4210 * If true, blocked users will not be allowed to login. When using this with
4211 * a public wiki, the effect of logging out blocked users may actually be
4212 * avers: unless the user's address is also blocked (e.g. auto-block),
4213 * logging the user out will again allow reading and editing, just as for
4214 * anonymous visitors.
4216 $wgBlockDisablesLogin = false;
4219 * Pages anonymous user may see, set as an array of pages titles.
4223 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4226 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4228 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4229 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4231 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4232 * will remain readable. You can use img_auth.php to protect uploaded files,
4233 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4235 $wgWhitelistRead = false;
4238 * Pages anonymous user may see, set as an array of regular expressions.
4240 * This function will match the regexp against the title name, which
4241 * is without underscore.
4244 * To whitelist [[Main Page]]:
4246 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4249 * @note Unless ^ and/or $ is specified, a regular expression might match
4250 * pages not intended to be whitelisted. The above example will also
4251 * whitelist a page named 'Security Main Page'.
4254 * To allow reading any page starting with 'User' regardless of the case:
4256 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4258 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4260 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4261 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4263 $wgWhitelistReadRegexp = false;
4266 * Should editors be required to have a validated e-mail
4267 * address before being allowed to edit?
4269 $wgEmailConfirmToEdit = false;
4272 * Permission keys given to users in each group.
4274 * This is an array where the keys are all groups and each value is an
4275 * array of the format (right => boolean).
4277 * The second format is used to support per-namespace permissions.
4278 * Note that this feature does not fully work for all permission types.
4280 * All users are implicitly in the '*' group including anonymous visitors;
4281 * logged-in users are all implicitly in the 'user' group. These will be
4282 * combined with the permissions of all groups that a given user is listed
4283 * in in the user_groups table.
4285 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4286 * doing! This will wipe all permissions, and may mean that your users are
4287 * unable to perform certain essential tasks or access new functionality
4288 * when new permissions are introduced and default grants established.
4290 * Functionality to make pages inaccessible has not been extensively tested
4291 * for security. Use at your own risk!
4293 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4295 $wgGroupPermissions = array();
4297 /** @cond file_level_code */
4298 // Implicit group for all visitors
4299 $wgGroupPermissions['*']['createaccount'] = true;
4300 $wgGroupPermissions['*']['read'] = true;
4301 $wgGroupPermissions['*']['edit'] = true;
4302 $wgGroupPermissions['*']['createpage'] = true;
4303 $wgGroupPermissions['*']['createtalk'] = true;
4304 $wgGroupPermissions['*']['writeapi'] = true;
4305 $wgGroupPermissions['*']['editmyusercss'] = true;
4306 $wgGroupPermissions['*']['editmyuserjs'] = true;
4307 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4308 $wgGroupPermissions['*']['editmywatchlist'] = true;
4309 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4310 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4311 $wgGroupPermissions['*']['editmyoptions'] = true;
4312 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4314 // Implicit group for all logged-in accounts
4315 $wgGroupPermissions['user']['move'] = true;
4316 $wgGroupPermissions['user']['move-subpages'] = true;
4317 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4318 $wgGroupPermissions['user']['move-categorypages'] = true;
4319 $wgGroupPermissions['user']['movefile'] = true;
4320 $wgGroupPermissions['user']['read'] = true;
4321 $wgGroupPermissions['user']['edit'] = true;
4322 $wgGroupPermissions['user']['createpage'] = true;
4323 $wgGroupPermissions['user']['createtalk'] = true;
4324 $wgGroupPermissions['user']['writeapi'] = true;
4325 $wgGroupPermissions['user']['upload'] = true;
4326 $wgGroupPermissions['user']['reupload'] = true;
4327 $wgGroupPermissions['user']['reupload-shared'] = true;
4328 $wgGroupPermissions['user']['minoredit'] = true;
4329 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4330 $wgGroupPermissions['user']['sendemail'] = true;
4332 // Implicit group for accounts that pass $wgAutoConfirmAge
4333 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4334 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4336 // Users with bot privilege can have their edits hidden
4337 // from various log pages by default
4338 $wgGroupPermissions['bot']['bot'] = true;
4339 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4340 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4341 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4342 $wgGroupPermissions['bot']['autopatrol'] = true;
4343 $wgGroupPermissions['bot']['suppressredirect'] = true;
4344 $wgGroupPermissions['bot']['apihighlimits'] = true;
4345 $wgGroupPermissions['bot']['writeapi'] = true;
4347 // Most extra permission abilities go to this group
4348 $wgGroupPermissions['sysop']['block'] = true;
4349 $wgGroupPermissions['sysop']['createaccount'] = true;
4350 $wgGroupPermissions['sysop']['delete'] = true;
4351 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4352 $wgGroupPermissions['sysop']['bigdelete'] = true;
4353 // can view deleted history entries, but not see or restore the text
4354 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4355 // can view deleted revision text
4356 $wgGroupPermissions['sysop']['deletedtext'] = true;
4357 $wgGroupPermissions['sysop']['undelete'] = true;
4358 $wgGroupPermissions['sysop']['editinterface'] = true;
4359 $wgGroupPermissions['sysop']['editusercss'] = true;
4360 $wgGroupPermissions['sysop']['edituserjs'] = true;
4361 $wgGroupPermissions['sysop']['import'] = true;
4362 $wgGroupPermissions['sysop']['importupload'] = true;
4363 $wgGroupPermissions['sysop']['move'] = true;
4364 $wgGroupPermissions['sysop']['move-subpages'] = true;
4365 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4366 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4367 $wgGroupPermissions['sysop']['patrol'] = true;
4368 $wgGroupPermissions['sysop']['autopatrol'] = true;
4369 $wgGroupPermissions['sysop']['protect'] = true;
4370 $wgGroupPermissions['sysop']['editprotected'] = true;
4371 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4372 $wgGroupPermissions['sysop']['rollback'] = true;
4373 $wgGroupPermissions['sysop']['upload'] = true;
4374 $wgGroupPermissions['sysop']['reupload'] = true;
4375 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4376 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4377 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4378 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4379 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4380 $wgGroupPermissions['sysop']['blockemail'] = true;
4381 $wgGroupPermissions['sysop']['markbotedits'] = true;
4382 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4383 $wgGroupPermissions['sysop']['browsearchive'] = true;
4384 $wgGroupPermissions['sysop']['noratelimit'] = true;
4385 $wgGroupPermissions['sysop']['movefile'] = true;
4386 $wgGroupPermissions['sysop']['unblockself'] = true;
4387 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4388 #$wgGroupPermissions['sysop']['pagelang'] = true;
4389 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4390 $wgGroupPermissions['sysop']['mergehistory'] = true;
4392 // Permission to change users' group assignments
4393 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4394 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4395 // Permission to change users' groups assignments across wikis
4396 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4397 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4398 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4400 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4401 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4402 // To hide usernames from users and Sysops
4403 #$wgGroupPermissions['suppress']['hideuser'] = true;
4404 // To hide revisions/log items from users and Sysops
4405 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4406 // To view revisions/log items hidden from users and Sysops
4407 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4408 // For private suppression log access
4409 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4412 * The developer group is deprecated, but can be activated if need be
4413 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4414 * that a lock file be defined and creatable/removable by the web
4417 # $wgGroupPermissions['developer']['siteadmin'] = true;
4422 * Permission keys revoked from users in each group.
4424 * This acts the same way as wgGroupPermissions above, except that
4425 * if the user is in a group here, the permission will be removed from them.
4427 * Improperly setting this could mean that your users will be unable to perform
4428 * certain essential tasks, so use at your own risk!
4430 $wgRevokePermissions = array();
4433 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4435 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4438 * A map of group names that the user is in, to group names that those users
4439 * are allowed to add or revoke.
4441 * Setting the list of groups to add or revoke to true is equivalent to "any
4445 * To allow sysops to add themselves to the "bot" group:
4447 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4451 * Implicit groups may be used for the source group, for instance:
4453 * $wgGroupsRemoveFromSelf = array( '*' => true );
4455 * This allows users in the '*' group (i.e. any user) to remove themselves from
4456 * any group that they happen to be in.
4458 $wgGroupsAddToSelf = array();
4461 * @see $wgGroupsAddToSelf
4463 $wgGroupsRemoveFromSelf = array();
4466 * Set of available actions that can be restricted via action=protect
4467 * You probably shouldn't change this.
4468 * Translated through restriction-* messages.
4469 * Title::getRestrictionTypes() will remove restrictions that are not
4470 * applicable to a specific title (create and upload)
4472 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4475 * Rights which can be required for each protection level (via action=protect)
4477 * You can add a new protection level that requires a specific
4478 * permission by manipulating this array. The ordering of elements
4479 * dictates the order on the protection form's lists.
4481 * - '' will be ignored (i.e. unprotected)
4482 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4483 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4485 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4488 * Restriction levels that can be used with cascading protection
4490 * A page can only be protected with cascading protection if the
4491 * requested restriction level is included in this array.
4493 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4494 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4496 $wgCascadingRestrictionLevels = array( 'sysop' );
4499 * Restriction levels that should be considered "semiprotected"
4501 * Certain places in the interface recognize a dichotomy between "protected"
4502 * and "semiprotected", without further distinguishing the specific levels. In
4503 * general, if anyone can be eligible to edit a protection level merely by
4504 * reaching some condition in $wgAutopromote, it should probably be considered
4507 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4508 * 'sysop' is not changed, since it really shouldn't be here.
4510 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4513 * Set the minimum permissions required to edit pages in each
4514 * namespace. If you list more than one permission, a user must
4515 * have all of them to edit pages in that namespace.
4517 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4519 $wgNamespaceProtection = array();
4522 * Pages in namespaces in this array can not be used as templates.
4524 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4525 * namespaces constants (NS_USER, NS_MAIN...).
4527 * Among other things, this may be useful to enforce read-restrictions
4528 * which may otherwise be bypassed by using the template mechanism.
4530 $wgNonincludableNamespaces = array();
4533 * Number of seconds an account is required to age before it's given the
4534 * implicit 'autoconfirm' group membership. This can be used to limit
4535 * privileges of new accounts.
4537 * Accounts created by earlier versions of the software may not have a
4538 * recorded creation date, and will always be considered to pass the age test.
4540 * When left at 0, all registered accounts will pass.
4543 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4545 * $wgAutoConfirmAge = 600; // ten minutes
4547 * Set age to one day:
4549 * $wgAutoConfirmAge = 3600*24; // one day
4552 $wgAutoConfirmAge = 0;
4555 * Number of edits an account requires before it is autoconfirmed.
4556 * Passing both this AND the time requirement is needed. Example:
4560 * $wgAutoConfirmCount = 50;
4563 $wgAutoConfirmCount = 0;
4566 * Automatically add a usergroup to any user who matches certain conditions.
4568 * @todo Redocument $wgAutopromote
4571 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4572 * where cond1, cond2, ... are themselves conditions; *OR*
4573 * APCOND_EMAILCONFIRMED, *OR*
4574 * array( APCOND_EMAILCONFIRMED ), *OR*
4575 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4576 * array( APCOND_AGE, seconds since registration ), *OR*
4577 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4578 * array( APCOND_ISIP, ip ), *OR*
4579 * array( APCOND_IPINRANGE, range ), *OR*
4580 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4581 * array( APCOND_BLOCKED ), *OR*
4582 * array( APCOND_ISBOT ), *OR*
4583 * similar constructs defined by extensions.
4585 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4586 * user who has provided an e-mail address.
4588 $wgAutopromote = array(
4589 'autoconfirmed' => array( '&',
4590 array( APCOND_EDITCOUNT
, &$wgAutoConfirmCount ),
4591 array( APCOND_AGE
, &$wgAutoConfirmAge ),
4596 * Automatically add a usergroup to any user who matches certain conditions.
4598 * Does not add the user to the group again if it has been removed.
4599 * Also, does not remove the group if the user no longer meets the criteria.
4603 * array( event => criteria, ... )
4605 * Where event is either:
4606 * - 'onEdit' (when user edits)
4607 * - 'onView' (when user views the wiki)
4609 * Criteria has the same format as $wgAutopromote
4611 * @see $wgAutopromote
4614 $wgAutopromoteOnce = array(
4615 'onEdit' => array(),
4620 * Put user rights log entries for autopromotion in recent changes?
4623 $wgAutopromoteOnceLogInRC = true;
4626 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4627 * can assign which groups at Special:Userrights.
4630 * Bureaucrats can add any group:
4632 * $wgAddGroups['bureaucrat'] = true;
4634 * Bureaucrats can only remove bots and sysops:
4636 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4638 * Sysops can make bots:
4640 * $wgAddGroups['sysop'] = array( 'bot' );
4642 * Sysops can disable other sysops in an emergency, and disable bots:
4644 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4647 $wgAddGroups = array();
4652 $wgRemoveGroups = array();
4655 * A list of available rights, in addition to the ones defined by the core.
4656 * For extensions only.
4658 $wgAvailableRights = array();
4661 * Optional to restrict deletion of pages with higher revision counts
4662 * to users with the 'bigdelete' permission. (Default given to sysops.)
4664 $wgDeleteRevisionsLimit = 0;
4667 * The maximum number of edits a user can have and
4668 * can still be hidden by users with the hideuser permission.
4669 * This is limited for performance reason.
4670 * Set to false to disable the limit.
4673 $wgHideUserContribLimit = 1000;
4676 * Number of accounts each IP address may create, 0 to disable.
4678 * @warning Requires memcached
4680 $wgAccountCreationThrottle = 0;
4683 * Edits matching these regular expressions in body text
4684 * will be recognised as spam and rejected automatically.
4686 * There's no administrator override on-wiki, so be careful what you set. :)
4687 * May be an array of regexes or a single string for backwards compatibility.
4689 * @see http://en.wikipedia.org/wiki/Regular_expression
4691 * @note Each regex needs a beginning/end delimiter, eg: # or /
4693 $wgSpamRegex = array();
4696 * Same as the above except for edit summaries
4698 $wgSummarySpamRegex = array();
4701 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4705 $wgEnableDnsBlacklist = false;
4708 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4710 * This is an array of either a URL or an array with the URL and a key (should
4711 * the blacklist require a key).
4715 * $wgDnsBlacklistUrls = array(
4716 * // String containing URL
4717 * 'http.dnsbl.sorbs.net.',
4718 * // Array with URL and key, for services that require a key
4719 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4720 * // Array with just the URL. While this works, it is recommended that you
4721 * // just use a string as shown above
4722 * array( 'opm.tornevall.org.' )
4726 * @note You should end the domain name with a . to avoid searching your
4727 * eventual domain search suffixes.
4730 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4733 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4734 * what the other methods might say.
4736 $wgProxyWhitelist = array();
4739 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4740 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4741 * (transparent) proxies without needing to block the proxies themselves.
4743 $wgApplyIpBlocksToXff = false;
4746 * Simple rate limiter options to brake edit floods.
4748 * Maximum number actions allowed in the given number of seconds; after that
4749 * the violating client receives HTTP 500 error pages until the period
4753 * To set a generic maximum of 4 hits in 60 seconds:
4755 * $wgRateLimits = array( 4, 60 );
4758 * You could also limit per action and then type of users. See the inline
4759 * code for a template to use.
4761 * This option set is experimental and likely to change.
4763 * @warning Requires memcached.
4765 $wgRateLimits = array(
4767 'anon' => null, // for any and all anonymous edits (aggregate)
4768 'user' => null, // for each logged-in user
4769 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4770 'ip' => null, // for each anon and recent account
4771 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4779 'mailpassword' => array( // triggering password resets emails
4782 'emailuser' => array( // emailing other users using MediaWiki
4785 'linkpurge' => array( // purges of link tables
4792 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4799 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
4809 * Set to a filename to log rate limiter hits.
4811 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
4813 $wgRateLimitLog = null;
4816 * Array of IPs which should be excluded from rate limits.
4817 * This may be useful for whitelisting NAT gateways for conferences, etc.
4819 $wgRateLimitsExcludedIPs = array();
4822 * Log IP addresses in the recentchanges table; can be accessed only by
4823 * extensions (e.g. CheckUser) or a DB admin
4824 * Used for retroactive autoblocks
4826 $wgPutIPinRC = true;
4829 * Integer defining default number of entries to show on
4830 * special pages which are query-pages such as Special:Whatlinkshere.
4832 $wgQueryPageDefaultLimit = 50;
4835 * Limit password attempts to X attempts per Y seconds per IP per account.
4837 * @warning Requires memcached.
4839 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4841 /** @} */ # end of user rights settings
4843 /************************************************************************//**
4844 * @name Proxy scanner settings
4849 * This should always be customised in LocalSettings.php
4851 $wgSecretKey = false;
4854 * Big list of banned IP addresses.
4856 * This can have the following formats:
4857 * - An array of addresses, either in the values
4858 * or the keys (for backward compatibility)
4859 * - A string, in that case this is the path to a file
4860 * containing the list of IP addresses, one per line
4862 $wgProxyList = array();
4864 /** @} */ # end of proxy scanner settings
4866 /************************************************************************//**
4867 * @name Cookie settings
4872 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
4874 $wgCookieExpiration = 180 * 86400;
4877 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
4878 * or ".any.subdomain.net"
4880 $wgCookieDomain = '';
4883 * Set this variable if you want to restrict cookies to a certain path within
4884 * the domain specified by $wgCookieDomain.
4886 $wgCookiePath = '/';
4889 * Whether the "secure" flag should be set on the cookie. This can be:
4890 * - true: Set secure flag
4891 * - false: Don't set secure flag
4892 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
4894 $wgCookieSecure = 'detect';
4897 * By default, MediaWiki checks if the client supports cookies during the
4898 * login process, so that it can display an informative error message if
4899 * cookies are disabled. Set this to true if you want to disable this cookie
4902 $wgDisableCookieCheck = false;
4905 * Cookies generated by MediaWiki have names starting with this prefix. Set it
4906 * to a string to use a custom prefix. Setting it to false causes the database
4907 * name to be used as a prefix.
4909 $wgCookiePrefix = false;
4912 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
4913 * in browsers that support this feature. This can mitigates some classes of
4916 $wgCookieHttpOnly = true;
4919 * A list of cookies that vary the cache (for use by extensions)
4921 $wgCacheVaryCookies = array();
4924 * Override to customise the session name
4926 $wgSessionName = false;
4928 /** @} */ # end of cookie settings }
4930 /************************************************************************//**
4931 * @name LaTeX (mathematical formulas)
4936 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
4937 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
4938 * (ImageMagick) installed and available in the PATH.
4939 * Please see math/README for more information.
4943 /** @} */ # end LaTeX }
4945 /************************************************************************//**
4946 * @name Profiling, testing and debugging
4948 * To enable profiling, edit StartProfiler.php
4954 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
4955 * The debug log file should be not be publicly accessible if it is used, as it
4956 * may contain private data.
4958 $wgDebugLogFile = '';
4961 * Prefix for debug log lines
4963 $wgDebugLogPrefix = '';
4966 * If true, instead of redirecting, show a page with a link to the redirect
4967 * destination. This allows for the inspection of PHP error messages, and easy
4968 * resubmission of form data. For developer use only.
4970 $wgDebugRedirects = false;
4973 * If true, log debugging data from action=raw and load.php.
4974 * This is normally false to avoid overlapping debug entries due to gen=css
4975 * and gen=js requests.
4977 $wgDebugRawPage = false;
4980 * Send debug data to an HTML comment in the output.
4982 * This may occasionally be useful when supporting a non-technical end-user.
4983 * It's more secure than exposing the debug log file to the web, since the
4984 * output only contains private data for the current user. But it's not ideal
4985 * for development use since data is lost on fatal errors and redirects.
4987 $wgDebugComments = false;
4990 * Extensive database transaction state debugging
4994 $wgDebugDBTransactions = false;
4997 * Write SQL queries to the debug log.
4999 * This setting is only used $wgLBFactoryConf['class'] is set to
5000 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5001 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5002 * connection to achieve the same functionality.
5004 $wgDebugDumpSql = false;
5007 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5011 $wgDebugDumpSqlLength = 500;
5014 * Map of string log group names to log destinations.
5016 * If set, wfDebugLog() output for that group will go to that file instead
5017 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5020 * Log destinations may be one of the following:
5021 * - false to completely remove from the output, including from $wgDebugLogFile.
5022 * - string values specifying a filename or URI.
5023 * - associative array mapping 'destination' key to the desired filename or URI.
5024 * The associative array may also contain a 'sample' key with an integer value,
5025 * specifying a sampling factor.
5029 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5032 * @par Advanced example:
5034 * $wgDebugLogGroups['memcached'] = (
5035 * 'destination' => '/var/log/mediawiki/memcached.log',
5036 * 'sample' => 1000, // log 1 message out of every 1,000.
5040 $wgDebugLogGroups = array();
5043 * Display debug data at the bottom of the main content area.
5045 * Useful for developers and technical users trying to working on a closed wiki.
5047 $wgShowDebug = false;
5050 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5051 * Since 1.19 also includes memory usage.
5053 $wgDebugTimestamps = false;
5056 * Print HTTP headers for every request in the debug information.
5058 $wgDebugPrintHttpHeaders = true;
5061 * Show the contents of $wgHooks in Special:Version
5063 $wgSpecialVersionShowHooks = false;
5066 * Whether to show "we're sorry, but there has been a database error" pages.
5067 * Displaying errors aids in debugging, but may display information useful
5070 $wgShowSQLErrors = false;
5073 * If set to true, uncaught exceptions will print a complete stack trace
5074 * to output. This should only be used for debugging, as it may reveal
5075 * private information in function parameters due to PHP's backtrace
5078 $wgShowExceptionDetails = false;
5081 * If true, show a backtrace for database errors
5083 * @note This setting only applies when connection errors and query errors are
5084 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5085 * including those in which an uncaught exception is thrown from within the
5086 * exception handler.
5088 $wgShowDBErrorBacktrace = false;
5091 * If true, send the exception backtrace to the error log
5093 $wgLogExceptionBacktrace = true;
5096 * Expose backend server host names through the API and various HTML comments
5098 $wgShowHostnames = false;
5101 * Override server hostname detection with a hardcoded value.
5102 * Should be a string, default false.
5105 $wgOverrideHostname = false;
5108 * If set to true MediaWiki will throw notices for some possible error
5109 * conditions and for deprecated functions.
5111 $wgDevelopmentWarnings = false;
5114 * Release limitation to wfDeprecated warnings, if set to a release number
5115 * development warnings will not be generated for deprecations added in releases
5118 $wgDeprecationReleaseLimit = false;
5121 * Only record profiling info for pages that took longer than this
5123 $wgProfileLimit = 0.0;
5126 * Don't put non-profiling info into log file
5128 * @deprecated since 1.23, set the log file in
5129 * $wgDebugLogGroups['profileoutput'] instead.
5131 $wgProfileOnly = false;
5134 * If true, print a raw call tree instead of per-function report
5136 $wgProfileCallTree = false;
5139 * Should application server host be put into profiling table
5141 $wgProfilePerHost = false;
5144 * Host for UDP profiler.
5146 * The host should be running a daemon which can be obtained from MediaWiki
5148 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5150 $wgUDPProfilerHost = '127.0.0.1';
5153 * Port for UDP profiler.
5154 * @see $wgUDPProfilerHost
5156 $wgUDPProfilerPort = '3811';
5159 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5160 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name) as arguments.
5161 * You can use sprintf's argument numbering/swapping capability to repeat,
5162 * re-order or omit fields.
5164 * @see $wgStatsFormatString
5167 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5170 * Output debug message on every wfProfileIn/wfProfileOut
5172 $wgDebugFunctionEntry = false;
5175 * Destination for wfIncrStats() data...
5176 * 'cache' to go into the system cache, if enabled (memcached)
5177 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5180 $wgStatsMethod = 'cache';
5183 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5184 * be aggregated over more than one wiki. The string will be used in place of
5185 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5188 $wgAggregateStatsID = false;
5191 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5192 * formatted. Its value should be a format string suitable for a sprintf()
5193 * invocation with (id, count, key) arguments, where 'id' is either
5194 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5195 * is being incremented, and 'key' is the metric name.
5197 * @see $wgUDPProfilerFormatString
5198 * @see $wgAggregateStatsID
5201 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5204 * Whereas to count the number of time an article is viewed.
5205 * Does not work if pages are cached (for example with squid).
5207 $wgDisableCounters = false;
5210 * InfoAction retrieves a list of transclusion links (both to and from).
5211 * This number puts a limit on that query in the case of highly transcluded
5214 $wgPageInfoTransclusionLimit = 50;
5217 * Set this to an integer to only do synchronous site_stats updates
5218 * one every *this many* updates. The other requests go into pending
5219 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5220 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5222 $wgSiteStatsAsyncFactor = false;
5225 * Parser test suite files to be run by parserTests.php when no specific
5226 * filename is passed to it.
5228 * Extensions may add their own tests to this array, or site-local tests
5229 * may be added via LocalSettings.php
5233 $wgParserTestFiles = array(
5234 "$IP/tests/parser/parserTests.txt",
5235 "$IP/tests/parser/extraParserTests.txt"
5239 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5241 $wgEnableJavaScriptTest = false;
5244 * Configuration for javascript testing.
5246 $wgJavaScriptTestConfig = array(
5248 // Page where documentation can be found relevant to the QUnit test suite being ran.
5249 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5250 // documentation link in the "javascripttest-qunit-intro" message.
5251 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5252 // If you are submitting the QUnit test suite to a TestSwarm instance,
5253 // point this to the "inject.js" script of that instance. This is was registers
5254 // the QUnit hooks to extract the test results and push them back up into the
5255 // TestSwarm database.
5256 // @example 'http://localhost/testswarm/js/inject.js'
5257 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5258 'testswarm-injectjs' => false,
5263 * Overwrite the caching key prefix with custom value.
5266 $wgCachePrefix = false;
5269 * Display the new debugging toolbar. This also enables profiling on database
5270 * queries and other useful output.
5271 * Will disable file cache.
5275 $wgDebugToolbar = false;
5277 /** @} */ # end of profiling, testing and debugging }
5279 /************************************************************************//**
5285 * Set this to true to disable the full text search feature.
5287 $wgDisableTextSearch = false;
5290 * Set to true to have nicer highlighted text in search results,
5291 * by default off due to execution overhead
5293 $wgAdvancedSearchHighlighting = false;
5296 * Regexp to match word boundaries, defaults for non-CJK languages
5297 * should be empty for CJK since the words are not separate
5299 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5302 * Template for OpenSearch suggestions, defaults to API action=opensearch
5304 * Sites with heavy load would typically have these point to a custom
5305 * PHP wrapper to avoid firing up mediawiki for every keystroke
5307 * Placeholders: {searchTerms}
5309 $wgOpenSearchTemplate = false;
5312 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5313 * false if you've disabled scripts that use api?action=opensearch and
5314 * want reduce load caused by cached scripts still pulling suggestions.
5315 * It will let the API fallback by responding with an empty array.
5317 $wgEnableOpenSearchSuggest = true;
5320 * Integer defining default number of entries to show on
5323 $wgOpenSearchDefaultLimit = 10;
5326 * Expiry time for search suggestion responses
5328 $wgSearchSuggestCacheExpiry = 1200;
5331 * If you've disabled search semi-permanently, this also disables updates to the
5332 * table. If you ever re-enable, be sure to rebuild the search table.
5334 $wgDisableSearchUpdate = false;
5337 * List of namespaces which are searched by default.
5341 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5342 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5345 $wgNamespacesToBeSearchedDefault = array(
5350 * Disable the internal MySQL-based search, to allow it to be
5351 * implemented by an extension instead.
5353 $wgDisableInternalSearch = false;
5356 * Set this to a URL to forward search requests to some external location.
5357 * If the URL includes '$1', this will be replaced with the URL-encoded
5361 * To forward to Google you'd have something like:
5363 * $wgSearchForwardUrl =
5364 * 'http://www.google.com/search?q=$1' .
5365 * '&domains=http://example.com' .
5366 * '&sitesearch=http://example.com' .
5367 * '&ie=utf-8&oe=utf-8';
5370 $wgSearchForwardUrl = null;
5373 * Search form behavior.
5374 * - true = use Go & Search buttons
5375 * - false = use Go button & Advanced search link
5377 $wgUseTwoButtonsSearchForm = true;
5380 * Array of namespaces to generate a Google sitemap for when the
5381 * maintenance/generateSitemap.php script is run, or false if one is to be
5382 * generated for all namespaces.
5384 $wgSitemapNamespaces = false;
5387 * Custom namespace priorities for sitemaps. Setting this will allow you to
5388 * set custom priorities to namespaces when sitemaps are generated using the
5389 * maintenance/generateSitemap.php script.
5391 * This should be a map of namespace IDs to priority
5394 * $wgSitemapNamespacesPriorities = array(
5400 $wgSitemapNamespacesPriorities = false;
5403 * If true, searches for IP addresses will be redirected to that IP's
5404 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5405 * [[Special:Contributions/1.2.3.4]]
5407 $wgEnableSearchContributorsByIP = true;
5409 /** @} */ # end of search settings
5411 /************************************************************************//**
5412 * @name Edit user interface
5417 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5418 * fall back to the old behavior (no merging).
5420 $wgDiff3 = '/usr/bin/diff3';
5423 * Path to the GNU diff utility.
5425 $wgDiff = '/usr/bin/diff';
5428 * Which namespaces have special treatment where they should be preview-on-open
5429 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5430 * can specify namespaces of pages they have special treatment for
5432 $wgPreviewOnOpenNamespaces = array(
5437 * Go button goes straight to the edit screen if the article doesn't exist.
5439 $wgGoToEdit = false;
5442 * Enable the UniversalEditButton for browsers that support it
5443 * (currently only Firefox with an extension)
5444 * See http://universaleditbutton.org for more background information
5446 $wgUniversalEditButton = true;
5449 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5450 * will try to automatically create one. This feature can be disabled by set-
5451 * ting this variable false.
5453 $wgUseAutomaticEditSummaries = true;
5455 /** @} */ # end edit UI }
5457 /************************************************************************//**
5459 * See also $wgSiteNotice
5464 * @cond file_level_code
5465 * Set $wgCommandLineMode if it's not set already, to avoid notices
5467 if ( !isset( $wgCommandLineMode ) ) {
5468 $wgCommandLineMode = false;
5473 * For colorized maintenance script output, is your terminal background dark ?
5475 $wgCommandLineDarkBg = false;
5478 * Set this to a string to put the wiki into read-only mode. The text will be
5479 * used as an explanation to users.
5481 * This prevents most write operations via the web interface. Cache updates may
5482 * still be possible. To prevent database writes completely, use the read_only
5488 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5489 * Its contents will be shown to users as part of the read-only warning
5492 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5494 $wgReadOnlyFile = false;
5497 * When you run the web-based upgrade utility, it will tell you what to set
5498 * this to in order to authorize the upgrade process. It will subsequently be
5499 * used as a password, to authorize further upgrades.
5501 * For security, do not set this to a guessable string. Use the value supplied
5502 * by the install/upgrade process. To cause the upgrader to generate a new key,
5503 * delete the old key from LocalSettings.php.
5505 $wgUpgradeKey = false;
5508 * Fully specified path to git binary
5510 $wgGitBin = '/usr/bin/git';
5513 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5515 * Key is a pattern passed to preg_match() and preg_replace(),
5516 * without the delimiters (which are #) and must match the whole URL.
5517 * The value is the replacement for the key (it can contain $1, etc.)
5518 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5519 * full SHA-1 of the HEAD revision.
5520 * %r will be replaced with a URL-encoded version of $1.
5524 $wgGitRepositoryViewers = array(
5525 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5526 'https://git.wikimedia.org/commit/%r/%H',
5527 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5528 'https://git.wikimedia.org/commit/%r/%H',
5531 /** @} */ # End of maintenance }
5533 /************************************************************************//**
5534 * @name Recent changes, new pages, watchlist and history
5539 * Recentchanges items are periodically purged; entries older than this many
5541 * Default: 13 weeks = about three months
5543 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5546 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5547 * higher than what will be stored. Note that this is disabled by default
5548 * because we sometimes do have RC data which is beyond the limit for some
5549 * reason, and some users may use the high numbers to display that data which
5552 $wgRCFilterByAge = false;
5555 * List of Limits options to list in the Special:Recentchanges and
5556 * Special:Recentchangeslinked pages.
5558 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5561 * List of Days options to list in the Special:Recentchanges and
5562 * Special:Recentchangeslinked pages.
5564 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5567 * Send recent changes updates via UDP. The updates will be formatted for IRC.
5568 * Set this to the IP address of the receiver.
5570 * @deprecated since 1.22, use $wgRCFeeds
5572 $wgRC2UDPAddress = false;
5575 * Port number for RC updates
5577 * @deprecated since 1.22, use $wgRCFeeds
5579 $wgRC2UDPPort = false;
5582 * Prefix to prepend to each UDP packet.
5583 * This can be used to identify the wiki. A script is available called
5584 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
5585 * tab to identify the IRC channel to send the log line to.
5587 * @deprecated since 1.22, use $wgRCFeeds
5589 $wgRC2UDPPrefix = '';
5592 * If this is set to true, the first entry in the $wgLocalInterwikis array (or
5593 * the value of $wgLocalInterwiki, if set) will be prepended to links in the IRC
5594 * feed. If this is set to a string, that string will be used as the prefix.
5596 * @deprecated since 1.22, use $wgRCFeeds
5598 $wgRC2UDPInterwikiPrefix = false;
5601 * Set to true to omit "bot" edits (by users with the bot permission) from the
5604 * @deprecated since 1.22, use $wgRCFeeds
5606 $wgRC2UDPOmitBots = false;
5609 * Destinations to which notifications about recent changes
5612 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5613 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5615 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5617 * The common options are:
5618 * * 'uri' -- the address to which the notices are to be sent.
5619 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5620 * produce the text to send. This can also be an object of the class.
5621 * * 'omit_bots' -- whether the bot edits should be in the feed
5622 * * 'omit_anon' -- whether anonymous edits should be in the feed
5623 * * 'omit_user' -- whether edits by registered users should be in the feed
5624 * * 'omit_minor' -- whether minor edits should be in the feed
5625 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5627 * The IRC-specific options are:
5628 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5629 * the first entry in the $wgLocalInterwikis array (or the value of
5630 * $wgLocalInterwiki, if set)
5632 * The JSON-specific options are:
5633 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5635 * To ensure backwards-compatibility, whenever $wgRC2UDPAddress is set, a
5636 * 'default' feed will be created reusing the deprecated $wgRC2UDP* variables.
5638 * @example $wgRCFeeds['example'] = array(
5639 * 'formatter' => 'JSONRCFeedFormatter',
5640 * 'uri' => "udp://localhost:1336",
5641 * 'add_interwiki_prefix' => false,
5642 * 'omit_bots' => true,
5644 * @example $wgRCFeeds['exampleirc'] = array(
5645 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5646 * 'uri' => "udp://localhost:1338",
5647 * 'add_interwiki_prefix' => false,
5648 * 'omit_bots' => true,
5652 $wgRCFeeds = array();
5655 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5656 * Keys are scheme names, values are names of engine classes.
5658 $wgRCEngines = array(
5659 'redis' => 'RedisPubSubFeedEngine',
5660 'udp' => 'UDPRCFeedEngine',
5664 * Use RC Patrolling to check for vandalism
5666 $wgUseRCPatrol = true;
5669 * Use new page patrolling to check new pages on Special:Newpages
5671 $wgUseNPPatrol = true;
5674 * Log autopatrol actions to the log table
5676 $wgLogAutopatrol = true;
5679 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5684 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5685 * eg Recentchanges, Newpages.
5690 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5691 * A cached version will continue to be served out even if changes
5692 * are made, until this many seconds runs out since the last render.
5694 * If set to 0, feed caching is disabled. Use this for debugging only;
5695 * feed generation can be pretty slow with diffs.
5697 $wgFeedCacheTimeout = 60;
5700 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5701 * pages larger than this size.
5703 $wgFeedDiffCutoff = 32768;
5706 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5707 * every page. Some sites might have a different feed they'd like to promote
5708 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5709 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5712 * Configure the 'atom' feed to http://example.com/somefeed.xml
5714 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5717 $wgOverrideSiteFeed = array();
5720 * Available feeds objects.
5721 * Should probably only be defined when a page is syndicated ie when
5722 * $wgOut->isSyndicated() is true.
5724 $wgFeedClasses = array(
5726 'atom' => 'AtomFeed',
5730 * Which feed types should we provide by default? This can include 'rss',
5731 * 'atom', neither, or both.
5733 $wgAdvertisedFeedTypes = array( 'atom' );
5736 * Show watching users in recent changes, watchlist and page history views
5738 $wgRCShowWatchingUsers = false; # UPO
5741 * Show watching users in Page views
5743 $wgPageShowWatchingUsers = false;
5746 * Show the amount of changed characters in recent changes
5748 $wgRCShowChangedSize = true;
5751 * If the difference between the character counts of the text
5752 * before and after the edit is below that value, the value will be
5753 * highlighted on the RC page.
5755 $wgRCChangedSizeThreshold = 500;
5758 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5759 * view for watched pages with new changes
5761 $wgShowUpdatedMarker = true;
5764 * Disable links to talk pages of anonymous users (IPs) in listings on special
5765 * pages like page history, Special:Recentchanges, etc.
5767 $wgDisableAnonTalk = false;
5770 * Enable filtering of categories in Recentchanges
5772 $wgAllowCategorizedRecentChanges = false;
5775 * Allow filtering by change tag in recentchanges, history, etc
5776 * Has no effect if no tags are defined in valid_tag.
5778 $wgUseTagFilter = true;
5781 * If set to an integer, pages that are watched by this many users or more
5782 * will not require the unwatchedpages permission to view the number of
5787 $wgUnwatchedPageThreshold = false;
5790 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5791 * certain types of edits.
5793 * To register a new one:
5795 * $wgRecentChangesFlags['flag'] => array(
5796 * // message for the letter displayed next to rows on changes lists
5797 * 'letter' => 'letter-msg',
5798 * // message for the tooltip of the letter
5799 * 'title' => 'tooltip-msg',
5800 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
5801 * 'legend' => 'legend-msg',
5802 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
5803 * 'class' => 'css-class',
5809 $wgRecentChangesFlags = array(
5811 'letter' => 'newpageletter',
5812 'title' => 'recentchanges-label-newpage',
5813 'legend' => 'recentchanges-legend-newpage',
5816 'letter' => 'minoreditletter',
5817 'title' => 'recentchanges-label-minor',
5818 'legend' => 'recentchanges-legend-minor',
5819 'class' => 'minoredit',
5822 'letter' => 'boteditletter',
5823 'title' => 'recentchanges-label-bot',
5824 'legend' => 'recentchanges-legend-bot',
5825 'class' => 'botedit',
5827 'unpatrolled' => array(
5828 'letter' => 'unpatrolledletter',
5829 'title' => 'recentchanges-label-unpatrolled',
5830 'legend' => 'recentchanges-legend-unpatrolled',
5834 /** @} */ # end RC/watchlist }
5836 /************************************************************************//**
5837 * @name Copyright and credits settings
5842 * Override for copyright metadata.
5844 * This is the name of the page containing information about the wiki's copyright status,
5845 * which will be added as a link in the footer if it is specified. It overrides
5846 * $wgRightsUrl if both are specified.
5848 $wgRightsPage = null;
5851 * Set this to specify an external URL containing details about the content license used on your
5853 * If $wgRightsPage is set then this setting is ignored.
5855 $wgRightsUrl = null;
5858 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5860 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5861 * of the page will also be used as the link if this variable is not set.
5863 $wgRightsText = null;
5866 * Override for copyright metadata.
5868 $wgRightsIcon = null;
5871 * Set this to some HTML to override the rights icon with an arbitrary logo
5872 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5874 $wgCopyrightIcon = null;
5877 * Set this to true if you want detailed copyright information forms on Upload.
5879 $wgUseCopyrightUpload = false;
5882 * Set this to the number of authors that you want to be credited below an
5883 * article text. Set it to zero to hide the attribution block, and a negative
5884 * number (like -1) to show all authors. Note that this will require 2-3 extra
5885 * database hits, which can have a not insignificant impact on performance for
5891 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5892 * Otherwise, link to a separate credits page.
5894 $wgShowCreditsIfMax = true;
5896 /** @} */ # end of copyright and credits settings }
5898 /************************************************************************//**
5899 * @name Import / Export
5904 * List of interwiki prefixes for wikis we'll accept as sources for
5905 * Special:Import (for sysops). Since complete page history can be imported,
5906 * these should be 'trusted'.
5908 * If a user has the 'import' permission but not the 'importupload' permission,
5909 * they will only be able to run imports through this transwiki interface.
5911 $wgImportSources = array();
5914 * Optional default target namespace for interwiki imports.
5915 * Can use this to create an incoming "transwiki"-style queue.
5916 * Set to numeric key, not the name.
5918 * Users may override this in the Special:Import dialog.
5920 $wgImportTargetNamespace = null;
5923 * If set to false, disables the full-history option on Special:Export.
5924 * This is currently poorly optimized for long edit histories, so is
5925 * disabled on Wikimedia's sites.
5927 $wgExportAllowHistory = true;
5930 * If set nonzero, Special:Export requests for history of pages with
5931 * more revisions than this will be rejected. On some big sites things
5932 * could get bogged down by very very long pages.
5934 $wgExportMaxHistory = 0;
5937 * Return distinct author list (when not returning full history)
5939 $wgExportAllowListContributors = false;
5942 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
5943 * up to this specified level, which will cause it to include all
5944 * pages linked to from the pages you specify. Since this number
5945 * can become *insanely large* and could easily break your wiki,
5946 * it's disabled by default for now.
5948 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
5949 * crazy-big export from being done by someone setting the depth number too
5950 * high. In other words, last resort safety net.
5952 $wgExportMaxLinkDepth = 0;
5955 * Whether to allow the "export all pages in namespace" option
5957 $wgExportFromNamespaces = false;
5960 * Whether to allow exporting the entire wiki into a single file
5962 $wgExportAllowAll = false;
5964 /** @} */ # end of import/export }
5966 /*************************************************************************//**
5972 * A list of callback functions which are called once MediaWiki is fully
5975 $wgExtensionFunctions = array();
5978 * Extension messages files.
5980 * Associative array mapping extension name to the filename where messages can be
5981 * found. The file should contain variable assignments. Any of the variables
5982 * present in languages/messages/MessagesEn.php may be defined, but $messages
5983 * is the most common.
5985 * Variables defined in extensions will override conflicting variables defined
5988 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
5989 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
5990 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
5991 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
5993 * Extensions using the JSON message format can preserve backward compatibility with
5994 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
5995 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
5996 * as for the $wgMessagesDirs entry.
6000 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6003 $wgExtensionMessagesFiles = array();
6006 * Extension messages directories.
6008 * Associative array mapping extension name to the path of the directory where message files can
6009 * be found. The message files are expected to be JSON files named for their language code, e.g.
6010 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6011 * message directories.
6013 * @par Simple example:
6015 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6018 * @par Complex example:
6020 * $wgMessagesDirs['Example'] = array(
6021 * __DIR__ . '/lib/ve/i18n',
6022 * __DIR__ . '/lib/oojs-ui/i18n',
6023 * __DIR__ . '/i18n',
6028 $wgMessagesDirs = array(
6029 'core' => "$IP/languages/i18n",
6030 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
6034 * Array of files with list(s) of extension entry points to be used in
6035 * maintenance/mergeMessageFileList.php
6038 $wgExtensionEntryPointListFiles = array();
6041 * Parser output hooks.
6042 * This is an associative array where the key is an extension-defined tag
6043 * (typically the extension name), and the value is a PHP callback.
6044 * These will be called as an OutputPageParserOutput hook, if the relevant
6045 * tag has been registered with the parser output object.
6047 * Registration is done with $pout->addOutputHook( $tag, $data ).
6049 * The callback has the form:
6051 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6054 $wgParserOutputHooks = array();
6057 * Whether to include the NewPP limit report as a HTML comment
6059 $wgEnableParserLimitReporting = true;
6062 * List of valid skin names
6064 * The key should be the name in all lower case, the value should be a properly
6065 * cased name for the skin. This value will be prefixed with "Skin" to create
6066 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6067 * if you wish to have access to the full list.
6069 $wgValidSkinNames = array();
6072 * Special page list.
6073 * See the top of SpecialPage.php for documentation.
6075 $wgSpecialPages = array();
6078 * Array mapping class names to filenames, for autoloading.
6080 $wgAutoloadClasses = array();
6083 * Switch controlling legacy case-insensitive classloading.
6084 * Do not disable if your wiki must support data created by PHP4, or by
6085 * MediaWiki 1.4 or earlier.
6087 $wgAutoloadAttemptLowercase = true;
6090 * An array of information about installed extensions keyed by their type.
6092 * All but 'name', 'path' and 'author' can be omitted.
6095 * $wgExtensionCredits[$type][] = array(
6096 * 'path' => __FILE__,
6097 * 'name' => 'Example extension',
6098 * 'namemsg' => 'exampleextension-name',
6099 * 'author' => array(
6102 * 'version' => '1.9.0',
6103 * 'url' => 'http://example.org/example-extension/',
6104 * 'descriptionmsg' => 'exampleextension-desc',
6105 * 'license-name' => 'GPL-2.0',
6109 * The extensions are listed on Special:Version. This page also looks for a file
6110 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6111 * view said file. When the 'license-name' key is specified, this file is
6112 * interpreted as wikitext.
6114 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6115 * 'skin', 'api', or 'other', or any additional types as specified through the
6116 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6118 * - name: Name of extension as an inline string instead of localizable message.
6119 * Do not omit this even if 'namemsg' is provided, as it is used to override
6120 * the path Special:Version uses to find extension's license info, and is
6121 * required for backwards-compatibility with MediaWiki 1.23 and older.
6123 * - namemsg (since MW 1.24): A message key for a message containing the
6124 * extension's name, if the name is localizable. (For example, skin names
6127 * - author: A string or an array of strings. Authors can be linked using
6128 * the regular wikitext link syntax. To have an internationalized version of
6129 * "and others" show, add an element "...". This element can also be linked,
6130 * for instance "[http://example ...]".
6132 * - descriptionmsg: A message key or an an array with message key and parameters:
6133 * `'descriptionmsg' => 'exampleextension-desc',`
6135 * - description: Description of extension as an inline string instead of
6136 * localizable message (omit in favour of 'descriptionmsg').
6138 * - license-name: Short name of the license (used as label for the link), such
6139 * as "GPL-2.0" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6141 $wgExtensionCredits = array();
6144 * Authentication plugin.
6145 * @var $wgAuth AuthPlugin
6150 * Global list of hooks.
6152 * The key is one of the events made available by MediaWiki, you can find
6153 * a description for most of them in docs/hooks.txt. The array is used
6154 * internally by Hook:run().
6156 * The value can be one of:
6158 * - A function name:
6160 * $wgHooks['event_name'][] = $function;
6162 * - A function with some data:
6164 * $wgHooks['event_name'][] = array( $function, $data );
6166 * - A an object method:
6168 * $wgHooks['event_name'][] = array( $object, 'method' );
6172 * $wgHooks['event_name'][] = function ( $hookParam ) {
6173 * // Handler code goes here.
6177 * @warning You should always append to an event array or you will end up
6178 * deleting a previous registered hook.
6180 * @warning Hook handlers should be registered at file scope. Registering
6181 * handlers after file scope can lead to unexpected results due to caching.
6186 * Maps jobs to their handling classes; extensions
6187 * can add to this to provide custom jobs
6189 $wgJobClasses = array(
6190 'refreshLinks' => 'RefreshLinksJob',
6191 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6192 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6193 'sendMail' => 'EmaillingJob',
6194 'enotifNotify' => 'EnotifNotifyJob',
6195 'fixDoubleRedirect' => 'DoubleRedirectJob',
6196 'uploadFromUrl' => 'UploadFromUrlJob',
6197 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6198 'PublishStashedFile' => 'PublishStashedFileJob',
6203 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6204 * special flags are set. The values here are keys of $wgJobClasses.
6207 * - Very long-running jobs.
6208 * - Jobs that you would never want to run as part of a page rendering request.
6209 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6210 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6211 * These settings should be global to all wikis.
6213 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6216 * Map of job types to how many job "work items" should be run per second
6217 * on each job runner process. The meaning of "work items" varies per job,
6218 * but typically would be something like "pages to update". A single job
6219 * may have a variable number of work items, as is the case with batch jobs.
6220 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6221 * These settings should be global to all wikis.
6224 $wgJobBackoffThrottling = array();
6227 * Map of job types to configuration arrays.
6228 * This determines which queue class and storage system is used for each job type.
6229 * Job types that do not have explicit configuration will use the 'default' config.
6230 * These settings should be global to all wikis.
6232 $wgJobTypeConf = array(
6233 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6237 * Which aggregator to use for tracking which queues have jobs.
6238 * These settings should be global to all wikis.
6240 $wgJobQueueAggregator = array(
6241 'class' => 'JobQueueAggregatorMemc'
6245 * Additional functions to be performed with updateSpecialPages.
6246 * Expensive Querypages are already updated.
6248 $wgSpecialPageCacheUpdates = array(
6249 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6250 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6254 * Hooks that are used for outputting exceptions. Format is:
6255 * $wgExceptionHooks[] = $funcname
6257 * $wgExceptionHooks[] = array( $class, $funcname )
6258 * Hooks should return strings or false
6260 $wgExceptionHooks = array();
6263 * Page property link table invalidation lists. When a page property
6264 * changes, this may require other link tables to be updated (eg
6265 * adding __HIDDENCAT__ means the hiddencat tracking category will
6266 * have been added, so the categorylinks table needs to be rebuilt).
6267 * This array can be added to by extensions.
6269 $wgPagePropLinkInvalidations = array(
6270 'hiddencat' => 'categorylinks',
6273 /** @} */ # End extensions }
6275 /*************************************************************************//**
6281 * Use experimental, DMOZ-like category browser
6283 $wgUseCategoryBrowser = false;
6286 * On category pages, show thumbnail gallery for images belonging to that
6287 * category instead of listing them as articles.
6289 $wgCategoryMagicGallery = true;
6292 * Paging limit for categories
6294 $wgCategoryPagingLimit = 200;
6297 * Specify how category names should be sorted, when listed on a category page.
6298 * A sorting scheme is also known as a collation.
6300 * Available values are:
6302 * - uppercase: Converts the category name to upper case, and sorts by that.
6304 * - identity: Does no conversion. Sorts by binary value of the string.
6306 * - uca-default: Provides access to the Unicode Collation Algorithm with
6307 * the default element table. This is a compromise collation which sorts
6308 * all languages in a mediocre way. However, it is better than "uppercase".
6310 * To use the uca-default collation, you must have PHP's intl extension
6311 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6312 * resulting collation will depend on the version of ICU installed on the
6315 * After you change this, you must run maintenance/updateCollation.php to fix
6316 * the sort keys in the database.
6318 * Extensions can define there own collations by subclassing Collation
6319 * and using the Collation::factory hook.
6321 $wgCategoryCollation = 'uppercase';
6323 /** @} */ # End categories }
6325 /*************************************************************************//**
6331 * The logging system has two levels: an event type, which describes the
6332 * general category and can be viewed as a named subset of all logs; and
6333 * an action, which is a specific kind of event that can exist in that
6336 $wgLogTypes = array(
6351 * This restricts log access to those who have a certain right
6352 * Users without this will not see it in the option menu and can not view it
6353 * Restricted logs are not added to recent changes
6354 * Logs should remain non-transcludable
6355 * Format: logtype => permissiontype
6357 $wgLogRestrictions = array(
6358 'suppress' => 'suppressionlog'
6362 * Show/hide links on Special:Log will be shown for these log types.
6364 * This is associative array of log type => boolean "hide by default"
6366 * See $wgLogTypes for a list of available log types.
6370 * $wgFilterLogTypes = array(
6372 * 'import' => false,
6376 * Will display show/hide links for the move and import logs. Move logs will be
6377 * hidden by default unless the link is clicked. Import logs will be shown by
6378 * default, and hidden when the link is clicked.
6380 * A message of the form log-show-hide-[type] should be added, and will be used
6381 * for the link text.
6383 $wgFilterLogTypes = array(
6388 * Lists the message key string for each log type. The localized messages
6389 * will be listed in the user interface.
6391 * Extensions with custom log types may add to this array.
6393 * @since 1.19, if you follow the naming convention log-name-TYPE,
6394 * where TYPE is your log type, yoy don't need to use this array.
6396 $wgLogNames = array(
6397 '' => 'all-logs-page',
6398 'block' => 'blocklogpage',
6399 'protect' => 'protectlogpage',
6400 'rights' => 'rightslog',
6401 'delete' => 'dellogpage',
6402 'upload' => 'uploadlogpage',
6403 'move' => 'movelogpage',
6404 'import' => 'importlogpage',
6405 'patrol' => 'patrol-log-page',
6406 'merge' => 'mergelog',
6407 'suppress' => 'suppressionlog',
6411 * Lists the message key string for descriptive text to be shown at the
6412 * top of each log type.
6414 * Extensions with custom log types may add to this array.
6416 * @since 1.19, if you follow the naming convention log-description-TYPE,
6417 * where TYPE is your log type, yoy don't need to use this array.
6419 $wgLogHeaders = array(
6420 '' => 'alllogstext',
6421 'block' => 'blocklogtext',
6422 'protect' => 'protectlogtext',
6423 'rights' => 'rightslogtext',
6424 'delete' => 'dellogpagetext',
6425 'upload' => 'uploadlogpagetext',
6426 'move' => 'movelogpagetext',
6427 'import' => 'importlogpagetext',
6428 'patrol' => 'patrol-log-header',
6429 'merge' => 'mergelogpagetext',
6430 'suppress' => 'suppressionlogtext',
6434 * Lists the message key string for formatting individual events of each
6435 * type and action when listed in the logs.
6437 * Extensions with custom log types may add to this array.
6439 $wgLogActions = array(
6440 'block/block' => 'blocklogentry',
6441 'block/unblock' => 'unblocklogentry',
6442 'block/reblock' => 'reblock-logentry',
6443 'protect/protect' => 'protectedarticle',
6444 'protect/modify' => 'modifiedarticleprotection',
6445 'protect/unprotect' => 'unprotectedarticle',
6446 'protect/move_prot' => 'movedarticleprotection',
6447 'upload/upload' => 'uploadedimage',
6448 'upload/overwrite' => 'overwroteimage',
6449 'upload/revert' => 'uploadedimage',
6450 'import/upload' => 'import-logentry-upload',
6451 'import/interwiki' => 'import-logentry-interwiki',
6452 'merge/merge' => 'pagemerge-logentry',
6453 'suppress/block' => 'blocklogentry',
6454 'suppress/reblock' => 'reblock-logentry',
6458 * The same as above, but here values are names of functions,
6460 * @see LogPage::actionText
6463 $wgLogActionsHandlers = array(
6464 'move/move' => 'MoveLogFormatter',
6465 'move/move_redir' => 'MoveLogFormatter',
6466 'delete/delete' => 'DeleteLogFormatter',
6467 'delete/restore' => 'DeleteLogFormatter',
6468 'delete/revision' => 'DeleteLogFormatter',
6469 'delete/event' => 'DeleteLogFormatter',
6470 'suppress/revision' => 'DeleteLogFormatter',
6471 'suppress/event' => 'DeleteLogFormatter',
6472 'suppress/delete' => 'DeleteLogFormatter',
6473 'patrol/patrol' => 'PatrolLogFormatter',
6474 'rights/rights' => 'RightsLogFormatter',
6475 'rights/autopromote' => 'RightsLogFormatter',
6479 * Maintain a log of newusers at Log/newusers?
6481 $wgNewUserLog = true;
6483 /** @} */ # end logging }
6485 /*************************************************************************//**
6486 * @name Special pages (general and miscellaneous)
6491 * Allow special page inclusions such as {{Special:Allpages}}
6493 $wgAllowSpecialInclusion = true;
6496 * Set this to an array of special page names to prevent
6497 * maintenance/updateSpecialPages.php from updating those pages.
6499 $wgDisableQueryPageUpdate = false;
6502 * List of special pages, followed by what subtitle they should go under
6503 * at Special:SpecialPages
6505 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6507 $wgSpecialPageGroups = array();
6510 * Whether or not to sort special pages in Special:Specialpages
6512 $wgSortSpecialPages = true;
6515 * On Special:Unusedimages, consider images "used", if they are put
6516 * into a category. Default (false) is not to count those as used.
6518 $wgCountCategorizedImagesAsUsed = false;
6521 * Maximum number of links to a redirect page listed on
6522 * Special:Whatlinkshere/RedirectDestination
6524 $wgMaxRedirectLinksRetrieved = 500;
6526 /** @} */ # end special pages }
6528 /*************************************************************************//**
6534 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6535 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6536 * 'foo' => true Load the class FooAction which subclasses Action
6537 * If something is specified in the getActionOverrides()
6538 * of the relevant Page object it will be used
6539 * instead of the default class.
6540 * 'foo' => false The action is disabled; show an error message
6541 * Unsetting core actions will probably cause things to complain loudly.
6549 'markpatrolled' => true,
6555 'revisiondelete' => true,
6558 'unprotect' => true,
6564 /** @} */ # end actions }
6566 /*************************************************************************//**
6567 * @name Robot (search engine crawler) policy
6568 * See also $wgNoFollowLinks.
6573 * Default robot policy. The default policy is to encourage indexing and fol-
6574 * lowing of links. It may be overridden on a per-namespace and/or per-page
6577 $wgDefaultRobotPolicy = 'index,follow';
6580 * Robot policies per namespaces. The default policy is given above, the array
6581 * is made of namespace constants as defined in includes/Defines.php. You can-
6582 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6583 * nofollow. This is because a number of special pages (e.g., ListPages) have
6584 * many permutations of options that display the same data under redundant
6585 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6586 * pages, all alike, and never reaching your actual content.
6590 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6593 $wgNamespaceRobotPolicies = array();
6596 * Robot policies per article. These override the per-namespace robot policies.
6597 * Must be in the form of an array where the key part is a properly canonicalised
6598 * text form title and the value is a robot policy.
6602 * $wgArticleRobotPolicies = array(
6603 * 'Main Page' => 'noindex,follow',
6604 * 'User:Bob' => 'index,follow',
6608 * @par Example that DOES NOT WORK because the names are not canonical text
6611 * $wgArticleRobotPolicies = array(
6612 * # Underscore, not space!
6613 * 'Main_Page' => 'noindex,follow',
6614 * # "Project", not the actual project name!
6615 * 'Project:X' => 'index,follow',
6616 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6617 * 'abc' => 'noindex,nofollow'
6621 $wgArticleRobotPolicies = array();
6624 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6625 * will not function, so users can't decide whether pages in that namespace are
6626 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6630 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6633 $wgExemptFromUserRobotsControl = null;
6635 /** @} */ # End robot policy }
6637 /************************************************************************//**
6638 * @name AJAX and API
6639 * Note: The AJAX entry point which this section refers to is gradually being
6640 * replaced by the API entry point, api.php. They are essentially equivalent.
6641 * Both of them are used for dynamic client-side features, via XHR.
6646 * Enable the MediaWiki API for convenient access to
6647 * machine-readable data via api.php
6649 * See https://www.mediawiki.org/wiki/API
6651 $wgEnableAPI = true;
6654 * Allow the API to be used to perform write operations
6655 * (page edits, rollback, etc.) when an authorised user
6658 $wgEnableWriteAPI = true;
6662 * WARNING: SECURITY THREAT - debug use only
6664 * Disables many security checks in the API for debugging purposes.
6665 * This flag should never be used on the production servers, as it introduces
6666 * a number of potential security holes. Even when enabled, the validation
6667 * will still be performed, but instead of failing, API will return a warning.
6668 * Also, there will always be a warning notifying that this flag is set.
6669 * At this point, the flag allows GET requests to go through for modules
6674 $wgDebugAPI = false;
6677 * API module extensions.
6678 * Associative array mapping module name to class name.
6679 * Extension modules may override the core modules.
6681 * See ApiMain::$Modules for a list of the core modules.
6683 $wgAPIModules = array();
6686 * API format module extensions.
6687 * Associative array mapping format module name to class name.
6688 * Extension modules may override the core modules.
6690 * See ApiMain::$Formats for a list of the core format modules.
6692 $wgAPIFormatModules = array();
6695 * API Query meta module extensions.
6696 * Associative array mapping meta module name to class name.
6697 * Extension modules may override the core modules.
6699 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6701 $wgAPIMetaModules = array();
6704 * API Query prop module extensions.
6705 * Associative array mapping properties module name to class name.
6706 * Extension modules may override the core modules.
6708 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6710 $wgAPIPropModules = array();
6713 * API Query list module extensions.
6714 * Associative array mapping list module name to class name.
6715 * Extension modules may override the core modules.
6717 * See ApiQuery::$QueryListModules for a list of the core list modules.
6719 $wgAPIListModules = array();
6722 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6723 * @deprecated since 1.21
6725 $wgAPIGeneratorModules = array();
6728 * Maximum amount of rows to scan in a DB query in the API
6729 * The default value is generally fine
6731 $wgAPIMaxDBRows = 5000;
6734 * The maximum size (in bytes) of an API result.
6735 * @warning Do not set this lower than $wgMaxArticleSize*1024
6737 $wgAPIMaxResultSize = 8388608;
6740 * The maximum number of uncached diffs that can be retrieved in one API
6741 * request. Set this to 0 to disable API diffs altogether
6743 $wgAPIMaxUncachedDiffs = 1;
6746 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6747 * API request logging
6749 $wgAPIRequestLog = false;
6752 * Set the timeout for the API help text cache. If set to 0, caching disabled
6754 $wgAPICacheHelpTimeout = 60 * 60;
6757 * The ApiQueryQueryPages module should skip pages that are redundant to true
6760 $wgAPIUselessQueryPages = array(
6761 'MIMEsearch', // aiprop=mime
6762 'LinkSearch', // list=exturlusage
6763 'FileDuplicateSearch', // prop=duplicatefiles
6767 * Enable AJAX framework
6772 * List of Ajax-callable functions.
6773 * Extensions acting as Ajax callbacks must register here
6775 $wgAjaxExportList = array();
6778 * Enable watching/unwatching pages using AJAX.
6779 * Requires $wgUseAjax to be true too.
6781 $wgAjaxWatch = true;
6784 * Enable AJAX check for file overwrite, pre-upload
6786 $wgAjaxUploadDestCheck = true;
6789 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6791 $wgAjaxLicensePreview = true;
6794 * Settings for incoming cross-site AJAX requests:
6795 * Newer browsers support cross-site AJAX when the target resource allows requests
6796 * from the origin domain by the Access-Control-Allow-Origin header.
6797 * This is currently only used by the API (requests to api.php)
6798 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6800 * - '*' matches any number of characters
6801 * - '?' matches any 1 character
6805 * $wgCrossSiteAJAXdomains = array(
6806 * 'www.mediawiki.org',
6807 * '*.wikipedia.org',
6808 * '*.wikimedia.org',
6809 * '*.wiktionary.org',
6813 $wgCrossSiteAJAXdomains = array();
6816 * Domains that should not be allowed to make AJAX requests,
6817 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6818 * Uses the same syntax as $wgCrossSiteAJAXdomains
6820 $wgCrossSiteAJAXdomainExceptions = array();
6822 /** @} */ # End AJAX and API }
6824 /************************************************************************//**
6825 * @name Shell and process control
6830 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6832 $wgMaxShellMemory = 307200;
6835 * Maximum file size created by shell processes under linux, in KB
6836 * ImageMagick convert for example can be fairly hungry for scratch space
6838 $wgMaxShellFileSize = 102400;
6841 * Maximum CPU time in seconds for shell processes under Linux
6843 $wgMaxShellTime = 180;
6846 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6847 * would measure) in seconds for shell processes under Linux
6849 $wgMaxShellWallClockTime = 180;
6852 * Under Linux: a cgroup directory used to constrain memory usage of shell
6853 * commands. The directory must be writable by the user which runs MediaWiki.
6855 * If specified, this is used instead of ulimit, which is inaccurate, and
6856 * causes malloc() to return NULL, which exposes bugs in C applications, making
6857 * them segfault or deadlock.
6859 * A wrapper script will create a cgroup for each shell command that runs, as
6860 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6861 * kernel will send a SIGKILL signal to a process in the subgroup.
6865 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6866 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6867 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6870 * The reliability of cgroup cleanup can be improved by installing a
6871 * notify_on_release script in the root cgroup, see e.g.
6872 * https://gerrit.wikimedia.org/r/#/c/40784
6874 $wgShellCgroup = false;
6877 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6879 $wgPhpCli = '/usr/bin/php';
6882 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
6883 * For Unix-like operating systems, set this to to a locale that has a UTF-8
6884 * character set. Only the character set is relevant.
6886 $wgShellLocale = 'en_US.utf8';
6888 /** @} */ # End shell }
6890 /************************************************************************//**
6896 * Timeout for HTTP requests done internally, in seconds.
6898 $wgHTTPTimeout = 25;
6901 * Timeout for Asynchronous (background) HTTP requests, in seconds.
6903 $wgAsyncHTTPTimeout = 25;
6906 * Proxy to use for CURL requests.
6908 $wgHTTPProxy = false;
6911 * Timeout for connections done internally (in seconds)
6912 * Only works for curl
6914 $wgHTTPConnectTimeout = 5e0
;
6916 /** @} */ # End HTTP client }
6918 /************************************************************************//**
6920 * See also $wgEnotifUseJobQ.
6925 * Number of jobs to perform per request. May be less than one in which case
6926 * jobs are performed probabalistically. If this is zero, jobs will not be done
6927 * during ordinary apache requests. In this case, maintenance/runJobs.php should
6928 * be run periodically.
6933 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
6934 * to handle the job execution, instead of blocking the request until the job
6935 * execution finishes.
6938 $wgRunJobsAsync = true;
6941 * Number of rows to update per job
6943 $wgUpdateRowsPerJob = 500;
6946 * Number of rows to update per query
6948 $wgUpdateRowsPerQuery = 100;
6950 /** @} */ # End job queue }
6952 /************************************************************************//**
6953 * @name Miscellaneous
6958 * Name of the external diff engine to use
6960 $wgExternalDiffEngine = false;
6963 * Disable redirects to special pages and interwiki redirects, which use a 302
6964 * and have no "redirected from" link.
6966 * @note This is only for articles with #REDIRECT in them. URL's containing a
6967 * local interwiki prefix (or a non-canonical special page name) are still hard
6968 * redirected regardless of this setting.
6970 $wgDisableHardRedirects = false;
6973 * LinkHolderArray batch size
6976 $wgLinkHolderBatchSize = 1000;
6979 * By default MediaWiki does not register links pointing to same server in
6980 * externallinks dataset, use this value to override:
6982 $wgRegisterInternalExternals = false;
6985 * Maximum number of pages to move at once when moving subpages with a page.
6987 $wgMaximumMovedPages = 100;
6990 * Fix double redirects after a page move.
6991 * Tends to conflict with page move vandalism, use only on a private wiki.
6993 $wgFixDoubleRedirects = false;
6996 * Allow redirection to another page when a user logs in.
6997 * To enable, set to a string like 'Main Page'
6999 $wgRedirectOnLogin = null;
7002 * Configuration for processing pool control, for use in high-traffic wikis.
7003 * An implementation is provided in the PoolCounter extension.
7005 * This configuration array maps pool types to an associative array. The only
7006 * defined key in the associative array is "class", which gives the class name.
7007 * The remaining elements are passed through to the class as constructor
7012 * $wgPoolCounterConf = array( 'ArticleView' => array(
7013 * 'class' => 'PoolCounter_Client',
7014 * 'timeout' => 15, // wait timeout in seconds
7015 * 'workers' => 5, // maximum number of active threads in each pool
7016 * 'maxqueue' => 50, // maximum number of total threads in each pool
7017 * ... any extension-specific options...
7021 $wgPoolCounterConf = null;
7024 * To disable file delete/restore temporarily
7026 $wgUploadMaintenance = false;
7029 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7030 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7031 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7032 * (except for the special case of JS and CS pages).
7036 $wgNamespaceContentModels = array();
7039 * How to react if a plain text version of a non-text Content object is requested using
7040 * ContentHandler::getContentText():
7042 * * 'ignore': return null
7043 * * 'fail': throw an MWException
7044 * * 'serialize': serialize to default format
7048 $wgContentHandlerTextFallback = 'ignore';
7051 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7052 * This way, the ContentHandler facility can be used without any additional information in the
7053 * database. A page's content model is then derived solely from the page's title. This however
7054 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7055 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7056 * a title that would default to a different content model.
7058 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7059 * handling is less robust and less flexible.
7063 $wgContentHandlerUseDB = true;
7066 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7067 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7068 * the effect on the database they would have on a wikitext page.
7070 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7071 * or at least parse only the contents of comments in the scripts.
7075 $wgTextModelsToParse = array(
7076 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
7077 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
7078 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
7082 * Whether the user must enter their password to change their e-mail address
7086 $wgRequirePasswordforEmailChange = true;
7089 * Register handlers for specific types of sites.
7093 $wgSiteTypes = array(
7094 'mediawiki' => 'MediaWikiSite',
7098 * Formerly a list of files for HipHop compilation
7099 * @deprecated since 1.22
7101 $wgCompiledFiles = array();
7104 * Whether the page_props table has a pp_sortkey column. Set to false in case
7105 * the respective database schema change was not applied.
7108 $wgPagePropsHaveSortkey = true;
7111 * Port where you have HTTPS running
7112 * Supports HTTPS on non-standard ports
7119 * Secret and algorithm for hmac-based key derivation function (fast,
7120 * cryptographically secure random numbers).
7121 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7125 $wgHKDFSecret = false;
7126 $wgHKDFAlgorithm = 'sha256';
7129 * Enable page language feature
7130 * Allows setting page language in database
7134 $wgPageLanguageUseDB = false;
7137 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7138 * Set this only if the fields are fully populated. This may be removed in 1.25.
7142 $wgUseLinkNamespaceDBFields = false;
7145 * For really cool vim folding this needs to be at the end:
7146 * vim: foldmarker=@{,@} foldmethod=marker