3 * Default values for MediaWiki configuration settings.
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
42 * @defgroup Globalsettings Global settings
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
58 * wgConf hold the site configuration.
59 * Not used for much in a default install.
62 $wgConf = new SiteConfiguration
;
65 * Registry of factory functions to create config objects:
66 * The 'main' key must be set, and the value should be a valid
70 $wgConfigRegistry = array(
71 'main' => 'GlobalVarConfig::newInstance'
75 * MediaWiki version number
78 $wgVersion = '1.27alpha';
81 * Name of the site. It must be changed in LocalSettings.php
83 $wgSitename = 'MediaWiki';
86 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
87 * the wiki on the standard ports (443 for https and 80 for http).
91 $wgAssumeProxiesUseDefaultProtocolPorts = true;
98 * $wgServer = 'http://example.com';
101 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
102 * wrong server, it will redirect incorrectly after you save a page. In that
103 * case, set this variable to fix it.
105 * If you want to use protocol-relative URLs on your wiki, set this to a
106 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
107 * to a fully qualified URL.
109 $wgServer = WebRequest
::detectServer();
112 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
113 * Must be fully qualified, even if $wgServer is protocol-relative.
115 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
118 $wgCanonicalServer = false;
121 * Server name. This is automatically computed by parsing the bare
122 * hostname out of $wgCanonicalServer. It should not be customized.
125 $wgServerName = false;
127 /************************************************************************//**
128 * @name Script path settings
133 * The path we should point to.
134 * It might be a virtual path in case with use apache mod_rewrite for example.
136 * This *needs* to be set correctly.
138 * Other paths will be set to defaults based on it unless they are directly
139 * set in LocalSettings.php
141 $wgScriptPath = '/wiki';
144 * Whether to support URLs like index.php/Page_title These often break when PHP
145 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
146 * but then again it may not; lighttpd converts incoming path data to lowercase
147 * on systems with case-insensitive filesystems, and there have been reports of
148 * problems on Apache as well.
150 * To be safe we'll continue to keep it off by default.
152 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
153 * incorrect garbage, or to true if it is really correct.
155 * The default $wgArticlePath will be set based on this value at runtime, but if
156 * you have customized it, having this incorrectly set to true can cause
157 * redirect loops when "pretty URLs" are used.
160 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
161 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
162 ( strpos( PHP_SAPI
, 'isapi' ) === false );
165 * The extension to append to script names by default.
167 * Some hosting providers used PHP 4 for *.php files, and PHP 5 for *.php5.
168 * This variable was provided to support those providers.
171 * @deprecated since 1.25; support for '.php5' has been phased out of MediaWiki
172 * proper. Backward-compatibility can be maintained by configuring your web
173 * server to rewrite URLs. See RELEASE-NOTES for details.
175 $wgScriptExtension = '.php';
179 /************************************************************************//**
180 * @name URLs and file paths
182 * These various web and file path variables are set to their defaults
183 * in Setup.php if they are not explicitly set from LocalSettings.php.
185 * These will relatively rarely need to be set manually, unless you are
186 * splitting style sheets or images outside the main document root.
188 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
189 * the host part, that starts with a slash. In most cases a full URL is also
190 * acceptable. A "directory" is a local file path.
192 * In both paths and directories, trailing slashes should not be included.
198 * The URL path to index.php.
200 * Defaults to "{$wgScriptPath}/index.php".
205 * The URL path to load.php.
207 * Defaults to "{$wgScriptPath}/load.php".
210 $wgLoadScript = false;
213 * The URL path of the skins directory.
214 * Defaults to "{$wgResourceBasePath}/skins".
217 $wgStylePath = false;
218 $wgStyleSheetPath = &$wgStylePath;
221 * The URL path of the skins directory. Should not point to an external domain.
222 * Defaults to "{$wgScriptPath}/skins".
225 $wgLocalStylePath = false;
228 * The URL path of the extensions directory.
229 * Defaults to "{$wgResourceBasePath}/extensions".
232 $wgExtensionAssetsPath = false;
235 * Filesystem extensions directory.
236 * Defaults to "{$IP}/extensions".
239 $wgExtensionDirectory = "{$IP}/extensions";
242 * Filesystem stylesheets directory.
243 * Defaults to "{$IP}/skins".
246 $wgStyleDirectory = "{$IP}/skins";
249 * The URL path for primary article page views. This path should contain $1,
250 * which is replaced by the article title.
252 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
253 * depending on $wgUsePathInfo.
255 $wgArticlePath = false;
258 * The URL path for the images directory.
259 * Defaults to "{$wgScriptPath}/images".
261 $wgUploadPath = false;
264 * The filesystem path of the images directory. Defaults to "{$IP}/images".
266 $wgUploadDirectory = false;
269 * Directory where the cached page will be saved.
270 * Defaults to "{$wgUploadDirectory}/cache".
272 $wgFileCacheDirectory = false;
275 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
276 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
281 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
282 * should be under 135x155 pixels.
283 * Only 1.5x and 2x versions are supported.
288 * "1.5x" => "path/to/1.5x_version.png",
289 * "2x" => "path/to/2x_version.png"
298 * The URL path of the shortcut icon.
301 $wgFavicon = '/favicon.ico';
304 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
305 * Defaults to no icon.
308 $wgAppleTouchIcon = false;
311 * Value for the referrer policy meta tag.
312 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
313 * prevents the meta tag from being output.
314 * See http://www.w3.org/TR/referrer-policy/ for details.
318 $wgReferrerPolicy = false;
321 * The local filesystem path to a temporary directory. This is not required to
324 * When this setting is set to false, its value will be set through a call
325 * to wfTempDir(). See that methods implementation for the actual detection
328 * Developers should use the global function wfTempDir() instead of this
332 * @note Default changed to false in MediaWiki 1.20.
334 $wgTmpDirectory = false;
337 * If set, this URL is added to the start of $wgUploadPath to form a complete
341 $wgUploadBaseUrl = '';
344 * To enable remote on-demand scaling, set this to the thumbnail base URL.
345 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
346 * where 'e6' are the first two characters of the MD5 hash of the file name.
347 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
350 $wgUploadStashScalerBaseUrl = false;
353 * To set 'pretty' URL paths for actions other than
354 * plain page views, add to this array.
357 * Set pretty URL for the edit action:
359 * 'edit' => "$wgScriptPath/edit/$1"
362 * There must be an appropriate script or rewrite rule in place to handle these
366 $wgActionPaths = array();
370 /************************************************************************//**
371 * @name Files and file uploads
376 * Uploads have to be specially set up to be secure
378 $wgEnableUploads = false;
381 * The maximum age of temporary (incomplete) uploaded files
383 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
386 * Allows to move images and other media files
388 $wgAllowImageMoving = true;
391 * Enable deferred upload tasks that use the job queue.
392 * Only enable this if job runners are set up for both the
393 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
395 * @note If you use suhosin, this setting is incompatible with
396 * suhosin.session.encrypt.
398 $wgEnableAsyncUploads = false;
401 * These are additional characters that should be replaced with '-' in filenames
403 $wgIllegalFileChars = ":";
406 * What directory to place deleted uploads in.
407 * Defaults to "{$wgUploadDirectory}/deleted".
409 $wgDeletedDirectory = false;
412 * Set this to true if you use img_auth and want the user to see details on why access failed.
414 $wgImgAuthDetails = false;
417 * Map of relative URL directories to match to internal mwstore:// base storage paths.
418 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
419 * if starts with any of the prefixes defined here. The prefixes should not overlap.
420 * The prefix that matches has a corresponding storage path, which the rest of the URL
421 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
424 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
425 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
426 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
428 * @see $wgFileBackends
430 $wgImgAuthUrlPathMap = array();
433 * File repository structures
435 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
436 * an array of such structures. Each repository structure is an associative
437 * array of properties configuring the repository.
439 * Properties required for all repos:
440 * - class The class name for the repository. May come from the core or an extension.
441 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
442 * FSRepo is also supported for backwards compatibility.
444 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
445 * The name should consist of alpha-numeric characters.
446 * - backend A file backend name (see $wgFileBackends).
448 * For most core repos:
449 * - zones Associative array of zone names that each map to an array with:
450 * container : backend container name the zone is in
451 * directory : root path within container for the zone
452 * url : base URL to the root of the zone
453 * urlsByExt : map of file extension types to base URLs
454 * (useful for using a different cache for videos)
455 * Zones default to using "<repo name>-<zone name>" as the container name
456 * and default to using the container root as the zone's root directory.
457 * Nesting of zone locations within other zones should be avoided.
458 * - url Public zone URL. The 'zones' settings take precedence.
459 * - hashLevels The number of directory levels for hash-based division of files
460 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
461 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
463 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
464 * determines whether filenames implicitly start with a capital letter.
465 * The current implementation may give incorrect description page links
466 * when the local $wgCapitalLinks and initialCapital are mismatched.
467 * - pathDisclosureProtection
468 * May be 'paranoid' to remove all parameters from error messages, 'none' to
469 * leave the paths in unchanged, or 'simple' to replace paths with
470 * placeholders. Default for LocalRepo is 'simple'.
471 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
473 * - directory The local filesystem directory where public files are stored. Not used for
475 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
476 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
477 * - isPrivate Set this if measures should always be taken to keep the files private.
478 * One should not trust this to assure that the files are not web readable;
479 * the server configuration should be done manually depending on the backend.
481 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
482 * for local repositories:
483 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
484 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
485 * https://en.wikipedia.org/w
486 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
487 * $wgScriptExtension, e.g. ".php5". Defaults to ".php".
489 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
490 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
491 * $wgFetchCommonsDescriptions.
492 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
493 * Short thumbnail names only have the width, parameters, and the extension.
496 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
497 * equivalent to the corresponding member of $wgDBservers
498 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
499 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
502 * - apibase Use for the foreign API's URL
503 * - apiThumbCacheExpiry How long to locally cache thumbs for
505 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
506 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
507 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
508 * If you set $wgForeignFileRepos to an array of repository structures, those will
509 * be searched after the local file repo.
510 * Otherwise, you will only have access to local media files.
512 * @see Setup.php for an example usage and default initialization.
514 $wgLocalFileRepo = false;
517 * @see $wgLocalFileRepo
519 $wgForeignFileRepos = array();
522 * Use Commons as a remote file repository. Essentially a wrapper, when this
523 * is enabled $wgForeignFileRepos will point at Commons with a set of default
526 $wgUseInstantCommons = false;
529 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
530 * are allowable upload targets. These wikis must have some method of
531 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
534 * $wgForeignUploadTargets = array( 'shared' );
536 $wgForeignUploadTargets = array();
539 * File backend structure configuration.
541 * This is an array of file backend configuration arrays.
542 * Each backend configuration has the following parameters:
543 * - 'name' : A unique name for the backend
544 * - 'class' : The file backend class to use
545 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
546 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
548 * See FileBackend::__construct() for more details.
549 * Additional parameters are specific to the file backend class used.
550 * These settings should be global to all wikis when possible.
552 * There are two particularly important aspects about each backend:
553 * - a) Whether it is fully qualified or wiki-relative.
554 * By default, the paths of files are relative to the current wiki,
555 * which works via prefixing them with the current wiki ID when accessed.
556 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
557 * all paths with the specified value instead. This can be useful if
558 * multiple wikis need to share the same data. Note that 'name' is *not*
559 * part of any prefix and thus should not be relied upon for namespacing.
560 * - b) Whether it is only defined for some wikis or is defined on all
561 * wikis in the wiki farm. Defining a backend globally is useful
562 * if multiple wikis need to share the same data.
563 * One should be aware of these aspects when configuring a backend for use with
564 * any basic feature or plugin. For example, suppose an extension stores data for
565 * different wikis in different directories and sometimes needs to access data from
566 * a foreign wiki's directory in order to render a page on given wiki. The extension
567 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
569 $wgFileBackends = array();
572 * Array of configuration arrays for each lock manager.
573 * Each backend configuration has the following parameters:
574 * - 'name' : A unique name for the lock manager
575 * - 'class' : The lock manger class to use
577 * See LockManager::__construct() for more details.
578 * Additional parameters are specific to the lock manager class used.
579 * These settings should be global to all wikis.
581 $wgLockManagers = array();
584 * Show Exif data, on by default if available.
585 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
587 * @note FOR WINDOWS USERS:
588 * To enable Exif functions, add the following lines to the "Windows
589 * extensions" section of php.ini:
591 * extension=extensions/php_mbstring.dll
592 * extension=extensions/php_exif.dll
595 $wgShowEXIF = function_exists( 'exif_read_data' );
598 * If to automatically update the img_metadata field
599 * if the metadata field is outdated but compatible with the current version.
602 $wgUpdateCompatibleMetadata = false;
605 * If you operate multiple wikis, you can define a shared upload path here.
606 * Uploads to this wiki will NOT be put there - they will be put into
607 * $wgUploadDirectory.
608 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
609 * no file of the given name is found in the local repository (for [[File:..]],
610 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
613 * Note that these configuration settings can now be defined on a per-
614 * repository basis for an arbitrary number of file repositories, using the
615 * $wgForeignFileRepos variable.
617 $wgUseSharedUploads = false;
620 * Full path on the web server where shared uploads can be found
622 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
625 * Fetch commons image description pages and display them on the local wiki?
627 $wgFetchCommonsDescriptions = false;
630 * Path on the file system where shared uploads can be found.
632 $wgSharedUploadDirectory = "/var/www/wiki3/images";
635 * DB name with metadata about shared directory.
636 * Set this to false if the uploads do not come from a wiki.
638 $wgSharedUploadDBname = false;
641 * Optional table prefix used in database.
643 $wgSharedUploadDBprefix = '';
646 * Cache shared metadata in memcached.
647 * Don't do this if the commons wiki is in a different memcached domain
649 $wgCacheSharedUploads = true;
652 * Allow for upload to be copied from an URL.
653 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
654 * You have to assign the user right 'upload_by_url' to a user group, to use this.
656 $wgAllowCopyUploads = false;
659 * Allow asynchronous copy uploads.
660 * This feature is experimental and broken as of r81612.
662 $wgAllowAsyncCopyUploads = false;
665 * A list of domains copy uploads can come from
669 $wgCopyUploadsDomains = array();
672 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
673 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
674 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
676 $wgCopyUploadsFromSpecialUpload = false;
679 * Proxy to use for copy upload requests.
682 $wgCopyUploadProxy = false;
685 * Different timeout for upload by url
686 * This could be useful since when fetching large files, you may want a
687 * timeout longer than the default $wgHTTPTimeout. False means fallback
692 $wgCopyUploadTimeout = false;
695 * Different timeout for upload by url when run as a background job
696 * This could be useful since when fetching large files via job queue,
697 * you may want a different timeout, especially because there is no
698 * http request being kept alive.
700 * false means fallback to $wgCopyUploadTimeout.
703 $wgCopyUploadAsyncTimeout = false;
706 * Max size for uploads, in bytes. If not set to an array, applies to all
707 * uploads. If set to an array, per upload type maximums can be set, using the
708 * file and url keys. If the * key is set this value will be used as maximum
709 * for non-specified types.
713 * $wgMaxUploadSize = array(
715 * 'url' => 500 * 1024,
718 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
719 * will have a maximum of 500 kB.
721 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
724 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
725 * chunks smaller than this will be rejected. May be reduced based on the
726 * 'upload_max_filesize' or 'post_max_size' PHP settings.
729 $wgMinUploadChunkSize = 1024; # 1KB
732 * Point the upload navigation link to an external URL
733 * Useful if you want to use a shared repository by default
734 * without disabling local uploads (use $wgEnableUploads = false for that).
738 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
741 $wgUploadNavigationUrl = false;
744 * Point the upload link for missing files to an external URL, as with
745 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
746 * appended to it as appropriate.
748 $wgUploadMissingFileUrl = false;
751 * Give a path here to use thumb.php for thumbnail generation on client
752 * request, instead of generating them on render and outputting a static URL.
753 * This is necessary if some of your apache servers don't have read/write
754 * access to the thumbnail path.
758 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
761 $wgThumbnailScriptPath = false;
764 * @see $wgThumbnailScriptPath
766 $wgSharedThumbnailScriptPath = false;
769 * Set this to false if you do not want MediaWiki to divide your images
770 * directory into many subdirectories, for improved performance.
772 * It's almost always good to leave this enabled. In previous versions of
773 * MediaWiki, some users set this to false to allow images to be added to the
774 * wiki by simply copying them into $wgUploadDirectory and then running
775 * maintenance/rebuildImages.php to register them in the database. This is no
776 * longer recommended, use maintenance/importImages.php instead.
778 * @note That this variable may be ignored if $wgLocalFileRepo is set.
779 * @todo Deprecate the setting and ultimately remove it from Core.
781 $wgHashedUploadDirectory = true;
784 * Set the following to false especially if you have a set of files that need to
785 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
788 $wgHashedSharedUploadDirectory = true;
791 * Base URL for a repository wiki. Leave this blank if uploads are just stored
792 * in a shared directory and not meant to be accessible through a separate wiki.
793 * Otherwise the image description pages on the local wiki will link to the
794 * image description page on this wiki.
796 * Please specify the namespace, as in the example below.
798 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
801 * This is the list of preferred extensions for uploading files. Uploading files
802 * with extensions not in this list will trigger a warning.
804 * @warning If you add any OpenOffice or Microsoft Office file formats here,
805 * such as odt or doc, and untrusted users are allowed to upload files, then
806 * your wiki will be vulnerable to cross-site request forgery (CSRF).
808 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg', 'webp' );
811 * Files with these extensions will never be allowed as uploads.
812 * An array of file extensions to blacklist. You should append to this array
813 * if you want to blacklist additional files.
815 $wgFileBlacklist = array(
816 # HTML may contain cookie-stealing JavaScript and web bugs
817 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
818 # PHP scripts may execute arbitrary code on the server
819 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
820 # Other types that may be interpreted by some servers
821 'shtml', 'jhtml', 'pl', 'py', 'cgi',
822 # May contain harmful executables for Windows victims
823 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
826 * Files with these MIME types will never be allowed as uploads
827 * if $wgVerifyMimeType is enabled.
829 $wgMimeTypeBlacklist = array(
830 # HTML may contain cookie-stealing JavaScript and web bugs
831 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
832 # PHP scripts may execute arbitrary code on the server
833 'application/x-php', 'text/x-php',
834 # Other types that may be interpreted by some servers
835 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
836 # Client-side hazards on Internet Explorer
837 'text/scriptlet', 'application/x-msdownload',
838 # Windows metafile, client-side vulnerability on some systems
839 'application/x-msmetafile',
843 * Allow Java archive uploads.
844 * This is not recommended for public wikis since a maliciously-constructed
845 * applet running on the same domain as the wiki can steal the user's cookies.
847 $wgAllowJavaUploads = false;
850 * This is a flag to determine whether or not to check file extensions on upload.
852 * @warning Setting this to false is insecure for public wikis.
854 $wgCheckFileExtensions = true;
857 * If this is turned off, users may override the warning for files not covered
858 * by $wgFileExtensions.
860 * @warning Setting this to false is insecure for public wikis.
862 $wgStrictFileExtensions = true;
865 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
867 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
868 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
870 $wgDisableUploadScriptChecks = false;
873 * Warn if uploaded files are larger than this (in bytes), or false to disable
875 $wgUploadSizeWarning = false;
878 * list of trusted media-types and MIME types.
879 * Use the MEDIATYPE_xxx constants to represent media types.
880 * This list is used by File::isSafeFile
882 * Types not listed here will have a warning about unsafe content
883 * displayed on the images description page. It would also be possible
884 * to use this for further restrictions, like disabling direct
885 * [[media:...]] links for non-trusted formats.
887 $wgTrustedMediaFormats = array(
888 MEDIATYPE_BITMAP
, // all bitmap formats
889 MEDIATYPE_AUDIO
, // all audio formats
890 MEDIATYPE_VIDEO
, // all plain video formats
891 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
892 "application/pdf", // PDF files
893 # "application/x-shockwave-flash", //flash/shockwave movie
897 * Plugins for media file type handling.
898 * Each entry in the array maps a MIME type to a class name
900 $wgMediaHandlers = array(
901 'image/jpeg' => 'JpegHandler',
902 'image/png' => 'PNGHandler',
903 'image/gif' => 'GIFHandler',
904 'image/tiff' => 'TiffHandler',
905 'image/webp' => 'WebPHandler',
906 'image/x-ms-bmp' => 'BmpHandler',
907 'image/x-bmp' => 'BmpHandler',
908 'image/x-xcf' => 'XCFHandler',
909 'image/svg+xml' => 'SvgHandler', // official
910 'image/svg' => 'SvgHandler', // compat
911 'image/vnd.djvu' => 'DjVuHandler', // official
912 'image/x.djvu' => 'DjVuHandler', // compat
913 'image/x-djvu' => 'DjVuHandler', // compat
917 * Plugins for page content model handling.
918 * Each entry in the array maps a model id to a class name.
922 $wgContentHandlers = array(
924 CONTENT_MODEL_WIKITEXT
=> 'WikitextContentHandler',
925 // dumb version, no syntax highlighting
926 CONTENT_MODEL_JAVASCRIPT
=> 'JavaScriptContentHandler',
927 // simple implementation, for use by extensions, etc.
928 CONTENT_MODEL_JSON
=> 'JsonContentHandler',
929 // dumb version, no syntax highlighting
930 CONTENT_MODEL_CSS
=> 'CssContentHandler',
931 // plain text, for use by extensions, etc.
932 CONTENT_MODEL_TEXT
=> 'TextContentHandler',
936 * Whether to enable server-side image thumbnailing. If false, images will
937 * always be sent to the client in full resolution, with appropriate width= and
938 * height= attributes on the <img> tag for the client to do its own scaling.
940 $wgUseImageResize = true;
943 * Resizing can be done using PHP's internal image libraries or using
944 * ImageMagick or another third-party converter, e.g. GraphicMagick.
945 * These support more file formats than PHP, which only supports PNG,
946 * GIF, JPG, XBM and WBMP.
948 * Use Image Magick instead of PHP builtin functions.
950 $wgUseImageMagick = false;
953 * The convert command shipped with ImageMagick
955 $wgImageMagickConvertCommand = '/usr/bin/convert';
958 * Sharpening parameter to ImageMagick
960 $wgSharpenParameter = '0x0.4';
963 * Reduction in linear dimensions below which sharpening will be enabled
965 $wgSharpenReductionThreshold = 0.85;
968 * Temporary directory used for ImageMagick. The directory must exist. Leave
969 * this set to false to let ImageMagick decide for itself.
971 $wgImageMagickTempDir = false;
974 * Use another resizing converter, e.g. GraphicMagick
975 * %s will be replaced with the source path, %d with the destination
976 * %w and %h will be replaced with the width and height.
978 * @par Example for GraphicMagick:
980 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
983 * Leave as false to skip this.
985 $wgCustomConvertCommand = false;
988 * used for lossless jpeg rotation
992 $wgJpegTran = '/usr/bin/jpegtran';
995 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
998 $wgExiv2Command = '/usr/bin/exiv2';
1002 * Path to exiftool binary. Used for lossless ICC profile swapping.
1006 $wgExiftool = '/usr/bin/exiftool';
1009 * Scalable Vector Graphics (SVG) may be uploaded as images.
1010 * Since SVG support is not yet standard in browsers, it is
1011 * necessary to rasterize SVGs to PNG as a fallback format.
1013 * An external program is required to perform this conversion.
1014 * If set to an array, the first item is a PHP callable and any further items
1015 * are passed as parameters after $srcPath, $dstPath, $width, $height
1017 $wgSVGConverters = array(
1019 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1020 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1021 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1022 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1024 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1025 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1026 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
1030 * Pick a converter defined in $wgSVGConverters
1032 $wgSVGConverter = 'ImageMagick';
1035 * If not in the executable PATH, specify the SVG converter path.
1037 $wgSVGConverterPath = '';
1040 * Don't scale a SVG larger than this
1042 $wgSVGMaxSize = 5120;
1045 * Don't read SVG metadata beyond this point.
1046 * Default is 1024*256 bytes
1048 $wgSVGMetadataCutoff = 262144;
1051 * Disallow <title> element in SVG files.
1053 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1054 * browsers which can not perform basic stuff like MIME detection and which are
1055 * vulnerable to further idiots uploading crap files as images.
1057 * When this directive is on, "<title>" will be allowed in files with an
1058 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1059 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1061 $wgAllowTitlesInSVG = false;
1064 * The maximum number of pixels a source image can have if it is to be scaled
1065 * down by a scaler that requires the full source image to be decompressed
1066 * and stored in decompressed form, before the thumbnail is generated.
1068 * This provides a limit on memory usage for the decompression side of the
1069 * image scaler. The limit is used when scaling PNGs with any of the
1070 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1071 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1073 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1074 * 12.5 million pixels or 3500x3500.
1076 $wgMaxImageArea = 1.25e7
;
1079 * Force thumbnailing of animated GIFs above this size to a single
1080 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1081 * is checked against the total size of all frames in the animation.
1082 * It probably makes sense to keep this equal to $wgMaxImageArea.
1084 $wgMaxAnimatedGifArea = 1.25e7
;
1087 * Browsers don't support TIFF inline generally...
1088 * For inline display, we need to convert to PNG or JPEG.
1089 * Note scaling should work with ImageMagick, but may not with GD scaling.
1093 * // PNG is lossless, but inefficient for photos
1094 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1095 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1096 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1099 $wgTiffThumbnailType = false;
1102 * If rendered thumbnail files are older than this timestamp, they
1103 * will be rerendered on demand as if the file didn't already exist.
1104 * Update if there is some need to force thumbs and SVG rasterizations
1105 * to rerender, such as fixes to rendering bugs.
1107 $wgThumbnailEpoch = '20030516000000';
1110 * Certain operations are avoided if there were too many recent failures,
1111 * for example, thumbnail generation. Bump this value to invalidate all
1112 * memory of failed operations and thus allow further attempts to resume.
1113 * This is useful when a cause for the failures has been found and fixed.
1115 $wgAttemptFailureEpoch = 1;
1118 * If set, inline scaled images will still produce "<img>" tags ready for
1119 * output instead of showing an error message.
1121 * This may be useful if errors are transitory, especially if the site
1122 * is configured to automatically render thumbnails on request.
1124 * On the other hand, it may obscure error conditions from debugging.
1125 * Enable the debug log or the 'thumbnail' log group to make sure errors
1126 * are logged to a file for review.
1128 $wgIgnoreImageErrors = false;
1131 * Allow thumbnail rendering on page view. If this is false, a valid
1132 * thumbnail URL is still output, but no file will be created at
1133 * the target location. This may save some time if you have a
1134 * thumb.php or 404 handler set up which is faster than the regular
1137 $wgGenerateThumbnailOnParse = true;
1140 * Show thumbnails for old images on the image description page
1142 $wgShowArchiveThumbnails = true;
1145 * If set to true, images that contain certain the exif orientation tag will
1146 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1147 * is available that can rotate.
1149 $wgEnableAutoRotation = null;
1152 * Internal name of virus scanner. This serves as a key to the
1153 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1154 * null, every file uploaded will be scanned for viruses.
1156 $wgAntivirus = null;
1159 * Configuration for different virus scanners. This an associative array of
1160 * associative arrays. It contains one setup array per known scanner type.
1161 * The entry is selected by $wgAntivirus, i.e.
1162 * valid values for $wgAntivirus are the keys defined in this array.
1164 * The configuration array for each scanner contains the following keys:
1165 * "command", "codemap", "messagepattern":
1167 * "command" is the full command to call the virus scanner - %f will be
1168 * replaced with the name of the file to scan. If not present, the filename
1169 * will be appended to the command. Note that this must be overwritten if the
1170 * scanner is not in the system path; in that case, please set
1171 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1174 * "codemap" is a mapping of exit code to return codes of the detectVirus
1175 * function in SpecialUpload.
1176 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1177 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1179 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1180 * the file to have an unsupported format, which is probably immune to
1181 * viruses. This causes the file to pass.
1182 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1183 * no virus was found.
1184 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1186 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1188 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1189 * output. The relevant part should be matched as group one (\1).
1190 * If not defined or the pattern does not match, the full message is shown to the user.
1192 $wgAntivirusSetup = array(
1196 'command' => 'clamscan --no-summary ',
1198 "0" => AV_NO_VIRUS
, # no virus
1199 "1" => AV_VIRUS_FOUND
, # virus found
1200 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1201 "*" => AV_SCAN_FAILED
, # else scan failed
1203 'messagepattern' => '/.*?:(.*)/sim',
1208 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1210 $wgAntivirusRequired = true;
1213 * Determines if the MIME type of uploaded files should be checked
1215 $wgVerifyMimeType = true;
1218 * Sets the MIME type definition file to use by MimeMagic.php.
1219 * Set to null, to use built-in defaults only.
1220 * example: $wgMimeTypeFile = '/etc/mime.types';
1222 $wgMimeTypeFile = 'includes/mime.types';
1225 * Sets the MIME type info file to use by MimeMagic.php.
1226 * Set to null, to use built-in defaults only.
1228 $wgMimeInfoFile = 'includes/mime.info';
1231 * Sets an external MIME detector program. The command must print only
1232 * the MIME type to standard output.
1233 * The name of the file to process will be appended to the command given here.
1234 * If not set or NULL, PHP's fileinfo extension will be used if available.
1238 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1241 $wgMimeDetectorCommand = null;
1244 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1245 * things, because only a few types of images are needed and file extensions
1248 $wgTrivialMimeDetection = false;
1251 * Additional XML types we can allow via MIME-detection.
1252 * array = ( 'rootElement' => 'associatedMimeType' )
1254 $wgXMLMimeTypes = array(
1255 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1256 'svg' => 'image/svg+xml',
1257 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1258 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1259 'html' => 'text/html', // application/xhtml+xml?
1263 * Limit images on image description pages to a user-selectable limit. In order
1264 * to reduce disk usage, limits can only be selected from a list.
1265 * The user preference is saved as an array offset in the database, by default
1266 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1267 * change it if you alter the array (see bug 8858).
1268 * This is the list of settings the user can choose from:
1270 $wgImageLimits = array(
1279 * Adjust thumbnails on image pages according to a user setting. In order to
1280 * reduce disk usage, the values can only be selected from a list. This is the
1281 * list of settings the user can choose from:
1283 $wgThumbLimits = array(
1293 * When defined, is an array of image widths used as buckets for thumbnail generation.
1294 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1295 * always using the original. This will incur a speed gain but cause a quality loss.
1297 * The buckets generation is chained, with each bucket generated based on the above bucket
1298 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1301 $wgThumbnailBuckets = null;
1304 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1305 * above the requested size. The distance represents how many extra pixels of width the bucket
1306 * needs in order to be used as the reference for a given thumbnail. For example, with the
1307 * following buckets:
1309 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1311 * and a distance of 50:
1313 * $wgThumbnailMinimumBucketDistance = 50;
1315 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1316 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1318 $wgThumbnailMinimumBucketDistance = 50;
1321 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1322 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1323 * has a performance impact for the first client to view a certain size.
1325 * This obviously means that more disk space is needed per upload upfront.
1330 $wgUploadThumbnailRenderMap = array();
1333 * The method through which the thumbnails will be prerendered for the entries in
1334 * $wgUploadThumbnailRenderMap
1336 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1338 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1339 * option uses the job queue to render the thumbnail.
1343 $wgUploadThumbnailRenderMethod = 'jobqueue';
1346 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1350 $wgUploadThumbnailRenderHttpCustomHost = false;
1353 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1358 $wgUploadThumbnailRenderHttpCustomDomain = false;
1361 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1362 * (and free) TinyRGB profile when generating thumbnails.
1366 $wgUseTinyRGBForJPGThumbnails = false;
1369 * Default parameters for the "<gallery>" tag
1371 $wgGalleryOptions = array(
1372 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1373 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1374 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1375 'captionLength' => 25, // Length of caption to truncate (in characters)
1376 'showBytes' => true, // Show the filesize in bytes in categories
1377 'mode' => 'traditional',
1381 * Adjust width of upright images when parameter 'upright' is used
1382 * This allows a nicer look for upright images without the need to fix the width
1383 * by hardcoded px in wiki sourcecode.
1385 $wgThumbUpright = 0.75;
1388 * Default value for chmoding of new directories.
1390 $wgDirectoryMode = 0777;
1393 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1395 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1396 * thumbnails, output via the srcset attribute.
1398 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1399 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1400 * The polyfill can be found in the jquery.hidpi module.
1402 $wgResponsiveImages = true;
1405 * @name DJVU settings
1410 * Path of the djvudump executable
1411 * Enable this and $wgDjvuRenderer to enable djvu rendering
1412 * example: $wgDjvuDump = 'djvudump';
1417 * Path of the ddjvu DJVU renderer
1418 * Enable this and $wgDjvuDump to enable djvu rendering
1419 * example: $wgDjvuRenderer = 'ddjvu';
1421 $wgDjvuRenderer = null;
1424 * Path of the djvutxt DJVU text extraction utility
1425 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1426 * example: $wgDjvuTxt = 'djvutxt';
1431 * Path of the djvutoxml executable
1432 * This works like djvudump except much, much slower as of version 3.5.
1434 * For now we recommend you use djvudump instead. The djvuxml output is
1435 * probably more stable, so we'll switch back to it as soon as they fix
1436 * the efficiency problem.
1437 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1441 * $wgDjvuToXML = 'djvutoxml';
1444 $wgDjvuToXML = null;
1447 * Shell command for the DJVU post processor
1448 * Default: pnmtojpeg, since ddjvu generates ppm output
1449 * Set this to false to output the ppm file directly.
1451 $wgDjvuPostProcessor = 'pnmtojpeg';
1454 * File extension for the DJVU post processor output
1456 $wgDjvuOutputExtension = 'jpg';
1458 /** @} */ # end of DJvu }
1460 /** @} */ # end of file uploads }
1462 /************************************************************************//**
1463 * @name Email settings
1469 * Site admin email address.
1471 * Defaults to "wikiadmin@$wgServerName".
1473 $wgEmergencyContact = false;
1476 * Password reminder email address.
1478 * The address we should use as sender when a user is requesting his password.
1480 * Defaults to "apache@$wgServerName".
1482 $wgPasswordSender = false;
1485 * Password reminder name
1487 * @deprecated since 1.23; use the system message 'emailsender' instead.
1489 $wgPasswordSenderName = 'MediaWiki Mail';
1492 * Dummy address which should be accepted during mail send action.
1493 * It might be necessary to adapt the address or to set it equal
1494 * to the $wgEmergencyContact address.
1496 $wgNoReplyAddress = 'reply@not.possible';
1499 * Set to true to enable the e-mail basic features:
1500 * Password reminders, etc. If sending e-mail on your
1501 * server doesn't work, you might want to disable this.
1503 $wgEnableEmail = true;
1506 * Set to true to enable user-to-user e-mail.
1507 * This can potentially be abused, as it's hard to track.
1509 $wgEnableUserEmail = true;
1512 * Set to true to put the sending user's email in a Reply-To header
1513 * instead of From. ($wgEmergencyContact will be used as From.)
1515 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1516 * which can cause problems with SPF validation and leak recipient addresses
1517 * when bounces are sent to the sender.
1519 $wgUserEmailUseReplyTo = false;
1522 * Minimum time, in hours, which must elapse between password reminder
1523 * emails for a given account. This is to prevent abuse by mail flooding.
1525 $wgPasswordReminderResendTime = 24;
1528 * The time, in seconds, when an emailed temporary password expires.
1530 $wgNewPasswordExpiry = 3600 * 24 * 7;
1533 * The time, in seconds, when an email confirmation email expires
1535 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1538 * The number of days that a user's password is good for. After this number of days, the
1539 * user will be asked to reset their password. Set to false to disable password expiration.
1541 $wgPasswordExpirationDays = false;
1544 * If a user's password is expired, the number of seconds when they can still login,
1545 * and cancel their password change, but are sent to the password change form on each login.
1547 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1552 * For using a direct (authenticated) SMTP server connection.
1553 * Default to false or fill an array :
1557 * 'host' => 'SMTP domain',
1558 * 'IDHost' => 'domain for MessageID',
1560 * 'auth' => [true|false],
1561 * 'username' => [SMTP username],
1562 * 'password' => [SMTP password],
1569 * Additional email parameters, will be passed as the last argument to mail() call.
1570 * If using safe_mode this has no effect
1572 $wgAdditionalMailParams = null;
1575 * For parts of the system that have been updated to provide HTML email content, send
1576 * both text and HTML parts as the body of the email
1578 $wgAllowHTMLEmail = false;
1581 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1582 * from $wgEmergencyContact
1584 $wgEnotifFromEditor = false;
1586 // TODO move UPO to preferences probably ?
1587 # If set to true, users get a corresponding option in their preferences and can choose to
1588 # enable or disable at their discretion
1589 # If set to false, the corresponding input form on the user preference page is suppressed
1590 # It call this to be a "user-preferences-option (UPO)"
1593 * Require email authentication before sending mail to an email address.
1594 * This is highly recommended. It prevents MediaWiki from being used as an open
1597 $wgEmailAuthentication = true;
1600 * Allow users to enable email notification ("enotif") on watchlist changes.
1602 $wgEnotifWatchlist = false;
1605 * Allow users to enable email notification ("enotif") when someone edits their
1608 $wgEnotifUserTalk = false;
1611 * Set the Reply-to address in notifications to the editor's address, if user
1612 * allowed this in the preferences.
1614 $wgEnotifRevealEditorAddress = false;
1617 * Send notification mails on minor edits to watchlist pages. This is enabled
1618 * by default. User talk notifications are affected by this, $wgEnotifUserTalk, and
1619 * the nominornewtalk user right.
1621 $wgEnotifMinorEdits = true;
1624 * Send a generic mail instead of a personalised mail for each user. This
1625 * always uses UTC as the time zone, and doesn't include the username.
1627 * For pages with many users watching, this can significantly reduce mail load.
1628 * Has no effect when using sendmail rather than SMTP.
1630 $wgEnotifImpersonal = false;
1633 * Maximum number of users to mail at once when using impersonal mail. Should
1634 * match the limit on your mail server.
1636 $wgEnotifMaxRecips = 500;
1639 * Send mails via the job queue. This can be useful to reduce the time it
1640 * takes to save a page that a lot of people are watching.
1642 $wgEnotifUseJobQ = false;
1645 * Use real name instead of username in e-mail "from" field.
1647 $wgEnotifUseRealName = false;
1650 * Array of usernames who will be sent a notification email for every change
1651 * which occurs on a wiki. Users will not be notified of their own changes.
1653 $wgUsersNotifiedOnAllChanges = array();
1655 /** @} */ # end of email settings
1657 /************************************************************************//**
1658 * @name Database settings
1663 * Database host name or IP address
1665 $wgDBserver = 'localhost';
1668 * Database port number (for PostgreSQL and Microsoft SQL Server).
1673 * Name of the database
1675 $wgDBname = 'my_wiki';
1680 $wgDBuser = 'wikiuser';
1683 * Database user's password
1690 $wgDBtype = 'mysql';
1693 * Whether to use SSL in DB connection.
1695 * This setting is only used $wgLBFactoryConf['class'] is set to
1696 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1697 * the DBO_SSL flag must be set in the 'flags' option of the database
1698 * connection to achieve the same functionality.
1703 * Whether to use compression in DB connection.
1705 * This setting is only used $wgLBFactoryConf['class'] is set to
1706 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1707 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1708 * connection to achieve the same functionality.
1710 $wgDBcompress = false;
1713 * Separate username for maintenance tasks. Leave as null to use the default.
1715 $wgDBadminuser = null;
1718 * Separate password for maintenance tasks. Leave as null to use the default.
1720 $wgDBadminpassword = null;
1724 * Leave as null to select the default search engine for the
1725 * selected database type (eg SearchMySQL), or set to a class
1726 * name to override to a custom search engine.
1728 $wgSearchType = null;
1731 * Alternative search types
1732 * Sometimes you want to support multiple search engines for testing. This
1733 * allows users to select their search engine of choice via url parameters
1734 * to Special:Search and the action=search API. If using this, there's no
1735 * need to add $wgSearchType to it, that is handled automatically.
1737 $wgSearchTypeAlternatives = null;
1745 * MySQL table options to use during installation or update
1747 $wgDBTableOptions = 'ENGINE=InnoDB';
1750 * SQL Mode - default is turning off all modes, including strict, if set.
1751 * null can be used to skip the setting for performance reasons and assume
1752 * DBA has done his best job.
1753 * String override can be used for some additional fun :-)
1760 $wgDBmwschema = null;
1763 * To override default SQLite data directory ($docroot/../data)
1765 $wgSQLiteDataDir = '';
1768 * Make all database connections secretly go to localhost. Fool the load balancer
1769 * thinking there is an arbitrarily large cluster of servers to connect to.
1770 * Useful for debugging.
1772 $wgAllDBsAreLocalhost = false;
1775 * Shared database for multiple wikis. Commonly used for storing a user table
1776 * for single sign-on. The server for this database must be the same as for the
1779 * For backwards compatibility the shared prefix is set to the same as the local
1780 * prefix, and the user table is listed in the default list of shared tables.
1781 * The user_properties table is also added so that users will continue to have their
1782 * preferences shared (preferences were stored in the user table prior to 1.16)
1784 * $wgSharedTables may be customized with a list of tables to share in the shared
1785 * database. However it is advised to limit what tables you do share as many of
1786 * MediaWiki's tables may have side effects if you try to share them.
1788 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1791 * $wgSharedSchema is the table schema for the shared database. It defaults to
1794 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1795 * access remote databases. Using wfGetLB() allows the shared database to
1796 * reside on separate servers to the wiki's own database, with suitable
1797 * configuration of $wgLBFactoryConf.
1804 $wgSharedPrefix = false;
1809 $wgSharedTables = array( 'user', 'user_properties' );
1815 $wgSharedSchema = false;
1818 * Database load balancer
1819 * This is a two-dimensional array, an array of server info structures
1822 * - dbname: Default database name
1824 * - password: DB password
1827 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1828 * If this is zero for any given server, no normal query traffic will be
1829 * sent to it. It will be excluded from lag checks in maintenance scripts.
1830 * The only way it can receive traffic is if groupLoads is used.
1832 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1833 * to several groups, the most specific group defined here is used.
1835 * - flags: bit field
1836 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1837 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1838 * - DBO_TRX -- wrap entire request in a transaction
1839 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1840 * - DBO_PERSISTENT -- enables persistent database connections
1841 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1842 * - DBO_COMPRESS -- uses internal compression in database connections,
1845 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1847 * These and any other user-defined properties will be assigned to the mLBInfo member
1848 * variable of the Database object.
1850 * Leave at false to use the single-server variables above. If you set this
1851 * variable, the single-server variables will generally be ignored (except
1852 * perhaps in some command-line scripts).
1854 * The first server listed in this array (with key 0) will be the master. The
1855 * rest of the servers will be slaves. To prevent writes to your slaves due to
1856 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1857 * slaves in my.cnf. You can set read_only mode at runtime using:
1860 * SET @@read_only=1;
1863 * Since the effect of writing to a slave is so damaging and difficult to clean
1864 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1865 * our masters, and then set read_only=0 on masters at runtime.
1867 $wgDBservers = false;
1870 * Load balancer factory configuration
1871 * To set up a multi-master wiki farm, set the class here to something that
1872 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1873 * The class identified here is responsible for reading $wgDBservers,
1874 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1876 * The LBFactoryMulti class is provided for this purpose, please see
1877 * includes/db/LBFactoryMulti.php for configuration information.
1879 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1882 * The ID of the current data center
1885 $wgDataCenterId = 'default';
1888 * Map of data center IDs to their role ("master" or "slave")
1890 * Multiple data centers can be setup to handle MediaWiki, with HTTP
1891 * POSTs routed to the master data center and GET/HEAD/OPTION routed to
1892 * any data center (usually the closest to the end user). In such setups,
1893 * this setting should be set to the appropriate value in the site
1894 * config for each data center.
1897 $wgDataCenterRoles = array( 'default' => 'master' );
1900 * After a state-changing request is done by a client, this determines
1901 * how many seconds that client should keep using the master datacenter.
1902 * This avoids unexpected stale or 404 responses due to replication lag.
1905 $wgDataCenterUpdateStickTTL = 10;
1908 * File to log database errors to
1910 $wgDBerrorLog = false;
1913 * Timezone to use in the error log.
1914 * Defaults to the wiki timezone ($wgLocaltimezone).
1916 * A list of usable timezones can found at:
1917 * http://php.net/manual/en/timezones.php
1921 * $wgDBerrorLogTZ = 'UTC';
1922 * $wgDBerrorLogTZ = 'GMT';
1923 * $wgDBerrorLogTZ = 'PST8PDT';
1924 * $wgDBerrorLogTZ = 'Europe/Sweden';
1925 * $wgDBerrorLogTZ = 'CET';
1930 $wgDBerrorLogTZ = false;
1933 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1934 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1936 * @warning THIS IS EXPERIMENTAL!
1938 * May break if you're not using the table defs from mysql5/tables.sql.
1939 * May break if you're upgrading an existing wiki if set differently.
1940 * Broken symptoms likely to include incorrect behavior with page titles,
1941 * usernames, comments etc containing non-ASCII characters.
1942 * Might also cause failures on the object cache and other things.
1944 * Even correct usage may cause failures with Unicode supplementary
1945 * characters (those not in the Basic Multilingual Plane) unless MySQL
1946 * has enhanced their Unicode support.
1948 $wgDBmysql5 = false;
1951 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1953 * To use this feature set to true and use a datasource defined as
1954 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1957 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1958 * Pool) that maintains established sessions and reuses them on new
1961 * Not completely tested, but it should fall back on normal connection
1962 * in case the pool is full or the datasource is not configured as
1964 * And the other way around; using oci_pconnect on a non pooled
1965 * datasource should produce a normal connection.
1967 * When it comes to frequent shortlived DB connections like with MW
1968 * Oracle tends to s***. The problem is the driver connects to the
1969 * database reasonably fast, but establishing a session takes time and
1970 * resources. MW does not rely on session state (as it does not use
1971 * features such as package variables) so establishing a valid session
1972 * is in this case an unwanted overhead that just slows things down.
1974 * @warning EXPERIMENTAL!
1977 $wgDBOracleDRCP = false;
1980 * Other wikis on this site, can be administered from a single developer
1982 * Array numeric key => database name
1984 $wgLocalDatabases = array();
1987 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1988 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1989 * show a more obvious warning.
1991 $wgSlaveLagWarning = 10;
1994 * @see $wgSlaveLagWarning
1996 $wgSlaveLagCritical = 30;
1999 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2001 $wgDBWindowsAuthentication = false;
2003 /**@}*/ # End of DB settings }
2005 /************************************************************************//**
2006 * @name Text storage
2011 * We can also compress text stored in the 'text' table. If this is set on, new
2012 * revisions will be compressed on page save if zlib support is available. Any
2013 * compressed revisions will be decompressed on load regardless of this setting,
2014 * but will not be readable at all* if zlib support is not available.
2016 $wgCompressRevisions = false;
2019 * External stores allow including content
2020 * from non database sources following URL links.
2022 * Short names of ExternalStore classes may be specified in an array here:
2024 * $wgExternalStores = array("http","file","custom")...
2027 * CAUTION: Access to database might lead to code execution
2029 $wgExternalStores = array();
2032 * An array of external MySQL servers.
2035 * Create a cluster named 'cluster1' containing three servers:
2037 * $wgExternalServers = array(
2038 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
2042 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2045 $wgExternalServers = array();
2048 * The place to put new revisions, false to put them in the local text table.
2049 * Part of a URL, e.g. DB://cluster1
2051 * Can be an array instead of a single string, to enable data distribution. Keys
2052 * must be consecutive integers, starting at zero.
2056 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
2061 $wgDefaultExternalStore = false;
2064 * Revision text may be cached in $wgMemc to reduce load on external storage
2065 * servers and object extraction overhead for frequently-loaded revisions.
2067 * Set to 0 to disable, or number of seconds before cache expiry.
2069 $wgRevisionCacheExpiry = 0;
2071 /** @} */ # end text storage }
2073 /************************************************************************//**
2074 * @name Performance hacks and limits
2079 * Disable database-intensive features
2081 $wgMiserMode = false;
2084 * Disable all query pages if miser mode is on, not just some
2086 $wgDisableQueryPages = false;
2089 * Number of rows to cache in 'querycache' table when miser mode is on
2091 $wgQueryCacheLimit = 1000;
2094 * Number of links to a page required before it is deemed "wanted"
2096 $wgWantedPagesThreshold = 1;
2099 * Enable slow parser functions
2101 $wgAllowSlowParserFunctions = false;
2104 * Allow schema updates
2106 $wgAllowSchemaUpdates = true;
2109 * Maximum article size in kilobytes
2111 $wgMaxArticleSize = 2048;
2114 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2115 * raise PHP's memory limit if it's below this amount.
2117 $wgMemoryLimit = "50M";
2120 * The minimum amount of time that MediaWiki needs for "slow" write request,
2121 * particularly ones with multiple non-atomic writes that *should* be as
2122 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2125 $wgTransactionalTimeLimit = 120;
2127 /** @} */ # end performance hacks }
2129 /************************************************************************//**
2130 * @name Cache settings
2135 * Directory for caching data in the local filesystem. Should not be accessible
2136 * from the web. Set this to false to not use any local caches.
2138 * Note: if multiple wikis share the same localisation cache directory, they
2139 * must all have the same set of extensions. You can set a directory just for
2140 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2142 $wgCacheDirectory = false;
2145 * Main cache type. This should be a cache with fast access, but it may have
2146 * limited space. By default, it is disabled, since the stock database cache
2147 * is not fast enough to make it worthwhile.
2151 * - CACHE_ANYTHING: Use anything, as long as it works
2152 * - CACHE_NONE: Do not cache
2153 * - CACHE_DB: Store cache objects in the DB
2154 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2155 * - CACHE_ACCEL: APC, XCache or WinCache
2156 * - (other): A string may be used which identifies a cache
2157 * configuration in $wgObjectCaches.
2159 * @see $wgMessageCacheType, $wgParserCacheType
2161 $wgMainCacheType = CACHE_NONE
;
2164 * The cache type for storing the contents of the MediaWiki namespace. This
2165 * cache is used for a small amount of data which is expensive to regenerate.
2167 * For available types see $wgMainCacheType.
2169 $wgMessageCacheType = CACHE_ANYTHING
;
2172 * The cache type for storing article HTML. This is used to store data which
2173 * is expensive to regenerate, and benefits from having plenty of storage space.
2175 * For available types see $wgMainCacheType.
2177 $wgParserCacheType = CACHE_ANYTHING
;
2180 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2182 * For available types see $wgMainCacheType.
2184 $wgSessionCacheType = CACHE_ANYTHING
;
2187 * The cache type for storing language conversion tables,
2188 * which are used when parsing certain text and interface messages.
2190 * For available types see $wgMainCacheType.
2194 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2197 * Advanced object cache configuration.
2199 * Use this to define the class names and constructor parameters which are used
2200 * for the various cache types. Custom cache types may be defined here and
2201 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2202 * or $wgLanguageConverterCacheType.
2204 * The format is an associative array where the key is a cache identifier, and
2205 * the value is an associative array of parameters. The "class" parameter is the
2206 * class name which will be used. Alternatively, a "factory" parameter may be
2207 * given, giving a callable function which will generate a suitable cache object.
2209 $wgObjectCaches = array(
2210 CACHE_NONE
=> array( 'class' => 'EmptyBagOStuff' ),
2211 CACHE_DB
=> array( 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ),
2213 CACHE_ANYTHING
=> array( 'factory' => 'ObjectCache::newAnything' ),
2214 CACHE_ACCEL
=> array( 'factory' => 'ObjectCache::getLocalServerInstance' ),
2215 CACHE_MEMCACHED
=> array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2217 'db-replicated' => array(
2218 'class' => 'ReplicatedBagOStuff',
2219 'readFactory' => array(
2220 'class' => 'SqlBagOStuff',
2221 'args' => array( array( 'slaveOnly' => true ) )
2223 'writeFactory' => array(
2224 'class' => 'SqlBagOStuff',
2225 'args' => array( array( 'slaveOnly' => false ) )
2227 'loggroup' => 'SQLBagOStuff'
2230 'apc' => array( 'class' => 'APCBagOStuff' ),
2231 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2232 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2233 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ),
2234 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ),
2235 'hash' => array( 'class' => 'HashBagOStuff' ),
2239 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2240 * but it may have limited space. By default, it is disabled, since the basic stock
2241 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2242 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2243 * cache with a relayer of type EventRelayerNull.
2246 * - false: Configure the cache using $wgMainCacheType, without using
2247 * a relayer (only matters if there are multiple data-centers)
2248 * - CACHE_NONE: Do not cache
2249 * - (other): A string may be used which identifies a cache
2250 * configuration in $wgWANObjectCaches
2253 $wgMainWANCache = false;
2256 * Advanced WAN object cache configuration.
2258 * Each WAN cache wraps a registered object cache (for the local cluster)
2259 * and it must also be configured to point to a PubSub instance. Subscribers
2260 * must be configured to relay purges to the actual cache servers.
2262 * The format is an associative array where the key is a cache identifier, and
2263 * the value is an associative array of parameters. The "cacheId" parameter is
2264 * a cache identifier from $wgObjectCaches. The "relayerConfig" parameter is an
2265 * array used to construct an EventRelayer object. The "pool" parameter is a
2266 * string that is used as a PubSub channel prefix. The "loggroup" parameter
2267 * controls where log events are sent.
2271 $wgWANObjectCaches = array(
2272 CACHE_NONE
=> array(
2273 'class' => 'WANObjectCache',
2274 'cacheId' => CACHE_NONE
,
2275 'pool' => 'mediawiki-main-none',
2276 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2278 /* Example of a simple single data-center cache:
2279 'memcached-php' => array(
2280 'class' => 'WANObjectCache',
2281 'cacheId' => 'memcached-php',
2282 'pool' => 'mediawiki-main-memcached',
2283 'relayerConfig' => array( 'class' => 'EventRelayerNull' )
2289 * Main object stash type. This should be a fast storage system for storing
2290 * lightweight data like hit counters and user activity. Sites with multiple
2291 * data-centers should have this use a store that replicates all writes. The
2292 * store should have enough consistency for CAS operations to be usable.
2293 * Reads outside of those needed for merge() may be eventually consistent.
2296 * - db: Store cache objects in the DB
2297 * - (other): A string may be used which identifies a cache
2298 * configuration in $wgObjectCaches
2302 $wgMainStash = 'db-replicated';
2305 * The expiry time for the parser cache, in seconds.
2306 * The default is 86400 (one day).
2308 $wgParserCacheExpireTime = 86400;
2311 * Deprecated alias for $wgSessionsInObjectCache.
2313 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2315 $wgSessionsInMemcached = false;
2318 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2319 * can be useful to improve performance, or to avoid the locking behavior of
2320 * PHP's default session handler, which tends to prevent multiple requests for
2321 * the same user from acting concurrently.
2323 $wgSessionsInObjectCache = false;
2326 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2327 * enabled, in seconds.
2329 $wgObjectCacheSessionExpiry = 3600;
2332 * This is used for setting php's session.save_handler. In practice, you will
2333 * almost never need to change this ever. Other options might be 'user' or
2334 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2335 * useful if you're doing cross-application sessions, see bug 11381)
2337 $wgSessionHandler = null;
2340 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2342 $wgMemCachedDebug = false;
2345 * The list of MemCached servers and port numbers
2347 $wgMemCachedServers = array( '127.0.0.1:11211' );
2350 * Use persistent connections to MemCached, which are shared across multiple
2353 $wgMemCachedPersistent = false;
2356 * Read/write timeout for MemCached server communication, in microseconds.
2358 $wgMemCachedTimeout = 500000;
2361 * Set this to true to maintain a copy of the message cache on the local server.
2363 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2365 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2367 * Note that this is about the message cache, which stores interface messages
2368 * maintained as wiki pages. This is separate from the localisation cache for interface
2369 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2371 $wgUseLocalMessageCache = false;
2374 * Instead of caching everything, only cache those messages which have
2375 * been customised in the site content language. This means that
2376 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2377 * This option is probably only useful for translatewiki.net.
2379 $wgAdaptiveMessageCache = false;
2382 * Localisation cache configuration. Associative array with keys:
2383 * class: The class to use. May be overridden by extensions.
2385 * store: The location to store cache data. May be 'files', 'array', 'db' or
2386 * 'detect'. If set to "files", data will be in CDB files. If set
2387 * to "db", data will be stored to the database. If set to
2388 * "detect", files will be used if $wgCacheDirectory is set,
2389 * otherwise the database will be used.
2390 * "array" is an experimental option that uses PHP files that
2391 * store static arrays.
2393 * storeClass: The class name for the underlying storage. If set to a class
2394 * name, it overrides the "store" setting.
2396 * storeDirectory: If the store class puts its data in files, this is the
2397 * directory it will use. If this is false, $wgCacheDirectory
2400 * manualRecache: Set this to true to disable cache updates on web requests.
2401 * Use maintenance/rebuildLocalisationCache.php instead.
2403 $wgLocalisationCacheConf = array(
2404 'class' => 'LocalisationCache',
2405 'store' => 'detect',
2406 'storeClass' => false,
2407 'storeDirectory' => false,
2408 'manualRecache' => false,
2412 * Allow client-side caching of pages
2414 $wgCachePages = true;
2417 * Set this to current time to invalidate all prior cached pages. Affects both
2418 * client-side and server-side caching.
2419 * You can get the current date on your server by using the command:
2421 * date +%Y%m%d%H%M%S
2424 $wgCacheEpoch = '20030516000000';
2427 * Directory where GitInfo will look for pre-computed cache files. If false,
2428 * $wgCacheDirectory/gitinfo will be used.
2430 $wgGitInfoCacheDirectory = false;
2433 * Bump this number when changing the global style sheets and JavaScript.
2435 * It should be appended in the query string of static CSS and JS includes,
2436 * to ensure that client-side caches do not keep obsolete copies of global
2439 $wgStyleVersion = '303';
2442 * This will cache static pages for non-logged-in users to reduce
2443 * database traffic on public sites. ResourceLoader requests to default
2444 * language and skins are cached as well as single module requests.
2446 $wgUseFileCache = false;
2449 * Depth of the subdirectory hierarchy to be created under
2450 * $wgFileCacheDirectory. The subdirectories will be named based on
2451 * the MD5 hash of the title. A value of 0 means all cache files will
2452 * be put directly into the main file cache directory.
2454 $wgFileCacheDepth = 2;
2457 * Kept for extension compatibility; see $wgParserCacheType
2460 $wgEnableParserCache = true;
2463 * Append a configured value to the parser cache and the sitenotice key so
2464 * that they can be kept separate for some class of activity.
2466 $wgRenderHashAppend = '';
2469 * If on, the sidebar navigation links are cached for users with the
2470 * current language set. This can save a touch of load on a busy site
2471 * by shaving off extra message lookups.
2473 * However it is also fragile: changing the site configuration, or
2474 * having a variable $wgArticlePath, can produce broken links that
2475 * don't update as expected.
2477 $wgEnableSidebarCache = false;
2480 * Expiry time for the sidebar cache, in seconds
2482 $wgSidebarCacheExpiry = 86400;
2485 * When using the file cache, we can store the cached HTML gzipped to save disk
2486 * space. Pages will then also be served compressed to clients that support it.
2488 * Requires zlib support enabled in PHP.
2493 * Whether MediaWiki should send an ETag header. Seems to cause
2494 * broken behavior with Squid 2.6, see bug 7098.
2499 * Clock skew or the one-second resolution of time() can occasionally cause cache
2500 * problems when the user requests two pages within a short period of time. This
2501 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2504 $wgClockSkewFudge = 5;
2507 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2508 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2509 * was previously done in the default LocalSettings.php file.
2511 * On high-traffic wikis, this should be set to false, to avoid the need to
2512 * check the file modification time, and to avoid the performance impact of
2513 * unnecessary cache invalidations.
2515 $wgInvalidateCacheOnLocalSettingsChange = true;
2518 * When loading extensions through the extension registration system, this
2519 * can be used to invalidate the cache. A good idea would be to set this to
2520 * one file, you can just `touch` that one to invalidate the cache
2524 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2527 * If set to false, the mtime for each individual JSON file will be checked,
2528 * which can be slow if a large number of extensions are being loaded.
2532 $wgExtensionInfoMTime = false;
2534 /** @} */ # end of cache settings
2536 /************************************************************************//**
2537 * @name HTTP proxy (Squid) settings
2539 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2540 * although they are referred to as Squid settings for historical reasons.
2542 * Achieving a high hit ratio with an HTTP proxy requires special
2543 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2550 * Enable/disable Squid.
2551 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2553 $wgUseSquid = false;
2556 * If you run Squid3 with ESI support, enable this (default:false):
2561 * Send the Key HTTP header for better caching.
2562 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2565 $wgUseKeyHeader = false;
2568 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2569 * RSS/Atom feeds. Use this if you have an SSL termination setup
2570 * and need to split the cache between HTTP and HTTPS for API requests,
2571 * feed requests and HTTP redirect responses in order to prevent cache
2572 * pollution. This does not affect 'normal' requests to index.php other than
2575 $wgVaryOnXFP = false;
2578 * Internal server name as known to Squid, if different.
2582 * $wgInternalServer = 'http://yourinternal.tld:8000';
2585 $wgInternalServer = false;
2588 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2589 * Surrogate-Control (with ESI). Without ESI, you should strip
2590 * out s-maxage in the Squid config.
2592 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2594 $wgSquidMaxage = 18000;
2597 * Cache timeout for the CDN when DB slave lag is high
2598 * @see $wgSquidMaxage
2601 $wgCdnMaxageLagged = 30;
2604 * Default maximum age for raw CSS/JS accesses
2606 * 300 seconds = 5 minutes.
2608 $wgForcedRawSMaxage = 300;
2611 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2613 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2614 * headers sent/modified from these proxies when obtaining the remote IP address
2616 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2618 $wgSquidServers = array();
2621 * As above, except these servers aren't purged on page changes; use to set a
2622 * list of trusted proxies, etc. Supports both individual IP addresses and
2624 * @since 1.23 Supports CIDR ranges
2626 $wgSquidServersNoPurge = array();
2629 * Whether to use a Host header in purge requests sent to the proxy servers
2630 * configured in $wgSquidServers. Set this to false to support Squid
2631 * configured in forward-proxy mode.
2633 * If this is set to true, a Host header will be sent, and only the path
2634 * component of the URL will appear on the request line, as if the request
2635 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2636 * request. Squid supports this style of request only if reverse-proxy mode
2637 * (http_port ... accel) is enabled.
2639 * If this is set to false, no Host header will be sent, and the absolute URL
2640 * will be sent in the request line, as is the standard for an HTTP proxy
2641 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2642 * by Varnish, but is supported by Squid in either configuration (forward or
2647 $wgSquidPurgeUseHostHeader = true;
2650 * Routing configuration for HTCP multicast purging. Add elements here to
2651 * enable HTCP and determine which purges are sent where. If set to an empty
2652 * array, HTCP is disabled.
2654 * Each key in this array is a regular expression to match against the purged
2655 * URL, or an empty string to match all URLs. The purged URL is matched against
2656 * the regexes in the order specified, and the first rule whose regex matches
2657 * is used, all remaining rules will thus be ignored.
2659 * @par Example configuration to send purges for upload.wikimedia.org to one
2660 * multicast group and all other purges to another:
2662 * $wgHTCPRouting = array(
2663 * '|^https?://upload\.wikimedia\.org|' => array(
2664 * 'host' => '239.128.0.113',
2668 * 'host' => '239.128.0.112',
2674 * You can also pass an array of hosts to send purges too. This is useful when
2675 * you have several multicast groups or unicast address that should receive a
2676 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2678 * @par Example of sending purges to multiple hosts:
2680 * $wgHTCPRouting = array(
2682 * // Purges to text caches using multicast
2683 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2684 * // Purges to a hardcoded list of caches
2685 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2686 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2687 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2694 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2695 * For back compatibility purposes, whenever its array is empty
2696 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2698 * @see $wgHTCPMulticastTTL
2700 $wgHTCPRouting = array();
2703 * HTCP multicast TTL.
2704 * @see $wgHTCPRouting
2706 $wgHTCPMulticastTTL = 1;
2709 * Should forwarded Private IPs be accepted?
2711 $wgUsePrivateIPs = false;
2713 /** @} */ # end of HTTP proxy settings
2715 /************************************************************************//**
2716 * @name Language, regional and character encoding settings
2721 * Site language code. See languages/Names.php for languages supported by
2722 * MediaWiki out of the box. Not all languages listed there have translations,
2723 * see languages/messages/ for the list of languages with some localisation.
2725 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2726 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2728 * This defines the default interface language for all users, but users can
2729 * change it in their preferences.
2731 * This also defines the language of pages in the wiki. The content is wrapped
2732 * in a html element with lang=XX attribute. This behavior can be overridden
2733 * via hooks, see Title::getPageLanguage.
2735 $wgLanguageCode = 'en';
2738 * Language cache size, or really how many languages can we handle
2739 * simultaneously without degrading to crawl speed.
2741 $wgLangObjCacheSize = 10;
2744 * Some languages need different word forms, usually for different cases.
2745 * Used in Language::convertGrammar().
2749 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2752 $wgGrammarForms = array();
2755 * Treat language links as magic connectors, not inline links
2757 $wgInterwikiMagic = true;
2760 * Hide interlanguage links from the sidebar
2762 $wgHideInterlanguageLinks = false;
2765 * List of additional interwiki prefixes that should be treated as
2766 * interlanguage links (i.e. placed in the sidebar).
2768 * - This will not do anything unless the prefixes are defined in the interwiki
2770 * - The display text for these custom interlanguage links will be fetched from
2771 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2773 * - A friendly name for each site, used for tooltip text, may optionally be
2774 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2775 * the prefix in this array.
2777 $wgExtraInterlanguageLinkPrefixes = array();
2780 * List of language names or overrides for default names in Names.php
2782 $wgExtraLanguageNames = array();
2785 * List of language codes that don't correspond to an actual language.
2786 * These codes are mostly left-offs from renames, or other legacy things.
2787 * This array makes them not appear as a selectable language on the installer,
2788 * and excludes them when running the transstat.php script.
2790 $wgDummyLanguageCodes = array(
2793 'be-x-old' => 'be-tarask',
2797 'qqq' => 'qqq', # Used for message documentation.
2798 'qqx' => 'qqx', # Used for viewing message keys.
2801 'zh-classical' => 'lzh',
2802 'zh-min-nan' => 'nan',
2807 * Character set for use in the article edit box. Language-specific encodings
2810 * This historic feature is one of the first that was added by former MediaWiki
2811 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2813 $wgEditEncoding = '';
2816 * Set this to true to replace Arabic presentation forms with their standard
2817 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2820 * Note that pages with titles containing presentation forms will become
2821 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2823 $wgFixArabicUnicode = true;
2826 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2827 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2828 * set to "ml". Note that some clients (even new clients as of 2010) do not
2829 * support these characters.
2831 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2832 * fix any ZWJ sequences in existing page titles.
2834 $wgFixMalayalamUnicode = true;
2837 * Set this to always convert certain Unicode sequences to modern ones
2838 * regardless of the content language. This has a small performance
2841 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2846 $wgAllUnicodeFixes = false;
2849 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2850 * loading old revisions not marked with "utf-8" flag. Use this when
2851 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2852 * burdensome mass conversion of old text data.
2854 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2855 * user names, etc still must be converted en masse in the database before
2856 * continuing as a UTF-8 wiki.
2858 $wgLegacyEncoding = false;
2861 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2862 * regexps : "/regexp/" matching problematic browsers. These browsers will
2863 * be served encoded unicode in the edit box instead of real unicode.
2865 $wgBrowserBlackList = array(
2867 * Netscape 2-4 detection
2868 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2869 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2870 * with a negative assertion. The [UIN] identifier specifies the level of security
2871 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2872 * The language string is unreliable, it is missing on NS4 Mac.
2874 * Reference: http://www.psychedelix.com/agents/index.shtml
2876 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2877 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2878 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2881 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2882 * Þ to <THORN> and Ð to <ETH>
2885 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2886 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2887 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2890 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2891 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2893 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2896 * Google wireless transcoder, seems to eat a lot of chars alive
2897 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2899 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2903 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2904 * create stub reference rows in the text table instead of copying
2905 * the full text of all current entries from 'cur' to 'text'.
2907 * This will speed up the conversion step for large sites, but
2908 * requires that the cur table be kept around for those revisions
2909 * to remain viewable.
2911 * This option affects the updaters *only*. Any present cur stub
2912 * revisions will be readable at runtime regardless of this setting.
2914 $wgLegacySchemaConversion = false;
2917 * Enable dates like 'May 12' instead of '12 May', if the default date format
2920 $wgAmericanDates = false;
2923 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2924 * numerals in interface.
2926 $wgTranslateNumerals = true;
2929 * Translation using MediaWiki: namespace.
2930 * Interface messages will be loaded from the database.
2932 $wgUseDatabaseMessages = true;
2935 * Expiry time for the message cache key
2937 $wgMsgCacheExpiry = 86400;
2940 * Maximum entry size in the message cache, in bytes
2942 $wgMaxMsgCacheEntrySize = 10000;
2945 * Whether to enable language variant conversion.
2947 $wgDisableLangConversion = false;
2950 * Whether to enable language variant conversion for links.
2952 $wgDisableTitleConversion = false;
2955 * Default variant code, if false, the default will be the language code
2957 $wgDefaultLanguageVariant = false;
2960 * Disabled variants array of language variant conversion.
2964 * $wgDisabledVariants[] = 'zh-mo';
2965 * $wgDisabledVariants[] = 'zh-my';
2968 $wgDisabledVariants = array();
2971 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2972 * path format that describes which parts of the URL contain the
2977 * $wgLanguageCode = 'sr';
2978 * $wgVariantArticlePath = '/$2/$1';
2979 * $wgArticlePath = '/wiki/$1';
2982 * A link to /wiki/ would be redirected to /sr/Главна_страна
2984 * It is important that $wgArticlePath not overlap with possible values
2985 * of $wgVariantArticlePath.
2987 $wgVariantArticlePath = false;
2990 * Show a bar of language selection links in the user login and user
2991 * registration forms; edit the "loginlanguagelinks" message to
2994 $wgLoginLanguageSelector = false;
2997 * When translating messages with wfMessage(), it is not always clear what
2998 * should be considered UI messages and what should be content messages.
3000 * For example, for the English Wikipedia, there should be only one 'mainpage',
3001 * so when getting the link for 'mainpage', we should treat it as site content
3002 * and call ->inContentLanguage()->text(), but for rendering the text of the
3003 * link, we call ->text(). The code behaves this way by default. However,
3004 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3005 * and the like for different languages. This array provides a way to override
3006 * the default behavior.
3009 * To allow language-specific main page and community
3012 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
3015 $wgForceUIMsgAsContentMsg = array();
3018 * Fake out the timezone that the server thinks it's in. This will be used for
3019 * date display and not for what's stored in the DB. Leave to null to retain
3020 * your server's OS-based timezone value.
3022 * This variable is currently used only for signature formatting and for local
3023 * time/date parser variables ({{LOCALTIME}} etc.)
3025 * Timezones can be translated by editing MediaWiki messages of type
3026 * timezone-nameinlowercase like timezone-utc.
3028 * A list of usable timezones can found at:
3029 * http://php.net/manual/en/timezones.php
3033 * $wgLocaltimezone = 'UTC';
3034 * $wgLocaltimezone = 'GMT';
3035 * $wgLocaltimezone = 'PST8PDT';
3036 * $wgLocaltimezone = 'Europe/Sweden';
3037 * $wgLocaltimezone = 'CET';
3040 $wgLocaltimezone = null;
3043 * Set an offset from UTC in minutes to use for the default timezone setting
3044 * for anonymous users and new user accounts.
3046 * This setting is used for most date/time displays in the software, and is
3047 * overridable in user preferences. It is *not* used for signature timestamps.
3049 * By default, this will be set to match $wgLocaltimezone.
3051 $wgLocalTZoffset = null;
3053 /** @} */ # End of language/charset settings
3055 /*************************************************************************//**
3056 * @name Output format and skin settings
3061 * The default Content-Type header.
3063 $wgMimeType = 'text/html';
3066 * Previously used as content type in HTML script tags. This is now ignored since
3067 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3068 * It was also previously used by RawAction to determine the ctype query parameter
3069 * value that will result in a javascript response.
3070 * @deprecated since 1.22
3072 $wgJsMimeType = null;
3075 * The default xmlns attribute. The option to define this has been removed.
3076 * The value of this variable is no longer used by core and is set to a fixed
3077 * value in Setup.php for compatibility with extensions that depend on the value
3078 * of this variable being set. Such a dependency however is deprecated.
3079 * @deprecated since 1.22
3081 $wgXhtmlDefaultNamespace = null;
3084 * Previously used to determine if we should output an HTML5 doctype.
3085 * This is no longer used as we always output HTML5 now. For compatibility with
3086 * extensions that still check the value of this config it's value is now forced
3087 * to true by Setup.php.
3088 * @deprecated since 1.22
3093 * Defines the value of the version attribute in the <html> tag, if any.
3094 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
3095 * (like if it's left at the default null value), it will be auto-initialized
3096 * to the correct value for RDFa+HTML5. As such, you should have no reason to
3097 * ever actually set this to anything.
3099 $wgHtml5Version = null;
3102 * Temporary variable that allows HTMLForms to be rendered as tables.
3103 * Table based layouts cause various issues when designing for mobile.
3104 * This global allows skins or extensions a means to force non-table based rendering.
3105 * Setting to false forces form components to always render as div elements.
3108 $wgHTMLFormAllowTableFormat = true;
3111 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3112 * Temporary variable that should be removed when mediawiki ui is more
3113 * stable and change has been communicated.
3116 $wgUseMediaWikiUIEverywhere = false;
3119 * Enabled RDFa attributes for use in wikitext.
3120 * NOTE: Interaction with HTML5 is somewhat underspecified.
3122 $wgAllowRdfaAttributes = false;
3125 * Enabled HTML5 microdata attributes for use in wikitext.
3127 $wgAllowMicrodataAttributes = false;
3130 * Should we try to make our HTML output well-formed XML? If set to false,
3131 * output will be a few bytes shorter, and the HTML will arguably be more
3132 * readable. If set to true, life will be much easier for the authors of
3133 * screen-scraping bots, and the HTML will arguably be more readable.
3135 * Setting this to false may omit quotation marks on some attributes, omit
3136 * slashes from some self-closing tags, omit some ending tags, etc., where
3137 * permitted by HTML5. Setting it to true will not guarantee that all pages
3138 * will be well-formed, although non-well-formed pages should be rare and it's
3139 * a bug if you find one. Conversely, setting it to false doesn't mean that
3140 * all XML-y constructs will be omitted, just that they might be.
3142 * Because of compatibility with screen-scraping bots, and because it's
3143 * controversial, this is currently left to true by default.
3145 $wgWellFormedXml = true;
3148 * Permit other namespaces in addition to the w3.org default.
3150 * Use the prefix for the key and the namespace for the value.
3154 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3156 * Normally we wouldn't have to define this in the root "<html>"
3157 * element, but IE needs it there in some circumstances.
3159 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3161 $wgXhtmlNamespaces = array();
3164 * Site notice shown at the top of each page
3166 * MediaWiki:Sitenotice page, which will override this. You can also
3167 * provide a separate message for logged-out users using the
3168 * MediaWiki:Anonnotice page.
3173 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3175 $wgSiteSupportPage = '';
3178 * Validate the overall output using tidy and refuse
3179 * to display the page if it's not valid.
3181 $wgValidateAllHtml = false;
3184 * Default skin, for new users and anonymous visitors. Registered users may
3185 * change this to any one of the other available skins in their preferences.
3187 $wgDefaultSkin = 'vector';
3190 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3194 $wgFallbackSkin = 'fallback';
3197 * Specify the names of skins that should not be presented in the list of
3198 * available skins in user preferences. If you want to remove a skin entirely,
3199 * remove it from the skins/ directory and its entry from LocalSettings.php.
3201 $wgSkipSkins = array();
3204 * @deprecated since 1.23; use $wgSkipSkins instead
3209 * Allow user Javascript page?
3210 * This enables a lot of neat customizations, but may
3211 * increase security risk to users and server load.
3213 $wgAllowUserJs = false;
3216 * Allow user Cascading Style Sheets (CSS)?
3217 * This enables a lot of neat customizations, but may
3218 * increase security risk to users and server load.
3220 $wgAllowUserCss = false;
3223 * Allow user-preferences implemented in CSS?
3224 * This allows users to customise the site appearance to a greater
3225 * degree; disabling it will improve page load times.
3227 $wgAllowUserCssPrefs = true;
3230 * Use the site's Javascript page?
3232 $wgUseSiteJs = true;
3235 * Use the site's Cascading Style Sheets (CSS)?
3237 $wgUseSiteCss = true;
3240 * Break out of framesets. This can be used to prevent clickjacking attacks,
3241 * or to prevent external sites from framing your site with ads.
3243 $wgBreakFrames = false;
3246 * The X-Frame-Options header to send on pages sensitive to clickjacking
3247 * attacks, such as edit pages. This prevents those pages from being displayed
3248 * in a frame or iframe. The options are:
3250 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3252 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3253 * to allow framing within a trusted domain. This is insecure if there
3254 * is a page on the same domain which allows framing of arbitrary URLs.
3256 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3257 * full compromise of local user accounts. Private wikis behind a
3258 * corporate firewall are especially vulnerable. This is not
3261 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3262 * not just edit pages.
3264 $wgEditPageFrameOptions = 'DENY';
3267 * Disallow framing of API pages directly, by setting the X-Frame-Options
3268 * header. Since the API returns CSRF tokens, allowing the results to be
3269 * framed can compromise your user's account security.
3271 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3272 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3273 * - false: Allow all framing.
3274 * Note: $wgBreakFrames will override this for human formatted API output.
3276 $wgApiFrameOptions = 'DENY';
3279 * Disable output compression (enabled by default if zlib is available)
3281 $wgDisableOutputCompression = false;
3284 * Should we allow a broader set of characters in id attributes, per HTML5? If
3285 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3286 * functionality is ready, it will be on by default with no option.
3288 * Currently this appears to work fine in all browsers, but it's disabled by
3289 * default because it normalizes id's a bit too aggressively, breaking preexisting
3290 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3292 $wgExperimentalHtmlIds = false;
3295 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3296 * You can add new icons to the built in copyright or poweredby, or you can create
3297 * a new block. Though note that you may need to add some custom css to get good styling
3298 * of new blocks in monobook. vector and modern should work without any special css.
3300 * $wgFooterIcons itself is a key/value array.
3301 * The key is the name of a block that the icons will be wrapped in. The final id varies
3302 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3303 * turns it into mw_poweredby.
3304 * The value is either key/value array of icons or a string.
3305 * In the key/value array the key may or may not be used by the skin but it can
3306 * be used to find the icon and unset it or change the icon if needed.
3307 * This is useful for disabling icons that are set by extensions.
3308 * The value should be either a string or an array. If it is a string it will be output
3309 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3310 * for the icon, the following keys are used:
3311 * - src: An absolute url to the image to use for the icon, this is recommended
3312 * but not required, however some skins will ignore icons without an image
3313 * - srcset: optional additional-resolution images; see HTML5 specs
3314 * - url: The url to use in the a element around the text or icon, if not set an a element will
3316 * - alt: This is the text form of the icon, it will be displayed without an image in
3317 * skins like Modern or if src is not set, and will otherwise be used as
3318 * the alt="" for the image. This key is required.
3319 * - width and height: If the icon specified by src is not of the standard size
3320 * you can specify the size of image to use with these keys.
3321 * Otherwise they will default to the standard 88x31.
3322 * @todo Reformat documentation.
3324 $wgFooterIcons = array(
3325 "copyright" => array(
3326 "copyright" => array(), // placeholder for the built in copyright icon
3328 "poweredby" => array(
3329 "mediawiki" => array(
3330 // Defaults to point at
3331 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3332 // plus srcset for 1.5x, 2x resolution variants.
3334 "url" => "//www.mediawiki.org/",
3335 "alt" => "Powered by MediaWiki",
3341 * Login / create account link behavior when it's possible for anonymous users
3342 * to create an account.
3343 * - true = use a combined login / create account link
3344 * - false = split login and create account into two separate links
3346 $wgUseCombinedLoginLink = false;
3349 * Display user edit counts in various prominent places.
3351 $wgEdititis = false;
3354 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3355 * status code, mangling or hiding MediaWiki's output. If you are using such a
3356 * host, you should start looking for a better one. While you're doing that,
3357 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3358 * that the generated error pages can be seen.
3360 * In cases where for technical reasons it is more important for MediaWiki to
3361 * send the correct status code than for the body to be transmitted intact,
3362 * this configuration variable is ignored.
3364 $wgSend404Code = true;
3367 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3368 * The numeric value of the variable controls how many edits MediaWiki will look back to
3369 * determine whether a rollback is allowed (by checking that they are all from the same author).
3370 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3371 * from hiding some useless rollback links.
3375 $wgShowRollbackEditCount = 10;
3378 * Output a <link rel="canonical"> tag on every page indicating the canonical
3379 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3380 * detection of the current server is unreliable, the link is sent
3383 $wgEnableCanonicalServerLink = false;
3386 * When OutputHandler is used, mangle any output that contains
3387 * <cross-domain-policy>. Without this, an attacker can send their own
3388 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3393 $wgMangleFlashPolicy = true;
3395 /** @} */ # End of output format settings }
3397 /*************************************************************************//**
3398 * @name ResourceLoader settings
3403 * Client-side resource modules.
3405 * Extensions should add their ResourceLoader module definitions
3406 * to the $wgResourceModules variable.
3410 * $wgResourceModules['ext.myExtension'] = array(
3411 * 'scripts' => 'myExtension.js',
3412 * 'styles' => 'myExtension.css',
3413 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3414 * 'localBasePath' => __DIR__,
3415 * 'remoteExtPath' => 'MyExtension',
3419 $wgResourceModules = array();
3422 * Skin-specific styles for resource modules.
3424 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3425 * not be modified or disabled.
3427 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3431 * $wgResourceModules['bar'] = array(
3432 * 'scripts' => 'resources/bar/bar.js',
3433 * 'styles' => 'resources/bar/main.css',
3436 * $wgResourceModuleSkinStyles['foo'] = array(
3437 * 'bar' => 'skins/Foo/bar.css',
3441 * This is mostly equivalent to:
3445 * $wgResourceModules['bar'] = array(
3446 * 'scripts' => 'resources/bar/bar.js',
3447 * 'styles' => 'resources/bar/main.css',
3448 * 'skinStyles' => array(
3449 * 'foo' => skins/Foo/bar.css',
3454 * If the module already defines its own entry in `skinStyles` for a given skin, then
3455 * $wgResourceModuleSkinStyles is ignored.
3457 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3458 * of replacing them. This can be done using the `+` prefix.
3462 * $wgResourceModules['bar'] = array(
3463 * 'scripts' => 'resources/bar/bar.js',
3464 * 'styles' => 'resources/bar/basic.css',
3465 * 'skinStyles' => array(
3466 * 'default' => 'resources/bar/additional.css',
3469 * // Note the '+' character:
3470 * $wgResourceModuleSkinStyles['foo'] = array(
3471 * '+bar' => 'skins/Foo/bar.css',
3475 * This is mostly equivalent to:
3479 * $wgResourceModules['bar'] = array(
3480 * 'scripts' => 'resources/bar/bar.js',
3481 * 'styles' => 'resources/bar/basic.css',
3482 * 'skinStyles' => array(
3483 * 'default' => 'resources/bar/additional.css',
3485 * 'resources/bar/additional.css',
3486 * 'skins/Foo/bar.css',
3492 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3493 * disabled by a skin. To provide default styles that may be extended or replaced,
3494 * use `skinStyles['default']`.
3496 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3497 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3501 * $wgResourceModuleSkinStyles['foo'] = array(
3502 * 'bar' => 'bar.css',
3503 * 'quux' => 'quux.css',
3504 * 'remoteSkinPath' => 'Foo',
3505 * 'localBasePath' => __DIR__,
3509 $wgResourceModuleSkinStyles = array();
3512 * Extensions should register foreign module sources here. 'local' is a
3513 * built-in source that is not in this array, but defined by
3514 * ResourceLoader::__construct() so that it cannot be unset.
3518 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3521 $wgResourceLoaderSources = array();
3524 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3525 * Defaults to $wgScriptPath.
3527 $wgResourceBasePath = null;
3530 * Maximum time in seconds to cache resources served by ResourceLoader.
3531 * Used to set last modified headers (max-age/s-maxage).
3533 * Following options to distinguish:
3534 * - versioned: Used for modules with a version, because changing version
3535 * numbers causes cache misses. This normally has a long expiry time.
3536 * - unversioned: Used for modules without a version to propagate changes
3537 * quickly to clients. Also used for modules with errors to recover quickly.
3538 * This normally has a short expiry time.
3540 * Expiry time for the options to distinguish:
3541 * - server: Squid/Varnish but also any other public proxy cache between the
3542 * client and MediaWiki.
3543 * - client: On the client side (e.g. in the browser cache).
3545 $wgResourceLoaderMaxage = array(
3546 'versioned' => array(
3547 'server' => 30 * 24 * 60 * 60, // 30 days
3548 'client' => 30 * 24 * 60 * 60, // 30 days
3550 'unversioned' => array(
3551 'server' => 5 * 60, // 5 minutes
3552 'client' => 5 * 60, // 5 minutes
3557 * The default debug mode (on/off) for of ResourceLoader requests.
3559 * This will still be overridden when the debug URL parameter is used.
3561 $wgResourceLoaderDebug = false;
3564 * Put each statement on its own line when minifying JavaScript. This makes
3565 * debugging in non-debug mode a bit easier.
3567 * @deprecated since 1.27: Always false; no longer configurable.
3569 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3572 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3573 * the minifier will try not to produce lines longer than this, but may be
3574 * forced to do so in certain cases.
3576 * @deprecated since 1.27: Always 1,000; no longer configurable.
3578 $wgResourceLoaderMinifierMaxLineLength = 1000;
3581 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3583 * @deprecated since 1.26: Always declare dependencies.
3585 $wgIncludeLegacyJavaScript = true;
3588 * Whether to ensure the mediawiki.util is loaded before other modules.
3590 * Before MediaWiki 1.19, modules used to load less asynchronous which allowed
3591 * modules to lack dependencies on 'popular' modules that were likely loaded already.
3593 * This setting is to aid scripts during migration by providing mediawiki.util
3594 * unconditionally (which was the most commonly missed dependency). It doesn't
3595 * cover all missing dependencies obviously but should fix most of them.
3597 * This should be removed at some point after site/user scripts have been fixed.
3598 * Enable this if your wiki has a large amount of user/site scripts that are
3599 * lacking dependencies.
3601 * @deprecated since 1.26: Always declare dependencies.
3603 $wgPreloadJavaScriptMwUtil = false;
3606 * Whether or not to assign configuration variables to the global window object.
3608 * If this is set to false, old code using deprecated variables will no longer
3611 * @par Example of legacy code:
3613 * if ( window.wgRestrictionEdit ) { ... }
3617 * if ( wgIsArticle ) { ... }
3620 * Instead, one needs to use mw.config.
3621 * @par Example using mw.config global configuration:
3623 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3627 * if ( mw.config.get('wgIsArticle') ) { ... }
3630 $wgLegacyJavaScriptGlobals = true;
3633 * If set to a positive number, ResourceLoader will not generate URLs whose
3634 * query string is more than this many characters long, and will instead use
3635 * multiple requests with shorter query strings. This degrades performance,
3636 * but may be needed if your web server has a low (less than, say 1024)
3637 * query string length limit or a low value for suhosin.get.max_value_length
3638 * that you can't increase.
3640 * If set to a negative number, ResourceLoader will assume there is no query
3641 * string length limit.
3643 * Defaults to a value based on php configuration.
3645 $wgResourceLoaderMaxQueryLength = false;
3648 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3649 * prior to minification to validate it.
3651 * Parse errors will result in a JS exception being thrown during module load,
3652 * which avoids breaking other modules loaded in the same request.
3654 $wgResourceLoaderValidateJS = true;
3657 * If set to true, statically-sourced (file-backed) JavaScript resources will
3658 * be parsed for validity before being bundled up into ResourceLoader modules.
3660 * This can be helpful for development by providing better error messages in
3661 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3662 * and may fail on large pre-bundled frameworks.
3664 $wgResourceLoaderValidateStaticJS = false;
3667 * Global LESS variables. An associative array binding variable names to
3668 * LESS code snippets representing their values.
3670 * Adding an item here is equivalent to writing `@variable: value;`
3671 * at the beginning of all your .less files, with all the consequences.
3672 * In particular, string values must be escaped and quoted.
3674 * Changes to LESS variables do not trigger cache invalidation.
3676 * If the LESS variables need to be dynamic, you can use the
3677 * ResourceLoaderGetLessVars hook (since 1.25).
3681 * $wgResourceLoaderLESSVars = array(
3682 * 'baseFontSize' => '1em',
3683 * 'smallFontSize' => '0.75em',
3684 * 'WikimediaBlue' => '#006699',
3689 $wgResourceLoaderLESSVars = array();
3692 * Default import paths for LESS modules. LESS files referenced in @import
3693 * statements will be looked up here first, and relative to the importing file
3694 * second. To avoid collisions, it's important for the LESS files in these
3695 * directories to have a common, predictable file name prefix.
3697 * Extensions need not (and should not) register paths in
3698 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3699 * currently compiling LESS file, which allows each extension to freely import
3700 * files from its own tree.
3704 $wgResourceLoaderLESSImportPaths = array(
3705 "$IP/resources/src/mediawiki.less/",
3709 * Whether ResourceLoader should attempt to persist modules in localStorage on
3710 * browsers that support the Web Storage API.
3712 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3714 $wgResourceLoaderStorageEnabled = false;
3717 * Cache version for client-side ResourceLoader module storage. You can trigger
3718 * invalidation of the contents of the module store by incrementing this value.
3722 $wgResourceLoaderStorageVersion = 1;
3725 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3726 * restricted pages like Special:UserLogin or Special:Preferences where
3727 * JavaScript is disabled for security reasons. As it is possible to
3728 * execute JavaScript through CSS, setting this to true opens up a
3729 * potential security hole. Some sites may "skin" their wiki by using
3730 * site-wide CSS, causing restricted pages to look unstyled and different
3731 * from the rest of the site.
3735 $wgAllowSiteCSSOnRestrictedPages = false;
3737 /** @} */ # End of ResourceLoader settings }
3739 /*************************************************************************//**
3740 * @name Page title and interwiki link settings
3745 * Name of the project namespace. If left set to false, $wgSitename will be
3748 $wgMetaNamespace = false;
3751 * Name of the project talk namespace.
3753 * Normally you can ignore this and it will be something like
3754 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3755 * manually for grammatical reasons.
3757 $wgMetaNamespaceTalk = false;
3760 * Additional namespaces. If the namespaces defined in Language.php and
3761 * Namespace.php are insufficient, you can create new ones here, for example,
3762 * to import Help files in other languages. You can also override the namespace
3763 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3764 * hook or extension.json.
3766 * @warning Once you delete a namespace, the pages in that namespace will
3767 * no longer be accessible. If you rename it, then you can access them through
3768 * the new namespace name.
3770 * Custom namespaces should start at 100 to avoid conflicting with standard
3771 * namespaces, and should always follow the even/odd main/talk pattern.
3775 * $wgExtraNamespaces = array(
3777 * 101 => "Hilfe_Diskussion",
3779 * 103 => "Discussion_Aide"
3783 * @todo Add a note about maintenance/namespaceDupes.php
3785 $wgExtraNamespaces = array();
3788 * Same as above, but for namespaces with gender distinction.
3789 * Note: the default form for the namespace should also be set
3790 * using $wgExtraNamespaces for the same index.
3793 $wgExtraGenderNamespaces = array();
3796 * Namespace aliases.
3798 * These are alternate names for the primary localised namespace names, which
3799 * are defined by $wgExtraNamespaces and the language file. If a page is
3800 * requested with such a prefix, the request will be redirected to the primary
3803 * Set this to a map from namespace names to IDs.
3807 * $wgNamespaceAliases = array(
3808 * 'Wikipedian' => NS_USER,
3813 $wgNamespaceAliases = array();
3816 * Allowed title characters -- regex character class
3817 * Don't change this unless you know what you're doing
3819 * Problematic punctuation:
3820 * - []{}|# Are needed for link syntax, never enable these
3821 * - <> Causes problems with HTML escaping, don't use
3822 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3823 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3824 * corrupted by apache
3825 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3827 * All three of these punctuation problems can be avoided by using an alias,
3828 * instead of a rewrite rule of either variety.
3830 * The problem with % is that when using a path to query rewrite rule, URLs are
3831 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3832 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3833 * for this, indeed double escaping would break if the double-escaped title was
3834 * passed in the query string rather than the path. This is a minor security issue
3835 * because articles can be created such that they are hard to view or edit.
3837 * In some rare cases you may wish to remove + for compatibility with old links.
3839 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3840 * this breaks interlanguage links
3842 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3845 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3847 * @deprecated since 1.23; use $wgLocalInterwikis instead
3849 $wgLocalInterwiki = false;
3852 * Array for multiple $wgLocalInterwiki values, in case there are several
3853 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3854 * set, its value is prepended to this array, for backwards compatibility.
3856 * Note, recent changes feeds use only the first entry in this array (or
3857 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3859 $wgLocalInterwikis = array();
3862 * Expiry time for cache of interwiki table
3864 $wgInterwikiExpiry = 10800;
3867 * @name Interwiki caching settings.
3872 *$wgInterwikiCache specifies path to constant database file.
3874 * This cdb database is generated by dumpInterwiki from maintenance and has
3876 * - dbname:key - a simple key (e.g. enwiki:meta)
3877 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3878 * - __global:key - global-scope key (e.g. __global:meta)
3879 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3881 * Sites mapping just specifies site name, other keys provide "local url"
3884 $wgInterwikiCache = false;
3887 * Specify number of domains to check for messages.
3888 * - 1: Just wiki(db)-level
3889 * - 2: wiki and global levels
3892 $wgInterwikiScopes = 3;
3895 * Fallback site, if unable to resolve from cache
3897 $wgInterwikiFallbackSite = 'wiki';
3899 /** @} */ # end of Interwiki caching settings.
3902 * @name SiteStore caching settings.
3907 * Specify the file location for the Sites json cache file.
3909 $wgSitesCacheFile = false;
3911 /** @} */ # end of SiteStore caching settings.
3914 * If local interwikis are set up which allow redirects,
3915 * set this regexp to restrict URLs which will be displayed
3916 * as 'redirected from' links.
3919 * It might look something like this:
3921 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3924 * Leave at false to avoid displaying any incoming redirect markers.
3925 * This does not affect intra-wiki redirects, which don't change
3928 $wgRedirectSources = false;
3931 * Set this to false to avoid forcing the first letter of links to capitals.
3933 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3934 * appearing with a capital at the beginning of a sentence will *not* go to the
3935 * same place as links in the middle of a sentence using a lowercase initial.
3937 $wgCapitalLinks = true;
3940 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3941 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3942 * true by default (and setting them has no effect), due to various things that
3943 * require them to be so. Also, since Talk namespaces need to directly mirror their
3944 * associated content namespaces, the values for those are ignored in favor of the
3945 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3950 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3953 $wgCapitalLinkOverrides = array();
3956 * Which namespaces should support subpages?
3957 * See Language.php for a list of namespaces.
3959 $wgNamespacesWithSubpages = array(
3962 NS_USER_TALK
=> true,
3964 NS_PROJECT_TALK
=> true,
3965 NS_FILE_TALK
=> true,
3966 NS_MEDIAWIKI
=> true,
3967 NS_MEDIAWIKI_TALK
=> true,
3968 NS_TEMPLATE_TALK
=> true,
3970 NS_HELP_TALK
=> true,
3971 NS_CATEGORY_TALK
=> true
3975 * Array holding default tracking category names.
3977 * Array contains the system messages for each tracking category.
3978 * Tracking categories allow pages with certain characteristics to be tracked.
3979 * It works by adding any such page to a category automatically.
3981 * A message with the suffix '-desc' should be added as a description message
3982 * to have extra information on Special:TrackingCategories.
3984 * @deprecated since 1.25 Extensions should now register tracking categories using
3985 * the new extension registration system.
3989 $wgTrackingCategories = array();
3992 * Array of namespaces which can be deemed to contain valid "content", as far
3993 * as the site statistics are concerned. Useful if additional namespaces also
3994 * contain "content" which should be considered when generating a count of the
3995 * number of articles in the wiki.
3997 $wgContentNamespaces = array( NS_MAIN
);
4000 * Array of namespaces, in addition to the talk namespaces, where signatures
4001 * (~~~~) are likely to be used. This determines whether to display the
4002 * Signature button on the edit toolbar, and may also be used by extensions.
4003 * For example, "traditional" style wikis, where content and discussion are
4004 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4006 $wgExtraSignatureNamespaces = array();
4009 * Max number of redirects to follow when resolving redirects.
4010 * 1 means only the first redirect is followed (default behavior).
4011 * 0 or less means no redirects are followed.
4013 $wgMaxRedirects = 1;
4016 * Array of invalid page redirect targets.
4017 * Attempting to create a redirect to any of the pages in this array
4018 * will make the redirect fail.
4019 * Userlogout is hard-coded, so it does not need to be listed here.
4020 * (bug 10569) Disallow Mypage and Mytalk as well.
4022 * As of now, this only checks special pages. Redirects to pages in
4023 * other namespaces cannot be invalidated by this variable.
4025 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
4027 /** @} */ # End of title and interwiki settings }
4029 /************************************************************************//**
4030 * @name Parser settings
4031 * These settings configure the transformation from wikitext to HTML.
4036 * Parser configuration. Associative array with the following members:
4038 * class The class name
4040 * preprocessorClass The preprocessor class. Two classes are currently available:
4041 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4042 * storage, and Preprocessor_DOM, which uses the DOM module for
4043 * temporary storage. Preprocessor_DOM generally uses less memory;
4044 * the speed of the two is roughly the same.
4046 * If this parameter is not given, it uses Preprocessor_DOM if the
4047 * DOM module is available, otherwise it uses Preprocessor_Hash.
4049 * The entire associative array will be passed through to the constructor as
4050 * the first parameter. Note that only Setup.php can use this variable --
4051 * the configuration will change at runtime via $wgParser member functions, so
4052 * the contents of this variable will be out-of-date. The variable can only be
4053 * changed during LocalSettings.php, in particular, it can't be changed during
4054 * an extension setup function.
4056 $wgParserConf = array(
4057 'class' => 'Parser',
4058 # 'preprocessorClass' => 'Preprocessor_Hash',
4062 * Maximum indent level of toc.
4064 $wgMaxTocLevel = 999;
4067 * A complexity limit on template expansion: the maximum number of nodes visited
4068 * by PPFrame::expand()
4070 $wgMaxPPNodeCount = 1000000;
4073 * A complexity limit on template expansion: the maximum number of elements
4074 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4075 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4076 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4077 * this default corresponds to about 155 MB.
4079 * When the limit is exceeded, an exception is thrown.
4081 $wgMaxGeneratedPPNodeCount = 1000000;
4084 * Maximum recursion depth for templates within templates.
4085 * The current parser adds two levels to the PHP call stack for each template,
4086 * and xdebug limits the call stack to 100 by default. So this should hopefully
4087 * stop the parser before it hits the xdebug limit.
4089 $wgMaxTemplateDepth = 40;
4092 * @see $wgMaxTemplateDepth
4094 $wgMaxPPExpandDepth = 40;
4097 * URL schemes that should be recognized as valid by wfParseUrl().
4099 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4100 * Instead, if you want to support file links, add 'file://'. The same applies
4101 * to any other protocols with the same name as a namespace. See bug #44011 for
4106 $wgUrlProtocols = array(
4107 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4108 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4109 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4110 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4114 * If true, removes (by substituting) templates in signatures.
4116 $wgCleanSignatures = true;
4119 * Whether to allow inline image pointing to other websites
4121 $wgAllowExternalImages = false;
4124 * If the above is false, you can specify an exception here. Image URLs
4125 * that start with this string are then rendered, while all others are not.
4126 * You can use this to set up a trusted, simple repository of images.
4127 * You may also specify an array of strings to allow multiple sites
4131 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4132 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
4135 $wgAllowExternalImagesFrom = '';
4138 * If $wgAllowExternalImages is false, you can allow an on-wiki
4139 * whitelist of regular expression fragments to match the image URL
4140 * against. If the image matches one of the regular expression fragments,
4141 * The image will be displayed.
4143 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4144 * Or false to disable it
4146 $wgEnableImageWhitelist = true;
4149 * A different approach to the above: simply allow the "<img>" tag to be used.
4150 * This allows you to specify alt text and other attributes, copy-paste HTML to
4151 * your wiki more easily, etc. However, allowing external images in any manner
4152 * will allow anyone with editing rights to snoop on your visitors' IP
4153 * addresses and so forth, if they wanted to, by inserting links to images on
4154 * sites they control.
4156 $wgAllowImageTag = false;
4159 * Configuration for HTML postprocessing tool. Set this to a configuration
4160 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4161 * used. See http://www.w3.org/People/Raggett/tidy/
4163 * If this is null and $wgUseTidy is true, the deprecated configuration
4164 * parameters will be used instead.
4166 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4170 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4171 * - RaggettInternalPHP: Use the PECL extension
4172 * - RaggettExternal: Shell out to an external binary (tidyBin)
4174 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4175 * - debugComment: True to add a comment to the output with warning messages
4176 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4177 * - tidyCommandLine: For RaggettExternal, additional command line options.
4179 $wgTidyConfig = null;
4182 * Set this to true to use the deprecated tidy configuration parameters.
4183 * @deprecated use $wgTidyConfig
4188 * The path to the tidy binary.
4189 * @deprecated Use $wgTidyConfig['tidyBin']
4191 $wgTidyBin = 'tidy';
4194 * The path to the tidy config file
4195 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4197 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4200 * The command line options to the tidy binary
4201 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4206 * Set this to true to use the tidy extension
4207 * @deprecated Use $wgTidyConfig['driver']
4209 $wgTidyInternal = extension_loaded( 'tidy' );
4212 * Put tidy warnings in HTML comments
4213 * Only works for internal tidy.
4215 $wgDebugTidy = false;
4218 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4219 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4220 * TO RESTRICT EDITING to only those that you trust
4225 * Set a default target for external links, e.g. _blank to pop up a new window
4227 $wgExternalLinkTarget = false;
4230 * If true, external URL links in wiki text will be given the
4231 * rel="nofollow" attribute as a hint to search engines that
4232 * they should not be followed for ranking purposes as they
4233 * are user-supplied and thus subject to spamming.
4235 $wgNoFollowLinks = true;
4238 * Namespaces in which $wgNoFollowLinks doesn't apply.
4239 * See Language.php for a list of namespaces.
4241 $wgNoFollowNsExceptions = array();
4244 * If this is set to an array of domains, external links to these domain names
4245 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4246 * value of $wgNoFollowLinks. For instance:
4248 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4249 * 'mediawiki.org' );
4251 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4252 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4255 * Defaults to mediawiki.org for the links included in the software by default.
4257 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4260 * Allow DISPLAYTITLE to change title display
4262 $wgAllowDisplayTitle = true;
4265 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4266 * canonical DB key. Also disallow some inline CSS rules like display: none;
4267 * which can cause the text to be hidden or unselectable.
4269 $wgRestrictDisplayTitle = true;
4272 * Maximum number of calls per parse to expensive parser functions such as
4275 $wgExpensiveParserFunctionLimit = 100;
4278 * Preprocessor caching threshold
4279 * Setting it to 'false' will disable the preprocessor cache.
4281 $wgPreprocessorCacheThreshold = 1000;
4284 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4286 $wgEnableScaryTranscluding = false;
4289 * Expiry time for transcluded templates cached in transcache database table.
4290 * Only used $wgEnableInterwikiTranscluding is set to true.
4292 $wgTranscludeCacheExpiry = 3600;
4294 /** @} */ # end of parser settings }
4296 /************************************************************************//**
4302 * Method used to determine if a page in a content namespace should be counted
4303 * as a valid article.
4305 * Redirect pages will never be counted as valid articles.
4307 * This variable can have the following values:
4308 * - 'any': all pages as considered as valid articles
4309 * - 'comma': the page must contain a comma to be considered valid
4310 * - 'link': the page must contain a [[wiki link]] to be considered valid
4312 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4314 * Retroactively changing this variable will not affect the existing count,
4315 * to update it, you will need to run the maintenance/updateArticleCount.php
4318 $wgArticleCountMethod = 'link';
4321 * How many days user must be idle before he is considered inactive. Will affect
4322 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4323 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4324 * You might want to leave this as the default value, to provide comparable
4325 * numbers between different wikis.
4327 $wgActiveUserDays = 30;
4329 /** @} */ # End of statistics }
4331 /************************************************************************//**
4332 * @name User accounts, authentication
4337 * Central ID lookup providers
4338 * Key is the provider ID, value is a specification for ObjectFactory
4341 $wgCentralIdLookupProviders = array(
4342 'local' => array( 'class' => 'LocalIdLookup' ),
4346 * Central ID lookup provider to use by default
4349 $wgCentralIdLookupProvider = 'local';
4352 * Password policy for local wiki users. A user's effective policy
4353 * is the superset of all policy statements from the policies for the
4354 * groups where the user is a member. If more than one group policy
4355 * include the same policy statement, the value is the max() of the
4356 * values. Note true > false. The 'default' policy group is required,
4357 * and serves as the minimum policy for all users. New statements can
4358 * be added by appending to $wgPasswordPolicy['checks'].
4360 * - MinimalPasswordLength - minimum length a user can set
4361 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4362 * not be allowed to login, regardless if it is correct.
4363 * - MaximalPasswordLength - maximum length password a user is allowed
4364 * to attempt. Prevents DoS attacks with pbkdf2.
4365 * - PasswordCannotMatchUsername - Password cannot match username to
4366 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4367 * match a specific, hardcoded blacklist.
4370 $wgPasswordPolicy = array(
4371 'policies' => array(
4372 'bureaucrat' => array(
4373 'MinimalPasswordLength' => 8,
4374 'MinimumPasswordLengthToLogin' => 1,
4375 'PasswordCannotMatchUsername' => true,
4378 'MinimalPasswordLength' => 8,
4379 'MinimumPasswordLengthToLogin' => 1,
4380 'PasswordCannotMatchUsername' => true,
4383 'MinimalPasswordLength' => 8,
4384 'MinimumPasswordLengthToLogin' => 1,
4385 'PasswordCannotMatchUsername' => true,
4388 'MinimalPasswordLength' => 1,
4389 'PasswordCannotMatchUsername' => true,
4390 'PasswordCannotMatchBlacklist' => true,
4391 'MaximalPasswordLength' => 4096,
4395 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4396 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4397 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4398 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4399 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4405 * For compatibility with old installations set to false
4406 * @deprecated since 1.24 will be removed in future
4408 $wgPasswordSalt = true;
4411 * Specifies the minimal length of a user password. If set to 0, empty pass-
4412 * words are allowed.
4413 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4415 $wgMinimalPasswordLength = false;
4418 * Specifies the maximal length of a user password (T64685).
4420 * It is not recommended to make this greater than the default, as it can
4421 * allow DoS attacks by users setting really long passwords. In addition,
4422 * this should not be lowered too much, as it enforces weak passwords.
4424 * @warning Unlike other password settings, user with passwords greater than
4425 * the maximum will not be able to log in.
4426 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4428 $wgMaximalPasswordLength = false;
4431 * Specifies if users should be sent to a password-reset form on login, if their
4432 * password doesn't meet the requirements of User::isValidPassword().
4435 $wgInvalidPasswordReset = true;
4438 * Default password type to use when hashing user passwords
4442 $wgPasswordDefault = 'pbkdf2';
4445 * Configuration for built-in password types. Maps the password type
4446 * to an array of options. The 'class' option is the Password class to
4447 * use. All other options are class-dependent.
4449 * An advanced example:
4451 * $wgPasswordConfig['bcrypt-peppered'] = array(
4452 * 'class' => 'EncryptedPassword',
4453 * 'underlying' => 'bcrypt',
4454 * 'secrets' => array(),
4455 * 'cipher' => MCRYPT_RIJNDAEL_256,
4456 * 'mode' => MCRYPT_MODE_CBC,
4463 $wgPasswordConfig = array(
4465 'class' => 'MWOldPassword',
4468 'class' => 'MWSaltedPassword',
4470 'pbkdf2-legacyA' => array(
4471 'class' => 'LayeredParameterizedPassword',
4477 'pbkdf2-legacyB' => array(
4478 'class' => 'LayeredParameterizedPassword',
4485 'class' => 'BcryptPassword',
4489 'class' => 'Pbkdf2Password',
4497 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4498 * with a temporary password you can use to get back into the account") identified by
4499 * various bits of data. Setting all of these to false (or the whole variable to false)
4500 * has the effect of disabling password resets entirely
4502 $wgPasswordResetRoutes = array(
4508 * Maximum number of Unicode characters in signature
4510 $wgMaxSigChars = 255;
4513 * Maximum number of bytes in username. You want to run the maintenance
4514 * script ./maintenance/checkUsernames.php once you have changed this value.
4516 $wgMaxNameChars = 255;
4519 * Array of usernames which may not be registered or logged in from
4520 * Maintenance scripts can still use these
4522 $wgReservedUsernames = array(
4523 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4524 'Conversion script', // Used for the old Wikipedia software upgrade
4525 'Maintenance script', // Maintenance scripts which perform editing, image import script
4526 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4527 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4528 'msg:double-redirect-fixer', // Automatic double redirect fix
4529 'msg:usermessage-editor', // Default user for leaving user messages
4530 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4531 'msg:spambot_username', // Used by cleanupSpam.php
4532 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4536 * Settings added to this array will override the default globals for the user
4537 * preferences used by anonymous visitors and newly created accounts.
4538 * For instance, to disable editing on double clicks:
4539 * $wgDefaultUserOptions ['editondblclick'] = 0;
4541 $wgDefaultUserOptions = array(
4542 'ccmeonemails' => 0,
4544 'date' => 'default',
4547 'editfont' => 'default',
4548 'editondblclick' => 0,
4549 'editsectiononrightclick' => 0,
4550 'enotifminoredits' => 0,
4551 'enotifrevealaddr' => 0,
4552 'enotifusertalkpages' => 1,
4553 'enotifwatchlistpages' => 1,
4554 'extendwatchlist' => 1,
4556 'forceeditsummary' => 0,
4557 'gender' => 'unknown',
4559 'hidepatrolled' => 0,
4560 'hidecategorization' => 1,
4563 'minordefault' => 0,
4564 'newpageshidepatrolled' => 0,
4566 'norollbackdiff' => 0,
4567 'numberheadings' => 0,
4568 'previewonfirst' => 0,
4569 'previewontop' => 1,
4573 'showhiddencats' => 0,
4574 'shownumberswatching' => 1,
4577 'stubthreshold' => 0,
4580 'uselivepreview' => 0,
4582 'watchcreations' => 1,
4583 'watchdefault' => 1,
4584 'watchdeletion' => 0,
4585 'watchlistdays' => 3.0,
4586 'watchlisthideanons' => 0,
4587 'watchlisthidebots' => 0,
4588 'watchlisthideliu' => 0,
4589 'watchlisthideminor' => 0,
4590 'watchlisthideown' => 0,
4591 'watchlisthidepatrolled' => 0,
4592 'watchlisthidecategorization' => 1,
4593 'watchlistreloadautomatically' => 0,
4595 'watchrollback' => 0,
4597 'useeditwarning' => 1,
4598 'prefershttps' => 1,
4602 * An array of preferences to not show for the user
4604 $wgHiddenPrefs = array();
4607 * Characters to prevent during new account creations.
4608 * This is used in a regular expression character class during
4609 * registration (regex metacharacters like / are escaped).
4611 $wgInvalidUsernameCharacters = '@:';
4614 * Character used as a delimiter when testing for interwiki userrights
4615 * (In Special:UserRights, it is possible to modify users on different
4616 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4618 * It is recommended that you have this delimiter in
4619 * $wgInvalidUsernameCharacters above, or you will not be able to
4620 * modify the user rights of those users via Special:UserRights
4622 $wgUserrightsInterwikiDelimiter = '@';
4625 * This is to let user authenticate using https when they come from http.
4626 * Based on an idea by George Herbert on wikitech-l:
4627 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4630 $wgSecureLogin = false;
4632 /** @} */ # end user accounts }
4634 /************************************************************************//**
4635 * @name User rights, access control and monitoring
4640 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4642 $wgAutoblockExpiry = 86400;
4645 * Set this to true to allow blocked users to edit their own user talk page.
4647 $wgBlockAllowsUTEdit = true;
4650 * Allow sysops to ban users from accessing Emailuser
4652 $wgSysopEmailBans = true;
4655 * Limits on the possible sizes of range blocks.
4657 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4658 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4659 * half the number of bits avoids such errors, and allows entire ISPs to be
4660 * blocked using a small number of range blocks.
4662 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4663 * customer, so range blocks larger than /64 (half the number of bits) will
4664 * plainly be required. RFC 4692 implies that a very large ISP may be
4665 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4666 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4668 $wgBlockCIDRLimit = array(
4669 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4674 * If true, blocked users will not be allowed to login. When using this with
4675 * a public wiki, the effect of logging out blocked users may actually be
4676 * avers: unless the user's address is also blocked (e.g. auto-block),
4677 * logging the user out will again allow reading and editing, just as for
4678 * anonymous visitors.
4680 $wgBlockDisablesLogin = false;
4683 * Pages anonymous user may see, set as an array of pages titles.
4687 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4690 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4692 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4693 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4695 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4696 * will remain readable. You can use img_auth.php to protect uploaded files,
4697 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4699 $wgWhitelistRead = false;
4702 * Pages anonymous user may see, set as an array of regular expressions.
4704 * This function will match the regexp against the title name, which
4705 * is without underscore.
4708 * To whitelist [[Main Page]]:
4710 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4713 * @note Unless ^ and/or $ is specified, a regular expression might match
4714 * pages not intended to be whitelisted. The above example will also
4715 * whitelist a page named 'Security Main Page'.
4718 * To allow reading any page starting with 'User' regardless of the case:
4720 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4722 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4724 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4725 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4727 $wgWhitelistReadRegexp = false;
4730 * Should editors be required to have a validated e-mail
4731 * address before being allowed to edit?
4733 $wgEmailConfirmToEdit = false;
4736 * Permission keys given to users in each group.
4738 * This is an array where the keys are all groups and each value is an
4739 * array of the format (right => boolean).
4741 * The second format is used to support per-namespace permissions.
4742 * Note that this feature does not fully work for all permission types.
4744 * All users are implicitly in the '*' group including anonymous visitors;
4745 * logged-in users are all implicitly in the 'user' group. These will be
4746 * combined with the permissions of all groups that a given user is listed
4747 * in in the user_groups table.
4749 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4750 * doing! This will wipe all permissions, and may mean that your users are
4751 * unable to perform certain essential tasks or access new functionality
4752 * when new permissions are introduced and default grants established.
4754 * Functionality to make pages inaccessible has not been extensively tested
4755 * for security. Use at your own risk!
4757 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4759 $wgGroupPermissions = array();
4761 /** @cond file_level_code */
4762 // Implicit group for all visitors
4763 $wgGroupPermissions['*']['createaccount'] = true;
4764 $wgGroupPermissions['*']['read'] = true;
4765 $wgGroupPermissions['*']['edit'] = true;
4766 $wgGroupPermissions['*']['createpage'] = true;
4767 $wgGroupPermissions['*']['createtalk'] = true;
4768 $wgGroupPermissions['*']['writeapi'] = true;
4769 $wgGroupPermissions['*']['editmyusercss'] = true;
4770 $wgGroupPermissions['*']['editmyuserjs'] = true;
4771 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4772 $wgGroupPermissions['*']['editmywatchlist'] = true;
4773 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4774 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4775 $wgGroupPermissions['*']['editmyoptions'] = true;
4776 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4778 // Implicit group for all logged-in accounts
4779 $wgGroupPermissions['user']['move'] = true;
4780 $wgGroupPermissions['user']['move-subpages'] = true;
4781 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4782 $wgGroupPermissions['user']['move-categorypages'] = true;
4783 $wgGroupPermissions['user']['movefile'] = true;
4784 $wgGroupPermissions['user']['read'] = true;
4785 $wgGroupPermissions['user']['edit'] = true;
4786 $wgGroupPermissions['user']['createpage'] = true;
4787 $wgGroupPermissions['user']['createtalk'] = true;
4788 $wgGroupPermissions['user']['writeapi'] = true;
4789 $wgGroupPermissions['user']['upload'] = true;
4790 $wgGroupPermissions['user']['reupload'] = true;
4791 $wgGroupPermissions['user']['reupload-shared'] = true;
4792 $wgGroupPermissions['user']['minoredit'] = true;
4793 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4794 $wgGroupPermissions['user']['sendemail'] = true;
4795 $wgGroupPermissions['user']['applychangetags'] = true;
4796 $wgGroupPermissions['user']['changetags'] = true;
4798 // Implicit group for accounts that pass $wgAutoConfirmAge
4799 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4800 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4802 // Users with bot privilege can have their edits hidden
4803 // from various log pages by default
4804 $wgGroupPermissions['bot']['bot'] = true;
4805 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4806 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4807 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4808 $wgGroupPermissions['bot']['autopatrol'] = true;
4809 $wgGroupPermissions['bot']['suppressredirect'] = true;
4810 $wgGroupPermissions['bot']['apihighlimits'] = true;
4811 $wgGroupPermissions['bot']['writeapi'] = true;
4813 // Most extra permission abilities go to this group
4814 $wgGroupPermissions['sysop']['block'] = true;
4815 $wgGroupPermissions['sysop']['createaccount'] = true;
4816 $wgGroupPermissions['sysop']['delete'] = true;
4817 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4818 $wgGroupPermissions['sysop']['bigdelete'] = true;
4819 // can view deleted history entries, but not see or restore the text
4820 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4821 // can view deleted revision text
4822 $wgGroupPermissions['sysop']['deletedtext'] = true;
4823 $wgGroupPermissions['sysop']['undelete'] = true;
4824 $wgGroupPermissions['sysop']['editinterface'] = true;
4825 $wgGroupPermissions['sysop']['editusercss'] = true;
4826 $wgGroupPermissions['sysop']['edituserjs'] = true;
4827 $wgGroupPermissions['sysop']['import'] = true;
4828 $wgGroupPermissions['sysop']['importupload'] = true;
4829 $wgGroupPermissions['sysop']['move'] = true;
4830 $wgGroupPermissions['sysop']['move-subpages'] = true;
4831 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4832 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4833 $wgGroupPermissions['sysop']['patrol'] = true;
4834 $wgGroupPermissions['sysop']['autopatrol'] = true;
4835 $wgGroupPermissions['sysop']['protect'] = true;
4836 $wgGroupPermissions['sysop']['editprotected'] = true;
4837 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4838 $wgGroupPermissions['sysop']['rollback'] = true;
4839 $wgGroupPermissions['sysop']['upload'] = true;
4840 $wgGroupPermissions['sysop']['reupload'] = true;
4841 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4842 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4843 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4844 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4845 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4846 $wgGroupPermissions['sysop']['blockemail'] = true;
4847 $wgGroupPermissions['sysop']['markbotedits'] = true;
4848 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4849 $wgGroupPermissions['sysop']['browsearchive'] = true;
4850 $wgGroupPermissions['sysop']['noratelimit'] = true;
4851 $wgGroupPermissions['sysop']['movefile'] = true;
4852 $wgGroupPermissions['sysop']['unblockself'] = true;
4853 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4854 # $wgGroupPermissions['sysop']['pagelang'] = true;
4855 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
4856 $wgGroupPermissions['sysop']['mergehistory'] = true;
4857 $wgGroupPermissions['sysop']['managechangetags'] = true;
4859 // Permission to change users' group assignments
4860 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4861 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4862 // Permission to change users' groups assignments across wikis
4863 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4864 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4865 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4867 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
4868 # $wgGroupPermissions['sysop']['deleterevision'] = true;
4869 // To hide usernames from users and Sysops
4870 # $wgGroupPermissions['suppress']['hideuser'] = true;
4871 // To hide revisions/log items from users and Sysops
4872 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
4873 // To view revisions/log items hidden from users and Sysops
4874 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
4875 // For private suppression log access
4876 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
4879 * The developer group is deprecated, but can be activated if need be
4880 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4881 * that a lock file be defined and creatable/removable by the web
4884 # $wgGroupPermissions['developer']['siteadmin'] = true;
4889 * Permission keys revoked from users in each group.
4891 * This acts the same way as wgGroupPermissions above, except that
4892 * if the user is in a group here, the permission will be removed from them.
4894 * Improperly setting this could mean that your users will be unable to perform
4895 * certain essential tasks, so use at your own risk!
4897 $wgRevokePermissions = array();
4900 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4902 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4905 * A map of group names that the user is in, to group names that those users
4906 * are allowed to add or revoke.
4908 * Setting the list of groups to add or revoke to true is equivalent to "any
4912 * To allow sysops to add themselves to the "bot" group:
4914 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4918 * Implicit groups may be used for the source group, for instance:
4920 * $wgGroupsRemoveFromSelf = array( '*' => true );
4922 * This allows users in the '*' group (i.e. any user) to remove themselves from
4923 * any group that they happen to be in.
4925 $wgGroupsAddToSelf = array();
4928 * @see $wgGroupsAddToSelf
4930 $wgGroupsRemoveFromSelf = array();
4933 * Set of available actions that can be restricted via action=protect
4934 * You probably shouldn't change this.
4935 * Translated through restriction-* messages.
4936 * Title::getRestrictionTypes() will remove restrictions that are not
4937 * applicable to a specific title (create and upload)
4939 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4942 * Rights which can be required for each protection level (via action=protect)
4944 * You can add a new protection level that requires a specific
4945 * permission by manipulating this array. The ordering of elements
4946 * dictates the order on the protection form's lists.
4948 * - '' will be ignored (i.e. unprotected)
4949 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4950 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4952 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4955 * Restriction levels that can be used with cascading protection
4957 * A page can only be protected with cascading protection if the
4958 * requested restriction level is included in this array.
4960 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4961 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4963 $wgCascadingRestrictionLevels = array( 'sysop' );
4966 * Restriction levels that should be considered "semiprotected"
4968 * Certain places in the interface recognize a dichotomy between "protected"
4969 * and "semiprotected", without further distinguishing the specific levels. In
4970 * general, if anyone can be eligible to edit a protection level merely by
4971 * reaching some condition in $wgAutopromote, it should probably be considered
4974 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4975 * 'sysop' is not changed, since it really shouldn't be here.
4977 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4980 * Set the minimum permissions required to edit pages in each
4981 * namespace. If you list more than one permission, a user must
4982 * have all of them to edit pages in that namespace.
4984 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4986 $wgNamespaceProtection = array();
4989 * Pages in namespaces in this array can not be used as templates.
4991 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4992 * namespaces constants (NS_USER, NS_MAIN...).
4994 * Among other things, this may be useful to enforce read-restrictions
4995 * which may otherwise be bypassed by using the template mechanism.
4997 $wgNonincludableNamespaces = array();
5000 * Number of seconds an account is required to age before it's given the
5001 * implicit 'autoconfirm' group membership. This can be used to limit
5002 * privileges of new accounts.
5004 * Accounts created by earlier versions of the software may not have a
5005 * recorded creation date, and will always be considered to pass the age test.
5007 * When left at 0, all registered accounts will pass.
5010 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5012 * $wgAutoConfirmAge = 600; // ten minutes
5014 * Set age to one day:
5016 * $wgAutoConfirmAge = 3600*24; // one day
5019 $wgAutoConfirmAge = 0;
5022 * Number of edits an account requires before it is autoconfirmed.
5023 * Passing both this AND the time requirement is needed. Example:
5027 * $wgAutoConfirmCount = 50;
5030 $wgAutoConfirmCount = 0;
5033 * Automatically add a usergroup to any user who matches certain conditions.
5035 * @todo Redocument $wgAutopromote
5038 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
5039 * where cond1, cond2, ... are themselves conditions; *OR*
5040 * APCOND_EMAILCONFIRMED, *OR*
5041 * array( APCOND_EMAILCONFIRMED ), *OR*
5042 * array( APCOND_EDITCOUNT, number of edits ), *OR*
5043 * array( APCOND_AGE, seconds since registration ), *OR*
5044 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
5045 * array( APCOND_ISIP, ip ), *OR*
5046 * array( APCOND_IPINRANGE, range ), *OR*
5047 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
5048 * array( APCOND_BLOCKED ), *OR*
5049 * array( APCOND_ISBOT ), *OR*
5050 * similar constructs defined by extensions.
5052 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
5053 * user who has provided an e-mail address.
5055 $wgAutopromote = array(
5056 'autoconfirmed' => array( '&',
5057 array( APCOND_EDITCOUNT
, &$wgAutoConfirmCount ),
5058 array( APCOND_AGE
, &$wgAutoConfirmAge ),
5063 * Automatically add a usergroup to any user who matches certain conditions.
5065 * Does not add the user to the group again if it has been removed.
5066 * Also, does not remove the group if the user no longer meets the criteria.
5070 * array( event => criteria, ... )
5072 * Where event is either:
5073 * - 'onEdit' (when user edits)
5075 * Criteria has the same format as $wgAutopromote
5077 * @see $wgAutopromote
5080 $wgAutopromoteOnce = array(
5081 'onEdit' => array(),
5085 * Put user rights log entries for autopromotion in recent changes?
5088 $wgAutopromoteOnceLogInRC = true;
5091 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5092 * can assign which groups at Special:Userrights.
5095 * Bureaucrats can add any group:
5097 * $wgAddGroups['bureaucrat'] = true;
5099 * Bureaucrats can only remove bots and sysops:
5101 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
5103 * Sysops can make bots:
5105 * $wgAddGroups['sysop'] = array( 'bot' );
5107 * Sysops can disable other sysops in an emergency, and disable bots:
5109 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
5112 $wgAddGroups = array();
5117 $wgRemoveGroups = array();
5120 * A list of available rights, in addition to the ones defined by the core.
5121 * For extensions only.
5123 $wgAvailableRights = array();
5126 * Optional to restrict deletion of pages with higher revision counts
5127 * to users with the 'bigdelete' permission. (Default given to sysops.)
5129 $wgDeleteRevisionsLimit = 0;
5132 * The maximum number of edits a user can have and
5133 * can still be hidden by users with the hideuser permission.
5134 * This is limited for performance reason.
5135 * Set to false to disable the limit.
5138 $wgHideUserContribLimit = 1000;
5141 * Number of accounts each IP address may create, 0 to disable.
5143 * @warning Requires memcached
5145 $wgAccountCreationThrottle = 0;
5148 * Edits matching these regular expressions in body text
5149 * will be recognised as spam and rejected automatically.
5151 * There's no administrator override on-wiki, so be careful what you set. :)
5152 * May be an array of regexes or a single string for backwards compatibility.
5154 * @see https://en.wikipedia.org/wiki/Regular_expression
5156 * @note Each regex needs a beginning/end delimiter, eg: # or /
5158 $wgSpamRegex = array();
5161 * Same as the above except for edit summaries
5163 $wgSummarySpamRegex = array();
5166 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5170 $wgEnableDnsBlacklist = false;
5173 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5175 * This is an array of either a URL or an array with the URL and a key (should
5176 * the blacklist require a key).
5180 * $wgDnsBlacklistUrls = array(
5181 * // String containing URL
5182 * 'http.dnsbl.sorbs.net.',
5183 * // Array with URL and key, for services that require a key
5184 * array( 'dnsbl.httpbl.net.', 'mykey' ),
5185 * // Array with just the URL. While this works, it is recommended that you
5186 * // just use a string as shown above
5187 * array( 'opm.tornevall.org.' )
5191 * @note You should end the domain name with a . to avoid searching your
5192 * eventual domain search suffixes.
5195 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
5198 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5199 * what the other methods might say.
5201 $wgProxyWhitelist = array();
5204 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5205 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5206 * (transparent) proxies without needing to block the proxies themselves.
5208 $wgApplyIpBlocksToXff = false;
5211 * Simple rate limiter options to brake edit floods.
5213 * Maximum number actions allowed in the given number of seconds; after that
5214 * the violating client receives HTTP 500 error pages until the period
5218 * To set a generic maximum of 4 hits in 60 seconds:
5220 * $wgRateLimits = array( 4, 60 );
5224 * You could also limit per action and then type of users.
5226 * $wgRateLimits = array(
5228 * 'anon' => array( x, y ), // any and all anonymous edits (aggregate)
5229 * 'user' => array( x, y ), // each logged-in user
5230 * 'newbie' => array( x, y ), // each new autoconfirmed accounts; overrides 'user'
5231 * 'ip' => array( x, y ), // each anon and recent account
5232 * 'subnet' => array( x, y ), // ... within a /24 subnet in IPv4 or /64 in IPv6
5237 * @warning Requires that $wgMainCacheType is set to something persistent
5239 $wgRateLimits = array(
5242 'ip' => array( 8, 60 ),
5243 'newbie' => array( 8, 60 ),
5247 'newbie' => array( 2, 120 ),
5248 'user' => array( 8, 60 ),
5252 'ip' => array( 8, 60 ),
5253 'newbie' => array( 8, 60 ),
5256 'rollback' => array(
5257 'user' => array( 10, 60 ),
5258 'newbie' => array( 5, 120 )
5260 // Triggering password resets emails
5261 'mailpassword' => array(
5262 'ip' => array( 5, 3600 ),
5264 // Emailing other users using MediaWiki
5265 'emailuser' => array(
5266 'ip' => array( 5, 86400 ),
5267 'newbie' => array( 5, 86400 ),
5268 'user' => array( 20, 86400 ),
5272 'ip' => array( 30, 60 ),
5273 'user' => array( 30, 60 ),
5275 // Purges of link tables
5276 'linkpurge' => array(
5277 'ip' => array( 30, 60 ),
5278 'user' => array( 30, 60 ),
5280 // Files rendered via thumb.php or thumb_handler.php
5281 'renderfile' => array(
5282 'ip' => array( 700, 30 ),
5283 'user' => array( 700, 30 ),
5285 // Same as above but for non-standard thumbnails
5286 'renderfile-nonstandard' => array(
5287 'ip' => array( 70, 30 ),
5288 'user' => array( 70, 30 ),
5290 // Stashing edits into cache before save
5291 'stashedit' => array(
5292 'ip' => array( 30, 60 ),
5293 'newbie' => array( 30, 60 ),
5295 // Adding or removing change tags
5296 'changetag' => array(
5297 'ip' => array( 8, 60 ),
5298 'newbie' => array( 8, 60 ),
5303 * Array of IPs which should be excluded from rate limits.
5304 * This may be useful for whitelisting NAT gateways for conferences, etc.
5306 $wgRateLimitsExcludedIPs = array();
5309 * Log IP addresses in the recentchanges table; can be accessed only by
5310 * extensions (e.g. CheckUser) or a DB admin
5311 * Used for retroactive autoblocks
5313 $wgPutIPinRC = true;
5316 * Integer defining default number of entries to show on
5317 * special pages which are query-pages such as Special:Whatlinkshere.
5319 $wgQueryPageDefaultLimit = 50;
5322 * Limit password attempts to X attempts per Y seconds per IP per account.
5324 * @warning Requires memcached.
5326 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5328 /** @} */ # end of user rights settings
5330 /************************************************************************//**
5331 * @name Proxy scanner settings
5336 * This should always be customised in LocalSettings.php
5338 $wgSecretKey = false;
5341 * Big list of banned IP addresses.
5343 * This can have the following formats:
5344 * - An array of addresses, either in the values
5345 * or the keys (for backward compatibility)
5346 * - A string, in that case this is the path to a file
5347 * containing the list of IP addresses, one per line
5349 $wgProxyList = array();
5351 /** @} */ # end of proxy scanner settings
5353 /************************************************************************//**
5354 * @name Cookie settings
5359 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5361 $wgCookieExpiration = 180 * 86400;
5364 * The identifiers of the login cookies that can have their lifetimes
5365 * extended independently of all other login cookies.
5369 $wgExtendedLoginCookies = array( 'UserID', 'Token' );
5372 * Default login cookie lifetime, in seconds. Setting
5373 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5374 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5375 * login cookies session-only.
5377 $wgExtendedLoginCookieExpiration = null;
5380 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5381 * or ".any.subdomain.net"
5383 $wgCookieDomain = '';
5386 * Set this variable if you want to restrict cookies to a certain path within
5387 * the domain specified by $wgCookieDomain.
5389 $wgCookiePath = '/';
5392 * Whether the "secure" flag should be set on the cookie. This can be:
5393 * - true: Set secure flag
5394 * - false: Don't set secure flag
5395 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5397 $wgCookieSecure = 'detect';
5400 * By default, MediaWiki checks if the client supports cookies during the
5401 * login process, so that it can display an informative error message if
5402 * cookies are disabled. Set this to true if you want to disable this cookie
5405 $wgDisableCookieCheck = false;
5408 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5409 * to a string to use a custom prefix. Setting it to false causes the database
5410 * name to be used as a prefix.
5412 $wgCookiePrefix = false;
5415 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5416 * in browsers that support this feature. This can mitigates some classes of
5419 $wgCookieHttpOnly = true;
5422 * A list of cookies that vary the cache (for use by extensions)
5424 $wgCacheVaryCookies = array();
5427 * Override to customise the session name
5429 $wgSessionName = false;
5431 /** @} */ # end of cookie settings }
5433 /************************************************************************//**
5434 * @name LaTeX (mathematical formulas)
5439 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5440 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5441 * (ImageMagick) installed and available in the PATH.
5442 * Please see math/README for more information.
5446 /** @} */ # end LaTeX }
5448 /************************************************************************//**
5449 * @name Profiling, testing and debugging
5451 * To enable profiling, edit StartProfiler.php
5457 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5458 * The debug log file should be not be publicly accessible if it is used, as it
5459 * may contain private data.
5461 $wgDebugLogFile = '';
5464 * Prefix for debug log lines
5466 $wgDebugLogPrefix = '';
5469 * If true, instead of redirecting, show a page with a link to the redirect
5470 * destination. This allows for the inspection of PHP error messages, and easy
5471 * resubmission of form data. For developer use only.
5473 $wgDebugRedirects = false;
5476 * If true, log debugging data from action=raw and load.php.
5477 * This is normally false to avoid overlapping debug entries due to gen=css
5478 * and gen=js requests.
5480 $wgDebugRawPage = false;
5483 * Send debug data to an HTML comment in the output.
5485 * This may occasionally be useful when supporting a non-technical end-user.
5486 * It's more secure than exposing the debug log file to the web, since the
5487 * output only contains private data for the current user. But it's not ideal
5488 * for development use since data is lost on fatal errors and redirects.
5490 $wgDebugComments = false;
5493 * Write SQL queries to the debug log.
5495 * This setting is only used $wgLBFactoryConf['class'] is set to
5496 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5497 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5498 * connection to achieve the same functionality.
5500 $wgDebugDumpSql = false;
5503 * Performance expectations for DB usage
5507 $wgTrxProfilerLimits = array(
5508 // Basic GET and POST requests
5512 'readQueryTime' => 5
5515 'readQueryTime' => 5,
5516 'writeQueryTime' => 1,
5517 'maxAffected' => 500
5519 // Background job runner
5520 'JobRunner' => array(
5521 'readQueryTime' => 30,
5522 'writeQueryTime' => 5,
5523 'maxAffected' => 1000
5525 // Command-line scripts
5526 'Maintenance' => array(
5527 'writeQueryTime' => 5,
5528 'maxAffected' => 1000
5533 * Map of string log group names to log destinations.
5535 * If set, wfDebugLog() output for that group will go to that file instead
5536 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5539 * Log destinations may be one of the following:
5540 * - false to completely remove from the output, including from $wgDebugLogFile.
5541 * - string values specifying a filename or URI.
5542 * - associative array with keys:
5543 * - 'destination' desired filename or URI.
5544 * - 'sample' an integer value, specifying a sampling factor (optional)
5545 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
5546 * to log (optional, since 1.25)
5550 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5553 * @par Advanced example:
5555 * $wgDebugLogGroups['memcached'] = array(
5556 * 'destination' => '/var/log/mediawiki/memcached.log',
5557 * 'sample' => 1000, // log 1 message out of every 1,000.
5558 * 'level' => \Psr\Log\LogLevel::WARNING
5562 $wgDebugLogGroups = array();
5565 * Default service provider for creating Psr\Log\LoggerInterface instances.
5567 * The value should be an array suitable for use with
5568 * ObjectFactory::getObjectFromSpec(). The created object is expected to
5569 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
5572 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
5573 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
5574 * and bypass the use of this configuration variable entirely.
5576 * @par To completely disable logging:
5578 * $wgMWLoggerDefaultSpi = array( 'class' => '\\MediaWiki\\Logger\\NullSpi' );
5582 * @var array $wgMWLoggerDefaultSpi
5585 $wgMWLoggerDefaultSpi = array(
5586 'class' => '\\MediaWiki\\Logger\\LegacySpi',
5590 * Display debug data at the bottom of the main content area.
5592 * Useful for developers and technical users trying to working on a closed wiki.
5594 $wgShowDebug = false;
5597 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5598 * Since 1.19 also includes memory usage.
5600 $wgDebugTimestamps = false;
5603 * Print HTTP headers for every request in the debug information.
5605 $wgDebugPrintHttpHeaders = true;
5608 * Show the contents of $wgHooks in Special:Version
5610 $wgSpecialVersionShowHooks = false;
5613 * Whether to show "we're sorry, but there has been a database error" pages.
5614 * Displaying errors aids in debugging, but may display information useful
5617 $wgShowSQLErrors = false;
5620 * If set to true, uncaught exceptions will print a complete stack trace
5621 * to output. This should only be used for debugging, as it may reveal
5622 * private information in function parameters due to PHP's backtrace
5625 $wgShowExceptionDetails = false;
5628 * If true, show a backtrace for database errors
5630 * @note This setting only applies when connection errors and query errors are
5631 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5632 * including those in which an uncaught exception is thrown from within the
5633 * exception handler.
5635 $wgShowDBErrorBacktrace = false;
5638 * If true, send the exception backtrace to the error log
5640 $wgLogExceptionBacktrace = true;
5643 * Expose backend server host names through the API and various HTML comments
5645 $wgShowHostnames = false;
5648 * Override server hostname detection with a hardcoded value.
5649 * Should be a string, default false.
5652 $wgOverrideHostname = false;
5655 * If set to true MediaWiki will throw notices for some possible error
5656 * conditions and for deprecated functions.
5658 $wgDevelopmentWarnings = false;
5661 * Release limitation to wfDeprecated warnings, if set to a release number
5662 * development warnings will not be generated for deprecations added in releases
5665 $wgDeprecationReleaseLimit = false;
5668 * Only record profiling info for pages that took longer than this
5669 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
5671 $wgProfileLimit = 0.0;
5674 * Don't put non-profiling info into log file
5676 * @deprecated since 1.23, set the log file in
5677 * $wgDebugLogGroups['profileoutput'] instead.
5679 $wgProfileOnly = false;
5682 * If true, print a raw call tree instead of per-function report
5684 $wgProfileCallTree = false;
5687 * Should application server host be put into profiling table
5689 * @deprecated set $wgProfiler['perhost'] = true instead
5691 $wgProfilePerHost = null;
5694 * Host for UDP profiler.
5696 * The host should be running a daemon which can be obtained from MediaWiki
5698 * https://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5700 * @deprecated set $wgProfiler['udphost'] instead
5702 $wgUDPProfilerHost = null;
5705 * Port for UDP profiler.
5706 * @see $wgUDPProfilerHost
5708 * @deprecated set $wgProfiler['udpport'] instead
5710 $wgUDPProfilerPort = null;
5713 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5714 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5715 * arguments. You can use sprintf's argument numbering/swapping capability to
5716 * repeat, re-order or omit fields.
5718 * @see $wgStatsFormatString
5721 * @deprecated set $wgProfiler['udpformat'] instead
5723 $wgUDPProfilerFormatString = null;
5726 * Destination for wfIncrStats() data...
5727 * 'cache' to go into the system cache, if enabled (memcached)
5728 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5731 $wgStatsMethod = 'cache';
5734 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5735 * be aggregated over more than one wiki. The string will be used in place of
5736 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5739 $wgAggregateStatsID = false;
5742 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5743 * formatted. Its value should be a format string suitable for a sprintf()
5744 * invocation with (id, count, key) arguments, where 'id' is either
5745 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5746 * is being incremented, and 'key' is the metric name.
5748 * @see $wgUDPProfilerFormatString
5749 * @see $wgAggregateStatsID
5752 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5755 * Destination of statsd metrics.
5757 * A host or host:port of a statsd server. Port defaults to 8125.
5759 * If not set, statsd metrics will not be collected.
5761 * @see wfLogProfilingData
5764 $wgStatsdServer = false;
5767 * Prefix for metric names sent to wgStatsdServer.
5769 * Defaults to "MediaWiki".
5771 * @see RequestContext::getStats
5772 * @see BufferingStatsdDataFactory
5775 $wgStatsdMetricPrefix = false;
5778 * InfoAction retrieves a list of transclusion links (both to and from).
5779 * This number puts a limit on that query in the case of highly transcluded
5782 $wgPageInfoTransclusionLimit = 50;
5785 * Set this to an integer to only do synchronous site_stats updates
5786 * one every *this many* updates. The other requests go into pending
5787 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5788 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5790 $wgSiteStatsAsyncFactor = false;
5793 * Parser test suite files to be run by parserTests.php when no specific
5794 * filename is passed to it.
5796 * Extensions may add their own tests to this array, or site-local tests
5797 * may be added via LocalSettings.php
5801 $wgParserTestFiles = array(
5802 "$IP/tests/parser/parserTests.txt",
5803 "$IP/tests/parser/extraParserTests.txt"
5807 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5809 $wgEnableJavaScriptTest = false;
5812 * Overwrite the caching key prefix with custom value.
5815 $wgCachePrefix = false;
5818 * Display the new debugging toolbar. This also enables profiling on database
5819 * queries and other useful output.
5820 * Will disable file cache.
5824 $wgDebugToolbar = false;
5826 /** @} */ # end of profiling, testing and debugging }
5828 /************************************************************************//**
5834 * Set this to true to disable the full text search feature.
5836 $wgDisableTextSearch = false;
5839 * Set to true to have nicer highlighted text in search results,
5840 * by default off due to execution overhead
5842 $wgAdvancedSearchHighlighting = false;
5845 * Regexp to match word boundaries, defaults for non-CJK languages
5846 * should be empty for CJK since the words are not separate
5848 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5851 * Template for OpenSearch suggestions, defaults to API action=opensearch
5853 * Sites with heavy load would typically have these point to a custom
5854 * PHP wrapper to avoid firing up mediawiki for every keystroke
5856 * Placeholders: {searchTerms}
5858 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
5860 $wgOpenSearchTemplate = false;
5863 * Templates for OpenSearch suggestions, defaults to API action=opensearch
5865 * Sites with heavy load would typically have these point to a custom
5866 * PHP wrapper to avoid firing up mediawiki for every keystroke
5868 * Placeholders: {searchTerms}
5870 $wgOpenSearchTemplates = array(
5871 'application/x-suggestions+json' => false,
5872 'application/x-suggestions+xml' => false,
5876 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5877 * false if you've disabled scripts that use api?action=opensearch and
5878 * want reduce load caused by cached scripts still pulling suggestions.
5879 * It will let the API fallback by responding with an empty array.
5881 $wgEnableOpenSearchSuggest = true;
5884 * Integer defining default number of entries to show on
5887 $wgOpenSearchDefaultLimit = 10;
5890 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
5892 $wgOpenSearchDescriptionLength = 100;
5895 * Expiry time for search suggestion responses
5897 $wgSearchSuggestCacheExpiry = 1200;
5900 * If you've disabled search semi-permanently, this also disables updates to the
5901 * table. If you ever re-enable, be sure to rebuild the search table.
5903 $wgDisableSearchUpdate = false;
5906 * List of namespaces which are searched by default.
5910 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5911 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5914 $wgNamespacesToBeSearchedDefault = array(
5919 * Disable the internal MySQL-based search, to allow it to be
5920 * implemented by an extension instead.
5922 $wgDisableInternalSearch = false;
5925 * Set this to a URL to forward search requests to some external location.
5926 * If the URL includes '$1', this will be replaced with the URL-encoded
5930 * To forward to Google you'd have something like:
5932 * $wgSearchForwardUrl =
5933 * 'http://www.google.com/search?q=$1' .
5934 * '&domains=http://example.com' .
5935 * '&sitesearch=http://example.com' .
5936 * '&ie=utf-8&oe=utf-8';
5939 $wgSearchForwardUrl = null;
5942 * Search form behavior.
5943 * - true = use Go & Search buttons
5944 * - false = use Go button & Advanced search link
5946 $wgUseTwoButtonsSearchForm = true;
5949 * Array of namespaces to generate a Google sitemap for when the
5950 * maintenance/generateSitemap.php script is run, or false if one is to be
5951 * generated for all namespaces.
5953 $wgSitemapNamespaces = false;
5956 * Custom namespace priorities for sitemaps. Setting this will allow you to
5957 * set custom priorities to namespaces when sitemaps are generated using the
5958 * maintenance/generateSitemap.php script.
5960 * This should be a map of namespace IDs to priority
5963 * $wgSitemapNamespacesPriorities = array(
5969 $wgSitemapNamespacesPriorities = false;
5972 * If true, searches for IP addresses will be redirected to that IP's
5973 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5974 * [[Special:Contributions/1.2.3.4]]
5976 $wgEnableSearchContributorsByIP = true;
5978 /** @} */ # end of search settings
5980 /************************************************************************//**
5981 * @name Edit user interface
5986 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5987 * fall back to the old behavior (no merging).
5989 $wgDiff3 = '/usr/bin/diff3';
5992 * Path to the GNU diff utility.
5994 $wgDiff = '/usr/bin/diff';
5997 * Which namespaces have special treatment where they should be preview-on-open
5998 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5999 * can specify namespaces of pages they have special treatment for
6001 $wgPreviewOnOpenNamespaces = array(
6006 * Enable the UniversalEditButton for browsers that support it
6007 * (currently only Firefox with an extension)
6008 * See http://universaleditbutton.org for more background information
6010 $wgUniversalEditButton = true;
6013 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6014 * will try to automatically create one. This feature can be disabled by set-
6015 * ting this variable false.
6017 $wgUseAutomaticEditSummaries = true;
6019 /** @} */ # end edit UI }
6021 /************************************************************************//**
6023 * See also $wgSiteNotice
6028 * @cond file_level_code
6029 * Set $wgCommandLineMode if it's not set already, to avoid notices
6031 if ( !isset( $wgCommandLineMode ) ) {
6032 $wgCommandLineMode = false;
6037 * For colorized maintenance script output, is your terminal background dark ?
6039 $wgCommandLineDarkBg = false;
6042 * Set this to a string to put the wiki into read-only mode. The text will be
6043 * used as an explanation to users.
6045 * This prevents most write operations via the web interface. Cache updates may
6046 * still be possible. To prevent database writes completely, use the read_only
6052 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6053 * Its contents will be shown to users as part of the read-only warning
6056 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6058 $wgReadOnlyFile = false;
6061 * When you run the web-based upgrade utility, it will tell you what to set
6062 * this to in order to authorize the upgrade process. It will subsequently be
6063 * used as a password, to authorize further upgrades.
6065 * For security, do not set this to a guessable string. Use the value supplied
6066 * by the install/upgrade process. To cause the upgrader to generate a new key,
6067 * delete the old key from LocalSettings.php.
6069 $wgUpgradeKey = false;
6072 * Fully specified path to git binary
6074 $wgGitBin = '/usr/bin/git';
6077 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6079 * Key is a pattern passed to preg_match() and preg_replace(),
6080 * without the delimiters (which are #) and must match the whole URL.
6081 * The value is the replacement for the key (it can contain $1, etc.)
6082 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6083 * full SHA-1 of the HEAD revision.
6084 * %r will be replaced with a URL-encoded version of $1.
6088 $wgGitRepositoryViewers = array(
6089 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6090 'https://git.wikimedia.org/tree/%r/%H',
6091 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6092 'https://git.wikimedia.org/tree/%r/%H',
6095 /** @} */ # End of maintenance }
6097 /************************************************************************//**
6098 * @name Recent changes, new pages, watchlist and history
6103 * Recentchanges items are periodically purged; entries older than this many
6105 * Default: 90 days = about three months
6107 $wgRCMaxAge = 90 * 24 * 3600;
6110 * Page watchers inactive for more than this many seconds are considered inactive.
6111 * Used mainly by action=info. Default: 180 days = about six months.
6114 $wgWatchersMaxAge = 180 * 24 * 3600;
6117 * If active watchers (per above) are this number or less, do not disclose it.
6118 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6119 * Set to -1 if you want to always complement watchers count with this info.
6122 $wgUnwatchedPageSecret = 1;
6125 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6126 * higher than what will be stored. Note that this is disabled by default
6127 * because we sometimes do have RC data which is beyond the limit for some
6128 * reason, and some users may use the high numbers to display that data which
6131 $wgRCFilterByAge = false;
6134 * List of Limits options to list in the Special:Recentchanges and
6135 * Special:Recentchangeslinked pages.
6137 $wgRCLinkLimits = array( 50, 100, 250, 500 );
6140 * List of Days options to list in the Special:Recentchanges and
6141 * Special:Recentchangeslinked pages.
6143 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
6146 * Destinations to which notifications about recent changes
6149 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
6150 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
6152 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
6154 * The common options are:
6155 * * 'uri' -- the address to which the notices are to be sent.
6156 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
6157 * produce the text to send. This can also be an object of the class.
6158 * * 'omit_bots' -- whether the bot edits should be in the feed
6159 * * 'omit_anon' -- whether anonymous edits should be in the feed
6160 * * 'omit_user' -- whether edits by registered users should be in the feed
6161 * * 'omit_minor' -- whether minor edits should be in the feed
6162 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
6164 * The IRC-specific options are:
6165 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
6166 * the first entry in the $wgLocalInterwikis array (or the value of
6167 * $wgLocalInterwiki, if set)
6169 * The JSON-specific options are:
6170 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6172 * @example $wgRCFeeds['example'] = array(
6173 * 'formatter' => 'JSONRCFeedFormatter',
6174 * 'uri' => "udp://localhost:1336",
6175 * 'add_interwiki_prefix' => false,
6176 * 'omit_bots' => true,
6178 * @example $wgRCFeeds['exampleirc'] = array(
6179 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6180 * 'uri' => "udp://localhost:1338",
6181 * 'add_interwiki_prefix' => false,
6182 * 'omit_bots' => true,
6186 $wgRCFeeds = array();
6189 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
6190 * Keys are scheme names, values are names of engine classes.
6192 $wgRCEngines = array(
6193 'redis' => 'RedisPubSubFeedEngine',
6194 'udp' => 'UDPRCFeedEngine',
6198 * Treat category membership changes as a RecentChange.
6199 * Changes are mentioned in RC for page actions as follows:
6200 * - creation: pages created with categories are mentioned
6201 * - edit: category additions/removals to existing pages are mentioned
6202 * - move: nothing is mentioned (unless templates used depend on the title)
6203 * - deletion: nothing is mentioned
6204 * - undeletion: nothing is mentioned
6208 $wgRCWatchCategoryMembership = false;
6211 * Use RC Patrolling to check for vandalism
6213 $wgUseRCPatrol = true;
6216 * Use new page patrolling to check new pages on Special:Newpages
6218 $wgUseNPPatrol = true;
6221 * Log autopatrol actions to the log table
6223 $wgLogAutopatrol = true;
6226 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6231 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6232 * eg Recentchanges, Newpages.
6237 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6238 * A cached version will continue to be served out even if changes
6239 * are made, until this many seconds runs out since the last render.
6241 * If set to 0, feed caching is disabled. Use this for debugging only;
6242 * feed generation can be pretty slow with diffs.
6244 $wgFeedCacheTimeout = 60;
6247 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6248 * pages larger than this size.
6250 $wgFeedDiffCutoff = 32768;
6253 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6254 * every page. Some sites might have a different feed they'd like to promote
6255 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6256 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6259 * Configure the 'atom' feed to http://example.com/somefeed.xml
6261 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6264 $wgOverrideSiteFeed = array();
6267 * Available feeds objects.
6268 * Should probably only be defined when a page is syndicated ie when
6269 * $wgOut->isSyndicated() is true.
6271 $wgFeedClasses = array(
6273 'atom' => 'AtomFeed',
6277 * Which feed types should we provide by default? This can include 'rss',
6278 * 'atom', neither, or both.
6280 $wgAdvertisedFeedTypes = array( 'atom' );
6283 * Show watching users in recent changes, watchlist and page history views
6285 $wgRCShowWatchingUsers = false; # UPO
6288 * Show the amount of changed characters in recent changes
6290 $wgRCShowChangedSize = true;
6293 * If the difference between the character counts of the text
6294 * before and after the edit is below that value, the value will be
6295 * highlighted on the RC page.
6297 $wgRCChangedSizeThreshold = 500;
6300 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6301 * view for watched pages with new changes
6303 $wgShowUpdatedMarker = true;
6306 * Disable links to talk pages of anonymous users (IPs) in listings on special
6307 * pages like page history, Special:Recentchanges, etc.
6309 $wgDisableAnonTalk = false;
6312 * Enable filtering of categories in Recentchanges
6314 $wgAllowCategorizedRecentChanges = false;
6317 * Allow filtering by change tag in recentchanges, history, etc
6318 * Has no effect if no tags are defined in valid_tag.
6320 $wgUseTagFilter = true;
6323 * If set to an integer, pages that are watched by this many users or more
6324 * will not require the unwatchedpages permission to view the number of
6329 $wgUnwatchedPageThreshold = false;
6332 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6333 * certain types of edits.
6335 * To register a new one:
6337 * $wgRecentChangesFlags['flag'] => array(
6338 * // message for the letter displayed next to rows on changes lists
6339 * 'letter' => 'letter-msg',
6340 * // message for the tooltip of the letter
6341 * 'title' => 'tooltip-msg',
6342 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6343 * 'legend' => 'legend-msg',
6344 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6345 * 'class' => 'css-class',
6351 $wgRecentChangesFlags = array(
6353 'letter' => 'newpageletter',
6354 'title' => 'recentchanges-label-newpage',
6355 'legend' => 'recentchanges-legend-newpage',
6358 'letter' => 'minoreditletter',
6359 'title' => 'recentchanges-label-minor',
6360 'legend' => 'recentchanges-legend-minor',
6361 'class' => 'minoredit',
6364 'letter' => 'boteditletter',
6365 'title' => 'recentchanges-label-bot',
6366 'legend' => 'recentchanges-legend-bot',
6367 'class' => 'botedit',
6369 'unpatrolled' => array(
6370 'letter' => 'unpatrolledletter',
6371 'title' => 'recentchanges-label-unpatrolled',
6372 'legend' => 'recentchanges-legend-unpatrolled',
6376 /** @} */ # end RC/watchlist }
6378 /************************************************************************//**
6379 * @name Copyright and credits settings
6384 * Override for copyright metadata.
6386 * This is the name of the page containing information about the wiki's copyright status,
6387 * which will be added as a link in the footer if it is specified. It overrides
6388 * $wgRightsUrl if both are specified.
6390 $wgRightsPage = null;
6393 * Set this to specify an external URL containing details about the content license used on your
6395 * If $wgRightsPage is set then this setting is ignored.
6397 $wgRightsUrl = null;
6400 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6402 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6403 * of the page will also be used as the link if this variable is not set.
6405 $wgRightsText = null;
6408 * Override for copyright metadata.
6410 $wgRightsIcon = null;
6413 * Set this to some HTML to override the rights icon with an arbitrary logo
6414 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
6416 $wgCopyrightIcon = null;
6419 * Set this to true if you want detailed copyright information forms on Upload.
6421 $wgUseCopyrightUpload = false;
6424 * Set this to the number of authors that you want to be credited below an
6425 * article text. Set it to zero to hide the attribution block, and a negative
6426 * number (like -1) to show all authors. Note that this will require 2-3 extra
6427 * database hits, which can have a not insignificant impact on performance for
6433 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6434 * Otherwise, link to a separate credits page.
6436 $wgShowCreditsIfMax = true;
6438 /** @} */ # end of copyright and credits settings }
6440 /************************************************************************//**
6441 * @name Import / Export
6446 * List of interwiki prefixes for wikis we'll accept as sources for
6447 * Special:Import and API action=import. Since complete page history can be
6448 * imported, these should be 'trusted'.
6450 * This can either be a regular array, or an associative map specifying
6451 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6454 * $wgImportSources = array(
6455 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6457 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6461 * If you have a very complex import sources setup, you can lazy-load it using
6462 * the ImportSources hook.
6464 * If a user has the 'import' permission but not the 'importupload' permission,
6465 * they will only be able to run imports through this transwiki interface.
6467 $wgImportSources = array();
6470 * Optional default target namespace for interwiki imports.
6471 * Can use this to create an incoming "transwiki"-style queue.
6472 * Set to numeric key, not the name.
6474 * Users may override this in the Special:Import dialog.
6476 $wgImportTargetNamespace = null;
6479 * If set to false, disables the full-history option on Special:Export.
6480 * This is currently poorly optimized for long edit histories, so is
6481 * disabled on Wikimedia's sites.
6483 $wgExportAllowHistory = true;
6486 * If set nonzero, Special:Export requests for history of pages with
6487 * more revisions than this will be rejected. On some big sites things
6488 * could get bogged down by very very long pages.
6490 $wgExportMaxHistory = 0;
6493 * Return distinct author list (when not returning full history)
6495 $wgExportAllowListContributors = false;
6498 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6499 * up to this specified level, which will cause it to include all
6500 * pages linked to from the pages you specify. Since this number
6501 * can become *insanely large* and could easily break your wiki,
6502 * it's disabled by default for now.
6504 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6505 * crazy-big export from being done by someone setting the depth number too
6506 * high. In other words, last resort safety net.
6508 $wgExportMaxLinkDepth = 0;
6511 * Whether to allow the "export all pages in namespace" option
6513 $wgExportFromNamespaces = false;
6516 * Whether to allow exporting the entire wiki into a single file
6518 $wgExportAllowAll = false;
6520 /** @} */ # end of import/export }
6522 /*************************************************************************//**
6528 * A list of callback functions which are called once MediaWiki is fully
6531 $wgExtensionFunctions = array();
6534 * Extension messages files.
6536 * Associative array mapping extension name to the filename where messages can be
6537 * found. The file should contain variable assignments. Any of the variables
6538 * present in languages/messages/MessagesEn.php may be defined, but $messages
6539 * is the most common.
6541 * Variables defined in extensions will override conflicting variables defined
6544 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6545 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6546 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6547 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6549 * Extensions using the JSON message format can preserve backward compatibility with
6550 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6551 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6552 * as for the $wgMessagesDirs entry.
6556 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6559 $wgExtensionMessagesFiles = array();
6562 * Extension messages directories.
6564 * Associative array mapping extension name to the path of the directory where message files can
6565 * be found. The message files are expected to be JSON files named for their language code, e.g.
6566 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6567 * message directories.
6569 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6571 * @par Simple example:
6573 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6576 * @par Complex example:
6578 * $wgMessagesDirs['Example'] = array(
6579 * __DIR__ . '/lib/ve/i18n',
6580 * __DIR__ . '/lib/oojs-ui/i18n',
6581 * __DIR__ . '/i18n',
6586 $wgMessagesDirs = array();
6589 * Array of files with list(s) of extension entry points to be used in
6590 * maintenance/mergeMessageFileList.php
6593 $wgExtensionEntryPointListFiles = array();
6596 * Parser output hooks.
6597 * This is an associative array where the key is an extension-defined tag
6598 * (typically the extension name), and the value is a PHP callback.
6599 * These will be called as an OutputPageParserOutput hook, if the relevant
6600 * tag has been registered with the parser output object.
6602 * Registration is done with $pout->addOutputHook( $tag, $data ).
6604 * The callback has the form:
6606 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6609 $wgParserOutputHooks = array();
6612 * Whether to include the NewPP limit report as a HTML comment
6614 $wgEnableParserLimitReporting = true;
6617 * List of valid skin names
6619 * The key should be the name in all lower case, the value should be a properly
6620 * cased name for the skin. This value will be prefixed with "Skin" to create
6621 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6622 * if you wish to have access to the full list.
6624 $wgValidSkinNames = array();
6627 * Special page list. This is an associative array mapping the (canonical) names of
6628 * special pages to either a class name to be instantiated, or a callback to use for
6629 * creating the special page object. In both cases, the result must be an instance of
6632 $wgSpecialPages = array();
6635 * Array mapping class names to filenames, for autoloading.
6637 $wgAutoloadClasses = array();
6640 * Switch controlling legacy case-insensitive classloading.
6641 * Do not disable if your wiki must support data created by PHP4, or by
6642 * MediaWiki 1.4 or earlier.
6644 $wgAutoloadAttemptLowercase = true;
6647 * An array of information about installed extensions keyed by their type.
6649 * All but 'name', 'path' and 'author' can be omitted.
6652 * $wgExtensionCredits[$type][] = array(
6653 * 'path' => __FILE__,
6654 * 'name' => 'Example extension',
6655 * 'namemsg' => 'exampleextension-name',
6656 * 'author' => array(
6659 * 'version' => '1.9.0',
6660 * 'url' => 'http://example.org/example-extension/',
6661 * 'descriptionmsg' => 'exampleextension-desc',
6662 * 'license-name' => 'GPL-2.0+',
6666 * The extensions are listed on Special:Version. This page also looks for a file
6667 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6668 * view said file. When the 'license-name' key is specified, this file is
6669 * interpreted as wikitext.
6671 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6672 * 'skin', 'api', or 'other', or any additional types as specified through the
6673 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6675 * - name: Name of extension as an inline string instead of localizable message.
6676 * Do not omit this even if 'namemsg' is provided, as it is used to override
6677 * the path Special:Version uses to find extension's license info, and is
6678 * required for backwards-compatibility with MediaWiki 1.23 and older.
6680 * - namemsg (since MW 1.24): A message key for a message containing the
6681 * extension's name, if the name is localizable. (For example, skin names
6684 * - author: A string or an array of strings. Authors can be linked using
6685 * the regular wikitext link syntax. To have an internationalized version of
6686 * "and others" show, add an element "...". This element can also be linked,
6687 * for instance "[http://example ...]".
6689 * - descriptionmsg: A message key or an an array with message key and parameters:
6690 * `'descriptionmsg' => 'exampleextension-desc',`
6692 * - description: Description of extension as an inline string instead of
6693 * localizable message (omit in favour of 'descriptionmsg').
6695 * - license-name: Short name of the license (used as label for the link), such
6696 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6698 $wgExtensionCredits = array();
6701 * Authentication plugin.
6702 * @var $wgAuth AuthPlugin
6707 * Global list of hooks.
6709 * The key is one of the events made available by MediaWiki, you can find
6710 * a description for most of them in docs/hooks.txt. The array is used
6711 * internally by Hook:run().
6713 * The value can be one of:
6715 * - A function name:
6717 * $wgHooks['event_name'][] = $function;
6719 * - A function with some data:
6721 * $wgHooks['event_name'][] = array( $function, $data );
6723 * - A an object method:
6725 * $wgHooks['event_name'][] = array( $object, 'method' );
6729 * $wgHooks['event_name'][] = function ( $hookParam ) {
6730 * // Handler code goes here.
6734 * @warning You should always append to an event array or you will end up
6735 * deleting a previous registered hook.
6737 * @warning Hook handlers should be registered at file scope. Registering
6738 * handlers after file scope can lead to unexpected results due to caching.
6743 * Maps jobs to their handling classes; extensions
6744 * can add to this to provide custom jobs
6746 $wgJobClasses = array(
6747 'refreshLinks' => 'RefreshLinksJob',
6748 'deleteLinks' => 'DeleteLinksJob',
6749 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6750 'sendMail' => 'EmaillingJob',
6751 'enotifNotify' => 'EnotifNotifyJob',
6752 'fixDoubleRedirect' => 'DoubleRedirectJob',
6753 'uploadFromUrl' => 'UploadFromUrlJob',
6754 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6755 'PublishStashedFile' => 'PublishStashedFileJob',
6756 'ThumbnailRender' => 'ThumbnailRenderJob',
6757 'recentChangesUpdate' => 'RecentChangesUpdateJob',
6758 'refreshLinksPrioritized' => 'RefreshLinksJob', // for cascading protection
6759 'refreshLinksDynamic' => 'RefreshLinksJob', // for pages with dynamic content
6760 'activityUpdateJob' => 'ActivityUpdateJob',
6761 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
6762 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
6767 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6768 * special flags are set. The values here are keys of $wgJobClasses.
6771 * - Very long-running jobs.
6772 * - Jobs that you would never want to run as part of a page rendering request.
6773 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6774 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6775 * These settings should be global to all wikis.
6777 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6780 * Map of job types to how many job "work items" should be run per second
6781 * on each job runner process. The meaning of "work items" varies per job,
6782 * but typically would be something like "pages to update". A single job
6783 * may have a variable number of work items, as is the case with batch jobs.
6784 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6785 * These settings should be global to all wikis.
6788 $wgJobBackoffThrottling = array();
6791 * Make job runners commit changes for slave-lag prone jobs one job at a time.
6792 * This is useful if there are many job workers that race on slave lag checks.
6793 * If set, jobs taking this many seconds of DB write time have serialized commits.
6795 * Note that affected jobs may have worse lock contention. Also, if they affect
6796 * several DBs at once they may have a smaller chance of being atomic due to the
6797 * possibility of connection loss while queueing up to commit. Affected jobs may
6798 * also fail due to the commit lock acquisition timeout.
6803 $wgJobSerialCommitThreshold = false;
6806 * Map of job types to configuration arrays.
6807 * This determines which queue class and storage system is used for each job type.
6808 * Job types that do not have explicit configuration will use the 'default' config.
6809 * These settings should be global to all wikis.
6811 $wgJobTypeConf = array(
6812 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ),
6816 * Which aggregator to use for tracking which queues have jobs.
6817 * These settings should be global to all wikis.
6819 $wgJobQueueAggregator = array(
6820 'class' => 'JobQueueAggregatorNull'
6824 * Additional functions to be performed with updateSpecialPages.
6825 * Expensive Querypages are already updated.
6827 $wgSpecialPageCacheUpdates = array(
6828 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' )
6832 * Hooks that are used for outputting exceptions. Format is:
6833 * $wgExceptionHooks[] = $funcname
6835 * $wgExceptionHooks[] = array( $class, $funcname )
6836 * Hooks should return strings or false
6838 $wgExceptionHooks = array();
6841 * Page property link table invalidation lists. When a page property
6842 * changes, this may require other link tables to be updated (eg
6843 * adding __HIDDENCAT__ means the hiddencat tracking category will
6844 * have been added, so the categorylinks table needs to be rebuilt).
6845 * This array can be added to by extensions.
6847 $wgPagePropLinkInvalidations = array(
6848 'hiddencat' => 'categorylinks',
6851 /** @} */ # End extensions }
6853 /*************************************************************************//**
6859 * Use experimental, DMOZ-like category browser
6861 $wgUseCategoryBrowser = false;
6864 * On category pages, show thumbnail gallery for images belonging to that
6865 * category instead of listing them as articles.
6867 $wgCategoryMagicGallery = true;
6870 * Paging limit for categories
6872 $wgCategoryPagingLimit = 200;
6875 * Specify how category names should be sorted, when listed on a category page.
6876 * A sorting scheme is also known as a collation.
6878 * Available values are:
6880 * - uppercase: Converts the category name to upper case, and sorts by that.
6882 * - identity: Does no conversion. Sorts by binary value of the string.
6884 * - uca-default: Provides access to the Unicode Collation Algorithm with
6885 * the default element table. This is a compromise collation which sorts
6886 * all languages in a mediocre way. However, it is better than "uppercase".
6888 * To use the uca-default collation, you must have PHP's intl extension
6889 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6890 * resulting collation will depend on the version of ICU installed on the
6893 * After you change this, you must run maintenance/updateCollation.php to fix
6894 * the sort keys in the database.
6896 * Extensions can define there own collations by subclassing Collation
6897 * and using the Collation::factory hook.
6899 $wgCategoryCollation = 'uppercase';
6901 /** @} */ # End categories }
6903 /*************************************************************************//**
6909 * The logging system has two levels: an event type, which describes the
6910 * general category and can be viewed as a named subset of all logs; and
6911 * an action, which is a specific kind of event that can exist in that
6914 $wgLogTypes = array(
6932 * This restricts log access to those who have a certain right
6933 * Users without this will not see it in the option menu and can not view it
6934 * Restricted logs are not added to recent changes
6935 * Logs should remain non-transcludable
6936 * Format: logtype => permissiontype
6938 $wgLogRestrictions = array(
6939 'suppress' => 'suppressionlog'
6943 * Show/hide links on Special:Log will be shown for these log types.
6945 * This is associative array of log type => boolean "hide by default"
6947 * See $wgLogTypes for a list of available log types.
6951 * $wgFilterLogTypes = array(
6953 * 'import' => false,
6957 * Will display show/hide links for the move and import logs. Move logs will be
6958 * hidden by default unless the link is clicked. Import logs will be shown by
6959 * default, and hidden when the link is clicked.
6961 * A message of the form log-show-hide-[type] should be added, and will be used
6962 * for the link text.
6964 $wgFilterLogTypes = array(
6970 * Lists the message key string for each log type. The localized messages
6971 * will be listed in the user interface.
6973 * Extensions with custom log types may add to this array.
6975 * @since 1.19, if you follow the naming convention log-name-TYPE,
6976 * where TYPE is your log type, yoy don't need to use this array.
6978 $wgLogNames = array(
6979 '' => 'all-logs-page',
6980 'block' => 'blocklogpage',
6981 'protect' => 'protectlogpage',
6982 'rights' => 'rightslog',
6983 'delete' => 'dellogpage',
6984 'upload' => 'uploadlogpage',
6985 'move' => 'movelogpage',
6986 'import' => 'importlogpage',
6987 'patrol' => 'patrol-log-page',
6988 'merge' => 'mergelog',
6989 'suppress' => 'suppressionlog',
6993 * Lists the message key string for descriptive text to be shown at the
6994 * top of each log type.
6996 * Extensions with custom log types may add to this array.
6998 * @since 1.19, if you follow the naming convention log-description-TYPE,
6999 * where TYPE is your log type, yoy don't need to use this array.
7001 $wgLogHeaders = array(
7002 '' => 'alllogstext',
7003 'block' => 'blocklogtext',
7004 'delete' => 'dellogpagetext',
7005 'import' => 'importlogpagetext',
7006 'merge' => 'mergelogpagetext',
7007 'move' => 'movelogpagetext',
7008 'patrol' => 'patrol-log-header',
7009 'protect' => 'protectlogtext',
7010 'rights' => 'rightslogtext',
7011 'suppress' => 'suppressionlogtext',
7012 'upload' => 'uploadlogpagetext',
7016 * Lists the message key string for formatting individual events of each
7017 * type and action when listed in the logs.
7019 * Extensions with custom log types may add to this array.
7021 $wgLogActions = array();
7024 * The same as above, but here values are names of classes,
7026 * @see LogPage::actionText
7029 $wgLogActionsHandlers = array(
7030 'block/block' => 'BlockLogFormatter',
7031 'block/reblock' => 'BlockLogFormatter',
7032 'block/unblock' => 'BlockLogFormatter',
7033 'contentmodel/change' => 'ContentModelLogFormatter',
7034 'delete/delete' => 'DeleteLogFormatter',
7035 'delete/event' => 'DeleteLogFormatter',
7036 'delete/restore' => 'DeleteLogFormatter',
7037 'delete/revision' => 'DeleteLogFormatter',
7038 'import/interwiki' => 'ImportLogFormatter',
7039 'import/upload' => 'ImportLogFormatter',
7040 'managetags/activate' => 'LogFormatter',
7041 'managetags/create' => 'LogFormatter',
7042 'managetags/deactivate' => 'LogFormatter',
7043 'managetags/delete' => 'LogFormatter',
7044 'merge/merge' => 'MergeLogFormatter',
7045 'move/move' => 'MoveLogFormatter',
7046 'move/move_redir' => 'MoveLogFormatter',
7047 'patrol/patrol' => 'PatrolLogFormatter',
7048 'protect/modify' => 'ProtectLogFormatter',
7049 'protect/move_prot' => 'ProtectLogFormatter',
7050 'protect/protect' => 'ProtectLogFormatter',
7051 'protect/unprotect' => 'ProtectLogFormatter',
7052 'rights/autopromote' => 'RightsLogFormatter',
7053 'rights/rights' => 'RightsLogFormatter',
7054 'suppress/block' => 'BlockLogFormatter',
7055 'suppress/delete' => 'DeleteLogFormatter',
7056 'suppress/event' => 'DeleteLogFormatter',
7057 'suppress/reblock' => 'BlockLogFormatter',
7058 'suppress/revision' => 'DeleteLogFormatter',
7059 'tag/update' => 'TagLogFormatter',
7060 'upload/overwrite' => 'UploadLogFormatter',
7061 'upload/revert' => 'UploadLogFormatter',
7062 'upload/upload' => 'UploadLogFormatter',
7066 * Maintain a log of newusers at Log/newusers?
7068 $wgNewUserLog = true;
7070 /** @} */ # end logging }
7072 /*************************************************************************//**
7073 * @name Special pages (general and miscellaneous)
7078 * Allow special page inclusions such as {{Special:Allpages}}
7080 $wgAllowSpecialInclusion = true;
7083 * Set this to an array of special page names to prevent
7084 * maintenance/updateSpecialPages.php from updating those pages.
7086 $wgDisableQueryPageUpdate = false;
7089 * On Special:Unusedimages, consider images "used", if they are put
7090 * into a category. Default (false) is not to count those as used.
7092 $wgCountCategorizedImagesAsUsed = false;
7095 * Maximum number of links to a redirect page listed on
7096 * Special:Whatlinkshere/RedirectDestination
7098 $wgMaxRedirectLinksRetrieved = 500;
7100 /** @} */ # end special pages }
7102 /*************************************************************************//**
7108 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7109 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7110 * 'foo' => true Load the class FooAction which subclasses Action
7111 * If something is specified in the getActionOverrides()
7112 * of the relevant Page object it will be used
7113 * instead of the default class.
7114 * 'foo' => false The action is disabled; show an error message
7115 * Unsetting core actions will probably cause things to complain loudly.
7121 'editchangetags' => 'SpecialPageAction',
7124 'markpatrolled' => true,
7130 'revisiondelete' => 'SpecialPageAction',
7133 'unprotect' => true,
7139 /** @} */ # end actions }
7141 /*************************************************************************//**
7142 * @name Robot (search engine crawler) policy
7143 * See also $wgNoFollowLinks.
7148 * Default robot policy. The default policy is to encourage indexing and fol-
7149 * lowing of links. It may be overridden on a per-namespace and/or per-page
7152 $wgDefaultRobotPolicy = 'index,follow';
7155 * Robot policies per namespaces. The default policy is given above, the array
7156 * is made of namespace constants as defined in includes/Defines.php. You can-
7157 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7158 * nofollow. This is because a number of special pages (e.g., ListPages) have
7159 * many permutations of options that display the same data under redundant
7160 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7161 * pages, all alike, and never reaching your actual content.
7165 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
7168 $wgNamespaceRobotPolicies = array();
7171 * Robot policies per article. These override the per-namespace robot policies.
7172 * Must be in the form of an array where the key part is a properly canonicalised
7173 * text form title and the value is a robot policy.
7177 * $wgArticleRobotPolicies = array(
7178 * 'Main Page' => 'noindex,follow',
7179 * 'User:Bob' => 'index,follow',
7183 * @par Example that DOES NOT WORK because the names are not canonical text
7186 * $wgArticleRobotPolicies = array(
7187 * # Underscore, not space!
7188 * 'Main_Page' => 'noindex,follow',
7189 * # "Project", not the actual project name!
7190 * 'Project:X' => 'index,follow',
7191 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7192 * 'abc' => 'noindex,nofollow'
7196 $wgArticleRobotPolicies = array();
7199 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7200 * will not function, so users can't decide whether pages in that namespace are
7201 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7205 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
7208 $wgExemptFromUserRobotsControl = null;
7210 /** @} */ # End robot policy }
7212 /************************************************************************//**
7213 * @name AJAX and API
7214 * Note: The AJAX entry point which this section refers to is gradually being
7215 * replaced by the API entry point, api.php. They are essentially equivalent.
7216 * Both of them are used for dynamic client-side features, via XHR.
7221 * Enable the MediaWiki API for convenient access to
7222 * machine-readable data via api.php
7224 * See https://www.mediawiki.org/wiki/API
7226 $wgEnableAPI = true;
7229 * Allow the API to be used to perform write operations
7230 * (page edits, rollback, etc.) when an authorised user
7233 $wgEnableWriteAPI = true;
7237 * WARNING: SECURITY THREAT - debug use only
7239 * Disables many security checks in the API for debugging purposes.
7240 * This flag should never be used on the production servers, as it introduces
7241 * a number of potential security holes. Even when enabled, the validation
7242 * will still be performed, but instead of failing, API will return a warning.
7243 * Also, there will always be a warning notifying that this flag is set.
7244 * At this point, the flag allows GET requests to go through for modules
7249 $wgDebugAPI = false;
7252 * API module extensions.
7254 * Associative array mapping module name to modules specs;
7255 * Each module spec is an associative array containing at least
7256 * the 'class' key for the module's class, and optionally a
7257 * 'factory' key for the factory function to use for the module.
7259 * That factory function will be called with two parameters,
7260 * the parent module (an instance of ApiBase, usually ApiMain)
7261 * and the name the module was registered under. The return
7262 * value must be an instance of the class given in the 'class'
7265 * For backward compatibility, the module spec may also be a
7266 * simple string containing the module's class name. In that
7267 * case, the class' constructor will be called with the parent
7268 * module and module name as parameters, as described above.
7270 * Examples for registering API modules:
7273 * $wgAPIModules['foo'] = 'ApiFoo';
7274 * $wgAPIModules['bar'] = array(
7275 * 'class' => 'ApiBar',
7276 * 'factory' => function( $main, $name ) { ... }
7278 * $wgAPIModules['xyzzy'] = array(
7279 * 'class' => 'ApiXyzzy',
7280 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
7284 * Extension modules may override the core modules.
7285 * See ApiMain::$Modules for a list of the core modules.
7287 $wgAPIModules = array();
7290 * API format module extensions.
7291 * Associative array mapping format module name to module specs (see $wgAPIModules).
7292 * Extension modules may override the core modules.
7294 * See ApiMain::$Formats for a list of the core format modules.
7296 $wgAPIFormatModules = array();
7299 * API Query meta module extensions.
7300 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7301 * Extension modules may override the core modules.
7303 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7305 $wgAPIMetaModules = array();
7308 * API Query prop module extensions.
7309 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7310 * Extension modules may override the core modules.
7312 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7314 $wgAPIPropModules = array();
7317 * API Query list module extensions.
7318 * Associative array mapping list module name to module specs (see $wgAPIModules).
7319 * Extension modules may override the core modules.
7321 * See ApiQuery::$QueryListModules for a list of the core list modules.
7323 $wgAPIListModules = array();
7326 * Maximum amount of rows to scan in a DB query in the API
7327 * The default value is generally fine
7329 $wgAPIMaxDBRows = 5000;
7332 * The maximum size (in bytes) of an API result.
7333 * @warning Do not set this lower than $wgMaxArticleSize*1024
7335 $wgAPIMaxResultSize = 8388608;
7338 * The maximum number of uncached diffs that can be retrieved in one API
7339 * request. Set this to 0 to disable API diffs altogether
7341 $wgAPIMaxUncachedDiffs = 1;
7344 * Maximum amount of DB lag on a majority of DB slaves to tolerate
7345 * before forcing bots to retry any write requests via API errors.
7346 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
7348 $wgAPIMaxLagThreshold = 7;
7351 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7352 * API request logging
7354 $wgAPIRequestLog = false;
7357 * Set the timeout for the API help text cache. If set to 0, caching disabled
7359 $wgAPICacheHelpTimeout = 60 * 60;
7362 * The ApiQueryQueryPages module should skip pages that are redundant to true
7365 $wgAPIUselessQueryPages = array(
7366 'MIMEsearch', // aiprop=mime
7367 'LinkSearch', // list=exturlusage
7368 'FileDuplicateSearch', // prop=duplicatefiles
7372 * Enable AJAX framework
7377 * List of Ajax-callable functions.
7378 * Extensions acting as Ajax callbacks must register here
7380 $wgAjaxExportList = array();
7383 * Enable AJAX check for file overwrite, pre-upload
7385 $wgAjaxUploadDestCheck = true;
7388 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7390 $wgAjaxLicensePreview = true;
7393 * Have clients send edits to be prepared when filling in edit summaries.
7394 * This gives the server a head start on the expensive parsing operation.
7396 $wgAjaxEditStash = true;
7399 * Settings for incoming cross-site AJAX requests:
7400 * Newer browsers support cross-site AJAX when the target resource allows requests
7401 * from the origin domain by the Access-Control-Allow-Origin header.
7402 * This is currently only used by the API (requests to api.php)
7403 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7405 * - '*' matches any number of characters
7406 * - '?' matches any 1 character
7410 * $wgCrossSiteAJAXdomains = array(
7411 * 'www.mediawiki.org',
7412 * '*.wikipedia.org',
7413 * '*.wikimedia.org',
7414 * '*.wiktionary.org',
7418 $wgCrossSiteAJAXdomains = array();
7421 * Domains that should not be allowed to make AJAX requests,
7422 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7423 * Uses the same syntax as $wgCrossSiteAJAXdomains
7425 $wgCrossSiteAJAXdomainExceptions = array();
7427 /** @} */ # End AJAX and API }
7429 /************************************************************************//**
7430 * @name Shell and process control
7435 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7437 $wgMaxShellMemory = 307200;
7440 * Maximum file size created by shell processes under linux, in KB
7441 * ImageMagick convert for example can be fairly hungry for scratch space
7443 $wgMaxShellFileSize = 102400;
7446 * Maximum CPU time in seconds for shell processes under Linux
7448 $wgMaxShellTime = 180;
7451 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7452 * would measure) in seconds for shell processes under Linux
7454 $wgMaxShellWallClockTime = 180;
7457 * Under Linux: a cgroup directory used to constrain memory usage of shell
7458 * commands. The directory must be writable by the user which runs MediaWiki.
7460 * If specified, this is used instead of ulimit, which is inaccurate, and
7461 * causes malloc() to return NULL, which exposes bugs in C applications, making
7462 * them segfault or deadlock.
7464 * A wrapper script will create a cgroup for each shell command that runs, as
7465 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7466 * kernel will send a SIGKILL signal to a process in the subgroup.
7470 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7471 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7472 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7475 * The reliability of cgroup cleanup can be improved by installing a
7476 * notify_on_release script in the root cgroup, see e.g.
7477 * https://gerrit.wikimedia.org/r/#/c/40784
7479 $wgShellCgroup = false;
7482 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7484 $wgPhpCli = '/usr/bin/php';
7487 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7488 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7489 * character set. Only the character set is relevant.
7491 $wgShellLocale = 'en_US.utf8';
7493 /** @} */ # End shell }
7495 /************************************************************************//**
7501 * Timeout for HTTP requests done internally, in seconds.
7503 $wgHTTPTimeout = 25;
7506 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7508 $wgAsyncHTTPTimeout = 25;
7511 * Proxy to use for CURL requests.
7513 $wgHTTPProxy = false;
7516 * Local virtual hosts.
7518 * This lists domains that are configured as virtual hosts on the same machine.
7519 * If a request is to be made to a domain listed here, or any subdomain thereof,
7520 * then no proxy will be used.
7521 * Command-line scripts are not affected by this setting and will always use
7522 * proxy if it is configured.
7525 $wgLocalVirtualHosts = array();
7528 * Timeout for connections done internally (in seconds)
7529 * Only works for curl
7531 $wgHTTPConnectTimeout = 5e0
;
7533 /** @} */ # End HTTP client }
7535 /************************************************************************//**
7537 * See also $wgEnotifUseJobQ.
7542 * Number of jobs to perform per request. May be less than one in which case
7543 * jobs are performed probabalistically. If this is zero, jobs will not be done
7544 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7545 * be run periodically.
7550 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7551 * to handle the job execution, instead of blocking the request until the job
7552 * execution finishes.
7555 $wgRunJobsAsync = true;
7558 * Number of rows to update per job
7560 $wgUpdateRowsPerJob = 300;
7563 * Number of rows to update per query
7565 $wgUpdateRowsPerQuery = 100;
7567 /** @} */ # End job queue }
7569 /************************************************************************//**
7570 * @name Miscellaneous
7575 * Name of the external diff engine to use
7577 $wgExternalDiffEngine = false;
7580 * Disable redirects to special pages and interwiki redirects, which use a 302
7581 * and have no "redirected from" link.
7583 * @note This is only for articles with #REDIRECT in them. URL's containing a
7584 * local interwiki prefix (or a non-canonical special page name) are still hard
7585 * redirected regardless of this setting.
7587 $wgDisableHardRedirects = false;
7590 * LinkHolderArray batch size
7593 $wgLinkHolderBatchSize = 1000;
7596 * By default MediaWiki does not register links pointing to same server in
7597 * externallinks dataset, use this value to override:
7599 $wgRegisterInternalExternals = false;
7602 * Maximum number of pages to move at once when moving subpages with a page.
7604 $wgMaximumMovedPages = 100;
7607 * Fix double redirects after a page move.
7608 * Tends to conflict with page move vandalism, use only on a private wiki.
7610 $wgFixDoubleRedirects = false;
7613 * Allow redirection to another page when a user logs in.
7614 * To enable, set to a string like 'Main Page'
7616 $wgRedirectOnLogin = null;
7619 * Configuration for processing pool control, for use in high-traffic wikis.
7620 * An implementation is provided in the PoolCounter extension.
7622 * This configuration array maps pool types to an associative array. The only
7623 * defined key in the associative array is "class", which gives the class name.
7624 * The remaining elements are passed through to the class as constructor
7629 * $wgPoolCounterConf = array( 'ArticleView' => array(
7630 * 'class' => 'PoolCounter_Client',
7631 * 'timeout' => 15, // wait timeout in seconds
7632 * 'workers' => 5, // maximum number of active threads in each pool
7633 * 'maxqueue' => 50, // maximum number of total threads in each pool
7634 * ... any extension-specific options...
7638 $wgPoolCounterConf = null;
7641 * To disable file delete/restore temporarily
7643 $wgUploadMaintenance = false;
7646 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7647 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7648 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7649 * (except for the special case of JS and CS pages).
7653 $wgNamespaceContentModels = array();
7656 * How to react if a plain text version of a non-text Content object is requested using
7657 * ContentHandler::getContentText():
7659 * * 'ignore': return null
7660 * * 'fail': throw an MWException
7661 * * 'serialize': serialize to default format
7665 $wgContentHandlerTextFallback = 'ignore';
7668 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7669 * This way, the ContentHandler facility can be used without any additional information in the
7670 * database. A page's content model is then derived solely from the page's title. This however
7671 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7672 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7673 * a title that would default to a different content model.
7675 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7676 * handling is less robust and less flexible.
7680 $wgContentHandlerUseDB = true;
7683 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7684 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7685 * the effect on the database they would have on a wikitext page.
7687 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7688 * or at least parse only the contents of comments in the scripts.
7692 $wgTextModelsToParse = array(
7693 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
7694 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
7695 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
7699 * Whether the user must enter their password to change their e-mail address
7703 $wgRequirePasswordforEmailChange = true;
7706 * Register handlers for specific types of sites.
7710 $wgSiteTypes = array(
7711 'mediawiki' => 'MediaWikiSite',
7715 * Whether the page_props table has a pp_sortkey column. Set to false in case
7716 * the respective database schema change was not applied.
7719 $wgPagePropsHaveSortkey = true;
7722 * Port where you have HTTPS running
7723 * Supports HTTPS on non-standard ports
7730 * Secret for hmac-based key derivation function (fast,
7731 * cryptographically secure random numbers).
7732 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7734 * See also: $wgHKDFAlgorithm
7737 $wgHKDFSecret = false;
7740 * Algorithm for hmac-based key derivation function (fast,
7741 * cryptographically secure random numbers).
7742 * See also: $wgHKDFSecret
7745 $wgHKDFAlgorithm = 'sha256';
7748 * Enable page language feature
7749 * Allows setting page language in database
7753 $wgPageLanguageUseDB = false;
7756 * Global configuration variable for Virtual REST Services.
7757 * Parameters for different services are to be declared inside
7758 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
7759 * array. Global parameters will be merged with service-specific ones. The
7760 * result will then be passed to VirtualRESTService::__construct() in the
7763 * Example config for Parsoid:
7765 * $wgVirtualRestConfig['modules']['parsoid'] = array(
7766 * 'url' => 'http://localhost:8000',
7767 * 'prefix' => 'enwiki',
7768 * 'domain' => 'en.wikipedia.org',
7774 $wgVirtualRestConfig = array(
7775 'modules' => array(),
7777 # Timeout in seconds
7779 # 'domain' is set to $wgCanonicalServer in Setup.php
7780 'forwardCookies' => false,
7786 * Controls whether zero-result search queries with suggestions should display results for
7787 * these suggestions.
7792 $wgSearchRunSuggestedQuery = true;
7795 * For really cool vim folding this needs to be at the end:
7796 * vim: foldmarker=@{,@} foldmethod=marker