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
71 'main' => 'GlobalVarConfig::newInstance'
75 * MediaWiki version number
78 $wgVersion = '1.28.0-alpha';
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
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 * Additional characters that are not allowed in filenames. They are replaced with '-' when
402 * uploading. Like $wgLegalTitleChars, this is a regexp character class.
404 * Slashes and backslashes are disallowed regardless of this setting, but included here for
407 $wgIllegalFileChars = ":\\/\\\\";
410 * What directory to place deleted uploads in.
411 * Defaults to "{$wgUploadDirectory}/deleted".
413 $wgDeletedDirectory = false;
416 * Set this to true if you use img_auth and want the user to see details on why access failed.
418 $wgImgAuthDetails = false;
421 * Map of relative URL directories to match to internal mwstore:// base storage paths.
422 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
423 * if starts with any of the prefixes defined here. The prefixes should not overlap.
424 * The prefix that matches has a corresponding storage path, which the rest of the URL
425 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
428 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
429 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
430 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
432 * @see $wgFileBackends
434 $wgImgAuthUrlPathMap = [];
437 * File repository structures
439 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
440 * an array of such structures. Each repository structure is an associative
441 * array of properties configuring the repository.
443 * Properties required for all repos:
444 * - class The class name for the repository. May come from the core or an extension.
445 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
446 * FSRepo is also supported for backwards compatibility.
448 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
449 * The name should consist of alpha-numeric characters.
450 * - backend A file backend name (see $wgFileBackends).
452 * For most core repos:
453 * - zones Associative array of zone names that each map to an array with:
454 * container : backend container name the zone is in
455 * directory : root path within container for the zone
456 * url : base URL to the root of the zone
457 * urlsByExt : map of file extension types to base URLs
458 * (useful for using a different cache for videos)
459 * Zones default to using "<repo name>-<zone name>" as the container name
460 * and default to using the container root as the zone's root directory.
461 * Nesting of zone locations within other zones should be avoided.
462 * - url Public zone URL. The 'zones' settings take precedence.
463 * - hashLevels The number of directory levels for hash-based division of files
464 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
465 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
467 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
468 * determines whether filenames implicitly start with a capital letter.
469 * The current implementation may give incorrect description page links
470 * when the local $wgCapitalLinks and initialCapital are mismatched.
471 * - pathDisclosureProtection
472 * May be 'paranoid' to remove all parameters from error messages, 'none' to
473 * leave the paths in unchanged, or 'simple' to replace paths with
474 * placeholders. Default for LocalRepo is 'simple'.
475 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
477 * - directory The local filesystem directory where public files are stored. Not used for
479 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
480 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
481 * - isPrivate Set this if measures should always be taken to keep the files private.
482 * One should not trust this to assure that the files are not web readable;
483 * the server configuration should be done manually depending on the backend.
485 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
486 * for local repositories:
487 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
488 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
489 * https://en.wikipedia.org/w
490 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
491 * $wgScriptExtension, e.g. ".php5". Defaults to ".php".
493 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
494 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
495 * $wgFetchCommonsDescriptions.
496 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
497 * Short thumbnail names only have the width, parameters, and the extension.
500 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
501 * equivalent to the corresponding member of $wgDBservers
502 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
503 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
506 * - apibase Use for the foreign API's URL
507 * - apiThumbCacheExpiry How long to locally cache thumbs for
509 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
510 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
511 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
512 * If you set $wgForeignFileRepos to an array of repository structures, those will
513 * be searched after the local file repo.
514 * Otherwise, you will only have access to local media files.
516 * @see Setup.php for an example usage and default initialization.
518 $wgLocalFileRepo = false;
521 * @see $wgLocalFileRepo
523 $wgForeignFileRepos = [];
526 * Use Commons as a remote file repository. Essentially a wrapper, when this
527 * is enabled $wgForeignFileRepos will point at Commons with a set of default
530 $wgUseInstantCommons = false;
533 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
534 * are allowable upload targets. These wikis must have some method of
535 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
536 * The string 'local' signifies the default local file repository.
539 * $wgForeignUploadTargets = [ 'shared' ];
541 $wgForeignUploadTargets = [ 'local' ];
544 * Configuration for file uploads using the embeddable upload dialog
545 * (https://www.mediawiki.org/wiki/Upload_dialog).
547 * This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis
548 * using the action=query&meta=siteinfo API).
550 * See below for documentation of each property. None of the properties may be omitted.
553 // Fields to make available in the dialog. `true` means that this field is visible, `false` means
554 // that it is hidden. The "Name" field can't be hidden. Note that you also have to add the
555 // matching replacement to the 'filepage' format key below to make use of these.
557 'description' => true,
559 'categories' => false,
561 // Suffix of localisation messages used to describe the license under which the uploaded file will
562 // be released. The same value may be set for both 'local' and 'foreign' uploads.
563 'licensemessages' => [
564 // The 'local' messages are used for local uploads on this wiki:
565 // * upload-form-label-own-work-message-generic-local
566 // * upload-form-label-not-own-work-message-generic-local
567 // * upload-form-label-not-own-work-local-generic-local
568 'local' => 'generic-local',
569 // The 'foreign' messages are used for cross-wiki uploads from other wikis to this wiki:
570 // * upload-form-label-own-work-message-generic-foreign
571 // * upload-form-label-not-own-work-message-generic-foreign
572 // * upload-form-label-not-own-work-local-generic-foreign
573 'foreign' => 'generic-foreign',
575 // Upload comments to use for 'local' and 'foreign' uploads. This can also be set to a single
576 // string value, in which case it is used for both kinds of uploads. Available replacements:
577 // * $HOST - domain name from which a cross-wiki upload originates
578 // * $PAGENAME - wiki page name from which an upload originates
583 // Format of the file page wikitext to be generated from the fields input by the user.
585 // Wrapper for the whole page. Available replacements:
586 // * $DESCRIPTION - file description, as input by the user (only if the 'description' field is
587 // enabled), wrapped as defined below in the 'description' key
588 // * $DATE - file creation date, as input by the user (only if the 'date' field is enabled)
589 // * $SOURCE - as defined below in the 'ownwork' key, may be extended in the future
590 // * $AUTHOR - linked user name, may be extended in the future
591 // * $LICENSE - as defined below in the 'license' key, may be extended in the future
592 // * $CATEGORIES - file categories wikitext, as input by the user (only if the 'categories'
593 // field is enabled), or if no input, as defined below in the 'uncategorized' key
594 'filepage' => '$DESCRIPTION',
595 // Wrapped for file description. Available replacements:
596 // * $LANGUAGE - source wiki's content language
597 // * $TEXT - input by the user
598 'description' => '$TEXT',
601 'uncategorized' => '',
606 * File backend structure configuration.
608 * This is an array of file backend configuration arrays.
609 * Each backend configuration has the following parameters:
610 * - 'name' : A unique name for the backend
611 * - 'class' : The file backend class to use
612 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
613 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
615 * See FileBackend::__construct() for more details.
616 * Additional parameters are specific to the file backend class used.
617 * These settings should be global to all wikis when possible.
619 * There are two particularly important aspects about each backend:
620 * - a) Whether it is fully qualified or wiki-relative.
621 * By default, the paths of files are relative to the current wiki,
622 * which works via prefixing them with the current wiki ID when accessed.
623 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
624 * all paths with the specified value instead. This can be useful if
625 * multiple wikis need to share the same data. Note that 'name' is *not*
626 * part of any prefix and thus should not be relied upon for namespacing.
627 * - b) Whether it is only defined for some wikis or is defined on all
628 * wikis in the wiki farm. Defining a backend globally is useful
629 * if multiple wikis need to share the same data.
630 * One should be aware of these aspects when configuring a backend for use with
631 * any basic feature or plugin. For example, suppose an extension stores data for
632 * different wikis in different directories and sometimes needs to access data from
633 * a foreign wiki's directory in order to render a page on given wiki. The extension
634 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
636 $wgFileBackends = [];
639 * Array of configuration arrays for each lock manager.
640 * Each backend configuration has the following parameters:
641 * - 'name' : A unique name for the lock manager
642 * - 'class' : The lock manger class to use
644 * See LockManager::__construct() for more details.
645 * Additional parameters are specific to the lock manager class used.
646 * These settings should be global to all wikis.
648 $wgLockManagers = [];
651 * Show Exif data, on by default if available.
652 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
654 * @note FOR WINDOWS USERS:
655 * To enable Exif functions, add the following line to the "Windows
656 * extensions" section of php.ini:
658 * extension=extensions/php_exif.dll
661 $wgShowEXIF = function_exists( 'exif_read_data' );
664 * If to automatically update the img_metadata field
665 * if the metadata field is outdated but compatible with the current version.
668 $wgUpdateCompatibleMetadata = false;
671 * If you operate multiple wikis, you can define a shared upload path here.
672 * Uploads to this wiki will NOT be put there - they will be put into
673 * $wgUploadDirectory.
674 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
675 * no file of the given name is found in the local repository (for [[File:..]],
676 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
679 * Note that these configuration settings can now be defined on a per-
680 * repository basis for an arbitrary number of file repositories, using the
681 * $wgForeignFileRepos variable.
683 $wgUseSharedUploads = false;
686 * Full path on the web server where shared uploads can be found
688 $wgSharedUploadPath = null;
691 * Fetch commons image description pages and display them on the local wiki?
693 $wgFetchCommonsDescriptions = false;
696 * Path on the file system where shared uploads can be found.
698 $wgSharedUploadDirectory = null;
701 * DB name with metadata about shared directory.
702 * Set this to false if the uploads do not come from a wiki.
704 $wgSharedUploadDBname = false;
707 * Optional table prefix used in database.
709 $wgSharedUploadDBprefix = '';
712 * Cache shared metadata in memcached.
713 * Don't do this if the commons wiki is in a different memcached domain
715 $wgCacheSharedUploads = true;
718 * Allow for upload to be copied from an URL.
719 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
720 * You have to assign the user right 'upload_by_url' to a user group, to use this.
722 $wgAllowCopyUploads = false;
725 * A list of domains copy uploads can come from
729 $wgCopyUploadsDomains = [];
732 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
733 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
734 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
736 $wgCopyUploadsFromSpecialUpload = false;
739 * Proxy to use for copy upload requests.
742 $wgCopyUploadProxy = false;
745 * Different timeout for upload by url
746 * This could be useful since when fetching large files, you may want a
747 * timeout longer than the default $wgHTTPTimeout. False means fallback
752 $wgCopyUploadTimeout = false;
755 * Max size for uploads, in bytes. If not set to an array, applies to all
756 * uploads. If set to an array, per upload type maximums can be set, using the
757 * file and url keys. If the * key is set this value will be used as maximum
758 * for non-specified types.
762 * $wgMaxUploadSize = [
764 * 'url' => 500 * 1024,
767 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
768 * will have a maximum of 500 kB.
770 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
773 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
774 * chunks smaller than this will be rejected. May be reduced based on the
775 * 'upload_max_filesize' or 'post_max_size' PHP settings.
778 $wgMinUploadChunkSize = 1024; # 1KB
781 * Point the upload navigation link to an external URL
782 * Useful if you want to use a shared repository by default
783 * without disabling local uploads (use $wgEnableUploads = false for that).
787 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
790 $wgUploadNavigationUrl = false;
793 * Point the upload link for missing files to an external URL, as with
794 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
795 * appended to it as appropriate.
797 $wgUploadMissingFileUrl = false;
800 * Give a path here to use thumb.php for thumbnail generation on client
801 * request, instead of generating them on render and outputting a static URL.
802 * This is necessary if some of your apache servers don't have read/write
803 * access to the thumbnail path.
807 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
810 $wgThumbnailScriptPath = false;
813 * @see $wgThumbnailScriptPath
815 $wgSharedThumbnailScriptPath = false;
818 * Set this to false if you do not want MediaWiki to divide your images
819 * directory into many subdirectories, for improved performance.
821 * It's almost always good to leave this enabled. In previous versions of
822 * MediaWiki, some users set this to false to allow images to be added to the
823 * wiki by simply copying them into $wgUploadDirectory and then running
824 * maintenance/rebuildImages.php to register them in the database. This is no
825 * longer recommended, use maintenance/importImages.php instead.
827 * @note That this variable may be ignored if $wgLocalFileRepo is set.
828 * @todo Deprecate the setting and ultimately remove it from Core.
830 $wgHashedUploadDirectory = true;
833 * Set the following to false especially if you have a set of files that need to
834 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
837 $wgHashedSharedUploadDirectory = true;
840 * Base URL for a repository wiki. Leave this blank if uploads are just stored
841 * in a shared directory and not meant to be accessible through a separate wiki.
842 * Otherwise the image description pages on the local wiki will link to the
843 * image description page on this wiki.
845 * Please specify the namespace, as in the example below.
847 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
850 * This is the list of preferred extensions for uploading files. Uploading files
851 * with extensions not in this list will trigger a warning.
853 * @warning If you add any OpenOffice or Microsoft Office file formats here,
854 * such as odt or doc, and untrusted users are allowed to upload files, then
855 * your wiki will be vulnerable to cross-site request forgery (CSRF).
857 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ];
860 * Files with these extensions will never be allowed as uploads.
861 * An array of file extensions to blacklist. You should append to this array
862 * if you want to blacklist additional files.
865 # HTML may contain cookie-stealing JavaScript and web bugs
866 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
867 # PHP scripts may execute arbitrary code on the server
868 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
869 # Other types that may be interpreted by some servers
870 'shtml', 'jhtml', 'pl', 'py', 'cgi',
871 # May contain harmful executables for Windows victims
872 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ];
875 * Files with these MIME types will never be allowed as uploads
876 * if $wgVerifyMimeType is enabled.
878 $wgMimeTypeBlacklist = [
879 # HTML may contain cookie-stealing JavaScript and web bugs
880 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
881 # PHP scripts may execute arbitrary code on the server
882 'application/x-php', 'text/x-php',
883 # Other types that may be interpreted by some servers
884 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
885 # Client-side hazards on Internet Explorer
886 'text/scriptlet', 'application/x-msdownload',
887 # Windows metafile, client-side vulnerability on some systems
888 'application/x-msmetafile',
892 * Allow Java archive uploads.
893 * This is not recommended for public wikis since a maliciously-constructed
894 * applet running on the same domain as the wiki can steal the user's cookies.
896 $wgAllowJavaUploads = false;
899 * This is a flag to determine whether or not to check file extensions on upload.
901 * @warning Setting this to false is insecure for public wikis.
903 $wgCheckFileExtensions = true;
906 * If this is turned off, users may override the warning for files not covered
907 * by $wgFileExtensions.
909 * @warning Setting this to false is insecure for public wikis.
911 $wgStrictFileExtensions = true;
914 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
916 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
917 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
919 $wgDisableUploadScriptChecks = false;
922 * Warn if uploaded files are larger than this (in bytes), or false to disable
924 $wgUploadSizeWarning = false;
927 * list of trusted media-types and MIME types.
928 * Use the MEDIATYPE_xxx constants to represent media types.
929 * This list is used by File::isSafeFile
931 * Types not listed here will have a warning about unsafe content
932 * displayed on the images description page. It would also be possible
933 * to use this for further restrictions, like disabling direct
934 * [[media:...]] links for non-trusted formats.
936 $wgTrustedMediaFormats = [
937 MEDIATYPE_BITMAP
, // all bitmap formats
938 MEDIATYPE_AUDIO
, // all audio formats
939 MEDIATYPE_VIDEO
, // all plain video formats
940 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
941 "application/pdf", // PDF files
942 # "application/x-shockwave-flash", //flash/shockwave movie
946 * Plugins for media file type handling.
947 * Each entry in the array maps a MIME type to a class name
949 * Core media handlers are listed in MediaHandlerFactory,
950 * and extensions should use extension.json.
952 $wgMediaHandlers = [];
955 * Plugins for page content model handling.
956 * Each entry in the array maps a model id to a class name or callback
957 * that creates an instance of the appropriate ContentHandler subclass.
961 $wgContentHandlers = [
963 CONTENT_MODEL_WIKITEXT
=> 'WikitextContentHandler',
964 // dumb version, no syntax highlighting
965 CONTENT_MODEL_JAVASCRIPT
=> 'JavaScriptContentHandler',
966 // simple implementation, for use by extensions, etc.
967 CONTENT_MODEL_JSON
=> 'JsonContentHandler',
968 // dumb version, no syntax highlighting
969 CONTENT_MODEL_CSS
=> 'CssContentHandler',
970 // plain text, for use by extensions, etc.
971 CONTENT_MODEL_TEXT
=> 'TextContentHandler',
975 * Whether to enable server-side image thumbnailing. If false, images will
976 * always be sent to the client in full resolution, with appropriate width= and
977 * height= attributes on the <img> tag for the client to do its own scaling.
979 $wgUseImageResize = true;
982 * Resizing can be done using PHP's internal image libraries or using
983 * ImageMagick or another third-party converter, e.g. GraphicMagick.
984 * These support more file formats than PHP, which only supports PNG,
985 * GIF, JPG, XBM and WBMP.
987 * Use Image Magick instead of PHP builtin functions.
989 $wgUseImageMagick = false;
992 * The convert command shipped with ImageMagick
994 $wgImageMagickConvertCommand = '/usr/bin/convert';
997 * Array of max pixel areas for interlacing per MIME type
1000 $wgMaxInterlacingAreas = [];
1003 * Sharpening parameter to ImageMagick
1005 $wgSharpenParameter = '0x0.4';
1008 * Reduction in linear dimensions below which sharpening will be enabled
1010 $wgSharpenReductionThreshold = 0.85;
1013 * Temporary directory used for ImageMagick. The directory must exist. Leave
1014 * this set to false to let ImageMagick decide for itself.
1016 $wgImageMagickTempDir = false;
1019 * Use another resizing converter, e.g. GraphicMagick
1020 * %s will be replaced with the source path, %d with the destination
1021 * %w and %h will be replaced with the width and height.
1023 * @par Example for GraphicMagick:
1025 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
1028 * Leave as false to skip this.
1030 $wgCustomConvertCommand = false;
1033 * used for lossless jpeg rotation
1037 $wgJpegTran = '/usr/bin/jpegtran';
1040 * At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma
1041 * subsampling to reduce file size, at the cost of possible color fringing
1044 * See https://en.wikipedia.org/wiki/Chroma_subsampling
1047 * false - use scaling system's default (same as pre-1.27 behavior)
1048 * 'yuv444' - luma and chroma at same resolution
1049 * 'yuv422' - chroma at 1/2 resolution horizontally, full vertically
1050 * 'yuv420' - chroma at 1/2 resolution in both dimensions
1052 * This setting is currently supported only for the ImageMagick backend;
1053 * others may default to 4:2:0 or 4:4:4 or maintaining the source file's
1054 * sampling in the thumbnail.
1058 $wgJpegPixelFormat = 'yuv420';
1061 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1064 $wgExiv2Command = '/usr/bin/exiv2';
1067 * Path to exiftool binary. Used for lossless ICC profile swapping.
1071 $wgExiftool = '/usr/bin/exiftool';
1074 * Scalable Vector Graphics (SVG) may be uploaded as images.
1075 * Since SVG support is not yet standard in browsers, it is
1076 * necessary to rasterize SVGs to PNG as a fallback format.
1078 * An external program is required to perform this conversion.
1079 * If set to an array, the first item is a PHP callable and any further items
1080 * are passed as parameters after $srcPath, $dstPath, $width, $height
1082 $wgSVGConverters = [
1084 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1085 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1086 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1087 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1089 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1090 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1091 'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
1095 * Pick a converter defined in $wgSVGConverters
1097 $wgSVGConverter = 'ImageMagick';
1100 * If not in the executable PATH, specify the SVG converter path.
1102 $wgSVGConverterPath = '';
1105 * Don't scale a SVG larger than this
1107 $wgSVGMaxSize = 5120;
1110 * Don't read SVG metadata beyond this point.
1111 * Default is 1024*256 bytes
1113 $wgSVGMetadataCutoff = 262144;
1116 * Disallow <title> element in SVG files.
1118 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1119 * browsers which can not perform basic stuff like MIME detection and which are
1120 * vulnerable to further idiots uploading crap files as images.
1122 * When this directive is on, "<title>" will be allowed in files with an
1123 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1124 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1126 $wgAllowTitlesInSVG = false;
1129 * The maximum number of pixels a source image can have if it is to be scaled
1130 * down by a scaler that requires the full source image to be decompressed
1131 * and stored in decompressed form, before the thumbnail is generated.
1133 * This provides a limit on memory usage for the decompression side of the
1134 * image scaler. The limit is used when scaling PNGs with any of the
1135 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1136 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1138 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1139 * 12.5 million pixels or 3500x3500.
1141 $wgMaxImageArea = 1.25e7
;
1144 * Force thumbnailing of animated GIFs above this size to a single
1145 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1146 * is checked against the total size of all frames in the animation.
1147 * It probably makes sense to keep this equal to $wgMaxImageArea.
1149 $wgMaxAnimatedGifArea = 1.25e7
;
1152 * Browsers don't support TIFF inline generally...
1153 * For inline display, we need to convert to PNG or JPEG.
1154 * Note scaling should work with ImageMagick, but may not with GD scaling.
1158 * // PNG is lossless, but inefficient for photos
1159 * $wgTiffThumbnailType = [ 'png', 'image/png' ];
1160 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1161 * $wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];
1164 $wgTiffThumbnailType = false;
1167 * If rendered thumbnail files are older than this timestamp, they
1168 * will be rerendered on demand as if the file didn't already exist.
1169 * Update if there is some need to force thumbs and SVG rasterizations
1170 * to rerender, such as fixes to rendering bugs.
1172 $wgThumbnailEpoch = '20030516000000';
1175 * Certain operations are avoided if there were too many recent failures,
1176 * for example, thumbnail generation. Bump this value to invalidate all
1177 * memory of failed operations and thus allow further attempts to resume.
1178 * This is useful when a cause for the failures has been found and fixed.
1180 $wgAttemptFailureEpoch = 1;
1183 * If set, inline scaled images will still produce "<img>" tags ready for
1184 * output instead of showing an error message.
1186 * This may be useful if errors are transitory, especially if the site
1187 * is configured to automatically render thumbnails on request.
1189 * On the other hand, it may obscure error conditions from debugging.
1190 * Enable the debug log or the 'thumbnail' log group to make sure errors
1191 * are logged to a file for review.
1193 $wgIgnoreImageErrors = false;
1196 * Allow thumbnail rendering on page view. If this is false, a valid
1197 * thumbnail URL is still output, but no file will be created at
1198 * the target location. This may save some time if you have a
1199 * thumb.php or 404 handler set up which is faster than the regular
1202 $wgGenerateThumbnailOnParse = true;
1205 * Show thumbnails for old images on the image description page
1207 $wgShowArchiveThumbnails = true;
1210 * If set to true, images that contain certain the exif orientation tag will
1211 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1212 * is available that can rotate.
1214 $wgEnableAutoRotation = null;
1217 * Internal name of virus scanner. This serves as a key to the
1218 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1219 * null, every file uploaded will be scanned for viruses.
1221 $wgAntivirus = null;
1224 * Configuration for different virus scanners. This an associative array of
1225 * associative arrays. It contains one setup array per known scanner type.
1226 * The entry is selected by $wgAntivirus, i.e.
1227 * valid values for $wgAntivirus are the keys defined in this array.
1229 * The configuration array for each scanner contains the following keys:
1230 * "command", "codemap", "messagepattern":
1232 * "command" is the full command to call the virus scanner - %f will be
1233 * replaced with the name of the file to scan. If not present, the filename
1234 * will be appended to the command. Note that this must be overwritten if the
1235 * scanner is not in the system path; in that case, please set
1236 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1239 * "codemap" is a mapping of exit code to return codes of the detectVirus
1240 * function in SpecialUpload.
1241 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1242 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1244 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1245 * the file to have an unsupported format, which is probably immune to
1246 * viruses. This causes the file to pass.
1247 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1248 * no virus was found.
1249 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1251 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1253 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1254 * output. The relevant part should be matched as group one (\1).
1255 * If not defined or the pattern does not match, the full message is shown to the user.
1257 $wgAntivirusSetup = [
1261 'command' => 'clamscan --no-summary ',
1263 "0" => AV_NO_VIRUS
, # no virus
1264 "1" => AV_VIRUS_FOUND
, # virus found
1265 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1266 "*" => AV_SCAN_FAILED
, # else scan failed
1268 'messagepattern' => '/.*?:(.*)/sim',
1273 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1275 $wgAntivirusRequired = true;
1278 * Determines if the MIME type of uploaded files should be checked
1280 $wgVerifyMimeType = true;
1283 * Sets the MIME type definition file to use by MimeMagic.php.
1284 * Set to null, to use built-in defaults only.
1285 * example: $wgMimeTypeFile = '/etc/mime.types';
1287 $wgMimeTypeFile = 'includes/mime.types';
1290 * Sets the MIME type info file to use by MimeMagic.php.
1291 * Set to null, to use built-in defaults only.
1293 $wgMimeInfoFile = 'includes/mime.info';
1296 * Sets an external MIME detector program. The command must print only
1297 * the MIME type to standard output.
1298 * The name of the file to process will be appended to the command given here.
1299 * If not set or NULL, PHP's fileinfo extension will be used if available.
1303 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1306 $wgMimeDetectorCommand = null;
1309 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1310 * things, because only a few types of images are needed and file extensions
1313 $wgTrivialMimeDetection = false;
1316 * Additional XML types we can allow via MIME-detection.
1317 * array = [ 'rootElement' => 'associatedMimeType' ]
1320 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1321 'svg' => 'image/svg+xml',
1322 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1323 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1324 'html' => 'text/html', // application/xhtml+xml?
1328 * Limit images on image description pages to a user-selectable limit. In order
1329 * to reduce disk usage, limits can only be selected from a list.
1330 * The user preference is saved as an array offset in the database, by default
1331 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1332 * change it if you alter the array (see bug 8858).
1333 * This is the list of settings the user can choose from:
1344 * Adjust thumbnails on image pages according to a user setting. In order to
1345 * reduce disk usage, the values can only be selected from a list. This is the
1346 * list of settings the user can choose from:
1358 * When defined, is an array of image widths used as buckets for thumbnail generation.
1359 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1360 * always using the original. This will incur a speed gain but cause a quality loss.
1362 * The buckets generation is chained, with each bucket generated based on the above bucket
1363 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1366 $wgThumbnailBuckets = null;
1369 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1370 * above the requested size. The distance represents how many extra pixels of width the bucket
1371 * needs in order to be used as the reference for a given thumbnail. For example, with the
1372 * following buckets:
1374 * $wgThumbnailBuckets = [ 128, 256, 512 ];
1376 * and a distance of 50:
1378 * $wgThumbnailMinimumBucketDistance = 50;
1380 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1381 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1383 $wgThumbnailMinimumBucketDistance = 50;
1386 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1387 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1388 * has a performance impact for the first client to view a certain size.
1390 * This obviously means that more disk space is needed per upload upfront.
1395 $wgUploadThumbnailRenderMap = [];
1398 * The method through which the thumbnails will be prerendered for the entries in
1399 * $wgUploadThumbnailRenderMap
1401 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1403 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1404 * option uses the job queue to render the thumbnail.
1408 $wgUploadThumbnailRenderMethod = 'jobqueue';
1411 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1415 $wgUploadThumbnailRenderHttpCustomHost = false;
1418 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1423 $wgUploadThumbnailRenderHttpCustomDomain = false;
1426 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1427 * (and free) TinyRGB profile when generating thumbnails.
1431 $wgUseTinyRGBForJPGThumbnails = false;
1434 * Default parameters for the "<gallery>" tag
1436 $wgGalleryOptions = [
1437 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1438 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1439 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1440 'captionLength' => true, // Deprecated @since 1.28
1441 // Length to truncate filename to in caption when using "showfilename".
1442 // A value of 'true' will truncate the filename to one line using CSS
1443 // and will be the behaviour after deprecation.
1444 'showBytes' => true, // Show the filesize in bytes in categories
1445 'mode' => 'traditional',
1449 * Adjust width of upright images when parameter 'upright' is used
1450 * This allows a nicer look for upright images without the need to fix the width
1451 * by hardcoded px in wiki sourcecode.
1453 $wgThumbUpright = 0.75;
1456 * Default value for chmoding of new directories.
1458 $wgDirectoryMode = 0777;
1461 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1463 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1464 * thumbnails, output via the srcset attribute.
1466 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1467 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1468 * The polyfill can be found in the jquery.hidpi module.
1470 $wgResponsiveImages = true;
1473 * @name DJVU settings
1478 * Path of the djvudump executable
1479 * Enable this and $wgDjvuRenderer to enable djvu rendering
1480 * example: $wgDjvuDump = 'djvudump';
1485 * Path of the ddjvu DJVU renderer
1486 * Enable this and $wgDjvuDump to enable djvu rendering
1487 * example: $wgDjvuRenderer = 'ddjvu';
1489 $wgDjvuRenderer = null;
1492 * Path of the djvutxt DJVU text extraction utility
1493 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1494 * example: $wgDjvuTxt = 'djvutxt';
1499 * Path of the djvutoxml executable
1500 * This works like djvudump except much, much slower as of version 3.5.
1502 * For now we recommend you use djvudump instead. The djvuxml output is
1503 * probably more stable, so we'll switch back to it as soon as they fix
1504 * the efficiency problem.
1505 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1509 * $wgDjvuToXML = 'djvutoxml';
1512 $wgDjvuToXML = null;
1515 * Shell command for the DJVU post processor
1516 * Default: pnmtojpeg, since ddjvu generates ppm output
1517 * Set this to false to output the ppm file directly.
1519 $wgDjvuPostProcessor = 'pnmtojpeg';
1522 * File extension for the DJVU post processor output
1524 $wgDjvuOutputExtension = 'jpg';
1526 /** @} */ # end of DJvu }
1528 /** @} */ # end of file uploads }
1530 /************************************************************************//**
1531 * @name Email settings
1536 * Site admin email address.
1538 * Defaults to "wikiadmin@$wgServerName".
1540 $wgEmergencyContact = false;
1543 * Sender email address for e-mail notifications.
1545 * The address we use as sender when a user requests a password reminder.
1547 * Defaults to "apache@$wgServerName".
1549 $wgPasswordSender = false;
1552 * Sender name for e-mail notifications.
1554 * @deprecated since 1.23; use the system message 'emailsender' instead.
1556 $wgPasswordSenderName = 'MediaWiki Mail';
1559 * Reply-To address for e-mail notifications.
1561 * Defaults to $wgPasswordSender.
1563 $wgNoReplyAddress = false;
1566 * Set to true to enable the e-mail basic features:
1567 * Password reminders, etc. If sending e-mail on your
1568 * server doesn't work, you might want to disable this.
1570 $wgEnableEmail = true;
1573 * Set to true to enable user-to-user e-mail.
1574 * This can potentially be abused, as it's hard to track.
1576 $wgEnableUserEmail = true;
1579 * Set to true to put the sending user's email in a Reply-To header
1580 * instead of From. ($wgEmergencyContact will be used as From.)
1582 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1583 * which can cause problems with SPF validation and leak recipient addresses
1584 * when bounces are sent to the sender.
1586 $wgUserEmailUseReplyTo = false;
1589 * Minimum time, in hours, which must elapse between password reminder
1590 * emails for a given account. This is to prevent abuse by mail flooding.
1592 $wgPasswordReminderResendTime = 24;
1595 * The time, in seconds, when an emailed temporary password expires.
1597 $wgNewPasswordExpiry = 3600 * 24 * 7;
1600 * The time, in seconds, when an email confirmation email expires
1602 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1605 * The number of days that a user's password is good for. After this number of days, the
1606 * user will be asked to reset their password. Set to false to disable password expiration.
1608 $wgPasswordExpirationDays = false;
1611 * If a user's password is expired, the number of seconds when they can still login,
1612 * and cancel their password change, but are sent to the password change form on each login.
1614 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1619 * For using a direct (authenticated) SMTP server connection.
1620 * Default to false or fill an array :
1624 * 'host' => 'SMTP domain',
1625 * 'IDHost' => 'domain for MessageID',
1627 * 'auth' => [true|false],
1628 * 'username' => [SMTP username],
1629 * 'password' => [SMTP password],
1636 * Additional email parameters, will be passed as the last argument to mail() call.
1638 $wgAdditionalMailParams = null;
1641 * For parts of the system that have been updated to provide HTML email content, send
1642 * both text and HTML parts as the body of the email
1644 $wgAllowHTMLEmail = false;
1647 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1648 * from $wgEmergencyContact
1650 $wgEnotifFromEditor = false;
1652 // TODO move UPO to preferences probably ?
1653 # If set to true, users get a corresponding option in their preferences and can choose to
1654 # enable or disable at their discretion
1655 # If set to false, the corresponding input form on the user preference page is suppressed
1656 # It call this to be a "user-preferences-option (UPO)"
1659 * Require email authentication before sending mail to an email address.
1660 * This is highly recommended. It prevents MediaWiki from being used as an open
1663 $wgEmailAuthentication = true;
1666 * Allow users to enable email notification ("enotif") on watchlist changes.
1668 $wgEnotifWatchlist = false;
1671 * Allow users to enable email notification ("enotif") when someone edits their
1674 * The owner of the user talk page must also have the 'enotifusertalkpages' user
1675 * preference set to true.
1677 $wgEnotifUserTalk = false;
1680 * Set the Reply-to address in notifications to the editor's address, if user
1681 * allowed this in the preferences.
1683 $wgEnotifRevealEditorAddress = false;
1686 * Potentially send notification mails on minor edits to pages. This is enabled
1687 * by default. If this is false, users will never be notified on minor edits.
1689 * If it is true, editors with the 'nominornewtalk' right (typically bots) will still not
1690 * trigger notifications for minor edits they make (to any page, not just user talk).
1692 * Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to
1693 * false, they will not receive notifications for minor edits.
1695 * User talk notifications are also affected by $wgEnotifMinorEdits, the above settings,
1696 * $wgEnotifUserTalk, and the preference described there.
1698 $wgEnotifMinorEdits = true;
1701 * Send a generic mail instead of a personalised mail for each user. This
1702 * always uses UTC as the time zone, and doesn't include the username.
1704 * For pages with many users watching, this can significantly reduce mail load.
1705 * Has no effect when using sendmail rather than SMTP.
1707 $wgEnotifImpersonal = false;
1710 * Maximum number of users to mail at once when using impersonal mail. Should
1711 * match the limit on your mail server.
1713 $wgEnotifMaxRecips = 500;
1716 * Use real name instead of username in e-mail "from" field.
1718 $wgEnotifUseRealName = false;
1721 * Array of usernames who will be sent a notification email for every change
1722 * which occurs on a wiki. Users will not be notified of their own changes.
1724 $wgUsersNotifiedOnAllChanges = [];
1726 /** @} */ # end of email settings
1728 /************************************************************************//**
1729 * @name Database settings
1734 * Database host name or IP address
1736 $wgDBserver = 'localhost';
1739 * Database port number (for PostgreSQL and Microsoft SQL Server).
1744 * Name of the database
1746 $wgDBname = 'my_wiki';
1751 $wgDBuser = 'wikiuser';
1754 * Database user's password
1761 $wgDBtype = 'mysql';
1764 * Whether to use SSL in DB connection.
1766 * This setting is only used $wgLBFactoryConf['class'] is set to
1767 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1768 * the DBO_SSL flag must be set in the 'flags' option of the database
1769 * connection to achieve the same functionality.
1774 * Whether to use compression in DB connection.
1776 * This setting is only used $wgLBFactoryConf['class'] is set to
1777 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1778 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1779 * connection to achieve the same functionality.
1781 $wgDBcompress = false;
1784 * Separate username for maintenance tasks. Leave as null to use the default.
1786 $wgDBadminuser = null;
1789 * Separate password for maintenance tasks. Leave as null to use the default.
1791 $wgDBadminpassword = null;
1795 * Leave as null to select the default search engine for the
1796 * selected database type (eg SearchMySQL), or set to a class
1797 * name to override to a custom search engine.
1799 $wgSearchType = null;
1802 * Alternative search types
1803 * Sometimes you want to support multiple search engines for testing. This
1804 * allows users to select their search engine of choice via url parameters
1805 * to Special:Search and the action=search API. If using this, there's no
1806 * need to add $wgSearchType to it, that is handled automatically.
1808 $wgSearchTypeAlternatives = null;
1816 * MySQL table options to use during installation or update
1818 $wgDBTableOptions = 'ENGINE=InnoDB';
1821 * SQL Mode - default is turning off all modes, including strict, if set.
1822 * null can be used to skip the setting for performance reasons and assume
1823 * DBA has done his best job.
1824 * String override can be used for some additional fun :-)
1831 $wgDBmwschema = null;
1834 * To override default SQLite data directory ($docroot/../data)
1836 $wgSQLiteDataDir = '';
1839 * Make all database connections secretly go to localhost. Fool the load balancer
1840 * thinking there is an arbitrarily large cluster of servers to connect to.
1841 * Useful for debugging.
1843 $wgAllDBsAreLocalhost = false;
1846 * Shared database for multiple wikis. Commonly used for storing a user table
1847 * for single sign-on. The server for this database must be the same as for the
1850 * For backwards compatibility the shared prefix is set to the same as the local
1851 * prefix, and the user table is listed in the default list of shared tables.
1852 * The user_properties table is also added so that users will continue to have their
1853 * preferences shared (preferences were stored in the user table prior to 1.16)
1855 * $wgSharedTables may be customized with a list of tables to share in the shared
1856 * database. However it is advised to limit what tables you do share as many of
1857 * MediaWiki's tables may have side effects if you try to share them.
1859 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1862 * $wgSharedSchema is the table schema for the shared database. It defaults to
1865 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1866 * access remote databases. Using wfGetLB() allows the shared database to
1867 * reside on separate servers to the wiki's own database, with suitable
1868 * configuration of $wgLBFactoryConf.
1875 $wgSharedPrefix = false;
1880 $wgSharedTables = [ 'user', 'user_properties' ];
1886 $wgSharedSchema = false;
1889 * Database load balancer
1890 * This is a two-dimensional array, an array of server info structures
1893 * - dbname: Default database name
1895 * - password: DB password
1898 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1899 * If this is zero for any given server, no normal query traffic will be
1900 * sent to it. It will be excluded from lag checks in maintenance scripts.
1901 * The only way it can receive traffic is if groupLoads is used.
1903 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1904 * to several groups, the most specific group defined here is used.
1906 * - flags: bit field
1907 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1908 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1909 * - DBO_TRX -- wrap entire request in a transaction
1910 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1911 * - DBO_PERSISTENT -- enables persistent database connections
1912 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1913 * - DBO_COMPRESS -- uses internal compression in database connections,
1916 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1917 * - is static: (optional) Set to true if the dataset is static and no replication is used.
1919 * These and any other user-defined properties will be assigned to the mLBInfo member
1920 * variable of the Database object.
1922 * Leave at false to use the single-server variables above. If you set this
1923 * variable, the single-server variables will generally be ignored (except
1924 * perhaps in some command-line scripts).
1926 * The first server listed in this array (with key 0) will be the master. The
1927 * rest of the servers will be slaves. To prevent writes to your slaves due to
1928 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1929 * slaves in my.cnf. You can set read_only mode at runtime using:
1932 * SET @@read_only=1;
1935 * Since the effect of writing to a slave is so damaging and difficult to clean
1936 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1937 * our masters, and then set read_only=0 on masters at runtime.
1939 $wgDBservers = false;
1942 * Load balancer factory configuration
1943 * To set up a multi-master wiki farm, set the class here to something that
1944 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1945 * The class identified here is responsible for reading $wgDBservers,
1946 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1948 * The LBFactoryMulti class is provided for this purpose, please see
1949 * includes/db/LBFactoryMulti.php for configuration information.
1951 $wgLBFactoryConf = [ 'class' => 'LBFactorySimple' ];
1954 * After a state-changing request is done by a client, this determines
1955 * how many seconds that client should keep using the master datacenter.
1956 * This avoids unexpected stale or 404 responses due to replication lag.
1959 $wgDataCenterUpdateStickTTL = 10;
1962 * File to log database errors to
1964 $wgDBerrorLog = false;
1967 * Timezone to use in the error log.
1968 * Defaults to the wiki timezone ($wgLocaltimezone).
1970 * A list of usable timezones can found at:
1971 * http://php.net/manual/en/timezones.php
1975 * $wgDBerrorLogTZ = 'UTC';
1976 * $wgDBerrorLogTZ = 'GMT';
1977 * $wgDBerrorLogTZ = 'PST8PDT';
1978 * $wgDBerrorLogTZ = 'Europe/Sweden';
1979 * $wgDBerrorLogTZ = 'CET';
1984 $wgDBerrorLogTZ = false;
1987 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1988 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1990 * @warning THIS IS EXPERIMENTAL!
1992 * May break if you're not using the table defs from mysql5/tables.sql.
1993 * May break if you're upgrading an existing wiki if set differently.
1994 * Broken symptoms likely to include incorrect behavior with page titles,
1995 * usernames, comments etc containing non-ASCII characters.
1996 * Might also cause failures on the object cache and other things.
1998 * Even correct usage may cause failures with Unicode supplementary
1999 * characters (those not in the Basic Multilingual Plane) unless MySQL
2000 * has enhanced their Unicode support.
2002 $wgDBmysql5 = false;
2005 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
2007 * To use this feature set to true and use a datasource defined as
2008 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
2011 * Starting from 11gR1 you can use DCRP (Database Resident Connection
2012 * Pool) that maintains established sessions and reuses them on new
2015 * Not completely tested, but it should fall back on normal connection
2016 * in case the pool is full or the datasource is not configured as
2018 * And the other way around; using oci_pconnect on a non pooled
2019 * datasource should produce a normal connection.
2021 * When it comes to frequent shortlived DB connections like with MW
2022 * Oracle tends to s***. The problem is the driver connects to the
2023 * database reasonably fast, but establishing a session takes time and
2024 * resources. MW does not rely on session state (as it does not use
2025 * features such as package variables) so establishing a valid session
2026 * is in this case an unwanted overhead that just slows things down.
2028 * @warning EXPERIMENTAL!
2031 $wgDBOracleDRCP = false;
2034 * Other wikis on this site, can be administered from a single developer
2036 * Array numeric key => database name
2038 $wgLocalDatabases = [];
2041 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
2042 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
2043 * show a more obvious warning.
2045 $wgSlaveLagWarning = 10;
2048 * @see $wgSlaveLagWarning
2050 $wgSlaveLagCritical = 30;
2053 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2055 $wgDBWindowsAuthentication = false;
2057 /**@}*/ # End of DB settings }
2059 /************************************************************************//**
2060 * @name Text storage
2065 * We can also compress text stored in the 'text' table. If this is set on, new
2066 * revisions will be compressed on page save if zlib support is available. Any
2067 * compressed revisions will be decompressed on load regardless of this setting,
2068 * but will not be readable at all* if zlib support is not available.
2070 $wgCompressRevisions = false;
2073 * External stores allow including content
2074 * from non database sources following URL links.
2076 * Short names of ExternalStore classes may be specified in an array here:
2078 * $wgExternalStores = [ "http","file","custom" ]...
2081 * CAUTION: Access to database might lead to code execution
2083 $wgExternalStores = [];
2086 * An array of external MySQL servers.
2089 * Create a cluster named 'cluster1' containing three servers:
2091 * $wgExternalServers = [
2092 * 'cluster1' => [ 'srv28', 'srv29', 'srv30' ]
2096 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2099 $wgExternalServers = [];
2102 * The place to put new revisions, false to put them in the local text table.
2103 * Part of a URL, e.g. DB://cluster1
2105 * Can be an array instead of a single string, to enable data distribution. Keys
2106 * must be consecutive integers, starting at zero.
2110 * $wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
2115 $wgDefaultExternalStore = false;
2118 * Revision text may be cached in $wgMemc to reduce load on external storage
2119 * servers and object extraction overhead for frequently-loaded revisions.
2121 * Set to 0 to disable, or number of seconds before cache expiry.
2123 $wgRevisionCacheExpiry = 0;
2125 /** @} */ # end text storage }
2127 /************************************************************************//**
2128 * @name Performance hacks and limits
2133 * Disable database-intensive features
2135 $wgMiserMode = false;
2138 * Disable all query pages if miser mode is on, not just some
2140 $wgDisableQueryPages = false;
2143 * Number of rows to cache in 'querycache' table when miser mode is on
2145 $wgQueryCacheLimit = 1000;
2148 * Number of links to a page required before it is deemed "wanted"
2150 $wgWantedPagesThreshold = 1;
2153 * Enable slow parser functions
2155 $wgAllowSlowParserFunctions = false;
2158 * Allow schema updates
2160 $wgAllowSchemaUpdates = true;
2163 * Maximum article size in kilobytes
2165 $wgMaxArticleSize = 2048;
2168 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2169 * raise PHP's memory limit if it's below this amount.
2171 $wgMemoryLimit = "50M";
2174 * The minimum amount of time that MediaWiki needs for "slow" write request,
2175 * particularly ones with multiple non-atomic writes that *should* be as
2176 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2179 $wgTransactionalTimeLimit = 120;
2181 /** @} */ # end performance hacks }
2183 /************************************************************************//**
2184 * @name Cache settings
2189 * Directory for caching data in the local filesystem. Should not be accessible
2192 * Note: if multiple wikis share the same localisation cache directory, they
2193 * must all have the same set of extensions. You can set a directory just for
2194 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2196 $wgCacheDirectory = false;
2199 * Main cache type. This should be a cache with fast access, but it may have
2200 * limited space. By default, it is disabled, since the stock database cache
2201 * is not fast enough to make it worthwhile.
2205 * - CACHE_ANYTHING: Use anything, as long as it works
2206 * - CACHE_NONE: Do not cache
2207 * - CACHE_DB: Store cache objects in the DB
2208 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2209 * - CACHE_ACCEL: APC, XCache or WinCache
2210 * - (other): A string may be used which identifies a cache
2211 * configuration in $wgObjectCaches.
2213 * @see $wgMessageCacheType, $wgParserCacheType
2215 $wgMainCacheType = CACHE_NONE
;
2218 * The cache type for storing the contents of the MediaWiki namespace. This
2219 * cache is used for a small amount of data which is expensive to regenerate.
2221 * For available types see $wgMainCacheType.
2223 $wgMessageCacheType = CACHE_ANYTHING
;
2226 * The cache type for storing article HTML. This is used to store data which
2227 * is expensive to regenerate, and benefits from having plenty of storage space.
2229 * For available types see $wgMainCacheType.
2231 $wgParserCacheType = CACHE_ANYTHING
;
2234 * The cache type for storing session data.
2236 * For available types see $wgMainCacheType.
2238 $wgSessionCacheType = CACHE_ANYTHING
;
2241 * The cache type for storing language conversion tables,
2242 * which are used when parsing certain text and interface messages.
2244 * For available types see $wgMainCacheType.
2248 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2251 * Advanced object cache configuration.
2253 * Use this to define the class names and constructor parameters which are used
2254 * for the various cache types. Custom cache types may be defined here and
2255 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2256 * or $wgLanguageConverterCacheType.
2258 * The format is an associative array where the key is a cache identifier, and
2259 * the value is an associative array of parameters. The "class" parameter is the
2260 * class name which will be used. Alternatively, a "factory" parameter may be
2261 * given, giving a callable function which will generate a suitable cache object.
2264 CACHE_NONE
=> [ 'class' => 'EmptyBagOStuff', 'reportDupes' => false ],
2265 CACHE_DB
=> [ 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ],
2267 CACHE_ANYTHING
=> [ 'factory' => 'ObjectCache::newAnything' ],
2268 CACHE_ACCEL
=> [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2269 CACHE_MEMCACHED
=> [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2271 'db-replicated' => [
2272 'class' => 'ReplicatedBagOStuff',
2274 'class' => 'SqlBagOStuff',
2275 'args' => [ [ 'slaveOnly' => true ] ]
2278 'class' => 'SqlBagOStuff',
2279 'args' => [ [ 'slaveOnly' => false ] ]
2281 'loggroup' => 'SQLBagOStuff'
2284 'apc' => [ 'class' => 'APCBagOStuff', 'reportDupes' => false ],
2285 'xcache' => [ 'class' => 'XCacheBagOStuff', 'reportDupes' => false ],
2286 'wincache' => [ 'class' => 'WinCacheBagOStuff', 'reportDupes' => false ],
2287 'memcached-php' => [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2288 'memcached-pecl' => [ 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ],
2289 'hash' => [ 'class' => 'HashBagOStuff', 'reportDupes' => false ],
2293 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2294 * but it may have limited space. By default, it is disabled, since the basic stock
2295 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2296 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2297 * cache with a relayer of type EventRelayerNull.
2300 * - false: Configure the cache using $wgMainCacheType, without using
2301 * a relayer (only matters if there are multiple data-centers)
2302 * - CACHE_NONE: Do not cache
2303 * - (other): A string may be used which identifies a cache
2304 * configuration in $wgWANObjectCaches
2307 $wgMainWANCache = false;
2310 * Advanced WAN object cache configuration.
2312 * Each WAN cache wraps a registered object cache (for the local cluster)
2313 * and it must also be configured to point to a PubSub instance. Subscribers
2314 * must be configured to relay purges to the actual cache servers.
2316 * The format is an associative array where the key is a cache identifier, and
2317 * the value is an associative array of parameters. The "cacheId" parameter is
2318 * a cache identifier from $wgObjectCaches. The "channels" parameter is a map of
2319 * actions ('purge') to PubSub channels defined in $wgEventRelayerConfig.
2320 * The "loggroup" parameter controls where log events are sent.
2324 $wgWANObjectCaches = [
2326 'class' => 'WANObjectCache',
2327 'cacheId' => CACHE_NONE
,
2330 /* Example of a simple single data-center cache:
2331 'memcached-php' => [
2332 'class' => 'WANObjectCache',
2333 'cacheId' => 'memcached-php',
2334 'channels' => [ 'purge' => 'wancache-main-memcached-purge' ]
2340 * Main object stash type. This should be a fast storage system for storing
2341 * lightweight data like hit counters and user activity. Sites with multiple
2342 * data-centers should have this use a store that replicates all writes. The
2343 * store should have enough consistency for CAS operations to be usable.
2344 * Reads outside of those needed for merge() may be eventually consistent.
2347 * - db: Store cache objects in the DB
2348 * - (other): A string may be used which identifies a cache
2349 * configuration in $wgObjectCaches
2353 $wgMainStash = 'db-replicated';
2356 * The expiry time for the parser cache, in seconds.
2357 * The default is 86400 (one day).
2359 $wgParserCacheExpireTime = 86400;
2362 * Deprecated alias for $wgSessionsInObjectCache.
2364 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2366 $wgSessionsInMemcached = true;
2369 * @deprecated since 1.27, session data is always stored in object cache.
2371 $wgSessionsInObjectCache = true;
2374 * The expiry time to use for session storage, in seconds.
2376 $wgObjectCacheSessionExpiry = 3600;
2379 * @deprecated since 1.27, MediaWiki\Session\SessionManager doesn't use PHP session storage.
2381 $wgSessionHandler = null;
2384 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2386 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2388 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2389 * session handling will function independently of SessionHandler.
2390 * SessionHandler and PHP's session handling may attempt to override each
2395 * - 'enable': Integrate with PHP's session handling as much as possible.
2396 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2397 * - 'disable': Throw exceptions if PHP session handling is used.
2399 $wgPHPSessionHandling = 'enable';
2402 * Number of internal PBKDF2 iterations to use when deriving session secrets.
2406 $wgSessionPbkdf2Iterations = 10001;
2409 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2411 $wgMemCachedDebug = false;
2414 * The list of MemCached servers and port numbers
2416 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2419 * Use persistent connections to MemCached, which are shared across multiple
2422 $wgMemCachedPersistent = false;
2425 * Read/write timeout for MemCached server communication, in microseconds.
2427 $wgMemCachedTimeout = 500000;
2430 * Set this to true to maintain a copy of the message cache on the local server.
2432 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2434 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2436 * Note that this is about the message cache, which stores interface messages
2437 * maintained as wiki pages. This is separate from the localisation cache for interface
2438 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2440 $wgUseLocalMessageCache = false;
2443 * Instead of caching everything, only cache those messages which have
2444 * been customised in the site content language. This means that
2445 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2446 * This option is probably only useful for translatewiki.net.
2448 $wgAdaptiveMessageCache = false;
2451 * Localisation cache configuration. Associative array with keys:
2452 * class: The class to use. May be overridden by extensions.
2454 * store: The location to store cache data. May be 'files', 'array', 'db' or
2455 * 'detect'. If set to "files", data will be in CDB files. If set
2456 * to "db", data will be stored to the database. If set to
2457 * "detect", files will be used if $wgCacheDirectory is set,
2458 * otherwise the database will be used.
2459 * "array" is an experimental option that uses PHP files that
2460 * store static arrays.
2462 * storeClass: The class name for the underlying storage. If set to a class
2463 * name, it overrides the "store" setting.
2465 * storeDirectory: If the store class puts its data in files, this is the
2466 * directory it will use. If this is false, $wgCacheDirectory
2469 * manualRecache: Set this to true to disable cache updates on web requests.
2470 * Use maintenance/rebuildLocalisationCache.php instead.
2472 $wgLocalisationCacheConf = [
2473 'class' => 'LocalisationCache',
2474 'store' => 'detect',
2475 'storeClass' => false,
2476 'storeDirectory' => false,
2477 'manualRecache' => false,
2481 * Allow client-side caching of pages
2483 $wgCachePages = true;
2486 * Set this to current time to invalidate all prior cached pages. Affects both
2487 * client-side and server-side caching.
2488 * You can get the current date on your server by using the command:
2490 * date +%Y%m%d%H%M%S
2493 $wgCacheEpoch = '20030516000000';
2496 * Directory where GitInfo will look for pre-computed cache files. If false,
2497 * $wgCacheDirectory/gitinfo will be used.
2499 $wgGitInfoCacheDirectory = false;
2502 * Bump this number when changing the global style sheets and JavaScript.
2504 * It should be appended in the query string of static CSS and JS includes,
2505 * to ensure that client-side caches do not keep obsolete copies of global
2508 $wgStyleVersion = '303';
2511 * This will cache static pages for non-logged-in users to reduce
2512 * database traffic on public sites. ResourceLoader requests to default
2513 * language and skins are cached as well as single module requests.
2515 $wgUseFileCache = false;
2518 * Depth of the subdirectory hierarchy to be created under
2519 * $wgFileCacheDirectory. The subdirectories will be named based on
2520 * the MD5 hash of the title. A value of 0 means all cache files will
2521 * be put directly into the main file cache directory.
2523 $wgFileCacheDepth = 2;
2526 * Kept for extension compatibility; see $wgParserCacheType
2527 * @deprecated since 1.26
2529 $wgEnableParserCache = true;
2532 * Append a configured value to the parser cache and the sitenotice key so
2533 * that they can be kept separate for some class of activity.
2535 $wgRenderHashAppend = '';
2538 * If on, the sidebar navigation links are cached for users with the
2539 * current language set. This can save a touch of load on a busy site
2540 * by shaving off extra message lookups.
2542 * However it is also fragile: changing the site configuration, or
2543 * having a variable $wgArticlePath, can produce broken links that
2544 * don't update as expected.
2546 $wgEnableSidebarCache = false;
2549 * Expiry time for the sidebar cache, in seconds
2551 $wgSidebarCacheExpiry = 86400;
2554 * When using the file cache, we can store the cached HTML gzipped to save disk
2555 * space. Pages will then also be served compressed to clients that support it.
2557 * Requires zlib support enabled in PHP.
2562 * Clock skew or the one-second resolution of time() can occasionally cause cache
2563 * problems when the user requests two pages within a short period of time. This
2564 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2567 $wgClockSkewFudge = 5;
2570 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2571 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2572 * was previously done in the default LocalSettings.php file.
2574 * On high-traffic wikis, this should be set to false, to avoid the need to
2575 * check the file modification time, and to avoid the performance impact of
2576 * unnecessary cache invalidations.
2578 $wgInvalidateCacheOnLocalSettingsChange = true;
2581 * When loading extensions through the extension registration system, this
2582 * can be used to invalidate the cache. A good idea would be to set this to
2583 * one file, you can just `touch` that one to invalidate the cache
2587 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2590 * If set to false, the mtime for each individual JSON file will be checked,
2591 * which can be slow if a large number of extensions are being loaded.
2595 $wgExtensionInfoMTime = false;
2597 /** @} */ # end of cache settings
2599 /************************************************************************//**
2600 * @name HTTP proxy (CDN) settings
2602 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2603 * although they are referred to as Squid settings for historical reasons.
2605 * Achieving a high hit ratio with an HTTP proxy requires special
2606 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2613 * Enable/disable CDN.
2614 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2616 $wgUseSquid = false;
2619 * If you run Squid3 with ESI support, enable this (default:false):
2624 * Send the Key HTTP header for better caching.
2625 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2628 $wgUseKeyHeader = false;
2631 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2632 * RSS/Atom feeds. Use this if you have an SSL termination setup
2633 * and need to split the cache between HTTP and HTTPS for API requests,
2634 * feed requests and HTTP redirect responses in order to prevent cache
2635 * pollution. This does not affect 'normal' requests to index.php other than
2638 $wgVaryOnXFP = false;
2641 * Internal server name as known to CDN, if different.
2645 * $wgInternalServer = 'http://yourinternal.tld:8000';
2648 $wgInternalServer = false;
2651 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2652 * Surrogate-Control (with ESI). Without ESI, you should strip
2653 * out s-maxage in the CDN config.
2655 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2657 $wgSquidMaxage = 18000;
2660 * Cache timeout for the CDN when DB slave lag is high
2661 * @see $wgSquidMaxage
2664 $wgCdnMaxageLagged = 30;
2667 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2668 * this many seconds later via the job queue. This requires delayed job support.
2669 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2670 * slave lag does not cause page to be stuck in stales states in CDN.
2672 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2673 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2674 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2675 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2676 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2680 $wgCdnReboundPurgeDelay = 0;
2683 * Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
2684 * @see $wgSquidMaxage
2687 $wgCdnMaxageSubstitute = 60;
2690 * Default maximum age for raw CSS/JS accesses
2692 * 300 seconds = 5 minutes.
2694 $wgForcedRawSMaxage = 300;
2697 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2699 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2700 * headers sent/modified from these proxies when obtaining the remote IP address
2702 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2704 $wgSquidServers = [];
2707 * As above, except these servers aren't purged on page changes; use to set a
2708 * list of trusted proxies, etc. Supports both individual IP addresses and
2710 * @since 1.23 Supports CIDR ranges
2712 $wgSquidServersNoPurge = [];
2715 * Whether to use a Host header in purge requests sent to the proxy servers
2716 * configured in $wgSquidServers. Set this to false to support Squid
2717 * configured in forward-proxy mode.
2719 * If this is set to true, a Host header will be sent, and only the path
2720 * component of the URL will appear on the request line, as if the request
2721 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2722 * request. Squid supports this style of request only if reverse-proxy mode
2723 * (http_port ... accel) is enabled.
2725 * If this is set to false, no Host header will be sent, and the absolute URL
2726 * will be sent in the request line, as is the standard for an HTTP proxy
2727 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2728 * by Varnish, but is supported by Squid in either configuration (forward or
2733 $wgSquidPurgeUseHostHeader = true;
2736 * Routing configuration for HTCP multicast purging. Add elements here to
2737 * enable HTCP and determine which purges are sent where. If set to an empty
2738 * array, HTCP is disabled.
2740 * Each key in this array is a regular expression to match against the purged
2741 * URL, or an empty string to match all URLs. The purged URL is matched against
2742 * the regexes in the order specified, and the first rule whose regex matches
2743 * is used, all remaining rules will thus be ignored.
2745 * @par Example configuration to send purges for upload.wikimedia.org to one
2746 * multicast group and all other purges to another:
2748 * $wgHTCPRouting = [
2749 * '|^https?://upload\.wikimedia\.org|' => [
2750 * 'host' => '239.128.0.113',
2754 * 'host' => '239.128.0.112',
2760 * You can also pass an array of hosts to send purges too. This is useful when
2761 * you have several multicast groups or unicast address that should receive a
2762 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2764 * @par Example of sending purges to multiple hosts:
2766 * $wgHTCPRouting = [
2768 * // Purges to text caches using multicast
2769 * [ 'host' => '239.128.0.114', 'port' => '4827' ],
2770 * // Purges to a hardcoded list of caches
2771 * [ 'host' => '10.88.66.1', 'port' => '4827' ],
2772 * [ 'host' => '10.88.66.2', 'port' => '4827' ],
2773 * [ 'host' => '10.88.66.3', 'port' => '4827' ],
2780 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2781 * For back compatibility purposes, whenever its array is empty
2782 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2784 * @see $wgHTCPMulticastTTL
2786 $wgHTCPRouting = [];
2789 * HTCP multicast TTL.
2790 * @see $wgHTCPRouting
2792 $wgHTCPMulticastTTL = 1;
2795 * Should forwarded Private IPs be accepted?
2797 $wgUsePrivateIPs = false;
2799 /** @} */ # end of HTTP proxy settings
2801 /************************************************************************//**
2802 * @name Language, regional and character encoding settings
2807 * Site language code. See languages/data/Names.php for languages supported by
2808 * MediaWiki out of the box. Not all languages listed there have translations,
2809 * see languages/messages/ for the list of languages with some localisation.
2811 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2812 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2814 * This defines the default interface language for all users, but users can
2815 * change it in their preferences.
2817 * This also defines the language of pages in the wiki. The content is wrapped
2818 * in a html element with lang=XX attribute. This behavior can be overridden
2819 * via hooks, see Title::getPageLanguage.
2821 $wgLanguageCode = 'en';
2824 * Language cache size, or really how many languages can we handle
2825 * simultaneously without degrading to crawl speed.
2827 $wgLangObjCacheSize = 10;
2830 * Some languages need different word forms, usually for different cases.
2831 * Used in Language::convertGrammar().
2835 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2838 $wgGrammarForms = [];
2841 * Treat language links as magic connectors, not inline links
2843 $wgInterwikiMagic = true;
2846 * Hide interlanguage links from the sidebar
2848 $wgHideInterlanguageLinks = false;
2851 * List of additional interwiki prefixes that should be treated as
2852 * interlanguage links (i.e. placed in the sidebar).
2854 * - This will not do anything unless the prefixes are defined in the interwiki
2856 * - The display text for these custom interlanguage links will be fetched from
2857 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2859 * - A friendly name for each site, used for tooltip text, may optionally be
2860 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2861 * the prefix in this array.
2863 $wgExtraInterlanguageLinkPrefixes = [];
2866 * List of language names or overrides for default names in Names.php
2868 $wgExtraLanguageNames = [];
2871 * List of language codes that don't correspond to an actual language.
2872 * These codes are mostly left-offs from renames, or other legacy things.
2873 * This array makes them not appear as a selectable language on the installer,
2874 * and excludes them when running the transstat.php script.
2876 $wgDummyLanguageCodes = [
2879 'be-x-old' => 'be-tarask',
2883 'qqq' => 'qqq', # Used for message documentation.
2884 'qqx' => 'qqx', # Used for viewing message keys.
2887 'zh-classical' => 'lzh',
2888 'zh-min-nan' => 'nan',
2893 * Set this to true to replace Arabic presentation forms with their standard
2894 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2897 * Note that pages with titles containing presentation forms will become
2898 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2900 $wgFixArabicUnicode = true;
2903 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2904 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2905 * set to "ml". Note that some clients (even new clients as of 2010) do not
2906 * support these characters.
2908 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2909 * fix any ZWJ sequences in existing page titles.
2911 $wgFixMalayalamUnicode = true;
2914 * Set this to always convert certain Unicode sequences to modern ones
2915 * regardless of the content language. This has a small performance
2918 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2923 $wgAllUnicodeFixes = false;
2926 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2927 * loading old revisions not marked with "utf-8" flag. Use this when
2928 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2929 * burdensome mass conversion of old text data.
2931 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2932 * user names, etc still must be converted en masse in the database before
2933 * continuing as a UTF-8 wiki.
2935 $wgLegacyEncoding = false;
2938 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2939 * regexps : "/regexp/" matching problematic browsers. These browsers will
2940 * be served encoded unicode in the edit box instead of real unicode.
2942 $wgBrowserBlackList = [
2944 * Netscape 2-4 detection
2945 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2946 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2947 * with a negative assertion. The [UIN] identifier specifies the level of security
2948 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2949 * The language string is unreliable, it is missing on NS4 Mac.
2951 * Reference: http://www.psychedelix.com/agents/index.shtml
2953 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2954 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2955 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2958 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2959 * Þ to <THORN> and Ð to <ETH>
2962 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2963 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2964 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2967 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2968 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2970 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2973 * Google wireless transcoder, seems to eat a lot of chars alive
2974 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2976 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2980 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2981 * create stub reference rows in the text table instead of copying
2982 * the full text of all current entries from 'cur' to 'text'.
2984 * This will speed up the conversion step for large sites, but
2985 * requires that the cur table be kept around for those revisions
2986 * to remain viewable.
2988 * This option affects the updaters *only*. Any present cur stub
2989 * revisions will be readable at runtime regardless of this setting.
2991 $wgLegacySchemaConversion = false;
2994 * Enable dates like 'May 12' instead of '12 May', if the default date format
2997 $wgAmericanDates = false;
3000 * For Hindi and Arabic use local numerals instead of Western style (0-9)
3001 * numerals in interface.
3003 $wgTranslateNumerals = true;
3006 * Translation using MediaWiki: namespace.
3007 * Interface messages will be loaded from the database.
3009 $wgUseDatabaseMessages = true;
3012 * Expiry time for the message cache key
3014 $wgMsgCacheExpiry = 86400;
3017 * Maximum entry size in the message cache, in bytes
3019 $wgMaxMsgCacheEntrySize = 10000;
3022 * Whether to enable language variant conversion.
3024 $wgDisableLangConversion = false;
3027 * Whether to enable language variant conversion for links.
3029 $wgDisableTitleConversion = false;
3032 * Default variant code, if false, the default will be the language code
3034 $wgDefaultLanguageVariant = false;
3037 * Disabled variants array of language variant conversion.
3041 * $wgDisabledVariants[] = 'zh-mo';
3042 * $wgDisabledVariants[] = 'zh-my';
3045 $wgDisabledVariants = [];
3048 * Like $wgArticlePath, but on multi-variant wikis, this provides a
3049 * path format that describes which parts of the URL contain the
3054 * $wgLanguageCode = 'sr';
3055 * $wgVariantArticlePath = '/$2/$1';
3056 * $wgArticlePath = '/wiki/$1';
3059 * A link to /wiki/ would be redirected to /sr/Главна_страна
3061 * It is important that $wgArticlePath not overlap with possible values
3062 * of $wgVariantArticlePath.
3064 $wgVariantArticlePath = false;
3067 * Show a bar of language selection links in the user login and user
3068 * registration forms; edit the "loginlanguagelinks" message to
3071 $wgLoginLanguageSelector = false;
3074 * When translating messages with wfMessage(), it is not always clear what
3075 * should be considered UI messages and what should be content messages.
3077 * For example, for the English Wikipedia, there should be only one 'mainpage',
3078 * so when getting the link for 'mainpage', we should treat it as site content
3079 * and call ->inContentLanguage()->text(), but for rendering the text of the
3080 * link, we call ->text(). The code behaves this way by default. However,
3081 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3082 * and the like for different languages. This array provides a way to override
3083 * the default behavior.
3086 * To allow language-specific main page and community
3089 * $wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];
3092 $wgForceUIMsgAsContentMsg = [];
3095 * Fake out the timezone that the server thinks it's in. This will be used for
3096 * date display and not for what's stored in the DB. Leave to null to retain
3097 * your server's OS-based timezone value.
3099 * This variable is currently used only for signature formatting and for local
3100 * time/date parser variables ({{LOCALTIME}} etc.)
3102 * Timezones can be translated by editing MediaWiki messages of type
3103 * timezone-nameinlowercase like timezone-utc.
3105 * A list of usable timezones can found at:
3106 * http://php.net/manual/en/timezones.php
3110 * $wgLocaltimezone = 'UTC';
3111 * $wgLocaltimezone = 'GMT';
3112 * $wgLocaltimezone = 'PST8PDT';
3113 * $wgLocaltimezone = 'Europe/Sweden';
3114 * $wgLocaltimezone = 'CET';
3117 $wgLocaltimezone = null;
3120 * Set an offset from UTC in minutes to use for the default timezone setting
3121 * for anonymous users and new user accounts.
3123 * This setting is used for most date/time displays in the software, and is
3124 * overridable in user preferences. It is *not* used for signature timestamps.
3126 * By default, this will be set to match $wgLocaltimezone.
3128 $wgLocalTZoffset = null;
3130 /** @} */ # End of language/charset settings
3132 /*************************************************************************//**
3133 * @name Output format and skin settings
3138 * The default Content-Type header.
3140 $wgMimeType = 'text/html';
3143 * Previously used as content type in HTML script tags. This is now ignored since
3144 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3145 * It was also previously used by RawAction to determine the ctype query parameter
3146 * value that will result in a javascript response.
3147 * @deprecated since 1.22
3149 $wgJsMimeType = null;
3152 * The default xmlns attribute. The option to define this has been removed.
3153 * The value of this variable is no longer used by core and is set to a fixed
3154 * value in Setup.php for compatibility with extensions that depend on the value
3155 * of this variable being set. Such a dependency however is deprecated.
3156 * @deprecated since 1.22
3158 $wgXhtmlDefaultNamespace = null;
3161 * Previously used to determine if we should output an HTML5 doctype.
3162 * This is no longer used as we always output HTML5 now. For compatibility with
3163 * extensions that still check the value of this config it's value is now forced
3164 * to true by Setup.php.
3165 * @deprecated since 1.22
3170 * Defines the value of the version attribute in the <html> tag, if any.
3172 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3173 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3174 * See also http://www.w3.org/TR/rdfa-in-html/#document-conformance
3177 $wgHtml5Version = null;
3180 * Temporary variable that allows HTMLForms to be rendered as tables.
3181 * Table based layouts cause various issues when designing for mobile.
3182 * This global allows skins or extensions a means to force non-table based rendering.
3183 * Setting to false forces form components to always render as div elements.
3186 $wgHTMLFormAllowTableFormat = true;
3189 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3190 * Temporary variable that should be removed when mediawiki ui is more
3191 * stable and change has been communicated.
3194 $wgUseMediaWikiUIEverywhere = false;
3197 * Whether to label the store-to-database-and-show-to-others button in the editor
3198 * as "Save page"/"Save changes" if false (the default) or, if true, instead as
3199 * "Publish page"/"Publish changes".
3203 $wgEditSubmitButtonLabelPublish = false;
3206 * Permit other namespaces in addition to the w3.org default.
3208 * Use the prefix for the key and the namespace for the value.
3212 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3214 * Normally we wouldn't have to define this in the root "<html>"
3215 * element, but IE needs it there in some circumstances.
3217 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3219 $wgXhtmlNamespaces = [];
3222 * Site notice shown at the top of each page
3224 * MediaWiki:Sitenotice page, which will override this. You can also
3225 * provide a separate message for logged-out users using the
3226 * MediaWiki:Anonnotice page.
3231 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3233 $wgSiteSupportPage = '';
3236 * Validate the overall output using tidy and refuse
3237 * to display the page if it's not valid.
3239 $wgValidateAllHtml = false;
3242 * Default skin, for new users and anonymous visitors. Registered users may
3243 * change this to any one of the other available skins in their preferences.
3245 $wgDefaultSkin = 'vector';
3248 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3252 $wgFallbackSkin = 'fallback';
3255 * Specify the names of skins that should not be presented in the list of
3256 * available skins in user preferences. If you want to remove a skin entirely,
3257 * remove it from the skins/ directory and its entry from LocalSettings.php.
3262 * @deprecated since 1.23; use $wgSkipSkins instead
3267 * Allow user Javascript page?
3268 * This enables a lot of neat customizations, but may
3269 * increase security risk to users and server load.
3271 $wgAllowUserJs = false;
3274 * Allow user Cascading Style Sheets (CSS)?
3275 * This enables a lot of neat customizations, but may
3276 * increase security risk to users and server load.
3278 $wgAllowUserCss = false;
3281 * Allow user-preferences implemented in CSS?
3282 * This allows users to customise the site appearance to a greater
3283 * degree; disabling it will improve page load times.
3285 $wgAllowUserCssPrefs = true;
3288 * Use the site's Javascript page?
3290 $wgUseSiteJs = true;
3293 * Use the site's Cascading Style Sheets (CSS)?
3295 $wgUseSiteCss = true;
3298 * Break out of framesets. This can be used to prevent clickjacking attacks,
3299 * or to prevent external sites from framing your site with ads.
3301 $wgBreakFrames = false;
3304 * The X-Frame-Options header to send on pages sensitive to clickjacking
3305 * attacks, such as edit pages. This prevents those pages from being displayed
3306 * in a frame or iframe. The options are:
3308 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3310 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3311 * to allow framing within a trusted domain. This is insecure if there
3312 * is a page on the same domain which allows framing of arbitrary URLs.
3314 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3315 * full compromise of local user accounts. Private wikis behind a
3316 * corporate firewall are especially vulnerable. This is not
3319 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3320 * not just edit pages.
3322 $wgEditPageFrameOptions = 'DENY';
3325 * Disallow framing of API pages directly, by setting the X-Frame-Options
3326 * header. Since the API returns CSRF tokens, allowing the results to be
3327 * framed can compromise your user's account security.
3329 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3330 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3331 * - false: Allow all framing.
3332 * Note: $wgBreakFrames will override this for human formatted API output.
3334 $wgApiFrameOptions = 'DENY';
3337 * Disable output compression (enabled by default if zlib is available)
3339 $wgDisableOutputCompression = false;
3342 * Should we allow a broader set of characters in id attributes, per HTML5? If
3343 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3344 * functionality is ready, it will be on by default with no option.
3346 * Currently this appears to work fine in all browsers, but it's disabled by
3347 * default because it normalizes id's a bit too aggressively, breaking preexisting
3348 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3350 $wgExperimentalHtmlIds = false;
3353 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3354 * You can add new icons to the built in copyright or poweredby, or you can create
3355 * a new block. Though note that you may need to add some custom css to get good styling
3356 * of new blocks in monobook. vector and modern should work without any special css.
3358 * $wgFooterIcons itself is a key/value array.
3359 * The key is the name of a block that the icons will be wrapped in. The final id varies
3360 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3361 * turns it into mw_poweredby.
3362 * The value is either key/value array of icons or a string.
3363 * In the key/value array the key may or may not be used by the skin but it can
3364 * be used to find the icon and unset it or change the icon if needed.
3365 * This is useful for disabling icons that are set by extensions.
3366 * The value should be either a string or an array. If it is a string it will be output
3367 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3368 * for the icon, the following keys are used:
3369 * - src: An absolute url to the image to use for the icon, this is recommended
3370 * but not required, however some skins will ignore icons without an image
3371 * - srcset: optional additional-resolution images; see HTML5 specs
3372 * - url: The url to use in the a element around the text or icon, if not set an a element will
3374 * - alt: This is the text form of the icon, it will be displayed without an image in
3375 * skins like Modern or if src is not set, and will otherwise be used as
3376 * the alt="" for the image. This key is required.
3377 * - width and height: If the icon specified by src is not of the standard size
3378 * you can specify the size of image to use with these keys.
3379 * Otherwise they will default to the standard 88x31.
3380 * @todo Reformat documentation.
3384 "copyright" => [], // placeholder for the built in copyright icon
3388 // Defaults to point at
3389 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3390 // plus srcset for 1.5x, 2x resolution variants.
3392 "url" => "//www.mediawiki.org/",
3393 "alt" => "Powered by MediaWiki",
3399 * Login / create account link behavior when it's possible for anonymous users
3400 * to create an account.
3401 * - true = use a combined login / create account link
3402 * - false = split login and create account into two separate links
3404 $wgUseCombinedLoginLink = false;
3407 * Display user edit counts in various prominent places.
3409 $wgEdititis = false;
3412 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3413 * status code, mangling or hiding MediaWiki's output. If you are using such a
3414 * host, you should start looking for a better one. While you're doing that,
3415 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3416 * that the generated error pages can be seen.
3418 * In cases where for technical reasons it is more important for MediaWiki to
3419 * send the correct status code than for the body to be transmitted intact,
3420 * this configuration variable is ignored.
3422 $wgSend404Code = true;
3425 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3426 * The numeric value of the variable controls how many edits MediaWiki will look back to
3427 * determine whether a rollback is allowed (by checking that they are all from the same author).
3428 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3429 * from hiding some useless rollback links.
3433 $wgShowRollbackEditCount = 10;
3436 * Output a <link rel="canonical"> tag on every page indicating the canonical
3437 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3438 * detection of the current server is unreliable, the link is sent
3441 $wgEnableCanonicalServerLink = false;
3444 * When OutputHandler is used, mangle any output that contains
3445 * <cross-domain-policy>. Without this, an attacker can send their own
3446 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3451 $wgMangleFlashPolicy = true;
3453 /** @} */ # End of output format settings }
3455 /*************************************************************************//**
3456 * @name ResourceLoader settings
3461 * Client-side resource modules.
3463 * Extensions should add their ResourceLoader module definitions
3464 * to the $wgResourceModules variable.
3468 * $wgResourceModules['ext.myExtension'] = [
3469 * 'scripts' => 'myExtension.js',
3470 * 'styles' => 'myExtension.css',
3471 * 'dependencies' => [ 'jquery.cookie', 'jquery.tabIndex' ],
3472 * 'localBasePath' => __DIR__,
3473 * 'remoteExtPath' => 'MyExtension',
3477 $wgResourceModules = [];
3480 * Skin-specific styles for resource modules.
3482 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3483 * not be modified or disabled.
3485 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3489 * $wgResourceModules['bar'] = [
3490 * 'scripts' => 'resources/bar/bar.js',
3491 * 'styles' => 'resources/bar/main.css',
3494 * $wgResourceModuleSkinStyles['foo'] = [
3495 * 'bar' => 'skins/Foo/bar.css',
3499 * This is mostly equivalent to:
3503 * $wgResourceModules['bar'] = [
3504 * 'scripts' => 'resources/bar/bar.js',
3505 * 'styles' => 'resources/bar/main.css',
3507 * 'foo' => skins/Foo/bar.css',
3512 * If the module already defines its own entry in `skinStyles` for a given skin, then
3513 * $wgResourceModuleSkinStyles is ignored.
3515 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3516 * of replacing them. This can be done using the `+` prefix.
3520 * $wgResourceModules['bar'] = [
3521 * 'scripts' => 'resources/bar/bar.js',
3522 * 'styles' => 'resources/bar/basic.css',
3524 * 'default' => 'resources/bar/additional.css',
3527 * // Note the '+' character:
3528 * $wgResourceModuleSkinStyles['foo'] = [
3529 * '+bar' => 'skins/Foo/bar.css',
3533 * This is mostly equivalent to:
3537 * $wgResourceModules['bar'] = [
3538 * 'scripts' => 'resources/bar/bar.js',
3539 * 'styles' => 'resources/bar/basic.css',
3541 * 'default' => 'resources/bar/additional.css',
3543 * 'resources/bar/additional.css',
3544 * 'skins/Foo/bar.css',
3550 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3551 * disabled by a skin. To provide default styles that may be extended or replaced,
3552 * use `skinStyles['default']`.
3554 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3555 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3559 * $wgResourceModuleSkinStyles['foo'] = [
3560 * 'bar' => 'bar.css',
3561 * 'quux' => 'quux.css',
3562 * 'remoteSkinPath' => 'Foo',
3563 * 'localBasePath' => __DIR__,
3567 $wgResourceModuleSkinStyles = [];
3570 * Extensions should register foreign module sources here. 'local' is a
3571 * built-in source that is not in this array, but defined by
3572 * ResourceLoader::__construct() so that it cannot be unset.
3576 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3579 $wgResourceLoaderSources = [];
3582 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3583 * Defaults to $wgScriptPath.
3585 $wgResourceBasePath = null;
3588 * Maximum time in seconds to cache resources served by ResourceLoader.
3589 * Used to set last modified headers (max-age/s-maxage).
3591 * Following options to distinguish:
3592 * - versioned: Used for modules with a version, because changing version
3593 * numbers causes cache misses. This normally has a long expiry time.
3594 * - unversioned: Used for modules without a version to propagate changes
3595 * quickly to clients. Also used for modules with errors to recover quickly.
3596 * This normally has a short expiry time.
3598 * Expiry time for the options to distinguish:
3599 * - server: Squid/Varnish but also any other public proxy cache between the
3600 * client and MediaWiki.
3601 * - client: On the client side (e.g. in the browser cache).
3603 $wgResourceLoaderMaxage = [
3605 'server' => 30 * 24 * 60 * 60, // 30 days
3606 'client' => 30 * 24 * 60 * 60, // 30 days
3609 'server' => 5 * 60, // 5 minutes
3610 'client' => 5 * 60, // 5 minutes
3615 * The default debug mode (on/off) for of ResourceLoader requests.
3617 * This will still be overridden when the debug URL parameter is used.
3619 $wgResourceLoaderDebug = false;
3622 * Put each statement on its own line when minifying JavaScript. This makes
3623 * debugging in non-debug mode a bit easier.
3625 * @deprecated since 1.27: Always false; no longer configurable.
3627 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3630 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3631 * the minifier will try not to produce lines longer than this, but may be
3632 * forced to do so in certain cases.
3634 * @deprecated since 1.27: Always 1,000; no longer configurable.
3636 $wgResourceLoaderMinifierMaxLineLength = 1000;
3639 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3641 * @deprecated since 1.26: Always declare dependencies.
3643 $wgIncludeLegacyJavaScript = false;
3646 * Whether or not to assign configuration variables to the global window object.
3648 * If this is set to false, old code using deprecated variables will no longer
3651 * @par Example of legacy code:
3653 * if ( window.wgRestrictionEdit ) { ... }
3657 * if ( wgIsArticle ) { ... }
3660 * Instead, one needs to use mw.config.
3661 * @par Example using mw.config global configuration:
3663 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3667 * if ( mw.config.get('wgIsArticle') ) { ... }
3670 $wgLegacyJavaScriptGlobals = true;
3673 * If set to a positive number, ResourceLoader will not generate URLs whose
3674 * query string is more than this many characters long, and will instead use
3675 * multiple requests with shorter query strings. This degrades performance,
3676 * but may be needed if your web server has a low (less than, say 1024)
3677 * query string length limit or a low value for suhosin.get.max_value_length
3678 * that you can't increase.
3680 * If set to a negative number, ResourceLoader will assume there is no query
3681 * string length limit.
3683 * Defaults to a value based on php configuration.
3685 $wgResourceLoaderMaxQueryLength = false;
3688 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3689 * prior to minification to validate it.
3691 * Parse errors will result in a JS exception being thrown during module load,
3692 * which avoids breaking other modules loaded in the same request.
3694 $wgResourceLoaderValidateJS = true;
3697 * If set to true, statically-sourced (file-backed) JavaScript resources will
3698 * be parsed for validity before being bundled up into ResourceLoader modules.
3700 * This can be helpful for development by providing better error messages in
3701 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3702 * and may fail on large pre-bundled frameworks.
3704 $wgResourceLoaderValidateStaticJS = false;
3707 * Global LESS variables. An associative array binding variable names to
3708 * LESS code snippets representing their values.
3710 * Adding an item here is equivalent to writing `@variable: value;`
3711 * at the beginning of all your .less files, with all the consequences.
3712 * In particular, string values must be escaped and quoted.
3714 * Changes to LESS variables do not trigger cache invalidation.
3716 * If the LESS variables need to be dynamic, you can use the
3717 * ResourceLoaderGetLessVars hook (since 1.25).
3721 * $wgResourceLoaderLESSVars = [
3722 * 'baseFontSize' => '1em',
3723 * 'smallFontSize' => '0.75em',
3724 * 'WikimediaBlue' => '#006699',
3729 $wgResourceLoaderLESSVars = [
3731 * Minimum available screen width at which a device can be considered a tablet/desktop
3732 * The number is currently based on the device width of a Samsung Galaxy S5 mini and is low
3733 * enough to cover iPad (768px). Number is prone to change with new information.
3736 'deviceWidthTablet' => '720px',
3740 * Default import paths for LESS modules. LESS files referenced in @import
3741 * statements will be looked up here first, and relative to the importing file
3742 * second. To avoid collisions, it's important for the LESS files in these
3743 * directories to have a common, predictable file name prefix.
3745 * Extensions need not (and should not) register paths in
3746 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3747 * currently compiling LESS file, which allows each extension to freely import
3748 * files from its own tree.
3752 $wgResourceLoaderLESSImportPaths = [
3753 "$IP/resources/src/mediawiki.less/",
3757 * Whether ResourceLoader should attempt to persist modules in localStorage on
3758 * browsers that support the Web Storage API.
3760 $wgResourceLoaderStorageEnabled = true;
3763 * Cache version for client-side ResourceLoader module storage. You can trigger
3764 * invalidation of the contents of the module store by incrementing this value.
3768 $wgResourceLoaderStorageVersion = 1;
3771 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3772 * restricted pages like Special:UserLogin or Special:Preferences where
3773 * JavaScript is disabled for security reasons. As it is possible to
3774 * execute JavaScript through CSS, setting this to true opens up a
3775 * potential security hole. Some sites may "skin" their wiki by using
3776 * site-wide CSS, causing restricted pages to look unstyled and different
3777 * from the rest of the site.
3781 $wgAllowSiteCSSOnRestrictedPages = false;
3783 /** @} */ # End of ResourceLoader settings }
3785 /*************************************************************************//**
3786 * @name Page title and interwiki link settings
3791 * Name of the project namespace. If left set to false, $wgSitename will be
3794 $wgMetaNamespace = false;
3797 * Name of the project talk namespace.
3799 * Normally you can ignore this and it will be something like
3800 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3801 * manually for grammatical reasons.
3803 $wgMetaNamespaceTalk = false;
3806 * Additional namespaces. If the namespaces defined in Language.php and
3807 * Namespace.php are insufficient, you can create new ones here, for example,
3808 * to import Help files in other languages. You can also override the namespace
3809 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3810 * hook or extension.json.
3812 * @warning Once you delete a namespace, the pages in that namespace will
3813 * no longer be accessible. If you rename it, then you can access them through
3814 * the new namespace name.
3816 * Custom namespaces should start at 100 to avoid conflicting with standard
3817 * namespaces, and should always follow the even/odd main/talk pattern.
3821 * $wgExtraNamespaces = [
3823 * 101 => "Hilfe_Diskussion",
3825 * 103 => "Discussion_Aide"
3829 * @todo Add a note about maintenance/namespaceDupes.php
3831 $wgExtraNamespaces = [];
3834 * Same as above, but for namespaces with gender distinction.
3835 * Note: the default form for the namespace should also be set
3836 * using $wgExtraNamespaces for the same index.
3839 $wgExtraGenderNamespaces = [];
3842 * Namespace aliases.
3844 * These are alternate names for the primary localised namespace names, which
3845 * are defined by $wgExtraNamespaces and the language file. If a page is
3846 * requested with such a prefix, the request will be redirected to the primary
3849 * Set this to a map from namespace names to IDs.
3853 * $wgNamespaceAliases = [
3854 * 'Wikipedian' => NS_USER,
3859 $wgNamespaceAliases = [];
3862 * Allowed title characters -- regex character class
3863 * Don't change this unless you know what you're doing
3865 * Problematic punctuation:
3866 * - []{}|# Are needed for link syntax, never enable these
3867 * - <> Causes problems with HTML escaping, don't use
3868 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3869 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3870 * corrupted by apache
3871 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3873 * All three of these punctuation problems can be avoided by using an alias,
3874 * instead of a rewrite rule of either variety.
3876 * The problem with % is that when using a path to query rewrite rule, URLs are
3877 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3878 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3879 * for this, indeed double escaping would break if the double-escaped title was
3880 * passed in the query string rather than the path. This is a minor security issue
3881 * because articles can be created such that they are hard to view or edit.
3883 * In some rare cases you may wish to remove + for compatibility with old links.
3885 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3886 * this breaks interlanguage links
3888 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3891 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3893 * @deprecated since 1.23; use $wgLocalInterwikis instead
3895 $wgLocalInterwiki = false;
3898 * Array for multiple $wgLocalInterwiki values, in case there are several
3899 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3900 * set, its value is prepended to this array, for backwards compatibility.
3902 * Note, recent changes feeds use only the first entry in this array (or
3903 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3905 $wgLocalInterwikis = [];
3908 * Expiry time for cache of interwiki table
3910 $wgInterwikiExpiry = 10800;
3913 * @name Interwiki caching settings.
3918 * Interwiki cache, either as an associative array or a path to a constant
3919 * database (.cdb) file.
3921 * This data structure database is generated by the `dumpInterwiki` maintenance
3922 * script (which lives in the WikimediaMaintenance repository) and has key
3923 * formats such as the following:
3925 * - dbname:key - a simple key (e.g. enwiki:meta)
3926 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3927 * - __global:key - global-scope key (e.g. __global:meta)
3928 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3930 * Sites mapping just specifies site name, other keys provide "local url"
3933 * @var bool|array|string
3935 $wgInterwikiCache = false;
3938 * Specify number of domains to check for messages.
3939 * - 1: Just wiki(db)-level
3940 * - 2: wiki and global levels
3943 $wgInterwikiScopes = 3;
3946 * Fallback site, if unable to resolve from cache
3948 $wgInterwikiFallbackSite = 'wiki';
3950 /** @} */ # end of Interwiki caching settings.
3953 * @name SiteStore caching settings.
3958 * Specify the file location for the Sites json cache file.
3960 $wgSitesCacheFile = false;
3962 /** @} */ # end of SiteStore caching settings.
3965 * If local interwikis are set up which allow redirects,
3966 * set this regexp to restrict URLs which will be displayed
3967 * as 'redirected from' links.
3970 * It might look something like this:
3972 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3975 * Leave at false to avoid displaying any incoming redirect markers.
3976 * This does not affect intra-wiki redirects, which don't change
3979 $wgRedirectSources = false;
3982 * Set this to false to avoid forcing the first letter of links to capitals.
3984 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3985 * appearing with a capital at the beginning of a sentence will *not* go to the
3986 * same place as links in the middle of a sentence using a lowercase initial.
3988 $wgCapitalLinks = true;
3991 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3992 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3993 * true by default (and setting them has no effect), due to various things that
3994 * require them to be so. Also, since Talk namespaces need to directly mirror their
3995 * associated content namespaces, the values for those are ignored in favor of the
3996 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
4001 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
4004 $wgCapitalLinkOverrides = [];
4007 * Which namespaces should support subpages?
4008 * See Language.php for a list of namespaces.
4010 $wgNamespacesWithSubpages = [
4013 NS_USER_TALK
=> true,
4015 NS_PROJECT_TALK
=> true,
4016 NS_FILE_TALK
=> true,
4017 NS_MEDIAWIKI
=> true,
4018 NS_MEDIAWIKI_TALK
=> true,
4019 NS_TEMPLATE_TALK
=> true,
4021 NS_HELP_TALK
=> true,
4022 NS_CATEGORY_TALK
=> true
4026 * Array holding default tracking category names.
4028 * Array contains the system messages for each tracking category.
4029 * Tracking categories allow pages with certain characteristics to be tracked.
4030 * It works by adding any such page to a category automatically.
4032 * A message with the suffix '-desc' should be added as a description message
4033 * to have extra information on Special:TrackingCategories.
4035 * @deprecated since 1.25 Extensions should now register tracking categories using
4036 * the new extension registration system.
4040 $wgTrackingCategories = [];
4043 * Array of namespaces which can be deemed to contain valid "content", as far
4044 * as the site statistics are concerned. Useful if additional namespaces also
4045 * contain "content" which should be considered when generating a count of the
4046 * number of articles in the wiki.
4048 $wgContentNamespaces = [ NS_MAIN
];
4051 * Array of namespaces, in addition to the talk namespaces, where signatures
4052 * (~~~~) are likely to be used. This determines whether to display the
4053 * Signature button on the edit toolbar, and may also be used by extensions.
4054 * For example, "traditional" style wikis, where content and discussion are
4055 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4057 $wgExtraSignatureNamespaces = [];
4060 * Max number of redirects to follow when resolving redirects.
4061 * 1 means only the first redirect is followed (default behavior).
4062 * 0 or less means no redirects are followed.
4064 $wgMaxRedirects = 1;
4067 * Array of invalid page redirect targets.
4068 * Attempting to create a redirect to any of the pages in this array
4069 * will make the redirect fail.
4070 * Userlogout is hard-coded, so it does not need to be listed here.
4071 * (bug 10569) Disallow Mypage and Mytalk as well.
4073 * As of now, this only checks special pages. Redirects to pages in
4074 * other namespaces cannot be invalidated by this variable.
4076 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ];
4078 /** @} */ # End of title and interwiki settings }
4080 /************************************************************************//**
4081 * @name Parser settings
4082 * These settings configure the transformation from wikitext to HTML.
4087 * Parser configuration. Associative array with the following members:
4089 * class The class name
4091 * preprocessorClass The preprocessor class. Two classes are currently available:
4092 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4093 * storage, and Preprocessor_DOM, which uses the DOM module for
4094 * temporary storage. Preprocessor_DOM generally uses less memory;
4095 * the speed of the two is roughly the same.
4097 * If this parameter is not given, it uses Preprocessor_DOM if the
4098 * DOM module is available, otherwise it uses Preprocessor_Hash.
4100 * The entire associative array will be passed through to the constructor as
4101 * the first parameter. Note that only Setup.php can use this variable --
4102 * the configuration will change at runtime via $wgParser member functions, so
4103 * the contents of this variable will be out-of-date. The variable can only be
4104 * changed during LocalSettings.php, in particular, it can't be changed during
4105 * an extension setup function.
4108 'class' => 'Parser',
4109 # 'preprocessorClass' => 'Preprocessor_Hash',
4113 * Maximum indent level of toc.
4115 $wgMaxTocLevel = 999;
4118 * A complexity limit on template expansion: the maximum number of nodes visited
4119 * by PPFrame::expand()
4121 $wgMaxPPNodeCount = 1000000;
4124 * A complexity limit on template expansion: the maximum number of elements
4125 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4126 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4127 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4128 * this default corresponds to about 155 MB.
4130 * When the limit is exceeded, an exception is thrown.
4132 $wgMaxGeneratedPPNodeCount = 1000000;
4135 * Maximum recursion depth for templates within templates.
4136 * The current parser adds two levels to the PHP call stack for each template,
4137 * and xdebug limits the call stack to 100 by default. So this should hopefully
4138 * stop the parser before it hits the xdebug limit.
4140 $wgMaxTemplateDepth = 40;
4143 * @see $wgMaxTemplateDepth
4145 $wgMaxPPExpandDepth = 40;
4148 * URL schemes that should be recognized as valid by wfParseUrl().
4150 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4151 * Instead, if you want to support file links, add 'file://'. The same applies
4152 * to any other protocols with the same name as a namespace. See bug #44011 for
4158 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4159 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4160 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4161 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4165 * If true, removes (by substituting) templates in signatures.
4167 $wgCleanSignatures = true;
4170 * Whether to allow inline image pointing to other websites
4172 $wgAllowExternalImages = false;
4175 * If the above is false, you can specify an exception here. Image URLs
4176 * that start with this string are then rendered, while all others are not.
4177 * You can use this to set up a trusted, simple repository of images.
4178 * You may also specify an array of strings to allow multiple sites
4182 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4183 * $wgAllowExternalImagesFrom = [ 'http://127.0.0.1/', 'http://example.com' ];
4186 $wgAllowExternalImagesFrom = '';
4189 * If $wgAllowExternalImages is false, you can allow an on-wiki
4190 * whitelist of regular expression fragments to match the image URL
4191 * against. If the image matches one of the regular expression fragments,
4192 * The image will be displayed.
4194 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4195 * Or false to disable it
4197 $wgEnableImageWhitelist = true;
4200 * A different approach to the above: simply allow the "<img>" tag to be used.
4201 * This allows you to specify alt text and other attributes, copy-paste HTML to
4202 * your wiki more easily, etc. However, allowing external images in any manner
4203 * will allow anyone with editing rights to snoop on your visitors' IP
4204 * addresses and so forth, if they wanted to, by inserting links to images on
4205 * sites they control.
4207 $wgAllowImageTag = false;
4210 * Configuration for HTML postprocessing tool. Set this to a configuration
4211 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4212 * used. See http://www.w3.org/People/Raggett/tidy/
4214 * If this is null and $wgUseTidy is true, the deprecated configuration
4215 * parameters will be used instead.
4217 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4221 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4222 * - RaggettInternalPHP: Use the PECL extension
4223 * - RaggettExternal: Shell out to an external binary (tidyBin)
4224 * - Html5Depurate: Use external Depurate service
4225 * - Html5Internal: Use the built-in HTML5 balancer
4227 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4228 * - debugComment: True to add a comment to the output with warning messages
4229 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4230 * - tidyCommandLine: For RaggettExternal, additional command line options.
4232 $wgTidyConfig = null;
4235 * Set this to true to use the deprecated tidy configuration parameters.
4236 * @deprecated use $wgTidyConfig
4241 * The path to the tidy binary.
4242 * @deprecated Use $wgTidyConfig['tidyBin']
4244 $wgTidyBin = 'tidy';
4247 * The path to the tidy config file
4248 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4250 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4253 * The command line options to the tidy binary
4254 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4259 * Set this to true to use the tidy extension
4260 * @deprecated Use $wgTidyConfig['driver']
4262 $wgTidyInternal = extension_loaded( 'tidy' );
4265 * Put tidy warnings in HTML comments
4266 * Only works for internal tidy.
4268 $wgDebugTidy = false;
4271 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4272 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4273 * TO RESTRICT EDITING to only those that you trust
4278 * Set a default target for external links, e.g. _blank to pop up a new window.
4280 * This will also set the "noreferrer" and "noopener" link rel to prevent the
4281 * attack described at https://mathiasbynens.github.io/rel-noopener/ .
4282 * Some older browsers may not support these link attributes, hence
4283 * setting $wgExternalLinkTarget to _blank may represent a security risk
4284 * to some of your users.
4286 $wgExternalLinkTarget = false;
4289 * If true, external URL links in wiki text will be given the
4290 * rel="nofollow" attribute as a hint to search engines that
4291 * they should not be followed for ranking purposes as they
4292 * are user-supplied and thus subject to spamming.
4294 $wgNoFollowLinks = true;
4297 * Namespaces in which $wgNoFollowLinks doesn't apply.
4298 * See Language.php for a list of namespaces.
4300 $wgNoFollowNsExceptions = [];
4303 * If this is set to an array of domains, external links to these domain names
4304 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4305 * value of $wgNoFollowLinks. For instance:
4307 * $wgNoFollowDomainExceptions = [ 'en.wikipedia.org', 'wiktionary.org', 'mediawiki.org' ];
4309 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4310 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4313 * Defaults to mediawiki.org for the links included in the software by default.
4315 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ];
4318 * Allow DISPLAYTITLE to change title display
4320 $wgAllowDisplayTitle = true;
4323 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4324 * canonical DB key. Also disallow some inline CSS rules like display: none;
4325 * which can cause the text to be hidden or unselectable.
4327 $wgRestrictDisplayTitle = true;
4330 * Maximum number of calls per parse to expensive parser functions such as
4333 $wgExpensiveParserFunctionLimit = 100;
4336 * Preprocessor caching threshold
4337 * Setting it to 'false' will disable the preprocessor cache.
4339 $wgPreprocessorCacheThreshold = 1000;
4342 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4344 $wgEnableScaryTranscluding = false;
4347 * Expiry time for transcluded templates cached in transcache database table.
4348 * Only used $wgEnableInterwikiTranscluding is set to true.
4350 $wgTranscludeCacheExpiry = 3600;
4352 /** @} */ # end of parser settings }
4354 /************************************************************************//**
4360 * Method used to determine if a page in a content namespace should be counted
4361 * as a valid article.
4363 * Redirect pages will never be counted as valid articles.
4365 * This variable can have the following values:
4366 * - 'any': all pages as considered as valid articles
4367 * - 'comma': the page must contain a comma to be considered valid
4368 * - 'link': the page must contain a [[wiki link]] to be considered valid
4370 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4372 * Retroactively changing this variable will not affect the existing count,
4373 * to update it, you will need to run the maintenance/updateArticleCount.php
4376 $wgArticleCountMethod = 'link';
4379 * How many days user must be idle before he is considered inactive. Will affect
4380 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4381 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4382 * You might want to leave this as the default value, to provide comparable
4383 * numbers between different wikis.
4385 $wgActiveUserDays = 30;
4387 /** @} */ # End of statistics }
4389 /************************************************************************//**
4390 * @name User accounts, authentication
4395 * Central ID lookup providers
4396 * Key is the provider ID, value is a specification for ObjectFactory
4399 $wgCentralIdLookupProviders = [
4400 'local' => [ 'class' => 'LocalIdLookup' ],
4404 * Central ID lookup provider to use by default
4407 $wgCentralIdLookupProvider = 'local';
4410 * Password policy for local wiki users. A user's effective policy
4411 * is the superset of all policy statements from the policies for the
4412 * groups where the user is a member. If more than one group policy
4413 * include the same policy statement, the value is the max() of the
4414 * values. Note true > false. The 'default' policy group is required,
4415 * and serves as the minimum policy for all users. New statements can
4416 * be added by appending to $wgPasswordPolicy['checks'].
4418 * - MinimalPasswordLength - minimum length a user can set
4419 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4420 * not be allowed to login, regardless if it is correct.
4421 * - MaximalPasswordLength - maximum length password a user is allowed
4422 * to attempt. Prevents DoS attacks with pbkdf2.
4423 * - PasswordCannotMatchUsername - Password cannot match username to
4424 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4425 * match a specific, hardcoded blacklist.
4426 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4427 * commonly chosen. Set to integer n to ban the top n passwords.
4428 * If you want to ban all common passwords on file, use the
4429 * PHP_INT_MAX constant.
4432 $wgPasswordPolicy = [
4435 'MinimalPasswordLength' => 8,
4436 'MinimumPasswordLengthToLogin' => 1,
4437 'PasswordCannotMatchUsername' => true,
4438 'PasswordCannotBePopular' => 25,
4441 'MinimalPasswordLength' => 8,
4442 'MinimumPasswordLengthToLogin' => 1,
4443 'PasswordCannotMatchUsername' => true,
4444 'PasswordCannotBePopular' => 25,
4447 'MinimalPasswordLength' => 8,
4448 'MinimumPasswordLengthToLogin' => 1,
4449 'PasswordCannotMatchUsername' => true,
4452 'MinimalPasswordLength' => 1,
4453 'PasswordCannotMatchUsername' => true,
4454 'PasswordCannotMatchBlacklist' => true,
4455 'MaximalPasswordLength' => 4096,
4459 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4460 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4461 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4462 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4463 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4464 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist'
4469 * Configure AuthManager
4471 * All providers are constructed using ObjectFactory, see that for the general
4472 * structure. The array may also contain a key "sort" used to order providers:
4473 * providers are stably sorted by this value, which should be an integer
4477 * - preauth: Array (keys ignored) of specifications for PreAuthenticationProviders
4478 * - primaryauth: Array (keys ignored) of specifications for PrimaryAuthenticationProviders
4479 * - secondaryauth: Array (keys ignored) of specifications for SecondaryAuthenticationProviders
4482 * @note If this is null or empty, the value from $wgAuthManagerAutoConfig is
4483 * used instead. Local customization should generally set this variable from
4484 * scratch to the desired configuration. Extensions that want to
4485 * auto-configure themselves should use $wgAuthManagerAutoConfig instead.
4487 $wgAuthManagerConfig = null;
4490 * @see $wgAuthManagerConfig
4493 $wgAuthManagerAutoConfig = [
4495 MediaWiki\Auth\LegacyHookPreAuthenticationProvider
::class => [
4496 'class' => MediaWiki\Auth\LegacyHookPreAuthenticationProvider
::class,
4499 MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class => [
4500 'class' => MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class,
4505 // TemporaryPasswordPrimaryAuthenticationProvider should come before
4506 // any other PasswordAuthenticationRequest-based
4507 // PrimaryAuthenticationProvider (or at least any that might return
4508 // FAIL rather than ABSTAIN for a wrong password), or password reset
4509 // won't work right. Do not remove this (or change the key) or
4510 // auto-configuration of other such providers in extensions will
4511 // probably auto-insert themselves in the wrong place.
4512 MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class => [
4513 'class' => MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class,
4515 // Fall through to LocalPasswordPrimaryAuthenticationProvider
4516 'authoritative' => false,
4520 MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class => [
4521 'class' => MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class,
4523 // Last one should be authoritative, or else the user will get
4524 // a less-than-helpful error message (something like "supplied
4525 // authentication info not supported" rather than "wrong
4526 // password") if it too fails.
4527 'authoritative' => true,
4532 'secondaryauth' => [
4533 MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class => [
4534 'class' => MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class,
4537 MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class => [
4538 'class' => MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class,
4541 // Linking during login is experimental, enable at your own risk - T134952
4542 // MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class => [
4543 // 'class' => MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class,
4546 MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class => [
4547 'class' => MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class,
4554 * Time frame for re-authentication.
4556 * With only password-based authentication, you'd just ask the user to re-enter
4557 * their password to verify certain operations like changing the password or
4558 * changing the account's email address. But under AuthManager, the user might
4559 * not have a password (you might even have to redirect the browser to a
4560 * third-party service or something complex like that), you might want to have
4561 * both factors of a two-factor authentication, and so on. So, the options are:
4562 * - Incorporate the whole multi-step authentication flow within everything
4563 * that needs to do this.
4564 * - Consider it good if they used Special:UserLogin during this session within
4565 * the last X seconds.
4566 * - Come up with a third option.
4568 * MediaWiki currently takes the second option. This setting configures the
4571 * This allows for configuring different time frames for different
4572 * "operations". The operations used in MediaWiki core include:
4575 * - ChangeCredentials
4576 * - RemoveCredentials
4579 * Additional operations may be used by extensions, either explicitly by
4580 * calling AuthManager::securitySensitiveOperationStatus(),
4581 * ApiAuthManagerHelper::securitySensitiveOperation() or
4582 * SpecialPage::checkLoginSecurityLevel(), or implicitly by overriding
4583 * SpecialPage::getLoginSecurityLevel() or by subclassing
4584 * AuthManagerSpecialPage.
4586 * The key 'default' is used if a requested operation isn't defined in the array.
4589 * @var int[] operation => time in seconds. A 'default' key must always be provided.
4591 $wgReauthenticateTime = [
4596 * Whether to allow security-sensitive operations when re-authentication is not possible.
4598 * If AuthManager::canAuthenticateNow() is false (e.g. the current
4599 * SessionProvider is not able to change users, such as when OAuth is in use),
4600 * AuthManager::securitySensitiveOperationStatus() cannot sensibly return
4601 * SEC_REAUTH. Setting an operation true here will have it return SEC_OK in
4602 * that case, while setting it false will have it return SEC_FAIL.
4604 * The key 'default' is used if a requested operation isn't defined in the array.
4607 * @see $wgReauthenticateTime
4608 * @var bool[] operation => boolean. A 'default' key must always be provided.
4610 $wgAllowSecuritySensitiveOperationIfCannotReauthenticate = [
4615 * List of AuthenticationRequest class names which are not changeable through
4616 * Special:ChangeCredentials and the changeauthenticationdata API.
4617 * This is only enforced on the client level; AuthManager itself (e.g.
4618 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4619 * Class names are checked for exact match (not for subclasses).
4623 $wgChangeCredentialsBlacklist = [
4624 \MediaWiki\Auth\TemporaryPasswordAuthenticationRequest
::class
4628 * List of AuthenticationRequest class names which are not removable through
4629 * Special:RemoveCredentials and the removeauthenticationdata API.
4630 * This is only enforced on the client level; AuthManager itself (e.g.
4631 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4632 * Class names are checked for exact match (not for subclasses).
4636 $wgRemoveCredentialsBlacklist = [
4637 \MediaWiki\Auth\PasswordAuthenticationRequest
::class,
4641 * For compatibility with old installations set to false
4642 * @deprecated since 1.24 will be removed in future
4644 $wgPasswordSalt = true;
4647 * Specifies the minimal length of a user password. If set to 0, empty pass-
4648 * words are allowed.
4649 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4651 $wgMinimalPasswordLength = false;
4654 * Specifies the maximal length of a user password (T64685).
4656 * It is not recommended to make this greater than the default, as it can
4657 * allow DoS attacks by users setting really long passwords. In addition,
4658 * this should not be lowered too much, as it enforces weak passwords.
4660 * @warning Unlike other password settings, user with passwords greater than
4661 * the maximum will not be able to log in.
4662 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4664 $wgMaximalPasswordLength = false;
4667 * Specifies if users should be sent to a password-reset form on login, if their
4668 * password doesn't meet the requirements of User::isValidPassword().
4671 $wgInvalidPasswordReset = true;
4674 * Default password type to use when hashing user passwords
4678 $wgPasswordDefault = 'pbkdf2';
4681 * Configuration for built-in password types. Maps the password type
4682 * to an array of options. The 'class' option is the Password class to
4683 * use. All other options are class-dependent.
4685 * An advanced example:
4687 * $wgPasswordConfig['bcrypt-peppered'] = [
4688 * 'class' => 'EncryptedPassword',
4689 * 'underlying' => 'bcrypt',
4691 * 'cipher' => MCRYPT_RIJNDAEL_256,
4692 * 'mode' => MCRYPT_MODE_CBC,
4699 $wgPasswordConfig = [
4701 'class' => 'MWOldPassword',
4704 'class' => 'MWSaltedPassword',
4706 'pbkdf2-legacyA' => [
4707 'class' => 'LayeredParameterizedPassword',
4713 'pbkdf2-legacyB' => [
4714 'class' => 'LayeredParameterizedPassword',
4721 'class' => 'BcryptPassword',
4725 'class' => 'Pbkdf2Password',
4733 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4734 * with a temporary password you can use to get back into the account") identified by
4735 * various bits of data. Setting all of these to false (or the whole variable to false)
4736 * has the effect of disabling password resets entirely
4738 $wgPasswordResetRoutes = [
4744 * Maximum number of Unicode characters in signature
4746 $wgMaxSigChars = 255;
4749 * Maximum number of bytes in username. You want to run the maintenance
4750 * script ./maintenance/checkUsernames.php once you have changed this value.
4752 $wgMaxNameChars = 255;
4755 * Array of usernames which may not be registered or logged in from
4756 * Maintenance scripts can still use these
4758 $wgReservedUsernames = [
4759 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4760 'Conversion script', // Used for the old Wikipedia software upgrade
4761 'Maintenance script', // Maintenance scripts which perform editing, image import script
4762 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4763 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4764 'msg:double-redirect-fixer', // Automatic double redirect fix
4765 'msg:usermessage-editor', // Default user for leaving user messages
4766 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4767 'msg:spambot_username', // Used by cleanupSpam.php
4768 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4772 * Settings added to this array will override the default globals for the user
4773 * preferences used by anonymous visitors and newly created accounts.
4774 * For instance, to disable editing on double clicks:
4775 * $wgDefaultUserOptions ['editondblclick'] = 0;
4777 $wgDefaultUserOptions = [
4778 'ccmeonemails' => 0,
4780 'date' => 'default',
4783 'editfont' => 'default',
4784 'editondblclick' => 0,
4785 'editsectiononrightclick' => 0,
4786 'enotifminoredits' => 0,
4787 'enotifrevealaddr' => 0,
4788 'enotifusertalkpages' => 1,
4789 'enotifwatchlistpages' => 1,
4790 'extendwatchlist' => 1,
4792 'forceeditsummary' => 0,
4793 'gender' => 'unknown',
4795 'hidepatrolled' => 0,
4796 'hidecategorization' => 1,
4799 'minordefault' => 0,
4800 'newpageshidepatrolled' => 0,
4802 'norollbackdiff' => 0,
4803 'numberheadings' => 0,
4804 'previewonfirst' => 0,
4805 'previewontop' => 1,
4809 'showhiddencats' => 0,
4810 'shownumberswatching' => 1,
4813 'stubthreshold' => 0,
4816 'uselivepreview' => 0,
4818 'watchcreations' => 1,
4819 'watchdefault' => 1,
4820 'watchdeletion' => 0,
4821 'watchuploads' => 1,
4822 'watchlistdays' => 3.0,
4823 'watchlisthideanons' => 0,
4824 'watchlisthidebots' => 0,
4825 'watchlisthideliu' => 0,
4826 'watchlisthideminor' => 0,
4827 'watchlisthideown' => 0,
4828 'watchlisthidepatrolled' => 0,
4829 'watchlisthidecategorization' => 1,
4830 'watchlistreloadautomatically' => 0,
4832 'watchrollback' => 0,
4834 'useeditwarning' => 1,
4835 'prefershttps' => 1,
4839 * An array of preferences to not show for the user
4841 $wgHiddenPrefs = [];
4844 * Characters to prevent during new account creations.
4845 * This is used in a regular expression character class during
4846 * registration (regex metacharacters like / are escaped).
4848 $wgInvalidUsernameCharacters = '@:';
4851 * Character used as a delimiter when testing for interwiki userrights
4852 * (In Special:UserRights, it is possible to modify users on different
4853 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4855 * It is recommended that you have this delimiter in
4856 * $wgInvalidUsernameCharacters above, or you will not be able to
4857 * modify the user rights of those users via Special:UserRights
4859 $wgUserrightsInterwikiDelimiter = '@';
4862 * This is to let user authenticate using https when they come from http.
4863 * Based on an idea by George Herbert on wikitech-l:
4864 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4867 $wgSecureLogin = false;
4870 * Versioning for authentication tokens.
4872 * If non-null, this is combined with the user's secret (the user_token field
4873 * in the DB) to generate the token cookie. Changing this will invalidate all
4874 * active sessions (i.e. it will log everyone out).
4879 $wgAuthenticationTokenVersion = null;
4882 * MediaWiki\Session\SessionProvider configuration.
4884 * Value is an array of ObjectFactory specifications for the SessionProviders
4885 * to be used. Keys in the array are ignored. Order is not significant.
4889 $wgSessionProviders = [
4890 MediaWiki\Session\CookieSessionProvider
::class => [
4891 'class' => MediaWiki\Session\CookieSessionProvider
::class,
4894 'callUserSetCookiesHook' => true,
4897 MediaWiki\Session\BotPasswordSessionProvider
::class => [
4898 'class' => MediaWiki\Session\BotPasswordSessionProvider
::class,
4905 /** @} */ # end user accounts }
4907 /************************************************************************//**
4908 * @name User rights, access control and monitoring
4913 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4915 $wgAutoblockExpiry = 86400;
4918 * Set this to true to allow blocked users to edit their own user talk page.
4920 $wgBlockAllowsUTEdit = true;
4923 * Allow sysops to ban users from accessing Emailuser
4925 $wgSysopEmailBans = true;
4928 * Limits on the possible sizes of range blocks.
4930 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4931 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4932 * half the number of bits avoids such errors, and allows entire ISPs to be
4933 * blocked using a small number of range blocks.
4935 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4936 * customer, so range blocks larger than /64 (half the number of bits) will
4937 * plainly be required. RFC 4692 implies that a very large ISP may be
4938 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4939 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4941 $wgBlockCIDRLimit = [
4942 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4947 * If true, blocked users will not be allowed to login. When using this with
4948 * a public wiki, the effect of logging out blocked users may actually be
4949 * avers: unless the user's address is also blocked (e.g. auto-block),
4950 * logging the user out will again allow reading and editing, just as for
4951 * anonymous visitors.
4953 $wgBlockDisablesLogin = false;
4956 * Pages anonymous user may see, set as an array of pages titles.
4960 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4963 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4965 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4966 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4968 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4969 * will remain readable. You can use img_auth.php to protect uploaded files,
4970 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4972 $wgWhitelistRead = false;
4975 * Pages anonymous user may see, set as an array of regular expressions.
4977 * This function will match the regexp against the title name, which
4978 * is without underscore.
4981 * To whitelist [[Main Page]]:
4983 * $wgWhitelistReadRegexp = [ "/Main Page/" ];
4986 * @note Unless ^ and/or $ is specified, a regular expression might match
4987 * pages not intended to be whitelisted. The above example will also
4988 * whitelist a page named 'Security Main Page'.
4991 * To allow reading any page starting with 'User' regardless of the case:
4993 * $wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];
4995 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4997 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4998 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
5000 $wgWhitelistReadRegexp = false;
5003 * Should editors be required to have a validated e-mail
5004 * address before being allowed to edit?
5006 $wgEmailConfirmToEdit = false;
5009 * Should MediaWiki attempt to protect user's privacy when doing redirects?
5010 * Keep this true if access counts to articles are made public.
5012 $wgHideIdentifiableRedirects = true;
5015 * Permission keys given to users in each group.
5017 * This is an array where the keys are all groups and each value is an
5018 * array of the format (right => boolean).
5020 * The second format is used to support per-namespace permissions.
5021 * Note that this feature does not fully work for all permission types.
5023 * All users are implicitly in the '*' group including anonymous visitors;
5024 * logged-in users are all implicitly in the 'user' group. These will be
5025 * combined with the permissions of all groups that a given user is listed
5026 * in in the user_groups table.
5028 * Note: Don't set $wgGroupPermissions = []; unless you know what you're
5029 * doing! This will wipe all permissions, and may mean that your users are
5030 * unable to perform certain essential tasks or access new functionality
5031 * when new permissions are introduced and default grants established.
5033 * Functionality to make pages inaccessible has not been extensively tested
5034 * for security. Use at your own risk!
5036 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
5038 $wgGroupPermissions = [];
5040 /** @cond file_level_code */
5041 // Implicit group for all visitors
5042 $wgGroupPermissions['*']['createaccount'] = true;
5043 $wgGroupPermissions['*']['read'] = true;
5044 $wgGroupPermissions['*']['edit'] = true;
5045 $wgGroupPermissions['*']['createpage'] = true;
5046 $wgGroupPermissions['*']['createtalk'] = true;
5047 $wgGroupPermissions['*']['writeapi'] = true;
5048 $wgGroupPermissions['*']['editmyusercss'] = true;
5049 $wgGroupPermissions['*']['editmyuserjs'] = true;
5050 $wgGroupPermissions['*']['viewmywatchlist'] = true;
5051 $wgGroupPermissions['*']['editmywatchlist'] = true;
5052 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
5053 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
5054 $wgGroupPermissions['*']['editmyoptions'] = true;
5055 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
5057 // Implicit group for all logged-in accounts
5058 $wgGroupPermissions['user']['move'] = true;
5059 $wgGroupPermissions['user']['move-subpages'] = true;
5060 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
5061 $wgGroupPermissions['user']['move-categorypages'] = true;
5062 $wgGroupPermissions['user']['movefile'] = true;
5063 $wgGroupPermissions['user']['read'] = true;
5064 $wgGroupPermissions['user']['edit'] = true;
5065 $wgGroupPermissions['user']['createpage'] = true;
5066 $wgGroupPermissions['user']['createtalk'] = true;
5067 $wgGroupPermissions['user']['writeapi'] = true;
5068 $wgGroupPermissions['user']['upload'] = true;
5069 $wgGroupPermissions['user']['reupload'] = true;
5070 $wgGroupPermissions['user']['reupload-shared'] = true;
5071 $wgGroupPermissions['user']['minoredit'] = true;
5072 $wgGroupPermissions['user']['purge'] = true;
5073 $wgGroupPermissions['user']['sendemail'] = true;
5074 $wgGroupPermissions['user']['applychangetags'] = true;
5075 $wgGroupPermissions['user']['changetags'] = true;
5077 // Implicit group for accounts that pass $wgAutoConfirmAge
5078 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
5079 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
5081 // Users with bot privilege can have their edits hidden
5082 // from various log pages by default
5083 $wgGroupPermissions['bot']['bot'] = true;
5084 $wgGroupPermissions['bot']['autoconfirmed'] = true;
5085 $wgGroupPermissions['bot']['editsemiprotected'] = true;
5086 $wgGroupPermissions['bot']['nominornewtalk'] = true;
5087 $wgGroupPermissions['bot']['autopatrol'] = true;
5088 $wgGroupPermissions['bot']['suppressredirect'] = true;
5089 $wgGroupPermissions['bot']['apihighlimits'] = true;
5090 $wgGroupPermissions['bot']['writeapi'] = true;
5092 // Most extra permission abilities go to this group
5093 $wgGroupPermissions['sysop']['block'] = true;
5094 $wgGroupPermissions['sysop']['createaccount'] = true;
5095 $wgGroupPermissions['sysop']['delete'] = true;
5096 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
5097 $wgGroupPermissions['sysop']['bigdelete'] = true;
5098 // can view deleted history entries, but not see or restore the text
5099 $wgGroupPermissions['sysop']['deletedhistory'] = true;
5100 // can view deleted revision text
5101 $wgGroupPermissions['sysop']['deletedtext'] = true;
5102 $wgGroupPermissions['sysop']['undelete'] = true;
5103 $wgGroupPermissions['sysop']['editinterface'] = true;
5104 $wgGroupPermissions['sysop']['editusercss'] = true;
5105 $wgGroupPermissions['sysop']['edituserjs'] = true;
5106 $wgGroupPermissions['sysop']['editcontentmodel'] = true;
5107 $wgGroupPermissions['sysop']['import'] = true;
5108 $wgGroupPermissions['sysop']['importupload'] = true;
5109 $wgGroupPermissions['sysop']['move'] = true;
5110 $wgGroupPermissions['sysop']['move-subpages'] = true;
5111 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
5112 $wgGroupPermissions['sysop']['move-categorypages'] = true;
5113 $wgGroupPermissions['sysop']['patrol'] = true;
5114 $wgGroupPermissions['sysop']['autopatrol'] = true;
5115 $wgGroupPermissions['sysop']['protect'] = true;
5116 $wgGroupPermissions['sysop']['editprotected'] = true;
5117 $wgGroupPermissions['sysop']['rollback'] = true;
5118 $wgGroupPermissions['sysop']['upload'] = true;
5119 $wgGroupPermissions['sysop']['reupload'] = true;
5120 $wgGroupPermissions['sysop']['reupload-shared'] = true;
5121 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
5122 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
5123 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
5124 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
5125 $wgGroupPermissions['sysop']['blockemail'] = true;
5126 $wgGroupPermissions['sysop']['markbotedits'] = true;
5127 $wgGroupPermissions['sysop']['apihighlimits'] = true;
5128 $wgGroupPermissions['sysop']['browsearchive'] = true;
5129 $wgGroupPermissions['sysop']['noratelimit'] = true;
5130 $wgGroupPermissions['sysop']['movefile'] = true;
5131 $wgGroupPermissions['sysop']['unblockself'] = true;
5132 $wgGroupPermissions['sysop']['suppressredirect'] = true;
5133 # $wgGroupPermissions['sysop']['pagelang'] = true;
5134 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
5135 $wgGroupPermissions['sysop']['mergehistory'] = true;
5136 $wgGroupPermissions['sysop']['managechangetags'] = true;
5137 $wgGroupPermissions['sysop']['deletechangetags'] = true;
5139 // Permission to change users' group assignments
5140 $wgGroupPermissions['bureaucrat']['userrights'] = true;
5141 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
5142 // Permission to change users' groups assignments across wikis
5143 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
5144 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
5145 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
5147 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
5148 # $wgGroupPermissions['sysop']['deleterevision'] = true;
5149 // To hide usernames from users and Sysops
5150 # $wgGroupPermissions['suppress']['hideuser'] = true;
5151 // To hide revisions/log items from users and Sysops
5152 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
5153 // To view revisions/log items hidden from users and Sysops
5154 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
5155 // For private suppression log access
5156 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
5159 * The developer group is deprecated, but can be activated if need be
5160 * to use the 'lockdb' and 'unlockdb' special pages. Those require
5161 * that a lock file be defined and creatable/removable by the web
5164 # $wgGroupPermissions['developer']['siteadmin'] = true;
5169 * Permission keys revoked from users in each group.
5171 * This acts the same way as wgGroupPermissions above, except that
5172 * if the user is in a group here, the permission will be removed from them.
5174 * Improperly setting this could mean that your users will be unable to perform
5175 * certain essential tasks, so use at your own risk!
5177 $wgRevokePermissions = [];
5180 * Implicit groups, aren't shown on Special:Listusers or somewhere else
5182 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ];
5185 * A map of group names that the user is in, to group names that those users
5186 * are allowed to add or revoke.
5188 * Setting the list of groups to add or revoke to true is equivalent to "any
5192 * To allow sysops to add themselves to the "bot" group:
5194 * $wgGroupsAddToSelf = [ 'sysop' => [ 'bot' ] ];
5198 * Implicit groups may be used for the source group, for instance:
5200 * $wgGroupsRemoveFromSelf = [ '*' => true ];
5202 * This allows users in the '*' group (i.e. any user) to remove themselves from
5203 * any group that they happen to be in.
5205 $wgGroupsAddToSelf = [];
5208 * @see $wgGroupsAddToSelf
5210 $wgGroupsRemoveFromSelf = [];
5213 * Set of available actions that can be restricted via action=protect
5214 * You probably shouldn't change this.
5215 * Translated through restriction-* messages.
5216 * Title::getRestrictionTypes() will remove restrictions that are not
5217 * applicable to a specific title (create and upload)
5219 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ];
5222 * Rights which can be required for each protection level (via action=protect)
5224 * You can add a new protection level that requires a specific
5225 * permission by manipulating this array. The ordering of elements
5226 * dictates the order on the protection form's lists.
5228 * - '' will be ignored (i.e. unprotected)
5229 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
5230 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
5232 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ];
5235 * Restriction levels that can be used with cascading protection
5237 * A page can only be protected with cascading protection if the
5238 * requested restriction level is included in this array.
5240 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5241 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
5243 $wgCascadingRestrictionLevels = [ 'sysop' ];
5246 * Restriction levels that should be considered "semiprotected"
5248 * Certain places in the interface recognize a dichotomy between "protected"
5249 * and "semiprotected", without further distinguishing the specific levels. In
5250 * general, if anyone can be eligible to edit a protection level merely by
5251 * reaching some condition in $wgAutopromote, it should probably be considered
5254 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5255 * 'sysop' is not changed, since it really shouldn't be here.
5257 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ];
5260 * Set the minimum permissions required to edit pages in each
5261 * namespace. If you list more than one permission, a user must
5262 * have all of them to edit pages in that namespace.
5264 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5266 $wgNamespaceProtection = [];
5269 * Pages in namespaces in this array can not be used as templates.
5271 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5272 * namespaces constants (NS_USER, NS_MAIN...).
5274 * Among other things, this may be useful to enforce read-restrictions
5275 * which may otherwise be bypassed by using the template mechanism.
5277 $wgNonincludableNamespaces = [];
5280 * Number of seconds an account is required to age before it's given the
5281 * implicit 'autoconfirm' group membership. This can be used to limit
5282 * privileges of new accounts.
5284 * Accounts created by earlier versions of the software may not have a
5285 * recorded creation date, and will always be considered to pass the age test.
5287 * When left at 0, all registered accounts will pass.
5290 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5292 * $wgAutoConfirmAge = 600; // ten minutes
5294 * Set age to one day:
5296 * $wgAutoConfirmAge = 3600*24; // one day
5299 $wgAutoConfirmAge = 0;
5302 * Number of edits an account requires before it is autoconfirmed.
5303 * Passing both this AND the time requirement is needed. Example:
5307 * $wgAutoConfirmCount = 50;
5310 $wgAutoConfirmCount = 0;
5313 * Automatically add a usergroup to any user who matches certain conditions.
5315 * @todo Redocument $wgAutopromote
5318 * [ '&' or '|' or '^' or '!', cond1, cond2, ... ]
5319 * where cond1, cond2, ... are themselves conditions; *OR*
5320 * APCOND_EMAILCONFIRMED, *OR*
5321 * [ APCOND_EMAILCONFIRMED ], *OR*
5322 * [ APCOND_EDITCOUNT, number of edits ], *OR*
5323 * [ APCOND_AGE, seconds since registration ], *OR*
5324 * [ APCOND_INGROUPS, group1, group2, ... ], *OR*
5325 * [ APCOND_ISIP, ip ], *OR*
5326 * [ APCOND_IPINRANGE, range ], *OR*
5327 * [ APCOND_AGE_FROM_EDIT, seconds since first edit ], *OR*
5328 * [ APCOND_BLOCKED ], *OR*
5329 * [ APCOND_ISBOT ], *OR*
5330 * similar constructs defined by extensions.
5332 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
5333 * user who has provided an e-mail address.
5336 'autoconfirmed' => [ '&',
5337 [ APCOND_EDITCOUNT
, &$wgAutoConfirmCount ],
5338 [ APCOND_AGE
, &$wgAutoConfirmAge ],
5343 * Automatically add a usergroup to any user who matches certain conditions.
5345 * Does not add the user to the group again if it has been removed.
5346 * Also, does not remove the group if the user no longer meets the criteria.
5350 * [ event => criteria, ... ]
5352 * Where event is either:
5353 * - 'onEdit' (when user edits)
5355 * Criteria has the same format as $wgAutopromote
5357 * @see $wgAutopromote
5360 $wgAutopromoteOnce = [
5365 * Put user rights log entries for autopromotion in recent changes?
5368 $wgAutopromoteOnceLogInRC = true;
5371 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5372 * can assign which groups at Special:Userrights.
5375 * Bureaucrats can add any group:
5377 * $wgAddGroups['bureaucrat'] = true;
5379 * Bureaucrats can only remove bots and sysops:
5381 * $wgRemoveGroups['bureaucrat'] = [ 'bot', 'sysop' ];
5383 * Sysops can make bots:
5385 * $wgAddGroups['sysop'] = [ 'bot' ];
5387 * Sysops can disable other sysops in an emergency, and disable bots:
5389 * $wgRemoveGroups['sysop'] = [ 'sysop', 'bot' ];
5397 $wgRemoveGroups = [];
5400 * A list of available rights, in addition to the ones defined by the core.
5401 * For extensions only.
5403 $wgAvailableRights = [];
5406 * Optional to restrict deletion of pages with higher revision counts
5407 * to users with the 'bigdelete' permission. (Default given to sysops.)
5409 $wgDeleteRevisionsLimit = 0;
5412 * The maximum number of edits a user can have and
5413 * can still be hidden by users with the hideuser permission.
5414 * This is limited for performance reason.
5415 * Set to false to disable the limit.
5418 $wgHideUserContribLimit = 1000;
5421 * Number of accounts each IP address may create, 0 to disable.
5423 * @warning Requires $wgMainCacheType to be enabled
5425 $wgAccountCreationThrottle = 0;
5428 * Edits matching these regular expressions in body text
5429 * will be recognised as spam and rejected automatically.
5431 * There's no administrator override on-wiki, so be careful what you set. :)
5432 * May be an array of regexes or a single string for backwards compatibility.
5434 * @see https://en.wikipedia.org/wiki/Regular_expression
5436 * @note Each regex needs a beginning/end delimiter, eg: # or /
5441 * Same as the above except for edit summaries
5443 $wgSummarySpamRegex = [];
5446 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5450 $wgEnableDnsBlacklist = false;
5453 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5455 * This is an array of either a URL or an array with the URL and a key (should
5456 * the blacklist require a key).
5460 * $wgDnsBlacklistUrls = [
5461 * // String containing URL
5462 * 'http.dnsbl.sorbs.net.',
5463 * // Array with URL and key, for services that require a key
5464 * [ 'dnsbl.httpbl.net.', 'mykey' ],
5465 * // Array with just the URL. While this works, it is recommended that you
5466 * // just use a string as shown above
5467 * [ 'opm.tornevall.org.' ]
5471 * @note You should end the domain name with a . to avoid searching your
5472 * eventual domain search suffixes.
5475 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ];
5478 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5479 * what the other methods might say.
5481 $wgProxyWhitelist = [];
5484 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5485 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5486 * (transparent) proxies without needing to block the proxies themselves.
5488 $wgApplyIpBlocksToXff = false;
5491 * Simple rate limiter options to brake edit floods.
5493 * Maximum number actions allowed in the given number of seconds; after that
5494 * the violating client receives HTTP 500 error pages until the period
5498 * To set a generic maximum of 4 hits in 60 seconds:
5500 * $wgRateLimits = [ 4, 60 ];
5504 * You could also limit per action and then type of users.
5508 * 'anon' => [ x, y ], // any and all anonymous edits (aggregate)
5509 * 'user' => [ x, y ], // each logged-in user
5510 * 'newbie' => [ x, y ], // each new autoconfirmed accounts; overrides 'user'
5511 * 'ip' => [ x, y ], // each anon and recent account
5512 * 'subnet' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
5517 * @warning Requires that $wgMainCacheType is set to something persistent
5523 'newbie' => [ 8, 60 ],
5527 'newbie' => [ 2, 120 ],
5528 'user' => [ 8, 60 ],
5533 'newbie' => [ 8, 60 ],
5537 'user' => [ 10, 60 ],
5538 'newbie' => [ 5, 120 ]
5540 // Triggering password resets emails
5542 'ip' => [ 5, 3600 ],
5544 // Emailing other users using MediaWiki
5546 'ip' => [ 5, 86400 ],
5547 'newbie' => [ 5, 86400 ],
5548 'user' => [ 20, 86400 ],
5553 'user' => [ 30, 60 ],
5555 // Purges of link tables
5558 'user' => [ 30, 60 ],
5560 // Files rendered via thumb.php or thumb_handler.php
5562 'ip' => [ 700, 30 ],
5563 'user' => [ 700, 30 ],
5565 // Same as above but for non-standard thumbnails
5566 'renderfile-nonstandard' => [
5568 'user' => [ 70, 30 ],
5570 // Stashing edits into cache before save
5573 'newbie' => [ 30, 60 ],
5575 // Adding or removing change tags
5578 'newbie' => [ 8, 60 ],
5583 * Array of IPs which should be excluded from rate limits.
5584 * This may be useful for whitelisting NAT gateways for conferences, etc.
5586 $wgRateLimitsExcludedIPs = [];
5589 * Log IP addresses in the recentchanges table; can be accessed only by
5590 * extensions (e.g. CheckUser) or a DB admin
5591 * Used for retroactive autoblocks
5593 $wgPutIPinRC = true;
5596 * Integer defining default number of entries to show on
5597 * special pages which are query-pages such as Special:Whatlinkshere.
5599 $wgQueryPageDefaultLimit = 50;
5602 * Limit password attempts to X attempts per Y seconds per IP per account.
5604 * Value is an array of arrays. Each sub-array must have a key for count
5605 * (ie count of how many attempts before throttle) and a key for seconds.
5606 * If the key 'allIPs' (case sensitive) is present, then the limit is
5607 * just per account instead of per IP per account.
5609 * @since 1.27 allIps support and multiple limits added in 1.27. Prior
5610 * to 1.27 this only supported having a single throttle.
5611 * @warning Requires $wgMainCacheType to be enabled
5613 $wgPasswordAttemptThrottle = [
5615 [ 'count' => 5, 'seconds' => 300 ],
5616 // Long term limit. We need to balance the risk
5617 // of somebody using this as a DoS attack to lock someone
5618 // out of their account, and someone doing a brute force attack.
5619 [ 'count' => 150, 'seconds' => 60*60*48 ],
5623 * @var Array Map of (grant => right => boolean)
5624 * Users authorize consumers (like Apps) to act on their behalf but only with
5625 * a subset of the user's normal account rights (signed off on by the user).
5626 * The possible rights to grant to a consumer are bundled into groups called
5627 * "grants". Each grant defines some rights it lets consumers inherit from the
5628 * account they may act on behalf of. Note that a user granting a right does
5629 * nothing if that user does not actually have that right to begin with.
5632 $wgGrantPermissions = [];
5634 // @TODO: clean up grants
5635 // @TODO: auto-include read/editsemiprotected rights?
5637 $wgGrantPermissions['basic']['autoconfirmed'] = true;
5638 $wgGrantPermissions['basic']['autopatrol'] = true;
5639 $wgGrantPermissions['basic']['editsemiprotected'] = true;
5640 $wgGrantPermissions['basic']['ipblock-exempt'] = true;
5641 $wgGrantPermissions['basic']['nominornewtalk'] = true;
5642 $wgGrantPermissions['basic']['patrolmarks'] = true;
5643 $wgGrantPermissions['basic']['purge'] = true;
5644 $wgGrantPermissions['basic']['read'] = true;
5645 $wgGrantPermissions['basic']['skipcaptcha'] = true;
5646 $wgGrantPermissions['basic']['writeapi'] = true;
5648 $wgGrantPermissions['highvolume']['bot'] = true;
5649 $wgGrantPermissions['highvolume']['apihighlimits'] = true;
5650 $wgGrantPermissions['highvolume']['noratelimit'] = true;
5651 $wgGrantPermissions['highvolume']['markbotedits'] = true;
5653 $wgGrantPermissions['editpage']['edit'] = true;
5654 $wgGrantPermissions['editpage']['minoredit'] = true;
5655 $wgGrantPermissions['editpage']['applychangetags'] = true;
5656 $wgGrantPermissions['editpage']['changetags'] = true;
5658 $wgGrantPermissions['editprotected'] = $wgGrantPermissions['editpage'];
5659 $wgGrantPermissions['editprotected']['editprotected'] = true;
5661 $wgGrantPermissions['editmycssjs'] = $wgGrantPermissions['editpage'];
5662 $wgGrantPermissions['editmycssjs']['editmyusercss'] = true;
5663 $wgGrantPermissions['editmycssjs']['editmyuserjs'] = true;
5665 $wgGrantPermissions['editmyoptions']['editmyoptions'] = true;
5667 $wgGrantPermissions['editinterface'] = $wgGrantPermissions['editpage'];
5668 $wgGrantPermissions['editinterface']['editinterface'] = true;
5669 $wgGrantPermissions['editinterface']['editusercss'] = true;
5670 $wgGrantPermissions['editinterface']['edituserjs'] = true;
5672 $wgGrantPermissions['createeditmovepage'] = $wgGrantPermissions['editpage'];
5673 $wgGrantPermissions['createeditmovepage']['createpage'] = true;
5674 $wgGrantPermissions['createeditmovepage']['createtalk'] = true;
5675 $wgGrantPermissions['createeditmovepage']['move'] = true;
5676 $wgGrantPermissions['createeditmovepage']['move-rootuserpages'] = true;
5677 $wgGrantPermissions['createeditmovepage']['move-subpages'] = true;
5678 $wgGrantPermissions['createeditmovepage']['move-categorypages'] = true;
5680 $wgGrantPermissions['uploadfile']['upload'] = true;
5681 $wgGrantPermissions['uploadfile']['reupload-own'] = true;
5683 $wgGrantPermissions['uploadeditmovefile'] = $wgGrantPermissions['uploadfile'];
5684 $wgGrantPermissions['uploadeditmovefile']['reupload'] = true;
5685 $wgGrantPermissions['uploadeditmovefile']['reupload-shared'] = true;
5686 $wgGrantPermissions['uploadeditmovefile']['upload_by_url'] = true;
5687 $wgGrantPermissions['uploadeditmovefile']['movefile'] = true;
5688 $wgGrantPermissions['uploadeditmovefile']['suppressredirect'] = true;
5690 $wgGrantPermissions['patrol']['patrol'] = true;
5692 $wgGrantPermissions['rollback']['rollback'] = true;
5694 $wgGrantPermissions['blockusers']['block'] = true;
5695 $wgGrantPermissions['blockusers']['blockemail'] = true;
5697 $wgGrantPermissions['viewdeleted']['browsearchive'] = true;
5698 $wgGrantPermissions['viewdeleted']['deletedhistory'] = true;
5699 $wgGrantPermissions['viewdeleted']['deletedtext'] = true;
5701 $wgGrantPermissions['delete'] = $wgGrantPermissions['editpage'] +
5702 $wgGrantPermissions['viewdeleted'];
5703 $wgGrantPermissions['delete']['delete'] = true;
5704 $wgGrantPermissions['delete']['bigdelete'] = true;
5705 $wgGrantPermissions['delete']['deletelogentry'] = true;
5706 $wgGrantPermissions['delete']['deleterevision'] = true;
5707 $wgGrantPermissions['delete']['undelete'] = true;
5709 $wgGrantPermissions['protect'] = $wgGrantPermissions['editprotected'];
5710 $wgGrantPermissions['protect']['protect'] = true;
5712 $wgGrantPermissions['viewmywatchlist']['viewmywatchlist'] = true;
5714 $wgGrantPermissions['editmywatchlist']['editmywatchlist'] = true;
5716 $wgGrantPermissions['sendemail']['sendemail'] = true;
5718 $wgGrantPermissions['createaccount']['createaccount'] = true;
5720 $wgGrantPermissions['privateinfo']['viewmyprivateinfo'] = true;
5723 * @var Array Map of grants to their UI grouping
5726 $wgGrantPermissionGroups = [
5727 // Hidden grants are implicitly present
5728 'basic' => 'hidden',
5730 'editpage' => 'page-interaction',
5731 'createeditmovepage' => 'page-interaction',
5732 'editprotected' => 'page-interaction',
5733 'patrol' => 'page-interaction',
5735 'uploadfile' => 'file-interaction',
5736 'uploadeditmovefile' => 'file-interaction',
5738 'sendemail' => 'email',
5740 'viewmywatchlist' => 'watchlist-interaction',
5741 'editviewmywatchlist' => 'watchlist-interaction',
5743 'editmycssjs' => 'customization',
5744 'editmyoptions' => 'customization',
5746 'editinterface' => 'administration',
5747 'rollback' => 'administration',
5748 'blockusers' => 'administration',
5749 'delete' => 'administration',
5750 'viewdeleted' => 'administration',
5751 'protect' => 'administration',
5752 'createaccount' => 'administration',
5754 'highvolume' => 'high-volume',
5756 'privateinfo' => 'private-information',
5760 * @var bool Whether to enable bot passwords
5763 $wgEnableBotPasswords = true;
5766 * Cluster for the bot_passwords table
5767 * @var string|bool If false, the normal cluster will be used
5770 $wgBotPasswordsCluster = false;
5773 * Database name for the bot_passwords table
5775 * To use a database with a table prefix, set this variable to
5776 * "{$database}-{$prefix}".
5777 * @var string|bool If false, the normal database will be used
5780 $wgBotPasswordsDatabase = false;
5782 /** @} */ # end of user rights settings
5784 /************************************************************************//**
5785 * @name Proxy scanner settings
5790 * This should always be customised in LocalSettings.php
5792 $wgSecretKey = false;
5795 * Big list of banned IP addresses.
5797 * This can have the following formats:
5798 * - An array of addresses, either in the values
5799 * or the keys (for backward compatibility)
5800 * - A string, in that case this is the path to a file
5801 * containing the list of IP addresses, one per line
5805 /** @} */ # end of proxy scanner settings
5807 /************************************************************************//**
5808 * @name Cookie settings
5813 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5815 $wgCookieExpiration = 180 * 86400;
5818 * Default login cookie lifetime, in seconds. Setting
5819 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5820 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5821 * login cookies session-only.
5823 $wgExtendedLoginCookieExpiration = null;
5826 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5827 * or ".any.subdomain.net"
5829 $wgCookieDomain = '';
5832 * Set this variable if you want to restrict cookies to a certain path within
5833 * the domain specified by $wgCookieDomain.
5835 $wgCookiePath = '/';
5838 * Whether the "secure" flag should be set on the cookie. This can be:
5839 * - true: Set secure flag
5840 * - false: Don't set secure flag
5841 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5843 $wgCookieSecure = 'detect';
5846 * By default, MediaWiki checks if the client supports cookies during the
5847 * login process, so that it can display an informative error message if
5848 * cookies are disabled. Set this to true if you want to disable this cookie
5851 $wgDisableCookieCheck = false;
5854 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5855 * to a string to use a custom prefix. Setting it to false causes the database
5856 * name to be used as a prefix.
5858 $wgCookiePrefix = false;
5861 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5862 * in browsers that support this feature. This can mitigates some classes of
5865 $wgCookieHttpOnly = true;
5868 * A list of cookies that vary the cache (for use by extensions)
5870 $wgCacheVaryCookies = [];
5873 * Override to customise the session name
5875 $wgSessionName = false;
5877 /** @} */ # end of cookie settings }
5879 /************************************************************************//**
5880 * @name LaTeX (mathematical formulas)
5885 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5886 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5887 * (ImageMagick) installed and available in the PATH.
5888 * Please see math/README for more information.
5892 /** @} */ # end LaTeX }
5894 /************************************************************************//**
5895 * @name Profiling, testing and debugging
5897 * To enable profiling, edit StartProfiler.php
5903 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5904 * The debug log file should be not be publicly accessible if it is used, as it
5905 * may contain private data.
5907 $wgDebugLogFile = '';
5910 * Prefix for debug log lines
5912 $wgDebugLogPrefix = '';
5915 * If true, instead of redirecting, show a page with a link to the redirect
5916 * destination. This allows for the inspection of PHP error messages, and easy
5917 * resubmission of form data. For developer use only.
5919 $wgDebugRedirects = false;
5922 * If true, log debugging data from action=raw and load.php.
5923 * This is normally false to avoid overlapping debug entries due to gen=css
5924 * and gen=js requests.
5926 $wgDebugRawPage = false;
5929 * Send debug data to an HTML comment in the output.
5931 * This may occasionally be useful when supporting a non-technical end-user.
5932 * It's more secure than exposing the debug log file to the web, since the
5933 * output only contains private data for the current user. But it's not ideal
5934 * for development use since data is lost on fatal errors and redirects.
5936 $wgDebugComments = false;
5939 * Write SQL queries to the debug log.
5941 * This setting is only used $wgLBFactoryConf['class'] is set to
5942 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5943 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5944 * connection to achieve the same functionality.
5946 $wgDebugDumpSql = false;
5949 * Performance expectations for DB usage
5953 $wgTrxProfilerLimits = [
5954 // HTTP GET/HEAD requests.
5955 // Master queries should not happen on GET requests
5959 'readQueryTime' => 5
5961 // HTTP POST requests.
5962 // Master reads and writes will happen for a subset of these.
5964 'readQueryTime' => 5,
5965 'writeQueryTime' => 1,
5966 'maxAffected' => 500
5968 'POST-nonwrite' => [
5971 'readQueryTime' => 5
5973 // Deferred updates that run after HTTP response is sent
5975 'readQueryTime' => 5,
5976 'writeQueryTime' => 1,
5977 'maxAffected' => 500
5979 // Background job runner
5981 'readQueryTime' => 30,
5982 'writeQueryTime' => 5,
5983 'maxAffected' => 1000
5985 // Command-line scripts
5987 'writeQueryTime' => 5,
5988 'maxAffected' => 1000
5993 * Map of string log group names to log destinations.
5995 * If set, wfDebugLog() output for that group will go to that file instead
5996 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5999 * Log destinations may be one of the following:
6000 * - false to completely remove from the output, including from $wgDebugLogFile.
6001 * - string values specifying a filename or URI.
6002 * - associative array with keys:
6003 * - 'destination' desired filename or URI.
6004 * - 'sample' an integer value, specifying a sampling factor (optional)
6005 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
6006 * to log (optional, since 1.25)
6010 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
6013 * @par Advanced example:
6015 * $wgDebugLogGroups['memcached'] = [
6016 * 'destination' => '/var/log/mediawiki/memcached.log',
6017 * 'sample' => 1000, // log 1 message out of every 1,000.
6018 * 'level' => \Psr\Log\LogLevel::WARNING
6022 $wgDebugLogGroups = [];
6025 * Default service provider for creating Psr\Log\LoggerInterface instances.
6027 * The value should be an array suitable for use with
6028 * ObjectFactory::getObjectFromSpec(). The created object is expected to
6029 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
6032 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
6033 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
6034 * and bypass the use of this configuration variable entirely.
6036 * @par To completely disable logging:
6038 * $wgMWLoggerDefaultSpi = [ 'class' => '\\MediaWiki\\Logger\\NullSpi' ];
6042 * @var array $wgMWLoggerDefaultSpi
6045 $wgMWLoggerDefaultSpi = [
6046 'class' => '\\MediaWiki\\Logger\\LegacySpi',
6050 * Display debug data at the bottom of the main content area.
6052 * Useful for developers and technical users trying to working on a closed wiki.
6054 $wgShowDebug = false;
6057 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
6058 * Since 1.19 also includes memory usage.
6060 $wgDebugTimestamps = false;
6063 * Print HTTP headers for every request in the debug information.
6065 $wgDebugPrintHttpHeaders = true;
6068 * Show the contents of $wgHooks in Special:Version
6070 $wgSpecialVersionShowHooks = false;
6073 * Whether to show "we're sorry, but there has been a database error" pages.
6074 * Displaying errors aids in debugging, but may display information useful
6077 $wgShowSQLErrors = false;
6080 * If set to true, uncaught exceptions will print a complete stack trace
6081 * to output. This should only be used for debugging, as it may reveal
6082 * private information in function parameters due to PHP's backtrace
6085 $wgShowExceptionDetails = false;
6088 * If true, show a backtrace for database errors
6090 * @note This setting only applies when connection errors and query errors are
6091 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
6092 * including those in which an uncaught exception is thrown from within the
6093 * exception handler.
6095 $wgShowDBErrorBacktrace = false;
6098 * If true, send the exception backtrace to the error log
6100 $wgLogExceptionBacktrace = true;
6103 * Expose backend server host names through the API and various HTML comments
6105 $wgShowHostnames = false;
6108 * Override server hostname detection with a hardcoded value.
6109 * Should be a string, default false.
6112 $wgOverrideHostname = false;
6115 * If set to true MediaWiki will throw notices for some possible error
6116 * conditions and for deprecated functions.
6118 $wgDevelopmentWarnings = false;
6121 * Release limitation to wfDeprecated warnings, if set to a release number
6122 * development warnings will not be generated for deprecations added in releases
6125 $wgDeprecationReleaseLimit = false;
6128 * Only record profiling info for pages that took longer than this
6129 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
6131 $wgProfileLimit = 0.0;
6134 * Don't put non-profiling info into log file
6136 * @deprecated since 1.23, set the log file in
6137 * $wgDebugLogGroups['profileoutput'] instead.
6139 $wgProfileOnly = false;
6142 * Destination of statsd metrics.
6144 * A host or host:port of a statsd server. Port defaults to 8125.
6146 * If not set, statsd metrics will not be collected.
6148 * @see wfLogProfilingData
6151 $wgStatsdServer = false;
6154 * Prefix for metric names sent to $wgStatsdServer.
6156 * @see MediaWikiServices::getStatsdDataFactory
6157 * @see BufferingStatsdDataFactory
6160 $wgStatsdMetricPrefix = 'MediaWiki';
6163 * InfoAction retrieves a list of transclusion links (both to and from).
6164 * This number puts a limit on that query in the case of highly transcluded
6167 $wgPageInfoTransclusionLimit = 50;
6170 * Set this to an integer to only do synchronous site_stats updates
6171 * one every *this many* updates. The other requests go into pending
6172 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
6173 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
6175 $wgSiteStatsAsyncFactor = false;
6178 * Parser test suite files to be run by parserTests.php when no specific
6179 * filename is passed to it.
6181 * Extensions may add their own tests to this array, or site-local tests
6182 * may be added via LocalSettings.php
6186 $wgParserTestFiles = [
6187 "$IP/tests/parser/parserTests.txt",
6188 "$IP/tests/parser/extraParserTests.txt"
6192 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
6194 $wgEnableJavaScriptTest = false;
6197 * Overwrite the caching key prefix with custom value.
6200 $wgCachePrefix = false;
6203 * Display the new debugging toolbar. This also enables profiling on database
6204 * queries and other useful output.
6205 * Will be ignored if $wgUseFileCache or $wgUseSquid is enabled.
6209 $wgDebugToolbar = false;
6211 /** @} */ # end of profiling, testing and debugging }
6213 /************************************************************************//**
6219 * Set this to true to disable the full text search feature.
6221 $wgDisableTextSearch = false;
6224 * Set to true to have nicer highlighted text in search results,
6225 * by default off due to execution overhead
6227 $wgAdvancedSearchHighlighting = false;
6230 * Regexp to match word boundaries, defaults for non-CJK languages
6231 * should be empty for CJK since the words are not separate
6233 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
6236 * Template for OpenSearch suggestions, defaults to API action=opensearch
6238 * Sites with heavy load would typically have these point to a custom
6239 * PHP wrapper to avoid firing up mediawiki for every keystroke
6241 * Placeholders: {searchTerms}
6243 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
6245 $wgOpenSearchTemplate = false;
6248 * Templates for OpenSearch suggestions, defaults to API action=opensearch
6250 * Sites with heavy load would typically have these point to a custom
6251 * PHP wrapper to avoid firing up mediawiki for every keystroke
6253 * Placeholders: {searchTerms}
6255 $wgOpenSearchTemplates = [
6256 'application/x-suggestions+json' => false,
6257 'application/x-suggestions+xml' => false,
6261 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
6262 * false if you've disabled scripts that use api?action=opensearch and
6263 * want reduce load caused by cached scripts still pulling suggestions.
6264 * It will let the API fallback by responding with an empty array.
6266 $wgEnableOpenSearchSuggest = true;
6269 * Integer defining default number of entries to show on
6272 $wgOpenSearchDefaultLimit = 10;
6275 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
6277 $wgOpenSearchDescriptionLength = 100;
6280 * Expiry time for search suggestion responses
6282 $wgSearchSuggestCacheExpiry = 1200;
6285 * If you've disabled search semi-permanently, this also disables updates to the
6286 * table. If you ever re-enable, be sure to rebuild the search table.
6288 $wgDisableSearchUpdate = false;
6291 * List of namespaces which are searched by default.
6295 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
6296 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
6299 $wgNamespacesToBeSearchedDefault = [
6304 * Disable the internal MySQL-based search, to allow it to be
6305 * implemented by an extension instead.
6307 $wgDisableInternalSearch = false;
6310 * Set this to a URL to forward search requests to some external location.
6311 * If the URL includes '$1', this will be replaced with the URL-encoded
6315 * To forward to Google you'd have something like:
6317 * $wgSearchForwardUrl =
6318 * 'http://www.google.com/search?q=$1' .
6319 * '&domains=http://example.com' .
6320 * '&sitesearch=http://example.com' .
6321 * '&ie=utf-8&oe=utf-8';
6324 $wgSearchForwardUrl = null;
6327 * Search form behavior.
6328 * - true = use Go & Search buttons
6329 * - false = use Go button & Advanced search link
6331 $wgUseTwoButtonsSearchForm = true;
6334 * Array of namespaces to generate a Google sitemap for when the
6335 * maintenance/generateSitemap.php script is run, or false if one is to be
6336 * generated for all namespaces.
6338 $wgSitemapNamespaces = false;
6341 * Custom namespace priorities for sitemaps. Setting this will allow you to
6342 * set custom priorities to namespaces when sitemaps are generated using the
6343 * maintenance/generateSitemap.php script.
6345 * This should be a map of namespace IDs to priority
6348 * $wgSitemapNamespacesPriorities = [
6354 $wgSitemapNamespacesPriorities = false;
6357 * If true, searches for IP addresses will be redirected to that IP's
6358 * contributions page. E.g. searching for "1.2.3.4" will redirect to
6359 * [[Special:Contributions/1.2.3.4]]
6361 $wgEnableSearchContributorsByIP = true;
6363 /** @} */ # end of search settings
6365 /************************************************************************//**
6366 * @name Edit user interface
6371 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
6372 * fall back to the old behavior (no merging).
6374 $wgDiff3 = '/usr/bin/diff3';
6377 * Path to the GNU diff utility.
6379 $wgDiff = '/usr/bin/diff';
6382 * Which namespaces have special treatment where they should be preview-on-open
6383 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
6384 * can specify namespaces of pages they have special treatment for
6386 $wgPreviewOnOpenNamespaces = [
6391 * Enable the UniversalEditButton for browsers that support it
6392 * (currently only Firefox with an extension)
6393 * See http://universaleditbutton.org for more background information
6395 $wgUniversalEditButton = true;
6398 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6399 * will try to automatically create one. This feature can be disabled by set-
6400 * ting this variable false.
6402 $wgUseAutomaticEditSummaries = true;
6404 /** @} */ # end edit UI }
6406 /************************************************************************//**
6408 * See also $wgSiteNotice
6413 * @cond file_level_code
6414 * Set $wgCommandLineMode if it's not set already, to avoid notices
6416 if ( !isset( $wgCommandLineMode ) ) {
6417 $wgCommandLineMode = false;
6422 * For colorized maintenance script output, is your terminal background dark ?
6424 $wgCommandLineDarkBg = false;
6427 * Set this to a string to put the wiki into read-only mode. The text will be
6428 * used as an explanation to users.
6430 * This prevents most write operations via the web interface. Cache updates may
6431 * still be possible. To prevent database writes completely, use the read_only
6437 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6438 * Its contents will be shown to users as part of the read-only warning
6441 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6443 $wgReadOnlyFile = false;
6446 * When you run the web-based upgrade utility, it will tell you what to set
6447 * this to in order to authorize the upgrade process. It will subsequently be
6448 * used as a password, to authorize further upgrades.
6450 * For security, do not set this to a guessable string. Use the value supplied
6451 * by the install/upgrade process. To cause the upgrader to generate a new key,
6452 * delete the old key from LocalSettings.php.
6454 $wgUpgradeKey = false;
6457 * Fully specified path to git binary
6459 $wgGitBin = '/usr/bin/git';
6462 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6464 * Key is a pattern passed to preg_match() and preg_replace(),
6465 * without the delimiters (which are #) and must match the whole URL.
6466 * The value is the replacement for the key (it can contain $1, etc.)
6467 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6468 * full SHA-1 of the HEAD revision.
6469 * %r will be replaced with a URL-encoded version of $1.
6470 * %R will be replaced with $1 and no URL-encoding
6474 $wgGitRepositoryViewers = [
6475 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6476 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6477 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6478 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6481 /** @} */ # End of maintenance }
6483 /************************************************************************//**
6484 * @name Recent changes, new pages, watchlist and history
6489 * Recentchanges items are periodically purged; entries older than this many
6491 * Default: 90 days = about three months
6493 $wgRCMaxAge = 90 * 24 * 3600;
6496 * Page watchers inactive for more than this many seconds are considered inactive.
6497 * Used mainly by action=info. Default: 180 days = about six months.
6500 $wgWatchersMaxAge = 180 * 24 * 3600;
6503 * If active watchers (per above) are this number or less, do not disclose it.
6504 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6505 * Set to -1 if you want to always complement watchers count with this info.
6508 $wgUnwatchedPageSecret = 1;
6511 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6512 * higher than what will be stored. Note that this is disabled by default
6513 * because we sometimes do have RC data which is beyond the limit for some
6514 * reason, and some users may use the high numbers to display that data which
6517 $wgRCFilterByAge = false;
6520 * List of Limits options to list in the Special:Recentchanges and
6521 * Special:Recentchangeslinked pages.
6523 $wgRCLinkLimits = [ 50, 100, 250, 500 ];
6526 * List of Days options to list in the Special:Recentchanges and
6527 * Special:Recentchangeslinked pages.
6529 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ];
6532 * Destinations to which notifications about recent changes
6535 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
6536 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
6538 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
6540 * The common options are:
6541 * * 'uri' -- the address to which the notices are to be sent.
6542 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
6543 * produce the text to send. This can also be an object of the class.
6544 * * 'omit_bots' -- whether the bot edits should be in the feed
6545 * * 'omit_anon' -- whether anonymous edits should be in the feed
6546 * * 'omit_user' -- whether edits by registered users should be in the feed
6547 * * 'omit_minor' -- whether minor edits should be in the feed
6548 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
6550 * The IRC-specific options are:
6551 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
6552 * the first entry in the $wgLocalInterwikis array (or the value of
6553 * $wgLocalInterwiki, if set)
6555 * The JSON-specific options are:
6556 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6558 * @example $wgRCFeeds['example'] = [
6559 * 'formatter' => 'JSONRCFeedFormatter',
6560 * 'uri' => "udp://localhost:1336",
6561 * 'add_interwiki_prefix' => false,
6562 * 'omit_bots' => true,
6564 * @example $wgRCFeeds['exampleirc'] = [
6565 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6566 * 'uri' => "udp://localhost:1338",
6567 * 'add_interwiki_prefix' => false,
6568 * 'omit_bots' => true,
6575 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
6576 * Keys are scheme names, values are names of engine classes.
6579 'redis' => 'RedisPubSubFeedEngine',
6580 'udp' => 'UDPRCFeedEngine',
6584 * Treat category membership changes as a RecentChange.
6585 * Changes are mentioned in RC for page actions as follows:
6586 * - creation: pages created with categories are mentioned
6587 * - edit: category additions/removals to existing pages are mentioned
6588 * - move: nothing is mentioned (unless templates used depend on the title)
6589 * - deletion: nothing is mentioned
6590 * - undeletion: nothing is mentioned
6594 $wgRCWatchCategoryMembership = false;
6597 * Use RC Patrolling to check for vandalism (from recent changes and watchlists)
6598 * New pages and new files are included.
6600 $wgUseRCPatrol = true;
6603 * Use new page patrolling to check new pages on Special:Newpages
6605 $wgUseNPPatrol = true;
6608 * Use file patrolling to check new files on Special:Newfiles
6612 $wgUseFilePatrol = true;
6615 * Log autopatrol actions to the log table
6617 $wgLogAutopatrol = true;
6620 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6625 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6626 * eg Recentchanges, Newpages.
6631 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6632 * A cached version will continue to be served out even if changes
6633 * are made, until this many seconds runs out since the last render.
6635 * If set to 0, feed caching is disabled. Use this for debugging only;
6636 * feed generation can be pretty slow with diffs.
6638 $wgFeedCacheTimeout = 60;
6641 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6642 * pages larger than this size.
6644 $wgFeedDiffCutoff = 32768;
6647 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6648 * every page. Some sites might have a different feed they'd like to promote
6649 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6650 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6653 * Configure the 'atom' feed to http://example.com/somefeed.xml
6655 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6658 $wgOverrideSiteFeed = [];
6661 * Available feeds objects.
6662 * Should probably only be defined when a page is syndicated ie when
6663 * $wgOut->isSyndicated() is true.
6667 'atom' => 'AtomFeed',
6671 * Which feed types should we provide by default? This can include 'rss',
6672 * 'atom', neither, or both.
6674 $wgAdvertisedFeedTypes = [ 'atom' ];
6677 * Show watching users in recent changes, watchlist and page history views
6679 $wgRCShowWatchingUsers = false; # UPO
6682 * Show the amount of changed characters in recent changes
6684 $wgRCShowChangedSize = true;
6687 * If the difference between the character counts of the text
6688 * before and after the edit is below that value, the value will be
6689 * highlighted on the RC page.
6691 $wgRCChangedSizeThreshold = 500;
6694 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6695 * view for watched pages with new changes
6697 $wgShowUpdatedMarker = true;
6700 * Disable links to talk pages of anonymous users (IPs) in listings on special
6701 * pages like page history, Special:Recentchanges, etc.
6703 $wgDisableAnonTalk = false;
6706 * Enable filtering of categories in Recentchanges
6708 $wgAllowCategorizedRecentChanges = false;
6711 * Allow filtering by change tag in recentchanges, history, etc
6712 * Has no effect if no tags are defined in valid_tag.
6714 $wgUseTagFilter = true;
6717 * If set to an integer, pages that are watched by this many users or more
6718 * will not require the unwatchedpages permission to view the number of
6723 $wgUnwatchedPageThreshold = false;
6726 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6727 * certain types of edits.
6729 * To register a new one:
6731 * $wgRecentChangesFlags['flag'] => [
6732 * // message for the letter displayed next to rows on changes lists
6733 * 'letter' => 'letter-msg',
6734 * // message for the tooltip of the letter
6735 * 'title' => 'tooltip-msg',
6736 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6737 * 'legend' => 'legend-msg',
6738 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6739 * 'class' => 'css-class',
6740 * // optional (defaults to 'any'), how top-level flag is determined. 'any'
6741 * // will set the top-level flag if any line contains the flag, 'all' will
6742 * // only be set if all lines contain the flag.
6743 * 'grouping' => 'any',
6749 $wgRecentChangesFlags = [
6751 'letter' => 'newpageletter',
6752 'title' => 'recentchanges-label-newpage',
6753 'legend' => 'recentchanges-legend-newpage',
6754 'grouping' => 'any',
6757 'letter' => 'minoreditletter',
6758 'title' => 'recentchanges-label-minor',
6759 'legend' => 'recentchanges-legend-minor',
6760 'class' => 'minoredit',
6761 'grouping' => 'all',
6764 'letter' => 'boteditletter',
6765 'title' => 'recentchanges-label-bot',
6766 'legend' => 'recentchanges-legend-bot',
6767 'class' => 'botedit',
6768 'grouping' => 'all',
6771 'letter' => 'unpatrolledletter',
6772 'title' => 'recentchanges-label-unpatrolled',
6773 'legend' => 'recentchanges-legend-unpatrolled',
6774 'grouping' => 'any',
6778 /** @} */ # end RC/watchlist }
6780 /************************************************************************//**
6781 * @name Copyright and credits settings
6786 * Override for copyright metadata.
6788 * This is the name of the page containing information about the wiki's copyright status,
6789 * which will be added as a link in the footer if it is specified. It overrides
6790 * $wgRightsUrl if both are specified.
6792 $wgRightsPage = null;
6795 * Set this to specify an external URL containing details about the content license used on your
6797 * If $wgRightsPage is set then this setting is ignored.
6799 $wgRightsUrl = null;
6802 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6804 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6805 * of the page will also be used as the link if this variable is not set.
6807 $wgRightsText = null;
6810 * Override for copyright metadata.
6812 $wgRightsIcon = null;
6815 * Set this to true if you want detailed copyright information forms on Upload.
6817 $wgUseCopyrightUpload = false;
6820 * Set this to the number of authors that you want to be credited below an
6821 * article text. Set it to zero to hide the attribution block, and a negative
6822 * number (like -1) to show all authors. Note that this will require 2-3 extra
6823 * database hits, which can have a not insignificant impact on performance for
6829 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6830 * Otherwise, link to a separate credits page.
6832 $wgShowCreditsIfMax = true;
6834 /** @} */ # end of copyright and credits settings }
6836 /************************************************************************//**
6837 * @name Import / Export
6842 * List of interwiki prefixes for wikis we'll accept as sources for
6843 * Special:Import and API action=import. Since complete page history can be
6844 * imported, these should be 'trusted'.
6846 * This can either be a regular array, or an associative map specifying
6847 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6850 * $wgImportSources = [
6851 * 'wikipedia' => [ 'cs', 'en', 'fr', 'zh' ],
6853 * 'wikia' => [ 'animanga', 'brickipedia', 'desserts' ],
6857 * If you have a very complex import sources setup, you can lazy-load it using
6858 * the ImportSources hook.
6860 * If a user has the 'import' permission but not the 'importupload' permission,
6861 * they will only be able to run imports through this transwiki interface.
6863 $wgImportSources = [];
6866 * Optional default target namespace for interwiki imports.
6867 * Can use this to create an incoming "transwiki"-style queue.
6868 * Set to numeric key, not the name.
6870 * Users may override this in the Special:Import dialog.
6872 $wgImportTargetNamespace = null;
6875 * If set to false, disables the full-history option on Special:Export.
6876 * This is currently poorly optimized for long edit histories, so is
6877 * disabled on Wikimedia's sites.
6879 $wgExportAllowHistory = true;
6882 * If set nonzero, Special:Export requests for history of pages with
6883 * more revisions than this will be rejected. On some big sites things
6884 * could get bogged down by very very long pages.
6886 $wgExportMaxHistory = 0;
6889 * Return distinct author list (when not returning full history)
6891 $wgExportAllowListContributors = false;
6894 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6895 * up to this specified level, which will cause it to include all
6896 * pages linked to from the pages you specify. Since this number
6897 * can become *insanely large* and could easily break your wiki,
6898 * it's disabled by default for now.
6900 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6901 * crazy-big export from being done by someone setting the depth number too
6902 * high. In other words, last resort safety net.
6904 $wgExportMaxLinkDepth = 0;
6907 * Whether to allow the "export all pages in namespace" option
6909 $wgExportFromNamespaces = false;
6912 * Whether to allow exporting the entire wiki into a single file
6914 $wgExportAllowAll = false;
6917 * Maximum number of pages returned by the GetPagesFromCategory and
6918 * GetPagesFromNamespace functions.
6922 $wgExportPagelistLimit = 5000;
6924 /** @} */ # end of import/export }
6926 /*************************************************************************//**
6932 * A list of callback functions which are called once MediaWiki is fully
6935 $wgExtensionFunctions = [];
6938 * Extension messages files.
6940 * Associative array mapping extension name to the filename where messages can be
6941 * found. The file should contain variable assignments. Any of the variables
6942 * present in languages/messages/MessagesEn.php may be defined, but $messages
6943 * is the most common.
6945 * Variables defined in extensions will override conflicting variables defined
6948 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6949 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6950 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6951 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6953 * Extensions using the JSON message format can preserve backward compatibility with
6954 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6955 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6956 * as for the $wgMessagesDirs entry.
6960 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6963 $wgExtensionMessagesFiles = [];
6966 * Extension messages directories.
6968 * Associative array mapping extension name to the path of the directory where message files can
6969 * be found. The message files are expected to be JSON files named for their language code, e.g.
6970 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6971 * message directories.
6973 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6975 * @par Simple example:
6977 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6980 * @par Complex example:
6982 * $wgMessagesDirs['Example'] = [
6983 * __DIR__ . '/lib/ve/i18n',
6984 * __DIR__ . '/lib/oojs-ui/i18n',
6985 * __DIR__ . '/i18n',
6990 $wgMessagesDirs = [];
6993 * Array of files with list(s) of extension entry points to be used in
6994 * maintenance/mergeMessageFileList.php
6997 $wgExtensionEntryPointListFiles = [];
7000 * Parser output hooks.
7001 * This is an associative array where the key is an extension-defined tag
7002 * (typically the extension name), and the value is a PHP callback.
7003 * These will be called as an OutputPageParserOutput hook, if the relevant
7004 * tag has been registered with the parser output object.
7006 * Registration is done with $pout->addOutputHook( $tag, $data ).
7008 * The callback has the form:
7010 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
7013 $wgParserOutputHooks = [];
7016 * Whether to include the NewPP limit report as a HTML comment
7018 $wgEnableParserLimitReporting = true;
7021 * List of valid skin names
7023 * The key should be the name in all lower case, the value should be a properly
7024 * cased name for the skin. This value will be prefixed with "Skin" to create
7025 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
7026 * if you wish to have access to the full list.
7028 $wgValidSkinNames = [];
7031 * Special page list. This is an associative array mapping the (canonical) names of
7032 * special pages to either a class name to be instantiated, or a callback to use for
7033 * creating the special page object. In both cases, the result must be an instance of
7036 $wgSpecialPages = [];
7039 * Array mapping class names to filenames, for autoloading.
7041 $wgAutoloadClasses = [];
7044 * Switch controlling legacy case-insensitive classloading.
7045 * Do not disable if your wiki must support data created by PHP4, or by
7046 * MediaWiki 1.4 or earlier.
7048 $wgAutoloadAttemptLowercase = true;
7051 * An array of information about installed extensions keyed by their type.
7053 * All but 'name', 'path' and 'author' can be omitted.
7056 * $wgExtensionCredits[$type][] = [
7057 * 'path' => __FILE__,
7058 * 'name' => 'Example extension',
7059 * 'namemsg' => 'exampleextension-name',
7063 * 'version' => '1.9.0',
7064 * 'url' => 'http://example.org/example-extension/',
7065 * 'descriptionmsg' => 'exampleextension-desc',
7066 * 'license-name' => 'GPL-2.0+',
7070 * The extensions are listed on Special:Version. This page also looks for a file
7071 * named COPYING or LICENSE (optional .txt extension) and provides a link to
7072 * view said file. When the 'license-name' key is specified, this file is
7073 * interpreted as wikitext.
7075 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
7076 * 'skin', 'api', or 'other', or any additional types as specified through the
7077 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
7079 * - name: Name of extension as an inline string instead of localizable message.
7080 * Do not omit this even if 'namemsg' is provided, as it is used to override
7081 * the path Special:Version uses to find extension's license info, and is
7082 * required for backwards-compatibility with MediaWiki 1.23 and older.
7084 * - namemsg (since MW 1.24): A message key for a message containing the
7085 * extension's name, if the name is localizable. (For example, skin names
7088 * - author: A string or an array of strings. Authors can be linked using
7089 * the regular wikitext link syntax. To have an internationalized version of
7090 * "and others" show, add an element "...". This element can also be linked,
7091 * for instance "[http://example ...]".
7093 * - descriptionmsg: A message key or an an array with message key and parameters:
7094 * `'descriptionmsg' => 'exampleextension-desc',`
7096 * - description: Description of extension as an inline string instead of
7097 * localizable message (omit in favour of 'descriptionmsg').
7099 * - license-name: Short name of the license (used as label for the link), such
7100 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
7102 $wgExtensionCredits = [];
7105 * Authentication plugin.
7106 * @var $wgAuth AuthPlugin
7107 * @deprecated since 1.27 use $wgAuthManagerConfig instead
7112 * Global list of hooks.
7114 * The key is one of the events made available by MediaWiki, you can find
7115 * a description for most of them in docs/hooks.txt. The array is used
7116 * internally by Hook:run().
7118 * The value can be one of:
7120 * - A function name:
7122 * $wgHooks['event_name'][] = $function;
7124 * - A function with some data:
7126 * $wgHooks['event_name'][] = [ $function, $data ];
7128 * - A an object method:
7130 * $wgHooks['event_name'][] = [ $object, 'method' ];
7134 * $wgHooks['event_name'][] = function ( $hookParam ) {
7135 * // Handler code goes here.
7139 * @warning You should always append to an event array or you will end up
7140 * deleting a previous registered hook.
7142 * @warning Hook handlers should be registered at file scope. Registering
7143 * handlers after file scope can lead to unexpected results due to caching.
7148 * List of service wiring files to be loaded by the default instance of MediaWikiServices.
7149 * Each file listed here is expected to return an associative array mapping service names
7150 * to instantiator functions. Extensions may add wiring files to define their own services.
7151 * However, this cannot be used to replace existing services - use the MediaWikiServices
7154 * @see MediaWikiServices
7155 * @see ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
7156 * @see docs/injection.txt for an overview of dependency injection in MediaWiki.
7158 $wgServiceWiringFiles = [
7159 __DIR__
. '/ServiceWiring.php'
7163 * Maps jobs to their handling classes; extensions
7164 * can add to this to provide custom jobs
7167 'refreshLinks' => 'RefreshLinksJob',
7168 'deleteLinks' => 'DeleteLinksJob',
7169 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
7170 'sendMail' => 'EmaillingJob',
7171 'enotifNotify' => 'EnotifNotifyJob',
7172 'fixDoubleRedirect' => 'DoubleRedirectJob',
7173 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
7174 'PublishStashedFile' => 'PublishStashedFileJob',
7175 'ThumbnailRender' => 'ThumbnailRenderJob',
7176 'recentChangesUpdate' => 'RecentChangesUpdateJob',
7177 'refreshLinksPrioritized' => 'RefreshLinksJob',
7178 'refreshLinksDynamic' => 'RefreshLinksJob',
7179 'activityUpdateJob' => 'ActivityUpdateJob',
7180 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
7181 'cdnPurge' => 'CdnPurgeJob',
7182 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
7187 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
7188 * special flags are set. The values here are keys of $wgJobClasses.
7191 * - Very long-running jobs.
7192 * - Jobs that you would never want to run as part of a page rendering request.
7193 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
7194 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
7195 * These settings should be global to all wikis.
7197 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ];
7200 * Map of job types to how many job "work items" should be run per second
7201 * on each job runner process. The meaning of "work items" varies per job,
7202 * but typically would be something like "pages to update". A single job
7203 * may have a variable number of work items, as is the case with batch jobs.
7204 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
7205 * These settings should be global to all wikis.
7208 $wgJobBackoffThrottling = [];
7211 * Make job runners commit changes for slave-lag prone jobs one job at a time.
7212 * This is useful if there are many job workers that race on slave lag checks.
7213 * If set, jobs taking this many seconds of DB write time have serialized commits.
7215 * Note that affected jobs may have worse lock contention. Also, if they affect
7216 * several DBs at once they may have a smaller chance of being atomic due to the
7217 * possibility of connection loss while queueing up to commit. Affected jobs may
7218 * also fail due to the commit lock acquisition timeout.
7223 $wgJobSerialCommitThreshold = false;
7226 * Map of job types to configuration arrays.
7227 * This determines which queue class and storage system is used for each job type.
7228 * Job types that do not have explicit configuration will use the 'default' config.
7229 * These settings should be global to all wikis.
7232 'default' => [ 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ],
7236 * Which aggregator to use for tracking which queues have jobs.
7237 * These settings should be global to all wikis.
7239 $wgJobQueueAggregator = [
7240 'class' => 'JobQueueAggregatorNull'
7244 * Additional functions to be performed with updateSpecialPages.
7245 * Expensive Querypages are already updated.
7247 $wgSpecialPageCacheUpdates = [
7248 'Statistics' => [ 'SiteStatsUpdate', 'cacheUpdate' ]
7252 * Hooks that are used for outputting exceptions. Format is:
7253 * $wgExceptionHooks[] = $funcname
7255 * $wgExceptionHooks[] = [ $class, $funcname ]
7256 * Hooks should return strings or false
7258 $wgExceptionHooks = [];
7261 * Page property link table invalidation lists. When a page property
7262 * changes, this may require other link tables to be updated (eg
7263 * adding __HIDDENCAT__ means the hiddencat tracking category will
7264 * have been added, so the categorylinks table needs to be rebuilt).
7265 * This array can be added to by extensions.
7267 $wgPagePropLinkInvalidations = [
7268 'hiddencat' => 'categorylinks',
7271 /** @} */ # End extensions }
7273 /*************************************************************************//**
7279 * Use experimental, DMOZ-like category browser
7281 $wgUseCategoryBrowser = false;
7284 * On category pages, show thumbnail gallery for images belonging to that
7285 * category instead of listing them as articles.
7287 $wgCategoryMagicGallery = true;
7290 * Paging limit for categories
7292 $wgCategoryPagingLimit = 200;
7295 * Specify how category names should be sorted, when listed on a category page.
7296 * A sorting scheme is also known as a collation.
7298 * Available values are:
7300 * - uppercase: Converts the category name to upper case, and sorts by that.
7302 * - identity: Does no conversion. Sorts by binary value of the string.
7304 * - uca-default: Provides access to the Unicode Collation Algorithm with
7305 * the default element table. This is a compromise collation which sorts
7306 * all languages in a mediocre way. However, it is better than "uppercase".
7308 * To use the uca-default collation, you must have PHP's intl extension
7309 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
7310 * resulting collation will depend on the version of ICU installed on the
7313 * After you change this, you must run maintenance/updateCollation.php to fix
7314 * the sort keys in the database.
7316 * Extensions can define there own collations by subclassing Collation
7317 * and using the Collation::factory hook.
7319 $wgCategoryCollation = 'uppercase';
7321 /** @} */ # End categories }
7323 /*************************************************************************//**
7329 * The logging system has two levels: an event type, which describes the
7330 * general category and can be viewed as a named subset of all logs; and
7331 * an action, which is a specific kind of event that can exist in that
7352 * This restricts log access to those who have a certain right
7353 * Users without this will not see it in the option menu and can not view it
7354 * Restricted logs are not added to recent changes
7355 * Logs should remain non-transcludable
7356 * Format: logtype => permissiontype
7358 $wgLogRestrictions = [
7359 'suppress' => 'suppressionlog'
7363 * Show/hide links on Special:Log will be shown for these log types.
7365 * This is associative array of log type => boolean "hide by default"
7367 * See $wgLogTypes for a list of available log types.
7371 * $wgFilterLogTypes = [ 'move' => true, 'import' => false ];
7374 * Will display show/hide links for the move and import logs. Move logs will be
7375 * hidden by default unless the link is clicked. Import logs will be shown by
7376 * default, and hidden when the link is clicked.
7378 * A message of the form log-show-hide-[type] should be added, and will be used
7379 * for the link text.
7381 $wgFilterLogTypes = [
7387 * Lists the message key string for each log type. The localized messages
7388 * will be listed in the user interface.
7390 * Extensions with custom log types may add to this array.
7392 * @since 1.19, if you follow the naming convention log-name-TYPE,
7393 * where TYPE is your log type, yoy don't need to use this array.
7396 '' => 'all-logs-page',
7397 'block' => 'blocklogpage',
7398 'protect' => 'protectlogpage',
7399 'rights' => 'rightslog',
7400 'delete' => 'dellogpage',
7401 'upload' => 'uploadlogpage',
7402 'move' => 'movelogpage',
7403 'import' => 'importlogpage',
7404 'patrol' => 'patrol-log-page',
7405 'merge' => 'mergelog',
7406 'suppress' => 'suppressionlog',
7410 * Lists the message key string for descriptive text to be shown at the
7411 * top of each log type.
7413 * Extensions with custom log types may add to this array.
7415 * @since 1.19, if you follow the naming convention log-description-TYPE,
7416 * where TYPE is your log type, yoy don't need to use this array.
7419 '' => 'alllogstext',
7420 'block' => 'blocklogtext',
7421 'delete' => 'dellogpagetext',
7422 'import' => 'importlogpagetext',
7423 'merge' => 'mergelogpagetext',
7424 'move' => 'movelogpagetext',
7425 'patrol' => 'patrol-log-header',
7426 'protect' => 'protectlogtext',
7427 'rights' => 'rightslogtext',
7428 'suppress' => 'suppressionlogtext',
7429 'upload' => 'uploadlogpagetext',
7433 * Lists the message key string for formatting individual events of each
7434 * type and action when listed in the logs.
7436 * Extensions with custom log types may add to this array.
7441 * The same as above, but here values are names of classes,
7443 * @see LogPage::actionText
7446 $wgLogActionsHandlers = [
7447 'block/block' => 'BlockLogFormatter',
7448 'block/reblock' => 'BlockLogFormatter',
7449 'block/unblock' => 'BlockLogFormatter',
7450 'contentmodel/change' => 'ContentModelLogFormatter',
7451 'contentmodel/new' => 'ContentModelLogFormatter',
7452 'delete/delete' => 'DeleteLogFormatter',
7453 'delete/event' => 'DeleteLogFormatter',
7454 'delete/restore' => 'DeleteLogFormatter',
7455 'delete/revision' => 'DeleteLogFormatter',
7456 'import/interwiki' => 'ImportLogFormatter',
7457 'import/upload' => 'ImportLogFormatter',
7458 'managetags/activate' => 'LogFormatter',
7459 'managetags/create' => 'LogFormatter',
7460 'managetags/deactivate' => 'LogFormatter',
7461 'managetags/delete' => 'LogFormatter',
7462 'merge/merge' => 'MergeLogFormatter',
7463 'move/move' => 'MoveLogFormatter',
7464 'move/move_redir' => 'MoveLogFormatter',
7465 'patrol/patrol' => 'PatrolLogFormatter',
7466 'patrol/autopatrol' => 'PatrolLogFormatter',
7467 'protect/modify' => 'ProtectLogFormatter',
7468 'protect/move_prot' => 'ProtectLogFormatter',
7469 'protect/protect' => 'ProtectLogFormatter',
7470 'protect/unprotect' => 'ProtectLogFormatter',
7471 'rights/autopromote' => 'RightsLogFormatter',
7472 'rights/rights' => 'RightsLogFormatter',
7473 'suppress/block' => 'BlockLogFormatter',
7474 'suppress/delete' => 'DeleteLogFormatter',
7475 'suppress/event' => 'DeleteLogFormatter',
7476 'suppress/reblock' => 'BlockLogFormatter',
7477 'suppress/revision' => 'DeleteLogFormatter',
7478 'tag/update' => 'TagLogFormatter',
7479 'upload/overwrite' => 'UploadLogFormatter',
7480 'upload/revert' => 'UploadLogFormatter',
7481 'upload/upload' => 'UploadLogFormatter',
7485 * List of log types that can be filtered by action types
7487 * To each action is associated the list of log_action
7488 * subtypes to search for, usually one, but not necessarily so
7489 * Extensions may append to this array
7492 $wgActionFilteredLogs = [
7494 'block' => [ 'block' ],
7495 'reblock' => [ 'reblock' ],
7496 'unblock' => [ 'unblock' ],
7499 'change' => [ 'change' ],
7503 'delete' => [ 'delete' ],
7504 'restore' => [ 'restore' ],
7505 'event' => [ 'event' ],
7506 'revision' => [ 'revision' ],
7509 'interwiki' => [ 'interwiki' ],
7510 'upload' => [ 'upload' ],
7513 'create' => [ 'create' ],
7514 'delete' => [ 'delete' ],
7515 'activate' => [ 'activate' ],
7516 'deactivate' => [ 'deactivate' ],
7519 'move' => [ 'move' ],
7520 'move_redir' => [ 'move_redir' ],
7523 'create' => [ 'create', 'newusers' ],
7524 'create2' => [ 'create2' ],
7525 'autocreate' => [ 'autocreate' ],
7526 'byemail' => [ 'byemail' ],
7529 'patrol' => [ 'patrol' ],
7530 'autopatrol' => [ 'autopatrol' ],
7533 'protect' => [ 'protect' ],
7534 'modify' => [ 'modify' ],
7535 'unprotect' => [ 'unprotect' ],
7536 'move_prot' => [ 'move_prot' ],
7539 'rights' => [ 'rights' ],
7540 'autopromote' => [ 'autopromote' ],
7543 'event' => [ 'event' ],
7544 'revision' => [ 'revision' ],
7545 'delete' => [ 'delete' ],
7546 'block' => [ 'block' ],
7547 'reblock' => [ 'reblock' ],
7550 'upload' => [ 'upload' ],
7551 'overwrite' => [ 'overwrite' ],
7556 * Maintain a log of newusers at Log/newusers?
7558 $wgNewUserLog = true;
7560 /** @} */ # end logging }
7562 /*************************************************************************//**
7563 * @name Special pages (general and miscellaneous)
7568 * Allow special page inclusions such as {{Special:Allpages}}
7570 $wgAllowSpecialInclusion = true;
7573 * Set this to an array of special page names to prevent
7574 * maintenance/updateSpecialPages.php from updating those pages.
7576 $wgDisableQueryPageUpdate = false;
7579 * On Special:Unusedimages, consider images "used", if they are put
7580 * into a category. Default (false) is not to count those as used.
7582 $wgCountCategorizedImagesAsUsed = false;
7585 * Maximum number of links to a redirect page listed on
7586 * Special:Whatlinkshere/RedirectDestination
7588 $wgMaxRedirectLinksRetrieved = 500;
7590 /** @} */ # end special pages }
7592 /*************************************************************************//**
7598 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7599 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7600 * 'foo' => true Load the class FooAction which subclasses Action
7601 * If something is specified in the getActionOverrides()
7602 * of the relevant Page object it will be used
7603 * instead of the default class.
7604 * 'foo' => false The action is disabled; show an error message
7605 * Unsetting core actions will probably cause things to complain loudly.
7611 'editchangetags' => 'SpecialPageAction',
7614 'markpatrolled' => true,
7620 'revisiondelete' => 'SpecialPageAction',
7623 'unprotect' => true,
7629 /** @} */ # end actions }
7631 /*************************************************************************//**
7632 * @name Robot (search engine crawler) policy
7633 * See also $wgNoFollowLinks.
7638 * Default robot policy. The default policy is to encourage indexing and fol-
7639 * lowing of links. It may be overridden on a per-namespace and/or per-page
7642 $wgDefaultRobotPolicy = 'index,follow';
7645 * Robot policies per namespaces. The default policy is given above, the array
7646 * is made of namespace constants as defined in includes/Defines.php. You can-
7647 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7648 * nofollow. This is because a number of special pages (e.g., ListPages) have
7649 * many permutations of options that display the same data under redundant
7650 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7651 * pages, all alike, and never reaching your actual content.
7655 * $wgNamespaceRobotPolicies = [ NS_TALK => 'noindex' ];
7658 $wgNamespaceRobotPolicies = [];
7661 * Robot policies per article. These override the per-namespace robot policies.
7662 * Must be in the form of an array where the key part is a properly canonicalised
7663 * text form title and the value is a robot policy.
7667 * $wgArticleRobotPolicies = [
7668 * 'Main Page' => 'noindex,follow',
7669 * 'User:Bob' => 'index,follow',
7673 * @par Example that DOES NOT WORK because the names are not canonical text
7676 * $wgArticleRobotPolicies = [
7677 * # Underscore, not space!
7678 * 'Main_Page' => 'noindex,follow',
7679 * # "Project", not the actual project name!
7680 * 'Project:X' => 'index,follow',
7681 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7682 * 'abc' => 'noindex,nofollow'
7686 $wgArticleRobotPolicies = [];
7689 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7690 * will not function, so users can't decide whether pages in that namespace are
7691 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7695 * $wgExemptFromUserRobotsControl = [ NS_MAIN, NS_TALK, NS_PROJECT ];
7698 $wgExemptFromUserRobotsControl = null;
7700 /** @} */ # End robot policy }
7702 /************************************************************************//**
7703 * @name AJAX and API
7704 * Note: The AJAX entry point which this section refers to is gradually being
7705 * replaced by the API entry point, api.php. They are essentially equivalent.
7706 * Both of them are used for dynamic client-side features, via XHR.
7711 * Enable the MediaWiki API for convenient access to
7712 * machine-readable data via api.php
7714 * See https://www.mediawiki.org/wiki/API
7716 $wgEnableAPI = true;
7719 * Allow the API to be used to perform write operations
7720 * (page edits, rollback, etc.) when an authorised user
7723 $wgEnableWriteAPI = true;
7727 * WARNING: SECURITY THREAT - debug use only
7729 * Disables many security checks in the API for debugging purposes.
7730 * This flag should never be used on the production servers, as it introduces
7731 * a number of potential security holes. Even when enabled, the validation
7732 * will still be performed, but instead of failing, API will return a warning.
7733 * Also, there will always be a warning notifying that this flag is set.
7734 * At this point, the flag allows GET requests to go through for modules
7739 $wgDebugAPI = false;
7742 * API module extensions.
7744 * Associative array mapping module name to modules specs;
7745 * Each module spec is an associative array containing at least
7746 * the 'class' key for the module's class, and optionally a
7747 * 'factory' key for the factory function to use for the module.
7749 * That factory function will be called with two parameters,
7750 * the parent module (an instance of ApiBase, usually ApiMain)
7751 * and the name the module was registered under. The return
7752 * value must be an instance of the class given in the 'class'
7755 * For backward compatibility, the module spec may also be a
7756 * simple string containing the module's class name. In that
7757 * case, the class' constructor will be called with the parent
7758 * module and module name as parameters, as described above.
7760 * Examples for registering API modules:
7763 * $wgAPIModules['foo'] = 'ApiFoo';
7764 * $wgAPIModules['bar'] = [
7765 * 'class' => 'ApiBar',
7766 * 'factory' => function( $main, $name ) { ... }
7768 * $wgAPIModules['xyzzy'] = [
7769 * 'class' => 'ApiXyzzy',
7770 * 'factory' => [ 'XyzzyFactory', 'newApiModule' ]
7774 * Extension modules may override the core modules.
7775 * See ApiMain::$Modules for a list of the core modules.
7780 * API format module extensions.
7781 * Associative array mapping format module name to module specs (see $wgAPIModules).
7782 * Extension modules may override the core modules.
7784 * See ApiMain::$Formats for a list of the core format modules.
7786 $wgAPIFormatModules = [];
7789 * API Query meta module extensions.
7790 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7791 * Extension modules may override the core modules.
7793 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7795 $wgAPIMetaModules = [];
7798 * API Query prop module extensions.
7799 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7800 * Extension modules may override the core modules.
7802 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7804 $wgAPIPropModules = [];
7807 * API Query list module extensions.
7808 * Associative array mapping list module name to module specs (see $wgAPIModules).
7809 * Extension modules may override the core modules.
7811 * See ApiQuery::$QueryListModules for a list of the core list modules.
7813 $wgAPIListModules = [];
7816 * Maximum amount of rows to scan in a DB query in the API
7817 * The default value is generally fine
7819 $wgAPIMaxDBRows = 5000;
7822 * The maximum size (in bytes) of an API result.
7823 * @warning Do not set this lower than $wgMaxArticleSize*1024
7825 $wgAPIMaxResultSize = 8388608;
7828 * The maximum number of uncached diffs that can be retrieved in one API
7829 * request. Set this to 0 to disable API diffs altogether
7831 $wgAPIMaxUncachedDiffs = 1;
7834 * Maximum amount of DB lag on a majority of DB slaves to tolerate
7835 * before forcing bots to retry any write requests via API errors.
7836 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
7838 $wgAPIMaxLagThreshold = 7;
7841 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7842 * API request logging
7844 $wgAPIRequestLog = false;
7847 * Set the timeout for the API help text cache. If set to 0, caching disabled
7849 $wgAPICacheHelpTimeout = 60 * 60;
7852 * The ApiQueryQueryPages module should skip pages that are redundant to true
7855 $wgAPIUselessQueryPages = [
7856 'MIMEsearch', // aiprop=mime
7857 'LinkSearch', // list=exturlusage
7858 'FileDuplicateSearch', // prop=duplicatefiles
7862 * Enable AJAX framework
7867 * List of Ajax-callable functions.
7868 * Extensions acting as Ajax callbacks must register here
7869 * @deprecated (officially) since 1.27; use the API instead
7871 $wgAjaxExportList = [];
7874 * Enable AJAX check for file overwrite, pre-upload
7876 $wgAjaxUploadDestCheck = true;
7879 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7881 $wgAjaxLicensePreview = true;
7884 * Have clients send edits to be prepared when filling in edit summaries.
7885 * This gives the server a head start on the expensive parsing operation.
7887 $wgAjaxEditStash = true;
7890 * Settings for incoming cross-site AJAX requests:
7891 * Newer browsers support cross-site AJAX when the target resource allows requests
7892 * from the origin domain by the Access-Control-Allow-Origin header.
7893 * This is currently only used by the API (requests to api.php)
7894 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7896 * - '*' matches any number of characters
7897 * - '?' matches any 1 character
7901 * $wgCrossSiteAJAXdomains = [
7902 * 'www.mediawiki.org',
7903 * '*.wikipedia.org',
7904 * '*.wikimedia.org',
7905 * '*.wiktionary.org',
7909 $wgCrossSiteAJAXdomains = [];
7912 * Domains that should not be allowed to make AJAX requests,
7913 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7914 * Uses the same syntax as $wgCrossSiteAJAXdomains
7916 $wgCrossSiteAJAXdomainExceptions = [];
7918 /** @} */ # End AJAX and API }
7920 /************************************************************************//**
7921 * @name Shell and process control
7926 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7928 $wgMaxShellMemory = 307200;
7931 * Maximum file size created by shell processes under linux, in KB
7932 * ImageMagick convert for example can be fairly hungry for scratch space
7934 $wgMaxShellFileSize = 102400;
7937 * Maximum CPU time in seconds for shell processes under Linux
7939 $wgMaxShellTime = 180;
7942 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7943 * would measure) in seconds for shell processes under Linux
7945 $wgMaxShellWallClockTime = 180;
7948 * Under Linux: a cgroup directory used to constrain memory usage of shell
7949 * commands. The directory must be writable by the user which runs MediaWiki.
7951 * If specified, this is used instead of ulimit, which is inaccurate, and
7952 * causes malloc() to return NULL, which exposes bugs in C applications, making
7953 * them segfault or deadlock.
7955 * A wrapper script will create a cgroup for each shell command that runs, as
7956 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7957 * kernel will send a SIGKILL signal to a process in the subgroup.
7961 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7962 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7963 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7966 * The reliability of cgroup cleanup can be improved by installing a
7967 * notify_on_release script in the root cgroup, see e.g.
7968 * https://gerrit.wikimedia.org/r/#/c/40784
7970 $wgShellCgroup = false;
7973 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7975 $wgPhpCli = '/usr/bin/php';
7978 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7979 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7980 * character set. Only the character set is relevant.
7982 $wgShellLocale = 'en_US.utf8';
7984 /** @} */ # End shell }
7986 /************************************************************************//**
7992 * Timeout for HTTP requests done internally, in seconds.
7994 $wgHTTPTimeout = 25;
7997 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7999 $wgAsyncHTTPTimeout = 25;
8002 * Proxy to use for CURL requests.
8004 $wgHTTPProxy = false;
8007 * Local virtual hosts.
8009 * This lists domains that are configured as virtual hosts on the same machine.
8010 * If a request is to be made to a domain listed here, or any subdomain thereof,
8011 * then no proxy will be used.
8012 * Command-line scripts are not affected by this setting and will always use
8013 * proxy if it is configured.
8016 $wgLocalVirtualHosts = [];
8019 * Timeout for connections done internally (in seconds)
8020 * Only works for curl
8022 $wgHTTPConnectTimeout = 5e0
;
8024 /** @} */ # End HTTP client }
8026 /************************************************************************//**
8032 * Number of jobs to perform per request. May be less than one in which case
8033 * jobs are performed probabalistically. If this is zero, jobs will not be done
8034 * during ordinary apache requests. In this case, maintenance/runJobs.php should
8035 * be run periodically.
8040 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
8041 * to handle the job execution, instead of blocking the request until the job
8042 * execution finishes.
8047 !function_exists( 'register_postsend_function' ) &&
8048 !function_exists( 'fastcgi_finish_request' )
8052 * Number of rows to update per job
8054 $wgUpdateRowsPerJob = 300;
8057 * Number of rows to update per query
8059 $wgUpdateRowsPerQuery = 100;
8061 /** @} */ # End job queue }
8063 /************************************************************************//**
8064 * @name Miscellaneous
8069 * Name of the external diff engine to use. Supported values:
8070 * * string: path to an external diff executable
8071 * * false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
8072 * * 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility
8074 $wgExternalDiffEngine = false;
8077 * Disable redirects to special pages and interwiki redirects, which use a 302
8078 * and have no "redirected from" link.
8080 * @note This is only for articles with #REDIRECT in them. URL's containing a
8081 * local interwiki prefix (or a non-canonical special page name) are still hard
8082 * redirected regardless of this setting.
8084 $wgDisableHardRedirects = false;
8087 * LinkHolderArray batch size
8090 $wgLinkHolderBatchSize = 1000;
8093 * By default MediaWiki does not register links pointing to same server in
8094 * externallinks dataset, use this value to override:
8096 $wgRegisterInternalExternals = false;
8099 * Maximum number of pages to move at once when moving subpages with a page.
8101 $wgMaximumMovedPages = 100;
8104 * Fix double redirects after a page move.
8105 * Tends to conflict with page move vandalism, use only on a private wiki.
8107 $wgFixDoubleRedirects = false;
8110 * Allow redirection to another page when a user logs in.
8111 * To enable, set to a string like 'Main Page'
8113 $wgRedirectOnLogin = null;
8116 * Configuration for processing pool control, for use in high-traffic wikis.
8117 * An implementation is provided in the PoolCounter extension.
8119 * This configuration array maps pool types to an associative array. The only
8120 * defined key in the associative array is "class", which gives the class name.
8121 * The remaining elements are passed through to the class as constructor
8126 * $wgPoolCounterConf = [ 'ArticleView' => [
8127 * 'class' => 'PoolCounter_Client',
8128 * 'timeout' => 15, // wait timeout in seconds
8129 * 'workers' => 5, // maximum number of active threads in each pool
8130 * 'maxqueue' => 50, // maximum number of total threads in each pool
8131 * ... any extension-specific options...
8135 $wgPoolCounterConf = null;
8138 * To disable file delete/restore temporarily
8140 $wgUploadMaintenance = false;
8143 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
8144 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
8145 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
8146 * (except for the special case of JS and CS pages).
8150 $wgNamespaceContentModels = [];
8153 * How to react if a plain text version of a non-text Content object is requested using
8154 * ContentHandler::getContentText():
8156 * * 'ignore': return null
8157 * * 'fail': throw an MWException
8158 * * 'serialize': serialize to default format
8162 $wgContentHandlerTextFallback = 'ignore';
8165 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
8166 * This way, the ContentHandler facility can be used without any additional information in the
8167 * database. A page's content model is then derived solely from the page's title. This however
8168 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
8169 * the page and/or make the content inaccessible. This also means that pages can not be moved to
8170 * a title that would default to a different content model.
8172 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
8173 * handling is less robust and less flexible.
8177 $wgContentHandlerUseDB = true;
8180 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
8181 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
8182 * the effect on the database they would have on a wikitext page.
8184 * @todo On the long run, it would be nice to put categories etc into a separate structure,
8185 * or at least parse only the contents of comments in the scripts.
8189 $wgTextModelsToParse = [
8190 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
8191 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
8192 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
8196 * Register handlers for specific types of sites.
8201 'mediawiki' => 'MediaWikiSite',
8205 * Whether the page_props table has a pp_sortkey column. Set to false in case
8206 * the respective database schema change was not applied.
8209 $wgPagePropsHaveSortkey = true;
8212 * Port where you have HTTPS running
8213 * Supports HTTPS on non-standard ports
8220 * Secret for session storage.
8221 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8225 $wgSessionSecret = false;
8228 * If for some reason you can't install the PHP OpenSSL or mcrypt extensions,
8229 * you can set this to true to make MediaWiki work again at the cost of storing
8230 * sensitive session data insecurely. But it would be much more secure to just
8231 * install the OpenSSL extension.
8234 $wgSessionInsecureSecrets = false;
8237 * Secret for hmac-based key derivation function (fast,
8238 * cryptographically secure random numbers).
8239 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8241 * See also: $wgHKDFAlgorithm
8244 $wgHKDFSecret = false;
8247 * Algorithm for hmac-based key derivation function (fast,
8248 * cryptographically secure random numbers).
8249 * See also: $wgHKDFSecret
8252 $wgHKDFAlgorithm = 'sha256';
8255 * Enable page language feature
8256 * Allows setting page language in database
8260 $wgPageLanguageUseDB = false;
8263 * Global configuration variable for Virtual REST Services.
8265 * Use the 'path' key to define automatically mounted services. The value for this
8266 * key is a map of path prefixes to service configuration. The later is an array of:
8267 * - class : the fully qualified class name
8268 * - options : map of arguments to the class constructor
8269 * Such services will be available to handle queries under their path from the VRS
8270 * singleton, e.g. MediaWikiServices::getInstance()->getVirtualRESTServiceClient();
8272 * Auto-mounting example for Parsoid:
8274 * $wgVirtualRestConfig['paths']['/parsoid/'] = [
8275 * 'class' => 'ParsoidVirtualRESTService',
8277 * 'url' => 'http://localhost:8000',
8278 * 'prefix' => 'enwiki',
8279 * 'domain' => 'en.wikipedia.org'
8283 * Parameters for different services can also be declared inside the 'modules' value,
8284 * which is to be treated as an associative array. The parameters in 'global' will be
8285 * merged with service-specific ones. The result will then be passed to
8286 * VirtualRESTService::__construct() in the module.
8288 * Example config for Parsoid:
8290 * $wgVirtualRestConfig['modules']['parsoid'] = [
8291 * 'url' => 'http://localhost:8000',
8292 * 'prefix' => 'enwiki',
8293 * 'domain' => 'en.wikipedia.org',
8299 $wgVirtualRestConfig = [
8303 # Timeout in seconds
8305 # 'domain' is set to $wgCanonicalServer in Setup.php
8306 'forwardCookies' => false,
8312 * Controls whether zero-result search queries with suggestions should display results for
8313 * these suggestions.
8318 $wgSearchRunSuggestedQuery = true;
8321 * Where popular password file is located.
8323 * Default in core contains 50,000 most popular. This config
8324 * allows you to change which file, in case you want to generate
8325 * a password file with > 50000 entries in it.
8327 * @see maintenance/createCommonPasswordCdb.php
8329 * @var string path to file
8331 $wgPopularPasswordFile = __DIR__
. '/../serialized/commonpasswords.cdb';
8334 * Max time (in seconds) a user-generated transaction can spend in writes.
8335 * If exceeded, the transaction is rolled back with an error instead of being committed.
8337 * @var int|bool Disabled if false
8340 $wgMaxUserDBWriteDuration = false;
8343 * Mapping of event channels (or channel categories) to EventRelayer configuration.
8345 * By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class
8346 * that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN
8347 * cache purging and CDN cache purging will emit events to this system. Appropriate listers can
8348 * subscribe to the channel and take actions based on the events. For example, a local daemon
8349 * can run on each CDN cache node and perfom local purges based on the URL purge channel events.
8351 * Some extensions may want to use "channel categories" so that different channels can also share
8352 * the same custom relayer instance (e.g. when it's likely to be overriden). They can use
8353 * EventRelayerGroup::getRelayer() based on the category but call notify() on various different
8354 * actual channels. One reason for this would be that some system have very different performance
8355 * vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.
8357 * The 'default' key is for all channels (or channel categories) without an explicit entry here.
8361 $wgEventRelayerConfig = [
8363 'class' => 'EventRelayerNull',
8368 * Share data about this installation with MediaWiki developers
8370 * When set to true, MediaWiki will periodically ping https://www.mediawiki.org/ with basic
8371 * data about this MediaWiki instance. This data includes, for example, the type of system,
8372 * PHP version, and chosen database backend. The Wikimedia Foundation shares this data with
8373 * MediaWiki developers to help guide future development efforts.
8375 * For details about what data is sent, see: https://www.mediawiki.org/wiki/Manual:$wgPingback
8380 $wgPingback = false;
8383 * List of urls which appear often to be triggering CSP reports
8384 * but do not appear to be caused by actual content, but by client
8385 * software inserting scripts (i.e. Ad-Ware).
8386 * List based on results from Wikimedia logs.
8390 $wgCSPFalsePositiveUrls = [
8391 'https://3hub.co' => true,
8392 'https://morepro.info' => true,
8393 'https://p.ato.mx' => true,
8394 'https://s.ato.mx' => true,
8395 'https://adserver.adtech.de' => true,
8396 'https://ums.adtechus.com' => true,
8397 'https://cas.criteo.com' => true,
8398 'https://cat.nl.eu.criteo.com' => true,
8399 'https://atpixel.alephd.com' => true,
8400 'https://rtb.metrigo.com' => true,
8401 'https://d5p.de17a.com' => true,
8405 * For really cool vim folding this needs to be at the end:
8406 * vim: foldmarker=@{,@} foldmethod=marker