Localisation updates from http://translatewiki.net.
[mediawiki.git] / includes / DefaultSettings.php
blob65f2477685eeccbdd6131601306470c1d16ae948
1 <?php
2 /**
3 * Default values for MediaWiki configuration settings.
6 * NEVER EDIT THIS FILE
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * 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
38 * @file
41 /**
42 * @defgroup Globalsettings Global settings
45 /**
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
52 die( 1 );
55 /**
56 * wgConf hold the site configuration.
57 * Not used for much in a default install.
58 * @since 1.5
60 $wgConf = new SiteConfiguration;
62 /**
63 * MediaWiki version number
64 * @since 1.2
66 $wgVersion = '1.22alpha';
68 /**
69 * Name of the site. It must be changed in LocalSettings.php
71 $wgSitename = 'MediaWiki';
73 /**
74 * URL of the server.
76 * @par Example:
77 * @code
78 * $wgServer = 'http://example.com';
79 * @endcode
81 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
82 * wrong server, it will redirect incorrectly after you save a page. In that
83 * case, set this variable to fix it.
85 * If you want to use protocol-relative URLs on your wiki, set this to a
86 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
87 * to a fully qualified URL.
89 $wgServer = WebRequest::detectServer();
91 /**
92 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
93 * Must be fully qualified, even if $wgServer is protocol-relative.
95 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
96 * @since 1.18
98 $wgCanonicalServer = false;
100 /************************************************************************//**
101 * @name Script path settings
102 * @{
106 * The path we should point to.
107 * It might be a virtual path in case with use apache mod_rewrite for example.
109 * This *needs* to be set correctly.
111 * Other paths will be set to defaults based on it unless they are directly
112 * set in LocalSettings.php
114 $wgScriptPath = '/wiki';
117 * Whether to support URLs like index.php/Page_title These often break when PHP
118 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
119 * but then again it may not; lighttpd converts incoming path data to lowercase
120 * on systems with case-insensitive filesystems, and there have been reports of
121 * problems on Apache as well.
123 * To be safe we'll continue to keep it off by default.
125 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
126 * incorrect garbage, or to true if it is really correct.
128 * The default $wgArticlePath will be set based on this value at runtime, but if
129 * you have customized it, having this incorrectly set to true can cause
130 * redirect loops when "pretty URLs" are used.
131 * @since 1.2.1
133 $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
134 ( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
135 ( strpos( PHP_SAPI, 'isapi' ) === false );
138 * The extension to append to script names by default. This can either be .php
139 * or .php5.
141 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
142 * variable is provided to support those providers.
143 * @since 1.11
145 $wgScriptExtension = '.php';
147 /**@}*/
149 /************************************************************************//**
150 * @name URLs and file paths
152 * These various web and file path variables are set to their defaults
153 * in Setup.php if they are not explicitly set from LocalSettings.php.
155 * These will relatively rarely need to be set manually, unless you are
156 * splitting style sheets or images outside the main document root.
158 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
159 * the host part, that starts with a slash. In most cases a full URL is also
160 * acceptable. A "directory" is a local file path.
162 * In both paths and directories, trailing slashes should not be included.
164 * @{
168 * The URL path to index.php.
170 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
172 $wgScript = false;
175 * The URL path to load.php.
177 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
178 * @since 1.17
180 $wgLoadScript = false;
183 * The URL path of the skins directory.
184 * Defaults to "{$wgScriptPath}/skins".
185 * @since 1.3
187 $wgStylePath = false;
188 $wgStyleSheetPath = &$wgStylePath;
191 * The URL path of the skins directory. Should not point to an external domain.
192 * Defaults to "{$wgScriptPath}/skins".
193 * @since 1.17
195 $wgLocalStylePath = false;
198 * The URL path of the extensions directory.
199 * Defaults to "{$wgScriptPath}/extensions".
200 * @since 1.16
202 $wgExtensionAssetsPath = false;
205 * Filesystem stylesheets directory.
206 * Defaults to "{$IP}/skins".
207 * @since 1.3
209 $wgStyleDirectory = false;
212 * The URL path for primary article page views. This path should contain $1,
213 * which is replaced by the article title.
215 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
216 * depending on $wgUsePathInfo.
218 $wgArticlePath = false;
221 * The URL path for the images directory.
222 * Defaults to "{$wgScriptPath}/images".
224 $wgUploadPath = false;
227 * The filesystem path of the images directory. Defaults to "{$IP}/images".
229 $wgUploadDirectory = false;
232 * Directory where the cached page will be saved.
233 * Defaults to "{$wgUploadDirectory}/cache".
235 $wgFileCacheDirectory = false;
238 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
239 * Defaults to "{$wgStylePath}/common/images/wiki.png".
241 $wgLogo = false;
244 * The URL path of the shortcut icon.
245 * @since 1.6
247 $wgFavicon = '/favicon.ico';
250 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
251 * Defaults to no icon.
252 * @since 1.12
254 $wgAppleTouchIcon = false;
257 * The local filesystem path to a temporary directory. This is not required to
258 * be web accessible.
260 * When this setting is set to false, its value will be set through a call
261 * to wfTempDir(). See that methods implementation for the actual detection
262 * logic.
264 * Developers should use the global function wfTempDir() instead of this
265 * variable.
267 * @see wfTempDir()
268 * @note Default changed to false in MediaWiki 1.20.
270 $wgTmpDirectory = false;
273 * If set, this URL is added to the start of $wgUploadPath to form a complete
274 * upload URL.
275 * @since 1.4
277 $wgUploadBaseUrl = '';
280 * To enable remote on-demand scaling, set this to the thumbnail base URL.
281 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
282 * where 'e6' are the first two characters of the MD5 hash of the file name.
283 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
284 * @since 1.17
286 $wgUploadStashScalerBaseUrl = false;
289 * To set 'pretty' URL paths for actions other than
290 * plain page views, add to this array.
292 * @par Example:
293 * Set pretty URL for the edit action:
294 * @code
295 * 'edit' => "$wgScriptPath/edit/$1"
296 * @endcode
298 * There must be an appropriate script or rewrite rule in place to handle these
299 * URLs.
300 * @since 1.5
302 $wgActionPaths = array();
304 /**@}*/
306 /************************************************************************//**
307 * @name Files and file uploads
308 * @{
311 /** Uploads have to be specially set up to be secure */
312 $wgEnableUploads = false;
315 * The maximum age of temporary (incomplete) uploaded files
317 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
319 /** Allows to move images and other media files */
320 $wgAllowImageMoving = true;
323 * Enable deferred upload tasks that use the job queue.
324 * Only enable this if job runners are set up for both the
325 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
327 $wgEnableAsyncUploads = false;
330 * These are additional characters that should be replaced with '-' in filenames
332 $wgIllegalFileChars = ":";
335 * @deprecated since 1.17 use $wgDeletedDirectory
337 $wgFileStore = array();
340 * What directory to place deleted uploads in.
341 * Defaults to "{$wgUploadDirectory}/deleted".
343 $wgDeletedDirectory = false;
346 * Set this to true if you use img_auth and want the user to see details on why access failed.
348 $wgImgAuthDetails = false;
351 * If this is enabled, img_auth.php will not allow image access unless the wiki
352 * is private. This improves security when image uploads are hosted on a
353 * separate domain.
355 $wgImgAuthPublicTest = true;
358 * File repository structures
360 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
361 * an array of such structures. Each repository structure is an associative
362 * array of properties configuring the repository.
364 * Properties required for all repos:
365 * - class The class name for the repository. May come from the core or an extension.
366 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
367 * FSRepo is also supported for backwards compatibility.
369 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
370 * The name should consist of alpha-numeric characters.
371 * - backend A file backend name (see $wgFileBackends).
373 * For most core repos:
374 * - zones Associative array of zone names that each map to an array with:
375 * container : backend container name the zone is in
376 * directory : root path within container for the zone
377 * url : base URL to the root of the zone
378 * urlsByExt : map of file extension types to base URLs
379 * (useful for using a different cache for videos)
380 * handlerUrl : base script-handled URL to the root of the zone
381 * (see FileRepo::getZoneHandlerUrl() function)
382 * Zones default to using "<repo name>-<zone name>" as the container name
383 * and default to using the container root as the zone's root directory.
384 * Nesting of zone locations within other zones should be avoided.
385 * - url Public zone URL. The 'zones' settings take precedence.
386 * - hashLevels The number of directory levels for hash-based division of files
387 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
388 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
389 * handler instead.
390 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
391 * determines whether filenames implicitly start with a capital letter.
392 * The current implementation may give incorrect description page links
393 * when the local $wgCapitalLinks and initialCapital are mismatched.
394 * - pathDisclosureProtection
395 * May be 'paranoid' to remove all parameters from error messages, 'none' to
396 * leave the paths in unchanged, or 'simple' to replace paths with
397 * placeholders. Default for LocalRepo is 'simple'.
398 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
399 * is 0644.
400 * - directory The local filesystem directory where public files are stored. Not used for
401 * some remote repos.
402 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
403 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
404 * - isPrivate Set this if measures should always be taken to keep the files private.
405 * One should not trust this to assure that the files are not web readable;
406 * the server configuration should be done manually depending on the backend.
408 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
409 * for local repositories:
410 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
411 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
412 * http://en.wikipedia.org/w
413 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
414 * $wgScriptExtension, e.g. .php5 defaults to .php
416 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
417 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
418 * $wgFetchCommonsDescriptions.
419 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
420 * Short thumbnail names only have the width, parameters, and the extension.
422 * ForeignDBRepo:
423 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
424 * equivalent to the corresponding member of $wgDBservers
425 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
426 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
428 * ForeignAPIRepo:
429 * - apibase Use for the foreign API's URL
430 * - apiThumbCacheExpiry How long to locally cache thumbs for
432 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
433 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
434 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
435 * If you set $wgForeignFileRepos to an array of repository structures, those will
436 * be searched after the local file repo.
437 * Otherwise, you will only have access to local media files.
439 * @see Setup.php for an example usage and default initialization.
441 $wgLocalFileRepo = false;
443 /** @see $wgLocalFileRepo */
444 $wgForeignFileRepos = array();
447 * Use Commons as a remote file repository. Essentially a wrapper, when this
448 * is enabled $wgForeignFileRepos will point at Commons with a set of default
449 * settings
451 $wgUseInstantCommons = false;
454 * File backend structure configuration.
456 * This is an array of file backend configuration arrays.
457 * Each backend configuration has the following parameters:
458 * - 'name' : A unique name for the backend
459 * - 'class' : The file backend class to use
460 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
461 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
463 * See FileBackend::__construct() for more details.
464 * Additional parameters are specific to the file backend class used.
465 * These settings should be global to all wikis when possible.
467 * There are two particularly important aspects about each backend:
468 * - a) Whether it is fully qualified or wiki-relative.
469 * By default, the paths of files are relative to the current wiki,
470 * which works via prefixing them with the current wiki ID when accessed.
471 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
472 * all paths with the specified value instead. This can be useful if
473 * multiple wikis need to share the same data. Note that 'name' is *not*
474 * part of any prefix and thus should not be relied upon for namespacing.
475 * - b) Whether it is only defined for some wikis or is defined on all
476 * wikis in the wiki farm. Defining a backend globally is useful
477 * if multiple wikis need to share the same data.
478 * One should be aware of these aspects when configuring a backend for use with
479 * any basic feature or plugin. For example, suppose an extension stores data for
480 * different wikis in different directories and sometimes needs to access data from
481 * a foreign wiki's directory in order to render a page on given wiki. The extension
482 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
484 $wgFileBackends = array();
487 * Array of configuration arrays for each lock manager.
488 * Each backend configuration has the following parameters:
489 * - 'name' : A unique name for the lock manager
490 * - 'class' : The lock manger class to use
492 * See LockManager::__construct() for more details.
493 * Additional parameters are specific to the lock manager class used.
494 * These settings should be global to all wikis.
496 $wgLockManagers = array();
499 * Show Exif data, on by default if available.
500 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
502 * @note FOR WINDOWS USERS:
503 * To enable Exif functions, add the following lines to the "Windows
504 * extensions" section of php.ini:
505 * @code{.ini}
506 * extension=extensions/php_mbstring.dll
507 * extension=extensions/php_exif.dll
508 * @endcode
510 $wgShowEXIF = function_exists( 'exif_read_data' );
513 * If to automatically update the img_metadata field
514 * if the metadata field is outdated but compatible with the current version.
515 * Defaults to false.
517 $wgUpdateCompatibleMetadata = false;
520 * If you operate multiple wikis, you can define a shared upload path here.
521 * Uploads to this wiki will NOT be put there - they will be put into
522 * $wgUploadDirectory.
523 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
524 * no file of the given name is found in the local repository (for [[File:..]],
525 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
526 * directory.
528 * Note that these configuration settings can now be defined on a per-
529 * repository basis for an arbitrary number of file repositories, using the
530 * $wgForeignFileRepos variable.
532 $wgUseSharedUploads = false;
534 /** Full path on the web server where shared uploads can be found */
535 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
537 /** Fetch commons image description pages and display them on the local wiki? */
538 $wgFetchCommonsDescriptions = false;
540 /** Path on the file system where shared uploads can be found. */
541 $wgSharedUploadDirectory = "/var/www/wiki3/images";
543 /** DB name with metadata about shared directory. Set this to false if the uploads do not come from a wiki. */
544 $wgSharedUploadDBname = false;
546 /** Optional table prefix used in database. */
547 $wgSharedUploadDBprefix = '';
549 /** Cache shared metadata in memcached. Don't do this if the commons wiki is in a different memcached domain */
550 $wgCacheSharedUploads = true;
553 * Allow for upload to be copied from an URL.
554 * The timeout for copy uploads is set by $wgHTTPTimeout.
555 * You have to assign the user right 'upload_by_url' to a user group, to use this.
557 $wgAllowCopyUploads = false;
560 * Allow asynchronous copy uploads.
561 * This feature is experimental and broken as of r81612.
563 $wgAllowAsyncCopyUploads = false;
566 * A list of domains copy uploads can come from
568 * @since 1.20
570 $wgCopyUploadsDomains = array();
573 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
574 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
575 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
577 $wgCopyUploadsFromSpecialUpload = false;
580 * Proxy to use for copy upload requests.
581 * @since 1.20
583 $wgCopyUploadProxy = false;
586 * Max size for uploads, in bytes. If not set to an array, applies to all
587 * uploads. If set to an array, per upload type maximums can be set, using the
588 * file and url keys. If the * key is set this value will be used as maximum
589 * for non-specified types.
591 * @par Example:
592 * @code
593 * $wgMaxUploadSize = array(
594 * '*' => 250 * 1024,
595 * 'url' => 500 * 1024,
596 * );
597 * @endcode
598 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
599 * will have a maximum of 500 kB.
601 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
604 * Point the upload navigation link to an external URL
605 * Useful if you want to use a shared repository by default
606 * without disabling local uploads (use $wgEnableUploads = false for that).
608 * @par Example:
609 * @code
610 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
611 * @endcode
613 $wgUploadNavigationUrl = false;
616 * Point the upload link for missing files to an external URL, as with
617 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
618 * appended to it as appropriate.
620 $wgUploadMissingFileUrl = false;
623 * Give a path here to use thumb.php for thumbnail generation on client
624 * request, instead of generating them on render and outputting a static URL.
625 * This is necessary if some of your apache servers don't have read/write
626 * access to the thumbnail path.
628 * @par Example:
629 * @code
630 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
631 * @endcode
633 $wgThumbnailScriptPath = false;
635 * @see $wgThumbnailScriptPath
637 $wgSharedThumbnailScriptPath = false;
640 * Set this to false if you do not want MediaWiki to divide your images
641 * directory into many subdirectories, for improved performance.
643 * It's almost always good to leave this enabled. In previous versions of
644 * MediaWiki, some users set this to false to allow images to be added to the
645 * wiki by simply copying them into $wgUploadDirectory and then running
646 * maintenance/rebuildImages.php to register them in the database. This is no
647 * longer recommended, use maintenance/importImages.php instead.
649 * @note That this variable may be ignored if $wgLocalFileRepo is set.
650 * @todo Deprecate the setting and ultimately remove it from Core.
652 $wgHashedUploadDirectory = true;
655 * Set the following to false especially if you have a set of files that need to
656 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
657 * directory layout.
659 $wgHashedSharedUploadDirectory = true;
662 * Base URL for a repository wiki. Leave this blank if uploads are just stored
663 * in a shared directory and not meant to be accessible through a separate wiki.
664 * Otherwise the image description pages on the local wiki will link to the
665 * image description page on this wiki.
667 * Please specify the namespace, as in the example below.
669 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
672 * This is the list of preferred extensions for uploading files. Uploading files
673 * with extensions not in this list will trigger a warning.
675 * @warning If you add any OpenOffice or Microsoft Office file formats here,
676 * such as odt or doc, and untrusted users are allowed to upload files, then
677 * your wiki will be vulnerable to cross-site request forgery (CSRF).
679 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
682 * Files with these extensions will never be allowed as uploads.
683 * An array of file extensions to blacklist. You should append to this array
684 * if you want to blacklist additional files.
686 $wgFileBlacklist = array(
687 # HTML may contain cookie-stealing JavaScript and web bugs
688 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
689 # PHP scripts may execute arbitrary code on the server
690 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
691 # Other types that may be interpreted by some servers
692 'shtml', 'jhtml', 'pl', 'py', 'cgi',
693 # May contain harmful executables for Windows victims
694 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
697 * Files with these mime types will never be allowed as uploads
698 * if $wgVerifyMimeType is enabled.
700 $wgMimeTypeBlacklist = array(
701 # HTML may contain cookie-stealing JavaScript and web bugs
702 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
703 # PHP scripts may execute arbitrary code on the server
704 'application/x-php', 'text/x-php',
705 # Other types that may be interpreted by some servers
706 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
707 # Client-side hazards on Internet Explorer
708 'text/scriptlet', 'application/x-msdownload',
709 # Windows metafile, client-side vulnerability on some systems
710 'application/x-msmetafile',
714 * Allow Java archive uploads.
715 * This is not recommended for public wikis since a maliciously-constructed
716 * applet running on the same domain as the wiki can steal the user's cookies.
718 $wgAllowJavaUploads = false;
721 * This is a flag to determine whether or not to check file extensions on upload.
723 * @warning Setting this to false is insecure for public wikis.
725 $wgCheckFileExtensions = true;
728 * If this is turned off, users may override the warning for files not covered
729 * by $wgFileExtensions.
731 * @warning Setting this to false is insecure for public wikis.
733 $wgStrictFileExtensions = true;
736 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
738 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
739 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
741 $wgDisableUploadScriptChecks = false;
744 * Warn if uploaded files are larger than this (in bytes), or false to disable
746 $wgUploadSizeWarning = false;
749 * list of trusted media-types and mime types.
750 * Use the MEDIATYPE_xxx constants to represent media types.
751 * This list is used by File::isSafeFile
753 * Types not listed here will have a warning about unsafe content
754 * displayed on the images description page. It would also be possible
755 * to use this for further restrictions, like disabling direct
756 * [[media:...]] links for non-trusted formats.
758 $wgTrustedMediaFormats = array(
759 MEDIATYPE_BITMAP, //all bitmap formats
760 MEDIATYPE_AUDIO, //all audio formats
761 MEDIATYPE_VIDEO, //all plain video formats
762 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
763 "application/pdf", //PDF files
764 #"application/x-shockwave-flash", //flash/shockwave movie
768 * Plugins for media file type handling.
769 * Each entry in the array maps a MIME type to a class name
771 $wgMediaHandlers = array(
772 'image/jpeg' => 'JpegHandler',
773 'image/png' => 'PNGHandler',
774 'image/gif' => 'GIFHandler',
775 'image/tiff' => 'TiffHandler',
776 'image/x-ms-bmp' => 'BmpHandler',
777 'image/x-bmp' => 'BmpHandler',
778 'image/x-xcf' => 'XCFHandler',
779 'image/svg+xml' => 'SvgHandler', // official
780 'image/svg' => 'SvgHandler', // compat
781 'image/vnd.djvu' => 'DjVuHandler', // official
782 'image/x.djvu' => 'DjVuHandler', // compat
783 'image/x-djvu' => 'DjVuHandler', // compat
787 * Plugins for page content model handling.
788 * Each entry in the array maps a model id to a class name.
790 * @since 1.21
792 $wgContentHandlers = array(
793 // the usual case
794 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
795 // dumb version, no syntax highlighting
796 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
797 // dumb version, no syntax highlighting
798 CONTENT_MODEL_CSS => 'CssContentHandler',
799 // plain text, for use by extensions etc
800 CONTENT_MODEL_TEXT => 'TextContentHandler',
804 * Resizing can be done using PHP's internal image libraries or using
805 * ImageMagick or another third-party converter, e.g. GraphicMagick.
806 * These support more file formats than PHP, which only supports PNG,
807 * GIF, JPG, XBM and WBMP.
809 * Use Image Magick instead of PHP builtin functions.
811 $wgUseImageMagick = false;
812 /** The convert command shipped with ImageMagick */
813 $wgImageMagickConvertCommand = '/usr/bin/convert';
814 /** The identify command shipped with ImageMagick */
815 $wgImageMagickIdentifyCommand = '/usr/bin/identify';
817 /** Sharpening parameter to ImageMagick */
818 $wgSharpenParameter = '0x0.4';
820 /** Reduction in linear dimensions below which sharpening will be enabled */
821 $wgSharpenReductionThreshold = 0.85;
824 * Temporary directory used for ImageMagick. The directory must exist. Leave
825 * this set to false to let ImageMagick decide for itself.
827 $wgImageMagickTempDir = false;
830 * Use another resizing converter, e.g. GraphicMagick
831 * %s will be replaced with the source path, %d with the destination
832 * %w and %h will be replaced with the width and height.
834 * @par Example for GraphicMagick:
835 * @code
836 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
837 * @endcode
839 * Leave as false to skip this.
841 $wgCustomConvertCommand = false;
843 /** used for lossless jpeg rotation
845 * @since 1.21
846 * **/
847 $wgJpegTran = '/usr/bin/jpegtran';
851 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
852 * image formats.
854 $wgExiv2Command = '/usr/bin/exiv2';
857 * Scalable Vector Graphics (SVG) may be uploaded as images.
858 * Since SVG support is not yet standard in browsers, it is
859 * necessary to rasterize SVGs to PNG as a fallback format.
861 * An external program is required to perform this conversion.
862 * If set to an array, the first item is a PHP callable and any further items
863 * are passed as parameters after $srcPath, $dstPath, $width, $height
865 $wgSVGConverters = array(
866 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
867 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
868 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
869 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d $output $input',
870 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
871 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
872 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
875 /** Pick a converter defined in $wgSVGConverters */
876 $wgSVGConverter = 'ImageMagick';
878 /** If not in the executable PATH, specify the SVG converter path. */
879 $wgSVGConverterPath = '';
881 /** Don't scale a SVG larger than this */
882 $wgSVGMaxSize = 2048;
884 /** Don't read SVG metadata beyond this point.
885 * Default is 1024*256 bytes
887 $wgSVGMetadataCutoff = 262144;
890 * Disallow <title> element in SVG files.
892 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
893 * browsers which can not perform basic stuff like MIME detection and which are
894 * vulnerable to further idiots uploading crap files as images.
896 * When this directive is on, "<title>" will be allowed in files with an
897 * "image/svg+xml" MIME type. You should leave this disabled if your web server
898 * is misconfigured and doesn't send appropriate MIME types for SVG images.
900 $wgAllowTitlesInSVG = false;
903 * The maximum number of pixels a source image can have if it is to be scaled
904 * down by a scaler that requires the full source image to be decompressed
905 * and stored in decompressed form, before the thumbnail is generated.
907 * This provides a limit on memory usage for the decompression side of the
908 * image scaler. The limit is used when scaling PNGs with any of the
909 * built-in image scalers, such as ImageMagick or GD. It is ignored for
910 * JPEGs with ImageMagick, and when using the VipsScaler extension.
912 * The default is 50 MB if decompressed to RGBA form, which corresponds to
913 * 12.5 million pixels or 3500x3500.
915 $wgMaxImageArea = 1.25e7;
917 * Force thumbnailing of animated GIFs above this size to a single
918 * frame instead of an animated thumbnail. As of MW 1.17 this limit
919 * is checked against the total size of all frames in the animation.
920 * It probably makes sense to keep this equal to $wgMaxImageArea.
922 $wgMaxAnimatedGifArea = 1.25e7;
924 * Browsers don't support TIFF inline generally...
925 * For inline display, we need to convert to PNG or JPEG.
926 * Note scaling should work with ImageMagick, but may not with GD scaling.
928 * @par Example:
929 * @code
930 * // PNG is lossless, but inefficient for photos
931 * $wgTiffThumbnailType = array( 'png', 'image/png' );
932 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
933 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
934 * @endcode
936 $wgTiffThumbnailType = false;
939 * If rendered thumbnail files are older than this timestamp, they
940 * will be rerendered on demand as if the file didn't already exist.
941 * Update if there is some need to force thumbs and SVG rasterizations
942 * to rerender, such as fixes to rendering bugs.
944 $wgThumbnailEpoch = '20030516000000';
947 * If set, inline scaled images will still produce "<img>" tags ready for
948 * output instead of showing an error message.
950 * This may be useful if errors are transitory, especially if the site
951 * is configured to automatically render thumbnails on request.
953 * On the other hand, it may obscure error conditions from debugging.
954 * Enable the debug log or the 'thumbnail' log group to make sure errors
955 * are logged to a file for review.
957 $wgIgnoreImageErrors = false;
960 * Allow thumbnail rendering on page view. If this is false, a valid
961 * thumbnail URL is still output, but no file will be created at
962 * the target location. This may save some time if you have a
963 * thumb.php or 404 handler set up which is faster than the regular
964 * webserver(s).
966 $wgGenerateThumbnailOnParse = true;
969 * Show thumbnails for old images on the image description page
971 $wgShowArchiveThumbnails = true;
973 /** Obsolete, always true, kept for compatibility with extensions */
974 $wgUseImageResize = true;
977 * If set to true, images that contain certain the exif orientation tag will
978 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
979 * is available that can rotate.
981 $wgEnableAutoRotation = null;
984 * Internal name of virus scanner. This serves as a key to the
985 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
986 * null, every file uploaded will be scanned for viruses.
988 $wgAntivirus = null;
991 * Configuration for different virus scanners. This an associative array of
992 * associative arrays. It contains one setup array per known scanner type.
993 * The entry is selected by $wgAntivirus, i.e.
994 * valid values for $wgAntivirus are the keys defined in this array.
996 * The configuration array for each scanner contains the following keys:
997 * "command", "codemap", "messagepattern":
999 * "command" is the full command to call the virus scanner - %f will be
1000 * replaced with the name of the file to scan. If not present, the filename
1001 * will be appended to the command. Note that this must be overwritten if the
1002 * scanner is not in the system path; in that case, please set
1003 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1004 * path.
1006 * "codemap" is a mapping of exit code to return codes of the detectVirus
1007 * function in SpecialUpload.
1008 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1009 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1010 * is not set.
1011 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1012 * the file to have an unsupported format, which is probably immune to
1013 * viruses. This causes the file to pass.
1014 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1015 * no virus was found.
1016 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1017 * a virus.
1018 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1020 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1021 * output. The relevant part should be matched as group one (\1).
1022 * If not defined or the pattern does not match, the full message is shown to the user.
1024 $wgAntivirusSetup = array(
1026 #setup for clamav
1027 'clamav' => array(
1028 'command' => 'clamscan --no-summary ',
1029 'codemap' => array(
1030 "0" => AV_NO_VIRUS, # no virus
1031 "1" => AV_VIRUS_FOUND, # virus found
1032 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1033 "*" => AV_SCAN_FAILED, # else scan failed
1035 'messagepattern' => '/.*?:(.*)/sim',
1039 /** Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. */
1040 $wgAntivirusRequired = true;
1042 /** Determines if the mime type of uploaded files should be checked */
1043 $wgVerifyMimeType = true;
1045 /** Sets the mime type definition file to use by MimeMagic.php. */
1046 $wgMimeTypeFile = 'includes/mime.types';
1047 #$wgMimeTypeFile = '/etc/mime.types';
1048 #$wgMimeTypeFile = null; #use built-in defaults only.
1050 /** Sets the mime type info file to use by MimeMagic.php. */
1051 $wgMimeInfoFile = 'includes/mime.info';
1052 #$wgMimeInfoFile = null; #use built-in defaults only.
1055 * Switch for loading the FileInfo extension by PECL at runtime.
1056 * This should be used only if fileinfo is installed as a shared object
1057 * or a dynamic library.
1059 $wgLoadFileinfoExtension = false;
1061 /** Sets an external mime detector program. The command must print only
1062 * the mime type to standard output.
1063 * The name of the file to process will be appended to the command given here.
1064 * If not set or NULL, mime_content_type will be used if available.
1066 * @par Example:
1067 * @code
1068 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
1069 * @endcode
1071 $wgMimeDetectorCommand = null;
1074 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
1075 * things, because only a few types of images are needed and file extensions
1076 * can be trusted.
1078 $wgTrivialMimeDetection = false;
1081 * Additional XML types we can allow via mime-detection.
1082 * array = ( 'rootElement' => 'associatedMimeType' )
1084 $wgXMLMimeTypes = array(
1085 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1086 'svg' => 'image/svg+xml',
1087 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1088 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1089 'html' => 'text/html', // application/xhtml+xml?
1093 * Limit images on image description pages to a user-selectable limit. In order
1094 * to reduce disk usage, limits can only be selected from a list.
1095 * The user preference is saved as an array offset in the database, by default
1096 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1097 * change it if you alter the array (see bug 8858).
1098 * This is the list of settings the user can choose from:
1100 $wgImageLimits = array(
1101 array( 320, 240 ),
1102 array( 640, 480 ),
1103 array( 800, 600 ),
1104 array( 1024, 768 ),
1105 array( 1280, 1024 )
1109 * Adjust thumbnails on image pages according to a user setting. In order to
1110 * reduce disk usage, the values can only be selected from a list. This is the
1111 * list of settings the user can choose from:
1113 $wgThumbLimits = array(
1114 120,
1115 150,
1116 180,
1117 200,
1118 250,
1123 * Default parameters for the "<gallery>" tag
1125 $wgGalleryOptions = array(
1126 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1127 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1128 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1129 'captionLength' => 25, // Length of caption to truncate (in characters)
1130 'showBytes' => true, // Show the filesize in bytes in categories
1134 * Adjust width of upright images when parameter 'upright' is used
1135 * This allows a nicer look for upright images without the need to fix the width
1136 * by hardcoded px in wiki sourcecode.
1138 $wgThumbUpright = 0.75;
1141 * Default value for chmoding of new directories.
1143 $wgDirectoryMode = 0777;
1146 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1148 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1149 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1150 * images in after loading the original low-resolution versions depending on the reported
1151 * window.devicePixelRatio.
1153 $wgResponsiveImages = true;
1156 * @name DJVU settings
1157 * @{
1160 * Path of the djvudump executable
1161 * Enable this and $wgDjvuRenderer to enable djvu rendering
1163 # $wgDjvuDump = 'djvudump';
1164 $wgDjvuDump = null;
1167 * Path of the ddjvu DJVU renderer
1168 * Enable this and $wgDjvuDump to enable djvu rendering
1170 # $wgDjvuRenderer = 'ddjvu';
1171 $wgDjvuRenderer = null;
1174 * Path of the djvutxt DJVU text extraction utility
1175 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1177 # $wgDjvuTxt = 'djvutxt';
1178 $wgDjvuTxt = null;
1181 * Path of the djvutoxml executable
1182 * This works like djvudump except much, much slower as of version 3.5.
1184 * For now we recommend you use djvudump instead. The djvuxml output is
1185 * probably more stable, so we'll switch back to it as soon as they fix
1186 * the efficiency problem.
1187 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1189 * @par Example:
1190 * @code
1191 * $wgDjvuToXML = 'djvutoxml';
1192 * @endcode
1194 $wgDjvuToXML = null;
1197 * Shell command for the DJVU post processor
1198 * Default: pnmtopng, since ddjvu generates ppm output
1199 * Set this to false to output the ppm file directly.
1201 $wgDjvuPostProcessor = 'pnmtojpeg';
1203 * File extension for the DJVU post processor output
1205 $wgDjvuOutputExtension = 'jpg';
1206 /** @} */ # end of DJvu }
1208 /** @} */ # end of file uploads }
1210 /************************************************************************//**
1211 * @name Email settings
1212 * @{
1215 $serverName = substr( $wgServer, strrpos( $wgServer, '/' ) + 1 );
1218 * Site admin email address.
1220 $wgEmergencyContact = 'wikiadmin@' . $serverName;
1223 * Password reminder email address.
1225 * The address we should use as sender when a user is requesting his password.
1227 $wgPasswordSender = 'apache@' . $serverName;
1229 unset( $serverName ); # Don't leak local variables to global scope
1232 * Password reminder name
1234 $wgPasswordSenderName = 'MediaWiki Mail';
1237 * Dummy address which should be accepted during mail send action.
1238 * It might be necessary to adapt the address or to set it equal
1239 * to the $wgEmergencyContact address.
1241 $wgNoReplyAddress = 'reply@not.possible';
1244 * Set to true to enable the e-mail basic features:
1245 * Password reminders, etc. If sending e-mail on your
1246 * server doesn't work, you might want to disable this.
1248 $wgEnableEmail = true;
1251 * Set to true to enable user-to-user e-mail.
1252 * This can potentially be abused, as it's hard to track.
1254 $wgEnableUserEmail = true;
1257 * Set to true to put the sending user's email in a Reply-To header
1258 * instead of From. ($wgEmergencyContact will be used as From.)
1260 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1261 * which can cause problems with SPF validation and leak recipient addresses
1262 * when bounces are sent to the sender.
1264 $wgUserEmailUseReplyTo = false;
1267 * Minimum time, in hours, which must elapse between password reminder
1268 * emails for a given account. This is to prevent abuse by mail flooding.
1270 $wgPasswordReminderResendTime = 24;
1273 * The time, in seconds, when an emailed temporary password expires.
1275 $wgNewPasswordExpiry = 3600 * 24 * 7;
1278 * The time, in seconds, when an email confirmation email expires
1280 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1283 * SMTP Mode.
1285 * For using a direct (authenticated) SMTP server connection.
1286 * Default to false or fill an array :
1288 * @code
1289 * $wgSMTP = array(
1290 * 'host' => 'SMTP domain',
1291 * 'IDHost' => 'domain for MessageID',
1292 * 'port' => '25',
1293 * 'auth' => [true|false],
1294 * 'username' => [SMTP username],
1295 * 'password' => [SMTP password],
1296 * );
1297 * @endcode
1299 $wgSMTP = false;
1302 * Additional email parameters, will be passed as the last argument to mail() call.
1303 * If using safe_mode this has no effect
1305 $wgAdditionalMailParams = null;
1308 * For parts of the system that have been updated to provide HTML email content, send
1309 * both text and HTML parts as the body of the email
1311 $wgAllowHTMLEmail = false;
1314 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1315 * from $wgEmergencyContact
1317 $wgEnotifFromEditor = false;
1319 // TODO move UPO to preferences probably ?
1320 # If set to true, users get a corresponding option in their preferences and can choose to enable or disable at their discretion
1321 # If set to false, the corresponding input form on the user preference page is suppressed
1322 # It call this to be a "user-preferences-option (UPO)"
1325 * Require email authentication before sending mail to an email address.
1326 * This is highly recommended. It prevents MediaWiki from being used as an open
1327 * spam relay.
1329 $wgEmailAuthentication = true;
1332 * Allow users to enable email notification ("enotif") on watchlist changes.
1334 $wgEnotifWatchlist = false;
1337 * Allow users to enable email notification ("enotif") when someone edits their
1338 * user talk page.
1340 $wgEnotifUserTalk = false;
1343 * Set the Reply-to address in notifications to the editor's address, if user
1344 * allowed this in the preferences.
1346 $wgEnotifRevealEditorAddress = false;
1349 * Send notification mails on minor edits to watchlist pages. This is enabled
1350 * by default. Does not affect user talk notifications.
1352 $wgEnotifMinorEdits = true;
1355 * Send a generic mail instead of a personalised mail for each user. This
1356 * always uses UTC as the time zone, and doesn't include the username.
1358 * For pages with many users watching, this can significantly reduce mail load.
1359 * Has no effect when using sendmail rather than SMTP.
1361 $wgEnotifImpersonal = false;
1364 * Maximum number of users to mail at once when using impersonal mail. Should
1365 * match the limit on your mail server.
1367 $wgEnotifMaxRecips = 500;
1370 * Send mails via the job queue. This can be useful to reduce the time it
1371 * takes to save a page that a lot of people are watching.
1373 $wgEnotifUseJobQ = false;
1376 * Use real name instead of username in e-mail "from" field.
1378 $wgEnotifUseRealName = false;
1381 * Array of usernames who will be sent a notification email for every change
1382 * which occurs on a wiki. Users will not be notified of their own changes.
1384 $wgUsersNotifiedOnAllChanges = array();
1387 /** @} */ # end of email settings
1389 /************************************************************************//**
1390 * @name Database settings
1391 * @{
1393 /** Database host name or IP address */
1394 $wgDBserver = 'localhost';
1395 /** Database port number (for PostgreSQL) */
1396 $wgDBport = 5432;
1397 /** Name of the database */
1398 $wgDBname = 'my_wiki';
1399 /** Database username */
1400 $wgDBuser = 'wikiuser';
1401 /** Database user's password */
1402 $wgDBpassword = '';
1403 /** Database type */
1404 $wgDBtype = 'mysql';
1405 /** Whether to use SSL in DB connection. */
1406 $wgDBssl = false;
1407 /** Whether to use compression in DB connection. */
1408 $wgDBcompress = false;
1410 /** Separate username for maintenance tasks. Leave as null to use the default. */
1411 $wgDBadminuser = null;
1412 /** Separate password for maintenance tasks. Leave as null to use the default. */
1413 $wgDBadminpassword = null;
1416 * Search type.
1417 * Leave as null to select the default search engine for the
1418 * selected database type (eg SearchMySQL), or set to a class
1419 * name to override to a custom search engine.
1421 $wgSearchType = null;
1423 /** Table name prefix */
1424 $wgDBprefix = '';
1425 /** MySQL table options to use during installation or update */
1426 $wgDBTableOptions = 'ENGINE=InnoDB';
1429 * SQL Mode - default is turning off all modes, including strict, if set.
1430 * null can be used to skip the setting for performance reasons and assume
1431 * DBA has done his best job.
1432 * String override can be used for some additional fun :-)
1434 $wgSQLMode = '';
1436 /** Mediawiki schema */
1437 $wgDBmwschema = 'mediawiki';
1439 /** To override default SQLite data directory ($docroot/../data) */
1440 $wgSQLiteDataDir = '';
1443 * Make all database connections secretly go to localhost. Fool the load balancer
1444 * thinking there is an arbitrarily large cluster of servers to connect to.
1445 * Useful for debugging.
1447 $wgAllDBsAreLocalhost = false;
1450 * Shared database for multiple wikis. Commonly used for storing a user table
1451 * for single sign-on. The server for this database must be the same as for the
1452 * main database.
1454 * For backwards compatibility the shared prefix is set to the same as the local
1455 * prefix, and the user table is listed in the default list of shared tables.
1456 * The user_properties table is also added so that users will continue to have their
1457 * preferences shared (preferences were stored in the user table prior to 1.16)
1459 * $wgSharedTables may be customized with a list of tables to share in the shared
1460 * database. However it is advised to limit what tables you do share as many of
1461 * MediaWiki's tables may have side effects if you try to share them.
1463 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1464 * $wgDBprefix.
1466 * @deprecated In new code, use the $wiki parameter to wfGetLB() to access
1467 * remote databases. Using wfGetLB() allows the shared database to reside on
1468 * separate servers to the wiki's own database, with suitable configuration
1469 * of $wgLBFactoryConf.
1471 $wgSharedDB = null;
1473 /** @see $wgSharedDB */
1474 $wgSharedPrefix = false;
1475 /** @see $wgSharedDB */
1476 $wgSharedTables = array( 'user', 'user_properties' );
1479 * Database load balancer
1480 * This is a two-dimensional array, an array of server info structures
1481 * Fields are:
1482 * - host: Host name
1483 * - dbname: Default database name
1484 * - user: DB user
1485 * - password: DB password
1486 * - type: "mysql" or "postgres"
1487 * - load: ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0
1488 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1489 * to several groups, the most specific group defined here is used.
1491 * - flags: bit field
1492 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1493 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1494 * - DBO_TRX -- wrap entire request in a transaction
1495 * - DBO_IGNORE -- ignore errors (not useful in LocalSettings.php)
1496 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1497 * - DBO_PERSISTENT -- enables persistent database connections
1498 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1499 * - DBO_COMPRESS -- uses internal compression in database connections, if available
1501 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1502 * - max threads: (optional) Maximum number of running threads
1504 * These and any other user-defined properties will be assigned to the mLBInfo member
1505 * variable of the Database object.
1507 * Leave at false to use the single-server variables above. If you set this
1508 * variable, the single-server variables will generally be ignored (except
1509 * perhaps in some command-line scripts).
1511 * The first server listed in this array (with key 0) will be the master. The
1512 * rest of the servers will be slaves. To prevent writes to your slaves due to
1513 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1514 * slaves in my.cnf. You can set read_only mode at runtime using:
1516 * @code
1517 * SET @@read_only=1;
1518 * @endcode
1520 * Since the effect of writing to a slave is so damaging and difficult to clean
1521 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1522 * our masters, and then set read_only=0 on masters at runtime.
1524 $wgDBservers = false;
1527 * Load balancer factory configuration
1528 * To set up a multi-master wiki farm, set the class here to something that
1529 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1530 * The class identified here is responsible for reading $wgDBservers,
1531 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1533 * The LBFactory_Multi class is provided for this purpose, please see
1534 * includes/db/LBFactory_Multi.php for configuration information.
1536 $wgLBFactoryConf = array( 'class' => 'LBFactory_Simple' );
1538 /** How long to wait for a slave to catch up to the master */
1539 $wgMasterWaitTimeout = 10;
1541 /** File to log database errors to */
1542 $wgDBerrorLog = false;
1545 * Timezone to use in the error log.
1546 * Defaults to the wiki timezone ($wgLocaltimezone).
1548 * A list of usable timezones can found at:
1549 * http://php.net/manual/en/timezones.php
1551 * @par Examples:
1552 * @code
1553 * $wgLocaltimezone = 'UTC';
1554 * $wgLocaltimezone = 'GMT';
1555 * $wgLocaltimezone = 'PST8PDT';
1556 * $wgLocaltimezone = 'Europe/Sweden';
1557 * $wgLocaltimezone = 'CET';
1558 * @endcode
1560 * @since 1.20
1562 $wgDBerrorLogTZ = false;
1564 /** When to give an error message */
1565 $wgDBClusterTimeout = 10;
1568 * Scale load balancer polling time so that under overload conditions, the
1569 * database server receives a SHOW STATUS query at an average interval of this
1570 * many microseconds
1572 $wgDBAvgStatusPoll = 2000;
1575 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1576 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1578 * @warning THIS IS EXPERIMENTAL!
1580 * May break if you're not using the table defs from mysql5/tables.sql.
1581 * May break if you're upgrading an existing wiki if set differently.
1582 * Broken symptoms likely to include incorrect behavior with page titles,
1583 * usernames, comments etc containing non-ASCII characters.
1584 * Might also cause failures on the object cache and other things.
1586 * Even correct usage may cause failures with Unicode supplementary
1587 * characters (those not in the Basic Multilingual Plane) unless MySQL
1588 * has enhanced their Unicode support.
1590 $wgDBmysql5 = false;
1593 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1595 * To use this feature set to true and use a datasource defined as
1596 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1597 * block).
1599 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1600 * Pool) that maintains established sessions and reuses them on new
1601 * connections.
1603 * Not completely tested, but it should fall back on normal connection
1604 * in case the pool is full or the datasource is not configured as
1605 * pooled.
1606 * And the other way around; using oci_pconnect on a non pooled
1607 * datasource should produce a normal connection.
1609 * When it comes to frequent shortlived DB connections like with MW
1610 * Oracle tends to s***. The problem is the driver connects to the
1611 * database reasonably fast, but establishing a session takes time and
1612 * resources. MW does not rely on session state (as it does not use
1613 * features such as package variables) so establishing a valid session
1614 * is in this case an unwanted overhead that just slows things down.
1616 * @warning EXPERIMENTAL!
1619 $wgDBOracleDRCP = false;
1622 * Other wikis on this site, can be administered from a single developer
1623 * account.
1624 * Array numeric key => database name
1626 $wgLocalDatabases = array();
1629 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1630 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1631 * show a more obvious warning.
1633 $wgSlaveLagWarning = 10;
1634 /** @see $wgSlaveLagWarning */
1635 $wgSlaveLagCritical = 30;
1638 * Use old names for change_tags indices.
1640 $wgOldChangeTagsIndex = false;
1642 /**@}*/ # End of DB settings }
1644 /************************************************************************//**
1645 * @name Text storage
1646 * @{
1650 * We can also compress text stored in the 'text' table. If this is set on, new
1651 * revisions will be compressed on page save if zlib support is available. Any
1652 * compressed revisions will be decompressed on load regardless of this setting
1653 * *but will not be readable at all* if zlib support is not available.
1655 $wgCompressRevisions = false;
1658 * External stores allow including content
1659 * from non database sources following URL links.
1661 * Short names of ExternalStore classes may be specified in an array here:
1662 * @code
1663 * $wgExternalStores = array("http","file","custom")...
1664 * @endcode
1666 * CAUTION: Access to database might lead to code execution
1668 $wgExternalStores = false;
1671 * An array of external MySQL servers.
1673 * @par Example:
1674 * Create a cluster named 'cluster1' containing three servers:
1675 * @code
1676 * $wgExternalServers = array(
1677 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1678 * );
1679 * @endcode
1681 * Used by LBFactory_Simple, may be ignored if $wgLBFactoryConf is set to
1682 * another class.
1684 $wgExternalServers = array();
1687 * The place to put new revisions, false to put them in the local text table.
1688 * Part of a URL, e.g. DB://cluster1
1690 * Can be an array instead of a single string, to enable data distribution. Keys
1691 * must be consecutive integers, starting at zero.
1693 * @par Example:
1694 * @code
1695 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1696 * @endcode
1698 * @var array
1700 $wgDefaultExternalStore = false;
1703 * Revision text may be cached in $wgMemc to reduce load on external storage
1704 * servers and object extraction overhead for frequently-loaded revisions.
1706 * Set to 0 to disable, or number of seconds before cache expiry.
1708 $wgRevisionCacheExpiry = 0;
1710 /** @} */ # end text storage }
1712 /************************************************************************//**
1713 * @name Performance hacks and limits
1714 * @{
1716 /** Disable database-intensive features */
1717 $wgMiserMode = false;
1718 /** Disable all query pages if miser mode is on, not just some */
1719 $wgDisableQueryPages = false;
1720 /** Number of rows to cache in 'querycache' table when miser mode is on */
1721 $wgQueryCacheLimit = 1000;
1722 /** Number of links to a page required before it is deemed "wanted" */
1723 $wgWantedPagesThreshold = 1;
1724 /** Enable slow parser functions */
1725 $wgAllowSlowParserFunctions = false;
1726 /** Allow schema updates */
1727 $wgAllowSchemaUpdates = true;
1730 * Do DELETE/INSERT for link updates instead of incremental
1732 $wgUseDumbLinkUpdate = false;
1735 * Anti-lock flags - bitfield
1736 * - ALF_NO_LINK_LOCK:
1737 * Don't use locking reads when updating the link table. This is
1738 * necessary for wikis with a high edit rate for performance
1739 * reasons, but may cause link table inconsistency
1741 $wgAntiLockFlags = 0;
1744 * Maximum article size in kilobytes
1746 $wgMaxArticleSize = 2048;
1749 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1750 * raise PHP's memory limit if it's below this amount.
1752 $wgMemoryLimit = "50M";
1754 /** @} */ # end performance hacks }
1756 /************************************************************************//**
1757 * @name Cache settings
1758 * @{
1762 * Directory for caching data in the local filesystem. Should not be accessible
1763 * from the web. Set this to false to not use any local caches.
1765 * Note: if multiple wikis share the same localisation cache directory, they
1766 * must all have the same set of extensions. You can set a directory just for
1767 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1769 $wgCacheDirectory = false;
1772 * Main cache type. This should be a cache with fast access, but it may have
1773 * limited space. By default, it is disabled, since the database is not fast
1774 * enough to make it worthwhile.
1776 * The options are:
1778 * - CACHE_ANYTHING: Use anything, as long as it works
1779 * - CACHE_NONE: Do not cache
1780 * - CACHE_DB: Store cache objects in the DB
1781 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
1782 * - CACHE_ACCEL: APC, XCache or WinCache
1783 * - CACHE_DBA: Use PHP's DBA extension to store in a DBM-style
1784 * database. This is slow, and is not recommended for
1785 * anything other than debugging.
1786 * - (other): A string may be used which identifies a cache
1787 * configuration in $wgObjectCaches.
1789 * @see $wgMessageCacheType, $wgParserCacheType
1791 $wgMainCacheType = CACHE_NONE;
1794 * The cache type for storing the contents of the MediaWiki namespace. This
1795 * cache is used for a small amount of data which is expensive to regenerate.
1797 * For available types see $wgMainCacheType.
1799 $wgMessageCacheType = CACHE_ANYTHING;
1802 * The cache type for storing article HTML. This is used to store data which
1803 * is expensive to regenerate, and benefits from having plenty of storage space.
1805 * For available types see $wgMainCacheType.
1807 $wgParserCacheType = CACHE_ANYTHING;
1810 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
1812 * For available types see $wgMainCacheType.
1814 $wgSessionCacheType = CACHE_ANYTHING;
1817 * The cache type for storing language conversion tables,
1818 * which are used when parsing certain text and interface messages.
1820 * For available types see $wgMainCacheType.
1822 * @since 1.20
1824 $wgLanguageConverterCacheType = CACHE_ANYTHING;
1827 * Advanced object cache configuration.
1829 * Use this to define the class names and constructor parameters which are used
1830 * for the various cache types. Custom cache types may be defined here and
1831 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
1832 * or $wgLanguageConverterCacheType.
1834 * The format is an associative array where the key is a cache identifier, and
1835 * the value is an associative array of parameters. The "class" parameter is the
1836 * class name which will be used. Alternatively, a "factory" parameter may be
1837 * given, giving a callable function which will generate a suitable cache object.
1839 * The other parameters are dependent on the class used.
1840 * - CACHE_DBA uses $wgTmpDirectory by default. The 'dir' parameter let you
1841 * overrides that.
1843 $wgObjectCaches = array(
1844 CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
1845 CACHE_DB => array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
1846 CACHE_DBA => array( 'class' => 'DBABagOStuff' ),
1848 CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
1849 CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
1850 CACHE_MEMCACHED => array( 'factory' => 'ObjectCache::newMemcached' ),
1852 'apc' => array( 'class' => 'APCBagOStuff' ),
1853 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
1854 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
1855 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
1856 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
1857 'hash' => array( 'class' => 'HashBagOStuff' ),
1861 * The expiry time for the parser cache, in seconds.
1862 * The default is 86400 (one day).
1864 $wgParserCacheExpireTime = 86400;
1867 * Select which DBA handler <http://www.php.net/manual/en/dba.requirements.php>
1868 * to use as CACHE_DBA backend.
1870 $wgDBAhandler = 'db3';
1873 * Deprecated alias for $wgSessionsInObjectCache.
1875 * @deprecated since 1.20; Use $wgSessionsInObjectCache
1877 $wgSessionsInMemcached = false;
1880 * Store sessions in an object cache, configured by $wgSessionCacheType. This
1881 * can be useful to improve performance, or to avoid the locking behavior of
1882 * PHP's default session handler, which tends to prevent multiple requests for
1883 * the same user from acting concurrently.
1885 $wgSessionsInObjectCache = false;
1888 * The expiry time to use for session storage when $wgSessionsInObjectCache is
1889 * enabled, in seconds.
1891 $wgObjectCacheSessionExpiry = 3600;
1894 * This is used for setting php's session.save_handler. In practice, you will
1895 * almost never need to change this ever. Other options might be 'user' or
1896 * 'session_mysql.' Setting to null skips setting this entirely (which might be
1897 * useful if you're doing cross-application sessions, see bug 11381)
1899 $wgSessionHandler = null;
1901 /** If enabled, will send MemCached debugging information to $wgDebugLogFile */
1902 $wgMemCachedDebug = false;
1904 /** The list of MemCached servers and port numbers */
1905 $wgMemCachedServers = array( '127.0.0.1:11211' );
1908 * Use persistent connections to MemCached, which are shared across multiple
1909 * requests.
1911 $wgMemCachedPersistent = false;
1914 * Read/write timeout for MemCached server communication, in microseconds.
1916 $wgMemCachedTimeout = 500000;
1919 * Set this to true to make a local copy of the message cache, for use in
1920 * addition to memcached. The files will be put in $wgCacheDirectory.
1922 $wgUseLocalMessageCache = false;
1925 * Instead of caching everything, only cache those messages which have
1926 * been customised in the site content language. This means that
1927 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
1928 * This option is probably only useful for translatewiki.net.
1930 $wgAdaptiveMessageCache = false;
1933 * Localisation cache configuration. Associative array with keys:
1934 * class: The class to use. May be overridden by extensions.
1936 * store: The location to store cache data. May be 'files', 'db' or
1937 * 'detect'. If set to "files", data will be in CDB files. If set
1938 * to "db", data will be stored to the database. If set to
1939 * "detect", files will be used if $wgCacheDirectory is set,
1940 * otherwise the database will be used.
1942 * storeClass: The class name for the underlying storage. If set to a class
1943 * name, it overrides the "store" setting.
1945 * storeDirectory: If the store class puts its data in files, this is the
1946 * directory it will use. If this is false, $wgCacheDirectory
1947 * will be used.
1949 * manualRecache: Set this to true to disable cache updates on web requests.
1950 * Use maintenance/rebuildLocalisationCache.php instead.
1952 $wgLocalisationCacheConf = array(
1953 'class' => 'LocalisationCache',
1954 'store' => 'detect',
1955 'storeClass' => false,
1956 'storeDirectory' => false,
1957 'manualRecache' => false,
1960 /** Allow client-side caching of pages */
1961 $wgCachePages = true;
1964 * Set this to current time to invalidate all prior cached pages. Affects both
1965 * client-side and server-side caching.
1966 * You can get the current date on your server by using the command:
1967 * @verbatim
1968 * date +%Y%m%d%H%M%S
1969 * @endverbatim
1971 $wgCacheEpoch = '20030516000000';
1974 * Bump this number when changing the global style sheets and JavaScript.
1976 * It should be appended in the query string of static CSS and JS includes,
1977 * to ensure that client-side caches do not keep obsolete copies of global
1978 * styles.
1980 $wgStyleVersion = '303';
1983 * This will cache static pages for non-logged-in users to reduce
1984 * database traffic on public sites.
1985 * Must set $wgShowIPinHeader = false
1986 * ResourceLoader requests to default language and skins are cached
1987 * as well as single module requests.
1989 $wgUseFileCache = false;
1992 * Depth of the subdirectory hierarchy to be created under
1993 * $wgFileCacheDirectory. The subdirectories will be named based on
1994 * the MD5 hash of the title. A value of 0 means all cache files will
1995 * be put directly into the main file cache directory.
1997 $wgFileCacheDepth = 2;
2000 * Keep parsed pages in a cache (objectcache table or memcached)
2001 * to speed up output of the same page viewed by another user with the
2002 * same options.
2004 * This can provide a significant speedup for medium to large pages,
2005 * so you probably want to keep it on. Extensions that conflict with the
2006 * parser cache should disable the cache on a per-page basis instead.
2008 $wgEnableParserCache = true;
2011 * Append a configured value to the parser cache and the sitenotice key so
2012 * that they can be kept separate for some class of activity.
2014 $wgRenderHashAppend = '';
2017 * If on, the sidebar navigation links are cached for users with the
2018 * current language set. This can save a touch of load on a busy site
2019 * by shaving off extra message lookups.
2021 * However it is also fragile: changing the site configuration, or
2022 * having a variable $wgArticlePath, can produce broken links that
2023 * don't update as expected.
2025 $wgEnableSidebarCache = false;
2028 * Expiry time for the sidebar cache, in seconds
2030 $wgSidebarCacheExpiry = 86400;
2033 * When using the file cache, we can store the cached HTML gzipped to save disk
2034 * space. Pages will then also be served compressed to clients that support it.
2036 * Requires zlib support enabled in PHP.
2038 $wgUseGzip = false;
2041 * Whether MediaWiki should send an ETag header. Seems to cause
2042 * broken behavior with Squid 2.6, see bug 7098.
2044 $wgUseETag = false;
2046 /** Clock skew or the one-second resolution of time() can occasionally cause cache
2047 * problems when the user requests two pages within a short period of time. This
2048 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2049 * a grace period.
2051 $wgClockSkewFudge = 5;
2054 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2055 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2056 * was previously done in the default LocalSettings.php file.
2058 * On high-traffic wikis, this should be set to false, to avoid the need to
2059 * check the file modification time, and to avoid the performance impact of
2060 * unnecessary cache invalidations.
2062 $wgInvalidateCacheOnLocalSettingsChange = true;
2064 /** @} */ # end of cache settings
2066 /************************************************************************//**
2067 * @name HTTP proxy (Squid) settings
2069 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2070 * although they are referred to as Squid settings for historical reasons.
2072 * Achieving a high hit ratio with an HTTP proxy requires special
2073 * configuration. See http://www.mediawiki.org/wiki/Manual:Squid_caching for
2074 * more details.
2076 * @{
2080 * Enable/disable Squid.
2081 * See http://www.mediawiki.org/wiki/Manual:Squid_caching
2083 $wgUseSquid = false;
2085 /** If you run Squid3 with ESI support, enable this (default:false): */
2086 $wgUseESI = false;
2088 /** Send X-Vary-Options header for better caching (requires patched Squid) */
2089 $wgUseXVO = false;
2091 /** Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2092 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2093 * and need to split the cache between HTTP and HTTPS for API requests,
2094 * feed requests and HTTP redirect responses in order to prevent cache
2095 * pollution. This does not affect 'normal' requests to index.php other than
2096 * HTTP redirects.
2098 $wgVaryOnXFP = false;
2101 * Internal server name as known to Squid, if different.
2103 * @par Example:
2104 * @code
2105 * $wgInternalServer = 'http://yourinternal.tld:8000';
2106 * @endcode
2108 $wgInternalServer = false;
2111 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2112 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2113 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2114 * days
2116 $wgSquidMaxage = 18000;
2119 * Default maximum age for raw CSS/JS accesses
2121 $wgForcedRawSMaxage = 300;
2124 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2126 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2127 * headers sent/modified from these proxies when obtaining the remote IP address
2129 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2131 $wgSquidServers = array();
2134 * As above, except these servers aren't purged on page changes; use to set a
2135 * list of trusted proxies, etc.
2137 $wgSquidServersNoPurge = array();
2139 /** Maximum number of titles to purge in any one client operation */
2140 $wgMaxSquidPurgeTitles = 400;
2143 * Whether to use a Host header in purge requests sent to the proxy servers
2144 * configured in $wgSquidServers. Set this to false to support Squid
2145 * configured in forward-proxy mode.
2147 * If this is set to true, a Host header will be sent, and only the path
2148 * component of the URL will appear on the request line, as if the request
2149 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2150 * request. Squid supports this style of request only if reverse-proxy mode
2151 * (http_port ... accel) is enabled.
2153 * If this is set to false, no Host header will be sent, and the absolute URL
2154 * will be sent in the request line, as is the standard for an HTTP proxy
2155 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2156 * by Varnish, but is supported by Squid in either configuration (forward or
2157 * reverse).
2159 * @since 1.21
2161 $wgSquidPurgeUseHostHeader = true;
2164 * Routing configuration for HTCP multicast purging. Add elements here to
2165 * enable HTCP and determine which purges are sent where. If set to an empty
2166 * array, HTCP is disabled.
2168 * Each key in this array is a regular expression to match against the purged
2169 * URL, or an empty string to match all URLs. The purged URL is matched against
2170 * the regexes in the order specified, and the first rule whose regex matches
2171 * is used.
2173 * Example configuration to send purges for upload.wikimedia.org to one
2174 * multicast group and all other purges to another:
2175 * @code
2176 * $wgHTCPMulticastRouting = array(
2177 * '|^https?://upload\.wikimedia\.org|' => array(
2178 * 'host' => '239.128.0.113',
2179 * 'port' => 4827,
2180 * ),
2181 * '' => array(
2182 * 'host' => '239.128.0.112',
2183 * 'port' => 4827,
2184 * ),
2185 * );
2186 * @endcode
2188 * @since 1.20
2190 * @see $wgHTCPMulticastTTL
2192 $wgHTCPMulticastRouting = array();
2195 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
2197 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
2198 * present in the earliest Squid implementations of the protocol.
2200 * This setting is DEPRECATED in favor of $wgHTCPMulticastRouting , and kept
2201 * for backwards compatibility only. If $wgHTCPMulticastRouting is set, this
2202 * setting is ignored. If $wgHTCPMulticastRouting is not set and this setting
2203 * is, it is used to populate $wgHTCPMulticastRouting.
2205 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting
2207 $wgHTCPMulticastAddress = false;
2210 * HTCP multicast port.
2211 * @deprecated since 1.20 in favor of $wgHTCPMulticastRouting
2212 * @see $wgHTCPMulticastAddress
2214 $wgHTCPPort = 4827;
2217 * HTCP multicast TTL.
2218 * @see $wgHTCPMulticastRouting
2220 $wgHTCPMulticastTTL = 1;
2222 /** Should forwarded Private IPs be accepted? */
2223 $wgUsePrivateIPs = false;
2225 /** @} */ # end of HTTP proxy settings
2227 /************************************************************************//**
2228 * @name Language, regional and character encoding settings
2229 * @{
2233 * Site language code. See languages/Names.php for languages supported by
2234 * MediaWiki out of the box. Not all languages listed there have translations,
2235 * see languages/messages/ for the list of languages with some localisation.
2237 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2238 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2240 * This defines the default interface language for all users, but users can
2241 * change it in their preferences.
2243 * This also defines the language of pages in the wiki. The content is wrapped
2244 * in a html element with lang=XX attribute. This behavior can be overridden
2245 * via hooks, see Title::getPageLanguage.
2247 $wgLanguageCode = 'en';
2250 * Language cache size, or really how many languages can we handle
2251 * simultaneously without degrading to crawl speed.
2253 $wgLangObjCacheSize = 10;
2256 * Some languages need different word forms, usually for different cases.
2257 * Used in Language::convertGrammar().
2259 * @par Example:
2260 * @code
2261 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2262 * @endcode
2264 $wgGrammarForms = array();
2266 /** Treat language links as magic connectors, not inline links */
2267 $wgInterwikiMagic = true;
2269 /** Hide interlanguage links from the sidebar */
2270 $wgHideInterlanguageLinks = false;
2272 /** List of language names or overrides for default names in Names.php */
2273 $wgExtraLanguageNames = array();
2276 * List of language codes that don't correspond to an actual language.
2277 * These codes are mostly left-offs from renames, or other legacy things.
2278 * This array makes them not appear as a selectable language on the installer,
2279 * and excludes them when running the transstat.php script.
2281 $wgDummyLanguageCodes = array(
2282 'als' => 'gsw',
2283 'bat-smg' => 'sgs',
2284 'be-x-old' => 'be-tarask',
2285 'bh' => 'bho',
2286 'fiu-vro' => 'vro',
2287 'no' => 'nb',
2288 'qqq' => 'qqq', # Used for message documentation.
2289 'qqx' => 'qqx', # Used for viewing message keys.
2290 'roa-rup' => 'rup',
2291 'simple' => 'en',
2292 'zh-classical' => 'lzh',
2293 'zh-min-nan' => 'nan',
2294 'zh-yue' => 'yue',
2298 * Character set for use in the article edit box. Language-specific encodings
2299 * may be defined.
2301 * This historic feature is one of the first that was added by former MediaWiki
2302 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2304 $wgEditEncoding = '';
2307 * Set this to true to replace Arabic presentation forms with their standard
2308 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2309 * set to "ar".
2311 * Note that pages with titles containing presentation forms will become
2312 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2314 $wgFixArabicUnicode = true;
2317 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2318 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2319 * set to "ml". Note that some clients (even new clients as of 2010) do not
2320 * support these characters.
2322 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2323 * fix any ZWJ sequences in existing page titles.
2325 $wgFixMalayalamUnicode = true;
2328 * Set this to always convert certain Unicode sequences to modern ones
2329 * regardless of the content language. This has a small performance
2330 * impact.
2332 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2333 * details.
2335 * @since 1.17
2337 $wgAllUnicodeFixes = false;
2340 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2341 * loading old revisions not marked with "utf-8" flag. Use this when
2342 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2343 * burdensome mass conversion of old text data.
2345 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2346 * user names, etc still must be converted en masse in the database before
2347 * continuing as a UTF-8 wiki.
2349 $wgLegacyEncoding = false;
2352 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2353 * regexps : "/regexp/" matching problematic browsers. These browsers will
2354 * be served encoded unicode in the edit box instead of real unicode.
2356 $wgBrowserBlackList = array(
2358 * Netscape 2-4 detection
2359 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2360 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2361 * with a negative assertion. The [UIN] identifier specifies the level of security
2362 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2363 * The language string is unreliable, it is missing on NS4 Mac.
2365 * Reference: http://www.psychedelix.com/agents/index.shtml
2367 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2368 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2369 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2372 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>, Þ to <THORN> and Ð to <ETH>
2374 * Known useragents:
2375 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2376 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2377 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2378 * - [...]
2380 * @link http://en.wikipedia.org/w/index.php?title=User%3A%C6var_Arnfj%F6r%F0_Bjarmason%2Ftestme&diff=12356041&oldid=12355864
2381 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2383 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2386 * Google wireless transcoder, seems to eat a lot of chars alive
2387 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2389 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2393 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2394 * create stub reference rows in the text table instead of copying
2395 * the full text of all current entries from 'cur' to 'text'.
2397 * This will speed up the conversion step for large sites, but
2398 * requires that the cur table be kept around for those revisions
2399 * to remain viewable.
2401 * This option affects the updaters *only*. Any present cur stub
2402 * revisions will be readable at runtime regardless of this setting.
2404 $wgLegacySchemaConversion = false;
2407 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2408 * the interface is set to English.
2410 $wgAmericanDates = false;
2412 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2413 * numerals in interface.
2415 $wgTranslateNumerals = true;
2418 * Translation using MediaWiki: namespace.
2419 * Interface messages will be loaded from the database.
2421 $wgUseDatabaseMessages = true;
2424 * Expiry time for the message cache key
2426 $wgMsgCacheExpiry = 86400;
2429 * Maximum entry size in the message cache, in bytes
2431 $wgMaxMsgCacheEntrySize = 10000;
2433 /** Whether to enable language variant conversion. */
2434 $wgDisableLangConversion = false;
2436 /** Whether to enable language variant conversion for links. */
2437 $wgDisableTitleConversion = false;
2439 /** Whether to enable canonical language links in meta data. */
2440 $wgCanonicalLanguageLinks = true;
2442 /** Default variant code, if false, the default will be the language code */
2443 $wgDefaultLanguageVariant = false;
2446 * Disabled variants array of language variant conversion.
2448 * @par Example:
2449 * @code
2450 * $wgDisabledVariants[] = 'zh-mo';
2451 * $wgDisabledVariants[] = 'zh-my';
2452 * @endcode
2454 $wgDisabledVariants = array();
2457 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2458 * path format that describes which parts of the URL contain the
2459 * language variant.
2461 * @par Example:
2462 * @code
2463 * $wgLanguageCode = 'sr';
2464 * $wgVariantArticlePath = '/$2/$1';
2465 * $wgArticlePath = '/wiki/$1';
2466 * @endcode
2468 * A link to /wiki/ would be redirected to /sr/Главна_страна
2470 * It is important that $wgArticlePath not overlap with possible values
2471 * of $wgVariantArticlePath.
2473 $wgVariantArticlePath = false;
2476 * Show a bar of language selection links in the user login and user
2477 * registration forms; edit the "loginlanguagelinks" message to
2478 * customise these.
2480 $wgLoginLanguageSelector = false;
2483 * When translating messages with wfMessage(), it is not always clear what
2484 * should be considered UI messages and what should be content messages.
2486 * For example, for the English Wikipedia, there should be only one 'mainpage',
2487 * so when getting the link for 'mainpage', we should treat it as site content
2488 * and call ->inContentLanguage()->text(), but for rendering the text of the
2489 * link, we call ->text(). The code behaves this way by default. However,
2490 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2491 * and the like for different languages. This array provides a way to override
2492 * the default behavior.
2494 * @par Example:
2495 * To allow language-specific main page and community
2496 * portal:
2497 * @code
2498 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2499 * @endcode
2501 $wgForceUIMsgAsContentMsg = array();
2504 * Fake out the timezone that the server thinks it's in. This will be used for
2505 * date display and not for what's stored in the DB. Leave to null to retain
2506 * your server's OS-based timezone value.
2508 * This variable is currently used only for signature formatting and for local
2509 * time/date parser variables ({{LOCALTIME}} etc.)
2511 * Timezones can be translated by editing MediaWiki messages of type
2512 * timezone-nameinlowercase like timezone-utc.
2514 * A list of usable timezones can found at:
2515 * http://php.net/manual/en/timezones.php
2517 * @par Examples:
2518 * @code
2519 * $wgLocaltimezone = 'UTC';
2520 * $wgLocaltimezone = 'GMT';
2521 * $wgLocaltimezone = 'PST8PDT';
2522 * $wgLocaltimezone = 'Europe/Sweden';
2523 * $wgLocaltimezone = 'CET';
2524 * @endcode
2526 $wgLocaltimezone = null;
2529 * Set an offset from UTC in minutes to use for the default timezone setting
2530 * for anonymous users and new user accounts.
2532 * This setting is used for most date/time displays in the software, and is
2533 * overridable in user preferences. It is *not* used for signature timestamps.
2535 * By default, this will be set to match $wgLocaltimezone.
2537 $wgLocalTZoffset = null;
2539 /** @} */ # End of language/charset settings
2541 /*************************************************************************//**
2542 * @name Output format and skin settings
2543 * @{
2546 /** The default Content-Type header. */
2547 $wgMimeType = 'text/html';
2550 * Previously used as content type in HTML script tags. This is now ignored since
2551 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2552 * It was also previously used by RawAction to determine the ctype query parameter
2553 * value that will result in a javascript response.
2554 * @deprecated since 1.22
2556 $wgJsMimeType = null;
2559 * The default xmlns attribute. The option to define this has been removed.
2560 * The value of this variable is no longer used by core and is set to a fixed
2561 * value in Setup.php for compatibility with extensions that depend on the value
2562 * of this variable being set. Such a dependency however is deprecated.
2563 * @deprecated since 1.22
2565 $wgXhtmlDefaultNamespace = null;
2568 * Previously used to determine if we should output an HTML5 doctype.
2569 * This is no longer used as we always output HTML5 now. For compatibility with
2570 * extensions that still check the value of this config it's value is now forced
2571 * to true by Setup.php.
2572 * @deprecated since 1.22
2574 $wgHtml5 = true;
2577 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2578 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2579 * (like if it's left at the default null value), it will be auto-initialized
2580 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2581 * ever actually set this to anything.
2583 $wgHtml5Version = null;
2586 * Enabled RDFa attributes for use in wikitext.
2587 * NOTE: Interaction with HTML5 is somewhat underspecified.
2589 $wgAllowRdfaAttributes = false;
2592 * Enabled HTML5 microdata attributes for use in wikitext.
2594 $wgAllowMicrodataAttributes = false;
2597 * Should we try to make our HTML output well-formed XML? If set to false,
2598 * output will be a few bytes shorter, and the HTML will arguably be more
2599 * readable. If set to true, life will be much easier for the authors of
2600 * screen-scraping bots, and the HTML will arguably be more readable.
2602 * Setting this to false may omit quotation marks on some attributes, omit
2603 * slashes from some self-closing tags, omit some ending tags, etc., where
2604 * permitted by HTML5. Setting it to true will not guarantee that all pages
2605 * will be well-formed, although non-well-formed pages should be rare and it's
2606 * a bug if you find one. Conversely, setting it to false doesn't mean that
2607 * all XML-y constructs will be omitted, just that they might be.
2609 * Because of compatibility with screen-scraping bots, and because it's
2610 * controversial, this is currently left to true by default.
2612 $wgWellFormedXml = true;
2615 * Permit other namespaces in addition to the w3.org default.
2617 * Use the prefix for the key and the namespace for the value.
2619 * @par Example:
2620 * @code
2621 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2622 * @endcode
2623 * Normally we wouldn't have to define this in the root "<html>"
2624 * element, but IE needs it there in some circumstances.
2626 * This is ignored if $wgMimeType is set to a non-XML mimetype.
2628 $wgXhtmlNamespaces = array();
2631 * Show IP address, for non-logged in users. It's necessary to switch this off
2632 * for some forms of caching.
2633 * @warning Will disable file cache.
2635 $wgShowIPinHeader = true;
2638 * Site notice shown at the top of each page
2640 * MediaWiki:Sitenotice page, which will override this. You can also
2641 * provide a separate message for logged-out users using the
2642 * MediaWiki:Anonnotice page.
2644 $wgSiteNotice = '';
2647 * A subtitle to add to the tagline, for skins that have it/
2649 $wgExtraSubtitle = '';
2652 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2654 $wgSiteSupportPage = '';
2657 * Validate the overall output using tidy and refuse
2658 * to display the page if it's not valid.
2660 $wgValidateAllHtml = false;
2663 * Default skin, for new users and anonymous visitors. Registered users may
2664 * change this to any one of the other available skins in their preferences.
2665 * This has to be completely lowercase; see the "skins" directory for the list
2666 * of available skins.
2668 $wgDefaultSkin = 'vector';
2671 * Specify the name of a skin that should not be presented in the list of
2672 * available skins. Use for blacklisting a skin which you do not want to
2673 * remove from the .../skins/ directory
2675 $wgSkipSkin = '';
2676 /** Array for more like $wgSkipSkin. */
2677 $wgSkipSkins = array();
2680 * Allow user Javascript page?
2681 * This enables a lot of neat customizations, but may
2682 * increase security risk to users and server load.
2684 $wgAllowUserJs = false;
2687 * Allow user Cascading Style Sheets (CSS)?
2688 * This enables a lot of neat customizations, but may
2689 * increase security risk to users and server load.
2691 $wgAllowUserCss = false;
2694 * Allow user-preferences implemented in CSS?
2695 * This allows users to customise the site appearance to a greater
2696 * degree; disabling it will improve page load times.
2698 $wgAllowUserCssPrefs = true;
2700 /** Use the site's Javascript page? */
2701 $wgUseSiteJs = true;
2703 /** Use the site's Cascading Style Sheets (CSS)? */
2704 $wgUseSiteCss = true;
2707 * Break out of framesets. This can be used to prevent clickjacking attacks,
2708 * or to prevent external sites from framing your site with ads.
2710 $wgBreakFrames = false;
2713 * The X-Frame-Options header to send on pages sensitive to clickjacking
2714 * attacks, such as edit pages. This prevents those pages from being displayed
2715 * in a frame or iframe. The options are:
2717 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2719 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
2720 * to allow framing within a trusted domain. This is insecure if there
2721 * is a page on the same domain which allows framing of arbitrary URLs.
2723 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
2724 * full compromise of local user accounts. Private wikis behind a
2725 * corporate firewall are especially vulnerable. This is not
2726 * recommended.
2728 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
2729 * not just edit pages.
2731 $wgEditPageFrameOptions = 'DENY';
2734 * Disallow framing of API pages directly, by setting the X-Frame-Options
2735 * header. Since the API returns CSRF tokens, allowing the results to be
2736 * framed can compromise your user's account security.
2737 * Options are:
2738 * - 'DENY': Do not allow framing. This is recommended for most wikis.
2739 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
2740 * - false: Allow all framing.
2742 $wgApiFrameOptions = 'DENY';
2745 * Disable output compression (enabled by default if zlib is available)
2747 $wgDisableOutputCompression = false;
2750 * Should we allow a broader set of characters in id attributes, per HTML5? If
2751 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
2752 * functionality is ready, it will be on by default with no option.
2754 * Currently this appears to work fine in all browsers, but it's disabled by
2755 * default because it normalizes id's a bit too aggressively, breaking preexisting
2756 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
2758 $wgExperimentalHtmlIds = false;
2761 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
2762 * You can add new icons to the built in copyright or poweredby, or you can create
2763 * a new block. Though note that you may need to add some custom css to get good styling
2764 * of new blocks in monobook. vector and modern should work without any special css.
2766 * $wgFooterIcons itself is a key/value array.
2767 * The key is the name of a block that the icons will be wrapped in. The final id varies
2768 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
2769 * turns it into mw_poweredby.
2770 * The value is either key/value array of icons or a string.
2771 * In the key/value array the key may or may not be used by the skin but it can
2772 * be used to find the icon and unset it or change the icon if needed.
2773 * This is useful for disabling icons that are set by extensions.
2774 * The value should be either a string or an array. If it is a string it will be output
2775 * directly as html, however some skins may choose to ignore it. An array is the preferred format
2776 * for the icon, the following keys are used:
2777 * - src: An absolute url to the image to use for the icon, this is recommended
2778 * but not required, however some skins will ignore icons without an image
2779 * - url: The url to use in the a element around the text or icon, if not set an a element will not be outputted
2780 * - alt: This is the text form of the icon, it will be displayed without an image in
2781 * skins like Modern or if src is not set, and will otherwise be used as
2782 * the alt="" for the image. This key is required.
2783 * - width and height: If the icon specified by src is not of the standard size
2784 * you can specify the size of image to use with these keys.
2785 * Otherwise they will default to the standard 88x31.
2786 * @todo Reformat documentation.
2788 $wgFooterIcons = array(
2789 "copyright" => array(
2790 "copyright" => array(), // placeholder for the built in copyright icon
2792 "poweredby" => array(
2793 "mediawiki" => array(
2794 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
2795 "url" => "//www.mediawiki.org/",
2796 "alt" => "Powered by MediaWiki",
2802 * Login / create account link behavior when it's possible for anonymous users
2803 * to create an account.
2804 * - true = use a combined login / create account link
2805 * - false = split login and create account into two separate links
2807 $wgUseCombinedLoginLink = false;
2810 * Search form look for Vector skin only.
2811 * - true = use an icon search button
2812 * - false = use Go & Search buttons
2814 $wgVectorUseSimpleSearch = true;
2817 * Watch and unwatch as an icon rather than a link for Vector skin only.
2818 * - true = use an icon watch/unwatch button
2819 * - false = use watch/unwatch text link
2821 $wgVectorUseIconWatch = true;
2824 * Display user edit counts in various prominent places.
2826 $wgEdititis = false;
2829 * Better directionality support (bug 6100 and related).
2830 * Removed in 1.18, still kept here for LiquidThreads backwards compatibility.
2832 * @deprecated since 1.18
2834 $wgBetterDirectionality = true;
2837 * Some web hosts attempt to rewrite all responses with a 404 (not found)
2838 * status code, mangling or hiding MediaWiki's output. If you are using such a
2839 * host, you should start looking for a better one. While you're doing that,
2840 * set this to false to convert some of MediaWiki's 404 responses to 200 so
2841 * that the generated error pages can be seen.
2843 * In cases where for technical reasons it is more important for MediaWiki to
2844 * send the correct status code than for the body to be transmitted intact,
2845 * this configuration variable is ignored.
2847 $wgSend404Code = true;
2850 * The $wgShowRollbackEditCount variable is used to show how many edits will be
2851 * rollback. The numeric value of the variable are the limit up to are counted.
2852 * If the value is false or 0, the edits are not counted. Disabling this will
2853 * furthermore prevent MediaWiki from hiding some useless rollback links.
2855 * @since 1.20
2857 $wgShowRollbackEditCount = 10;
2860 * Output a <link rel="canonical"> tag on every page indicating the canonical
2861 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
2862 * detection of the current server is unreliable, the link is sent
2863 * unconditionally.
2865 $wgEnableCanonicalServerLink = false;
2867 /** @} */ # End of output format settings }
2869 /*************************************************************************//**
2870 * @name Resource loader settings
2871 * @{
2875 * Client-side resource modules.
2877 * Extensions should add their resource loader module definitions
2878 * to the $wgResourceModules variable.
2880 * @par Example:
2881 * @code
2882 * $wgResourceModules['ext.myExtension'] = array(
2883 * 'scripts' => 'myExtension.js',
2884 * 'styles' => 'myExtension.css',
2885 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
2886 * 'localBasePath' => __DIR__,
2887 * 'remoteExtPath' => 'MyExtension',
2888 * );
2889 * @endcode
2891 $wgResourceModules = array();
2894 * Extensions should register foreign module sources here. 'local' is a
2895 * built-in source that is not in this array, but defined by
2896 * ResourceLoader::__construct() so that it cannot be unset.
2898 * @par Example:
2899 * @code
2900 * $wgResourceLoaderSources['foo'] = array(
2901 * 'loadScript' => 'http://example.org/w/load.php',
2902 * 'apiScript' => 'http://example.org/w/api.php'
2903 * );
2904 * @endcode
2906 $wgResourceLoaderSources = array();
2909 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
2910 * If not set, then $wgScriptPath will be used as a fallback.
2912 $wgResourceBasePath = null;
2915 * Maximum time in seconds to cache resources served by the resource loader.
2917 * @todo Document array structure
2919 $wgResourceLoaderMaxage = array(
2920 'versioned' => array(
2921 // Squid/Varnish but also any other public proxy cache between the client and MediaWiki
2922 'server' => 30 * 24 * 60 * 60, // 30 days
2923 // On the client side (e.g. in the browser cache).
2924 'client' => 30 * 24 * 60 * 60, // 30 days
2926 'unversioned' => array(
2927 'server' => 5 * 60, // 5 minutes
2928 'client' => 5 * 60, // 5 minutes
2933 * The default debug mode (on/off) for of ResourceLoader requests.
2935 * This will still be overridden when the debug URL parameter is used.
2937 $wgResourceLoaderDebug = false;
2940 * Enable embedding of certain resources using Edge Side Includes. This will
2941 * improve performance but only works if there is something in front of the
2942 * web server (e..g a Squid or Varnish server) configured to process the ESI.
2944 $wgResourceLoaderUseESI = false;
2947 * Put each statement on its own line when minifying JavaScript. This makes
2948 * debugging in non-debug mode a bit easier.
2950 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
2953 * Maximum line length when minifying JavaScript. This is not a hard maximum:
2954 * the minifier will try not to produce lines longer than this, but may be
2955 * forced to do so in certain cases.
2957 $wgResourceLoaderMinifierMaxLineLength = 1000;
2960 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
2961 * dependencies.
2963 $wgIncludeLegacyJavaScript = true;
2966 * Whether to preload the mediawiki.util module as blocking module in the top
2967 * queue.
2969 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
2970 * allowed modules to lack dependencies on 'popular' modules that were likely
2971 * loaded already.
2973 * This setting is to aid scripts during migration by providing mediawiki.util
2974 * unconditionally (which was the most commonly missed dependency).
2975 * It doesn't cover all missing dependencies obviously but should fix most of
2976 * them.
2978 * This should be removed at some point after site/user scripts have been fixed.
2979 * Enable this if your wiki has a large amount of user/site scripts that are
2980 * lacking dependencies.
2981 * @todo Deprecate
2983 $wgPreloadJavaScriptMwUtil = false;
2986 * Whether or not to assign configuration variables to the global window object.
2988 * If this is set to false, old code using deprecated variables will no longer
2989 * work.
2991 * @par Example of legacy code:
2992 * @code{,js}
2993 * if ( window.wgRestrictionEdit ) { ... }
2994 * @endcode
2995 * or:
2996 * @code{,js}
2997 * if ( wgIsArticle ) { ... }
2998 * @endcode
3000 * Instead, one needs to use mw.config.
3001 * @par Example using mw.config global configuration:
3002 * @code{,js}
3003 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3004 * @endcode
3005 * or:
3006 * @code{,js}
3007 * if ( mw.config.get('wgIsArticle') ) { ... }
3008 * @endcode
3010 $wgLegacyJavaScriptGlobals = true;
3013 * If set to a positive number, ResourceLoader will not generate URLs whose
3014 * query string is more than this many characters long, and will instead use
3015 * multiple requests with shorter query strings. This degrades performance,
3016 * but may be needed if your web server has a low (less than, say 1024)
3017 * query string length limit or a low value for suhosin.get.max_value_length
3018 * that you can't increase.
3020 * If set to a negative number, ResourceLoader will assume there is no query
3021 * string length limit.
3023 $wgResourceLoaderMaxQueryLength = -1;
3026 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3027 * prior to minification to validate it.
3029 * Parse errors will result in a JS exception being thrown during module load,
3030 * which avoids breaking other modules loaded in the same request.
3032 $wgResourceLoaderValidateJS = true;
3035 * If set to true, statically-sourced (file-backed) JavaScript resources will
3036 * be parsed for validity before being bundled up into ResourceLoader modules.
3038 * This can be helpful for development by providing better error messages in
3039 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3040 * and may fail on large pre-bundled frameworks.
3042 $wgResourceLoaderValidateStaticJS = false;
3045 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3046 * will be enabled. This is an experimental feature that's supposed to make
3047 * JavaScript load faster.
3049 $wgResourceLoaderExperimentalAsyncLoading = false;
3051 /** @} */ # End of resource loader settings }
3053 /*************************************************************************//**
3054 * @name Page title and interwiki link settings
3055 * @{
3059 * Name of the project namespace. If left set to false, $wgSitename will be
3060 * used instead.
3062 $wgMetaNamespace = false;
3065 * Name of the project talk namespace.
3067 * Normally you can ignore this and it will be something like
3068 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3069 * manually for grammatical reasons.
3071 $wgMetaNamespaceTalk = false;
3074 * Additional namespaces. If the namespaces defined in Language.php and
3075 * Namespace.php are insufficient, you can create new ones here, for example,
3076 * to import Help files in other languages. You can also override the namespace
3077 * names of existing namespaces. Extensions developers should use
3078 * $wgCanonicalNamespaceNames.
3080 * @warning Once you delete a namespace, the pages in that namespace will
3081 * no longer be accessible. If you rename it, then you can access them through
3082 * the new namespace name.
3084 * Custom namespaces should start at 100 to avoid conflicting with standard
3085 * namespaces, and should always follow the even/odd main/talk pattern.
3087 * @par Example:
3088 * @code
3089 * $wgExtraNamespaces = array(
3090 * 100 => "Hilfe",
3091 * 101 => "Hilfe_Diskussion",
3092 * 102 => "Aide",
3093 * 103 => "Discussion_Aide"
3094 * );
3095 * @endcode
3097 * @todo Add a note about maintenance/namespaceDupes.php
3099 $wgExtraNamespaces = array();
3102 * Same as above, but for namespaces with gender distinction.
3103 * Note: the default form for the namespace should also be set
3104 * using $wgExtraNamespaces for the same index.
3105 * @since 1.18
3107 $wgExtraGenderNamespaces = array();
3110 * Namespace aliases.
3112 * These are alternate names for the primary localised namespace names, which
3113 * are defined by $wgExtraNamespaces and the language file. If a page is
3114 * requested with such a prefix, the request will be redirected to the primary
3115 * name.
3117 * Set this to a map from namespace names to IDs.
3119 * @par Example:
3120 * @code
3121 * $wgNamespaceAliases = array(
3122 * 'Wikipedian' => NS_USER,
3123 * 'Help' => 100,
3124 * );
3125 * @endcode
3127 $wgNamespaceAliases = array();
3130 * Allowed title characters -- regex character class
3131 * Don't change this unless you know what you're doing
3133 * Problematic punctuation:
3134 * - []{}|# Are needed for link syntax, never enable these
3135 * - <> Causes problems with HTML escaping, don't use
3136 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3137 * - + Enabled by default, but doesn't work with path to query rewrite rules, corrupted by apache
3138 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3140 * All three of these punctuation problems can be avoided by using an alias,
3141 * instead of a rewrite rule of either variety.
3143 * The problem with % is that when using a path to query rewrite rule, URLs are
3144 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3145 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3146 * for this, indeed double escaping would break if the double-escaped title was
3147 * passed in the query string rather than the path. This is a minor security issue
3148 * because articles can be created such that they are hard to view or edit.
3150 * In some rare cases you may wish to remove + for compatibility with old links.
3152 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3153 * this breaks interlanguage links
3155 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3158 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3160 $wgLocalInterwiki = false;
3163 * Expiry time for cache of interwiki table
3165 $wgInterwikiExpiry = 10800;
3168 * @name Interwiki caching settings.
3169 * @{
3172 *$wgInterwikiCache specifies path to constant database file.
3174 * This cdb database is generated by dumpInterwiki from maintenance and has
3175 * such key formats:
3176 * - dbname:key - a simple key (e.g. enwiki:meta)
3177 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3178 * - __global:key - global-scope key (e.g. __global:meta)
3179 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3181 * Sites mapping just specifies site name, other keys provide "local url"
3182 * data layout.
3184 $wgInterwikiCache = false;
3186 * Specify number of domains to check for messages.
3187 * - 1: Just wiki(db)-level
3188 * - 2: wiki and global levels
3189 * - 3: site levels
3191 $wgInterwikiScopes = 3;
3193 * $wgInterwikiFallbackSite - if unable to resolve from cache
3195 $wgInterwikiFallbackSite = 'wiki';
3196 /** @} */ # end of Interwiki caching settings.
3199 * If local interwikis are set up which allow redirects,
3200 * set this regexp to restrict URLs which will be displayed
3201 * as 'redirected from' links.
3203 * @par Example:
3204 * It might look something like this:
3205 * @code
3206 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3207 * @endcode
3209 * Leave at false to avoid displaying any incoming redirect markers.
3210 * This does not affect intra-wiki redirects, which don't change
3211 * the URL.
3213 $wgRedirectSources = false;
3216 * Set this to false to avoid forcing the first letter of links to capitals.
3218 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3219 * appearing with a capital at the beginning of a sentence will *not* go to the
3220 * same place as links in the middle of a sentence using a lowercase initial.
3222 $wgCapitalLinks = true;
3225 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3226 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3227 * true by default (and setting them has no effect), due to various things that
3228 * require them to be so. Also, since Talk namespaces need to directly mirror their
3229 * associated content namespaces, the values for those are ignored in favor of the
3230 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3231 * NS_FILE.
3233 * @par Example:
3234 * @code
3235 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3236 * @endcode
3238 $wgCapitalLinkOverrides = array();
3240 /** Which namespaces should support subpages?
3241 * See Language.php for a list of namespaces.
3243 $wgNamespacesWithSubpages = array(
3244 NS_TALK => true,
3245 NS_USER => true,
3246 NS_USER_TALK => true,
3247 NS_PROJECT => true,
3248 NS_PROJECT_TALK => true,
3249 NS_FILE_TALK => true,
3250 NS_MEDIAWIKI => true,
3251 NS_MEDIAWIKI_TALK => true,
3252 NS_TEMPLATE_TALK => true,
3253 NS_HELP => true,
3254 NS_HELP_TALK => true,
3255 NS_CATEGORY_TALK => true
3259 * Array of namespaces which can be deemed to contain valid "content", as far
3260 * as the site statistics are concerned. Useful if additional namespaces also
3261 * contain "content" which should be considered when generating a count of the
3262 * number of articles in the wiki.
3264 $wgContentNamespaces = array( NS_MAIN );
3267 * Max number of redirects to follow when resolving redirects.
3268 * 1 means only the first redirect is followed (default behavior).
3269 * 0 or less means no redirects are followed.
3271 $wgMaxRedirects = 1;
3274 * Array of invalid page redirect targets.
3275 * Attempting to create a redirect to any of the pages in this array
3276 * will make the redirect fail.
3277 * Userlogout is hard-coded, so it does not need to be listed here.
3278 * (bug 10569) Disallow Mypage and Mytalk as well.
3280 * As of now, this only checks special pages. Redirects to pages in
3281 * other namespaces cannot be invalidated by this variable.
3283 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3285 /** @} */ # End of title and interwiki settings }
3287 /************************************************************************//**
3288 * @name Parser settings
3289 * These settings configure the transformation from wikitext to HTML.
3290 * @{
3294 * Parser configuration. Associative array with the following members:
3296 * class The class name
3298 * preprocessorClass The preprocessor class. Two classes are currently available:
3299 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3300 * storage, and Preprocessor_DOM, which uses the DOM module for
3301 * temporary storage. Preprocessor_DOM generally uses less memory;
3302 * the speed of the two is roughly the same.
3304 * If this parameter is not given, it uses Preprocessor_DOM if the
3305 * DOM module is available, otherwise it uses Preprocessor_Hash.
3307 * The entire associative array will be passed through to the constructor as
3308 * the first parameter. Note that only Setup.php can use this variable --
3309 * the configuration will change at runtime via $wgParser member functions, so
3310 * the contents of this variable will be out-of-date. The variable can only be
3311 * changed during LocalSettings.php, in particular, it can't be changed during
3312 * an extension setup function.
3314 $wgParserConf = array(
3315 'class' => 'Parser',
3316 #'preprocessorClass' => 'Preprocessor_Hash',
3319 /** Maximum indent level of toc. */
3320 $wgMaxTocLevel = 999;
3323 * A complexity limit on template expansion: the maximum number of nodes visited
3324 * by PPFrame::expand()
3326 $wgMaxPPNodeCount = 1000000;
3329 * A complexity limit on template expansion: the maximum number of elements
3330 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3331 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3332 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3333 * this default corresponds to about 155 MB.
3335 * When the limit is exceeded, an exception is thrown.
3337 $wgMaxGeneratedPPNodeCount = 1000000;
3340 * Maximum recursion depth for templates within templates.
3341 * The current parser adds two levels to the PHP call stack for each template,
3342 * and xdebug limits the call stack to 100 by default. So this should hopefully
3343 * stop the parser before it hits the xdebug limit.
3345 $wgMaxTemplateDepth = 40;
3347 /** @see $wgMaxTemplateDepth */
3348 $wgMaxPPExpandDepth = 40;
3350 /** The external URL protocols */
3351 $wgUrlProtocols = array(
3352 'http://',
3353 'https://',
3354 'ftp://',
3355 'ftps://', // If we allow ftp:// we should allow the secure version.
3356 'ssh://',
3357 'sftp://', // SFTP > FTP
3358 'irc://',
3359 'ircs://', // @bug 28503
3360 'xmpp:', // Another open communication protocol
3361 'sip:',
3362 'sips:',
3363 'gopher://',
3364 'telnet://', // Well if we're going to support the above.. -ævar
3365 'nntp://', // @bug 3808 RFC 1738
3366 'worldwind://',
3367 'mailto:',
3368 'tel:', // If we can make emails linkable, why not phone numbers?
3369 'sms:', // Likewise this is standardized too
3370 'news:',
3371 'svn://',
3372 'git://',
3373 'mms://',
3374 'bitcoin:', // Even registerProtocolHandler whitelists this along with mailto:
3375 'magnet:', // No reason to reject torrents over magnet: when they're allowed over http://
3376 'urn:', // Allow URNs to be used in Microdata/RDFa <link ... href="urn:...">s
3377 'geo:', // geo: urls define locations, they're useful in Microdata/RDFa and when mentioning coordinates.
3378 '//', // for protocol-relative URLs
3382 * If true, removes (substitutes) templates in "~~~~" signatures.
3384 $wgCleanSignatures = true;
3386 /** Whether to allow inline image pointing to other websites */
3387 $wgAllowExternalImages = false;
3390 * If the above is false, you can specify an exception here. Image URLs
3391 * that start with this string are then rendered, while all others are not.
3392 * You can use this to set up a trusted, simple repository of images.
3393 * You may also specify an array of strings to allow multiple sites
3395 * @par Examples:
3396 * @code
3397 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3398 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3399 * @endcode
3401 $wgAllowExternalImagesFrom = '';
3403 /** If $wgAllowExternalImages is false, you can allow an on-wiki
3404 * whitelist of regular expression fragments to match the image URL
3405 * against. If the image matches one of the regular expression fragments,
3406 * The image will be displayed.
3408 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3409 * Or false to disable it
3411 $wgEnableImageWhitelist = true;
3414 * A different approach to the above: simply allow the "<img>" tag to be used.
3415 * This allows you to specify alt text and other attributes, copy-paste HTML to
3416 * your wiki more easily, etc. However, allowing external images in any manner
3417 * will allow anyone with editing rights to snoop on your visitors' IP
3418 * addresses and so forth, if they wanted to, by inserting links to images on
3419 * sites they control.
3421 $wgAllowImageTag = false;
3424 * $wgUseTidy: use tidy to make sure HTML output is sane.
3425 * Tidy is a free tool that fixes broken HTML.
3426 * See http://www.w3.org/People/Raggett/tidy/
3428 * - $wgTidyBin should be set to the path of the binary and
3429 * - $wgTidyConf to the path of the configuration file.
3430 * - $wgTidyOpts can include any number of parameters.
3431 * - $wgTidyInternal controls the use of the PECL extension or the
3432 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3433 * of spawning a separate program.
3434 * Normally you shouldn't need to override the setting except for
3435 * debugging. To install, use 'pear install tidy' and add a line
3436 * 'extension=tidy.so' to php.ini.
3438 $wgUseTidy = false;
3439 /** @see $wgUseTidy */
3440 $wgAlwaysUseTidy = false;
3441 /** @see $wgUseTidy */
3442 $wgTidyBin = 'tidy';
3443 /** @see $wgUseTidy */
3444 $wgTidyConf = $IP . '/includes/tidy.conf';
3445 /** @see $wgUseTidy */
3446 $wgTidyOpts = '';
3447 /** @see $wgUseTidy */
3448 $wgTidyInternal = extension_loaded( 'tidy' );
3451 * Put tidy warnings in HTML comments
3452 * Only works for internal tidy.
3454 $wgDebugTidy = false;
3456 /** Allow raw, unchecked HTML in "<html>...</html>" sections.
3457 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
3458 * TO RESTRICT EDITING to only those that you trust
3460 $wgRawHtml = false;
3463 * Set a default target for external links, e.g. _blank to pop up a new window
3465 $wgExternalLinkTarget = false;
3468 * If true, external URL links in wiki text will be given the
3469 * rel="nofollow" attribute as a hint to search engines that
3470 * they should not be followed for ranking purposes as they
3471 * are user-supplied and thus subject to spamming.
3473 $wgNoFollowLinks = true;
3476 * Namespaces in which $wgNoFollowLinks doesn't apply.
3477 * See Language.php for a list of namespaces.
3479 $wgNoFollowNsExceptions = array();
3482 * If this is set to an array of domains, external links to these domain names
3483 * (or any subdomains) will not be set to rel="nofollow" regardless of the
3484 * value of $wgNoFollowLinks. For instance:
3486 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org' );
3488 * This would add rel="nofollow" to links to de.wikipedia.org, but not
3489 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
3490 * etc.
3492 $wgNoFollowDomainExceptions = array();
3495 * Allow DISPLAYTITLE to change title display
3497 $wgAllowDisplayTitle = true;
3500 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
3501 * canonical DB key. Also disallow some inline CSS rules like display: none;
3502 * which can cause the text to be hidden or unselectable.
3504 $wgRestrictDisplayTitle = true;
3507 * Maximum number of calls per parse to expensive parser functions such as
3508 * PAGESINCATEGORY.
3510 $wgExpensiveParserFunctionLimit = 100;
3513 * Preprocessor caching threshold
3514 * Setting it to 'false' will disable the preprocessor cache.
3516 $wgPreprocessorCacheThreshold = 1000;
3519 * Enable interwiki transcluding. Only when iw_trans=1.
3521 $wgEnableScaryTranscluding = false;
3524 * (see next option $wgGlobalDatabase).
3526 $wgTranscludeCacheExpiry = 3600;
3528 /** @} */ # end of parser settings }
3530 /************************************************************************//**
3531 * @name Statistics
3532 * @{
3536 * Method used to determine if a page in a content namespace should be counted
3537 * as a valid article.
3539 * Redirect pages will never be counted as valid articles.
3541 * This variable can have the following values:
3542 * - 'any': all pages as considered as valid articles
3543 * - 'comma': the page must contain a comma to be considered valid
3544 * - 'link': the page must contain a [[wiki link]] to be considered valid
3545 * - null: the value will be set at run time depending on $wgUseCommaCount:
3546 * if $wgUseCommaCount is false, it will be 'link', if it is true
3547 * it will be 'comma'
3549 * See also See http://www.mediawiki.org/wiki/Manual:Article_count
3551 * Retroactively changing this variable will not affect the existing count,
3552 * to update it, you will need to run the maintenance/updateArticleCount.php
3553 * script.
3555 $wgArticleCountMethod = null;
3558 * Backward compatibility setting, will set $wgArticleCountMethod if it is null.
3559 * @deprecated since 1.18; use $wgArticleCountMethod instead
3561 $wgUseCommaCount = false;
3564 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
3565 * values are easier on the database. A value of 1 causes the counters to be
3566 * updated on every hit, any higher value n cause them to update *on average*
3567 * every n hits. Should be set to either 1 or something largish, eg 1000, for
3568 * maximum efficiency.
3570 $wgHitcounterUpdateFreq = 1;
3573 * How many days user must be idle before he is considered inactive. Will affect
3574 * the number shown on Special:Statistics, Special:ActiveUsers, and the
3575 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
3576 * You might want to leave this as the default value, to provide comparable
3577 * numbers between different wikis.
3579 $wgActiveUserDays = 30;
3581 /** @} */ # End of statistics }
3583 /************************************************************************//**
3584 * @name User accounts, authentication
3585 * @{
3588 /** For compatibility with old installations set to false */
3589 $wgPasswordSalt = true;
3592 * Specifies the minimal length of a user password. If set to 0, empty pass-
3593 * words are allowed.
3595 $wgMinimalPasswordLength = 1;
3598 * Whether to allow password resets ("enter some identifying data, and we'll send an email
3599 * with a temporary password you can use to get back into the account") identified by
3600 * various bits of data. Setting all of these to false (or the whole variable to false)
3601 * has the effect of disabling password resets entirely
3603 $wgPasswordResetRoutes = array(
3604 'username' => true,
3605 'email' => false,
3609 * Maximum number of Unicode characters in signature
3611 $wgMaxSigChars = 255;
3614 * Maximum number of bytes in username. You want to run the maintenance
3615 * script ./maintenance/checkUsernames.php once you have changed this value.
3617 $wgMaxNameChars = 255;
3620 * Array of usernames which may not be registered or logged in from
3621 * Maintenance scripts can still use these
3623 $wgReservedUsernames = array(
3624 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
3625 'Conversion script', // Used for the old Wikipedia software upgrade
3626 'Maintenance script', // Maintenance scripts which perform editing, image import script
3627 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
3628 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
3629 'msg:double-redirect-fixer', // Automatic double redirect fix
3630 'msg:usermessage-editor', // Default user for leaving user messages
3631 'msg:proxyblocker', // For Special:Blockme
3635 * Settings added to this array will override the default globals for the user
3636 * preferences used by anonymous visitors and newly created accounts.
3637 * For instance, to disable section editing links:
3638 * $wgDefaultUserOptions ['editsection'] = 0;
3640 $wgDefaultUserOptions = array(
3641 'ccmeonemails' => 0,
3642 'cols' => 80,
3643 'date' => 'default',
3644 'diffonly' => 0,
3645 'disablemail' => 0,
3646 'disablesuggest' => 0,
3647 'editfont' => 'default',
3648 'editondblclick' => 0,
3649 'editsection' => 1,
3650 'editsectiononrightclick' => 0,
3651 'enotifminoredits' => 0,
3652 'enotifrevealaddr' => 0,
3653 'enotifusertalkpages' => 1,
3654 'enotifwatchlistpages' => 0,
3655 'extendwatchlist' => 0,
3656 'fancysig' => 0,
3657 'forceeditsummary' => 0,
3658 'gender' => 'unknown',
3659 'hideminor' => 0,
3660 'hidepatrolled' => 0,
3661 'imagesize' => 2,
3662 'justify' => 0,
3663 'math' => 1,
3664 'minordefault' => 0,
3665 'newpageshidepatrolled' => 0,
3666 'nocache' => 0,
3667 'noconvertlink' => 0,
3668 'norollbackdiff' => 0,
3669 'numberheadings' => 0,
3670 'previewonfirst' => 0,
3671 'previewontop' => 1,
3672 'rcdays' => 7,
3673 'rclimit' => 50,
3674 'rememberpassword' => 0,
3675 'rows' => 25,
3676 'searchlimit' => 20,
3677 'showhiddencats' => 0,
3678 'showjumplinks' => 1,
3679 'shownumberswatching' => 1,
3680 'showtoc' => 1,
3681 'showtoolbar' => 1,
3682 'skin' => false,
3683 'stubthreshold' => 0,
3684 'thumbsize' => 2,
3685 'underline' => 2,
3686 'uselivepreview' => 0,
3687 'usenewrc' => 0,
3688 'watchcreations' => 0,
3689 'watchdefault' => 0,
3690 'watchdeletion' => 0,
3691 'watchlistdays' => 3.0,
3692 'watchlisthideanons' => 0,
3693 'watchlisthidebots' => 0,
3694 'watchlisthideliu' => 0,
3695 'watchlisthideminor' => 0,
3696 'watchlisthideown' => 0,
3697 'watchlisthidepatrolled' => 0,
3698 'watchmoves' => 0,
3699 'wllimit' => 250,
3700 'useeditwarning' => 1,
3703 /** An array of preferences to not show for the user */
3704 $wgHiddenPrefs = array();
3707 * Characters to prevent during new account creations.
3708 * This is used in a regular expression character class during
3709 * registration (regex metacharacters like / are escaped).
3711 $wgInvalidUsernameCharacters = '@';
3714 * Character used as a delimiter when testing for interwiki userrights
3715 * (In Special:UserRights, it is possible to modify users on different
3716 * databases if the delimiter is used, e.g. "Someuser@enwiki").
3718 * It is recommended that you have this delimiter in
3719 * $wgInvalidUsernameCharacters above, or you will not be able to
3720 * modify the user rights of those users via Special:UserRights
3722 $wgUserrightsInterwikiDelimiter = '@';
3725 * This is to let user authenticate using https when they come from http.
3726 * Based on an idea by George Herbert on wikitech-l:
3727 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
3728 * @since 1.17
3730 $wgSecureLogin = false;
3733 * By default, keep users logged in via HTTPS when $wgSecureLogin is also
3734 * true. Users opt-out of HTTPS when they login by de-selecting the checkbox.
3735 * @since 1.21
3737 $wgSecureLoginDefaultHTTPS = true;
3739 /** @} */ # end user accounts }
3741 /************************************************************************//**
3742 * @name User rights, access control and monitoring
3743 * @{
3747 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
3749 $wgAutoblockExpiry = 86400;
3752 * Set this to true to allow blocked users to edit their own user talk page.
3754 $wgBlockAllowsUTEdit = false;
3756 /** Allow sysops to ban users from accessing Emailuser */
3757 $wgSysopEmailBans = true;
3760 * Limits on the possible sizes of range blocks.
3762 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
3763 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
3764 * half the number of bits avoids such errors, and allows entire ISPs to be
3765 * blocked using a small number of range blocks.
3767 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
3768 * customer, so range blocks larger than /64 (half the number of bits) will
3769 * plainly be required. RFC 4692 implies that a very large ISP may be
3770 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
3771 * as our limit. As of 2012, blocking the whole world would require a /4 range.
3773 $wgBlockCIDRLimit = array(
3774 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
3775 'IPv6' => 19,
3779 * If true, blocked users will not be allowed to login. When using this with
3780 * a public wiki, the effect of logging out blocked users may actually be
3781 * avers: unless the user's address is also blocked (e.g. auto-block),
3782 * logging the user out will again allow reading and editing, just as for
3783 * anonymous visitors.
3785 $wgBlockDisablesLogin = false;
3788 * Pages anonymous user may see, set as an array of pages titles.
3790 * @par Example:
3791 * @code
3792 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
3793 * @endcode
3795 * Special:Userlogin and Special:ChangePassword are always whitelisted.
3797 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
3798 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
3800 * @note Also that this will only protect _pages in the wiki_. Uploaded files
3801 * will remain readable. You can use img_auth.php to protect uploaded files,
3802 * see http://www.mediawiki.org/wiki/Manual:Image_Authorization
3804 $wgWhitelistRead = false;
3807 * Pages anonymous user may see, set as an array of regular expressions.
3809 * This function will match the regexp against the title name, which
3810 * is without underscore.
3812 * @par Example:
3813 * To whitelist [[Main Page]]:
3814 * @code
3815 * $wgWhitelistReadRegexp = array( "/Main Page/" );
3816 * @endcode
3818 * @note Unless ^ and/or $ is specified, a regular expression might match
3819 * pages not intended to be whitelisted. The above example will also
3820 * whitelist a page named 'Security Main Page'.
3822 * @par Example:
3823 * To allow reading any page starting with 'User' regardless of the case:
3824 * @code
3825 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
3826 * @endcode
3827 * Will allow both [[User is banned]] and [[User:JohnDoe]]
3829 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
3830 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
3832 $wgWhitelistReadRegexp = false;
3835 * Should editors be required to have a validated e-mail
3836 * address before being allowed to edit?
3838 $wgEmailConfirmToEdit = false;
3841 * Permission keys given to users in each group.
3843 * This is an array where the keys are all groups and each value is an
3844 * array of the format (right => boolean).
3846 * The second format is used to support per-namespace permissions.
3847 * Note that this feature does not fully work for all permission types.
3849 * All users are implicitly in the '*' group including anonymous visitors;
3850 * logged-in users are all implicitly in the 'user' group. These will be
3851 * combined with the permissions of all groups that a given user is listed
3852 * in in the user_groups table.
3854 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
3855 * doing! This will wipe all permissions, and may mean that your users are
3856 * unable to perform certain essential tasks or access new functionality
3857 * when new permissions are introduced and default grants established.
3859 * Functionality to make pages inaccessible has not been extensively tested
3860 * for security. Use at your own risk!
3862 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
3864 $wgGroupPermissions = array();
3866 /** @cond file_level_code */
3867 // Implicit group for all visitors
3868 $wgGroupPermissions['*']['createaccount'] = true;
3869 $wgGroupPermissions['*']['read'] = true;
3870 $wgGroupPermissions['*']['edit'] = true;
3871 $wgGroupPermissions['*']['createpage'] = true;
3872 $wgGroupPermissions['*']['createtalk'] = true;
3873 $wgGroupPermissions['*']['writeapi'] = true;
3874 $wgGroupPermissions['*']['editmyusercss'] = true;
3875 $wgGroupPermissions['*']['editmyuserjs'] = true;
3876 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
3878 // Implicit group for all logged-in accounts
3879 $wgGroupPermissions['user']['move'] = true;
3880 $wgGroupPermissions['user']['move-subpages'] = true;
3881 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
3882 $wgGroupPermissions['user']['movefile'] = true;
3883 $wgGroupPermissions['user']['read'] = true;
3884 $wgGroupPermissions['user']['edit'] = true;
3885 $wgGroupPermissions['user']['createpage'] = true;
3886 $wgGroupPermissions['user']['createtalk'] = true;
3887 $wgGroupPermissions['user']['writeapi'] = true;
3888 $wgGroupPermissions['user']['upload'] = true;
3889 $wgGroupPermissions['user']['reupload'] = true;
3890 $wgGroupPermissions['user']['reupload-shared'] = true;
3891 $wgGroupPermissions['user']['minoredit'] = true;
3892 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
3893 $wgGroupPermissions['user']['sendemail'] = true;
3895 // Implicit group for accounts that pass $wgAutoConfirmAge
3896 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
3898 // Users with bot privilege can have their edits hidden
3899 // from various log pages by default
3900 $wgGroupPermissions['bot']['bot'] = true;
3901 $wgGroupPermissions['bot']['autoconfirmed'] = true;
3902 $wgGroupPermissions['bot']['nominornewtalk'] = true;
3903 $wgGroupPermissions['bot']['autopatrol'] = true;
3904 $wgGroupPermissions['bot']['suppressredirect'] = true;
3905 $wgGroupPermissions['bot']['apihighlimits'] = true;
3906 $wgGroupPermissions['bot']['writeapi'] = true;
3907 #$wgGroupPermissions['bot']['editprotected'] = true; // can edit all protected pages without cascade protection enabled
3909 // Most extra permission abilities go to this group
3910 $wgGroupPermissions['sysop']['block'] = true;
3911 $wgGroupPermissions['sysop']['createaccount'] = true;
3912 $wgGroupPermissions['sysop']['delete'] = true;
3913 $wgGroupPermissions['sysop']['bigdelete'] = true; // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
3914 $wgGroupPermissions['sysop']['deletedhistory'] = true; // can view deleted history entries, but not see or restore the text
3915 $wgGroupPermissions['sysop']['deletedtext'] = true; // can view deleted revision text
3916 $wgGroupPermissions['sysop']['undelete'] = true;
3917 $wgGroupPermissions['sysop']['editinterface'] = true;
3918 $wgGroupPermissions['sysop']['editusercss'] = true;
3919 $wgGroupPermissions['sysop']['edituserjs'] = true;
3920 $wgGroupPermissions['sysop']['import'] = true;
3921 $wgGroupPermissions['sysop']['importupload'] = true;
3922 $wgGroupPermissions['sysop']['move'] = true;
3923 $wgGroupPermissions['sysop']['move-subpages'] = true;
3924 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
3925 $wgGroupPermissions['sysop']['patrol'] = true;
3926 $wgGroupPermissions['sysop']['autopatrol'] = true;
3927 $wgGroupPermissions['sysop']['protect'] = true;
3928 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
3929 $wgGroupPermissions['sysop']['rollback'] = true;
3930 $wgGroupPermissions['sysop']['upload'] = true;
3931 $wgGroupPermissions['sysop']['reupload'] = true;
3932 $wgGroupPermissions['sysop']['reupload-shared'] = true;
3933 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
3934 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
3935 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
3936 $wgGroupPermissions['sysop']['blockemail'] = true;
3937 $wgGroupPermissions['sysop']['markbotedits'] = true;
3938 $wgGroupPermissions['sysop']['apihighlimits'] = true;
3939 $wgGroupPermissions['sysop']['browsearchive'] = true;
3940 $wgGroupPermissions['sysop']['noratelimit'] = true;
3941 $wgGroupPermissions['sysop']['movefile'] = true;
3942 $wgGroupPermissions['sysop']['unblockself'] = true;
3943 $wgGroupPermissions['sysop']['suppressredirect'] = true;
3944 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
3945 #$wgGroupPermissions['sysop']['mergehistory'] = true;
3947 // Permission to change users' group assignments
3948 $wgGroupPermissions['bureaucrat']['userrights'] = true;
3949 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
3950 // Permission to change users' groups assignments across wikis
3951 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
3952 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
3953 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
3955 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
3956 #$wgGroupPermissions['sysop']['deleterevision'] = true;
3957 // To hide usernames from users and Sysops
3958 #$wgGroupPermissions['suppress']['hideuser'] = true;
3959 // To hide revisions/log items from users and Sysops
3960 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
3961 // For private suppression log access
3962 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
3965 * The developer group is deprecated, but can be activated if need be
3966 * to use the 'lockdb' and 'unlockdb' special pages. Those require
3967 * that a lock file be defined and creatable/removable by the web
3968 * server.
3970 # $wgGroupPermissions['developer']['siteadmin'] = true;
3972 /** @endcond */
3975 * Permission keys revoked from users in each group.
3977 * This acts the same way as wgGroupPermissions above, except that
3978 * if the user is in a group here, the permission will be removed from them.
3980 * Improperly setting this could mean that your users will be unable to perform
3981 * certain essential tasks, so use at your own risk!
3983 $wgRevokePermissions = array();
3986 * Implicit groups, aren't shown on Special:Listusers or somewhere else
3988 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
3991 * A map of group names that the user is in, to group names that those users
3992 * are allowed to add or revoke.
3994 * Setting the list of groups to add or revoke to true is equivalent to "any
3995 * group".
3997 * @par Example:
3998 * To allow sysops to add themselves to the "bot" group:
3999 * @code
4000 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4001 * @endcode
4003 * @par Example:
4004 * Implicit groups may be used for the source group, for instance:
4005 * @code
4006 * $wgGroupsRemoveFromSelf = array( '*' => true );
4007 * @endcode
4008 * This allows users in the '*' group (i.e. any user) to remove themselves from
4009 * any group that they happen to be in.
4011 $wgGroupsAddToSelf = array();
4013 /** @see $wgGroupsAddToSelf */
4014 $wgGroupsRemoveFromSelf = array();
4017 * Set of available actions that can be restricted via action=protect
4018 * You probably shouldn't change this.
4019 * Translated through restriction-* messages.
4020 * Title::getRestrictionTypes() will remove restrictions that are not
4021 * applicable to a specific title (create and upload)
4023 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4026 * Rights which can be required for each protection level (via action=protect)
4028 * You can add a new protection level that requires a specific
4029 * permission by manipulating this array. The ordering of elements
4030 * dictates the order on the protection form's lists.
4032 * - '' will be ignored (i.e. unprotected)
4033 * - 'sysop' is quietly rewritten to 'protect' for backwards compatibility
4035 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4038 * Restriction levels that can be used with cascading protection
4040 * A page can only be protected with cascading protection if the
4041 * requested restriction level is included in this array.
4043 * This is intended to prevent abuse - if any protection could be
4044 * cascading, users could who cannot normally protect pages could
4045 * "protect" them by transcluding them on protected pages they are
4046 * allowed to edit.
4048 * 'sysop' is quietly rewritten to 'protect' for backwards compatibility.
4050 $wgCascadingRestrictionLevels = array( 'sysop' );
4053 * Set the minimum permissions required to edit pages in each
4054 * namespace. If you list more than one permission, a user must
4055 * have all of them to edit pages in that namespace.
4057 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4059 $wgNamespaceProtection = array();
4062 * Pages in namespaces in this array can not be used as templates.
4064 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4065 * namespaces constants (NS_USER, NS_MAIN...).
4067 * Among other things, this may be useful to enforce read-restrictions
4068 * which may otherwise be bypassed by using the template mechanism.
4070 $wgNonincludableNamespaces = array();
4073 * Number of seconds an account is required to age before it's given the
4074 * implicit 'autoconfirm' group membership. This can be used to limit
4075 * privileges of new accounts.
4077 * Accounts created by earlier versions of the software may not have a
4078 * recorded creation date, and will always be considered to pass the age test.
4080 * When left at 0, all registered accounts will pass.
4082 * @par Example:
4083 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4084 * @code
4085 * $wgAutoConfirmAge = 600; // ten minutes
4086 * @endcode
4087 * Set age to one day:
4088 * @code
4089 * $wgAutoConfirmAge = 3600*24; // one day
4090 * @endcode
4092 $wgAutoConfirmAge = 0;
4095 * Number of edits an account requires before it is autoconfirmed.
4096 * Passing both this AND the time requirement is needed. Example:
4098 * @par Example:
4099 * @code
4100 * $wgAutoConfirmCount = 50;
4101 * @endcode
4103 $wgAutoConfirmCount = 0;
4106 * Automatically add a usergroup to any user who matches certain conditions.
4108 * @todo Redocument $wgAutopromote
4110 * The format is
4111 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4112 * where cond1, cond2, ... are themselves conditions; *OR*
4113 * APCOND_EMAILCONFIRMED, *OR*
4114 * array( APCOND_EMAILCONFIRMED ), *OR*
4115 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4116 * array( APCOND_AGE, seconds since registration ), *OR*
4117 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4118 * array( APCOND_ISIP, ip ), *OR*
4119 * array( APCOND_IPINRANGE, range ), *OR*
4120 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4121 * array( APCOND_BLOCKED ), *OR*
4122 * array( APCOND_ISBOT ), *OR*
4123 * similar constructs defined by extensions.
4125 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4126 * user who has provided an e-mail address.
4128 $wgAutopromote = array(
4129 'autoconfirmed' => array( '&',
4130 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
4131 array( APCOND_AGE, &$wgAutoConfirmAge ),
4136 * Automatically add a usergroup to any user who matches certain conditions.
4138 * Does not add the user to the group again if it has been removed.
4139 * Also, does not remove the group if the user no longer meets the criteria.
4141 * The format is:
4142 * @code
4143 * array( event => criteria, ... )
4144 * @endcode
4145 * Where event is either:
4146 * - 'onEdit' (when user edits)
4147 * - 'onView' (when user views the wiki)
4149 * Criteria has the same format as $wgAutopromote
4151 * @see $wgAutopromote
4152 * @since 1.18
4154 $wgAutopromoteOnce = array(
4155 'onEdit' => array(),
4156 'onView' => array()
4160 * Put user rights log entries for autopromotion in recent changes?
4161 * @since 1.18
4163 $wgAutopromoteOnceLogInRC = true;
4166 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4167 * can assign which groups at Special:Userrights.
4169 * @par Example:
4170 * Bureaucrats can add any group:
4171 * @code
4172 * $wgAddGroups['bureaucrat'] = true;
4173 * @endcode
4174 * Bureaucrats can only remove bots and sysops:
4175 * @code
4176 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4177 * @endcode
4178 * Sysops can make bots:
4179 * @code
4180 * $wgAddGroups['sysop'] = array( 'bot' );
4181 * @endcode
4182 * Sysops can disable other sysops in an emergency, and disable bots:
4183 * @code
4184 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4185 * @endcode
4187 $wgAddGroups = array();
4188 /** @see $wgAddGroups */
4189 $wgRemoveGroups = array();
4192 * A list of available rights, in addition to the ones defined by the core.
4193 * For extensions only.
4195 $wgAvailableRights = array();
4198 * Optional to restrict deletion of pages with higher revision counts
4199 * to users with the 'bigdelete' permission. (Default given to sysops.)
4201 $wgDeleteRevisionsLimit = 0;
4204 * Number of accounts each IP address may create, 0 to disable.
4206 * @warning Requires memcached
4208 $wgAccountCreationThrottle = 0;
4211 * Edits matching these regular expressions in body text
4212 * will be recognised as spam and rejected automatically.
4214 * There's no administrator override on-wiki, so be careful what you set. :)
4215 * May be an array of regexes or a single string for backwards compatibility.
4217 * @see http://en.wikipedia.org/wiki/Regular_expression
4219 * @note Each regex needs a beginning/end delimiter, eg: # or /
4221 $wgSpamRegex = array();
4223 /** Same as the above except for edit summaries */
4224 $wgSummarySpamRegex = array();
4227 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4228 * proxies
4229 * @since 1.16
4231 $wgEnableDnsBlacklist = false;
4234 * @deprecated since 1.17 Use $wgEnableDnsBlacklist instead, only kept for
4235 * backward compatibility.
4237 $wgEnableSorbs = false;
4240 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4242 * This is an array of either a URL or an array with the URL and a key (should
4243 * the blacklist require a key).
4245 * @par Example:
4246 * @code
4247 * $wgDnsBlacklistUrls = array(
4248 * // String containing URL
4249 * 'http.dnsbl.sorbs.net.',
4250 * // Array with URL and key, for services that require a key
4251 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4252 * // Array with just the URL. While this works, it is recommended that you
4253 * // just use a string as shown above
4254 * array( 'opm.tornevall.org.' )
4255 * );
4256 * @endcode
4258 * @note You should end the domain name with a . to avoid searching your
4259 * eventual domain search suffixes.
4260 * @since 1.16
4262 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4265 * @deprecated since 1.17 Use $wgDnsBlacklistUrls instead, only kept for
4266 * backward compatibility.
4268 $wgSorbsUrl = array();
4271 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4272 * what the other methods might say.
4274 $wgProxyWhitelist = array();
4277 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4278 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4279 * (transparent) proxies without needing to block the proxies themselves.
4281 $wgApplyIpBlocksToXff = false;
4284 * Simple rate limiter options to brake edit floods.
4286 * Maximum number actions allowed in the given number of seconds; after that
4287 * the violating client receives HTTP 500 error pages until the period
4288 * elapses.
4290 * @par Example:
4291 * To set a generic maximum of 4 hits in 60 seconds:
4292 * @code
4293 * $wgRateLimits = array( 4, 60 );
4294 * @endcode
4296 * You could also limit per action and then type of users. See the inline
4297 * code for a template to use.
4299 * This option set is experimental and likely to change.
4301 * @warning Requires memcached.
4303 $wgRateLimits = array(
4304 'edit' => array(
4305 'anon' => null, // for any and all anonymous edits (aggregate)
4306 'user' => null, // for each logged-in user
4307 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4308 'ip' => null, // for each anon and recent account
4309 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4311 'move' => array(
4312 'user' => null,
4313 'newbie' => null,
4314 'ip' => null,
4315 'subnet' => null,
4317 'mailpassword' => array(
4318 'anon' => null,
4320 'emailuser' => array(
4321 'user' => null,
4326 * Set to a filename to log rate limiter hits.
4328 $wgRateLimitLog = null;
4331 * Array of IPs which should be excluded from rate limits.
4332 * This may be useful for whitelisting NAT gateways for conferences, etc.
4334 $wgRateLimitsExcludedIPs = array();
4337 * Log IP addresses in the recentchanges table; can be accessed only by
4338 * extensions (e.g. CheckUser) or a DB admin
4339 * Used for retroactive autoblocks
4341 $wgPutIPinRC = true;
4344 * Integer defining default number of entries to show on
4345 * special pages which are query-pages such as Special:Whatlinkshere.
4347 $wgQueryPageDefaultLimit = 50;
4350 * Limit password attempts to X attempts per Y seconds per IP per account.
4352 * @warning Requires memcached.
4354 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
4356 /** @} */ # end of user rights settings
4358 /************************************************************************//**
4359 * @name Proxy scanner settings
4360 * @{
4364 * If you enable this, every editor's IP address will be scanned for open HTTP
4365 * proxies.
4367 * @warning Don't enable this. Many sysops will report "hostile TCP port scans"
4368 * to your ISP and ask for your server to be shut down.
4369 * You have been warned.
4371 $wgBlockOpenProxies = false;
4372 /** Port we want to scan for a proxy */
4373 $wgProxyPorts = array( 80, 81, 1080, 3128, 6588, 8000, 8080, 8888, 65506 );
4374 /** Script used to scan */
4375 $wgProxyScriptPath = "$IP/maintenance/proxyCheck.php";
4376 /** Expiration time for cached proxy IPs */
4377 $wgProxyMemcExpiry = 86400;
4378 /** This should always be customised in LocalSettings.php */
4379 $wgSecretKey = false;
4382 * Big list of banned IP addresses.
4384 * This can have the following formats:
4385 * - An array of addresses, either in the values
4386 * or the keys (for backward compatibility)
4387 * - A string, in that case this is the path to a file
4388 * containing the list of IP addresses, one per line
4390 $wgProxyList = array();
4393 * @deprecated since 1.14
4395 $wgProxyKey = false;
4397 /** @} */ # end of proxy scanner settings
4399 /************************************************************************//**
4400 * @name Cookie settings
4401 * @{
4405 * Default cookie expiration time. Setting to 0 makes all cookies session-only.
4407 $wgCookieExpiration = 180 * 86400;
4410 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
4411 * or ".any.subdomain.net"
4413 $wgCookieDomain = '';
4416 * Set this variable if you want to restrict cookies to a certain path within
4417 * the domain specified by $wgCookieDomain.
4419 $wgCookiePath = '/';
4422 * Whether the "secure" flag should be set on the cookie. This can be:
4423 * - true: Set secure flag
4424 * - false: Don't set secure flag
4425 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
4427 $wgCookieSecure = 'detect';
4430 * By default, MediaWiki checks if the client supports cookies during the
4431 * login process, so that it can display an informative error message if
4432 * cookies are disabled. Set this to true if you want to disable this cookie
4433 * check.
4435 $wgDisableCookieCheck = false;
4438 * Cookies generated by MediaWiki have names starting with this prefix. Set it
4439 * to a string to use a custom prefix. Setting it to false causes the database
4440 * name to be used as a prefix.
4442 $wgCookiePrefix = false;
4445 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
4446 * in browsers that support this feature. This can mitigates some classes of
4447 * XSS attack.
4449 $wgCookieHttpOnly = true;
4452 * If the requesting browser matches a regex in this blacklist, we won't
4453 * send it cookies with HttpOnly mode, even if $wgCookieHttpOnly is on.
4455 $wgHttpOnlyBlacklist = array(
4456 // Internet Explorer for Mac; sometimes the cookies work, sometimes
4457 // they don't. It's difficult to predict, as combinations of path
4458 // and expiration options affect its parsing.
4459 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
4462 /** A list of cookies that vary the cache (for use by extensions) */
4463 $wgCacheVaryCookies = array();
4465 /** Override to customise the session name */
4466 $wgSessionName = false;
4468 /** @} */ # end of cookie settings }
4470 /************************************************************************//**
4471 * @name LaTeX (mathematical formulas)
4472 * @{
4476 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
4477 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
4478 * (ImageMagick) installed and available in the PATH.
4479 * Please see math/README for more information.
4481 $wgUseTeX = false;
4483 /** @} */ # end LaTeX }
4485 /************************************************************************//**
4486 * @name Profiling, testing and debugging
4488 * To enable profiling, edit StartProfiler.php
4490 * @{
4494 * Filename for debug logging. See http://www.mediawiki.org/wiki/How_to_debug
4495 * The debug log file should be not be publicly accessible if it is used, as it
4496 * may contain private data.
4498 $wgDebugLogFile = '';
4501 * Prefix for debug log lines
4503 $wgDebugLogPrefix = '';
4506 * If true, instead of redirecting, show a page with a link to the redirect
4507 * destination. This allows for the inspection of PHP error messages, and easy
4508 * resubmission of form data. For developer use only.
4510 $wgDebugRedirects = false;
4513 * If true, log debugging data from action=raw and load.php.
4514 * This is normally false to avoid overlapping debug entries due to gen=css
4515 * and gen=js requests.
4517 $wgDebugRawPage = false;
4520 * Send debug data to an HTML comment in the output.
4522 * This may occasionally be useful when supporting a non-technical end-user.
4523 * It's more secure than exposing the debug log file to the web, since the
4524 * output only contains private data for the current user. But it's not ideal
4525 * for development use since data is lost on fatal errors and redirects.
4527 $wgDebugComments = false;
4530 * Extensive database transaction state debugging
4532 * @since 1.20
4534 $wgDebugDBTransactions = false;
4537 * Write SQL queries to the debug log
4539 $wgDebugDumpSql = false;
4542 * Set to an array of log group keys to filenames.
4543 * If set, wfDebugLog() output for that group will go to that file instead
4544 * of the regular $wgDebugLogFile. Useful for enabling selective logging
4545 * in production.
4547 $wgDebugLogGroups = array();
4550 * Display debug data at the bottom of the main content area.
4552 * Useful for developers and technical users trying to working on a closed wiki.
4554 $wgShowDebug = false;
4557 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
4558 * Since 1.19 also includes memory usage.
4560 $wgDebugTimestamps = false;
4563 * Print HTTP headers for every request in the debug information.
4565 $wgDebugPrintHttpHeaders = true;
4568 * Show the contents of $wgHooks in Special:Version
4570 $wgSpecialVersionShowHooks = false;
4573 * Whether to show "we're sorry, but there has been a database error" pages.
4574 * Displaying errors aids in debugging, but may display information useful
4575 * to an attacker.
4577 $wgShowSQLErrors = false;
4580 * If set to true, uncaught exceptions will print a complete stack trace
4581 * to output. This should only be used for debugging, as it may reveal
4582 * private information in function parameters due to PHP's backtrace
4583 * formatting.
4585 $wgShowExceptionDetails = false;
4588 * If true, show a backtrace for database errors
4590 $wgShowDBErrorBacktrace = false;
4593 * If true, send the exception backtrace to the error log
4595 $wgLogExceptionBacktrace = true;
4598 * Expose backend server host names through the API and various HTML comments
4600 $wgShowHostnames = false;
4603 * Override server hostname detection with a hardcoded value.
4604 * Should be a string, default false.
4605 * @since 1.20
4607 $wgOverrideHostname = false;
4610 * If set to true MediaWiki will throw notices for some possible error
4611 * conditions and for deprecated functions.
4613 $wgDevelopmentWarnings = false;
4616 * Release limitation to wfDeprecated warnings, if set to a release number
4617 * development warnings will not be generated for deprecations added in releases
4618 * after the limit.
4620 $wgDeprecationReleaseLimit = false;
4622 /** Only record profiling info for pages that took longer than this */
4623 $wgProfileLimit = 0.0;
4625 /** Don't put non-profiling info into log file */
4626 $wgProfileOnly = false;
4629 * Log sums from profiling into "profiling" table in db.
4631 * You have to create a 'profiling' table in your database before using
4632 * this feature. Run set $wgProfileToDatabase to true in
4633 * LocalSettings.php and run maintenance/update.php or otherwise
4634 * manually add patch-profiling.sql to your database.
4636 * To enable profiling, edit StartProfiler.php
4638 $wgProfileToDatabase = false;
4640 /** If true, print a raw call tree instead of per-function report */
4641 $wgProfileCallTree = false;
4643 /** Should application server host be put into profiling table */
4644 $wgProfilePerHost = false;
4647 * Host for UDP profiler.
4649 * The host should be running a daemon which can be obtained from MediaWiki
4650 * Subversion at: http://svn.wikimedia.org/svnroot/mediawiki/trunk/udpprofile
4652 $wgUDPProfilerHost = '127.0.0.1';
4655 * Port for UDP profiler.
4656 * @see $wgUDPProfilerHost
4658 $wgUDPProfilerPort = '3811';
4660 /** Detects non-matching wfProfileIn/wfProfileOut calls */
4661 $wgDebugProfiling = false;
4663 /** Output debug message on every wfProfileIn/wfProfileOut */
4664 $wgDebugFunctionEntry = false;
4667 * Destination for wfIncrStats() data...
4668 * 'cache' to go into the system cache, if enabled (memcached)
4669 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
4670 * false to disable
4672 $wgStatsMethod = 'cache';
4675 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
4676 * be aggregated over more than one wiki. The string will be used in place of
4677 * the DB name in outgoing UDP packets. If this is set to false, the DB name
4678 * will be used.
4680 $wgAggregateStatsID = false;
4682 /** Whereas to count the number of time an article is viewed.
4683 * Does not work if pages are cached (for example with squid).
4685 $wgDisableCounters = false;
4688 * InfoAction retrieves a list of transclusion links (both to and from).
4689 * This number puts a limit on that query in the case of highly transcluded
4690 * templates.
4692 $wgPageInfoTransclusionLimit = 50;
4695 * Set this to an integer to only do synchronous site_stats updates
4696 * one every *this many* updates. The other requests go into pending
4697 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
4698 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
4700 $wgSiteStatsAsyncFactor = false;
4703 * Parser test suite files to be run by parserTests.php when no specific
4704 * filename is passed to it.
4706 * Extensions may add their own tests to this array, or site-local tests
4707 * may be added via LocalSettings.php
4709 * Use full paths.
4711 $wgParserTestFiles = array(
4712 "$IP/tests/parser/parserTests.txt",
4713 "$IP/tests/parser/extraParserTests.txt"
4717 * If configured, specifies target CodeReview installation to send test
4718 * result data from 'parserTests.php --upload'
4720 * Something like this:
4721 * $wgParserTestRemote = array(
4722 * 'api-url' => 'http://www.mediawiki.org/w/api.php',
4723 * 'repo' => 'MediaWiki',
4724 * 'suite' => 'ParserTests',
4725 * 'path' => '/trunk/phase3', // not used client-side; for reference
4726 * 'secret' => 'qmoicj3mc4mcklmqw', // Shared secret used in HMAC validation
4727 * );
4729 $wgParserTestRemote = false;
4732 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
4734 $wgEnableJavaScriptTest = false;
4737 * Configuration for javascript testing.
4739 $wgJavaScriptTestConfig = array(
4740 'qunit' => array(
4741 // Page where documentation can be found relevant to the QUnit test suite being ran.
4742 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
4743 // documentation link in the "javascripttest-qunit-intro" message.
4744 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
4745 // If you are submitting the QUnit test suite to a TestSwarm instance,
4746 // point this to the "inject.js" script of that instance. This is was registers
4747 // the QUnit hooks to extract the test results and push them back up into the
4748 // TestSwarm database.
4749 // @example 'http://localhost/testswarm/js/inject.js'
4750 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
4751 'testswarm-injectjs' => false,
4756 * Overwrite the caching key prefix with custom value.
4757 * @since 1.19
4759 $wgCachePrefix = false;
4762 * Display the new debugging toolbar. This also enables profiling on database
4763 * queries and other useful output.
4764 * Will disable file cache.
4766 * @since 1.19
4768 $wgDebugToolbar = false;
4770 /** @} */ # end of profiling, testing and debugging }
4772 /************************************************************************//**
4773 * @name Search
4774 * @{
4778 * Set this to true to disable the full text search feature.
4780 $wgDisableTextSearch = false;
4783 * Set to true to have nicer highlighted text in search results,
4784 * by default off due to execution overhead
4786 $wgAdvancedSearchHighlighting = false;
4789 * Regexp to match word boundaries, defaults for non-CJK languages
4790 * should be empty for CJK since the words are not separate
4792 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
4795 * Set to true to have the search engine count total
4796 * search matches to present in the Special:Search UI.
4797 * Not supported by every search engine shipped with MW.
4799 * This could however be slow on larger wikis, and is pretty flaky
4800 * with the current title vs content split. Recommend avoiding until
4801 * that's been worked out cleanly; but this may aid in testing the
4802 * search UI and API to confirm that the result count works.
4804 $wgCountTotalSearchHits = false;
4807 * Template for OpenSearch suggestions, defaults to API action=opensearch
4809 * Sites with heavy load would typically have these point to a custom
4810 * PHP wrapper to avoid firing up mediawiki for every keystroke
4812 * Placeholders: {searchTerms}
4814 $wgOpenSearchTemplate = false;
4817 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
4818 * false if you've disabled scripts that use api?action=opensearch and
4819 * want reduce load caused by cached scripts still pulling suggestions.
4820 * It will let the API fallback by responding with an empty array.
4822 $wgEnableOpenSearchSuggest = true;
4825 * Expiry time for search suggestion responses
4827 $wgSearchSuggestCacheExpiry = 1200;
4830 * If you've disabled search semi-permanently, this also disables updates to the
4831 * table. If you ever re-enable, be sure to rebuild the search table.
4833 $wgDisableSearchUpdate = false;
4836 * List of namespaces which are searched by default.
4838 * @par Example:
4839 * @code
4840 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
4841 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
4842 * @endcode
4844 $wgNamespacesToBeSearchedDefault = array(
4845 NS_MAIN => true,
4849 * Namespaces to be searched when user clicks the "Help" tab
4850 * on Special:Search.
4852 * Same format as $wgNamespacesToBeSearchedDefault.
4854 $wgNamespacesToBeSearchedHelp = array(
4855 NS_PROJECT => true,
4856 NS_HELP => true,
4860 * If set to true the 'searcheverything' preference will be effective only for
4861 * logged-in users.
4862 * Useful for big wikis to maintain different search profiles for anonymous and
4863 * logged-in users.
4865 $wgSearchEverythingOnlyLoggedIn = false;
4868 * Disable the internal MySQL-based search, to allow it to be
4869 * implemented by an extension instead.
4871 $wgDisableInternalSearch = false;
4874 * Set this to a URL to forward search requests to some external location.
4875 * If the URL includes '$1', this will be replaced with the URL-encoded
4876 * search term.
4878 * @par Example:
4879 * To forward to Google you'd have something like:
4880 * @code
4881 * $wgSearchForwardUrl =
4882 * 'http://www.google.com/search?q=$1' .
4883 * '&domains=http://example.com' .
4884 * '&sitesearch=http://example.com' .
4885 * '&ie=utf-8&oe=utf-8';
4886 * @endcode
4888 $wgSearchForwardUrl = null;
4891 * Search form behavior.
4892 * - true = use Go & Search buttons
4893 * - false = use Go button & Advanced search link
4895 $wgUseTwoButtonsSearchForm = true;
4898 * Array of namespaces to generate a Google sitemap for when the
4899 * maintenance/generateSitemap.php script is run, or false if one is to be
4900 * generated for all namespaces.
4902 $wgSitemapNamespaces = false;
4905 * Custom namespace priorities for sitemaps. Setting this will allow you to
4906 * set custom priorities to namespaces when sitemaps are generated using the
4907 * maintenance/generateSitemap.php script.
4909 * This should be a map of namespace IDs to priority
4910 * @par Example:
4911 * @code
4912 * $wgSitemapNamespacesPriorities = array(
4913 * NS_USER => '0.9',
4914 * NS_HELP => '0.0',
4915 * );
4916 * @endcode
4918 $wgSitemapNamespacesPriorities = false;
4921 * If true, searches for IP addresses will be redirected to that IP's
4922 * contributions page. E.g. searching for "1.2.3.4" will redirect to
4923 * [[Special:Contributions/1.2.3.4]]
4925 $wgEnableSearchContributorsByIP = true;
4927 /** @} */ # end of search settings
4929 /************************************************************************//**
4930 * @name Edit user interface
4931 * @{
4935 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
4936 * fall back to the old behavior (no merging).
4938 $wgDiff3 = '/usr/bin/diff3';
4941 * Path to the GNU diff utility.
4943 $wgDiff = '/usr/bin/diff';
4946 * Which namespaces have special treatment where they should be preview-on-open
4947 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
4948 * can specify namespaces of pages they have special treatment for
4950 $wgPreviewOnOpenNamespaces = array(
4951 NS_CATEGORY => true
4954 /** Go button goes straight to the edit screen if the article doesn't exist. */
4955 $wgGoToEdit = false;
4958 * Enable the UniversalEditButton for browsers that support it
4959 * (currently only Firefox with an extension)
4960 * See http://universaleditbutton.org for more background information
4962 $wgUniversalEditButton = true;
4965 * If user doesn't specify any edit summary when making a an edit, MediaWiki
4966 * will try to automatically create one. This feature can be disabled by set-
4967 * ting this variable false.
4969 $wgUseAutomaticEditSummaries = true;
4971 /** @} */ # end edit UI }
4973 /************************************************************************//**
4974 * @name Maintenance
4975 * See also $wgSiteNotice
4976 * @{
4980 * @cond file_level_code
4981 * Set $wgCommandLineMode if it's not set already, to avoid notices
4983 if ( !isset( $wgCommandLineMode ) ) {
4984 $wgCommandLineMode = false;
4986 /** @endcond */
4988 /** For colorized maintenance script output, is your terminal background dark ? */
4989 $wgCommandLineDarkBg = false;
4992 * Array for extensions to register their maintenance scripts with the
4993 * system. The key is the name of the class and the value is the full
4994 * path to the file
4996 $wgMaintenanceScripts = array();
4999 * Set this to a string to put the wiki into read-only mode. The text will be
5000 * used as an explanation to users.
5002 * This prevents most write operations via the web interface. Cache updates may
5003 * still be possible. To prevent database writes completely, use the read_only
5004 * option in MySQL.
5006 $wgReadOnly = null;
5009 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5010 * Its contents will be shown to users as part of the read-only warning
5011 * message.
5013 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5015 $wgReadOnlyFile = false;
5018 * When you run the web-based upgrade utility, it will tell you what to set
5019 * this to in order to authorize the upgrade process. It will subsequently be
5020 * used as a password, to authorize further upgrades.
5022 * For security, do not set this to a guessable string. Use the value supplied
5023 * by the install/upgrade process. To cause the upgrader to generate a new key,
5024 * delete the old key from LocalSettings.php.
5026 $wgUpgradeKey = false;
5029 * Fully specified path to git binary
5031 $wgGitBin = '/usr/bin/git';
5034 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5036 * Key is a pattern passed to preg_match() and preg_replace(),
5037 * without the delimiters (which are #) and must match the whole URL.
5038 * The value is the replacement for the key (it can contain $1, etc.)
5039 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5040 * full SHA-1 of the HEAD revision.
5041 * %r will be replaced with a URL-encoded version of $1.
5043 * @since 1.20
5045 $wgGitRepositoryViewers = array(
5046 'https://gerrit.wikimedia.org/r/p/(.*)' => 'https://git.wikimedia.org/commit/%r/%H',
5047 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' => 'https://git.wikimedia.org/commit/%r/%H',
5050 /** @} */ # End of maintenance }
5052 /************************************************************************//**
5053 * @name Recent changes, new pages, watchlist and history
5054 * @{
5058 * Recentchanges items are periodically purged; entries older than this many
5059 * seconds will go.
5060 * Default: 13 weeks = about three months
5062 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5065 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5066 * higher than what will be stored. Note that this is disabled by default
5067 * because we sometimes do have RC data which is beyond the limit for some
5068 * reason, and some users may use the high numbers to display that data which
5069 * is still there.
5071 $wgRCFilterByAge = false;
5074 * List of Days and Limits options to list in the Special:Recentchanges and
5075 * Special:Recentchangeslinked pages.
5077 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5078 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5081 * Send recent changes updates via UDP. The updates will be formatted for IRC.
5082 * Set this to the IP address of the receiver.
5084 $wgRC2UDPAddress = false;
5087 * Port number for RC updates
5089 $wgRC2UDPPort = false;
5092 * Prefix to prepend to each UDP packet.
5093 * This can be used to identify the wiki. A script is available called
5094 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
5095 * tab to identify the IRC channel to send the log line to.
5097 $wgRC2UDPPrefix = '';
5100 * If this is set to true, $wgLocalInterwiki will be prepended to links in the
5101 * IRC feed. If this is set to a string, that string will be used as the prefix.
5103 $wgRC2UDPInterwikiPrefix = false;
5106 * Set to true to omit "bot" edits (by users with the bot permission) from the
5107 * UDP feed.
5109 $wgRC2UDPOmitBots = false;
5112 * Enable user search in Special:Newpages
5113 * This is really a temporary hack around an index install bug on some Wikipedias.
5114 * Kill it once fixed.
5116 $wgEnableNewpagesUserFilter = true;
5118 /** Use RC Patrolling to check for vandalism */
5119 $wgUseRCPatrol = true;
5121 /** Use new page patrolling to check new pages on Special:Newpages */
5122 $wgUseNPPatrol = true;
5124 /** Log autopatrol actions to the log table */
5125 $wgLogAutopatrol = true;
5127 /** Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages */
5128 $wgFeed = true;
5130 /** Set maximum number of results to return in syndication feeds (RSS, Atom) for
5131 * eg Recentchanges, Newpages. */
5132 $wgFeedLimit = 50;
5134 /** _Minimum_ timeout for cached Recentchanges feed, in seconds.
5135 * A cached version will continue to be served out even if changes
5136 * are made, until this many seconds runs out since the last render.
5138 * If set to 0, feed caching is disabled. Use this for debugging only;
5139 * feed generation can be pretty slow with diffs.
5141 $wgFeedCacheTimeout = 60;
5143 /** When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5144 * pages larger than this size. */
5145 $wgFeedDiffCutoff = 32768;
5147 /** Override the site's default RSS/ATOM feed for recentchanges that appears on
5148 * every page. Some sites might have a different feed they'd like to promote
5149 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5150 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5151 * as value.
5152 * @par Example:
5153 * Configure the 'atom' feed to http://example.com/somefeed.xml
5154 * @code
5155 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5156 * @endcode
5158 $wgOverrideSiteFeed = array();
5161 * Available feeds objects.
5162 * Should probably only be defined when a page is syndicated ie when
5163 * $wgOut->isSyndicated() is true.
5165 $wgFeedClasses = array(
5166 'rss' => 'RSSFeed',
5167 'atom' => 'AtomFeed',
5171 * Which feed types should we provide by default? This can include 'rss',
5172 * 'atom', neither, or both.
5174 $wgAdvertisedFeedTypes = array( 'atom' );
5176 /** Show watching users in recent changes, watchlist and page history views */
5177 $wgRCShowWatchingUsers = false; # UPO
5178 /** Show watching users in Page views */
5179 $wgPageShowWatchingUsers = false;
5180 /** Show the amount of changed characters in recent changes */
5181 $wgRCShowChangedSize = true;
5184 * If the difference between the character counts of the text
5185 * before and after the edit is below that value, the value will be
5186 * highlighted on the RC page.
5188 $wgRCChangedSizeThreshold = 500;
5191 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5192 * view for watched pages with new changes */
5193 $wgShowUpdatedMarker = true;
5196 * Disable links to talk pages of anonymous users (IPs) in listings on special
5197 * pages like page history, Special:Recentchanges, etc.
5199 $wgDisableAnonTalk = false;
5202 * Enable filtering of categories in Recentchanges
5204 $wgAllowCategorizedRecentChanges = false;
5207 * Allow filtering by change tag in recentchanges, history, etc
5208 * Has no effect if no tags are defined in valid_tag.
5210 $wgUseTagFilter = true;
5213 * If set to an integer, pages that are watched by this many users or more
5214 * will not require the unwatchedpages permission to view the number of
5215 * watchers.
5217 * @since 1.21
5219 $wgUnwatchedPageThreshold = false;
5222 * Recent changes flag, shown in Recentchanges and watchlist
5224 * Adding a new one:
5225 * $wgRecentChangesFlags['flag'] => array( 'letter-msg', 'tooltip-msg' );
5226 * 'class' allows to set a css class different than the flag name
5228 * @since 1.22
5230 $wgRecentChangesFlags = array(
5231 'newpage' => array( 'letter' => 'newpageletter',
5232 'title' => 'recentchanges-label-newpage' ),
5233 'minor' => array( 'letter' => 'minoreditletter',
5234 'title' => 'recentchanges-label-minor', 'class' => 'minoredit' ),
5235 'bot' => array( 'letter' => 'boteditletter',
5236 'title' => 'recentchanges-label-bot', 'class' => 'botedit' ),
5237 'unpatrolled' => array( 'letter' => 'unpatrolledletter',
5238 'title' => 'recentchanges-label-unpatrolled' ),
5241 /** @} */ # end RC/watchlist }
5243 /************************************************************************//**
5244 * @name Copyright and credits settings
5245 * @{
5249 * Override for copyright metadata.
5251 * This is the name of the page containing information about the wiki's copyright status,
5252 * which will be added as a link in the footer if it is specified. It overrides
5253 * $wgRightsUrl if both are specified.
5255 $wgRightsPage = null;
5258 * Set this to specify an external URL containing details about the content license used on your wiki.
5259 * If $wgRightsPage is set then this setting is ignored.
5261 $wgRightsUrl = null;
5264 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link.
5265 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name of the
5266 * page will also be used as the link if this variable is not set.
5268 $wgRightsText = null;
5271 * Override for copyright metadata.
5273 $wgRightsIcon = null;
5276 * Set to an array of metadata terms. Else they will be loaded based on $wgRightsUrl
5278 $wgLicenseTerms = false;
5281 * Set this to some HTML to override the rights icon with an arbitrary logo
5282 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5284 $wgCopyrightIcon = null;
5286 /** Set this to true if you want detailed copyright information forms on Upload. */
5287 $wgUseCopyrightUpload = false;
5290 * Set this to the number of authors that you want to be credited below an
5291 * article text. Set it to zero to hide the attribution block, and a negative
5292 * number (like -1) to show all authors. Note that this will require 2-3 extra
5293 * database hits, which can have a not insignificant impact on performance for
5294 * large wikis.
5296 $wgMaxCredits = 0;
5298 /** If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
5299 * Otherwise, link to a separate credits page. */
5300 $wgShowCreditsIfMax = true;
5302 /** @} */ # end of copyright and credits settings }
5304 /************************************************************************//**
5305 * @name Import / Export
5306 * @{
5310 * List of interwiki prefixes for wikis we'll accept as sources for
5311 * Special:Import (for sysops). Since complete page history can be imported,
5312 * these should be 'trusted'.
5314 * If a user has the 'import' permission but not the 'importupload' permission,
5315 * they will only be able to run imports through this transwiki interface.
5317 $wgImportSources = array();
5320 * Optional default target namespace for interwiki imports.
5321 * Can use this to create an incoming "transwiki"-style queue.
5322 * Set to numeric key, not the name.
5324 * Users may override this in the Special:Import dialog.
5326 $wgImportTargetNamespace = null;
5329 * If set to false, disables the full-history option on Special:Export.
5330 * This is currently poorly optimized for long edit histories, so is
5331 * disabled on Wikimedia's sites.
5333 $wgExportAllowHistory = true;
5336 * If set nonzero, Special:Export requests for history of pages with
5337 * more revisions than this will be rejected. On some big sites things
5338 * could get bogged down by very very long pages.
5340 $wgExportMaxHistory = 0;
5343 * Return distinct author list (when not returning full history)
5345 $wgExportAllowListContributors = false;
5348 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
5349 * up to this specified level, which will cause it to include all
5350 * pages linked to from the pages you specify. Since this number
5351 * can become *insanely large* and could easily break your wiki,
5352 * it's disabled by default for now.
5354 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
5355 * crazy-big export from being done by someone setting the depth number too
5356 * high. In other words, last resort safety net.
5358 $wgExportMaxLinkDepth = 0;
5361 * Whether to allow the "export all pages in namespace" option
5363 $wgExportFromNamespaces = false;
5366 * Whether to allow exporting the entire wiki into a single file
5368 $wgExportAllowAll = false;
5370 /** @} */ # end of import/export }
5372 /*************************************************************************//**
5373 * @name Extensions
5374 * @{
5378 * A list of callback functions which are called once MediaWiki is fully
5379 * initialised
5381 $wgExtensionFunctions = array();
5384 * Extension messages files.
5386 * Associative array mapping extension name to the filename where messages can be
5387 * found. The file should contain variable assignments. Any of the variables
5388 * present in languages/messages/MessagesEn.php may be defined, but $messages
5389 * is the most common.
5391 * Variables defined in extensions will override conflicting variables defined
5392 * in the core.
5394 * @par Example:
5395 * @code
5396 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
5397 * @endcode
5399 $wgExtensionMessagesFiles = array();
5402 * Parser output hooks.
5403 * This is an associative array where the key is an extension-defined tag
5404 * (typically the extension name), and the value is a PHP callback.
5405 * These will be called as an OutputPageParserOutput hook, if the relevant
5406 * tag has been registered with the parser output object.
5408 * Registration is done with $pout->addOutputHook( $tag, $data ).
5410 * The callback has the form:
5411 * @code
5412 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
5413 * @endcode
5415 $wgParserOutputHooks = array();
5418 * List of valid skin names.
5419 * The key should be the name in all lower case, the value should be a properly
5420 * cased name for the skin. This value will be prefixed with "Skin" to create the
5421 * class name of the skin to load, and if the skin's class cannot be found through
5422 * the autoloader it will be used to load a .php file by that name in the skins directory.
5423 * The default skins will be added later, by Skin::getSkinNames(). Use
5424 * Skin::getSkinNames() as an accessor if you wish to have access to the full list.
5426 $wgValidSkinNames = array();
5429 * Special page list.
5430 * See the top of SpecialPage.php for documentation.
5432 $wgSpecialPages = array();
5435 * Array mapping class names to filenames, for autoloading.
5437 $wgAutoloadClasses = array();
5440 * An array of extension types and inside that their names, versions, authors,
5441 * urls, descriptions and pointers to localized description msgs. Note that
5442 * the version, url, description and descriptionmsg key can be omitted.
5444 * @code
5445 * $wgExtensionCredits[$type][] = array(
5446 * 'name' => 'Example extension',
5447 * 'version' => 1.9,
5448 * 'path' => __FILE__,
5449 * 'author' => 'Foo Barstein',
5450 * 'url' => 'http://www.example.com/Example%20Extension/',
5451 * 'description' => 'An example extension',
5452 * 'descriptionmsg' => 'exampleextension-desc',
5453 * );
5454 * @endcode
5456 * Where $type is 'specialpage', 'parserhook', 'variable', 'media' or 'other'.
5457 * Where 'descriptionmsg' can be an array with message key and parameters:
5458 * 'descriptionmsg' => array( 'exampleextension-desc', param1, param2, ... ),
5460 * author can be a string or an array of strings. Authors can be linked using
5461 * the regular wikitext link syntax. To have an internationalized version of
5462 * "and others" show, add an element "...". This element can also be linked,
5463 * for instance "[http://example ...]".
5465 $wgExtensionCredits = array();
5468 * Authentication plugin.
5469 * @var $wgAuth AuthPlugin
5471 $wgAuth = null;
5474 * Global list of hooks.
5476 * The key is one of the events made available by MediaWiki, you can find
5477 * a description for most of them in docs/hooks.txt. The array is used
5478 * internally by Hook:run().
5480 * The value can be one of:
5482 * - A function name:
5483 * @code
5484 * $wgHooks['event_name'][] = $function;
5485 * @endcode
5486 * - A function with some data:
5487 * @code
5488 * $wgHooks['event_name'][] = array($function, $data);
5489 * @endcode
5490 * - A an object method:
5491 * @code
5492 * $wgHooks['event_name'][] = array($object, 'method');
5493 * @endcode
5495 * @warning You should always append to an event array or you will end up
5496 * deleting a previous registered hook.
5498 * @todo Does it support PHP closures?
5500 $wgHooks = array();
5503 * Maps jobs to their handling classes; extensions
5504 * can add to this to provide custom jobs
5506 $wgJobClasses = array(
5507 'refreshLinks' => 'RefreshLinksJob',
5508 'refreshLinks2' => 'RefreshLinksJob2',
5509 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
5510 'sendMail' => 'EmaillingJob',
5511 'enotifNotify' => 'EnotifNotifyJob',
5512 'fixDoubleRedirect' => 'DoubleRedirectJob',
5513 'uploadFromUrl' => 'UploadFromUrlJob',
5514 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
5515 'PublishStashedFile' => 'PublishStashedFileJob',
5516 'null' => 'NullJob'
5520 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
5521 * special flags are set. The values here are keys of $wgJobClasses.
5523 * These can be:
5524 * - Very long-running jobs.
5525 * - Jobs that you would never want to run as part of a page rendering request.
5526 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
5527 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
5529 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
5532 * Map of job types to configuration arrays.
5533 * This determines which queue class and storage system is used for each job type.
5534 * Job types that do not have explicit configuration will use the 'default' config.
5535 * These settings should be global to all wikis.
5537 $wgJobTypeConf = array(
5538 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
5542 * Which aggregator to use for tracking which queues have jobs.
5543 * These settings should be global to all wikis.
5545 $wgJobQueueAggregator = array(
5546 'class' => 'JobQueueAggregatorMemc'
5550 * Additional functions to be performed with updateSpecialPages.
5551 * Expensive Querypages are already updated.
5553 $wgSpecialPageCacheUpdates = array(
5554 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
5558 * Hooks that are used for outputting exceptions. Format is:
5559 * $wgExceptionHooks[] = $funcname
5560 * or:
5561 * $wgExceptionHooks[] = array( $class, $funcname )
5562 * Hooks should return strings or false
5564 $wgExceptionHooks = array();
5567 * Page property link table invalidation lists. When a page property
5568 * changes, this may require other link tables to be updated (eg
5569 * adding __HIDDENCAT__ means the hiddencat tracking category will
5570 * have been added, so the categorylinks table needs to be rebuilt).
5571 * This array can be added to by extensions.
5573 $wgPagePropLinkInvalidations = array(
5574 'hiddencat' => 'categorylinks',
5577 /** @} */ # End extensions }
5579 /*************************************************************************//**
5580 * @name Categories
5581 * @{
5585 * Use experimental, DMOZ-like category browser
5587 $wgUseCategoryBrowser = false;
5590 * On category pages, show thumbnail gallery for images belonging to that
5591 * category instead of listing them as articles.
5593 $wgCategoryMagicGallery = true;
5596 * Paging limit for categories
5598 $wgCategoryPagingLimit = 200;
5601 * Specify how category names should be sorted, when listed on a category page.
5602 * A sorting scheme is also known as a collation.
5604 * Available values are:
5606 * - uppercase: Converts the category name to upper case, and sorts by that.
5608 * - identity: Does no conversion. Sorts by binary value of the string.
5610 * - uca-default: Provides access to the Unicode Collation Algorithm with
5611 * the default element table. This is a compromise collation which sorts
5612 * all languages in a mediocre way. However, it is better than "uppercase".
5614 * To use the uca-default collation, you must have PHP's intl extension
5615 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
5616 * resulting collation will depend on the version of ICU installed on the
5617 * server.
5619 * After you change this, you must run maintenance/updateCollation.php to fix
5620 * the sort keys in the database.
5622 * Extensions can define there own collations by subclassing Collation
5623 * and using the Collation::factory hook.
5625 $wgCategoryCollation = 'uppercase';
5627 /** @} */ # End categories }
5629 /*************************************************************************//**
5630 * @name Logging
5631 * @{
5635 * The logging system has two levels: an event type, which describes the
5636 * general category and can be viewed as a named subset of all logs; and
5637 * an action, which is a specific kind of event that can exist in that
5638 * log type.
5640 $wgLogTypes = array(
5642 'block',
5643 'protect',
5644 'rights',
5645 'delete',
5646 'upload',
5647 'move',
5648 'import',
5649 'patrol',
5650 'merge',
5651 'suppress',
5655 * This restricts log access to those who have a certain right
5656 * Users without this will not see it in the option menu and can not view it
5657 * Restricted logs are not added to recent changes
5658 * Logs should remain non-transcludable
5659 * Format: logtype => permissiontype
5661 $wgLogRestrictions = array(
5662 'suppress' => 'suppressionlog'
5666 * Show/hide links on Special:Log will be shown for these log types.
5668 * This is associative array of log type => boolean "hide by default"
5670 * See $wgLogTypes for a list of available log types.
5672 * @par Example:
5673 * @code
5674 * $wgFilterLogTypes = array(
5675 * 'move' => true,
5676 * 'import' => false,
5677 * );
5678 * @endcode
5680 * Will display show/hide links for the move and import logs. Move logs will be
5681 * hidden by default unless the link is clicked. Import logs will be shown by
5682 * default, and hidden when the link is clicked.
5684 * A message of the form log-show-hide-[type] should be added, and will be used
5685 * for the link text.
5687 $wgFilterLogTypes = array(
5688 'patrol' => true
5692 * Lists the message key string for each log type. The localized messages
5693 * will be listed in the user interface.
5695 * Extensions with custom log types may add to this array.
5697 * @since 1.19, if you follow the naming convention log-name-TYPE,
5698 * where TYPE is your log type, yoy don't need to use this array.
5700 $wgLogNames = array(
5701 '' => 'all-logs-page',
5702 'block' => 'blocklogpage',
5703 'protect' => 'protectlogpage',
5704 'rights' => 'rightslog',
5705 'delete' => 'dellogpage',
5706 'upload' => 'uploadlogpage',
5707 'move' => 'movelogpage',
5708 'import' => 'importlogpage',
5709 'patrol' => 'patrol-log-page',
5710 'merge' => 'mergelog',
5711 'suppress' => 'suppressionlog',
5715 * Lists the message key string for descriptive text to be shown at the
5716 * top of each log type.
5718 * Extensions with custom log types may add to this array.
5720 * @since 1.19, if you follow the naming convention log-description-TYPE,
5721 * where TYPE is your log type, yoy don't need to use this array.
5723 $wgLogHeaders = array(
5724 '' => 'alllogstext',
5725 'block' => 'blocklogtext',
5726 'protect' => 'protectlogtext',
5727 'rights' => 'rightslogtext',
5728 'delete' => 'dellogpagetext',
5729 'upload' => 'uploadlogpagetext',
5730 'move' => 'movelogpagetext',
5731 'import' => 'importlogpagetext',
5732 'patrol' => 'patrol-log-header',
5733 'merge' => 'mergelogpagetext',
5734 'suppress' => 'suppressionlogtext',
5738 * Lists the message key string for formatting individual events of each
5739 * type and action when listed in the logs.
5741 * Extensions with custom log types may add to this array.
5743 $wgLogActions = array(
5744 'block/block' => 'blocklogentry',
5745 'block/unblock' => 'unblocklogentry',
5746 'block/reblock' => 'reblock-logentry',
5747 'protect/protect' => 'protectedarticle',
5748 'protect/modify' => 'modifiedarticleprotection',
5749 'protect/unprotect' => 'unprotectedarticle',
5750 'protect/move_prot' => 'movedarticleprotection',
5751 'upload/upload' => 'uploadedimage',
5752 'upload/overwrite' => 'overwroteimage',
5753 'upload/revert' => 'uploadedimage',
5754 'import/upload' => 'import-logentry-upload',
5755 'import/interwiki' => 'import-logentry-interwiki',
5756 'merge/merge' => 'pagemerge-logentry',
5757 'suppress/block' => 'blocklogentry',
5758 'suppress/reblock' => 'reblock-logentry',
5762 * The same as above, but here values are names of functions,
5763 * not messages.
5764 * @see LogPage::actionText
5765 * @see LogFormatter
5767 $wgLogActionsHandlers = array(
5768 'move/move' => 'MoveLogFormatter',
5769 'move/move_redir' => 'MoveLogFormatter',
5770 'delete/delete' => 'DeleteLogFormatter',
5771 'delete/restore' => 'DeleteLogFormatter',
5772 'delete/revision' => 'DeleteLogFormatter',
5773 'delete/event' => 'DeleteLogFormatter',
5774 'suppress/revision' => 'DeleteLogFormatter',
5775 'suppress/event' => 'DeleteLogFormatter',
5776 'suppress/delete' => 'DeleteLogFormatter',
5777 'patrol/patrol' => 'PatrolLogFormatter',
5778 'rights/rights' => 'RightsLogFormatter',
5779 'rights/autopromote' => 'RightsLogFormatter',
5783 * Maintain a log of newusers at Log/newusers?
5785 $wgNewUserLog = true;
5787 /** @} */ # end logging }
5789 /*************************************************************************//**
5790 * @name Special pages (general and miscellaneous)
5791 * @{
5795 * Allow special page inclusions such as {{Special:Allpages}}
5797 $wgAllowSpecialInclusion = true;
5800 * Set this to an array of special page names to prevent
5801 * maintenance/updateSpecialPages.php from updating those pages.
5803 $wgDisableQueryPageUpdate = false;
5806 * List of special pages, followed by what subtitle they should go under
5807 * at Special:SpecialPages
5809 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
5811 $wgSpecialPageGroups = array();
5814 * Whether or not to sort special pages in Special:Specialpages
5816 $wgSortSpecialPages = true;
5819 * On Special:Unusedimages, consider images "used", if they are put
5820 * into a category. Default (false) is not to count those as used.
5822 $wgCountCategorizedImagesAsUsed = false;
5825 * Maximum number of links to a redirect page listed on
5826 * Special:Whatlinkshere/RedirectDestination
5828 $wgMaxRedirectLinksRetrieved = 500;
5830 /** @} */ # end special pages }
5832 /*************************************************************************//**
5833 * @name Actions
5834 * @{
5838 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
5839 * 'foo' => 'ClassName' Load the specified class which subclasses Action
5840 * 'foo' => true Load the class FooAction which subclasses Action
5841 * If something is specified in the getActionOverrides()
5842 * of the relevant Page object it will be used
5843 * instead of the default class.
5844 * 'foo' => false The action is disabled; show an error message
5845 * Unsetting core actions will probably cause things to complain loudly.
5847 $wgActions = array(
5848 'credits' => true,
5849 'delete' => true,
5850 'edit' => true,
5851 'history' => true,
5852 'info' => true,
5853 'markpatrolled' => true,
5854 'protect' => true,
5855 'purge' => true,
5856 'raw' => true,
5857 'render' => true,
5858 'revert' => true,
5859 'revisiondelete' => true,
5860 'rollback' => true,
5861 'submit' => true,
5862 'unprotect' => true,
5863 'unwatch' => true,
5864 'view' => true,
5865 'watch' => true,
5869 * Array of disabled article actions, e.g. view, edit, delete, etc.
5870 * @deprecated since 1.18; just set $wgActions['action'] = false instead
5872 $wgDisabledActions = array();
5874 /** @} */ # end actions }
5876 /*************************************************************************//**
5877 * @name Robot (search engine crawler) policy
5878 * See also $wgNoFollowLinks.
5879 * @{
5883 * Default robot policy. The default policy is to encourage indexing and fol-
5884 * lowing of links. It may be overridden on a per-namespace and/or per-page
5885 * basis.
5887 $wgDefaultRobotPolicy = 'index,follow';
5890 * Robot policies per namespaces. The default policy is given above, the array
5891 * is made of namespace constants as defined in includes/Defines.php. You can-
5892 * not specify a different default policy for NS_SPECIAL: it is always noindex,
5893 * nofollow. This is because a number of special pages (e.g., ListPages) have
5894 * many permutations of options that display the same data under redundant
5895 * URLs, so search engine spiders risk getting lost in a maze of twisty special
5896 * pages, all alike, and never reaching your actual content.
5898 * @par Example:
5899 * @code
5900 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
5901 * @endcode
5903 $wgNamespaceRobotPolicies = array();
5906 * Robot policies per article. These override the per-namespace robot policies.
5907 * Must be in the form of an array where the key part is a properly canonicalised
5908 * text form title and the value is a robot policy.
5910 * @par Example:
5911 * @code
5912 * $wgArticleRobotPolicies = array(
5913 * 'Main Page' => 'noindex,follow',
5914 * 'User:Bob' => 'index,follow',
5915 * );
5916 * @endcode
5918 * @par Example that DOES NOT WORK because the names are not canonical text
5919 * forms:
5920 * @code
5921 * $wgArticleRobotPolicies = array(
5922 * # Underscore, not space!
5923 * 'Main_Page' => 'noindex,follow',
5924 * # "Project", not the actual project name!
5925 * 'Project:X' => 'index,follow',
5926 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
5927 * 'abc' => 'noindex,nofollow'
5928 * );
5929 * @endcode
5931 $wgArticleRobotPolicies = array();
5934 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
5935 * will not function, so users can't decide whether pages in that namespace are
5936 * indexed by search engines. If set to null, default to $wgContentNamespaces.
5938 * @par Example:
5939 * @code
5940 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
5941 * @endcode
5943 $wgExemptFromUserRobotsControl = null;
5945 /** @} */ # End robot policy }
5947 /************************************************************************//**
5948 * @name AJAX and API
5949 * Note: The AJAX entry point which this section refers to is gradually being
5950 * replaced by the API entry point, api.php. They are essentially equivalent.
5951 * Both of them are used for dynamic client-side features, via XHR.
5952 * @{
5956 * Enable the MediaWiki API for convenient access to
5957 * machine-readable data via api.php
5959 * See http://www.mediawiki.org/wiki/API
5961 $wgEnableAPI = true;
5964 * Allow the API to be used to perform write operations
5965 * (page edits, rollback, etc.) when an authorised user
5966 * accesses it
5968 $wgEnableWriteAPI = true;
5972 * WARNING: SECURITY THREAT - debug use only
5974 * Disables many security checks in the API for debugging purposes.
5975 * This flag should never be used on the production servers, as it introduces
5976 * a number of potential security holes. Even when enabled, the validation
5977 * will still be performed, but instead of failing, API will return a warning.
5978 * Also, there will always be a warning notifying that this flag is set.
5979 * At this point, the flag allows GET requests to go through for modules
5980 * requiring POST.
5982 * @since 1.21
5984 $wgDebugAPI = false;
5987 * API module extensions.
5988 * Associative array mapping module name to class name.
5989 * Extension modules may override the core modules.
5990 * @todo Describe each of the variables, group them and add examples
5992 $wgAPIModules = array();
5993 $wgAPIMetaModules = array();
5994 $wgAPIPropModules = array();
5995 $wgAPIListModules = array();
5998 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
5999 * @deprecated since 1.21
6001 $wgAPIGeneratorModules = array();
6004 * Maximum amount of rows to scan in a DB query in the API
6005 * The default value is generally fine
6007 $wgAPIMaxDBRows = 5000;
6010 * The maximum size (in bytes) of an API result.
6011 * @warning Do not set this lower than $wgMaxArticleSize*1024
6013 $wgAPIMaxResultSize = 8388608;
6016 * The maximum number of uncached diffs that can be retrieved in one API
6017 * request. Set this to 0 to disable API diffs altogether
6019 $wgAPIMaxUncachedDiffs = 1;
6022 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6023 * API request logging
6025 $wgAPIRequestLog = false;
6028 * Set the timeout for the API help text cache. If set to 0, caching disabled
6030 $wgAPICacheHelpTimeout = 60 * 60;
6033 * Enable AJAX framework
6035 $wgUseAjax = true;
6038 * List of Ajax-callable functions.
6039 * Extensions acting as Ajax callbacks must register here
6041 $wgAjaxExportList = array();
6044 * Enable watching/unwatching pages using AJAX.
6045 * Requires $wgUseAjax to be true too.
6047 $wgAjaxWatch = true;
6050 * Enable AJAX check for file overwrite, pre-upload
6052 $wgAjaxUploadDestCheck = true;
6055 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6057 $wgAjaxLicensePreview = true;
6060 * Settings for incoming cross-site AJAX requests:
6061 * Newer browsers support cross-site AJAX when the target resource allows requests
6062 * from the origin domain by the Access-Control-Allow-Origin header.
6063 * This is currently only used by the API (requests to api.php)
6064 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6066 * - '*' matches any number of characters
6067 * - '?' matches any 1 character
6069 * @par Example:
6070 * @code
6071 * $wgCrossSiteAJAXdomains = array(
6072 * 'www.mediawiki.org',
6073 * '*.wikipedia.org',
6074 * '*.wikimedia.org',
6075 * '*.wiktionary.org',
6076 * );
6077 * @endcode
6079 $wgCrossSiteAJAXdomains = array();
6082 * Domains that should not be allowed to make AJAX requests,
6083 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6084 * Uses the same syntax as $wgCrossSiteAJAXdomains
6086 $wgCrossSiteAJAXdomainExceptions = array();
6088 /** @} */ # End AJAX and API }
6090 /************************************************************************//**
6091 * @name Shell and process control
6092 * @{
6096 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6098 $wgMaxShellMemory = 102400;
6101 * Maximum file size created by shell processes under linux, in KB
6102 * ImageMagick convert for example can be fairly hungry for scratch space
6104 $wgMaxShellFileSize = 102400;
6107 * Maximum CPU time in seconds for shell processes under Linux
6109 $wgMaxShellTime = 180;
6112 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
6113 * would measure) in seconds for shell processes under Linux
6115 $wgMaxShellWallClockTime = 180;
6118 * Under Linux: a cgroup directory used to constrain memory usage of shell
6119 * commands. The directory must be writable by the user which runs MediaWiki.
6121 * If specified, this is used instead of ulimit, which is inaccurate, and
6122 * causes malloc() to return NULL, which exposes bugs in C applications, making
6123 * them segfault or deadlock.
6125 * A wrapper script will create a cgroup for each shell command that runs, as
6126 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
6127 * kernel will send a SIGKILL signal to a process in the subgroup.
6129 * @par Example:
6130 * @code
6131 * mkdir -p /sys/fs/cgroup/memory/mediawiki
6132 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
6133 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
6134 * @endcode
6136 * The reliability of cgroup cleanup can be improved by installing a
6137 * notify_on_release script in the root cgroup, see e.g.
6138 * https://gerrit.wikimedia.org/r/#/c/40784
6140 $wgShellCgroup = false;
6143 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
6145 $wgPhpCli = '/usr/bin/php';
6148 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
6149 * For Unix-like operating systems, set this to to a locale that has a UTF-8
6150 * character set. Only the character set is relevant.
6152 $wgShellLocale = 'en_US.utf8';
6154 /** @} */ # End shell }
6156 /************************************************************************//**
6157 * @name HTTP client
6158 * @{
6162 * Timeout for HTTP requests done internally
6164 $wgHTTPTimeout = 25;
6167 * Timeout for Asynchronous (background) HTTP requests
6169 $wgAsyncHTTPTimeout = 25;
6172 * Proxy to use for CURL requests.
6174 $wgHTTPProxy = false;
6177 * Timeout for connections done internally (in seconds)
6178 * Only works for curl
6180 $wgHTTPConnectTimeout = 5e0;
6182 /** @} */ # End HTTP client }
6184 /************************************************************************//**
6185 * @name Job queue
6186 * See also $wgEnotifUseJobQ.
6187 * @{
6191 * Number of jobs to perform per request. May be less than one in which case
6192 * jobs are performed probabalistically. If this is zero, jobs will not be done
6193 * during ordinary apache requests. In this case, maintenance/runJobs.php should
6194 * be run periodically.
6196 $wgJobRunRate = 1;
6199 * Number of rows to update per job
6201 $wgUpdateRowsPerJob = 500;
6204 * Number of rows to update per query
6206 $wgUpdateRowsPerQuery = 100;
6209 * Do not purge all the pages that use a page when it is edited
6210 * if there are more than this many such pages. This is used to
6211 * avoid invalidating a large portion of the squid/parser cache.
6213 * This setting should factor in any squid/parser cache expiry settings.
6215 $wgMaxBacklinksInvalidate = false;
6217 /** @} */ # End job queue }
6219 /************************************************************************//**
6220 * @name Miscellaneous
6221 * @{
6224 /** Name of the external diff engine to use */
6225 $wgExternalDiffEngine = false;
6228 * Disable redirects to special pages and interwiki redirects, which use a 302
6229 * and have no "redirected from" link.
6231 * @note This is only for articles with #REDIRECT in them. URL's containing a
6232 * local interwiki prefix (or a non-canonical special page name) are still hard
6233 * redirected regardless of this setting.
6235 $wgDisableHardRedirects = false;
6238 * LinkHolderArray batch size
6239 * For debugging
6241 $wgLinkHolderBatchSize = 1000;
6244 * By default MediaWiki does not register links pointing to same server in
6245 * externallinks dataset, use this value to override:
6247 $wgRegisterInternalExternals = false;
6250 * Maximum number of pages to move at once when moving subpages with a page.
6252 $wgMaximumMovedPages = 100;
6255 * Fix double redirects after a page move.
6256 * Tends to conflict with page move vandalism, use only on a private wiki.
6258 $wgFixDoubleRedirects = false;
6261 * Allow redirection to another page when a user logs in.
6262 * To enable, set to a string like 'Main Page'
6264 $wgRedirectOnLogin = null;
6267 * Configuration for processing pool control, for use in high-traffic wikis.
6268 * An implementation is provided in the PoolCounter extension.
6270 * This configuration array maps pool types to an associative array. The only
6271 * defined key in the associative array is "class", which gives the class name.
6272 * The remaining elements are passed through to the class as constructor
6273 * parameters.
6275 * @par Example:
6276 * @code
6277 * $wgPoolCounterConf = array( 'ArticleView' => array(
6278 * 'class' => 'PoolCounter_Client',
6279 * 'timeout' => 15, // wait timeout in seconds
6280 * 'workers' => 5, // maximum number of active threads in each pool
6281 * 'maxqueue' => 50, // maximum number of total threads in each pool
6282 * ... any extension-specific options...
6283 * );
6284 * @endcode
6286 $wgPoolCounterConf = null;
6289 * To disable file delete/restore temporarily
6291 $wgUploadMaintenance = false;
6294 * Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by
6295 * default (use the CONTENT_MODEL_XXX constants). If no special content type is defined for a given namespace,
6296 * pages in that namespace will use the CONTENT_MODEL_WIKITEXT (except for the special case of JS and CS pages).
6298 * @since 1.21
6300 $wgNamespaceContentModels = array();
6303 * How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText():
6305 * * 'ignore': return null
6306 * * 'fail': throw an MWException
6307 * * 'serialize': serialize to default format
6309 * @since 1.21
6311 $wgContentHandlerTextFallback = 'ignore';
6314 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
6315 * This way, the ContentHandler facility can be used without any additional information in the database.
6316 * A page's content model is then derived solely from the page's title. This however means that changing
6317 * a page's default model (e.g. using $wgNamespaceContentModels) will break the page and/or make the content
6318 * inaccessible. This also means that pages can not be moved to a title that would default to a different
6319 * content model.
6321 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content handling
6322 * is less robust and less flexible.
6324 * @since 1.21
6326 $wgContentHandlerUseDB = true;
6329 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
6330 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
6331 * the effect on the database they would have on a wikitext page.
6333 * @todo On the long run, it would be nice to put categories etc into a separate structure,
6334 * or at least parse only the contents of comments in the scripts.
6336 * @since 1.21
6338 $wgTextModelsToParse = array(
6339 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
6340 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
6341 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
6345 * Whether the user must enter their password to change their e-mail address
6347 * @since 1.20
6349 $wgRequirePasswordforEmailChange = true;
6352 * Register handlers for specific types of sites.
6354 * @since 1.20
6356 $wgSiteTypes = array(
6357 'mediawiki' => 'MediaWikiSite',
6361 * Formerly a list of files for HipHop compilation
6362 * @deprecated since 1.22
6364 $wgCompiledFiles = array();
6367 * For really cool vim folding this needs to be at the end:
6368 * vim: foldmarker=@{,@} foldmethod=marker
6369 * @}