(bug 24898) MediaWiki uses /tmp even if a vHost-specific tempdir is set, also make...
[mediawiki.git] / includes / DefaultSettings.php
blob333b3a5bd503f05819311bb30c37648ce6959b18
1 <?php
2 /**
3 * @file
5 * NEVER EDIT THIS FILE
8 * To customize your installation, edit "LocalSettings.php". If you make
9 * changes here, they will be lost on next upgrade of MediaWiki!
11 * Note that since all these string interpolations are expanded
12 * before LocalSettings is included, if you localize something
13 * like $wgScriptPath, you must also localize everything that
14 * depends on it.
16 * Documentation is in the source and on:
17 * http://www.mediawiki.org/wiki/Manual:Configuration_settings
20 /**
21 * @cond file_level_code
22 * This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
24 if( !defined( 'MEDIAWIKI' ) ) {
25 echo "This file is part of MediaWiki and is not a valid entry point\n";
26 die( 1 );
30 # Create a site configuration object. Not used for much in a default install
31 if ( !defined( 'MW_PHP4' ) ) {
32 require_once( "$IP/includes/SiteConfiguration.php" );
33 $wgConf = new SiteConfiguration;
35 /** @endcond */
37 /** MediaWiki version number */
38 $wgVersion = '1.17alpha';
40 /** Name of the site. It must be changed in LocalSettings.php */
41 $wgSitename = 'MediaWiki';
43 /**
44 * URL of the server. It will be automatically built including https mode.
46 * Example:
47 * <code>
48 * $wgServer = http://example.com
49 * </code>
51 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
52 * wrong server, it will redirect incorrectly after you save a page. In that
53 * case, set this variable to fix it.
55 $wgServer = '';
57 /** @cond file_level_code */
58 if( isset( $_SERVER['SERVER_NAME'] ) ) {
59 $wgServerName = $_SERVER['SERVER_NAME'];
60 } elseif( isset( $_SERVER['HOSTNAME'] ) ) {
61 $wgServerName = $_SERVER['HOSTNAME'];
62 } elseif( isset( $_SERVER['HTTP_HOST'] ) ) {
63 $wgServerName = $_SERVER['HTTP_HOST'];
64 } elseif( isset( $_SERVER['SERVER_ADDR'] ) ) {
65 $wgServerName = $_SERVER['SERVER_ADDR'];
66 } else {
67 $wgServerName = 'localhost';
70 $wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
72 $wgServer = $wgProto.'://' . $wgServerName;
73 # If the port is a non-standard one, add it to the URL
74 if( isset( $_SERVER['SERVER_PORT'] )
75 && !strpos( $wgServerName, ':' )
76 && ( ( $wgProto == 'http' && $_SERVER['SERVER_PORT'] != 80 )
77 || ( $wgProto == 'https' && $_SERVER['SERVER_PORT'] != 443 ) ) ) {
79 $wgServer .= ":" . $_SERVER['SERVER_PORT'];
81 /** @endcond */
83 /************************************************************************//**
84 * @name Script path settings
85 * @{
88 /**
89 * The path we should point to.
90 * It might be a virtual path in case with use apache mod_rewrite for example.
92 * This *needs* to be set correctly.
94 * Other paths will be set to defaults based on it unless they are directly
95 * set in LocalSettings.php
97 $wgScriptPath = '/wiki';
99 /**
100 * Whether to support URLs like index.php/Page_title These often break when PHP
101 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
102 * but then again it may not; lighttpd converts incoming path data to lowercase
103 * on systems with case-insensitive filesystems, and there have been reports of
104 * problems on Apache as well.
106 * To be safe we'll continue to keep it off by default.
108 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
109 * incorrect garbage, or to true if it is really correct.
111 * The default $wgArticlePath will be set based on this value at runtime, but if
112 * you have customized it, having this incorrectly set to true can cause
113 * redirect loops when "pretty URLs" are used.
115 $wgUsePathInfo =
116 ( strpos( php_sapi_name(), 'cgi' ) === false ) &&
117 ( strpos( php_sapi_name(), 'apache2filter' ) === false ) &&
118 ( strpos( php_sapi_name(), 'isapi' ) === false );
121 * The extension to append to script names by default. This can either be .php
122 * or .php5.
124 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
125 * variable is provided to support those providers.
127 $wgScriptExtension = '.php';
130 * The URL path to index.php.
132 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
134 $wgScript = false;
137 * The URL path to redirect.php. This is a script that is used by the Nostalgia
138 * skin.
140 * Defaults to "{$wgScriptPath}/redirect{$wgScriptExtension}".
142 $wgRedirectScript = false; ///< defaults to
143 /**@}*/
146 /************************************************************************//**
147 * @name URLs and file paths
149 * These various web and file path variables are set to their defaults
150 * in Setup.php if they are not explicitly set from LocalSettings.php.
151 * If you do override them, be sure to set them all!
153 * These will relatively rarely need to be set manually, unless you are
154 * splitting style sheets or images outside the main document root.
156 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
157 * the host part, that starts with a slash. In most cases a full URL is also
158 * acceptable. A "directory" is a local file path.
160 * In both paths and directories, trailing slashes should not be included.
162 * @{
166 * The URL path of the skins directory. Defaults to "{$wgScriptPath}/skins"
168 $wgStylePath = false;
169 $wgStyleSheetPath = &$wgStylePath;
172 * The URL path of the skins directory. Should not point to an external domain.
173 * Defaults to "{$wgScriptPath}/skins".
175 $wgLocalStylePath = false;
178 * The URL path of the extensions directory.
179 * Defaults to "{$wgScriptPath}/extensions".
181 $wgExtensionAssetsPath = false;
184 * Filesystem stylesheets directory. Defaults to "{$IP}/skins"
186 $wgStyleDirectory = false;
189 * The URL path for primary article page views. This path should contain $1,
190 * which is replaced by the article title.
192 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1", depending on
193 * $wgUsePathInfo.
195 $wgArticlePath = false;
198 * The URL path for the images directory. Defaults to "{$wgScriptPath}/images"
200 $wgUploadPath = false;
203 * The filesystem path of the images directory. Defaults to "{$IP}/images".
205 $wgUploadDirectory = false;
208 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
209 * Defaults to "{$wgStylePath}/common/images/wiki.png".
211 $wgLogo = false;
214 * The URL path of the shortcut icon.
216 $wgFavicon = '/favicon.ico';
219 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
220 * Defaults to no icon.
222 $wgAppleTouchIcon = false;
225 * The URL path of the math directory. Defaults to "{$wgUploadPath}/math".
227 * See http://www.mediawiki.org/wiki/Manual:Enable_TeX for details about how to
228 * set up mathematical formula display.
230 $wgMathPath = false;
233 * The filesystem path of the math directory.
234 * Defaults to "{$wgUploadDirectory}/math".
236 * See http://www.mediawiki.org/wiki/Manual:Enable_TeX for details about how to
237 * set up mathematical formula display.
239 $wgMathDirectory = false;
242 * The local filesystem path to a temporary directory. This is not required to
243 * be web accessible.
245 * Defaults to "{$wgUploadDirectory}/tmp".
247 $wgTmpDirectory = false;
250 * If set, this URL is added to the start of $wgUploadPath to form a complete
251 * upload URL.
253 $wgUploadBaseUrl = "";
256 * To set 'pretty' URL paths for actions other than
257 * plain page views, add to this array. For instance:
258 * 'edit' => "$wgScriptPath/edit/$1"
260 * There must be an appropriate script or rewrite rule
261 * in place to handle these URLs.
263 $wgActionPaths = array();
265 /**@}*/
267 /************************************************************************//**
268 * @name Files and file uploads
269 * @{
272 /** Uploads have to be specially set up to be secure */
273 $wgEnableUploads = false;
275 /** Allows to move images and other media files */
276 $wgAllowImageMoving = true;
279 * These are additional characters that should be replaced with '-' in file names
281 $wgIllegalFileChars = ":";
284 * @deprecated use $wgDeletedDirectory
286 $wgFileStore = array();
289 * What directory to place deleted uploads in
291 $wgDeletedDirectory = false; // Defaults to $wgUploadDirectory/deleted
294 * Set this to true if you use img_auth and want the user to see details on why access failed.
296 $wgImgAuthDetails = false;
299 * If this is enabled, img_auth.php will not allow image access unless the wiki
300 * is private. This improves security when image uploads are hosted on a
301 * separate domain.
303 $wgImgAuthPublicTest = true;
306 * File repository structures
308 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
309 * an array of such structures. Each repository structure is an associative
310 * array of properties configuring the repository.
312 * Properties required for all repos:
313 * - class The class name for the repository. May come from the core or an extension.
314 * The core repository classes are LocalRepo, ForeignDBRepo, FSRepo.
316 * - name A unique name for the repository.
318 * For most core repos:
319 * - url Base public URL
320 * - hashLevels The number of directory levels for hash-based division of files
321 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
322 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
323 * handler instead.
324 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
325 * determines whether filenames implicitly start with a capital letter.
326 * The current implementation may give incorrect description page links
327 * when the local $wgCapitalLinks and initialCapital are mismatched.
328 * - pathDisclosureProtection
329 * May be 'paranoid' to remove all parameters from error messages, 'none' to
330 * leave the paths in unchanged, or 'simple' to replace paths with
331 * placeholders. Default for LocalRepo is 'simple'.
332 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
333 * is 0644.
334 * - directory The local filesystem directory where public files are stored. Not used for
335 * some remote repos.
336 * - thumbDir The base thumbnail directory. Defaults to <directory>/thumb.
337 * - thumbUrl The base thumbnail URL. Defaults to <url>/thumb.
340 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
341 * for local repositories:
342 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
343 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
344 * http://en.wikipedia.org/w
345 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
346 * $wgScriptExtension, e.g. .php5 defaults to .php
348 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
349 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
350 * $wgFetchCommonsDescriptions.
352 * ForeignDBRepo:
353 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
354 * equivalent to the corresponding member of $wgDBservers
355 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
356 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
358 * ForeignAPIRepo:
359 * - apibase Use for the foreign API's URL
360 * - apiThumbCacheExpiry How long to locally cache thumbs for
362 * The default is to initialise these arrays from the MW<1.11 backwards compatible settings:
363 * $wgUploadPath, $wgThumbnailScriptPath, $wgSharedUploadDirectory, etc.
365 $wgLocalFileRepo = false;
367 /** @see $wgLocalFileRepo */
368 $wgForeignFileRepos = array();
371 * Use Commons as a remote file repository. Essentially a wrapper, when this
372 * is enabled $wgForeignFileRepos will point at Commons with a set of default
373 * settings
375 $wgUseInstantCommons = false;
378 * Show EXIF data, on by default if available.
379 * Requires PHP's EXIF extension: http://www.php.net/manual/en/ref.exif.php
381 * NOTE FOR WINDOWS USERS:
382 * To enable EXIF functions, add the folloing lines to the
383 * "Windows extensions" section of php.ini:
385 * extension=extensions/php_mbstring.dll
386 * extension=extensions/php_exif.dll
388 $wgShowEXIF = function_exists( 'exif_read_data' );
391 * Set to true to enable the upload _link_ while local uploads are disabled.
392 * Assumes that the special page link will be bounced to another server where
393 * uploads do work.
395 $wgRemoteUploads = false;
398 * If you operate multiple wikis, you can define a shared upload path here.
399 * Uploads to this wiki will NOT be put there - they will be put into
400 * $wgUploadDirectory.
401 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
402 * no file of the given name is found in the local repository (for [[File:..]],
403 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
404 * directory.
406 * Note that these configuration settings can now be defined on a per-
407 * repository basis for an arbitrary number of file repositories, using the
408 * $wgForeignFileRepos variable.
410 $wgUseSharedUploads = false;
411 /** Full path on the web server where shared uploads can be found */
412 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
413 /** Fetch commons image description pages and display them on the local wiki? */
414 $wgFetchCommonsDescriptions = false;
415 /** Path on the file system where shared uploads can be found. */
416 $wgSharedUploadDirectory = "/var/www/wiki3/images";
417 /** DB name with metadata about shared directory. Set this to false if the uploads do not come from a wiki. */
418 $wgSharedUploadDBname = false;
419 /** Optional table prefix used in database. */
420 $wgSharedUploadDBprefix = '';
421 /** Cache shared metadata in memcached. Don't do this if the commons wiki is in a different memcached domain */
422 $wgCacheSharedUploads = true;
424 * Allow for upload to be copied from an URL. Requires Special:Upload?source=web
425 * The timeout for copy uploads is set by $wgHTTPTimeout.
427 $wgAllowCopyUploads = false;
429 * Allow asynchronous copy uploads.
430 * This feature is experimental.
432 $wgAllowAsyncCopyUploads = false;
435 * Max size for uploads, in bytes. Applies to all uploads.
437 $wgMaxUploadSize = 1024*1024*100; # 100MB
440 * Point the upload navigation link to an external URL
441 * Useful if you want to use a shared repository by default
442 * without disabling local uploads (use $wgEnableUploads = false for that)
443 * e.g. $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
445 $wgUploadNavigationUrl = false;
448 * Point the upload link for missing files to an external URL, as with
449 * $wgUploadNavigationUrl. The URL will get (?|&)wpDestFile=<filename>
450 * appended to it as appropriate.
452 $wgUploadMissingFileUrl = false;
455 * Give a path here to use thumb.php for thumbnail generation on client request, instead of
456 * generating them on render and outputting a static URL. This is necessary if some of your
457 * apache servers don't have read/write access to the thumbnail path.
459 * Example:
460 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
462 $wgThumbnailScriptPath = false;
463 $wgSharedThumbnailScriptPath = false;
466 * Set this to false if you do not want MediaWiki to divide your images
467 * directory into many subdirectories, for improved performance.
469 * It's almost always good to leave this enabled. In previous versions of
470 * MediaWiki, some users set this to false to allow images to be added to the
471 * wiki by simply copying them into $wgUploadDirectory and then running
472 * maintenance/rebuildImages.php to register them in the database. This is no
473 * longer recommended, use maintenance/importImages.php instead.
475 * Note that this variable may be ignored if $wgLocalFileRepo is set.
477 $wgHashedUploadDirectory = true;
480 * Set the following to false especially if you have a set of files that need to
481 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
482 * directory layout.
484 $wgHashedSharedUploadDirectory = true;
487 * Base URL for a repository wiki. Leave this blank if uploads are just stored
488 * in a shared directory and not meant to be accessible through a separate wiki.
489 * Otherwise the image description pages on the local wiki will link to the
490 * image description page on this wiki.
492 * Please specify the namespace, as in the example below.
494 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
497 * This is the list of preferred extensions for uploading files. Uploading files
498 * with extensions not in this list will trigger a warning.
500 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
502 /** Files with these extensions will never be allowed as uploads. */
503 $wgFileBlacklist = array(
504 # HTML may contain cookie-stealing JavaScript and web bugs
505 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
506 # PHP scripts may execute arbitrary code on the server
507 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
508 # Other types that may be interpreted by some servers
509 'shtml', 'jhtml', 'pl', 'py', 'cgi',
510 # May contain harmful executables for Windows victims
511 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
513 /**
514 * Files with these mime types will never be allowed as uploads
515 * if $wgVerifyMimeType is enabled.
517 $wgMimeTypeBlacklist = array(
518 # HTML may contain cookie-stealing JavaScript and web bugs
519 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
520 # PHP scripts may execute arbitrary code on the server
521 'application/x-php', 'text/x-php',
522 # Other types that may be interpreted by some servers
523 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
524 # Client-side hazards on Internet Explorer
525 'text/scriptlet', 'application/x-msdownload',
526 # Windows metafile, client-side vulnerability on some systems
527 'application/x-msmetafile',
528 # A ZIP file may be a valid Java archive containing an applet which exploits the
529 # same-origin policy to steal cookies
530 'application/zip',
531 # MS Office OpenXML and other Open Package Conventions files are zip files
532 # and thus blacklisted just as other zip files
533 'application/x-opc+zip',
536 /** This is a flag to determine whether or not to check file extensions on upload. */
537 $wgCheckFileExtensions = true;
540 * If this is turned off, users may override the warning for files not covered
541 * by $wgFileExtensions.
543 $wgStrictFileExtensions = true;
545 /** Warn if uploaded files are larger than this (in bytes), or false to disable*/
546 $wgUploadSizeWarning = false;
549 * list of trusted media-types and mime types.
550 * Use the MEDIATYPE_xxx constants to represent media types.
551 * This list is used by File::isSafeFile
553 * Types not listed here will have a warning about unsafe content
554 * displayed on the images description page. It would also be possible
555 * to use this for further restrictions, like disabling direct
556 * [[media:...]] links for non-trusted formats.
558 $wgTrustedMediaFormats = array(
559 MEDIATYPE_BITMAP, //all bitmap formats
560 MEDIATYPE_AUDIO, //all audio formats
561 MEDIATYPE_VIDEO, //all plain video formats
562 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
563 "application/pdf", //PDF files
564 #"application/x-shockwave-flash", //flash/shockwave movie
568 * Plugins for media file type handling.
569 * Each entry in the array maps a MIME type to a class name
571 $wgMediaHandlers = array(
572 'image/jpeg' => 'BitmapHandler',
573 'image/png' => 'PNGHandler',
574 'image/gif' => 'GIFHandler',
575 'image/tiff' => 'TiffHandler',
576 'image/x-ms-bmp' => 'BmpHandler',
577 'image/x-bmp' => 'BmpHandler',
578 'image/svg+xml' => 'SvgHandler', // official
579 'image/svg' => 'SvgHandler', // compat
580 'image/vnd.djvu' => 'DjVuHandler', // official
581 'image/x.djvu' => 'DjVuHandler', // compat
582 'image/x-djvu' => 'DjVuHandler', // compat
586 * Resizing can be done using PHP's internal image libraries or using
587 * ImageMagick or another third-party converter, e.g. GraphicMagick.
588 * These support more file formats than PHP, which only supports PNG,
589 * GIF, JPG, XBM and WBMP.
591 * Use Image Magick instead of PHP builtin functions.
593 $wgUseImageMagick = false;
594 /** The convert command shipped with ImageMagick */
595 $wgImageMagickConvertCommand = '/usr/bin/convert';
597 /** Sharpening parameter to ImageMagick */
598 $wgSharpenParameter = '0x0.4';
600 /** Reduction in linear dimensions below which sharpening will be enabled */
601 $wgSharpenReductionThreshold = 0.85;
604 * Temporary directory used for ImageMagick. The directory must exist. Leave
605 * this set to false to let ImageMagick decide for itself.
607 $wgImageMagickTempDir = false;
610 * Use another resizing converter, e.g. GraphicMagick
611 * %s will be replaced with the source path, %d with the destination
612 * %w and %h will be replaced with the width and height.
614 * Example for GraphicMagick:
615 * <code>
616 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
617 * </code>
619 * Leave as false to skip this.
621 $wgCustomConvertCommand = false;
624 * Scalable Vector Graphics (SVG) may be uploaded as images.
625 * Since SVG support is not yet standard in browsers, it is
626 * necessary to rasterize SVGs to PNG as a fallback format.
628 * An external program is required to perform this conversion.
630 $wgSVGConverters = array(
631 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
632 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
633 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
634 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d $output $input',
635 'rsvg' => '$path/rsvg -w$width -h$height $input $output',
636 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
638 /** Pick a converter defined in $wgSVGConverters */
639 $wgSVGConverter = 'ImageMagick';
640 /** If not in the executable PATH, specify the SVG converter path. */
641 $wgSVGConverterPath = '';
642 /** Don't scale a SVG larger than this */
643 $wgSVGMaxSize = 2048;
646 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic browsers which can't
647 * perform basic stuff like MIME detection and which are vulnerable to further idiots uploading
648 * crap files as images. When this directive is on, <title> will be allowed in files with
649 * an "image/svg+xml" MIME type. You should leave this disabled if your web server is misconfigured
650 * and doesn't send appropriate MIME types for SVG images.
652 $wgAllowTitlesInSVG = false;
655 * Don't thumbnail an image if it will use too much working memory.
656 * Default is 50 MB if decompressed to RGBA form, which corresponds to
657 * 12.5 million pixels or 3500x3500
659 $wgMaxImageArea = 1.25e7;
661 * Force thumbnailing of animated GIFs above this size to a single
662 * frame instead of an animated thumbnail. As of MW 1.17 this limit
663 * is checked against the total size of all frames in the animation.
664 * It probably makes sense to keep this equal to $wgMaxImageArea.
666 $wgMaxAnimatedGifArea = 1.25e7;
668 * Browsers don't support TIFF inline generally...
669 * For inline display, we need to convert to PNG or JPEG.
670 * Note scaling should work with ImageMagick, but may not with GD scaling.
672 * Example:
673 * <code>
674 * // PNG is lossless, but inefficient for photos
675 * $wgTiffThumbnailType = array( 'png', 'image/png' );
676 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
677 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
678 * </code>
680 $wgTiffThumbnailType = false;
683 * If rendered thumbnail files are older than this timestamp, they
684 * will be rerendered on demand as if the file didn't already exist.
685 * Update if there is some need to force thumbs and SVG rasterizations
686 * to rerender, such as fixes to rendering bugs.
688 $wgThumbnailEpoch = '20030516000000';
691 * If set, inline scaled images will still produce <img> tags ready for
692 * output instead of showing an error message.
694 * This may be useful if errors are transitory, especially if the site
695 * is configured to automatically render thumbnails on request.
697 * On the other hand, it may obscure error conditions from debugging.
698 * Enable the debug log or the 'thumbnail' log group to make sure errors
699 * are logged to a file for review.
701 $wgIgnoreImageErrors = false;
704 * Allow thumbnail rendering on page view. If this is false, a valid
705 * thumbnail URL is still output, but no file will be created at
706 * the target location. This may save some time if you have a
707 * thumb.php or 404 handler set up which is faster than the regular
708 * webserver(s).
710 $wgGenerateThumbnailOnParse = true;
713 * Show thumbnails for old images on the image description page
715 $wgShowArchiveThumbnails = true;
717 /** Obsolete, always true, kept for compatibility with extensions */
718 $wgUseImageResize = true;
721 /**
722 * Internal name of virus scanner. This servers as a key to the
723 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
724 * null, every file uploaded will be scanned for viruses.
726 $wgAntivirus= null;
728 /**
729 * Configuration for different virus scanners. This an associative array of
730 * associative arrays. It contains one setup array per known scanner type.
731 * The entry is selected by $wgAntivirus, i.e.
732 * valid values for $wgAntivirus are the keys defined in this array.
734 * The configuration array for each scanner contains the following keys:
735 * "command", "codemap", "messagepattern":
737 * "command" is the full command to call the virus scanner - %f will be
738 * replaced with the name of the file to scan. If not present, the filename
739 * will be appended to the command. Note that this must be overwritten if the
740 * scanner is not in the system path; in that case, plase set
741 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
742 * path.
744 * "codemap" is a mapping of exit code to return codes of the detectVirus
745 * function in SpecialUpload.
746 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
747 * the scan to be failed. This will pass the file if $wgAntivirusRequired
748 * is not set.
749 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
750 * the file to have an usupported format, which is probably imune to
751 * virusses. This causes the file to pass.
752 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
753 * no virus was found.
754 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
755 * a virus.
756 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
758 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
759 * output. The relevant part should be matched as group one (\1).
760 * If not defined or the pattern does not match, the full message is shown to the user.
762 $wgAntivirusSetup = array(
764 #setup for clamav
765 'clamav' => array (
766 'command' => "clamscan --no-summary ",
768 'codemap' => array (
769 "0" => AV_NO_VIRUS, # no virus
770 "1" => AV_VIRUS_FOUND, # virus found
771 "52" => AV_SCAN_ABORTED, # unsupported file format (probably imune)
772 "*" => AV_SCAN_FAILED, # else scan failed
775 'messagepattern' => '/.*?:(.*)/sim',
778 #setup for f-prot
779 'f-prot' => array (
780 'command' => "f-prot ",
782 'codemap' => array (
783 "0" => AV_NO_VIRUS, # no virus
784 "3" => AV_VIRUS_FOUND, # virus found
785 "6" => AV_VIRUS_FOUND, # virus found
786 "*" => AV_SCAN_FAILED, # else scan failed
789 'messagepattern' => '/.*?Infection:(.*)$/m',
794 /** Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. */
795 $wgAntivirusRequired = true;
797 /** Determines if the mime type of uploaded files should be checked */
798 $wgVerifyMimeType = true;
800 /** Sets the mime type definition file to use by MimeMagic.php. */
801 $wgMimeTypeFile = "includes/mime.types";
802 #$wgMimeTypeFile= "/etc/mime.types";
803 #$wgMimeTypeFile= null; #use built-in defaults only.
805 /** Sets the mime type info file to use by MimeMagic.php. */
806 $wgMimeInfoFile= "includes/mime.info";
807 #$wgMimeInfoFile= null; #use built-in defaults only.
809 /**
810 * Switch for loading the FileInfo extension by PECL at runtime.
811 * This should be used only if fileinfo is installed as a shared object
812 * or a dynamic library.
814 $wgLoadFileinfoExtension = false;
816 /** Sets an external mime detector program. The command must print only
817 * the mime type to standard output.
818 * The name of the file to process will be appended to the command given here.
819 * If not set or NULL, mime_content_type will be used if available.
820 * Example:
821 * <code>
822 * #$wgMimeDetectorCommand = "file -bi"; # use external mime detector (Linux)
823 * </code>
825 $wgMimeDetectorCommand = null;
827 /**
828 * Switch for trivial mime detection. Used by thumb.php to disable all fancy
829 * things, because only a few types of images are needed and file extensions
830 * can be trusted.
832 $wgTrivialMimeDetection = false;
835 * Additional XML types we can allow via mime-detection.
836 * array = ( 'rootElement' => 'associatedMimeType' )
838 $wgXMLMimeTypes = array(
839 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
840 'svg' => 'image/svg+xml',
841 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
842 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
843 'html' => 'text/html', // application/xhtml+xml?
847 * Limit images on image description pages to a user-selectable limit. In order
848 * to reduce disk usage, limits can only be selected from a list.
849 * The user preference is saved as an array offset in the database, by default
850 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
851 * change it if you alter the array (see bug 8858).
852 * This is the list of settings the user can choose from:
854 $wgImageLimits = array (
855 array(320,240),
856 array(640,480),
857 array(800,600),
858 array(1024,768),
859 array(1280,1024),
860 array(10000,10000) );
863 * Adjust thumbnails on image pages according to a user setting. In order to
864 * reduce disk usage, the values can only be selected from a list. This is the
865 * list of settings the user can choose from:
867 $wgThumbLimits = array(
868 120,
869 150,
870 180,
871 200,
872 250,
877 * Default parameters for the <gallery> tag
879 $wgGalleryOptions = array (
880 'imagesPerRow' => 4, // Default number of images per-row in the gallery
881 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
882 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
883 'captionLength' => 20, // Length of caption to truncate (in characters)
884 'showBytes' => true, // Show the filesize in bytes in categories
888 * Adjust width of upright images when parameter 'upright' is used
889 * This allows a nicer look for upright images without the need to fix the width
890 * by hardcoded px in wiki sourcecode.
892 $wgThumbUpright = 0.75;
895 * Default value for chmoding of new directories.
897 $wgDirectoryMode = 0777;
900 * DJVU settings
901 * Path of the djvudump executable
902 * Enable this and $wgDjvuRenderer to enable djvu rendering
904 # $wgDjvuDump = 'djvudump';
905 $wgDjvuDump = null;
908 * Path of the ddjvu DJVU renderer
909 * Enable this and $wgDjvuDump to enable djvu rendering
911 # $wgDjvuRenderer = 'ddjvu';
912 $wgDjvuRenderer = null;
915 * Path of the djvutxt DJVU text extraction utility
916 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
918 # $wgDjvuTxt = 'djvutxt';
919 $wgDjvuTxt = null;
922 * Path of the djvutoxml executable
923 * This works like djvudump except much, much slower as of version 3.5.
925 * For now I recommend you use djvudump instead. The djvuxml output is
926 * probably more stable, so we'll switch back to it as soon as they fix
927 * the efficiency problem.
928 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
930 # $wgDjvuToXML = 'djvutoxml';
931 $wgDjvuToXML = null;
935 * Shell command for the DJVU post processor
936 * Default: pnmtopng, since ddjvu generates ppm output
937 * Set this to false to output the ppm file directly.
939 $wgDjvuPostProcessor = 'pnmtojpeg';
941 * File extension for the DJVU post processor output
943 $wgDjvuOutputExtension = 'jpg';
945 /** @} */ # end of file uploads }
947 /************************************************************************//**
948 * @name Email settings
949 * @{
953 * Site admin email address.
955 $wgEmergencyContact = 'wikiadmin@' . $wgServerName;
958 * Password reminder email address.
960 * The address we should use as sender when a user is requesting his password.
962 $wgPasswordSender = 'MediaWiki Mail <apache@' . $wgServerName . '>';
965 * Dummy address which should be accepted during mail send action.
966 * It might be necessary to adapt the address or to set it equal
967 * to the $wgEmergencyContact address.
969 $wgNoReplyAddress = 'reply@not.possible';
972 * Set to true to enable the e-mail basic features:
973 * Password reminders, etc. If sending e-mail on your
974 * server doesn't work, you might want to disable this.
976 $wgEnableEmail = true;
979 * Set to true to enable user-to-user e-mail.
980 * This can potentially be abused, as it's hard to track.
982 $wgEnableUserEmail = true;
985 * Set to true to put the sending user's email in a Reply-To header
986 * instead of From. ($wgEmergencyContact will be used as From.)
988 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
989 * which can cause problems with SPF validation and leak recipient addressses
990 * when bounces are sent to the sender.
992 $wgUserEmailUseReplyTo = false;
995 * Minimum time, in hours, which must elapse between password reminder
996 * emails for a given account. This is to prevent abuse by mail flooding.
998 $wgPasswordReminderResendTime = 24;
1001 * The time, in seconds, when an emailed temporary password expires.
1003 $wgNewPasswordExpiry = 3600 * 24 * 7;
1006 * SMTP Mode
1007 * For using a direct (authenticated) SMTP server connection.
1008 * Default to false or fill an array :
1009 * <code>
1010 * "host" => 'SMTP domain',
1011 * "IDHost" => 'domain for MessageID',
1012 * "port" => "25",
1013 * "auth" => true/false,
1014 * "username" => user,
1015 * "password" => password
1016 * </code>
1018 $wgSMTP = false;
1020 /** For email notification on page changes */
1021 $wgPasswordSender = $wgEmergencyContact;
1024 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1025 * from $wgEmergencyContact
1027 $wgEnotifFromEditor = false;
1029 // TODO move UPO to preferences probably ?
1030 # If set to true, users get a corresponding option in their preferences and can choose to enable or disable at their discretion
1031 # If set to false, the corresponding input form on the user preference page is suppressed
1032 # It call this to be a "user-preferences-option (UPO)"
1035 * Require email authentication before sending mail to an email addres. This is
1036 * highly recommended. It prevents MediaWiki from being used as an open spam
1037 * relay.
1039 $wgEmailAuthentication = true;
1042 * Allow users to enable email notification ("enotif") on watchlist changes.
1044 $wgEnotifWatchlist = false;
1047 * Allow users to enable email notification ("enotif") when someone edits their
1048 * user talk page.
1050 $wgEnotifUserTalk = false;
1053 * Set the Reply-to address in notifications to the editor's address, if user
1054 * allowed this in the preferences.
1056 $wgEnotifRevealEditorAddress = false;
1059 * Send notification mails on minor edits to watchlist pages. This is enabled
1060 * by default. Does not affect user talk notifications.
1062 $wgEnotifMinorEdits = true;
1065 * Send a generic mail instead of a personalised mail for each user. This
1066 * always uses UTC as the time zone, and doesn't include the username.
1068 * For pages with many users watching, this can significantly reduce mail load.
1069 * Has no effect when using sendmail rather than SMTP.
1071 $wgEnotifImpersonal = false;
1074 * Maximum number of users to mail at once when using impersonal mail. Should
1075 * match the limit on your mail server.
1077 $wgEnotifMaxRecips = 500;
1080 * Send mails via the job queue. This can be useful to reduce the time it
1081 * takes to save a page that a lot of people are watching.
1083 $wgEnotifUseJobQ = false;
1086 * Use real name instead of username in e-mail "from" field.
1088 $wgEnotifUseRealName = false;
1091 * Array of usernames who will be sent a notification email for every change
1092 * which occurs on a wiki.
1094 $wgUsersNotifiedOnAllChanges = array();
1097 /** @} */ # end of email settings
1099 /************************************************************************//**
1100 * @name Database settings
1101 * @{
1103 /** Database host name or IP address */
1104 $wgDBserver = 'localhost';
1105 /** Database port number (for PostgreSQL) */
1106 $wgDBport = 5432;
1107 /** Name of the database */
1108 $wgDBname = 'my_wiki';
1109 /** Database username */
1110 $wgDBuser = 'wikiuser';
1111 /** Database user's password */
1112 $wgDBpassword = '';
1113 /** Database type */
1114 $wgDBtype = 'mysql';
1116 /** Separate username for maintenance tasks. Leave as null to use the default. */
1117 $wgDBadminuser = null;
1118 /** Separate password for maintenance tasks. Leave as null to use the default. */
1119 $wgDBadminpassword = null;
1121 /**
1122 * Search type.
1123 * Leave as null to select the default search engine for the
1124 * selected database type (eg SearchMySQL), or set to a class
1125 * name to override to a custom search engine.
1127 $wgSearchType = null;
1129 /** Table name prefix */
1130 $wgDBprefix = '';
1131 /** MySQL table options to use during installation or update */
1132 $wgDBTableOptions = 'ENGINE=InnoDB';
1135 * SQL Mode - default is turning off all modes, including strict, if set.
1136 * null can be used to skip the setting for performance reasons and assume
1137 * DBA has done his best job.
1138 * String override can be used for some additional fun :-)
1140 $wgSQLMode = '';
1142 /** Mediawiki schema */
1143 $wgDBmwschema = 'mediawiki';
1144 /** Tsearch2 schema */
1145 $wgDBts2schema = 'public';
1147 /** To override default SQLite data directory ($docroot/../data) */
1148 $wgSQLiteDataDir = '';
1151 * Make all database connections secretly go to localhost. Fool the load balancer
1152 * thinking there is an arbitrarily large cluster of servers to connect to.
1153 * Useful for debugging.
1155 $wgAllDBsAreLocalhost = false;
1158 * Shared database for multiple wikis. Commonly used for storing a user table
1159 * for single sign-on. The server for this database must be the same as for the
1160 * main database.
1162 * For backwards compatibility the shared prefix is set to the same as the local
1163 * prefix, and the user table is listed in the default list of shared tables.
1164 * The user_properties table is also added so that users will continue to have their
1165 * preferences shared (preferences were stored in the user table prior to 1.16)
1167 * $wgSharedTables may be customized with a list of tables to share in the shared
1168 * datbase. However it is advised to limit what tables you do share as many of
1169 * MediaWiki's tables may have side effects if you try to share them.
1170 * EXPERIMENTAL
1172 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1173 * $wgDBprefix.
1175 $wgSharedDB = null;
1177 /** @see $wgSharedDB */
1178 $wgSharedPrefix = false;
1179 /** @see $wgSharedDB */
1180 $wgSharedTables = array( 'user', 'user_properties' );
1183 * Database load balancer
1184 * This is a two-dimensional array, an array of server info structures
1185 * Fields are:
1186 * - host: Host name
1187 * - dbname: Default database name
1188 * - user: DB user
1189 * - password: DB password
1190 * - type: "mysql" or "postgres"
1191 * - load: ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0
1192 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1193 * to several groups, the most specific group defined here is used.
1195 * - flags: bit field
1196 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1197 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1198 * - DBO_TRX -- wrap entire request in a transaction
1199 * - DBO_IGNORE -- ignore errors (not useful in LocalSettings.php)
1200 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1202 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1203 * - max threads: (optional) Maximum number of running threads
1205 * These and any other user-defined properties will be assigned to the mLBInfo member
1206 * variable of the Database object.
1208 * Leave at false to use the single-server variables above. If you set this
1209 * variable, the single-server variables will generally be ignored (except
1210 * perhaps in some command-line scripts).
1212 * The first server listed in this array (with key 0) will be the master. The
1213 * rest of the servers will be slaves. To prevent writes to your slaves due to
1214 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1215 * slaves in my.cnf. You can set read_only mode at runtime using:
1217 * <code>
1218 * SET @@read_only=1;
1219 * </code>
1221 * Since the effect of writing to a slave is so damaging and difficult to clean
1222 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1223 * our masters, and then set read_only=0 on masters at runtime.
1225 $wgDBservers = false;
1228 * Load balancer factory configuration
1229 * To set up a multi-master wiki farm, set the class here to something that
1230 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1231 * The class identified here is responsible for reading $wgDBservers,
1232 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1234 * The LBFactory_Multi class is provided for this purpose, please see
1235 * includes/db/LBFactory_Multi.php for configuration information.
1237 $wgLBFactoryConf = array( 'class' => 'LBFactory_Simple' );
1239 /** How long to wait for a slave to catch up to the master */
1240 $wgMasterWaitTimeout = 10;
1242 /** File to log database errors to */
1243 $wgDBerrorLog = false;
1245 /** When to give an error message */
1246 $wgDBClusterTimeout = 10;
1249 * Scale load balancer polling time so that under overload conditions, the database server
1250 * receives a SHOW STATUS query at an average interval of this many microseconds
1252 $wgDBAvgStatusPoll = 2000;
1254 /** Set to true if using InnoDB tables */
1255 $wgDBtransactions = false;
1256 /** Set to true for compatibility with extensions that might be checking.
1257 * MySQL 3.23.x is no longer supported. */
1258 $wgDBmysql4 = true;
1261 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1262 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1264 * WARNING: THIS IS EXPERIMENTAL!
1266 * May break if you're not using the table defs from mysql5/tables.sql.
1267 * May break if you're upgrading an existing wiki if set differently.
1268 * Broken symptoms likely to include incorrect behavior with page titles,
1269 * usernames, comments etc containing non-ASCII characters.
1270 * Might also cause failures on the object cache and other things.
1272 * Even correct usage may cause failures with Unicode supplementary
1273 * characters (those not in the Basic Multilingual Plane) unless MySQL
1274 * has enhanced their Unicode support.
1276 $wgDBmysql5 = false;
1279 * Other wikis on this site, can be administered from a single developer
1280 * account.
1281 * Array numeric key => database name
1283 $wgLocalDatabases = array();
1286 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1287 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1288 * show a more obvious warning.
1290 $wgSlaveLagWarning = 10;
1291 /** @see $wgSlaveLagWarning */
1292 $wgSlaveLagCritical = 30;
1295 * Use old names for change_tags indices.
1297 $wgOldChangeTagsIndex = false;
1299 /**@}*/ # End of DB settings }
1302 /************************************************************************//**
1303 * @name Text storage
1304 * @{
1308 * We can also compress text stored in the 'text' table. If this is set on, new
1309 * revisions will be compressed on page save if zlib support is available. Any
1310 * compressed revisions will be decompressed on load regardless of this setting
1311 * *but will not be readable at all* if zlib support is not available.
1313 $wgCompressRevisions = false;
1316 * External stores allow including content
1317 * from non database sources following URL links
1319 * Short names of ExternalStore classes may be specified in an array here:
1320 * $wgExternalStores = array("http","file","custom")...
1322 * CAUTION: Access to database might lead to code execution
1324 $wgExternalStores = false;
1327 * An array of external mysql servers, e.g.
1328 * $wgExternalServers = array( 'cluster1' => array( 'srv28', 'srv29', 'srv30' ) );
1329 * Used by LBFactory_Simple, may be ignored if $wgLBFactoryConf is set to another class.
1331 $wgExternalServers = array();
1334 * The place to put new revisions, false to put them in the local text table.
1335 * Part of a URL, e.g. DB://cluster1
1337 * Can be an array instead of a single string, to enable data distribution. Keys
1338 * must be consecutive integers, starting at zero. Example:
1340 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1343 $wgDefaultExternalStore = false;
1346 * Revision text may be cached in $wgMemc to reduce load on external storage
1347 * servers and object extraction overhead for frequently-loaded revisions.
1349 * Set to 0 to disable, or number of seconds before cache expiry.
1351 $wgRevisionCacheExpiry = 0;
1353 /** @} */ # end text storage }
1355 /************************************************************************//**
1356 * @name Performance hacks and limits
1357 * @{
1359 /** Disable database-intensive features */
1360 $wgMiserMode = false;
1361 /** Disable all query pages if miser mode is on, not just some */
1362 $wgDisableQueryPages = false;
1363 /** Number of rows to cache in 'querycache' table when miser mode is on */
1364 $wgQueryCacheLimit = 1000;
1365 /** Number of links to a page required before it is deemed "wanted" */
1366 $wgWantedPagesThreshold = 1;
1367 /** Enable slow parser functions */
1368 $wgAllowSlowParserFunctions = false;
1371 * Do DELETE/INSERT for link updates instead of incremental
1373 $wgUseDumbLinkUpdate = false;
1376 * Anti-lock flags - bitfield
1377 * - ALF_PRELOAD_LINKS:
1378 * Preload links during link update for save
1379 * - ALF_PRELOAD_EXISTENCE:
1380 * Preload cur_id during replaceLinkHolders
1381 * - ALF_NO_LINK_LOCK:
1382 * Don't use locking reads when updating the link table. This is
1383 * necessary for wikis with a high edit rate for performance
1384 * reasons, but may cause link table inconsistency
1385 * - ALF_NO_BLOCK_LOCK:
1386 * As for ALF_LINK_LOCK, this flag is a necessity for high-traffic
1387 * wikis.
1389 $wgAntiLockFlags = 0;
1392 * Maximum article size in kilobytes
1394 $wgMaxArticleSize = 2048;
1397 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
1398 * raise PHP's memory limit if it's below this amount.
1400 $wgMemoryLimit = "50M";
1402 /** @} */ # end performance hacks }
1404 /************************************************************************//**
1405 * @name Cache settings
1406 * @{
1410 * Directory for caching data in the local filesystem. Should not be accessible
1411 * from the web. Set this to false to not use any local caches.
1413 * Note: if multiple wikis share the same localisation cache directory, they
1414 * must all have the same set of extensions. You can set a directory just for
1415 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
1417 $wgCacheDirectory = false;
1420 * Main cache type. This should be a cache with fast access, but it may have
1421 * limited space. By default, it is disabled, since the database is not fast
1422 * enough to make it worthwhile.
1424 * The options are:
1426 * - CACHE_ANYTHING: Use anything, as long as it works
1427 * - CACHE_NONE: Do not cache
1428 * - CACHE_DB: Store cache objects in the DB
1429 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCacheServers
1430 * - CACHE_ACCEL: eAccelerator, APC, XCache or WinCache
1431 * - CACHE_DBA: Use PHP's DBA extension to store in a DBM-style
1432 * database. This is slow, and is not recommended for
1433 * anything other than debugging.
1435 * @see $wgMessageCacheType, $wgParserCacheType
1437 $wgMainCacheType = CACHE_NONE;
1440 * The cache type for storing the contents of the MediaWiki namespace. This
1441 * cache is used for a small amount of data which is expensive to regenerate.
1443 * For available types see $wgMainCacheType.
1445 $wgMessageCacheType = CACHE_ANYTHING;
1448 * The cache type for storing article HTML. This is used to store data which
1449 * is expensive to regenerate, and benefits from having plenty of storage space.
1451 * For available types see $wgMainCacheType.
1453 $wgParserCacheType = CACHE_ANYTHING;
1456 * The expiry time for the parser cache, in seconds. The default is 86.4k
1457 * seconds, otherwise known as a day.
1459 $wgParserCacheExpireTime = 86400;
1462 * Select which DBA handler <http://www.php.net/manual/en/dba.requirements.php> to use as CACHE_DBA backend
1464 $wgDBAhandler = 'db3';
1467 * Store sessions in MemCached. This can be useful to improve performance, or to
1468 * avoid the locking behaviour of PHP's default session handler, which tends to
1469 * prevent multiple requests for the same user from acting concurrently.
1471 $wgSessionsInMemcached = false;
1473 /**
1474 * This is used for setting php's session.save_handler. In practice, you will
1475 * almost never need to change this ever. Other options might be 'user' or
1476 * 'session_mysql.' Setting to null skips setting this entirely (which might be
1477 * useful if you're doing cross-application sessions, see bug 11381)
1479 $wgSessionHandler = 'files';
1481 /** If enabled, will send MemCached debugging information to $wgDebugLogFile */
1482 $wgMemCachedDebug = false;
1484 /** The list of MemCached servers and port numbers */
1485 $wgMemCachedServers = array( '127.0.0.1:11000' );
1487 /**
1488 * Use persistent connections to MemCached, which are shared across multiple
1489 * requests.
1491 $wgMemCachedPersistent = false;
1494 * Read/write timeout for MemCached server communication, in microseconds.
1496 $wgMemCachedTimeout = 100000;
1499 * Set this to true to make a local copy of the message cache, for use in
1500 * addition to memcached. The files will be put in $wgCacheDirectory.
1502 $wgUseLocalMessageCache = false;
1505 * Defines format of local cache
1506 * true - Serialized object
1507 * false - PHP source file (Warning - security risk)
1509 $wgLocalMessageCacheSerialized = true;
1512 * Instead of caching everything, keep track which messages are requested and
1513 * load only most used messages. This only makes sense if there is lots of
1514 * interface messages customised in the wiki (like hundreds in many languages).
1516 $wgAdaptiveMessageCache = false;
1519 * Localisation cache configuration. Associative array with keys:
1520 * class: The class to use. May be overridden by extensions.
1522 * store: The location to store cache data. May be 'files', 'db' or
1523 * 'detect'. If set to "files", data will be in CDB files. If set
1524 * to "db", data will be stored to the database. If set to
1525 * "detect", files will be used if $wgCacheDirectory is set,
1526 * otherwise the database will be used.
1528 * storeClass: The class name for the underlying storage. If set to a class
1529 * name, it overrides the "store" setting.
1531 * storeDirectory: If the store class puts its data in files, this is the
1532 * directory it will use. If this is false, $wgCacheDirectory
1533 * will be used.
1535 * manualRecache: Set this to true to disable cache updates on web requests.
1536 * Use maintenance/rebuildLocalisationCache.php instead.
1538 $wgLocalisationCacheConf = array(
1539 'class' => 'LocalisationCache',
1540 'store' => 'detect',
1541 'storeClass' => false,
1542 'storeDirectory' => false,
1543 'manualRecache' => false,
1546 /** Allow client-side caching of pages */
1547 $wgCachePages = true;
1550 * Set this to current time to invalidate all prior cached pages. Affects both
1551 * client- and server-side caching.
1552 * You can get the current date on your server by using the command:
1553 * date +%Y%m%d%H%M%S
1555 $wgCacheEpoch = '20030516000000';
1558 * Bump this number when changing the global style sheets and JavaScript.
1559 * It should be appended in the query string of static CSS and JS includes,
1560 * to ensure that client-side caches do not keep obsolete copies of global
1561 * styles.
1563 $wgStyleVersion = '301';
1566 * This will cache static pages for non-logged-in users to reduce
1567 * database traffic on public sites.
1568 * Must set $wgShowIPinHeader = false
1570 $wgUseFileCache = false;
1572 /**
1573 * Directory where the cached page will be saved.
1574 * Defaults to "$wgCacheDirectory/html".
1576 $wgFileCacheDirectory = false;
1579 * Keep parsed pages in a cache (objectcache table or memcached)
1580 * to speed up output of the same page viewed by another user with the
1581 * same options.
1583 * This can provide a significant speedup for medium to large pages,
1584 * so you probably want to keep it on. Extensions that conflict with the
1585 * parser cache should disable the cache on a per-page basis instead.
1587 $wgEnableParserCache = true;
1590 * Append a configured value to the parser cache and the sitenotice key so
1591 * that they can be kept separate for some class of activity.
1593 $wgRenderHashAppend = '';
1596 * If on, the sidebar navigation links are cached for users with the
1597 * current language set. This can save a touch of load on a busy site
1598 * by shaving off extra message lookups.
1600 * However it is also fragile: changing the site configuration, or
1601 * having a variable $wgArticlePath, can produce broken links that
1602 * don't update as expected.
1604 $wgEnableSidebarCache = false;
1607 * Expiry time for the sidebar cache, in seconds
1609 $wgSidebarCacheExpiry = 86400;
1612 * When using the file cache, we can store the cached HTML gzipped to save disk
1613 * space. Pages will then also be served compressed to clients that support it.
1614 * THIS IS NOT COMPATIBLE with ob_gzhandler which is now enabled if supported in
1615 * the default LocalSettings.php! If you enable this, remove that setting first.
1617 * Requires zlib support enabled in PHP.
1619 $wgUseGzip = false;
1621 /** Whether MediaWiki should send an ETag header */
1622 $wgUseETag = false;
1624 /** Clock skew or the one-second resolution of time() can occasionally cause cache
1625 * problems when the user requests two pages within a short period of time. This
1626 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
1627 * a grace period.
1629 $wgClockSkewFudge = 5;
1631 /** @} */ # end of cache settings
1633 /************************************************************************//**
1634 * @name HTTP proxy (Squid) settings
1636 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
1637 * although they are referred to as Squid settings for historical reasons.
1639 * Achieving a high hit ratio with an HTTP proxy requires special
1640 * configuration. See http://www.mediawiki.org/wiki/Manual:Squid_caching for
1641 * more details.
1643 * @{
1646 /**
1647 * Enable/disable Squid.
1648 * See http://www.mediawiki.org/wiki/Manual:Squid_caching
1650 $wgUseSquid = false;
1652 /** If you run Squid3 with ESI support, enable this (default:false): */
1653 $wgUseESI = false;
1655 /** Send X-Vary-Options header for better caching (requires patched Squid) */
1656 $wgUseXVO = false;
1658 /**
1659 * Internal server name as known to Squid, if different. Example:
1660 * <code>
1661 * $wgInternalServer = 'http://yourinternal.tld:8000';
1662 * </code>
1664 $wgInternalServer = $wgServer;
1667 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
1668 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
1669 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
1670 * days
1672 $wgSquidMaxage = 18000;
1675 * Default maximum age for raw CSS/JS accesses
1677 $wgForcedRawSMaxage = 300;
1680 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
1682 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
1683 * headers sent/modified from these proxies when obtaining the remote IP address
1685 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
1687 $wgSquidServers = array();
1690 * As above, except these servers aren't purged on page changes; use to set a
1691 * list of trusted proxies, etc.
1693 $wgSquidServersNoPurge = array();
1695 /** Maximum number of titles to purge in any one client operation */
1696 $wgMaxSquidPurgeTitles = 400;
1698 /**
1699 * HTCP multicast address. Set this to a multicast IP address to enable HTCP.
1701 * Note that MediaWiki uses the old non-RFC compliant HTCP format, which was
1702 * present in the earliest Squid implementations of the protocol.
1704 $wgHTCPMulticastAddress = false;
1706 /**
1707 * HTCP multicast port.
1708 * @see $wgHTCPMulticastAddress
1710 $wgHTCPPort = 4827;
1712 /**
1713 * HTCP multicast TTL.
1714 * @see $wgHTCPMulticastAddress
1716 $wgHTCPMulticastTTL = 1;
1718 /** Should forwarded Private IPs be accepted? */
1719 $wgUsePrivateIPs = false;
1721 /** @} */ # end of HTTP proxy settings
1723 /************************************************************************//**
1724 * @name Language, regional and character encoding settings
1725 * @{
1728 /** Site language code, should be one of ./languages/Language(.*).php */
1729 $wgLanguageCode = 'en';
1732 * Some languages need different word forms, usually for different cases.
1733 * Used in Language::convertGrammar(). Example:
1735 * <code>
1736 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
1737 * </code>
1739 $wgGrammarForms = array();
1741 /** Treat language links as magic connectors, not inline links */
1742 $wgInterwikiMagic = true;
1744 /** Hide interlanguage links from the sidebar */
1745 $wgHideInterlanguageLinks = false;
1747 /** List of language names or overrides for default names in Names.php */
1748 $wgExtraLanguageNames = array();
1751 * List of language codes that don't correspond to an actual language.
1752 * These codes are leftoffs from renames, or other legacy things.
1753 * Also, qqq is a dummy "language" for documenting messages.
1755 $wgDummyLanguageCodes = array( 'qqq', 'als', 'be-x-old', 'dk', 'fiu-vro', 'iu', 'nb', 'simple', 'tp' );
1757 /** @deprecated Since MediaWiki 1.5, this must always be set to UTF-8. */
1758 $wgInputEncoding = 'UTF-8';
1759 /** @deprecated Since MediaWiki 1.5, this must always be set to UTF-8. */
1760 $wgOutputEncoding = 'UTF-8';
1763 * Character set for use in the article edit box. Language-specific encodings
1764 * may be defined.
1766 * This historic feature is one of the first that was added by former MediaWiki
1767 * team leader Brion Vibber, and is used to support the Esperanto x-system.
1769 $wgEditEncoding = '';
1772 * Set this to true to replace Arabic presentation forms with their standard
1773 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
1774 * set to "ar".
1776 * Note that pages with titles containing presentation forms will become
1777 * inaccessible, run maintenance/cleanupTitles.php to fix this.
1779 $wgFixArabicUnicode = true;
1782 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
1783 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
1784 * set to "ml". Note that some clients (even new clients as of 2010) do not
1785 * support these characters.
1787 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
1788 * fix any ZWJ sequences in existing page titles.
1790 $wgFixMalayalamUnicode = true;
1793 * Set this to always convert certain Unicode sequences to modern ones
1794 * regardless of the content language. This has a small performance
1795 * impact.
1797 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
1798 * details.
1800 * @since 1.17
1802 $wgAllUnicodeFixes = false;
1805 * Set this to eg 'ISO-8859-1' to perform character set conversion when
1806 * loading old revisions not marked with "utf-8" flag. Use this when
1807 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
1808 * burdensome mass conversion of old text data.
1810 * NOTE! This DOES NOT touch any fields other than old_text.Titles, comments,
1811 * user names, etc still must be converted en masse in the database before
1812 * continuing as a UTF-8 wiki.
1814 $wgLegacyEncoding = false;
1817 * Browser Blacklist for unicode non compliant browsers. Contains a list of
1818 * regexps : "/regexp/" matching problematic browsers. These browsers will
1819 * be served encoded unicode in the edit box instead of real unicode.
1821 $wgBrowserBlackList = array(
1823 * Netscape 2-4 detection
1824 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
1825 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
1826 * with a negative assertion. The [UIN] identifier specifies the level of security
1827 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
1828 * The language string is unreliable, it is missing on NS4 Mac.
1830 * Reference: http://www.psychedelix.com/agents/index.shtml
1832 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
1833 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
1834 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
1837 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>, Þ to <THORN> and Ð to <ETH>
1839 * Known useragents:
1840 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
1841 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
1842 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
1843 * - [...]
1845 * @link http://en.wikipedia.org/w/index.php?title=User%3A%C6var_Arnfj%F6r%F0_Bjarmason%2Ftestme&diff=12356041&oldid=12355864
1846 * @link http://en.wikipedia.org/wiki/Template%3AOS9
1848 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
1851 * Google wireless transcoder, seems to eat a lot of chars alive
1852 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
1854 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
1858 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
1859 * create stub reference rows in the text table instead of copying
1860 * the full text of all current entries from 'cur' to 'text'.
1862 * This will speed up the conversion step for large sites, but
1863 * requires that the cur table be kept around for those revisions
1864 * to remain viewable.
1866 * maintenance/migrateCurStubs.php can be used to complete the
1867 * migration in the background once the wiki is back online.
1869 * This option affects the updaters *only*. Any present cur stub
1870 * revisions will be readable at runtime regardless of this setting.
1872 $wgLegacySchemaConversion = false;
1874 /**
1875 * Enable to allow rewriting dates in page text.
1876 * DOES NOT FORMAT CORRECTLY FOR MOST LANGUAGES.
1878 $wgUseDynamicDates = false;
1879 /**
1880 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
1881 * the interface is set to English.
1883 $wgAmericanDates = false;
1885 * For Hindi and Arabic use local numerals instead of Western style (0-9)
1886 * numerals in interface.
1888 $wgTranslateNumerals = true;
1891 * Translation using MediaWiki: namespace.
1892 * Interface messages will be loaded from the database.
1894 $wgUseDatabaseMessages = true;
1897 * Expiry time for the message cache key
1899 $wgMsgCacheExpiry = 86400;
1902 * Maximum entry size in the message cache, in bytes
1904 $wgMaxMsgCacheEntrySize = 10000;
1906 /** Whether to enable language variant conversion. */
1907 $wgDisableLangConversion = false;
1909 /** Whether to enable language variant conversion for links. */
1910 $wgDisableTitleConversion = false;
1912 /** Default variant code, if false, the default will be the language code */
1913 $wgDefaultLanguageVariant = false;
1915 /**
1916 * Disabled variants array of language variant conversion. Example:
1917 * <code>
1918 * $wgDisabledVariants[] = 'zh-mo';
1919 * $wgDisabledVariants[] = 'zh-my';
1920 * </code>
1922 * or:
1924 * <code>
1925 * $wgDisabledVariants = array('zh-mo', 'zh-my');
1926 * </code>
1928 $wgDisabledVariants = array();
1931 * Like $wgArticlePath, but on multi-variant wikis, this provides a
1932 * path format that describes which parts of the URL contain the
1933 * language variant. For Example:
1935 * $wgLanguageCode = 'sr';
1936 * $wgVariantArticlePath = '/$2/$1';
1937 * $wgArticlePath = '/wiki/$1';
1939 * A link to /wiki/ would be redirected to /sr/Главна_страна
1941 * It is important that $wgArticlePath not overlap with possible values
1942 * of $wgVariantArticlePath.
1944 $wgVariantArticlePath = false;
1947 * Show a bar of language selection links in the user login and user
1948 * registration forms; edit the "loginlanguagelinks" message to
1949 * customise these.
1951 $wgLoginLanguageSelector = false;
1954 * When translating messages with wfMsg(), it is not always clear what should
1955 * be considered UI messages and what should be content messages.
1957 * For example, for the English Wikipedia, there should be only one 'mainpage',
1958 * so when getting the link for 'mainpage', we should treat it as site content
1959 * and call wfMsgForContent(), but for rendering the text of the link, we call
1960 * wfMsg(). The code behaves this way by default. However, sites like the
1961 * Wikimedia Commons do offer different versions of 'mainpage' and the like for
1962 * different languages. This array provides a way to override the default
1963 * behavior. For example, to allow language-specific main page and community
1964 * portal, set
1966 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
1968 $wgForceUIMsgAsContentMsg = array();
1971 * Fake out the timezone that the server thinks it's in. This will be used for
1972 * date display and not for what's stored in the DB. Leave to null to retain
1973 * your server's OS-based timezone value.
1975 * This variable is currently used only for signature formatting and for local
1976 * time/date parser variables ({{LOCALTIME}} etc.)
1978 * Timezones can be translated by editing MediaWiki messages of type
1979 * timezone-nameinlowercase like timezone-utc.
1981 * Examples:
1982 * <code>
1983 * $wgLocaltimezone = 'GMT';
1984 * $wgLocaltimezone = 'PST8PDT';
1985 * $wgLocaltimezone = 'Europe/Sweden';
1986 * $wgLocaltimezone = 'CET';
1987 * </code>
1989 $wgLocaltimezone = null;
1992 * Set an offset from UTC in minutes to use for the default timezone setting
1993 * for anonymous users and new user accounts.
1995 * This setting is used for most date/time displays in the software, and is
1996 * overrideable in user preferences. It is *not* used for signature timestamps.
1998 * You can set it to match the configured server timezone like this:
1999 * $wgLocalTZoffset = date("Z") / 60;
2001 * If your server is not configured for the timezone you want, you can set
2002 * this in conjunction with the signature timezone and override the PHP default
2003 * timezone like so:
2004 * $wgLocaltimezone="Europe/Berlin";
2005 * date_default_timezone_set( $wgLocaltimezone );
2006 * $wgLocalTZoffset = date("Z") / 60;
2008 * Leave at NULL to show times in universal time (UTC/GMT).
2010 $wgLocalTZoffset = null;
2012 /** @} */ # End of language/charset settings
2014 /*************************************************************************//**
2015 * @name Output format and skin settings
2016 * @{
2019 /** The default Content-Type header. */
2020 $wgMimeType = 'text/html';
2022 /** The content type used in script tags. */
2023 $wgJsMimeType = 'text/javascript';
2025 /** The HTML document type. */
2026 $wgDocType = '-//W3C//DTD XHTML 1.0 Transitional//EN';
2028 /** The URL of the document type declaration. */
2029 $wgDTD = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd';
2031 /** The default xmlns attribute. */
2032 $wgXhtmlDefaultNamespace = 'http://www.w3.org/1999/xhtml';
2035 * Should we output an HTML5 doctype? If false, use XHTML 1.0 Transitional
2036 * instead, and disable HTML5 features. This may eventually be removed and set
2037 * to always true.
2039 $wgHtml5 = true;
2042 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
2043 * Will be initialized later if not set explicitly.
2045 $wgHtml5Version = null;
2048 * Enabled RDFa attributes for use in wikitext.
2049 * NOTE: Interaction with HTML5 is somewhat underspecified.
2051 $wgAllowRdfaAttributes = false;
2054 * Enabled HTML5 microdata attributes for use in wikitext, if $wgHtml5 is also true.
2056 $wgAllowMicrodataAttributes = false;
2059 * Should we try to make our HTML output well-formed XML? If set to false,
2060 * output will be a few bytes shorter, and the HTML will arguably be more
2061 * readable. If set to true, life will be much easier for the authors of
2062 * screen-scraping bots, and the HTML will arguably be more readable.
2064 * Setting this to false may omit quotation marks on some attributes, omit
2065 * slashes from some self-closing tags, omit some ending tags, etc., where
2066 * permitted by HTML5. Setting it to true will not guarantee that all pages
2067 * will be well-formed, although non-well-formed pages should be rare and it's
2068 * a bug if you find one. Conversely, setting it to false doesn't mean that
2069 * all XML-y constructs will be omitted, just that they might be.
2071 * Because of compatibility with screen-scraping bots, and because it's
2072 * controversial, this is currently left to true by default.
2074 $wgWellFormedXml = true;
2077 * Permit other namespaces in addition to the w3.org default.
2078 * Use the prefix for the key and the namespace for the value. For
2079 * example:
2080 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2081 * Normally we wouldn't have to define this in the root <html>
2082 * element, but IE needs it there in some circumstances.
2084 $wgXhtmlNamespaces = array();
2087 * Show IP address, for non-logged in users. It's necessary to switch this off
2088 * for some forms of caching.
2090 $wgShowIPinHeader = true;
2093 * Site notice shown at the top of each page
2095 * MediaWiki:Sitenotice page, which will override this. You can also
2096 * provide a separate message for logged-out users using the
2097 * MediaWiki:Anonnotice page.
2099 $wgSiteNotice = '';
2102 * A subtitle to add to the tagline, for skins that have it/
2104 $wgExtraSubtitle = '';
2107 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2109 $wgSiteSupportPage = '';
2112 * Validate the overall output using tidy and refuse
2113 * to display the page if it's not valid.
2115 $wgValidateAllHtml = false;
2118 * Default skin, for new users and anonymous visitors. Registered users may
2119 * change this to any one of the other available skins in their preferences.
2120 * This has to be completely lowercase; see the "skins" directory for the list
2121 * of available skins.
2123 $wgDefaultSkin = 'vector';
2126 * Should we allow the user's to select their own skin that will override the default?
2127 * @deprecated in 1.16, use $wgHiddenPrefs[] = 'skin' to disable it
2129 $wgAllowUserSkin = true;
2132 * Specify the name of a skin that should not be presented in the list of
2133 * available skins. Use for blacklisting a skin which you do not want to
2134 * remove from the .../skins/ directory
2136 $wgSkipSkin = '';
2137 /** Array for more like $wgSkipSkin. */
2138 $wgSkipSkins = array();
2141 * Optionally, we can specify a stylesheet to use for media="handheld".
2142 * This is recognized by some, but not all, handheld/mobile/PDA browsers.
2143 * If left empty, compliant handheld browsers won't pick up the skin
2144 * stylesheet, which is specified for 'screen' media.
2146 * Can be a complete URL, base-relative path, or $wgStylePath-relative path.
2147 * Try 'chick/main.css' to apply the Chick styles to the MonoBook HTML.
2149 * Will also be switched in when 'handheld=yes' is added to the URL, like
2150 * the 'printable=yes' mode for print media.
2152 $wgHandheldStyle = false;
2155 * If set, 'screen' and 'handheld' media specifiers for stylesheets are
2156 * transformed such that they apply to the iPhone/iPod Touch Mobile Safari,
2157 * which doesn't recognize 'handheld' but does support media queries on its
2158 * screen size.
2160 * Consider only using this if you have a *really good* handheld stylesheet,
2161 * as iPhone users won't have any way to disable it and use the "grown-up"
2162 * styles instead.
2164 $wgHandheldForIPhone = false;
2167 * Allow user Javascript page?
2168 * This enables a lot of neat customizations, but may
2169 * increase security risk to users and server load.
2171 $wgAllowUserJs = false;
2174 * Allow user Cascading Style Sheets (CSS)?
2175 * This enables a lot of neat customizations, but may
2176 * increase security risk to users and server load.
2178 $wgAllowUserCss = false;
2181 * Allow user-preferences implemented in CSS?
2182 * This allows users to customise the site appearance to a greater
2183 * degree; disabling it will improve page load times.
2185 $wgAllowUserCssPrefs = true;
2187 /** Use the site's Javascript page? */
2188 $wgUseSiteJs = true;
2190 /** Use the site's Cascading Style Sheets (CSS)? */
2191 $wgUseSiteCss = true;
2194 * Version of jQuery to use. Currently available versions are 1.3.2 and 1.4.2 .
2195 * Other versions can be installed by hand at your own risk, see
2196 * http://www.mediawiki.org/wiki/Manual:$wgJQueryVersion
2198 $wgJQueryVersion = '1.4.2';
2201 * Use a minified version of jQuery. If enabled, jquery-versionnumber.min.js
2202 * will be used instead of jquery-versionnumber.js . It is recommended you only
2203 * disable this for debugging purposes.
2205 $wgJQueryMinified = true;
2208 * Include jQuery on every page served by MediaWiki. You can disable this if
2209 * your user/site-wide JS doesn't need it and you want to save bandwidth.
2211 $wgJQueryOnEveryPage = true;
2214 * Set to false to disable application of access keys and tooltips,
2215 * eg to avoid keyboard conflicts with system keys or as a low-level
2216 * optimization.
2218 $wgEnableTooltipsAndAccesskeys = true;
2221 * Break out of framesets. This can be used to prevent external sites from
2222 * framing your site with ads.
2224 $wgBreakFrames = false;
2227 * Disable output compression (enabled by default if zlib is available)
2229 $wgDisableOutputCompression = false;
2232 * Should we allow a broader set of characters in id attributes, per HTML5? If
2233 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
2234 * functionality is ready, it will be on by default with no option.
2236 * Currently this appears to work fine in Chrome 4 and 5, Firefox 3.5 and 3.6, IE6
2237 * and 8, and Opera 10.50, but it fails in Opera 10.10: Unicode IDs don't seem
2238 * to work as anchors. So not quite ready for general use yet.
2240 $wgExperimentalHtmlIds = true;
2243 * Search form behavior for Vector skin only
2244 * true = use an icon search button
2245 * false = use Go & Search buttons
2247 $wgVectorUseSimpleSearch = false;
2250 * Watch and unwatch as an icon rather than a link for Vector skin only
2251 * true = use an icon watch/unwatch button
2252 * false = use watch/unwatch text link
2254 $wgVectorUseIconWatch = false;
2257 * Show the name of the current variant as a label in the variants drop-down menu
2259 $wgVectorShowVariantName = false;
2262 * Add extra stylesheets for Vector - This is only being used so that we can play around with different options while
2263 * keeping our CSS code in the SVN and not having to change the main Vector styles. This will probably go away later on.
2264 * null = add no extra styles
2265 * array = list of style paths relative to skins/vector/
2267 $wgVectorExtraStyles = null;
2270 * Display user edit counts in various prominent places.
2272 $wgEdititis = false;
2275 * Experimental better directionality support.
2277 $wgBetterDirectionality = false;
2280 /** @} */ # End of output format settings }
2282 /*************************************************************************//**
2283 * @name Page title and interwiki link settings
2284 * @{
2288 * Name of the project namespace. If left set to false, $wgSitename will be
2289 * used instead.
2291 $wgMetaNamespace = false;
2294 * Name of the project talk namespace.
2296 * Normally you can ignore this and it will be something like
2297 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
2298 * manually for grammatical reasons.
2300 $wgMetaNamespaceTalk = false;
2303 * Additional namespaces. If the namespaces defined in Language.php and
2304 * Namespace.php are insufficient, you can create new ones here, for example,
2305 * to import Help files in other languages. You can also override the namespace
2306 * names of existing namespaces. Extensions developers should use
2307 * $wgCanonicalNamespaceNames.
2309 * PLEASE NOTE: Once you delete a namespace, the pages in that namespace will
2310 * no longer be accessible. If you rename it, then you can access them through
2311 * the new namespace name.
2313 * Custom namespaces should start at 100 to avoid conflicting with standard
2314 * namespaces, and should always follow the even/odd main/talk pattern.
2316 #$wgExtraNamespaces =
2317 # array(100 => "Hilfe",
2318 # 101 => "Hilfe_Diskussion",
2319 # 102 => "Aide",
2320 # 103 => "Discussion_Aide"
2321 # );
2322 $wgExtraNamespaces = array();
2325 * Namespace aliases
2326 * These are alternate names for the primary localised namespace names, which
2327 * are defined by $wgExtraNamespaces and the language file. If a page is
2328 * requested with such a prefix, the request will be redirected to the primary
2329 * name.
2331 * Set this to a map from namespace names to IDs.
2332 * Example:
2333 * $wgNamespaceAliases = array(
2334 * 'Wikipedian' => NS_USER,
2335 * 'Help' => 100,
2336 * );
2338 $wgNamespaceAliases = array();
2341 * Allowed title characters -- regex character class
2342 * Don't change this unless you know what you're doing
2344 * Problematic punctuation:
2345 * - []{}|# Are needed for link syntax, never enable these
2346 * - <> Causes problems with HTML escaping, don't use
2347 * - % Enabled by default, minor problems with path to query rewrite rules, see below
2348 * - + Enabled by default, but doesn't work with path to query rewrite rules, corrupted by apache
2349 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
2351 * All three of these punctuation problems can be avoided by using an alias, instead of a
2352 * rewrite rule of either variety.
2354 * The problem with % is that when using a path to query rewrite rule, URLs are
2355 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
2356 * %253F, for example, becomes "?". Our code does not double-escape to compensate
2357 * for this, indeed double escaping would break if the double-escaped title was
2358 * passed in the query string rather than the path. This is a minor security issue
2359 * because articles can be created such that they are hard to view or edit.
2361 * In some rare cases you may wish to remove + for compatibility with old links.
2363 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
2364 * this breaks interlanguage links
2366 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
2368 $wgLocalInterwiki = 'w';
2369 $wgInterwikiExpiry = 10800; # Expiry time for cache of interwiki table
2371 /** Interwiki caching settings.
2372 $wgInterwikiCache specifies path to constant database file
2373 This cdb database is generated by dumpInterwiki from maintenance
2374 and has such key formats:
2375 dbname:key - a simple key (e.g. enwiki:meta)
2376 _sitename:key - site-scope key (e.g. wiktionary:meta)
2377 __global:key - global-scope key (e.g. __global:meta)
2378 __sites:dbname - site mapping (e.g. __sites:enwiki)
2379 Sites mapping just specifies site name, other keys provide
2380 "local url" data layout.
2381 $wgInterwikiScopes specify number of domains to check for messages:
2382 1 - Just wiki(db)-level
2383 2 - wiki and global levels
2384 3 - site levels
2385 $wgInterwikiFallbackSite - if unable to resolve from cache
2387 $wgInterwikiCache = false;
2388 $wgInterwikiScopes = 3;
2389 $wgInterwikiFallbackSite = 'wiki';
2392 * If local interwikis are set up which allow redirects,
2393 * set this regexp to restrict URLs which will be displayed
2394 * as 'redirected from' links.
2396 * It might look something like this:
2397 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
2399 * Leave at false to avoid displaying any incoming redirect markers.
2400 * This does not affect intra-wiki redirects, which don't change
2401 * the URL.
2403 $wgRedirectSources = false;
2406 * Set this to false to avoid forcing the first letter of links to capitals.
2407 * WARNING: may break links! This makes links COMPLETELY case-sensitive. Links
2408 * appearing with a capital at the beginning of a sentence will *not* go to the
2409 * same place as links in the middle of a sentence using a lowercase initial.
2411 $wgCapitalLinks = true;
2414 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
2415 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
2416 * true by default (and setting them has no effect), due to various things that
2417 * require them to be so. Also, since Talk namespaces need to directly mirror their
2418 * associated content namespaces, the values for those are ignored in favor of the
2419 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
2420 * NS_FILE.
2421 * EX: $wgCapitalLinkOverrides[ NS_FILE ] = false;
2423 $wgCapitalLinkOverrides = array();
2425 /** Which namespaces should support subpages?
2426 * See Language.php for a list of namespaces.
2428 $wgNamespacesWithSubpages = array(
2429 NS_TALK => true,
2430 NS_USER => true,
2431 NS_USER_TALK => true,
2432 NS_PROJECT_TALK => true,
2433 NS_FILE_TALK => true,
2434 NS_MEDIAWIKI => true,
2435 NS_MEDIAWIKI_TALK => true,
2436 NS_TEMPLATE_TALK => true,
2437 NS_HELP_TALK => true,
2438 NS_CATEGORY_TALK => true
2442 * Array of namespaces which can be deemed to contain valid "content", as far
2443 * as the site statistics are concerned. Useful if additional namespaces also
2444 * contain "content" which should be considered when generating a count of the
2445 * number of articles in the wiki.
2447 $wgContentNamespaces = array( NS_MAIN );
2450 * Max number of redirects to follow when resolving redirects.
2451 * 1 means only the first redirect is followed (default behavior).
2452 * 0 or less means no redirects are followed.
2454 $wgMaxRedirects = 1;
2457 * Array of invalid page redirect targets.
2458 * Attempting to create a redirect to any of the pages in this array
2459 * will make the redirect fail.
2460 * Userlogout is hard-coded, so it does not need to be listed here.
2461 * (bug 10569) Disallow Mypage and Mytalk as well.
2463 * As of now, this only checks special pages. Redirects to pages in
2464 * other namespaces cannot be invalidated by this variable.
2466 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk' );
2468 /** @} */ # End of title and interwiki settings }
2470 /************************************************************************//**
2471 * @name Parser settings
2472 * These settings configure the transformation from wikitext to HTML.
2473 * @{
2477 * Parser configuration. Associative array with the following members:
2479 * class The class name
2481 * preprocessorClass The preprocessor class. Two classes are currently available:
2482 * Preprocessor_Hash, which uses plain PHP arrays for tempoarary
2483 * storage, and Preprocessor_DOM, which uses the DOM module for
2484 * temporary storage. Preprocessor_DOM generally uses less memory;
2485 * the speed of the two is roughly the same.
2487 * If this parameter is not given, it uses Preprocessor_DOM if the
2488 * DOM module is available, otherwise it uses Preprocessor_Hash.
2490 * The entire associative array will be passed through to the constructor as
2491 * the first parameter. Note that only Setup.php can use this variable --
2492 * the configuration will change at runtime via $wgParser member functions, so
2493 * the contents of this variable will be out-of-date. The variable can only be
2494 * changed during LocalSettings.php, in particular, it can't be changed during
2495 * an extension setup function.
2497 $wgParserConf = array(
2498 'class' => 'Parser',
2499 #'preprocessorClass' => 'Preprocessor_Hash',
2502 /** Maximum indent level of toc. */
2503 $wgMaxTocLevel = 999;
2506 * A complexity limit on template expansion
2508 $wgMaxPPNodeCount = 1000000;
2511 * Maximum recursion depth for templates within templates.
2512 * The current parser adds two levels to the PHP call stack for each template,
2513 * and xdebug limits the call stack to 100 by default. So this should hopefully
2514 * stop the parser before it hits the xdebug limit.
2516 $wgMaxTemplateDepth = 40;
2518 /** @see $wgMaxTemplateDepth */
2519 $wgMaxPPExpandDepth = 40;
2521 /** The external URL protocols */
2522 $wgUrlProtocols = array(
2523 'http://',
2524 'https://',
2525 'ftp://',
2526 'irc://',
2527 'gopher://',
2528 'telnet://', // Well if we're going to support the above.. -ævar
2529 'nntp://', // @bug 3808 RFC 1738
2530 'worldwind://',
2531 'mailto:',
2532 'news:',
2533 'svn://',
2534 'git://',
2535 'mms://',
2539 * If true, removes (substitutes) templates in "~~~~" signatures.
2541 $wgCleanSignatures = true;
2543 /** Whether to allow inline image pointing to other websites */
2544 $wgAllowExternalImages = false;
2546 /**
2547 * If the above is false, you can specify an exception here. Image URLs
2548 * that start with this string are then rendered, while all others are not.
2549 * You can use this to set up a trusted, simple repository of images.
2550 * You may also specify an array of strings to allow multiple sites
2552 * Examples:
2553 * <code>
2554 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
2555 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
2556 * </code>
2558 $wgAllowExternalImagesFrom = '';
2560 /** If $wgAllowExternalImages is false, you can allow an on-wiki
2561 * whitelist of regular expression fragments to match the image URL
2562 * against. If the image matches one of the regular expression fragments,
2563 * The image will be displayed.
2565 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
2566 * Or false to disable it
2568 $wgEnableImageWhitelist = true;
2571 * A different approach to the above: simply allow the <img> tag to be used.
2572 * This allows you to specify alt text and other attributes, copy-paste HTML to
2573 * your wiki more easily, etc. However, allowing external images in any manner
2574 * will allow anyone with editing rights to snoop on your visitors' IP
2575 * addresses and so forth, if they wanted to, by inserting links to images on
2576 * sites they control.
2578 $wgAllowImageTag = false;
2581 * $wgUseTidy: use tidy to make sure HTML output is sane.
2582 * Tidy is a free tool that fixes broken HTML.
2583 * See http://www.w3.org/People/Raggett/tidy/
2585 * - $wgTidyBin should be set to the path of the binary and
2586 * - $wgTidyConf to the path of the configuration file.
2587 * - $wgTidyOpts can include any number of parameters.
2588 * - $wgTidyInternal controls the use of the PECL extension to use an in-
2589 * process tidy library instead of spawning a separate program.
2590 * Normally you shouldn't need to override the setting except for
2591 * debugging. To install, use 'pear install tidy' and add a line
2592 * 'extension=tidy.so' to php.ini.
2594 $wgUseTidy = false;
2595 /** @see $wgUseTidy */
2596 $wgAlwaysUseTidy = false;
2597 /** @see $wgUseTidy */
2598 $wgTidyBin = 'tidy';
2599 /** @see $wgUseTidy */
2600 $wgTidyConf = $IP.'/includes/tidy.conf';
2601 /** @see $wgUseTidy */
2602 $wgTidyOpts = '';
2603 /** @see $wgUseTidy */
2604 $wgTidyInternal = extension_loaded( 'tidy' );
2607 * Put tidy warnings in HTML comments
2608 * Only works for internal tidy.
2610 $wgDebugTidy = false;
2612 /** Allow raw, unchecked HTML in <html>...</html> sections.
2613 * THIS IS VERY DANGEROUS on a publically editable site, so USE wgGroupPermissions
2614 * TO RESTRICT EDITING to only those that you trust
2616 $wgRawHtml = false;
2619 * Set a default target for external links, e.g. _blank to pop up a new window
2621 $wgExternalLinkTarget = false;
2624 * If true, external URL links in wiki text will be given the
2625 * rel="nofollow" attribute as a hint to search engines that
2626 * they should not be followed for ranking purposes as they
2627 * are user-supplied and thus subject to spamming.
2629 $wgNoFollowLinks = true;
2632 * Namespaces in which $wgNoFollowLinks doesn't apply.
2633 * See Language.php for a list of namespaces.
2635 $wgNoFollowNsExceptions = array();
2638 * If this is set to an array of domains, external links to these domain names
2639 * (or any subdomains) will not be set to rel="nofollow" regardless of the
2640 * value of $wgNoFollowLinks. For instance:
2642 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org' );
2644 * This would add rel="nofollow" to links to de.wikipedia.org, but not
2645 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
2646 * etc.
2648 $wgNoFollowDomainExceptions = array();
2651 * Allow DISPLAYTITLE to change title display
2653 $wgAllowDisplayTitle = true;
2656 * For consistency, restrict DISPLAYTITLE to titles that normalize to the same
2657 * canonical DB key.
2659 $wgRestrictDisplayTitle = true;
2662 * Maximum number of calls per parse to expensive parser functions such as
2663 * PAGESINCATEGORY.
2665 $wgExpensiveParserFunctionLimit = 100;
2668 * Preprocessor caching threshold
2670 $wgPreprocessorCacheThreshold = 1000;
2673 * Enable interwiki transcluding. Only when iw_trans=1.
2675 $wgEnableScaryTranscluding = false;
2678 * Expiry time for interwiki transclusion
2680 $wgTranscludeCacheExpiry = 3600;
2682 /** @} */ # end of parser settings }
2684 /************************************************************************//**
2685 * @name Statistics
2686 * @{
2690 * Under which condition should a page in the main namespace be counted
2691 * as a valid article? If $wgUseCommaCount is set to true, it will be
2692 * counted if it contains at least one comma. If it is set to false
2693 * (default), it will only be counted if it contains at least one [[wiki
2694 * link]]. See http://www.mediawiki.org/wiki/Manual:Article_count
2696 * Retroactively changing this variable will not affect
2697 * the existing count (cf. maintenance/recount.sql).
2699 $wgUseCommaCount = false;
2702 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
2703 * values are easier on the database. A value of 1 causes the counters to be
2704 * updated on every hit, any higher value n cause them to update *on average*
2705 * every n hits. Should be set to either 1 or something largish, eg 1000, for
2706 * maximum efficiency.
2708 $wgHitcounterUpdateFreq = 1;
2711 * How many days user must be idle before he is considered inactive. Will affect
2712 * the number shown on Special:Statistics and Special:ActiveUsers special page.
2713 * You might want to leave this as the default value, to provide comparable
2714 * numbers between different wikis.
2716 $wgActiveUserDays = 30;
2718 /** @} */ # End of statistics }
2720 /************************************************************************//**
2721 * @name User accounts, authentication
2722 * @{
2725 /** For compatibility with old installations set to false */
2726 $wgPasswordSalt = true;
2729 * Specifies the minimal length of a user password. If set to 0, empty pass-
2730 * words are allowed.
2732 $wgMinimalPasswordLength = 1;
2735 * Maximum number of Unicode characters in signature
2737 $wgMaxSigChars = 255;
2740 * Maximum number of bytes in username. You want to run the maintenance
2741 * script ./maintenance/checkUsernames.php once you have changed this value.
2743 $wgMaxNameChars = 255;
2746 * Array of usernames which may not be registered or logged in from
2747 * Maintenance scripts can still use these
2749 $wgReservedUsernames = array(
2750 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
2751 'Conversion script', // Used for the old Wikipedia software upgrade
2752 'Maintenance script', // Maintenance scripts which perform editing, image import script
2753 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
2754 'msg:double-redirect-fixer', // Automatic double redirect fix
2755 'msg:usermessage-editor', // Default user for leaving user messages
2756 'msg:proxyblocker', // For Special:Blockme
2760 * Settings added to this array will override the default globals for the user
2761 * preferences used by anonymous visitors and newly created accounts.
2762 * For instance, to disable section editing links:
2763 * $wgDefaultUserOptions ['editsection'] = 0;
2766 $wgDefaultUserOptions = array(
2767 'ccmeonemails' => 0,
2768 'cols' => 80,
2769 'contextchars' => 50,
2770 'contextlines' => 5,
2771 'date' => 'default',
2772 'diffonly' => 0,
2773 'disablemail' => 0,
2774 'disablesuggest' => 0,
2775 'editfont' => 'default',
2776 'editondblclick' => 0,
2777 'editsection' => 1,
2778 'editsectiononrightclick' => 0,
2779 'enotifminoredits' => 0,
2780 'enotifrevealaddr' => 0,
2781 'enotifusertalkpages' => 1,
2782 'enotifwatchlistpages' => 0,
2783 'extendwatchlist' => 0,
2784 'externaldiff' => 0,
2785 'externaleditor' => 0,
2786 'fancysig' => 0,
2787 'forceeditsummary' => 0,
2788 'gender' => 'unknown',
2789 'hideminor' => 0,
2790 'hidepatrolled' => 0,
2791 'highlightbroken' => 1,
2792 'imagesize' => 2,
2793 'justify' => 0,
2794 'math' => 1,
2795 'newpageshidepatrolled' => 0,
2796 'nocache' => 0,
2797 'noconvertlink' => 0,
2798 'norollbackdiff' => 0,
2799 'numberheadings' => 0,
2800 'previewonfirst' => 0,
2801 'previewontop' => 1,
2802 'quickbar' => 1,
2803 'rcdays' => 7,
2804 'rclimit' => 50,
2805 'rememberpassword' => 0,
2806 'rows' => 25,
2807 'searchlimit' => 20,
2808 'showhiddencats' => 0,
2809 'showjumplinks' => 1,
2810 'shownumberswatching' => 1,
2811 'showtoc' => 1,
2812 'showtoolbar' => 1,
2813 'skin' => false,
2814 'stubthreshold' => 0,
2815 'thumbsize' => 2,
2816 'underline' => 2,
2817 'uselivepreview' => 0,
2818 'usenewrc' => 0,
2819 'watchcreations' => 0,
2820 'watchdefault' => 0,
2821 'watchdeletion' => 0,
2822 'watchlistdays' => 3.0,
2823 'watchlisthideanons' => 0,
2824 'watchlisthidebots' => 0,
2825 'watchlisthideliu' => 0,
2826 'watchlisthideminor' => 0,
2827 'watchlisthideown' => 0,
2828 'watchlisthidepatrolled' => 0,
2829 'watchmoves' => 0,
2830 'wllimit' => 250,
2834 * Whether or not to allow and use real name fields.
2835 * @deprecated in 1.16, use $wgHiddenPrefs[] = 'realname' below to disable real
2836 * names
2838 $wgAllowRealName = true;
2840 /** An array of preferences to not show for the user */
2841 $wgHiddenPrefs = array();
2844 * Characters to prevent during new account creations.
2845 * This is used in a regular expression character class during
2846 * registration (regex metacharacters like / are escaped).
2848 $wgInvalidUsernameCharacters = '@';
2851 * Character used as a delimiter when testing for interwiki userrights
2852 * (In Special:UserRights, it is possible to modify users on different
2853 * databases if the delimiter is used, e.g. Someuser@enwiki).
2855 * It is recommended that you have this delimiter in
2856 * $wgInvalidUsernameCharacters above, or you will not be able to
2857 * modify the user rights of those users via Special:UserRights
2859 $wgUserrightsInterwikiDelimiter = '@';
2862 * Use some particular type of external authentication. The specific
2863 * authentication module you use will normally require some extra settings to
2864 * be specified.
2866 * null indicates no external authentication is to be used. Otherwise,
2867 * $wgExternalAuthType must be the name of a non-abstract class that extends
2868 * ExternalUser.
2870 * Core authentication modules can be found in includes/extauth/.
2872 $wgExternalAuthType = null;
2875 * Configuration for the external authentication. This may include arbitrary
2876 * keys that depend on the authentication mechanism. For instance,
2877 * authentication against another web app might require that the database login
2878 * info be provided. Check the file where your auth mechanism is defined for
2879 * info on what to put here.
2881 $wgExternalAuthConf = array();
2884 * When should we automatically create local accounts when external accounts
2885 * already exist, if using ExternalAuth? Can have three values: 'never',
2886 * 'login', 'view'. 'view' requires the external database to support cookies,
2887 * and implies 'login'.
2889 * TODO: Implement 'view' (currently behaves like 'login').
2891 $wgAutocreatePolicy = 'login';
2894 * Policies for how each preference is allowed to be changed, in the presence
2895 * of external authentication. The keys are preference keys, e.g., 'password'
2896 * or 'emailaddress' (see Preferences.php et al.). The value can be one of the
2897 * following:
2899 * - local: Allow changes to this pref through the wiki interface but only
2900 * apply them locally (default).
2901 * - semiglobal: Allow changes through the wiki interface and try to apply them
2902 * to the foreign database, but continue on anyway if that fails.
2903 * - global: Allow changes through the wiki interface, but only let them go
2904 * through if they successfully update the foreign database.
2905 * - message: Allow no local changes for linked accounts; replace the change
2906 * form with a message provided by the auth plugin, telling the user how to
2907 * change the setting externally (maybe providing a link, etc.). If the auth
2908 * plugin provides no message for this preference, hide it entirely.
2910 * Accounts that are not linked to an external account are never affected by
2911 * this setting. You may want to look at $wgHiddenPrefs instead.
2912 * $wgHiddenPrefs supersedes this option.
2914 * TODO: Implement message, global.
2916 $wgAllowPrefChange = array();
2918 /** @} */ # end user accounts }
2920 /************************************************************************//**
2921 * @name User rights, access control and monitoring
2922 * @{
2925 /** Allow sysops to ban logged-in users */
2926 $wgSysopUserBans = true;
2928 /** Allow sysops to ban IP ranges */
2929 $wgSysopRangeBans = true;
2931 /**
2932 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
2934 $wgAutoblockExpiry = 86400;
2936 /**
2937 * Set this to true to allow blocked users to edit their own user talk page.
2939 $wgBlockAllowsUTEdit = false;
2941 /** Allow sysops to ban users from accessing Emailuser */
2942 $wgSysopEmailBans = true;
2945 * Limits on the possible sizes of range blocks.
2947 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
2948 * /1 is a small range and a /31 is a large range. Setting this to half the
2949 * number of bits avoids such errors.
2951 $wgBlockCIDRLimit = array(
2952 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
2953 'IPv6' => 64, # 2^64 = ~1.8x10^19 addresses
2957 * If true, blocked users will not be allowed to login. When using this with
2958 * a public wiki, the effect of logging out blocked users may actually be
2959 * avers: unless the user's address is also blocked (e.g. auto-block),
2960 * logging the user out will again allow reading and editing, just as for
2961 * anonymous visitors.
2963 $wgBlockDisablesLogin = false;
2966 * Pages anonymous user may see as an array, e.g.
2968 * <code>
2969 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
2970 * </code>
2972 * Special:Userlogin and Special:Resetpass are always whitelisted.
2974 * NOTE: This will only work if $wgGroupPermissions['*']['read'] is false --
2975 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
2977 * Also note that this will only protect _pages in the wiki_. Uploaded files
2978 * will remain readable. You can use img_auth.php to protect uploaded files,
2979 * see http://www.mediawiki.org/wiki/Manual:Image_Authorization
2981 $wgWhitelistRead = false;
2984 * Should editors be required to have a validated e-mail
2985 * address before being allowed to edit?
2987 $wgEmailConfirmToEdit = false;
2990 * Permission keys given to users in each group.
2991 * All users are implicitly in the '*' group including anonymous visitors;
2992 * logged-in users are all implicitly in the 'user' group. These will be
2993 * combined with the permissions of all groups that a given user is listed
2994 * in in the user_groups table.
2996 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
2997 * doing! This will wipe all permissions, and may mean that your users are
2998 * unable to perform certain essential tasks or access new functionality
2999 * when new permissions are introduced and default grants established.
3001 * Functionality to make pages inaccessible has not been extensively tested
3002 * for security. Use at your own risk!
3004 * This replaces wgWhitelistAccount and wgWhitelistEdit
3006 $wgGroupPermissions = array();
3008 /** @cond file_level_code */
3009 // Implicit group for all visitors
3010 $wgGroupPermissions['*']['createaccount'] = true;
3011 $wgGroupPermissions['*']['read'] = true;
3012 $wgGroupPermissions['*']['edit'] = true;
3013 $wgGroupPermissions['*']['createpage'] = true;
3014 $wgGroupPermissions['*']['createtalk'] = true;
3015 $wgGroupPermissions['*']['writeapi'] = true;
3016 //$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
3018 // Implicit group for all logged-in accounts
3019 $wgGroupPermissions['user']['move'] = true;
3020 $wgGroupPermissions['user']['move-subpages'] = true;
3021 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
3022 //$wgGroupPermissions['user']['movefile'] = true; // Disabled for now due to possible bugs and security concerns
3023 $wgGroupPermissions['user']['read'] = true;
3024 $wgGroupPermissions['user']['edit'] = true;
3025 $wgGroupPermissions['user']['createpage'] = true;
3026 $wgGroupPermissions['user']['createtalk'] = true;
3027 $wgGroupPermissions['user']['writeapi'] = true;
3028 $wgGroupPermissions['user']['upload'] = true;
3029 $wgGroupPermissions['user']['reupload'] = true;
3030 $wgGroupPermissions['user']['reupload-shared'] = true;
3031 $wgGroupPermissions['user']['minoredit'] = true;
3032 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
3033 $wgGroupPermissions['user']['sendemail'] = true;
3035 // Implicit group for accounts that pass $wgAutoConfirmAge
3036 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
3038 // Users with bot privilege can have their edits hidden
3039 // from various log pages by default
3040 $wgGroupPermissions['bot']['bot'] = true;
3041 $wgGroupPermissions['bot']['autoconfirmed'] = true;
3042 $wgGroupPermissions['bot']['nominornewtalk'] = true;
3043 $wgGroupPermissions['bot']['autopatrol'] = true;
3044 $wgGroupPermissions['bot']['suppressredirect'] = true;
3045 $wgGroupPermissions['bot']['apihighlimits'] = true;
3046 $wgGroupPermissions['bot']['writeapi'] = true;
3047 #$wgGroupPermissions['bot']['editprotected'] = true; // can edit all protected pages without cascade protection enabled
3049 // Most extra permission abilities go to this group
3050 $wgGroupPermissions['sysop']['block'] = true;
3051 $wgGroupPermissions['sysop']['createaccount'] = true;
3052 $wgGroupPermissions['sysop']['delete'] = true;
3053 $wgGroupPermissions['sysop']['bigdelete'] = true; // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
3054 $wgGroupPermissions['sysop']['deletedhistory'] = true; // can view deleted history entries, but not see or restore the text
3055 $wgGroupPermissions['sysop']['deletedtext'] = true; // can view deleted revision text
3056 $wgGroupPermissions['sysop']['undelete'] = true;
3057 $wgGroupPermissions['sysop']['editinterface'] = true;
3058 $wgGroupPermissions['sysop']['editusercss'] = true;
3059 $wgGroupPermissions['sysop']['edituserjs'] = true;
3060 $wgGroupPermissions['sysop']['import'] = true;
3061 $wgGroupPermissions['sysop']['importupload'] = true;
3062 $wgGroupPermissions['sysop']['move'] = true;
3063 $wgGroupPermissions['sysop']['move-subpages'] = true;
3064 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
3065 $wgGroupPermissions['sysop']['patrol'] = true;
3066 $wgGroupPermissions['sysop']['autopatrol'] = true;
3067 $wgGroupPermissions['sysop']['protect'] = true;
3068 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
3069 $wgGroupPermissions['sysop']['rollback'] = true;
3070 $wgGroupPermissions['sysop']['trackback'] = true;
3071 $wgGroupPermissions['sysop']['upload'] = true;
3072 $wgGroupPermissions['sysop']['reupload'] = true;
3073 $wgGroupPermissions['sysop']['reupload-shared'] = true;
3074 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
3075 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
3076 $wgGroupPermissions['sysop']['upload_by_url'] = true;
3077 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
3078 $wgGroupPermissions['sysop']['blockemail'] = true;
3079 $wgGroupPermissions['sysop']['markbotedits'] = true;
3080 $wgGroupPermissions['sysop']['apihighlimits'] = true;
3081 $wgGroupPermissions['sysop']['browsearchive'] = true;
3082 $wgGroupPermissions['sysop']['noratelimit'] = true;
3083 $wgGroupPermissions['sysop']['movefile'] = true;
3084 $wgGroupPermissions['sysop']['unblockself'] = true;
3085 #$wgGroupPermissions['sysop']['mergehistory'] = true;
3087 // Permission to change users' group assignments
3088 $wgGroupPermissions['bureaucrat']['userrights'] = true;
3089 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
3090 // Permission to change users' groups assignments across wikis
3091 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
3092 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
3093 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
3095 #$wgGroupPermissions['sysop']['deleterevision'] = true;
3096 // To hide usernames from users and Sysops
3097 #$wgGroupPermissions['suppress']['hideuser'] = true;
3098 // To hide revisions/log items from users and Sysops
3099 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
3100 // For private suppression log access
3101 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
3104 * The developer group is deprecated, but can be activated if need be
3105 * to use the 'lockdb' and 'unlockdb' special pages. Those require
3106 * that a lock file be defined and creatable/removable by the web
3107 * server.
3109 # $wgGroupPermissions['developer']['siteadmin'] = true;
3111 /** @endcond */
3114 * Permission keys revoked from users in each group.
3115 * This acts the same way as wgGroupPermissions above, except that
3116 * if the user is in a group here, the permission will be removed from them.
3118 * Improperly setting this could mean that your users will be unable to perform
3119 * certain essential tasks, so use at your own risk!
3121 $wgRevokePermissions = array();
3124 * Implicit groups, aren't shown on Special:Listusers or somewhere else
3126 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
3129 * A map of group names that the user is in, to group names that those users
3130 * are allowed to add or revoke.
3132 * Setting the list of groups to add or revoke to true is equivalent to "any group".
3134 * For example, to allow sysops to add themselves to the "bot" group:
3136 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
3138 * Implicit groups may be used for the source group, for instance:
3140 * $wgGroupsRemoveFromSelf = array( '*' => true );
3142 * This allows users in the '*' group (i.e. any user) to remove themselves from
3143 * any group that they happen to be in.
3146 $wgGroupsAddToSelf = array();
3148 /** @see $wgGroupsAddToSelf */
3149 $wgGroupsRemoveFromSelf = array();
3152 * Set of available actions that can be restricted via action=protect
3153 * You probably shouldn't change this.
3154 * Translated through restriction-* messages.
3156 $wgRestrictionTypes = array( 'edit', 'move' );
3159 * Rights which can be required for each protection level (via action=protect)
3161 * You can add a new protection level that requires a specific
3162 * permission by manipulating this array. The ordering of elements
3163 * dictates the order on the protection form's lists.
3165 * - '' will be ignored (i.e. unprotected)
3166 * - 'sysop' is quietly rewritten to 'protect' for backwards compatibility
3168 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
3171 * Set the minimum permissions required to edit pages in each
3172 * namespace. If you list more than one permission, a user must
3173 * have all of them to edit pages in that namespace.
3175 * Note: NS_MEDIAWIKI is implicitly restricted to editinterface.
3177 $wgNamespaceProtection = array();
3180 * Pages in namespaces in this array can not be used as templates.
3181 * Elements must be numeric namespace ids.
3182 * Among other things, this may be useful to enforce read-restrictions
3183 * which may otherwise be bypassed by using the template machanism.
3185 $wgNonincludableNamespaces = array();
3188 * Number of seconds an account is required to age before it's given the
3189 * implicit 'autoconfirm' group membership. This can be used to limit
3190 * privileges of new accounts.
3192 * Accounts created by earlier versions of the software may not have a
3193 * recorded creation date, and will always be considered to pass the age test.
3195 * When left at 0, all registered accounts will pass.
3197 * Example:
3198 * <code>
3199 * $wgAutoConfirmAge = 600; // ten minutes
3200 * $wgAutoConfirmAge = 3600*24; // one day
3201 * </code>
3203 $wgAutoConfirmAge = 0;
3206 * Number of edits an account requires before it is autoconfirmed.
3207 * Passing both this AND the time requirement is needed. Example:
3209 * <code>
3210 * $wgAutoConfirmCount = 50;
3211 * </code>
3213 $wgAutoConfirmCount = 0;
3216 * Automatically add a usergroup to any user who matches certain conditions.
3217 * The format is
3218 * array( '&' or '|' or '^', cond1, cond2, ... )
3219 * where cond1, cond2, ... are themselves conditions; *OR*
3220 * APCOND_EMAILCONFIRMED, *OR*
3221 * array( APCOND_EMAILCONFIRMED ), *OR*
3222 * array( APCOND_EDITCOUNT, number of edits ), *OR*
3223 * array( APCOND_AGE, seconds since registration ), *OR*
3224 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
3225 * array( APCOND_ISIP, ip ), *OR*
3226 * array( APCOND_IPINRANGE, range ), *OR*
3227 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
3228 * array( APCOND_BLOCKED ), *OR*
3229 * similar constructs defined by extensions.
3231 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
3232 * user who has provided an e-mail address.
3234 $wgAutopromote = array(
3235 'autoconfirmed' => array( '&',
3236 array( APCOND_EDITCOUNT, &$wgAutoConfirmCount ),
3237 array( APCOND_AGE, &$wgAutoConfirmAge ),
3242 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
3243 * can assign which groups at Special:Userrights. Example configuration:
3245 * @code
3246 * // Bureaucrat can add any group
3247 * $wgAddGroups['bureaucrat'] = true;
3248 * // Bureaucrats can only remove bots and sysops
3249 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
3250 * // Sysops can make bots
3251 * $wgAddGroups['sysop'] = array( 'bot' );
3252 * // Sysops can disable other sysops in an emergency, and disable bots
3253 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
3254 * @endcode
3256 $wgAddGroups = array();
3257 /** @see $wgAddGroups */
3258 $wgRemoveGroups = array();
3261 * A list of available rights, in addition to the ones defined by the core.
3262 * For extensions only.
3264 $wgAvailableRights = array();
3267 * Optional to restrict deletion of pages with higher revision counts
3268 * to users with the 'bigdelete' permission. (Default given to sysops.)
3270 $wgDeleteRevisionsLimit = 0;
3272 /** Number of accounts each IP address may create, 0 to disable.
3273 * Requires memcached */
3274 $wgAccountCreationThrottle = 0;
3277 * Edits matching these regular expressions in body text
3278 * will be recognised as spam and rejected automatically.
3280 * There's no administrator override on-wiki, so be careful what you set. :)
3281 * May be an array of regexes or a single string for backwards compatibility.
3283 * See http://en.wikipedia.org/wiki/Regular_expression
3284 * Note that each regex needs a beginning/end delimiter, eg: # or /
3286 $wgSpamRegex = array();
3288 /** Same as the above except for edit summaries */
3289 $wgSummarySpamRegex = array();
3291 /**
3292 * Similarly you can get a function to do the job. The function will be given
3293 * the following args:
3294 * - a Title object for the article the edit is made on
3295 * - the text submitted in the textarea (wpTextbox1)
3296 * - the section number.
3297 * The return should be boolean indicating whether the edit matched some evilness:
3298 * - true : block it
3299 * - false : let it through
3301 * @deprecated Use hooks. See SpamBlacklist extension.
3303 $wgFilterCallback = false;
3306 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies
3307 * @since 1.16
3309 $wgEnableDnsBlacklist = false;
3312 * @deprecated Use $wgEnableDnsBlacklist instead, only kept for backward
3313 * compatibility
3315 $wgEnableSorbs = false;
3318 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true
3319 * @since 1.16
3321 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
3324 * @deprecated Use $wgDnsBlacklistUrls instead, only kept for backward
3325 * compatibility
3327 $wgSorbsUrl = array();
3330 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
3331 * what the other methods might say.
3333 $wgProxyWhitelist = array();
3336 * Simple rate limiter options to brake edit floods. Maximum number actions
3337 * allowed in the given number of seconds; after that the violating client re-
3338 * ceives HTTP 500 error pages until the period elapses.
3340 * array( 4, 60 ) for a maximum of 4 hits in 60 seconds.
3342 * This option set is experimental and likely to change. Requires memcached.
3344 $wgRateLimits = array(
3345 'edit' => array(
3346 'anon' => null, // for any and all anonymous edits (aggregate)
3347 'user' => null, // for each logged-in user
3348 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
3349 'ip' => null, // for each anon and recent account
3350 'subnet' => null, // ... with final octet removed
3352 'move' => array(
3353 'user' => null,
3354 'newbie' => null,
3355 'ip' => null,
3356 'subnet' => null,
3358 'mailpassword' => array(
3359 'anon' => null,
3361 'emailuser' => array(
3362 'user' => null,
3367 * Set to a filename to log rate limiter hits.
3369 $wgRateLimitLog = null;
3372 * Array of groups which should never trigger the rate limiter
3374 * @deprecated as of 1.13.0, the preferred method is using
3375 * $wgGroupPermissions[]['noratelimit']. However, this will still
3376 * work if desired.
3378 * $wgRateLimitsExcludedGroups = array( 'sysop', 'bureaucrat' );
3380 $wgRateLimitsExcludedGroups = array();
3383 * Array of IPs which should be excluded from rate limits.
3384 * This may be useful for whitelisting NAT gateways for conferences, etc.
3386 $wgRateLimitsExcludedIPs = array();
3388 /**
3389 * Log IP addresses in the recentchanges table; can be accessed only by
3390 * extensions (e.g. CheckUser) or a DB admin
3392 $wgPutIPinRC = true;
3395 * Limit password attempts to X attempts per Y seconds per IP per account.
3396 * Requires memcached.
3398 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
3400 /** @} */ # end of user rights settings
3402 /************************************************************************//**
3403 * @name Proxy scanner settings
3404 * @{
3408 * If you enable this, every editor's IP address will be scanned for open HTTP
3409 * proxies.
3411 * Don't enable this. Many sysops will report "hostile TCP port scans" to your
3412 * ISP and ask for your server to be shut down.
3414 * You have been warned.
3416 $wgBlockOpenProxies = false;
3417 /** Port we want to scan for a proxy */
3418 $wgProxyPorts = array( 80, 81, 1080, 3128, 6588, 8000, 8080, 8888, 65506 );
3419 /** Script used to scan */
3420 $wgProxyScriptPath = "$IP/includes/proxy_check.php";
3421 /** */
3422 $wgProxyMemcExpiry = 86400;
3423 /** This should always be customised in LocalSettings.php */
3424 $wgSecretKey = false;
3425 /** big list of banned IP addresses, in the keys not the values */
3426 $wgProxyList = array();
3427 /** deprecated */
3428 $wgProxyKey = false;
3430 /** @} */ # end of proxy scanner settings
3432 /************************************************************************//**
3433 * @name Cookie settings
3434 * @{
3438 * Default cookie expiration time. Setting to 0 makes all cookies session-only.
3440 $wgCookieExpiration = 30*86400;
3443 * Set to set an explicit domain on the login cookies eg, "justthis.domain. org"
3444 * or ".any.subdomain.net"
3446 $wgCookieDomain = '';
3447 $wgCookiePath = '/';
3448 $wgCookieSecure = ($wgProto == 'https');
3449 $wgDisableCookieCheck = false;
3452 * Set $wgCookiePrefix to use a custom one. Setting to false sets the default of
3453 * using the database name.
3455 $wgCookiePrefix = false;
3458 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
3459 * in browsers that support this feature. This can mitigates some classes of
3460 * XSS attack.
3462 * Only supported on PHP 5.2 or higher.
3464 $wgCookieHttpOnly = version_compare("5.2", PHP_VERSION, "<");
3467 * If the requesting browser matches a regex in this blacklist, we won't
3468 * send it cookies with HttpOnly mode, even if $wgCookieHttpOnly is on.
3470 $wgHttpOnlyBlacklist = array(
3471 // Internet Explorer for Mac; sometimes the cookies work, sometimes
3472 // they don't. It's difficult to predict, as combinations of path
3473 // and expiration options affect its parsing.
3474 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
3477 /** A list of cookies that vary the cache (for use by extensions) */
3478 $wgCacheVaryCookies = array();
3480 /** Override to customise the session name */
3481 $wgSessionName = false;
3483 /** @} */ # end of cookie settings }
3485 /************************************************************************//**
3486 * @name LaTeX (mathematical formulas)
3487 * @{
3491 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
3492 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
3493 * (ImageMagick) installed and available in the PATH.
3494 * Please see math/README for more information.
3496 $wgUseTeX = false;
3497 /** Location of the texvc binary */
3498 $wgTexvc = './math/texvc';
3500 * Texvc background color
3501 * use LaTeX color format as used in \special function
3502 * for transparent background use value 'Transparent' for alpha transparency or
3503 * 'transparent' for binary transparency.
3505 $wgTexvcBackgroundColor = 'transparent';
3508 * Normally when generating math images, we double-check that the
3509 * directories we want to write to exist, and that files that have
3510 * been generated still exist when we need to bring them up again.
3512 * This lets us give useful error messages in case of permission
3513 * problems, and automatically rebuild images that have been lost.
3515 * On a big site with heavy NFS traffic this can be slow and flaky,
3516 * so sometimes we want to short-circuit it by setting this to false.
3518 $wgMathCheckFiles = true;
3520 /* @} */ # end LaTeX }
3522 /************************************************************************//**
3523 * @name Profiling, testing and debugging
3525 * To enable profiling, edit StartProfiler.php
3527 * @{
3531 * Filename for debug logging. See http://www.mediawiki.org/wiki/How_to_debug
3532 * The debug log file should be not be publicly accessible if it is used, as it
3533 * may contain private data.
3535 $wgDebugLogFile = '';
3538 * Prefix for debug log lines
3540 $wgDebugLogPrefix = '';
3543 * If true, instead of redirecting, show a page with a link to the redirect
3544 * destination. This allows for the inspection of PHP error messages, and easy
3545 * resubmission of form data. For developer use only.
3547 $wgDebugRedirects = false;
3550 * If true, log debugging data from action=raw.
3551 * This is normally false to avoid overlapping debug entries due to gen=css and
3552 * gen=js requests.
3554 $wgDebugRawPage = false;
3557 * Send debug data to an HTML comment in the output.
3559 * This may occasionally be useful when supporting a non-technical end-user. It's
3560 * more secure than exposing the debug log file to the web, since the output only
3561 * contains private data for the current user. But it's not ideal for development
3562 * use since data is lost on fatal errors and redirects.
3564 $wgDebugComments = false;
3567 * Write SQL queries to the debug log
3569 $wgDebugDumpSql = false;
3572 * Set to an array of log group keys to filenames.
3573 * If set, wfDebugLog() output for that group will go to that file instead
3574 * of the regular $wgDebugLogFile. Useful for enabling selective logging
3575 * in production.
3577 $wgDebugLogGroups = array();
3580 * Display debug data at the bottom of the main content area.
3582 * Useful for developers and technical users trying to working on a closed wiki.
3584 $wgShowDebug = false;
3587 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
3589 $wgDebugTimestamps = false;
3592 * Print HTTP headers for every request in the debug information.
3594 $wgDebugPrintHttpHeaders = true;
3597 * Show the contents of $wgHooks in Special:Version
3599 $wgSpecialVersionShowHooks = false;
3602 * Whether to show "we're sorry, but there has been a database error" pages.
3603 * Displaying errors aids in debugging, but may display information useful
3604 * to an attacker.
3606 $wgShowSQLErrors = false;
3609 * If set to true, uncaught exceptions will print a complete stack trace
3610 * to output. This should only be used for debugging, as it may reveal
3611 * private information in function parameters due to PHP's backtrace
3612 * formatting.
3614 $wgShowExceptionDetails = false;
3617 * If true, show a backtrace for database errors
3619 $wgShowDBErrorBacktrace = false;
3622 * Expose backend server host names through the API and various HTML comments
3624 $wgShowHostnames = false;
3627 * If set to true MediaWiki will throw notices for some possible error
3628 * conditions and for deprecated functions.
3630 $wgDevelopmentWarnings = false;
3632 /** Only record profiling info for pages that took longer than this */
3633 $wgProfileLimit = 0.0;
3635 /** Don't put non-profiling info into log file */
3636 $wgProfileOnly = false;
3638 /**
3639 * Log sums from profiling into "profiling" table in db.
3641 * You have to create a 'profiling' table in your database before using
3642 * this feature, see maintenance/archives/patch-profiling.sql
3644 * To enable profiling, edit StartProfiler.php
3646 $wgProfileToDatabase = false;
3648 /** If true, print a raw call tree instead of per-function report */
3649 $wgProfileCallTree = false;
3651 /** Should application server host be put into profiling table */
3652 $wgProfilePerHost = false;
3654 /**
3655 * Host for UDP profiler.
3657 * The host should be running a daemon which can be obtained from MediaWiki
3658 * Subversion at: http://svn.wikimedia.org/svnroot/mediawiki/trunk/udpprofile
3660 $wgUDPProfilerHost = '127.0.0.1';
3662 /**
3663 * Port for UDP profiler.
3664 * @see $wgUDPProfilerHost
3666 $wgUDPProfilerPort = '3811';
3668 /** Detects non-matching wfProfileIn/wfProfileOut calls */
3669 $wgDebugProfiling = false;
3671 /** Output debug message on every wfProfileIn/wfProfileOut */
3672 $wgDebugFunctionEntry = 0;
3675 * Destination for wfIncrStats() data...
3676 * 'cache' to go into the system cache, if enabled (memcached)
3677 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
3678 * false to disable
3680 $wgStatsMethod = 'cache';
3682 /** Whereas to count the number of time an article is viewed.
3683 * Does not work if pages are cached (for example with squid).
3685 $wgDisableCounters = false;
3688 * Support blog-style "trackbacks" for articles. See
3689 * http://www.sixapart.com/pronet/docs/trackback_spec for details.
3691 $wgUseTrackbacks = false;
3694 * Parser test suite files to be run by parserTests.php when no specific
3695 * filename is passed to it.
3697 * Extensions may add their own tests to this array, or site-local tests
3698 * may be added via LocalSettings.php
3700 * Use full paths.
3702 $wgParserTestFiles = array(
3703 "$IP/maintenance/parserTests.txt",
3704 "$IP/maintenance/ExtraParserTests.txt"
3708 * If configured, specifies target CodeReview installation to send test
3709 * result data from 'parserTests.php --upload'
3711 * Something like this:
3712 * $wgParserTestRemote = array(
3713 * 'api-url' => 'http://www.mediawiki.org/w/api.php',
3714 * 'repo' => 'MediaWiki',
3715 * 'suite' => 'ParserTests',
3716 * 'path' => '/trunk/phase3', // not used client-side; for reference
3717 * 'secret' => 'qmoicj3mc4mcklmqw', // Shared secret used in HMAC validation
3718 * );
3720 $wgParserTestRemote = false;
3723 * Enable Selenium test framework.
3724 * This enables maintenance/tests/RunSeleniumTests.php and [[Special:Selenium]].
3726 $wgEnableSelenium = false;
3728 /** List of Selenium test suites. These must be registered with the autoloader. */
3729 $wgSeleniumTestSuites = array(
3730 'SimpleSeleniumTestSuite'
3734 /** Hostname of selenium server */
3735 $wgSeleniumTestsSeleniumHost = 'localhost';
3737 /** URL of the wiki to be tested. By default, the local wiki is used. */
3738 $wgSeleniumTestsWikiUrl = false;
3740 /** Port used by selenium server. */
3741 $wgSeleniumServerPort = 4444;
3743 /** Wiki login username. Used by Selenium to log onto the wiki. */
3744 $wgSeleniumTestsWikiUser = 'Wikiuser';
3746 /** Wiki login password. Used by Selenium to log onto the wiki. */
3747 $wgSeleniumTestsWikiPassword = '';
3750 * Common browsers on Windows platform. Modify for other platforms or
3751 * other Windows browsers.
3752 * Use the *chrome handler in order to be able to test file uploads.
3753 * Further solution suggestions: http://www.brokenbuild.com/blog/2007/06/07/testing-file-uploads-with-selenium-rc-and-firefoxor-reducing-javascript-security-in-firefox-for-fun-and-profit/
3755 $wgSeleniumTestsBrowsers = array(
3756 'firefox' => '*firefox /usr/bin/firefox',
3757 'iexplorer' => '*iexploreproxy',
3758 'opera' => '*chrome /usr/bin/opera',
3761 /** Actually, use this browser */
3762 $wgSeleniumTestsUseBrowser = 'firefox';
3766 /** @} */ # end of profiling, testing and debugging }
3768 /************************************************************************//**
3769 * @name Search
3770 * @{
3774 * Set this to true to disable the full text search feature.
3776 $wgDisableTextSearch = false;
3779 * Set to true to have nicer highligted text in search results,
3780 * by default off due to execution overhead
3782 $wgAdvancedSearchHighlighting = false;
3785 * Regexp to match word boundaries, defaults for non-CJK languages
3786 * should be empty for CJK since the words are not separate
3788 $wgSearchHighlightBoundaries = version_compare("5.1", PHP_VERSION, "<")? '[\p{Z}\p{P}\p{C}]'
3789 : '[ ,.;:!?~!@#$%\^&*\(\)+=\-\\|\[\]"\'<>\n\r\/{}]'; // PHP 5.0 workaround
3792 * Set to true to have the search engine count total
3793 * search matches to present in the Special:Search UI.
3794 * Not supported by every search engine shipped with MW.
3796 * This could however be slow on larger wikis, and is pretty flaky
3797 * with the current title vs content split. Recommend avoiding until
3798 * that's been worked out cleanly; but this may aid in testing the
3799 * search UI and API to confirm that the result count works.
3801 $wgCountTotalSearchHits = false;
3804 * Template for OpenSearch suggestions, defaults to API action=opensearch
3806 * Sites with heavy load would tipically have these point to a custom
3807 * PHP wrapper to avoid firing up mediawiki for every keystroke
3809 * Placeholders: {searchTerms}
3812 $wgOpenSearchTemplate = false;
3815 * Enable suggestions while typing in search boxes
3816 * (results are passed around in OpenSearch format)
3817 * Requires $wgEnableOpenSearchSuggest = true;
3819 $wgEnableMWSuggest = false;
3822 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
3823 * false if you've disabled MWSuggest or another suggestion script and
3824 * want reduce load caused by cached scripts pulling suggestions.
3826 $wgEnableOpenSearchSuggest = true;
3829 * Expiry time for search suggestion responses
3831 $wgSearchSuggestCacheExpiry = 1200;
3834 * Template for internal MediaWiki suggestion engine, defaults to API action=opensearch
3836 * Placeholders: {searchTerms}, {namespaces}, {dbname}
3839 $wgMWSuggestTemplate = false;
3842 * If you've disabled search semi-permanently, this also disables updates to the
3843 * table. If you ever re-enable, be sure to rebuild the search table.
3845 $wgDisableSearchUpdate = false;
3848 * List of namespaces which are searched by default. Example:
3850 * <code>
3851 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
3852 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
3853 * </code>
3855 $wgNamespacesToBeSearchedDefault = array(
3856 NS_MAIN => true,
3860 * Namespaces to be searched when user clicks the "Help" tab
3861 * on Special:Search
3863 * Same format as $wgNamespacesToBeSearchedDefault
3865 $wgNamespacesToBeSearchedHelp = array(
3866 NS_PROJECT => true,
3867 NS_HELP => true,
3871 * If set to true the 'searcheverything' preference will be effective only for logged-in users.
3872 * Useful for big wikis to maintain different search profiles for anonymous and logged-in users.
3875 $wgSearchEverythingOnlyLoggedIn = false;
3878 * Disable the internal MySQL-based search, to allow it to be
3879 * implemented by an extension instead.
3881 $wgDisableInternalSearch = false;
3884 * Set this to a URL to forward search requests to some external location.
3885 * If the URL includes '$1', this will be replaced with the URL-encoded
3886 * search term.
3888 * For example, to forward to Google you'd have something like:
3889 * $wgSearchForwardUrl = 'http://www.google.com/search?q=$1' .
3890 * '&domains=http://example.com' .
3891 * '&sitesearch=http://example.com' .
3892 * '&ie=utf-8&oe=utf-8';
3894 $wgSearchForwardUrl = null;
3897 * Search form behavior
3898 * true = use Go & Search buttons
3899 * false = use Go button & Advanced search link
3901 $wgUseTwoButtonsSearchForm = true;
3904 * Array of namespaces to generate a Google sitemap for when the
3905 * maintenance/generateSitemap.php script is run, or false if one is to be ge-
3906 * nerated for all namespaces.
3908 $wgSitemapNamespaces = false;
3910 /** @} */ # end of search settings
3912 /************************************************************************//**
3913 * @name Edit user interface
3914 * @{
3918 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
3919 * fall back to the old behaviour (no merging).
3921 $wgDiff3 = '/usr/bin/diff3';
3924 * Path to the GNU diff utility.
3926 $wgDiff = '/usr/bin/diff';
3929 * Which namespaces have special treatment where they should be preview-on-open
3930 * Internaly only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
3931 * can specify namespaces of pages they have special treatment for
3933 $wgPreviewOnOpenNamespaces = array(
3934 NS_CATEGORY => true
3938 * Activate external editor interface for files and pages
3939 * See http://www.mediawiki.org/wiki/Manual:External_editors
3941 $wgUseExternalEditor = true;
3943 /** Go button goes straight to the edit screen if the article doesn't exist. */
3944 $wgGoToEdit = false;
3947 * Enable the UniversalEditButton for browsers that support it
3948 * (currently only Firefox with an extension)
3949 * See http://universaleditbutton.org for more background information
3951 $wgUniversalEditButton = true;
3954 * If user doesn't specify any edit summary when making a an edit, MediaWiki
3955 * will try to automatically create one. This feature can be disabled by set-
3956 * ting this variable false.
3958 $wgUseAutomaticEditSummaries = true;
3960 /** @} */ # end edit UI }
3962 /************************************************************************//**
3963 * @name Maintenance
3964 * See also $wgSiteNotice
3965 * @{
3968 /**
3969 * @cond file_level_code
3970 * Set $wgCommandLineMode if it's not set already, to avoid notices
3972 if( !isset( $wgCommandLineMode ) ) {
3973 $wgCommandLineMode = false;
3975 /** @endcond */
3977 /** For colorized maintenance script output, is your terminal background dark ? */
3978 $wgCommandLineDarkBg = false;
3981 * Array for extensions to register their maintenance scripts with the
3982 * system. The key is the name of the class and the value is the full
3983 * path to the file
3985 $wgMaintenanceScripts = array();
3988 * Set this to a string to put the wiki into read-only mode. The text will be
3989 * used as an explanation to users.
3991 * This prevents most write operations via the web interface. Cache updates may
3992 * still be possible. To prevent database writes completely, use the read_only
3993 * option in MySQL.
3995 $wgReadOnly = null;
3997 /***
3998 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
3999 * Its contents will be shown to users as part of the read-only warning
4000 * message.
4002 * Defaults to "{$wgUploadDirectory}/lock_yBgMBwiR".
4004 $wgReadOnlyFile = false;
4006 /** @} */ # End of maintenance }
4008 /************************************************************************//**
4009 * @name Recent changes, new pages, watchlist and history
4010 * @{
4014 * Recentchanges items are periodically purged; entries older than this many
4015 * seconds will go.
4016 * Default: 13 weeks = about three months
4018 $wgRCMaxAge = 13 * 7 * 24 * 3600;
4021 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
4022 * higher than what will be stored. Note that this is disabled by default
4023 * because we sometimes do have RC data which is beyond the limit for some
4024 * reason, and some users may use the high numbers to display that data which
4025 * is still there.
4027 $wgRCFilterByAge = false;
4030 * List of Days and Limits options to list in the Special:Recentchanges and
4031 * Special:Recentchangeslinked pages.
4033 $wgRCLinkLimits = array( 50, 100, 250, 500 );
4034 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
4037 * Send recent changes updates via UDP. The updates will be formatted for IRC.
4038 * Set this to the IP address of the receiver.
4040 $wgRC2UDPAddress = false;
4043 * Port number for RC updates
4045 $wgRC2UDPPort = false;
4048 * Prefix to prepend to each UDP packet.
4049 * This can be used to identify the wiki. A script is available called
4050 * mxircecho.py which listens on a UDP port, and uses a prefix ending in a
4051 * tab to identify the IRC channel to send the log line to.
4053 $wgRC2UDPPrefix = '';
4056 * If this is set to true, $wgLocalInterwiki will be prepended to links in the
4057 * IRC feed. If this is set to a string, that string will be used as the prefix.
4059 $wgRC2UDPInterwikiPrefix = false;
4062 * Set to true to omit "bot" edits (by users with the bot permission) from the
4063 * UDP feed.
4065 $wgRC2UDPOmitBots = false;
4068 * Enable user search in Special:Newpages
4069 * This is really a temporary hack around an index install bug on some Wikipedias.
4070 * Kill it once fixed.
4072 $wgEnableNewpagesUserFilter = true;
4074 /** Use RC Patrolling to check for vandalism */
4075 $wgUseRCPatrol = true;
4077 /** Use new page patrolling to check new pages on Special:Newpages */
4078 $wgUseNPPatrol = true;
4080 /** Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages */
4081 $wgFeed = true;
4083 /** Set maximum number of results to return in syndication feeds (RSS, Atom) for
4084 * eg Recentchanges, Newpages. */
4085 $wgFeedLimit = 50;
4087 /** _Minimum_ timeout for cached Recentchanges feed, in seconds.
4088 * A cached version will continue to be served out even if changes
4089 * are made, until this many seconds runs out since the last render.
4091 * If set to 0, feed caching is disabled. Use this for debugging only;
4092 * feed generation can be pretty slow with diffs.
4094 $wgFeedCacheTimeout = 60;
4096 /** When generating Recentchanges RSS/Atom feed, diffs will not be generated for
4097 * pages larger than this size. */
4098 $wgFeedDiffCutoff = 32768;
4100 /** Override the site's default RSS/ATOM feed for recentchanges that appears on
4101 * every page. Some sites might have a different feed they'd like to promote
4102 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
4103 * Ex: $wgSiteFeed['format'] = "http://example.com/somefeed.xml"; Format can be one
4104 * of either 'rss' or 'atom'.
4106 $wgOverrideSiteFeed = array();
4109 * Which feed types should we provide by default? This can include 'rss',
4110 * 'atom', neither, or both.
4112 $wgAdvertisedFeedTypes = array( 'atom' );
4114 /** Show watching users in recent changes, watchlist and page history views */
4115 $wgRCShowWatchingUsers = false; # UPO
4116 /** Show watching users in Page views */
4117 $wgPageShowWatchingUsers = false;
4118 /** Show the amount of changed characters in recent changes */
4119 $wgRCShowChangedSize = true;
4122 * If the difference between the character counts of the text
4123 * before and after the edit is below that value, the value will be
4124 * highlighted on the RC page.
4126 $wgRCChangedSizeThreshold = 500;
4129 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
4130 * view for watched pages with new changes */
4131 $wgShowUpdatedMarker = true;
4134 * Disable links to talk pages of anonymous users (IPs) in listings on special
4135 * pages like page history, Special:Recentchanges, etc.
4137 $wgDisableAnonTalk = false;
4140 * Enable filtering of categories in Recentchanges
4142 $wgAllowCategorizedRecentChanges = false;
4145 * Allow filtering by change tag in recentchanges, history, etc
4146 * Has no effect if no tags are defined in valid_tag.
4148 $wgUseTagFilter = true;
4150 /** @} */ # end RC/watchlist }
4152 /************************************************************************//**
4153 * @name Copyright and credits settings
4154 * @{
4157 /** RDF metadata toggles */
4158 $wgEnableDublinCoreRdf = false;
4159 $wgEnableCreativeCommonsRdf = false;
4161 /** Override for copyright metadata.
4162 * TODO: these options need documentation
4164 $wgRightsPage = null;
4165 $wgRightsUrl = null;
4166 $wgRightsText = null;
4167 $wgRightsIcon = null;
4170 * Set to an array of metadata terms. Else they will be loaded based on $wgRightsUrl
4172 $wgLicenseTerms = false;
4174 /** Set this to some HTML to override the rights icon with an arbitrary logo */
4175 $wgCopyrightIcon = null;
4177 /** Set this to true if you want detailed copyright information forms on Upload. */
4178 $wgUseCopyrightUpload = false;
4180 /** Set this to false if you want to disable checking that detailed copyright
4181 * information values are not empty. */
4182 $wgCheckCopyrightUpload = true;
4185 * Set this to the number of authors that you want to be credited below an
4186 * article text. Set it to zero to hide the attribution block, and a negative
4187 * number (like -1) to show all authors. Note that this will require 2-3 extra
4188 * database hits, which can have a not insignificant impact on performance for
4189 * large wikis.
4191 $wgMaxCredits = 0;
4193 /** If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
4194 * Otherwise, link to a separate credits page. */
4195 $wgShowCreditsIfMax = true;
4197 /** @} */ # end of copyright and credits settings }
4199 /************************************************************************//**
4200 * @name Import / Export
4201 * @{
4205 * List of interwiki prefixes for wikis we'll accept as sources for
4206 * Special:Import (for sysops). Since complete page history can be imported,
4207 * these should be 'trusted'.
4209 * If a user has the 'import' permission but not the 'importupload' permission,
4210 * they will only be able to run imports through this transwiki interface.
4212 $wgImportSources = array();
4215 * Optional default target namespace for interwiki imports.
4216 * Can use this to create an incoming "transwiki"-style queue.
4217 * Set to numeric key, not the name.
4219 * Users may override this in the Special:Import dialog.
4221 $wgImportTargetNamespace = null;
4224 * If set to false, disables the full-history option on Special:Export.
4225 * This is currently poorly optimized for long edit histories, so is
4226 * disabled on Wikimedia's sites.
4228 $wgExportAllowHistory = true;
4231 * If set nonzero, Special:Export requests for history of pages with
4232 * more revisions than this will be rejected. On some big sites things
4233 * could get bogged down by very very long pages.
4235 $wgExportMaxHistory = 0;
4238 * Return distinct author list (when not returning full history)
4240 $wgExportAllowListContributors = false ;
4243 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
4244 * up to this specified level, which will cause it to include all
4245 * pages linked to from the pages you specify. Since this number
4246 * can become *insanely large* and could easily break your wiki,
4247 * it's disabled by default for now.
4249 * There's a HARD CODED limit of 5 levels of recursion to prevent a
4250 * crazy-big export from being done by someone setting the depth
4251 * number too high. In other words, last resort safety net.
4253 $wgExportMaxLinkDepth = 0;
4256 * Whether to allow the "export all pages in namespace" option
4258 $wgExportFromNamespaces = false;
4260 /** @} */ # end of import/export }
4262 /*************************************************************************//**
4263 * @name Extensions
4264 * @{
4268 * A list of callback functions which are called once MediaWiki is fully initialised
4270 $wgExtensionFunctions = array();
4273 * Extension functions for initialisation of skins. This is called somewhat earlier
4274 * than $wgExtensionFunctions.
4276 $wgSkinExtensionFunctions = array();
4279 * Extension messages files.
4281 * Associative array mapping extension name to the filename where messages can be
4282 * found. The file should contain variable assignments. Any of the variables
4283 * present in languages/messages/MessagesEn.php may be defined, but $messages
4284 * is the most common.
4286 * Variables defined in extensions will override conflicting variables defined
4287 * in the core.
4289 * Example:
4290 * $wgExtensionMessagesFiles['ConfirmEdit'] = dirname(__FILE__).'/ConfirmEdit.i18n.php';
4293 $wgExtensionMessagesFiles = array();
4296 * Aliases for special pages provided by extensions.
4297 * @deprecated Use $specialPageAliases in a file referred to by $wgExtensionMessagesFiles
4299 $wgExtensionAliasesFiles = array();
4302 * Parser output hooks.
4303 * This is an associative array where the key is an extension-defined tag
4304 * (typically the extension name), and the value is a PHP callback.
4305 * These will be called as an OutputPageParserOutput hook, if the relevant
4306 * tag has been registered with the parser output object.
4308 * Registration is done with $pout->addOutputHook( $tag, $data ).
4310 * The callback has the form:
4311 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
4313 $wgParserOutputHooks = array();
4316 * List of valid skin names.
4317 * The key should be the name in all lower case, the value should be a display name.
4318 * The default skins will be added later, by Skin::getSkinNames(). Use
4319 * Skin::getSkinNames() as an accessor if you wish to have access to the full list.
4321 $wgValidSkinNames = array();
4324 * Special page list.
4325 * See the top of SpecialPage.php for documentation.
4327 $wgSpecialPages = array();
4330 * Array mapping class names to filenames, for autoloading.
4332 $wgAutoloadClasses = array();
4335 * An array of extension types and inside that their names, versions, authors,
4336 * urls, descriptions and pointers to localized description msgs. Note that
4337 * the version, url, description and descriptionmsg key can be omitted.
4339 * <code>
4340 * $wgExtensionCredits[$type][] = array(
4341 * 'name' => 'Example extension',
4342 * 'version' => 1.9,
4343 * 'path' => __FILE__,
4344 * 'author' => 'Foo Barstein',
4345 * 'url' => 'http://wwww.example.com/Example%20Extension/',
4346 * 'description' => 'An example extension',
4347 * 'descriptionmsg' => 'exampleextension-desc',
4348 * );
4349 * </code>
4351 * Where $type is 'specialpage', 'parserhook', 'variable', 'media' or 'other'.
4352 * Where 'descriptionmsg' can be an array with message key and parameters:
4353 * 'descriptionmsg' => array( 'exampleextension-desc', param1, param2, ... ),
4355 $wgExtensionCredits = array();
4358 * Authentication plugin.
4360 $wgAuth = null;
4363 * Global list of hooks.
4364 * Add a hook by doing:
4365 * $wgHooks['event_name'][] = $function;
4366 * or:
4367 * $wgHooks['event_name'][] = array($function, $data);
4368 * or:
4369 * $wgHooks['event_name'][] = array($object, 'method');
4371 $wgHooks = array();
4374 * Maps jobs to their handling classes; extensions
4375 * can add to this to provide custom jobs
4377 $wgJobClasses = array(
4378 'refreshLinks' => 'RefreshLinksJob',
4379 'refreshLinks2' => 'RefreshLinksJob2',
4380 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
4381 'html_cache_update' => 'HTMLCacheUpdateJob', // backwards-compatible
4382 'sendMail' => 'EmaillingJob',
4383 'enotifNotify' => 'EnotifNotifyJob',
4384 'fixDoubleRedirect' => 'DoubleRedirectJob',
4385 'uploadFromUrl' => 'UploadFromUrlJob',
4389 * Additional functions to be performed with updateSpecialPages.
4390 * Expensive Querypages are already updated.
4392 $wgSpecialPageCacheUpdates = array(
4393 'Statistics' => array('SiteStatsUpdate','cacheUpdate')
4397 * Hooks that are used for outputting exceptions. Format is:
4398 * $wgExceptionHooks[] = $funcname
4399 * or:
4400 * $wgExceptionHooks[] = array( $class, $funcname )
4401 * Hooks should return strings or false
4403 $wgExceptionHooks = array();
4406 * List of page property names and descriptions of what they are.
4407 * This is used for the API prop=pageprops module to know which
4408 * page props to search for. The help message is only seen from
4409 * the API help page.
4411 $wgPageProps = array(
4412 'hiddencat' => 'Whether or not the page has a category with the __HIDDENCAT__ magic word',
4416 * Page property link table invalidation lists. When a page property
4417 * changes, this may require other link tables to be updated (eg
4418 * adding __HIDDENCAT__ means the hiddencat tracking category will
4419 * have been added, so the categorylinks table needs to be rebuilt).
4420 * This array can be added to by extensions.
4422 $wgPagePropLinkInvalidations = array(
4423 'hiddencat' => 'categorylinks',
4426 /** @} */ # End extensions }
4428 /*************************************************************************//**
4429 * @name Categories
4430 * @{
4434 * Use experimental, DMOZ-like category browser
4436 $wgUseCategoryBrowser = false;
4439 * On category pages, show thumbnail gallery for images belonging to that
4440 * category instead of listing them as articles.
4442 $wgCategoryMagicGallery = true;
4445 * Paging limit for categories
4447 $wgCategoryPagingLimit = 200;
4450 * A version indicator for collations that will be stored in cl_collation for
4451 * all new rows. Used when the collation algorithm changes: a script checks
4452 * for all rows where cl_collation != $wgCollationVersion and regenerates
4453 * cl_sortkey based on the page name and cl_sortkey_prefix.
4455 $wgCollationVersion = 1;
4457 /** @} */ # End categories }
4459 /*************************************************************************//**
4460 * @name Logging
4461 * @{
4465 * The logging system has two levels: an event type, which describes the
4466 * general category and can be viewed as a named subset of all logs; and
4467 * an action, which is a specific kind of event that can exist in that
4468 * log type.
4470 $wgLogTypes = array( '',
4471 'block',
4472 'protect',
4473 'rights',
4474 'delete',
4475 'upload',
4476 'move',
4477 'import',
4478 'patrol',
4479 'merge',
4480 'suppress',
4484 * This restricts log access to those who have a certain right
4485 * Users without this will not see it in the option menu and can not view it
4486 * Restricted logs are not added to recent changes
4487 * Logs should remain non-transcludable
4488 * Format: logtype => permissiontype
4490 $wgLogRestrictions = array(
4491 'suppress' => 'suppressionlog'
4495 * Show/hide links on Special:Log will be shown for these log types.
4497 * This is associative array of log type => boolean "hide by default"
4499 * See $wgLogTypes for a list of available log types.
4501 * For example:
4502 * $wgFilterLogTypes => array(
4503 * 'move' => true,
4504 * 'import' => false,
4505 * );
4507 * Will display show/hide links for the move and import logs. Move logs will be
4508 * hidden by default unless the link is clicked. Import logs will be shown by
4509 * default, and hidden when the link is clicked.
4511 * A message of the form log-show-hide-<type> should be added, and will be used
4512 * for the link text.
4514 $wgFilterLogTypes = array(
4515 'patrol' => true
4519 * Lists the message key string for each log type. The localized messages
4520 * will be listed in the user interface.
4522 * Extensions with custom log types may add to this array.
4524 $wgLogNames = array(
4525 '' => 'all-logs-page',
4526 'block' => 'blocklogpage',
4527 'protect' => 'protectlogpage',
4528 'rights' => 'rightslog',
4529 'delete' => 'dellogpage',
4530 'upload' => 'uploadlogpage',
4531 'move' => 'movelogpage',
4532 'import' => 'importlogpage',
4533 'patrol' => 'patrol-log-page',
4534 'merge' => 'mergelog',
4535 'suppress' => 'suppressionlog',
4539 * Lists the message key string for descriptive text to be shown at the
4540 * top of each log type.
4542 * Extensions with custom log types may add to this array.
4544 $wgLogHeaders = array(
4545 '' => 'alllogstext',
4546 'block' => 'blocklogtext',
4547 'protect' => 'protectlogtext',
4548 'rights' => 'rightslogtext',
4549 'delete' => 'dellogpagetext',
4550 'upload' => 'uploadlogpagetext',
4551 'move' => 'movelogpagetext',
4552 'import' => 'importlogpagetext',
4553 'patrol' => 'patrol-log-header',
4554 'merge' => 'mergelogpagetext',
4555 'suppress' => 'suppressionlogtext',
4559 * Lists the message key string for formatting individual events of each
4560 * type and action when listed in the logs.
4562 * Extensions with custom log types may add to this array.
4564 $wgLogActions = array(
4565 'block/block' => 'blocklogentry',
4566 'block/unblock' => 'unblocklogentry',
4567 'block/reblock' => 'reblock-logentry',
4568 'protect/protect' => 'protectedarticle',
4569 'protect/modify' => 'modifiedarticleprotection',
4570 'protect/unprotect' => 'unprotectedarticle',
4571 'protect/move_prot' => 'movedarticleprotection',
4572 'rights/rights' => 'rightslogentry',
4573 'delete/delete' => 'deletedarticle',
4574 'delete/restore' => 'undeletedarticle',
4575 'delete/revision' => 'revdelete-logentry',
4576 'delete/event' => 'logdelete-logentry',
4577 'upload/upload' => 'uploadedimage',
4578 'upload/overwrite' => 'overwroteimage',
4579 'upload/revert' => 'uploadedimage',
4580 'move/move' => '1movedto2',
4581 'move/move_redir' => '1movedto2_redir',
4582 'move/move_rev' => 'moverevlogentry',
4583 'import/upload' => 'import-logentry-upload',
4584 'import/interwiki' => 'import-logentry-interwiki',
4585 'merge/merge' => 'pagemerge-logentry',
4586 'suppress/revision' => 'revdelete-logentry',
4587 'suppress/file' => 'revdelete-logentry',
4588 'suppress/event' => 'logdelete-logentry',
4589 'suppress/delete' => 'suppressedarticle',
4590 'suppress/block' => 'blocklogentry',
4591 'suppress/reblock' => 'reblock-logentry',
4592 'patrol/patrol' => 'patrol-log-line',
4596 * The same as above, but here values are names of functions,
4597 * not messages.
4598 * @see LogPage::actionText
4600 $wgLogActionsHandlers = array();
4603 * Maintain a log of newusers at Log/newusers?
4605 $wgNewUserLog = true;
4608 * Log the automatic creations of new users accounts?
4610 $wgLogAutocreatedAccounts = false;
4612 /** @} */ # end logging }
4614 /*************************************************************************//**
4615 * @name Special pages (general and miscellaneous)
4616 * @{
4620 * Allow special page inclusions such as {{Special:Allpages}}
4622 $wgAllowSpecialInclusion = true;
4625 * Set this to an array of special page names to prevent
4626 * maintenance/updateSpecialPages.php from updating those pages.
4628 $wgDisableQueryPageUpdate = false;
4631 * List of special pages, followed by what subtitle they should go under
4632 * at Special:SpecialPages
4634 $wgSpecialPageGroups = array(
4635 'DoubleRedirects' => 'maintenance',
4636 'BrokenRedirects' => 'maintenance',
4637 'Lonelypages' => 'maintenance',
4638 'Uncategorizedpages' => 'maintenance',
4639 'Uncategorizedcategories' => 'maintenance',
4640 'Uncategorizedimages' => 'maintenance',
4641 'Uncategorizedtemplates' => 'maintenance',
4642 'Unusedcategories' => 'maintenance',
4643 'Unusedimages' => 'maintenance',
4644 'Protectedpages' => 'maintenance',
4645 'Protectedtitles' => 'maintenance',
4646 'Unusedtemplates' => 'maintenance',
4647 'Withoutinterwiki' => 'maintenance',
4648 'Longpages' => 'maintenance',
4649 'Shortpages' => 'maintenance',
4650 'Ancientpages' => 'maintenance',
4651 'Deadendpages' => 'maintenance',
4652 'Wantedpages' => 'maintenance',
4653 'Wantedcategories' => 'maintenance',
4654 'Wantedfiles' => 'maintenance',
4655 'Wantedtemplates' => 'maintenance',
4656 'Unwatchedpages' => 'maintenance',
4657 'Fewestrevisions' => 'maintenance',
4659 'Userlogin' => 'login',
4660 'Userlogout' => 'login',
4661 'CreateAccount' => 'login',
4663 'Recentchanges' => 'changes',
4664 'Recentchangeslinked' => 'changes',
4665 'Watchlist' => 'changes',
4666 'Newimages' => 'changes',
4667 'Newpages' => 'changes',
4668 'Log' => 'changes',
4669 'Tags' => 'changes',
4671 'Upload' => 'media',
4672 'Listfiles' => 'media',
4673 'MIMEsearch' => 'media',
4674 'FileDuplicateSearch' => 'media',
4675 'Filepath' => 'media',
4677 'Listusers' => 'users',
4678 'Activeusers' => 'users',
4679 'Listgrouprights' => 'users',
4680 'Ipblocklist' => 'users',
4681 'Contributions' => 'users',
4682 'Emailuser' => 'users',
4683 'Listadmins' => 'users',
4684 'Listbots' => 'users',
4685 'Userrights' => 'users',
4686 'Blockip' => 'users',
4687 'Preferences' => 'users',
4688 'Resetpass' => 'users',
4689 'DeletedContributions' => 'users',
4691 'Mostlinked' => 'highuse',
4692 'Mostlinkedcategories' => 'highuse',
4693 'Mostlinkedtemplates' => 'highuse',
4694 'Mostcategories' => 'highuse',
4695 'Mostimages' => 'highuse',
4696 'Mostrevisions' => 'highuse',
4698 'Allpages' => 'pages',
4699 'Prefixindex' => 'pages',
4700 'Listredirects' => 'pages',
4701 'Categories' => 'pages',
4702 'Disambiguations' => 'pages',
4704 'Randompage' => 'redirects',
4705 'Randomredirect' => 'redirects',
4706 'Mypage' => 'redirects',
4707 'Mytalk' => 'redirects',
4708 'Mycontributions' => 'redirects',
4709 'Search' => 'redirects',
4710 'LinkSearch' => 'redirects',
4712 'ComparePages' => 'pagetools',
4713 'Movepage' => 'pagetools',
4714 'MergeHistory' => 'pagetools',
4715 'Revisiondelete' => 'pagetools',
4716 'Undelete' => 'pagetools',
4717 'Export' => 'pagetools',
4718 'Import' => 'pagetools',
4719 'Whatlinkshere' => 'pagetools',
4721 'Statistics' => 'wiki',
4722 'Version' => 'wiki',
4723 'Lockdb' => 'wiki',
4724 'Unlockdb' => 'wiki',
4725 'Allmessages' => 'wiki',
4726 'Popularpages' => 'wiki',
4728 'Specialpages' => 'other',
4729 'Blockme' => 'other',
4730 'Booksources' => 'other',
4733 /** Whether or not to sort special pages in Special:Specialpages */
4735 $wgSortSpecialPages = true;
4738 * Filter for Special:Randompage. Part of a WHERE clause
4739 * @deprecated as of 1.16, use the SpecialRandomGetRandomTitle hook
4741 $wgExtraRandompageSQL = false;
4744 * On Special:Unusedimages, consider images "used", if they are put
4745 * into a category. Default (false) is not to count those as used.
4747 $wgCountCategorizedImagesAsUsed = false;
4750 * Maximum number of links to a redirect page listed on
4751 * Special:Whatlinkshere/RedirectDestination
4753 $wgMaxRedirectLinksRetrieved = 500;
4755 /** @} */ # end special pages }
4757 /*************************************************************************//**
4758 * @name Robot (search engine crawler) policy
4759 * See also $wgNoFollowLinks.
4760 * @{
4764 * Default robot policy. The default policy is to encourage indexing and fol-
4765 * lowing of links. It may be overridden on a per-namespace and/or per-page
4766 * basis.
4768 $wgDefaultRobotPolicy = 'index,follow';
4771 * Robot policies per namespaces. The default policy is given above, the array
4772 * is made of namespace constants as defined in includes/Defines.php. You can-
4773 * not specify a different default policy for NS_SPECIAL: it is always noindex,
4774 * nofollow. This is because a number of special pages (e.g., ListPages) have
4775 * many permutations of options that display the same data under redundant
4776 * URLs, so search engine spiders risk getting lost in a maze of twisty special
4777 * pages, all alike, and never reaching your actual content.
4779 * Example:
4780 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
4782 $wgNamespaceRobotPolicies = array();
4785 * Robot policies per article. These override the per-namespace robot policies.
4786 * Must be in the form of an array where the key part is a properly canonical-
4787 * ised text form title and the value is a robot policy.
4788 * Example:
4789 * $wgArticleRobotPolicies = array( 'Main Page' => 'noindex,follow',
4790 * 'User:Bob' => 'index,follow' );
4791 * Example that DOES NOT WORK because the names are not canonical text forms:
4792 * $wgArticleRobotPolicies = array(
4793 * # Underscore, not space!
4794 * 'Main_Page' => 'noindex,follow',
4795 * # "Project", not the actual project name!
4796 * 'Project:X' => 'index,follow',
4797 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
4798 * 'abc' => 'noindex,nofollow'
4799 * );
4801 $wgArticleRobotPolicies = array();
4804 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
4805 * will not function, so users can't decide whether pages in that namespace are
4806 * indexed by search engines. If set to null, default to $wgContentNamespaces.
4807 * Example:
4808 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
4810 $wgExemptFromUserRobotsControl = null;
4812 /** @} */ # End robot policy }
4814 /************************************************************************//**
4815 * @name AJAX and API
4816 * Note: The AJAX entry point which this section refers to is gradually being
4817 * replaced by the API entry point, api.php. They are essentially equivalent.
4818 * Both of them are used for dynamic client-side features, via XHR.
4819 * @{
4823 * Enable the MediaWiki API for convenient access to
4824 * machine-readable data via api.php
4826 * See http://www.mediawiki.org/wiki/API
4828 $wgEnableAPI = true;
4831 * Allow the API to be used to perform write operations
4832 * (page edits, rollback, etc.) when an authorised user
4833 * accesses it
4835 $wgEnableWriteAPI = true;
4838 * API module extensions
4839 * Associative array mapping module name to class name.
4840 * Extension modules may override the core modules.
4842 $wgAPIModules = array();
4843 $wgAPIMetaModules = array();
4844 $wgAPIPropModules = array();
4845 $wgAPIListModules = array();
4848 * Maximum amount of rows to scan in a DB query in the API
4849 * The default value is generally fine
4851 $wgAPIMaxDBRows = 5000;
4854 * The maximum size (in bytes) of an API result.
4855 * Don't set this lower than $wgMaxArticleSize*1024
4857 $wgAPIMaxResultSize = 8388608;
4860 * The maximum number of uncached diffs that can be retrieved in one API
4861 * request. Set this to 0 to disable API diffs altogether
4863 $wgAPIMaxUncachedDiffs = 1;
4866 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
4867 * API request logging
4869 $wgAPIRequestLog = false;
4872 * Cache the API help text for up to an hour. Disable this during API
4873 * debugging and development
4875 $wgAPICacheHelp = true;
4878 * Set the timeout for the API help text cache. Ignored if $wgAPICacheHelp
4879 * is false.
4881 $wgAPICacheHelpTimeout = 60*60;
4884 * Enable AJAX framework
4886 $wgUseAjax = true;
4889 * List of Ajax-callable functions.
4890 * Extensions acting as Ajax callbacks must register here
4892 $wgAjaxExportList = array( 'wfAjaxGetFileUrl' );
4895 * Enable watching/unwatching pages using AJAX.
4896 * Requires $wgUseAjax to be true too.
4897 * Causes wfAjaxWatch to be added to $wgAjaxExportList
4899 $wgAjaxWatch = true;
4902 * Enable AJAX check for file overwrite, pre-upload
4904 $wgAjaxUploadDestCheck = true;
4907 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
4909 $wgAjaxLicensePreview = true;
4912 * Settings for incoming cross-site AJAX requests:
4913 * Newer browsers support cross-site AJAX when the target resource allows requests
4914 * from the origin domain by the Access-Control-Allow-Origin header.
4915 * This is currently only used by the API (requests to api.php)
4916 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
4918 * '*' matches any number of characters
4919 * '?' matches any 1 character
4921 * Example:
4922 $wgCrossSiteAJAXdomains = array(
4923 'www.mediawiki.org',
4924 '*.wikipedia.org',
4925 '*.wikimedia.org',
4926 '*.wiktionary.org',
4930 $wgCrossSiteAJAXdomains = array();
4933 * Domains that should not be allowed to make AJAX requests,
4934 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
4935 * Uses the same syntax as $wgCrossSiteAJAXdomains
4938 $wgCrossSiteAJAXdomainExceptions = array();
4940 /** @} */ # End AJAX and API }
4942 /************************************************************************//**
4943 * @name Shell and process control
4944 * @{
4948 * Maximum amount of virtual memory available to shell processes under linux, in KB.
4950 $wgMaxShellMemory = 102400;
4953 * Maximum file size created by shell processes under linux, in KB
4954 * ImageMagick convert for example can be fairly hungry for scratch space
4956 $wgMaxShellFileSize = 102400;
4959 * Maximum CPU time in seconds for shell processes under linux
4961 $wgMaxShellTime = 180;
4964 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
4966 $wgPhpCli = '/usr/bin/php';
4969 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
4970 * For Unix-like operating systems, set this to to a locale that has a UTF-8
4971 * character set. Only the character set is relevant.
4973 $wgShellLocale = 'en_US.utf8';
4975 /** @} */ # End shell }
4977 /************************************************************************//**
4978 * @name HTTP client
4979 * @{
4983 * Timeout for HTTP requests done internally
4985 $wgHTTPTimeout = 25;
4988 * Timeout for Asynchronous (background) HTTP requests
4990 $wgAsyncHTTPTimeout = 25;
4993 * Proxy to use for CURL requests.
4995 $wgHTTPProxy = false;
4997 /** @} */ # End HTTP client }
4999 /************************************************************************//**
5000 * @name Job queue
5001 * See also $wgEnotifUseJobQ.
5002 * @{
5006 * Number of jobs to perform per request. May be less than one in which case
5007 * jobs are performed probabalistically. If this is zero, jobs will not be done
5008 * during ordinary apache requests. In this case, maintenance/runJobs.php should
5009 * be run periodically.
5011 $wgJobRunRate = 1;
5014 * Number of rows to update per job
5016 $wgUpdateRowsPerJob = 500;
5019 * Number of rows to update per query
5021 $wgUpdateRowsPerQuery = 100;
5023 /** @} */ # End job queue }
5025 /************************************************************************//**
5026 * @name Miscellaneous
5027 * @{
5030 /** Allow the "info" action, very inefficient at the moment */
5031 $wgAllowPageInfo = false;
5033 /** Name of the external diff engine to use */
5034 $wgExternalDiffEngine = false;
5037 * Array of disabled article actions, e.g. view, edit, dublincore, delete, etc.
5039 $wgDisabledActions = array();
5042 * Disable redirects to special pages and interwiki redirects, which use a 302
5043 * and have no "redirected from" link.
5045 $wgDisableHardRedirects = false;
5048 * LinkHolderArray batch size
5049 * For debugging
5051 $wgLinkHolderBatchSize = 1000;
5054 * By default MediaWiki does not register links pointing to same server in externallinks dataset,
5055 * use this value to override:
5057 $wgRegisterInternalExternals = false;
5060 * Maximum number of pages to move at once when moving subpages with a page.
5062 $wgMaximumMovedPages = 100;
5065 * Fix double redirects after a page move.
5066 * Tends to conflict with page move vandalism, use only on a private wiki.
5068 $wgFixDoubleRedirects = false;
5071 * Allow redirection to another page when a user logs in.
5072 * To enable, set to a string like 'Main Page'
5074 $wgRedirectOnLogin = null;
5077 * Configuration for processing pool control, for use in high-traffic wikis.
5078 * An implementation is provided in the PoolCounter extension.
5080 * This configuration array maps pool types to an associative array. The only
5081 * defined key in the associative array is "class", which gives the class name.
5082 * The remaining elements are passed through to the class as constructor
5083 * parameters. Example:
5085 * $wgPoolCounterConf = array( 'Article::view' => array(
5086 * 'class' => 'PoolCounter_Client',
5087 * ... any extension-specific options...
5088 * );
5090 $wgPoolCounterConf = null;
5093 * To disable file delete/restore temporarily
5095 $wgUploadMaintenance = false;
5098 * Enabes or disables JavaScript-based suggestions of password strength
5100 $wgLivePasswordStrengthChecks = false;
5103 * The location of the MediaWiki package repository to use.
5105 * @since 1.17
5106 * @var string
5108 $wgRepositoryApiLocation = 'http://www.mediawiki.org/w/api.php';
5111 * The location of the remote web interface for the selected repository.
5113 * @since 1.17
5114 * @var string
5116 $wgRepositoryLocation = 'http://www.mediawiki.org/wiki/Special:Repository';
5119 * List of package states to filter update detection and extension listing on.
5121 * @since 1.17
5122 * @var array
5124 $wgRepositoryPackageStates = array(
5125 //'dev',
5126 //'alpha',
5127 'beta',
5128 //'rc',
5129 'stable',
5130 //'deprecated',
5134 * For really cool vim folding this needs to be at the end:
5135 * vim: foldmarker=@{,@} foldmethod=marker
5136 * @}