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 * Sharpening parameter to ImageMagick
889 $wgSharpenParameter = '0x0.4';
892 * Reduction in linear dimensions below which sharpening will be enabled
894 $wgSharpenReductionThreshold = 0.85;
897 * Temporary directory used for ImageMagick. The directory must exist. Leave
898 * this set to false to let ImageMagick decide for itself.
900 $wgImageMagickTempDir = false;
903 * Use another resizing converter, e.g. GraphicMagick
904 * %s will be replaced with the source path, %d with the destination
905 * %w and %h will be replaced with the width and height.
907 * @par Example for GraphicMagick:
909 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
912 * Leave as false to skip this.
914 $wgCustomConvertCommand = false;
917 * used for lossless jpeg rotation
921 $wgJpegTran = '/usr/bin/jpegtran';
924 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
927 $wgExiv2Command = '/usr/bin/exiv2';
930 * Scalable Vector Graphics (SVG) may be uploaded as images.
931 * Since SVG support is not yet standard in browsers, it is
932 * necessary to rasterize SVGs to PNG as a fallback format.
934 * An external program is required to perform this conversion.
935 * If set to an array, the first item is a PHP callable and any further items
936 * are passed as parameters after $srcPath, $dstPath, $width, $height
938 $wgSVGConverters = array(
939 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
940 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
941 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
942 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
944 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
945 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
946 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
950 * Pick a converter defined in $wgSVGConverters
952 $wgSVGConverter = 'ImageMagick';
955 * If not in the executable PATH, specify the SVG converter path.
957 $wgSVGConverterPath = '';
960 * Don't scale a SVG larger than this
962 $wgSVGMaxSize = 2048;
965 * Don't read SVG metadata beyond this point.
966 * Default is 1024*256 bytes
968 $wgSVGMetadataCutoff = 262144;
971 * Disallow <title> element in SVG files.
973 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
974 * browsers which can not perform basic stuff like MIME detection and which are
975 * vulnerable to further idiots uploading crap files as images.
977 * When this directive is on, "<title>" will be allowed in files with an
978 * "image/svg+xml" MIME type. You should leave this disabled if your web server
979 * is misconfigured and doesn't send appropriate MIME types for SVG images.
981 $wgAllowTitlesInSVG = false;
984 * The maximum number of pixels a source image can have if it is to be scaled
985 * down by a scaler that requires the full source image to be decompressed
986 * and stored in decompressed form, before the thumbnail is generated.
988 * This provides a limit on memory usage for the decompression side of the
989 * image scaler. The limit is used when scaling PNGs with any of the
990 * built-in image scalers, such as ImageMagick or GD. It is ignored for
991 * JPEGs with ImageMagick, and when using the VipsScaler extension.
993 * The default is 50 MB if decompressed to RGBA form, which corresponds to
994 * 12.5 million pixels or 3500x3500.
996 $wgMaxImageArea = 1.25e7
;
999 * Force thumbnailing of animated GIFs above this size to a single
1000 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1001 * is checked against the total size of all frames in the animation.
1002 * It probably makes sense to keep this equal to $wgMaxImageArea.
1004 $wgMaxAnimatedGifArea = 1.25e7
;
1007 * Browsers don't support TIFF inline generally...
1008 * For inline display, we need to convert to PNG or JPEG.
1009 * Note scaling should work with ImageMagick, but may not with GD scaling.
1013 * // PNG is lossless, but inefficient for photos
1014 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1015 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1016 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1019 $wgTiffThumbnailType = false;
1022 * If rendered thumbnail files are older than this timestamp, they
1023 * will be rerendered on demand as if the file didn't already exist.
1024 * Update if there is some need to force thumbs and SVG rasterizations
1025 * to rerender, such as fixes to rendering bugs.
1027 $wgThumbnailEpoch = '20030516000000';
1030 * Certain operations are avoided if there were too many recent failures,
1031 * for example, thumbnail generation. Bump this value to invalidate all
1032 * memory of failed operations and thus allow further attempts to resume.
1033 * This is useful when a cause for the failures has been found and fixed.
1035 $wgAttemptFailureEpoch = 1;
1038 * If set, inline scaled images will still produce "<img>" tags ready for
1039 * output instead of showing an error message.
1041 * This may be useful if errors are transitory, especially if the site
1042 * is configured to automatically render thumbnails on request.
1044 * On the other hand, it may obscure error conditions from debugging.
1045 * Enable the debug log or the 'thumbnail' log group to make sure errors
1046 * are logged to a file for review.
1048 $wgIgnoreImageErrors = false;
1051 * Allow thumbnail rendering on page view. If this is false, a valid
1052 * thumbnail URL is still output, but no file will be created at
1053 * the target location. This may save some time if you have a
1054 * thumb.php or 404 handler set up which is faster than the regular
1057 $wgGenerateThumbnailOnParse = true;
1060 * Show thumbnails for old images on the image description page
1062 $wgShowArchiveThumbnails = true;
1065 * Obsolete, always true, kept for compatibility with extensions
1067 $wgUseImageResize = true;
1070 * If set to true, images that contain certain the exif orientation tag will
1071 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1072 * is available that can rotate.
1074 $wgEnableAutoRotation = null;
1077 * Internal name of virus scanner. This serves as a key to the
1078 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1079 * null, every file uploaded will be scanned for viruses.
1081 $wgAntivirus = null;
1084 * Configuration for different virus scanners. This an associative array of
1085 * associative arrays. It contains one setup array per known scanner type.
1086 * The entry is selected by $wgAntivirus, i.e.
1087 * valid values for $wgAntivirus are the keys defined in this array.
1089 * The configuration array for each scanner contains the following keys:
1090 * "command", "codemap", "messagepattern":
1092 * "command" is the full command to call the virus scanner - %f will be
1093 * replaced with the name of the file to scan. If not present, the filename
1094 * will be appended to the command. Note that this must be overwritten if the
1095 * scanner is not in the system path; in that case, please set
1096 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1099 * "codemap" is a mapping of exit code to return codes of the detectVirus
1100 * function in SpecialUpload.
1101 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1102 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1104 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1105 * the file to have an unsupported format, which is probably immune to
1106 * viruses. This causes the file to pass.
1107 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1108 * no virus was found.
1109 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1111 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1113 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1114 * output. The relevant part should be matched as group one (\1).
1115 * If not defined or the pattern does not match, the full message is shown to the user.
1117 $wgAntivirusSetup = array(
1121 'command' => 'clamscan --no-summary ',
1123 "0" => AV_NO_VIRUS
, # no virus
1124 "1" => AV_VIRUS_FOUND
, # virus found
1125 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1126 "*" => AV_SCAN_FAILED
, # else scan failed
1128 'messagepattern' => '/.*?:(.*)/sim',
1133 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1135 $wgAntivirusRequired = true;
1138 * Determines if the mime type of uploaded files should be checked
1140 $wgVerifyMimeType = true;
1143 * Sets the mime type definition file to use by MimeMagic.php.
1144 * Set to null, to use built-in defaults only.
1145 * example: $wgMimeTypeFile = '/etc/mime.types';
1147 $wgMimeTypeFile = 'includes/mime.types';
1150 * Sets the mime type info file to use by MimeMagic.php.
1151 * Set to null, to use built-in defaults only.
1153 $wgMimeInfoFile = 'includes/mime.info';
1156 * Sets an external mime detector program. The command must print only
1157 * the mime type to standard output.
1158 * The name of the file to process will be appended to the command given here.
1159 * If not set or NULL, mime_content_type will be used if available.
1163 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
1166 $wgMimeDetectorCommand = null;
1169 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
1170 * things, because only a few types of images are needed and file extensions
1173 $wgTrivialMimeDetection = false;
1176 * Additional XML types we can allow via mime-detection.
1177 * array = ( 'rootElement' => 'associatedMimeType' )
1179 $wgXMLMimeTypes = array(
1180 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1181 'svg' => 'image/svg+xml',
1182 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1183 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1184 'html' => 'text/html', // application/xhtml+xml?
1188 * Limit images on image description pages to a user-selectable limit. In order
1189 * to reduce disk usage, limits can only be selected from a list.
1190 * The user preference is saved as an array offset in the database, by default
1191 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1192 * change it if you alter the array (see bug 8858).
1193 * This is the list of settings the user can choose from:
1195 $wgImageLimits = array(
1204 * Adjust thumbnails on image pages according to a user setting. In order to
1205 * reduce disk usage, the values can only be selected from a list. This is the
1206 * list of settings the user can choose from:
1208 $wgThumbLimits = array(
1218 * Default parameters for the "<gallery>" tag
1220 $wgGalleryOptions = array(
1221 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1222 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1223 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1224 'captionLength' => 25, // Length of caption to truncate (in characters)
1225 'showBytes' => true, // Show the filesize in bytes in categories
1226 'mode' => 'traditional',
1230 * Adjust width of upright images when parameter 'upright' is used
1231 * This allows a nicer look for upright images without the need to fix the width
1232 * by hardcoded px in wiki sourcecode.
1234 $wgThumbUpright = 0.75;
1237 * Default value for chmoding of new directories.
1239 $wgDirectoryMode = 0777;
1242 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1244 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1245 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1246 * images in after loading the original low-resolution versions depending on the reported
1247 * window.devicePixelRatio.
1249 $wgResponsiveImages = true;
1252 * @name DJVU settings
1257 * Path of the djvudump executable
1258 * Enable this and $wgDjvuRenderer to enable djvu rendering
1259 * example: $wgDjvuDump = 'djvudump';
1264 * Path of the ddjvu DJVU renderer
1265 * Enable this and $wgDjvuDump to enable djvu rendering
1266 * example: $wgDjvuRenderer = 'ddjvu';
1268 $wgDjvuRenderer = null;
1271 * Path of the djvutxt DJVU text extraction utility
1272 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1273 * example: $wgDjvuTxt = 'djvutxt';
1278 * Path of the djvutoxml executable
1279 * This works like djvudump except much, much slower as of version 3.5.
1281 * For now we recommend you use djvudump instead. The djvuxml output is
1282 * probably more stable, so we'll switch back to it as soon as they fix
1283 * the efficiency problem.
1284 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1288 * $wgDjvuToXML = 'djvutoxml';
1291 $wgDjvuToXML = null;
1294 * Shell command for the DJVU post processor
1295 * Default: pnmtopng, since ddjvu generates ppm output
1296 * Set this to false to output the ppm file directly.
1298 $wgDjvuPostProcessor = 'pnmtojpeg';
1301 * File extension for the DJVU post processor output
1303 $wgDjvuOutputExtension = 'jpg';
1305 /** @} */ # end of DJvu }
1307 /** @} */ # end of file uploads }
1309 /************************************************************************//**
1310 * @name Email settings
1314 $serverName = substr( $wgServer, strrpos( $wgServer, '/' ) +
1 );
1317 * Site admin email address.
1319 $wgEmergencyContact = 'wikiadmin@' . $serverName;
1322 * Password reminder email address.
1324 * The address we should use as sender when a user is requesting his password.
1326 $wgPasswordSender = 'apache@' . $serverName;
1328 unset( $serverName ); # Don't leak local variables to global scope
1331 * Password reminder name
1333 * @deprecated since 1.23; use the system message 'emailsender' instead.
1335 $wgPasswordSenderName = 'MediaWiki Mail';
1338 * Dummy address which should be accepted during mail send action.
1339 * It might be necessary to adapt the address or to set it equal
1340 * to the $wgEmergencyContact address.
1342 $wgNoReplyAddress = 'reply@not.possible';
1345 * Set to true to enable the e-mail basic features:
1346 * Password reminders, etc. If sending e-mail on your
1347 * server doesn't work, you might want to disable this.
1349 $wgEnableEmail = true;
1352 * Set to true to enable user-to-user e-mail.
1353 * This can potentially be abused, as it's hard to track.
1355 $wgEnableUserEmail = true;
1358 * Set to true to put the sending user's email in a Reply-To header
1359 * instead of From. ($wgEmergencyContact will be used as From.)
1361 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1362 * which can cause problems with SPF validation and leak recipient addresses
1363 * when bounces are sent to the sender.
1365 $wgUserEmailUseReplyTo = false;
1368 * Minimum time, in hours, which must elapse between password reminder
1369 * emails for a given account. This is to prevent abuse by mail flooding.
1371 $wgPasswordReminderResendTime = 24;
1374 * The time, in seconds, when an emailed temporary password expires.
1376 $wgNewPasswordExpiry = 3600 * 24 * 7;
1379 * The time, in seconds, when an email confirmation email expires
1381 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1386 * For using a direct (authenticated) SMTP server connection.
1387 * Default to false or fill an array :
1391 * 'host' => 'SMTP domain',
1392 * 'IDHost' => 'domain for MessageID',
1394 * 'auth' => [true|false],
1395 * 'username' => [SMTP username],
1396 * 'password' => [SMTP password],
1403 * Additional email parameters, will be passed as the last argument to mail() call.
1404 * If using safe_mode this has no effect
1406 $wgAdditionalMailParams = null;
1409 * For parts of the system that have been updated to provide HTML email content, send
1410 * both text and HTML parts as the body of the email
1412 $wgAllowHTMLEmail = false;
1415 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1416 * from $wgEmergencyContact
1418 $wgEnotifFromEditor = false;
1420 // TODO move UPO to preferences probably ?
1421 # If set to true, users get a corresponding option in their preferences and can choose to
1422 # enable or disable at their discretion
1423 # If set to false, the corresponding input form on the user preference page is suppressed
1424 # It call this to be a "user-preferences-option (UPO)"
1427 * Require email authentication before sending mail to an email address.
1428 * This is highly recommended. It prevents MediaWiki from being used as an open
1431 $wgEmailAuthentication = true;
1434 * Allow users to enable email notification ("enotif") on watchlist changes.
1436 $wgEnotifWatchlist = false;
1439 * Allow users to enable email notification ("enotif") when someone edits their
1442 $wgEnotifUserTalk = false;
1445 * Set the Reply-to address in notifications to the editor's address, if user
1446 * allowed this in the preferences.
1448 $wgEnotifRevealEditorAddress = false;
1451 * Send notification mails on minor edits to watchlist pages. This is enabled
1452 * by default. Does not affect user talk notifications.
1454 $wgEnotifMinorEdits = true;
1457 * Send a generic mail instead of a personalised mail for each user. This
1458 * always uses UTC as the time zone, and doesn't include the username.
1460 * For pages with many users watching, this can significantly reduce mail load.
1461 * Has no effect when using sendmail rather than SMTP.
1463 $wgEnotifImpersonal = false;
1466 * Maximum number of users to mail at once when using impersonal mail. Should
1467 * match the limit on your mail server.
1469 $wgEnotifMaxRecips = 500;
1472 * Send mails via the job queue. This can be useful to reduce the time it
1473 * takes to save a page that a lot of people are watching.
1475 $wgEnotifUseJobQ = false;
1478 * Use real name instead of username in e-mail "from" field.
1480 $wgEnotifUseRealName = false;
1483 * Array of usernames who will be sent a notification email for every change
1484 * which occurs on a wiki. Users will not be notified of their own changes.
1486 $wgUsersNotifiedOnAllChanges = array();
1488 /** @} */ # end of email settings
1490 /************************************************************************//**
1491 * @name Database settings
1496 * Database host name or IP address
1498 $wgDBserver = 'localhost';
1501 * Database port number (for PostgreSQL)
1506 * Name of the database
1508 $wgDBname = 'my_wiki';
1513 $wgDBuser = 'wikiuser';
1516 * Database user's password
1523 $wgDBtype = 'mysql';
1526 * Whether to use SSL in DB connection.
1531 * Whether to use compression in DB connection.
1533 $wgDBcompress = false;
1536 * Separate username for maintenance tasks. Leave as null to use the default.
1538 $wgDBadminuser = null;
1541 * Separate password for maintenance tasks. Leave as null to use the default.
1543 $wgDBadminpassword = null;
1547 * Leave as null to select the default search engine for the
1548 * selected database type (eg SearchMySQL), or set to a class
1549 * name to override to a custom search engine.
1551 $wgSearchType = null;
1554 * Alternative search types
1555 * Sometimes you want to support multiple search engines for testing. This
1556 * allows users to select their search engine of choice via url parameters
1557 * to Special:Search and the action=search API. If using this, there's no
1558 * need to add $wgSearchType to it, that is handled automatically.
1560 $wgSearchTypeAlternatives = null;
1568 * MySQL table options to use during installation or update
1570 $wgDBTableOptions = 'ENGINE=InnoDB';
1573 * SQL Mode - default is turning off all modes, including strict, if set.
1574 * null can be used to skip the setting for performance reasons and assume
1575 * DBA has done his best job.
1576 * String override can be used for some additional fun :-)
1583 $wgDBmwschema = 'mediawiki';
1586 * To override default SQLite data directory ($docroot/../data)
1588 $wgSQLiteDataDir = '';
1591 * Make all database connections secretly go to localhost. Fool the load balancer
1592 * thinking there is an arbitrarily large cluster of servers to connect to.
1593 * Useful for debugging.
1595 $wgAllDBsAreLocalhost = false;
1598 * Shared database for multiple wikis. Commonly used for storing a user table
1599 * for single sign-on. The server for this database must be the same as for the
1602 * For backwards compatibility the shared prefix is set to the same as the local
1603 * prefix, and the user table is listed in the default list of shared tables.
1604 * The user_properties table is also added so that users will continue to have their
1605 * preferences shared (preferences were stored in the user table prior to 1.16)
1607 * $wgSharedTables may be customized with a list of tables to share in the shared
1608 * database. However it is advised to limit what tables you do share as many of
1609 * MediaWiki's tables may have side effects if you try to share them.
1611 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1614 * @deprecated In new code, use the $wiki parameter to wfGetLB() to access
1615 * remote databases. Using wfGetLB() allows the shared database to reside on
1616 * separate servers to the wiki's own database, with suitable configuration
1617 * of $wgLBFactoryConf.
1624 $wgSharedPrefix = false;
1629 $wgSharedTables = array( 'user', 'user_properties' );
1632 * Database load balancer
1633 * This is a two-dimensional array, an array of server info structures
1636 * - dbname: Default database name
1638 * - password: DB password
1639 * - type: "mysql" or "postgres"
1641 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1642 * If this is zero for any given server, no normal query traffic will be
1643 * sent to it. It will be excluded from lag checks in maintenance scripts.
1644 * The only way it can receive traffic is if groupLoads is used.
1646 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1647 * to several groups, the most specific group defined here is used.
1649 * - flags: bit field
1650 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1651 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1652 * - DBO_TRX -- wrap entire request in a transaction
1653 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1654 * - DBO_PERSISTENT -- enables persistent database connections
1655 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1656 * - DBO_COMPRESS -- uses internal compression in database connections,
1659 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1661 * These and any other user-defined properties will be assigned to the mLBInfo member
1662 * variable of the Database object.
1664 * Leave at false to use the single-server variables above. If you set this
1665 * variable, the single-server variables will generally be ignored (except
1666 * perhaps in some command-line scripts).
1668 * The first server listed in this array (with key 0) will be the master. The
1669 * rest of the servers will be slaves. To prevent writes to your slaves due to
1670 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1671 * slaves in my.cnf. You can set read_only mode at runtime using:
1674 * SET @@read_only=1;
1677 * Since the effect of writing to a slave is so damaging and difficult to clean
1678 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1679 * our masters, and then set read_only=0 on masters at runtime.
1681 $wgDBservers = false;
1684 * Load balancer factory configuration
1685 * To set up a multi-master wiki farm, set the class here to something that
1686 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1687 * The class identified here is responsible for reading $wgDBservers,
1688 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1690 * The LBFactoryMulti class is provided for this purpose, please see
1691 * includes/db/LBFactoryMulti.php for configuration information.
1693 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1696 * How long to wait for a slave to catch up to the master
1698 $wgMasterWaitTimeout = 10;
1701 * File to log database errors to
1703 $wgDBerrorLog = false;
1706 * Timezone to use in the error log.
1707 * Defaults to the wiki timezone ($wgLocaltimezone).
1709 * A list of usable timezones can found at:
1710 * http://php.net/manual/en/timezones.php
1714 * $wgLocaltimezone = 'UTC';
1715 * $wgLocaltimezone = 'GMT';
1716 * $wgLocaltimezone = 'PST8PDT';
1717 * $wgLocaltimezone = 'Europe/Sweden';
1718 * $wgLocaltimezone = 'CET';
1723 $wgDBerrorLogTZ = false;
1726 * When to give an error message
1728 $wgDBClusterTimeout = 10;
1731 * Scale load balancer polling time so that under overload conditions, the
1732 * database server receives a SHOW STATUS query at an average interval of this
1735 $wgDBAvgStatusPoll = 2000;
1738 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1739 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1741 * @warning THIS IS EXPERIMENTAL!
1743 * May break if you're not using the table defs from mysql5/tables.sql.
1744 * May break if you're upgrading an existing wiki if set differently.
1745 * Broken symptoms likely to include incorrect behavior with page titles,
1746 * usernames, comments etc containing non-ASCII characters.
1747 * Might also cause failures on the object cache and other things.
1749 * Even correct usage may cause failures with Unicode supplementary
1750 * characters (those not in the Basic Multilingual Plane) unless MySQL
1751 * has enhanced their Unicode support.
1753 $wgDBmysql5 = false;
1756 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1758 * To use this feature set to true and use a datasource defined as
1759 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1762 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1763 * Pool) that maintains established sessions and reuses them on new
1766 * Not completely tested, but it should fall back on normal connection
1767 * in case the pool is full or the datasource is not configured as
1769 * And the other way around; using oci_pconnect on a non pooled
1770 * datasource should produce a normal connection.
1772 * When it comes to frequent shortlived DB connections like with MW
1773 * Oracle tends to s***. The problem is the driver connects to the
1774 * database reasonably fast, but establishing a session takes time and
1775 * resources. MW does not rely on session state (as it does not use
1776 * features such as package variables) so establishing a valid session
1777 * is in this case an unwanted overhead that just slows things down.
1779 * @warning EXPERIMENTAL!
1782 $wgDBOracleDRCP = false;
1785 * Other wikis on this site, can be administered from a single developer
1787 * Array numeric key => database name
1789 $wgLocalDatabases = array();
1792 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1793 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1794 * show a more obvious warning.
1796 $wgSlaveLagWarning = 10;
1799 * @see $wgSlaveLagWarning
1801 $wgSlaveLagCritical = 30;
1803 /**@}*/ # End of DB settings }
1805 /************************************************************************//**
1806 * @name Text storage
1811 * We can also compress text stored in the 'text' table. If this is set on, new
1812 * revisions will be compressed on page save if zlib support is available. Any
1813 * compressed revisions will be decompressed on load regardless of this setting,
1814 * but will not be readable at all* if zlib support is not available.
1816 $wgCompressRevisions = false;
1819 * External stores allow including content
1820 * from non database sources following URL links.
1822 * Short names of ExternalStore classes may be specified in an array here:
1824 * $wgExternalStores = array("http","file","custom")...
1827 * CAUTION: Access to database might lead to code execution
1829 $wgExternalStores = array();
1832 * An array of external MySQL servers.
1835 * Create a cluster named 'cluster1' containing three servers:
1837 * $wgExternalServers = array(
1838 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1842 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1845 $wgExternalServers = array();
1848 * The place to put new revisions, false to put them in the local text table.
1849 * Part of a URL, e.g. DB://cluster1
1851 * Can be an array instead of a single string, to enable data distribution. Keys
1852 * must be consecutive integers, starting at zero.
1856 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1861 $wgDefaultExternalStore = false;
1864 * Revision text may be cached in $wgMemc to reduce load on external storage
1865 * servers and object extraction overhead for frequently-loaded revisions.
1867 * Set to 0 to disable, or number of seconds before cache expiry.
1869 $wgRevisionCacheExpiry = 0;
1871 /** @} */ # end text storage }
1873 /************************************************************************//**
1874 * @name Performance hacks and limits
1879 * Disable database-intensive features
1881 $wgMiserMode = false;
1884 * Disable all query pages if miser mode is on, not just some
1886 $wgDisableQueryPages = false;
1889 * Number of rows to cache in 'querycache' table when miser mode is on
1891 $wgQueryCacheLimit = 1000;
1894 * Number of links to a page required before it is deemed "wanted"
1896 $wgWantedPagesThreshold = 1;
1899 * Enable slow parser functions
1901 $wgAllowSlowParserFunctions = false;
1904 * Allow schema updates
1906 $wgAllowSchemaUpdates = true;
1909 * Anti-lock flags - bitfield
1910 * - ALF_NO_LINK_LOCK:
1911 * Don't use locking reads when updating the link table. This is
1912 * necessary for wikis with a high edit rate for performance
1913 * reasons, but may cause link table inconsistency
1915 $wgAntiLockFlags = 0;
1918 * Maximum article size in kilobytes
1920 $wgMaxArticleSize = 2048;
1923 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1924 * raise PHP's memory limit if it's below this amount.
1926 $wgMemoryLimit = "50M";
1928 /** @} */ # end performance hacks }
1930 /************************************************************************//**
1931 * @name Cache settings
1936 * Directory for caching data in the local filesystem. Should not be accessible
1937 * from the web. Set this to false to not use any local caches.
1939 * Note: if multiple wikis share the same localisation cache directory, they
1940 * must all have the same set of extensions. You can set a directory just for
1941 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1943 $wgCacheDirectory = false;
1946 * Main cache type. This should be a cache with fast access, but it may have
1947 * limited space. By default, it is disabled, since the database is not fast
1948 * enough to make it worthwhile.
1952 * - CACHE_ANYTHING: Use anything, as long as it works
1953 * - CACHE_NONE: Do not cache
1954 * - CACHE_DB: Store cache objects in the DB
1955 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
1956 * - CACHE_ACCEL: APC, XCache or WinCache
1957 * - (other): A string may be used which identifies a cache
1958 * configuration in $wgObjectCaches.
1960 * @see $wgMessageCacheType, $wgParserCacheType
1962 $wgMainCacheType = CACHE_NONE
;
1965 * The cache type for storing the contents of the MediaWiki namespace. This
1966 * cache is used for a small amount of data which is expensive to regenerate.
1968 * For available types see $wgMainCacheType.
1970 $wgMessageCacheType = CACHE_ANYTHING
;
1973 * The cache type for storing article HTML. This is used to store data which
1974 * is expensive to regenerate, and benefits from having plenty of storage space.
1976 * For available types see $wgMainCacheType.
1978 $wgParserCacheType = CACHE_ANYTHING
;
1981 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
1983 * For available types see $wgMainCacheType.
1985 $wgSessionCacheType = CACHE_ANYTHING
;
1988 * The cache type for storing language conversion tables,
1989 * which are used when parsing certain text and interface messages.
1991 * For available types see $wgMainCacheType.
1995 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
1998 * Advanced object cache configuration.
2000 * Use this to define the class names and constructor parameters which are used
2001 * for the various cache types. Custom cache types may be defined here and
2002 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2003 * or $wgLanguageConverterCacheType.
2005 * The format is an associative array where the key is a cache identifier, and
2006 * the value is an associative array of parameters. The "class" parameter is the
2007 * class name which will be used. Alternatively, a "factory" parameter may be
2008 * given, giving a callable function which will generate a suitable cache object.
2010 $wgObjectCaches = array(
2011 CACHE_NONE
=> array( 'class' => 'EmptyBagOStuff' ),
2012 CACHE_DB
=> array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
2014 CACHE_ANYTHING
=> array( 'factory' => 'ObjectCache::newAnything' ),
2015 CACHE_ACCEL
=> array( 'factory' => 'ObjectCache::newAccelerator' ),
2016 CACHE_MEMCACHED
=> array( 'factory' => 'ObjectCache::newMemcached' ),
2018 'apc' => array( 'class' => 'APCBagOStuff' ),
2019 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2020 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2021 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2022 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2023 'hash' => array( 'class' => 'HashBagOStuff' ),
2027 * The expiry time for the parser cache, in seconds.
2028 * The default is 86400 (one day).
2030 $wgParserCacheExpireTime = 86400;
2033 * Deprecated alias for $wgSessionsInObjectCache.
2035 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2037 $wgSessionsInMemcached = false;
2040 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2041 * can be useful to improve performance, or to avoid the locking behavior of
2042 * PHP's default session handler, which tends to prevent multiple requests for
2043 * the same user from acting concurrently.
2045 $wgSessionsInObjectCache = false;
2048 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2049 * enabled, in seconds.
2051 $wgObjectCacheSessionExpiry = 3600;
2054 * This is used for setting php's session.save_handler. In practice, you will
2055 * almost never need to change this ever. Other options might be 'user' or
2056 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2057 * useful if you're doing cross-application sessions, see bug 11381)
2059 $wgSessionHandler = null;
2062 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2064 $wgMemCachedDebug = false;
2067 * The list of MemCached servers and port numbers
2069 $wgMemCachedServers = array( '127.0.0.1:11211' );
2072 * Use persistent connections to MemCached, which are shared across multiple
2075 $wgMemCachedPersistent = false;
2078 * Read/write timeout for MemCached server communication, in microseconds.
2080 $wgMemCachedTimeout = 500000;
2083 * Set this to true to make a local copy of the message cache, for use in
2084 * addition to memcached. The files will be put in $wgCacheDirectory.
2086 $wgUseLocalMessageCache = false;
2089 * Instead of caching everything, only cache those messages which have
2090 * been customised in the site content language. This means that
2091 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2092 * This option is probably only useful for translatewiki.net.
2094 $wgAdaptiveMessageCache = false;
2097 * Localisation cache configuration. Associative array with keys:
2098 * class: The class to use. May be overridden by extensions.
2100 * store: The location to store cache data. May be 'files', 'db' or
2101 * 'detect'. If set to "files", data will be in CDB files. If set
2102 * to "db", data will be stored to the database. If set to
2103 * "detect", files will be used if $wgCacheDirectory is set,
2104 * otherwise the database will be used.
2106 * storeClass: The class name for the underlying storage. If set to a class
2107 * name, it overrides the "store" setting.
2109 * storeDirectory: If the store class puts its data in files, this is the
2110 * directory it will use. If this is false, $wgCacheDirectory
2113 * manualRecache: Set this to true to disable cache updates on web requests.
2114 * Use maintenance/rebuildLocalisationCache.php instead.
2116 $wgLocalisationCacheConf = array(
2117 'class' => 'LocalisationCache',
2118 'store' => 'detect',
2119 'storeClass' => false,
2120 'storeDirectory' => false,
2121 'manualRecache' => false,
2125 * Allow client-side caching of pages
2127 $wgCachePages = true;
2130 * Set this to current time to invalidate all prior cached pages. Affects both
2131 * client-side and server-side caching.
2132 * You can get the current date on your server by using the command:
2134 * date +%Y%m%d%H%M%S
2137 $wgCacheEpoch = '20030516000000';
2140 * Bump this number when changing the global style sheets and JavaScript.
2142 * It should be appended in the query string of static CSS and JS includes,
2143 * to ensure that client-side caches do not keep obsolete copies of global
2146 $wgStyleVersion = '303';
2149 * This will cache static pages for non-logged-in users to reduce
2150 * database traffic on public sites.
2151 * Automatically sets $wgShowIPinHeader = false
2152 * ResourceLoader requests to default language and skins are cached
2153 * as well as single module requests.
2155 $wgUseFileCache = false;
2158 * Depth of the subdirectory hierarchy to be created under
2159 * $wgFileCacheDirectory. The subdirectories will be named based on
2160 * the MD5 hash of the title. A value of 0 means all cache files will
2161 * be put directly into the main file cache directory.
2163 $wgFileCacheDepth = 2;
2166 * Keep parsed pages in a cache (objectcache table or memcached)
2167 * to speed up output of the same page viewed by another user with the
2170 * This can provide a significant speedup for medium to large pages,
2171 * so you probably want to keep it on. Extensions that conflict with the
2172 * parser cache should disable the cache on a per-page basis instead.
2174 $wgEnableParserCache = true;
2177 * Append a configured value to the parser cache and the sitenotice key so
2178 * that they can be kept separate for some class of activity.
2180 $wgRenderHashAppend = '';
2183 * If on, the sidebar navigation links are cached for users with the
2184 * current language set. This can save a touch of load on a busy site
2185 * by shaving off extra message lookups.
2187 * However it is also fragile: changing the site configuration, or
2188 * having a variable $wgArticlePath, can produce broken links that
2189 * don't update as expected.
2191 $wgEnableSidebarCache = false;
2194 * Expiry time for the sidebar cache, in seconds
2196 $wgSidebarCacheExpiry = 86400;
2199 * When using the file cache, we can store the cached HTML gzipped to save disk
2200 * space. Pages will then also be served compressed to clients that support it.
2202 * Requires zlib support enabled in PHP.
2207 * Whether MediaWiki should send an ETag header. Seems to cause
2208 * broken behavior with Squid 2.6, see bug 7098.
2213 * Clock skew or the one-second resolution of time() can occasionally cause cache
2214 * problems when the user requests two pages within a short period of time. This
2215 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2218 $wgClockSkewFudge = 5;
2221 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2222 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2223 * was previously done in the default LocalSettings.php file.
2225 * On high-traffic wikis, this should be set to false, to avoid the need to
2226 * check the file modification time, and to avoid the performance impact of
2227 * unnecessary cache invalidations.
2229 $wgInvalidateCacheOnLocalSettingsChange = true;
2231 /** @} */ # end of cache settings
2233 /************************************************************************//**
2234 * @name HTTP proxy (Squid) settings
2236 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2237 * although they are referred to as Squid settings for historical reasons.
2239 * Achieving a high hit ratio with an HTTP proxy requires special
2240 * configuration. See http://www.mediawiki.org/wiki/Manual:Squid_caching for
2247 * Enable/disable Squid.
2248 * See http://www.mediawiki.org/wiki/Manual:Squid_caching
2250 $wgUseSquid = false;
2253 * If you run Squid3 with ESI support, enable this (default:false):
2258 * Send X-Vary-Options header for better caching (requires patched Squid)
2263 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2264 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2265 * and need to split the cache between HTTP and HTTPS for API requests,
2266 * feed requests and HTTP redirect responses in order to prevent cache
2267 * pollution. This does not affect 'normal' requests to index.php other than
2270 $wgVaryOnXFP = false;
2273 * Internal server name as known to Squid, if different.
2277 * $wgInternalServer = 'http://yourinternal.tld:8000';
2280 $wgInternalServer = false;
2283 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2284 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2285 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2288 $wgSquidMaxage = 18000;
2291 * Default maximum age for raw CSS/JS accesses
2293 $wgForcedRawSMaxage = 300;
2296 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2298 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2299 * headers sent/modified from these proxies when obtaining the remote IP address
2301 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2303 $wgSquidServers = array();
2306 * As above, except these servers aren't purged on page changes; use to set a
2307 * list of trusted proxies, etc. Supports both individual IP addresses and
2309 * @since 1.23 Supports CIDR ranges
2311 $wgSquidServersNoPurge = array();
2314 * Maximum number of titles to purge in any one client operation
2316 $wgMaxSquidPurgeTitles = 400;
2319 * Whether to use a Host header in purge requests sent to the proxy servers
2320 * configured in $wgSquidServers. Set this to false to support Squid
2321 * configured in forward-proxy mode.
2323 * If this is set to true, a Host header will be sent, and only the path
2324 * component of the URL will appear on the request line, as if the request
2325 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2326 * request. Squid supports this style of request only if reverse-proxy mode
2327 * (http_port ... accel) is enabled.
2329 * If this is set to false, no Host header will be sent, and the absolute URL
2330 * will be sent in the request line, as is the standard for an HTTP proxy
2331 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2332 * by Varnish, but is supported by Squid in either configuration (forward or
2337 $wgSquidPurgeUseHostHeader = true;
2340 * Routing configuration for HTCP multicast purging. Add elements here to
2341 * enable HTCP and determine which purges are sent where. If set to an empty
2342 * array, HTCP is disabled.
2344 * Each key in this array is a regular expression to match against the purged
2345 * URL, or an empty string to match all URLs. The purged URL is matched against
2346 * the regexes in the order specified, and the first rule whose regex matches
2347 * is used, all remaining rules will thus be ignored.
2349 * @par Example configuration to send purges for upload.wikimedia.org to one
2350 * multicast group and all other purges to another:
2352 * $wgHTCPRouting = array(
2353 * '|^https?://upload\.wikimedia\.org|' => array(
2354 * 'host' => '239.128.0.113',
2358 * 'host' => '239.128.0.112',
2364 * You can also pass an array of hosts to send purges too. This is useful when
2365 * you have several multicast groups or unicast address that should receive a
2366 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2368 * @par Example of sending purges to multiple hosts:
2370 * $wgHTCPRouting = array(
2372 * // Purges to text caches using multicast
2373 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2374 * // Purges to a hardcoded list of caches
2375 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2376 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2377 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2384 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2385 * For back compatibility purposes, whenever its array is empty
2386 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2388 * @see $wgHTCPMulticastTTL
2390 $wgHTCPRouting = array();
2393 * @deprecated since 1.22, please use $wgHTCPRouting instead.
2395 * Whenever this is set and $wgHTCPRouting evaluates to false, $wgHTCPRouting
2396 * will be set to this value.
2397 * This is merely for back compatibility.
2401 $wgHTCPMulticastRouting = null;
2404 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
2406 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
2407 * present in the earliest Squid implementations of the protocol.
2409 * This setting is DEPRECATED in favor of $wgHTCPRouting , and kept for
2410 * backwards compatibility only. If $wgHTCPRouting is set, this setting is
2411 * ignored. If $wgHTCPRouting is not set and this setting is, it is used to
2412 * populate $wgHTCPRouting.
2414 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2415 * favor of $wgHTCPRouting.
2417 $wgHTCPMulticastAddress = false;
2420 * HTCP multicast port.
2421 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting and since 1.22 in
2422 * favor of $wgHTCPRouting.
2424 * @see $wgHTCPMulticastAddress
2429 * HTCP multicast TTL.
2430 * @see $wgHTCPRouting
2432 $wgHTCPMulticastTTL = 1;
2435 * Should forwarded Private IPs be accepted?
2437 $wgUsePrivateIPs = false;
2439 /** @} */ # end of HTTP proxy settings
2441 /************************************************************************//**
2442 * @name Language, regional and character encoding settings
2447 * Site language code. See languages/Names.php for languages supported by
2448 * MediaWiki out of the box. Not all languages listed there have translations,
2449 * see languages/messages/ for the list of languages with some localisation.
2451 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2452 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2454 * This defines the default interface language for all users, but users can
2455 * change it in their preferences.
2457 * This also defines the language of pages in the wiki. The content is wrapped
2458 * in a html element with lang=XX attribute. This behavior can be overridden
2459 * via hooks, see Title::getPageLanguage.
2461 $wgLanguageCode = 'en';
2464 * Language cache size, or really how many languages can we handle
2465 * simultaneously without degrading to crawl speed.
2467 $wgLangObjCacheSize = 10;
2470 * Some languages need different word forms, usually for different cases.
2471 * Used in Language::convertGrammar().
2475 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2478 $wgGrammarForms = array();
2481 * Treat language links as magic connectors, not inline links
2483 $wgInterwikiMagic = true;
2486 * Hide interlanguage links from the sidebar
2488 $wgHideInterlanguageLinks = false;
2491 * List of language names or overrides for default names in Names.php
2493 $wgExtraLanguageNames = array();
2496 * List of language codes that don't correspond to an actual language.
2497 * These codes are mostly left-offs from renames, or other legacy things.
2498 * This array makes them not appear as a selectable language on the installer,
2499 * and excludes them when running the transstat.php script.
2501 $wgDummyLanguageCodes = array(
2504 'be-x-old' => 'be-tarask',
2508 'qqq' => 'qqq', # Used for message documentation.
2509 'qqx' => 'qqx', # Used for viewing message keys.
2512 'zh-classical' => 'lzh',
2513 'zh-min-nan' => 'nan',
2518 * Character set for use in the article edit box. Language-specific encodings
2521 * This historic feature is one of the first that was added by former MediaWiki
2522 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2524 $wgEditEncoding = '';
2527 * Set this to true to replace Arabic presentation forms with their standard
2528 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2531 * Note that pages with titles containing presentation forms will become
2532 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2534 $wgFixArabicUnicode = true;
2537 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2538 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2539 * set to "ml". Note that some clients (even new clients as of 2010) do not
2540 * support these characters.
2542 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2543 * fix any ZWJ sequences in existing page titles.
2545 $wgFixMalayalamUnicode = true;
2548 * Set this to always convert certain Unicode sequences to modern ones
2549 * regardless of the content language. This has a small performance
2552 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2557 $wgAllUnicodeFixes = false;
2560 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2561 * loading old revisions not marked with "utf-8" flag. Use this when
2562 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2563 * burdensome mass conversion of old text data.
2565 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2566 * user names, etc still must be converted en masse in the database before
2567 * continuing as a UTF-8 wiki.
2569 $wgLegacyEncoding = false;
2572 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2573 * regexps : "/regexp/" matching problematic browsers. These browsers will
2574 * be served encoded unicode in the edit box instead of real unicode.
2576 $wgBrowserBlackList = array(
2578 * Netscape 2-4 detection
2579 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2580 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2581 * with a negative assertion. The [UIN] identifier specifies the level of security
2582 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2583 * The language string is unreliable, it is missing on NS4 Mac.
2585 * Reference: http://www.psychedelix.com/agents/index.shtml
2587 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2588 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2589 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2592 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2593 * Þ to <THORN> and Ð to <ETH>
2596 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2597 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2598 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2601 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2602 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2604 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2607 * Google wireless transcoder, seems to eat a lot of chars alive
2608 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2610 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2614 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2615 * create stub reference rows in the text table instead of copying
2616 * the full text of all current entries from 'cur' to 'text'.
2618 * This will speed up the conversion step for large sites, but
2619 * requires that the cur table be kept around for those revisions
2620 * to remain viewable.
2622 * This option affects the updaters *only*. Any present cur stub
2623 * revisions will be readable at runtime regardless of this setting.
2625 $wgLegacySchemaConversion = false;
2628 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2629 * the interface is set to English.
2631 $wgAmericanDates = false;
2634 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2635 * numerals in interface.
2637 $wgTranslateNumerals = true;
2640 * Translation using MediaWiki: namespace.
2641 * Interface messages will be loaded from the database.
2643 $wgUseDatabaseMessages = true;
2646 * Expiry time for the message cache key
2648 $wgMsgCacheExpiry = 86400;
2651 * Maximum entry size in the message cache, in bytes
2653 $wgMaxMsgCacheEntrySize = 10000;
2656 * Whether to enable language variant conversion.
2658 $wgDisableLangConversion = false;
2661 * Whether to enable language variant conversion for links.
2663 $wgDisableTitleConversion = false;
2666 * Whether to enable canonical language links in meta data.
2668 $wgCanonicalLanguageLinks = true;
2671 * Default variant code, if false, the default will be the language code
2673 $wgDefaultLanguageVariant = false;
2676 * Disabled variants array of language variant conversion.
2680 * $wgDisabledVariants[] = 'zh-mo';
2681 * $wgDisabledVariants[] = 'zh-my';
2684 $wgDisabledVariants = array();
2687 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2688 * path format that describes which parts of the URL contain the
2693 * $wgLanguageCode = 'sr';
2694 * $wgVariantArticlePath = '/$2/$1';
2695 * $wgArticlePath = '/wiki/$1';
2698 * A link to /wiki/ would be redirected to /sr/Главна_страна
2700 * It is important that $wgArticlePath not overlap with possible values
2701 * of $wgVariantArticlePath.
2703 $wgVariantArticlePath = false;
2706 * Show a bar of language selection links in the user login and user
2707 * registration forms; edit the "loginlanguagelinks" message to
2710 $wgLoginLanguageSelector = false;
2713 * When translating messages with wfMessage(), it is not always clear what
2714 * should be considered UI messages and what should be content messages.
2716 * For example, for the English Wikipedia, there should be only one 'mainpage',
2717 * so when getting the link for 'mainpage', we should treat it as site content
2718 * and call ->inContentLanguage()->text(), but for rendering the text of the
2719 * link, we call ->text(). The code behaves this way by default. However,
2720 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2721 * and the like for different languages. This array provides a way to override
2722 * the default behavior.
2725 * To allow language-specific main page and community
2728 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2731 $wgForceUIMsgAsContentMsg = array();
2734 * Fake out the timezone that the server thinks it's in. This will be used for
2735 * date display and not for what's stored in the DB. Leave to null to retain
2736 * your server's OS-based timezone value.
2738 * This variable is currently used only for signature formatting and for local
2739 * time/date parser variables ({{LOCALTIME}} etc.)
2741 * Timezones can be translated by editing MediaWiki messages of type
2742 * timezone-nameinlowercase like timezone-utc.
2744 * A list of usable timezones can found at:
2745 * http://php.net/manual/en/timezones.php
2749 * $wgLocaltimezone = 'UTC';
2750 * $wgLocaltimezone = 'GMT';
2751 * $wgLocaltimezone = 'PST8PDT';
2752 * $wgLocaltimezone = 'Europe/Sweden';
2753 * $wgLocaltimezone = 'CET';
2756 $wgLocaltimezone = null;
2759 * Set an offset from UTC in minutes to use for the default timezone setting
2760 * for anonymous users and new user accounts.
2762 * This setting is used for most date/time displays in the software, and is
2763 * overridable in user preferences. It is *not* used for signature timestamps.
2765 * By default, this will be set to match $wgLocaltimezone.
2767 $wgLocalTZoffset = null;
2769 /** @} */ # End of language/charset settings
2771 /*************************************************************************//**
2772 * @name Output format and skin settings
2777 * The default Content-Type header.
2779 $wgMimeType = 'text/html';
2782 * Previously used as content type in HTML script tags. This is now ignored since
2783 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2784 * It was also previously used by RawAction to determine the ctype query parameter
2785 * value that will result in a javascript response.
2786 * @deprecated since 1.22
2788 $wgJsMimeType = null;
2791 * The default xmlns attribute. The option to define this has been removed.
2792 * The value of this variable is no longer used by core and is set to a fixed
2793 * value in Setup.php for compatibility with extensions that depend on the value
2794 * of this variable being set. Such a dependency however is deprecated.
2795 * @deprecated since 1.22
2797 $wgXhtmlDefaultNamespace = null;
2800 * Previously used to determine if we should output an HTML5 doctype.
2801 * This is no longer used as we always output HTML5 now. For compatibility with
2802 * extensions that still check the value of this config it's value is now forced
2803 * to true by Setup.php.
2804 * @deprecated since 1.22
2809 * Defines the value of the version attribute in the <html> tag, if any.
2810 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2811 * (like if it's left at the default null value), it will be auto-initialized
2812 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2813 * ever actually set this to anything.
2815 $wgHtml5Version = null;
2818 * Enabled RDFa attributes for use in wikitext.
2819 * NOTE: Interaction with HTML5 is somewhat underspecified.
2821 $wgAllowRdfaAttributes = false;
2824 * Enabled HTML5 microdata attributes for use in wikitext.
2826 $wgAllowMicrodataAttributes = false;
2829 * Should we try to make our HTML output well-formed XML? If set to false,
2830 * output will be a few bytes shorter, and the HTML will arguably be more
2831 * readable. If set to true, life will be much easier for the authors of
2832 * screen-scraping bots, and the HTML will arguably be more readable.
2834 * Setting this to false may omit quotation marks on some attributes, omit
2835 * slashes from some self-closing tags, omit some ending tags, etc., where
2836 * permitted by HTML5. Setting it to true will not guarantee that all pages
2837 * will be well-formed, although non-well-formed pages should be rare and it's
2838 * a bug if you find one. Conversely, setting it to false doesn't mean that
2839 * all XML-y constructs will be omitted, just that they might be.
2841 * Because of compatibility with screen-scraping bots, and because it's
2842 * controversial, this is currently left to true by default.
2844 $wgWellFormedXml = true;
2847 * Permit other namespaces in addition to the w3.org default.
2849 * Use the prefix for the key and the namespace for the value.
2853 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2855 * Normally we wouldn't have to define this in the root "<html>"
2856 * element, but IE needs it there in some circumstances.
2858 * This is ignored if $wgMimeType is set to a non-XML mimetype.
2860 $wgXhtmlNamespaces = array();
2863 * Show IP address, for non-logged in users. It's necessary to switch this off
2864 * for some forms of caching.
2865 * @warning Will disable file cache.
2867 $wgShowIPinHeader = true;
2870 * Site notice shown at the top of each page
2872 * MediaWiki:Sitenotice page, which will override this. You can also
2873 * provide a separate message for logged-out users using the
2874 * MediaWiki:Anonnotice page.
2879 * A subtitle to add to the tagline, for skins that have it/
2881 $wgExtraSubtitle = '';
2884 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2886 $wgSiteSupportPage = '';
2889 * Validate the overall output using tidy and refuse
2890 * to display the page if it's not valid.
2892 $wgValidateAllHtml = false;
2895 * Default skin, for new users and anonymous visitors. Registered users may
2896 * change this to any one of the other available skins in their preferences.
2897 * This has to be completely lowercase; see the "skins" directory for the list
2898 * of available skins.
2900 $wgDefaultSkin = 'vector';
2903 * Specify the name of a skin that should not be presented in the list of
2904 * available skins. Use for blacklisting a skin which you do not want to
2905 * remove from the .../skins/ directory
2910 * Array for more like $wgSkipSkin.
2912 $wgSkipSkins = array();
2915 * Allow user Javascript page?
2916 * This enables a lot of neat customizations, but may
2917 * increase security risk to users and server load.
2919 $wgAllowUserJs = false;
2922 * Allow user Cascading Style Sheets (CSS)?
2923 * This enables a lot of neat customizations, but may
2924 * increase security risk to users and server load.
2926 $wgAllowUserCss = false;
2929 * Allow user-preferences implemented in CSS?
2930 * This allows users to customise the site appearance to a greater
2931 * degree; disabling it will improve page load times.
2933 $wgAllowUserCssPrefs = true;
2936 * Use the site's Javascript page?
2938 $wgUseSiteJs = true;
2941 * Use the site's Cascading Style Sheets (CSS)?
2943 $wgUseSiteCss = true;
2946 * Break out of framesets. This can be used to prevent clickjacking attacks,
2947 * or to prevent external sites from framing your site with ads.
2949 $wgBreakFrames = false;
2952 * The X-Frame-Options header to send on pages sensitive to clickjacking
2953 * attacks, such as edit pages. This prevents those pages from being displayed
2954 * in a frame or iframe. The options are:
2956 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2958 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
2959 * to allow framing within a trusted domain. This is insecure if there
2960 * is a page on the same domain which allows framing of arbitrary URLs.
2962 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
2963 * full compromise of local user accounts. Private wikis behind a
2964 * corporate firewall are especially vulnerable. This is not
2967 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
2968 * not just edit pages.
2970 $wgEditPageFrameOptions = 'DENY';
2973 * Disallow framing of API pages directly, by setting the X-Frame-Options
2974 * header. Since the API returns CSRF tokens, allowing the results to be
2975 * framed can compromise your user's account security.
2977 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2978 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
2979 * - false: Allow all framing.
2981 $wgApiFrameOptions = 'DENY';
2984 * Disable output compression (enabled by default if zlib is available)
2986 $wgDisableOutputCompression = false;
2989 * Should we allow a broader set of characters in id attributes, per HTML5? If
2990 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
2991 * functionality is ready, it will be on by default with no option.
2993 * Currently this appears to work fine in all browsers, but it's disabled by
2994 * default because it normalizes id's a bit too aggressively, breaking preexisting
2995 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
2997 $wgExperimentalHtmlIds = false;
3000 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3001 * You can add new icons to the built in copyright or poweredby, or you can create
3002 * a new block. Though note that you may need to add some custom css to get good styling
3003 * of new blocks in monobook. vector and modern should work without any special css.
3005 * $wgFooterIcons itself is a key/value array.
3006 * The key is the name of a block that the icons will be wrapped in. The final id varies
3007 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3008 * turns it into mw_poweredby.
3009 * The value is either key/value array of icons or a string.
3010 * In the key/value array the key may or may not be used by the skin but it can
3011 * be used to find the icon and unset it or change the icon if needed.
3012 * This is useful for disabling icons that are set by extensions.
3013 * The value should be either a string or an array. If it is a string it will be output
3014 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3015 * for the icon, the following keys are used:
3016 * - src: An absolute url to the image to use for the icon, this is recommended
3017 * but not required, however some skins will ignore icons without an image
3018 * - url: The url to use in the a element around the text or icon, if not set an a element will
3020 * - alt: This is the text form of the icon, it will be displayed without an image in
3021 * skins like Modern or if src is not set, and will otherwise be used as
3022 * the alt="" for the image. This key is required.
3023 * - width and height: If the icon specified by src is not of the standard size
3024 * you can specify the size of image to use with these keys.
3025 * Otherwise they will default to the standard 88x31.
3026 * @todo Reformat documentation.
3028 $wgFooterIcons = array(
3029 "copyright" => array(
3030 "copyright" => array(), // placeholder for the built in copyright icon
3032 "poweredby" => array(
3033 "mediawiki" => array(
3034 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
3035 "url" => "//www.mediawiki.org/",
3036 "alt" => "Powered by MediaWiki",
3042 * Login / create account link behavior when it's possible for anonymous users
3043 * to create an account.
3044 * - true = use a combined login / create account link
3045 * - false = split login and create account into two separate links
3047 $wgUseCombinedLoginLink = false;
3050 * Search form look for Vector skin only.
3051 * - true = use an icon search button
3052 * - false = use Go & Search buttons
3054 $wgVectorUseSimpleSearch = true;
3057 * Watch and unwatch as an icon rather than a link for Vector skin only.
3058 * - true = use an icon watch/unwatch button
3059 * - false = use watch/unwatch text link
3061 $wgVectorUseIconWatch = true;
3064 * Display user edit counts in various prominent places.
3066 $wgEdititis = false;
3069 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3070 * status code, mangling or hiding MediaWiki's output. If you are using such a
3071 * host, you should start looking for a better one. While you're doing that,
3072 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3073 * that the generated error pages can be seen.
3075 * In cases where for technical reasons it is more important for MediaWiki to
3076 * send the correct status code than for the body to be transmitted intact,
3077 * this configuration variable is ignored.
3079 $wgSend404Code = true;
3082 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3083 * rollback. The numeric value of the variable are the limit up to are counted.
3084 * If the value is false or 0, the edits are not counted. Disabling this will
3085 * furthermore prevent MediaWiki from hiding some useless rollback links.
3089 $wgShowRollbackEditCount = 10;
3092 * Output a <link rel="canonical"> tag on every page indicating the canonical
3093 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3094 * detection of the current server is unreliable, the link is sent
3097 $wgEnableCanonicalServerLink = false;
3099 /** @} */ # End of output format settings }
3101 /*************************************************************************//**
3102 * @name Resource loader settings
3107 * Client-side resource modules.
3109 * Extensions should add their resource loader module definitions
3110 * to the $wgResourceModules variable.
3114 * $wgResourceModules['ext.myExtension'] = array(
3115 * 'scripts' => 'myExtension.js',
3116 * 'styles' => 'myExtension.css',
3117 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3118 * 'localBasePath' => __DIR__,
3119 * 'remoteExtPath' => 'MyExtension',
3123 $wgResourceModules = array();
3126 * Extensions should register foreign module sources here. 'local' is a
3127 * built-in source that is not in this array, but defined by
3128 * ResourceLoader::__construct() so that it cannot be unset.
3132 * $wgResourceLoaderSources['foo'] = array(
3133 * 'loadScript' => 'http://example.org/w/load.php',
3134 * 'apiScript' => 'http://example.org/w/api.php'
3138 $wgResourceLoaderSources = array();
3141 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3142 * If not set, then $wgScriptPath will be used as a fallback.
3144 $wgResourceBasePath = null;
3147 * Maximum time in seconds to cache resources served by the resource loader.
3149 * @todo Document array structure
3151 $wgResourceLoaderMaxage = array(
3152 'versioned' => array(
3153 // Squid/Varnish but also any other public proxy cache between the client and MediaWiki
3154 'server' => 30 * 24 * 60 * 60, // 30 days
3155 // On the client side (e.g. in the browser cache).
3156 'client' => 30 * 24 * 60 * 60, // 30 days
3158 'unversioned' => array(
3159 'server' => 5 * 60, // 5 minutes
3160 'client' => 5 * 60, // 5 minutes
3165 * The default debug mode (on/off) for of ResourceLoader requests.
3167 * This will still be overridden when the debug URL parameter is used.
3169 $wgResourceLoaderDebug = false;
3172 * Enable embedding of certain resources using Edge Side Includes. This will
3173 * improve performance but only works if there is something in front of the
3174 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3176 $wgResourceLoaderUseESI = false;
3179 * Put each statement on its own line when minifying JavaScript. This makes
3180 * debugging in non-debug mode a bit easier.
3182 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3185 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3186 * the minifier will try not to produce lines longer than this, but may be
3187 * forced to do so in certain cases.
3189 $wgResourceLoaderMinifierMaxLineLength = 1000;
3192 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3195 $wgIncludeLegacyJavaScript = true;
3198 * Whether to preload the mediawiki.util module as blocking module in the top
3201 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3202 * allowed modules to lack dependencies on 'popular' modules that were likely
3205 * This setting is to aid scripts during migration by providing mediawiki.util
3206 * unconditionally (which was the most commonly missed dependency).
3207 * It doesn't cover all missing dependencies obviously but should fix most of
3210 * This should be removed at some point after site/user scripts have been fixed.
3211 * Enable this if your wiki has a large amount of user/site scripts that are
3212 * lacking dependencies.
3215 $wgPreloadJavaScriptMwUtil = false;
3218 * Whether or not to assign configuration variables to the global window object.
3220 * If this is set to false, old code using deprecated variables will no longer
3223 * @par Example of legacy code:
3225 * if ( window.wgRestrictionEdit ) { ... }
3229 * if ( wgIsArticle ) { ... }
3232 * Instead, one needs to use mw.config.
3233 * @par Example using mw.config global configuration:
3235 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3239 * if ( mw.config.get('wgIsArticle') ) { ... }
3242 $wgLegacyJavaScriptGlobals = true;
3245 * If set to a positive number, ResourceLoader will not generate URLs whose
3246 * query string is more than this many characters long, and will instead use
3247 * multiple requests with shorter query strings. This degrades performance,
3248 * but may be needed if your web server has a low (less than, say 1024)
3249 * query string length limit or a low value for suhosin.get.max_value_length
3250 * that you can't increase.
3252 * If set to a negative number, ResourceLoader will assume there is no query
3253 * string length limit.
3255 * Defaults to a value based on php configuration.
3257 $wgResourceLoaderMaxQueryLength = false;
3260 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3261 * prior to minification to validate it.
3263 * Parse errors will result in a JS exception being thrown during module load,
3264 * which avoids breaking other modules loaded in the same request.
3266 $wgResourceLoaderValidateJS = true;
3269 * If set to true, statically-sourced (file-backed) JavaScript resources will
3270 * be parsed for validity before being bundled up into ResourceLoader modules.
3272 * This can be helpful for development by providing better error messages in
3273 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3274 * and may fail on large pre-bundled frameworks.
3276 $wgResourceLoaderValidateStaticJS = false;
3279 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3280 * will be enabled. This is an experimental feature that's supposed to make
3281 * JavaScript load faster.
3283 $wgResourceLoaderExperimentalAsyncLoading = false;
3286 * Global LESS variables. An associative array binding variable names to CSS
3289 * Because the hashed contents of this array are used to construct the cache key
3290 * that ResourceLoader uses to look up LESS compilation results, updating this
3291 * array can be used to deliberately invalidate the set of cached results.
3295 * $wgResourceLoaderLESSVars = array(
3296 * 'baseFontSize' => '1em',
3297 * 'smallFontSize' => '0.75em',
3298 * 'WikimediaBlue' => '#006699',
3303 $wgResourceLoaderLESSVars = array();
3306 * Custom LESS functions. An associative array mapping function name to PHP
3309 * Changes to LESS functions do not trigger cache invalidation. If you update
3310 * the behavior of a LESS function and need to invalidate stale compilation
3311 * results, you can touch one of values in $wgResourceLoaderLESSVars, as
3316 $wgResourceLoaderLESSFunctions = array(
3317 'embeddable' => 'ResourceLoaderLESSFunctions::embeddable',
3318 'embed' => 'ResourceLoaderLESSFunctions::embed',
3322 * Default import paths for LESS modules. LESS files referenced in @import
3323 * statements will be looked up here first, and relative to the importing file
3324 * second. To avoid collisions, it's important for the LESS files in these
3325 * directories to have a common, predictable file name prefix.
3327 * Extensions need not (and should not) register paths in
3328 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3329 * currently compiling LESS file, which allows each extension to freely import
3330 * files from its own tree.
3334 $wgResourceLoaderLESSImportPaths = array(
3335 "$IP/resources/mediawiki.less/",
3336 "$IP/skins/vector/",
3340 * Whether ResourceLoader should attempt to persist modules in localStorage on
3341 * browsers that support the Web Storage API.
3343 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3345 $wgResourceLoaderStorageEnabled = false;
3348 * Cache version for client-side ResourceLoader module storage. You can trigger
3349 * invalidation of the contents of the module store by incrementing this value.
3353 $wgResourceLoaderStorageVersion = 1;
3355 /** @} */ # End of resource loader settings }
3357 /*************************************************************************//**
3358 * @name Page title and interwiki link settings
3363 * Name of the project namespace. If left set to false, $wgSitename will be
3366 $wgMetaNamespace = false;
3369 * Name of the project talk namespace.
3371 * Normally you can ignore this and it will be something like
3372 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3373 * manually for grammatical reasons.
3375 $wgMetaNamespaceTalk = false;
3378 * Additional namespaces. If the namespaces defined in Language.php and
3379 * Namespace.php are insufficient, you can create new ones here, for example,
3380 * to import Help files in other languages. You can also override the namespace
3381 * names of existing namespaces. Extensions developers should use
3382 * $wgCanonicalNamespaceNames.
3384 * @warning Once you delete a namespace, the pages in that namespace will
3385 * no longer be accessible. If you rename it, then you can access them through
3386 * the new namespace name.
3388 * Custom namespaces should start at 100 to avoid conflicting with standard
3389 * namespaces, and should always follow the even/odd main/talk pattern.
3393 * $wgExtraNamespaces = array(
3395 * 101 => "Hilfe_Diskussion",
3397 * 103 => "Discussion_Aide"
3401 * @todo Add a note about maintenance/namespaceDupes.php
3403 $wgExtraNamespaces = array();
3406 * Same as above, but for namespaces with gender distinction.
3407 * Note: the default form for the namespace should also be set
3408 * using $wgExtraNamespaces for the same index.
3411 $wgExtraGenderNamespaces = array();
3414 * Namespace aliases.
3416 * These are alternate names for the primary localised namespace names, which
3417 * are defined by $wgExtraNamespaces and the language file. If a page is
3418 * requested with such a prefix, the request will be redirected to the primary
3421 * Set this to a map from namespace names to IDs.
3425 * $wgNamespaceAliases = array(
3426 * 'Wikipedian' => NS_USER,
3431 $wgNamespaceAliases = array();
3434 * Allowed title characters -- regex character class
3435 * Don't change this unless you know what you're doing
3437 * Problematic punctuation:
3438 * - []{}|# Are needed for link syntax, never enable these
3439 * - <> Causes problems with HTML escaping, don't use
3440 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3441 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3442 * corrupted by apache
3443 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3445 * All three of these punctuation problems can be avoided by using an alias,
3446 * instead of a rewrite rule of either variety.
3448 * The problem with % is that when using a path to query rewrite rule, URLs are
3449 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3450 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3451 * for this, indeed double escaping would break if the double-escaped title was
3452 * passed in the query string rather than the path. This is a minor security issue
3453 * because articles can be created such that they are hard to view or edit.
3455 * In some rare cases you may wish to remove + for compatibility with old links.
3457 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3458 * this breaks interlanguage links
3460 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3463 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3465 $wgLocalInterwiki = false;
3468 * Expiry time for cache of interwiki table
3470 $wgInterwikiExpiry = 10800;
3473 * @name Interwiki caching settings.
3478 *$wgInterwikiCache specifies path to constant database file.
3480 * This cdb database is generated by dumpInterwiki from maintenance and has
3482 * - dbname:key - a simple key (e.g. enwiki:meta)
3483 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3484 * - __global:key - global-scope key (e.g. __global:meta)
3485 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3487 * Sites mapping just specifies site name, other keys provide "local url"
3490 $wgInterwikiCache = false;
3493 * Specify number of domains to check for messages.
3494 * - 1: Just wiki(db)-level
3495 * - 2: wiki and global levels
3498 $wgInterwikiScopes = 3;
3501 * Fallback site, if unable to resolve from cache
3503 $wgInterwikiFallbackSite = 'wiki';
3505 /** @} */ # end of Interwiki caching settings.
3508 * If local interwikis are set up which allow redirects,
3509 * set this regexp to restrict URLs which will be displayed
3510 * as 'redirected from' links.
3513 * It might look something like this:
3515 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3518 * Leave at false to avoid displaying any incoming redirect markers.
3519 * This does not affect intra-wiki redirects, which don't change
3522 $wgRedirectSources = false;
3525 * Set this to false to avoid forcing the first letter of links to capitals.
3527 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3528 * appearing with a capital at the beginning of a sentence will *not* go to the
3529 * same place as links in the middle of a sentence using a lowercase initial.
3531 $wgCapitalLinks = true;
3534 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3535 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3536 * true by default (and setting them has no effect), due to various things that
3537 * require them to be so. Also, since Talk namespaces need to directly mirror their
3538 * associated content namespaces, the values for those are ignored in favor of the
3539 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3544 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3547 $wgCapitalLinkOverrides = array();
3550 * Which namespaces should support subpages?
3551 * See Language.php for a list of namespaces.
3553 $wgNamespacesWithSubpages = array(
3556 NS_USER_TALK
=> true,
3558 NS_PROJECT_TALK
=> true,
3559 NS_FILE_TALK
=> true,
3560 NS_MEDIAWIKI
=> true,
3561 NS_MEDIAWIKI_TALK
=> true,
3562 NS_TEMPLATE_TALK
=> true,
3564 NS_HELP_TALK
=> true,
3565 NS_CATEGORY_TALK
=> true
3569 * Array of namespaces which can be deemed to contain valid "content", as far
3570 * as the site statistics are concerned. Useful if additional namespaces also
3571 * contain "content" which should be considered when generating a count of the
3572 * number of articles in the wiki.
3574 $wgContentNamespaces = array( NS_MAIN
);
3577 * Max number of redirects to follow when resolving redirects.
3578 * 1 means only the first redirect is followed (default behavior).
3579 * 0 or less means no redirects are followed.
3581 $wgMaxRedirects = 1;
3584 * Array of invalid page redirect targets.
3585 * Attempting to create a redirect to any of the pages in this array
3586 * will make the redirect fail.
3587 * Userlogout is hard-coded, so it does not need to be listed here.
3588 * (bug 10569) Disallow Mypage and Mytalk as well.
3590 * As of now, this only checks special pages. Redirects to pages in
3591 * other namespaces cannot be invalidated by this variable.
3593 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3595 /** @} */ # End of title and interwiki settings }
3597 /************************************************************************//**
3598 * @name Parser settings
3599 * These settings configure the transformation from wikitext to HTML.
3604 * Parser configuration. Associative array with the following members:
3606 * class The class name
3608 * preprocessorClass The preprocessor class. Two classes are currently available:
3609 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3610 * storage, and Preprocessor_DOM, which uses the DOM module for
3611 * temporary storage. Preprocessor_DOM generally uses less memory;
3612 * the speed of the two is roughly the same.
3614 * If this parameter is not given, it uses Preprocessor_DOM if the
3615 * DOM module is available, otherwise it uses Preprocessor_Hash.
3617 * The entire associative array will be passed through to the constructor as
3618 * the first parameter. Note that only Setup.php can use this variable --
3619 * the configuration will change at runtime via $wgParser member functions, so
3620 * the contents of this variable will be out-of-date. The variable can only be
3621 * changed during LocalSettings.php, in particular, it can't be changed during
3622 * an extension setup function.
3624 $wgParserConf = array(
3625 'class' => 'Parser',
3626 #'preprocessorClass' => 'Preprocessor_Hash',
3630 * Maximum indent level of toc.
3632 $wgMaxTocLevel = 999;
3635 * A complexity limit on template expansion: the maximum number of nodes visited
3636 * by PPFrame::expand()
3638 $wgMaxPPNodeCount = 1000000;
3641 * A complexity limit on template expansion: the maximum number of elements
3642 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3643 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3644 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3645 * this default corresponds to about 155 MB.
3647 * When the limit is exceeded, an exception is thrown.
3649 $wgMaxGeneratedPPNodeCount = 1000000;
3652 * Maximum recursion depth for templates within templates.
3653 * The current parser adds two levels to the PHP call stack for each template,
3654 * and xdebug limits the call stack to 100 by default. So this should hopefully
3655 * stop the parser before it hits the xdebug limit.
3657 $wgMaxTemplateDepth = 40;
3660 * @see $wgMaxTemplateDepth
3662 $wgMaxPPExpandDepth = 40;
3665 * The external URL protocols
3667 $wgUrlProtocols = array(
3671 'ftps://', // If we allow ftp:// we should allow the secure version.
3673 'sftp://', // SFTP > FTP
3675 'ircs://', // @bug 28503
3676 'xmpp:', // Another open communication protocol
3680 'telnet://', // Well if we're going to support the above.. -ævar
3681 'nntp://', // @bug 3808 RFC 1738
3684 'tel:', // If we can make emails linkable, why not phone numbers?
3685 'sms:', // Likewise this is standardized too
3690 'bitcoin:', // Even registerProtocolHandler whitelists this along with mailto:
3691 'magnet:', // No reason to reject torrents over magnet: when they're allowed over http://
3692 'urn:', // Allow URNs to be used in Microdata/RDFa <link ... href="urn:...">s
3693 'geo:', // urls define geo locations, they're useful in Microdata/RDFa and for coordinates
3694 '//', // for protocol-relative URLs
3698 * If true, removes (substitutes) templates in "~~~~" signatures.
3700 $wgCleanSignatures = true;
3703 * Whether to allow inline image pointing to other websites
3705 $wgAllowExternalImages = false;
3708 * If the above is false, you can specify an exception here. Image URLs
3709 * that start with this string are then rendered, while all others are not.
3710 * You can use this to set up a trusted, simple repository of images.
3711 * You may also specify an array of strings to allow multiple sites
3715 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3716 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3719 $wgAllowExternalImagesFrom = '';
3722 * If $wgAllowExternalImages is false, you can allow an on-wiki
3723 * whitelist of regular expression fragments to match the image URL
3724 * against. If the image matches one of the regular expression fragments,
3725 * The image will be displayed.
3727 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3728 * Or false to disable it
3730 $wgEnableImageWhitelist = true;
3733 * A different approach to the above: simply allow the "<img>" tag to be used.
3734 * This allows you to specify alt text and other attributes, copy-paste HTML to
3735 * your wiki more easily, etc. However, allowing external images in any manner
3736 * will allow anyone with editing rights to snoop on your visitors' IP
3737 * addresses and so forth, if they wanted to, by inserting links to images on
3738 * sites they control.
3740 $wgAllowImageTag = false;
3743 * $wgUseTidy: use tidy to make sure HTML output is sane.
3744 * Tidy is a free tool that fixes broken HTML.
3745 * See http://www.w3.org/People/Raggett/tidy/
3747 * - $wgTidyBin should be set to the path of the binary and
3748 * - $wgTidyConf to the path of the configuration file.
3749 * - $wgTidyOpts can include any number of parameters.
3750 * - $wgTidyInternal controls the use of the PECL extension or the
3751 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3752 * of spawning a separate program.
3753 * Normally you shouldn't need to override the setting except for
3754 * debugging. To install, use 'pear install tidy' and add a line
3755 * 'extension=tidy.so' to php.ini.
3762 $wgAlwaysUseTidy = false;
3767 $wgTidyBin = 'tidy';
3772 $wgTidyConf = $IP . '/includes/tidy.conf';
3782 $wgTidyInternal = extension_loaded( 'tidy' );
3785 * Put tidy warnings in HTML comments
3786 * Only works for internal tidy.
3788 $wgDebugTidy = false;
3791 * Allow raw, unchecked HTML in "<html>...</html>" sections.
3792 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3793 * TO RESTRICT EDITING to only those that you trust
3798 * Set a default target for external links, e.g. _blank to pop up a new window
3800 $wgExternalLinkTarget = false;
3803 * If true, external URL links in wiki text will be given the
3804 * rel="nofollow" attribute as a hint to search engines that
3805 * they should not be followed for ranking purposes as they
3806 * are user-supplied and thus subject to spamming.
3808 $wgNoFollowLinks = true;
3811 * Namespaces in which $wgNoFollowLinks doesn't apply.
3812 * See Language.php for a list of namespaces.
3814 $wgNoFollowNsExceptions = array();
3817 * If this is set to an array of domains, external links to these domain names
3818 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3819 * value of $wgNoFollowLinks. For instance:
3821 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
3822 * 'mediawiki.org' );
3824 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3825 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3828 * Defaults to mediawiki.org for the links included in the software by default.
3830 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
3833 * Allow DISPLAYTITLE to change title display
3835 $wgAllowDisplayTitle = true;
3838 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
3839 * canonical DB key. Also disallow some inline CSS rules like display: none;
3840 * which can cause the text to be hidden or unselectable.
3842 $wgRestrictDisplayTitle = true;
3845 * Maximum number of calls per parse to expensive parser functions such as
3848 $wgExpensiveParserFunctionLimit = 100;
3851 * Preprocessor caching threshold
3852 * Setting it to 'false' will disable the preprocessor cache.
3854 $wgPreprocessorCacheThreshold = 1000;
3857 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
3859 $wgEnableScaryTranscluding = false;
3862 * Expiry time for transcluded templates cached in transcache database table.
3863 * Only used $wgEnableInterwikiTranscluding is set to true.
3865 $wgTranscludeCacheExpiry = 3600;
3867 /** @} */ # end of parser settings }
3869 /************************************************************************//**
3875 * Method used to determine if a page in a content namespace should be counted
3876 * as a valid article.
3878 * Redirect pages will never be counted as valid articles.
3880 * This variable can have the following values:
3881 * - 'any': all pages as considered as valid articles
3882 * - 'comma': the page must contain a comma to be considered valid
3883 * - 'link': the page must contain a [[wiki link]] to be considered valid
3884 * - null: the value will be set at run time depending on $wgUseCommaCount:
3885 * if $wgUseCommaCount is false, it will be 'link', if it is true
3886 * it will be 'comma'
3888 * See also See http://www.mediawiki.org/wiki/Manual:Article_count
3890 * Retroactively changing this variable will not affect the existing count,
3891 * to update it, you will need to run the maintenance/updateArticleCount.php
3894 $wgArticleCountMethod = null;
3897 * Backward compatibility setting, will set $wgArticleCountMethod if it is null.
3898 * @deprecated since 1.18; use $wgArticleCountMethod instead
3900 $wgUseCommaCount = false;
3903 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
3904 * values are easier on the database. A value of 1 causes the counters to be
3905 * updated on every hit, any higher value n cause them to update *on average*
3906 * every n hits. Should be set to either 1 or something largish, eg 1000, for
3907 * maximum efficiency.
3909 $wgHitcounterUpdateFreq = 1;
3912 * How many days user must be idle before he is considered inactive. Will affect
3913 * the number shown on Special:Statistics, Special:ActiveUsers, and the
3914 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
3915 * You might want to leave this as the default value, to provide comparable
3916 * numbers between different wikis.
3918 $wgActiveUserDays = 30;
3920 /** @} */ # End of statistics }
3922 /************************************************************************//**
3923 * @name User accounts, authentication
3928 * For compatibility with old installations set to false
3930 $wgPasswordSalt = true;
3933 * Specifies the minimal length of a user password. If set to 0, empty pass-
3934 * words are allowed.
3936 $wgMinimalPasswordLength = 1;
3939 * Whether to allow password resets ("enter some identifying data, and we'll send an email
3940 * with a temporary password you can use to get back into the account") identified by
3941 * various bits of data. Setting all of these to false (or the whole variable to false)
3942 * has the effect of disabling password resets entirely
3944 $wgPasswordResetRoutes = array(
3950 * Maximum number of Unicode characters in signature
3952 $wgMaxSigChars = 255;
3955 * Maximum number of bytes in username. You want to run the maintenance
3956 * script ./maintenance/checkUsernames.php once you have changed this value.
3958 $wgMaxNameChars = 255;
3961 * Array of usernames which may not be registered or logged in from
3962 * Maintenance scripts can still use these
3964 $wgReservedUsernames = array(
3965 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
3966 'Conversion script', // Used for the old Wikipedia software upgrade
3967 'Maintenance script', // Maintenance scripts which perform editing, image import script
3968 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
3969 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
3970 'msg:double-redirect-fixer', // Automatic double redirect fix
3971 'msg:usermessage-editor', // Default user for leaving user messages
3972 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
3976 * Settings added to this array will override the default globals for the user
3977 * preferences used by anonymous visitors and newly created accounts.
3978 * For instance, to disable editing on double clicks:
3979 * $wgDefaultUserOptions ['editondblclick'] = 0;
3981 $wgDefaultUserOptions = array(
3982 'ccmeonemails' => 0,
3984 'date' => 'default',
3987 'editfont' => 'default',
3988 'editondblclick' => 0,
3989 'editsectiononrightclick' => 0,
3990 'enotifminoredits' => 0,
3991 'enotifrevealaddr' => 0,
3992 'enotifusertalkpages' => 1,
3993 'enotifwatchlistpages' => 1,
3994 'extendwatchlist' => 0,
3996 'forceeditsummary' => 0,
3997 'gender' => 'unknown',
3999 '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,
4018 'stubthreshold' => 0,
4021 'uselivepreview' => 0,
4023 'vector-simplesearch' => 1,
4024 'watchcreations' => 1,
4025 'watchdefault' => 1,
4026 'watchdeletion' => 0,
4027 'watchlistdays' => 3.0,
4028 'watchlisthideanons' => 0,
4029 'watchlisthidebots' => 0,
4030 'watchlisthideliu' => 0,
4031 'watchlisthideminor' => 0,
4032 'watchlisthideown' => 0,
4033 'watchlisthidepatrolled' => 0,
4036 'useeditwarning' => 1,
4037 'prefershttps' => 1,
4041 * An array of preferences to not show for the user
4043 $wgHiddenPrefs = array();
4046 * Characters to prevent during new account creations.
4047 * This is used in a regular expression character class during
4048 * registration (regex metacharacters like / are escaped).
4050 $wgInvalidUsernameCharacters = '@';
4053 * Character used as a delimiter when testing for interwiki userrights
4054 * (In Special:UserRights, it is possible to modify users on different
4055 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4057 * It is recommended that you have this delimiter in
4058 * $wgInvalidUsernameCharacters above, or you will not be able to
4059 * modify the user rights of those users via Special:UserRights
4061 $wgUserrightsInterwikiDelimiter = '@';
4064 * This is to let user authenticate using https when they come from http.
4065 * Based on an idea by George Herbert on wikitech-l:
4066 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4069 $wgSecureLogin = false;
4071 /** @} */ # end user accounts }
4073 /************************************************************************//**
4074 * @name User rights, access control and monitoring
4079 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4081 $wgAutoblockExpiry = 86400;
4084 * Set this to true to allow blocked users to edit their own user talk page.
4086 $wgBlockAllowsUTEdit = false;
4089 * Allow sysops to ban users from accessing Emailuser
4091 $wgSysopEmailBans = true;
4094 * Limits on the possible sizes of range blocks.
4096 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4097 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4098 * half the number of bits avoids such errors, and allows entire ISPs to be
4099 * blocked using a small number of range blocks.
4101 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4102 * customer, so range blocks larger than /64 (half the number of bits) will
4103 * plainly be required. RFC 4692 implies that a very large ISP may be
4104 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4105 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4107 $wgBlockCIDRLimit = array(
4108 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4113 * If true, blocked users will not be allowed to login. When using this with
4114 * a public wiki, the effect of logging out blocked users may actually be
4115 * avers: unless the user's address is also blocked (e.g. auto-block),
4116 * logging the user out will again allow reading and editing, just as for
4117 * anonymous visitors.
4119 $wgBlockDisablesLogin = false;
4122 * Pages anonymous user may see, set as an array of pages titles.
4126 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4129 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4131 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4132 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4134 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4135 * will remain readable. You can use img_auth.php to protect uploaded files,
4136 * see http://www.mediawiki.org/wiki/Manual:Image_Authorization
4138 $wgWhitelistRead = false;
4141 * Pages anonymous user may see, set as an array of regular expressions.
4143 * This function will match the regexp against the title name, which
4144 * is without underscore.
4147 * To whitelist [[Main Page]]:
4149 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4152 * @note Unless ^ and/or $ is specified, a regular expression might match
4153 * pages not intended to be whitelisted. The above example will also
4154 * whitelist a page named 'Security Main Page'.
4157 * To allow reading any page starting with 'User' regardless of the case:
4159 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4161 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4163 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4164 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4166 $wgWhitelistReadRegexp = false;
4169 * Should editors be required to have a validated e-mail
4170 * address before being allowed to edit?
4172 $wgEmailConfirmToEdit = false;
4175 * Permission keys given to users in each group.
4177 * This is an array where the keys are all groups and each value is an
4178 * array of the format (right => boolean).
4180 * The second format is used to support per-namespace permissions.
4181 * Note that this feature does not fully work for all permission types.
4183 * All users are implicitly in the '*' group including anonymous visitors;
4184 * logged-in users are all implicitly in the 'user' group. These will be
4185 * combined with the permissions of all groups that a given user is listed
4186 * in in the user_groups table.
4188 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4189 * doing! This will wipe all permissions, and may mean that your users are
4190 * unable to perform certain essential tasks or access new functionality
4191 * when new permissions are introduced and default grants established.
4193 * Functionality to make pages inaccessible has not been extensively tested
4194 * for security. Use at your own risk!
4196 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4198 $wgGroupPermissions = array();
4200 /** @cond file_level_code */
4201 // Implicit group for all visitors
4202 $wgGroupPermissions['*']['createaccount'] = true;
4203 $wgGroupPermissions['*']['read'] = true;
4204 $wgGroupPermissions['*']['edit'] = true;
4205 $wgGroupPermissions['*']['createpage'] = true;
4206 $wgGroupPermissions['*']['createtalk'] = true;
4207 $wgGroupPermissions['*']['writeapi'] = true;
4208 $wgGroupPermissions['*']['editmyusercss'] = true;
4209 $wgGroupPermissions['*']['editmyuserjs'] = true;
4210 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4211 $wgGroupPermissions['*']['editmywatchlist'] = true;
4212 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4213 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4214 $wgGroupPermissions['*']['editmyoptions'] = true;
4215 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4217 // Implicit group for all logged-in accounts
4218 $wgGroupPermissions['user']['move'] = true;
4219 $wgGroupPermissions['user']['move-subpages'] = true;
4220 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4221 $wgGroupPermissions['user']['movefile'] = true;
4222 $wgGroupPermissions['user']['read'] = true;
4223 $wgGroupPermissions['user']['edit'] = true;
4224 $wgGroupPermissions['user']['createpage'] = true;
4225 $wgGroupPermissions['user']['createtalk'] = true;
4226 $wgGroupPermissions['user']['writeapi'] = true;
4227 $wgGroupPermissions['user']['upload'] = true;
4228 $wgGroupPermissions['user']['reupload'] = true;
4229 $wgGroupPermissions['user']['reupload-shared'] = true;
4230 $wgGroupPermissions['user']['minoredit'] = true;
4231 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4232 $wgGroupPermissions['user']['sendemail'] = true;
4234 // Implicit group for accounts that pass $wgAutoConfirmAge
4235 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4236 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4238 // Users with bot privilege can have their edits hidden
4239 // from various log pages by default
4240 $wgGroupPermissions['bot']['bot'] = true;
4241 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4242 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4243 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4244 $wgGroupPermissions['bot']['autopatrol'] = true;
4245 $wgGroupPermissions['bot']['suppressredirect'] = true;
4246 $wgGroupPermissions['bot']['apihighlimits'] = true;
4247 $wgGroupPermissions['bot']['writeapi'] = true;
4249 // Most extra permission abilities go to this group
4250 $wgGroupPermissions['sysop']['block'] = true;
4251 $wgGroupPermissions['sysop']['createaccount'] = true;
4252 $wgGroupPermissions['sysop']['delete'] = true;
4253 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4254 $wgGroupPermissions['sysop']['bigdelete'] = true;
4255 // can view deleted history entries, but not see or restore the text
4256 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4257 // can view deleted revision text
4258 $wgGroupPermissions['sysop']['deletedtext'] = true;
4259 $wgGroupPermissions['sysop']['undelete'] = true;
4260 $wgGroupPermissions['sysop']['editinterface'] = true;
4261 $wgGroupPermissions['sysop']['editusercss'] = true;
4262 $wgGroupPermissions['sysop']['edituserjs'] = true;
4263 $wgGroupPermissions['sysop']['import'] = true;
4264 $wgGroupPermissions['sysop']['importupload'] = true;
4265 $wgGroupPermissions['sysop']['move'] = true;
4266 $wgGroupPermissions['sysop']['move-subpages'] = true;
4267 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4268 $wgGroupPermissions['sysop']['patrol'] = true;
4269 $wgGroupPermissions['sysop']['autopatrol'] = true;
4270 $wgGroupPermissions['sysop']['protect'] = true;
4271 $wgGroupPermissions['sysop']['editprotected'] = true;
4272 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4273 $wgGroupPermissions['sysop']['rollback'] = true;
4274 $wgGroupPermissions['sysop']['upload'] = true;
4275 $wgGroupPermissions['sysop']['reupload'] = true;
4276 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4277 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4278 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4279 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4280 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4281 $wgGroupPermissions['sysop']['blockemail'] = true;
4282 $wgGroupPermissions['sysop']['markbotedits'] = true;
4283 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4284 $wgGroupPermissions['sysop']['browsearchive'] = true;
4285 $wgGroupPermissions['sysop']['noratelimit'] = true;
4286 $wgGroupPermissions['sysop']['movefile'] = true;
4287 $wgGroupPermissions['sysop']['unblockself'] = true;
4288 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4289 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4290 #$wgGroupPermissions['sysop']['mergehistory'] = true;
4292 // Permission to change users' group assignments
4293 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4294 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4295 // Permission to change users' groups assignments across wikis
4296 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4297 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4298 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4300 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4301 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4302 // To hide usernames from users and Sysops
4303 #$wgGroupPermissions['suppress']['hideuser'] = true;
4304 // To hide revisions/log items from users and Sysops
4305 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4306 // For private suppression log access
4307 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4310 * The developer group is deprecated, but can be activated if need be
4311 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4312 * that a lock file be defined and creatable/removable by the web
4315 # $wgGroupPermissions['developer']['siteadmin'] = true;
4320 * Permission keys revoked from users in each group.
4322 * This acts the same way as wgGroupPermissions above, except that
4323 * if the user is in a group here, the permission will be removed from them.
4325 * Improperly setting this could mean that your users will be unable to perform
4326 * certain essential tasks, so use at your own risk!
4328 $wgRevokePermissions = array();
4331 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4333 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4336 * A map of group names that the user is in, to group names that those users
4337 * are allowed to add or revoke.
4339 * Setting the list of groups to add or revoke to true is equivalent to "any
4343 * To allow sysops to add themselves to the "bot" group:
4345 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4349 * Implicit groups may be used for the source group, for instance:
4351 * $wgGroupsRemoveFromSelf = array( '*' => true );
4353 * This allows users in the '*' group (i.e. any user) to remove themselves from
4354 * any group that they happen to be in.
4356 $wgGroupsAddToSelf = array();
4359 * @see $wgGroupsAddToSelf
4361 $wgGroupsRemoveFromSelf = array();
4364 * Set of available actions that can be restricted via action=protect
4365 * You probably shouldn't change this.
4366 * Translated through restriction-* messages.
4367 * Title::getRestrictionTypes() will remove restrictions that are not
4368 * applicable to a specific title (create and upload)
4370 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4373 * Rights which can be required for each protection level (via action=protect)
4375 * You can add a new protection level that requires a specific
4376 * permission by manipulating this array. The ordering of elements
4377 * dictates the order on the protection form's lists.
4379 * - '' will be ignored (i.e. unprotected)
4380 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4381 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4383 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4386 * Restriction levels that can be used with cascading protection
4388 * A page can only be protected with cascading protection if the
4389 * requested restriction level is included in this array.
4391 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4392 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4394 $wgCascadingRestrictionLevels = array( 'sysop' );
4397 * Restriction levels that should be considered "semiprotected"
4399 * Certain places in the interface recognize a dichotomy between "protected"
4400 * and "semiprotected", without further distinguishing the specific levels. In
4401 * general, if anyone can be eligible to edit a protection level merely by
4402 * reaching some condition in $wgAutopromote, it should probably be considered
4405 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4406 * 'sysop' is not changed, since it really shouldn't be here.
4408 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4411 * Set the minimum permissions required to edit pages in each
4412 * namespace. If you list more than one permission, a user must
4413 * have all of them to edit pages in that namespace.
4415 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4417 $wgNamespaceProtection = array();
4420 * Pages in namespaces in this array can not be used as templates.
4422 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4423 * namespaces constants (NS_USER, NS_MAIN...).
4425 * Among other things, this may be useful to enforce read-restrictions
4426 * which may otherwise be bypassed by using the template mechanism.
4428 $wgNonincludableNamespaces = array();
4431 * Number of seconds an account is required to age before it's given the
4432 * implicit 'autoconfirm' group membership. This can be used to limit
4433 * privileges of new accounts.
4435 * Accounts created by earlier versions of the software may not have a
4436 * recorded creation date, and will always be considered to pass the age test.
4438 * When left at 0, all registered accounts will pass.
4441 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4443 * $wgAutoConfirmAge = 600; // ten minutes
4445 * Set age to one day:
4447 * $wgAutoConfirmAge = 3600*24; // one day
4450 $wgAutoConfirmAge = 0;
4453 * Number of edits an account requires before it is autoconfirmed.
4454 * Passing both this AND the time requirement is needed. Example:
4458 * $wgAutoConfirmCount = 50;
4461 $wgAutoConfirmCount = 0;
4464 * Automatically add a usergroup to any user who matches certain conditions.
4466 * @todo Redocument $wgAutopromote
4469 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4470 * where cond1, cond2, ... are themselves conditions; *OR*
4471 * APCOND_EMAILCONFIRMED, *OR*
4472 * array( APCOND_EMAILCONFIRMED ), *OR*
4473 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4474 * array( APCOND_AGE, seconds since registration ), *OR*
4475 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4476 * array( APCOND_ISIP, ip ), *OR*
4477 * array( APCOND_IPINRANGE, range ), *OR*
4478 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4479 * array( APCOND_BLOCKED ), *OR*
4480 * array( APCOND_ISBOT ), *OR*
4481 * similar constructs defined by extensions.
4483 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4484 * user who has provided an e-mail address.
4486 $wgAutopromote = array(
4487 'autoconfirmed' => array( '&',
4488 array( APCOND_EDITCOUNT
, &$wgAutoConfirmCount ),
4489 array( APCOND_AGE
, &$wgAutoConfirmAge ),
4494 * Automatically add a usergroup to any user who matches certain conditions.
4496 * Does not add the user to the group again if it has been removed.
4497 * Also, does not remove the group if the user no longer meets the criteria.
4501 * array( event => criteria, ... )
4503 * Where event is either:
4504 * - 'onEdit' (when user edits)
4505 * - 'onView' (when user views the wiki)
4507 * Criteria has the same format as $wgAutopromote
4509 * @see $wgAutopromote
4512 $wgAutopromoteOnce = array(
4513 'onEdit' => array(),
4518 * Put user rights log entries for autopromotion in recent changes?
4521 $wgAutopromoteOnceLogInRC = true;
4524 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4525 * can assign which groups at Special:Userrights.
4528 * Bureaucrats can add any group:
4530 * $wgAddGroups['bureaucrat'] = true;
4532 * Bureaucrats can only remove bots and sysops:
4534 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4536 * Sysops can make bots:
4538 * $wgAddGroups['sysop'] = array( 'bot' );
4540 * Sysops can disable other sysops in an emergency, and disable bots:
4542 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4545 $wgAddGroups = array();
4550 $wgRemoveGroups = array();
4553 * A list of available rights, in addition to the ones defined by the core.
4554 * For extensions only.
4556 $wgAvailableRights = array();
4559 * Optional to restrict deletion of pages with higher revision counts
4560 * to users with the 'bigdelete' permission. (Default given to sysops.)
4562 $wgDeleteRevisionsLimit = 0;
4565 * The maximum number of edits a user can have and
4566 * can still be hidden by users with the hideuser permission.
4567 * This is limited for performance reason.
4568 * Set to false to disable the limit.
4571 $wgHideUserContribLimit = 1000;
4574 * Number of accounts each IP address may create, 0 to disable.
4576 * @warning Requires memcached
4578 $wgAccountCreationThrottle = 0;
4581 * Edits matching these regular expressions in body text
4582 * will be recognised as spam and rejected automatically.
4584 * There's no administrator override on-wiki, so be careful what you set. :)
4585 * May be an array of regexes or a single string for backwards compatibility.
4587 * @see http://en.wikipedia.org/wiki/Regular_expression
4589 * @note Each regex needs a beginning/end delimiter, eg: # or /
4591 $wgSpamRegex = array();
4594 * Same as the above except for edit summaries
4596 $wgSummarySpamRegex = array();
4599 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4603 $wgEnableDnsBlacklist = false;
4606 * @deprecated since 1.17 Use $wgEnableDnsBlacklist instead, only kept for
4607 * backward compatibility.
4609 $wgEnableSorbs = false;
4612 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4614 * This is an array of either a URL or an array with the URL and a key (should
4615 * the blacklist require a key).
4619 * $wgDnsBlacklistUrls = array(
4620 * // String containing URL
4621 * 'http.dnsbl.sorbs.net.',
4622 * // Array with URL and key, for services that require a key
4623 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4624 * // Array with just the URL. While this works, it is recommended that you
4625 * // just use a string as shown above
4626 * array( 'opm.tornevall.org.' )
4630 * @note You should end the domain name with a . to avoid searching your
4631 * eventual domain search suffixes.
4634 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4637 * @deprecated since 1.17 Use $wgDnsBlacklistUrls instead, only kept for
4638 * backward compatibility.
4640 $wgSorbsUrl = array();
4643 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4644 * what the other methods might say.
4646 $wgProxyWhitelist = array();
4649 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4650 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4651 * (transparent) proxies without needing to block the proxies themselves.
4653 $wgApplyIpBlocksToXff = false;
4656 * Simple rate limiter options to brake edit floods.
4658 * Maximum number actions allowed in the given number of seconds; after that
4659 * the violating client receives HTTP 500 error pages until the period
4663 * To set a generic maximum of 4 hits in 60 seconds:
4665 * $wgRateLimits = array( 4, 60 );
4668 * You could also limit per action and then type of users. See the inline
4669 * code for a template to use.
4671 * This option set is experimental and likely to change.
4673 * @warning Requires memcached.
4675 $wgRateLimits = array(
4677 'anon' => null, // for any and all anonymous edits (aggregate)
4678 'user' => null, // for each logged-in user
4679 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4680 'ip' => null, // for each anon and recent account
4681 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4689 'mailpassword' => array( // triggering password resets emails
4692 'emailuser' => array( // emailing other users using MediaWiki
4695 'linkpurge' => array( // purges of link tables
4702 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4712 * Set to a filename to log rate limiter hits.
4714 $wgRateLimitLog = null;
4717 * Array of IPs which should be excluded from rate limits.
4718 * This may be useful for whitelisting NAT gateways for conferences, etc.
4720 $wgRateLimitsExcludedIPs = array();
4723 * Log IP addresses in the recentchanges table; can be accessed only by
4724 * extensions (e.g. CheckUser) or a DB admin
4725 * Used for retroactive autoblocks
4727 $wgPutIPinRC = true;
4730 * Integer defining default number of entries to show on
4731 * special pages which are query-pages such as Special:Whatlinkshere.
4733 $wgQueryPageDefaultLimit = 50;
4736 * Limit password attempts to X attempts per Y seconds per IP per account.
4738 * @warning Requires memcached.
4740 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4742 /** @} */ # end of user rights settings
4744 /************************************************************************//**
4745 * @name Proxy scanner settings
4750 * This should always be customised in LocalSettings.php
4752 $wgSecretKey = false;
4755 * Big list of banned IP addresses.
4757 * This can have the following formats:
4758 * - An array of addresses, either in the values
4759 * or the keys (for backward compatibility)
4760 * - A string, in that case this is the path to a file
4761 * containing the list of IP addresses, one per line
4763 $wgProxyList = array();
4766 * @deprecated since 1.14
4768 $wgProxyKey = false;
4770 /** @} */ # end of proxy scanner settings
4772 /************************************************************************//**
4773 * @name Cookie settings
4778 * Default cookie expiration time. Setting to 0 makes all cookies session-only.
4780 $wgCookieExpiration = 180 * 86400;
4783 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
4784 * or ".any.subdomain.net"
4786 $wgCookieDomain = '';
4789 * Set this variable if you want to restrict cookies to a certain path within
4790 * the domain specified by $wgCookieDomain.
4792 $wgCookiePath = '/';
4795 * Whether the "secure" flag should be set on the cookie. This can be:
4796 * - true: Set secure flag
4797 * - false: Don't set secure flag
4798 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
4800 $wgCookieSecure = 'detect';
4803 * By default, MediaWiki checks if the client supports cookies during the
4804 * login process, so that it can display an informative error message if
4805 * cookies are disabled. Set this to true if you want to disable this cookie
4808 $wgDisableCookieCheck = false;
4811 * Cookies generated by MediaWiki have names starting with this prefix. Set it
4812 * to a string to use a custom prefix. Setting it to false causes the database
4813 * name to be used as a prefix.
4815 $wgCookiePrefix = false;
4818 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
4819 * in browsers that support this feature. This can mitigates some classes of
4822 $wgCookieHttpOnly = true;
4825 * If the requesting browser matches a regex in this blacklist, we won't
4826 * send it cookies with HttpOnly mode, even if $wgCookieHttpOnly is on.
4828 $wgHttpOnlyBlacklist = array(
4829 // Internet Explorer for Mac; sometimes the cookies work, sometimes
4830 // they don't. It's difficult to predict, as combinations of path
4831 // and expiration options affect its parsing.
4832 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
4836 * A list of cookies that vary the cache (for use by extensions)
4838 $wgCacheVaryCookies = array();
4841 * Override to customise the session name
4843 $wgSessionName = false;
4845 /** @} */ # end of cookie settings }
4847 /************************************************************************//**
4848 * @name LaTeX (mathematical formulas)
4853 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
4854 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
4855 * (ImageMagick) installed and available in the PATH.
4856 * Please see math/README for more information.
4860 /** @} */ # end LaTeX }
4862 /************************************************************************//**
4863 * @name Profiling, testing and debugging
4865 * To enable profiling, edit StartProfiler.php
4871 * Filename for debug logging. See http://www.mediawiki.org/wiki/How_to_debug
4872 * The debug log file should be not be publicly accessible if it is used, as it
4873 * may contain private data.
4875 $wgDebugLogFile = '';
4878 * Prefix for debug log lines
4880 $wgDebugLogPrefix = '';
4883 * If true, instead of redirecting, show a page with a link to the redirect
4884 * destination. This allows for the inspection of PHP error messages, and easy
4885 * resubmission of form data. For developer use only.
4887 $wgDebugRedirects = false;
4890 * If true, log debugging data from action=raw and load.php.
4891 * This is normally false to avoid overlapping debug entries due to gen=css
4892 * and gen=js requests.
4894 $wgDebugRawPage = false;
4897 * Send debug data to an HTML comment in the output.
4899 * This may occasionally be useful when supporting a non-technical end-user.
4900 * It's more secure than exposing the debug log file to the web, since the
4901 * output only contains private data for the current user. But it's not ideal
4902 * for development use since data is lost on fatal errors and redirects.
4904 $wgDebugComments = false;
4907 * Extensive database transaction state debugging
4911 $wgDebugDBTransactions = false;
4914 * Write SQL queries to the debug log
4916 $wgDebugDumpSql = false;
4919 * Map of string log group names to log destinations.
4921 * If set, wfDebugLog() output for that group will go to that file instead
4922 * of the regular $wgDebugLogFile. Useful for enabling selective logging
4925 * Log destinations may be string values specifying a filename or URI, or they
4926 * may be filename or an associative array mapping 'destination' to the desired
4927 * filename. The associative array may also contain a 'sample' key with an
4928 * integer value, specifying a sampling factor.
4932 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
4935 * @par Advanced example:
4937 * $wgDebugLogGroups['memcached'] = (
4938 * 'destination' => '/var/log/mediawiki/memcached.log',
4939 * 'sample' => 1000, // log 1 message out of every 1,000.
4943 $wgDebugLogGroups = array();
4946 * Display debug data at the bottom of the main content area.
4948 * Useful for developers and technical users trying to working on a closed wiki.
4950 $wgShowDebug = false;
4953 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
4954 * Since 1.19 also includes memory usage.
4956 $wgDebugTimestamps = false;
4959 * Print HTTP headers for every request in the debug information.
4961 $wgDebugPrintHttpHeaders = true;
4964 * Show the contents of $wgHooks in Special:Version
4966 $wgSpecialVersionShowHooks = false;
4969 * Whether to show "we're sorry, but there has been a database error" pages.
4970 * Displaying errors aids in debugging, but may display information useful
4973 $wgShowSQLErrors = false;
4976 * If set to true, uncaught exceptions will print a complete stack trace
4977 * to output. This should only be used for debugging, as it may reveal
4978 * private information in function parameters due to PHP's backtrace
4981 $wgShowExceptionDetails = false;
4984 * If true, show a backtrace for database errors
4986 $wgShowDBErrorBacktrace = false;
4989 * If true, send the exception backtrace to the error log
4991 $wgLogExceptionBacktrace = true;
4994 * Expose backend server host names through the API and various HTML comments
4996 $wgShowHostnames = false;
4999 * Override server hostname detection with a hardcoded value.
5000 * Should be a string, default false.
5003 $wgOverrideHostname = false;
5006 * If set to true MediaWiki will throw notices for some possible error
5007 * conditions and for deprecated functions.
5009 $wgDevelopmentWarnings = false;
5012 * Release limitation to wfDeprecated warnings, if set to a release number
5013 * development warnings will not be generated for deprecations added in releases
5016 $wgDeprecationReleaseLimit = false;
5019 * Only record profiling info for pages that took longer than this
5021 $wgProfileLimit = 0.0;
5024 * Don't put non-profiling info into log file
5026 $wgProfileOnly = false;
5029 * Log sums from profiling into "profiling" table in db.
5031 * You have to create a 'profiling' table in your database before using
5032 * this feature. Run set $wgProfileToDatabase to true in
5033 * LocalSettings.php and run maintenance/update.php or otherwise
5034 * manually add patch-profiling.sql to your database.
5036 * To enable profiling, edit StartProfiler.php
5038 $wgProfileToDatabase = false;
5041 * If true, print a raw call tree instead of per-function report
5043 $wgProfileCallTree = false;
5046 * Should application server host be put into profiling table
5048 $wgProfilePerHost = false;
5051 * Host for UDP profiler.
5053 * The host should be running a daemon which can be obtained from MediaWiki
5055 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5057 $wgUDPProfilerHost = '127.0.0.1';
5060 * Port for UDP profiler.
5061 * @see $wgUDPProfilerHost
5063 $wgUDPProfilerPort = '3811';
5066 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5067 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name) as arguments.
5068 * You can use sprintf's argument numbering/swapping capability to repeat,
5069 * re-order or omit fields.
5071 * @see $wgStatsFormatString
5074 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5077 * Detects non-matching wfProfileIn/wfProfileOut calls
5079 $wgDebugProfiling = false;
5082 * Output debug message on every wfProfileIn/wfProfileOut
5084 $wgDebugFunctionEntry = false;
5087 * Destination for wfIncrStats() data...
5088 * 'cache' to go into the system cache, if enabled (memcached)
5089 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5092 $wgStatsMethod = 'cache';
5095 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5096 * be aggregated over more than one wiki. The string will be used in place of
5097 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5100 $wgAggregateStatsID = false;
5103 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5104 * formatted. Its value should be a format string suitable for a sprintf()
5105 * invocation with (id, count, key) arguments, where 'id' is either
5106 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5107 * is being incremented, and 'key' is the metric name.
5109 * @see $wgUDPProfilerFormatString
5110 * @see $wgAggregateStatsID
5113 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5116 * Whereas to count the number of time an article is viewed.
5117 * Does not work if pages are cached (for example with squid).
5119 $wgDisableCounters = false;
5122 * InfoAction retrieves a list of transclusion links (both to and from).
5123 * This number puts a limit on that query in the case of highly transcluded
5126 $wgPageInfoTransclusionLimit = 50;
5129 * Set this to an integer to only do synchronous site_stats updates
5130 * one every *this many* updates. The other requests go into pending
5131 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5132 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5134 $wgSiteStatsAsyncFactor = false;
5137 * Parser test suite files to be run by parserTests.php when no specific
5138 * filename is passed to it.
5140 * Extensions may add their own tests to this array, or site-local tests
5141 * may be added via LocalSettings.php
5145 $wgParserTestFiles = array(
5146 "$IP/tests/parser/parserTests.txt",
5147 "$IP/tests/parser/extraParserTests.txt"
5151 * If configured, specifies target CodeReview installation to send test
5152 * result data from 'parserTests.php --upload'
5154 * Something like this:
5155 * $wgParserTestRemote = array(
5156 * 'api-url' => 'http://www.mediawiki.org/w/api.php',
5157 * 'repo' => 'MediaWiki',
5158 * 'suite' => 'ParserTests',
5159 * 'path' => '/trunk/phase3', // not used client-side; for reference
5160 * 'secret' => 'qmoicj3mc4mcklmqw', // Shared secret used in HMAC validation
5163 $wgParserTestRemote = false;
5166 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5168 $wgEnableJavaScriptTest = false;
5171 * Configuration for javascript testing.
5173 $wgJavaScriptTestConfig = array(
5175 // Page where documentation can be found relevant to the QUnit test suite being ran.
5176 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5177 // documentation link in the "javascripttest-qunit-intro" message.
5178 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5179 // If you are submitting the QUnit test suite to a TestSwarm instance,
5180 // point this to the "inject.js" script of that instance. This is was registers
5181 // the QUnit hooks to extract the test results and push them back up into the
5182 // TestSwarm database.
5183 // @example 'http://localhost/testswarm/js/inject.js'
5184 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5185 'testswarm-injectjs' => false,
5190 * Overwrite the caching key prefix with custom value.
5193 $wgCachePrefix = false;
5196 * Display the new debugging toolbar. This also enables profiling on database
5197 * queries and other useful output.
5198 * Will disable file cache.
5202 $wgDebugToolbar = false;
5204 /** @} */ # end of profiling, testing and debugging }
5206 /************************************************************************//**
5212 * Set this to true to disable the full text search feature.
5214 $wgDisableTextSearch = false;
5217 * Set to true to have nicer highlighted text in search results,
5218 * by default off due to execution overhead
5220 $wgAdvancedSearchHighlighting = false;
5223 * Regexp to match word boundaries, defaults for non-CJK languages
5224 * should be empty for CJK since the words are not separate
5226 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5229 * Set to true to have the search engine count total
5230 * search matches to present in the Special:Search UI.
5231 * Not supported by every search engine shipped with MW.
5233 * This could however be slow on larger wikis, and is pretty flaky
5234 * with the current title vs content split. Recommend avoiding until
5235 * that's been worked out cleanly; but this may aid in testing the
5236 * search UI and API to confirm that the result count works.
5238 $wgCountTotalSearchHits = false;
5241 * Template for OpenSearch suggestions, defaults to API action=opensearch
5243 * Sites with heavy load would typically have these point to a custom
5244 * PHP wrapper to avoid firing up mediawiki for every keystroke
5246 * Placeholders: {searchTerms}
5248 $wgOpenSearchTemplate = false;
5251 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5252 * false if you've disabled scripts that use api?action=opensearch and
5253 * want reduce load caused by cached scripts still pulling suggestions.
5254 * It will let the API fallback by responding with an empty array.
5256 $wgEnableOpenSearchSuggest = true;
5259 * Integer defining default number of entries to show on
5262 $wgOpenSearchDefaultLimit = 10;
5265 * Expiry time for search suggestion responses
5267 $wgSearchSuggestCacheExpiry = 1200;
5270 * If you've disabled search semi-permanently, this also disables updates to the
5271 * table. If you ever re-enable, be sure to rebuild the search table.
5273 $wgDisableSearchUpdate = false;
5276 * List of namespaces which are searched by default.
5280 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5281 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5284 $wgNamespacesToBeSearchedDefault = array(
5289 * Namespaces to be searched when user clicks the "Help" tab
5290 * on Special:Search.
5292 * Same format as $wgNamespacesToBeSearchedDefault.
5294 $wgNamespacesToBeSearchedHelp = array(
5300 * If set to true the 'searcheverything' preference will be effective only for
5302 * Useful for big wikis to maintain different search profiles for anonymous and
5305 $wgSearchEverythingOnlyLoggedIn = false;
5308 * Disable the internal MySQL-based search, to allow it to be
5309 * implemented by an extension instead.
5311 $wgDisableInternalSearch = false;
5314 * Set this to a URL to forward search requests to some external location.
5315 * If the URL includes '$1', this will be replaced with the URL-encoded
5319 * To forward to Google you'd have something like:
5321 * $wgSearchForwardUrl =
5322 * 'http://www.google.com/search?q=$1' .
5323 * '&domains=http://example.com' .
5324 * '&sitesearch=http://example.com' .
5325 * '&ie=utf-8&oe=utf-8';
5328 $wgSearchForwardUrl = null;
5331 * Search form behavior.
5332 * - true = use Go & Search buttons
5333 * - false = use Go button & Advanced search link
5335 $wgUseTwoButtonsSearchForm = true;
5338 * Array of namespaces to generate a Google sitemap for when the
5339 * maintenance/generateSitemap.php script is run, or false if one is to be
5340 * generated for all namespaces.
5342 $wgSitemapNamespaces = false;
5345 * Custom namespace priorities for sitemaps. Setting this will allow you to
5346 * set custom priorities to namespaces when sitemaps are generated using the
5347 * maintenance/generateSitemap.php script.
5349 * This should be a map of namespace IDs to priority
5352 * $wgSitemapNamespacesPriorities = array(
5358 $wgSitemapNamespacesPriorities = false;
5361 * If true, searches for IP addresses will be redirected to that IP's
5362 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5363 * [[Special:Contributions/1.2.3.4]]
5365 $wgEnableSearchContributorsByIP = true;
5367 /** @} */ # end of search settings
5369 /************************************************************************//**
5370 * @name Edit user interface
5375 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5376 * fall back to the old behavior (no merging).
5378 $wgDiff3 = '/usr/bin/diff3';
5381 * Path to the GNU diff utility.
5383 $wgDiff = '/usr/bin/diff';
5386 * Which namespaces have special treatment where they should be preview-on-open
5387 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5388 * can specify namespaces of pages they have special treatment for
5390 $wgPreviewOnOpenNamespaces = array(
5395 * Go button goes straight to the edit screen if the article doesn't exist.
5397 $wgGoToEdit = false;
5400 * Enable the UniversalEditButton for browsers that support it
5401 * (currently only Firefox with an extension)
5402 * See http://universaleditbutton.org for more background information
5404 $wgUniversalEditButton = true;
5407 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5408 * will try to automatically create one. This feature can be disabled by set-
5409 * ting this variable false.
5411 $wgUseAutomaticEditSummaries = true;
5413 /** @} */ # end edit UI }
5415 /************************************************************************//**
5417 * See also $wgSiteNotice
5422 * @cond file_level_code
5423 * Set $wgCommandLineMode if it's not set already, to avoid notices
5425 if ( !isset( $wgCommandLineMode ) ) {
5426 $wgCommandLineMode = false;
5431 * For colorized maintenance script output, is your terminal background dark ?
5433 $wgCommandLineDarkBg = false;
5436 * Set this to a string to put the wiki into read-only mode. The text will be
5437 * used as an explanation to users.
5439 * This prevents most write operations via the web interface. Cache updates may
5440 * still be possible. To prevent database writes completely, use the read_only
5446 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5447 * Its contents will be shown to users as part of the read-only warning
5450 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5452 $wgReadOnlyFile = false;
5455 * When you run the web-based upgrade utility, it will tell you what to set
5456 * this to in order to authorize the upgrade process. It will subsequently be
5457 * used as a password, to authorize further upgrades.
5459 * For security, do not set this to a guessable string. Use the value supplied
5460 * by the install/upgrade process. To cause the upgrader to generate a new key,
5461 * delete the old key from LocalSettings.php.
5463 $wgUpgradeKey = false;
5466 * Fully specified path to git binary
5468 $wgGitBin = '/usr/bin/git';
5471 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5473 * Key is a pattern passed to preg_match() and preg_replace(),
5474 * without the delimiters (which are #) and must match the whole URL.
5475 * The value is the replacement for the key (it can contain $1, etc.)
5476 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5477 * full SHA-1 of the HEAD revision.
5478 * %r will be replaced with a URL-encoded version of $1.
5482 $wgGitRepositoryViewers = array(
5483 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' => 'https://git.wikimedia.org/commit/%r/%H',
5484 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)'
5485 => 'https://git.wikimedia.org/commit/%r/%H',
5488 /** @} */ # End of maintenance }
5490 /************************************************************************//**
5491 * @name Recent changes, new pages, watchlist and history
5496 * Recentchanges items are periodically purged; entries older than this many
5498 * Default: 13 weeks = about three months
5500 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5503 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5504 * higher than what will be stored. Note that this is disabled by default
5505 * because we sometimes do have RC data which is beyond the limit for some
5506 * reason, and some users may use the high numbers to display that data which
5509 $wgRCFilterByAge = false;
5512 * List of Limits options to list in the Special:Recentchanges and
5513 * Special:Recentchangeslinked pages.
5515 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5518 * List of Days options to list in the Special:Recentchanges and
5519 * Special:Recentchangeslinked pages.
5521 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5524 * Send recent changes updates via UDP. The updates will be formatted for IRC.
5525 * Set this to the IP address of the receiver.
5527 * @deprecated since 1.22, use $wgRCFeeds
5529 $wgRC2UDPAddress = false;
5532 * Port number for RC updates
5534 * @deprecated since 1.22, use $wgRCFeeds
5536 $wgRC2UDPPort = false;
5539 * Prefix to prepend to each UDP packet.
5540 * This can be used to identify the wiki. A script is available called
5541 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
5542 * tab to identify the IRC channel to send the log line to.
5544 * @deprecated since 1.22, use $wgRCFeeds
5546 $wgRC2UDPPrefix = '';
5549 * If this is set to true, $wgLocalInterwiki will be prepended to links in the
5550 * IRC feed. If this is set to a string, that string will be used as the prefix.
5552 * @deprecated since 1.22, use $wgRCFeeds
5554 $wgRC2UDPInterwikiPrefix = false;
5557 * Set to true to omit "bot" edits (by users with the bot permission) from the
5560 * @deprecated since 1.22, use $wgRCFeeds
5562 $wgRC2UDPOmitBots = false;
5565 * Destinations to which notifications about recent changes
5568 * As of MediaWiki 1.22, the only supported 'engine' parameter option in core
5569 * is 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5571 * The common options are:
5572 * * 'uri' -- the address to which the notices are to be sent.
5573 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5574 * produce the text to send.
5575 * * 'omit_bots' -- whether the bot edits should be in the feed
5576 * The IRC-specific options are:
5577 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5578 * $wgLocalInterwiki.
5579 * The JSON-specific options are:
5580 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5582 * To ensure backwards-compatability, whenever $wgRC2UDPAddress is set, a
5583 * 'default' feed will be created reusing the deprecated $wgRC2UDP* variables.
5585 * @example $wgRCFeeds['example'] = array(
5586 * 'formatter' => 'JSONRCFeedFormatter',
5587 * 'uri' => "udp://localhost:1336",
5588 * 'add_interwiki_prefix' => false,
5589 * 'omit_bots' => true,
5591 * @example $wgRCFeeds['exampleirc'] = array(
5592 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5593 * 'uri' => "udp://localhost:1338",
5594 * 'add_interwiki_prefix' => false,
5595 * 'omit_bots' => true,
5599 $wgRCFeeds = array();
5602 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5603 * Keys are scheme names, values are names of engine classes.
5605 $wgRCEngines = array(
5606 'redis' => 'RedisPubSubFeedEngine',
5607 'udp' => 'UDPRCFeedEngine',
5611 * Enable user search in Special:Newpages
5612 * This is really a temporary hack around an index install bug on some Wikipedias.
5613 * Kill it once fixed.
5615 $wgEnableNewpagesUserFilter = true;
5618 * Use RC Patrolling to check for vandalism
5620 $wgUseRCPatrol = true;
5623 * Use new page patrolling to check new pages on Special:Newpages
5625 $wgUseNPPatrol = true;
5628 * Log autopatrol actions to the log table
5630 $wgLogAutopatrol = true;
5633 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5638 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5639 * eg Recentchanges, Newpages.
5644 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5645 * A cached version will continue to be served out even if changes
5646 * are made, until this many seconds runs out since the last render.
5648 * If set to 0, feed caching is disabled. Use this for debugging only;
5649 * feed generation can be pretty slow with diffs.
5651 $wgFeedCacheTimeout = 60;
5654 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5655 * pages larger than this size.
5657 $wgFeedDiffCutoff = 32768;
5660 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5661 * every page. Some sites might have a different feed they'd like to promote
5662 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5663 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5666 * Configure the 'atom' feed to http://example.com/somefeed.xml
5668 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5671 $wgOverrideSiteFeed = array();
5674 * Available feeds objects.
5675 * Should probably only be defined when a page is syndicated ie when
5676 * $wgOut->isSyndicated() is true.
5678 $wgFeedClasses = array(
5680 'atom' => 'AtomFeed',
5684 * Which feed types should we provide by default? This can include 'rss',
5685 * 'atom', neither, or both.
5687 $wgAdvertisedFeedTypes = array( 'atom' );
5690 * Show watching users in recent changes, watchlist and page history views
5692 $wgRCShowWatchingUsers = false; # UPO
5695 * Show watching users in Page views
5697 $wgPageShowWatchingUsers = false;
5700 * Show the amount of changed characters in recent changes
5702 $wgRCShowChangedSize = true;
5705 * If the difference between the character counts of the text
5706 * before and after the edit is below that value, the value will be
5707 * highlighted on the RC page.
5709 $wgRCChangedSizeThreshold = 500;
5712 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5713 * view for watched pages with new changes
5715 $wgShowUpdatedMarker = true;
5718 * Disable links to talk pages of anonymous users (IPs) in listings on special
5719 * pages like page history, Special:Recentchanges, etc.
5721 $wgDisableAnonTalk = false;
5724 * Enable filtering of categories in Recentchanges
5726 $wgAllowCategorizedRecentChanges = false;
5729 * Allow filtering by change tag in recentchanges, history, etc
5730 * Has no effect if no tags are defined in valid_tag.
5732 $wgUseTagFilter = true;
5735 * If set to an integer, pages that are watched by this many users or more
5736 * will not require the unwatchedpages permission to view the number of
5741 $wgUnwatchedPageThreshold = false;
5744 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5745 * certain types of edits.
5747 * To register a new one:
5749 * $wgRecentChangesFlags['flag'] => array(
5750 * 'letter' => 'letter-msg',
5751 * 'title' => 'tooltip-msg'
5755 * Optional 'class' allows to set a css class different than the flag name.
5759 $wgRecentChangesFlags = array(
5760 'newpage' => array( 'letter' => 'newpageletter',
5761 'title' => 'recentchanges-label-newpage' ),
5762 'minor' => array( 'letter' => 'minoreditletter',
5763 'title' => 'recentchanges-label-minor', 'class' => 'minoredit' ),
5764 'bot' => array( 'letter' => 'boteditletter',
5765 'title' => 'recentchanges-label-bot', 'class' => 'botedit' ),
5766 'unpatrolled' => array( 'letter' => 'unpatrolledletter',
5767 'title' => 'recentchanges-label-unpatrolled' ),
5770 /** @} */ # end RC/watchlist }
5772 /************************************************************************//**
5773 * @name Copyright and credits settings
5778 * Override for copyright metadata.
5780 * This is the name of the page containing information about the wiki's copyright status,
5781 * which will be added as a link in the footer if it is specified. It overrides
5782 * $wgRightsUrl if both are specified.
5784 $wgRightsPage = null;
5787 * Set this to specify an external URL containing details about the content license used on your
5789 * If $wgRightsPage is set then this setting is ignored.
5791 $wgRightsUrl = null;
5794 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5796 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5797 * of the page will also be used as the link if this variable is not set.
5799 $wgRightsText = null;
5802 * Override for copyright metadata.
5804 $wgRightsIcon = null;
5807 * Set to an array of metadata terms. Else they will be loaded based on $wgRightsUrl
5809 $wgLicenseTerms = false;
5812 * Set this to some HTML to override the rights icon with an arbitrary logo
5813 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5815 $wgCopyrightIcon = null;
5818 * Set this to true if you want detailed copyright information forms on Upload.
5820 $wgUseCopyrightUpload = false;
5823 * Set this to the number of authors that you want to be credited below an
5824 * article text. Set it to zero to hide the attribution block, and a negative
5825 * number (like -1) to show all authors. Note that this will require 2-3 extra
5826 * database hits, which can have a not insignificant impact on performance for
5832 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5833 * Otherwise, link to a separate credits page.
5835 $wgShowCreditsIfMax = true;
5837 /** @} */ # end of copyright and credits settings }
5839 /************************************************************************//**
5840 * @name Import / Export
5845 * List of interwiki prefixes for wikis we'll accept as sources for
5846 * Special:Import (for sysops). Since complete page history can be imported,
5847 * these should be 'trusted'.
5849 * If a user has the 'import' permission but not the 'importupload' permission,
5850 * they will only be able to run imports through this transwiki interface.
5852 $wgImportSources = array();
5855 * Optional default target namespace for interwiki imports.
5856 * Can use this to create an incoming "transwiki"-style queue.
5857 * Set to numeric key, not the name.
5859 * Users may override this in the Special:Import dialog.
5861 $wgImportTargetNamespace = null;
5864 * If set to false, disables the full-history option on Special:Export.
5865 * This is currently poorly optimized for long edit histories, so is
5866 * disabled on Wikimedia's sites.
5868 $wgExportAllowHistory = true;
5871 * If set nonzero, Special:Export requests for history of pages with
5872 * more revisions than this will be rejected. On some big sites things
5873 * could get bogged down by very very long pages.
5875 $wgExportMaxHistory = 0;
5878 * Return distinct author list (when not returning full history)
5880 $wgExportAllowListContributors = false;
5883 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
5884 * up to this specified level, which will cause it to include all
5885 * pages linked to from the pages you specify. Since this number
5886 * can become *insanely large* and could easily break your wiki,
5887 * it's disabled by default for now.
5889 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
5890 * crazy-big export from being done by someone setting the depth number too
5891 * high. In other words, last resort safety net.
5893 $wgExportMaxLinkDepth = 0;
5896 * Whether to allow the "export all pages in namespace" option
5898 $wgExportFromNamespaces = false;
5901 * Whether to allow exporting the entire wiki into a single file
5903 $wgExportAllowAll = false;
5905 /** @} */ # end of import/export }
5907 /*************************************************************************//**
5913 * A list of callback functions which are called once MediaWiki is fully
5916 $wgExtensionFunctions = array();
5919 * Extension messages files.
5921 * Associative array mapping extension name to the filename where messages can be
5922 * found. The file should contain variable assignments. Any of the variables
5923 * present in languages/messages/MessagesEn.php may be defined, but $messages
5924 * is the most common.
5926 * Variables defined in extensions will override conflicting variables defined
5929 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
5930 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
5931 * $messages, $wgExtensionMessagesFiles should still be used.
5933 * If there is an entry in $wgMessagesDirs with the same key as one in
5934 * $wgExtensionMessagesFiles, then any $messages variables set in the $wgExtensionMessagesFiles file
5935 * will be ignored. This means an extension that only provides messages can be backwards compatible
5936 * by using both $wgExtensionMessagesFiles and $wgMessagesDirs, and only one of the two
5937 * will be used depending on what the version of MediaWiki supports.
5941 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
5944 $wgExtensionMessagesFiles = array();
5947 * Extension messages directories.
5949 * Associative array mapping extension name to the path of the directory where message files can
5950 * be found. The message files are expected to be JSON files named for their language code, e.g.
5951 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
5952 * message directories.
5954 * @par Simple example:
5956 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
5959 * @par Complex example:
5961 * $wgMessagesDirs['Example'] = array(
5962 * __DIR__ . '/lib/ve/i18n',
5963 * __DIR__ . '/lib/oojs-ui/i18n',
5964 * __DIR__ . '/i18n',
5969 $wgMessagesDirs = array(
5970 "$IP/resources/oojs-ui/i18n",
5974 * Array of files with list(s) of extension entry points to be used in
5975 * maintenance/mergeMessageFileList.php
5978 $wgExtensionEntryPointListFiles = array();
5981 * Parser output hooks.
5982 * This is an associative array where the key is an extension-defined tag
5983 * (typically the extension name), and the value is a PHP callback.
5984 * These will be called as an OutputPageParserOutput hook, if the relevant
5985 * tag has been registered with the parser output object.
5987 * Registration is done with $pout->addOutputHook( $tag, $data ).
5989 * The callback has the form:
5991 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
5994 $wgParserOutputHooks = array();
5997 * Whether to include the NewPP limit report as a HTML comment
5999 $wgEnableParserLimitReporting = true;
6002 * List of valid skin names.
6003 * The key should be the name in all lower case, the value should be a properly
6004 * cased name for the skin. This value will be prefixed with "Skin" to create the
6005 * class name of the skin to load, and if the skin's class cannot be found through
6006 * the autoloader it will be used to load a .php file by that name in the skins directory.
6007 * The default skins will be added later, by Skin::getSkinNames(). Use
6008 * Skin::getSkinNames() as an accessor if you wish to have access to the full list.
6010 $wgValidSkinNames = array();
6013 * Special page list.
6014 * See the top of SpecialPage.php for documentation.
6016 $wgSpecialPages = array();
6019 * Array mapping class names to filenames, for autoloading.
6021 $wgAutoloadClasses = array();
6024 * Switch controlling legacy case-insensitive classloading.
6025 * Do not disable if your wiki must support data created by PHP4, or by
6026 * MediaWiki 1.4 or earlier.
6028 $wgAutoloadAttemptLowercase = true;
6031 * An array of extension types and inside that their names, versions, authors,
6032 * urls, descriptions and pointers to localized description msgs. Note that
6033 * the version, url, description and descriptionmsg key can be omitted.
6036 * $wgExtensionCredits[$type][] = array(
6037 * 'name' => 'Example extension',
6039 * 'path' => __FILE__,
6040 * 'author' => 'Foo Barstein',
6041 * 'url' => 'http://www.example.com/Example%20Extension/',
6042 * 'description' => 'An example extension',
6043 * 'descriptionmsg' => 'exampleextension-desc',
6047 * Where $type is 'specialpage', 'parserhook', 'variable', 'media' or 'other'.
6048 * Where 'descriptionmsg' can be an array with message key and parameters:
6049 * 'descriptionmsg' => array( 'exampleextension-desc', param1, param2, ... ),
6051 * author can be a string or an array of strings. Authors can be linked using
6052 * the regular wikitext link syntax. To have an internationalized version of
6053 * "and others" show, add an element "...". This element can also be linked,
6054 * for instance "[http://example ...]".
6056 $wgExtensionCredits = array();
6059 * Authentication plugin.
6060 * @var $wgAuth AuthPlugin
6065 * Global list of hooks.
6067 * The key is one of the events made available by MediaWiki, you can find
6068 * a description for most of them in docs/hooks.txt. The array is used
6069 * internally by Hook:run().
6071 * The value can be one of:
6073 * - A function name:
6075 * $wgHooks['event_name'][] = $function;
6077 * - A function with some data:
6079 * $wgHooks['event_name'][] = array( $function, $data );
6081 * - A an object method:
6083 * $wgHooks['event_name'][] = array( $object, 'method' );
6087 * $wgHooks['event_name'][] = function ( $hookParam ) {
6088 * // Handler code goes here.
6092 * @warning You should always append to an event array or you will end up
6093 * deleting a previous registered hook.
6095 * @warning Hook handlers should be registered at file scope. Registering
6096 * handlers after file scope can lead to unexpected results due to caching.
6101 * Maps jobs to their handling classes; extensions
6102 * can add to this to provide custom jobs
6104 $wgJobClasses = array(
6105 'refreshLinks' => 'RefreshLinksJob',
6106 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6107 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6108 'sendMail' => 'EmaillingJob',
6109 'enotifNotify' => 'EnotifNotifyJob',
6110 'fixDoubleRedirect' => 'DoubleRedirectJob',
6111 'uploadFromUrl' => 'UploadFromUrlJob',
6112 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6113 'PublishStashedFile' => 'PublishStashedFileJob',
6118 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6119 * special flags are set. The values here are keys of $wgJobClasses.
6122 * - Very long-running jobs.
6123 * - Jobs that you would never want to run as part of a page rendering request.
6124 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6125 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6126 * These settings should be global to all wikis.
6128 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6131 * Map of job types to how many job "work items" should be run per second
6132 * on each job runner process. The meaning of "work items" varies per job,
6133 * but typically would be something like "pages to update". A single job
6134 * may have a variable number of work items, as is the case with batch jobs.
6135 * These settings should be global to all wikis.
6137 $wgJobBackoffThrottling = array();
6140 * Map of job types to configuration arrays.
6141 * This determines which queue class and storage system is used for each job type.
6142 * Job types that do not have explicit configuration will use the 'default' config.
6143 * These settings should be global to all wikis.
6145 $wgJobTypeConf = array(
6146 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6150 * Which aggregator to use for tracking which queues have jobs.
6151 * These settings should be global to all wikis.
6153 $wgJobQueueAggregator = array(
6154 'class' => 'JobQueueAggregatorMemc'
6158 * Additional functions to be performed with updateSpecialPages.
6159 * Expensive Querypages are already updated.
6161 $wgSpecialPageCacheUpdates = array(
6162 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6163 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6167 * Hooks that are used for outputting exceptions. Format is:
6168 * $wgExceptionHooks[] = $funcname
6170 * $wgExceptionHooks[] = array( $class, $funcname )
6171 * Hooks should return strings or false
6173 $wgExceptionHooks = array();
6176 * Page property link table invalidation lists. When a page property
6177 * changes, this may require other link tables to be updated (eg
6178 * adding __HIDDENCAT__ means the hiddencat tracking category will
6179 * have been added, so the categorylinks table needs to be rebuilt).
6180 * This array can be added to by extensions.
6182 $wgPagePropLinkInvalidations = array(
6183 'hiddencat' => 'categorylinks',
6186 /** @} */ # End extensions }
6188 /*************************************************************************//**
6194 * Use experimental, DMOZ-like category browser
6196 $wgUseCategoryBrowser = false;
6199 * On category pages, show thumbnail gallery for images belonging to that
6200 * category instead of listing them as articles.
6202 $wgCategoryMagicGallery = true;
6205 * Paging limit for categories
6207 $wgCategoryPagingLimit = 200;
6210 * Specify how category names should be sorted, when listed on a category page.
6211 * A sorting scheme is also known as a collation.
6213 * Available values are:
6215 * - uppercase: Converts the category name to upper case, and sorts by that.
6217 * - identity: Does no conversion. Sorts by binary value of the string.
6219 * - uca-default: Provides access to the Unicode Collation Algorithm with
6220 * the default element table. This is a compromise collation which sorts
6221 * all languages in a mediocre way. However, it is better than "uppercase".
6223 * To use the uca-default collation, you must have PHP's intl extension
6224 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6225 * resulting collation will depend on the version of ICU installed on the
6228 * After you change this, you must run maintenance/updateCollation.php to fix
6229 * the sort keys in the database.
6231 * Extensions can define there own collations by subclassing Collation
6232 * and using the Collation::factory hook.
6234 $wgCategoryCollation = 'uppercase';
6236 /** @} */ # End categories }
6238 /*************************************************************************//**
6244 * The logging system has two levels: an event type, which describes the
6245 * general category and can be viewed as a named subset of all logs; and
6246 * an action, which is a specific kind of event that can exist in that
6249 $wgLogTypes = array(
6264 * This restricts log access to those who have a certain right
6265 * Users without this will not see it in the option menu and can not view it
6266 * Restricted logs are not added to recent changes
6267 * Logs should remain non-transcludable
6268 * Format: logtype => permissiontype
6270 $wgLogRestrictions = array(
6271 'suppress' => 'suppressionlog'
6275 * Show/hide links on Special:Log will be shown for these log types.
6277 * This is associative array of log type => boolean "hide by default"
6279 * See $wgLogTypes for a list of available log types.
6283 * $wgFilterLogTypes = array(
6285 * 'import' => false,
6289 * Will display show/hide links for the move and import logs. Move logs will be
6290 * hidden by default unless the link is clicked. Import logs will be shown by
6291 * default, and hidden when the link is clicked.
6293 * A message of the form log-show-hide-[type] should be added, and will be used
6294 * for the link text.
6296 $wgFilterLogTypes = array(
6301 * Lists the message key string for each log type. The localized messages
6302 * will be listed in the user interface.
6304 * Extensions with custom log types may add to this array.
6306 * @since 1.19, if you follow the naming convention log-name-TYPE,
6307 * where TYPE is your log type, yoy don't need to use this array.
6309 $wgLogNames = array(
6310 '' => 'all-logs-page',
6311 'block' => 'blocklogpage',
6312 'protect' => 'protectlogpage',
6313 'rights' => 'rightslog',
6314 'delete' => 'dellogpage',
6315 'upload' => 'uploadlogpage',
6316 'move' => 'movelogpage',
6317 'import' => 'importlogpage',
6318 'patrol' => 'patrol-log-page',
6319 'merge' => 'mergelog',
6320 'suppress' => 'suppressionlog',
6324 * Lists the message key string for descriptive text to be shown at the
6325 * top of each log type.
6327 * Extensions with custom log types may add to this array.
6329 * @since 1.19, if you follow the naming convention log-description-TYPE,
6330 * where TYPE is your log type, yoy don't need to use this array.
6332 $wgLogHeaders = array(
6333 '' => 'alllogstext',
6334 'block' => 'blocklogtext',
6335 'protect' => 'protectlogtext',
6336 'rights' => 'rightslogtext',
6337 'delete' => 'dellogpagetext',
6338 'upload' => 'uploadlogpagetext',
6339 'move' => 'movelogpagetext',
6340 'import' => 'importlogpagetext',
6341 'patrol' => 'patrol-log-header',
6342 'merge' => 'mergelogpagetext',
6343 'suppress' => 'suppressionlogtext',
6347 * Lists the message key string for formatting individual events of each
6348 * type and action when listed in the logs.
6350 * Extensions with custom log types may add to this array.
6352 $wgLogActions = array(
6353 'block/block' => 'blocklogentry',
6354 'block/unblock' => 'unblocklogentry',
6355 'block/reblock' => 'reblock-logentry',
6356 'protect/protect' => 'protectedarticle',
6357 'protect/modify' => 'modifiedarticleprotection',
6358 'protect/unprotect' => 'unprotectedarticle',
6359 'protect/move_prot' => 'movedarticleprotection',
6360 'upload/upload' => 'uploadedimage',
6361 'upload/overwrite' => 'overwroteimage',
6362 'upload/revert' => 'uploadedimage',
6363 'import/upload' => 'import-logentry-upload',
6364 'import/interwiki' => 'import-logentry-interwiki',
6365 'merge/merge' => 'pagemerge-logentry',
6366 'suppress/block' => 'blocklogentry',
6367 'suppress/reblock' => 'reblock-logentry',
6371 * The same as above, but here values are names of functions,
6373 * @see LogPage::actionText
6376 $wgLogActionsHandlers = array(
6377 'move/move' => 'MoveLogFormatter',
6378 'move/move_redir' => 'MoveLogFormatter',
6379 'delete/delete' => 'DeleteLogFormatter',
6380 'delete/restore' => 'DeleteLogFormatter',
6381 'delete/revision' => 'DeleteLogFormatter',
6382 'delete/event' => 'DeleteLogFormatter',
6383 'suppress/revision' => 'DeleteLogFormatter',
6384 'suppress/event' => 'DeleteLogFormatter',
6385 'suppress/delete' => 'DeleteLogFormatter',
6386 'patrol/patrol' => 'PatrolLogFormatter',
6387 'rights/rights' => 'RightsLogFormatter',
6388 'rights/autopromote' => 'RightsLogFormatter',
6392 * Maintain a log of newusers at Log/newusers?
6394 $wgNewUserLog = true;
6396 /** @} */ # end logging }
6398 /*************************************************************************//**
6399 * @name Special pages (general and miscellaneous)
6404 * Allow special page inclusions such as {{Special:Allpages}}
6406 $wgAllowSpecialInclusion = true;
6409 * Set this to an array of special page names to prevent
6410 * maintenance/updateSpecialPages.php from updating those pages.
6412 $wgDisableQueryPageUpdate = false;
6415 * List of special pages, followed by what subtitle they should go under
6416 * at Special:SpecialPages
6418 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6420 $wgSpecialPageGroups = array();
6423 * Whether or not to sort special pages in Special:Specialpages
6425 $wgSortSpecialPages = true;
6428 * On Special:Unusedimages, consider images "used", if they are put
6429 * into a category. Default (false) is not to count those as used.
6431 $wgCountCategorizedImagesAsUsed = false;
6434 * Maximum number of links to a redirect page listed on
6435 * Special:Whatlinkshere/RedirectDestination
6437 $wgMaxRedirectLinksRetrieved = 500;
6439 /** @} */ # end special pages }
6441 /*************************************************************************//**
6447 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6448 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6449 * 'foo' => true Load the class FooAction which subclasses Action
6450 * If something is specified in the getActionOverrides()
6451 * of the relevant Page object it will be used
6452 * instead of the default class.
6453 * 'foo' => false The action is disabled; show an error message
6454 * Unsetting core actions will probably cause things to complain loudly.
6462 'markpatrolled' => true,
6468 'revisiondelete' => true,
6471 'unprotect' => true,
6478 * Array of disabled article actions, e.g. view, edit, delete, etc.
6479 * @deprecated since 1.18; just set $wgActions['action'] = false instead
6481 $wgDisabledActions = array();
6483 /** @} */ # end actions }
6485 /*************************************************************************//**
6486 * @name Robot (search engine crawler) policy
6487 * See also $wgNoFollowLinks.
6492 * Default robot policy. The default policy is to encourage indexing and fol-
6493 * lowing of links. It may be overridden on a per-namespace and/or per-page
6496 $wgDefaultRobotPolicy = 'index,follow';
6499 * Robot policies per namespaces. The default policy is given above, the array
6500 * is made of namespace constants as defined in includes/Defines.php. You can-
6501 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6502 * nofollow. This is because a number of special pages (e.g., ListPages) have
6503 * many permutations of options that display the same data under redundant
6504 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6505 * pages, all alike, and never reaching your actual content.
6509 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6512 $wgNamespaceRobotPolicies = array();
6515 * Robot policies per article. These override the per-namespace robot policies.
6516 * Must be in the form of an array where the key part is a properly canonicalised
6517 * text form title and the value is a robot policy.
6521 * $wgArticleRobotPolicies = array(
6522 * 'Main Page' => 'noindex,follow',
6523 * 'User:Bob' => 'index,follow',
6527 * @par Example that DOES NOT WORK because the names are not canonical text
6530 * $wgArticleRobotPolicies = array(
6531 * # Underscore, not space!
6532 * 'Main_Page' => 'noindex,follow',
6533 * # "Project", not the actual project name!
6534 * 'Project:X' => 'index,follow',
6535 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6536 * 'abc' => 'noindex,nofollow'
6540 $wgArticleRobotPolicies = array();
6543 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6544 * will not function, so users can't decide whether pages in that namespace are
6545 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6549 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6552 $wgExemptFromUserRobotsControl = null;
6554 /** @} */ # End robot policy }
6556 /************************************************************************//**
6557 * @name AJAX and API
6558 * Note: The AJAX entry point which this section refers to is gradually being
6559 * replaced by the API entry point, api.php. They are essentially equivalent.
6560 * Both of them are used for dynamic client-side features, via XHR.
6565 * Enable the MediaWiki API for convenient access to
6566 * machine-readable data via api.php
6568 * See http://www.mediawiki.org/wiki/API
6570 $wgEnableAPI = true;
6573 * Allow the API to be used to perform write operations
6574 * (page edits, rollback, etc.) when an authorised user
6577 $wgEnableWriteAPI = true;
6581 * WARNING: SECURITY THREAT - debug use only
6583 * Disables many security checks in the API for debugging purposes.
6584 * This flag should never be used on the production servers, as it introduces
6585 * a number of potential security holes. Even when enabled, the validation
6586 * will still be performed, but instead of failing, API will return a warning.
6587 * Also, there will always be a warning notifying that this flag is set.
6588 * At this point, the flag allows GET requests to go through for modules
6593 $wgDebugAPI = false;
6596 * API module extensions.
6597 * Associative array mapping module name to class name.
6598 * Extension modules may override the core modules.
6600 * See ApiMain::$Modules for a list of the core modules.
6602 $wgAPIModules = array();
6605 * API format module extensions.
6606 * Associative array mapping format module name to class name.
6607 * Extension modules may override the core modules.
6609 * See ApiMain::$Formats for a list of the core format modules.
6611 $wgAPIFormatModules = array();
6614 * API Query meta module extensions.
6615 * Associative array mapping meta module name to class name.
6616 * Extension modules may override the core modules.
6618 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6620 $wgAPIMetaModules = array();
6623 * API Query prop module extensions.
6624 * Associative array mapping properties module name to class name.
6625 * Extension modules may override the core modules.
6627 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6629 $wgAPIPropModules = array();
6632 * API Query list module extensions.
6633 * Associative array mapping list module name to class name.
6634 * Extension modules may override the core modules.
6636 * See ApiQuery::$QueryListModules for a list of the core list modules.
6638 $wgAPIListModules = array();
6641 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6642 * @deprecated since 1.21
6644 $wgAPIGeneratorModules = array();
6647 * Maximum amount of rows to scan in a DB query in the API
6648 * The default value is generally fine
6650 $wgAPIMaxDBRows = 5000;
6653 * The maximum size (in bytes) of an API result.
6654 * @warning Do not set this lower than $wgMaxArticleSize*1024
6656 $wgAPIMaxResultSize = 8388608;
6659 * The maximum number of uncached diffs that can be retrieved in one API
6660 * request. Set this to 0 to disable API diffs altogether
6662 $wgAPIMaxUncachedDiffs = 1;
6665 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6666 * API request logging
6668 $wgAPIRequestLog = false;
6671 * Set the timeout for the API help text cache. If set to 0, caching disabled
6673 $wgAPICacheHelpTimeout = 60 * 60;
6676 * The ApiQueryQueryPages module should skip pages that are redundant to true
6679 $wgAPIUselessQueryPages = array(
6680 'MIMEsearch', // aiprop=mime
6681 'LinkSearch', // list=exturlusage
6682 'FileDuplicateSearch', // prop=duplicatefiles
6686 * Enable AJAX framework
6691 * List of Ajax-callable functions.
6692 * Extensions acting as Ajax callbacks must register here
6694 $wgAjaxExportList = array();
6697 * Enable watching/unwatching pages using AJAX.
6698 * Requires $wgUseAjax to be true too.
6700 $wgAjaxWatch = true;
6703 * Enable AJAX check for file overwrite, pre-upload
6705 $wgAjaxUploadDestCheck = true;
6708 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6710 $wgAjaxLicensePreview = true;
6713 * Settings for incoming cross-site AJAX requests:
6714 * Newer browsers support cross-site AJAX when the target resource allows requests
6715 * from the origin domain by the Access-Control-Allow-Origin header.
6716 * This is currently only used by the API (requests to api.php)
6717 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6719 * - '*' matches any number of characters
6720 * - '?' matches any 1 character
6724 * $wgCrossSiteAJAXdomains = array(
6725 * 'www.mediawiki.org',
6726 * '*.wikipedia.org',
6727 * '*.wikimedia.org',
6728 * '*.wiktionary.org',
6732 $wgCrossSiteAJAXdomains = array();
6735 * Domains that should not be allowed to make AJAX requests,
6736 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6737 * Uses the same syntax as $wgCrossSiteAJAXdomains
6739 $wgCrossSiteAJAXdomainExceptions = array();
6741 /** @} */ # End AJAX and API }
6743 /************************************************************************//**
6744 * @name Shell and process control
6749 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6751 $wgMaxShellMemory = 307200;
6754 * Maximum file size created by shell processes under linux, in KB
6755 * ImageMagick convert for example can be fairly hungry for scratch space
6757 $wgMaxShellFileSize = 102400;
6760 * Maximum CPU time in seconds for shell processes under Linux
6762 $wgMaxShellTime = 180;
6765 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6766 * would measure) in seconds for shell processes under Linux
6768 $wgMaxShellWallClockTime = 180;
6771 * Under Linux: a cgroup directory used to constrain memory usage of shell
6772 * commands. The directory must be writable by the user which runs MediaWiki.
6774 * If specified, this is used instead of ulimit, which is inaccurate, and
6775 * causes malloc() to return NULL, which exposes bugs in C applications, making
6776 * them segfault or deadlock.
6778 * A wrapper script will create a cgroup for each shell command that runs, as
6779 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6780 * kernel will send a SIGKILL signal to a process in the subgroup.
6784 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6785 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6786 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6789 * The reliability of cgroup cleanup can be improved by installing a
6790 * notify_on_release script in the root cgroup, see e.g.
6791 * https://gerrit.wikimedia.org/r/#/c/40784
6793 $wgShellCgroup = false;
6796 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6798 $wgPhpCli = '/usr/bin/php';
6801 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
6802 * For Unix-like operating systems, set this to to a locale that has a UTF-8
6803 * character set. Only the character set is relevant.
6805 $wgShellLocale = 'en_US.utf8';
6807 /** @} */ # End shell }
6809 /************************************************************************//**
6815 * Timeout for HTTP requests done internally
6817 $wgHTTPTimeout = 25;
6820 * Timeout for Asynchronous (background) HTTP requests
6822 $wgAsyncHTTPTimeout = 25;
6825 * Proxy to use for CURL requests.
6827 $wgHTTPProxy = false;
6830 * Timeout for connections done internally (in seconds)
6831 * Only works for curl
6833 $wgHTTPConnectTimeout = 5e0
;
6835 /** @} */ # End HTTP client }
6837 /************************************************************************//**
6839 * See also $wgEnotifUseJobQ.
6844 * Number of jobs to perform per request. May be less than one in which case
6845 * jobs are performed probabalistically. If this is zero, jobs will not be done
6846 * during ordinary apache requests. In this case, maintenance/runJobs.php should
6847 * be run periodically.
6852 * Number of rows to update per job
6854 $wgUpdateRowsPerJob = 500;
6857 * Number of rows to update per query
6859 $wgUpdateRowsPerQuery = 100;
6862 * Do not purge all the pages that use a page when it is edited
6863 * if there are more than this many such pages. This is used to
6864 * avoid invalidating a large portion of the squid/parser cache.
6866 * This setting should factor in any squid/parser cache expiry settings.
6868 $wgMaxBacklinksInvalidate = false;
6870 /** @} */ # End job queue }
6872 /************************************************************************//**
6873 * @name Miscellaneous
6878 * Name of the external diff engine to use
6880 $wgExternalDiffEngine = false;
6883 * Disable redirects to special pages and interwiki redirects, which use a 302
6884 * and have no "redirected from" link.
6886 * @note This is only for articles with #REDIRECT in them. URL's containing a
6887 * local interwiki prefix (or a non-canonical special page name) are still hard
6888 * redirected regardless of this setting.
6890 $wgDisableHardRedirects = false;
6893 * LinkHolderArray batch size
6896 $wgLinkHolderBatchSize = 1000;
6899 * By default MediaWiki does not register links pointing to same server in
6900 * externallinks dataset, use this value to override:
6902 $wgRegisterInternalExternals = false;
6905 * Maximum number of pages to move at once when moving subpages with a page.
6907 $wgMaximumMovedPages = 100;
6910 * Fix double redirects after a page move.
6911 * Tends to conflict with page move vandalism, use only on a private wiki.
6913 $wgFixDoubleRedirects = false;
6916 * Allow redirection to another page when a user logs in.
6917 * To enable, set to a string like 'Main Page'
6919 $wgRedirectOnLogin = null;
6922 * Configuration for processing pool control, for use in high-traffic wikis.
6923 * An implementation is provided in the PoolCounter extension.
6925 * This configuration array maps pool types to an associative array. The only
6926 * defined key in the associative array is "class", which gives the class name.
6927 * The remaining elements are passed through to the class as constructor
6932 * $wgPoolCounterConf = array( 'ArticleView' => array(
6933 * 'class' => 'PoolCounter_Client',
6934 * 'timeout' => 15, // wait timeout in seconds
6935 * 'workers' => 5, // maximum number of active threads in each pool
6936 * 'maxqueue' => 50, // maximum number of total threads in each pool
6937 * ... any extension-specific options...
6941 $wgPoolCounterConf = null;
6944 * To disable file delete/restore temporarily
6946 $wgUploadMaintenance = false;
6949 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
6950 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
6951 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
6952 * (except for the special case of JS and CS pages).
6956 $wgNamespaceContentModels = array();
6959 * How to react if a plain text version of a non-text Content object is requested using
6960 * ContentHandler::getContentText():
6962 * * 'ignore': return null
6963 * * 'fail': throw an MWException
6964 * * 'serialize': serialize to default format
6968 $wgContentHandlerTextFallback = 'ignore';
6971 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
6972 * This way, the ContentHandler facility can be used without any additional information in the
6973 * database. A page's content model is then derived solely from the page's title. This however
6974 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
6975 * the page and/or make the content inaccessible. This also means that pages can not be moved to
6976 * a title that would default to a different content model.
6978 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
6979 * handling is less robust and less flexible.
6983 $wgContentHandlerUseDB = true;
6986 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
6987 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
6988 * the effect on the database they would have on a wikitext page.
6990 * @todo On the long run, it would be nice to put categories etc into a separate structure,
6991 * or at least parse only the contents of comments in the scripts.
6995 $wgTextModelsToParse = array(
6996 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
6997 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
6998 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
7002 * Whether the user must enter their password to change their e-mail address
7006 $wgRequirePasswordforEmailChange = true;
7009 * Register handlers for specific types of sites.
7013 $wgSiteTypes = array(
7014 'mediawiki' => 'MediaWikiSite',
7018 * Formerly a list of files for HipHop compilation
7019 * @deprecated since 1.22
7021 $wgCompiledFiles = array();
7024 * For really cool vim folding this needs to be at the end:
7025 * vim: foldmarker=@{,@} foldmethod=marker