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 * http://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
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 * Class name to use for accessing Config.
64 * Currently only 'GlobalConfig' is available
67 $wgConfigClass = 'GlobalConfig';
70 * MediaWiki version number
73 $wgVersion = '1.23alpha';
76 * Name of the site. It must be changed in LocalSettings.php
78 $wgSitename = 'MediaWiki';
85 * $wgServer = 'http://example.com';
88 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
89 * wrong server, it will redirect incorrectly after you save a page. In that
90 * case, set this variable to fix it.
92 * If you want to use protocol-relative URLs on your wiki, set this to a
93 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
94 * to a fully qualified URL.
96 $wgServer = WebRequest
::detectServer();
99 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
100 * Must be fully qualified, even if $wgServer is protocol-relative.
102 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
105 $wgCanonicalServer = false;
107 /************************************************************************//**
108 * @name Script path settings
113 * The path we should point to.
114 * It might be a virtual path in case with use apache mod_rewrite for example.
116 * This *needs* to be set correctly.
118 * Other paths will be set to defaults based on it unless they are directly
119 * set in LocalSettings.php
121 $wgScriptPath = '/wiki';
124 * Whether to support URLs like index.php/Page_title These often break when PHP
125 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
126 * but then again it may not; lighttpd converts incoming path data to lowercase
127 * on systems with case-insensitive filesystems, and there have been reports of
128 * problems on Apache as well.
130 * To be safe we'll continue to keep it off by default.
132 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
133 * incorrect garbage, or to true if it is really correct.
135 * The default $wgArticlePath will be set based on this value at runtime, but if
136 * you have customized it, having this incorrectly set to true can cause
137 * redirect loops when "pretty URLs" are used.
140 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
141 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
142 ( strpos( PHP_SAPI
, 'isapi' ) === false );
145 * The extension to append to script names by default. This can either be .php
148 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
149 * variable is provided to support those providers.
152 $wgScriptExtension = '.php';
156 /************************************************************************//**
157 * @name URLs and file paths
159 * These various web and file path variables are set to their defaults
160 * in Setup.php if they are not explicitly set from LocalSettings.php.
162 * These will relatively rarely need to be set manually, unless you are
163 * splitting style sheets or images outside the main document root.
165 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
166 * the host part, that starts with a slash. In most cases a full URL is also
167 * acceptable. A "directory" is a local file path.
169 * In both paths and directories, trailing slashes should not be included.
175 * The URL path to index.php.
177 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
182 * The URL path to load.php.
184 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
187 $wgLoadScript = false;
190 * The URL path of the skins directory.
191 * Defaults to "{$wgScriptPath}/skins".
194 $wgStylePath = false;
195 $wgStyleSheetPath = &$wgStylePath;
198 * The URL path of the skins directory. Should not point to an external domain.
199 * Defaults to "{$wgScriptPath}/skins".
202 $wgLocalStylePath = false;
205 * The URL path of the extensions directory.
206 * Defaults to "{$wgScriptPath}/extensions".
209 $wgExtensionAssetsPath = false;
212 * Filesystem stylesheets directory.
213 * Defaults to "{$IP}/skins".
216 $wgStyleDirectory = false;
219 * The URL path for primary article page views. This path should contain $1,
220 * which is replaced by the article title.
222 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
223 * depending on $wgUsePathInfo.
225 $wgArticlePath = false;
228 * The URL path for the images directory.
229 * Defaults to "{$wgScriptPath}/images".
231 $wgUploadPath = false;
234 * The filesystem path of the images directory. Defaults to "{$IP}/images".
236 $wgUploadDirectory = false;
239 * Directory where the cached page will be saved.
240 * Defaults to "{$wgUploadDirectory}/cache".
242 $wgFileCacheDirectory = false;
245 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
246 * Defaults to "{$wgStylePath}/common/images/wiki.png".
251 * The URL path of the shortcut icon.
254 $wgFavicon = '/favicon.ico';
257 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
258 * Defaults to no icon.
261 $wgAppleTouchIcon = false;
264 * The local filesystem path to a temporary directory. This is not required to
267 * When this setting is set to false, its value will be set through a call
268 * to wfTempDir(). See that methods implementation for the actual detection
271 * Developers should use the global function wfTempDir() instead of this
275 * @note Default changed to false in MediaWiki 1.20.
277 $wgTmpDirectory = false;
280 * If set, this URL is added to the start of $wgUploadPath to form a complete
284 $wgUploadBaseUrl = '';
287 * To enable remote on-demand scaling, set this to the thumbnail base URL.
288 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
289 * where 'e6' are the first two characters of the MD5 hash of the file name.
290 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
293 $wgUploadStashScalerBaseUrl = false;
296 * To set 'pretty' URL paths for actions other than
297 * plain page views, add to this array.
300 * Set pretty URL for the edit action:
302 * 'edit' => "$wgScriptPath/edit/$1"
305 * There must be an appropriate script or rewrite rule in place to handle these
309 $wgActionPaths = array();
313 /************************************************************************//**
314 * @name Files and file uploads
319 * Uploads have to be specially set up to be secure
321 $wgEnableUploads = false;
324 * The maximum age of temporary (incomplete) uploaded files
326 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
329 * Allows to move images and other media files
331 $wgAllowImageMoving = true;
334 * Enable deferred upload tasks that use the job queue.
335 * Only enable this if job runners are set up for both the
336 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
338 * @note If you use suhosin, this setting is incompatible with
339 * suhosin.session.encrypt.
341 $wgEnableAsyncUploads = false;
344 * These are additional characters that should be replaced with '-' in filenames
346 $wgIllegalFileChars = ":";
349 * @deprecated since 1.17 use $wgDeletedDirectory
351 $wgFileStore = array();
354 * What directory to place deleted uploads in.
355 * Defaults to "{$wgUploadDirectory}/deleted".
357 $wgDeletedDirectory = false;
360 * Set this to true if you use img_auth and want the user to see details on why access failed.
362 $wgImgAuthDetails = false;
365 * If this is enabled, img_auth.php will not allow image access unless the wiki
366 * is private. This improves security when image uploads are hosted on a
369 $wgImgAuthPublicTest = true;
372 * Map of relative URL directories to match to internal mwstore:// base storage paths.
373 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
374 * if starts with any of the prefixes defined here. The prefixes should not overlap.
375 * The prefix that matches has a corresponding storage path, which the rest of the URL
376 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
379 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
380 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
381 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
383 * @see $wgFileBackends
385 $wgImgAuthUrlPathMap = array();
388 * File repository structures
390 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
391 * an array of such structures. Each repository structure is an associative
392 * array of properties configuring the repository.
394 * Properties required for all repos:
395 * - class The class name for the repository. May come from the core or an extension.
396 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
397 * FSRepo is also supported for backwards compatibility.
399 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
400 * The name should consist of alpha-numeric characters.
401 * - backend A file backend name (see $wgFileBackends).
403 * For most core repos:
404 * - zones Associative array of zone names that each map to an array with:
405 * container : backend container name the zone is in
406 * directory : root path within container for the zone
407 * url : base URL to the root of the zone
408 * urlsByExt : map of file extension types to base URLs
409 * (useful for using a different cache for videos)
410 * handlerUrl : base script-handled URL to the root of the zone
411 * (see FileRepo::getZoneHandlerUrl() function)
412 * Zones default to using "<repo name>-<zone name>" as the container name
413 * and default to using the container root as the zone's root directory.
414 * Nesting of zone locations within other zones should be avoided.
415 * - url Public zone URL. The 'zones' settings take precedence.
416 * - hashLevels The number of directory levels for hash-based division of files
417 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
418 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
420 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
421 * determines whether filenames implicitly start with a capital letter.
422 * The current implementation may give incorrect description page links
423 * when the local $wgCapitalLinks and initialCapital are mismatched.
424 * - pathDisclosureProtection
425 * May be 'paranoid' to remove all parameters from error messages, 'none' to
426 * leave the paths in unchanged, or 'simple' to replace paths with
427 * placeholders. Default for LocalRepo is 'simple'.
428 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
430 * - directory The local filesystem directory where public files are stored. Not used for
432 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
433 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
434 * - isPrivate Set this if measures should always be taken to keep the files private.
435 * One should not trust this to assure that the files are not web readable;
436 * the server configuration should be done manually depending on the backend.
438 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
439 * for local repositories:
440 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
441 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
442 * http://en.wikipedia.org/w
443 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
444 * $wgScriptExtension, e.g. .php5 defaults to .php
446 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
447 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
448 * $wgFetchCommonsDescriptions.
449 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
450 * Short thumbnail names only have the width, parameters, and the extension.
453 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
454 * equivalent to the corresponding member of $wgDBservers
455 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
456 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
459 * - apibase Use for the foreign API's URL
460 * - apiThumbCacheExpiry How long to locally cache thumbs for
462 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
463 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
464 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
465 * If you set $wgForeignFileRepos to an array of repository structures, those will
466 * be searched after the local file repo.
467 * Otherwise, you will only have access to local media files.
469 * @see Setup.php for an example usage and default initialization.
471 $wgLocalFileRepo = false;
474 * @see $wgLocalFileRepo
476 $wgForeignFileRepos = array();
479 * Use Commons as a remote file repository. Essentially a wrapper, when this
480 * is enabled $wgForeignFileRepos will point at Commons with a set of default
483 $wgUseInstantCommons = false;
486 * File backend structure configuration.
488 * This is an array of file backend configuration arrays.
489 * Each backend configuration has the following parameters:
490 * - 'name' : A unique name for the backend
491 * - 'class' : The file backend class to use
492 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
493 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
495 * See FileBackend::__construct() for more details.
496 * Additional parameters are specific to the file backend class used.
497 * These settings should be global to all wikis when possible.
499 * There are two particularly important aspects about each backend:
500 * - a) Whether it is fully qualified or wiki-relative.
501 * By default, the paths of files are relative to the current wiki,
502 * which works via prefixing them with the current wiki ID when accessed.
503 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
504 * all paths with the specified value instead. This can be useful if
505 * multiple wikis need to share the same data. Note that 'name' is *not*
506 * part of any prefix and thus should not be relied upon for namespacing.
507 * - b) Whether it is only defined for some wikis or is defined on all
508 * wikis in the wiki farm. Defining a backend globally is useful
509 * if multiple wikis need to share the same data.
510 * One should be aware of these aspects when configuring a backend for use with
511 * any basic feature or plugin. For example, suppose an extension stores data for
512 * different wikis in different directories and sometimes needs to access data from
513 * a foreign wiki's directory in order to render a page on given wiki. The extension
514 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
516 $wgFileBackends = array();
519 * Array of configuration arrays for each lock manager.
520 * Each backend configuration has the following parameters:
521 * - 'name' : A unique name for the lock manager
522 * - 'class' : The lock manger class to use
524 * See LockManager::__construct() for more details.
525 * Additional parameters are specific to the lock manager class used.
526 * These settings should be global to all wikis.
528 $wgLockManagers = array();
531 * Show Exif data, on by default if available.
532 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
534 * @note FOR WINDOWS USERS:
535 * To enable Exif functions, add the following lines to the "Windows
536 * extensions" section of php.ini:
538 * extension=extensions/php_mbstring.dll
539 * extension=extensions/php_exif.dll
542 $wgShowEXIF = function_exists( 'exif_read_data' );
545 * If to automatically update the img_metadata field
546 * if the metadata field is outdated but compatible with the current version.
549 $wgUpdateCompatibleMetadata = false;
552 * If you operate multiple wikis, you can define a shared upload path here.
553 * Uploads to this wiki will NOT be put there - they will be put into
554 * $wgUploadDirectory.
555 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
556 * no file of the given name is found in the local repository (for [[File:..]],
557 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
560 * Note that these configuration settings can now be defined on a per-
561 * repository basis for an arbitrary number of file repositories, using the
562 * $wgForeignFileRepos variable.
564 $wgUseSharedUploads = false;
567 * Full path on the web server where shared uploads can be found
569 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
572 * Fetch commons image description pages and display them on the local wiki?
574 $wgFetchCommonsDescriptions = false;
577 * Path on the file system where shared uploads can be found.
579 $wgSharedUploadDirectory = "/var/www/wiki3/images";
582 * DB name with metadata about shared directory.
583 * Set this to false if the uploads do not come from a wiki.
585 $wgSharedUploadDBname = false;
588 * Optional table prefix used in database.
590 $wgSharedUploadDBprefix = '';
593 * Cache shared metadata in memcached.
594 * Don't do this if the commons wiki is in a different memcached domain
596 $wgCacheSharedUploads = true;
599 * Allow for upload to be copied from an URL.
600 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
601 * You have to assign the user right 'upload_by_url' to a user group, to use this.
603 $wgAllowCopyUploads = false;
606 * Allow asynchronous copy uploads.
607 * This feature is experimental and broken as of r81612.
609 $wgAllowAsyncCopyUploads = false;
612 * A list of domains copy uploads can come from
616 $wgCopyUploadsDomains = array();
619 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
620 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
621 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
623 $wgCopyUploadsFromSpecialUpload = false;
626 * Proxy to use for copy upload requests.
629 $wgCopyUploadProxy = false;
632 * Different timeout for upload by url
633 * This could be useful since when fetching large files, you may want a
634 * timeout longer than the default $wgHTTPTimeout. False means fallback
639 $wgCopyUploadTimeout = false;
642 * Different timeout for upload by url when run as a background job
643 * This could be useful since when fetching large files via job queue,
644 * you may want a different timeout, especially because there is no
645 * http request being kept alive.
647 * false means fallback to $wgCopyUploadTimeout.
650 $wgCopyUploadAsyncTimeout = false;
653 * Max size for uploads, in bytes. If not set to an array, applies to all
654 * uploads. If set to an array, per upload type maximums can be set, using the
655 * file and url keys. If the * key is set this value will be used as maximum
656 * for non-specified types.
660 * $wgMaxUploadSize = array(
662 * 'url' => 500 * 1024,
665 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
666 * will have a maximum of 500 kB.
668 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
671 * Point the upload navigation link to an external URL
672 * Useful if you want to use a shared repository by default
673 * without disabling local uploads (use $wgEnableUploads = false for that).
677 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
680 $wgUploadNavigationUrl = false;
683 * Point the upload link for missing files to an external URL, as with
684 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
685 * appended to it as appropriate.
687 $wgUploadMissingFileUrl = false;
690 * Give a path here to use thumb.php for thumbnail generation on client
691 * request, instead of generating them on render and outputting a static URL.
692 * This is necessary if some of your apache servers don't have read/write
693 * access to the thumbnail path.
697 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
700 $wgThumbnailScriptPath = false;
703 * @see $wgThumbnailScriptPath
705 $wgSharedThumbnailScriptPath = false;
708 * Set this to false if you do not want MediaWiki to divide your images
709 * directory into many subdirectories, for improved performance.
711 * It's almost always good to leave this enabled. In previous versions of
712 * MediaWiki, some users set this to false to allow images to be added to the
713 * wiki by simply copying them into $wgUploadDirectory and then running
714 * maintenance/rebuildImages.php to register them in the database. This is no
715 * longer recommended, use maintenance/importImages.php instead.
717 * @note That this variable may be ignored if $wgLocalFileRepo is set.
718 * @todo Deprecate the setting and ultimately remove it from Core.
720 $wgHashedUploadDirectory = true;
723 * Set the following to false especially if you have a set of files that need to
724 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
727 $wgHashedSharedUploadDirectory = true;
730 * Base URL for a repository wiki. Leave this blank if uploads are just stored
731 * in a shared directory and not meant to be accessible through a separate wiki.
732 * Otherwise the image description pages on the local wiki will link to the
733 * image description page on this wiki.
735 * Please specify the namespace, as in the example below.
737 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
740 * This is the list of preferred extensions for uploading files. Uploading files
741 * with extensions not in this list will trigger a warning.
743 * @warning If you add any OpenOffice or Microsoft Office file formats here,
744 * such as odt or doc, and untrusted users are allowed to upload files, then
745 * your wiki will be vulnerable to cross-site request forgery (CSRF).
747 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
750 * Files with these extensions will never be allowed as uploads.
751 * An array of file extensions to blacklist. You should append to this array
752 * if you want to blacklist additional files.
754 $wgFileBlacklist = array(
755 # HTML may contain cookie-stealing JavaScript and web bugs
756 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
757 # PHP scripts may execute arbitrary code on the server
758 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
759 # Other types that may be interpreted by some servers
760 'shtml', 'jhtml', 'pl', 'py', 'cgi',
761 # May contain harmful executables for Windows victims
762 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
765 * Files with these mime types will never be allowed as uploads
766 * if $wgVerifyMimeType is enabled.
768 $wgMimeTypeBlacklist = array(
769 # HTML may contain cookie-stealing JavaScript and web bugs
770 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
771 # PHP scripts may execute arbitrary code on the server
772 'application/x-php', 'text/x-php',
773 # Other types that may be interpreted by some servers
774 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
775 # Client-side hazards on Internet Explorer
776 'text/scriptlet', 'application/x-msdownload',
777 # Windows metafile, client-side vulnerability on some systems
778 'application/x-msmetafile',
782 * Allow Java archive uploads.
783 * This is not recommended for public wikis since a maliciously-constructed
784 * applet running on the same domain as the wiki can steal the user's cookies.
786 $wgAllowJavaUploads = false;
789 * This is a flag to determine whether or not to check file extensions on upload.
791 * @warning Setting this to false is insecure for public wikis.
793 $wgCheckFileExtensions = true;
796 * If this is turned off, users may override the warning for files not covered
797 * by $wgFileExtensions.
799 * @warning Setting this to false is insecure for public wikis.
801 $wgStrictFileExtensions = true;
804 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
806 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
807 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
809 $wgDisableUploadScriptChecks = false;
812 * Warn if uploaded files are larger than this (in bytes), or false to disable
814 $wgUploadSizeWarning = false;
817 * list of trusted media-types and mime types.
818 * Use the MEDIATYPE_xxx constants to represent media types.
819 * This list is used by File::isSafeFile
821 * Types not listed here will have a warning about unsafe content
822 * displayed on the images description page. It would also be possible
823 * to use this for further restrictions, like disabling direct
824 * [[media:...]] links for non-trusted formats.
826 $wgTrustedMediaFormats = array(
827 MEDIATYPE_BITMAP
, //all bitmap formats
828 MEDIATYPE_AUDIO
, //all audio formats
829 MEDIATYPE_VIDEO
, //all plain video formats
830 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
831 "application/pdf", //PDF files
832 #"application/x-shockwave-flash", //flash/shockwave movie
836 * Plugins for media file type handling.
837 * Each entry in the array maps a MIME type to a class name
839 $wgMediaHandlers = array(
840 'image/jpeg' => 'JpegHandler',
841 'image/png' => 'PNGHandler',
842 'image/gif' => 'GIFHandler',
843 'image/tiff' => 'TiffHandler',
844 'image/x-ms-bmp' => 'BmpHandler',
845 'image/x-bmp' => 'BmpHandler',
846 'image/x-xcf' => 'XCFHandler',
847 'image/svg+xml' => 'SvgHandler', // official
848 'image/svg' => 'SvgHandler', // compat
849 'image/vnd.djvu' => 'DjVuHandler', // official
850 'image/x.djvu' => 'DjVuHandler', // compat
851 'image/x-djvu' => 'DjVuHandler', // compat
855 * Plugins for page content model handling.
856 * Each entry in the array maps a model id to a class name.
860 $wgContentHandlers = array(
862 CONTENT_MODEL_WIKITEXT
=> 'WikitextContentHandler',
863 // dumb version, no syntax highlighting
864 CONTENT_MODEL_JAVASCRIPT
=> 'JavaScriptContentHandler',
865 // dumb version, no syntax highlighting
866 CONTENT_MODEL_CSS
=> 'CssContentHandler',
867 // plain text, for use by extensions etc
868 CONTENT_MODEL_TEXT
=> 'TextContentHandler',
872 * Resizing can be done using PHP's internal image libraries or using
873 * ImageMagick or another third-party converter, e.g. GraphicMagick.
874 * These support more file formats than PHP, which only supports PNG,
875 * GIF, JPG, XBM and WBMP.
877 * Use Image Magick instead of PHP builtin functions.
879 $wgUseImageMagick = false;
882 * The convert command shipped with ImageMagick
884 $wgImageMagickConvertCommand = '/usr/bin/convert';
887 * The identify command shipped with ImageMagick
889 $wgImageMagickIdentifyCommand = '/usr/bin/identify';
892 * Sharpening parameter to ImageMagick
894 $wgSharpenParameter = '0x0.4';
897 * Reduction in linear dimensions below which sharpening will be enabled
899 $wgSharpenReductionThreshold = 0.85;
902 * Temporary directory used for ImageMagick. The directory must exist. Leave
903 * this set to false to let ImageMagick decide for itself.
905 $wgImageMagickTempDir = false;
908 * Use another resizing converter, e.g. GraphicMagick
909 * %s will be replaced with the source path, %d with the destination
910 * %w and %h will be replaced with the width and height.
912 * @par Example for GraphicMagick:
914 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
917 * Leave as false to skip this.
919 $wgCustomConvertCommand = false;
922 * used for lossless jpeg rotation
926 $wgJpegTran = '/usr/bin/jpegtran';
929 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
932 $wgExiv2Command = '/usr/bin/exiv2';
935 * Scalable Vector Graphics (SVG) may be uploaded as images.
936 * Since SVG support is not yet standard in browsers, it is
937 * necessary to rasterize SVGs to PNG as a fallback format.
939 * An external program is required to perform this conversion.
940 * If set to an array, the first item is a PHP callable and any further items
941 * are passed as parameters after $srcPath, $dstPath, $width, $height
943 $wgSVGConverters = array(
944 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
945 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
946 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
947 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
949 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
950 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
951 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
955 * Pick a converter defined in $wgSVGConverters
957 $wgSVGConverter = 'ImageMagick';
960 * If not in the executable PATH, specify the SVG converter path.
962 $wgSVGConverterPath = '';
965 * Don't scale a SVG larger than this
967 $wgSVGMaxSize = 2048;
970 * Don't read SVG metadata beyond this point.
971 * Default is 1024*256 bytes
973 $wgSVGMetadataCutoff = 262144;
976 * Disallow <title> element in SVG files.
978 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
979 * browsers which can not perform basic stuff like MIME detection and which are
980 * vulnerable to further idiots uploading crap files as images.
982 * When this directive is on, "<title>" will be allowed in files with an
983 * "image/svg+xml" MIME type. You should leave this disabled if your web server
984 * is misconfigured and doesn't send appropriate MIME types for SVG images.
986 $wgAllowTitlesInSVG = false;
989 * The maximum number of pixels a source image can have if it is to be scaled
990 * down by a scaler that requires the full source image to be decompressed
991 * and stored in decompressed form, before the thumbnail is generated.
993 * This provides a limit on memory usage for the decompression side of the
994 * image scaler. The limit is used when scaling PNGs with any of the
995 * built-in image scalers, such as ImageMagick or GD. It is ignored for
996 * JPEGs with ImageMagick, and when using the VipsScaler extension.
998 * The default is 50 MB if decompressed to RGBA form, which corresponds to
999 * 12.5 million pixels or 3500x3500.
1001 $wgMaxImageArea = 1.25e7
;
1004 * Force thumbnailing of animated GIFs above this size to a single
1005 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1006 * is checked against the total size of all frames in the animation.
1007 * It probably makes sense to keep this equal to $wgMaxImageArea.
1009 $wgMaxAnimatedGifArea = 1.25e7
;
1012 * Browsers don't support TIFF inline generally...
1013 * For inline display, we need to convert to PNG or JPEG.
1014 * Note scaling should work with ImageMagick, but may not with GD scaling.
1018 * // PNG is lossless, but inefficient for photos
1019 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1020 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1021 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1024 $wgTiffThumbnailType = false;
1027 * If rendered thumbnail files are older than this timestamp, they
1028 * will be rerendered on demand as if the file didn't already exist.
1029 * Update if there is some need to force thumbs and SVG rasterizations
1030 * to rerender, such as fixes to rendering bugs.
1032 $wgThumbnailEpoch = '20030516000000';
1035 * If set, inline scaled images will still produce "<img>" tags ready for
1036 * output instead of showing an error message.
1038 * This may be useful if errors are transitory, especially if the site
1039 * is configured to automatically render thumbnails on request.
1041 * On the other hand, it may obscure error conditions from debugging.
1042 * Enable the debug log or the 'thumbnail' log group to make sure errors
1043 * are logged to a file for review.
1045 $wgIgnoreImageErrors = false;
1048 * Allow thumbnail rendering on page view. If this is false, a valid
1049 * thumbnail URL is still output, but no file will be created at
1050 * the target location. This may save some time if you have a
1051 * thumb.php or 404 handler set up which is faster than the regular
1054 $wgGenerateThumbnailOnParse = true;
1057 * Show thumbnails for old images on the image description page
1059 $wgShowArchiveThumbnails = true;
1062 * Obsolete, always true, kept for compatibility with extensions
1064 $wgUseImageResize = true;
1067 * If set to true, images that contain certain the exif orientation tag will
1068 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1069 * is available that can rotate.
1071 $wgEnableAutoRotation = null;
1074 * Internal name of virus scanner. This serves as a key to the
1075 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1076 * null, every file uploaded will be scanned for viruses.
1078 $wgAntivirus = null;
1081 * Configuration for different virus scanners. This an associative array of
1082 * associative arrays. It contains one setup array per known scanner type.
1083 * The entry is selected by $wgAntivirus, i.e.
1084 * valid values for $wgAntivirus are the keys defined in this array.
1086 * The configuration array for each scanner contains the following keys:
1087 * "command", "codemap", "messagepattern":
1089 * "command" is the full command to call the virus scanner - %f will be
1090 * replaced with the name of the file to scan. If not present, the filename
1091 * will be appended to the command. Note that this must be overwritten if the
1092 * scanner is not in the system path; in that case, please set
1093 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1096 * "codemap" is a mapping of exit code to return codes of the detectVirus
1097 * function in SpecialUpload.
1098 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1099 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1101 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1102 * the file to have an unsupported format, which is probably immune to
1103 * viruses. This causes the file to pass.
1104 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1105 * no virus was found.
1106 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1108 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1110 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1111 * output. The relevant part should be matched as group one (\1).
1112 * If not defined or the pattern does not match, the full message is shown to the user.
1114 $wgAntivirusSetup = array(
1118 'command' => 'clamscan --no-summary ',
1120 "0" => AV_NO_VIRUS
, # no virus
1121 "1" => AV_VIRUS_FOUND
, # virus found
1122 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1123 "*" => AV_SCAN_FAILED
, # else scan failed
1125 'messagepattern' => '/.*?:(.*)/sim',
1130 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1132 $wgAntivirusRequired = true;
1135 * Determines if the mime type of uploaded files should be checked
1137 $wgVerifyMimeType = true;
1140 * Sets the mime type definition file to use by MimeMagic.php.
1141 * Set to null, to use built-in defaults only.
1142 * example: $wgMimeTypeFile = '/etc/mime.types';
1144 $wgMimeTypeFile = 'includes/mime.types';
1147 * Sets the mime type info file to use by MimeMagic.php.
1148 * Set to null, to use built-in defaults only.
1150 $wgMimeInfoFile = 'includes/mime.info';
1153 * Sets an external mime detector program. The command must print only
1154 * the mime type to standard output.
1155 * The name of the file to process will be appended to the command given here.
1156 * If not set or NULL, mime_content_type will be used if available.
1160 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
1163 $wgMimeDetectorCommand = null;
1166 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
1167 * things, because only a few types of images are needed and file extensions
1170 $wgTrivialMimeDetection = false;
1173 * Additional XML types we can allow via mime-detection.
1174 * array = ( 'rootElement' => 'associatedMimeType' )
1176 $wgXMLMimeTypes = array(
1177 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1178 'svg' => 'image/svg+xml',
1179 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1180 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1181 'html' => 'text/html', // application/xhtml+xml?
1185 * Limit images on image description pages to a user-selectable limit. In order
1186 * to reduce disk usage, limits can only be selected from a list.
1187 * The user preference is saved as an array offset in the database, by default
1188 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1189 * change it if you alter the array (see bug 8858).
1190 * This is the list of settings the user can choose from:
1192 $wgImageLimits = array(
1201 * Adjust thumbnails on image pages according to a user setting. In order to
1202 * reduce disk usage, the values can only be selected from a list. This is the
1203 * list of settings the user can choose from:
1205 $wgThumbLimits = array(
1215 * Default parameters for the "<gallery>" tag
1217 $wgGalleryOptions = array(
1218 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1219 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1220 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1221 'captionLength' => 25, // Length of caption to truncate (in characters)
1222 'showBytes' => true, // Show the filesize in bytes in categories
1223 'mode' => 'traditional',
1227 * Adjust width of upright images when parameter 'upright' is used
1228 * This allows a nicer look for upright images without the need to fix the width
1229 * by hardcoded px in wiki sourcecode.
1231 $wgThumbUpright = 0.75;
1234 * Default value for chmoding of new directories.
1236 $wgDirectoryMode = 0777;
1239 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1241 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1242 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1243 * images in after loading the original low-resolution versions depending on the reported
1244 * window.devicePixelRatio.
1246 $wgResponsiveImages = true;
1249 * @name DJVU settings
1254 * Path of the djvudump executable
1255 * Enable this and $wgDjvuRenderer to enable djvu rendering
1256 * example: $wgDjvuDump = 'djvudump';
1261 * Path of the ddjvu DJVU renderer
1262 * Enable this and $wgDjvuDump to enable djvu rendering
1263 * example: $wgDjvuRenderer = 'ddjvu';
1265 $wgDjvuRenderer = null;
1268 * Path of the djvutxt DJVU text extraction utility
1269 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1270 * example: $wgDjvuTxt = 'djvutxt';
1275 * Path of the djvutoxml executable
1276 * This works like djvudump except much, much slower as of version 3.5.
1278 * For now we recommend you use djvudump instead. The djvuxml output is
1279 * probably more stable, so we'll switch back to it as soon as they fix
1280 * the efficiency problem.
1281 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1285 * $wgDjvuToXML = 'djvutoxml';
1288 $wgDjvuToXML = null;
1291 * Shell command for the DJVU post processor
1292 * Default: pnmtopng, since ddjvu generates ppm output
1293 * Set this to false to output the ppm file directly.
1295 $wgDjvuPostProcessor = 'pnmtojpeg';
1298 * File extension for the DJVU post processor output
1300 $wgDjvuOutputExtension = 'jpg';
1302 /** @} */ # end of DJvu }
1304 /** @} */ # end of file uploads }
1306 /************************************************************************//**
1307 * @name Email settings
1311 $serverName = substr( $wgServer, strrpos( $wgServer, '/' ) +
1 );
1314 * Site admin email address.
1316 $wgEmergencyContact = 'wikiadmin@' . $serverName;
1319 * Password reminder email address.
1321 * The address we should use as sender when a user is requesting his password.
1323 $wgPasswordSender = 'apache@' . $serverName;
1325 unset( $serverName ); # Don't leak local variables to global scope
1328 * Password reminder name
1330 * @deprecated since 1.23; use the system message 'emailsender' instead.
1332 $wgPasswordSenderName = 'MediaWiki Mail';
1335 * Dummy address which should be accepted during mail send action.
1336 * It might be necessary to adapt the address or to set it equal
1337 * to the $wgEmergencyContact address.
1339 $wgNoReplyAddress = 'reply@not.possible';
1342 * Set to true to enable the e-mail basic features:
1343 * Password reminders, etc. If sending e-mail on your
1344 * server doesn't work, you might want to disable this.
1346 $wgEnableEmail = true;
1349 * Set to true to enable user-to-user e-mail.
1350 * This can potentially be abused, as it's hard to track.
1352 $wgEnableUserEmail = true;
1355 * Set to true to put the sending user's email in a Reply-To header
1356 * instead of From. ($wgEmergencyContact will be used as From.)
1358 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1359 * which can cause problems with SPF validation and leak recipient addresses
1360 * when bounces are sent to the sender.
1362 $wgUserEmailUseReplyTo = false;
1365 * Minimum time, in hours, which must elapse between password reminder
1366 * emails for a given account. This is to prevent abuse by mail flooding.
1368 $wgPasswordReminderResendTime = 24;
1371 * The time, in seconds, when an emailed temporary password expires.
1373 $wgNewPasswordExpiry = 3600 * 24 * 7;
1376 * The time, in seconds, when an email confirmation email expires
1378 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1383 * For using a direct (authenticated) SMTP server connection.
1384 * Default to false or fill an array :
1388 * 'host' => 'SMTP domain',
1389 * 'IDHost' => 'domain for MessageID',
1391 * 'auth' => [true|false],
1392 * 'username' => [SMTP username],
1393 * 'password' => [SMTP password],
1400 * Additional email parameters, will be passed as the last argument to mail() call.
1401 * If using safe_mode this has no effect
1403 $wgAdditionalMailParams = null;
1406 * For parts of the system that have been updated to provide HTML email content, send
1407 * both text and HTML parts as the body of the email
1409 $wgAllowHTMLEmail = false;
1412 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1413 * from $wgEmergencyContact
1415 $wgEnotifFromEditor = false;
1417 // TODO move UPO to preferences probably ?
1418 # If set to true, users get a corresponding option in their preferences and can choose to
1419 # enable or disable at their discretion
1420 # If set to false, the corresponding input form on the user preference page is suppressed
1421 # It call this to be a "user-preferences-option (UPO)"
1424 * Require email authentication before sending mail to an email address.
1425 * This is highly recommended. It prevents MediaWiki from being used as an open
1428 $wgEmailAuthentication = true;
1431 * Allow users to enable email notification ("enotif") on watchlist changes.
1433 $wgEnotifWatchlist = false;
1436 * Allow users to enable email notification ("enotif") when someone edits their
1439 $wgEnotifUserTalk = false;
1442 * Set the Reply-to address in notifications to the editor's address, if user
1443 * allowed this in the preferences.
1445 $wgEnotifRevealEditorAddress = false;
1448 * Send notification mails on minor edits to watchlist pages. This is enabled
1449 * by default. Does not affect user talk notifications.
1451 $wgEnotifMinorEdits = true;
1454 * Send a generic mail instead of a personalised mail for each user. This
1455 * always uses UTC as the time zone, and doesn't include the username.
1457 * For pages with many users watching, this can significantly reduce mail load.
1458 * Has no effect when using sendmail rather than SMTP.
1460 $wgEnotifImpersonal = false;
1463 * Maximum number of users to mail at once when using impersonal mail. Should
1464 * match the limit on your mail server.
1466 $wgEnotifMaxRecips = 500;
1469 * Send mails via the job queue. This can be useful to reduce the time it
1470 * takes to save a page that a lot of people are watching.
1472 $wgEnotifUseJobQ = false;
1475 * Use real name instead of username in e-mail "from" field.
1477 $wgEnotifUseRealName = false;
1480 * Array of usernames who will be sent a notification email for every change
1481 * which occurs on a wiki. Users will not be notified of their own changes.
1483 $wgUsersNotifiedOnAllChanges = array();
1485 /** @} */ # end of email settings
1487 /************************************************************************//**
1488 * @name Database settings
1493 * Database host name or IP address
1495 $wgDBserver = 'localhost';
1498 * Database port number (for PostgreSQL)
1503 * Name of the database
1505 $wgDBname = 'my_wiki';
1510 $wgDBuser = 'wikiuser';
1513 * Database user's password
1520 $wgDBtype = 'mysql';
1523 * Whether to use SSL in DB connection.
1528 * Whether to use compression in DB connection.
1530 $wgDBcompress = false;
1533 * Separate username for maintenance tasks. Leave as null to use the default.
1535 $wgDBadminuser = null;
1538 * Separate password for maintenance tasks. Leave as null to use the default.
1540 $wgDBadminpassword = null;
1544 * Leave as null to select the default search engine for the
1545 * selected database type (eg SearchMySQL), or set to a class
1546 * name to override to a custom search engine.
1548 $wgSearchType = null;
1551 * Alternative search types
1552 * Sometimes you want to support multiple search engines for testing. This
1553 * allows users to select their search engine of choice via url parameters
1554 * to Special:Search and the action=search API. If using this, there's no
1555 * need to add $wgSearchType to it, that is handled automatically.
1557 $wgSearchTypeAlternatives = null;
1565 * MySQL table options to use during installation or update
1567 $wgDBTableOptions = 'ENGINE=InnoDB';
1570 * SQL Mode - default is turning off all modes, including strict, if set.
1571 * null can be used to skip the setting for performance reasons and assume
1572 * DBA has done his best job.
1573 * String override can be used for some additional fun :-)
1580 $wgDBmwschema = 'mediawiki';
1583 * To override default SQLite data directory ($docroot/../data)
1585 $wgSQLiteDataDir = '';
1588 * Make all database connections secretly go to localhost. Fool the load balancer
1589 * thinking there is an arbitrarily large cluster of servers to connect to.
1590 * Useful for debugging.
1592 $wgAllDBsAreLocalhost = false;
1595 * Shared database for multiple wikis. Commonly used for storing a user table
1596 * for single sign-on. The server for this database must be the same as for the
1599 * For backwards compatibility the shared prefix is set to the same as the local
1600 * prefix, and the user table is listed in the default list of shared tables.
1601 * The user_properties table is also added so that users will continue to have their
1602 * preferences shared (preferences were stored in the user table prior to 1.16)
1604 * $wgSharedTables may be customized with a list of tables to share in the shared
1605 * database. However it is advised to limit what tables you do share as many of
1606 * MediaWiki's tables may have side effects if you try to share them.
1608 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1611 * @deprecated In new code, use the $wiki parameter to wfGetLB() to access
1612 * remote databases. Using wfGetLB() allows the shared database to reside on
1613 * separate servers to the wiki's own database, with suitable configuration
1614 * of $wgLBFactoryConf.
1621 $wgSharedPrefix = false;
1626 $wgSharedTables = array( 'user', 'user_properties' );
1629 * Database load balancer
1630 * This is a two-dimensional array, an array of server info structures
1633 * - dbname: Default database name
1635 * - password: DB password
1636 * - type: "mysql" or "postgres"
1638 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1639 * If this is zero for any given server, no normal query traffic will be
1640 * sent to it. It will be excluded from lag checks in maintenance scripts.
1641 * The only way it can receive traffic is if groupLoads is used.
1643 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1644 * to several groups, the most specific group defined here is used.
1646 * - flags: bit field
1647 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1648 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1649 * - DBO_TRX -- wrap entire request in a transaction
1650 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1651 * - DBO_PERSISTENT -- enables persistent database connections
1652 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1653 * - DBO_COMPRESS -- uses internal compression in database connections,
1656 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1657 * - max threads: (optional) Maximum number of running threads
1659 * These and any other user-defined properties will be assigned to the mLBInfo member
1660 * variable of the Database object.
1662 * Leave at false to use the single-server variables above. If you set this
1663 * variable, the single-server variables will generally be ignored (except
1664 * perhaps in some command-line scripts).
1666 * The first server listed in this array (with key 0) will be the master. The
1667 * rest of the servers will be slaves. To prevent writes to your slaves due to
1668 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1669 * slaves in my.cnf. You can set read_only mode at runtime using:
1672 * SET @@read_only=1;
1675 * Since the effect of writing to a slave is so damaging and difficult to clean
1676 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1677 * our masters, and then set read_only=0 on masters at runtime.
1679 $wgDBservers = false;
1682 * Load balancer factory configuration
1683 * To set up a multi-master wiki farm, set the class here to something that
1684 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1685 * The class identified here is responsible for reading $wgDBservers,
1686 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1688 * The LBFactoryMulti class is provided for this purpose, please see
1689 * includes/db/LBFactoryMulti.php for configuration information.
1691 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1694 * How long to wait for a slave to catch up to the master
1696 $wgMasterWaitTimeout = 10;
1699 * File to log database errors to
1701 $wgDBerrorLog = false;
1704 * Timezone to use in the error log.
1705 * Defaults to the wiki timezone ($wgLocaltimezone).
1707 * A list of usable timezones can found at:
1708 * http://php.net/manual/en/timezones.php
1712 * $wgLocaltimezone = 'UTC';
1713 * $wgLocaltimezone = 'GMT';
1714 * $wgLocaltimezone = 'PST8PDT';
1715 * $wgLocaltimezone = 'Europe/Sweden';
1716 * $wgLocaltimezone = 'CET';
1721 $wgDBerrorLogTZ = false;
1724 * When to give an error message
1726 $wgDBClusterTimeout = 10;
1729 * Scale load balancer polling time so that under overload conditions, the
1730 * database server receives a SHOW STATUS query at an average interval of this
1733 $wgDBAvgStatusPoll = 2000;
1736 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1737 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1739 * @warning THIS IS EXPERIMENTAL!
1741 * May break if you're not using the table defs from mysql5/tables.sql.
1742 * May break if you're upgrading an existing wiki if set differently.
1743 * Broken symptoms likely to include incorrect behavior with page titles,
1744 * usernames, comments etc containing non-ASCII characters.
1745 * Might also cause failures on the object cache and other things.
1747 * Even correct usage may cause failures with Unicode supplementary
1748 * characters (those not in the Basic Multilingual Plane) unless MySQL
1749 * has enhanced their Unicode support.
1751 $wgDBmysql5 = false;
1754 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1756 * To use this feature set to true and use a datasource defined as
1757 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1760 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1761 * Pool) that maintains established sessions and reuses them on new
1764 * Not completely tested, but it should fall back on normal connection
1765 * in case the pool is full or the datasource is not configured as
1767 * And the other way around; using oci_pconnect on a non pooled
1768 * datasource should produce a normal connection.
1770 * When it comes to frequent shortlived DB connections like with MW
1771 * Oracle tends to s***. The problem is the driver connects to the
1772 * database reasonably fast, but establishing a session takes time and
1773 * resources. MW does not rely on session state (as it does not use
1774 * features such as package variables) so establishing a valid session
1775 * is in this case an unwanted overhead that just slows things down.
1777 * @warning EXPERIMENTAL!
1780 $wgDBOracleDRCP = false;
1783 * Other wikis on this site, can be administered from a single developer
1785 * Array numeric key => database name
1787 $wgLocalDatabases = array();
1790 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1791 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1792 * show a more obvious warning.
1794 $wgSlaveLagWarning = 10;
1797 * @see $wgSlaveLagWarning
1799 $wgSlaveLagCritical = 30;
1801 /**@}*/ # End of DB settings }
1803 /************************************************************************//**
1804 * @name Text storage
1809 * We can also compress text stored in the 'text' table. If this is set on, new
1810 * revisions will be compressed on page save if zlib support is available. Any
1811 * compressed revisions will be decompressed on load regardless of this setting,
1812 * but will not be readable at all* if zlib support is not available.
1814 $wgCompressRevisions = false;
1817 * External stores allow including content
1818 * from non database sources following URL links.
1820 * Short names of ExternalStore classes may be specified in an array here:
1822 * $wgExternalStores = array("http","file","custom")...
1825 * CAUTION: Access to database might lead to code execution
1827 $wgExternalStores = array();
1830 * An array of external MySQL servers.
1833 * Create a cluster named 'cluster1' containing three servers:
1835 * $wgExternalServers = array(
1836 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1840 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1843 $wgExternalServers = array();
1846 * The place to put new revisions, false to put them in the local text table.
1847 * Part of a URL, e.g. DB://cluster1
1849 * Can be an array instead of a single string, to enable data distribution. Keys
1850 * must be consecutive integers, starting at zero.
1854 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1859 $wgDefaultExternalStore = false;
1862 * Revision text may be cached in $wgMemc to reduce load on external storage
1863 * servers and object extraction overhead for frequently-loaded revisions.
1865 * Set to 0 to disable, or number of seconds before cache expiry.
1867 $wgRevisionCacheExpiry = 0;
1869 /** @} */ # end text storage }
1871 /************************************************************************//**
1872 * @name Performance hacks and limits
1877 * Disable database-intensive features
1879 $wgMiserMode = false;
1882 * Disable all query pages if miser mode is on, not just some
1884 $wgDisableQueryPages = false;
1887 * Number of rows to cache in 'querycache' table when miser mode is on
1889 $wgQueryCacheLimit = 1000;
1892 * Number of links to a page required before it is deemed "wanted"
1894 $wgWantedPagesThreshold = 1;
1897 * Enable slow parser functions
1899 $wgAllowSlowParserFunctions = false;
1902 * Allow schema updates
1904 $wgAllowSchemaUpdates = true;
1907 * Anti-lock flags - bitfield
1908 * - ALF_NO_LINK_LOCK:
1909 * Don't use locking reads when updating the link table. This is
1910 * necessary for wikis with a high edit rate for performance
1911 * reasons, but may cause link table inconsistency
1913 $wgAntiLockFlags = 0;
1916 * Maximum article size in kilobytes
1918 $wgMaxArticleSize = 2048;
1921 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1922 * raise PHP's memory limit if it's below this amount.
1924 $wgMemoryLimit = "50M";
1926 /** @} */ # end performance hacks }
1928 /************************************************************************//**
1929 * @name Cache settings
1934 * Directory for caching data in the local filesystem. Should not be accessible
1935 * from the web. Set this to false to not use any local caches.
1937 * Note: if multiple wikis share the same localisation cache directory, they
1938 * must all have the same set of extensions. You can set a directory just for
1939 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1941 $wgCacheDirectory = false;
1944 * Main cache type. This should be a cache with fast access, but it may have
1945 * limited space. By default, it is disabled, since the database is not fast
1946 * enough to make it worthwhile.
1950 * - CACHE_ANYTHING: Use anything, as long as it works
1951 * - CACHE_NONE: Do not cache
1952 * - CACHE_DB: Store cache objects in the DB
1953 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
1954 * - CACHE_ACCEL: APC, XCache or WinCache
1955 * - (other): A string may be used which identifies a cache
1956 * configuration in $wgObjectCaches.
1958 * @see $wgMessageCacheType, $wgParserCacheType
1960 $wgMainCacheType = CACHE_NONE
;
1963 * The cache type for storing the contents of the MediaWiki namespace. This
1964 * cache is used for a small amount of data which is expensive to regenerate.
1966 * For available types see $wgMainCacheType.
1968 $wgMessageCacheType = CACHE_ANYTHING
;
1971 * The cache type for storing article HTML. This is used to store data which
1972 * is expensive to regenerate, and benefits from having plenty of storage space.
1974 * For available types see $wgMainCacheType.
1976 $wgParserCacheType = CACHE_ANYTHING
;
1979 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
1981 * For available types see $wgMainCacheType.
1983 $wgSessionCacheType = CACHE_ANYTHING
;
1986 * The cache type for storing language conversion tables,
1987 * which are used when parsing certain text and interface messages.
1989 * For available types see $wgMainCacheType.
1993 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
1996 * Advanced object cache configuration.
1998 * Use this to define the class names and constructor parameters which are used
1999 * for the various cache types. Custom cache types may be defined here and
2000 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2001 * or $wgLanguageConverterCacheType.
2003 * The format is an associative array where the key is a cache identifier, and
2004 * the value is an associative array of parameters. The "class" parameter is the
2005 * class name which will be used. Alternatively, a "factory" parameter may be
2006 * given, giving a callable function which will generate a suitable cache object.
2008 $wgObjectCaches = array(
2009 CACHE_NONE
=> array( 'class' => 'EmptyBagOStuff' ),
2010 CACHE_DB
=> array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
2012 CACHE_ANYTHING
=> array( 'factory' => 'ObjectCache::newAnything' ),
2013 CACHE_ACCEL
=> array( 'factory' => 'ObjectCache::newAccelerator' ),
2014 CACHE_MEMCACHED
=> array( 'factory' => 'ObjectCache::newMemcached' ),
2016 'apc' => array( 'class' => 'APCBagOStuff' ),
2017 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2018 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2019 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2020 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2021 'hash' => array( 'class' => 'HashBagOStuff' ),
2025 * The expiry time for the parser cache, in seconds.
2026 * The default is 86400 (one day).
2028 $wgParserCacheExpireTime = 86400;
2031 * Deprecated alias for $wgSessionsInObjectCache.
2033 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2035 $wgSessionsInMemcached = false;
2038 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2039 * can be useful to improve performance, or to avoid the locking behavior of
2040 * PHP's default session handler, which tends to prevent multiple requests for
2041 * the same user from acting concurrently.
2043 $wgSessionsInObjectCache = false;
2046 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2047 * enabled, in seconds.
2049 $wgObjectCacheSessionExpiry = 3600;
2052 * This is used for setting php's session.save_handler. In practice, you will
2053 * almost never need to change this ever. Other options might be 'user' or
2054 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2055 * useful if you're doing cross-application sessions, see bug 11381)
2057 $wgSessionHandler = null;
2060 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2062 $wgMemCachedDebug = false;
2065 * The list of MemCached servers and port numbers
2067 $wgMemCachedServers = array( '127.0.0.1:11211' );
2070 * Use persistent connections to MemCached, which are shared across multiple
2073 $wgMemCachedPersistent = false;
2076 * Read/write timeout for MemCached server communication, in microseconds.
2078 $wgMemCachedTimeout = 500000;
2081 * Set this to true to make a local copy of the message cache, for use in
2082 * addition to memcached. The files will be put in $wgCacheDirectory.
2084 $wgUseLocalMessageCache = false;
2087 * Instead of caching everything, only cache those messages which have
2088 * been customised in the site content language. This means that
2089 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2090 * This option is probably only useful for translatewiki.net.
2092 $wgAdaptiveMessageCache = false;
2095 * Localisation cache configuration. Associative array with keys:
2096 * class: The class to use. May be overridden by extensions.
2098 * store: The location to store cache data. May be 'files', 'db' or
2099 * 'detect'. If set to "files", data will be in CDB files. If set
2100 * to "db", data will be stored to the database. If set to
2101 * "detect", files will be used if $wgCacheDirectory is set,
2102 * otherwise the database will be used.
2104 * storeClass: The class name for the underlying storage. If set to a class
2105 * name, it overrides the "store" setting.
2107 * storeDirectory: If the store class puts its data in files, this is the
2108 * directory it will use. If this is false, $wgCacheDirectory
2111 * manualRecache: Set this to true to disable cache updates on web requests.
2112 * Use maintenance/rebuildLocalisationCache.php instead.
2114 $wgLocalisationCacheConf = array(
2115 'class' => 'LocalisationCache',
2116 'store' => 'detect',
2117 'storeClass' => false,
2118 'storeDirectory' => false,
2119 'manualRecache' => false,
2123 * Allow client-side caching of pages
2125 $wgCachePages = true;
2128 * Set this to current time to invalidate all prior cached pages. Affects both
2129 * client-side and server-side caching.
2130 * You can get the current date on your server by using the command:
2132 * date +%Y%m%d%H%M%S
2135 $wgCacheEpoch = '20030516000000';
2138 * Bump this number when changing the global style sheets and JavaScript.
2140 * It should be appended in the query string of static CSS and JS includes,
2141 * to ensure that client-side caches do not keep obsolete copies of global
2144 $wgStyleVersion = '303';
2147 * This will cache static pages for non-logged-in users to reduce
2148 * database traffic on public sites.
2149 * Automatically sets $wgShowIPinHeader = false
2150 * ResourceLoader requests to default language and skins are cached
2151 * as well as single module requests.
2153 $wgUseFileCache = false;
2156 * Depth of the subdirectory hierarchy to be created under
2157 * $wgFileCacheDirectory. The subdirectories will be named based on
2158 * the MD5 hash of the title. A value of 0 means all cache files will
2159 * be put directly into the main file cache directory.
2161 $wgFileCacheDepth = 2;
2164 * Keep parsed pages in a cache (objectcache table or memcached)
2165 * to speed up output of the same page viewed by another user with the
2168 * This can provide a significant speedup for medium to large pages,
2169 * so you probably want to keep it on. Extensions that conflict with the
2170 * parser cache should disable the cache on a per-page basis instead.
2172 $wgEnableParserCache = true;
2175 * Append a configured value to the parser cache and the sitenotice key so
2176 * that they can be kept separate for some class of activity.
2178 $wgRenderHashAppend = '';
2181 * If on, the sidebar navigation links are cached for users with the
2182 * current language set. This can save a touch of load on a busy site
2183 * by shaving off extra message lookups.
2185 * However it is also fragile: changing the site configuration, or
2186 * having a variable $wgArticlePath, can produce broken links that
2187 * don't update as expected.
2189 $wgEnableSidebarCache = false;
2192 * Expiry time for the sidebar cache, in seconds
2194 $wgSidebarCacheExpiry = 86400;
2197 * When using the file cache, we can store the cached HTML gzipped to save disk
2198 * space. Pages will then also be served compressed to clients that support it.
2200 * Requires zlib support enabled in PHP.
2205 * Whether MediaWiki should send an ETag header. Seems to cause
2206 * broken behavior with Squid 2.6, see bug 7098.
2211 * Clock skew or the one-second resolution of time() can occasionally cause cache
2212 * problems when the user requests two pages within a short period of time. This
2213 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2216 $wgClockSkewFudge = 5;
2219 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2220 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2221 * was previously done in the default LocalSettings.php file.
2223 * On high-traffic wikis, this should be set to false, to avoid the need to
2224 * check the file modification time, and to avoid the performance impact of
2225 * unnecessary cache invalidations.
2227 $wgInvalidateCacheOnLocalSettingsChange = true;
2229 /** @} */ # end of cache settings
2231 /************************************************************************//**
2232 * @name HTTP proxy (Squid) settings
2234 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2235 * although they are referred to as Squid settings for historical reasons.
2237 * Achieving a high hit ratio with an HTTP proxy requires special
2238 * configuration. See http://www.mediawiki.org/wiki/Manual:Squid_caching for
2245 * Enable/disable Squid.
2246 * See http://www.mediawiki.org/wiki/Manual:Squid_caching
2248 $wgUseSquid = false;
2251 * If you run Squid3 with ESI support, enable this (default:false):
2256 * Send X-Vary-Options header for better caching (requires patched Squid)
2261 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2262 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2263 * and need to split the cache between HTTP and HTTPS for API requests,
2264 * feed requests and HTTP redirect responses in order to prevent cache
2265 * pollution. This does not affect 'normal' requests to index.php other than
2268 $wgVaryOnXFP = false;
2271 * Internal server name as known to Squid, if different.
2275 * $wgInternalServer = 'http://yourinternal.tld:8000';
2278 $wgInternalServer = false;
2281 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2282 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2283 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2286 $wgSquidMaxage = 18000;
2289 * Default maximum age for raw CSS/JS accesses
2291 $wgForcedRawSMaxage = 300;
2294 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2296 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2297 * headers sent/modified from these proxies when obtaining the remote IP address
2299 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2301 $wgSquidServers = array();
2304 * As above, except these servers aren't purged on page changes; use to set a
2305 * list of trusted proxies, etc. Supports both individual IP addresses and
2307 * @since 1.23 Supports CIDR ranges
2309 $wgSquidServersNoPurge = array();
2312 * Maximum number of titles to purge in any one client operation
2314 $wgMaxSquidPurgeTitles = 400;
2317 * Whether to use a Host header in purge requests sent to the proxy servers
2318 * configured in $wgSquidServers. Set this to false to support Squid
2319 * configured in forward-proxy mode.
2321 * If this is set to true, a Host header will be sent, and only the path
2322 * component of the URL will appear on the request line, as if the request
2323 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2324 * request. Squid supports this style of request only if reverse-proxy mode
2325 * (http_port ... accel) is enabled.
2327 * If this is set to false, no Host header will be sent, and the absolute URL
2328 * will be sent in the request line, as is the standard for an HTTP proxy
2329 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2330 * by Varnish, but is supported by Squid in either configuration (forward or
2335 $wgSquidPurgeUseHostHeader = true;
2338 * Routing configuration for HTCP multicast purging. Add elements here to
2339 * enable HTCP and determine which purges are sent where. If set to an empty
2340 * array, HTCP is disabled.
2342 * Each key in this array is a regular expression to match against the purged
2343 * URL, or an empty string to match all URLs. The purged URL is matched against
2344 * the regexes in the order specified, and the first rule whose regex matches
2345 * is used, all remaining rules will thus be ignored.
2347 * @par Example configuration to send purges for upload.wikimedia.org to one
2348 * multicast group and all other purges to another:
2350 * $wgHTCPRouting = array(
2351 * '|^https?://upload\.wikimedia\.org|' => array(
2352 * 'host' => '239.128.0.113',
2356 * 'host' => '239.128.0.112',
2362 * You can also pass an array of hosts to send purges too. This is useful when
2363 * you have several multicast groups or unicast address that should receive a
2364 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2366 * @par Example of sending purges to multiple hosts:
2368 * $wgHTCPRouting = array(
2370 * // Purges to text caches using multicast
2371 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2372 * // Purges to a hardcoded list of caches
2373 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2374 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2375 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2382 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2383 * For back compatibility purposes, whenever its array is empty
2384 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2386 * @see $wgHTCPMulticastTTL
2388 $wgHTCPRouting = array();
2391 * @deprecated since 1.22, please use $wgHTCPRouting instead.
2393 * Whenever this is set and $wgHTCPRouting evaluates to false, $wgHTCPRouting
2394 * will be set to this value.
2395 * This is merely for back compatibility.
2399 $wgHTCPMulticastRouting = null;
2402 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
2404 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
2405 * present in the earliest Squid implementations of the protocol.
2407 * This setting is DEPRECATED in favor of $wgHTCPRouting , and kept for
2408 * backwards compatibility only. If $wgHTCPRouting is set, this setting is
2409 * ignored. If $wgHTCPRouting is not set and this setting is, it is used to
2410 * populate $wgHTCPRouting.
2412 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2413 * favor of $wgHTCPRouting.
2415 $wgHTCPMulticastAddress = false;
2418 * HTCP multicast port.
2419 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2420 * favor of $wgHTCPRouting.
2422 * @see $wgHTCPMulticastAddress
2427 * HTCP multicast TTL.
2428 * @see $wgHTCPRouting
2430 $wgHTCPMulticastTTL = 1;
2433 * Should forwarded Private IPs be accepted?
2435 $wgUsePrivateIPs = false;
2437 /** @} */ # end of HTTP proxy settings
2439 /************************************************************************//**
2440 * @name Language, regional and character encoding settings
2445 * Site language code. See languages/Names.php for languages supported by
2446 * MediaWiki out of the box. Not all languages listed there have translations,
2447 * see languages/messages/ for the list of languages with some localisation.
2449 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2450 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2452 * This defines the default interface language for all users, but users can
2453 * change it in their preferences.
2455 * This also defines the language of pages in the wiki. The content is wrapped
2456 * in a html element with lang=XX attribute. This behavior can be overridden
2457 * via hooks, see Title::getPageLanguage.
2459 $wgLanguageCode = 'en';
2462 * Language cache size, or really how many languages can we handle
2463 * simultaneously without degrading to crawl speed.
2465 $wgLangObjCacheSize = 10;
2468 * Some languages need different word forms, usually for different cases.
2469 * Used in Language::convertGrammar().
2473 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2476 $wgGrammarForms = array();
2479 * Treat language links as magic connectors, not inline links
2481 $wgInterwikiMagic = true;
2484 * Hide interlanguage links from the sidebar
2486 $wgHideInterlanguageLinks = false;
2489 * List of language names or overrides for default names in Names.php
2491 $wgExtraLanguageNames = array();
2494 * List of language codes that don't correspond to an actual language.
2495 * These codes are mostly left-offs from renames, or other legacy things.
2496 * This array makes them not appear as a selectable language on the installer,
2497 * and excludes them when running the transstat.php script.
2499 $wgDummyLanguageCodes = array(
2502 'be-x-old' => 'be-tarask',
2506 'qqq' => 'qqq', # Used for message documentation.
2507 'qqx' => 'qqx', # Used for viewing message keys.
2510 'zh-classical' => 'lzh',
2511 'zh-min-nan' => 'nan',
2516 * Character set for use in the article edit box. Language-specific encodings
2519 * This historic feature is one of the first that was added by former MediaWiki
2520 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2522 $wgEditEncoding = '';
2525 * Set this to true to replace Arabic presentation forms with their standard
2526 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2529 * Note that pages with titles containing presentation forms will become
2530 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2532 $wgFixArabicUnicode = true;
2535 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2536 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2537 * set to "ml". Note that some clients (even new clients as of 2010) do not
2538 * support these characters.
2540 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2541 * fix any ZWJ sequences in existing page titles.
2543 $wgFixMalayalamUnicode = true;
2546 * Set this to always convert certain Unicode sequences to modern ones
2547 * regardless of the content language. This has a small performance
2550 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2555 $wgAllUnicodeFixes = false;
2558 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2559 * loading old revisions not marked with "utf-8" flag. Use this when
2560 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2561 * burdensome mass conversion of old text data.
2563 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2564 * user names, etc still must be converted en masse in the database before
2565 * continuing as a UTF-8 wiki.
2567 $wgLegacyEncoding = false;
2570 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2571 * regexps : "/regexp/" matching problematic browsers. These browsers will
2572 * be served encoded unicode in the edit box instead of real unicode.
2574 $wgBrowserBlackList = array(
2576 * Netscape 2-4 detection
2577 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2578 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2579 * with a negative assertion. The [UIN] identifier specifies the level of security
2580 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2581 * The language string is unreliable, it is missing on NS4 Mac.
2583 * Reference: http://www.psychedelix.com/agents/index.shtml
2585 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2586 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2587 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2590 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2591 * Þ to <THORN> and Ð to <ETH>
2594 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2595 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2596 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2599 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2600 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2602 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2605 * Google wireless transcoder, seems to eat a lot of chars alive
2606 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2608 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2612 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2613 * create stub reference rows in the text table instead of copying
2614 * the full text of all current entries from 'cur' to 'text'.
2616 * This will speed up the conversion step for large sites, but
2617 * requires that the cur table be kept around for those revisions
2618 * to remain viewable.
2620 * This option affects the updaters *only*. Any present cur stub
2621 * revisions will be readable at runtime regardless of this setting.
2623 $wgLegacySchemaConversion = false;
2626 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2627 * the interface is set to English.
2629 $wgAmericanDates = false;
2632 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2633 * numerals in interface.
2635 $wgTranslateNumerals = true;
2638 * Translation using MediaWiki: namespace.
2639 * Interface messages will be loaded from the database.
2641 $wgUseDatabaseMessages = true;
2644 * Expiry time for the message cache key
2646 $wgMsgCacheExpiry = 86400;
2649 * Maximum entry size in the message cache, in bytes
2651 $wgMaxMsgCacheEntrySize = 10000;
2654 * Whether to enable language variant conversion.
2656 $wgDisableLangConversion = false;
2659 * Whether to enable language variant conversion for links.
2661 $wgDisableTitleConversion = false;
2664 * Whether to enable canonical language links in meta data.
2666 $wgCanonicalLanguageLinks = true;
2669 * Default variant code, if false, the default will be the language code
2671 $wgDefaultLanguageVariant = false;
2674 * Disabled variants array of language variant conversion.
2678 * $wgDisabledVariants[] = 'zh-mo';
2679 * $wgDisabledVariants[] = 'zh-my';
2682 $wgDisabledVariants = array();
2685 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2686 * path format that describes which parts of the URL contain the
2691 * $wgLanguageCode = 'sr';
2692 * $wgVariantArticlePath = '/$2/$1';
2693 * $wgArticlePath = '/wiki/$1';
2696 * A link to /wiki/ would be redirected to /sr/Главна_страна
2698 * It is important that $wgArticlePath not overlap with possible values
2699 * of $wgVariantArticlePath.
2701 $wgVariantArticlePath = false;
2704 * Show a bar of language selection links in the user login and user
2705 * registration forms; edit the "loginlanguagelinks" message to
2708 $wgLoginLanguageSelector = false;
2711 * When translating messages with wfMessage(), it is not always clear what
2712 * should be considered UI messages and what should be content messages.
2714 * For example, for the English Wikipedia, there should be only one 'mainpage',
2715 * so when getting the link for 'mainpage', we should treat it as site content
2716 * and call ->inContentLanguage()->text(), but for rendering the text of the
2717 * link, we call ->text(). The code behaves this way by default. However,
2718 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2719 * and the like for different languages. This array provides a way to override
2720 * the default behavior.
2723 * To allow language-specific main page and community
2726 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2729 $wgForceUIMsgAsContentMsg = array();
2732 * Fake out the timezone that the server thinks it's in. This will be used for
2733 * date display and not for what's stored in the DB. Leave to null to retain
2734 * your server's OS-based timezone value.
2736 * This variable is currently used only for signature formatting and for local
2737 * time/date parser variables ({{LOCALTIME}} etc.)
2739 * Timezones can be translated by editing MediaWiki messages of type
2740 * timezone-nameinlowercase like timezone-utc.
2742 * A list of usable timezones can found at:
2743 * http://php.net/manual/en/timezones.php
2747 * $wgLocaltimezone = 'UTC';
2748 * $wgLocaltimezone = 'GMT';
2749 * $wgLocaltimezone = 'PST8PDT';
2750 * $wgLocaltimezone = 'Europe/Sweden';
2751 * $wgLocaltimezone = 'CET';
2754 $wgLocaltimezone = null;
2757 * Set an offset from UTC in minutes to use for the default timezone setting
2758 * for anonymous users and new user accounts.
2760 * This setting is used for most date/time displays in the software, and is
2761 * overridable in user preferences. It is *not* used for signature timestamps.
2763 * By default, this will be set to match $wgLocaltimezone.
2765 $wgLocalTZoffset = null;
2767 /** @} */ # End of language/charset settings
2769 /*************************************************************************//**
2770 * @name Output format and skin settings
2775 * The default Content-Type header.
2777 $wgMimeType = 'text/html';
2780 * Previously used as content type in HTML script tags. This is now ignored since
2781 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2782 * It was also previously used by RawAction to determine the ctype query parameter
2783 * value that will result in a javascript response.
2784 * @deprecated since 1.22
2786 $wgJsMimeType = null;
2789 * The default xmlns attribute. The option to define this has been removed.
2790 * The value of this variable is no longer used by core and is set to a fixed
2791 * value in Setup.php for compatibility with extensions that depend on the value
2792 * of this variable being set. Such a dependency however is deprecated.
2793 * @deprecated since 1.22
2795 $wgXhtmlDefaultNamespace = null;
2798 * Previously used to determine if we should output an HTML5 doctype.
2799 * This is no longer used as we always output HTML5 now. For compatibility with
2800 * extensions that still check the value of this config it's value is now forced
2801 * to true by Setup.php.
2802 * @deprecated since 1.22
2807 * Defines the value of the version attribute in the <html> tag, if any.
2808 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2809 * (like if it's left at the default null value), it will be auto-initialized
2810 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2811 * ever actually set this to anything.
2813 $wgHtml5Version = null;
2816 * Enabled RDFa attributes for use in wikitext.
2817 * NOTE: Interaction with HTML5 is somewhat underspecified.
2819 $wgAllowRdfaAttributes = false;
2822 * Enabled HTML5 microdata attributes for use in wikitext.
2824 $wgAllowMicrodataAttributes = false;
2827 * Should we try to make our HTML output well-formed XML? If set to false,
2828 * output will be a few bytes shorter, and the HTML will arguably be more
2829 * readable. If set to true, life will be much easier for the authors of
2830 * screen-scraping bots, and the HTML will arguably be more readable.
2832 * Setting this to false may omit quotation marks on some attributes, omit
2833 * slashes from some self-closing tags, omit some ending tags, etc., where
2834 * permitted by HTML5. Setting it to true will not guarantee that all pages
2835 * will be well-formed, although non-well-formed pages should be rare and it's
2836 * a bug if you find one. Conversely, setting it to false doesn't mean that
2837 * all XML-y constructs will be omitted, just that they might be.
2839 * Because of compatibility with screen-scraping bots, and because it's
2840 * controversial, this is currently left to true by default.
2842 $wgWellFormedXml = true;
2845 * Permit other namespaces in addition to the w3.org default.
2847 * Use the prefix for the key and the namespace for the value.
2851 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2853 * Normally we wouldn't have to define this in the root "<html>"
2854 * element, but IE needs it there in some circumstances.
2856 * This is ignored if $wgMimeType is set to a non-XML mimetype.
2858 $wgXhtmlNamespaces = array();
2861 * Show IP address, for non-logged in users. It's necessary to switch this off
2862 * for some forms of caching.
2863 * @warning Will disable file cache.
2865 $wgShowIPinHeader = true;
2868 * Site notice shown at the top of each page
2870 * MediaWiki:Sitenotice page, which will override this. You can also
2871 * provide a separate message for logged-out users using the
2872 * MediaWiki:Anonnotice page.
2877 * A subtitle to add to the tagline, for skins that have it/
2879 $wgExtraSubtitle = '';
2882 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2884 $wgSiteSupportPage = '';
2887 * Validate the overall output using tidy and refuse
2888 * to display the page if it's not valid.
2890 $wgValidateAllHtml = false;
2893 * Default skin, for new users and anonymous visitors. Registered users may
2894 * change this to any one of the other available skins in their preferences.
2895 * This has to be completely lowercase; see the "skins" directory for the list
2896 * of available skins.
2898 $wgDefaultSkin = 'vector';
2901 * Specify the name of a skin that should not be presented in the list of
2902 * available skins. Use for blacklisting a skin which you do not want to
2903 * remove from the .../skins/ directory
2908 * Array for more like $wgSkipSkin.
2910 $wgSkipSkins = array();
2913 * Allow user Javascript page?
2914 * This enables a lot of neat customizations, but may
2915 * increase security risk to users and server load.
2917 $wgAllowUserJs = false;
2920 * Allow user Cascading Style Sheets (CSS)?
2921 * This enables a lot of neat customizations, but may
2922 * increase security risk to users and server load.
2924 $wgAllowUserCss = false;
2927 * Allow user-preferences implemented in CSS?
2928 * This allows users to customise the site appearance to a greater
2929 * degree; disabling it will improve page load times.
2931 $wgAllowUserCssPrefs = true;
2934 * Use the site's Javascript page?
2936 $wgUseSiteJs = true;
2939 * Use the site's Cascading Style Sheets (CSS)?
2941 $wgUseSiteCss = true;
2944 * Break out of framesets. This can be used to prevent clickjacking attacks,
2945 * or to prevent external sites from framing your site with ads.
2947 $wgBreakFrames = false;
2950 * The X-Frame-Options header to send on pages sensitive to clickjacking
2951 * attacks, such as edit pages. This prevents those pages from being displayed
2952 * in a frame or iframe. The options are:
2954 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2956 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
2957 * to allow framing within a trusted domain. This is insecure if there
2958 * is a page on the same domain which allows framing of arbitrary URLs.
2960 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
2961 * full compromise of local user accounts. Private wikis behind a
2962 * corporate firewall are especially vulnerable. This is not
2965 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
2966 * not just edit pages.
2968 $wgEditPageFrameOptions = 'DENY';
2971 * Disallow framing of API pages directly, by setting the X-Frame-Options
2972 * header. Since the API returns CSRF tokens, allowing the results to be
2973 * framed can compromise your user's account security.
2975 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2976 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
2977 * - false: Allow all framing.
2979 $wgApiFrameOptions = 'DENY';
2982 * Disable output compression (enabled by default if zlib is available)
2984 $wgDisableOutputCompression = false;
2987 * Should we allow a broader set of characters in id attributes, per HTML5? If
2988 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
2989 * functionality is ready, it will be on by default with no option.
2991 * Currently this appears to work fine in all browsers, but it's disabled by
2992 * default because it normalizes id's a bit too aggressively, breaking preexisting
2993 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
2995 $wgExperimentalHtmlIds = false;
2998 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
2999 * You can add new icons to the built in copyright or poweredby, or you can create
3000 * a new block. Though note that you may need to add some custom css to get good styling
3001 * of new blocks in monobook. vector and modern should work without any special css.
3003 * $wgFooterIcons itself is a key/value array.
3004 * The key is the name of a block that the icons will be wrapped in. The final id varies
3005 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3006 * turns it into mw_poweredby.
3007 * The value is either key/value array of icons or a string.
3008 * In the key/value array the key may or may not be used by the skin but it can
3009 * be used to find the icon and unset it or change the icon if needed.
3010 * This is useful for disabling icons that are set by extensions.
3011 * The value should be either a string or an array. If it is a string it will be output
3012 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3013 * for the icon, the following keys are used:
3014 * - src: An absolute url to the image to use for the icon, this is recommended
3015 * but not required, however some skins will ignore icons without an image
3016 * - url: The url to use in the a element around the text or icon, if not set an a element will
3018 * - alt: This is the text form of the icon, it will be displayed without an image in
3019 * skins like Modern or if src is not set, and will otherwise be used as
3020 * the alt="" for the image. This key is required.
3021 * - width and height: If the icon specified by src is not of the standard size
3022 * you can specify the size of image to use with these keys.
3023 * Otherwise they will default to the standard 88x31.
3024 * @todo Reformat documentation.
3026 $wgFooterIcons = array(
3027 "copyright" => array(
3028 "copyright" => array(), // placeholder for the built in copyright icon
3030 "poweredby" => array(
3031 "mediawiki" => array(
3032 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
3033 "url" => "//www.mediawiki.org/",
3034 "alt" => "Powered by MediaWiki",
3040 * Login / create account link behavior when it's possible for anonymous users
3041 * to create an account.
3042 * - true = use a combined login / create account link
3043 * - false = split login and create account into two separate links
3045 $wgUseCombinedLoginLink = false;
3048 * Search form look for Vector skin only.
3049 * - true = use an icon search button
3050 * - false = use Go & Search buttons
3052 $wgVectorUseSimpleSearch = true;
3055 * Watch and unwatch as an icon rather than a link for Vector skin only.
3056 * - true = use an icon watch/unwatch button
3057 * - false = use watch/unwatch text link
3059 $wgVectorUseIconWatch = true;
3062 * Display user edit counts in various prominent places.
3064 $wgEdititis = false;
3067 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3068 * status code, mangling or hiding MediaWiki's output. If you are using such a
3069 * host, you should start looking for a better one. While you're doing that,
3070 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3071 * that the generated error pages can be seen.
3073 * In cases where for technical reasons it is more important for MediaWiki to
3074 * send the correct status code than for the body to be transmitted intact,
3075 * this configuration variable is ignored.
3077 $wgSend404Code = true;
3080 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3081 * rollback. The numeric value of the variable are the limit up to are counted.
3082 * If the value is false or 0, the edits are not counted. Disabling this will
3083 * furthermore prevent MediaWiki from hiding some useless rollback links.
3087 $wgShowRollbackEditCount = 10;
3090 * Output a <link rel="canonical"> tag on every page indicating the canonical
3091 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3092 * detection of the current server is unreliable, the link is sent
3095 $wgEnableCanonicalServerLink = false;
3097 /** @} */ # End of output format settings }
3099 /*************************************************************************//**
3100 * @name Resource loader settings
3105 * Client-side resource modules.
3107 * Extensions should add their resource loader module definitions
3108 * to the $wgResourceModules variable.
3112 * $wgResourceModules['ext.myExtension'] = array(
3113 * 'scripts' => 'myExtension.js',
3114 * 'styles' => 'myExtension.css',
3115 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3116 * 'localBasePath' => __DIR__,
3117 * 'remoteExtPath' => 'MyExtension',
3121 $wgResourceModules = array();
3124 * Extensions should register foreign module sources here. 'local' is a
3125 * built-in source that is not in this array, but defined by
3126 * ResourceLoader::__construct() so that it cannot be unset.
3130 * $wgResourceLoaderSources['foo'] = array(
3131 * 'loadScript' => 'http://example.org/w/load.php',
3132 * 'apiScript' => 'http://example.org/w/api.php'
3136 $wgResourceLoaderSources = array();
3139 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3140 * If not set, then $wgScriptPath will be used as a fallback.
3142 $wgResourceBasePath = null;
3145 * Maximum time in seconds to cache resources served by the resource loader.
3147 * @todo Document array structure
3149 $wgResourceLoaderMaxage = array(
3150 'versioned' => array(
3151 // Squid/Varnish but also any other public proxy cache between the client and MediaWiki
3152 'server' => 30 * 24 * 60 * 60, // 30 days
3153 // On the client side (e.g. in the browser cache).
3154 'client' => 30 * 24 * 60 * 60, // 30 days
3156 'unversioned' => array(
3157 'server' => 5 * 60, // 5 minutes
3158 'client' => 5 * 60, // 5 minutes
3163 * The default debug mode (on/off) for of ResourceLoader requests.
3165 * This will still be overridden when the debug URL parameter is used.
3167 $wgResourceLoaderDebug = false;
3170 * Enable embedding of certain resources using Edge Side Includes. This will
3171 * improve performance but only works if there is something in front of the
3172 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3174 $wgResourceLoaderUseESI = false;
3177 * Put each statement on its own line when minifying JavaScript. This makes
3178 * debugging in non-debug mode a bit easier.
3180 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3183 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3184 * the minifier will try not to produce lines longer than this, but may be
3185 * forced to do so in certain cases.
3187 $wgResourceLoaderMinifierMaxLineLength = 1000;
3190 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3193 $wgIncludeLegacyJavaScript = true;
3196 * Whether to preload the mediawiki.util module as blocking module in the top
3199 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3200 * allowed modules to lack dependencies on 'popular' modules that were likely
3203 * This setting is to aid scripts during migration by providing mediawiki.util
3204 * unconditionally (which was the most commonly missed dependency).
3205 * It doesn't cover all missing dependencies obviously but should fix most of
3208 * This should be removed at some point after site/user scripts have been fixed.
3209 * Enable this if your wiki has a large amount of user/site scripts that are
3210 * lacking dependencies.
3213 $wgPreloadJavaScriptMwUtil = false;
3216 * Whether or not to assign configuration variables to the global window object.
3218 * If this is set to false, old code using deprecated variables will no longer
3221 * @par Example of legacy code:
3223 * if ( window.wgRestrictionEdit ) { ... }
3227 * if ( wgIsArticle ) { ... }
3230 * Instead, one needs to use mw.config.
3231 * @par Example using mw.config global configuration:
3233 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3237 * if ( mw.config.get('wgIsArticle') ) { ... }
3240 $wgLegacyJavaScriptGlobals = true;
3243 * If set to a positive number, ResourceLoader will not generate URLs whose
3244 * query string is more than this many characters long, and will instead use
3245 * multiple requests with shorter query strings. This degrades performance,
3246 * but may be needed if your web server has a low (less than, say 1024)
3247 * query string length limit or a low value for suhosin.get.max_value_length
3248 * that you can't increase.
3250 * If set to a negative number, ResourceLoader will assume there is no query
3251 * string length limit.
3253 * Defaults to a value based on php configuration.
3255 $wgResourceLoaderMaxQueryLength = false;
3258 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3259 * prior to minification to validate it.
3261 * Parse errors will result in a JS exception being thrown during module load,
3262 * which avoids breaking other modules loaded in the same request.
3264 $wgResourceLoaderValidateJS = true;
3267 * If set to true, statically-sourced (file-backed) JavaScript resources will
3268 * be parsed for validity before being bundled up into ResourceLoader modules.
3270 * This can be helpful for development by providing better error messages in
3271 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3272 * and may fail on large pre-bundled frameworks.
3274 $wgResourceLoaderValidateStaticJS = false;
3277 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3278 * will be enabled. This is an experimental feature that's supposed to make
3279 * JavaScript load faster.
3281 $wgResourceLoaderExperimentalAsyncLoading = false;
3284 * Global LESS variables. An associative array binding variable names to CSS
3287 * Because the hashed contents of this array are used to construct the cache key
3288 * that ResourceLoader uses to look up LESS compilation results, updating this
3289 * array can be used to deliberately invalidate the set of cached results.
3293 * $wgResourceLoaderLESSVars = array(
3294 * 'baseFontSize' => '1em',
3295 * 'smallFontSize' => '0.75em',
3296 * 'WikimediaBlue' => '#006699',
3301 $wgResourceLoaderLESSVars = array();
3304 * Custom LESS functions. An associative array mapping function name to PHP
3307 * Changes to LESS functions do not trigger cache invalidation. If you update
3308 * the behavior of a LESS function and need to invalidate stale compilation
3309 * results, you can touch one of values in $wgResourceLoaderLESSVars, as
3314 $wgResourceLoaderLESSFunctions = array(
3315 'embeddable' => 'ResourceLoaderLESSFunctions::embeddable',
3316 'embed' => 'ResourceLoaderLESSFunctions::embed',
3320 * Default import paths for LESS modules. LESS files referenced in @import
3321 * statements will be looked up here first, and relative to the importing file
3322 * second. To avoid collisions, it's important for the LESS files in these
3323 * directories to have a common, predictable file name prefix.
3325 * Extensions need not (and should not) register paths in
3326 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3327 * currently compiling LESS file, which allows each extension to freely import
3328 * files from its own tree.
3332 $wgResourceLoaderLESSImportPaths = array(
3333 "$IP/resources/mediawiki.less/",
3334 "$IP/skins/vector/",
3338 * Whether ResourceLoader should attempt to persist modules in localStorage on
3339 * browsers that support the Web Storage API.
3341 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3343 $wgResourceLoaderStorageEnabled = false;
3346 * Cache version for client-side ResourceLoader module storage. You can trigger
3347 * invalidation of the contents of the module store by incrementing this value.
3351 $wgResourceLoaderStorageVersion = 1;
3353 /** @} */ # End of resource loader settings }
3355 /*************************************************************************//**
3356 * @name Page title and interwiki link settings
3361 * Name of the project namespace. If left set to false, $wgSitename will be
3364 $wgMetaNamespace = false;
3367 * Name of the project talk namespace.
3369 * Normally you can ignore this and it will be something like
3370 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3371 * manually for grammatical reasons.
3373 $wgMetaNamespaceTalk = false;
3376 * Additional namespaces. If the namespaces defined in Language.php and
3377 * Namespace.php are insufficient, you can create new ones here, for example,
3378 * to import Help files in other languages. You can also override the namespace
3379 * names of existing namespaces. Extensions developers should use
3380 * $wgCanonicalNamespaceNames.
3382 * @warning Once you delete a namespace, the pages in that namespace will
3383 * no longer be accessible. If you rename it, then you can access them through
3384 * the new namespace name.
3386 * Custom namespaces should start at 100 to avoid conflicting with standard
3387 * namespaces, and should always follow the even/odd main/talk pattern.
3391 * $wgExtraNamespaces = array(
3393 * 101 => "Hilfe_Diskussion",
3395 * 103 => "Discussion_Aide"
3399 * @todo Add a note about maintenance/namespaceDupes.php
3401 $wgExtraNamespaces = array();
3404 * Same as above, but for namespaces with gender distinction.
3405 * Note: the default form for the namespace should also be set
3406 * using $wgExtraNamespaces for the same index.
3409 $wgExtraGenderNamespaces = array();
3412 * Namespace aliases.
3414 * These are alternate names for the primary localised namespace names, which
3415 * are defined by $wgExtraNamespaces and the language file. If a page is
3416 * requested with such a prefix, the request will be redirected to the primary
3419 * Set this to a map from namespace names to IDs.
3423 * $wgNamespaceAliases = array(
3424 * 'Wikipedian' => NS_USER,
3429 $wgNamespaceAliases = array();
3432 * Allowed title characters -- regex character class
3433 * Don't change this unless you know what you're doing
3435 * Problematic punctuation:
3436 * - []{}|# Are needed for link syntax, never enable these
3437 * - <> Causes problems with HTML escaping, don't use
3438 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3439 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3440 * corrupted by apache
3441 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3443 * All three of these punctuation problems can be avoided by using an alias,
3444 * instead of a rewrite rule of either variety.
3446 * The problem with % is that when using a path to query rewrite rule, URLs are
3447 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3448 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3449 * for this, indeed double escaping would break if the double-escaped title was
3450 * passed in the query string rather than the path. This is a minor security issue
3451 * because articles can be created such that they are hard to view or edit.
3453 * In some rare cases you may wish to remove + for compatibility with old links.
3455 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3456 * this breaks interlanguage links
3458 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3461 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3463 $wgLocalInterwiki = false;
3466 * Expiry time for cache of interwiki table
3468 $wgInterwikiExpiry = 10800;
3471 * @name Interwiki caching settings.
3476 *$wgInterwikiCache specifies path to constant database file.
3478 * This cdb database is generated by dumpInterwiki from maintenance and has
3480 * - dbname:key - a simple key (e.g. enwiki:meta)
3481 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3482 * - __global:key - global-scope key (e.g. __global:meta)
3483 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3485 * Sites mapping just specifies site name, other keys provide "local url"
3488 $wgInterwikiCache = false;
3491 * Specify number of domains to check for messages.
3492 * - 1: Just wiki(db)-level
3493 * - 2: wiki and global levels
3496 $wgInterwikiScopes = 3;
3499 * Fallback site, if unable to resolve from cache
3501 $wgInterwikiFallbackSite = 'wiki';
3503 /** @} */ # end of Interwiki caching settings.
3506 * If local interwikis are set up which allow redirects,
3507 * set this regexp to restrict URLs which will be displayed
3508 * as 'redirected from' links.
3511 * It might look something like this:
3513 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3516 * Leave at false to avoid displaying any incoming redirect markers.
3517 * This does not affect intra-wiki redirects, which don't change
3520 $wgRedirectSources = false;
3523 * Set this to false to avoid forcing the first letter of links to capitals.
3525 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3526 * appearing with a capital at the beginning of a sentence will *not* go to the
3527 * same place as links in the middle of a sentence using a lowercase initial.
3529 $wgCapitalLinks = true;
3532 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3533 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3534 * true by default (and setting them has no effect), due to various things that
3535 * require them to be so. Also, since Talk namespaces need to directly mirror their
3536 * associated content namespaces, the values for those are ignored in favor of the
3537 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3542 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3545 $wgCapitalLinkOverrides = array();
3548 * Which namespaces should support subpages?
3549 * See Language.php for a list of namespaces.
3551 $wgNamespacesWithSubpages = array(
3554 NS_USER_TALK
=> true,
3556 NS_PROJECT_TALK
=> true,
3557 NS_FILE_TALK
=> true,
3558 NS_MEDIAWIKI
=> true,
3559 NS_MEDIAWIKI_TALK
=> true,
3560 NS_TEMPLATE_TALK
=> true,
3562 NS_HELP_TALK
=> true,
3563 NS_CATEGORY_TALK
=> true
3567 * Array of namespaces which can be deemed to contain valid "content", as far
3568 * as the site statistics are concerned. Useful if additional namespaces also
3569 * contain "content" which should be considered when generating a count of the
3570 * number of articles in the wiki.
3572 $wgContentNamespaces = array( NS_MAIN
);
3575 * Max number of redirects to follow when resolving redirects.
3576 * 1 means only the first redirect is followed (default behavior).
3577 * 0 or less means no redirects are followed.
3579 $wgMaxRedirects = 1;
3582 * Array of invalid page redirect targets.
3583 * Attempting to create a redirect to any of the pages in this array
3584 * will make the redirect fail.
3585 * Userlogout is hard-coded, so it does not need to be listed here.
3586 * (bug 10569) Disallow Mypage and Mytalk as well.
3588 * As of now, this only checks special pages. Redirects to pages in
3589 * other namespaces cannot be invalidated by this variable.
3591 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3593 /** @} */ # End of title and interwiki settings }
3595 /************************************************************************//**
3596 * @name Parser settings
3597 * These settings configure the transformation from wikitext to HTML.
3602 * Parser configuration. Associative array with the following members:
3604 * class The class name
3606 * preprocessorClass The preprocessor class. Two classes are currently available:
3607 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3608 * storage, and Preprocessor_DOM, which uses the DOM module for
3609 * temporary storage. Preprocessor_DOM generally uses less memory;
3610 * the speed of the two is roughly the same.
3612 * If this parameter is not given, it uses Preprocessor_DOM if the
3613 * DOM module is available, otherwise it uses Preprocessor_Hash.
3615 * The entire associative array will be passed through to the constructor as
3616 * the first parameter. Note that only Setup.php can use this variable --
3617 * the configuration will change at runtime via $wgParser member functions, so
3618 * the contents of this variable will be out-of-date. The variable can only be
3619 * changed during LocalSettings.php, in particular, it can't be changed during
3620 * an extension setup function.
3622 $wgParserConf = array(
3623 'class' => 'Parser',
3624 #'preprocessorClass' => 'Preprocessor_Hash',
3628 * Maximum indent level of toc.
3630 $wgMaxTocLevel = 999;
3633 * A complexity limit on template expansion: the maximum number of nodes visited
3634 * by PPFrame::expand()
3636 $wgMaxPPNodeCount = 1000000;
3639 * A complexity limit on template expansion: the maximum number of elements
3640 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3641 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3642 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3643 * this default corresponds to about 155 MB.
3645 * When the limit is exceeded, an exception is thrown.
3647 $wgMaxGeneratedPPNodeCount = 1000000;
3650 * Maximum recursion depth for templates within templates.
3651 * The current parser adds two levels to the PHP call stack for each template,
3652 * and xdebug limits the call stack to 100 by default. So this should hopefully
3653 * stop the parser before it hits the xdebug limit.
3655 $wgMaxTemplateDepth = 40;
3658 * @see $wgMaxTemplateDepth
3660 $wgMaxPPExpandDepth = 40;
3663 * The external URL protocols
3665 $wgUrlProtocols = array(
3669 'ftps://', // If we allow ftp:// we should allow the secure version.
3671 'sftp://', // SFTP > FTP
3673 'ircs://', // @bug 28503
3674 'xmpp:', // Another open communication protocol
3678 'telnet://', // Well if we're going to support the above.. -ævar
3679 'nntp://', // @bug 3808 RFC 1738
3682 'tel:', // If we can make emails linkable, why not phone numbers?
3683 'sms:', // Likewise this is standardized too
3688 'bitcoin:', // Even registerProtocolHandler whitelists this along with mailto:
3689 'magnet:', // No reason to reject torrents over magnet: when they're allowed over http://
3690 'urn:', // Allow URNs to be used in Microdata/RDFa <link ... href="urn:...">s
3691 'geo:', // urls define geo locations, they're useful in Microdata/RDFa and for coordinates
3692 '//', // for protocol-relative URLs
3696 * If true, removes (substitutes) templates in "~~~~" signatures.
3698 $wgCleanSignatures = true;
3701 * Whether to allow inline image pointing to other websites
3703 $wgAllowExternalImages = false;
3706 * If the above is false, you can specify an exception here. Image URLs
3707 * that start with this string are then rendered, while all others are not.
3708 * You can use this to set up a trusted, simple repository of images.
3709 * You may also specify an array of strings to allow multiple sites
3713 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3714 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3717 $wgAllowExternalImagesFrom = '';
3720 * If $wgAllowExternalImages is false, you can allow an on-wiki
3721 * whitelist of regular expression fragments to match the image URL
3722 * against. If the image matches one of the regular expression fragments,
3723 * The image will be displayed.
3725 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3726 * Or false to disable it
3728 $wgEnableImageWhitelist = true;
3731 * A different approach to the above: simply allow the "<img>" tag to be used.
3732 * This allows you to specify alt text and other attributes, copy-paste HTML to
3733 * your wiki more easily, etc. However, allowing external images in any manner
3734 * will allow anyone with editing rights to snoop on your visitors' IP
3735 * addresses and so forth, if they wanted to, by inserting links to images on
3736 * sites they control.
3738 $wgAllowImageTag = false;
3741 * $wgUseTidy: use tidy to make sure HTML output is sane.
3742 * Tidy is a free tool that fixes broken HTML.
3743 * See http://www.w3.org/People/Raggett/tidy/
3745 * - $wgTidyBin should be set to the path of the binary and
3746 * - $wgTidyConf to the path of the configuration file.
3747 * - $wgTidyOpts can include any number of parameters.
3748 * - $wgTidyInternal controls the use of the PECL extension or the
3749 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3750 * of spawning a separate program.
3751 * Normally you shouldn't need to override the setting except for
3752 * debugging. To install, use 'pear install tidy' and add a line
3753 * 'extension=tidy.so' to php.ini.
3760 $wgAlwaysUseTidy = false;
3765 $wgTidyBin = 'tidy';
3770 $wgTidyConf = $IP . '/includes/tidy.conf';
3780 $wgTidyInternal = extension_loaded( 'tidy' );
3783 * Put tidy warnings in HTML comments
3784 * Only works for internal tidy.
3786 $wgDebugTidy = false;
3789 * Allow raw, unchecked HTML in "<html>...</html>" sections.
3790 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3791 * TO RESTRICT EDITING to only those that you trust
3796 * Set a default target for external links, e.g. _blank to pop up a new window
3798 $wgExternalLinkTarget = false;
3801 * If true, external URL links in wiki text will be given the
3802 * rel="nofollow" attribute as a hint to search engines that
3803 * they should not be followed for ranking purposes as they
3804 * are user-supplied and thus subject to spamming.
3806 $wgNoFollowLinks = true;
3809 * Namespaces in which $wgNoFollowLinks doesn't apply.
3810 * See Language.php for a list of namespaces.
3812 $wgNoFollowNsExceptions = array();
3815 * If this is set to an array of domains, external links to these domain names
3816 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3817 * value of $wgNoFollowLinks. For instance:
3819 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
3820 * 'mediawiki.org' );
3822 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3823 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3826 * Defaults to mediawiki.org for the links included in the software by default.
3828 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
3831 * Allow DISPLAYTITLE to change title display
3833 $wgAllowDisplayTitle = true;
3836 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
3837 * canonical DB key. Also disallow some inline CSS rules like display: none;
3838 * which can cause the text to be hidden or unselectable.
3840 $wgRestrictDisplayTitle = true;
3843 * Maximum number of calls per parse to expensive parser functions such as
3846 $wgExpensiveParserFunctionLimit = 100;
3849 * Preprocessor caching threshold
3850 * Setting it to 'false' will disable the preprocessor cache.
3852 $wgPreprocessorCacheThreshold = 1000;
3855 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
3857 $wgEnableScaryTranscluding = false;
3860 * Expiry time for transcluded templates cached in transcache database table.
3861 * Only used $wgEnableInterwikiTranscluding is set to true.
3863 $wgTranscludeCacheExpiry = 3600;
3865 /** @} */ # end of parser settings }
3867 /************************************************************************//**
3873 * Method used to determine if a page in a content namespace should be counted
3874 * as a valid article.
3876 * Redirect pages will never be counted as valid articles.
3878 * This variable can have the following values:
3879 * - 'any': all pages as considered as valid articles
3880 * - 'comma': the page must contain a comma to be considered valid
3881 * - 'link': the page must contain a [[wiki link]] to be considered valid
3882 * - null: the value will be set at run time depending on $wgUseCommaCount:
3883 * if $wgUseCommaCount is false, it will be 'link', if it is true
3884 * it will be 'comma'
3886 * See also See http://www.mediawiki.org/wiki/Manual:Article_count
3888 * Retroactively changing this variable will not affect the existing count,
3889 * to update it, you will need to run the maintenance/updateArticleCount.php
3892 $wgArticleCountMethod = null;
3895 * Backward compatibility setting, will set $wgArticleCountMethod if it is null.
3896 * @deprecated since 1.18; use $wgArticleCountMethod instead
3898 $wgUseCommaCount = false;
3901 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
3902 * values are easier on the database. A value of 1 causes the counters to be
3903 * updated on every hit, any higher value n cause them to update *on average*
3904 * every n hits. Should be set to either 1 or something largish, eg 1000, for
3905 * maximum efficiency.
3907 $wgHitcounterUpdateFreq = 1;
3910 * How many days user must be idle before he is considered inactive. Will affect
3911 * the number shown on Special:Statistics, Special:ActiveUsers, and the
3912 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
3913 * You might want to leave this as the default value, to provide comparable
3914 * numbers between different wikis.
3916 $wgActiveUserDays = 30;
3918 /** @} */ # End of statistics }
3920 /************************************************************************//**
3921 * @name User accounts, authentication
3926 * For compatibility with old installations set to false
3928 $wgPasswordSalt = true;
3931 * Specifies the minimal length of a user password. If set to 0, empty pass-
3932 * words are allowed.
3934 $wgMinimalPasswordLength = 1;
3937 * Whether to allow password resets ("enter some identifying data, and we'll send an email
3938 * with a temporary password you can use to get back into the account") identified by
3939 * various bits of data. Setting all of these to false (or the whole variable to false)
3940 * has the effect of disabling password resets entirely
3942 $wgPasswordResetRoutes = array(
3948 * Maximum number of Unicode characters in signature
3950 $wgMaxSigChars = 255;
3953 * Maximum number of bytes in username. You want to run the maintenance
3954 * script ./maintenance/checkUsernames.php once you have changed this value.
3956 $wgMaxNameChars = 255;
3959 * Array of usernames which may not be registered or logged in from
3960 * Maintenance scripts can still use these
3962 $wgReservedUsernames = array(
3963 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
3964 'Conversion script', // Used for the old Wikipedia software upgrade
3965 'Maintenance script', // Maintenance scripts which perform editing, image import script
3966 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
3967 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
3968 'msg:double-redirect-fixer', // Automatic double redirect fix
3969 'msg:usermessage-editor', // Default user for leaving user messages
3970 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
3974 * Settings added to this array will override the default globals for the user
3975 * preferences used by anonymous visitors and newly created accounts.
3976 * For instance, to disable section editing links:
3977 * $wgDefaultUserOptions ['editsection'] = 0;
3979 $wgDefaultUserOptions = array(
3980 'ccmeonemails' => 0,
3982 'date' => 'default',
3985 'editfont' => 'default',
3986 'editondblclick' => 0,
3988 'editsectiononrightclick' => 0,
3989 'enotifminoredits' => 0,
3990 'enotifrevealaddr' => 0,
3991 'enotifusertalkpages' => 1,
3992 'enotifwatchlistpages' => 0,
3993 'extendwatchlist' => 0,
3995 'forceeditsummary' => 0,
3996 'gender' => 'unknown',
3998 'hidepatrolled' => 0,
4002 'minordefault' => 0,
4003 'newpageshidepatrolled' => 0,
4005 'noconvertlink' => 0,
4006 'norollbackdiff' => 0,
4007 'numberheadings' => 0,
4008 'previewonfirst' => 0,
4009 'previewontop' => 1,
4012 'rememberpassword' => 0,
4014 'showhiddencats' => 0,
4015 'shownumberswatching' => 1,
4019 'stubthreshold' => 0,
4022 'uselivepreview' => 0,
4024 'vector-simplesearch' => 1,
4025 'watchcreations' => 1,
4026 'watchdefault' => 1,
4027 'watchdeletion' => 0,
4028 'watchlistdays' => 3.0,
4029 'watchlisthideanons' => 0,
4030 'watchlisthidebots' => 0,
4031 'watchlisthideliu' => 0,
4032 'watchlisthideminor' => 0,
4033 'watchlisthideown' => 0,
4034 'watchlisthidepatrolled' => 0,
4037 'useeditwarning' => 1,
4038 'prefershttps' => 1,
4042 * An array of preferences to not show for the user
4044 $wgHiddenPrefs = array();
4047 * Characters to prevent during new account creations.
4048 * This is used in a regular expression character class during
4049 * registration (regex metacharacters like / are escaped).
4051 $wgInvalidUsernameCharacters = '@';
4054 * Character used as a delimiter when testing for interwiki userrights
4055 * (In Special:UserRights, it is possible to modify users on different
4056 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4058 * It is recommended that you have this delimiter in
4059 * $wgInvalidUsernameCharacters above, or you will not be able to
4060 * modify the user rights of those users via Special:UserRights
4062 $wgUserrightsInterwikiDelimiter = '@';
4065 * This is to let user authenticate using https when they come from http.
4066 * Based on an idea by George Herbert on wikitech-l:
4067 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4070 $wgSecureLogin = false;
4072 /** @} */ # end user accounts }
4074 /************************************************************************//**
4075 * @name User rights, access control and monitoring
4080 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4082 $wgAutoblockExpiry = 86400;
4085 * Set this to true to allow blocked users to edit their own user talk page.
4087 $wgBlockAllowsUTEdit = false;
4090 * Allow sysops to ban users from accessing Emailuser
4092 $wgSysopEmailBans = true;
4095 * Limits on the possible sizes of range blocks.
4097 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4098 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4099 * half the number of bits avoids such errors, and allows entire ISPs to be
4100 * blocked using a small number of range blocks.
4102 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4103 * customer, so range blocks larger than /64 (half the number of bits) will
4104 * plainly be required. RFC 4692 implies that a very large ISP may be
4105 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4106 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4108 $wgBlockCIDRLimit = array(
4109 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4114 * If true, blocked users will not be allowed to login. When using this with
4115 * a public wiki, the effect of logging out blocked users may actually be
4116 * avers: unless the user's address is also blocked (e.g. auto-block),
4117 * logging the user out will again allow reading and editing, just as for
4118 * anonymous visitors.
4120 $wgBlockDisablesLogin = false;
4123 * Pages anonymous user may see, set as an array of pages titles.
4127 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4130 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4132 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4133 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4135 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4136 * will remain readable. You can use img_auth.php to protect uploaded files,
4137 * see http://www.mediawiki.org/wiki/Manual:Image_Authorization
4139 $wgWhitelistRead = false;
4142 * Pages anonymous user may see, set as an array of regular expressions.
4144 * This function will match the regexp against the title name, which
4145 * is without underscore.
4148 * To whitelist [[Main Page]]:
4150 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4153 * @note Unless ^ and/or $ is specified, a regular expression might match
4154 * pages not intended to be whitelisted. The above example will also
4155 * whitelist a page named 'Security Main Page'.
4158 * To allow reading any page starting with 'User' regardless of the case:
4160 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4162 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4164 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4165 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4167 $wgWhitelistReadRegexp = false;
4170 * Should editors be required to have a validated e-mail
4171 * address before being allowed to edit?
4173 $wgEmailConfirmToEdit = false;
4176 * Permission keys given to users in each group.
4178 * This is an array where the keys are all groups and each value is an
4179 * array of the format (right => boolean).
4181 * The second format is used to support per-namespace permissions.
4182 * Note that this feature does not fully work for all permission types.
4184 * All users are implicitly in the '*' group including anonymous visitors;
4185 * logged-in users are all implicitly in the 'user' group. These will be
4186 * combined with the permissions of all groups that a given user is listed
4187 * in in the user_groups table.
4189 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4190 * doing! This will wipe all permissions, and may mean that your users are
4191 * unable to perform certain essential tasks or access new functionality
4192 * when new permissions are introduced and default grants established.
4194 * Functionality to make pages inaccessible has not been extensively tested
4195 * for security. Use at your own risk!
4197 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4199 $wgGroupPermissions = array();
4201 /** @cond file_level_code */
4202 // Implicit group for all visitors
4203 $wgGroupPermissions['*']['createaccount'] = true;
4204 $wgGroupPermissions['*']['read'] = true;
4205 $wgGroupPermissions['*']['edit'] = true;
4206 $wgGroupPermissions['*']['createpage'] = true;
4207 $wgGroupPermissions['*']['createtalk'] = true;
4208 $wgGroupPermissions['*']['writeapi'] = true;
4209 $wgGroupPermissions['*']['editmyusercss'] = true;
4210 $wgGroupPermissions['*']['editmyuserjs'] = true;
4211 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4212 $wgGroupPermissions['*']['editmywatchlist'] = true;
4213 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4214 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4215 $wgGroupPermissions['*']['editmyoptions'] = true;
4216 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4218 // Implicit group for all logged-in accounts
4219 $wgGroupPermissions['user']['move'] = true;
4220 $wgGroupPermissions['user']['move-subpages'] = true;
4221 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4222 $wgGroupPermissions['user']['movefile'] = true;
4223 $wgGroupPermissions['user']['read'] = true;
4224 $wgGroupPermissions['user']['edit'] = true;
4225 $wgGroupPermissions['user']['createpage'] = true;
4226 $wgGroupPermissions['user']['createtalk'] = true;
4227 $wgGroupPermissions['user']['writeapi'] = true;
4228 $wgGroupPermissions['user']['upload'] = true;
4229 $wgGroupPermissions['user']['reupload'] = true;
4230 $wgGroupPermissions['user']['reupload-shared'] = true;
4231 $wgGroupPermissions['user']['minoredit'] = true;
4232 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4233 $wgGroupPermissions['user']['sendemail'] = true;
4235 // Implicit group for accounts that pass $wgAutoConfirmAge
4236 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4237 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4239 // Users with bot privilege can have their edits hidden
4240 // from various log pages by default
4241 $wgGroupPermissions['bot']['bot'] = true;
4242 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4243 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4244 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4245 $wgGroupPermissions['bot']['autopatrol'] = true;
4246 $wgGroupPermissions['bot']['suppressredirect'] = true;
4247 $wgGroupPermissions['bot']['apihighlimits'] = true;
4248 $wgGroupPermissions['bot']['writeapi'] = true;
4250 // Most extra permission abilities go to this group
4251 $wgGroupPermissions['sysop']['block'] = true;
4252 $wgGroupPermissions['sysop']['createaccount'] = true;
4253 $wgGroupPermissions['sysop']['delete'] = true;
4254 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4255 $wgGroupPermissions['sysop']['bigdelete'] = true;
4256 // can view deleted history entries, but not see or restore the text
4257 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4258 // can view deleted revision text
4259 $wgGroupPermissions['sysop']['deletedtext'] = true;
4260 $wgGroupPermissions['sysop']['undelete'] = true;
4261 $wgGroupPermissions['sysop']['editinterface'] = true;
4262 $wgGroupPermissions['sysop']['editusercss'] = true;
4263 $wgGroupPermissions['sysop']['edituserjs'] = true;
4264 $wgGroupPermissions['sysop']['import'] = true;
4265 $wgGroupPermissions['sysop']['importupload'] = true;
4266 $wgGroupPermissions['sysop']['move'] = true;
4267 $wgGroupPermissions['sysop']['move-subpages'] = true;
4268 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4269 $wgGroupPermissions['sysop']['patrol'] = true;
4270 $wgGroupPermissions['sysop']['autopatrol'] = true;
4271 $wgGroupPermissions['sysop']['protect'] = true;
4272 $wgGroupPermissions['sysop']['editprotected'] = true;
4273 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4274 $wgGroupPermissions['sysop']['rollback'] = true;
4275 $wgGroupPermissions['sysop']['upload'] = true;
4276 $wgGroupPermissions['sysop']['reupload'] = true;
4277 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4278 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4279 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4280 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4281 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4282 $wgGroupPermissions['sysop']['blockemail'] = true;
4283 $wgGroupPermissions['sysop']['markbotedits'] = true;
4284 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4285 $wgGroupPermissions['sysop']['browsearchive'] = true;
4286 $wgGroupPermissions['sysop']['noratelimit'] = true;
4287 $wgGroupPermissions['sysop']['movefile'] = true;
4288 $wgGroupPermissions['sysop']['unblockself'] = true;
4289 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4290 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4291 #$wgGroupPermissions['sysop']['mergehistory'] = true;
4293 // Permission to change users' group assignments
4294 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4295 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4296 // Permission to change users' groups assignments across wikis
4297 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4298 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4299 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4301 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4302 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4303 // To hide usernames from users and Sysops
4304 #$wgGroupPermissions['suppress']['hideuser'] = true;
4305 // To hide revisions/log items from users and Sysops
4306 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4307 // For private suppression log access
4308 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4311 * The developer group is deprecated, but can be activated if need be
4312 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4313 * that a lock file be defined and creatable/removable by the web
4316 # $wgGroupPermissions['developer']['siteadmin'] = true;
4321 * Permission keys revoked from users in each group.
4323 * This acts the same way as wgGroupPermissions above, except that
4324 * if the user is in a group here, the permission will be removed from them.
4326 * Improperly setting this could mean that your users will be unable to perform
4327 * certain essential tasks, so use at your own risk!
4329 $wgRevokePermissions = array();
4332 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4334 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4337 * A map of group names that the user is in, to group names that those users
4338 * are allowed to add or revoke.
4340 * Setting the list of groups to add or revoke to true is equivalent to "any
4344 * To allow sysops to add themselves to the "bot" group:
4346 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4350 * Implicit groups may be used for the source group, for instance:
4352 * $wgGroupsRemoveFromSelf = array( '*' => true );
4354 * This allows users in the '*' group (i.e. any user) to remove themselves from
4355 * any group that they happen to be in.
4357 $wgGroupsAddToSelf = array();
4360 * @see $wgGroupsAddToSelf
4362 $wgGroupsRemoveFromSelf = array();
4365 * Set of available actions that can be restricted via action=protect
4366 * You probably shouldn't change this.
4367 * Translated through restriction-* messages.
4368 * Title::getRestrictionTypes() will remove restrictions that are not
4369 * applicable to a specific title (create and upload)
4371 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4374 * Rights which can be required for each protection level (via action=protect)
4376 * You can add a new protection level that requires a specific
4377 * permission by manipulating this array. The ordering of elements
4378 * dictates the order on the protection form's lists.
4380 * - '' will be ignored (i.e. unprotected)
4381 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4382 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4384 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4387 * Restriction levels that can be used with cascading protection
4389 * A page can only be protected with cascading protection if the
4390 * requested restriction level is included in this array.
4392 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4393 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4395 $wgCascadingRestrictionLevels = array( 'sysop' );
4398 * Restriction levels that should be considered "semiprotected"
4400 * Certain places in the interface recognize a dichotomy between "protected"
4401 * and "semiprotected", without further distinguishing the specific levels. In
4402 * general, if anyone can be eligible to edit a protection level merely by
4403 * reaching some condition in $wgAutopromote, it should probably be considered
4406 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4407 * 'sysop' is not changed, since it really shouldn't be here.
4409 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4412 * Set the minimum permissions required to edit pages in each
4413 * namespace. If you list more than one permission, a user must
4414 * have all of them to edit pages in that namespace.
4416 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4418 $wgNamespaceProtection = array();
4421 * Pages in namespaces in this array can not be used as templates.
4423 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4424 * namespaces constants (NS_USER, NS_MAIN...).
4426 * Among other things, this may be useful to enforce read-restrictions
4427 * which may otherwise be bypassed by using the template mechanism.
4429 $wgNonincludableNamespaces = array();
4432 * Number of seconds an account is required to age before it's given the
4433 * implicit 'autoconfirm' group membership. This can be used to limit
4434 * privileges of new accounts.
4436 * Accounts created by earlier versions of the software may not have a
4437 * recorded creation date, and will always be considered to pass the age test.
4439 * When left at 0, all registered accounts will pass.
4442 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4444 * $wgAutoConfirmAge = 600; // ten minutes
4446 * Set age to one day:
4448 * $wgAutoConfirmAge = 3600*24; // one day
4451 $wgAutoConfirmAge = 0;
4454 * Number of edits an account requires before it is autoconfirmed.
4455 * Passing both this AND the time requirement is needed. Example:
4459 * $wgAutoConfirmCount = 50;
4462 $wgAutoConfirmCount = 0;
4465 * Automatically add a usergroup to any user who matches certain conditions.
4467 * @todo Redocument $wgAutopromote
4470 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4471 * where cond1, cond2, ... are themselves conditions; *OR*
4472 * APCOND_EMAILCONFIRMED, *OR*
4473 * array( APCOND_EMAILCONFIRMED ), *OR*
4474 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4475 * array( APCOND_AGE, seconds since registration ), *OR*
4476 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4477 * array( APCOND_ISIP, ip ), *OR*
4478 * array( APCOND_IPINRANGE, range ), *OR*
4479 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4480 * array( APCOND_BLOCKED ), *OR*
4481 * array( APCOND_ISBOT ), *OR*
4482 * similar constructs defined by extensions.
4484 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4485 * user who has provided an e-mail address.
4487 $wgAutopromote = array(
4488 'autoconfirmed' => array( '&',
4489 array( APCOND_EDITCOUNT
, &$wgAutoConfirmCount ),
4490 array( APCOND_AGE
, &$wgAutoConfirmAge ),
4495 * Automatically add a usergroup to any user who matches certain conditions.
4497 * Does not add the user to the group again if it has been removed.
4498 * Also, does not remove the group if the user no longer meets the criteria.
4502 * array( event => criteria, ... )
4504 * Where event is either:
4505 * - 'onEdit' (when user edits)
4506 * - 'onView' (when user views the wiki)
4508 * Criteria has the same format as $wgAutopromote
4510 * @see $wgAutopromote
4513 $wgAutopromoteOnce = array(
4514 'onEdit' => array(),
4519 * Put user rights log entries for autopromotion in recent changes?
4522 $wgAutopromoteOnceLogInRC = true;
4525 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4526 * can assign which groups at Special:Userrights.
4529 * Bureaucrats can add any group:
4531 * $wgAddGroups['bureaucrat'] = true;
4533 * Bureaucrats can only remove bots and sysops:
4535 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4537 * Sysops can make bots:
4539 * $wgAddGroups['sysop'] = array( 'bot' );
4541 * Sysops can disable other sysops in an emergency, and disable bots:
4543 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4546 $wgAddGroups = array();
4551 $wgRemoveGroups = array();
4554 * A list of available rights, in addition to the ones defined by the core.
4555 * For extensions only.
4557 $wgAvailableRights = array();
4560 * Optional to restrict deletion of pages with higher revision counts
4561 * to users with the 'bigdelete' permission. (Default given to sysops.)
4563 $wgDeleteRevisionsLimit = 0;
4566 * The maximum number of edits a user can have and
4567 * can still be hidden by users with the hideuser permission.
4568 * This is limited for performance reason.
4569 * Set to false to disable the limit.
4572 $wgHideUserContribLimit = 1000;
4575 * Number of accounts each IP address may create, 0 to disable.
4577 * @warning Requires memcached
4579 $wgAccountCreationThrottle = 0;
4582 * Edits matching these regular expressions in body text
4583 * will be recognised as spam and rejected automatically.
4585 * There's no administrator override on-wiki, so be careful what you set. :)
4586 * May be an array of regexes or a single string for backwards compatibility.
4588 * @see http://en.wikipedia.org/wiki/Regular_expression
4590 * @note Each regex needs a beginning/end delimiter, eg: # or /
4592 $wgSpamRegex = array();
4595 * Same as the above except for edit summaries
4597 $wgSummarySpamRegex = array();
4600 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4604 $wgEnableDnsBlacklist = false;
4607 * @deprecated since 1.17 Use $wgEnableDnsBlacklist instead, only kept for
4608 * backward compatibility.
4610 $wgEnableSorbs = false;
4613 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4615 * This is an array of either a URL or an array with the URL and a key (should
4616 * the blacklist require a key).
4620 * $wgDnsBlacklistUrls = array(
4621 * // String containing URL
4622 * 'http.dnsbl.sorbs.net.',
4623 * // Array with URL and key, for services that require a key
4624 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4625 * // Array with just the URL. While this works, it is recommended that you
4626 * // just use a string as shown above
4627 * array( 'opm.tornevall.org.' )
4631 * @note You should end the domain name with a . to avoid searching your
4632 * eventual domain search suffixes.
4635 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4638 * @deprecated since 1.17 Use $wgDnsBlacklistUrls instead, only kept for
4639 * backward compatibility.
4641 $wgSorbsUrl = array();
4644 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4645 * what the other methods might say.
4647 $wgProxyWhitelist = array();
4650 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4651 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4652 * (transparent) proxies without needing to block the proxies themselves.
4654 $wgApplyIpBlocksToXff = false;
4657 * Simple rate limiter options to brake edit floods.
4659 * Maximum number actions allowed in the given number of seconds; after that
4660 * the violating client receives HTTP 500 error pages until the period
4664 * To set a generic maximum of 4 hits in 60 seconds:
4666 * $wgRateLimits = array( 4, 60 );
4669 * You could also limit per action and then type of users. See the inline
4670 * code for a template to use.
4672 * This option set is experimental and likely to change.
4674 * @warning Requires memcached.
4676 $wgRateLimits = array(
4678 'anon' => null, // for any and all anonymous edits (aggregate)
4679 'user' => null, // for each logged-in user
4680 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4681 'ip' => null, // for each anon and recent account
4682 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4690 'mailpassword' => array( // triggering password resets emails
4693 'emailuser' => array( // emailing other users using MediaWiki
4696 'linkpurge' => array( // purges of link tables
4703 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4713 * Set to a filename to log rate limiter hits.
4715 $wgRateLimitLog = null;
4718 * Array of IPs which should be excluded from rate limits.
4719 * This may be useful for whitelisting NAT gateways for conferences, etc.
4721 $wgRateLimitsExcludedIPs = array();
4724 * Log IP addresses in the recentchanges table; can be accessed only by
4725 * extensions (e.g. CheckUser) or a DB admin
4726 * Used for retroactive autoblocks
4728 $wgPutIPinRC = true;
4731 * Integer defining default number of entries to show on
4732 * special pages which are query-pages such as Special:Whatlinkshere.
4734 $wgQueryPageDefaultLimit = 50;
4737 * Limit password attempts to X attempts per Y seconds per IP per account.
4739 * @warning Requires memcached.
4741 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4743 /** @} */ # end of user rights settings
4745 /************************************************************************//**
4746 * @name Proxy scanner settings
4751 * This should always be customised in LocalSettings.php
4753 $wgSecretKey = false;
4756 * Big list of banned IP addresses.
4758 * This can have the following formats:
4759 * - An array of addresses, either in the values
4760 * or the keys (for backward compatibility)
4761 * - A string, in that case this is the path to a file
4762 * containing the list of IP addresses, one per line
4764 $wgProxyList = array();
4767 * @deprecated since 1.14
4769 $wgProxyKey = false;
4771 /** @} */ # end of proxy scanner settings
4773 /************************************************************************//**
4774 * @name Cookie settings
4779 * Default cookie expiration time. Setting to 0 makes all cookies session-only.
4781 $wgCookieExpiration = 180 * 86400;
4784 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
4785 * or ".any.subdomain.net"
4787 $wgCookieDomain = '';
4790 * Set this variable if you want to restrict cookies to a certain path within
4791 * the domain specified by $wgCookieDomain.
4793 $wgCookiePath = '/';
4796 * Whether the "secure" flag should be set on the cookie. This can be:
4797 * - true: Set secure flag
4798 * - false: Don't set secure flag
4799 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
4801 $wgCookieSecure = 'detect';
4804 * By default, MediaWiki checks if the client supports cookies during the
4805 * login process, so that it can display an informative error message if
4806 * cookies are disabled. Set this to true if you want to disable this cookie
4809 $wgDisableCookieCheck = false;
4812 * Cookies generated by MediaWiki have names starting with this prefix. Set it
4813 * to a string to use a custom prefix. Setting it to false causes the database
4814 * name to be used as a prefix.
4816 $wgCookiePrefix = false;
4819 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
4820 * in browsers that support this feature. This can mitigates some classes of
4823 $wgCookieHttpOnly = true;
4826 * If the requesting browser matches a regex in this blacklist, we won't
4827 * send it cookies with HttpOnly mode, even if $wgCookieHttpOnly is on.
4829 $wgHttpOnlyBlacklist = array(
4830 // Internet Explorer for Mac; sometimes the cookies work, sometimes
4831 // they don't. It's difficult to predict, as combinations of path
4832 // and expiration options affect its parsing.
4833 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
4837 * A list of cookies that vary the cache (for use by extensions)
4839 $wgCacheVaryCookies = array();
4842 * Override to customise the session name
4844 $wgSessionName = false;
4846 /** @} */ # end of cookie settings }
4848 /************************************************************************//**
4849 * @name LaTeX (mathematical formulas)
4854 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
4855 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
4856 * (ImageMagick) installed and available in the PATH.
4857 * Please see math/README for more information.
4861 /** @} */ # end LaTeX }
4863 /************************************************************************//**
4864 * @name Profiling, testing and debugging
4866 * To enable profiling, edit StartProfiler.php
4872 * Filename for debug logging. See http://www.mediawiki.org/wiki/How_to_debug
4873 * The debug log file should be not be publicly accessible if it is used, as it
4874 * may contain private data.
4876 $wgDebugLogFile = '';
4879 * Prefix for debug log lines
4881 $wgDebugLogPrefix = '';
4884 * If true, instead of redirecting, show a page with a link to the redirect
4885 * destination. This allows for the inspection of PHP error messages, and easy
4886 * resubmission of form data. For developer use only.
4888 $wgDebugRedirects = false;
4891 * If true, log debugging data from action=raw and load.php.
4892 * This is normally false to avoid overlapping debug entries due to gen=css
4893 * and gen=js requests.
4895 $wgDebugRawPage = false;
4898 * Send debug data to an HTML comment in the output.
4900 * This may occasionally be useful when supporting a non-technical end-user.
4901 * It's more secure than exposing the debug log file to the web, since the
4902 * output only contains private data for the current user. But it's not ideal
4903 * for development use since data is lost on fatal errors and redirects.
4905 $wgDebugComments = false;
4908 * Extensive database transaction state debugging
4912 $wgDebugDBTransactions = false;
4915 * Write SQL queries to the debug log
4917 $wgDebugDumpSql = false;
4920 * Map of string log group names to log destinations.
4922 * If set, wfDebugLog() output for that group will go to that file instead
4923 * of the regular $wgDebugLogFile. Useful for enabling selective logging
4926 * Log destinations may be string values specifying a filename or URI, or they
4927 * may be filename or an associative array mapping 'destination' to the desired
4928 * filename. The associative array may also contain a 'sample' key with an
4929 * integer value, specifying a sampling factor.
4933 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
4936 * @par Advanced example:
4938 * $wgDebugLogGroups['memcached'] = (
4939 * 'destination' => '/var/log/mediawiki/memcached.log',
4940 * 'sample' => 1000, // log 1 message out of every 1,000.
4944 $wgDebugLogGroups = array();
4947 * Display debug data at the bottom of the main content area.
4949 * Useful for developers and technical users trying to working on a closed wiki.
4951 $wgShowDebug = false;
4954 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
4955 * Since 1.19 also includes memory usage.
4957 $wgDebugTimestamps = false;
4960 * Print HTTP headers for every request in the debug information.
4962 $wgDebugPrintHttpHeaders = true;
4965 * Show the contents of $wgHooks in Special:Version
4967 $wgSpecialVersionShowHooks = false;
4970 * Whether to show "we're sorry, but there has been a database error" pages.
4971 * Displaying errors aids in debugging, but may display information useful
4974 $wgShowSQLErrors = false;
4977 * If set to true, uncaught exceptions will print a complete stack trace
4978 * to output. This should only be used for debugging, as it may reveal
4979 * private information in function parameters due to PHP's backtrace
4982 $wgShowExceptionDetails = false;
4985 * If true, show a backtrace for database errors
4987 $wgShowDBErrorBacktrace = false;
4990 * If true, send the exception backtrace to the error log
4992 $wgLogExceptionBacktrace = true;
4995 * Expose backend server host names through the API and various HTML comments
4997 $wgShowHostnames = false;
5000 * Override server hostname detection with a hardcoded value.
5001 * Should be a string, default false.
5004 $wgOverrideHostname = false;
5007 * If set to true MediaWiki will throw notices for some possible error
5008 * conditions and for deprecated functions.
5010 $wgDevelopmentWarnings = false;
5013 * Release limitation to wfDeprecated warnings, if set to a release number
5014 * development warnings will not be generated for deprecations added in releases
5017 $wgDeprecationReleaseLimit = false;
5020 * Only record profiling info for pages that took longer than this
5022 $wgProfileLimit = 0.0;
5025 * Don't put non-profiling info into log file
5027 $wgProfileOnly = false;
5030 * Log sums from profiling into "profiling" table in db.
5032 * You have to create a 'profiling' table in your database before using
5033 * this feature. Run set $wgProfileToDatabase to true in
5034 * LocalSettings.php and run maintenance/update.php or otherwise
5035 * manually add patch-profiling.sql to your database.
5037 * To enable profiling, edit StartProfiler.php
5039 $wgProfileToDatabase = false;
5042 * If true, print a raw call tree instead of per-function report
5044 $wgProfileCallTree = false;
5047 * Should application server host be put into profiling table
5049 $wgProfilePerHost = false;
5052 * Host for UDP profiler.
5054 * The host should be running a daemon which can be obtained from MediaWiki
5056 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5058 $wgUDPProfilerHost = '127.0.0.1';
5061 * Port for UDP profiler.
5062 * @see $wgUDPProfilerHost
5064 $wgUDPProfilerPort = '3811';
5067 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5068 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name) as arguments.
5069 * You can use sprintf's argument numbering/swapping capability to repeat,
5070 * re-order or omit fields.
5072 * @see $wgStatsFormatString
5075 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5078 * Detects non-matching wfProfileIn/wfProfileOut calls
5080 $wgDebugProfiling = false;
5083 * Output debug message on every wfProfileIn/wfProfileOut
5085 $wgDebugFunctionEntry = false;
5088 * Destination for wfIncrStats() data...
5089 * 'cache' to go into the system cache, if enabled (memcached)
5090 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5093 $wgStatsMethod = 'cache';
5096 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5097 * be aggregated over more than one wiki. The string will be used in place of
5098 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5101 $wgAggregateStatsID = false;
5104 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5105 * formatted. Its value should be a format string suitable for a sprintf()
5106 * invocation with (id, count, key) arguments, where 'id' is either
5107 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5108 * is being incremented, and 'key' is the metric name.
5110 * @see $wgUDPProfilerFormatString
5111 * @see $wgAggregateStatsID
5114 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5117 * Whereas to count the number of time an article is viewed.
5118 * Does not work if pages are cached (for example with squid).
5120 $wgDisableCounters = false;
5123 * InfoAction retrieves a list of transclusion links (both to and from).
5124 * This number puts a limit on that query in the case of highly transcluded
5127 $wgPageInfoTransclusionLimit = 50;
5130 * Set this to an integer to only do synchronous site_stats updates
5131 * one every *this many* updates. The other requests go into pending
5132 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5133 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5135 $wgSiteStatsAsyncFactor = false;
5138 * Parser test suite files to be run by parserTests.php when no specific
5139 * filename is passed to it.
5141 * Extensions may add their own tests to this array, or site-local tests
5142 * may be added via LocalSettings.php
5146 $wgParserTestFiles = array(
5147 "$IP/tests/parser/parserTests.txt",
5148 "$IP/tests/parser/extraParserTests.txt"
5152 * If configured, specifies target CodeReview installation to send test
5153 * result data from 'parserTests.php --upload'
5155 * Something like this:
5156 * $wgParserTestRemote = array(
5157 * 'api-url' => 'http://www.mediawiki.org/w/api.php',
5158 * 'repo' => 'MediaWiki',
5159 * 'suite' => 'ParserTests',
5160 * 'path' => '/trunk/phase3', // not used client-side; for reference
5161 * 'secret' => 'qmoicj3mc4mcklmqw', // Shared secret used in HMAC validation
5164 $wgParserTestRemote = false;
5167 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5169 $wgEnableJavaScriptTest = false;
5172 * Configuration for javascript testing.
5174 $wgJavaScriptTestConfig = array(
5176 // Page where documentation can be found relevant to the QUnit test suite being ran.
5177 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5178 // documentation link in the "javascripttest-qunit-intro" message.
5179 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5180 // If you are submitting the QUnit test suite to a TestSwarm instance,
5181 // point this to the "inject.js" script of that instance. This is was registers
5182 // the QUnit hooks to extract the test results and push them back up into the
5183 // TestSwarm database.
5184 // @example 'http://localhost/testswarm/js/inject.js'
5185 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5186 'testswarm-injectjs' => false,
5191 * Overwrite the caching key prefix with custom value.
5194 $wgCachePrefix = false;
5197 * Display the new debugging toolbar. This also enables profiling on database
5198 * queries and other useful output.
5199 * Will disable file cache.
5203 $wgDebugToolbar = false;
5205 /** @} */ # end of profiling, testing and debugging }
5207 /************************************************************************//**
5213 * Set this to true to disable the full text search feature.
5215 $wgDisableTextSearch = false;
5218 * Set to true to have nicer highlighted text in search results,
5219 * by default off due to execution overhead
5221 $wgAdvancedSearchHighlighting = false;
5224 * Regexp to match word boundaries, defaults for non-CJK languages
5225 * should be empty for CJK since the words are not separate
5227 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5230 * Set to true to have the search engine count total
5231 * search matches to present in the Special:Search UI.
5232 * Not supported by every search engine shipped with MW.
5234 * This could however be slow on larger wikis, and is pretty flaky
5235 * with the current title vs content split. Recommend avoiding until
5236 * that's been worked out cleanly; but this may aid in testing the
5237 * search UI and API to confirm that the result count works.
5239 $wgCountTotalSearchHits = false;
5242 * Template for OpenSearch suggestions, defaults to API action=opensearch
5244 * Sites with heavy load would typically have these point to a custom
5245 * PHP wrapper to avoid firing up mediawiki for every keystroke
5247 * Placeholders: {searchTerms}
5249 $wgOpenSearchTemplate = false;
5252 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5253 * false if you've disabled scripts that use api?action=opensearch and
5254 * want reduce load caused by cached scripts still pulling suggestions.
5255 * It will let the API fallback by responding with an empty array.
5257 $wgEnableOpenSearchSuggest = true;
5260 * Integer defining default number of entries to show on
5263 $wgOpenSearchDefaultLimit = 10;
5266 * Expiry time for search suggestion responses
5268 $wgSearchSuggestCacheExpiry = 1200;
5271 * If you've disabled search semi-permanently, this also disables updates to the
5272 * table. If you ever re-enable, be sure to rebuild the search table.
5274 $wgDisableSearchUpdate = false;
5277 * List of namespaces which are searched by default.
5281 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5282 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5285 $wgNamespacesToBeSearchedDefault = array(
5290 * Namespaces to be searched when user clicks the "Help" tab
5291 * on Special:Search.
5293 * Same format as $wgNamespacesToBeSearchedDefault.
5295 $wgNamespacesToBeSearchedHelp = array(
5301 * If set to true the 'searcheverything' preference will be effective only for
5303 * Useful for big wikis to maintain different search profiles for anonymous and
5306 $wgSearchEverythingOnlyLoggedIn = false;
5309 * Disable the internal MySQL-based search, to allow it to be
5310 * implemented by an extension instead.
5312 $wgDisableInternalSearch = false;
5315 * Set this to a URL to forward search requests to some external location.
5316 * If the URL includes '$1', this will be replaced with the URL-encoded
5320 * To forward to Google you'd have something like:
5322 * $wgSearchForwardUrl =
5323 * 'http://www.google.com/search?q=$1' .
5324 * '&domains=http://example.com' .
5325 * '&sitesearch=http://example.com' .
5326 * '&ie=utf-8&oe=utf-8';
5329 $wgSearchForwardUrl = null;
5332 * Search form behavior.
5333 * - true = use Go & Search buttons
5334 * - false = use Go button & Advanced search link
5336 $wgUseTwoButtonsSearchForm = true;
5339 * Array of namespaces to generate a Google sitemap for when the
5340 * maintenance/generateSitemap.php script is run, or false if one is to be
5341 * generated for all namespaces.
5343 $wgSitemapNamespaces = false;
5346 * Custom namespace priorities for sitemaps. Setting this will allow you to
5347 * set custom priorities to namespaces when sitemaps are generated using the
5348 * maintenance/generateSitemap.php script.
5350 * This should be a map of namespace IDs to priority
5353 * $wgSitemapNamespacesPriorities = array(
5359 $wgSitemapNamespacesPriorities = false;
5362 * If true, searches for IP addresses will be redirected to that IP's
5363 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5364 * [[Special:Contributions/1.2.3.4]]
5366 $wgEnableSearchContributorsByIP = true;
5368 /** @} */ # end of search settings
5370 /************************************************************************//**
5371 * @name Edit user interface
5376 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5377 * fall back to the old behavior (no merging).
5379 $wgDiff3 = '/usr/bin/diff3';
5382 * Path to the GNU diff utility.
5384 $wgDiff = '/usr/bin/diff';
5387 * Which namespaces have special treatment where they should be preview-on-open
5388 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5389 * can specify namespaces of pages they have special treatment for
5391 $wgPreviewOnOpenNamespaces = array(
5396 * Go button goes straight to the edit screen if the article doesn't exist.
5398 $wgGoToEdit = false;
5401 * Enable the UniversalEditButton for browsers that support it
5402 * (currently only Firefox with an extension)
5403 * See http://universaleditbutton.org for more background information
5405 $wgUniversalEditButton = true;
5408 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5409 * will try to automatically create one. This feature can be disabled by set-
5410 * ting this variable false.
5412 $wgUseAutomaticEditSummaries = true;
5414 /** @} */ # end edit UI }
5416 /************************************************************************//**
5418 * See also $wgSiteNotice
5423 * @cond file_level_code
5424 * Set $wgCommandLineMode if it's not set already, to avoid notices
5426 if ( !isset( $wgCommandLineMode ) ) {
5427 $wgCommandLineMode = false;
5432 * For colorized maintenance script output, is your terminal background dark ?
5434 $wgCommandLineDarkBg = false;
5437 * Array for extensions to register their maintenance scripts with the
5438 * system. The key is the name of the class and the value is the full
5441 $wgMaintenanceScripts = array();
5444 * Set this to a string to put the wiki into read-only mode. The text will be
5445 * used as an explanation to users.
5447 * This prevents most write operations via the web interface. Cache updates may
5448 * still be possible. To prevent database writes completely, use the read_only
5454 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5455 * Its contents will be shown to users as part of the read-only warning
5458 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5460 $wgReadOnlyFile = false;
5463 * When you run the web-based upgrade utility, it will tell you what to set
5464 * this to in order to authorize the upgrade process. It will subsequently be
5465 * used as a password, to authorize further upgrades.
5467 * For security, do not set this to a guessable string. Use the value supplied
5468 * by the install/upgrade process. To cause the upgrader to generate a new key,
5469 * delete the old key from LocalSettings.php.
5471 $wgUpgradeKey = false;
5474 * Fully specified path to git binary
5476 $wgGitBin = '/usr/bin/git';
5479 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5481 * Key is a pattern passed to preg_match() and preg_replace(),
5482 * without the delimiters (which are #) and must match the whole URL.
5483 * The value is the replacement for the key (it can contain $1, etc.)
5484 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5485 * full SHA-1 of the HEAD revision.
5486 * %r will be replaced with a URL-encoded version of $1.
5490 $wgGitRepositoryViewers = array(
5491 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' => 'https://git.wikimedia.org/commit/%r/%H',
5492 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)'
5493 => 'https://git.wikimedia.org/commit/%r/%H',
5496 /** @} */ # End of maintenance }
5498 /************************************************************************//**
5499 * @name Recent changes, new pages, watchlist and history
5504 * Recentchanges items are periodically purged; entries older than this many
5506 * Default: 13 weeks = about three months
5508 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5511 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5512 * higher than what will be stored. Note that this is disabled by default
5513 * because we sometimes do have RC data which is beyond the limit for some
5514 * reason, and some users may use the high numbers to display that data which
5517 $wgRCFilterByAge = false;
5520 * List of Limits options to list in the Special:Recentchanges and
5521 * Special:Recentchangeslinked pages.
5523 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5526 * List of Days options to list in the Special:Recentchanges and
5527 * Special:Recentchangeslinked pages.
5529 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5532 * Send recent changes updates via UDP. The updates will be formatted for IRC.
5533 * Set this to the IP address of the receiver.
5535 * @deprecated since 1.22, use $wgRCFeeds
5537 $wgRC2UDPAddress = false;
5540 * Port number for RC updates
5542 * @deprecated since 1.22, use $wgRCFeeds
5544 $wgRC2UDPPort = false;
5547 * Prefix to prepend to each UDP packet.
5548 * This can be used to identify the wiki. A script is available called
5549 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
5550 * tab to identify the IRC channel to send the log line to.
5552 * @deprecated since 1.22, use $wgRCFeeds
5554 $wgRC2UDPPrefix = '';
5557 * If this is set to true, $wgLocalInterwiki will be prepended to links in the
5558 * IRC feed. If this is set to a string, that string will be used as the prefix.
5560 * @deprecated since 1.22, use $wgRCFeeds
5562 $wgRC2UDPInterwikiPrefix = false;
5565 * Set to true to omit "bot" edits (by users with the bot permission) from the
5568 * @deprecated since 1.22, use $wgRCFeeds
5570 $wgRC2UDPOmitBots = false;
5573 * Destinations to which notifications about recent changes
5576 * As of MediaWiki 1.22, the only supported 'engine' parameter option in core
5577 * is 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5579 * The common options are:
5580 * * 'uri' -- the address to which the notices are to be sent.
5581 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5582 * produce the text to send.
5583 * * 'omit_bots' -- whether the bot edits should be in the feed
5584 * The IRC-specific options are:
5585 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5586 * $wgLocalInterwiki.
5587 * The JSON-specific options are:
5588 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5590 * To ensure backwards-compatability, whenever $wgRC2UDPAddress is set, a
5591 * 'default' feed will be created reusing the deprecated $wgRC2UDP* variables.
5593 * @example $wgRCFeeds['example'] = array(
5594 * 'formatter' => 'JSONRCFeedFormatter',
5595 * 'uri' => "udp://localhost:1336",
5596 * 'add_interwiki_prefix' => false,
5597 * 'omit_bots' => true,
5599 * @example $wgRCFeeds['exampleirc'] = array(
5600 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5601 * 'uri' => "udp://localhost:1338",
5602 * 'add_interwiki_prefix' => false,
5603 * 'omit_bots' => true,
5607 $wgRCFeeds = array();
5610 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5611 * Keys are scheme names, values are names of engine classes.
5613 $wgRCEngines = array(
5614 'redis' => 'RedisPubSubFeedEngine',
5615 'udp' => 'UDPRCFeedEngine',
5619 * Enable user search in Special:Newpages
5620 * This is really a temporary hack around an index install bug on some Wikipedias.
5621 * Kill it once fixed.
5623 $wgEnableNewpagesUserFilter = true;
5626 * Use RC Patrolling to check for vandalism
5628 $wgUseRCPatrol = true;
5631 * Use new page patrolling to check new pages on Special:Newpages
5633 $wgUseNPPatrol = true;
5636 * Log autopatrol actions to the log table
5638 $wgLogAutopatrol = true;
5641 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5646 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5647 * eg Recentchanges, Newpages.
5652 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5653 * A cached version will continue to be served out even if changes
5654 * are made, until this many seconds runs out since the last render.
5656 * If set to 0, feed caching is disabled. Use this for debugging only;
5657 * feed generation can be pretty slow with diffs.
5659 $wgFeedCacheTimeout = 60;
5662 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5663 * pages larger than this size.
5665 $wgFeedDiffCutoff = 32768;
5668 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5669 * every page. Some sites might have a different feed they'd like to promote
5670 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5671 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5674 * Configure the 'atom' feed to http://example.com/somefeed.xml
5676 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5679 $wgOverrideSiteFeed = array();
5682 * Available feeds objects.
5683 * Should probably only be defined when a page is syndicated ie when
5684 * $wgOut->isSyndicated() is true.
5686 $wgFeedClasses = array(
5688 'atom' => 'AtomFeed',
5692 * Which feed types should we provide by default? This can include 'rss',
5693 * 'atom', neither, or both.
5695 $wgAdvertisedFeedTypes = array( 'atom' );
5698 * Show watching users in recent changes, watchlist and page history views
5700 $wgRCShowWatchingUsers = false; # UPO
5703 * Show watching users in Page views
5705 $wgPageShowWatchingUsers = false;
5708 * Show the amount of changed characters in recent changes
5710 $wgRCShowChangedSize = true;
5713 * If the difference between the character counts of the text
5714 * before and after the edit is below that value, the value will be
5715 * highlighted on the RC page.
5717 $wgRCChangedSizeThreshold = 500;
5720 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5721 * view for watched pages with new changes
5723 $wgShowUpdatedMarker = true;
5726 * Disable links to talk pages of anonymous users (IPs) in listings on special
5727 * pages like page history, Special:Recentchanges, etc.
5729 $wgDisableAnonTalk = false;
5732 * Enable filtering of categories in Recentchanges
5734 $wgAllowCategorizedRecentChanges = false;
5737 * Allow filtering by change tag in recentchanges, history, etc
5738 * Has no effect if no tags are defined in valid_tag.
5740 $wgUseTagFilter = true;
5743 * If set to an integer, pages that are watched by this many users or more
5744 * will not require the unwatchedpages permission to view the number of
5749 $wgUnwatchedPageThreshold = false;
5752 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5753 * certain types of edits.
5755 * To register a new one:
5757 * $wgRecentChangesFlags['flag'] => array(
5758 * 'letter' => 'letter-msg',
5759 * 'title' => 'tooltip-msg'
5763 * Optional 'class' allows to set a css class different than the flag name.
5767 $wgRecentChangesFlags = array(
5768 'newpage' => array( 'letter' => 'newpageletter',
5769 'title' => 'recentchanges-label-newpage' ),
5770 'minor' => array( 'letter' => 'minoreditletter',
5771 'title' => 'recentchanges-label-minor', 'class' => 'minoredit' ),
5772 'bot' => array( 'letter' => 'boteditletter',
5773 'title' => 'recentchanges-label-bot', 'class' => 'botedit' ),
5774 'unpatrolled' => array( 'letter' => 'unpatrolledletter',
5775 'title' => 'recentchanges-label-unpatrolled' ),
5778 /** @} */ # end RC/watchlist }
5780 /************************************************************************//**
5781 * @name Copyright and credits settings
5786 * Override for copyright metadata.
5788 * This is the name of the page containing information about the wiki's copyright status,
5789 * which will be added as a link in the footer if it is specified. It overrides
5790 * $wgRightsUrl if both are specified.
5792 $wgRightsPage = null;
5795 * Set this to specify an external URL containing details about the content license used on your
5797 * If $wgRightsPage is set then this setting is ignored.
5799 $wgRightsUrl = null;
5802 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5804 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5805 * of the page will also be used as the link if this variable is not set.
5807 $wgRightsText = null;
5810 * Override for copyright metadata.
5812 $wgRightsIcon = null;
5815 * Set to an array of metadata terms. Else they will be loaded based on $wgRightsUrl
5817 $wgLicenseTerms = false;
5820 * Set this to some HTML to override the rights icon with an arbitrary logo
5821 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5823 $wgCopyrightIcon = null;
5826 * Set this to true if you want detailed copyright information forms on Upload.
5828 $wgUseCopyrightUpload = false;
5831 * Set this to the number of authors that you want to be credited below an
5832 * article text. Set it to zero to hide the attribution block, and a negative
5833 * number (like -1) to show all authors. Note that this will require 2-3 extra
5834 * database hits, which can have a not insignificant impact on performance for
5840 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5841 * Otherwise, link to a separate credits page.
5843 $wgShowCreditsIfMax = true;
5845 /** @} */ # end of copyright and credits settings }
5847 /************************************************************************//**
5848 * @name Import / Export
5853 * List of interwiki prefixes for wikis we'll accept as sources for
5854 * Special:Import (for sysops). Since complete page history can be imported,
5855 * these should be 'trusted'.
5857 * If a user has the 'import' permission but not the 'importupload' permission,
5858 * they will only be able to run imports through this transwiki interface.
5860 $wgImportSources = array();
5863 * Optional default target namespace for interwiki imports.
5864 * Can use this to create an incoming "transwiki"-style queue.
5865 * Set to numeric key, not the name.
5867 * Users may override this in the Special:Import dialog.
5869 $wgImportTargetNamespace = null;
5872 * If set to false, disables the full-history option on Special:Export.
5873 * This is currently poorly optimized for long edit histories, so is
5874 * disabled on Wikimedia's sites.
5876 $wgExportAllowHistory = true;
5879 * If set nonzero, Special:Export requests for history of pages with
5880 * more revisions than this will be rejected. On some big sites things
5881 * could get bogged down by very very long pages.
5883 $wgExportMaxHistory = 0;
5886 * Return distinct author list (when not returning full history)
5888 $wgExportAllowListContributors = false;
5891 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
5892 * up to this specified level, which will cause it to include all
5893 * pages linked to from the pages you specify. Since this number
5894 * can become *insanely large* and could easily break your wiki,
5895 * it's disabled by default for now.
5897 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
5898 * crazy-big export from being done by someone setting the depth number too
5899 * high. In other words, last resort safety net.
5901 $wgExportMaxLinkDepth = 0;
5904 * Whether to allow the "export all pages in namespace" option
5906 $wgExportFromNamespaces = false;
5909 * Whether to allow exporting the entire wiki into a single file
5911 $wgExportAllowAll = false;
5913 /** @} */ # end of import/export }
5915 /*************************************************************************//**
5921 * A list of callback functions which are called once MediaWiki is fully
5924 $wgExtensionFunctions = array();
5927 * Extension messages files.
5929 * Associative array mapping extension name to the filename where messages can be
5930 * found. The file should contain variable assignments. Any of the variables
5931 * present in languages/messages/MessagesEn.php may be defined, but $messages
5932 * is the most common.
5934 * Variables defined in extensions will override conflicting variables defined
5937 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
5938 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
5939 * $messages, $wgExtensionMessagesFiles should still be used.
5941 * If there is an entry in $wgMessagesDirs with the same key as one in
5942 * $wgExtensionMessagesFiles, then any $messages variables set in the $wgExtensionMessagesFiles file
5943 * will be ignored. This means an extension that only provides messages can be backwards compatible
5944 * by using both $wgExtensionMessagesFiles and $wgMessagesDirs, and only one of the two
5945 * will be used depending on what the version of MediaWiki supports.
5949 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
5952 $wgExtensionMessagesFiles = array();
5955 * Extension messages directories.
5957 * Associative array mapping extension name to the path of the directory where message files can
5958 * be found. The message files are expected to be JSON files named for their language code, e.g.
5959 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
5960 * message directories.
5962 * @par Simple example:
5964 * $wgMessagesDirs['ConfirmEdit'] = __DIR__ . '/i18n';
5967 * @par Complex example:
5969 * $wgMessagesDirs['VisualEditor'] = array(
5970 * __DIR__ . '/i18n',
5971 * __DIR__ . '/modules/ve-core/i18n',
5972 * __DIR__ . '/modules/qunit/localisation',
5973 * __DIR__ . '/modules/oojs-ui/messages',
5978 $wgMessagesDirs = array();
5981 * Array of files with list(s) of extension entry points to be used in
5982 * maintenance/mergeMessageFileList.php
5985 $wgExtensionEntryPointListFiles = array();
5988 * Parser output hooks.
5989 * This is an associative array where the key is an extension-defined tag
5990 * (typically the extension name), and the value is a PHP callback.
5991 * These will be called as an OutputPageParserOutput hook, if the relevant
5992 * tag has been registered with the parser output object.
5994 * Registration is done with $pout->addOutputHook( $tag, $data ).
5996 * The callback has the form:
5998 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6001 $wgParserOutputHooks = array();
6004 * Whether to include the NewPP limit report as a HTML comment
6006 $wgEnableParserLimitReporting = true;
6009 * List of valid skin names.
6010 * The key should be the name in all lower case, the value should be a properly
6011 * cased name for the skin. This value will be prefixed with "Skin" to create the
6012 * class name of the skin to load, and if the skin's class cannot be found through
6013 * the autoloader it will be used to load a .php file by that name in the skins directory.
6014 * The default skins will be added later, by Skin::getSkinNames(). Use
6015 * Skin::getSkinNames() as an accessor if you wish to have access to the full list.
6017 $wgValidSkinNames = array();
6020 * Special page list.
6021 * See the top of SpecialPage.php for documentation.
6023 $wgSpecialPages = array();
6026 * Array mapping class names to filenames, for autoloading.
6028 $wgAutoloadClasses = array();
6031 * Switch controlling legacy case-insensitive classloading.
6032 * Do not disable if your wiki must support data created by PHP4, or by
6033 * MediaWiki 1.4 or earlier.
6035 $wgAutoloadAttemptLowercase = true;
6038 * An array of extension types and inside that their names, versions, authors,
6039 * urls, descriptions and pointers to localized description msgs. Note that
6040 * the version, url, description and descriptionmsg key can be omitted.
6043 * $wgExtensionCredits[$type][] = array(
6044 * 'name' => 'Example extension',
6046 * 'path' => __FILE__,
6047 * 'author' => 'Foo Barstein',
6048 * 'url' => 'http://www.example.com/Example%20Extension/',
6049 * 'description' => 'An example extension',
6050 * 'descriptionmsg' => 'exampleextension-desc',
6054 * Where $type is 'specialpage', 'parserhook', 'variable', 'media' or 'other'.
6055 * Where 'descriptionmsg' can be an array with message key and parameters:
6056 * 'descriptionmsg' => array( 'exampleextension-desc', param1, param2, ... ),
6058 * author can be a string or an array of strings. Authors can be linked using
6059 * the regular wikitext link syntax. To have an internationalized version of
6060 * "and others" show, add an element "...". This element can also be linked,
6061 * for instance "[http://example ...]".
6063 $wgExtensionCredits = array();
6066 * Authentication plugin.
6067 * @var $wgAuth AuthPlugin
6072 * Global list of hooks.
6074 * The key is one of the events made available by MediaWiki, you can find
6075 * a description for most of them in docs/hooks.txt. The array is used
6076 * internally by Hook:run().
6078 * The value can be one of:
6080 * - A function name:
6082 * $wgHooks['event_name'][] = $function;
6084 * - A function with some data:
6086 * $wgHooks['event_name'][] = array( $function, $data );
6088 * - A an object method:
6090 * $wgHooks['event_name'][] = array( $object, 'method' );
6094 * $wgHooks['event_name'][] = function ( $hookParam ) {
6095 * // Handler code goes here.
6099 * @warning You should always append to an event array or you will end up
6100 * deleting a previous registered hook.
6102 * @warning Hook handlers should be registered at file scope. Registering
6103 * handlers after file scope can lead to unexpected results due to caching.
6108 * Maps jobs to their handling classes; extensions
6109 * can add to this to provide custom jobs
6111 $wgJobClasses = array(
6112 'refreshLinks' => 'RefreshLinksJob',
6113 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6114 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6115 'sendMail' => 'EmaillingJob',
6116 'enotifNotify' => 'EnotifNotifyJob',
6117 'fixDoubleRedirect' => 'DoubleRedirectJob',
6118 'uploadFromUrl' => 'UploadFromUrlJob',
6119 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6120 'PublishStashedFile' => 'PublishStashedFileJob',
6125 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6126 * special flags are set. The values here are keys of $wgJobClasses.
6129 * - Very long-running jobs.
6130 * - Jobs that you would never want to run as part of a page rendering request.
6131 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6132 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6133 * These settings should be global to all wikis.
6135 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6138 * Map of job types to how many job "work items" should be run per second
6139 * on each job runner process. The meaning of "work items" varies per job,
6140 * but typically would be something like "pages to update". A single job
6141 * may have a variable number of work items, as is the case with batch jobs.
6142 * These settings should be global to all wikis.
6144 $wgJobBackoffThrottling = array();
6147 * Map of job types to configuration arrays.
6148 * This determines which queue class and storage system is used for each job type.
6149 * Job types that do not have explicit configuration will use the 'default' config.
6150 * These settings should be global to all wikis.
6152 $wgJobTypeConf = array(
6153 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6157 * Which aggregator to use for tracking which queues have jobs.
6158 * These settings should be global to all wikis.
6160 $wgJobQueueAggregator = array(
6161 'class' => 'JobQueueAggregatorMemc'
6165 * Additional functions to be performed with updateSpecialPages.
6166 * Expensive Querypages are already updated.
6168 $wgSpecialPageCacheUpdates = array(
6169 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
6173 * Hooks that are used for outputting exceptions. Format is:
6174 * $wgExceptionHooks[] = $funcname
6176 * $wgExceptionHooks[] = array( $class, $funcname )
6177 * Hooks should return strings or false
6179 $wgExceptionHooks = array();
6182 * Page property link table invalidation lists. When a page property
6183 * changes, this may require other link tables to be updated (eg
6184 * adding __HIDDENCAT__ means the hiddencat tracking category will
6185 * have been added, so the categorylinks table needs to be rebuilt).
6186 * This array can be added to by extensions.
6188 $wgPagePropLinkInvalidations = array(
6189 'hiddencat' => 'categorylinks',
6192 /** @} */ # End extensions }
6194 /*************************************************************************//**
6200 * Use experimental, DMOZ-like category browser
6202 $wgUseCategoryBrowser = false;
6205 * On category pages, show thumbnail gallery for images belonging to that
6206 * category instead of listing them as articles.
6208 $wgCategoryMagicGallery = true;
6211 * Paging limit for categories
6213 $wgCategoryPagingLimit = 200;
6216 * Specify how category names should be sorted, when listed on a category page.
6217 * A sorting scheme is also known as a collation.
6219 * Available values are:
6221 * - uppercase: Converts the category name to upper case, and sorts by that.
6223 * - identity: Does no conversion. Sorts by binary value of the string.
6225 * - uca-default: Provides access to the Unicode Collation Algorithm with
6226 * the default element table. This is a compromise collation which sorts
6227 * all languages in a mediocre way. However, it is better than "uppercase".
6229 * To use the uca-default collation, you must have PHP's intl extension
6230 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6231 * resulting collation will depend on the version of ICU installed on the
6234 * After you change this, you must run maintenance/updateCollation.php to fix
6235 * the sort keys in the database.
6237 * Extensions can define there own collations by subclassing Collation
6238 * and using the Collation::factory hook.
6240 $wgCategoryCollation = 'uppercase';
6242 /** @} */ # End categories }
6244 /*************************************************************************//**
6250 * The logging system has two levels: an event type, which describes the
6251 * general category and can be viewed as a named subset of all logs; and
6252 * an action, which is a specific kind of event that can exist in that
6255 $wgLogTypes = array(
6270 * This restricts log access to those who have a certain right
6271 * Users without this will not see it in the option menu and can not view it
6272 * Restricted logs are not added to recent changes
6273 * Logs should remain non-transcludable
6274 * Format: logtype => permissiontype
6276 $wgLogRestrictions = array(
6277 'suppress' => 'suppressionlog'
6281 * Show/hide links on Special:Log will be shown for these log types.
6283 * This is associative array of log type => boolean "hide by default"
6285 * See $wgLogTypes for a list of available log types.
6289 * $wgFilterLogTypes = array(
6291 * 'import' => false,
6295 * Will display show/hide links for the move and import logs. Move logs will be
6296 * hidden by default unless the link is clicked. Import logs will be shown by
6297 * default, and hidden when the link is clicked.
6299 * A message of the form log-show-hide-[type] should be added, and will be used
6300 * for the link text.
6302 $wgFilterLogTypes = array(
6307 * Lists the message key string for each log type. The localized messages
6308 * will be listed in the user interface.
6310 * Extensions with custom log types may add to this array.
6312 * @since 1.19, if you follow the naming convention log-name-TYPE,
6313 * where TYPE is your log type, yoy don't need to use this array.
6315 $wgLogNames = array(
6316 '' => 'all-logs-page',
6317 'block' => 'blocklogpage',
6318 'protect' => 'protectlogpage',
6319 'rights' => 'rightslog',
6320 'delete' => 'dellogpage',
6321 'upload' => 'uploadlogpage',
6322 'move' => 'movelogpage',
6323 'import' => 'importlogpage',
6324 'patrol' => 'patrol-log-page',
6325 'merge' => 'mergelog',
6326 'suppress' => 'suppressionlog',
6330 * Lists the message key string for descriptive text to be shown at the
6331 * top of each log type.
6333 * Extensions with custom log types may add to this array.
6335 * @since 1.19, if you follow the naming convention log-description-TYPE,
6336 * where TYPE is your log type, yoy don't need to use this array.
6338 $wgLogHeaders = array(
6339 '' => 'alllogstext',
6340 'block' => 'blocklogtext',
6341 'protect' => 'protectlogtext',
6342 'rights' => 'rightslogtext',
6343 'delete' => 'dellogpagetext',
6344 'upload' => 'uploadlogpagetext',
6345 'move' => 'movelogpagetext',
6346 'import' => 'importlogpagetext',
6347 'patrol' => 'patrol-log-header',
6348 'merge' => 'mergelogpagetext',
6349 'suppress' => 'suppressionlogtext',
6353 * Lists the message key string for formatting individual events of each
6354 * type and action when listed in the logs.
6356 * Extensions with custom log types may add to this array.
6358 $wgLogActions = array(
6359 'block/block' => 'blocklogentry',
6360 'block/unblock' => 'unblocklogentry',
6361 'block/reblock' => 'reblock-logentry',
6362 'protect/protect' => 'protectedarticle',
6363 'protect/modify' => 'modifiedarticleprotection',
6364 'protect/unprotect' => 'unprotectedarticle',
6365 'protect/move_prot' => 'movedarticleprotection',
6366 'upload/upload' => 'uploadedimage',
6367 'upload/overwrite' => 'overwroteimage',
6368 'upload/revert' => 'uploadedimage',
6369 'import/upload' => 'import-logentry-upload',
6370 'import/interwiki' => 'import-logentry-interwiki',
6371 'merge/merge' => 'pagemerge-logentry',
6372 'suppress/block' => 'blocklogentry',
6373 'suppress/reblock' => 'reblock-logentry',
6377 * The same as above, but here values are names of functions,
6379 * @see LogPage::actionText
6382 $wgLogActionsHandlers = array(
6383 'move/move' => 'MoveLogFormatter',
6384 'move/move_redir' => 'MoveLogFormatter',
6385 'delete/delete' => 'DeleteLogFormatter',
6386 'delete/restore' => 'DeleteLogFormatter',
6387 'delete/revision' => 'DeleteLogFormatter',
6388 'delete/event' => 'DeleteLogFormatter',
6389 'suppress/revision' => 'DeleteLogFormatter',
6390 'suppress/event' => 'DeleteLogFormatter',
6391 'suppress/delete' => 'DeleteLogFormatter',
6392 'patrol/patrol' => 'PatrolLogFormatter',
6393 'rights/rights' => 'RightsLogFormatter',
6394 'rights/autopromote' => 'RightsLogFormatter',
6398 * Maintain a log of newusers at Log/newusers?
6400 $wgNewUserLog = true;
6402 /** @} */ # end logging }
6404 /*************************************************************************//**
6405 * @name Special pages (general and miscellaneous)
6410 * Allow special page inclusions such as {{Special:Allpages}}
6412 $wgAllowSpecialInclusion = true;
6415 * Set this to an array of special page names to prevent
6416 * maintenance/updateSpecialPages.php from updating those pages.
6418 $wgDisableQueryPageUpdate = false;
6421 * List of special pages, followed by what subtitle they should go under
6422 * at Special:SpecialPages
6424 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6426 $wgSpecialPageGroups = array();
6429 * Whether or not to sort special pages in Special:Specialpages
6431 $wgSortSpecialPages = true;
6434 * On Special:Unusedimages, consider images "used", if they are put
6435 * into a category. Default (false) is not to count those as used.
6437 $wgCountCategorizedImagesAsUsed = false;
6440 * Maximum number of links to a redirect page listed on
6441 * Special:Whatlinkshere/RedirectDestination
6443 $wgMaxRedirectLinksRetrieved = 500;
6445 /** @} */ # end special pages }
6447 /*************************************************************************//**
6453 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6454 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6455 * 'foo' => true Load the class FooAction which subclasses Action
6456 * If something is specified in the getActionOverrides()
6457 * of the relevant Page object it will be used
6458 * instead of the default class.
6459 * 'foo' => false The action is disabled; show an error message
6460 * Unsetting core actions will probably cause things to complain loudly.
6468 'markpatrolled' => true,
6474 'revisiondelete' => true,
6477 'unprotect' => true,
6484 * Array of disabled article actions, e.g. view, edit, delete, etc.
6485 * @deprecated since 1.18; just set $wgActions['action'] = false instead
6487 $wgDisabledActions = array();
6489 /** @} */ # end actions }
6491 /*************************************************************************//**
6492 * @name Robot (search engine crawler) policy
6493 * See also $wgNoFollowLinks.
6498 * Default robot policy. The default policy is to encourage indexing and fol-
6499 * lowing of links. It may be overridden on a per-namespace and/or per-page
6502 $wgDefaultRobotPolicy = 'index,follow';
6505 * Robot policies per namespaces. The default policy is given above, the array
6506 * is made of namespace constants as defined in includes/Defines.php. You can-
6507 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6508 * nofollow. This is because a number of special pages (e.g., ListPages) have
6509 * many permutations of options that display the same data under redundant
6510 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6511 * pages, all alike, and never reaching your actual content.
6515 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6518 $wgNamespaceRobotPolicies = array();
6521 * Robot policies per article. These override the per-namespace robot policies.
6522 * Must be in the form of an array where the key part is a properly canonicalised
6523 * text form title and the value is a robot policy.
6527 * $wgArticleRobotPolicies = array(
6528 * 'Main Page' => 'noindex,follow',
6529 * 'User:Bob' => 'index,follow',
6533 * @par Example that DOES NOT WORK because the names are not canonical text
6536 * $wgArticleRobotPolicies = array(
6537 * # Underscore, not space!
6538 * 'Main_Page' => 'noindex,follow',
6539 * # "Project", not the actual project name!
6540 * 'Project:X' => 'index,follow',
6541 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6542 * 'abc' => 'noindex,nofollow'
6546 $wgArticleRobotPolicies = array();
6549 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6550 * will not function, so users can't decide whether pages in that namespace are
6551 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6555 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6558 $wgExemptFromUserRobotsControl = null;
6560 /** @} */ # End robot policy }
6562 /************************************************************************//**
6563 * @name AJAX and API
6564 * Note: The AJAX entry point which this section refers to is gradually being
6565 * replaced by the API entry point, api.php. They are essentially equivalent.
6566 * Both of them are used for dynamic client-side features, via XHR.
6571 * Enable the MediaWiki API for convenient access to
6572 * machine-readable data via api.php
6574 * See http://www.mediawiki.org/wiki/API
6576 $wgEnableAPI = true;
6579 * Allow the API to be used to perform write operations
6580 * (page edits, rollback, etc.) when an authorised user
6583 $wgEnableWriteAPI = true;
6587 * WARNING: SECURITY THREAT - debug use only
6589 * Disables many security checks in the API for debugging purposes.
6590 * This flag should never be used on the production servers, as it introduces
6591 * a number of potential security holes. Even when enabled, the validation
6592 * will still be performed, but instead of failing, API will return a warning.
6593 * Also, there will always be a warning notifying that this flag is set.
6594 * At this point, the flag allows GET requests to go through for modules
6599 $wgDebugAPI = false;
6602 * API module extensions.
6603 * Associative array mapping module name to class name.
6604 * Extension modules may override the core modules.
6606 * See ApiMain::$Modules for a list of the core modules.
6608 $wgAPIModules = array();
6611 * API format module extensions.
6612 * Associative array mapping format module name to class name.
6613 * Extension modules may override the core modules.
6615 * See ApiMain::$Formats for a list of the core format modules.
6617 $wgAPIFormatModules = array();
6620 * API Query meta module extensions.
6621 * Associative array mapping meta module name to class name.
6622 * Extension modules may override the core modules.
6624 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6626 $wgAPIMetaModules = array();
6629 * API Query prop module extensions.
6630 * Associative array mapping properties module name to class name.
6631 * Extension modules may override the core modules.
6633 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6635 $wgAPIPropModules = array();
6638 * API Query list module extensions.
6639 * Associative array mapping list module name to class name.
6640 * Extension modules may override the core modules.
6642 * See ApiQuery::$QueryListModules for a list of the core list modules.
6644 $wgAPIListModules = array();
6647 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6648 * @deprecated since 1.21
6650 $wgAPIGeneratorModules = array();
6653 * Maximum amount of rows to scan in a DB query in the API
6654 * The default value is generally fine
6656 $wgAPIMaxDBRows = 5000;
6659 * The maximum size (in bytes) of an API result.
6660 * @warning Do not set this lower than $wgMaxArticleSize*1024
6662 $wgAPIMaxResultSize = 8388608;
6665 * The maximum number of uncached diffs that can be retrieved in one API
6666 * request. Set this to 0 to disable API diffs altogether
6668 $wgAPIMaxUncachedDiffs = 1;
6671 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6672 * API request logging
6674 $wgAPIRequestLog = false;
6677 * Set the timeout for the API help text cache. If set to 0, caching disabled
6679 $wgAPICacheHelpTimeout = 60 * 60;
6682 * The ApiQueryQueryPages module should skip pages that are redundant to true
6685 $wgAPIUselessQueryPages = array(
6686 'MIMEsearch', // aiprop=mime
6687 'LinkSearch', // list=exturlusage
6688 'FileDuplicateSearch', // prop=duplicatefiles
6692 * Enable AJAX framework
6697 * List of Ajax-callable functions.
6698 * Extensions acting as Ajax callbacks must register here
6700 $wgAjaxExportList = array();
6703 * Enable watching/unwatching pages using AJAX.
6704 * Requires $wgUseAjax to be true too.
6706 $wgAjaxWatch = true;
6709 * Enable AJAX check for file overwrite, pre-upload
6711 $wgAjaxUploadDestCheck = true;
6714 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6716 $wgAjaxLicensePreview = true;
6719 * Settings for incoming cross-site AJAX requests:
6720 * Newer browsers support cross-site AJAX when the target resource allows requests
6721 * from the origin domain by the Access-Control-Allow-Origin header.
6722 * This is currently only used by the API (requests to api.php)
6723 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6725 * - '*' matches any number of characters
6726 * - '?' matches any 1 character
6730 * $wgCrossSiteAJAXdomains = array(
6731 * 'www.mediawiki.org',
6732 * '*.wikipedia.org',
6733 * '*.wikimedia.org',
6734 * '*.wiktionary.org',
6738 $wgCrossSiteAJAXdomains = array();
6741 * Domains that should not be allowed to make AJAX requests,
6742 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6743 * Uses the same syntax as $wgCrossSiteAJAXdomains
6745 $wgCrossSiteAJAXdomainExceptions = array();
6747 /** @} */ # End AJAX and API }
6749 /************************************************************************//**
6750 * @name Shell and process control
6755 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6757 $wgMaxShellMemory = 307200;
6760 * Maximum file size created by shell processes under linux, in KB
6761 * ImageMagick convert for example can be fairly hungry for scratch space
6763 $wgMaxShellFileSize = 102400;
6766 * Maximum CPU time in seconds for shell processes under Linux
6768 $wgMaxShellTime = 180;
6771 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6772 * would measure) in seconds for shell processes under Linux
6774 $wgMaxShellWallClockTime = 180;
6777 * Under Linux: a cgroup directory used to constrain memory usage of shell
6778 * commands. The directory must be writable by the user which runs MediaWiki.
6780 * If specified, this is used instead of ulimit, which is inaccurate, and
6781 * causes malloc() to return NULL, which exposes bugs in C applications, making
6782 * them segfault or deadlock.
6784 * A wrapper script will create a cgroup for each shell command that runs, as
6785 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6786 * kernel will send a SIGKILL signal to a process in the subgroup.
6790 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6791 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6792 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6795 * The reliability of cgroup cleanup can be improved by installing a
6796 * notify_on_release script in the root cgroup, see e.g.
6797 * https://gerrit.wikimedia.org/r/#/c/40784
6799 $wgShellCgroup = false;
6802 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6804 $wgPhpCli = '/usr/bin/php';
6807 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
6808 * For Unix-like operating systems, set this to to a locale that has a UTF-8
6809 * character set. Only the character set is relevant.
6811 $wgShellLocale = 'en_US.utf8';
6813 /** @} */ # End shell }
6815 /************************************************************************//**
6821 * Timeout for HTTP requests done internally
6823 $wgHTTPTimeout = 25;
6826 * Timeout for Asynchronous (background) HTTP requests
6828 $wgAsyncHTTPTimeout = 25;
6831 * Proxy to use for CURL requests.
6833 $wgHTTPProxy = false;
6836 * Timeout for connections done internally (in seconds)
6837 * Only works for curl
6839 $wgHTTPConnectTimeout = 5e0
;
6841 /** @} */ # End HTTP client }
6843 /************************************************************************//**
6845 * See also $wgEnotifUseJobQ.
6850 * Number of jobs to perform per request. May be less than one in which case
6851 * jobs are performed probabalistically. If this is zero, jobs will not be done
6852 * during ordinary apache requests. In this case, maintenance/runJobs.php should
6853 * be run periodically.
6858 * Number of rows to update per job
6860 $wgUpdateRowsPerJob = 500;
6863 * Number of rows to update per query
6865 $wgUpdateRowsPerQuery = 100;
6868 * Do not purge all the pages that use a page when it is edited
6869 * if there are more than this many such pages. This is used to
6870 * avoid invalidating a large portion of the squid/parser cache.
6872 * This setting should factor in any squid/parser cache expiry settings.
6874 $wgMaxBacklinksInvalidate = false;
6876 /** @} */ # End job queue }
6878 /************************************************************************//**
6879 * @name Miscellaneous
6884 * Name of the external diff engine to use
6886 $wgExternalDiffEngine = false;
6889 * Disable redirects to special pages and interwiki redirects, which use a 302
6890 * and have no "redirected from" link.
6892 * @note This is only for articles with #REDIRECT in them. URL's containing a
6893 * local interwiki prefix (or a non-canonical special page name) are still hard
6894 * redirected regardless of this setting.
6896 $wgDisableHardRedirects = false;
6899 * LinkHolderArray batch size
6902 $wgLinkHolderBatchSize = 1000;
6905 * By default MediaWiki does not register links pointing to same server in
6906 * externallinks dataset, use this value to override:
6908 $wgRegisterInternalExternals = false;
6911 * Maximum number of pages to move at once when moving subpages with a page.
6913 $wgMaximumMovedPages = 100;
6916 * Fix double redirects after a page move.
6917 * Tends to conflict with page move vandalism, use only on a private wiki.
6919 $wgFixDoubleRedirects = false;
6922 * Allow redirection to another page when a user logs in.
6923 * To enable, set to a string like 'Main Page'
6925 $wgRedirectOnLogin = null;
6928 * Configuration for processing pool control, for use in high-traffic wikis.
6929 * An implementation is provided in the PoolCounter extension.
6931 * This configuration array maps pool types to an associative array. The only
6932 * defined key in the associative array is "class", which gives the class name.
6933 * The remaining elements are passed through to the class as constructor
6938 * $wgPoolCounterConf = array( 'ArticleView' => array(
6939 * 'class' => 'PoolCounter_Client',
6940 * 'timeout' => 15, // wait timeout in seconds
6941 * 'workers' => 5, // maximum number of active threads in each pool
6942 * 'maxqueue' => 50, // maximum number of total threads in each pool
6943 * ... any extension-specific options...
6947 $wgPoolCounterConf = null;
6950 * To disable file delete/restore temporarily
6952 $wgUploadMaintenance = false;
6955 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
6956 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
6957 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
6958 * (except for the special case of JS and CS pages).
6962 $wgNamespaceContentModels = array();
6965 * How to react if a plain text version of a non-text Content object is requested using
6966 * ContentHandler::getContentText():
6968 * * 'ignore': return null
6969 * * 'fail': throw an MWException
6970 * * 'serialize': serialize to default format
6974 $wgContentHandlerTextFallback = 'ignore';
6977 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
6978 * This way, the ContentHandler facility can be used without any additional information in the
6979 * database. A page's content model is then derived solely from the page's title. This however
6980 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
6981 * the page and/or make the content inaccessible. This also means that pages can not be moved to
6982 * a title that would default to a different content model.
6984 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
6985 * handling is less robust and less flexible.
6989 $wgContentHandlerUseDB = true;
6992 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
6993 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
6994 * the effect on the database they would have on a wikitext page.
6996 * @todo On the long run, it would be nice to put categories etc into a separate structure,
6997 * or at least parse only the contents of comments in the scripts.
7001 $wgTextModelsToParse = array(
7002 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
7003 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
7004 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
7008 * Whether the user must enter their password to change their e-mail address
7012 $wgRequirePasswordforEmailChange = true;
7015 * Register handlers for specific types of sites.
7019 $wgSiteTypes = array(
7020 'mediawiki' => 'MediaWikiSite',
7024 * Formerly a list of files for HipHop compilation
7025 * @deprecated since 1.22
7027 $wgCompiledFiles = array();
7030 * For really cool vim folding this needs to be at the end:
7031 * vim: foldmarker=@{,@} foldmethod=marker